Merge branch 'feature-generator'

Author: pjkundert

.github/workflows/main.yml

@@ -0,0 +1,42 @@
+# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: Python package
+
+on:
+  push:
+    branches:
+      - master
+      - feature-**
+      - fix-**
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        # Requires Python3 w/ Type Annotations
+        python-version: [3.9, 3.x]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python3 -m pip install --upgrade pip
+        python3 -m pip install wheel
+        if [ -f requirements.txt ]; then python3 -m pip install -r requirements.txt; fi
+        python3 -m pip install flake8 pytest
+    - name: Lint with flake8
+      run: |
+        make analyze || true
+    - name: Test with pytest
+      run: |
+        make test

GNUmakefile

@@ -33,7 +33,7 @@ doctest:
 
 analyze:
 	flake8 -j 1 --max-line-length=200 \
-	  --ignore=E201,E202,E221,E223,E226,E231,E242,E251,E265,E272,E274 \
+	  --ignore=W503,E201,E202,E221,E223,E226,E231,E242,E251,E265,E272,E274 \
 	  slip39
 
 pylint:

README.org

@@ -0,0 +1 @@
+eth-account

README.pdf

@@ -1,5 +1,7 @@
-shamir-mnemonic
-eth-account
-hdwallet
+chacha20poly1305>=0.0.3
 fpdf2
+hdwallet
+mnemonic>=0.19,<1
+pyserial>=3.5
 qrcode
+shamir-mnemonic

images/slip39-pdf.png

@@ -17,7 +17,8 @@
 
 console_scripts			= [
     'slip39		= slip39.main:main',
-    'slip39-recovery	= slip39.recovery.__main__:main',
+    'slip39-recovery	= slip39.recovery.main:main',
+    'slip39-generator	= slip39.generator.main:main',
 ]
 
 entry_points			= {
@@ -30,6 +31,7 @@
 package_dir			= {
     "slip39":			"./slip39",
     "slip39.recovery":		"./slip39/recovery",
+    "slip39.generator":		"./slip39/generator",
 }
 
 long_description_content_type	= 'text/markdown'
@@ -141,5 +143,5 @@
     keywords			= "Ethereum cryptocurrency SLIP39 BIP39 seed recovery",
     url				= "https://github.com/pjkundert/python-slip39",
     classifiers			= classifiers,
-    python_requires		= ">=3.6",
+    python_requires		= ">=3.9",
 )

requirements-optional.txt

@@ -2,4 +2,3 @@
 from .types	import *				# noqa F403
 from .api	import *				# noqa F403
 from .recovery  import *				# noqa F403
-from .main	import *				# noqa F403

requirements.txt

@@ -1,6 +1,7 @@
-import codecs
 import itertools
 import logging
+import math
+import re
 import secrets
 
 from collections	import namedtuple
@@ -9,7 +10,7 @@
 from shamir_mnemonic	import generate_mnemonics
 
 from .types		import Account
-from .defaults		import BITS_DEFAULT, BITS, MNEM_ROWS_COLS, cryptocurrency_supported
+from .defaults		import BITS_DEFAULT, BITS, MNEM_ROWS_COLS, GROUP_REQUIRED_RATIO
 from .util		import ordinal
 
 
@@ -22,7 +23,10 @@ def path_parser(
     paths: str,
     allow_unbounded: bool	= True,
 ) -> Tuple[str, Dict[str, Callable[[], int]]]:
-    """Create a format and a dictionary of iterators to feed into it."""
+    """Create a format and a dictionary of iterators to feed into it.
+
+    Supports paths with an arbitrary prefix, eg. 'm/' or '.../'
+    """
     path_segs			= paths.split( '/' )
     unbounded			= False
     ranges			= {}
@@ -156,6 +160,37 @@ def organize_mnemonic( mnemonic, rows=None, cols=None, label="" ):
         yield line,words
 
 
+def group_parser( group_spec ):
+    """Parse a SLIP-39 group specification.
+
+        Fren6, Fren 6, Fren(6)	- A 3/6 group (default is 1/2 of group size, rounded up)
+        Fren2/6, Fren(2/6)	- A 2/6 group
+
+    """
+    match			= group_parser.RE.match( group_spec )
+    if not match:
+        raise ValueError( f"Invalid group specification: {group_spec!r}" )
+    name			= match.group( 'name' )
+    size			= match.group( 'size' )
+    require			= match.group( 'require' )
+    if not size:
+        size			= 1
+    if not require:
+        # eg. default 2/4, 3/5
+        require			= math.ceil( int( size ) * GROUP_REQUIRED_RATIO )
+    return name,(int(require),int(size))
+group_parser.RE			= re.compile( # noqa E305
+    r"""^
+        \s*
+        (?P<name> [^\d\(/]+ )
+        \s*\(?\s*
+        (:? (?P<require> \d* ) \s* / )?
+        \s*
+        (?P<size> \d* )
+        \s*\)?\s*
+        $""", re.VERBOSE )
+
+
 def create(
     name: str,
     group_threshold: int,
@@ -233,35 +268,36 @@ def mnemonics(
 def account(
     master_secret: Union[str,bytes],
     crypto: str			= None,  # default 'ETH'
-    path: str			= None,  # default to the crypto's DEFAULT_PATH
+    path: str			= None,  # default to the crypto's path_default
+    format: str			= None,  # eg. 'bech32', or use the default address format for the crypto
 ):
     """Generate an HD wallet Account from the supplied master_secret seed, at the given HD derivation
     path, for the specified cryptocurrency.
 
     """
-    if type( master_secret ) is bytes:
-        master_secret		= codecs.encode( master_secret, 'hex_codec' ).decode( 'ascii' )
     acct			= Account(
-        symbol		= cryptocurrency_supported( crypto or 'ETH' )
+        crypto		= crypto or 'ETH',
+        format		= format,
     ).from_seed(
-        seed		= master_secret
-    )
-    return acct.from_path(
-        path		= path or acct._cryptocurrency.DEFAULT_PATH
+        seed		= master_secret,
+        path		= path,
     )
+    return acct
 
 
 def accounts(
     master_secret: Union[str,bytes],
     crypto: str			= None,  # default 'ETH'
-    paths: str			= None,  # default to the crypto's DEFAULT_PATH; allow ranges
+    paths: str			= None,  # default to the crypto's path_default; allow ranges
+    format: str			= None,
     allow_unbounded		= True,
 ):
+    """Create accounts for crypto, at the provided paths (allowing ranges), with the optionsal address format. """
     for path in [None] if paths is None else path_sequence( *path_parser(
         paths		= paths,
         allow_unbounded	= allow_unbounded,
     )):
-        yield account( master_secret, crypto, path )
+        yield account( master_secret, crypto=crypto, path=path, format=format )
 
 
 def accountgroups(
@@ -305,27 +341,30 @@ def address(
     master_secret: bytes,
     crypto: str			= None,
     path: str			= None,
+    format: str			= None,
 ):
     """Return the specified cryptocurrency HD account address at path."""
     return account(
         master_secret,
         path		= path,
-        crypto		= cryptocurrency_supported( crypto or 'ETH' ),
+        crypto		= crypto,
+        format		= format,
     ).address
 
 
 def addresses(
     master_secret: bytes,
     crypto: str	 		= None,  # default 'ETH'
-    paths: str			= None,  # default: The crypto's DEFAULT_PATH; supports ranges
+    paths: str			= None,  # default: The crypto's path_default; supports ranges
+    format: str			= None,
     allow_unbounded: bool	= True,
 ):
     """Generate a sequence of cryptocurrency account (path, address, ...)  for all designated
     cryptocurrencies.  Usually a single (<path>, <address>) tuple is desired (different
     cryptocurrencies typically have their own unique path derivations.
 
     """
-    for acct in accounts( master_secret, crypto, paths, allow_unbounded=allow_unbounded ):
+    for acct in accounts( master_secret, crypto, paths, format, allow_unbounded=allow_unbounded ):
         yield (acct.crypto, acct.path, acct.address)