foundry-solidity

Foundry Solidity 开发

使用 Foundry 1.5.0 和 Solidity 0.8.30 构建安全、高效智能合约的完整指南。

何时使用此技能

• 开发 Ethereum/EVM 智能合约
• 编写 Forge 测试（单元测试、模糊测试、不变量测试、分叉测试）
• 使用脚本部署合约
• 使用 Foundry 工具（forge、cast、anvil、chisel）
• 处理 foundry.toml、*.t.sol、*.s.sol 文件
• 调试交易和合约交互

快速开始

# Create new project
forge init my-project && cd my-project

# Build contracts
forge build

# Run tests
forge test

# Deploy (dry-run)
forge script script/Deploy.s.sol --rpc-url sepolia

# Deploy (broadcast)
forge script script/Deploy.s.sol --rpc-url sepolia --broadcast --verify

项目结构

my-project/
├── foundry.toml          # Configuration
├── src/                  # Contracts
│   └── Counter.sol
├── test/                 # Tests (*.t.sol)
│   └── Counter.t.sol
├── script/               # Deploy scripts (*.s.sol)
│   └── Deploy.s.sol
└── lib/                  # Dependencies
    └── forge-std/

核心命令

构建与测试

forge build                          # Compile
forge test                           # Run all tests
forge test -vvvv                     # With traces
forge test --match-test testDeposit  # Filter by test name
forge test --match-contract Vault    # Filter by contract
forge test --fork-url $RPC_URL       # Fork testing
forge test --gas-report              # Gas usage report

部署

# Single contract
forge create src/Token.sol:Token --rpc-url sepolia --private-key $KEY --broadcast

# Script deployment (recommended)
forge script script/Deploy.s.sol:Deploy --rpc-url sepolia --broadcast --verify

# Verify existing contract
forge verify-contract $ADDRESS src/Token.sol:Token --chain sepolia

Cast - 区块链交互

cast call $CONTRACT "balanceOf(address)" $USER --rpc-url mainnet
cast send $CONTRACT "transfer(address,uint256)" $TO $AMOUNT --private-key $KEY
cast decode-tx $TX_HASH
cast storage $CONTRACT 0 --rpc-url mainnet

Anvil - 本地节点

anvil                           # Start local node
anvil --fork-url $RPC_URL       # Fork mainnet
anvil --fork-block-number 18000000

基本测试合约

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

import {Test, console} from "forge-std/Test.sol";
import {Counter} from "../src/Counter.sol";

contract CounterTest is Test {
    Counter public counter;
    address public user;

    function setUp() public {
        counter = new Counter();
        user = makeAddr("user");
        deal(user, 10 ether);
    }

    function test_Increment() public {
        counter.increment();
        assertEq(counter.number(), 1);
    }

    function test_RevertWhen_Unauthorized() public {
        vm.expectRevert("Unauthorized");
        vm.prank(user);
        counter.adminFunction();
    }

    function testFuzz_SetNumber(uint256 x) public {
        x = bound(x, 0, 1000);
        counter.setNumber(x);
        assertEq(counter.number(), x);
    }
}

必备作弊码

// Identity & ETH
address alice = makeAddr("alice");          // Create labeled address
deal(alice, 10 ether);                      // Give ETH
deal(address(token), alice, 1000e18);       // Give ERC20

// Impersonation
vm.prank(alice);                            // Next call as alice
vm.startPrank(alice);                       // All calls as alice
vm.stopPrank();

// Time & Block
vm.warp(block.timestamp + 1 days);          // Set timestamp
vm.roll(block.number + 100);                // Set block number

// Assertions
vm.expectRevert("Error message");           // Expect revert
vm.expectRevert(CustomError.selector);      // Custom error
vm.expectEmit(true, true, false, true);     // Expect event
emit Transfer(from, to, amount);            // Must match next emit

// Storage
vm.store(addr, slot, value);                // Write storage
vm.load(addr, slot);                        // Read storage

部署脚本

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

import {Script, console} from "forge-std/Script.sol";
import {Counter} from "../src/Counter.sol";

contract Deploy is Script {
    function run() external {
        uint256 deployerKey = vm.envUint("PRIVATE_KEY");

        vm.startBroadcast(deployerKey);
        Counter counter = new Counter();
        counter.setNumber(42);
        vm.stopBroadcast();

        console.log("Deployed to:", address(counter));
    }
}

现代 Solidity 模式（0.8.30）

// Custom errors (gas efficient)
error InsufficientBalance(uint256 available, uint256 required);

// Transient storage (0.8.28+) - cheap reentrancy guard
bool transient locked;
modifier nonReentrant() {
    require(!locked, "Reentrancy");
    locked = true;
    _;
    locked = false;
}

// Immutable variables (cheap reads)
address public immutable owner;

// Named mapping parameters
mapping(address user => uint256 balance) public balances;

// require with custom error (0.8.26+)
require(amount <= balance, InsufficientBalance(balance, amount));

配置（foundry.toml）

[profile.default]
src = "src"
out = "out"
libs = ["lib"]
solc = "0.8.30"
optimizer = true
optimizer_runs = 200
evm_version = "prague"

fuzz.runs = 256
invariant.runs = 256
invariant.depth = 50

[rpc_endpoints]
mainnet = "${MAINNET_RPC_URL}"
sepolia = "${SEPOLIA_RPC_URL}"

[etherscan]
mainnet = { key = "${ETHERSCAN_API_KEY}" }
sepolia = { key = "${ETHERSCAN_API_KEY}" }

[profile.ci]
fuzz.runs = 10000
invariant.runs = 1000

参考资料

如需详细指南，请参阅：

• 测试：参阅 references/testing.md，了解完整的测试模式（单元测试、模糊测试、不变量测试、分叉测试）、所有作弊码和最佳实践
• forge-std API：参阅 references/forge-std-api.md，查看完整的库参考（150 多个函数）
• Solidity 0.8.30：参阅 references/solidity-modern.md，了解新功能和现代语法
• 部署：参阅 references/deployment.md，了解脚本编写、验证和多链部署
• 配置：参阅 references/configuration.md，了解所有 foundry.toml 选项
• Gas 优化：参阅 references/gas-optimization.md，了解存储打包、编译器设置和性能分析
• 模式：参阅 references/patterns.md，了解访问控制、重入保护、工厂和常见惯用写法
• 安全：参阅 references/security.md，了解漏洞、防御模式和审计准备
• 资源：参阅 references/resources.md，了解官方文档、库、安全工具和学习路径
• 调试：参阅 references/debugging.md，了解跟踪、断点、console.log 和交互式调试器
• 依赖项：参阅 references/dependencies.md，了解 forge install、重映射和 Soldeer 包管理器
• CI/CD：参阅 references/cicd.md，了解 GitHub Actions 工作流、缓存和 Gas 跟踪
• Chisel：参阅 references/chisel.md，了解交互式 Solidity REPL
• Cast 高级用法：参阅 references/cast-advanced.md，了解解码、编码、钱包管理和批量操作
• Anvil 高级用法：参阅 references/anvil-advanced.md，了解身份模拟、状态操作和挖矿模式