Merge pull request #6611 from ethereum-optimism/clabby/ctb/add-local-data-tests

feat(ctb): Add unit tests for `addLocalData`

op-bindings/bindings/alphabetvm.go

@@ -31,7 +31,7 @@ var (
 // AlphabetVMMetaData contains all meta data concerning the AlphabetVM contract.
 var AlphabetVMMetaData = &bind.MetaData{
 	ABI: "[{\"inputs\":[{\"internalType\":\"Claim\",\"name\":\"_absolutePrestate\",\"type\":\"bytes32\"}],\"stateMutability\":\"nonpayable\",\"type\":\"constructor\"},{\"inputs\":[],\"name\":\"oracle\",\"outputs\":[{\"internalType\":\"contractIPreimageOracle\",\"name\":\"\",\"type\":\"address\"}],\"stateMutability\":\"view\",\"type\":\"function\"},{\"inputs\":[{\"internalType\":\"bytes\",\"name\":\"_stateData\",\"type\":\"bytes\"},{\"internalType\":\"bytes\",\"name\":\"\",\"type\":\"bytes\"}],\"name\":\"step\",\"outputs\":[{\"internalType\":\"bytes32\",\"name\":\"postState_\",\"type\":\"bytes32\"}],\"stateMutability\":\"view\",\"type\":\"function\"}]",
-	Bin: "0x60a060405234801561001057600080fd5b5060405161039838038061039883398101604081905261002f9161007a565b608081905261003c610062565b600080546001600160a01b0319166001600160a01b039290921691909117905550610093565b6460016000f36000908152600580601b83f091505090565b60006020828403121561008c57600080fd5b5051919050565b6080516102eb6100ad600039600060ad01526102eb6000f3fe608060405234801561001057600080fd5b50600436106100365760003560e01c80637dc0d1d01461003b578063f8e0cb9614610085575b600080fd5b60005461005b9073ffffffffffffffffffffffffffffffffffffffff1681565b60405173ffffffffffffffffffffffffffffffffffffffff90911681526020015b60405180910390f35b6100986100933660046101a8565b6100a6565b60405190815260200161007c565b60008060007f000000000000000000000000000000000000000000000000000000000000000087876040516100dc929190610214565b60405180910390200361010057600091506100f986880188610224565b905061011f565b61010c8688018861023d565b90925090508161011b8161028e565b9250505b8161012b8260016102c6565b6040805160208101939093528201526060016040516020818303038152906040528051906020012092505050949350505050565b60008083601f84011261017157600080fd5b50813567ffffffffffffffff81111561018957600080fd5b6020830191508360208285010111156101a157600080fd5b9250929050565b600080600080604085870312156101be57600080fd5b843567ffffffffffffffff808211156101d657600080fd5b6101e28883890161015f565b909650945060208701359150808211156101fb57600080fd5b506102088782880161015f565b95989497509550505050565b8183823760009101908152919050565b60006020828403121561023657600080fd5b5035919050565b6000806040838503121561025057600080fd5b50508035926020909101359150565b7f4e487b7100000000000000000000000000000000000000000000000000000000600052601160045260246000fd5b60007fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff82036102bf576102bf61025f565b5060010190565b600082198211156102d9576102d961025f565b50019056fea164736f6c634300080f000a",
+	Bin: "0x60a060405234801561001057600080fd5b50604051610a73380380610a7383398101604081905261002f91610090565b608081905260405161004090610083565b604051809103906000f08015801561005c573d6000803e3d6000fd5b50600080546001600160a01b0319166001600160a01b0392909216919091179055506100a9565b6106c5806103ae83390190565b6000602082840312156100a257600080fd5b5051919050565b6080516102eb6100c3600039600060ad01526102eb6000f3fe608060405234801561001057600080fd5b50600436106100365760003560e01c80637dc0d1d01461003b578063f8e0cb9614610085575b600080fd5b60005461005b9073ffffffffffffffffffffffffffffffffffffffff1681565b60405173ffffffffffffffffffffffffffffffffffffffff90911681526020015b60405180910390f35b6100986100933660046101a8565b6100a6565b60405190815260200161007c565b60008060007f000000000000000000000000000000000000000000000000000000000000000087876040516100dc929190610214565b60405180910390200361010057600091506100f986880188610224565b905061011f565b61010c8688018861023d565b90925090508161011b8161028e565b9250505b8161012b8260016102c6565b6040805160208101939093528201526060016040516020818303038152906040528051906020012092505050949350505050565b60008083601f84011261017157600080fd5b50813567ffffffffffffffff81111561018957600080fd5b6020830191508360208285010111156101a157600080fd5b9250929050565b600080600080604085870312156101be57600080fd5b843567ffffffffffffffff808211156101d657600080fd5b6101e28883890161015f565b909650945060208701359150808211156101fb57600080fd5b506102088782880161015f565b95989497509550505050565b8183823760009101908152919050565b60006020828403121561023657600080fd5b5035919050565b6000806040838503121561025057600080fd5b50508035926020909101359150565b7f4e487b7100000000000000000000000000000000000000000000000000000000600052601160045260246000fd5b60007fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff82036102bf576102bf61025f565b5060010190565b600082198211156102d9576102d961025f565b50019056fea164736f6c634300080f000a608060405234801561001057600080fd5b506106a5806100206000396000f3fe608060405234801561001057600080fd5b506004361061007d5760003560e01c8063e03110e11161005b578063e03110e114610111578063e159261114610139578063fe4ac08e1461014e578063fef2b4ed146101c357600080fd5b806361238bde146100825780638542cf50146100c05780639a1f5e7f146100fe575b600080fd5b6100ad610090366004610551565b600160209081526000928352604080842090915290825290205481565b6040519081526020015b60405180910390f35b6100ee6100ce366004610551565b600260209081526000928352604080842090915290825290205460ff1681565b60405190151581526020016100b7565b6100ad61010c366004610573565b6101e3565b61012461011f366004610551565b6102b6565b604080519283526020830191909152016100b7565b61014c6101473660046105a5565b6103a7565b005b61014c61015c366004610573565b6000838152600260209081526040808320878452825280832080547fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff001660019081179091558684528252808320968352958152858220939093559283529082905291902055565b6100ad6101d1366004610621565b60006020819052908152604090205481565b60006101ee856104b0565b90506101fb836008610669565b8211806102085750602083115b1561023f576040517ffe25498700000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b6000602081815260c085901b82526008959095528251828252600286526040808320858452875280832080547fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff0016600190811790915584845287528083209483529386528382205581815293849052922055919050565b6000828152600260209081526040808320848452909152812054819060ff1661033f576040517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601460248201527f7072652d696d616765206d757374206578697374000000000000000000000000604482015260640160405180910390fd5b506000838152602081815260409091205461035b816008610669565b610366856020610669565b106103845783610377826008610669565b6103819190610681565b91505b506000938452600160209081526040808620948652939052919092205492909150565b604435600080600883018611156103c65763fe2549876000526004601cfd5b60c083901b6080526088838682378087017ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff80151908490207effffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff167f02000000000000000000000000000000000000000000000000000000000000001760008181526002602090815260408083208b8452825280832080547fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff0016600190811790915584845282528083209a83529981528982209390935590815290819052959095209190915550505050565b7f01000000000000000000000000000000000000000000000000000000000000007effffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff82161761054b81600090815233602052604090207effffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff167f01000000000000000000000000000000000000000000000000000000000000001790565b92915050565b6000806040838503121561056457600080fd5b50508035926020909101359150565b6000806000806080858703121561058957600080fd5b5050823594602084013594506040840135936060013592509050565b6000806000604084860312156105ba57600080fd5b83359250602084013567ffffffffffffffff808211156105d957600080fd5b818601915086601f8301126105ed57600080fd5b8135818111156105fc57600080fd5b87602082850101111561060e57600080fd5b6020830194508093505050509250925092565b60006020828403121561063357600080fd5b5035919050565b7f4e487b7100000000000000000000000000000000000000000000000000000000600052601160045260246000fd5b6000821982111561067c5761067c61063a565b500190565b6000828210156106935761069361063a565b50039056fea164736f6c634300080f000a",
 }
 
 // AlphabetVMABI is the input ABI used to generate the binding from.

packages/contracts-bedrock/.gas-snapshot

@@ -97,28 +97,29 @@ FaultDisputeGame_ResolvesCorrectly_IncorrectRoot2:test_resolvesCorrectly_succeed
 FaultDisputeGame_ResolvesCorrectly_IncorrectRoot3:test_resolvesCorrectly_succeeds() (gas: 501212)
 FaultDisputeGame_ResolvesCorrectly_IncorrectRoot4:test_resolvesCorrectly_succeeds() (gas: 502409)
 FaultDisputeGame_ResolvesCorrectly_IncorrectRoot5:test_resolvesCorrectly_succeeds() (gas: 501698)
-FaultDisputeGame_Test:test_createdAt_succeeds() (gas: 10364)
-FaultDisputeGame_Test:test_extraData_succeeds() (gas: 32354)
-FaultDisputeGame_Test:test_gameData_succeeds() (gas: 32806)
-FaultDisputeGame_Test:test_gameType_succeeds() (gas: 8272)
-FaultDisputeGame_Test:test_initialize_correctData_succeeds() (gas: 57716)
-FaultDisputeGame_Test:test_initialize_firstOutput_reverts() (gas: 210532)
-FaultDisputeGame_Test:test_initialize_l1HeadTooOld_reverts() (gas: 228402)
+FaultDisputeGame_Test:test_addLocalData_static_succeeds() (gas: 640503)
+FaultDisputeGame_Test:test_createdAt_succeeds() (gas: 10342)
+FaultDisputeGame_Test:test_extraData_succeeds() (gas: 32377)
+FaultDisputeGame_Test:test_gameData_succeeds() (gas: 32829)
+FaultDisputeGame_Test:test_gameType_succeeds() (gas: 8250)
+FaultDisputeGame_Test:test_initialize_correctData_succeeds() (gas: 57694)
+FaultDisputeGame_Test:test_initialize_firstOutput_reverts() (gas: 210576)
+FaultDisputeGame_Test:test_initialize_l1HeadTooOld_reverts() (gas: 228425)
 FaultDisputeGame_Test:test_move_clockCorrectness_succeeds() (gas: 415993)
-FaultDisputeGame_Test:test_move_clockTimeExceeded_reverts() (gas: 23175)
+FaultDisputeGame_Test:test_move_clockTimeExceeded_reverts() (gas: 23219)
 FaultDisputeGame_Test:test_move_defendRoot_reverts() (gas: 13366)
-FaultDisputeGame_Test:test_move_duplicateClaim_reverts() (gas: 102942)
+FaultDisputeGame_Test:test_move_duplicateClaim_reverts() (gas: 102920)
 FaultDisputeGame_Test:test_move_gameDepthExceeded_reverts() (gas: 407913)
 FaultDisputeGame_Test:test_move_gameNotInProgress_reverts() (gas: 11024)
-FaultDisputeGame_Test:test_move_nonExistentParent_reverts() (gas: 24667)
-FaultDisputeGame_Test:test_move_simpleAttack_succeeds() (gas: 107318)
-FaultDisputeGame_Test:test_resolve_challengeContested_succeeds() (gas: 224883)
+FaultDisputeGame_Test:test_move_nonExistentParent_reverts() (gas: 24732)
+FaultDisputeGame_Test:test_move_simpleAttack_succeeds() (gas: 107341)
+FaultDisputeGame_Test:test_resolve_challengeContested_succeeds() (gas: 224906)
 FaultDisputeGame_Test:test_resolve_notInProgress_reverts() (gas: 9664)
 FaultDisputeGame_Test:test_resolve_rootContested_succeeds() (gas: 109856)
-FaultDisputeGame_Test:test_resolve_rootUncontestedClockNotExpired_succeeds() (gas: 21443)
-FaultDisputeGame_Test:test_resolve_rootUncontested_succeeds() (gas: 27278)
+FaultDisputeGame_Test:test_resolve_rootUncontestedClockNotExpired_succeeds() (gas: 21421)
+FaultDisputeGame_Test:test_resolve_rootUncontested_succeeds() (gas: 27256)
 FaultDisputeGame_Test:test_resolve_teamDeathmatch_succeeds() (gas: 395635)
-FaultDisputeGame_Test:test_rootClaim_succeeds() (gas: 8253)
+FaultDisputeGame_Test:test_rootClaim_succeeds() (gas: 8276)
 FeeVault_Test:test_constructor_succeeds() (gas: 18185)
 GasBenchMark_L1CrossDomainMessenger:test_sendMessage_benchmark_0() (gas: 352113)
 GasBenchMark_L1CrossDomainMessenger:test_sendMessage_benchmark_1() (gas: 2950320)

packages/contracts-bedrock/semver-lock.json

@@ -14,7 +14,7 @@
   "src/L2/L2StandardBridge.sol": "0x73a4fea3dca8ac7d7ba32e38aadeb69bd344042666a40a75e8c28849f01999e5",
   "src/L2/L2ToL1MessagePasser.sol": "0xed800b600cb3f67e18a1ab10750e3934a8b3e42178f422bcacfde770a6e8e8bd",
   "src/L2/SequencerFeeVault.sol": "0xd57c143b1f042400430b991b806bf971628e6980406c751e82d19ae80eeb4e8d",
-  "src/dispute/FaultDisputeGame.sol": "0xc191d9caad8498c46035e9bceb1ee372be24f9d7f6cb9f8fda8f646bc875d338",
+  "src/dispute/FaultDisputeGame.sol": "0x2a7f367443752f841d734f339a596c4ad93e16f7df0230f1cdd5e6f0b4b58368",
   "src/legacy/DeployerWhitelist.sol": "0x5e80f7b13ef73f06c63bd9b118a49da1ff06a5c0fcf8067b5a3365d731c23765",
   "src/legacy/L1BlockNumber.sol": "0x84cc587148de5920dfcd19da44d28e769f0e4d08ca2bcc93f18aa78c6cc2ebe6",
   "src/legacy/LegacyMessagePasser.sol": "0x2692b50b227e5f75a53439c0cf303498edfd4fc087555b3fc9bc4bceb518229b",

packages/contracts-bedrock/src/dispute/FaultDisputeGame.sol

@@ -282,9 +282,10 @@ contract FaultDisputeGame is IFaultDisputeGame, Clone, Semver {
         if (status != GameStatus.IN_PROGRESS) revert GameNotInProgress();
 
         IPreimageOracle oracle = VM.oracle();
+        bytes4 loadLocalDataSelector = IPreimageOracle.loadLocalData.selector;
         assembly {
             // Store the `loadLocalData(uint256,bytes32,uint256,uint256)` selector
-            mstore(0x00, 0x9a1f5e7f)
+            mstore(0x1C, loadLocalDataSelector)
             // Store the `_ident` argument
             mstore(0x20, _ident)
             // Store the data to load

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

@@ -8,6 +8,8 @@ import { DisputeGameFactory } from "src/dispute/DisputeGameFactory.sol";
 import { FaultDisputeGame } from "src/dispute/FaultDisputeGame.sol";
 import { L2OutputOracle } from "src/L1/L2OutputOracle.sol";
 import { BlockOracle } from "src/dispute/BlockOracle.sol";
+import { PreimageOracle } from "src/cannon/PreimageOracle.sol";
+import { PreimageKeyLib } from "src/cannon/PreimageKeyLib.sol";
 
 import "src/libraries/DisputeTypes.sol";
 import "src/libraries/DisputeErrors.sol";
@@ -38,12 +40,7 @@ contract FaultDisputeGame_Init is DisputeGameFactory_Init {
         // Propose 2 mock outputs
         vm.startPrank(oracle.PROPOSER());
         for (uint256 i; i < 2; i++) {
-            oracle.proposeL2Output(
-                bytes32(i + 1),
-                oracle.nextBlockNumber(),
-                blockhash(i),
-                i
-            );
+            oracle.proposeL2Output(bytes32(i + 1), oracle.nextBlockNumber(), blockhash(i), i);
 
             // Advance 1 block
             vm.roll(block.number + 1);
@@ -129,7 +126,11 @@ contract FaultDisputeGame_Test is FaultDisputeGame_Init {
     ///      contain the disputed L2 output root.
     function test_initialize_l1HeadTooOld_reverts() public {
         // Store a mock block hash for the genesis block. The timestamp will default to 0.
-        vm.store(address(gameImpl.BLOCK_ORACLE()), keccak256(abi.encode(0, 0)), bytes32(uint256(1)));
+        vm.store(
+            address(gameImpl.BLOCK_ORACLE()),
+            keccak256(abi.encode(0, 0)),
+            bytes32(uint256(1))
+        );
         bytes memory _extraData = abi.encode(oracle.SUBMISSION_INTERVAL() * 2, 0);
 
         vm.expectRevert(L1HeadTooOld.selector);
@@ -149,7 +150,10 @@ contract FaultDisputeGame_Test is FaultDisputeGame_Init {
     /// @dev Tests that the game is initialized with the correct data.
     function test_initialize_correctData_succeeds() public {
         // Starting
-        (FaultDisputeGame.OutputProposal memory startingProp, FaultDisputeGame.OutputProposal memory disputedProp) = gameProxy.proposals();
+        (
+            FaultDisputeGame.OutputProposal memory startingProp,
+            FaultDisputeGame.OutputProposal memory disputedProp
+        ) = gameProxy.proposals();
         Types.OutputProposal memory starting = oracle.getL2Output(startingProp.index);
         assertEq(startingProp.index, 0);
         assertEq(startingProp.l2BlockNumber, starting.l2BlockNumber);
@@ -421,6 +425,59 @@ contract FaultDisputeGame_Test is FaultDisputeGame_Init {
         assertEq(uint8(status), uint8(GameStatus.CHALLENGER_WINS));
         assertEq(uint8(gameProxy.status()), uint8(GameStatus.CHALLENGER_WINS));
     }
+
+    /// @dev Tests that adding local data with an out of bounds identifier reverts.
+    function testFuzz_addLocalData_oob_reverts(uint256 _ident) public {
+        // [1, 5] are valid local data identifiers.
+        if (_ident <= 5) _ident = 0;
+
+        vm.expectRevert(InvalidLocalIdent.selector);
+        gameProxy.addLocalData(_ident, 0);
+    }
+
+    /// @dev Tests that local data is loaded into the preimage oracle correctly.
+    function test_addLocalData_static_succeeds() public {
+        IPreimageOracle oracle = IPreimageOracle(address(gameProxy.VM().oracle()));
+        (
+            FaultDisputeGame.OutputProposal memory starting,
+            FaultDisputeGame.OutputProposal memory disputed
+        ) = gameProxy.proposals();
+
+        bytes32[5] memory data = [
+            Hash.unwrap(gameProxy.l1Head()),
+            Hash.unwrap(starting.outputRoot),
+            Hash.unwrap(disputed.outputRoot),
+            bytes32(uint256(starting.l2BlockNumber) << 0xC0),
+            bytes32(block.chainid << 0xC0)
+        ];
+
+        for (uint256 i = 1; i <= 5; i++) {
+            uint256 expectedLen = i > 3 ? 8 : 32;
+
+            gameProxy.addLocalData(i, 0);
+            bytes32 key = _getKey(i);
+            (bytes32 dat, uint256 datLen) = oracle.readPreimage(key, 0);
+            assertEq(dat >> 0xC0, bytes32(expectedLen));
+            // Account for the length prefix if i > 3 (the data stored
+            // at identifiers i <= 3 are 32 bytes long, so the expected
+            // length is already correct. If i > 3, the data is only 8
+            // bytes long, so the length prefix + the data is 16 bytes
+            // total.)
+            assertEq(datLen, expectedLen + (i > 3 ? 8 : 0));
+
+            gameProxy.addLocalData(i, 8);
+            key = _getKey(i);
+            (dat, datLen) = oracle.readPreimage(key, 8);
+            assertEq(dat, data[i - 1]);
+            assertEq(datLen, expectedLen);
+        }
+    }
+
+    /// @dev Helper to get the localized key for an identifier in the context of the game proxy.
+    function _getKey(uint256 _ident) internal view returns (bytes32) {
+        bytes32 h = keccak256(abi.encode(_ident | (1 << 248), address(gameProxy)));
+        return bytes32((uint256(h) & ~uint256(0xFF << 248)) | (1 << 248));
+    }
 }
 
 /// @notice A generic game player actor with a configurable trace.
@@ -963,7 +1020,7 @@ contract AlphabetVM is IBigStepper {
 
     constructor(Claim _absolutePrestate) {
         ABSOLUTE_PRESTATE = _absolutePrestate;
-        oracle = IPreimageOracle(deployNoop());
+        oracle = new PreimageOracle();
     }
 
     /// @inheritdoc IBigStepper
@@ -987,16 +1044,3 @@ contract AlphabetVM is IBigStepper {
         postState_ = keccak256(abi.encode(traceIndex, claim + 1));
     }
 }
-
-////////////////////////////////////////////////////////////////
-//                          HELPERS                           //
-////////////////////////////////////////////////////////////////
-
-/// @notice Deploys a noop contract.
-function deployNoop() returns (address noop_) {
-    assembly {
-        mstore(0x00, 0x60016000F3)
-        let size := 5
-        noop_ := create(0, sub(0x20, size), size)
-    }
-}