使用Foundry部署合约至Moonbeam¶

概览¶

Foundry是一个用Rust语言编写的以太坊部署环境，能够帮助开发者管理依赖项、编译项目、运行测试、部署合约以及从命令行与区块链交互。Foundry可以直接与Moonbeam的以太坊API交互，所以可以直接用于将智能合约部署至Moonbeam。

Foundry由四个工具组成：

• Forge - 编译、测试和部署合约
• Cast - 用于与合约交互的命令行界面
• Anvil - 用于开发目的的本地测试节点，可分叉预先存在的网络
• Chisel - 用于快速测试Solidity片段的Solidity REPL（交互式编程环境）

本教程将涵盖如何使用Foundry在Moonbase Alpha TestNet上编译、部署和调试以太坊智能合约。此教程同样适用于Moonbeam、Moonriver和Moonbeam开发节点。

查看先决条件¶

开始之前，您将需要准备以下内容：

• 拥有资金的账户。 您可以每24小时一次从Moonbase Alpha水龙头上获取DEV代币以在Moonbase Alpha上进行测试
• 要在Moonbeam或Moonriver网络上测试本指南中的示例，您可以从受支持的网络端点提供商之一获取您自己的端点和API密钥
• 提前安装Foundry

创建Foundry项目¶

如果您尚未拥有Foundry项目，您需要通过以下步骤创建一个：

1. 如果您尚未安装，您需要先安装Foundry。如果您在Linux或MacOS系统操作，您可以运行以下命令：

   curl -L https://foundry.paradigm.xyz | bash
   foundryup
   

   如果在Windows系统操作，您必须安装Rust，然后从源代码构建Foundry：

   curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs/ | sh
   cargo install --git https://github.com/foundry-rs/foundry foundry-cli anvil --bins --locked
   

2. 创建项目，这将创建一个文件夹并打开它，其中包含三个文件夹,：

   forge init foundry && cd foundry
   

创建默认项目后，您将看到以下三个文件夹：

• lib - 项目所有的依赖项以git子模块的形式
• src - 用于存放智能合约（以及功能）
• test - 用于存放项目的Forge测试，这些测试是用Solidity编写的

除了这三个文件夹，还将创建一个git项目以及一个预先编写的.gitignore文件，其中相关文件类型和文件夹被忽略。

源代码文件夹¶

src文件夹可能已经包含Counter.sol（一个最小的Solidity合约），您可以自行删除此合约。同时为了避免可能出现的报错，您也需要删除 scripts 文件夹中的 Counter.s.sol 以及 test 文件夹中的 Counter.t.sol. 下一步您需要部署一个ERC-20合约。在合约目录中，您可以创建一个MyToken.sol文件：

cd src
touch MyToken.sol

打开文件并添加以下合约：

pragma solidity ^0.8.0;

// Import OpenZeppelin Contract
import "@openzeppelin/contracts/token/ERC20/ERC20.sol";

// This ERC-20 contract mints the specified amount of tokens to the contract creator
contract MyToken is ERC20 {
    constructor(uint256 initialSupply) ERC20("MyToken", "MYTOK") {
        _mint(msg.sender, initialSupply);
    }
}

在尝试编译合约之前，您需要安装OpenZeppelin合约作为依赖项。您可能需要先将以前的更改提交到git。默认情况下，Foundry使用git子模块而非npm程序包，因此没有使用传统的npm导入路径和命令。相反，使用OpenZeppelin GitHub repository的名称。

forge install OpenZeppelin/openzeppelin-contracts

编译Solidity¶

安装完所有的依赖项后，您可以开始编译合约：

forge build

编译完成后，将创建两个文件夹：out和cache。您合约的ABI和字节码将包含在out文件夹中。这两个文件夹已被默认Foundry项目初始化中包含的.gitignore忽略。

部署合约¶

Foundry提供两种主要合约部署方式。第一种方法比较直接，是使用命令forge create；第二种更为灵活和强大，是使用Foundry脚本，该脚本会在任何部署之前运行模拟。以下部分将分别介绍forge create和 Foundry脚本这两种方法。

使用 Forge Create¶

使用forge create来部署合约只需一个命令，但您必须包含一个RPC端点、一个拥有资产的私钥和构造函数参数。MyToken.sol在其构造函数中要求提供初始代币供应量，因此以下的命令都包含100作做为一个构造参数。您可以使用以下命令部署MyToken.sol合约至正确网络的：

forge create --rpc-url INSERT_RPC_API_ENDPOINT \
--constructor-args 100 \
--private-key YOUR_PRIVATE_KEY \
src/MyToken.sol:MyToken

forge create --rpc-url INSERT_RPC_API_ENDPOINT \
--constructor-args 100 \
--private-key YOUR_PRIVATE_KEY \
src/MyToken.sol:MyToken

forge create --rpc-url https://rpc.api.moonbase.moonbeam.network \
--constructor-args 100 \
--private-key YOUR_PRIVATE_KEY \
src/MyToken.sol:MyToken

forge create --rpc-url http://127.0.0.1:9944 \
--constructor-args 100 \
--private-key YOUR_PRIVATE_KEY \
src/MyToken.sol:MyToken

部署合约后几秒钟，您应该会在终端看到合约地址。

恭喜！您的合约已部署成功！请保存该地址，您将在下一步中使用它与该合约实例进行交互。

使用Solidity脚本部署¶

Solidity脚本是一种比 forge create 更强大、更灵活的合约部署方式。 编写Solidity脚本与编写普通的Solidity智能合约相同，但您永远不会部署此脚本。

您可以使用各种参数定制forge script的行为。除了本地模拟（这是每次运行的必要部分）之外，所有组件都是可选的。forge script命令将按照以下顺序尝试执行所有步骤：

1. Local simulation - 在本地EVM中模拟交易
2. Onchain simulation - 通过提供的RPC URL模拟交易
3. Broadcasting - 当提供 --broadcast 标志并且模拟成功时，交易将被发送
4. Verification - 当提供 --verify 标志和有效API密钥时，进行基于API的智能合约验证

现在开始编写脚本。在脚本文件夹中，创建一个名为 MyToken.s.sol 的文件。复制并粘贴以下文件的内容：

// SPDX-License-Identifier: UNLICENSED
pragma solidity ^0.8.13;

import "forge-std/Script.sol";
import "../src/MyToken.sol";

contract MyScript is Script {
    function run() external {
        uint256 deployerPrivateKey = INSERT_PRIVATE_KEY;
        vm.startBroadcast(deployerPrivateKey);

        MyToken mytoken = new MyToken(1000000000);

        vm.stopBroadcast();
    }
}

请注意，即使上述脚本不会被部署，它仍需要符合典型Solidity合约的所有格式，例如pragma语句。

您可以使用以下命令部署 MyToken.sol 合约。请记住它将按顺序执行所有相关步骤。对于此示例，Foundry将首先尝试本地模拟和利用提供的 RPC进行模拟，然后才部署合约。如果任何模拟失败，Foundry都不会继续部署。

forge script script/MyToken.s.sol --rpc-url https://rpc.api.moonbase.moonbeam.network --broadcast

如果您的脚本执行成功，您的终端应展示一下内容：

这样就成了。有关使用Foundry进行Solidity脚本编写的更多信息，请查看Foundry文档。

与合约交互¶

Foundry包括cast，一个用于执行以太坊RPC调用的CLI。

尝试使用Cast检索Token名称，其中INSERT_YOUR_CONTRACT_ADDRESS是您在上一部分部署合约的地址：

cast call INSERT_YOUR_CONTRACT_ADDRESS "name()" --rpc-url INSERT_RPC_API_ENDPOINT

cast call INSERT_YOUR_CONTRACT_ADDRESS "name()" --rpc-url INSERT_RPC_API_ENDPOINT

cast call INSERT_YOUR_CONTRACT_ADDRESS "name()" --rpc-url https://rpc.api.moonbase.moonbeam.network

cast call INSERT_YOUR_CONTRACT_ADDRESS "name()" --rpc-url http://127.0.0.1:9944

您需要获取此数据的hex格式：

0x000000000000000000000000000000000000000000000000000000000000002000000000000000000000000000000000000000000000000000000000000000074d79546f6b656e00000000000000000000000000000000000000000000000000

此数据非可读，但您可以使用Cast将其转换成您想要的格式。在这种情况下，数据是文本，因此您可以将其转换为ASCII字符以查看“My Token”：

cast --to-ascii 0x000000000000000000000000000000000000000000000000000000000000002000000000000000000000000000000000000000000000000000000000000000074d79546f6b656e00000000000000000000000000000000000000000000000000

您也可以使用cast来改变数据。通过将其发送到0地址来尝试销毁Token。

cast send --private-key YOUR_PRIVATE_KEY \
--rpc-url INSERT_RPC_API_ENDPOINT \
--chain 1284 \
YOUR_CONTRACT_ADDRESS \
"transfer(address,uint256)" 0x0000000000000000000000000000000000000001 1

cast send --private-key YOUR_PRIVATE_KEY \
--rpc-url INSERT_RPC_API_ENDPOINT \
--chain 1285 \
YOUR_CONTRACT_ADDRESS \
"transfer(address,uint256)" 0x0000000000000000000000000000000000000001 1

cast send --private-key YOUR_PRIVATE_KEY \
--rpc-url https://rpc.api.moonbase.moonbeam.network \
--chain 1287 \
YOUR_CONTRACT_ADDRESS \
"transfer(address,uint256)" 0x0000000000000000000000000000000000000001 1

cast send --private-key YOUR_PRIVATE_KEY \
--rpc-url http://127.0.0.1:9944 \
--chain 1281 \
YOUR_CONTRACT_ADDRESS \
"transfer(address,uint256)" 0x0000000000000000000000000000000000000001 1

交易将由您的Moonbase账户签署并传播到网络。输出应如下所示：

恭喜您！您已成功使用Foundry部署和交互合约！

使用Anvil进行分叉¶

如上所述，Anvil是用于开发目的的本地测试网节点，可以分叉预先存在的网络。分叉Moonbeam允许用户与部署在网络上的实时合约交互。

使用Anvil分叉时需要注意一些限制。由于Anvil是基于EVM实现，因此您无法与任何Moonbeam已编译的合约及其功能交互。预编译是Substrate实现的一部分，因此无法在模拟的EVM环境中复制。从而，您无法与在Moonbeam上的跨链资产和基于Substrate的功能（如质押和治理）进行交互。

要分叉Moonbeam或Moonriver，您将需要用到您的端点和API钥匙，您可通过支持的端点提供商获取。

要从命令行分叉Moonbeam，您可以在Foundry项目的目录中运行以下命令：

anvil --fork-url INSERT_RPC_API_ENDPOINT

anvil --fork-url INSERT_RPC_API_ENDPOINT

anvil --fork-url https://rpc.api.moonbase.moonbeam.network

分叉的实例将拥有10个已经预先注资10,000测试Token的开发账户。分叉的实例位于http://127.0.0.1:8545/。终端输出应类似于以下内容：

要验证您是否已分叉了网络，您可以查询最新的区块号：

curl --data '{"method":"eth_blockNumber","params":[],"id":1,"jsonrpc":"2.0"}' -H "Content-Type: application/json" -X POST localhost:8545 

如果您已经将result从16进制转换成十进制，您应该在分叉网络时获得了最新区块号。您可以使用区块浏览器交叉查询区块号。

从这里，您可以将新合约部署到您的Moonbeam的分叉实例或与已部署的合约进行交互。在本教程的上述示例的基础上，您可以使用Cast进行调用，来检查您部署合约的帐户中铸造的MYTOK Token的余额：

cast call INSERT_CONTRACT_ADDRESS  "balanceOf(address)(uint256)" INSERT_YOUR_ADDRESS --rpc-url http://localhost:8545

使用Chisel¶

Chisel是一个Solidity REPL，或shell。它允许开发者直接在控制台中编写Solidity以测试比较小的代码片段，让开发者跳过项目设置和合约部署步骤，实现快速的操作流程。

由于Chisel主要用于快速测试，因此可以用于Foundry以外的项目。但是，如果在Foundry项目内执行，在运行时会将配置保留在foundry.toml中。

在本示例中，您将在Solidity中测试一些abi的功能。因为其相对比较复杂可以很好地演示Chisel的作用。要开始使用Chisel，请在命令行中运行以下命令以启动Chisel shell：

chisel

在Chisel shell中，您可以像在函数中运行一样编写Solidity代码：

bytes memory myData = abi.encode(100, true, "Develop on Moonbeam");

假设您对abi如何编码数据感兴趣，因为您正在研究如何最有效地将数据存储在区块链上，从而节省gas费用。要查看myData是如何存储在内存中的，您可以在Chisel shell中使用以下命令：

!memdump

memdump将显示当前会话中的所有数据。您可能会看到类似下面这样的内容。如果您不熟悉hex格式或者ABI编码的工作原理，那么您可能无法找到myData变量的存储位置。

幸运的是，Chisel会轻松帮您找到这些信息存储位置。使用!rawstack命令，您可以找到变量值在栈中的位置。

!rawstack myData

在此情况下，因为字节的长度超过32个字节，因此将显示内存指针。这样您已经从!memdump命令了解了整个栈。

!rawstack命令显示myData变量存储在0x80中，与从!memdump命令检索到的内存内容对比时，看起来myData存储如下所示：

[0x80:0xa0]: 0x00000000000000000000000000000000000000000000000000000000000000a0
[0xa0:0xc0]: 0x0000000000000000000000000000000000000000000000000000000000000064
[0xc0:0xe0]: 0x0000000000000000000000000000000000000000000000000000000000000001
[0xe0:0x100]: 0x0000000000000000000000000000000000000000000000000000000000000060
[0x100:0x120]: 0x0000000000000000000000000000000000000000000000000000000000000013
[0x120:0x140]: 0x446576656c6f70206f6e204d6f6f6e6265616d00000000000000000000000000

乍一看数据很合理，因为0xa0的值0x64等于100，0xc0的值0x01等于true。如果您想要了解ABI编码的工作原理，请参考ABI的Solidity文档。在本示例中，这种数据打包方式有很多个零，因此作为智能合约开发者，您可以尝试使用结构或者bitwise（按位）代码更有效地将数据打包在一起。

由于您已经完成这段代码，您可以清除Chisel的状态，以防止其干扰您想要尝试的任何未来逻辑（在运行相同的Chisel实例时）：

!clear

测试Chisel还有一个更简单的方式。当编写以分号（;）结尾的代码时，Chisel将其作为一个语句来运行，并将其值存储在Chisel的Runtime（运行时）状态中。但是，如果您真的只需要查看ABI编码数据的表示方式，那么您可以将代码作为表达式运行。要使用相同的abi示例进行尝试，请在Chisel shell中编写以下内容：

abi.encode(100, true, "Develop on Moonbeam")

您应该看到如下所示输出：

虽然它没有以相同的方式显示数据，但您仍然可以获得数据的内容，并且它还进一步分解了信息的编码方式，例如让您知道0xa0值定义了数据长度。

默认情况下，当您离开Chisel shell时，不会保留任何数据。但是你可以通过指示chisel进行操作。 例如，您可以执行以下步骤存储一个变量：

1. 在Chisel中存储uint256

   uint256 myNumber = 101;
   

2. 使用!save存储会话。在本示例中，您可以使用数字1作为存储ID

   !save 1
   

3. 退出对话

   !quit
   

然后，要查看并与您存储的Chisel状态进行交互，您可以执行以下步骤：

1. 查看存储的Chisel状态列表

   chisel list
   

2. 加载存储的状态

   chisel load 1
   

3. 查看上一组步骤中保存在Chisel中的uint256

   !rawstack myNumber
   

您甚至可以在使用Chisel时分叉网络：

!fork https://rpc.api.moonbase.moonbeam.network

然后，例如，您可以查询其中一个Moonbase Alpha收集人的余额：

0x12E7BCCA9b1B15f33585b5fc898B967149BDb9a5.balance

如果您想要获取关于Chisel的更多信息，请下载Foundry并参考其官方页面。

通过Hardhat使用Foundry¶

通常，您希望集成的项目的所有设置都在Hardhat中，因此将整个项目转换为Foundry是一项艰巨的任务。通过创建同时使用Hardhat和Foundry功能的混合项目，可以避免这项额外的工作。这可以通过Hardhat的hardhat-foundry插件来实现。

要将预先存在的Foundry项目转换成混合项目，您需要先在同一个文件夹中安装Hardhat项目：

npm init
npm install --save-dev hardhat @nomicfoundation/hardhat-foundry
npx hardhat init

更多信息，请参考创建Hardhat项目的文档。

初始化新的Hardhat项目后，将会出现一些新的文件夹和文件：contracts、hardhat.config.js、scripts和test/Lock.js。您只需稍微调整即可创建一个混合项目：

1. 在Repo中编辑hardhat.config.js文件。打开后，在头部添加下方指令：

   require("@nomicfoundation/hardhat-foundry");
   

   添加hardhat-foundry插件后，Hardhat的contracts文件夹将失效，因为现在Hardhat期望所有智能合约都存储在Foundry的src文件夹中

2. 将contracts文件夹中的所有智能合约移至src文件夹，然后删除contracts文件夹

3. 编辑foundry.toml文件以确保通过Git子模块和npm安装的依赖项可以由Forge工具编译。编辑profile.default以确保libs条目同时具有lib和node_modules：

   [profile.default]
   src = 'src'
   out = 'out'
   libs = ['lib', 'node_modules']
   solc = '0.8.20'
   evm_version = 'london'
   

现在，无论依赖关系如何，forge build和npx hardhat compile都应该可以工作。 forge test和npx hardhat test现在应该能够访问所有智能合约和依赖项。forge test将仅用于Solidity测试，而npx Hardhat test将仅用于JavaScript测试。如果您想结合使用它们，那么您可以在package.json文件中创建一个新脚本：

"scripts": {
    "test": "npx hardhat test && forge test"
}

您可以运行以下指令：

npm run test

最后，虽非必要，但可以将所有JavaScript脚本从scripts文件夹移动到Foundry的script文件夹中，并删除scripts文件夹，这样就不会出现两个具有相同用途的文件夹。