Improve demurrage modifier calculation for redistribution cache, add gas bench for same

Compact words, add demurragemodifier to redistribution word
Merge branch 'lash/use-timestamps' into 'master'
2021-02-06 19:58:41 +01:00 · 2021-02-06 19:10:27 +01:00 · 2021-02-06 14:48:40 +00:00 · 2021-02-06 14:48:40 +00:00 · 2021-02-06 14:18:30 +00:00 · 2021-02-06 14:18:30 +00:00
6 changed files with 392 additions and 185 deletions
--- a/python/tests/bench.py
+++ b/python/tests/bench.py
@@ -0,0 +1,72 @@
+# standard imports
+import os
+import unittest
+import json
+import logging
+
+# third-party imports
+import web3
+import eth_tester
+import eth_abi
+
+logging.basicConfig(level=logging.DEBUG)
+logg = logging.getLogger()
+
+logging.getLogger('web3').setLevel(logging.WARNING)
+logging.getLogger('eth.vm').setLevel(logging.WARNING)
+
+testdir = os.path.dirname(__file__)
+
+TAX_LEVEL = 10000 * 2 # 2%
+
+
+class Test(unittest.TestCase):
+
+    contract = None
+
+    def setUp(self):
+        eth_params = eth_tester.backends.pyevm.main.get_default_genesis_params({
+            'gas_limit': 9000000,
+            })
+
+        f = open(os.path.join(testdir, '../../solidity/RedistributedDemurrageToken.bin'), 'r')
+        self.bytecode = f.read()
+        f.close()
+
+        f = open(os.path.join(testdir, '../../solidity/RedistributedDemurrageToken.json'), 'r')
+        self.abi = json.load(f)
+        f.close()
+
+        backend = eth_tester.PyEVMBackend(eth_params)
+        self.eth_tester =  eth_tester.EthereumTester(backend)
+        provider = web3.Web3.EthereumTesterProvider(self.eth_tester)
+        self.w3 = web3.Web3(provider)
+        self.sink_address = self.w3.eth.accounts[9]
+
+    def tearDown(self):
+        pass
+
+
+    def test_gas_changeperiod(self):
+        period = 43200
+        for i in range(5):
+            c = self.w3.eth.contract(abi=self.abi, bytecode=self.bytecode)
+            tx_hash = c.constructor('Foo Token', 'FOO', 6, TAX_LEVEL * (10 ** 32), period, self.sink_address).transact({'from': self.w3.eth.accounts[0]})
+            r = self.w3.eth.getTransactionReceipt(tx_hash)
+            contract = self.w3.eth.contract(abi=self.abi, address=r.contractAddress)
+
+            start_block = self.w3.eth.blockNumber
+            b = self.w3.eth.getBlock(start_block)
+            start_time = b['timestamp']
+
+            period_seconds = period * 60
+            self.eth_tester.time_travel(start_time + period_seconds + (60 * (10 ** i)))
+            tx_hash = contract.functions.changePeriod().transact()
+            r = self.w3.eth.getTransactionReceipt(tx_hash)
+
+            print('{} ({}): {}'.format(i, 60 * (10 ** i), r['gasUsed']))
+
+if __name__ == '__main__':
+    unittest.main()
+
+ 
--- a/python/tests/test_basic.py
+++ b/python/tests/test_basic.py
@@ -3,6 +3,7 @@ import os
 import unittest
 import json
 import logging
+import datetime

 # third-party imports
 import web3
@@ -18,9 +19,11 @@ logging.getLogger('eth.vm').setLevel(logging.WARNING)
 testdir = os.path.dirname(__file__)

 #BLOCKTIME = 5 # seconds
-TAX_LEVEL = 10000 * 2 # 2%
+TAX_LEVEL = int(10000 * 2) # 2%
+# calc "1-(0.98)^(1/518400)" <- 518400 = 30 days of blocks
+# 0.00000003897127107225
 #PERIOD = int(60/BLOCKTIME) * 60 * 24 * 30 # month
-PERIOD = 10
+PERIOD = 1


 class Test(unittest.TestCase):
@@ -48,12 +51,15 @@ class Test(unittest.TestCase):
        self.sink_address = self.w3.eth.accounts[9]

        c = self.w3.eth.contract(abi=self.abi, bytecode=self.bytecode)
-        tx_hash = c.constructor('Foo Token', 'FOO', 6, TAX_LEVEL, PERIOD, self.sink_address).transact({'from': self.w3.eth.accounts[0]})
+        tx_hash = c.constructor('Foo Token', 'FOO', 6, TAX_LEVEL * (10 ** 32), PERIOD, self.sink_address).transact({'from': self.w3.eth.accounts[0]})

        r = self.w3.eth.getTransactionReceipt(tx_hash)
        self.contract = self.w3.eth.contract(abi=self.abi, address=r.contractAddress)

        self.start_block = self.w3.eth.blockNumber
+        b = self.w3.eth.getBlock(self.start_block)
+        self.start_time = b['timestamp']
+

    def tearDown(self):
        pass
@@ -61,10 +67,31 @@ class Test(unittest.TestCase):

    def test_hello(self):
        self.assertEqual(self.contract.functions.actualPeriod().call(), 1)
-        self.eth_tester.mine_blocks(PERIOD)
+        self.eth_tester.time_travel(self.start_time + 61)
        self.assertEqual(self.contract.functions.actualPeriod().call(), 2)


+
+    def test_apply_demurrage(self):
+        modifier = 10 * (10 ** 37)
+        demurrage_modifier = self.contract.functions.demurrageModifier().call()
+        demurrage_modifier &= (1 << 128) - 1
+        self.assertEqual(modifier, demurrage_modifier)
+
+        self.eth_tester.time_travel(self.start_time + 59)
+        demurrage_modifier = self.contract.functions.demurrageModifier().call()
+        demurrage_modifier &= (1 << 128) - 1
+        self.assertEqual(modifier, demurrage_modifier)
+
+        self.eth_tester.time_travel(self.start_time + 61)
+        tx_hash = self.contract.functions.applyDemurrage().transact()
+        r = self.w3.eth.getTransactionReceipt(tx_hash)
+
+        demurrage_modifier = self.contract.functions.demurrageModifier().call()
+        demurrage_modifier &= (1 << 128) - 1
+        self.assertEqual(int(98 * (10 ** 36)), demurrage_modifier)
+
+
    def test_mint(self):
        tx_hash = self.contract.functions.mintTo(self.w3.eth.accounts[1], 1024).transact()
        r = self.w3.eth.getTransactionReceipt(tx_hash)
@@ -80,6 +107,26 @@ class Test(unittest.TestCase):
        balance = self.contract.functions.balanceOf(self.w3.eth.accounts[1]).call()
        self.assertEqual(balance, 2000)

+        self.eth_tester.time_travel(self.start_time + 61)
+        balance = self.contract.functions.balanceOf(self.w3.eth.accounts[1]).call()
+        self.assertEqual(balance, int(2000 * 0.98))
+
+    
+    def test_base_amount(self):
+        tx_hash = self.contract.functions.mintTo(self.w3.eth.accounts[1], 1000).transact()
+        r = self.w3.eth.getTransactionReceipt(tx_hash)
+        self.assertEqual(r.status, 1)
+
+        self.eth_tester.time_travel(self.start_time + 61)
+
+        self.contract.functions.applyDemurrage().transact()
+        demurrage_modifier = self.contract.functions.demurrageModifier().call()
+        demurrage_amount = self.contract.functions.toDemurrageAmount(demurrage_modifier).call()
+        logg.debug('d {} {}'.format(demurrage_modifier.to_bytes(32, 'big').hex(), demurrage_amount))
+
+        a = self.contract.functions.toBaseAmount(1000).call();
+        self.assertEqual(a, 1020)
+

    def test_transfer(self):
        tx_hash = self.contract.functions.mintTo(self.w3.eth.accounts[1], 1024).transact()
@@ -128,62 +175,5 @@ class Test(unittest.TestCase):
        self.assertEqual(balance_alice, 500)


-    def test_apply_tax(self):
-        self.contract.functions.mintTo(self.w3.eth.accounts[1], 1024).transact()
-
-        self.eth_tester.mine_blocks(PERIOD)
-        tx_hash = self.contract.functions.applyTax().transact()
-        r = self.w3.eth.getTransactionReceipt(tx_hash)
-        self.assertEqual(self.contract.functions.redistributionCount().call(), 2)
-        self.assertEqual(self.contract.functions.demurrageModifier().call(), 980000)
-
-        self.eth_tester.mine_blocks(PERIOD)
-        tx_hash = self.contract.functions.applyTax().transact()
-        r = self.w3.eth.getTransactionReceipt(tx_hash)
-        self.assertEqual(self.contract.functions.redistributionCount().call(), 3)
-        self.assertEqual(self.contract.functions.demurrageModifier().call(), 960400)
-
-
-    def test_tax_balance(self):
-        tx_hash = self.contract.functions.mintTo(self.w3.eth.accounts[1], 1000).transact()
-        r = self.w3.eth.getTransactionReceipt(tx_hash)
-        self.assertEqual(r.status, 1)
-
-        self.eth_tester.mine_blocks(PERIOD)
-        tx_hash = self.contract.functions.applyTax().transact()
-        r = self.w3.eth.getTransactionReceipt(tx_hash)
-        self.assertEqual(r.status, 1)
-
-        balance = self.contract.functions.balanceOf(self.w3.eth.accounts[1]).call()
-        self.assertEqual(balance, 980)
-
-    
-    def test_taxed_transfer(self):
-        tx_hash = self.contract.functions.mintTo(self.w3.eth.accounts[1], 1000000).transact()
-        r = self.w3.eth.getTransactionReceipt(tx_hash)
-        self.assertEqual(r.status, 1)
-
-        self.eth_tester.mine_blocks(PERIOD)
-        tx_hash = self.contract.functions.applyTax().transact()
-        r = self.w3.eth.getTransactionReceipt(tx_hash)
-        self.assertEqual(r.status, 1)
-
-        balance_alice = self.contract.functions.balanceOf(self.w3.eth.accounts[1]).call()
-        self.assertEqual(balance_alice, 980000)
-
-        tx_hash = self.contract.functions.transfer(self.w3.eth.accounts[2], 500000).transact({'from': self.w3.eth.accounts[1]})
-        r = self.w3.eth.getTransactionReceipt(tx_hash)
-        logg.debug('r {}'.format(r))
-        self.assertEqual(r.status, 1)
-
-        balance_alice = self.contract.functions.balanceOf(self.w3.eth.accounts[1]).call()
-        balance_alice_trunc = int(balance_alice/1000)*1000
-        self.assertEqual(balance_alice_trunc, 480000)
-
-        balance_bob = self.contract.functions.balanceOf(self.w3.eth.accounts[2]).call()
-        balance_bob_trunc = int(balance_bob/1000)*1000
-        self.assertEqual(balance_bob_trunc, 500000)
-
-
 if __name__ == '__main__':
    unittest.main()
--- a/python/tests/test_period.py
+++ b/python/tests/test_period.py
@@ -20,7 +20,7 @@ testdir = os.path.dirname(__file__)
 #BLOCKTIME = 5 # seconds
 TAX_LEVEL = 10000 * 2 # 2%
 #PERIOD = int(60/BLOCKTIME) * 60 * 24 * 30 # month
-PERIOD = 2
+PERIOD = 1


 class Test(unittest.TestCase):
@@ -47,12 +47,15 @@ class Test(unittest.TestCase):
        self.sink_address = self.w3.eth.accounts[9]

        c = self.w3.eth.contract(abi=self.abi, bytecode=self.bytecode)
-        tx_hash = c.constructor('Foo Token', 'FOO', 6, TAX_LEVEL, PERIOD, self.sink_address).transact({'from': self.w3.eth.accounts[0]})
+        tx_hash = c.constructor('Foo Token', 'FOO', 6, TAX_LEVEL * (10 ** 32), PERIOD, self.sink_address).transact({'from': self.w3.eth.accounts[0]})

        r = self.w3.eth.getTransactionReceipt(tx_hash)
        self.contract = self.w3.eth.contract(abi=self.abi, address=r.contractAddress)

        self.start_block = self.w3.eth.blockNumber
+        b = self.w3.eth.getBlock(self.start_block)
+        self.start_time = b['timestamp']
+

    def tearDown(self):
        pass
@@ -63,15 +66,14 @@ class Test(unittest.TestCase):
        r = self.w3.eth.getTransactionReceipt(tx_hash)
        self.assertEqual(r.status, 1)

-        self.eth_tester.mine_blocks(PERIOD * 10)
-
-        tx_hash = self.contract.functions.transfer(self.w3.eth.accounts[2], 500).transact({'from': self.w3.eth.accounts[1]})
+        self.eth_tester.time_travel(self.start_time + 61)
+        tx_hash = self.contract.functions.changePeriod().transact()
        r = self.w3.eth.getTransactionReceipt(tx_hash)
-        logg.debug('r {}'.format(r));
        self.assertEqual(r.status, 1)

-        period = self.contract.functions.accountPeriod(self.w3.eth.accounts[1]).call()
-        self.assertEqual(period, 12)
+        redistribution = self.contract.functions.redistributions(1).call()
+        self.assertEqual(2, self.contract.functions.toRedistributionPeriod(redistribution).call())
+        self.assertEqual(2, self.contract.functions.actualPeriod().call())


 if __name__ == '__main__':
--- a/python/tests/test_pure.py
+++ b/python/tests/test_pure.py
@@ -19,8 +19,7 @@ logging.getLogger('eth.vm').setLevel(logging.WARNING)
 testdir = os.path.dirname(__file__)

 #BLOCKTIME = 5 # seconds
-TAX_LEVEL = 10000 * 2 # 2%
-#PERIOD = int(60/BLOCKTIME) * 60 * 24 * 30 # month
+TAX_LEVEL = int((10000 * 2) * (10 ** 32)) # 2%
 PERIOD = 10


@@ -62,14 +61,20 @@ class Test(unittest.TestCase):


    def test_tax_period(self):
+        t = self.contract.functions.taxLevel().call()
+        logg.debug('taxlevel {}'.format(t))
+
        a = self.contract.functions.toTaxPeriodAmount(1000000, 0).call()
-        self.assertEqual(1000000, a)
+        self.assertEqual(a, 1000000)

        a = self.contract.functions.toTaxPeriodAmount(1000000, 1).call()
-        self.assertEqual(980000, a)
+        self.assertEqual(a, 980000)

        a = self.contract.functions.toTaxPeriodAmount(1000000, 2).call()
-        self.assertEqual(960400, a)
+        self.assertEqual(a, 960400)
+
+        a = self.contract.functions.toTaxPeriodAmount(980000, 1).call()
+        self.assertEqual(a, 960400)


    def test_fractional_state(self):
--- a/python/tests/test_redistribution.py
+++ b/python/tests/test_redistribution.py
@@ -20,7 +20,7 @@ testdir = os.path.dirname(__file__)
 #BLOCKTIME = 5 # seconds
 TAX_LEVEL = 10000 * 2 # 2%
 #PERIOD = int(60/BLOCKTIME) * 60 * 24 * 30 # month
-PERIOD = 20
+PERIOD = 1


 class Test(unittest.TestCase):
@@ -47,13 +47,15 @@ class Test(unittest.TestCase):
        self.sink_address = self.w3.eth.accounts[9]

        c = self.w3.eth.contract(abi=self.abi, bytecode=self.bytecode)
-        tx_hash = c.constructor('Foo Token', 'FOO', 6, TAX_LEVEL, PERIOD, self.sink_address).transact({'from': self.w3.eth.accounts[0]})
+        tx_hash = c.constructor('Foo Token', 'FOO', 6, TAX_LEVEL * (10 ** 32), PERIOD, self.sink_address).transact({'from': self.w3.eth.accounts[0]})

        r = self.w3.eth.getTransactionReceipt(tx_hash)
        self.contract = self.w3.eth.contract(abi=self.abi, address=r.contractAddress)

        self.start_block = self.w3.eth.blockNumber
-        logg.debug('starting at block number {}'.format(self.start_block))
+        b = self.w3.eth.getBlock(self.start_block)
+        self.start_time = b['timestamp']
+

    def tearDown(self):
        pass
@@ -68,26 +70,28 @@ class Test(unittest.TestCase):


    # TODO: check receipt log outputs
-    @unittest.skip('foo')
    def test_redistribution_storage(self):
-        self.contract.functions.mintTo(self.w3.eth.accounts[1], 2000).transact()
+        self.contract.functions.mintTo(self.w3.eth.accounts[1], 1000000).transact()
+        self.contract.functions.mintTo(self.w3.eth.accounts[2], 1000000).transact()

-        tx_hash = self.contract.functions.transfer(self.w3.eth.accounts[2], 500).transact({'from': self.w3.eth.accounts[1]})
+        external_address = web3.Web3.toChecksumAddress('0x' + os.urandom(20).hex())
+        tx_hash = self.contract.functions.transfer(external_address, 1000000).transact({'from': self.w3.eth.accounts[2]})
+        tx_hash = self.contract.functions.transfer(external_address, 999999).transact({'from': self.w3.eth.accounts[1]})
        r = self.w3.eth.getTransactionReceipt(tx_hash)
        logg.debug('tx before {}'.format(r))
        self.assertEqual(r.status, 1)

-        self.eth_tester.mine_blocks(PERIOD)
+        self.eth_tester.time_travel(self.start_time + 61)

        redistribution = self.contract.functions.redistributions(0).call();
-        self.assertEqual(redistribution.hex(), '000000000100000000000000000000000000000000000007d000000000000001')
+        self.assertEqual(redistribution.hex(), '000000000000000000000000f42400000000010000000000001e848000000001')

        tx_hash = self.contract.functions.mintTo(self.w3.eth.accounts[0], 1000000).transact()
        r = self.w3.eth.getTransactionReceipt(tx_hash)
        self.assertEqual(r.status, 1)

        redistribution = self.contract.functions.redistributions(1).call()
-        self.assertEqual(redistribution.hex(), '000000000000000000000000000000000000000000000f4a1000000000000002')
+        self.assertEqual(redistribution.hex(), '000000000000000000000000ef4200000000000000000000002dc6c000000002')
    

    def test_redistribution_balance_on_zero_participants(self):
@@ -95,24 +99,27 @@ class Test(unittest.TestCase):
        tx_hash = self.contract.functions.mintTo(self.w3.eth.accounts[1], supply).transact()
        r = self.w3.eth.getTransactionReceipt(tx_hash)

-        self.eth_tester.mine_blocks(PERIOD)
+        self.eth_tester.time_travel(self.start_time + 61)

-        tx_hash = self.contract.functions.applyTax().transact()
+        tx_hash = self.contract.functions.applyDemurrage().transact()
        r = self.w3.eth.getTransactionReceipt(tx_hash)
        logg.debug('r {}'.format(r))
        self.assertEqual(r.status, 1)
+        tx_hash = self.contract.functions.changePeriod().transact()
+        rr = self.w3.eth.getTransactionReceipt(tx_hash)
+        self.assertEqual(rr.status, 1)

        redistribution = self.contract.functions.redistributions(0).call();
        supply = self.contract.functions.totalSupply().call()

        sink_increment = int(supply * (TAX_LEVEL / 1000000))
        for l in r['logs']:
-            if l.topics[0].hex() == '0x337db9c77a0769d770641c73e3282be23b15e2bddd830c219461dec832313389': # event Taxed(uint256,uint256)
+            if l.topics[0].hex() == '0xa0717e54e02bd9829db5e6e998aec0ae9de796b8d150a3cc46a92ab869697755': # event Decayed(uint256,uint256,uint256,uint256)
                period = int.from_bytes(l.topics[1], 'big')
-                self.assertEqual(period, 1)
+                self.assertEqual(period, 2)
                b = bytes.fromhex(l.data[2:])
                remainder = int.from_bytes(b, 'big')
-                self.assertEqual(remainder, sink_increment)
+                self.assertEqual(remainder, int((1000000 - TAX_LEVEL) * (10 ** 32)))
                logg.debug('period {} remainder {}'.format(period, remainder))

        sink_balance = self.contract.functions.balanceOf(self.sink_address).call()
@@ -140,14 +147,15 @@ class Test(unittest.TestCase):
        r = self.w3.eth.getTransactionReceipt(tx_hash)
        # No cheating!
        self.contract.functions.transfer(self.w3.eth.accounts[3], spend_amount).transact({'from': self.w3.eth.accounts[3]})
-        # Too low
+        # No cheapskating!
        self.contract.functions.transfer(external_address, spend_amount-1).transact({'from': self.w3.eth.accounts[4]})

        self.assertEqual(r.status, 1)

-        self.eth_tester.mine_blocks(PERIOD)
+        self.eth_tester.time_travel(self.start_time + 61)

-        self.contract.functions.applyTax().transact()
+        self.contract.functions.applyDemurrage().transact()
+        self.contract.functions.changePeriod().transact()

        bummer_balance = self.contract.functions.balanceOf(self.w3.eth.accounts[3]).call()
        self.assertEqual(bummer_balance, mint_amount - (mint_amount * (TAX_LEVEL / 1000000)))
--- a/solidity/RedistributedDemurrageToken.sol
+++ b/solidity/RedistributedDemurrageToken.sol
@@ -11,14 +11,17 @@ contract RedistributedDemurrageToken {
 	uint256 public decimals;
 	uint256 public totalSupply;
 	uint256 public minimumParticipantSpend;
+	uint256 constant ppmDivider = 100000000000000000000000000000000;

-	uint256 public periodStart;
-	uint256 public periodDuration;
-	uint256 public taxLevel; // PPM
-	uint256 public demurrageModifier; // PPM
+	uint256 public immutable periodStart; // timestamp
+	uint256 public immutable periodDuration; // duration in SECONDS
+	uint256 public immutable taxLevel; // PPM per MINUTE
+	uint256 public demurrageModifier; // PPM uint128(block) | uint128(ppm)

-	bytes32[] public redistributions; // uint1(isFractional) | uint1(unused) | uint38(participants) | uint160(value) | uint56(period)
-	mapping (address => bytes32) account; // uint20(unused) | uint56(period) | uint160(value)
+	//bytes32[] public redistributions; // uint1(isFractional) | uint1(unused) | uint38(participants) | uint160(value) | uint56(period)
+	bytes32[] public redistributions; // uint1(isFractional) | uint95(unused) | uint20(demurrageModifier) | uint36(participants) | uint72(value) | uint32(period)
+	//mapping (address => bytes32) account; // uint20(unused) | uint56(period) | uint160(value)
+	mapping (address => bytes32) account; // uint152(unused) | uint32(period) | uint72(value)
 	mapping (address => bool) minter;
 	mapping (address => mapping (address => uint256 ) ) allowance; // holder -> spender -> amount (amount is subject to demurrage)

@@ -27,22 +30,23 @@ contract RedistributedDemurrageToken {
 	event Transfer(address indexed _from, address indexed _to, uint256 _value);
 	event Approval(address indexed _owner, address indexed _spender, uint256 _value);
 	event Mint(address indexed _minter, address indexed _beneficiary, uint256 _value);
-	//event Debug(uint256 _foo);
-	event Taxed(uint256 indexed _period, uint256 remainder);
+	event Debug(bytes32 _foo);
+	event Decayed(uint256 indexed _period, uint256 indexed _periodCount, uint256 indexed _oldAmount, uint256 _newAmount);
 	event Redistribution(address indexed _account, uint256 indexed _period, uint256 _value);

-	constructor(string memory _name, string memory _symbol, uint8 _decimals, uint32 _taxLevel, uint256 _period, address _defaultSinkAddress) public {
+	constructor(string memory _name, string memory _symbol, uint8 _decimals, uint256 _taxLevelMinute, uint256 _periodMinutes, address _defaultSinkAddress) public {
 		owner = msg.sender;
 		minter[owner] = true;
-		periodStart = block.number;
-		periodDuration = _period;
-		taxLevel = _taxLevel;
+		periodStart = block.timestamp;
+		periodDuration = _periodMinutes * 60;
 		name = _name;
 		symbol = _symbol;
 		decimals = _decimals;
-		demurrageModifier = 1000000;
+		demurrageModifier = ppmDivider * 1000000; // Emulates 38 decimal places
+		demurrageModifier |= (1 << 128);
+		taxLevel = _taxLevelMinute; // 38 decimal places
 		sinkAddress = _defaultSinkAddress;
-		bytes32 initialRedistribution = toRedistribution(0, 0, 1);
+		bytes32 initialRedistribution = toRedistribution(0, 1000000, 0, 1);
 		redistributions.push(initialRedistribution);
 		minimumParticipantSpend = 10 ** uint256(_decimals);
 	}
@@ -53,30 +57,53 @@ contract RedistributedDemurrageToken {
 		minter[_minter] = true;
 		return true;
 	}
-	
+
 	/// ERC20
 	function balanceOf(address _account) public view returns (uint256) {
-		uint256 baseBalance = getBaseBalance(_account);
-		uint256 inverseModifier = 1000000 - demurrageModifier;
-		uint256 balanceModifier = (inverseModifier * baseBalance) / 1000000;
-		return baseBalance - balanceModifier;
+		uint256 baseBalance;
+		uint256 anchorDemurrageAmount;
+		uint256 anchorDemurragePeriod;
+		uint256 currentDemurrageAmount;
+		uint256 periodCount;
+
+		baseBalance = getBaseBalance(_account);
+		anchorDemurrageAmount = toDemurrageAmount(demurrageModifier);
+		anchorDemurragePeriod = toDemurragePeriod(demurrageModifier);
+
+		periodCount = actualPeriod() - toDemurragePeriod(demurrageModifier);
+
+		currentDemurrageAmount = decayBy(anchorDemurrageAmount, periodCount);
+
+		return (baseBalance * currentDemurrageAmount) / (ppmDivider * 1000000);
 	}

 	/// Balance unmodified by demurrage
 	function getBaseBalance(address _account) private view returns (uint256) {
-		return uint256(account[_account]) & 0x00ffffffffffffffffffffffffffffffffffffffff;
+		//return uint256(account[_account]) & 0x00ffffffffffffffffffffffffffffffffffffffff;
+		return uint256(account[_account]) & 0xffffffffffffffffff;
 	}

 	/// Increases base balance for a single account
 	function increaseBaseBalance(address _account, uint256 _delta) private returns (bool) {
 		uint256 oldBalance;
 		uint256 newBalance;
-		
+		uint256 workAccount;
+
+		workAccount = uint256(account[_account]); // | (newBalance & 0xffffffffffffffffff);
+	
+		if (_delta == 0) {
+			return false;
+		}
+
 		oldBalance = getBaseBalance(_account);
 		newBalance = oldBalance + _delta;
 		require(uint160(newBalance) > uint160(oldBalance), 'ERR_WOULDWRAP'); // revert if increase would result in a wrapped value
-		account[_account] &= bytes32(0xffffffffffffffffffffffff0000000000000000000000000000000000000000);
-		account[_account] |= bytes32(newBalance & 0x00ffffffffffffffffffffffffffffffffffffffff);
+		//account[_account] &= bytes32(0xfffffffffffffffffffffff0000000000000000000000000000000000000000);
+		//account[_account] = bytes32(uint256(account[_account]) & 0xfffffffffffffffffffffffffffffffffffffffffffff000000000000000000);
+		workAccount &= 0xfffffffffffffffffffffffffffffffffffffffffffff000000000000000000;
+		//account[_account] |= bytes32(newBalance & 0x00ffffffffffffffffffffffffffffffffffffffff);
+		workAccount |= newBalance & 0xffffffffffffffffff;
+		account[_account] = bytes32(workAccount);
 		return true;
 	}

@@ -84,52 +111,71 @@ contract RedistributedDemurrageToken {
 	function decreaseBaseBalance(address _account, uint256 _delta) private returns (bool) {
 		uint256 oldBalance;
 	       	uint256 newBalance;
+		uint256 workAccount;
+
+		workAccount = uint256(account[_account]); // | (newBalance & 0xffffffffffffffffff);
+
+		if (_delta == 0) {
+			return false;
+		}

 		oldBalance = getBaseBalance(_account);	
 		require(oldBalance >= _delta, 'ERR_OVERSPEND'); // overspend guard
 		newBalance = oldBalance - _delta;
-		account[_account] &= bytes32(0xffffffffffffffffffffffff0000000000000000000000000000000000000000);
-		account[_account] |= bytes32(newBalance & 0x00ffffffffffffffffffffffffffffffffffffffff);
+		//account[_account] &= bytes32(0xffffffffffffffffffffffff0000000000000000000000000000000000000000);
+		workAccount &= 0xfffffffffffffffffffffffffffffffffffffffffffff000000000000000000;
+		//account[_account] |= bytes32(newBalance & 0x00ffffffffffffffffffffffffffffffffffffffff);
+		workAccount |= newBalance & 0xffffffffffffffffff;
+		account[_account] = bytes32(workAccount);
 		return true;
 	}

 	// Creates new tokens out of thin air, and allocates them to the given address
 	// Triggers tax
 	function mintTo(address _beneficiary, uint256 _amount) external returns (bool) {
+		uint256 baseAmount;
+
 		require(minter[msg.sender]);

-		// TODO: get base amount for minting
-		applyTax();
+		changePeriod();
+		baseAmount = _amount;
 		totalSupply += _amount;
-		increaseBaseBalance(_beneficiary, _amount);
+		increaseBaseBalance(_beneficiary, baseAmount);
 		emit Mint(msg.sender, _beneficiary, _amount);
 		saveRedistributionSupply();
 		return true;
 	}

 	// Deserializes the redistribution word
-	function toRedistribution(uint256 _participants, uint256 _value, uint256 _period) private pure returns(bytes32) {
+	// uint1(isFractional) | uint95(unused) | uint20(demurrageModifier) | uint36(participants) | uint72(value) | uint32(period)
+	function toRedistribution(uint256 _participants, uint256 _demurrageModifierPpm, uint256 _value, uint256 _period) private pure returns(bytes32) {
 		bytes32 redistribution;

-		redistribution |= bytes32((_participants & 0x7fffffffff) << 216);
-		redistribution |= bytes32((_value & 0xffffffffffffffffffffffff) << 56);
-		redistribution |= bytes32(_period & 0xffffffffffffff);
+		redistribution |= bytes32((_demurrageModifierPpm & 0x0fffff) << 140);
+		redistribution |= bytes32((_participants & 0x0fffffffff) << 104);
+		redistribution |= bytes32((_value & 0xffffffffffffffffff) << 32);
+		redistribution |= bytes32(_period & 0xffffffff);
 		return redistribution;
 	}

 	// Serializes the demurrage period part of the redistribution word
 	function toRedistributionPeriod(bytes32 redistribution) public pure returns (uint256) {
-		return uint256(redistribution & 0x00000000000000000000000000000000000000000000000000ffffffffffffff);
+		return uint256(redistribution) & 0xffffffff;
 	}

 	// Serializes the supply part of the redistribution word
 	function toRedistributionSupply(bytes32 redistribution) public pure returns (uint256) {
-		return uint256(redistribution & 0x0000000000ffffffffffffffffffffffffffffffffffffffff00000000000000) >> 56;
+		return uint256(redistribution & 0x00000000000000000000000000000000000000ffffffffffffffffff00000000) >> 32;
 	}

 	// Serializes the number of participants part of the redistribution word
 	function toRedistributionParticipants(bytes32 redistribution) public pure returns (uint256) {
-		return uint256(redistribution & 0x7fffffffff000000000000000000000000000000000000000000000000000000) >> 216;
+		return uint256(redistribution & 0x00000000000000000000000000000fffffffff00000000000000000000000000) >> 104;
+	}
+
+	// Serializes the number of participants part of the redistribution word
+	function toRedistributionDemurrageModifier(bytes32 redistribution) public pure returns (uint256) {
+		return uint256(redistribution & 0x000000000000000000000000fffff00000000000000000000000000000000000) >> 140;
 	}

 	// Client accessor to the redistributions array length
@@ -139,16 +185,19 @@ contract RedistributedDemurrageToken {

 	// Add number of participants for the current redistribution period by one
 	function incrementRedistributionParticipants() private returns (bool) {
-		uint256 currentRedistribution;
+		bytes32 currentRedistribution;
+		uint256 tmpRedistribution;
 		uint256 participants;

-		currentRedistribution = uint256(redistributions[redistributions.length-1]);
-		participants = ((currentRedistribution & 0x7fffffffff000000000000000000000000000000000000000000000000000000) >> 216) + 1;
-		currentRedistribution &= 0x8000000000ffffffffffffffffffffffffffffffffffffffffffffffffffffff;
-		currentRedistribution |= participants << 216;
+		currentRedistribution = redistributions[redistributions.length-1];
+		participants = toRedistributionParticipants(currentRedistribution) + 1;
+		tmpRedistribution = uint256(currentRedistribution);
+		tmpRedistribution &= 0xfffffffffffffffffffffffffffff000000000ffffffffffffffffffffffffff;
+		tmpRedistribution |= (participants & 0x0fffffffff) << 104;

-		//emit Debug(participants);
-		redistributions[redistributions.length-1] = bytes32(currentRedistribution);
+		redistributions[redistributions.length-1] = bytes32(tmpRedistribution);
+
+		return true;
 	}

 	// Save the current total supply amount to the current redistribution period
@@ -156,15 +205,16 @@ contract RedistributedDemurrageToken {
 		uint256 currentRedistribution;

 		currentRedistribution = uint256(redistributions[redistributions.length-1]);
-		currentRedistribution &= 0xffffffffff0000000000000000000000000000000000000000ffffffffffffff;
-		currentRedistribution |= totalSupply << 56;
+		currentRedistribution &= 0xffffffffffffffffffffffffffffffffffffff000000000000000000ffffffff;
+		currentRedistribution |= totalSupply << 32;

 		redistributions[redistributions.length-1] = bytes32(currentRedistribution);
+		return true;
 	}

 	// Get the demurrage period of the current block number
 	function actualPeriod() public view returns (uint256) {
-		return (block.number - periodStart) / periodDuration + 1;
+		return (block.timestamp - periodStart) / periodDuration + 1;
 	}

 	// Add an entered demurrage period to the redistribution array
@@ -182,14 +232,17 @@ contract RedistributedDemurrageToken {

 	// Deserialize the pemurrage period for the given account is participating in
 	function accountPeriod(address _account) public view returns (uint256) {
-		return (uint256(account[_account]) & 0xffffffffffffffffffffffff0000000000000000000000000000000000000000) >> 160;
+		//return (uint256(account[_account]) & 0xffffffffffffffffffffffff0000000000000000000000000000000000000000) >> 160;
+		return (uint256(account[_account]) & 0x00000000000000000000000000000000000000ffffffff000000000000000000) >> 72;
 	}

 	// Save the given demurrage period as the currently participation period for the given address
 	function registerAccountPeriod(address _account, uint256 _period) private returns (bool) {
-		account[_account] &= 0x000000000000000000000000ffffffffffffffffffffffffffffffffffffffff;
-		account[_account] |= bytes32(_period << 160);
+		//account[_account] &= 0x000000000000000000000000ffffffffffffffffffffffffffffffffffffffff;
+		account[_account] &= 0xffffffffffffffffffffffffffffffffffffff00000000ffffffffffffffffff;
+		account[_account] |= bytes32(_period << 72);
 		incrementRedistributionParticipants();
+		return true;
 	}

 	// Determine whether the unit number is rounded down, rounded up or evenly divides.
@@ -224,11 +277,11 @@ contract RedistributedDemurrageToken {

 		if (truncatedResult < redistributionSupply) {
 			redistributionPeriod = toRedistributionPeriod(_redistribution); // since we reuse period here, can possibly be optimized by passing period instead
-			redistributions[redistributionPeriod-1] &= 0x0000000000ffffffffffffffffffffffffffffffffffffffffffffffffffffff; // just to be safe, zero out all participant count data, in this case there will be only one
-			redistributions[redistributionPeriod-1] |= 0x8000000001000000000000000000000000000000000000000000000000000000;
+			redistributions[redistributionPeriod-1] &= 0xfffffffffffffffffffffffffffff000000000ffffffffffffffffffffffffff; // just to be safe, zero out all participant count data, in this case there will be only one
+			redistributions[redistributionPeriod-1] |= 0x8000000000000000000000000000000000000100000000000000000000000000;
 		}

-		increaseBaseBalance(sinkAddress, unit); //truncatedResult);
+		increaseBaseBalance(sinkAddress, unit / ppmDivider); //truncatedResult);
 		return unit;
 	}

@@ -241,6 +294,7 @@ contract RedistributedDemurrageToken {
 			return false;
 		}

+		// is this needed?
 		redistributions[_period-1] |= 0x8000000000000000000000000000000000000000000000000000000000000000;

 		periodSupply = toRedistributionSupply(redistributions[_period-1]);
@@ -248,22 +302,80 @@ contract RedistributedDemurrageToken {
 		return true;
 	}

+
+	function toDemurrageAmount(uint256 _demurrage) public pure returns (uint256) {
+		return _demurrage & 0x00000000000000000000000000000000ffffffffffffffffffffffffffffffff;
+	}
+
+	function toDemurragePeriod(uint256 _demurrage) public pure returns (uint256) {
+		return (_demurrage & 0xffffffffffffffffffffffffffffffff00000000000000000000000000000000) >> 128;
+	}
+
+	function applyDemurrage() public returns (bool) {
+		uint256 epochPeriodCount;
+		uint256 periodCount;
+		uint256 lastDemurrageAmount;
+		uint256 newDemurrageAmount;
+
+		epochPeriodCount = actualPeriod();
+		//epochPeriodCount = (block.timestamp - periodStart) / periodDuration; // toDemurrageTime(demurrageModifier);
+		periodCount = epochPeriodCount - toDemurragePeriod(demurrageModifier);
+		if (periodCount == 0) {
+			return false;
+		}
+		lastDemurrageAmount = toDemurrageAmount(demurrageModifier);
+		newDemurrageAmount = decayBy(lastDemurrageAmount, periodCount);
+		demurrageModifier = 0;
+		demurrageModifier |= (newDemurrageAmount & 0x00000000000000000000000000000000ffffffffffffffffffffffffffffffff);
+		demurrageModifier |= (epochPeriodCount << 128);
+		emit Decayed(epochPeriodCount, periodCount, lastDemurrageAmount, newDemurrageAmount);
+		return true;
+	}
+
+	// Return timestamp of start of period threshold
+	function getPeriodTimeDelta(uint256 _periodCount) public view returns (uint256) {
+		return periodStart + (_periodCount * periodDuration);
+	}
+
+	// Amount of demurrage cycles inbetween the current timestamp and the given target time
+	function demurrageCycles(uint256 _target) public view returns (uint256) {
+		return (block.timestamp - _target) / 60;
+	}
+
 	// Recalculate the demurrage modifier for the new period
 	// After this, all REPORTED balances will have been reduced by the corresponding ratio (but the effecive totalsupply stays the same)
-	function applyTax() public returns (uint256) {
+	//function applyTax() public returns (uint256) {
+	function changePeriod() public returns (bool) {
 		bytes32 currentRedistribution;
 		bytes32 nextRedistribution;
 		uint256 currentPeriod;
 		uint256 currentParticipants;
 		uint256 currentRemainder;
+		uint256 currentDemurrageAmount;
+		uint256 nextRedistributionDemurrage;
+		uint256 demurrageCounts;
+		uint256 periodTimestamp;

 		currentRedistribution = checkPeriod();
 		if (currentRedistribution == bytes32(0x00)) {
-			return demurrageModifier;
+			return false;
 		}
-		demurrageModifier -= (demurrageModifier * taxLevel) / 1000000;
+
 		currentPeriod = toRedistributionPeriod(currentRedistribution);
-		nextRedistribution = toRedistribution(0, totalSupply, currentPeriod + 1);
+		periodTimestamp = getPeriodTimeDelta(currentPeriod);
+
+		applyDemurrage();
+		currentDemurrageAmount = toDemurrageAmount(demurrageModifier);
+
+		demurrageCounts = demurrageCycles(periodTimestamp);
+		if (demurrageCounts > 0) {
+			nextRedistributionDemurrage = growBy(currentDemurrageAmount, demurrageCounts) / ppmDivider;
+		} else {
+			nextRedistributionDemurrage = currentDemurrageAmount / ppmDivider;
+		}
+		
+		nextRedistribution = toRedistribution(0, nextRedistributionDemurrage, totalSupply, currentPeriod + 1);
+		emit Debug(bytes32(currentDemurrageAmount));
 		redistributions.push(nextRedistribution);

 		currentParticipants = toRedistributionParticipants(currentRedistribution);
@@ -273,19 +385,35 @@ contract RedistributedDemurrageToken {
 			currentRemainder = remainder(currentParticipants, totalSupply); // we can use totalSupply directly because it will always be the same as the recorded supply on the current redistribution
 			applyRemainderOnPeriod(currentRemainder, currentPeriod);
 		}
-		emit Taxed(currentPeriod, currentRemainder);
-		return demurrageModifier;
+		return true;
+	}
+
+	function growBy(uint256 _value, uint256 _period) public view returns (uint256) {
+		uint256 valueFactor;
+		uint256 truncatedTaxLevel;
+	      
+		// TODO: if can't get to work, reverse the iteration from current period.
+		valueFactor = 1000000;
+		truncatedTaxLevel = taxLevel / ppmDivider;
+
+		for (uint256 i = 0; i < _period; i++) {
+			valueFactor = valueFactor + ((valueFactor * truncatedTaxLevel) / 1000000);
+		}
+		return (valueFactor * _value) / 1000000;
 	}

 	// Calculate a value reduced by demurrage by the given period
-	function toTaxPeriodAmount(uint256 _value, uint256 _period) public view returns (uint256) {
+	// TODO: higher precision
+	function decayBy(uint256 _value, uint256 _period) public view returns (uint256) {
 		uint256 valueFactor;
+		uint256 truncatedTaxLevel;
 	      
-	       	// TODO: doesn't work for solidity as floats are missing and using ints linearly increases the order of magnitude  	
-		// valueFactor = 1000000 * (((1000000-taxLevel)/1000000) ** _period);
+		// TODO: if can't get to work, reverse the iteration from current period.
 		valueFactor = 1000000;
+		truncatedTaxLevel = taxLevel / ppmDivider;
+
 		for (uint256 i = 0; i < _period; i++) {
-			valueFactor = valueFactor - ((valueFactor * taxLevel) / 1000000);
+			valueFactor = valueFactor - ((valueFactor * truncatedTaxLevel) / 1000000);
 		}
 		return (valueFactor * _value) / 1000000;
 	}
@@ -311,10 +439,11 @@ contract RedistributedDemurrageToken {
 		}

 		supply = toRedistributionSupply(periodRedistribution);
-		baseValue = ((supply / participants) * (taxLevel) / 1000000);
-		value = toTaxPeriodAmount(baseValue, period - 1);
+		baseValue = ((supply / participants) * (taxLevel / 1000000)) / ppmDivider;
+		value = decayBy(baseValue, period - 1);

-		account[_account] &= bytes32(0x000000000000000000000000ffffffffffffffffffffffffffffffffffffffff);
+		//account[_account] &= bytes32(0x000000000000000000000000ffffffffffffffffffffffffffffffffffffffff);
+		account[_account] &= bytes32(0xffffffffffffffffffffffffffffffffffffff00000000ffffffffffffffffff);
 		increaseBaseBalance(_account, value);

 		emit Redistribution(_account, period, value);
@@ -323,7 +452,20 @@ contract RedistributedDemurrageToken {

 	// Inflates the given amount according to the current demurrage modifier
 	function toBaseAmount(uint256 _value) public view returns (uint256) {
-		return (_value * 1000000) / demurrageModifier;
+		return (_value * ppmDivider * 1000000) / toDemurrageAmount(demurrageModifier);
+	}
+
+	// ERC20, triggers tax and/or redistribution
+	function approve(address _spender, uint256 _value) public returns (bool) {
+		uint256 baseValue;
+
+		changePeriod();
+		applyRedistributionOnAccount(msg.sender);
+
+		baseValue = toBaseAmount(_value);
+		allowance[msg.sender][_spender] += baseValue;
+		emit Approval(msg.sender, _spender, _value);
+		return true;
 	}

 	// ERC20, triggers tax and/or redistribution
@@ -331,7 +473,7 @@ contract RedistributedDemurrageToken {
 		uint256 baseValue;
 		bool result;

-		applyTax();
+		changePeriod();
 		applyRedistributionOnAccount(msg.sender);

 		// TODO: Prefer to truncate the result, instead it seems to round to nearest :/
@@ -341,6 +483,22 @@ contract RedistributedDemurrageToken {
 		return result;
 	}

+
+	// ERC20, triggers tax and/or redistribution
+	function transferFrom(address _from, address _to, uint256 _value) public returns (bool) {
+		uint256 baseValue;
+		bool result;
+
+		changePeriod();
+		applyRedistributionOnAccount(msg.sender);
+
+		baseValue = toBaseAmount(_value);
+		require(allowance[_from][msg.sender] >= baseValue);
+
+		result = transferBase(_from, _to, baseValue);
+		return result;
+	}
+
 	// ERC20 transfer backend for transfer, transferFrom
 	function transferBase(address _from, address _to, uint256 _value) private returns (bool) {
 		uint256 period;
@@ -354,32 +512,4 @@ contract RedistributedDemurrageToken {
 		}
 		return true;
 	}
-
-	// ERC20, triggers tax and/or redistribution
-	function transferFrom(address _from, address _to, uint256 _value) public returns (bool) {
-		uint256 baseValue;
-		bool result;
-
-		applyTax();
-		applyRedistributionOnAccount(msg.sender);
-
-		baseValue = toBaseAmount(_value);
-		require(allowance[_from][msg.sender] >= baseValue);
-
-		result = transferBase(_from, _to, baseValue);
-		return result;
-	}
-
-	// ERC20, triggers tax and/or redistribution
-	function approve(address _spender, uint256 _value) public returns (bool) {
-		uint256 baseValue;
-
-		applyTax();
-		applyRedistributionOnAccount(msg.sender);
-
-		baseValue = toBaseAmount(_value);
-		allowance[msg.sender][_spender] += baseValue;
-		emit Approval(msg.sender, _spender, _value);
-		return true;
-	}
 }
Author	SHA1	Message	Date
nolash	806ed1907a	Improve demurrage modifier calculation for redistribution cache, add gas bench for same	2021-02-06 19:58:41 +01:00
nolash	2ad59df9c9	Compact words, add demurragemodifier to redistribution word	2021-02-06 19:10:27 +01:00
Louis Holbrook	0f816ebdc5	Merge branch 'lash/use-timestamps' into 'master' Correct base amount on mint See merge request grassrootseconomics/sarafu-token!5	2021-02-06 14:48:40 +00:00
Louis Holbrook	0202676d51	Correct base amount on mint	2021-02-06 14:48:40 +00:00
Louis Holbrook	cf6fd57672	Merge branch 'lash/use-timestamps' into 'master' Use timestamps instead of blocks See merge request grassrootseconomics/sarafu-token!4	2021-02-06 14:18:30 +00:00
Louis Holbrook	0053b90368	Use timestamps instead of blocks	2021-02-06 14:18:30 +00:00