Foundry 简介
Foundry 是一个强大的 Solidity 开发框架,帮助开发者高效地构建、测试和部署智能合约。
优势
- 以 solidity 为第一公民,可以完全使用 solidity 开发与测试
- 强大的测试功能,方便模拟各种情况,支持模糊测试
- 使用 rust 语言编写,包含一系列可以与 Ethereum 交互的工具
安装
Foundryup 是 foundry 工具包的安装器,通过它我们来完成 foundry 的安装,首先,在终端执行如下命令:
curl -L https://foundry.paradigm.xyz | bash
安装完成后,会自动安装 forge, cast, anvil, Chisel 工具。可以通过如下命令验证是否安装成功:
forge --version
初始化项目
init 命令会创建一个项目目录,并安装好forge-std 库。
forge init hello_foundry
工程结构
> tree -L 2
.
├── README.md
├── foundry.toml
├── lib
│ └── forge-std
├── script
│ └── Counter.s.sol
├── src
│ └── Counter.sol
└── test
└── Counter.t.sol
6 directories, 5 files
● src:智能合约目录
● script :部署脚本文件
● lib: 依赖库目录
● test:智能合约测试用例文件夹
● foundry.toml:配置文件,配置连接的网络URL 及编译选项。
合约编译及测试
编译命令:
forge build
如果 foundry.toml 文件未指定 Solc 编译器版本,则默认使用最新的版本。编译好的文件(合约ABI,bytecode ),会放在out的文件夹中。
测试命令:
forge test
关于测试的一些约定:
● 测试用例位于test包下,通常使用***.t.sol为结尾来命名测试文件。
● 测试方法的命名,是由test_ 为前缀,后面遵循驼峰命名法。
● 继承 forge-std 标准库下的 Test.sol 合约来编写测试用例。
合约部署与验证
部署前的准备工作
部署之前要准备有测试币的账号,以及配置好相应的测试网。
关于网络配置及领取测试币的过程这里略过,还不会操作的小伙伴可以去 hackquest 自行学习。
如果合约中用到了其他依赖,需要首先安装对应的依赖,安装命令如下:
forge install
合约部署
部署命令:
forge create --rpc-url <your_rpc_url> --private-key <your_private_key> --verify src/MyContract.sol:MyContract --constructor-args <constructor_args>
● rpc-url: 即区块链节点 RPC,例如:https://eth-sepolia.g.alchemy.com/v2/xxxxxxxxx
● private-key: 即钱包私钥,建议创建专门用来开发测试的新钱包。
● etherscan-api-key: 即区块链浏览器的 API KEY TOKEN,用于验证合约。
● verify: 验证合约,即在浏览器中开源合约的代码
● :MyContract: 实际部署的合约,由于一个 solidity 中允许存在多个合约,因此这里指定需要部署的合约名称。
● constructor-args: 合约的构造参数,如果没有,可以不设置该属性
脚本部署与验证
通过 forge create 命令进行合约的部署&验证需要输入的参数较多,更推荐的做法是使用 solidity-scripting,它是一种使用 Solidity 以声明方式部署合约的方法。
具体配置信息请移步:这里