refactor(protocol): replace finalize with verify (#298)

* chore(ci): disable checking coverage against the base of the PR * chore: update configs * chore: add flag_management * chore: try * chore: try2 * feat(protocol): enable whitelisting provers (disabled for now) (#287) * Finalize -> Verify Co-authored-by: David <[email protected]>
taikoxyz · Nov 22, 2022 · 5c4d370 · 5c4d370
1 parent 151415e
commit 5c4d370
Show file tree

Hide file tree

Showing 14 changed files with 70 additions and 67 deletions.
diff --git a/packages/protocol/contracts/L1/LibData.sol b/packages/protocol/contracts/L1/LibData.sol
@@ -45,8 +45,8 @@ library LibData {
         mapping(bytes32 => uint256) commits;
         mapping(address => bool) provers; // Whitelisted provers
         uint64 genesisHeight;
-        uint64 latestFinalizedHeight;
-        uint64 latestFinalizedId;
+        uint64 latestVerifiedHeight;
+        uint64 latestVerifiedId;
         uint64 nextBlockId;
     }
 
@@ -69,7 +69,7 @@ library LibData {
         State storage s,
         uint256 number
     ) internal view returns (bytes32) {
-        require(number <= s.latestFinalizedHeight, "L1:id");
+        require(number <= s.latestVerifiedHeight, "L1:id");
         return s.l2Hashes[number];
     }
 
@@ -80,14 +80,14 @@ library LibData {
         view
         returns (
             uint64 genesisHeight,
-            uint64 latestFinalizedHeight,
-            uint64 latestFinalizedId,
+            uint64 latestVerifiedHeight,
+            uint64 latestVerifiedId,
             uint64 nextBlockId
         )
     {
         genesisHeight = s.genesisHeight;
-        latestFinalizedHeight = s.latestFinalizedHeight;
-        latestFinalizedId = s.latestFinalizedId;
+        latestVerifiedHeight = s.latestVerifiedHeight;
+        latestVerifiedId = s.latestVerifiedId;
         nextBlockId = s.nextBlockId;
     }
 

diff --git a/packages/protocol/contracts/L1/TaikoL1.sol b/packages/protocol/contracts/L1/TaikoL1.sol
@@ -71,9 +71,9 @@ contract TaikoL1 is EssentialContract, IHeaderSync, V1Events {
      */
     function proposeBlock(bytes[] calldata inputs) external nonReentrant {
         V1Proposing.proposeBlock(state, inputs);
-        V1Finalizing.finalizeBlocks(
+        V1Finalizing.verifyBlocks(
             state,
-            LibConstants.TAIKO_MAX_FINALIZATIONS_PER_TX
+            LibConstants.TAIKO_MAX_VERIFICATIONS_PER_TX
         );
     }
 
@@ -97,9 +97,9 @@ contract TaikoL1 is EssentialContract, IHeaderSync, V1Events {
         bytes[] calldata inputs
     ) external nonReentrant {
         V1Proving.proveBlock(state, AddressResolver(this), blockIndex, inputs);
-        V1Finalizing.finalizeBlocks(
+        V1Finalizing.verifyBlocks(
             state,
-            LibConstants.TAIKO_MAX_FINALIZATIONS_PER_TX
+            LibConstants.TAIKO_MAX_VERIFICATIONS_PER_TX
         );
     }
 
@@ -128,9 +128,9 @@ contract TaikoL1 is EssentialContract, IHeaderSync, V1Events {
             blockIndex,
             inputs
         );
-        V1Finalizing.finalizeBlocks(
+        V1Finalizing.verifyBlocks(
             state,
-            LibConstants.TAIKO_MAX_FINALIZATIONS_PER_TX
+            LibConstants.TAIKO_MAX_VERIFICATIONS_PER_TX
         );
     }
 
@@ -157,11 +157,14 @@ contract TaikoL1 is EssentialContract, IHeaderSync, V1Events {
         return V1Proving.isProverWhitelisted(state, prover);
     }
 
-    /// @notice Finalize up to N blocks.
-    /// @param maxBlocks Max number of blocks to finalize.
-    function finalizeBlocks(uint256 maxBlocks) external nonReentrant {
+
+    /** 
+     * Verify up to N blocks.
+     * @param maxBlocks Max number of blocks to verify.
+     */
+    function verifyBlocks(uint256 maxBlocks) external nonReentrant {
         require(maxBlocks > 0, "L1:maxBlocks");
-        V1Finalizing.finalizeBlocks(state, maxBlocks);
+        V1Finalizing.verifyBlocks(state, maxBlocks);
     }
 
     function isCommitValid(bytes32 hash) public view returns (bool) {
@@ -185,16 +188,16 @@ contract TaikoL1 is EssentialContract, IHeaderSync, V1Events {
     }
 
     function getLatestSyncedHeader() public view override returns (bytes32) {
-        return state.getL2BlockHash(state.latestFinalizedHeight);
+        return state.getL2BlockHash(state.latestVerifiedHeight);
     }
 
     function getStateVariables()
         public
         view
         returns (
             uint64 /*genesisHeight*/,
-            uint64 /*latestFinalizedHeight*/,
-            uint64 /*latestFinalizedId*/,
+            uint64 /*latestVerifiedHeight*/,
+            uint64 /*latestVerifiedId*/,
             uint64 /*nextBlockId*/
         )
     {
@@ -214,7 +217,7 @@ contract TaikoL1 is EssentialContract, IHeaderSync, V1Events {
         returns (
             uint256, // TAIKO_CHAIN_ID
             uint256, // TAIKO_MAX_PROPOSED_BLOCKS
-            uint256, // TAIKO_MAX_FINALIZATIONS_PER_TX
+            uint256, // TAIKO_MAX_VERIFICATIONS_PER_TX
             uint256, // TAIKO_COMMIT_DELAY_CONFIRMATIONS
             uint256, // TAIKO_MAX_PROOFS_PER_FORK_CHOICE
             uint256, // TAIKO_BLOCK_MAX_GAS_LIMIT
@@ -230,7 +233,7 @@ contract TaikoL1 is EssentialContract, IHeaderSync, V1Events {
         return (
             LibConstants.TAIKO_CHAIN_ID,
             LibConstants.TAIKO_MAX_PROPOSED_BLOCKS,
-            LibConstants.TAIKO_MAX_FINALIZATIONS_PER_TX,
+            LibConstants.TAIKO_MAX_VERIFICATIONS_PER_TX,
             LibConstants.TAIKO_COMMIT_DELAY_CONFIRMATIONS,
             LibConstants.TAIKO_MAX_PROOFS_PER_FORK_CHOICE,
             LibConstants.TAIKO_BLOCK_MAX_GAS_LIMIT,

diff --git a/packages/protocol/contracts/L1/v1/V1Events.sol b/packages/protocol/contracts/L1/v1/V1Events.sol
@@ -13,7 +13,7 @@ import "../LibData.sol";
 /// @author david <[email protected]>
 abstract contract V1Events {
     // The following events must match the definitions in other V1 libraries.
-    event BlockFinalized(uint256 indexed id, bytes32 blockHash);
+    event BlockVerified(uint256 indexed id, bytes32 blockHash);
 
     event BlockCommitted(bytes32 hash, uint256 validSince);
 

diff --git a/packages/protocol/contracts/L1/v1/V1Finalizing.sol b/packages/protocol/contracts/L1/v1/V1Finalizing.sol
@@ -14,7 +14,7 @@ import "../LibData.sol";
 
 /// @author dantaik <[email protected]>
 library V1Finalizing {
-    event BlockFinalized(uint256 indexed id, bytes32 blockHash);
+    event BlockVerified(uint256 indexed id, bytes32 blockHash);
 
     event HeaderSynced(
         uint256 indexed height,
@@ -27,39 +27,39 @@ library V1Finalizing {
         s.nextBlockId = 1;
         s.genesisHeight = uint64(block.number);
 
-        emit BlockFinalized(0, _genesisBlockHash);
+        emit BlockVerified(0, _genesisBlockHash);
         emit HeaderSynced(block.number, 0, _genesisBlockHash);
     }
 
-    function finalizeBlocks(LibData.State storage s, uint256 maxBlocks) public {
-        uint64 latestL2Height = s.latestFinalizedHeight;
+    function verifyBlocks(LibData.State storage s, uint256 maxBlocks) public {
+        uint64 latestL2Height = s.latestVerifiedHeight;
         bytes32 latestL2Hash = s.l2Hashes[latestL2Height];
         uint64 processed = 0;
 
         for (
-            uint256 i = s.latestFinalizedId + 1;
+            uint256 i = s.latestVerifiedId + 1;
             i < s.nextBlockId && processed <= maxBlocks;
             i++
         ) {
             LibData.ForkChoice storage fc = s.forkChoices[i][latestL2Hash];
 
             if (fc.blockHash == LibConstants.TAIKO_BLOCK_DEADEND_HASH) {
-                emit BlockFinalized(i, 0);
+                emit BlockVerified(i, 0);
             } else if (fc.blockHash != 0) {
                 latestL2Height += 1;
                 latestL2Hash = fc.blockHash;
-                emit BlockFinalized(i, latestL2Hash);
+                emit BlockVerified(i, latestL2Hash);
             } else {
                 break;
             }
             processed += 1;
         }
 
         if (processed > 0) {
-            s.latestFinalizedId += processed;
+            s.latestVerifiedId += processed;
 
-            if (latestL2Height > s.latestFinalizedHeight) {
-                s.latestFinalizedHeight = latestL2Height;
+            if (latestL2Height > s.latestVerifiedHeight) {
+                s.latestVerifiedHeight = latestL2Height;
                 s.l2Hashes[latestL2Height] = latestL2Hash;
                 emit HeaderSynced(block.number, latestL2Height, latestL2Hash);
             }

diff --git a/packages/protocol/contracts/L1/v1/V1Proposing.sol b/packages/protocol/contracts/L1/v1/V1Proposing.sol
@@ -64,7 +64,7 @@ library V1Proposing {
         );
         require(
             s.nextBlockId <=
-                s.latestFinalizedId + LibConstants.TAIKO_MAX_PROPOSED_BLOCKS,
+                s.latestVerifiedId + LibConstants.TAIKO_MAX_PROPOSED_BLOCKS,
             "L1:tooMany"
         );
 

diff --git a/packages/protocol/contracts/L1/v1/V1Proving.sol b/packages/protocol/contracts/L1/v1/V1Proving.sol
@@ -316,7 +316,7 @@ library V1Proving {
         LibData.BlockMetadata memory meta
     ) private view {
         require(
-            meta.id > s.latestFinalizedId && meta.id < s.nextBlockId,
+            meta.id > s.latestVerifiedId && meta.id < s.nextBlockId,
             "L1:meta:id"
         );
         require(

diff --git a/packages/protocol/contracts/L2/V1TaikoL2.sol b/packages/protocol/contracts/L2/V1TaikoL2.sol
@@ -140,7 +140,7 @@ contract V1TaikoL2 is AddressResolver, ReentrancyGuard, IHeaderSync {
         returns (
             uint256, // TAIKO_CHAIN_ID
             uint256, // TAIKO_MAX_PROPOSED_BLOCKS
-            uint256, // TAIKO_MAX_FINALIZATIONS_PER_TX
+            uint256, // TAIKO_MAX_VERIFICATIONS_PER_TX
             uint256, // TAIKO_COMMIT_DELAY_CONFIRMATIONS
             uint256, // TAIKO_MAX_PROOFS_PER_FORK_CHOICE
             uint256, // TAIKO_BLOCK_MAX_GAS_LIMIT
@@ -156,7 +156,7 @@ contract V1TaikoL2 is AddressResolver, ReentrancyGuard, IHeaderSync {
         return (
             LibConstants.TAIKO_CHAIN_ID,
             LibConstants.TAIKO_MAX_PROPOSED_BLOCKS,
-            LibConstants.TAIKO_MAX_FINALIZATIONS_PER_TX,
+            LibConstants.TAIKO_MAX_VERIFICATIONS_PER_TX,
             LibConstants.TAIKO_COMMIT_DELAY_CONFIRMATIONS,
             LibConstants.TAIKO_MAX_PROOFS_PER_FORK_CHOICE,
             LibConstants.TAIKO_BLOCK_MAX_GAS_LIMIT,

diff --git a/packages/protocol/contracts/libs/LibConstants.sol b/packages/protocol/contracts/libs/LibConstants.sol
@@ -13,7 +13,7 @@ library LibConstants {
     // https://github.com/ethereum-lists/chains/pull/1611
     uint256 public constant TAIKO_CHAIN_ID = 167;
     uint256 public constant TAIKO_MAX_PROPOSED_BLOCKS = 2048;
-    uint256 public constant TAIKO_MAX_FINALIZATIONS_PER_TX = 20;
+    uint256 public constant TAIKO_MAX_VERIFICATIONS_PER_TX = 20;
     uint256 public constant TAIKO_COMMIT_DELAY_CONFIRMATIONS = 4;
     uint256 public constant TAIKO_MAX_PROOFS_PER_FORK_CHOICE = 5;
     uint256 public constant TAIKO_BLOCK_MAX_GAS_LIMIT = 5000000; // TODO

diff --git a/packages/protocol/docs/L1/LibData.md b/packages/protocol/docs/L1/LibData.md
@@ -47,8 +47,8 @@ struct State {
   mapping(uint256 => mapping(bytes32 => struct LibData.ForkChoice)) forkChoices;
   mapping(bytes32 => uint256) commits;
   uint64 genesisHeight;
-  uint64 latestFinalizedHeight;
-  uint64 latestFinalizedId;
+  uint64 latestVerifiedHeight;
+  uint64 latestVerifiedId;
   uint64 nextBlockId;
 }
 ```
@@ -74,7 +74,7 @@ function getL2BlockHash(struct LibData.State s, uint256 number) internal view re
 ### getStateVariables
 
 ```solidity
-function getStateVariables(struct LibData.State s) internal view returns (uint64 genesisHeight, uint64 latestFinalizedHeight, uint64 latestFinalizedId, uint64 nextBlockId)
+function getStateVariables(struct LibData.State s) internal view returns (uint64 genesisHeight, uint64 latestVerifiedHeight, uint64 latestVerifiedId, uint64 nextBlockId)
 ```
 
 ### hashMetadata

diff --git a/packages/protocol/docs/L1/TaikoL1.md b/packages/protocol/docs/L1/TaikoL1.md
@@ -80,19 +80,19 @@ merkel proof.
 | blockIndex | uint256 | The index of the block to prove. This is also used to select the right implementation version.                                                                                                                                                                                                                                                              |
 | inputs     | bytes[] | A list of data input: - inputs[0] An Evidence object with various information regarding the block to be proven and the actual proofs. - inputs[1] The target block to be proven invalid. - inputs[2] The receipt for the `invalidBlock` transaction on L2. Note that the `invalidBlock` transaction is supposed to be the only transaction in the L2 block. |
 
-### finalizeBlocks
+### verifyBlocks
 
 ```solidity
-function finalizeBlocks(uint256 maxBlocks) external
+function verifyBlocks(uint256 maxBlocks) external
 ```
 
-Finalize up to N blocks.
+Verify up to N blocks.
 
 #### Parameters
 
-| Name      | Type    | Description                       |
-| --------- | ------- | --------------------------------- |
-| maxBlocks | uint256 | Max number of blocks to finalize. |
+| Name      | Type    | Description                     |
+| --------- | ------- | ------------------------------- |
+| maxBlocks | uint256 | Max number of blocks to verify. |
 
 ### isCommitValid
 

diff --git a/packages/protocol/docs/L1/v1/V1Events.md b/packages/protocol/docs/L1/v1/V1Events.md
@@ -1,9 +1,9 @@
 ## V1Events
 
-### BlockFinalized
+### BlockVerified
 
 ```solidity
-event BlockFinalized(uint256 id, bytes32 blockHash)
+event BlockVerified(uint256 id, bytes32 blockHash)
 ```
 
 ### BlockCommitted

diff --git a/packages/protocol/docs/L1/v1/V1Finalizing.md b/packages/protocol/docs/L1/v1/V1Finalizing.md
@@ -1,9 +1,9 @@
 ## V1Finalizing
 
-### BlockFinalized
+### BlockVerified
 
 ```solidity
-event BlockFinalized(uint256 id, bytes32 blockHash)
+event BlockVerified(uint256 id, bytes32 blockHash)
 ```
 
 ### HeaderSynced
@@ -18,8 +18,8 @@ event HeaderSynced(uint256 height, uint256 srcHeight, bytes32 srcHash)
 function init(struct LibData.State s, bytes32 _genesisBlockHash) public
 ```
 
-### finalizeBlocks
+### verifyBlocks
 
 ```solidity
-function finalizeBlocks(struct LibData.State s, uint256 maxBlocks) public
+function verifyBlocks(struct LibData.State s, uint256 maxBlocks) public
 ```
diff --git a/packages/protocol/docs/libs/LibConstants.md b/packages/protocol/docs/libs/LibConstants.md
@@ -12,10 +12,10 @@ uint256 TAIKO_CHAIN_ID
 uint256 TAIKO_MAX_PROPOSED_BLOCKS
 ```
 
-### TAIKO_MAX_FINALIZATIONS_PER_TX
+### TAIKO_MAX_VERIFICATIONS_PER_TX
 
 ```solidity
-uint256 TAIKO_MAX_FINALIZATIONS_PER_TX
+uint256 TAIKO_MAX_VERIFICATIONS_PER_TX
 ```
 
 ### TAIKO_COMMIT_DELAY_CONFIRMATIONS