feat: config helper contract

.github/workflows/ci.yml

@@ -30,7 +30,15 @@ jobs:
       - uses: actions/checkout@v4
       - uses: foundry-rs/foundry-toolchain@v1
       - run: forge --version
-      - run: forge build --skip test --deny-warnings ${{ matrix.flags }}
+      - run: |
+          case "${{ matrix.flags }}" in
+            *"solc:0.8.0"* | *"solc:0.7"* | *"solc:0.6"*)
+              forge build --skip test --skip Config --skip StdConfig --skip LibVariable --deny-warnings ${{ matrix.flags }}
+              ;;
+            *)
+              forge build --skip test --deny-warnings ${{ matrix.flags }}
+              ;;
+          esac
       # via-ir compilation time checks.
       - if: contains(matrix.flags, '--via-ir')
         run: forge build --skip test --deny-warnings ${{ matrix.flags }} --contracts 'test/compilation/*'
@@ -48,7 +56,12 @@ jobs:
         with:
           version: ${{ matrix.toolchain }}
       - run: forge --version
-      - run: forge test -vvv
+      - run: |
+          if [ "${{ matrix.toolchain }}" = "stable" ]; then
+            forge test -vvv --no-match-path "test/Config.t.sol"
+          else
+            forge test -vvv
+          fi
 
   fmt:
     runs-on: ubuntu-latest

foundry.toml

@@ -1,12 +1,16 @@
 [profile.default]
-fs_permissions = [{ access = "read-write", path = "./"}]
+fs_permissions = [{ access = "read-write", path = "./" }]
 optimizer = true
 optimizer_runs = 200
 
+# A list of solidity error codes to ignore.
+# 3860 = init-code-size
+ignored_error_codes = [3860]
+
 [rpc_endpoints]
 # The RPC URLs are modified versions of the default for testing initialization.
-mainnet = "https://eth.merkle.io" # Different API key.
-optimism_sepolia = "https://sepolia.optimism.io/" # Adds a trailing slash.
+mainnet = "https://eth.merkle.io"                                # Different API key.
+optimism_sepolia = "https://sepolia.optimism.io/"                # Adds a trailing slash.
 arbitrum_one_sepolia = "https://sepolia-rollup.arbitrum.io/rpc/" # Adds a trailing slash.
 needs_undefined_env_var = "${UNDEFINED_RPC_URL_PLACEHOLDER}"
 
@@ -20,4 +24,4 @@ multiline_func_header = 'attributes_first'
 quote_style = 'double'
 number_underscore = 'preserve'
 single_line_statement_blocks = 'preserve'
-ignore = ["src/console.sol", "src/console2.sol"]
+ignore = ["src/console.sol", "src/console2.sol"]

src/Base.sol

@@ -8,22 +8,28 @@ abstract contract CommonBase {
     /// @dev Cheat code address.
     /// Calculated as `address(uint160(uint256(keccak256("hevm cheat code"))))`.
     address internal constant VM_ADDRESS = 0x7109709ECfa91a80626fF3989D68f67F5b1DD12D;
+
     /// @dev console.sol and console2.sol work by executing a staticcall to this address.
     /// Calculated as `address(uint160(uint88(bytes11("console.log"))))`.
     address internal constant CONSOLE = 0x000000000000000000636F6e736F6c652e6c6f67;
+
     /// @dev Used when deploying with create2.
     /// Taken from https://github.com/Arachnid/deterministic-deployment-proxy.
     address internal constant CREATE2_FACTORY = 0x4e59b44847b379578588920cA78FbF26c0B4956C;
+
     /// @dev The default address for tx.origin and msg.sender.
     /// Calculated as `address(uint160(uint256(keccak256("foundry default caller"))))`.
     address internal constant DEFAULT_SENDER = 0x1804c8AB1F12E6bbf3894d4083f33e07309d1f38;
+
     /// @dev The address of the first contract `CREATE`d by a running test contract.
     /// When running tests, each test contract is `CREATE`d by `DEFAULT_SENDER` with nonce 1.
     /// Calculated as `VM.computeCreateAddress(VM.computeCreateAddress(DEFAULT_SENDER, 1), 1)`.
     address internal constant DEFAULT_TEST_CONTRACT = 0x5615dEB798BB3E4dFa0139dFa1b3D433Cc23b72f;
+
     /// @dev Deterministic deployment address of the Multicall3 contract.
     /// Taken from https://www.multicall3.com.
     address internal constant MULTICALL3_ADDRESS = 0xcA11bde05977b3631167028862bE2a173976CA11;
+
     /// @dev The order of the secp256k1 curve.
     uint256 internal constant SECP256K1_ORDER =
         115792089237316195423570985008687907852837564279074904382605163141518161494337;

src/Config.sol

@@ -0,0 +1,60 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.13;
+
+import {console} from "./console.sol";
+import {StdConfig} from "./StdConfig.sol";
+import {CommonBase} from "./Base.sol";
+
+/// @notice Boilerplate to streamline the setup of multi-chain environments.
+abstract contract Config is CommonBase {
+    // -- STORAGE (CONFIG + CHAINS + FORKS) ------------------------------------
+
+    /// @dev Contract instance holding the data from the TOML config file.
+    StdConfig internal config;
+
+    /// @dev Array of chain IDs for which forks have been created.
+    uint256[] internal chainIds;
+
+    /// @dev A mapping from a chain ID to its initialized fork ID.
+    mapping(uint256 => uint256) internal forkOf;
+
+    // -- HELPER FUNCTIONS -----------------------------------------------------
+
+    /// @notice  Loads configuration from a file.
+    ///
+    /// @dev     This function instantiates a `Config` contract, caching all its config variables.
+    ///
+    /// @param   filePath: the path to the TOML configuration file.
+    /// @param   writeToFile: whether updates are written back to the TOML file.
+    function _loadConfig(string memory filePath, bool writeToFile) internal {
+        console.log("----------");
+        console.log(string.concat("Loading config from '", filePath, "'"));
+        config = new StdConfig(filePath, writeToFile);
+        vm.makePersistent(address(config));
+        console.log("Config successfully loaded");
+        console.log("----------");
+    }
+
+    /// @notice  Loads configuration from a file and creates forks for each specified chain.
+    ///
+    /// @dev     This function instantiates a `Config` contract, caching all its config variables,
+    ///          reads the configured chain ids, and iterates through them to create a fork for each one.
+    ///          It also creates a map `forkOf[chainId] -> forkId` to easily switch between forks.
+    ///
+    /// @param   filePath: the path to the TOML configuration file.
+    /// @param   writeToFile: whether updates are written back to the TOML file.
+    function _loadConfigAndForks(string memory filePath, bool writeToFile) internal {
+        _loadConfig(filePath, writeToFile);
+
+        console.log("Setting up forks for the configured chains...");
+        uint256[] memory chains = config.getChainIds();
+        for (uint256 i = 0; i < chains.length; i++) {
+            uint256 chainId = chains[i];
+            uint256 forkId = vm.createFork(config.getRpcUrl(chainId));
+            forkOf[chainId] = forkId;
+            chainIds.push(chainId);
+        }
+        console.log("Forks successfully created");
+        console.log("----------");
+    }
+}