contracts-bedrock: forge-std v1.8.1 (#10161)

* contracts-bedrock: forge-std v1.8.1 Updates to latest `forge-std` release to get access to the latest cheatcodes with a nice API. https://github.com/foundry-rs/forge-std/releases/tag/v1.8.1 * contracts-bedrock: fix warnings * lint: fix * contracts-bedrock: fix compiler * lint: fix * snapshots: update * contracts-bedrock: make deploy config safe + expect safe mem * gas-snapshot
ethereum-optimism · Apr 17, 2024 · 05ab396 · 05ab396
1 parent dcc4fb3
commit 05ab396
Show file tree

Hide file tree

Showing 77 changed files with 263 additions and 259 deletions.
diff --git a/packages/contracts-bedrock/.gas-snapshot b/packages/contracts-bedrock/.gas-snapshot
@@ -1,11 +1,11 @@
-GasBenchMark_L1CrossDomainMessenger:test_sendMessage_benchmark_0() (gas: 356410)
-GasBenchMark_L1CrossDomainMessenger:test_sendMessage_benchmark_1() (gas: 2954595)
-GasBenchMark_L1StandardBridge_Deposit:test_depositERC20_benchmark_0() (gas: 549189)
-GasBenchMark_L1StandardBridge_Deposit:test_depositERC20_benchmark_1() (gas: 4061165)
-GasBenchMark_L1StandardBridge_Deposit:test_depositETH_benchmark_0() (gas: 450338)
-GasBenchMark_L1StandardBridge_Deposit:test_depositETH_benchmark_1() (gas: 3496087)
-GasBenchMark_L1StandardBridge_Finalize:test_finalizeETHWithdrawal_benchmark() (gas: 59803)
-GasBenchMark_L2OutputOracle:test_proposeL2Output_benchmark() (gas: 92930)
-GasBenchMark_OptimismPortal:test_depositTransaction_benchmark() (gas: 68390)
-GasBenchMark_OptimismPortal:test_depositTransaction_benchmark_1() (gas: 69043)
-GasBenchMark_OptimismPortal:test_proveWithdrawalTransaction_benchmark() (gas: 155559)
+GasBenchMark_L1CrossDomainMessenger:test_sendMessage_benchmark_0() (gas: 356411)
+GasBenchMark_L1CrossDomainMessenger:test_sendMessage_benchmark_1() (gas: 2954596)
+GasBenchMark_L1StandardBridge_Deposit:test_depositERC20_benchmark_0() (gas: 549198)
+GasBenchMark_L1StandardBridge_Deposit:test_depositERC20_benchmark_1() (gas: 4061174)
+GasBenchMark_L1StandardBridge_Deposit:test_depositETH_benchmark_0() (gas: 450326)
+GasBenchMark_L1StandardBridge_Deposit:test_depositETH_benchmark_1() (gas: 3496075)
+GasBenchMark_L1StandardBridge_Finalize:test_finalizeETHWithdrawal_benchmark() (gas: 59809)
+GasBenchMark_L2OutputOracle:test_proposeL2Output_benchmark() (gas: 92951)
+GasBenchMark_OptimismPortal:test_depositTransaction_benchmark() (gas: 68398)
+GasBenchMark_OptimismPortal:test_depositTransaction_benchmark_1() (gas: 69062)
+GasBenchMark_OptimismPortal:test_proveWithdrawalTransaction_benchmark() (gas: 155567)
diff --git a/packages/contracts-bedrock/lib/forge-std b/packages/contracts-bedrock/lib/forge-std
diff --git a/packages/contracts-bedrock/scripts/DeployConfig.s.sol b/packages/contracts-bedrock/scripts/DeployConfig.s.sol
@@ -7,10 +7,6 @@ import { stdJson } from "forge-std/StdJson.sol";
 import { Executables } from "scripts/Executables.sol";
 import { Chains } from "scripts/Chains.sol";
 
-// Global constant for the `useFaultProofs` slot in the DeployConfig contract, which can be overridden in the testing
-// environment.
-bytes32 constant USE_FAULT_PROOFS_SLOT = bytes32(uint256(63));
-
 /// @title DeployConfig
 /// @notice Represents the configuration required to deploy the system. It is expected
 ///         to read the file from JSON. A future improvement would be to have fallback
@@ -180,6 +176,11 @@ contract DeployConfig is Script {
         usePlasma = _usePlasma;
     }
 
+    /// @notice Allow the `useFaultProofs` config to be overridden in testing environments
+    function setUseFaultProofs(bool _useFaultProofs) public {
+        useFaultProofs = _useFaultProofs;
+    }
+
     function _getBlockByTag(string memory _tag) internal returns (bytes32) {
         string[] memory cmd = new string[](3);
         cmd[0] = Executables.bash;

diff --git a/packages/contracts-bedrock/scripts/Deployer.sol b/packages/contracts-bedrock/scripts/Deployer.sol
@@ -5,7 +5,6 @@ import { Script } from "forge-std/Script.sol";
 import { Artifacts } from "scripts/Artifacts.s.sol";
 import { Config } from "scripts/Config.sol";
 import { DeployConfig } from "scripts/DeployConfig.s.sol";
-import { USE_FAULT_PROOFS_SLOT } from "scripts/DeployConfig.s.sol";
 
 /// @title Deployer
 /// @author tynes
@@ -18,18 +17,10 @@ abstract contract Deployer is Script, Artifacts {
     function setUp() public virtual override {
         Artifacts.setUp();
 
-        // Load the `useFaultProofs` slot value prior to etching the DeployConfig's bytecode and reading the deploy
-        // config file. If this slot has already been set, it will override the preference in the deploy config.
-        bytes32 useFaultProofsOverride = vm.load(address(cfg), USE_FAULT_PROOFS_SLOT);
-
         vm.etch(address(cfg), vm.getDeployedCode("DeployConfig.s.sol:DeployConfig"));
         vm.label(address(cfg), "DeployConfig");
         vm.allowCheatcodes(address(cfg));
         cfg.read(Config.deployConfigPath());
-
-        if (useFaultProofsOverride != 0) {
-            vm.store(address(cfg), USE_FAULT_PROOFS_SLOT, useFaultProofsOverride);
-        }
     }
 
     /// @notice Returns the name of the deployment script. Children contracts

diff --git a/packages/contracts-bedrock/scripts/fpac/FPACOPS.s.sol b/packages/contracts-bedrock/scripts/fpac/FPACOPS.s.sol
@@ -151,7 +151,7 @@ contract FPACOPS is Deploy, StdAssertions {
     }
 
     /// @notice Checks that the deployed system is configured correctly.
-    function postDeployAssertions(address _proxyAdmin, address _systemOwnerSafe) internal {
+    function postDeployAssertions(address _proxyAdmin, address _systemOwnerSafe) internal view {
         Types.ContractSet memory contracts = _proxiesUnstrict();
         contracts.OptimismPortal2 = mustGetAddress("OptimismPortal2");
 

diff --git a/packages/contracts-bedrock/snapshots/state-diff/Kontrol-Deploy.json b/packages/contracts-bedrock/snapshots/state-diff/Kontrol-Deploy.json
@@ -1137,7 +1137,7 @@
           "newValue": "0x0000000000000000000000009965507d1a55bcc2695c58ba16fb37d819b0a4dc",
           "previousValue": "0x0000000000000000000000009965507d1a55bcc2695c58ba16fb37d819b0a4dc",
           "reverted": false,
-          "slot": "0x000000000000000000000000000000000000000000000000000000000000000e"
+          "slot": "0x000000000000000000000000000000000000000000000000000000000000000f"
         }
       ],
       "value": 0
@@ -1413,7 +1413,7 @@
           "newValue": "0x0000000000000000000000009965507d1a55bcc2695c58ba16fb37d819b0a4dc",
           "previousValue": "0x0000000000000000000000009965507d1a55bcc2695c58ba16fb37d819b0a4dc",
           "reverted": false,
-          "slot": "0x000000000000000000000000000000000000000000000000000000000000000e"
+          "slot": "0x000000000000000000000000000000000000000000000000000000000000000f"
         }
       ],
       "value": 0
@@ -1962,7 +1962,7 @@
           "newValue": "0x0000000000000000000000009965507d1a55bcc2695c58ba16fb37d819b0a4dc",
           "previousValue": "0x0000000000000000000000009965507d1a55bcc2695c58ba16fb37d819b0a4dc",
           "reverted": false,
-          "slot": "0x000000000000000000000000000000000000000000000000000000000000000d"
+          "slot": "0x000000000000000000000000000000000000000000000000000000000000000e"
         }
       ],
       "value": 0
@@ -1988,7 +1988,7 @@
           "newValue": "0x0000000000000000000000000000000000000000000000000000000000000000",
           "previousValue": "0x0000000000000000000000000000000000000000000000000000000000000000",
           "reverted": false,
-          "slot": "0x000000000000000000000000000000000000000000000000000000000000003a"
+          "slot": "0x000000000000000000000000000000000000000000000000000000000000003b"
         }
       ],
       "value": 0
@@ -2014,7 +2014,7 @@
           "newValue": "0x0000000000000000000000000000000000000000000000000000000000000000",
           "previousValue": "0x0000000000000000000000000000000000000000000000000000000000000000",
           "reverted": false,
-          "slot": "0x000000000000000000000000000000000000000000000000000000000000003b"
+          "slot": "0x000000000000000000000000000000000000000000000000000000000000003c"
         }
       ],
       "value": 0
@@ -2397,7 +2397,7 @@
           "newValue": "0x0000000000000000000000009965507d1a55bcc2695c58ba16fb37d819b0a4dc",
           "previousValue": "0x0000000000000000000000009965507d1a55bcc2695c58ba16fb37d819b0a4dc",
           "reverted": false,
-          "slot": "0x000000000000000000000000000000000000000000000000000000000000000d"
+          "slot": "0x000000000000000000000000000000000000000000000000000000000000000e"
         }
       ],
       "value": 0
@@ -2475,7 +2475,7 @@
           "newValue": "0x0000000000000000000000000000000000000000000000000000000000000000",
           "previousValue": "0x0000000000000000000000000000000000000000000000000000000000000000",
           "reverted": false,
-          "slot": "0x000000000000000000000000000000000000000000000000000000000000003a"
+          "slot": "0x000000000000000000000000000000000000000000000000000000000000003b"
         }
       ],
       "value": 0
@@ -2553,7 +2553,7 @@
           "newValue": "0x0000000000000000000000000000000000000000000000000000000000000000",
           "previousValue": "0x0000000000000000000000000000000000000000000000000000000000000000",
           "reverted": false,
-          "slot": "0x000000000000000000000000000000000000000000000000000000000000003b"
+          "slot": "0x000000000000000000000000000000000000000000000000000000000000003c"
         }
       ],
       "value": 0
@@ -3540,7 +3540,7 @@
           "newValue": "0x0000000000000000000000009965507d1a55bcc2695c58ba16fb37d819b0a4dc",
           "previousValue": "0x0000000000000000000000009965507d1a55bcc2695c58ba16fb37d819b0a4dc",
           "reverted": false,
-          "slot": "0x000000000000000000000000000000000000000000000000000000000000000e"
+          "slot": "0x000000000000000000000000000000000000000000000000000000000000000f"
         }
       ],
       "value": 0
@@ -6043,7 +6043,7 @@
           "newValue": "0x0000000000000000000000003c44cdddb6a900fa2b585dd299e03d12fa4293bc",
           "previousValue": "0x0000000000000000000000003c44cdddb6a900fa2b585dd299e03d12fa4293bc",
           "reverted": false,
-          "slot": "0x0000000000000000000000000000000000000000000000000000000000000017"
+          "slot": "0x0000000000000000000000000000000000000000000000000000000000000018"
         }
       ],
       "value": 0
@@ -6069,7 +6069,7 @@
           "newValue": "0x0000000000000000000000009965507d1a55bcc2695c58ba16fb37d819b0a4dc",
           "previousValue": "0x0000000000000000000000009965507d1a55bcc2695c58ba16fb37d819b0a4dc",
           "reverted": false,
-          "slot": "0x000000000000000000000000000000000000000000000000000000000000000d"
+          "slot": "0x000000000000000000000000000000000000000000000000000000000000000e"
         }
       ],
       "value": 0
@@ -6095,7 +6095,7 @@
           "newValue": "0x0000000000000000000000000000000000000000000000000000000000000834",
           "previousValue": "0x0000000000000000000000000000000000000000000000000000000000000834",
           "reverted": false,
-          "slot": "0x000000000000000000000000000000000000000000000000000000000000002b"
+          "slot": "0x000000000000000000000000000000000000000000000000000000000000002c"
         }
       ],
       "value": 0
@@ -6121,7 +6121,7 @@
           "newValue": "0x00000000000000000000000000000000000000000000000000000000000f4240",
           "previousValue": "0x00000000000000000000000000000000000000000000000000000000000f4240",
           "reverted": false,
-          "slot": "0x000000000000000000000000000000000000000000000000000000000000002c"
+          "slot": "0x000000000000000000000000000000000000000000000000000000000000002d"
         }
       ],
       "value": 0
@@ -6147,7 +6147,7 @@
           "newValue": "0x00000000000000000000000000000000000000000000000000000000017d7840",
           "previousValue": "0x00000000000000000000000000000000000000000000000000000000017d7840",
           "reverted": false,
-          "slot": "0x0000000000000000000000000000000000000000000000000000000000000029"
+          "slot": "0x000000000000000000000000000000000000000000000000000000000000002a"
         }
       ],
       "value": 0
@@ -6173,7 +6173,7 @@
           "newValue": "0x0000000000000000000000009965507d1a55bcc2695c58ba16fb37d819b0a4dc",
           "previousValue": "0x0000000000000000000000009965507d1a55bcc2695c58ba16fb37d819b0a4dc",
           "reverted": false,
-          "slot": "0x0000000000000000000000000000000000000000000000000000000000000015"
+          "slot": "0x0000000000000000000000000000000000000000000000000000000000000016"
         }
       ],
       "value": 0
@@ -6199,7 +6199,7 @@
           "newValue": "0x000000000000000000000000ff00000000000000000000000000000000000000",
           "previousValue": "0x000000000000000000000000ff00000000000000000000000000000000000000",
           "reverted": false,
-          "slot": "0x0000000000000000000000000000000000000000000000000000000000000016"
+          "slot": "0x0000000000000000000000000000000000000000000000000000000000000017"
         }
       ],
       "value": 0
@@ -6778,7 +6778,7 @@
           "newValue": "0x0000000000000000000000009965507d1a55bcc2695c58ba16fb37d819b0a4dc",
           "previousValue": "0x0000000000000000000000009965507d1a55bcc2695c58ba16fb37d819b0a4dc",
           "reverted": false,
-          "slot": "0x000000000000000000000000000000000000000000000000000000000000000d"
+          "slot": "0x000000000000000000000000000000000000000000000000000000000000000e"
         }
       ],
       "value": 0
@@ -6856,7 +6856,7 @@
           "newValue": "0x0000000000000000000000000000000000000000000000000000000000000834",
           "previousValue": "0x0000000000000000000000000000000000000000000000000000000000000834",
           "reverted": false,
-          "slot": "0x000000000000000000000000000000000000000000000000000000000000002b"
+          "slot": "0x000000000000000000000000000000000000000000000000000000000000002c"
         }
       ],
       "value": 0
@@ -6934,7 +6934,7 @@
           "newValue": "0x00000000000000000000000000000000000000000000000000000000000f4240",
           "previousValue": "0x00000000000000000000000000000000000000000000000000000000000f4240",
           "reverted": false,
-          "slot": "0x000000000000000000000000000000000000000000000000000000000000002c"
+          "slot": "0x000000000000000000000000000000000000000000000000000000000000002d"
         }
       ],
       "value": 0
@@ -7012,7 +7012,7 @@
           "newValue": "0x0000000000000000000000003c44cdddb6a900fa2b585dd299e03d12fa4293bc",
           "previousValue": "0x0000000000000000000000003c44cdddb6a900fa2b585dd299e03d12fa4293bc",
           "reverted": false,
-          "slot": "0x0000000000000000000000000000000000000000000000000000000000000017"
+          "slot": "0x0000000000000000000000000000000000000000000000000000000000000018"
         }
       ],
       "value": 0
@@ -7090,7 +7090,7 @@
           "newValue": "0x00000000000000000000000000000000000000000000000000000000017d7840",
           "previousValue": "0x00000000000000000000000000000000000000000000000000000000017d7840",
           "reverted": false,
-          "slot": "0x0000000000000000000000000000000000000000000000000000000000000029"
+          "slot": "0x000000000000000000000000000000000000000000000000000000000000002a"
         }
       ],
       "value": 0
@@ -7168,7 +7168,7 @@
           "newValue": "0x0000000000000000000000009965507d1a55bcc2695c58ba16fb37d819b0a4dc",
           "previousValue": "0x0000000000000000000000009965507d1a55bcc2695c58ba16fb37d819b0a4dc",
           "reverted": false,
-          "slot": "0x0000000000000000000000000000000000000000000000000000000000000015"
+          "slot": "0x0000000000000000000000000000000000000000000000000000000000000016"
         }
       ],
       "value": 0
@@ -7246,7 +7246,7 @@
           "newValue": "0x0000000000000000000000000000000000000000000000000000000000000000",
           "previousValue": "0x0000000000000000000000000000000000000000000000000000000000000000",
           "reverted": false,
-          "slot": "0x0000000000000000000000000000000000000000000000000000000000000039"
+          "slot": "0x000000000000000000000000000000000000000000000000000000000000003a"
         }
       ],
       "value": 0
@@ -7324,7 +7324,7 @@
           "newValue": "0x000000000000000000000000ff00000000000000000000000000000000000000",
           "previousValue": "0x000000000000000000000000ff00000000000000000000000000000000000000",
           "reverted": false,
-          "slot": "0x0000000000000000000000000000000000000000000000000000000000000016"
+          "slot": "0x0000000000000000000000000000000000000000000000000000000000000017"
         }
       ],
       "value": 0
@@ -11400,7 +11400,7 @@
           "newValue": "0x0000000000000000000000009965507d1a55bcc2695c58ba16fb37d819b0a4dc",
           "previousValue": "0x0000000000000000000000009965507d1a55bcc2695c58ba16fb37d819b0a4dc",
           "reverted": false,
-          "slot": "0x000000000000000000000000000000000000000000000000000000000000000e"
+          "slot": "0x000000000000000000000000000000000000000000000000000000000000000f"
         }
       ],
       "value": 0

diff --git a/packages/contracts-bedrock/test/L1/L1CrossDomainMessenger.t.sol b/packages/contracts-bedrock/test/L1/L1CrossDomainMessenger.t.sol
@@ -37,7 +37,7 @@ contract L1CrossDomainMessenger_Test is Bridge_Initializer {
     }
 
     /// @dev Tests that the proxy is initialized correctly.
-    function test_initialize_succeeds() external {
+    function test_initialize_succeeds() external view {
         assertEq(address(l1CrossDomainMessenger.superchainConfig()), address(superchainConfig));
         assertEq(address(l1CrossDomainMessenger.PORTAL()), address(optimismPortal));
         assertEq(address(l1CrossDomainMessenger.portal()), address(optimismPortal));
@@ -46,7 +46,7 @@ contract L1CrossDomainMessenger_Test is Bridge_Initializer {
     }
 
     /// @dev Tests that the version can be decoded from the message nonce.
-    function test_messageVersion_succeeds() external {
+    function test_messageVersion_succeeds() external view {
         (, uint16 version) = Encoding.decodeVersionedNonce(l1CrossDomainMessenger.messageNonce());
         assertEq(version, l1CrossDomainMessenger.MESSAGE_VERSION());
     }

diff --git a/packages/contracts-bedrock/test/L1/L1ERC721Bridge.t.sol b/packages/contracts-bedrock/test/L1/L1ERC721Bridge.t.sol
@@ -76,7 +76,7 @@ contract L1ERC721Bridge_Test is Bridge_Initializer {
     }
 
     /// @dev Tests that the proxy is initialized with the correct values.
-    function test_initialize_succeeds() public {
+    function test_initialize_succeeds() public view {
         assertEq(address(l1ERC721Bridge.MESSENGER()), address(l1CrossDomainMessenger));
         assertEq(address(l1ERC721Bridge.messenger()), address(l1CrossDomainMessenger));
         assertEq(address(l1ERC721Bridge.OTHER_BRIDGE()), Predeploys.L2_ERC721_BRIDGE);
@@ -316,7 +316,7 @@ contract L1ERC721Bridge_Test is Bridge_Initializer {
 contract L1ERC721Bridge_Pause_Test is Bridge_Initializer {
     /// @dev Verifies that the `paused` accessor returns the same value as the `paused` function of the
     ///      `superchainConfig`.
-    function test_paused_succeeds() external {
+    function test_paused_succeeds() external view {
         assertEq(l1ERC721Bridge.paused(), superchainConfig.paused());
     }
 

diff --git a/packages/contracts-bedrock/test/L1/L1StandardBridge.t.sol b/packages/contracts-bedrock/test/L1/L1StandardBridge.t.sol
@@ -45,7 +45,7 @@ contract L1StandardBridge_Initialize_Test is Bridge_Initializer {
     }
 
     /// @dev Test that the initialize function sets the correct values.
-    function test_initialize_succeeds() external {
+    function test_initialize_succeeds() external view {
         assertEq(address(l1StandardBridge.superchainConfig()), address(superchainConfig));
         assertEq(address(l1StandardBridge.MESSENGER()), address(l1CrossDomainMessenger));
         assertEq(address(l1StandardBridge.messenger()), address(l1CrossDomainMessenger));
@@ -58,7 +58,7 @@ contract L1StandardBridge_Initialize_Test is Bridge_Initializer {
 contract L1StandardBridge_Pause_Test is Bridge_Initializer {
     /// @dev Verifies that the `paused` accessor returns the same value as the `paused` function of the
     ///      `superchainConfig`.
-    function test_paused_succeeds() external {
+    function test_paused_succeeds() external view {
         assertEq(l1StandardBridge.paused(), superchainConfig.paused());
     }
 

diff --git a/packages/contracts-bedrock/test/L1/L2OutputOracle.t.sol b/packages/contracts-bedrock/test/L1/L2OutputOracle.t.sol
@@ -168,7 +168,7 @@ contract L2OutputOracle_getter_Test is CommonTest {
     }
 
     /// @dev Tests that `nextBlockNumber` returns the correct value.
-    function test_nextBlockNumber_succeeds() external {
+    function test_nextBlockNumber_succeeds() external view {
         assertEq(
             l2OutputOracle.nextBlockNumber(),
             // The return value should match this arithmetic
+0 −3		.gitmodules
+1 −1		README.md
+1 −1		foundry.toml
+0 −1		lib/ds-test
+1 −1		package.json
+1 −1		scripts/vm.py
+518 −225		src/StdAssertions.sol
+3 −1		src/StdChains.sol
+7 −11		src/StdJson.sol
+201 −106		src/StdStorage.sol
+179 −0		src/StdToml.sol
+4 −4		src/Test.sol
+525 −1		src/Vm.sol
+51 −33		src/mocks/MockERC20.sol
+46 −32		src/mocks/MockERC721.sol
+39 −909		test/StdAssertions.t.sol
+29 −24		test/StdChains.t.sol
+18 −10		test/StdCheats.t.sol
+49 −0		test/StdJson.t.sol
+8 −8		test/StdMath.t.sol
+159 −11		test/StdStorage.t.sol
+49 −0		test/StdToml.t.sol
+18 −18		test/StdUtils.t.sol
+3 −3		test/Vm.t.sol
+8 −0		test/fixtures/test.json
+6 −0		test/fixtures/test.toml
+1 −1		test/mocks/MockERC20.t.sol
+1 −1		test/mocks/MockERC721.t.sol