智能合约与以太坊 / 系统课时
安装 Foundry 并初始化项目
安装 Foundry 并初始化项目
完成本篇后,你会在本机安装 Forge、Cast、Anvil,创建一个带 Solidity 示例合约和测试的工程,并能检查编译器、依赖映射及构建结果。整个过程只使用终端,不需要连接 Ethereum 主网或准备钱包私钥。
学习目标
- 安装 Foundry 工具链并分别验证三个命令可用。
- 识别
foundry.toml、src/、test/、script/、lib/的职责。 - 编译默认合约、运行测试并定位常见环境故障。
检查系统与安装前提
以下命令适用于 macOS、Linux 以及 Windows 的 WSL2(建议 Ubuntu)终端;Windows 用户不要直接把 Bash 安装命令粘贴到 PowerShell。先确保 Git、curl 可用,并且可以访问 GitHub 和 Solidity 编译器下载源。
git --version
curl --version预期结果:两条命令分别输出 Git 和 curl 的版本及相关信息。版本号随机器而异;如果提示 command not found,先通过系统包管理器安装缺失工具。
安装 Forge、Cast 和 Anvil
Foundry 官方通过 foundryup 管理工具链。执行安装脚本后,按终端提示重新打开终端或加载对应 Shell 配置,使 foundryup 进入 PATH。
# 安装 Foundry 工具链管理器
curl -L https://foundry.paradigm.xyz | bash预期结果:安装器提示 foundryup 的安装位置和后续操作;实际提示文字可能随版本改变。仅从确认可信的官方地址执行远程脚本。
重新打开终端后继续:
# 下载并安装稳定版工具链
foundryup
forge --version
cast --version
anvil --version预期结果:foundryup 安装完成,后三条命令分别打印各自的版本信息。Forge 负责合约编译与测试,Cast 负责调用和查询链上接口,Anvil 是本地 JSON-RPC 开发节点;这里只验证它们已安装,不需要启动 Anvil。
初始化工程并检查目录
在准备存放项目的目录执行:
# 创建独立工程,随后进入项目根目录
forge init hello_foundry
cd hello_foundry预期结果:出现 hello_foundry 工程目录,默认模板通常带有 Counter 合约、测试和脚本,并安装 forge-std 测试依赖。初始化需要 Git 和网络访问,模板文件可能随 Foundry 版本小幅调整。
| 路径 | 用途与检查点 |
|---|---|
foundry.toml |
项目构建配置,位于工程根目录 |
src/ |
Solidity 合约源码,通常有 Counter.sol |
test/ |
Forge 测试,通常有 Counter.t.sol |
script/ |
部署或交互脚本,通常有 Counter.s.sol |
lib/forge-std/ |
标准测试库,检查 src/Test.sol 是否存在 |
out/、cache/ |
构建后生成的产物和增量编译缓存,不是手写源码目录 |
检查编译器配置与依赖映射
打开工程根目录的 foundry.toml,确认至少包含以下配置;若模板已有更多字段,可以保留。这里选择让 Forge 根据合约的 pragma solidity 自动解析兼容的 Solidity 编译器版本。
[profile.default]
src = "src"
test = "test"
script = "script"
out = "out"
libs = ["lib"]
auto_detect_solc = true这是配置文件示例,不是终端命令。首次编译可能自动下载 solc,因此需要联网。如果团队需要锁定编译器,可改用 solc_version = "0.8.30",但必须确认项目和依赖的 Solidity 版本约束都兼容;设置 solc_version 后会覆盖自动检测行为。
在工程根目录检查最终生效的配置和自动识别的依赖映射:
forge config
forge remappings预期结果:forge config 显示当前配置,其中源码目录为 src、产物目录为 out、依赖目录包含 lib;forge remappings 通常包含 forge-std/=lib/forge-std/src/。具体显示格式取决于安装版本。若缺少该映射,先检查 lib/forge-std/ 是否完整,再确认 libs 没有指向错误目录。
构建、测试和故障定位
保持终端位于 hello_foundry 根目录,执行:
# 编译项目并运行模板自带的 Solidity 测试
forge build
forge test预期结果:forge build 报告编译成功,out/ 下生成合约 ABI 和字节码相关产物;forge test 输出模板测试的 [PASS] 记录及成功汇总。实际编译文件数、耗时、测试数量及编译器版本不固定。
- 出现
foundryup: command not found:重开终端,检查~/.foundry/bin是否已加入当前 Shell 的PATH。 - 出现
git: command not found或依赖下载失败:安装 Git,检查网络和 GitHub 访问,再重新初始化;不要把缺失的lib/forge-std当成 Solidity 语法错误。 - 出现
Solc ... not found、版本冲突或编译器下载失败:检查pragma solidity与solc_version是否兼容;确认网络可访问下载源,避免误开offline模式。
当三个工具都能打印版本、forge remappings 找到标准库且 forge build 与 forge test 成功时,开发环境就满足继续编写和调试合约的基本条件。