Add contract metadata

python/eth_faucet/data/EthFaucet.json

@@ -1 +1 @@
-[{"inputs":[],"stateMutability":"nonpayable","type":"constructor"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint256","name":"_amount","type":"uint256"}],"name":"FaucetAmountChange","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"_recipient","type":"address"},{"indexed":true,"internalType":"address","name":"_token","type":"address"},{"indexed":false,"internalType":"uint256","name":"_amount","type":"uint256"}],"name":"FaucetFail","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"uint256","name":"_sealState","type":"uint256"},{"indexed":false,"internalType":"address","name":"_registry","type":"address"},{"indexed":false,"internalType":"address","name":"_periodChecker","type":"address"}],"name":"FaucetStateChange","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"_recipient","type":"address"},{"indexed":true,"internalType":"address","name":"_token","type":"address"},{"indexed":false,"internalType":"uint256","name":"_amount","type":"uint256"}],"name":"FaucetUsed","type":"event"},{"anonymous":false,"inputs":[],"name":"ImNotGassy","type":"event"},{"inputs":[],"name":"amount","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"gimme","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"_recipient","type":"address"}],"name":"giveTo","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"maxSealState","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"owner","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"periodChecker","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"registry","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"_state","type":"uint256"}],"name":"seal","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"sealState","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"_v","type":"uint256"}],"name":"setAmount","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"_checker","type":"address"}],"name":"setPeriodChecker","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"_registry","type":"address"}],"name":"setRegistry","outputs":[],"stateMutability":"nonpayable","type":"function"},{"stateMutability":"payable","type":"receive"}]
+[{"inputs":[],"stateMutability":"nonpayable","type":"constructor"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint256","name":"_amount","type":"uint256"}],"name":"FaucetAmountChange","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"_recipient","type":"address"},{"indexed":true,"internalType":"address","name":"_token","type":"address"},{"indexed":false,"internalType":"uint256","name":"_amount","type":"uint256"}],"name":"Give","type":"event"},{"anonymous":false,"inputs":[],"name":"ImNotGassy","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"uint256","name":"_sealState","type":"uint256"},{"indexed":false,"internalType":"address","name":"_registry","type":"address"},{"indexed":false,"internalType":"address","name":"_periodChecker","type":"address"}],"name":"SealStateChange","type":"event"},{"inputs":[{"internalType":"address","name":"_recipient","type":"address"}],"name":"check","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"gimme","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"_recipient","type":"address"}],"name":"giveTo","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"maxSealState","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"_subject","type":"address"}],"name":"nextTime","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"owner","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"periodChecker","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"registry","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"_state","type":"uint256"}],"name":"seal","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"sealState","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"_v","type":"uint256"}],"name":"setAmount","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"_checker","type":"address"}],"name":"setPeriodChecker","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"_registry","type":"address"}],"name":"setRegistry","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"token","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"pure","type":"function"},{"inputs":[],"name":"tokenAmount","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"stateMutability":"payable","type":"receive"}]

python/eth_faucet/data/EthFaucet.metadata.json

@@ -0,0 +1 @@
+{"compiler":{"version":"0.8.18+commit.87f61d96"},"language":"Solidity","output":{"abi":[{"inputs":[],"stateMutability":"nonpayable","type":"constructor"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint256","name":"_amount","type":"uint256"}],"name":"FaucetAmountChange","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"_recipient","type":"address"},{"indexed":true,"internalType":"address","name":"_token","type":"address"},{"indexed":false,"internalType":"uint256","name":"_amount","type":"uint256"}],"name":"Give","type":"event"},{"anonymous":false,"inputs":[],"name":"ImNotGassy","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"uint256","name":"_sealState","type":"uint256"},{"indexed":false,"internalType":"address","name":"_registry","type":"address"},{"indexed":false,"internalType":"address","name":"_periodChecker","type":"address"}],"name":"SealStateChange","type":"event"},{"inputs":[{"internalType":"address","name":"_recipient","type":"address"}],"name":"check","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"gimme","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"_recipient","type":"address"}],"name":"giveTo","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"maxSealState","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"_subject","type":"address"}],"name":"nextTime","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"owner","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"periodChecker","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"registry","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"_state","type":"uint256"}],"name":"seal","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"sealState","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"_v","type":"uint256"}],"name":"setAmount","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"_checker","type":"address"}],"name":"setPeriodChecker","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"_registry","type":"address"}],"name":"setRegistry","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"token","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"pure","type":"function"},{"inputs":[],"name":"tokenAmount","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"stateMutability":"payable","type":"receive"}],"devdoc":{"kind":"dev","methods":{},"version":1},"userdoc":{"kind":"user","methods":{},"version":1}},"settings":{"compilationTarget":{"EthFaucet.sol":"EthFacuet"},"evmVersion":"byzantium","libraries":{},"metadata":{"bytecodeHash":"ipfs"},"optimizer":{"enabled":false,"runs":200},"remappings":[]},"sources":{"EthFaucet.sol":{"keccak256":"0x4eee39d6ae6437809f3dc9a38a6541224c66586a6e1735411946386af156efc5","license":"GPL-3.0-or-later","urls":["bzz-raw://ffb6836ece8743ce991344bb7cbfe615c5193cc8976e334bbc87c545a502a76c","dweb:/ipfs/QmcromwDBMiPDKJKRA4ygWDwF9t3MvE4BNdgmQMYcERX6R"]}},"version":1}

python/eth_faucet/data/PeriodSimple.json

@@ -1 +1 @@
-[{"inputs":[],"stateMutability":"nonpayable","type":"constructor"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint256","name":"_value","type":"uint256"}],"name":"PeriodChange","type":"event"},{"inputs":[],"name":"balanceThreshold","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"_subject","type":"address"}],"name":"check","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"","type":"address"}],"name":"lastUsed","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"owner","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"period","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"_subject","type":"address"}],"name":"poke","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"poker","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"_threshold","type":"uint256"}],"name":"setBalanceThreshold","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"_period","type":"uint256"}],"name":"setPeriod","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"_poker","type":"address"}],"name":"setPoker","outputs":[],"stateMutability":"nonpayable","type":"function"}]
+[{"inputs":[],"stateMutability":"nonpayable","type":"constructor"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint256","name":"_value","type":"uint256"}],"name":"BalanceThresholdChange","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint256","name":"_value","type":"uint256"}],"name":"PeriodChange","type":"event"},{"inputs":[],"name":"balanceThreshold","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"_subject","type":"address"}],"name":"check","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"","type":"address"}],"name":"lastUsed","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"_subject","type":"address"}],"name":"next","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"owner","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"period","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"_subject","type":"address"}],"name":"poke","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"poker","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"_threshold","type":"uint256"}],"name":"setBalanceThreshold","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"_period","type":"uint256"}],"name":"setPeriod","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"_poker","type":"address"}],"name":"setPoker","outputs":[],"stateMutability":"nonpayable","type":"function"}]

python/eth_faucet/data/PeriodSimple.metadata.json

@@ -0,0 +1 @@
+{"compiler":{"version":"0.8.18+commit.87f61d96"},"language":"Solidity","output":{"abi":[{"inputs":[],"stateMutability":"nonpayable","type":"constructor"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint256","name":"_value","type":"uint256"}],"name":"BalanceThresholdChange","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint256","name":"_value","type":"uint256"}],"name":"PeriodChange","type":"event"},{"inputs":[],"name":"balanceThreshold","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"_subject","type":"address"}],"name":"check","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"","type":"address"}],"name":"lastUsed","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"_subject","type":"address"}],"name":"next","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"owner","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"period","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"_subject","type":"address"}],"name":"poke","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"poker","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"_threshold","type":"uint256"}],"name":"setBalanceThreshold","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"_period","type":"uint256"}],"name":"setPeriod","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"_poker","type":"address"}],"name":"setPoker","outputs":[],"stateMutability":"nonpayable","type":"function"}],"devdoc":{"kind":"dev","methods":{},"version":1},"userdoc":{"kind":"user","methods":{},"version":1}},"settings":{"compilationTarget":{"PeriodSimple.sol":"PeriodSimple"},"evmVersion":"byzantium","libraries":{},"metadata":{"bytecodeHash":"ipfs"},"optimizer":{"enabled":false,"runs":200},"remappings":[]},"sources":{"PeriodSimple.sol":{"keccak256":"0xaa53391796f933e59e3c6809d3a19e35623f78ca90f20386c14d3b4845df62d3","license":"GPL-3.0-or-later","urls":["bzz-raw://e8ab3b6c5568c7907c2e515e43c68da038629f5adcb576083a73ede9a4879661","dweb:/ipfs/QmUSY345fKi8Neq2pkKPGbyMYV9bmHALFtj3QviodprEQr"]}},"version":1}

python/eth_faucet/faucet.py

@@ -17,6 +17,7 @@ from chainlib.eth.contract import (
         ABIContractType,
         )
 from chainlib.eth.tx import TxFormat
+from chainlib.jsonrpc import JSONRPCRequest
 from erc20_faucet import Faucet
 from hexathon import add_0x
 
@@ -86,3 +87,21 @@ class EthFaucet(Faucet):
         tx = self.set_code(tx, data)
         tx = self.finalize(tx, tx_format)
         return tx
+
+
+    def check(self, contract_address, address, sender_address=ZERO_ADDRESS, id_generator=None):
+        j = JSONRPCRequest(id_generator)
+        o = j.template()
+        o['method'] = 'eth_call'
+        enc = ABIContractEncoder()
+        enc.method('check')
+        enc.typ(ABIContractType.ADDRESS)
+        enc.address(address)
+        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
+

python/eth_faucet/runnable/gen.py

@@ -0,0 +1,27 @@
+# standard imports
+import sys
+import os
+import argparse
+
+script_dir=os.path.dirname(os.path.realpath(__file__))
+data_dir=os.path.join(script_dir, '..', 'data')
+
+tr={
+        'faucet': 'EthFaucet',
+        'period': 'PeriodSimple',
+        }
+
+argparser = argparse.ArgumentParser()
+argparser.add_argument('name', type=str, default='faucet', choices=['faucet', 'period'], help='list code identifiers')
+args = argparser.parse_args(sys.argv[1:])
+
+def main():
+    fp = os.path.join(data_dir, tr[args.name] + '.bin')
+    f = open(fp, 'r')
+    r = f.read()
+    f.close()
+    print(r)
+
+
+if __name__ == '__main__':
+    main()

python/eth_faucet/runnable/publish.py

@@ -0,0 +1,88 @@
+"""Deploys accounts index, registering arbitrary number of writers
+
+.. moduleauthor:: Louis Holbrook <dev@holbrook.no>
+.. pgp:: 0826EDA1702D1E87C6E2875121D2E7BB88C2A746 
+
+"""
+
+# standard imports
+import sys
+import os
+import logging
+
+# external imports
+import chainlib.eth.cli
+from chainlib.chain import ChainSpec
+from chainlib.eth.connection import EthHTTPConnection
+from chainlib.eth.tx import receipt
+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
+from chainlib.eth.settings import process_settings
+from chainlib.settings import ChainSettings
+
+# local imports
+from eth_faucet import EthFaucet
+
+logging.basicConfig(level=logging.WARNING)
+logg = logging.getLogger()
+
+arg_flags = ArgFlag()
+arg = Arg(arg_flags)
+flags = arg_flags.STD_WRITE 
+
+argparser = chainlib.eth.cli.ArgumentParser()
+argparser = process_args(argparser, arg, flags)
+args = argparser.parse_args()
+
+logg = process_log(args, logg)
+
+config = Config()
+config = process_config(config, arg, args, flags)
+logg.debug('config loaded:\n{}'.format(config))
+
+settings = ChainSettings()
+settings = process_settings(settings, config)
+logg.debug('settings loaded:\n{}'.format(settings))
+
+
+def main():
+    conn = settings.get('CONN')
+
+    c = EthFaucet(
+            settings.get('CHAIN_SPEC'),
+            signer=settings.get('SIGNER'),
+            gas_oracle=settings.get('FEE_ORACLE'),
+            nonce_oracle=settings.get('NONCE_ORACLE'),
+            )
+
+    (tx_hash_hex, o) = c.constructor(
+            settings.get('SENDER_ADDRESS'),
+            )
+
+    if settings.get('RPC_SEND'):
+        conn.do(o)
+        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')
+                sys.exit(1)
+            # TODO: pass through translator for keys (evm tester uses underscore instead of camelcase)
+            address = r['contractAddress']
+
+            print(address)
+        else:
+            print(tx_hash_hex)
+    else:
+        print(o)
+
+
+if __name__ == '__main__':
+    main()

python/requirements.txt

@@ -1,2 +1,2 @@
 chainlib-eth~=0.4.8
-erc20-faucet~=0.5.0
+erc20-faucet~=0.6.0

python/setup.cfg

@@ -1,10 +1,10 @@
 [metadata]
 name = eth-faucet
-version = 0.1.0
+version = 0.2.0
 description = Gas token gifter with controls from time intervals, amounts and access.
 author = Louis Holbrook
 author_email = dev@holbrook.no
-url = https://git.grassecon.net/cicnet/eth-faucet
+url = https://git.defalsify.org/eth-faucet
 keywords =
 	ethereum
 classifiers =
@@ -24,8 +24,8 @@ licence_files =
 include_package_data = True
 python_requires = >= 3.6
 packages = 
-	eth_accounts_index
-	eth_accounts_index.runnable
+	eth_faucet
+	eth_faucet.runnable
 
 [options.extras_require]
 testing = 
@@ -38,6 +38,7 @@ testing =
  	**/data/*.json
  	**/data/*.bin
 
-#[options.entry_points]
-#console_scripts =
-	#eth-faucet-publish = eth_faucet.runnable.publish:main
+[options.entry_points]
+console_scripts =
+	eth-faucet-publish = eth_faucet.runnable.publish:main
+	eth-faucet-gen = eth_faucet.runnable.gen:main

python/tests/test_period.py

@@ -35,13 +35,12 @@ class TestFaucetPeriod(EthTesterCase):
     def setUp(self):
         super(TestFaucetPeriod, self).setUp()
         # DRY
+        self.conn = RPCConnection.connect(self.chain_spec, 'default')
+        nonce_oracle = RPCNonceOracle(self.accounts[0], self.conn)
         c = PeriodSimple(self.chain_spec, signer=self.signer, nonce_oracle=nonce_oracle)
         (tx_hash_hex, o) = c.constructor(self.accounts[0])
         r = self.conn.do(o)
 
-        self.conn = RPCConnection.connect(self.chain_spec, 'default')
-        nonce_oracle = RPCNonceOracle(self.accounts[0], self.conn)
-
         f = open(os.path.join(datadir, 'PeriodSimple.bin'))
         period_store_bytecode = f.read()
         f.close()
@@ -207,5 +206,39 @@ class TestFaucetPeriod(EthTesterCase):
         self.assertEqual(r['status'], 1)
 
 
+    def test_period_front(self):
+        nonce_oracle = RPCNonceOracle(self.accounts[0], self.conn)
+        c = TxFactory(self.chain_spec, signer=self.signer, nonce_oracle=nonce_oracle)
+        enc = ABIContractEncoder()
+        enc.method('setPeriod')
+        enc.typ(ABIContractType.UINT256)
+        enc.uint256(100)
+        data = enc.get()
+        tx = c.template(self.accounts[0], self.period_store_address, use_nonce=True)
+        tx = c.set_code(tx, data)
+        (tx_hash_hex, o) = c.finalize(tx)
+        self.conn.do(o)
+   
+        nonce_oracle = RPCNonceOracle(self.accounts[0], self.conn)
+        c = EthFaucet(self.chain_spec, signer=self.signer, nonce_oracle=nonce_oracle)
+        (tx_hash_hex, o) = c.gimme(self.address, self.accounts[0])
+        self.conn.do(o)
+        o = receipt(tx_hash_hex)
+        r = self.conn.do(o)
+        o = block_by_number(r['block_number'])
+        r = self.conn.do(o)
+        thistime = r['timestamp']
+
+        o = c.next_time(self.address, self.accounts[0], sender_address=self.accounts[0])
+        r = self.conn.do(o)
+        nexttime = int(r, 16)
+        self.assertEqual(nexttime, thistime+100)
+
+        o = c.check(self.address, self.accounts[0], sender_address=self.accounts[0])
+        r = self.conn.do(o)
+        checked = int(r, 16)
+        self.assertEqual(checked, 0)
+
+
 if __name__ == '__main__':
     unittest.main()

python/tests/test_registry.py

@@ -104,5 +104,17 @@ class TestFaucetRegistry(EthTesterCase):
         self.assertEqual(r['status'], 1)
 
 
+    def test_transparent(self):
+        nonce_oracle = RPCNonceOracle(self.accounts[0], self.conn)
+        c = EthFaucet(self.chain_spec, signer=self.signer, nonce_oracle=nonce_oracle)
+        o = c.check(self.address, self.accounts[2], sender_address=self.accounts[0])
+        r = self.conn.do(o)
+        self.assertEqual(int(r, 16), 0)
+
+        o = c.check(self.address, self.accounts[1], sender_address=self.accounts[0])
+        r = self.conn.do(o)
+        self.assertEqual(int(r, 16), 1)
+
+
 if __name__ == '__main__':
     unittest.main()

solidity/EthFaucet.sol

@@ -8,17 +8,16 @@ contract EthFacuet {
 	address public registry;
 	address public periodChecker;
 	uint256 public sealState;
-	uint256 public amount;
+	uint256 amount;
 
 	uint8 constant REGISTRY_STATE = 1;
 	uint8 constant PERIODCHECKER_STATE = 2;
 	uint8 constant VALUE_STATE = 4;
 	uint256 constant public maxSealState = 7;
 
-	event FaucetUsed(address indexed _recipient, address indexed _token, uint256 _amount);
-	event FaucetFail(address indexed _recipient, address indexed _token, uint256 _amount);
+	event Give(address indexed _recipient, address indexed _token, uint256 _amount);
 	event FaucetAmountChange(uint256 _amount);
-	event FaucetStateChange(uint256 indexed _sealState, address _registry, address _periodChecker);
+	event SealStateChange(uint256 indexed _sealState, address _registry, address _periodChecker);
 	event ImNotGassy();
 
 	constructor() {
@@ -29,7 +28,7 @@ contract EthFacuet {
 		require(_state < 8, 'ERR_INVALID_STATE');
 		require(_state & sealState == 0, 'ERR_ALREADY_LOCKED');
 		sealState |= _state;
-		emit FaucetStateChange(sealState, registry, periodChecker);
+		emit SealStateChange(sealState, registry, periodChecker);
 		return uint256(sealState);
 	}
 
@@ -45,86 +44,119 @@ contract EthFacuet {
 		require(msg.sender == owner, 'ERR_NOT_OWNER');
 		require(sealState & PERIODCHECKER_STATE == 0, 'ERR_SEALED');
 		periodChecker = _checker;
-		emit FaucetStateChange(sealState, registry, periodChecker);
+		emit SealStateChange(sealState, registry, periodChecker);
 	}
 
 	function setRegistry(address _registry) public {
 		require(msg.sender == owner, 'ERR_NOT_OWNER');
 		require(sealState & REGISTRY_STATE == 0, 'ERR_SEALED');
 		registry = _registry;
-		emit FaucetStateChange(sealState, registry, periodChecker);
+		emit SealStateChange(sealState, registry, periodChecker);
 	}
 
 	function checkPeriod(address _recipient) private returns(bool) {
 		bool _ok;
 		bytes memory _result;
 
-		(_ok, _result) = periodChecker.call(abi.encodeWithSignature("check(address)", _recipient));
-		if (!_ok) {
-			emit FaucetFail(_recipient, address(0), amount);
-			revert('ERR_PERIOD_BACKEND_ERROR');
-		}
-		if (_result[31] == 0) {
-			emit FaucetFail(_recipient, address(0), amount);
-			revert('ERR_PERIOD_CHECK');
+		if (periodChecker == address(0)) {
+			return true;
 		}
 
-		(_ok, _result) = periodChecker.call(abi.encodeWithSignature("poke(address)", _recipient));
+		(_ok, _result) = periodChecker.call(abi.encodeWithSignature("check(address)", _recipient));
 		if (!_ok) {
-			emit FaucetFail(_recipient, address(0), amount);
-			revert('ERR_REGISTRY_BACKEND_ERROR');
+			revert('ERR_PERIOD_BACKEND');
 		}
-		return true;
+		return _result[31] == 0x01;
 	}
 
 	function checkRegistry(address _recipient) private returns(bool) {
 		bool _ok;
 		bytes memory _result;
 
+		if (registry == address(0)) {
+			return true;
+		}
+
 		(_ok, _result) = registry.call(abi.encodeWithSignature("have(address)", _recipient));
 		if (!_ok) {
-			emit FaucetFail(_recipient, address(0), amount);
-			revert('ERR_TRANSFER');
+			revert('ERR_REGISTRY_BACKEND');
 		}
+		return _result[31] == 0x01;
+	}
+
+	function checkBalance() private view returns(bool) {
+		return amount >= address(this).balance;
+	}
+
+	function check(address _recipient) public returns(bool) {
+		if (!checkPeriod(_recipient)) {
+			return false;
+		}
+		if (!checkRegistry(_recipient)) {
+			return false;
+		}
+		return checkBalance();
+	}
+	
+	function checkAndPoke(address _recipient) private returns(bool){
+		bool _ok;
+		bytes memory _result;
+
+		if (!checkBalance()) {
+			revert('ERR_INSUFFICIENT_BALANCE');
+		}
+
+		if (!checkRegistry(_recipient)) {
+			revert('ERR_NOT_IN_WHITELIST');
+		}
+
+		if (periodChecker == address(0)) {
+			return true;
+		}
+
+		(_ok, _result) = periodChecker.call(abi.encodeWithSignature("poke(address)", _recipient));
+		if (!_ok) {
+			revert('ERR_PERIOD_BACKEND');
+		} 
 		if (_result[31] == 0) {
-			emit FaucetFail(_recipient, address(0), amount);
-			revert('ERR_REGISTRY_CHECK');
+			revert('ERR_PERIOD_CHECK');
 		}
-
-		emit FaucetUsed(_recipient, address(0), amount);
-		return true;
-	}
-
-	function checkBalance() private {
-		if (amount > address(this).balance) {
-			emit ImNotGassy();
-			revert('ERR_ITSNOTAGAS');
-		}
-	}
-
-	function check(address _recipient) private returns(bool) {
-		if (periodChecker != address(0)) {
-			checkPeriod(_recipient);
-		}
-		if (registry != address(0)) {
-			checkRegistry(_recipient);
-		}
-		checkBalance();
 		return true;
 	}
 
 	function gimme() public returns(uint256) {
-		require(check(msg.sender));
+		require(checkAndPoke(msg.sender));
 		payable(msg.sender).transfer(amount);
+		emit Give(msg.sender, address(0), amount);
 		return amount;
 	}
 
 	function giveTo(address _recipient) public returns(uint256) {
-		require(check(_recipient));
+		require(checkAndPoke(_recipient));
 		payable(_recipient).transfer(amount);
+		emit Give(_recipient, address(0), amount);
 		return amount;
 	}
 
+	function nextTime(address _subject) public returns(uint256) {
+		bool _ok;
+		bytes memory _result;
+
+		(_ok, _result) = periodChecker.call(abi.encodeWithSignature("next(address)", _subject));
+		if (!_ok) {
+			revert('ERR_PERIOD_BACKEND_ERROR');
+		}
+		return uint256(bytes32(_result));
+	}
+
+	function tokenAmount() public view returns(uint256) {
+		return amount;
+	}
+
+	function token() public pure returns(address) {
+		return address(0);
+	}
+
 	receive () payable external {
 	}
 }

solidity/Makefile

@@ -2,12 +2,15 @@ SOLC = /usr/bin/solc
 
 all:
 	$(SOLC) --bin EthFaucet.sol --evm-version byzantium | awk 'NR>3' > EthFaucet.bin
-	truncate -s -1 EthFaucet.bin
 	$(SOLC) --abi EthFaucet.sol --evm-version byzantium | awk 'NR>3' > EthFaucet.json
+	$(SOLC) --metadata EthFaucet.sol --evm-version byzantium | awk 'NR>3' > EthFaucet.metadata.json
 	$(SOLC) --bin PeriodSimple.sol --evm-version byzantium | awk 'NR>3' > PeriodSimple.bin
-	truncate -s -1 PeriodSimple.bin
 	$(SOLC) --abi PeriodSimple.sol --evm-version byzantium | awk 'NR==4' > PeriodSimple.json
+	$(SOLC) --metadata PeriodSimple.sol --evm-version byzantium | awk 'NR==4' > PeriodSimple.metadata.json
+	truncate -s -1 EthFaucet.bin
+	truncate -s -1 PeriodSimple.bin
 
 install: all
-	cp -v *{json,bin} ../python/eth_faucet/data/
+	cp -v *.json ../python/eth_faucet/data/
+	cp -v *.bin ../python/eth_faucet/data/
 

solidity/PeriodSimple.sol

@@ -11,7 +11,7 @@ contract PeriodSimple {
 	mapping (address => uint256) public lastUsed;
 
 	event PeriodChange(uint256 _value);
-
+	event BalanceThresholdChange(uint256 _value);
 	constructor() {
 		owner = msg.sender;
 		poker = owner;
@@ -20,6 +20,7 @@ contract PeriodSimple {
 	function setPeriod(uint256 _period) public {
 		require(owner == msg.sender, 'ERR_NOT_OWNER');
 		period = _period;
+		emit PeriodChange(_period);
 	}
 
 	function setPoker(address _poker) public {
@@ -30,19 +31,25 @@ contract PeriodSimple {
 	function setBalanceThreshold(uint256 _threshold) public {
 		require(msg.sender == owner);
 		balanceThreshold = _threshold;
+		emit BalanceThresholdChange(_threshold);
 	}
 
-	function check(address _subject) public view returns(bool) {
+	function next(address _subject) external view returns(uint256) {
+		return lastUsed[_subject] + period;
+	}
+	
+	function check(address _subject) external view returns(bool) {
 		require(_subject.balance >= balanceThreshold);
 		if (lastUsed[_subject] == 0) {
 			return true;
 		}
-		return block.timestamp > lastUsed[_subject] + period;
+		return block.timestamp > this.next(_subject);
 	}
 
-	function poke(address _subject) public {
+	function poke(address _subject) external returns(bool) {
 		require(msg.sender == owner || msg.sender == poker, 'ERR_ACCESS');
-		require(check(_subject), 'ERR_PREMATURE');
+		require(this.check(_subject), 'ERR_PREMATURE');
 		lastUsed[_subject] = block.timestamp;
+		return true;
 	}
 }