feat(ctb): MPT Fuzzing

.changeset/fuzzy-phones-tan.md

@@ -0,0 +1,5 @@
+---
+'@eth-optimism/contracts-bedrock': patch
+---
+
+Adds a fuzz input generator for testing Bedrock's `MerkleTrie.sol`

go.work

@@ -16,6 +16,7 @@ use (
 	./op-node
 	./op-proposer
 	./op-service
+	./packages/contracts-bedrock/go-fuzz
 	./proxyd
 )
 

packages/contracts-bedrock/.gas-snapshot

@@ -10,7 +10,7 @@ GasBenchMark_OptimismPortal:test_depositTransaction_benchmark() (gas: 74956)
 GasBenchMark_OptimismPortal:test_depositTransaction_benchmark_1() (gas: 35693)
 CrossDomainMessenger_Test:testFuzz_baseGas(uint32) (runs: 256, μ: 20196, ~: 20196)
 CrossDomainMessenger_Test:test_baseGas() (gas: 20054)
-CrossDomainOwnableThroughPortal_Test:test_depositTransaction_crossDomainOwner() (gas: 61809)
+CrossDomainOwnableThroughPortal_Test:test_depositTransaction_crossDomainOwner() (gas: 61815)
 CrossDomainOwnable_Test:test_onlyOwner() (gas: 34861)
 CrossDomainOwnable_Test:test_revertOnlyOwner() (gas: 10530)
 CrossDomainOwnable2_Test:test_onlyOwner() (gas: 77782)
@@ -131,27 +131,37 @@ LegacyERC20ETH_Test:test_mint() (gas: 10649)
 LegacyERC20ETH_Test:test_transfer() (gas: 10711)
 LegacyERC20ETH_Test:test_transferFrom() (gas: 12887)
 LegacyMessagePasser_Test:test_LegacyMessagePasser_passMessageToL1_Succeeds() (gas: 34519)
-MerkleTrie_Test:test_get_reverts_corruptedProof() (gas: 5686)
-MerkleTrie_Test:test_get_reverts_extraProofElements() (gas: 60560)
-MerkleTrie_Test:test_get_reverts_invalidDataRemainder() (gas: 35827)
-MerkleTrie_Test:test_get_reverts_invalidInternalNodeHash() (gas: 50763)
-MerkleTrie_Test:test_get_reverts_nonexistentKey1() (gas: 59624)
-MerkleTrie_Test:test_get_reverts_nonexistentKey2() (gas: 23359)
-MerkleTrie_Test:test_get_reverts_smallerPathThanKey1() (gas: 53476)
-MerkleTrie_Test:test_get_reverts_smallerPathThanKey2() (gas: 54913)
-MerkleTrie_Test:test_get_reverts_wrongKeyProof() (gas: 53844)
-MerkleTrie_Test:test_get_reverts_zeroBranchValueLength() (gas: 43222)
-MerkleTrie_Test:test_get_reverts_zeroLengthKey() (gas: 15886)
-MerkleTrie_Test:test_get_validProofSucceeds1() (gas: 61619)
-MerkleTrie_Test:test_get_validProofSucceeds10() (gas: 50546)
-MerkleTrie_Test:test_get_validProofSucceeds2() (gas: 71531)
-MerkleTrie_Test:test_get_validProofSucceeds3() (gas: 32779)
-MerkleTrie_Test:test_get_validProofSucceeds4() (gas: 23553)
-MerkleTrie_Test:test_get_validProofSucceeds5() (gas: 84215)
-MerkleTrie_Test:test_get_validProofSucceeds6() (gas: 72991)
-MerkleTrie_Test:test_get_validProofSucceeds7() (gas: 79670)
-MerkleTrie_Test:test_get_validProofSucceeds8() (gas: 50546)
-MerkleTrie_Test:test_get_validProofSucceeds9() (gas: 50501)
+MerkleTrie_Test:testFuzz_get_corruptedProof_reverts(bytes4) (runs: 256, μ: 78643, ~: 74433)
+MerkleTrie_Test:testFuzz_get_emptyKey_reverts(bytes4) (runs: 256, μ: 33263, ~: 33495)
+MerkleTrie_Test:testFuzz_get_extraProofElements_reverts(bytes4) (runs: 256, μ: 192689, ~: 193884)
+MerkleTrie_Test:testFuzz_get_invalidDataRemainder_reverts(bytes4) (runs: 256, μ: 82410, ~: 79887)
+MerkleTrie_Test:testFuzz_get_invalidInternalNodeHash_reverts(bytes4) (runs: 256, μ: 137634, ~: 142307)
+MerkleTrie_Test:testFuzz_get_invalidLargeInternalHash_reverts(bytes4) (runs: 256, μ: 143153, ~: 145631)
+MerkleTrie_Test:testFuzz_get_invalidRoot_reverts(bytes4) (runs: 256, μ: 137579, ~: 140414)
+MerkleTrie_Test:testFuzz_get_partialProof_reverts(bytes4) (runs: 256, μ: 97449, ~: 103650)
+MerkleTrie_Test:testFuzz_get_prefixedValidKey_reverts(bytes4) (runs: 256, μ: 146367, ~: 149444)
+MerkleTrie_Test:testFuzz_get_validProofs_success(bytes4) (runs: 256, μ: 305718, ~: 305766)
+MerkleTrie_Test:test_get_reverts_corruptedProof() (gas: 5756)
+MerkleTrie_Test:test_get_reverts_extraProofElements() (gas: 60608)
+MerkleTrie_Test:test_get_reverts_invalidDataRemainder() (gas: 35808)
+MerkleTrie_Test:test_get_reverts_invalidInternalNodeHash() (gas: 50833)
+MerkleTrie_Test:test_get_reverts_nonexistentKey1() (gas: 59694)
+MerkleTrie_Test:test_get_reverts_nonexistentKey2() (gas: 23407)
+MerkleTrie_Test:test_get_reverts_smallerPathThanKey1() (gas: 53502)
+MerkleTrie_Test:test_get_reverts_smallerPathThanKey2() (gas: 54962)
+MerkleTrie_Test:test_get_reverts_wrongKeyProof() (gas: 53870)
+MerkleTrie_Test:test_get_reverts_zeroBranchValueLength() (gas: 43270)
+MerkleTrie_Test:test_get_reverts_zeroLengthKey() (gas: 3655)
+MerkleTrie_Test:test_get_validProofSucceeds1() (gas: 61667)
+MerkleTrie_Test:test_get_validProofSucceeds10() (gas: 50572)
+MerkleTrie_Test:test_get_validProofSucceeds2() (gas: 71557)
+MerkleTrie_Test:test_get_validProofSucceeds3() (gas: 32827)
+MerkleTrie_Test:test_get_validProofSucceeds4() (gas: 23623)
+MerkleTrie_Test:test_get_validProofSucceeds5() (gas: 84306)
+MerkleTrie_Test:test_get_validProofSucceeds6() (gas: 73039)
+MerkleTrie_Test:test_get_validProofSucceeds7() (gas: 79674)
+MerkleTrie_Test:test_get_validProofSucceeds8() (gas: 50528)
+MerkleTrie_Test:test_get_validProofSucceeds9() (gas: 50549)
 OptimismMintableERC20_Test:test_bridge() (gas: 7599)
 OptimismMintableERC20_Test:test_burn() (gas: 51031)
 OptimismMintableERC20_Test:test_burnRevertsFromNotBridge() (gas: 11164)
@@ -170,23 +180,23 @@ OptimismPortalUpgradeable_Test:test_initialize_cannotInitImpl_reverts() (gas: 10
 OptimismPortalUpgradeable_Test:test_initialize_cannotInitProxy_reverts() (gas: 15767)
 OptimismPortalUpgradeable_Test:test_params_initValuesOnProxy_success() (gas: 16010)
 OptimismPortalUpgradeable_Test:test_upgradeToAndCall_upgrading_success() (gas: 180435)
-OptimismPortal_FinalizeWithdrawal_Test:test_finalizeWithdrawalTransaction_ifOutputRootChanges_reverts() (gas: 198517)
-OptimismPortal_FinalizeWithdrawal_Test:test_finalizeWithdrawalTransaction_ifOutputTimestampIsNotFinalized_reverts() (gas: 200739)
+OptimismPortal_FinalizeWithdrawal_Test:test_finalizeWithdrawalTransaction_ifOutputRootChanges_reverts() (gas: 198543)
+OptimismPortal_FinalizeWithdrawal_Test:test_finalizeWithdrawalTransaction_ifOutputTimestampIsNotFinalized_reverts() (gas: 200765)
 OptimismPortal_FinalizeWithdrawal_Test:test_finalizeWithdrawalTransaction_ifWithdrawalNotProven_reverts() (gas: 39634)
-OptimismPortal_FinalizeWithdrawal_Test:test_finalizeWithdrawalTransaction_ifWithdrawalProofNotOldEnough_reverts() (gas: 196193)
-OptimismPortal_FinalizeWithdrawal_Test:test_finalizeWithdrawalTransaction_onInsufficientGas_reverts() (gas: 194402)
-OptimismPortal_FinalizeWithdrawal_Test:test_finalizeWithdrawalTransaction_onRecentWithdrawal_reverts() (gas: 174437)
-OptimismPortal_FinalizeWithdrawal_Test:test_finalizeWithdrawalTransaction_onReentrancy_reverts() (gas: 234659)
-OptimismPortal_FinalizeWithdrawal_Test:test_finalizeWithdrawalTransaction_onReplay_reverts() (gas: 238957)
-OptimismPortal_FinalizeWithdrawal_Test:test_finalizeWithdrawalTransaction_provenWithdrawalHash_success() (gas: 230626)
-OptimismPortal_FinalizeWithdrawal_Test:test_finalizeWithdrawalTransaction_targetFails_fails() (gas: 333263)
-OptimismPortal_FinalizeWithdrawal_Test:test_finalizeWithdrawalTransaction_timestampLessThanL2OracleStart_reverts() (gas: 194807)
+OptimismPortal_FinalizeWithdrawal_Test:test_finalizeWithdrawalTransaction_ifWithdrawalProofNotOldEnough_reverts() (gas: 196219)
+OptimismPortal_FinalizeWithdrawal_Test:test_finalizeWithdrawalTransaction_onInsufficientGas_reverts() (gas: 194532)
+OptimismPortal_FinalizeWithdrawal_Test:test_finalizeWithdrawalTransaction_onRecentWithdrawal_reverts() (gas: 174463)
+OptimismPortal_FinalizeWithdrawal_Test:test_finalizeWithdrawalTransaction_onReentrancy_reverts() (gas: 234789)
+OptimismPortal_FinalizeWithdrawal_Test:test_finalizeWithdrawalTransaction_onReplay_reverts() (gas: 238983)
+OptimismPortal_FinalizeWithdrawal_Test:test_finalizeWithdrawalTransaction_provenWithdrawalHash_success() (gas: 230652)
+OptimismPortal_FinalizeWithdrawal_Test:test_finalizeWithdrawalTransaction_targetFails_fails() (gas: 333289)
+OptimismPortal_FinalizeWithdrawal_Test:test_finalizeWithdrawalTransaction_timestampLessThanL2OracleStart_reverts() (gas: 194833)
 OptimismPortal_FinalizeWithdrawal_Test:test_proveWithdrawalTransaction_onInvalidOutputRootProof_reverts() (gas: 85539)
-OptimismPortal_FinalizeWithdrawal_Test:test_proveWithdrawalTransaction_onInvalidWithdrawalProof_reverts() (gas: 137224)
+OptimismPortal_FinalizeWithdrawal_Test:test_proveWithdrawalTransaction_onInvalidWithdrawalProof_reverts() (gas: 137250)
 OptimismPortal_FinalizeWithdrawal_Test:test_proveWithdrawalTransaction_onSelfCall_reverts() (gas: 50754)
-OptimismPortal_FinalizeWithdrawal_Test:test_proveWithdrawalTransaction_replayProveChangedOutputRoot_success() (gas: 277238)
-OptimismPortal_FinalizeWithdrawal_Test:test_proveWithdrawalTransaction_replayProve_reverts() (gas: 190171)
-OptimismPortal_FinalizeWithdrawal_Test:test_proveWithdrawalTransaction_validWithdrawalProof_success() (gas: 180360)
+OptimismPortal_FinalizeWithdrawal_Test:test_proveWithdrawalTransaction_replayProveChangedOutputRoot_success() (gas: 277290)
+OptimismPortal_FinalizeWithdrawal_Test:test_proveWithdrawalTransaction_replayProve_reverts() (gas: 190197)
+OptimismPortal_FinalizeWithdrawal_Test:test_proveWithdrawalTransaction_validWithdrawalProof_success() (gas: 180386)
 OptimismPortal_Test:test_OptimismPortalConstructor() (gas: 17298)
 OptimismPortal_Test:test_OptimismPortalReceiveEth_success() (gas: 127483)
 OptimismPortal_Test:test_depositTransaction_NoValueContract_success() (gas: 76706)
@@ -303,7 +313,7 @@ ResourceMetering_Test:test_updateTenEmptyBlocks() (gas: 20548)
 ResourceMetering_Test:test_updateTwoEmptyBlocks() (gas: 20594)
 ResourceMetering_Test:test_useMaxSucceeds() (gas: 8017123)
 ResourceMetering_Test:test_useMoreThanMaxReverts() (gas: 16045)
-SafeCall_Test:test_safeCall(address,address,uint256,uint64,bytes) (runs: 256, μ: 43316, ~: 45640)
+SafeCall_Test:test_safeCall(address,address,uint256,uint64,bytes) (runs: 256, μ: 43191, ~: 45640)
 Semver_Test:test_behindProxy() (gas: 506748)
 Semver_Test:test_version() (gas: 9373)
 SequencerFeeVault_Test:test_constructor() (gas: 5459)

packages/contracts-bedrock/.gitignore

@@ -10,3 +10,4 @@ src/contract-artifacts.ts
 tmp-artifacts
 deployments/mainnet-forked
 deploy-config/mainnet-forked.json
+go-fuzz/fuzz

packages/contracts-bedrock/contracts/libraries/trie/MerkleTrie.sol

@@ -90,6 +90,8 @@ library MerkleTrie {
         bytes[] memory _proof,
         bytes32 _root
     ) internal pure returns (bytes memory) {
+        require(_key.length > 0, "MerkleTrie: empty key");
+
         TrieNode[] memory proof = _parseProof(_proof);
         bytes memory key = Bytes.toNibbles(_key);
         bytes memory currentNodeID = abi.encodePacked(_root);

packages/contracts-bedrock/contracts/test/CommonTest.t.sol

@@ -129,10 +129,7 @@ contract L2OutputOracle_Initializer is CommonTest {
         vm.prank(multisig);
         proxy.upgradeToAndCall(
             address(oracleImpl),
-            abi.encodeCall(
-                L2OutputOracle.initialize,
-                (startingBlockNumber, startingTimestamp)
-            )
+            abi.encodeCall(L2OutputOracle.initialize, (startingBlockNumber, startingTimestamp))
         );
         oracle = L2OutputOracle(address(proxy));
         vm.label(address(oracle), "L2OutputOracle");
@@ -631,6 +628,25 @@ contract FFIInterface is Test {
         bytes memory result = vm.ffi(cmds);
         return abi.decode(result, (uint256, uint256));
     }
+
+    function getMerkleTrieFuzzCase(string memory variant)
+        external
+        returns (
+            bytes32,
+            bytes memory,
+            bytes memory,
+            bytes[] memory
+        )
+    {
+        string[] memory cmds = new string[](5);
+        cmds[0] = "./go-fuzz/fuzz";
+        cmds[1] = "-m";
+        cmds[2] = "trie";
+        cmds[3] = "-v";
+        cmds[4] = variant;
+
+        return abi.decode(vm.ffi(cmds), (bytes32, bytes, bytes, bytes[]));
+    }
 }
 
 // Used for testing a future upgrade beyond the current implementations.

packages/contracts-bedrock/contracts/test/L2OutputOracle.t.sol

@@ -335,18 +335,12 @@ contract L2OutputOracleUpgradeable_Test is L2OutputOracle_Initializer {
 
     function test_cannotInitProxy() external {
         vm.expectRevert("Initializable: contract is already initialized");
-        L2OutputOracle(payable(proxy)).initialize(
-            startingBlockNumber,
-            startingTimestamp
-        );
+        L2OutputOracle(payable(proxy)).initialize(startingBlockNumber, startingTimestamp);
     }
 
     function test_cannotInitImpl() external {
         vm.expectRevert("Initializable: contract is already initialized");
-        L2OutputOracle(oracleImpl).initialize(
-            startingBlockNumber,
-            startingTimestamp
-        );
+        L2OutputOracle(oracleImpl).initialize(startingBlockNumber, startingTimestamp);
     }
 
     function test_upgrading() external {