Merge pull request #578 from deepesh-kn/gh_424

Unit test cases for progressStakeWithProof

contracts/gateway/EIP20Gateway.sol

@@ -445,30 +445,23 @@ contract EIP20Gateway is GatewayBase {
     {
         require(
             _messageHash != bytes32(0),
-            "Message hash must not be zero"
+            "Message hash must not be zero."
         );
         require(
             _rlpParentNodes.length > 0,
-            "RLP encoded parent nodes must not be zero"
+            "RLP encoded parent nodes must not be zero."
         );
 
         bytes32 storageRoot = storageRoots[_blockHeight];
 
         require(
             storageRoot != bytes32(0),
-            "Storage root must not be zero"
+            "Storage root must not be zero."
         );
 
         // Get the message object
         MessageBus.Message storage message = messages[_messageHash];
 
-        (staker_, stakeAmount_) = progressStakeInternal(
-            _messageHash,
-            message,
-            bytes32(0),
-            true
-        );
-
         MessageBus.progressOutboxWithProof(
             messageBox,
             message,
@@ -477,6 +470,14 @@ contract EIP20Gateway is GatewayBase {
             storageRoot,
             MessageBus.MessageStatus(_messageStatus)
         );
+
+        (staker_, stakeAmount_) = progressStakeInternal(
+            _messageHash,
+            message,
+            bytes32(0),
+            true
+        );
+
     }
 
     /**
@@ -737,7 +738,6 @@ contract EIP20Gateway is GatewayBase {
      *                      facilitator while initiating the redeem
      *
      * @return redeemer_ Redeemer address
-     * @return beneficiary_ Address to which the tokens will be transferred.
      * @return redeemAmount_ Total amount for which the redeem was
      *                       initiated. The reward amount is deducted from the
      *                       total redeem amount and is given to the

contracts/lib/MessageBus.sol

@@ -258,21 +258,34 @@ library MessageBus {
         external
         returns (bytes32 messageHash_)
     {
-        // The inbox message status must be either `Declared` or `Progressed`.
-        require(
-            _messageStatus == MessageStatus.Declared ||
-            _messageStatus == MessageStatus.Progressed,
-            "Message on target must be Declared or Progressed."
-        );
-
         messageHash_ = messageDigest(_message);
 
-        // The message status must be `Declared` or DeclaredRevocation`.
-        require(
-            _messageBox.outbox[messageHash_] == MessageStatus.Declared ||
-            _messageBox.outbox[messageHash_] == MessageStatus.DeclaredRevocation,
-            "Message on source must be Declared."
-        );
+        if(_messageBox.outbox[messageHash_] == MessageStatus.Declared) {
+
+            /*
+             * The inbox message status of target must be either `Declared` or
+             * `Progressed` when outbox message status at source is `Declared`.
+             */
+            require(
+                _messageStatus == MessageStatus.Declared ||
+                _messageStatus == MessageStatus.Progressed,
+                "Message on target must be Declared or Progressed."
+            );
+
+        } else if (_messageBox.outbox[messageHash_] == MessageStatus.DeclaredRevocation) {
+
+            /*
+             * The inbox message status of target must be either `Progressed`
+             * when outbox message status at source is `DeclaredRevocation`.
+             */
+            require(
+                _messageStatus == MessageStatus.Progressed,
+                "Message on target must be Progressed."
+            );
+
+        } else {
+            revert("Status of message on source must be Declared or DeclareRevocation.");
+        }
 
         bytes memory storagePath = bytes32ToBytes(
             storageVariablePathForStruct(
@@ -683,31 +696,20 @@ library MessageBus {
         pure
         returns(bytes32 storagePath_)
     {
+        if(_offset > 0){
+            _structPosition = _structPosition + _offset;
+        }
+
         bytes memory indexBytes = BytesLib.leftPad(
-            bytes32ToBytes(
-                bytes32(uint256(_structPosition))
-            )
+            bytes32ToBytes(bytes32(uint256(_structPosition)))
         );
+
         bytes memory keyBytes = BytesLib.leftPad(bytes32ToBytes(_key));
         bytes memory path = BytesLib.concat(keyBytes, indexBytes);
 
-        bytes32 structPath = keccak256(
-            abi.encodePacked(
-                keccak256(
-                    abi.encodePacked(path)
-                )
-            )
+        storagePath_ = keccak256(
+            abi.encodePacked(keccak256(abi.encodePacked(path)))
         );
-
-        if (_offset == 0) {
-            return structPath;
-        }
-        bytes32 storagePath;
-        uint8 offset = _offset;
-        assembly {
-            storagePath := add(structPath, offset)
-        }
-        storagePath_ = keccak256(abi.encodePacked(storagePath));
     }
 
     /**

contracts/test/TestEIP20Gateway.sol

@@ -179,6 +179,23 @@ contract TestEIP20Gateway is EIP20Gateway {
         messageBox.outbox[_messageHash] = _status;
     }
 
+    /**
+     * @notice It sets the storage root for given block height.
+     *
+     * @dev This is used for testing purpose.
+     *
+     * @param _blockHeight Mocked block height for testing.
+     * @param _storageRoot Mocked storage root for merkle proof testing.
+    */
+    function setStorageRoot(
+        uint256 _blockHeight,
+        bytes32 _storageRoot
+    )
+        public
+    {
+        storageRoots[_blockHeight] = _storageRoot;
+    }
+
     /**
      * @notice It sets the status of inbox.
      *

contracts/test/lib/MockMessageBus.sol

@@ -258,21 +258,34 @@ library MockMessageBus {
         external
         returns (bytes32 messageHash_)
     {
-        // The inbox message status must be either `Declared` or `Progressed`.
-        require(
-            _messageStatus == MessageStatus.Declared ||
-            _messageStatus == MessageStatus.Progressed,
-            "Message on target must be Declared or Progressed."
-        );
-
         messageHash_ = messageDigest(_message);
 
-        // The message status must be `Declared` or DeclaredRevocation`.
-        require(
-            _messageBox.outbox[messageHash_] == MessageStatus.Declared ||
-            _messageBox.outbox[messageHash_] == MessageStatus.DeclaredRevocation,
-            "Message on source must be Declared."
-        );
+        if(_messageBox.outbox[messageHash_] == MessageStatus.Declared) {
+
+            /*
+             * The inbox message status of target must be either `Declared` or
+             * `Progressed` when outbox message status at source is `Declared`.
+             */
+            require(
+                _messageStatus == MessageStatus.Declared ||
+                _messageStatus == MessageStatus.Progressed,
+                "Message on target must be Declared or Progressed."
+            );
+
+        } else if (_messageBox.outbox[messageHash_] == MessageStatus.DeclaredRevocation) {
+
+            /*
+             * The inbox message status of target must be either `Progressed`
+             * when outbox message status at source is `DeclaredRevocation`.
+             */
+            require(
+                _messageStatus == MessageStatus.Progressed,
+                "Message on target must be Progressed."
+            );
+
+        } else {
+            revert("Status of message on source must be Declared or DeclareRevocation.");
+        }
 
         bytes memory storagePath = bytes32ToBytes(
             storageVariablePathForStruct(
@@ -689,31 +702,20 @@ library MockMessageBus {
         pure
         returns(bytes32 storagePath_)
     {
+        if(_offset > 0){
+            _structPosition = _structPosition + _offset;
+        }
+
         bytes memory indexBytes = BytesLib.leftPad(
-            bytes32ToBytes(
-                bytes32(uint256(_structPosition))
-            )
+            bytes32ToBytes(bytes32(uint256(_structPosition)))
         );
+
         bytes memory keyBytes = BytesLib.leftPad(bytes32ToBytes(_key));
         bytes memory path = BytesLib.concat(keyBytes, indexBytes);
 
-        bytes32 structPath = keccak256(
-            abi.encodePacked(
-                keccak256(
-                    abi.encodePacked(path)
-                )
-            )
+        storagePath_ = keccak256(
+            abi.encodePacked(keccak256(abi.encodePacked(path)))
         );
-
-        if (_offset == 0) {
-            return structPath;
-        }
-        bytes32 storagePath;
-        uint8 offset = _offset;
-        assembly {
-            storagePath := add(structPath, offset)
-        }
-        storagePath_ = keccak256(abi.encodePacked(storagePath));
     }
 
     /**