Merge pull request #202 from hyperledger-labs/fix-timestamp-nanosecs

Clarify getTimestampAtHeight returns nanoseconds from unix epoch Signed-off-by: Jun Kimura <[email protected]>
hyperledger-labs · Aug 30, 2023 · 3c89bc6 · 3c89bc6
2 parents 9e672af + 0bb0f0f
commit 3c89bc6
Show file tree

Hide file tree

Showing 8 changed files with 13 additions and 9 deletions.
diff --git a/.gas-snapshot b/.gas-snapshot
@@ -1,6 +1,6 @@
-IBCTest:testBenchmarkCreateMockClient() (gas: 212200)
+IBCTest:testBenchmarkCreateMockClient() (gas: 213924)
 IBCTest:testBenchmarkRecvPacket() (gas: 152562)
 IBCTest:testBenchmarkSendPacket() (gas: 85084)
-IBCTest:testBenchmarkUpdateMockClient() (gas: 126734)
-IBCTest:testConnectionOpenInit() (gas: 494208)
+IBCTest:testBenchmarkUpdateMockClient() (gas: 129368)
+IBCTest:testConnectionOpenInit() (gas: 495932)
 IBCTest:testToUint128((uint64,uint64)) (runs: 256, μ: 1051, ~: 1051)
diff --git a/contracts/clients/IBFT2Client.sol b/contracts/clients/IBFT2Client.sol
@@ -91,6 +91,7 @@ contract IBFT2Client is ILightClient {
 
     /**
      * @dev getTimestampAtHeight returns the timestamp of the consensus state at the given height.
+     *      The timestamp is nanoseconds since unix epoch.
      */
     function getTimestampAtHeight(string calldata clientId, Height.Data calldata height)
         external
@@ -99,7 +100,8 @@ contract IBFT2Client is ILightClient {
         returns (uint64, bool)
     {
         ConsensusState.Data storage consensusState = consensusStates[clientId][height.toUint128()];
-        return (consensusState.timestamp, consensusState.timestamp != 0);
+        // ConsensState.timestamp is seconds since unix epoch, so need to convert it to nanoseconds
+        return (consensusState.timestamp * 1e9, consensusState.timestamp != 0);
     }
 
     /**

diff --git a/contracts/clients/MockClient.sol b/contracts/clients/MockClient.sol
@@ -74,6 +74,7 @@ contract MockClient is ILightClient {
 
     /**
      * @dev getTimestampAtHeight returns the timestamp of the consensus state at the given height.
+     *      The timestamp is nanoseconds since unix epoch.
      */
     function getTimestampAtHeight(string calldata clientId, Height.Data calldata height)
         external

diff --git a/contracts/core/02-client/ILightClient.sol b/contracts/core/02-client/ILightClient.sol
@@ -18,6 +18,7 @@ interface ILightClient {
 
     /**
      * @dev getTimestampAtHeight returns the timestamp of the consensus state at the given height.
+     *      The timestamp is nanoseconds since unix epoch.
      */
     function getTimestampAtHeight(string calldata clientId, Height.Data calldata height)
         external

diff --git a/contracts/core/04-channel/IBCPacket.sol b/contracts/core/04-channel/IBCPacket.sol
@@ -21,7 +21,7 @@ contract IBCPacket is IBCStore, IIBCPacket {
     /**
      * @dev sendPacket is called by a module in order to send an IBC packet on a channel.
      * The packet sequence generated for the packet to be sent is returned. An error
-     * is returned if one occurs.
+     * is returned if one occurs. Also, `timeoutTimestamp` is given in nanoseconds since unix epoch.
      */
     function sendPacket(
         string calldata sourcePort,

diff --git a/contracts/core/04-channel/IIBCChannel.sol b/contracts/core/04-channel/IIBCChannel.sol
@@ -40,7 +40,7 @@ interface IIBCPacket {
     /**
      * @dev sendPacket is called by a module in order to send an IBC packet on a channel.
      * The packet sequence generated for the packet to be sent is returned. An error
-     * is returned if one occurs.
+     * is returned if one occurs. Also, `timeoutTimestamp` is given in nanoseconds since unix epoch.
      */
     function sendPacket(
         string calldata sourcePort,

diff --git a/pkg/testing/chains.go b/pkg/testing/chains.go
@@ -262,7 +262,7 @@ func (chain *Chain) ConstructMockMsgCreateClient(counterparty *Chain) ibchandler
 		LatestHeight: ibcclient.NewHeightFromBN(counterparty.LastHeader().Number),
 	}
 	consensusState := mockclienttypes.ConsensusState{
-		Timestamp: counterparty.LastHeader().Time,
+		Timestamp: counterparty.LastHeader().Time * 1e9,
 	}
 	clientStateBytes, err := MarshalWithAny(&clientState)
 	if err != nil {

diff --git a/tests/foundry/src/IBC.t.sol b/tests/foundry/src/IBC.t.sol
@@ -155,7 +155,7 @@ contract IBCTest is Test {
                     })
                     ),
                 consensusStateBytes: wrapAnyMockConsensusState(
-                    IbcLightclientsMockV1ConsensusState.Data({timestamp: uint64(block.timestamp)})
+                    IbcLightclientsMockV1ConsensusState.Data({timestamp: uint64(block.timestamp * 1e9)})
                     )
             })
         );
@@ -168,7 +168,7 @@ contract IBCTest is Test {
                 clientMessage: wrapAnyMockHeader(
                     IbcLightclientsMockV1Header.Data({
                         height: Height.Data({revision_number: 0, revision_height: nextRevisionHeight}),
-                        timestamp: uint64(block.timestamp)
+                        timestamp: uint64(block.timestamp * 1e9)
                     })
                     )
             })