Add giftable token contract metadata

python/CHANGELOG

@@ -1,3 +1,9 @@
+* 0.6.2
+	- Add Giftable Token contract metadata
+* 0.6.1
+	- Add explicit burn (reduces supply) to giftable token
+* 0.6.0
+	- Add token expiry to giftable token
 * 0.5.6
 	- Remove name and symbol lookup
 	- Remove decimals lookup for raw output

python/eth_erc20/unittest/base.py

@@ -0,0 +1,169 @@
+# standard imports
+import logging
+
+# external imports
+from chainlib.eth.unittest.ethtester import EthTesterCase
+from chainlib.eth.nonce import RPCNonceOracle
+from chainlib.eth.gas import OverrideGasOracle
+from chainlib.eth.tx import (
+        transaction,
+        receipt,
+        )
+from hexathon import strip_0x
+
+# local imports
+from giftable_erc20_token.unittest import TestGiftableToken
+from eth_erc20 import ERC20
+
+logging.basicConfig(level=logging.DEBUG)
+logg = logging.getLogger(__name__)
+
+
+class TestInterface:
+
+    def test_balance(self):
+        c = ERC20(self.chain_spec)
+        o = c.balance_of(self.address, self.accounts[0], sender_address=self.accounts[0])
+        r = self.conn.do(o)
+        balance = ERC20.parse_balance(r)
+        self.assertEqual(self.initial_supply, balance)
+
+
+    def test_supply(self):
+        c = ERC20(self.chain_spec)
+        o = c.total_supply(self.address, sender_address=self.accounts[0])
+        r = self.conn.do(o)
+        supply = ERC20.parse_total_supply(r)
+        self.assertEqual(self.initial_supply, supply)
+
+
+    def test_name(self):
+        c = ERC20(self.chain_spec)
+        o = c.name(self.address, sender_address=self.accounts[0])
+        r = self.conn.do(o)
+        name = ERC20.parse_name(r)
+        self.assertEqual(self.name, name)
+
+
+    def test_symbol(self):
+        c = ERC20(self.chain_spec)
+        o = c.symbol(self.address, sender_address=self.accounts[0])
+        r = self.conn.do(o)
+        symbol = ERC20.parse_symbol(r)
+        self.assertEqual(self.symbol, symbol)
+
+
+    def test_transfer(self):
+        nonce_oracle = RPCNonceOracle(self.accounts[0], conn=self.conn)
+        gas_oracle = OverrideGasOracle(limit=100000, conn=self.conn)
+        c = ERC20(self.chain_spec, signer=self.signer, nonce_oracle=nonce_oracle, gas_oracle=gas_oracle)
+        (tx_hash, o) = c.transfer(self.address, self.accounts[0], self.accounts[1], 1000)
+        r = self.rpc.do(o)
+        o = receipt(tx_hash)
+        r = self.rpc.do(o)
+        self.assertEqual(r['status'], 1)
+
+        o = c.balance_of(self.address, self.accounts[0], sender_address=self.accounts[0])
+        r = self.rpc.do(o)
+        balance = c.parse_balance(r)
+        self.assertEqual(balance, self.initial_supply - 1000)
+
+        o = c.balance_of(self.address, self.accounts[1], sender_address=self.accounts[0])
+        r = self.rpc.do(o)
+        balance = c.parse_balance(r)
+        self.assertEqual(balance, 1000)
+
+        o = transaction(tx_hash)
+        r = self.rpc.do(o)
+        data = c.parse_transfer_request(r['data'])
+        self.assertEqual(data[0], strip_0x(self.accounts[1]))
+        self.assertEqual(data[1], 1000)
+
+
+    def test_transfer_from(self):
+        nonce_oracle = RPCNonceOracle(self.accounts[0], conn=self.conn)
+        gas_oracle = OverrideGasOracle(limit=100000, conn=self.conn)
+        c = ERC20(self.chain_spec, signer=self.signer, nonce_oracle=nonce_oracle, gas_oracle=gas_oracle)
+        (tx_hash, o) = c.approve(self.address, self.accounts[0], self.accounts[1], 1000)
+        r = self.rpc.do(o)
+        o = receipt(tx_hash)
+        r = self.rpc.do(o)
+        self.assertEqual(r['status'], 1)
+
+        o = c.allowance(self.address, self.accounts[0], self.accounts[1], sender_address=self.accounts[0])
+        r = self.rpc.do(o)
+        allowance = c.parse_allowance(r)
+        self.assertEqual(allowance, 1000)
+
+        o = transaction(tx_hash)
+        r = self.rpc.do(o)
+        data = c.parse_approve_request(r['data'])
+        self.assertEqual(data[0], strip_0x(self.accounts[1]))
+        self.assertEqual(data[1], 1000)
+
+        nonce_oracle = RPCNonceOracle(self.accounts[1], conn=self.conn)
+        c = ERC20(self.chain_spec, signer=self.signer, nonce_oracle=nonce_oracle, gas_oracle=gas_oracle)
+        (tx_hash, o) = c.transfer_from(self.address, self.accounts[1], self.accounts[0], self.accounts[2], 1001)
+        r = self.rpc.do(o)
+        o = receipt(tx_hash)
+        r = self.rpc.do(o)
+        self.assertEqual(r['status'], 0)
+
+        o = transaction(tx_hash)
+        r = self.rpc.do(o)
+        data = c.parse_transfer_from_request(r['data'])
+        self.assertEqual(data[0], strip_0x(self.accounts[0]))
+        self.assertEqual(data[1], strip_0x(self.accounts[2]))
+        self.assertEqual(data[2], 1001)
+
+        (tx_hash, o) = c.transfer_from(self.address, self.accounts[1], self.accounts[0], self.accounts[2], 1000)
+        r = self.rpc.do(o)
+        o = receipt(tx_hash)
+        r = self.rpc.do(o)
+        self.assertEqual(r['status'], 1)
+
+        o = c.balance_of(self.address, self.accounts[0], sender_address=self.accounts[0])
+        r = self.rpc.do(o)
+        balance = c.parse_balance(r)
+        self.assertEqual(balance, self.initial_supply - 1000)
+
+        o = c.balance_of(self.address, self.accounts[2], sender_address=self.accounts[0])
+        r = self.rpc.do(o)
+        balance = c.parse_balance(r)
+        self.assertEqual(balance, 1000)
+
+
+    def test_revoke_approve(self):
+        nonce_oracle = RPCNonceOracle(self.accounts[0], conn=self.conn)
+        gas_oracle = OverrideGasOracle(limit=100000, conn=self.conn)
+        c = ERC20(self.chain_spec, signer=self.signer, nonce_oracle=nonce_oracle, gas_oracle=gas_oracle)
+        (tx_hash, o) = c.approve(self.address, self.accounts[0], self.accounts[1], 1000)
+        r = self.rpc.do(o)
+        o = receipt(tx_hash)
+        r = self.rpc.do(o)
+        self.assertEqual(r['status'], 1)
+        
+        (tx_hash, o) = c.approve(self.address, self.accounts[0], self.accounts[1], 999)
+        r = self.rpc.do(o)
+        o = receipt(tx_hash)
+        r = self.rpc.do(o)
+        self.assertEqual(r['status'], 0)
+     
+        (tx_hash, o) = c.approve(self.address, self.accounts[0], self.accounts[1], 0)
+        r = self.rpc.do(o)
+        o = receipt(tx_hash)
+        r = self.rpc.do(o)
+        self.assertEqual(r['status'], 1)
+ 
+        o = c.allowance(self.address, self.accounts[0], self.accounts[1], sender_address=self.accounts[0])
+        r = self.rpc.do(o)
+        allowance = c.parse_allowance(r)
+        self.assertEqual(allowance, 0)
+
+        nonce_oracle = RPCNonceOracle(self.accounts[1], conn=self.conn)
+        c = ERC20(self.chain_spec, signer=self.signer, nonce_oracle=nonce_oracle, gas_oracle=gas_oracle)
+        (tx_hash, o) = c.transfer_from(self.address, self.accounts[1], self.accounts[0], self.accounts[2], 1)
+        r = self.rpc.do(o)
+        o = receipt(tx_hash)
+        r = self.rpc.do(o)
+        self.assertEqual(r['status'], 0)

python/giftable_erc20_token/data/StaticToken.json

@@ -0,0 +1 @@
+[{"inputs":[{"internalType":"string","name":"_name","type":"string"},{"internalType":"string","name":"_symbol","type":"string"},{"internalType":"uint8","name":"_decimals","type":"uint8"},{"internalType":"uint256","name":"_supply","type":"uint256"}],"stateMutability":"nonpayable","type":"constructor"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"_owner","type":"address"},{"indexed":true,"internalType":"address","name":"_spender","type":"address"},{"indexed":false,"internalType":"uint256","name":"_value","type":"uint256"}],"name":"Approval","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"_from","type":"address"},{"indexed":true,"internalType":"address","name":"_to","type":"address"},{"indexed":false,"internalType":"uint256","name":"_value","type":"uint256"}],"name":"Transfer","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"_from","type":"address"},{"indexed":true,"internalType":"address","name":"_to","type":"address"},{"indexed":true,"internalType":"address","name":"_spender","type":"address"},{"indexed":false,"internalType":"uint256","name":"_value","type":"uint256"}],"name":"TransferFrom","type":"event"},{"inputs":[{"internalType":"address","name":"","type":"address"},{"internalType":"address","name":"","type":"address"}],"name":"allowance","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"_spender","type":"address"},{"internalType":"uint256","name":"_value","type":"uint256"}],"name":"approve","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"","type":"address"}],"name":"balanceOf","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"decimals","outputs":[{"internalType":"uint8","name":"","type":"uint8"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"name","outputs":[{"internalType":"string","name":"","type":"string"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"bytes4","name":"_sum","type":"bytes4"}],"name":"supportsInterface","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"pure","type":"function"},{"inputs":[],"name":"symbol","outputs":[{"internalType":"string","name":"","type":"string"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"totalSupply","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"_to","type":"address"},{"internalType":"uint256","name":"_value","type":"uint256"}],"name":"transfer","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"_from","type":"address"},{"internalType":"address","name":"_to","type":"address"},{"internalType":"uint256","name":"_value","type":"uint256"}],"name":"transferFrom","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"nonpayable","type":"function"}]

python/giftable_erc20_token/data/StaticToken.metadata.json

@@ -0,0 +1 @@
+{"compiler":{"version":"0.8.18+commit.87f61d96"},"language":"Solidity","output":{"abi":[{"inputs":[{"internalType":"string","name":"_name","type":"string"},{"internalType":"string","name":"_symbol","type":"string"},{"internalType":"uint8","name":"_decimals","type":"uint8"},{"internalType":"uint256","name":"_supply","type":"uint256"}],"stateMutability":"nonpayable","type":"constructor"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"_owner","type":"address"},{"indexed":true,"internalType":"address","name":"_spender","type":"address"},{"indexed":false,"internalType":"uint256","name":"_value","type":"uint256"}],"name":"Approval","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"_from","type":"address"},{"indexed":true,"internalType":"address","name":"_to","type":"address"},{"indexed":false,"internalType":"uint256","name":"_value","type":"uint256"}],"name":"Transfer","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"_from","type":"address"},{"indexed":true,"internalType":"address","name":"_to","type":"address"},{"indexed":true,"internalType":"address","name":"_spender","type":"address"},{"indexed":false,"internalType":"uint256","name":"_value","type":"uint256"}],"name":"TransferFrom","type":"event"},{"inputs":[{"internalType":"address","name":"","type":"address"},{"internalType":"address","name":"","type":"address"}],"name":"allowance","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"_spender","type":"address"},{"internalType":"uint256","name":"_value","type":"uint256"}],"name":"approve","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"","type":"address"}],"name":"balanceOf","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"decimals","outputs":[{"internalType":"uint8","name":"","type":"uint8"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"name","outputs":[{"internalType":"string","name":"","type":"string"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"bytes4","name":"_sum","type":"bytes4"}],"name":"supportsInterface","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"pure","type":"function"},{"inputs":[],"name":"symbol","outputs":[{"internalType":"string","name":"","type":"string"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"totalSupply","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"_to","type":"address"},{"internalType":"uint256","name":"_value","type":"uint256"}],"name":"transfer","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"_from","type":"address"},{"internalType":"address","name":"_to","type":"address"},{"internalType":"uint256","name":"_value","type":"uint256"}],"name":"transferFrom","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"nonpayable","type":"function"}],"devdoc":{"kind":"dev","methods":{},"version":1},"userdoc":{"kind":"user","methods":{},"version":1}},"settings":{"compilationTarget":{"StaticToken.sol":"StaticToken"},"evmVersion":"byzantium","libraries":{},"metadata":{"bytecodeHash":"ipfs"},"optimizer":{"enabled":false,"runs":200},"remappings":[]},"sources":{"StaticToken.sol":{"keccak256":"0x7afcc41cbaaaeeac2e372c50ed4cf6962035af89e33b500a65927f46d8bf31f2","license":"GPL-3.0-or-later","urls":["bzz-raw://4077171f628fd470cb7f72ca80426297132050f4d08380b55ca74c87e3df2727","dweb:/ipfs/QmWvgFNWrRtzQFejyfjy6LaerghSnYQ86R5WVTnXS7wiuD"]}},"version":1}

python/giftable_erc20_token/factory.py

@@ -12,6 +12,9 @@ from chainlib.eth.contract import (
         ABIContractEncoder,
         ABIContractType,
         )
+from chainlib.eth.constant import ZERO_ADDRESS
+from chainlib.jsonrpc import JSONRPCRequest
+from hexathon import add_0x
 
 # local imports
 from giftable_erc20_token.data import data_dir
@@ -107,6 +110,48 @@ class GiftableToken(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 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('burned')
+        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 total_minted(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('totalMinted')
+        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 bytecode(**kwargs):
     return GiftableToken.bytecode(version=kwargs.get('version'))
 

python/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = eth-erc20
-version = 0.6.0
+version = 0.6.2
 description = ERC20 interface and simple contract with deployment script that lets any address mint and gift itself tokens.
 author = Louis Holbrook
 author_email = dev@holbrook.no

python/tests/test_erc20_interface.py

@@ -1,176 +1,13 @@
-# standard imports
-import logging
+# import logging
 import unittest
 
-# external imports
-from chainlib.eth.unittest.ethtester import EthTesterCase
-from chainlib.connection import RPCConnection
-from chainlib.eth.nonce import RPCNonceOracle
-from chainlib.eth.gas import OverrideGasOracle
-from chainlib.eth.tx import (
-        transaction,
-        receipt,
-        )
-from chainlib.eth.address import to_checksum_address
-from hexathon import strip_0x
-
 # local imports
 from giftable_erc20_token.unittest import TestGiftableToken
-from eth_erc20 import ERC20
-
-logging.basicConfig(level=logging.DEBUG)
-logg = logging.getLogger()
+from eth_erc20.unittest import TestInterface
 
 
-class TestToken(TestGiftableToken):
-
-    def test_balance(self):
-        c = ERC20(self.chain_spec)
-        o = c.balance_of(self.address, self.accounts[0], sender_address=self.accounts[0])
-        r = self.conn.do(o)
-        balance = ERC20.parse_balance(r)
-        self.assertEqual(self.initial_supply, balance)
-
-
-    def test_supply(self):
-        c = ERC20(self.chain_spec)
-        o = c.total_supply(self.address, sender_address=self.accounts[0])
-        r = self.conn.do(o)
-        supply = ERC20.parse_total_supply(r)
-        self.assertEqual(self.initial_supply, supply)
-
-
-    def test_name(self):
-        c = ERC20(self.chain_spec)
-        o = c.name(self.address, sender_address=self.accounts[0])
-        r = self.conn.do(o)
-        name = ERC20.parse_name(r)
-        self.assertEqual(self.name, name)
-
-
-    def test_symbol(self):
-        c = ERC20(self.chain_spec)
-        o = c.symbol(self.address, sender_address=self.accounts[0])
-        r = self.conn.do(o)
-        symbol = ERC20.parse_symbol(r)
-        self.assertEqual(self.symbol, symbol)
-
-
-    def test_transfer(self):
-        nonce_oracle = RPCNonceOracle(self.accounts[0], conn=self.conn)
-        gas_oracle = OverrideGasOracle(limit=100000, conn=self.conn)
-        c = ERC20(self.chain_spec, signer=self.signer, nonce_oracle=nonce_oracle, gas_oracle=gas_oracle)
-        (tx_hash, o) = c.transfer(self.address, self.accounts[0], self.accounts[1], 1000)
-        r = self.rpc.do(o)
-        o = receipt(tx_hash)
-        r = self.rpc.do(o)
-        self.assertEqual(r['status'], 1)
-
-        o = c.balance_of(self.address, self.accounts[0], sender_address=self.accounts[0])
-        r = self.rpc.do(o)
-        balance = c.parse_balance(r)
-        self.assertEqual(balance, self.initial_supply - 1000)
-
-        o = c.balance_of(self.address, self.accounts[1], sender_address=self.accounts[0])
-        r = self.rpc.do(o)
-        balance = c.parse_balance(r)
-        self.assertEqual(balance, 1000)
-
-        o = transaction(tx_hash)
-        r = self.rpc.do(o)
-        data = c.parse_transfer_request(r['data'])
-        self.assertEqual(data[0], strip_0x(self.accounts[1]))
-        self.assertEqual(data[1], 1000)
-
-
-    def test_transfer_from(self):
-        nonce_oracle = RPCNonceOracle(self.accounts[0], conn=self.conn)
-        gas_oracle = OverrideGasOracle(limit=100000, conn=self.conn)
-        c = ERC20(self.chain_spec, signer=self.signer, nonce_oracle=nonce_oracle, gas_oracle=gas_oracle)
-        (tx_hash, o) = c.approve(self.address, self.accounts[0], self.accounts[1], 1000)
-        r = self.rpc.do(o)
-        o = receipt(tx_hash)
-        r = self.rpc.do(o)
-        self.assertEqual(r['status'], 1)
-
-        o = c.allowance(self.address, self.accounts[0], self.accounts[1], sender_address=self.accounts[0])
-        r = self.rpc.do(o)
-        allowance = c.parse_allowance(r)
-        self.assertEqual(allowance, 1000)
-
-        o = transaction(tx_hash)
-        r = self.rpc.do(o)
-        data = c.parse_approve_request(r['data'])
-        self.assertEqual(data[0], strip_0x(self.accounts[1]))
-        self.assertEqual(data[1], 1000)
-
-        nonce_oracle = RPCNonceOracle(self.accounts[1], conn=self.conn)
-        c = ERC20(self.chain_spec, signer=self.signer, nonce_oracle=nonce_oracle, gas_oracle=gas_oracle)
-        (tx_hash, o) = c.transfer_from(self.address, self.accounts[1], self.accounts[0], self.accounts[2], 1001)
-        r = self.rpc.do(o)
-        o = receipt(tx_hash)
-        r = self.rpc.do(o)
-        self.assertEqual(r['status'], 0)
-
-        o = transaction(tx_hash)
-        r = self.rpc.do(o)
-        data = c.parse_transfer_from_request(r['data'])
-        self.assertEqual(data[0], strip_0x(self.accounts[0]))
-        self.assertEqual(data[1], strip_0x(self.accounts[2]))
-        self.assertEqual(data[2], 1001)
-
-        (tx_hash, o) = c.transfer_from(self.address, self.accounts[1], self.accounts[0], self.accounts[2], 1000)
-        r = self.rpc.do(o)
-        o = receipt(tx_hash)
-        r = self.rpc.do(o)
-        self.assertEqual(r['status'], 1)
-
-        o = c.balance_of(self.address, self.accounts[0], sender_address=self.accounts[0])
-        r = self.rpc.do(o)
-        balance = c.parse_balance(r)
-        self.assertEqual(balance, self.initial_supply - 1000)
-
-        o = c.balance_of(self.address, self.accounts[2], sender_address=self.accounts[0])
-        r = self.rpc.do(o)
-        balance = c.parse_balance(r)
-        self.assertEqual(balance, 1000)
-
-
-    def test_revoke_approve(self):
-        nonce_oracle = RPCNonceOracle(self.accounts[0], conn=self.conn)
-        gas_oracle = OverrideGasOracle(limit=100000, conn=self.conn)
-        c = ERC20(self.chain_spec, signer=self.signer, nonce_oracle=nonce_oracle, gas_oracle=gas_oracle)
-        (tx_hash, o) = c.approve(self.address, self.accounts[0], self.accounts[1], 1000)
-        r = self.rpc.do(o)
-        o = receipt(tx_hash)
-        r = self.rpc.do(o)
-        self.assertEqual(r['status'], 1)
-        
-        (tx_hash, o) = c.approve(self.address, self.accounts[0], self.accounts[1], 999)
-        r = self.rpc.do(o)
-        o = receipt(tx_hash)
-        r = self.rpc.do(o)
-        self.assertEqual(r['status'], 0)
-     
-        (tx_hash, o) = c.approve(self.address, self.accounts[0], self.accounts[1], 0)
-        r = self.rpc.do(o)
-        o = receipt(tx_hash)
-        r = self.rpc.do(o)
-        self.assertEqual(r['status'], 1)
- 
-        o = c.allowance(self.address, self.accounts[0], self.accounts[1], sender_address=self.accounts[0])
-        r = self.rpc.do(o)
-        allowance = c.parse_allowance(r)
-        self.assertEqual(allowance, 0)
-
-        nonce_oracle = RPCNonceOracle(self.accounts[1], conn=self.conn)
-        c = ERC20(self.chain_spec, signer=self.signer, nonce_oracle=nonce_oracle, gas_oracle=gas_oracle)
-        (tx_hash, o) = c.transfer_from(self.address, self.accounts[1], self.accounts[0], self.accounts[2], 1)
-        r = self.rpc.do(o)
-        o = receipt(tx_hash)
-        r = self.rpc.do(o)
-        self.assertEqual(r['status'], 0)
-
+class TestBasic(TestGiftableToken, TestInterface):
+    pass
 
 
 if __name__ == '__main__':

python/tests/test_giftable.py

@@ -80,5 +80,44 @@ class TestExpire(TestGiftableExpireToken):
         self.assertEqual(supply, mint_amount)
 
 
+    def test_burn(self):
+        mint_amount = self.initial_supply
+        nonce_oracle = RPCNonceOracle(self.accounts[1], self.rpc)
+        c = GiftableToken(self.chain_spec, signer=self.signer, nonce_oracle=nonce_oracle)
+        (tx_hash, o) = c.burn(self.address, self.accounts[1], int(mint_amount / 4))
+        self.rpc.do(o)
+        o = receipt(tx_hash)
+        r = self.rpc.do(o)
+        self.assertEqual(r['status'], 0)
+
+        nonce_oracle = RPCNonceOracle(self.accounts[0], self.rpc)
+        c = GiftableToken(self.chain_spec, signer=self.signer, nonce_oracle=nonce_oracle)
+        (tx_hash, o) = c.burn(self.address, self.accounts[0], int(mint_amount / 4))
+        self.rpc.do(o)
+        o = receipt(tx_hash)
+        r = self.rpc.do(o)
+        self.assertEqual(r['status'], 1)
+
+        o = c.burned(self.address, sender_address=self.accounts[0])
+        r = self.rpc.do(o)
+        burned = c.parse_balance(r)
+        self.assertEqual(burned, int(mint_amount / 4))
+
+        o = c.balance_of(self.address, self.accounts[0], sender_address=self.accounts[0])
+        r = self.rpc.do(o)
+        balance = c.parse_balance(r)
+        self.assertEqual(balance, mint_amount - burned)
+
+        o = c.total_supply(self.address, sender_address=self.accounts[0])
+        r = self.rpc.do(o)
+        balance = c.parse_balance(r)
+        self.assertEqual(balance, mint_amount - burned)
+
+        o = c.total_minted(self.address, sender_address=self.accounts[0])
+        r = self.rpc.do(o)
+        balance = c.parse_balance(r)
+        self.assertEqual(balance, mint_amount)
+
+
 if __name__ == '__main__':
     unittest.main()

solidity/GiftableToken.sol

@@ -5,8 +5,11 @@ pragma solidity >=0.6.11;
 
 contract GiftableToken {
 
+	// Implements EIP173
 	address public owner;
-	mapping(address => bool) minters;
+
+	// Implements Writer
+	mapping(address => bool) writer;
 
 	// Implements ERC20
 	string public name;
@@ -15,62 +18,90 @@ contract GiftableToken {
 	// Implements ERC20
 	uint8 public decimals;
 	// Implements ERC20
-	uint256 public totalSupply;
-	// Implements ERC20
 	mapping (address => uint256) public balanceOf;
 	// Implements ERC20
 	mapping (address => mapping (address => uint256)) public allowance;
 
-	// timestamp when token contract expires
+	// Implements Burner
+	uint256 public totalMinted;
+	// Implements Burner
+	uint256 public burned;
+
+	// Implements expire
 	uint256 public expires;
 	bool expired;
 
+	// Implements ERC20
 	event Transfer(address indexed _from, address indexed _to, uint256 _value);
+	// Implements ERC20
 	event TransferFrom(address indexed _from, address indexed _to, address indexed _spender, uint256 _value);
+	// Implements ERC20
 	event Approval(address indexed _owner, address indexed _spender, uint256 _value);
+
+	// Implements Minter
 	event Mint(address indexed _minter, address indexed _beneficiary, uint256 _value);
+
+	// Implement Expire
 	event Expired(uint256 _timestamp);
 
-	constructor(string memory _name, string memory _symbol, uint8 _decimals, uint256 _expireTimestamp) public {
+	// Implements Writer
+	event WriterAdded(address _writer);
+	// Implements Writer
+	event WriterRemoved(address _writer);
+
+	// Implements Burner
+	event Burn(uint256 _value);
+
+	constructor(string memory _name, string memory _symbol, uint8 _decimals, uint256 _expireTimestamp) {
 		owner = msg.sender;
 		name = _name;
 		symbol = _symbol;
 		decimals = _decimals;
-		minters[msg.sender] = true;
 		expires = _expireTimestamp;
 	}
 
+	// Implements ERC20
+	function totalSupply() public view returns (uint256) {
+		return totalMinted - burned;
+	}
+
+	// Implements Minter
+	mapping(address => bool) writers;
 	function mintTo(address _to, uint256 _value) public returns (bool) {
-		require(minters[msg.sender] || msg.sender == owner);
+		require(writers[msg.sender] || msg.sender == owner);
 
 		balanceOf[_to] += _value;
-		totalSupply += _value;
+		totalMinted += _value;
 
 		emit Mint(msg.sender, _to, _value);
 
 		return true;
 	}
 
+	// Implements Writer
 	function addWriter(address _minter) public returns (bool) {
 		require(msg.sender == owner);
 
-		minters[_minter] = true;
+		writers[_minter] = true;
 
 		return true;
 	}
 
+	// Implements Writer
 	function removeWriter(address _minter) public returns (bool) {
 		require(msg.sender == owner || msg.sender == _minter);
 
-		minters[_minter] = false;
+		writers[_minter] = false;
 
 		return true;
 	}
 
+	// Implements Writer
 	function isWriter(address _minter) public view returns(bool) {
-		return minters[_minter] || _minter == owner;
+		return writers[_minter] || _minter == owner;
 	}
 
+	// Implements Expire
 	function applyExpiry() public returns(uint8) {
 		if (expires == 0) {
 			return 0;
@@ -97,6 +128,18 @@ contract GiftableToken {
 		return true;
 	}
 
+	// Implements Burner
+	function burn(uint256 _value) public returns (bool) {
+		require(msg.sender == owner, 'ERR_ACCESS');
+		require(balanceOf[msg.sender] >= _value, 'ERR_FUNDS');
+
+		balanceOf[msg.sender] -= _value;
+		burned += _value;
+
+		emit Burn(_value);
+		return true;
+	}
+
 	// Implements ERC20
 	function transferFrom(address _from, address _to, uint256 _value) public returns (bool) {
 		require(applyExpiry() == 0);
@@ -124,10 +167,11 @@ contract GiftableToken {
 	function transferOwnership(address _newOwner) public returns (bool) {
 		require(msg.sender == owner);
 		owner = _newOwner;
+		return true;
 	}
 
 	// Implements EIP165
-	function supportsInterface(bytes4 _sum) public returns (bool) {
+	function supportsInterface(bytes4 _sum) public pure returns (bool) {
 		if (_sum == 0xc6bb4b70) { // ERC20
 			return true;
 		}
@@ -140,6 +184,12 @@ contract GiftableToken {
 		if (_sum == 0x9493f8b2) { // EIP173
 			return true;
 		}
+		if (_sum == 0xabe1f1f5) { // Writer
+			return true;
+		}
+		if (_sum == 0xfccc2e79) { // Burner
+			return true;
+		}
 		return false;
 	}
 }

solidity/Makefile

@@ -2,13 +2,15 @@ SOLC = /usr/bin/solc
 
 all:
 	$(SOLC) --bin GiftableToken.sol --evm-version byzantium | awk 'NR>3' > GiftableToken.bin
-	truncate -s -1 GiftableToken.bin
 	$(SOLC) --abi GiftableToken.sol --evm-version byzantium | awk 'NR>3' > GiftableToken.json
+	$(SOLC) --metadata GiftableToken.sol --evm-version byzantium | awk 'NR>3' > GiftableToken.metadata.json
 	$(SOLC) --bin StaticToken.sol --evm-version byzantium | awk 'NR>3' > StaticToken.bin
-	truncate -s -1 StaticToken.bin
 	$(SOLC) --abi StaticToken.sol --evm-version byzantium | awk 'NR>3' > StaticToken.json
+	$(SOLC) --metadata StaticToken.sol --evm-version byzantium | awk 'NR>3' > StaticToken.metadata.json
+	truncate -s -1 StaticToken.bin
+	truncate -s -1 GiftableToken.bin
 
 install: all
-	cp -v Giftable*{json,bin} ../python/giftable_erc20_token/data/
-	cp -v Static*{json,bin} ../python/static_token/data/
+	cp -v *.json ../python/giftable_erc20_token/data/
+	cp -v *.bin ../python/giftable_erc20_token/data/
 

solidity/StaticToken.json

@@ -1 +1 @@
-[{"inputs":[{"internalType":"string","name":"_name","type":"string"},{"internalType":"string","name":"_symbol","type":"string"},{"internalType":"uint8","name":"_decimals","type":"uint8"},{"internalType":"uint256","name":"_supply","type":"uint256"}],"stateMutability":"nonpayable","type":"constructor"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"_owner","type":"address"},{"indexed":true,"internalType":"address","name":"_spender","type":"address"},{"indexed":false,"internalType":"uint256","name":"_value","type":"uint256"}],"name":"Approval","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"_from","type":"address"},{"indexed":true,"internalType":"address","name":"_to","type":"address"},{"indexed":false,"internalType":"uint256","name":"_value","type":"uint256"}],"name":"Transfer","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"_from","type":"address"},{"indexed":true,"internalType":"address","name":"_to","type":"address"},{"indexed":true,"internalType":"address","name":"_spender","type":"address"},{"indexed":false,"internalType":"uint256","name":"_value","type":"uint256"}],"name":"TransferFrom","type":"event"},{"inputs":[{"internalType":"address","name":"","type":"address"},{"internalType":"address","name":"","type":"address"}],"name":"allowance","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"_spender","type":"address"},{"internalType":"uint256","name":"_value","type":"uint256"}],"name":"approve","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"","type":"address"}],"name":"balanceOf","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"decimals","outputs":[{"internalType":"uint8","name":"","type":"uint8"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"name","outputs":[{"internalType":"string","name":"","type":"string"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"bytes4","name":"_sum","type":"bytes4"}],"name":"supportsInterface","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"symbol","outputs":[{"internalType":"string","name":"","type":"string"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"totalSupply","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"_to","type":"address"},{"internalType":"uint256","name":"_value","type":"uint256"}],"name":"transfer","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"_from","type":"address"},{"internalType":"address","name":"_to","type":"address"},{"internalType":"uint256","name":"_value","type":"uint256"}],"name":"transferFrom","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"nonpayable","type":"function"}]
+[{"inputs":[{"internalType":"string","name":"_name","type":"string"},{"internalType":"string","name":"_symbol","type":"string"},{"internalType":"uint8","name":"_decimals","type":"uint8"},{"internalType":"uint256","name":"_supply","type":"uint256"}],"stateMutability":"nonpayable","type":"constructor"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"_owner","type":"address"},{"indexed":true,"internalType":"address","name":"_spender","type":"address"},{"indexed":false,"internalType":"uint256","name":"_value","type":"uint256"}],"name":"Approval","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"_from","type":"address"},{"indexed":true,"internalType":"address","name":"_to","type":"address"},{"indexed":false,"internalType":"uint256","name":"_value","type":"uint256"}],"name":"Transfer","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"_from","type":"address"},{"indexed":true,"internalType":"address","name":"_to","type":"address"},{"indexed":true,"internalType":"address","name":"_spender","type":"address"},{"indexed":false,"internalType":"uint256","name":"_value","type":"uint256"}],"name":"TransferFrom","type":"event"},{"inputs":[{"internalType":"address","name":"","type":"address"},{"internalType":"address","name":"","type":"address"}],"name":"allowance","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"_spender","type":"address"},{"internalType":"uint256","name":"_value","type":"uint256"}],"name":"approve","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"","type":"address"}],"name":"balanceOf","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"decimals","outputs":[{"internalType":"uint8","name":"","type":"uint8"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"name","outputs":[{"internalType":"string","name":"","type":"string"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"bytes4","name":"_sum","type":"bytes4"}],"name":"supportsInterface","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"pure","type":"function"},{"inputs":[],"name":"symbol","outputs":[{"internalType":"string","name":"","type":"string"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"totalSupply","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"_to","type":"address"},{"internalType":"uint256","name":"_value","type":"uint256"}],"name":"transfer","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"_from","type":"address"},{"internalType":"address","name":"_to","type":"address"},{"internalType":"uint256","name":"_value","type":"uint256"}],"name":"transferFrom","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"nonpayable","type":"function"}]

solidity/StaticToken.sol

@@ -24,7 +24,7 @@ contract StaticToken {
 	event TransferFrom(address indexed _from, address indexed _to, address indexed _spender, uint256 _value);
 	event Approval(address indexed _owner, address indexed _spender, uint256 _value);
 
-	constructor(string memory _name, string memory _symbol, uint8 _decimals, uint256 _supply) public {
+	constructor(string memory _name, string memory _symbol, uint8 _decimals, uint256 _supply) {
 		owner = msg.sender;
 		name = _name;
 		symbol = _symbol;
@@ -64,7 +64,7 @@ contract StaticToken {
 	}
 
 	// Implements EIP165
-	function supportsInterface(bytes4 _sum) public returns (bool) {
+	function supportsInterface(bytes4 _sum) public pure returns (bool) {
 		if (_sum == 0xc6bb4b70) { // ERC20
 			return true;
 		}