Gateways should store roots in ring buffer (Contract approach)

contracts/gateway/EIP20CoGateway.sol

@@ -211,6 +211,8 @@ contract EIP20CoGateway is GatewayBase {
      * @param _organization Address of an organization contract.
      * @param _gateway Gateway contract address.
      * @param _burner Address where base coin will be burned.
+     * @param _maxStorageRootItems Defines how many storage roots should be
+     *                             stored in circular buffer.
      */
     constructor(
         address _valueToken,
@@ -219,12 +221,14 @@ contract EIP20CoGateway is GatewayBase {
         uint256 _bounty,
         OrganizationInterface _organization,
         address _gateway,
-        address payable _burner
+        address payable _burner,
+        uint256 _maxStorageRootItems
     )
         GatewayBase(
             _stateRootProvider,
             _bounty,
-            _organization
+            _organization,
+            _maxStorageRootItems
         )
         public
     {

contracts/gateway/EIP20Gateway.sol

@@ -237,19 +237,23 @@ contract EIP20Gateway is GatewayBase {
      *                stake process.
      * @param _organization Address of an organization contract.
      * @param _burner Address where base tokens will be burned.
+     * @param _maxStorageRootItems Defines how many storage roots should be
+     *                             stored in circular buffer.
      */
     constructor(
         EIP20Interface _valueToken,
         EIP20Interface _baseToken,
         StateRootInterface _stateRootProvider,
         uint256 _bounty,
         OrganizationInterface _organization,
-        address _burner
+        address _burner,
+        uint256 _maxStorageRootItems
     )
         GatewayBase(
             _stateRootProvider,
             _bounty,
-            _organization
+            _organization,
+            _maxStorageRootItems
         )
         public
     {

contracts/gateway/GatewayBase.sol

@@ -20,6 +20,7 @@ pragma solidity ^0.5.0;
 //
 // ----------------------------------------------------------------------------
 
+import "../lib/CircularBufferUint.sol";
 import "../lib/EIP20Interface.sol";
 import "../lib/GatewayLib.sol";
 import "../lib/MessageBus.sol";
@@ -31,7 +32,7 @@ import "../lib/StateRootInterface.sol";
 /**
  *  @title GatewayBase is the base contract for EIP20Gateway and EIP20CoGateway.
  */
-contract GatewayBase is Organized {
+contract GatewayBase is Organized, CircularBufferUint {
 
     /* Usings */
 
@@ -67,12 +68,12 @@ contract GatewayBase is Organized {
     /* Constants */
 
     /** Position of message bus in the storage. */
-    uint8 constant MESSAGE_BOX_OFFSET = 7;
+    uint8 public constant MESSAGE_BOX_OFFSET = 9;
 
     /**
      * Penalty in bounty amount percentage charged to message sender on revert message.
      */
-    uint8 constant REVOCATION_PENALTY = 150;
+    uint8 public constant REVOCATION_PENALTY = 150;
 
     //todo identify how to get block time for both chains
     /**
@@ -112,8 +113,8 @@ contract GatewayBase is Organized {
 
     /**
      * Message box.
-     * @dev Keep this is at location 1, in case this is changed then update
-     *      constant MESSAGE_BOX_OFFSET accordingly.
+     * @dev update constant MESSAGE_BOX_OFFSET according to the index of messageBox.
+     *
      */
     MessageBus.MessageBox internal messageBox;
 
@@ -159,13 +160,17 @@ contract GatewayBase is Organized {
      * @param _bounty The amount that facilitator will stakes to initiate the
      *                message transfers.
      * @param _organization Address of an organization contract.
+     * @param _maxStorageRootItems Defines how many storage roots should be
+     *                             stored in circular buffer.
      */
     constructor(
         StateRootInterface _stateRootProvider,
         uint256 _bounty,
-        OrganizationInterface _organization
+        OrganizationInterface _organization,
+        uint256 _maxStorageRootItems
     )
         Organized(_organization)
+        CircularBufferUint(_maxStorageRootItems)
         public
     {
         require(
@@ -257,6 +262,8 @@ contract GatewayBase is Organized {
         );
 
         storageRoots[_blockHeight] = storageRoot;
+        uint256 oldestStoredBlockHeight = CircularBufferUint.store(_blockHeight);
+        delete storageRoots[oldestStoredBlockHeight];
 
         // wasAlreadyProved is false since Gateway is called for the first time
         // for a block height

contracts/test/gateway/MockGatewayBase.sol

@@ -22,17 +22,21 @@ contract MockGatewayBase is GatewayBase {
      * @param _bounty The amount that facilitator will stakes to initiate the
      *                stake process.
      * @param _organization Address of a contract that manages workers.
+     * @param _maxStorageRootItems Defines how many storage roots should be
+     *                             stored in circular buffer.
      */
     constructor(
         StateRootInterface _stateRootProvider,
         uint256 _bounty,
-        OrganizationInterface _organization
+        OrganizationInterface _organization,
+        uint256 _maxStorageRootItems
     )
         public
         GatewayBase(
             _stateRootProvider,
             _bounty,
-            _organization
+            _organization,
+            _maxStorageRootItems
         )
     {}
 
@@ -102,9 +106,9 @@ contract MockGatewayBase is GatewayBase {
             // return true
             return true;
         }
-        
+
         // On successful proof verification storage root is returned other wise
-        // transaction is reverted. 
+        // transaction is reverted.
         bytes32 storageRoot = MockGatewayLib.proveAccount(
             _rlpAccount,
             _rlpParentNodes,
@@ -113,6 +117,8 @@ contract MockGatewayBase is GatewayBase {
         );
 
         storageRoots[_blockHeight] = storageRoot;
+        uint256 oldestStoredBlockHeight = CircularBufferUint.store(_blockHeight);
+        delete storageRoots[oldestStoredBlockHeight];
 
         // wasAlreadyProved is false since Gateway is called for the first time
         // for a block height
@@ -125,4 +131,23 @@ contract MockGatewayBase is GatewayBase {
 
         return true;
     }
+
+    /**
+     *  @notice Get the storage root for the given block height. This is only
+     *          testing
+     *
+     *  @param _blockHeight Block height for which the storage root is to be
+     *                      fetched.
+     *
+     *  @return storageRoot_ Storage root for the given block height.
+     */
+    function getStorageRoot(
+        uint256 _blockHeight
+    )
+        external
+        view
+        returns (bytes32 storageRoot_)
+    {
+        storageRoot_ = storageRoots[_blockHeight];
+    }
 }

contracts/test/gateway/TestEIP20CoGateway.sol

@@ -47,6 +47,8 @@ contract TestEIP20CoGateway is EIP20CoGateway {
      * @param _organization Address of an organization contract.
      * @param _gateway Gateway contract address.
      * @param _burner An address where base tokens are sent when they should be burnt.
+     * @param _maxStorageRootItems Defines how many storage roots should be
+     *                             stored in circular buffer.
      */
     constructor(
         address _valueToken,
@@ -55,7 +57,8 @@ contract TestEIP20CoGateway is EIP20CoGateway {
         uint256 _bounty,
         OrganizationInterface _organization,
         address _gateway,
-        address payable _burner
+        address payable _burner,
+        uint256 _maxStorageRootItems
     )
         EIP20CoGateway(
             _valueToken,
@@ -64,7 +67,8 @@ contract TestEIP20CoGateway is EIP20CoGateway {
             _bounty,
             _organization,
             _gateway,
-            _burner
+            _burner,
+            _maxStorageRootItems
     )
         public
     {}

contracts/test/gateway/TestEIP20Gateway.sol

@@ -42,22 +42,26 @@ contract TestEIP20Gateway is EIP20Gateway {
      *                stake process.
      * @param _organization Address of an organization contract.
      * @param _burner Address where base tokens will be burned.
+     * @param _maxStorageRootItems Defines how many storage roots should be
+     *                             stored in circular buffer.
      */
     constructor(
         EIP20Interface _valueToken,
         EIP20Interface _baseToken,
         StateRootInterface _stateRootProvider,
         uint256 _bounty,
         OrganizationInterface _organization,
-        address payable _burner
+        address payable _burner,
+        uint256 _maxStorageRootItems
     )
         EIP20Gateway(
             _valueToken,
             _baseToken,
             _stateRootProvider,
             _bounty,
             _organization,
-            _burner
+            _burner,
+            _maxStorageRootItems
         )
         public
     {

contracts/test/gateway/TestGatewayBase.sol

@@ -47,17 +47,21 @@ contract TestGatewayBase is GatewayBase {
      * @param _bounty The amount that facilitator will stakes to initiate the
      *                message transfers.
      * @param _organization Address of a contract that manages workers.
+     * @param _maxStorageRootItems Defines how many storage roots should be
+     *                             stored in circular buffer.
      */
     constructor(
         StateRootInterface _stateRootProvider,
         uint256 _bounty,
-        OrganizationInterface _organization
+        OrganizationInterface _organization,
+        uint256 _maxStorageRootItems
     )
         public
         GatewayBase(
             _stateRootProvider,
             _bounty,
-            _organization
+            _organization,
+            _maxStorageRootItems
         )
     {}
 

proof_generation/deployer.js

@@ -48,6 +48,7 @@ async function deployer(web3Provider, accounts) {
   const bounty = new BN(100);
   const organization = await MockOrganization.new(owner, worker);
   const burner = Utils.NULL_ADDRESS;
+  const maxStorageRootItems = new BN(50);
 
   const anchor = await Anchor.new(
     remoteChainId,
@@ -75,6 +76,7 @@ async function deployer(web3Provider, accounts) {
     bounty,
     organization.address,
     burner,
+    maxStorageRootItems,
   );
 
   const coGateway = await CoGateway.new(
@@ -85,6 +87,7 @@ async function deployer(web3Provider, accounts) {
     organization.address,
     gateway.address,
     burner,
+    maxStorageRootItems,
   );
 
   await mockUtilityToken.setCoGateway(coGateway.address, { from: owner });

proof_generation/generator.js

@@ -288,3 +288,74 @@ contract('Redeem and Unstake ', (accounts) => {
     }
   });
 });
+
+contract('Reward based on gas consumption', (accounts) => {
+  let registeredContracts;
+  let redeemParams;
+  let rpcEndpointOrigin;
+  let proofUtils;
+  let web3Provider;
+  let proofGenerationUtils;
+
+  before(async () => {
+    ({ rpcEndpointOrigin } = await docker());
+    web3Provider = new Web3(rpcEndpointOrigin);
+    proofUtils = new ProofUtils(web3Provider, web3Provider);
+  });
+
+  beforeEach(async () => {
+    registeredContracts = await deployer(web3Provider, accounts);
+    redeemParams = {
+      amount: new BN(1000000000000000),
+      gasPrice: new BN(10000000),
+      gasLimit: new BN(10000000),
+      nonce: new BN(0),
+      redeemer: accounts[0],
+      beneficiary: accounts[2],
+    };
+    proofGenerationUtils = new ProofGenerationUtils(
+      registeredContracts,
+      null,
+      redeemParams,
+      proofUtils,
+    );
+  });
+
+  it('Generates proof data for "Redeem progressed"', async () => {
+    const numberOfProofs = 1;
+
+    for (let i = 0; i < numberOfProofs; i++) {
+      proofGenerationUtils.resetProofData();
+      await proofGenerationUtils.initializeProofData();
+
+      const {
+        redeemProofData,
+      } = await proofGenerationUtils.populateRedeemProofData();
+
+      const {
+        confirmRedeemIntentResult,
+      } = await proofGenerationUtils.populateConfirmRedeemIntentProofData(
+        redeemProofData,
+      );
+
+      const {
+        progressRedeemParams,
+      } = await proofGenerationUtils.populateProgressRedeemProofData(
+        confirmRedeemIntentResult,
+      );
+
+      await proofGenerationUtils.populateProgressUnstakeProofData(
+        progressRedeemParams,
+      );
+
+      // Write the proof data in to the files.
+      writeToFile(
+        `${PROOF_GENERATED_PATH}redeem_progressed_reward_based_on_gas_consumption.json`,
+        JSON.stringify(proofGenerationUtils.proofData),
+      );
+
+      // proof data is generated starting from nonce 0.
+      redeemParams.nonce = redeemParams.nonce.addn(1);
+    }
+  });
+});

proof_generation/helper/gateway.js

@@ -431,6 +431,15 @@ class Gateway {
       burner,
     };
   }
+
+  /**
+   * Returns the message box offset
+   *
+   * @returns {BN} message box offset.
+   */
+  async getMessageBoxOffset() {
+    return await this.gateway.MESSAGE_BOX_OFFSET.call();
+  }
 }
 
 module.exports = Gateway;