Add steps option to demurrage cli

python/CHANGELOG

@@ -1,7 +1,14 @@
+- 0.1.1
+	* Settable demurrage steps for apply demurrage cli tool
+- 0.1.0
+	* Dependency upgrades
+- 0.0.11
+	* Apply demurrage cli tool
+- 0.0.10
+	* Settable sink address
 - 0.0.9
-	* Fix wrong redistribution calculation in single nocap
-[...]
+	* Correct redistribution amount for SingleNocap contract
 - 0.0.2
 	* Move to chainlib-eth
-- 0.0.1-unreleased
+- 0.0.1
 	* Interface for redistributed and non-redistributed, with or without cap

python/erc20_demurrage_token/runnable/apply.py

@@ -0,0 +1,144 @@
+"""Deploy sarafu token
+
+.. moduleauthor:: Louis Holbrook <dev@holbrook.no>
+.. pgp:: 0826EDA1702D1E87C6E2875121D2E7BB88C2A746 
+
+"""
+
+# standard imports
+import sys
+import os
+import json
+import argparse
+import logging
+import datetime
+import math
+
+# external imports
+import confini
+from funga.eth.signer import EIP155Signer
+from funga.eth.keystore.dict import DictKeystore
+from chainlib.chain import ChainSpec
+from chainlib.eth.nonce import (
+        RPCNonceOracle,
+        OverrideNonceOracle,
+        )
+from chainlib.eth.gas import (
+        RPCGasOracle,
+        OverrideGasOracle,
+        )
+from chainlib.eth.block import (
+        block_latest,
+        block_by_number,
+        Block,
+        )
+from chainlib.eth.connection import EthHTTPConnection
+from chainlib.eth.tx import receipt
+from chainlib.eth.constant import ZERO_ADDRESS
+import chainlib.eth.cli
+from hexathon import to_int as hex_to_int
+
+# local imports
+import erc20_demurrage_token
+from erc20_demurrage_token import (
+        DemurrageToken,
+        DemurrageTokenSettings,
+        )
+
+logging.basicConfig(level=logging.WARNING)
+logg = logging.getLogger()
+
+script_dir = os.path.dirname(__file__)
+data_dir = os.path.join(script_dir, '..', 'data')
+
+config_dir = os.path.join(data_dir, 'config')
+
+arg_flags = chainlib.eth.cli.argflag_std_write | chainlib.eth.cli.Flag.EXEC
+argparser = chainlib.eth.cli.ArgumentParser(arg_flags)
+argparser.add_argument('--steps', type=int, default=0, help='Max demurrage steps to apply per round')
+args = argparser.parse_args()
+config = chainlib.eth.cli.Config.from_args(args, arg_flags, default_fee_limit=DemurrageToken.gas(), base_config_dir=config_dir)
+config.add(args.steps, '_STEPS', False)
+logg.debug('config loaded:\n{}'.format(config))
+
+wallet = chainlib.eth.cli.Wallet()
+wallet.from_config(config)
+
+rpc = chainlib.eth.cli.Rpc(wallet=wallet)
+conn = rpc.connect_by_config(config)
+
+chain_spec = ChainSpec.from_chain_str(config.get('CHAIN_SPEC'))
+
+
+def main():
+    o = block_latest()
+    r = conn.do(o)
+ 
+    block_start_number = None
+    try:
+        block_start_number = hex_to_int(r)
+    except TypeError:
+        block_start_number = int(r)
+
+    o = block_by_number(block_start_number)
+    r = conn.do(o)
+
+    block_start = Block(r)
+    block_start_timestamp = block_start.timestamp
+    block_start_datetime = datetime.datetime.fromtimestamp(block_start_timestamp)
+
+    gas_oracle = rpc.get_gas_oracle()
+    c = DemurrageToken(chain_spec, gas_oracle=gas_oracle)
+    o = c.demurrage_timestamp(config.get('_EXEC_ADDRESS'))
+    r = conn.do(o)
+
+    demurrage_timestamp = None
+    try:
+        demurrage_timestamp = hex_to_int(r)
+    except TypeError:
+        demurrage_timestamp = int(r)
+    demurrage_datetime = datetime.datetime.fromtimestamp(demurrage_timestamp)
+
+    total_seconds = block_start_timestamp - demurrage_timestamp
+    total_steps = total_seconds / 60
+
+    if total_steps < 1.0:
+        logg.error('only {} seconds since last demurrage application, skipping'.format(total_seconds))
+        return
+
+    logg.debug('block start is at {} demurrage is at {} -> {} minutes'.format(
+        block_start_datetime,
+        demurrage_datetime,
+        total_steps,
+        ))
+
+    rounds = 1
+    if config.get('_STEPS') > 0:
+        rounds = math.ceil(total_steps / config.get('_STEPS'))
+
+    logg.info('will perform {} rounds of {} steps'.format(rounds, config.get('_STEPS')))
+
+    last_tx_hash = None
+    for i in range(rounds):
+        signer = rpc.get_signer()
+        signer_address = rpc.get_sender_address()
+
+        nonce_oracle = rpc.get_nonce_oracle()
+
+        c = DemurrageToken(chain_spec, signer=signer, gas_oracle=gas_oracle, nonce_oracle=nonce_oracle)
+        (tx_hash_hex, o) = c.apply_demurrage(config.get('_EXEC_ADDRESS'), signer_address, limit=config.get('_STEPS'))
+        if config.get('_RPC_SEND'):
+            print(tx_hash_hex)
+            conn.do(o)
+            if config.get('_WAIT_ALL') or (i == rounds - 1 and config.get('_WAIT')):
+                r = conn.wait(tx_hash_hex)
+                if r['status'] == 0:
+                    sys.stderr.write('EVM revert while deploying contract. Wish I had more to tell you')
+                    sys.exit(1)
+        else:
+            print(o)
+
+
+
+if __name__ == '__main__':
+    main()

python/erc20_demurrage_token/runnable/deploy.py

@@ -49,8 +49,8 @@ arg_flags = chainlib.eth.cli.argflag_std_write
 argparser = chainlib.eth.cli.ArgumentParser(arg_flags)
 argparser.add_argument('--name', dest='token_name', type=str, help='Token name')
 argparser.add_argument('--symbol', dest='token_symbol', required=True, type=str, help='Token symbol')
-argparser.add_argument('--decimals', dest='token_decimals', default=18, type=int, help='Token decimals')
-argparser.add_argument('--sink-address', dest='sink_address', default=ZERO_ADDRESS, type=str, help='demurrage level,ppm per minute') 
+argparser.add_argument('--decimals', dest='token_decimals', type=int, help='Token decimals')
+argparser.add_argument('--sink-address', dest='sink_address', type=str, help='demurrage level,ppm per minute') 
 argparser.add_argument('--supply-limit', dest='supply_limit', type=int, help='token supply limit (0 = no limit)')
 argparser.add_argument('--redistribution-period', type=int, help='redistribution period, minutes (0 = deactivate)') # default 10080 = week
 argparser.add_argument('--multi', action='store_true', help='automatic redistribution')
@@ -90,7 +90,6 @@ conn = rpc.connect_by_config(config)
 
 chain_spec = ChainSpec.from_chain_str(config.get('CHAIN_SPEC'))
 
-
 def main():
     signer = rpc.get_signer()
     signer_address = rpc.get_sender_address()

python/erc20_demurrage_token/token.py

@@ -380,6 +380,10 @@ class DemurrageToken(ERC20):
         return self.call_noarg('demurrageAmount', contract_address, sender_address=sender_address)
 
 
+    def demurrage_timestamp(self, contract_address, sender_address=ZERO_ADDRESS):
+        return self.call_noarg('demurrageTimestamp', contract_address, sender_address=sender_address)
+
+
     def supply_cap(self, contract_address, sender_address=ZERO_ADDRESS):
         return self.call_noarg('supplyCap', contract_address, sender_address=sender_address)
 

python/requirements.txt

@@ -1,3 +1,3 @@
-chainlib-eth~=0.0.27
-eth-erc20~=0.1.10
-funga-eth~=0.5.6
+chainlib-eth>=0.1.0,<0.2.0
+eth-erc20~=0.3.0
+funga-eth~=0.6.0

python/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = erc20-demurrage-token
-version = 0.0.10
+version = 0.1.1
 description = ERC20 token with redistributed continual demurrage
 author = Louis Holbrook
 author_email = dev@holbrook.no
@@ -25,12 +25,13 @@ licence_files =
 
 [options]
 include_package_data = True
-python_requires = >= 3.6
+python_requires = >= 3.7
 packages =
 	erc20_demurrage_token
 	erc20_demurrage_token.runnable
 	erc20_demurrage_token.data
 	erc20_demurrage_token.sim
+	erc20_demurrage_token.unittest
 
 [options.package_data]
 * =
@@ -40,3 +41,4 @@ packages =
 [options.entry_points]
 console_scripts =
 	erc20-demurrage-token-deploy = erc20_demurrage_token.runnable.deploy:main
+	erc20-demurrage-token-apply = erc20_demurrage_token.runnable.apply:main