Progress toward passing all tests

o Break out package extras [invoice] from [wallet], and add [all]
o Remove the extras [dev]; move into requirements-tests.txt
o Default to Alchemy "Testing" API token w/ warning

Author: pjkundert

GNUmakefile

@@ -167,7 +167,7 @@ dist/slip39-$(VERSION)-py3-none-any.whl: build-check FORCE
 
 # Install from wheel, including all optional extra dependencies (except dev)
 install:		dist/slip39-$(VERSION)-py3-none-any.whl FORCE
-	$(PY3) -m pip install --force-reinstall $<[gui,wallet,serial]
+	$(PY3) -m pip install --force-reinstall $<[all]
 
 install-dev:
 	$(PY3) -m pip install --upgrade -r requirements-dev.txt

requirements-dev.txt

@@ -1,4 +1,9 @@
+aiosmtpd		>=1.4,	<2
+build
+cx_Freeze		>=6.12
 flake8
+pyinstaller		>=5.5
 pytest			>=7.2.0,<8
 pytest-cov		>=4.0.0,<5
-aiosmtpd		>=1.4,	<2
+setuptools
+wheel

requirements-tests.txt

@@ -1,11 +1 @@
 eth-account		>=0.7.0,<0.8
-py-solc-x		>=1.1.1,<1.2
-pycryptodome		>=3.16,	<4 
-requests		>=2.20,	<3
-tabulate		>=0.9,	<1
-crypto-licensing	>=3.0.3
-dkimpy[ed25519]		>=1.0.5,<2
-
-# These versions are very brittle; must be upgraded in lock-step (see web3.py/setup.py)
-web3[tester]		==6.0.0b8
-eth-tester[py-evm]	==v0.7.0-beta.1

requirements-wallet.txt

@@ -3,7 +3,6 @@
 import glob
 import fnmatch
 
-
 # 
 # All platforms
 # 
@@ -12,14 +11,21 @@
 install_requires		= open( os.path.join( HERE, "requirements.txt" )).readlines()
 tests_require			= open( os.path.join( HERE, "requirements-tests.txt" )).readlines()
 extras_require			= {
-    option: open( os.path.join( HERE, f"requirements-{option}.txt" )).readlines()
+    option: list(
+        # Remove whitespace, elide blank lines and comments
+        ''.join( r.split() )
+        for r in open( os.path.join( HERE, f"requirements-{option}.txt" )).readlines()
+        if r.strip() and not r.strip().startswith( '#' )
+    )
     for option in [
-        'gui',		# slip39[gui]:    Support PySimpleGUI/tkinter Graphical UI App
-        'dev',		# slip39[dev]:    All modules to support development
-        'serial',	# slip39[serial]: Support serial I/O of generated wallet data
-        'wallet',	# slip39[wallet]: Paper Wallet and BIP-38/Ethereum wallet encryption
+        'gui',		# slip39[gui]:		Support PySimpleGUI/tkinter Graphical UI App
+        'serial',	# slip39[serial]:	Support serial I/O of generated wallet data
+        'wallet',	# slip39[wallet]:	Paper Wallet and BIP-38/Ethereum wallet encryption
+        'invoice',	# slip39[invoice]:	Generation of invoices, and associated Smart Contracts
     ]
 }
+# Make python-slip39[all] install all extra (non-tests) requirements, excluding duplicates
+extras_require['all']		= list( set( sum( extras_require.values(), [] )))
 
 Executable			= None
 if sys.platform == 'win32':

setup.py

@@ -117,7 +117,7 @@ def test_communications_dkim():
             msg,
             #from_addr	= SMTP_FROM,		# Envelope MAIL FROM: specifies actual sender
             #to_addrs	= [ SMTP_TO ],		# Will be the same as message To: (should default)
-            relay		= ['mail2.kundert.ca'],  # 'localhost',   # use eg. ssh -fNL 0.0.0.0:25:linda.mx.cloudflare.net:25 [email protected]
+            #relay		= ['mail2.kundert.ca'],  # 'localhost',   # use eg. ssh -fNL 0.0.0.0:25:linda.mx.cloudflare.net:25 [email protected]
             #port		= 25,  # 465 --> SSL, 587 --> TLS (default),
             #usessl = False, starttls = False, verifycert = False,  # to mail.kundert.ca; no TLS
             #usessl = False, starttls = True, verifycert = False,  # default

slip39/invoice/communications_test.py

@@ -66,8 +66,8 @@ def contract_address(
     assert isinstance( b_address, bytes ) and len( b_address ) == 20, \
         f"Expected 20-byte adddress, got {b_address!r}"
 
-    if nonce is not None and salt is None and creation is None and creation_hash:
-        # A CREATE (traditional, or transaction-based) contract creation
+    if nonce is not None and salt is None and creation is None and creation_hash is None:
+        # A CREATE (traditional, or transaction-based) contract creation; only address and nonce
         assert isinstance( nonce, int ), \
             f"The nonce for CREATE must be an integer, not {nonce!r}"
         b_result		= Web3.keccak( rlp_encode([ b_address, nonce ]) )
@@ -99,11 +99,56 @@ class Chain( Enum ):
     Goerli		= 2
 
 
+#
+# Etherscan API, for accessing Gas Oracle and wallet data
+#
 etherscan_urls			= dict(
     Ethereum	= 'https://api.etherscan.io/api',
     Goerli	= 'https://api-goerli.etherscan.io/api',
 )
 
+#
+# Alchemy API, for accessing the Ethereum blockchain w/o running a local instance
+#
+#     They provide a free "testing" API token, with a very low 50 "Compute Units/Second" limit, for
+# testing their API: https://docs.alchemy.com/reference/throughput.  This should be sufficient for
+# accessing "free" (view) APIs in contracts.  However, for any advanced usage (ie. to deploy
+# contracts), you'll probably need an official ALCHEMY_API_TOKEN
+#
+alchemy_urls			= dict(
+    Ethereum	= 'eth-mainnet.g.alchemy.com/v2',
+    Goerli	= 'eth-goerli.g.alchemy.com/v2',
+)
+
+alchemy_api_testing		= dict(
+    Goerli	= 'AxnmGEYn7VDkC4KqfNSFbSW9pHFR7PDO',
+    Ethereum	= 'J038e3gaccJC6Ue0BrvmpjzxsdfGly9n',
+)
+
+
+def alchemy_url( chain, protocol='wss' ):
+    """Return our Alchemy API URL, including our API token, from the ALCHEMY_API_TOKEN environment
+    variable.
+
+    If none specified, we'll default to their "Testing" API token, which should be adequate for
+    low-rate "free" (view) contract APIs.  However, for deploying contracts, either an official
+    (free) Alchemy API token will be required, or a local Ethereum node.
+
+    """
+    assert protocol in ( 'wss', 'https' ), \
+        "Must specify either Websocket over SSL ('wss') or HTTP over SSL ('https')"
+    api_token			= os.getenv( 'ALCHEMY_API_TOKEN' )
+    if not alchemy_url.api_token or api_token != alchemy_url.api_token:
+        # Alchemy API token not yet discovered, or has changed
+        if api_token:
+            alchemy_url.api_token	= api_token
+            log.info( f"Using supplied Alchemy {chain} API token: {alchemy_url.api_token:.5}..." )
+        elif not alchemy_url.api_token:
+            alchemy_url.api_token	= alchemy_api_testing[chain.name]
+            log.warning( f"Using \"Testing\" Alchemy {chain} API token: {alchemy_url.api_token}; obtain an official API key: https://docs.alchemy.com/reference/api-overview" )
+    return f"{protocol}://{alchemy_urls[chain.name]}/{alchemy_url.api_token}"
+alchemy_url.api_token		= None   # noqa E305
+
 
 @memoize( maxage=ETHERSCAN_MEMO_MAXAGE, maxsize=ETHERSCAN_MEMO_MAXSIZE, log_at=logging.INFO )
 def etherscan( chain, params, headers=None, apikey=None, timeout=None, verify=True ):
@@ -628,7 +673,7 @@ class Contract:
     def __init__(
         self,
         w3_provider,
-        agent,						# The Ethereum account of the agent accessing the Contract
+        agent				= None,		# The Ethereum account of the agent accessing the Contract
         agent_prvkey: Optional[bytes]	= None,		# Can only query public data, view methods without
         source: Optional[Path]		= None,
         version: Optional[str]		= None,
@@ -642,15 +687,16 @@ def __init__(
         gas_oracle: Optional[GasOracle]	= None,
         gas_oracle_timeout: Optional[Tuple[int,float]] = None,  # None avoids waiting, doesn't check
     ):
-        # If a GasOracle is supplied, well wait up to gas_oracle_timeout seconds for it to report
+        # If a GasOracle is supplied, we'll wait up to gas_oracle_timeout seconds for it to report
         # online.  Give it a tickle here to get it started, while we do other time-consuming stuff.
         self._gas_oracle	= GasOracle() if gas_oracle is None else gas_oracle
         gas_oracle_beg		= timer()
         bool( self._gas_oracle )
 
         self._w3		= Web3( w3_provider )
         self._agent		= agent
-        self._w3.eth.default_account = str( self._agent )
+        if self._agent is not None:
+            self._w3.eth.default_account = str( self._agent )
 
         if agent_prvkey:
             account_signing	= eth_account.Account.from_key( '0x' + agent_prvkey )

slip39/invoice/ethereum.py

@@ -18,7 +18,6 @@
 from __future__		import annotations
 
 import logging
-import os
 import textwrap
 
 from typing		import Union
@@ -28,7 +27,6 @@
 from tabulate		import tabulate
 
 from ..util		import remainder_after, fraction_allocated, commas
-from ..api		import account
 from .ethereum		import Chain, Contract, contract_address  # noqa F401
 
 __author__                      = "Perry Kundert"
@@ -38,29 +36,6 @@
 
 log				= logging.getLogger( 'multipayout' )
 
-goerli_account			= None
-goerli_xprvkey			= os.getenv( 'GOERLI_XPRVKEY' )
-if not goerli_xprvkey:
-    goerli_seed			= os.getenv( 'GOERLI_SEED' )
-    if goerli_seed:
-        try:
-            # why m/44'/1'?  Dunno.  That's the derivation path Trezor Suite uses for Goerli wallets...
-            goerli_xprvkey	= account( goerli_seed, crypto="ETH", path="m/44'/1'/0'" ).xprvkey
-        except Exception:
-            pass
-        # Using the "xprv..." key, and derive the 1st sub-account, on the combined path m/44'/1'/0'/0/0
-        goerli_account		= account( goerli_xprvkey, crypto='ETH', path="m/0/0" )
-
-
-alchemy_urls			= dict(
-    Ethereum	= 'eth-mainnet.g.alchemy.com/v2',
-    Goerli	= 'eth-goerli.g.alchemy.com/v2',
-)
-
-
-def alchemy_url( chain, protocol='wss' ):
-    return f"{protocol}://{alchemy_urls[chain.name]}/{os.getenv( 'ALCHEMY_API_TOKEN' )}"
-
 
 def payout_reserve( addr_frac, bits=16 ):
     """Produce recipients array elements w/ fixed fractional/proportional amounts to predefined
@@ -117,21 +92,32 @@ class MultiPayoutERC20( Contract ):
     address, or _deploy a new contract by specifying payees and optionally a list of erc20s to
     support.
 
-        >>> assert os.getenv( 'ETHERSCAN_API_TOKEN' )
-        >>> assert os.getenv( 'ALCHEMY_API_TOKEN' )
-        >>> assert goerli_account
+        >>> from .ethereum import Chain, alchemy_url
         >>> mp = MultiPayoutERC20( Web3.WebsocketProvider( alchemy_url( Chain.Goerli )),
-        ...    agent		= goerli_account.address,
-        ...    agent_prvkey	= goerli_account.prvkey,
         ...    address		= "0x8b3D24A120BB486c2B7583601E6c0cf37c9A2C04"
         ... )
+        MultiPayoutERC20 Payees:
+            | Payee                                      | Share                 |   Frac. % |   Reserve |   Reserve/2^16 |   Frac.Rec. % |   Error % |
+            |--------------------------------------------+-----------------------+-----------+-----------+----------------+---------------+-----------|
+            | 0x7Fc431B8FC8250A992567E3D7Da20EE68C155109 | 4323/65536            |   6.59638 |     61213 |          61213 |       6.59638 |         0 |
+            | 0xEeC2b464c2f50706E3364f5893c659edC9E4153A | 1507247699/4294967296 |  35.0933  |     40913 |          40913 |      35.0933  |         0 |
+            | 0xE5714055437154E812d451aF86239087E0829fA8 | 2504407469/4294967296 |  58.3103  |         0 |              0 |      58.3103  |         0 |
+        ERC-20s:
+            | Token                                      | Symbol   |   Digits |
+            |--------------------------------------------+----------+----------|
+            | 0xe802376580c10fE23F027e1E19Ed9D54d4C9311e | USDT     |        6 |
+            | 0xde637d4C445cA2aae8F782FFAc8d2971b93A4998 | USDC     |        6 |
+            | 0xaFF4481D10270F50f203E0763e2597776068CBc5 | WEENUS   |       18 |
+            | 0x1f9061B953bBa0E36BF50F21876132DcF276fC6e | ZEENUS   |        0 |
+
+        >>> import json
         >>> print( json.dumps( mp._payees, indent=4, default=lambda f: f"{float( f * 100 ):9.5f}%" ))
         {
             "0x7Fc431B8FC8250A992567E3D7Da20EE68C155109": "  6.59637%",
             "0xEeC2b464c2f50706E3364f5893c659edC9E4153A": " 35.09335%",
             "0xE5714055437154E812d451aF86239087E0829fA8": " 58.31028%"
         }
-        >>> print( json.dumps( mp._erc20s, indent=4 ))
+        >>> print( json.dumps( mp._erc20s_data, indent=4 ))
         {
             "0xe802376580c10fE23F027e1E19Ed9D54d4C9311e": [
                 "USDT",
@@ -189,8 +175,7 @@ def __str__( self ):
 {self.__class__.__name__} Payees:
 {textwrap.indent( self._payees_table, ' ' * 4 )}
 ERC-20s:
-{textwrap.indent( self._erc20s_table, ' ' * 4 )}
-"""
+{textwrap.indent( self._erc20s_table, ' ' * 4 )}"""
 
     @property
     def _erc20s_table( self ):
@@ -215,10 +200,7 @@ def _payees_data( self ):
         addrs,fracs,rsrvs	= zip( *payout_reserve( self._payees, bits=self._bits ))
         share			= list( self._payees[a] for a in addrs )
         rsrvs_int		= list( map( int, rsrvs ))
-        fracs_recov		= list( fraction_allocated(
-            rsrvs_int,
-            scale	= 2**self._bits,
-        ))
+        fracs_recov		= list( fraction_allocated( rsrvs_int, scale=2**self._bits ))
         # Now, compute the "error" between the originally specified payout fractions, and the payout
         # fractions recovered after reversing the 1/2^bits reserve calculations.  The error should
         # always be < 1/2^bits.
@@ -275,7 +257,6 @@ def _payees_reserve( self, payees_reserve ):
                 log.warning( f"Recovered payees fractions don't match: \n{self._payees_table}" )
         else:
             self._payees	= payees
-            log.info( f"Recovered payees fractions from reserves: \n{self._payees_table}" )
 
     @property
     def _payees_table( self ):
@@ -314,7 +295,6 @@ def _update( self ):
 
         """
         self._forwarder_hash	= self.forwarder_hash()
-        log.info( f"{self._name} Forwarder CREATE2 hash: 0x{self._forwarder_hash.hex()}" )
 
         def payees_reserve():
             for i in count():
@@ -349,4 +329,4 @@ def erc20s_data():
         if self._erc20s:
             assert self._erc20s == erc20s
         else:
-            self._ers20s	= erc20s
+            self._erc20s	= erc20s

slip39/invoice/multipayout.py

@@ -18,7 +18,7 @@
 from eth_account	import Account
 
 from .			import contract_address
-from .ethereum		import Etherscan, Chain
+from .ethereum		import Etherscan, Chain, alchemy_url
 from .multipayout	import MultiPayoutERC20, payout_reserve
 from ..api		import account, accounts
 
@@ -108,10 +108,9 @@ def test_solcx_smoke():
     print( f"Goerli Ethereum Testnet dst ETH addresses: {json.dumps( goerli_destination, indent=4 )}" )
 
     web3_testers	       += [(
-        # Web3.HTTPProvider( f"https://eth-goerli.g.alchemy.com/v2/{os.getenv( 'ALCHEMY_API_TOKEN' )}" ),
         "Goerli",
-        Web3.WebsocketProvider(					# Provider and chain_id (if any)
-            f"wss://eth-goerli.g.alchemy.com/v2/{os.getenv( 'ALCHEMY_API_TOKEN' )}"
+        Web3.WebsocketProvider(
+            alchemy_url( Chain.Goerli )  # f"wss://eth-goerli.g.alchemy.com/v2/{os.getenv( 'ALCHEMY_API_TOKEN' )}"
         ),  None,
         goerli_src.address, goerli_src.prvkey, goerli_destination,
     ),]
@@ -274,12 +273,12 @@ def test_create2(address, salt, creation, expected_address):
     (
         '0x6ac7ea33f8831ea9dcc53393aaa88b25a785dbf0',
         0,
-        '0xcd234a471b72ba2f1ccf0a70fcaba648a5eecd8d',
+        '0xcd234A471b72ba2F1Ccf0A70FCABA648a5eeCD8d',
     ),
     (
         '0x6ac7ea33f8831ea9dcc53393aaa88b25a785dbf0',
         1,
-        '0x343c43a37d37dff08ae8c4a11544c718abb4fcf8',
+        '0x343c43A37D37dfF08AE8C4A11544c718AbB4fCF8',
     ),
 ])
 def test_create(address, nonce, expected_address):

slip39/invoice/multipayout_test.py

@@ -1,2 +1,2 @@
-__version_info__		= ( 10, 1, 1 )
+__version_info__		= ( 10, 2, 0 )
 __version__			= '.'.join( map( str, __version_info__ ))