refactor: migrate codebase to foundry-template (#8)

Closes #3

script/Base.s.sol

@@ -0,0 +1,41 @@
+// SPDX-License-Identifier: MIT
+pragma solidity >=0.8.19 <=0.9.0;
+
+import { Script } from "forge-std/Script.sol";
+
+abstract contract BaseScript is Script {
+    /// @dev Included to enable compilation of the script without a $MNEMONIC environment variable.
+    string internal constant TEST_MNEMONIC = "test test test test test test test test test test test junk";
+
+    /// @dev Needed for the deterministic deployments.
+    bytes32 internal constant ZERO_SALT = bytes32(0);
+
+    /// @dev The address of the transaction broadcaster.
+    address internal broadcaster;
+
+    /// @dev Used to derive the broadcaster's address if $ETH_FROM is not defined.
+    string internal mnemonic;
+
+    /// @dev Initializes the transaction broadcaster like this:
+    ///
+    /// - If $ETH_FROM is defined, use it.
+    /// - Otherwise, derive the broadcaster address from $MNEMONIC.
+    /// - If $MNEMONIC is not defined, default to a test mnemonic.
+    ///
+    /// The use case for $ETH_FROM is to specify the broadcaster key and its address via the command line.
+    constructor() {
+        address from = vm.envOr({ name: "ETH_FROM", defaultValue: address(0) });
+        if (from != address(0)) {
+            broadcaster = from;
+        } else {
+            mnemonic = vm.envOr({ name: "MNEMONIC", defaultValue: TEST_MNEMONIC });
+            (broadcaster,) = deriveRememberKey({ mnemonic: mnemonic, index: 0 });
+        }
+    }
+
+    modifier broadcast() {
+        vm.startBroadcast(broadcaster);
+        _;
+        vm.stopBroadcast();
+    }
+}

script/Deploy.s.sol

@@ -0,0 +1,11 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity >=0.8.19 <=0.9.0;
+
+import { BaseScript } from "./Base.s.sol";
+import { DeploymentConfig } from "./DeploymentConfig.s.sol";
+
+contract Deploy is BaseScript {
+    function run() public returns (DeploymentConfig deploymentConfig) {
+        deploymentConfig = new DeploymentConfig(broadcaster);
+    }
+}

script/DeploymentConfig.s.sol

@@ -0,0 +1,39 @@
+//// SPDX-License-Identifier: UNLICENSED
+
+pragma solidity >=0.8.19 <=0.9.0;
+
+import { Script } from "forge-std/Script.sol";
+
+contract DeploymentConfig is Script {
+    error DeploymentConfig_InvalidDeployerAddress();
+    error DeploymentConfig_NoConfigForChain(uint256);
+
+    struct NetworkConfig {
+        address deployer;
+    }
+
+    NetworkConfig public activeNetworkConfig;
+
+    address private deployer;
+
+    constructor(address _broadcaster) {
+        if (block.chainid == 31_337) {
+            activeNetworkConfig = getOrCreateAnvilEthConfig();
+        } else {
+            revert DeploymentConfig_NoConfigForChain(block.chainid);
+        }
+        if (_broadcaster == address(0)) revert DeploymentConfig_InvalidDeployerAddress();
+        deployer = _broadcaster;
+    }
+
+    function getOrCreateAnvilEthConfig() public view returns (NetworkConfig memory) {
+        return NetworkConfig({ deployer: deployer });
+    }
+
+    // This function is a hack to have it excluded by `forge coverage` until
+    // https://github.com/foundry-rs/foundry/issues/2988 is fixed.
+    // See: https://github.com/foundry-rs/foundry/issues/2988#issuecomment-1437784542
+    // for more info.
+    // solhint-disable-next-line
+    function test() public { }
+}