Document scanning for, loading and deploying MultiPayoutERC20

Author: pjkundert

GNUmakefile

@@ -78,6 +78,7 @@ test:
 
 analyze:
 	$(PY3) -m flake8 --color never -j 1 --max-line-length=250 \
+	  --exclude slip39/tabulate \
 	  --ignore=W503,E201,E202,E203,E127,E221,E223,E226,E231,E241,E242,E251,E265,E272,E274 \
 	  slip39
 

README.org

@@ -206,7 +206,7 @@ def main( argv=None ):
             healthy		= serial_connected
             encoding		= 'UTF-8'
 
-            def file_opener():
+            def file_opener():  # noqa: F811
                 ser		= Serial(
                     port	= args.device,
                     baudrate	= args.baudrate or BAUDRATE,
@@ -217,7 +217,7 @@ def file_opener():
                 )
                 return ser
 
-            def healthy_reset( file ):
+            def healthy_reset( file ):  # noaq: F811
                 file.dtr		= False
                 # Wait for a server to de-assert DTR, discarding input.  After the Server has de-asserted, we still need to drain
                 # the Server's output / Client's input buffers, so keep flushing 'til input buffer empty...
@@ -346,7 +346,7 @@ def healthy_reset( file ):
         encoding		= 'UTF-8'
         healthy			= serial_connected
 
-        def file_opener():
+        def file_opener():  # noqa: F811
             ser			= Serial(
                 port	= args.device,
                 baudrate = args.baudrate or BAUDRATE,
@@ -356,7 +356,7 @@ def file_opener():
             )
             return ser
 
-        def healthy_waiter( file ):
+        def healthy_waiter( file ):  # noqa: F811
             file.dtr		= False
             # Wait for a client; when seen, assert DTR
             while ( flow := serial_flow( file ) ) and not flow[0].dsr:

README.pdf

@@ -228,7 +228,7 @@ def etherscan( chain, params, headers=None, apikey=None, timeout=None, verify=Tr
     return response_json['result']
 
 
-@retry( tries=5, delay=3, backoff=1.5, log_at=logging.WARNING, exc_at=logging.WARNING, default_cls=dict )
+@retry( tries=5, delay=3, backoff=1.5, log_at=logging.INFO, exc_at=logging.WARNING, default_cls=dict )
 def gasoracle( chain=None, **kwds ):
     """Return (possibly cached) Gas Oracle values from etherscan.io, or empty dict, allowing retries w/
     up to 3*1.5^5 seconds (22s) exponential backoff.
@@ -244,7 +244,7 @@ def gasoracle( chain=None, **kwds ):
     )
 
 
-@retry( tries=5, delay=3, backoff=1.5, log_at=logging.WARNING, exc_at=logging.WARNING, default_cls=dict )
+@retry( tries=5, delay=3, backoff=1.5, log_at=logging.INFO, exc_at=logging.WARNING, default_cls=dict )
 def ethprice( chain=None, **kwds ):
     """Return (possibly cached) Ethereum price in $USD from etherscan.io, or empty dict (performs exponential
     backoff of 3*1.5^5 seconds (22s) on Exceptions.)
@@ -260,7 +260,7 @@ def ethprice( chain=None, **kwds ):
     )
 
 
-@retry( tries=5, delay=3, backoff=1.5, log_at=logging.WARNING, exc_at=logging.WARNING, default_cls=dict )
+@retry( tries=5, delay=3, backoff=1.5, log_at=logging.INFO, exc_at=logging.WARNING, default_cls=dict )
 def erc20tx( chain=None, address=None, token=None, **kwds ):
     """Return (possibly cached) ERC-20 transactions from etherscan.io, or empty dict (performs exponential
     backoff of 3*1.5^5 seconds (22s) on Exceptions.)
@@ -293,7 +293,7 @@ def erc20tx( chain=None, address=None, token=None, **kwds ):
     )
 
 
-@retry( tries=5, delay=3, backoff=1.5, log_at=logging.WARNING, exc_at=logging.WARNING, default_cls=dict )
+@retry( tries=5, delay=3, backoff=1.5, log_at=logging.INFO, exc_at=logging.WARNING, default_cls=dict )
 def etherbalance( chain=None, address=None, **kwds ):
     """Return (possibly cached) ETH balance from etherscan.io, or empty dict (performs exponential
     backoff of 3^5 seconds (4 min.) on Exceptions.)
@@ -315,7 +315,7 @@ def etherbalance( chain=None, address=None, **kwds ):
     )
 
 
-@retry( tries=5, delay=3, backoff=1.5, log_at=logging.WARNING, exc_at=logging.WARNING, default_cls=dict )
+@retry( tries=5, delay=3, backoff=1.5, log_at=logging.INFO, exc_at=logging.WARNING, default_cls=dict )
 def ethertx( chain=None, address=None, **kwds ):
     """Return (possibly cached) ETH normal transactions from etherscan.io, or empty dict (performs exponential
     backoff of 3^5 seconds (4 min.) on Exceptions.)
@@ -355,7 +355,7 @@ def etherio( chain=None, address=None, direction=None, **kwds ):
     """
     if direction is None:
         direction		= Direction.Incoming
-    for tx in ethertx( chain=chain, address=address ):
+    for tx in ethertx( chain=chain, address=address, **kwds ):
         if tx["value"] == "0" or tx["isError"] != "0":
             continue
         # A non-error value-bearing transaction.  Ignore?
@@ -830,7 +830,7 @@ def _call( self, name, *args, gas=None, **kwds ):
             success		= False
             raise
         finally:
-            log.warning( f"Called  {self._name}.{name}( {commas( args )} ) -{'-' if success else 'x'}> {result}" )
+            log.info( f"Called  {self._name}.{name}( {commas( args )} ) -{'-' if success else 'x'}> {result}" )
         return result
 
     def __getattr__( self, name ):
@@ -993,7 +993,7 @@ def _deploy( self, *args, gas=None, **kwds ):
         beg			= timer()
         while ( block_number := self._w3.eth.block_number ) < cons_receipt.blockNumber:
             time.sleep( 1 )
-        log.warning( f"Waited {timer()-beg:.2f}s for block {block_number} to be mined, vs. Contract block: {cons_receipt.blockNumber}" )
+        log.info( f"Waited {timer()-beg:.2f}s for block {block_number} to be mined, vs. Contract block: {cons_receipt.blockNumber}" )
 
         self._update()
 

images/BIP-39-backup-entropy.png

@@ -431,7 +431,6 @@ def test_multipayout_ERC20_web3_tester( testnet, provider, chain_id, src, src_pr
     latest			= w3.eth.get_block('latest')
     print( f"{testnet:10}: Web3 Latest block: {json.dumps( latest, indent=4, default=str )}" )
 
-
     def gas_pricing(
         of		= f"{testnet:10}: Web3 Tester",
         gas		= None,
@@ -566,7 +565,7 @@ def gas_pricing(
 
     MultiPayoutERC20_contract	= w3.eth.contract( abi=mp_ERC20_abi, bytecode=mp_ERC20_bytecode )
 
-    gas				= 1400000 # 1388019 Gas is actual cost, as of 20230910
+    gas				= 1400000  # 1388019 Gas is actual cost, as of 20230910
     spend			= gas * max_usd_per_gas
     gas_price			= ETH.maxPriorityFeePerGas( spend=spend, gas=gas ) if ETH.UPDATED else gas_price_testnet
     mc_cons_tx			= {
@@ -576,10 +575,10 @@ def gas_pricing(
     } | gas_price
 
     gas_pricing( f"{testnet:10}: Web3 Tester Construct MultiPayoutERC20", **mc_cons_tx)
-    
+
     print( f"{testnet:10}: Web3 Tester Construct MultiPayoutERC20 Tx (using {'Mainnet' if ETH.UPDATED else 'Testnet'} Gas pricing): {json.dumps(mc_cons_tx, indent=4)}" )
     # Let's see what this would cost, using the estimated gas:
-    
+
     mc_cons_hash		= MultiPayoutERC20_contract.constructor( payees, tokens ).transact( mc_cons_tx )
     print( f"{testnet:10}: Web3 Tester Construct MultiPayoutERC20 hash: {mc_cons_hash.hex()}" )
     mc_cons			= w3.eth.get_transaction( mc_cons_hash )
@@ -1089,11 +1088,23 @@ def test_multipayout_recover( testnet, provider, chain_id, src, src_prvkey, dest
     # Recover an already deployed MultiPayoutERC20.  No need for a GasOracle (free calls only)
     mp_r			= MultiPayoutERC20(
         provider,
-        address		= "0xb8A8db0B4B8107c71D0C079351Be69c8CCe27469",
-        agent		= src,
-        agent_prvkey	= src_prvkey,
+        address		= "0xdb0bFb2E582Ecd3bc51C264d2F087D034857bF40",
     )
-    print( f"Recovered MultiPayoutERC20 at {mp_r._address}" )
+    print( f"Recovered MultiPayoutERC20 at {mp_r._address}: {mp_r}" )
+    assert str(mp_r) == """\
+MultiPayoutERC20 Payees:
+    | Payee                                      | Share                 |   Frac. % |   Reserve |   Reserve/2^16 |   Frac.Rec. % |   Error % |
+    |--------------------------------------------+-----------------------+-----------+-----------+----------------+---------------+-----------|
+    | 0xEeC2b464c2f50706E3364f5893c659edC9E4153A | 14979/65536           |   22.8561 |     50557 |          50557 |       22.8561 |         0 |
+    | 0xE5714055437154E812d451aF86239087E0829fA8 | 1228888999/4294967296 |   28.6123 |     41229 |          41229 |       28.6123 |         0 |
+    | 0x7Fc431B8FC8250A992567E3D7Da20EE68C155109 | 2084414553/4294967296 |   48.5316 |         0 |              0 |       48.5316 |         0 |
+ERC-20s:
+    | Token                                      | Symbol   |   Digits |
+    |--------------------------------------------+----------+----------|
+    | 0xe802376580c10fE23F027e1E19Ed9D54d4C9311e | USDT     |        6 |
+    | 0xde637d4C445cA2aae8F782FFAc8d2971b93A4998 | USDC     |        6 |
+    | 0xaFF4481D10270F50f203E0763e2597776068CBc5 | WEENUS   |       18 |
+    | 0x1f9061B953bBa0E36BF50F21876132DcF276fC6e | ZEENUS   |        0 |"""
 
 
 @pytest.mark.skipif( not goerli_xprvkey and not ganache_xprvkey,

slip39/generator/main.py

@@ -1,6 +1,5 @@
 import pytest
 import logging
-import os
 import subprocess
 
 from pathlib		import Path