Merge pull request #8 from datachainlab/max-clock-drift

Add `max_clock_drift` option support Signed-off-by: Jun Kimura <[email protected]>
datachainlab · Jun 30, 2024 · 29cf77c · 29cf77c
2 parents ae3d7d5 + a75be2b
commit 29cf77c
Show file tree

Hide file tree

Showing 10 changed files with 389 additions and 357 deletions.
diff --git a/e2e/package-lock.json b/e2e/package-lock.json
diff --git a/e2e/package.json b/e2e/package.json
@@ -3,7 +3,7 @@
   "version": "0.1.0",
   "description": "A hardhat example project with ibc-solidity",
   "devDependencies": {
-    "@hyperledger-labs/yui-ibc-solidity": "git+https://github.com/hyperledger-labs/yui-ibc-solidity.git#v0.3.29",
+    "@hyperledger-labs/yui-ibc-solidity": "git+https://github.com/hyperledger-labs/yui-ibc-solidity.git#v0.3.30",
     "@nomicfoundation/hardhat-toolbox": "^4.0.0",
     "chai": "^4.3.10",
     "hardhat": "^2.19.1"

diff --git a/e2e/relayer/configs/templates/ibc0.json.tpl b/e2e/relayer/configs/templates/ibc0.json.tpl
@@ -33,6 +33,7 @@
   "prover": {
     "@type": "/relayer.provers.qbft.config.ProverConfig",
     "consensus_type": "$CONSENSUS_TYPE",
-    "trusting_period": "336h"
+    "trusting_period": "336h",
+    "max_clock_drift": "30s"
   }
 }
diff --git a/e2e/relayer/configs/templates/ibc1.json.tpl b/e2e/relayer/configs/templates/ibc1.json.tpl
@@ -30,6 +30,7 @@
   "prover": {
     "@type": "/relayer.provers.qbft.config.ProverConfig",
     "consensus_type": "$CONSENSUS_TYPE",
-    "trusting_period": "336h"
+    "trusting_period": "336h",
+    "max_clock_drift": "30s"
   }
 }
diff --git a/module/config.go b/module/config.go
@@ -32,6 +32,11 @@ func (c ProverConfig) Validate() error {
 			return fmt.Errorf("invalid trusting period: %s", c.TrustingPeriod)
 		}
 	}
+	if c.MaxClockDrift != "" {
+		if _, err := time.ParseDuration(c.MaxClockDrift); err != nil {
+			return fmt.Errorf("invalid max clock drift: %s", c.MaxClockDrift)
+		}
+	}
 	return nil
 }
 
@@ -49,3 +54,14 @@ func (c ProverConfig) GetTrustingPeriod() time.Duration {
 	}
 	return d
 }
+
+func (c ProverConfig) GetMaxClockDrift() time.Duration {
+	if c.MaxClockDrift == "" {
+		return 0
+	}
+	d, err := time.ParseDuration(c.MaxClockDrift)
+	if err != nil {
+		panic(err)
+	}
+	return d
+}
diff --git a/module/config.pb.go b/module/config.pb.go
diff --git a/module/prover.go b/module/prover.go
@@ -77,6 +77,7 @@ func (pr *Prover) CreateInitialLightClientState(height exported.Height) (exporte
 		IbcStoreAddress: pr.chain.Config().IBCAddress().Bytes(),
 		LatestHeight:    clienttypes.NewHeight(0, uint64(header.Number.Int64())),
 		TrustingPeriod:  uint64(pr.config.GetTrustingPeriod().Seconds()),
+		MaxClockDrift:   uint64(pr.config.GetMaxClockDrift().Seconds()),
 	}
 	consensusState := &ConsensusState{
 		Timestamp:  header.Time,

diff --git a/module/qbft.pb.go b/module/qbft.pb.go
diff --git a/proto/ibc/lightclients/qbft/v1/qbft.proto b/proto/ibc/lightclients/qbft/v1/qbft.proto
@@ -12,7 +12,11 @@ message ClientState {
   bytes chain_id = 1;
   bytes ibc_store_address = 2;
   ibc.core.client.v1.Height latest_height = 3 [(gogoproto.nullable) = false];
+  // duration in seconds
+  // if this is set to 0, the client will not verify the header's timestamp is within the trusting period
   uint64 trusting_period = 4;
+  // duration in seconds
+  uint64 max_clock_drift = 5;
 }
 
 message ConsensusState {
@@ -22,6 +26,7 @@ message ConsensusState {
 }
 
 message Header {
+  // RLP encoded header of Besu, which does not include the seals in the extra data
   bytes besu_header_rlp = 1;
   repeated bytes seals = 2;
   ibc.core.client.v1.Height trusted_height = 3 [(gogoproto.nullable) = false];

diff --git a/proto/relayer/provers/qbft/config/config.proto b/proto/relayer/provers/qbft/config/config.proto
@@ -9,4 +9,5 @@ option (gogoproto.goproto_getters_all) = false;
 message ProverConfig {
   string consensus_type = 1;
   string trusting_period = 2;
+  string max_clock_drift = 3;
 }