Add burn method + minor bug fixes

python/erc20_demurrage_token/demurrage.py

@@ -9,8 +9,7 @@ from chainlib.eth.constant import ZERO_ADDRESS
 # local imports
 from .token import DemurrageToken
 
-logging.basicConfig(level=logging.DEBUG)
-logg = logging.getLogger()
+logg = logging.getLogger(__name__)
 
 
 class DemurrageCalculator:

python/erc20_demurrage_token/runnable/apply.py

@@ -16,17 +16,7 @@ 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,
-        )
+import chainlib.eth.cli
 from chainlib.eth.block import (
         block_latest,
         block_by_number,
@@ -35,8 +25,20 @@ from chainlib.eth.block import (
 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
+import chainlib.eth.cli
+from chainlib.eth.settings import process_settings
+from chainlib.settings import ChainSettings
+from chainlib.eth.cli.arg import (
+        Arg,
+        ArgFlag,
+        process_args,
+        )
+from chainlib.eth.cli.config import (
+        Config,
+        process_config,
+        )
+from chainlib.eth.cli.log import process_log
 
 # local imports
 import erc20_demurrage_token
@@ -45,32 +47,38 @@ from erc20_demurrage_token import (
         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')
+def process_config_local(config, arg, args, flags):
+    config.add(args.steps, '_STEPS', False)
+    return config
 
-arg_flags = chainlib.eth.cli.argflag_std_write | chainlib.eth.cli.Flag.EXEC
-argparser = chainlib.eth.cli.ArgumentParser(arg_flags)
+
+arg_flags = ArgFlag()
+arg = Arg(arg_flags)
+flags = arg_flags.STD_WRITE | arg_flags.EXEC | arg_flags.WALLET
+
+argparser = chainlib.eth.cli.ArgumentParser()
+argparser = process_args(argparser, 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 = process_log(args, logg)
+
+config = Config()
+config = process_config(config, arg, args, flags)
+config = process_config_local(config, arg, args, flags)
 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'))
+settings = ChainSettings()
+settings = process_settings(settings, config)
+logg.debug('settings loaded:\n{}'.format(settings))
 
 
 def main():
+    chain_spec = settings.get('CHAIN_SPEC')
+    conn = settings.get('CONN')
     o = block_latest()
     r = conn.do(o)
  
@@ -87,9 +95,9 @@ def main():
     block_start_timestamp = block_start.timestamp
     block_start_datetime = datetime.datetime.fromtimestamp(block_start_timestamp)
 
-    gas_oracle = rpc.get_gas_oracle()
+    gas_oracle = settings.get('FEE_ORACLE')
     c = DemurrageToken(chain_spec, gas_oracle=gas_oracle)
-    o = c.demurrage_timestamp(config.get('_EXEC_ADDRESS'))
+    o = c.demurrage_timestamp(settings.get('EXEC'))
     r = conn.do(o)
 
     demurrage_timestamp = None
@@ -120,17 +128,17 @@ def main():
 
     last_tx_hash = None
     for i in range(rounds):
-        signer = rpc.get_signer()
-        signer_address = rpc.get_sender_address()
+        signer = settings.get('SIGNER')
+        signer_address = settings.get('SENDER_ADDRESS')
 
-        nonce_oracle = rpc.get_nonce_oracle()
+        nonce_oracle = settings.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'):
+        if settings.get('RPC_SEND'):
             print(tx_hash_hex)
             conn.do(o)
-            if config.get('_WAIT_ALL') or (i == rounds - 1 and config.get('_WAIT')):
+            if config.true('_WAIT_ALL') or (i == rounds - 1 and config.true('_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')

python/erc20_demurrage_token/runnable/deploy.py

@@ -14,21 +14,22 @@ import logging
 
 # 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.connection import EthHTTPConnection
 from chainlib.eth.tx import receipt
 from chainlib.eth.constant import ZERO_ADDRESS
 import chainlib.eth.cli
+from chainlib.eth.settings import process_settings
+from chainlib.settings import ChainSettings
+from chainlib.eth.cli.arg import (
+        Arg,
+        ArgFlag,
+        process_args,
+        )
+from chainlib.eth.cli.config import (
+        Config,
+        process_config,
+        )
+from chainlib.eth.cli.log import process_log
 
 # local imports
 import erc20_demurrage_token
@@ -37,84 +38,75 @@ from erc20_demurrage_token import (
         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')
+def process_config_local(config, arg, args, flags):
+    config.add(args.token_name, 'TOKEN_NAME', False)
+    config.add(args.token_symbol, 'TOKEN_SYMBOL', False)
+    config.add(args.token_decimals, 'TOKEN_DECIMALS', False)
+    config.add(args.sink_address, 'TOKEN_SINK_ADDRESS', False)
+    config.add(args.redistribution_period, 'TOKEN_REDISTRIBUTION_PERIOD', False)
+    config.add(args.demurrage_level, 'TOKEN_DEMURRAGE_LEVEL', False)
+    config.add(0, 'TOKEN_SUPPLY_LIMIT', False)
+    return config
 
-arg_flags = chainlib.eth.cli.argflag_std_write
-argparser = chainlib.eth.cli.ArgumentParser(arg_flags)
+
+arg_flags = ArgFlag()
+arg = Arg(arg_flags)
+flags = arg_flags.STD_WRITE | arg_flags.EXEC | arg_flags.WALLET
+
+argparser = chainlib.eth.cli.ArgumentParser()
+argparser = process_args(argparser, 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', 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')
+#argparser.add_argument('--supply-limit', dest='supply_limit', type=int, help='token supply limit (0 = no limit)')
+argparser.add_argument('--redistribution-period', dest='redistribution_period', type=int, help='redistribution period, minutes (0 = deactivate)') # default 10080 = week
+#argparser.add_argument('--multi', action='store_true', help='automatic redistribution')
 argparser.add_argument('--demurrage-level', dest='demurrage_level', type=int, help='demurrage level, ppm per minute') 
 args = argparser.parse_args()
 
-arg_flags = chainlib.eth.cli.argflag_std_write
+logg = process_log(args, logg)
 
-extra_args = {
-        'redistribution_period': 'TOKEN_REDISTRIBUTION_PERIOD',
-        'demurrage_level': 'TOKEN_DEMURRAGE_LEVEL',
-        'supply_limit': 'TOKEN_SUPPLY_LIMIT',
-        'token_name': 'TOKEN_NAME',
-        'token_symbol': 'TOKEN_SYMBOL',
-        'token_decimals': 'TOKEN_DECIMALS',
-        'sink_address': 'TOKEN_SINK_ADDRESS',
-        'multi': None,
-        }
-config = chainlib.eth.cli.Config.from_args(args, arg_flags, extra_args=extra_args, default_fee_limit=DemurrageToken.gas(), base_config_dir=config_dir)
-
-if not bool(config.get('TOKEN_NAME')):
-    logg.info('token name not set, using symbol {} as name'.format(config.get('TOKEN_SYMBOL')))
-    config.add(config.get('TOKEN_SYMBOL'), 'TOKEN_NAME', True)
-
-if config.get('TOKEN_SUPPLY_LIMIT') == None:
-    config.add(0, 'TOKEN_SUPPLY_LIMIT', True)
-
-if config.get('TOKEN_REDISTRIBUTION_PERIOD') == None:
-    config.add(10800, 'TOKEN_REDISTRIBUTION_PERIOD', True)
+config = Config()
+config = process_config(config, arg, args, flags)
+config = process_config_local(config, arg, args, flags)
 logg.debug('config loaded:\n{}'.format(config))
 
-wallet = chainlib.eth.cli.Wallet()
-wallet.from_config(config)
+settings = ChainSettings()
+settings = process_settings(settings, config)
+logg.debug('settings loaded:\n{}'.format(settings))
 
-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():
-    signer = rpc.get_signer()
-    signer_address = rpc.get_sender_address()
+    chain_spec = settings.get('CHAIN_SPEC')
+    conn = settings.get('CONN')
+    signer = settings.get('SIGNER')
+    signer_address = settings.get('SENDER_ADDRESS')
 
-    gas_oracle = rpc.get_gas_oracle()
-    nonce_oracle = rpc.get_nonce_oracle()
+    gas_oracle = settings.get('FEE_ORACLE')
+    nonce_oracle = settings.get('NONCE_ORACLE')
 
     c = DemurrageToken(chain_spec, signer=signer, gas_oracle=gas_oracle, nonce_oracle=nonce_oracle)
-    settings = DemurrageTokenSettings()
-    settings.name = config.get('TOKEN_NAME')
-    settings.symbol = config.get('TOKEN_SYMBOL')
-    settings.decimals = int(config.get('TOKEN_DECIMALS'))
-    settings.demurrage_level = int(config.get('TOKEN_DEMURRAGE_LEVEL'))
-    settings.period_minutes = int(config.get('TOKEN_REDISTRIBUTION_PERIOD'))
-    settings.sink_address = config.get('TOKEN_SINK_ADDRESS')
+    token_settings = DemurrageTokenSettings()
+    token_settings.name = config.get('TOKEN_NAME')
+    token_settings.symbol = config.get('TOKEN_SYMBOL')
+    token_settings.decimals = int(config.get('TOKEN_DECIMALS'))
+    token_settings.demurrage_level = int(config.get('TOKEN_DEMURRAGE_LEVEL'))
+    token_settings.period_minutes = int(config.get('TOKEN_REDISTRIBUTION_PERIOD'))
+    token_settings.sink_address = config.get('TOKEN_SINK_ADDRESS')
 
     (tx_hash_hex, o) = c.constructor(
             signer_address,
-            settings,
+            token_settings,
             redistribute=config.true('_MULTI'),
             cap=int(config.get('TOKEN_SUPPLY_LIMIT')),
             )
-    if config.get('_RPC_SEND'):
+    if settings.get('RPC_SEND'):
         conn.do(o)
-        if config.get('_WAIT'):
+        if config.true('_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')

python/erc20_demurrage_token/token.py

@@ -117,6 +117,34 @@ class DemurrageToken(ERC20):
         return DemurrageToken.__bytecode[name]
 
 
+    def increase_allowance(self, contract_address, sender_address, address, value, tx_format=TxFormat.JSONRPC):
+        enc = ABIContractEncoder()
+        enc.method('increaseAllowance')
+        enc.typ(ABIContractType.ADDRESS)
+        enc.typ(ABIContractType.UINT256)
+        enc.address(address)
+        enc.uint256(value)
+        data = enc.get()
+        tx = self.template(sender_address, contract_address, use_nonce=True)
+        tx = self.set_code(tx, data)
+        tx = self.finalize(tx, tx_format)
+        return tx
+
+
+    def decrease_allowance(self, contract_address, sender_address, address, value, tx_format=TxFormat.JSONRPC):
+        enc = ABIContractEncoder()
+        enc.method('decreaseAllowance')
+        enc.typ(ABIContractType.ADDRESS)
+        enc.typ(ABIContractType.UINT256)
+        enc.address(address)
+        enc.uint256(value)
+        data = enc.get()
+        tx = self.template(sender_address, contract_address, use_nonce=True)
+        tx = self.set_code(tx, data)
+        tx = self.finalize(tx, tx_format)
+        return tx
+
+
     def add_minter(self, contract_address, sender_address, address, tx_format=TxFormat.JSONRPC):
         enc = ABIContractEncoder()
         enc.method('addMinter')
@@ -155,6 +183,33 @@ class DemurrageToken(ERC20):
         return tx
 
 
+    def burn(self, contract_address, sender_address, value, tx_format=TxFormat.JSONRPC):
+        enc = ABIContractEncoder()
+        enc.method('burn')
+        enc.typ(ABIContractType.UINT256)
+        enc.uint256(value)
+        data = enc.get()
+        tx = self.template(sender_address, contract_address, use_nonce=True)
+        tx = self.set_code(tx, data)
+        tx = self.finalize(tx, tx_format)
+        return tx
+
+
+    def total_burned(self, contract_address, sender_address=ZERO_ADDRESS, id_generator=None):
+        j = JSONRPCRequest(id_generator)
+        o = j.template()
+        o['method'] = 'eth_call'
+        enc = ABIContractEncoder()
+        enc.method('totalBurned')
+        data = add_0x(enc.get())
+        tx = self.template(sender_address, contract_address)
+        tx = self.set_code(tx, data)
+        o['params'].append(self.normalize(tx))
+        o['params'].append('latest')
+        o = j.finalize(o)
+        return o
+
+
     def to_base_amount(self, contract_address, value, sender_address=ZERO_ADDRESS, id_generator=None):
         j = JSONRPCRequest(id_generator)
         o = j.template()
@@ -526,6 +581,7 @@ class DemurrageToken(ERC20):
     def parse_supply_cap(self, v):
         return abi_decode_single(ABIContractType.UINT256, v)
 
+
     @classmethod
     def parse_grow_by(self, v):
         return abi_decode_single(ABIContractType.UINT256, v)
@@ -549,3 +605,8 @@ class DemurrageToken(ERC20):
     @classmethod
     def parse_resolution_factor(self, v):
         return abi_decode_single(ABIContractType.UINT256, v)
+
+
+    @classmethod
+    def parse_total_burned(self, v):
+        return abi_decode_single(ABIContractType.UINT256, v)

python/erc20_demurrage_token/unittest/base.py

@@ -20,7 +20,7 @@ from erc20_demurrage_token import (
         DemurrageToken,
         )
 
-logg = logging.getLogger()
+logg = logging.getLogger(__name__)
 
 #BLOCKTIME = 5 # seconds
 TAX_LEVEL = int(10000 * 2) # 2%
@@ -95,13 +95,6 @@ class TestDemurrage(EthTesterCase):
 
     def setUp(self):
         super(TestDemurrage, self).setUp()
-#        token_deploy = TestTokenDeploy()
-#        self.settings = token_deploy.settings
-#        self.sink_address = token_deploy.sink_address
-#        self.start_block = token_deploy.start_block
-#        self.start_time = token_deploy.start_time
-#        self.default_supply = self.default_supply
-#        self.default_supply_cap = self.default_supply_cap
         period = PERIOD
         try:
             period = getattr(self, 'period')
@@ -133,6 +126,13 @@ class TestDemurrage(EthTesterCase):
         logg.debug('asserted within lower {} <= {} <= {}'.format(lower_target, v, target))
 
 
+    def assert_within_greater(self, v, target, tolerance_ppm):
+        higher_target = target + (target * (tolerance_ppm / 1000000))
+        self.assertLessEqual(v, higher_target)
+        self.assertGreaterEqual(v, target)
+        logg.debug('asserted within lower {} <= {} <= {}'.format(target, v, higher_target))
+
+
     def tearDown(self):
         pass