Merge branch 'feature-ripple'

Author: pjkundert

images/XRP.png

@@ -161,23 +161,110 @@ class BinanceMainnet( cryptocurrencies.Cryptocurrency ):
     WIF_SECRET_KEY = 0x80
 
 
-class Account( hdwallet.HDWallet ):
+class RippleMainnet( cryptocurrencies.Cryptocurrency ):
+    """The standard HDWallet.p2pkh_address (Pay to Public Key Hash) encoding is used, w/ a prefix of
+    00.  However, the XRP-specific base-58 encoding is used, resulting in a fixed 'r' prefix.
 
-    """Supports producing Legacy addresses for Bitcoin, and Litecoin.  Doge (D...) and Ethereum (0x...)
+    See: https://xrpl.org/accounts.html#address-encoding.
+
+    """
+    NAME = "Ripple"
+    SYMBOL = "XRP"
+    NETWORK = "mainnet"
+    SOURCE_CODE = "https://github.com/ripple/rippled"
+    COIN_TYPE = cryptocurrencies.CoinType({
+        "INDEX": 144,
+        "HARDENED": True
+    })
+
+    PUBLIC_KEY_ADDRESS = 0x00 # Results in the prefix r..., when used w/ the Ripple base-58 alphabet
+    SEGWIT_ADDRESS = cryptocurrencies.SegwitAddress({
+        "HRP": None,
+        "VERSION": 0x00
+    })
+
+    EXTENDED_PRIVATE_KEY = cryptocurrencies.ExtendedPrivateKey({
+        "P2PKH": None,
+        "P2SH": None,
+        "P2WPKH": None,
+        "P2WPKH_IN_P2SH": None,
+        "P2WSH": None,
+        "P2WSH_IN_P2SH": None,
+    })
+    EXTENDED_PUBLIC_KEY = cryptocurrencies.ExtendedPublicKey({
+        "P2PKH": None,
+        "P2SH": None,
+        "P2WPKH": None,
+        "P2WPKH_IN_P2SH": None,
+        "P2WSH": None,
+        "P2WSH_IN_P2SH": None,
+    })
+
+    MESSAGE_PREFIX = None
+    DEFAULT_PATH = f"m/44'/{str(COIN_TYPE)}/0'/0/0"
+    WIF_SECRET_KEY = 0x80
+
+
+class XRPHDWallet( hdwallet.HDWallet ) :
+    """The XRP address format uses the standard p2pkh_address formulation, from
+    https://xrpl.org/accounts.html#creating-accounts:
+
+    The ripemd160 hash of sha256 hash of public key, then base58-encoded w/ 4-byte checksum.  The
+    base-58 dictionary used is the standard Ripple (not Bitcoin!) alphabet:
+
+        rpshnaf39wBUDNEGHJKLM4PQRST7VWXYZ2bcdeCg65jkm8oFqi1tuvAxyz
+
+    NOTE: Only secp256k1 keypairs are supported; these are the default for the Ripple ledger.
+
+    """
+    def p2pkh_address( self ):
+        p2pkh_btc	= super( XRPHDWallet, self ).p2pkh_address()
+        p2pkh		= base58.b58decode_check( p2pkh_btc )
+        return base58.b58encode_check( p2pkh, base58.RIPPLE_ALPHABET ).decode( 'UTF-8' )
+
+
+class Account:
+    """A Cryptocurrency "Account" / Wallet, based on a variety of underlying Python crypto-asset
+    support modules.  Presently, only meherett/python-hdwallet is used
+
+    An appropriate hdwallet-like wrapper is built, for any crypto-asset supported using another
+    module.  The required hdwallet API calls are:
+
+      .from_seed	-- start deriving from the provided seed
+      .from_mnemonic	-- start deriving from the provided seed via BIP-39 mnemonic
+      .clean_derivation	-- forget any prior derivation path
+      .from_path	-- derive a wallet from the specified derivation path
+      .p2pkh_address	-- produce a Legacy format address
+      .p2sh_address	-- produce a SegWit format address
+      .p2wpkh_address	-- produce a Bech32 format address
+      .path		-- return the current wallet derivation path
+      .private_key	-- return the current wallet's private key
+
+    For testing eg. BIP-38 encrypted wallets:
+
+      .from_private_key	-- import a specific private key
+      .from_encrypted	-- import an encrypted wallet
+
+    Also expect the following attributes to be available:
+
+      ._cryptocurrency.SYMBOL:	The short name of the crypto-asset, eg 'XRP'
+
+    Supports producing Legacy addresses for Bitcoin, and Litecoin.  Doge (D...) and Ethereum (0x...)
     addresses use standard BIP44 derivation.
 
-    | Crypto | Semantic | Path             | Address | Support |
-    |--------+----------+------------------+---------+---------|
-    | ETH    | Legacy   | m/44'/60'/0'/0/0 | 0x...   |         |
-    | BNB    | Legacy   | m/44'/60'/0'/0/0 | 0x...   | Beta    |
-    | CRO    | Bech32   | m/44'/60'/0'/0/0 | crc1... | Beta    |
-    | BTC    | Legacy   | m/44'/ 0'/0'/0/0 | 1...    |         |
-    |        | SegWit   | m/44'/ 0'/0'/0/0 | 3...    |         |
-    |        | Bech32   | m/84'/ 0'/0'/0/0 | bc1...  |         |
-    | LTC    | Legacy   | m/44'/ 2'/0'/0/0 | L...    |         |
-    |        | SegWit   | m/44'/ 2'/0'/0/0 | M...    |         |
-    |        | Bech32   | m/84'/ 2'/0'/0/0 | ltc1... |         |
-    | DOGE   | Legacy   | m/44'/ 3'/0'/0/0 | D...    |         |
+    | Crypto | Semantic | Path              | Address | Support |
+    |--------+----------+-------------------+---------+---------|
+    | ETH    | Legacy   | m/44'/ 60'/0'/0/0 | 0x...   |         |
+    | BNB    | Legacy   | m/44'/ 60'/0'/0/0 | 0x...   | Beta    |
+    | CRO    | Bech32   | m/44'/ 60'/0'/0/0 | crc1... | Beta    |
+    | BTC    | Legacy   | m/44'/  0'/0'/0/0 | 1...    |         |
+    |        | SegWit   | m/44'/  0'/0'/0/0 | 3...    |         |
+    |        | Bech32   | m/84'/  0'/0'/0/0 | bc1...  |         |
+    | LTC    | Legacy   | m/44'/  2'/0'/0/0 | L...    |         |
+    |        | SegWit   | m/44'/  2'/0'/0/0 | M...    |         |
+    |        | Bech32   | m/84'/  2'/0'/0/0 | ltc1... |         |
+    | DOGE   | Legacy   | m/44'/  3'/0'/0/0 | D...    |         |
+    | XRP    | Legacy   | m/44'/144'/0'/0/0 | r...    | Beta    |
 
     """
     CRYPTO_NAMES		= dict(				# Currently supported (in order of visibility)
@@ -187,9 +274,10 @@ class Account( hdwallet.HDWallet ):
         dogecoin	= 'DOGE',
         cronos		= 'CRO',
         binance		= 'BNB',
+        ripple		= 'XRP',
     )
     CRYPTOCURRENCIES		= set( CRYPTO_NAMES.values() )
-    CRYPTOCURRENCIES_BETA	= set( ('BNB', 'CRO') )
+    CRYPTOCURRENCIES_BETA	= set( ('BNB', 'CRO', 'XRP') )
 
     ETHJS_ENCRYPT		= set( ('ETH', 'CRO', 'BNB') )		# Can be encrypted w/ Ethereum JSON wallet
     BIP38_ENCRYPT		= CRYPTOCURRENCIES - ETHJS_ENCRYPT      # Can be encrypted w/ BIP-38
@@ -201,13 +289,18 @@ class Account( hdwallet.HDWallet ):
         DOGE		= "legacy",
         CRO		= "bech32",
         BNB		= "legacy",
+        XRP		= "legacy",
     )
 
-    # Any locally-defined python-hdwallet cryptocurrencies, and any that may require some
-    # adjustments when calling python-hdwallet address and other functions.
+    # Any locally-defined python-hdwallet classes, cryptocurrency definitions, and any that may
+    # require some adjustments when calling python-hdwallet address and other functions.
+    CRYPTO_WALLET_CLS		= dict(
+        XRP		= XRPHDWallet,
+    )
     CRYPTO_LOCAL		= dict(
         CRO		= CronosMainnet,
         BNB		= BinanceMainnet,
+        XRP		= RippleMainnet,
     )
     CRYPTO_LOCAL_SYMBOL		= dict(
         BNB		= "ETH"
@@ -237,7 +330,10 @@ class Account( hdwallet.HDWallet ):
             bech32	= "m/84'/2'/0'/0/0",
         ),
         DOGE		= dict(
-            legacy	="m/44'/3'/0'/0/0",
+            legacy	= "m/44'/3'/0'/0/0",
+        ),
+        XRP		= dict(
+            legacy	= "m/44'/144'/0'/0/0",
         )
     )
 
@@ -285,14 +381,16 @@ def supported( cls, crypto ):
 
     def __init__( self, crypto, format=None ):
         crypto			= Account.supported( crypto )
-        cryptocurrency		= self.CRYPTO_LOCAL.get( crypto, None )  # None, unless locally defined, above
+        cryptocurrency		= self.CRYPTO_LOCAL.get( crypto )
         self.format		= format.lower() if format else Account.address_format( crypto )
-        if self.format in ("legacy", "segwit",):
-            self.hdwallet	= hdwallet.BIP44HDWallet( symbol=crypto, cryptocurrency=cryptocurrency )
-        elif self.format in ("bech32",):
-            self.hdwallet	= hdwallet.BIP84HDWallet( symbol=crypto, cryptocurrency=cryptocurrency )
-        else:
+        hdwallet_cls		= self.CRYPTO_WALLET_CLS.get( crypto )
+        if hdwallet_cls is None and self.format in ("legacy", "segwit",):
+            hdwallet_cls	= hdwallet.BIP44HDWallet
+        if hdwallet_cls is None and self.format in ("bech32",):
+            hdwallet_cls	= hdwallet.BIP84HDWallet
+        if hdwallet_cls is None:
             raise ValueError( f"{crypto} does not support address format {self.format}" )
+        self.hdwallet		= hdwallet_cls( symbol=crypto, cryptocurrency=cryptocurrency )
 
     def from_seed( self, seed: str, path: str = None ) -> "Account":
         """Derive the Account from the supplied seed and (optionally) path; uses the default derivation path
@@ -305,6 +403,15 @@ def from_seed( self, seed: str, path: str = None ) -> "Account":
         self.from_path( path )
         return self
 
+    def from_mnemonic( self, mnemonic: str, path: str = None ) -> "Account":
+        """Derive the Account from the supplied BIP-39 mnemonic and (optionally) path; uses the
+        default derivation path for the Account address format, if None provided.
+
+        """
+        self.hdwallet.from_mnemonic( mnemonic )
+        self.from_path( path )
+        return self
+
     def from_path( self, path: str = None ) -> "Account":
         """Change the Account to derive from the provided path.
 
@@ -376,6 +483,10 @@ def path( self ):
     def key( self ):
         return self.hdwallet.private_key()
 
+    @property
+    def pubkey( self ):
+        return self.hdwallet.public_key()
+
     def from_private_key( self, private_key ):
         self.hdwallet.from_private_key( private_key )
         return self

images/XRP.svg

@@ -1,6 +1,7 @@
 # -*- mode: python ; coding: utf-8 -*-
 import json
 import pytest
+import codecs
 
 try:
     import eth_account
@@ -18,7 +19,7 @@
 from .			import account, create, addresses, addressgroups, accountgroups, Account
 from .recovery		import recover
 
-from .dependency_test	import substitute, nonrandom_bytes, SEED_XMAS
+from .dependency_test	import substitute, nonrandom_bytes, SEED_XMAS, SEED_ONES
 
 
 def test_account():
@@ -38,11 +39,20 @@ def test_account():
     acct			= account( SEED_XMAS, crypto='Bitcoin', format='Legacy' )
     assert acct.address == '19FQ983heQEBXmopVNyJKf93XG7pN7sNFa'
     assert acct.path == "m/44'/0'/0'/0/0"
+    assert acct.pubkey == '02d0bca9d976ad7303d1c0c3fd6ad0cb6bb78077d2ff158c16ac21bed763fb49a8'
 
     acct			= account( SEED_XMAS, crypto='Bitcoin', format='SegWit' )
     assert acct.address == '3HxUpD7E8Y31vDDgDq1VFdNXWViAgBjYJe'
     assert acct.path == "m/44'/0'/0'/0/0"
 
+    # And, confirm that we retrieve the same Bech32 address for the all-ones seed,
+    # as on a real Trezor "Model T".
+    acct			= account( SEED_ONES, crypto='Bitcoin' )
+    assert acct.address == 'bc1q9yscq3l2yfxlvnlk3cszpqefparrv7tk24u6pl'
+    assert acct.path == "m/84'/0'/0'/0/0"
+    assert acct.pubkey == '038f7fa5776f5359eb861994bee043f0b16a5ca24b66eb38696a7325d3e1717e72'
+
+
     acct			= account( SEED_XMAS, crypto='Litecoin' )
     assert acct.address == 'ltc1qfjepkelqd3jx4e73s7p79lls6kqvvmak5pxy97'
     assert acct.path == "m/84'/2'/0'/0/0"
@@ -60,6 +70,31 @@ def test_account():
     assert acct.path == "m/44'/3'/0'/0/0"
 
 
+    acct			= account( SEED_ONES, crypto='Ripple' )
+    assert acct.path == "m/44'/144'/0'/0/0"  # Default
+    assert acct.address == 'rsXwvDVHHPrSm23gogdxJdrJg9WBvqRE9m'
+
+    # Fake up some known Ripple pubkey --> addresses, by replacing the underlying "compressed"
+    # public key function to return a fixed value.  Test values from:
+    # trezor-firmware/core/tests/test_apps.ripple.address.py
+    compressed_save		= acct.hdwallet.compressed
+    acct.hdwallet.compressed	= lambda: 'ed9434799226374926eda3b54b1b461b4abf7237962eae18528fea67595397fa32'
+    assert acct.pubkey == 'ed9434799226374926eda3b54b1b461b4abf7237962eae18528fea67595397fa32'
+    assert acct.address == 'rDTXLQ7ZKZVKz33zJbHjgVShjsBnqMBhmN'
+    acct.hdwallet.compressed	= lambda: '03e2b079e9b09ae8916da8f5ee40cbda9578dbe7c820553fe4d5f872eec7b1fdd4'
+    assert acct.address == 'rhq549rEtUrJowuxQC2WsHNGLjAjBQdAe8'
+    acct.hdwallet.compressed	= lambda: '0282ee731039929e97db6aec242002e9aa62cd62b989136df231f4bb9b8b7c7eb2'    
+    assert acct.address == 'rKzE5DTyF9G6z7k7j27T2xEas2eMo85kmw'
+    acct.hdwallet.compressed	= compressed_save
+
+    # Test values from a Trezor "Model T" w/ root seed 'zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo wrong' loaded.
+    # The Trezor Suite UI produced the following account derivation path and public address for:
+    acct.from_mnemonic( 'zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo wrong' )
+    assert acct.path == "m/44'/144'/0'/0/0"  # Default
+    assert acct.address == 'rUPzi4ZwoYxi7peKCqUkzqEuSrzSRyLguV'  # From Trezor "Model T" w/ 
+    assert acct.pubkey == '039d65db4964cbf2049ad49467a6b73e7fec7d6e6f8a303cfbdb99fa21c7a1d2bc'
+
+
 @pytest.mark.skipif( not scrypt or not eth_account,
                      reason="pip install slip39[wallet] to support private key encryption" )
 def test_account_encrypt():
@@ -135,6 +170,20 @@ def test_account_encrypt():
         'something'
     ).address == 'bc1qk0a9hr7wjfxeenz9nwenw9flhq0tmsf6vsgnn2'
 
+    # Ripple BIP-38 encrypted wallets.  Should round-trip via BIP-38
+    acct_xrp = Account( crypto='XRP' )
+    acct_xrp.from_mnemonic( 'zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo wrong' )
+    assert acct_xrp.path == "m/44'/144'/0'/0/0"  # Default
+    assert acct_xrp.address == 'rUPzi4ZwoYxi7peKCqUkzqEuSrzSRyLguV'  # From Trezor "Model T" w/
+    assert acct_xrp.pubkey == '039d65db4964cbf2049ad49467a6b73e7fec7d6e6f8a303cfbdb99fa21c7a1d2bc'
+    acct_xrp_encrypted		= acct_xrp.encrypted( 'password' )
+    assert acct_xrp_encrypted == '6PYTRxHt4sPM9i6zagBJ4pWdaefJ1FfVQwFCWQxDhVBw7fJYpYP3kMPfro'
+
+    acct_dec			= Account( crypto='XRP' ).from_encrypted( acct_xrp_encrypted, 'password' )
+    acct_dec.path == "m/44'/144'/0'/0/0"
+    assert acct_dec.address == 'rUPzi4ZwoYxi7peKCqUkzqEuSrzSRyLguV'
+    assert acct_dec.pubkey == '039d65db4964cbf2049ad49467a6b73e7fec7d6e6f8a303cfbdb99fa21c7a1d2bc'
+
 
 @substitute( shamir_mnemonic.shamir, 'RANDOM_BYTES', nonrandom_bytes )
 def test_create():