Begin to add invoice.artifact Invoice generation

o Add ERC-20 token pricing oracle and memo-ized querying functions
o Add top 100 ERC-20 tokens, and lookup by symbol/name

Author: pjkundert

README.org

@@ -1730,6 +1730,20 @@ sets of 20 words is difficult, error-prone and time consuming.
   the many intermediary banking industry and government parties involved in any traditional
   financial transaction, even if you are not convicted of a crime.
 
+  Even if such payments are allowed, and none of the counterparties are actively hostile to you, the
+  complexity and expense of quoting a price, signing a client, invoicing for payment, confirming the
+  validity of the invoice and making the payment, monitoring for incoming payments and associating
+  them with the correct invoices, conforming amounts paid are correct, issuing a receipt,
+  book-keeping the incoming payment, converting currencies, retaining the correct taxes for each
+  counterparty jurisdiction, reconciling books, and finally preparing and filing taxes, and then
+  (perhaps years later) defending your accounting decisions against a hostile tax inspector with
+  infinite funds to prosecute -- all this makes it virtually impossible for a small business to
+  survive.  Furthermore, you must accomplish all this, *without error*, while attempting to defend
+  yourself against business adversaries with preferential tax treatment, office-towers full of
+  lawyers and accountants, for whom the total percentage of gross revenues paid to accomplish
+  compliance is less than 1%, while the small business is likely to spend 10% to 25% of
+  their entire gross revenue *just* to financial and regulatory compliance overheads.
+
   Fortunately, DeFi (Decentralized Finance) provides you with the capability to receive payments,
   quickly and efficiently, from anyone on the planet who wishes to pay you for your services.
 
@@ -1804,53 +1818,62 @@ sets of 20 words is difficult, error-prone and time consuming.
    storing an immutable value associated with the "salt" value from which the "Forwarder" account
    address is derived.
 
-*** Client "Forwarder" Contract
+*** The Client "Forwarder" Contract
 
     Once the product's =MultiPayoutERC20= "Fee Distribution" contract address is identified, the act
     of obtaining a unique client payee "Forwarder" address is simple.
 
     1) A "salt" value unique to the client is deduced, usually consisting of "something they know"
-       (eg. a Public Key) plus "something they have" (eg. a Machine ID).
+       (eg. a Public Key) plus "something they have" (eg. a Machine ID, or a User Name).
     2) The salt is used to deduce the client's unique "Forwarder" address
 
-    Here's an example (using the Ethereum "Goerli" testnet):
+**** The Product Owner's MultiPayoutERC20 Contract
 
-    #+LATEX: {\scriptsize
-    #+BEGIN_SRC ipython :session :exports both :results output raw drawer
+     The creation of a =MultiPayoutERC20= is simple.
 
-    # Provide yourself with a Goerli testnet account under your control;
-    # provide an "xpub..." key for it, or the BIP-39 Mnemonic phrase to
-    # derive its HD wallet.  Use the https://goerlifaucet.com to fund the
-    # account with some Goerli test Ethereum; requires you to set up an
-    # https://alchemy.com account, and put your API token in the
-    # ALCHEMY_API_TOKEN environment variable.
-    goerli_xprvkey		= os.getenv( 'GOERLI_XPRVKEY' )
-    if not goerli_xprvkey:
-    	  goerli_seed		= os.getenv( 'GOERLI_SEED' )
-    	  if goerli_seed:
-    	      try:
-    		  # why m/44'/1'/... instead of m/44'/60'/...?  Dunno;
-    		  # That's the derivation path that Trezor Suite uses for
-    		  # Goerli testnet wallets...
-    		  goerli_xprvkey = slip39.account(
-    		      goerli_seed, crypto="ETH", path="m/44'/1'/0'"
-    		  ).xprvkey
-    	      except Exception:
-    		  pass
-    if goerli_xprvkey:
-    	  # the Account.address/.prvkey
-    	  goerli_src		= slip39.account(
-    	      goerli_xprvkey, crypto='ETH', path="m/0/0"
-        )
-
-    from slip39.invoice import MultiPayoutERC20
-
-    mp				= MultiPayoutERC20(
-    	agent		= goerli_src.address,
-    	agent_prvkey	= goerli_src.prvkey,
-    	address		= "0xb2D03aD9a84F0E10697BF2CDc2B98765688134d8",
-    )
-    salt			
+     The product owner must know the Ethereum addresses of the payees, and each payee's proportion
+     of the product revenue.  A payee may be another MultiPayoutERC20 contract (eg. for a product
+     module sub-license), which may in turn have its own payees.
+
+     An Ethereum account containing sufficient funds to establish the MultiPayoutERC20 contract must
+     be available.  Here's an example (using the Ethereum "Goerli" testnet):
+
+     #+LATEX: {\scriptsize
+     #+BEGIN_SRC ipython :session :exports both :results output raw drawer
+  
+     # Provide yourself with a Goerli testnet account under your control;
+     # provide an "xpub..." key for it, or the BIP-39 Mnemonic phrase to
+     # derive its HD wallet.  Use the https://goerlifaucet.com to fund the
+     # account with some Goerli test Ethereum; requires you to set up an
+     # https://alchemy.com account, and put your API token in the
+     # ALCHEMY_API_TOKEN environment variable.
+     goerli_xprvkey		= os.getenv( 'GOERLI_XPRVKEY' )
+     if not goerli_xprvkey:
+     	  goerli_seed		= os.getenv( 'GOERLI_SEED' )
+     	  if goerli_seed:
+     	      try:
+     		  # why m/44'/1'/... instead of m/44'/60'/...?  Dunno;
+     		  # That's the derivation path that Trezor Suite uses for
+     		  # Goerli testnet wallets...
+     		  goerli_xprvkey = slip39.account(
+     		      goerli_seed, crypto="ETH", path="m/44'/1'/0'"
+     		  ).xprvkey
+     	      except Exception:
+     		  pass
+     if goerli_xprvkey:
+     	  # the Account.address/.prvkey
+     	  goerli_src		= slip39.account(
+     	      goerli_xprvkey, crypto='ETH', path="m/0/0"
+         )
+  
+     from slip39.invoice import MultiPayoutERC20
+  
+     mp				= MultiPayoutERC20(
+     	agent		= goerli_src.address,
+     	agent_prvkey	= goerli_src.prvkey,
+     	address		= "0xb2D03aD9a84F0E10697BF2CDc2B98765688134d8",
+     )
+     salt			
 
     #+END_SRC
     #+LATEX: }
@@ -1863,8 +1886,8 @@ sets of 20 words is difficult, error-prone and time consuming.
     payments to a plain Account (for which you hold the private key) may not be acceptable to all
     parties involved.  A product owner providing a licensee the capability to sub-licensing their
     product may, for example, charge a much better fee, if the licensee can prove that payments will
-    *automatically* flow back to the licensor, every time the licensee sells their product which
-    contains the sub-license.
+    *automatically* flow back to the license owner, every time the licensee sells their product
+    which contains the sub-license.
 
     There are ways to ensure that each client payment *must* be distributed to each payee, as agreed,
     using cryptocurrencies which implement Smart Contracts.

slip39/api.py

@@ -58,7 +58,6 @@
     scrypt			= None
     message			= f"Unable to support Paper Wallet output: {exc}"
     warnings.warn( message, ImportWarning )
-    log.warning( message )
     if log.isEnabledFor( logging.DEBUG ):
         log.exception( message )
     paper_wallet_issues.append( message )
@@ -69,7 +68,6 @@
     eth_account			= None
     message			= f"Unable to support Paper Wallet output: {exc}"
     warnings.warn( message, ImportWarning )
-    log.warning( message )
     if log.isEnabledFor( logging.DEBUG ):
         log.exception( message )
     paper_wallet_issues.append( message )

slip39/communications.py

@@ -610,7 +610,8 @@ def autoresponder( address, from_addr, to_addrs, server, port, reinject ):
 
     Install python-slip39 (no extras required for just slip39.communications)
 
-      # python3.10 -m pip install https://github.com/pjkundert/python-slip39/archive/feature-invoice.zip#egg=slip39
+      # rm -rf ~/.cache/pip
+      # python3.10 -m pip install --upgrade https://github.com/pjkundert/python-slip39/archive/feature-invoice.zip#egg=slip39
 
     Configure Postfix system roughly as per: https://github.com/innovara/autoreply,
     to run our slip39.communications autoresponder
@@ -622,7 +623,7 @@ def autoresponder( address, from_addr, to_addrs, server, port, reinject ):
 
         # autoresponder pipe
         autoreply unix  -       n       n       -       -       pipe
-         flags= user=autoreply null_sender=
+         flags= user=nobody null_sender=
          argv=/usr/local/bin/python3.10 -m slip39.communications autoresponder [email protected] ${sender} ${recipient}
 
     - Create /etc/postfix/autoreply w/ lines like (and postmap /etc/postfix/autoreply):

slip39/communications_test.py

@@ -28,12 +28,12 @@
     # No local key (the usual case, unless you're Dominion R&D!)
     dkim_selector		= '20221230'
     dkim_msg			= message_from_string( """\
+Content-Type: multipart/alternative; boundary================1903566236404015660==
 MIME-Version: 1.0
 From: [email protected]
 To: [email protected]
 Reply-To: [email protected]
 Subject: Hello, world!
-Content-Type: multipart/alternative; boundary================1903566236404015660==
 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=licensing.dominionrnd.com; [email protected]; q=dns/txt; s=20221230; t=1673405994; h=from : to;\
  bh=RkF6KP4Q94MVDBEv7pluaWdzw0z0GNQxK72rU02XNcE=; b=Tao30CJGcqyX86f37pSrSFLSDvA8VkzQW0jiMf+aFg5D99LsUYmUZxSgnDhW2ZEzjwu6bzjkEEyvSEv8LxfDUW+AZZG3enbq/mnnUZw3PXp4l\
 MaZGN9whvTIUy4/QUlMGKuf+7Vzi+8eKKjh4CWKN/UEyX6YoU7V5eyjTTA7q1jIjEl8jiM4LXYEFQ9LaKUmqqmRh2OkxBVf1QG+fEYTYUed+oS05m/d1SyVLjxv8ldeXT/mGgm1CrGk1qfRTzfcksX4qNAluTfJTa\
@@ -71,19 +71,22 @@ def test_communications_matchaddr():
 
 
 def test_communications_dkim():
-    msg				= dkim_msg if not dkim_key else dkim_message(
-        sender_email	= SMTP_FROM,			# Message From: specifies claimed sender
-        to_email	= SMTP_TO,			# See https://dkimvalidator.com to test!
-        reply_to_email	= "[email protected]",
-        subject		= "Hello, world!",
-        message_text	= "Testing 123",
-        message_html	= "<em>Testing 123</em>",
-        dkim_private_key_path = dkim_key,
-        dkim_selector	= dkim_selector,
-        headers		= ['From', 'To'],
-    )
+    if dkim_key:
+        msg			= dkim_message(
+            sender_email	= SMTP_FROM,			# Message From: specifies claimed sender
+            to_email		= SMTP_TO,			# See https://dkimvalidator.com to test!
+            reply_to_email	= "[email protected]",
+            subject		= "Hello, world!",
+            message_text	= "Testing 123",
+            message_html	= "<em>Testing 123</em>",
+            dkim_private_key_path = dkim_key,
+            dkim_selector	= dkim_selector,
+            headers		= ['From', 'To'],
+        )
+    else:
+        msg			= dkim_msg
 
-    log.info( f"DKIM Message: {msg}" )
+    log.info( f"DKIM {'signed' if dkim_key else 'canned'} Message:\n{msg}" )
 
     sig			= msg['DKIM-Signature']
     sig_kvs		= sig.split( ';' )
@@ -136,17 +139,20 @@ def test_communications_autoresponder( monkeypatch ):
     the auto-forwarded message(s).
 
     """
-    msg				= dkim_msg if not dkim_key else dkim_message(
-        sender_email	= SMTP_FROM,			# Message From: specifies claimed sender
-        to_email	= SMTP_TO,			# See https://dkimvalidator.com to test!
-        reply_to_email	= "[email protected]",
-        subject		= "Hello, world!",
-        message_text	= "Testing 123",
-        message_html	= "<em>Testing 123</em>",
-        dkim_private_key_path = dkim_key,
-        dkim_selector	= dkim_selector,
-        headers		= ['From', 'To'],
-    )
+    if dkim_key:
+        msg			= dkim_message(
+            sender_email	= SMTP_FROM,			# Message From: specifies claimed sender
+            to_email		= SMTP_TO,			# See https://dkimvalidator.com to test!
+            reply_to_email	= "[email protected]",
+            subject		= "Hello, world!",
+            message_text	= "Testing 123",
+            message_html	= "<em>Testing 123</em>",
+            dkim_private_key_path = dkim_key,
+            dkim_selector	= dkim_selector,
+            headers		= ['From', 'To'],
+        )
+    else:
+        msg			= dkim_msg
 
     envelopes		= []
 

slip39/defaults.py

@@ -163,7 +163,9 @@
 # We'll default to 30-second intervals for querying Etherscan for Gas, ETH, ERC-20 Pricing info
 ETHERSCAN_MEMO_MAXAGE		= 30
 ETHERSCAN_MEMO_MAXSIZE		= None
-
+# For token prices, default to 5 minute refreshes
+TOKPRICES_MEMO_MAXAGE		= 5*60
+TOKPRICES_MEMO_MAXSIZE		= None
 
 SMTP_TO				= "[email protected]"
 SMTP_FROM			= "[email protected]"