Moved SLIP-39 backup of BIP-39 en/decoding into create; pass unit tests

o Ensure that default derivation path is available in from_...

Author: pjkundert

README.org

@@ -107,17 +107,17 @@ by entering the mnemonics right on the device.
    The account owner might store their First and Second group data in their home and office safes.
    These are 1/1 groups (1 required, and only 1 member, so each of these are3 1-card groups.)
 
-   If the seed needs to be recovered, collecting the First and Second cards from the home and
-   office safe is sufficient to recover the seed, and re-generate all of the HD Wallet accounts.
+   If the Seed needs to be recovered, collecting the First and Second cards from the home and
+   office safe is sufficient to recover the Seed, and re-generate all of the HD Wallet accounts.
 
    Only 2 Fam group member's cards must be collected to recover the Fam group's data.  So, if the HD
    Wallet owner loses their home (and the one and only First group card) in a fire, they could get
    the one Second group card from the office safe, and also 2 cards from Fam group members, and
-   recover the seed and all of their wallets.
+   recover the Seed and all of their wallets.
 
    If catastrophe strikes and the wallet owner dies, and the heirs don't have access to either the
    First (at home) or Second (at the office) cards, they can collect 2 Fam cards and 3 Frens cards
-   (at the funeral, for example), completing the Fam and Frens groups' data, and recover the seed,
+   (at the funeral, for example), completing the Fam and Frens groups' data, and recover the Seed,
    and all derived HD Wallet accounts.
 
    Since Frens are less likely to persist long term, we'll produce more (6) of these cards.
@@ -127,8 +127,8 @@ by entering the mnemonics right on the device.
 
 * SLIP-39 Account Creation, Recovery and Address Generation
 
-  Generating a new SLIP-39 encoded seed is easy, with results available as PDF and text.  Any number
-  of derived HD wallet account addresses can be generated from this seed, and the seed (and all
+  Generating a new SLIP-39 encoded Seed is easy, with results available as PDF and text.  Any number
+  of derived HD wallet account addresses can be generated from this Seed, and the Seed (and all
   derived HD wallets, for all cryptocurrencies) can be recovered by collecting the desired groups of
   recover card phrases.  The default recovery groups are as described above.
 
@@ -141,7 +141,7 @@ by entering the mnemonics right on the device.
    [[./images/slip39-cards.png]]
 
    Run the following to obtain a PDF file containing business cards with the default SLIP-39 groups for
-   a new account seed named "Personal"; insert a USB drive to collect the output, and run:
+   a new account Seed named "Personal"; insert a USB drive to collect the output, and run:
 
    #+LATEX: {\scriptsize
    #+BEGIN_EXAMPLE
@@ -192,12 +192,12 @@ by entering the mnemonics right on the device.
 
 *** Supported Cryptocurrencies
 
-    While the SLIP-39 seed is not cryptocurrency-specific (any wallet for any cryptocurrency can be
+    While the SLIP-39 Seed is not cryptocurrency-specific (any wallet for any cryptocurrency can be
     derived from it), each type of cryptocurrency has its own standard derivation path
     (eg. =m/44'/3'/0'/0/0= for DOGE), and its own address representation (eg. Bech32 at
     =m/84'/0'/0'/0/0= for BTC eg. =bc1qcupw7k8enymvvsa7w35j5hq4ergtvus3zk8a8s=.
 
-    When you import your SLIP-39 seed into a Trezor, you gain access to all derived HD
+    When you import your SLIP-39 Seed into a Trezor, you gain access to all derived HD
     cryptocurrency wallets supported directly by that hardware wallet, and *indirectly*, to any coin
     and/or blockchain network supported by any wallet software (eg. Metamask).
 
@@ -255,7 +255,7 @@ by entering the mnemonics right on the device.
 
 ** The Python =slip39= CLI
 
-   From the command line, you can create SLIP-39 seed Mnemonic card PDFs.
+   From the command line, you can create SLIP-39 Seed Mnemonic card PDFs.
 
 *** =slip39= Synopsis
 

slip39/api.py

@@ -11,7 +11,7 @@
 
 from functools		import wraps
 from collections	import namedtuple
-from typing		import Dict, List, Sequence, Tuple, Union, Callable
+from typing		import Dict, List, Sequence, Tuple, Optional, Union, Callable
 
 from shamir_mnemonic	import generate_mnemonics
 
@@ -20,6 +20,7 @@
 
 from .defaults		import BITS_DEFAULT, BITS, MNEM_ROWS_COLS, GROUP_REQUIRED_RATIO, CRYPTO_PATHS
 from .util		import ordinal
+from .recovery		import produce_bip39, recover_bip39
 
 log				= logging.getLogger( __package__ )
 
@@ -72,7 +73,7 @@ def path_edit(
     if edit.startswith( '.' ):
         new_segs	= edit.lstrip( './' ).split( '/' )
         cur_segs	= path.split( '/' )
-        log.info( f"Using {edit} to replace last {len(new_segs)} of {path} with {'/'.join(new_segs)}" )
+        log.debug( f"Using {edit} to replace last {len(new_segs)} of {path} with {'/'.join(new_segs)}" )
         if len( new_segs ) >= len( cur_segs ):
             raise ValueError( f"Cannot use {edit} to replace last {len(new_segs)} of {path} with {'/'.join(new_segs)}" )
         res_segs	= cur_segs[:len(cur_segs)-len(new_segs)] + new_segs
@@ -267,7 +268,7 @@ class Account:
     | XRP    | Legacy   | m/44'/144'/0'/0/0 | r...    | Beta    |
 
     """
-    CRYPTO_NAMES		= dict(				# Currently supported (in order of visibility)
+    CRYPTO_NAMES		= dict(  # Currently supported (in order of visibility)
         ethereum	= 'ETH',
         bitcoin		= 'BTC',
         litecoin	= 'LTC',
@@ -371,14 +372,26 @@ def supported( cls, crypto ):
         for it, or raises an a ValueError.  Eg. "Ethereum" --> "ETH"
 
         """
-        validated			= cls.CRYPTO_NAMES.get(
+        validated		= cls.CRYPTO_NAMES.get(
             crypto.lower(),
             crypto.upper() if crypto.upper() in cls.CRYPTOCURRENCIES else None
         )
         if validated:
             return validated
         raise ValueError( f"{crypto} not presently supported; specify {', '.join( cls.CRYPTOCURRENCIES )}" )
 
+    def __str__( self ):
+        """Until from_seed/from_path are invoked, may not have an address or derivation path."""
+        address			= None
+        try:
+            address		= self.address
+        except Exception:
+            pass
+        return f"{self.crypto}: {address}"
+
+    def __repr__( self ):
+        return f"{self.__class__.__name__}({self} @{self.path})"
+
     def __init__( self, crypto, format=None ):
         crypto			= Account.supported( crypto )
         cryptocurrency		= self.CRYPTO_LOCAL.get( crypto )
@@ -416,15 +429,14 @@ def from_path( self, path: str = None ) -> "Account":
         """Change the Account to derive from the provided path.
 
         If a partial path is provided (eg "...1'/0/3"), then use it to replace the given segments in
-        current account path, leaving the remainder alone.
+        current (or the default) account path, leaving the remainder alone.
 
         """
+        from_path		= self.path or Account.path_default( self.crypto, self.format )
         if path:
-            path		= path_edit( self.path, path )
-        else:
-            path		= Account.path_default( self.crypto, self.format )
+            from_path		= path_edit( from_path, path )
         self.hdwallet.clean_derivation()
-        self.hdwallet.from_path( path )
+        self.hdwallet.from_path( from_path )
         return self
 
     @property
@@ -656,15 +668,19 @@ def path_sequence(
 
 
 def cryptopaths_parser( cryptocurrency, edit=None ):
-    """
-    Generate a standard cryptopaths list, from the given list of "<crypto>[:<paths>]"
-    cryptocurrencies (default: CRYPTO_PATHS).
+    """Generate a standard cryptopaths list, from the given sequnce of (<crypto>,<paths>) or
+    "<crypto>[:<paths>]" cryptocurrencies (default: CRYPTO_PATHS).
 
-    Adjusts the provided derivation paths by an optional eg. "../-" path adjustment."""
+    Adjusts the provided derivation paths by an optional eg. "../-" path adjustment.
+
+    """
     cryptopaths 		= []
     for crypto in cryptocurrency or CRYPTO_PATHS:
         try:
-            crypto,paths	= crypto.split( ':' )
+            if type(crypto) is str:
+                crypto,paths	= crypto.split( ':' )   # A sequence of str
+            else:
+                crypto,paths	= crypto                # A sequence of tuples
         except ValueError:
             crypto,paths	= crypto,None
         crypto			= Account.supported( crypto )
@@ -770,33 +786,65 @@ def create(
     name: str,
     group_threshold: int,
     groups: Dict[str,Tuple[int, int]],
-    master_secret: bytes	= None,		# Default: 128-bit seeds
+    master_secret: bytes	= None,	        # Default: 128-bit seeds
     passphrase: bytes		= b"",
+    using_bip39: bool		= False,        # Generate wallet Seed from master_secret Entropy using BIP-39 generation
     iteration_exponent: int	= 1,
-    cryptopaths: Sequence[Tuple[str,str]] = None,  # default: ETH, BTC at default paths
+    cryptopaths: Optional[Sequence[Union[str,Tuple[str,str]]]] = None,  # default: ETH, BTC at default paths
     strength: int		= 128,
 ) -> Tuple[str,int,Dict[str,Tuple[int,List[str]]], Sequence[Sequence[Account]]]:
-    """Creates a SLIP-39 encoding and 1 or more Ethereum accounts.  Returns the details, in a form
-    directly compatible with the layout.produce_pdf API.
+    """Creates a SLIP-39 encoding for supplied master_secret Entropy, and 1 or more Cryptocurrency
+    accounts.  Returns the details, in a form directly compatible with the layout.produce_pdf API.
+
+    Creates accountgroups derived from the Seed Entropy.  By default, this is done in the SLIP-39
+    standard, using the master_secret Entropy directly.  If a passphrase is supplied, this is also
+    used in the SLIP-39 standard fashion (not recommended -- not Trezor "Model T" compatible).
+
+    If using_bip39, creates the Cryptocurrency accountgroups from the supplied master_secret
+    Entropy, but by generating the Seed from a BIP-38 Mnemonic produced from the provided entropy
+    (or generated, default 128 bits), plus the supplied passphrase.
 
     """
+
     if master_secret is None:
         assert strength in BITS, f"Invalid {strength}-bit secret length specified"
         master_secret		= random_secret( strength // 8 )
+
     g_names,g_dims		= list( zip( *groups.items() ))
+
+    # Derive the desired account(s) at the specified derivation paths, or the default, using either
+    # BIP-39 Seed generation, or directly from Entropy for SLIP-39.
+    if using_bip39:
+        # For BIP-39, the passphrase is consumed here, and Cryptocurrency accounts are generated
+        # using the BIP-39 Seed generated from entropy + passphrase
+        bip39_mnem		= produce_bip39( entropy=master_secret )
+        bip39_seed		= recover_bip39(
+            mnemonic	= bip39_mnem,
+            passphrase	= passphrase,
+        )
+        accts			= list( accountgroups(
+            master_secret	= bip39_seed,
+            cryptopaths		= cryptopaths,
+            allow_unbounded	= False,
+        ))
+        passphrase		= b""
+    else:
+        # For SLIP-39, accounts are generated directly from supplied Entropy, and passphrase
+        # encrypts the SLIP-39 Mnemonics, below.
+        accts			= list( accountgroups(
+            master_secret	= master_secret,
+            cryptopaths		= cryptopaths,
+            allow_unbounded	= False,
+        ))
+
+    # Generate the SLIP-39 Mnemonics representing the supplied
     mnems			= mnemonics(
         group_threshold	= group_threshold,
         groups		= g_dims,
         master_secret	= master_secret,
         passphrase	= passphrase,
         iteration_exponent= iteration_exponent
     )
-    # Derive the desired account(s) at the specified derivation paths, or the default
-    accts			= list( accountgroups(
-        master_secret	= master_secret,
-        cryptopaths	= cryptopaths or [('ETH',None), ('BTC',None)],
-        allow_unbounded	= False,
-    ))
 
     groups			= {
         g_name: (g_of, g_mnems)
@@ -859,6 +907,7 @@ def account(
         seed		= master_secret,
         path		= path,
     )
+    log.debug( f"Created {acct} from {len(master_secret)*8}-bit seed, at derivation path {path}" )
     return acct
 
 
@@ -879,7 +928,7 @@ def accounts(
 
 def accountgroups(
     master_secret: bytes,
-    cryptopaths: Sequence[Tuple[str,str]],
+    cryptopaths: Optional[Sequence[Union[str,Tuple[str,str]]]] = None,  # Default: ETH, BTC
     allow_unbounded: bool	= True,
 ) -> Sequence[Sequence[Account]]:
     """Generate the desired cryptocurrency account(s) at each crypto's given path(s).  This is useful
@@ -910,7 +959,7 @@ def accountgroups(
             crypto		= crypto,
             allow_unbounded	= allow_unbounded,
         )
-        for crypto,paths in cryptopaths
+        for crypto,paths in cryptopaths_parser( cryptopaths )
     ])
 
 
@@ -947,7 +996,7 @@ def addresses(
 
 def addressgroups(
     master_secret: bytes,
-    cryptopaths: Sequence[Tuple[str,str]],
+    cryptopaths: Optional[Sequence[Union[str,Tuple[str,str]]]] = None,  # Default ETH, BTC
     allow_unbounded: bool	= True,
 ) -> Sequence[str]:
     """Yields account (<crypto>, <path>, <address>) records for the desired cryptocurrencies at paths.
@@ -960,5 +1009,5 @@ def addressgroups(
             crypto		= crypto,
             allow_unbounded	= allow_unbounded,
         )
-        for crypto,paths in cryptopaths
+        for crypto,paths in cryptopaths_parser( cryptopaths )
     ])