Merge branch 'main' into hotshot/rc-0.5.59

EspressoSystems · Jun 24, 2024 · 89efa27 · 89efa27
2 parents 7862a1d + cae4960
commit 89efa27
Show file tree

Hide file tree

Showing 6 changed files with 18 additions and 14 deletions.
diff --git a/contract-bindings/artifacts/LightClientMock_bytecode.json b/contract-bindings/artifacts/LightClientMock_bytecode.json
diff --git a/contract-bindings/artifacts/LightClient_bytecode.json b/contract-bindings/artifacts/LightClient_bytecode.json
diff --git a/contract-bindings/src/light_client.rs b/contract-bindings/src/light_client.rs
diff --git a/contract-bindings/src/light_client_mock.rs b/contract-bindings/src/light_client_mock.rs
diff --git a/contracts/src/LightClient.sol b/contracts/src/LightClient.sol
@@ -421,19 +421,22 @@ contract LightClient is Initializable, OwnableUpgradeable, UUPSUpgradeable {
         return stateUpdateBlockNumbers.length;
     }
 
-    /// @notice get the HotShot commitment at the specified block height
+    /// @notice get the HotShot commitment that represents the Merkle root containing the leaf at
+    /// the provided height
     /// @param hotShotBlockHeight hotShotBlockHeight
     function getHotShotCommitment(uint256 hotShotBlockHeight)
         public
         view
         returns (HotShotCommitment memory)
     {
         uint256 commitmentsHeight = hotShotCommitments.length;
-        if (hotShotBlockHeight > hotShotCommitments[commitmentsHeight - 1].blockHeight) {
+        if (hotShotBlockHeight >= hotShotCommitments[commitmentsHeight - 1].blockHeight) {
             revert InvalidHotShotBlockForCommitmentCheck();
         }
         for (uint256 i = 0; i < commitmentsHeight; i++) {
-            if (hotShotCommitments[i].blockHeight >= hotShotBlockHeight) {
+            // The first commitment greater than the provided height is the root of the tree
+            // that leaf at that HotShot height
+            if (hotShotCommitments[i].blockHeight > hotShotBlockHeight) {
                 return hotShotCommitments[i];
             }
         }

diff --git a/contracts/test/LightClient.t.sol b/contracts/test/LightClient.t.sol
@@ -852,6 +852,10 @@ contract LightClient_HotShotCommUpdatesTest is LightClientCommonTest {
         assertEq(BN254.ScalarField.unwrap(a), BN254.ScalarField.unwrap(b));
     }
 
+    function assertNotEqBN254(BN254.ScalarField a, BN254.ScalarField b) public pure {
+        assertNotEq(BN254.ScalarField.unwrap(a), BN254.ScalarField.unwrap(b));
+    }
+
     function test_hotShotBlockCommIsUpdated() public {
         uint256 blockCommCount = lc.getHotShotBlockCommitmentsCount();
 
@@ -899,12 +903,9 @@ contract LightClient_HotShotCommUpdatesTest is LightClientCommonTest {
         emit LC.NewState(newState.viewNum, newState.blockHeight, newState.blockCommRoot);
         lc.newFinalizedState(newState, newProof);
 
-        // Test for a the same hotShotBlockHeight
-        BN254.ScalarField blockComm = lc.getHotShotCommitment(newState.blockHeight).blockCommRoot;
-        assertEqBN254(blockComm, newState.blockCommRoot);
-
         // Test for a smaller hotShotBlockHeight
-        blockComm = lc.getHotShotCommitment(newState.blockHeight - 1).blockCommRoot;
+        BN254.ScalarField blockComm =
+            lc.getHotShotCommitment(newState.blockHeight - 1).blockCommRoot;
         assertEqBN254(blockComm, newState.blockCommRoot);
     }