doc

ringecosystem · Jul 31, 2023 · dc40852 · dc40852
1 parent e680621
commit dc40852
Show file tree

Hide file tree

Showing 8 changed files with 27 additions and 16 deletions.
diff --git a/src/Channel.sol b/src/Channel.sol
@@ -17,14 +17,10 @@
 
 pragma solidity 0.8.17;
 
-import "./Common.sol";
-import "./imt/IncrementalMerkleTree.sol";
+import "./interfaces/IEndpoint.sol";
 import "./interfaces/IUserConfig.sol";
 import "./interfaces/IVerifier.sol";
-
-interface IEndpoint {
-    function recv(Message calldata message) external returns (bool dispatchResult);
-}
+import "./imt/IncrementalMerkleTree.sol";
 
 /// @title Channel
 /// @notice A channel is a logical connection over cross-chain network.

diff --git a/src/Endpoint.sol b/src/Endpoint.sol
@@ -18,11 +18,11 @@
 pragma solidity 0.8.17;
 
 import "./Common.sol";
-import "./call/ExcessivelySafeCall.sol";
-import "./interfaces/IUserConfig.sol";
+import "./interfaces/IOracle.sol";
 import "./interfaces/IChannel.sol";
 import "./interfaces/IRelayer.sol";
-import "./interfaces/IOracle.sol";
+import "./interfaces/IUserConfig.sol";
+import "./call/ExcessivelySafeCall.sol";
 import "./security/ReentrancyGuard.sol";
 
 /// @title Endpoint

diff --git a/src/Verifier.sol b/src/Verifier.sol
@@ -17,17 +17,24 @@
 
 pragma solidity 0.8.17;
 
-import "./imt/IncrementalMerkleTree.sol";
 import "./interfaces/IVerifier.sol";
+import "./imt/IncrementalMerkleTree.sol";
 
 abstract contract Verifier is IVerifier {
+    /// @notice Message proof.
+    /// @param messageIndex Leaf index of the message hash in incremental merkle tree.
+    /// @param messageProof Merkle proof of the message hash.
     struct Proof {
         uint256 messageIndex;
         bytes32[32] messageProof;
     }
 
+    /// @notice Fetch message root oracle.
+    /// @param chainId The destination chain id.
+    /// @return Message root in destination chain.
     function merkleRoot(uint256 chainId) public view virtual returns (bytes32);
 
+    /// @inheritdoc IVerifier
     function verifyMessageProof(uint256 fromChainId, bytes32 msgHash, bytes calldata proof)
         external
         view

diff --git a/src/eco/Oracle.sol b/src/eco/Oracle.sol
@@ -17,8 +17,8 @@
 
 pragma solidity 0.8.17;
 
-import "../interfaces/IFeedOracle.sol";
 import "../Verifier.sol";
+import "../interfaces/IFeedOracle.sol";
 
 contract Oracle is Verifier {
     event Assigned(bytes32 indexed msgHash);

diff --git a/src/eco/Relayer.sol b/src/eco/Relayer.sol
@@ -17,11 +17,7 @@
 
 pragma solidity 0.8.17;
 
-import "../Common.sol";
-
-interface IChannel {
-    function recvMessage(Message calldata message, bytes calldata proof) external;
-}
+import "../interfaces/IChannel.sol";
 
 contract Relayer {
     event Assigned(bytes32 indexed msgHash, uint256 fee);

diff --git a/src/interfaces/IChannel.sol b/src/interfaces/IChannel.sol
@@ -17,8 +17,11 @@
 
 pragma solidity 0.8.17;
 
+import "../Common.sol";
+
 interface IChannel {
     function sendMessage(address from, uint256 toChainId, address to, bytes calldata encoded)
         external
         returns (bytes32);
+    function recvMessage(Message calldata message, bytes calldata proof) external;
 }
diff --git a/src/interfaces/IEndpoint.sol b/src/interfaces/IEndpoint.sol
@@ -44,4 +44,6 @@ interface IEndpoint {
     /// @param message Failed message info.
     /// @return dispatchResult Result of the message dispatch.
     function retryFailedMessage(Message calldata message) external returns (bool dispatchResult);
+
+    function recv(Message calldata message) external returns (bool dispatchResult);
 }
diff --git a/src/interfaces/IVerifier.sol b/src/interfaces/IVerifier.sol
@@ -18,6 +18,13 @@
 pragma solidity 0.8.17;
 
 interface IVerifier {
+    /// @notice Verify message proof
+    /// @dev Message proof provided by relayer. Oracle should provide message root of
+    ///      source chain, and verify the merkle proof of the message hash.
+    /// @param fromChainId Source chain id.
+    /// @param msgHash Hash of the message.
+    /// @param proof Merkle proof of the message
+    /// @return Result of the message verify.
     function verifyMessageProof(uint256 fromChainId, bytes32 msgHash, bytes calldata proof)
         external
         view