Add Beta support for BNB, CRO

pjkundert · pjkundert · commit 8a0e197eb3f3 · 2022-03-10T14:54:11.000-07:00
o Fix PDF output from python -m slip39, borken when printing added
diff --git a/App.pdf b/App.pdf
diff --git a/README.org b/README.org
diff --git a/README.pdf b/README.pdf
diff --git a/README.txt b/README.txt
diff --git a/SLIP-39-macOS.spec b/SLIP-39-macOS.spec
@@ -50,9 +50,9 @@ coll = COLLECT(exe,
 app = BUNDLE(coll,
              name='SLIP-39.app',
              icon='images/SLIP-39.icns',
-             version='8.1.2',
+             version='8.2.0',
              info_plist={
-                 'CFBundleVersion':'8.1.2',
+                 'CFBundleVersion':'8.2.0',
                  'CFBundlePackageType':'APPL',
                  'LSApplicationCategoryType':'public.app-category.finance',
                  'LSMinimumSystemVersion':'10.15.0',
diff --git a/slip39/api.py b/slip39/api.py
@@ -148,22 +148,21 @@ class Account( hdwallet.HDWallet ):
     """Supports producing Legacy addresses for Bitcoin, and Litecoin.  Doge (D...) and Ethereum (0x...)
     addresses use standard BIP44 derivation.
 
-    | Crypto | Semantic | Path             | Address |
-    |        |          |                  | <       |
-    |--------+----------+------------------+---------|
-    | ETH    | Legacy   | m/44'/60'/0'/0/0 | 0x...   |
-    | BNB    | Legacy   | m/44'/60'/0'/0/0 | 0x...   |
-    | CRO    | Bech32   | m/44'/60'/0'/0/0 | crc1... |
-    | 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...    |         |
 
     """
-    CRYPTO_NAMES		= dict(				# Currently supported
+    CRYPTO_NAMES		= dict(				# Currently supported (in order of visibility)
         ethereum	= 'ETH',
         bitcoin		= 'BTC',
         litecoin	= 'LTC',
@@ -172,17 +171,18 @@ class Account( hdwallet.HDWallet ):
         binance		= 'BNB',
     )
     CRYPTOCURRENCIES		= set( CRYPTO_NAMES.values() )
+    CRYPTOCURRENCIES_BETA	= set( ('BNB', 'CRO') )
 
     ETHJS_ENCRYPT		= set( ('ETH', 'CRO', 'BNB') )		# Can be encrypted w/ Ethereum JSON wallet
     BIP38_ENCRYPT		= CRYPTOCURRENCIES - ETHJS_ENCRYPT      # Can be encrypted w/ BIP-38
 
     CRYPTO_FORMAT		= dict(
         ETH		= "legacy",
-        BNB		= "legacy",
-        CRO		= "bech32",
         BTC		= "bech32",
         LTC		= "bech32",
         DOGE		= "legacy",
+        CRO		= "bech32",
+        BNB		= "legacy",
     )
 
     # Any locally-defined python-hdwallet cryptocurrencies, and any that may require some
diff --git a/slip39/generator/main.py b/slip39/generator/main.py
@@ -85,7 +85,9 @@ def main( argv=None ):
                      help="Use the supplied 128-, 256- or 512-bit hex value as the secret seed; '-' (default) reads it from stdin (eg. output from slip39.recover)" )
     ap.add_argument( '-f', '--format', action='append',
                      default=[],
-                     help=f"Specify crypto address formats: {', '.join( Account.FORMATS )}; default {', '.join( f'{c}:{Account.address_format(c)}' for c in sorted(Account.CRYPTOCURRENCIES))}" )
+                     help=f"Specify crypto address formats: {', '.join( Account.FORMATS )}; default: " +', '.join(
+                         f'{c}:{Account.address_format(c)}' for c in Account.CRYPTO_NAMES.values()
+                     ))
     ap.add_argument( '-c', '--cryptocurrency', action='append',
                      default=[],
                      help="A crypto name and optional derivation path (default: \"ETH:{Account.path_default('ETH')}\"), optionally w/ ranges, eg: ETH:../0/-" )
diff --git a/slip39/gui/SLIP-39-CRYPTO.org b/slip39/gui/SLIP-39-CRYPTO.org
@@ -8,8 +8,28 @@ On each SLIP-39 card, up to 2 Wallet addresses and QR codes will be displayed, f
 purposes only, to illustrate *which* Wallets are derived from this Seed.  The cryptocurrencies
 supported, and the standard BIP-44 derivation paths (Trezor compatible) displayed are:
 
-| BTC  | m/84'/0'/0'/0/0 (Bech32) |
-| ETH  | m/44'/60'/0'/0/0         |
-| LTC  | m/44'/2'/0'/0/0          |
-| DOGE | m/44'/3'/0'/0/0          |
+* Cryptocurrencies Supported
+
+  | 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...    |         |
+
+
+** Cryptocurrencies In Beta Testing
+
+   The BNB and CRO wallet addresses are also supported, if desired (currently in Beta testing
+   quality).  Generated Paper Wallets should be /tested/ to ensure that generated and recovered
+   private keys are valid.
+
+
+
 #+END_ABSTRACT
diff --git a/slip39/gui/SLIP-39-CRYPTO.txt b/slip39/gui/SLIP-39-CRYPTO.txt
@@ -1,12 +1,37 @@
-Cryptocurrencies Wallet addresses to display, and Paper Wallets to
-produce (if password supplied).
+#+BEGIN_ABSTRACT Cryptocurrencies Wallet addresses to display, and Paper
+Wallets to produce (if password supplied).
 
 On each SLIP-39 card, up to 2 Wallet addresses and QR codes will be
 displayed, for information purposes only, to illustrate *which* Wallets
 are derived from this Seed.  The cryptocurrencies supported, and the
 standard BIP-44 derivation paths (Trezor compatible) displayed are:
 
- BTC   m/84'/0'/0'/0/0 (Bech32) 
- ETH   m/44'/60'/0'/0/0         
- LTC   m/44'/2'/0'/0/0          
- DOGE  m/44'/3'/0'/0/0          
+
+1 Cryptocurrencies Supported
+============================
+
+   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...             
+
+
+1.1 Cryptocurrencies In Beta Testing
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+  The BNB and CRO wallet addresses are also supported, if desired
+  (currently in Beta testing quality).  Generated Paper Wallets should
+  be /tested/ to ensure that generated and recovered private keys are
+  valid.
+
+
+
+  #+END_ABSTRACT
diff --git a/slip39/gui/main.py b/slip39/gui/main.py
@@ -126,6 +126,13 @@ def groups_layout(
     LO				= LAYOUT_OPTIONS[controls] if controls is not None else LAYOUT
     LO_REC			= LO != LAYOUT_OPTIONS[0]		# True iff LO == Recover or Pro
     LO_PRO			= LO == LAYOUT_OPTIONS[-1]		# True iff LO == Pro
+
+    CRYPTO_DISPLAY		= list(
+        symbol
+        for symbol in Account.CRYPTO_NAMES.values()  # Retains desired ordering (vs. CRYPTOCURRENCIES set)
+        if LO_PRO or symbol not in Account.CRYPTOCURRENCIES_BETA
+    )
+
     layout                      = [
         [
             sg.Frame( '1. Name(s) and formats of SLIP-39 Cards for output PDF File(s)', [
@@ -271,8 +278,7 @@ def groups_layout(
                             for c in c_row
                         ]
                         for c_row in chunker(
-                            list( Account.CRYPTO_NAMES.values() ),  # Retain ordering vs. CRYPTOCURRENCIES set
-                            int( round( math.sqrt( len( Account.CRYPTOCURRENCIES )) + .5 ))
+                            CRYPTO_DISPLAY, int( round( math.sqrt( len( CRYPTO_DISPLAY )) + .25 ))
                         )
                     ],                                                          visible=LO_REC )
                 ] + [
@@ -1169,8 +1175,9 @@ def main( argv=None ):
                      help="A group name[[<require>/]<size>] (default: <size> = 1, <require> = half of <size>, rounded up, eg. 'Frens(3/5)' )." )
     ap.add_argument( '-c', '--cryptocurrency', action='append',
                      default=[],
-                     help="A crypto name and optional derivation path ('../<range>/<range>' allowed); defaults:"
-                     f" {', '.join( f'{c}:{Account.path_default(c)}' for c in Account.CRYPTOCURRENCIES)}" )
+                     help="A crypto name and optional derivation path ('../<range>/<range>' allowed); defaults:" + ', '.join(
+                         f'{c}:{Account.path_default(c)}' for c in Account.CRYPTO_NAMES.values()
+                     ))
     ap.add_argument( '-p', '--path',
                      default=None,
                      help="Modify all derivation paths by replacing the final segment(s) w/ the supplied range(s), eg. '.../1/-' means .../1/[0,...)")
diff --git a/slip39/layout/__init__.py b/slip39/layout/__init__.py
@@ -643,7 +643,7 @@ def write_pdfs(
     card_format		= None,		# Eg. "credit"; False outputs no SLIP-39 Mnemonic cards to PDF
     paper_format	= None,		# Eg. "Letter", "Legal", (x,y)
     filename		= None,		# A file name format w/ {path}, etc. formatters
-    filepath		= None,		# A file path, if PDF output to file is desired; empty implies current dir.
+    filepath		= True,		# A file path, if PDF output to file is desired; ''/True implies current dir.
     printer		= None,		# A printer name (or True for default), if output to printer is desired
     json_pwd		= None,		# If JSON wallet output desired, supply password
     text		= None,		# Truthy outputs SLIP-39 recover phrases to stdout
@@ -894,8 +894,10 @@ def write_pdfs(
                     pdf.image( qrcode.make( json_str ).get_image(), h=min(pdf.eph, pdf.epw)/2, w=min(pdf.eph, pdf.epw)/2 )
 
         if pdf:
-            if filepath is not None:  # empty path implies current dir.
-                pdf_path	= os.path.join( filepath, pdf_name ) if filepath else pdf_name
+            if filepath is not None:  # ''/True path implies current dir.
+                if filepath is True:
+                    filepath	= ''
+                pdf_path		= os.path.join( filepath, pdf_name ) if filepath else pdf_name
                 log.warning( f"Writing SLIP39-encoded wallet for {name!r} to: {pdf_path}" )
                 pdf.output( pdf_path )
             if printer is not None:  # if True, uses "default" printer
diff --git a/slip39/main.py b/slip39/main.py
@@ -37,10 +37,14 @@ def main( argv=None ):
                      help="A group name[[<require>/]<size>] (default: <size> = 1, <require> = half of <size>, rounded up, eg. 'Frens(3/5)' )." )
     ap.add_argument( '-f', '--format', action='append',
                      default=[],
-                     help=f"Specify crypto address formats: {', '.join( Account.FORMATS )}; default {', '.join( f'{c}:{Account.address_format(c)}' for c in sorted(Account.CRYPTOCURRENCIES))}" )
+                     help=f"Specify crypto address formats: {', '.join( Account.FORMATS )}; default: " + ', '.join(
+                         f'{c}:{Account.address_format(c)}' for c in Account.CRYPTO_NAMES.values()
+                     ))
     ap.add_argument( '-c', '--cryptocurrency', action='append',
                      default=[],
-                     help=f"A crypto name and optional derivation path (eg. '../<range>/<range>'); defaults: {', '.join( f'{c}:{Account.path_default(c)}' for c in sorted(Account.CRYPTOCURRENCIES))}" )
+                     help=f"A crypto name and optional derivation path (eg. '../<range>/<range>'); defaults: " + ', '.join(
+                         f'{c}:{Account.path_default(c)}' for c in Account.CRYPTO_NAMES.values()
+                     ))
     ap.add_argument( '-p', '--path',
                      default=None,
                      help="Modify all derivation paths by replacing the final segment(s) w/ the supplied range(s), eg. '.../1/-' means .../1/[0,...)")
@@ -158,9 +162,9 @@ def main( argv=None ):
             group_threshold	= args.threshold,
             cryptocurrency	= args.cryptocurrency,
             edit		= args.path,
-            card_format		= args.card,
+            card_format		= args.card,    # False inhibits SLIP-39 Card output
             paper_format	= args.paper,
-            filename		= args.output,
+            filename		= args.output,  # outputs to the current working dir, by default
             json_pwd		= json_pwd,
             text		= args.text,
             wallet_pwd		= wallet_pwd,
