forge-scripting

Forge Script Deployment Patterns

Basic Deployment Script

// SPDX-License-Identifier: MIT
pragma solidity ^0.8.20;

import {Script, console2} from "forge-std/Script.sol";
import {MyToken} from "../src/MyToken.sol";

contract DeployScript is Script {
    function run() external {
        uint256 deployerKey = vm.envUint("DEPLOYER_PRIVATE_KEY");
        address deployer = vm.addr(deployerKey);

        console2.log("Deployer:", deployer);
        console2.log("Balance:", deployer.balance);

        vm.startBroadcast(deployerKey);

        MyToken token = new MyToken("My Token", "MTK", 1_000_000e18);
        console2.log("Token deployed at:", address(token));

        vm.stopBroadcast();
    }
}

Running Scripts

# Dry run (simulation only, no tx sent)
forge script script/Deploy.s.sol --rpc-url $ETH_RPC_URL

# Broadcast (send real transactions)
forge script script/Deploy.s.sol --rpc-url $ETH_RPC_URL --broadcast

# Broadcast + verify on Etherscan
forge script script/Deploy.s.sol --rpc-url $ETH_RPC_URL \
  --broadcast --verify --etherscan-api-key $ETHERSCAN_API_KEY

# With specific sender
forge script script/Deploy.s.sol --rpc-url $ETH_RPC_URL \
  --broadcast --sender 0xDeployer

# Resume failed broadcast
forge script script/Deploy.s.sol --rpc-url $ETH_RPC_URL --resume

# Slow mode (wait for each tx confirmation)
forge script script/Deploy.s.sol --rpc-url $ETH_RPC_URL --broadcast --slow

Deployment Script Template

// SPDX-License-Identifier: MIT
pragma solidity ^0.8.20;

import {Script, console2} from "forge-std/Script.sol";
import {ERC1967Proxy} from "@openzeppelin/contracts/proxy/ERC1967/ERC1967Proxy.sol";
import {MyProtocol} from "../src/MyProtocol.sol";
import {Treasury} from "../src/Treasury.sol";

contract DeployProtocol is Script {
    struct DeployConfig {
        address admin;
        address treasury;
        uint256 feeRate;
        address weth;
    }

    function getConfig() internal view returns (DeployConfig memory) {
        if (block.chainid == 1) {
            return DeployConfig({
                admin: vm.envAddress("MAINNET_ADMIN"),
                treasury: vm.envAddress("MAINNET_TREASURY"),
                feeRate: 30, // 0.3%
                weth: 0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2
            });
        } else if (block.chainid == 8453) {
            return DeployConfig({
                admin: vm.envAddress("BASE_ADMIN"),
                treasury: vm.envAddress("BASE_TREASURY"),
                feeRate: 30,
                weth: 0x4200000000000000000000000000000000000006
            });
        } else if (block.chainid == 11155111) {
            return DeployConfig({
                admin: msg.sender,
                treasury: msg.sender,
                feeRate: 100,
                weth: address(0)
            });
        } else {
            revert("Unsupported chain");
        }
    }

    function run() external {
        DeployConfig memory cfg = getConfig();
        uint256 deployerKey = vm.envUint("DEPLOYER_PRIVATE_KEY");

        vm.startBroadcast(deployerKey);

        // Deploy implementation
        MyProtocol impl = new MyProtocol();
        console2.log("Implementation:", address(impl));

        // Deploy proxy
        bytes memory initData = abi.encodeCall(
            MyProtocol.initialize, (cfg.admin, cfg.treasury, cfg.feeRate, cfg.weth)
        );
        ERC1967Proxy proxy = new ERC1967Proxy(address(impl), initData);
        console2.log("Proxy:", address(proxy));

        // Deploy treasury
        Treasury treasury = new Treasury(address(proxy));
        console2.log("Treasury:", address(treasury));

        // Post-deploy configuration
        MyProtocol(address(proxy)).setTreasury(address(treasury));

        vm.stopBroadcast();

        // Verify deployment (runs after broadcast)
        _verify(address(proxy), cfg);
    }

    function _verify(address proxy, DeployConfig memory cfg) internal view {
        MyProtocol protocol = MyProtocol(proxy);
        require(protocol.admin() == cfg.admin, "Admin mismatch");
        require(protocol.feeRate() == cfg.feeRate, "Fee mismatch");
        console2.log("Verification passed");
    }
}