AVAX合约开发实战：欧易OKX教程【新手指南】

如何通过欧易进行AVAX合约开发

前言

Avalanche (AVAX) 以其独特的三链架构（X-Chain、C-Chain 和 P-Chain）和雪崩共识机制，实现了卓越的高速交易和极低的交易费用，从而在区块链领域迅速崛起。C-Chain 兼容以太坊虚拟机 (EVM)，使得以太坊开发者能够轻松迁移和部署应用。越来越多的开发者和企业选择在 Avalanche 上部署智能合约，以利用其强大的性能、可扩展性和高度的定制化能力，构建下一代去中心化应用 (DApps) 和金融工具。本文将详细介绍如何通过欧易（OKX）提供的相关工具和资源进行 AVAX 合约开发，涵盖从环境搭建到合约部署的完整流程，包括必要工具的安装、开发环境配置、Solidity 合约编写、使用 Hardhat 或 Remix 进行编译、利用 OKX Web3 钱包进行部署以及通过 OKX 区块链浏览器进行交易测试和验证等关键环节。我们将深入探讨每一步骤，并提供详细的代码示例和操作指导，旨在帮助开发者快速上手 Avalanche 合约开发。

1. 环境搭建

在启动 Avalanche (AVAX) 区块链上的智能合约开发旅程之前，务必确保已配置好全面且高效的开发环境。一个精心设计的开发环境能够显著提升开发效率，并减少潜在的错误。以下是经过实践验证的工具和分步指南，旨在帮助您快速搭建起理想的AVAX合约开发环境：

1.1 安装Node.js 和 npm (Node Package Manager):

Node.js 是一个基于 Chrome V8 引擎的 JavaScript 运行环境，npm 则是 Node.js 的包管理器。它们是许多现代 Web 开发工具的基础，也是进行智能合约开发所必需的。请访问 Node.js 官方网站 (https://nodejs.org) 下载并安装适合您操作系统的最新稳定版本。安装过程中，请务必勾选 "Add to PATH" 选项，以便在命令行中直接使用 node 和 npm 命令。

安装完成后，打开命令行终端，输入以下命令来验证安装是否成功：

node -v
npm -v

如果能够正确显示 Node.js 和 npm 的版本号，则表明安装已成功。

1.2 安装 Hardhat：

Hardhat 是一个专为以太坊智能合约开发设计的开发环境。它提供了编译、部署、测试和调试智能合约所需的所有工具。虽然 Avalanche 与以太坊虚拟机 (EVM) 兼容，因此 Hardhat 也同样适用于AVAX合约开发。使用 npm 可以轻松安装 Hardhat：

npm install --save-dev hardhat

这个命令会将 Hardhat 安装到您的项目目录下的 node_modules 文件夹中，并将其添加到 package. 文件的 devDependencies 中。

1.3 创建 Hardhat 项目：

在您希望创建项目的目录中，打开命令行终端，并执行以下命令来初始化一个新的 Hardhat 项目：

npx hardhat

运行该命令后，Hardhat 会提示您选择一个项目模板。对于初学者，建议选择 "Create an empty hardhat.config.js" 选项。然后，Hardhat 会自动创建项目所需的必要文件和文件夹，包括 contracts , scripts , test 和 hardhat.config.js 。

1.4 配置 Hardhat 连接到 Avalanche 网络：

要将 Hardhat 连接到 Avalanche 网络，您需要在 hardhat.config.js 文件中进行配置。您需要安装 @nomicfoundation/hardhat-toolbox 和 dotenv ：

npm install --save-dev @nomicfoundation/hardhat-toolbox dotenv

然后，编辑 hardhat.config.js 文件，添加以下配置信息：

require("@nomicfoundation/hardhat-toolbox");
require("dotenv").config();

const FUJI_PRIVATE_KEY = process.env.FUJI_PRIVATE_KEY || "0x0000000000000000000000000000000000000000000000000000000000000000";
const SNOWTRACE_API_KEY = process.env.SNOWTRACE_API_KEY || "";

module.exports = {
  solidity: "0.8.17",
  networks: {
    fuji: {
      url: "https://api.avax-test.network/ext/bc/C/rpc",
      chainId: 43113,
      accounts: [FUJI_PRIVATE_KEY],
    },
  },
  etherscan: {
    apiKey: {
      avalancheFujiTestnet: SNOWTRACE_API_KEY,
    },
  },
};

请注意，您需要将 FUJI_PRIVATE_KEY 替换为您在 Avalanche Fuji 测试网上的私钥。为了安全起见，建议将私钥存储在 .env 文件中，并使用 dotenv 包加载。您还需要在 Snowtrace (Avalanche 的区块浏览器) 上获取 API 密钥，并将其设置为 SNOWTRACE_API_KEY 环境变量，以便验证合约。

1.5 安装 Avalanche 插件 (可选)：

虽然 Hardhat 可以直接用于AVAX合约开发，但安装 Avalanche 插件可以提供一些额外的便利功能，例如自动检测 Avalanche 网络配置、简化部署流程等。目前可用的 Avalanche 插件可能相对较少，您可以根据自己的需求选择是否安装。

1.6 代码编辑器：

选择一款功能强大的代码编辑器，例如 Visual Studio Code (VS Code)。VS Code 拥有丰富的插件生态系统，可以提供语法高亮、代码自动补全、调试等功能，极大地提高开发效率。推荐安装 Solidity 插件，以便更好地支持 Solidity 语言的开发。

通过以上步骤，您应该已经成功搭建了一个完整的 AVAX 合约开发环境。现在，您可以开始编写、编译、部署和测试您的智能合约了。

1.1 安装 Node.js 和 npm

Node.js 是一个构建在 Chrome V8 JavaScript 引擎之上的开源、跨平台的 JavaScript 运行时环境。它允许开发者使用 JavaScript 在服务器端运行代码，打破了 JavaScript 只能在浏览器端运行的传统。npm（Node Package Manager）是 Node.js 的默认包管理器，它是一个庞大的在线仓库，包含了大量的 JavaScript 模块和工具，方便开发者进行项目依赖管理和代码复用。

为了搭建基于 JavaScript 的加密货币开发环境，我们需要安装 Node.js 和 npm。访问 Node.js 官方网站 (https://nodejs.org/)，根据你的操作系统（Windows、macOS 或 Linux）下载并安装最新稳定版本（LTS - Long Term Support）的 Node.js。在 Windows 平台的安装过程中，务必勾选 "Add to PATH" 选项。此操作会将 `node` 和 `npm` 命令添加到系统的环境变量中，从而允许你在任何目录下通过命令行直接调用它们，无需指定安装路径。

安装完成后，可以通过命令行终端验证 Node.js 和 npm 是否成功安装及其版本。打开终端（在 Windows 上是命令提示符或 PowerShell，在 macOS 和 Linux 上是 Terminal），输入以下命令：

node -v
npm -v

如果安装成功，将会分别显示 Node.js 和 npm 的版本号。例如：

node v18.16.0
npm 9.5.1

如果命令未找到，请检查 Node.js 的安装路径是否已正确添加到系统的环境变量中。如果未添加，需要手动添加，然后重启终端使环境变量生效。

1.2 安装 Truffle

Truffle 是一款功能强大的以太坊开发框架，为智能合约的开发、部署和测试提供了全面的工具集。它简化了合约的编译流程，允许开发者轻松将 Solidity 代码转换为可部署的字节码。同时，Truffle 提供了灵活的部署机制，支持将合约部署到不同的以太坊网络，包括本地测试网络和公共区块链。其内置的测试框架能够帮助开发者编写和执行自动化测试，确保合约的正确性和安全性，并提供代码调试工具，方便开发者定位和修复问题。尽管我们主要关注在 Avalanche 上的开发，Truffle 仍然是一个非常有价值的工具，并且可以无缝地与 Avalanche 网络集成。

通过以下 npm 命令，你可以全局安装 Truffle：

npm install -g truffle

此命令会将 Truffle 安装到你的全局环境中，以便你可以从任何目录访问 Truffle 命令。

安装完成后，通过运行以下命令来验证 Truffle 是否成功安装以及检查版本信息：

truffle version

该命令会显示已安装的 Truffle 版本以及其他相关组件的版本信息，如 Solidity 编译器 (solc) 和 Ganache CLI (如果已安装)。如果命令成功执行并显示版本信息，则表示 Truffle 已成功安装并可以开始使用。

1.3 安装 Ganache CLI (可选)

Ganache CLI 是一款轻量级的本地区块链模拟器，专门为以太坊及兼容链（包括 Avalanche）的智能合约开发、测试和调试而设计。它提供了一个快速、隔离的环境，允许开发者在无需连接到公共 Avalanche 测试网或主网的情况下，模拟区块链的行为。通过 Ganache CLI，你可以方便地部署合约、执行交易、检查状态，而无需担心真实的 Gas 费用或网络拥堵问题。

是否需要安装 Ganache CLI 取决于你的开发流程。如果你希望直接与 Avalanche Fuji 测试网或主网交互（例如使用 Avalanche Bridge 或部署最终产品），则无需安装 Ganache CLI。但对于快速原型设计、单元测试以及需要在受控环境中进行迭代的场景，Ganache CLI 非常有用。

使用 Node Package Manager (npm) 可以轻松安装 Ganache CLI。请确保你已经安装了 Node.js 和 npm。如果没有，请先安装它们。然后，在你的命令行或终端中执行以下命令来全局安装 Ganache CLI：

npm install -g ganache-cli

这条命令会将 Ganache CLI 安装到你的全局环境中，这意味着你可以在任何目录下通过命令行访问它。

安装完成后，为了验证 Ganache CLI 是否成功安装，以及确认安装的版本，可以在命令行中运行以下命令：

ganache-cli --version

如果安装成功，该命令会输出 Ganache CLI 的版本号。如果出现错误，请检查你的 Node.js 和 npm 是否安装正确，以及 npm 是否正确配置了全局模块的路径。

1.4 安装 MetaMask (可选)

MetaMask 是一个流行的浏览器插件钱包，作为用户与去中心化应用程序 (DApps) 和区块链网络交互的桥梁。 在 Avalanche 生态系统中，MetaMask 允许您安全地管理您的 AVAX 代币，以及与 Avalanche 网络上的各种协议进行交互。 由于 Avalanche 网络支持 EVM (以太坊虚拟机)，MetaMask 可以轻松配置为与 Avalanche 的 C-Chain (合约链) 兼容。 对于希望参与 Avalanche 测试网或主网的用户，安装 MetaMask 是一个必要的步骤， 它使您能够发送、接收 AVAX 代币，并与其他 DeFi 应用程序进行交互。

要开始使用 MetaMask，请访问 MetaMask 官方网站 (https://metamask.io/)。 务必从官方网站下载 MetaMask 插件，以避免潜在的安全风险。 MetaMask 支持多种浏览器，包括 Chrome, Firefox, Brave 和 Edge。 下载并安装与您使用的浏览器兼容的 MetaMask 插件后，按照 MetaMask 提供的逐步指南创建一个新的钱包。 在创建钱包的过程中，MetaMask 将生成一个由 12 或 24 个单词组成的助记词（也称为种子短语）。 **务必将您的助记词写在纸上并安全地存储在离线环境中。** 切勿将您的助记词以数字形式存储在您的计算机或移动设备上，也不要与任何人分享。 助记词是恢复您的 MetaMask 钱包的唯一方法，如果丢失，您将无法访问您的资金。 除了助记词，您还需要设置一个强密码来保护您的 MetaMask 钱包。 此密码用于解锁您的钱包，并授权交易。 完成钱包创建后，您需要配置 MetaMask 以连接到 Avalanche 网络。 您可以通过手动添加 Avalanche 网络的信息到 MetaMask 的自定义网络设置中，或者通过使用像 Chainlist 这样的网站自动添加。

2. 创建 Truffle 项目

搭建好 Solidity 智能合约的开发环境后，接下来需要创建一个新的 Truffle 项目。Truffle 是一个流行的以太坊开发框架，它提供了一套完整的工具，方便开发者进行合约编译、部署、测试和管理。

在命令行界面（例如 Terminal 或 Command Prompt）中，导航到你希望创建项目的目录。可以使用 cd 命令来改变当前目录。例如，要在名为 "myproject" 的目录下创建项目，可以执行 cd myproject 命令。然后，在该目录下执行以下命令，初始化一个新的 Truffle 项目：

truffle init

该命令会使用 Truffle 的默认模板，在当前目录下创建一个包含必要文件和目录的 Truffle 项目结构。初始化过程会自动下载并安装项目所需的基本依赖项。

Truffle 项目创建完成后，你会看到以下目录和文件：

• contracts/ : 这是一个用于存放 Solidity 智能合约源代码的目录。你所有的 .sol 文件都应该放在这里。Truffle 将会自动编译这个目录下的所有合约。
• migrations/ : 这个目录用于存放合约部署脚本。部署脚本使用 JavaScript 编写，描述了合约部署到区块链网络的步骤。每个部署脚本都应该以数字开头，以便 Truffle 按照顺序执行它们。
• test/ : 用于存放智能合约的测试用例。测试用例可以使用 JavaScript 或 Solidity 编写。使用 JavaScript 可以更灵活地进行测试，而使用 Solidity 可以直接在链上测试合约。
• truffle-config.js (或 truffle-config.ts ): 这是 Truffle 的配置文件。它包含了关于项目配置的信息，例如网络设置、编译器版本、合约目录和部署选项。你需要根据你的需求修改这个文件。例如，你需要配置连接到 Ganache 或其他以太坊测试网络的参数。

3. 编写智能合约

在 contracts/ 目录下创建一个新的 Solidity 文件，建议以 .sol 作为文件扩展名，例如 MyContract.sol 。Solidity 是一种专门为以太坊虚拟机（EVM）设计的智能合约编程语言。在此文件中，你将编写智能合约的具体代码，定义合约的状态变量、函数以及事件。

以下是一个简单的示例合约，它展示了如何声明状态变量、构造函数以及修改和读取状态变量的函数：

solidity pragma solidity ^0.8.0;

contract MyContract { string public message;

constructor(string memory _message) {
     message = _message;
}

function setMessage(string memory _newMessage) public {
    message = _newMessage;
}

function getMessage() public view returns (string memory) {
    return message;
}

}

这个合约包含一个名为 message 的字符串状态变量，它的访问修饰符是 public ，这意味着它可以从合约外部直接访问。构造函数 constructor(string memory _message) 在合约部署时被调用一次，用于初始化 message 的值。 setMessage 函数允许用户修改 message 的值，它接收一个字符串作为输入，并将其设置为新的 message 。 getMessage 函数用于检索当前的 message 值，它是一个 view 函数，这意味着它不会修改合约的状态，因此不需要消耗 Gas。

4. 配置 Truffle

配置 truffle-config.js 文件至关重要，以便与 Avalanche 网络进行交互。 此配置文件定义了 Truffle 如何连接到不同的区块链网络，以及如何编译和部署智能合约。

必须安装 @truffle/hdwallet-provider 。 这是一个关键的依赖项，它允许 Truffle 使用 HD 钱包（分层确定性钱包）的助记词安全地连接到 Avalanche 网络。 HD 钱包提供了一种从单个种子短语（助记词）生成多个密钥对的方法，增强了安全性和便利性。

bash
npm install @truffle/hdwallet-provider

接下来，需要修改 truffle-config.js 文件，添加 Avalanche 网络的相关配置。 其中，必须替换占位符 YOUR_MNEMONIC 和 YOUR_AVALANCHE_RPC_URL 为实际的助记词和 Avalanche RPC URL。 助记词是用于控制 Avalanche 地址的私钥，而 Avalanche RPC URL 是 Avalanche 网络节点的 HTTP(S) 地址，Truffle 将通过此地址与区块链交互。

javascript const HDWalletProvider = require('@truffle/hdwallet-provider'); module.exports = { networks: { development: { host: "127.0.0.1", port: 8545, network_id: "*" // Match any network id }, avalanche: { provider: () => new HDWalletProvider( "YOUR_MNEMONIC", "YOUR_AVALANCHE_RPC_URL" ), network_id: "*", // Avalanche network id gas: 8000000, // Gas limit gasPrice: 225000000000 // Gas price } }, compilers: { solc: { version: "0.8.0", // Fetch exact version from solc-bin (default: truffle's version) // docker: true, // Use "0.5.1" you've installed locally with docker (default: false) settings: { // See the solidity docs for advice about optimization and evmVersion optimizer: { enabled: false, runs: 200 }, // evmVersion: "byzantium" } } } };

Avalanche RPC URL 可以从多种提供商处获取，如欧易（OKX）等交易所，以及 Chainstack 和 Ankr 等区块链基础设施服务提供商。 这些提供商提供对 Avalanche 网络的可靠访问，使开发者能够部署和测试其智能合约。

5. 编译智能合约

在命令行界面中，导航至您的 Truffle 项目根目录。 确保您已正确安装 Truffle 及其依赖项，并已初始化一个新的 Truffle 项目。 接下来，执行以下命令来编译您的 Solidity 智能合约：

truffle compile

此命令会指示 Truffle 编译器处理项目中的所有 .sol 文件。 如果合约编译成功，Truffle 将在 build/contracts/ 目录下生成 JSON 文件，每个合约对应一个文件。 这些 JSON 文件包含了合约的 ABI (Application Binary Interface，应用程序二进制接口) 和 bytecode (字节码)。 ABI 描述了合约的函数及其参数，允许外部应用程序（如 JavaScript 前端）与合约进行交互。 bytecode 是合约的编译后的机器码，将被部署到区块链上执行。

在编译过程中，Truffle 可能会报告警告或错误。 警告通常指示潜在的问题，例如未使用的变量或潜在的安全漏洞。 错误则指示编译失败，通常需要检查合约中的语法错误或类型不匹配。 确保仔细阅读编译器的输出，并修复任何报告的问题，以确保您的合约能够正确部署和执行。

6. 部署合约

为了将智能合约部署到区块链上，需要创建一个部署脚本。 在 Truffle 项目的 migrations/ 目录下，新建一个 JavaScript 文件，文件命名通常以数字开头，例如 1_deploy_my_contract.js ，以便 Truffle 按照顺序执行这些脚本。该文件负责编写合约部署的逻辑。

示例代码如下，该代码使用 Truffle 的部署器 (deployer) 来部署 MyContract 合约:

const MyContract = artifacts.require("MyContract");

module.exports = function (deployer) {
  // 部署 MyContract 合约，并传递构造函数参数 "Hello, Avalanche!"
  deployer.deploy(MyContract, "Hello, Avalanche!");
};

这段脚本首先使用 artifacts.require() 方法加载合约的抽象，该抽象包含了合约的 ABI (Application Binary Interface) 和字节码。然后，通过 deployer.deploy() 函数将合约部署到区块链。 在此示例中，构造函数接收一个字符串参数 "Hello, Avalanche!" ，该参数将在合约部署时传递。

准备好部署脚本后，使用以下命令将合约部署到 Avalanche 网络：

truffle migrate --network avalanche

truffle migrate 命令会执行 migrations/ 目录下的所有部署脚本。 --network avalanche 选项指定了部署的目标网络为 Avalanche。 确保 Truffle 配置文件 ( truffle-config.js ) 中已正确配置了 Avalanche 网络的参数，包括网络 ID、节点 URL 和私钥。

合约部署完成后，Truffle 会在控制台中显示部署交易的哈希值和合约地址。 你可以使用这些信息在 Avalanche 区块链浏览器 (例如欧易区块链浏览器或其他 Avalanche 区块链浏览器) 上查看合约的部署详情，例如交易状态、Gas 消耗和合约的存储内容。 通过区块链浏览器，可以验证合约是否成功部署以及构造函数参数是否正确设置。

7. 测试合约

为了确保智能合约的功能符合预期，并且能够正确地在Avalanche网络上运行，编写和执行测试用例至关重要。在Truffle项目中， test/ 目录下用于存放这些测试文件。通常，我们会创建一个新的 JavaScript 文件，例如 my_contract.test.js ，并在其中编写针对合约的各种测试用例。

以下是一个示例，展示了如何使用 JavaScript 和 Truffle 框架来测试一个名为 MyContract 的智能合约。

javascript const MyContract = artifacts.require("MyContract");

contract("MyContract", (accounts) => { // 测试用例 1：验证合约部署时是否正确设置了初始消息 it("should set the message correctly", async () => { // 获取已部署的 MyContract 实例 const myContract = await MyContract.deployed(); // 调用 getMessage() 函数来获取存储的消息 const message = await myContract.getMessage(); // 使用断言来验证消息是否与预期值相等 assert.equal(message, "Hello, Avalanche!", "The message should be 'Hello, Avalanche!'"); });

// 测试用例 2：验证 setMessage() 函数是否能够正确更新消息 it("should update the message correctly", async () => { // 获取已部署的 MyContract 实例 const myContract = await MyContract.deployed(); // 调用 setMessage() 函数来更新消息 await myContract.setMessage("Goodbye, Avalanche!"); // 再次调用 getMessage() 函数来获取更新后的消息 const newMessage = await myContract.getMessage(); // 使用断言来验证更新后的消息是否与预期值相等 assert.equal(newMessage, "Goodbye, Avalanche!", "The message should be 'Goodbye, Avalanche!'"); }); });

上述测试用例包含了两个关键的测试函数：

• 第一个测试函数旨在验证合约在部署时是否正确地设置了初始的 message 变量。它会部署合约，然后调用 getMessage() 函数来检索消息，并使用断言来确保消息的内容与预期值 "Hello, Avalanche!" 相符。
• 第二个测试函数旨在验证 setMessage() 函数是否能够正确地更新 message 的值。它会部署合约，然后调用 setMessage() 函数来将消息更新为 "Goodbye, Avalanche!"。接下来，它会调用 getMessage() 函数来检索更新后的消息，并使用断言来确保消息的内容与预期值相符。

为了运行这些测试用例，你需要使用 Truffle 命令行工具，并指定 Avalanche 网络。

在命令行中，执行以下命令来运行测试用例：

bash truffle test --network avalanche

--network avalanche 标志告诉 Truffle 使用 truffle-config.js 文件中定义的 Avalanche 网络配置来运行测试。确保你的 Avalanche 网络节点正在运行并且配置正确。

如果所有测试用例都顺利通过，那么这意味着你的智能合约已经成功地部署到了 Avalanche 网络，并且其核心功能经过验证可以按照预期的方式运行。如果任何测试用例失败，你需要仔细检查你的合约代码和测试用例，找出问题并进行修复，直到所有测试用例都通过为止。通过充分的测试，可以最大限度地减少合约中的潜在漏洞和错误，从而确保智能合约的安全性和可靠性。

8. 与合约交互

部署到 Avalanche 网络上的智能合约可以通过多种方式进行交互，常用的包括 Truffle Console、Remix IDE，以及使用 Web3.js 或 Ethers.js 等库构建的自定义应用程序。选择合适的工具取决于开发者的需求和偏好。

例如，Truffle Console 提供了一个便捷的交互式环境，可以快速与部署的合约进行交互，发送交易和调用合约函数。使用以下命令启动针对 Avalanche 网络的 Truffle Console：

truffle console --network avalanche

在 Truffle Console 中，你需要获取已部署合约的实例。以下 JavaScript 代码展示了如何获取名为 MyContract 的合约实例，并将其存储在 contractInstance 变量中：

MyContract.deployed().then(instance => {
  contractInstance = instance;
});

获取合约实例后，就可以调用合约的函数了。以下示例展示了如何调用合约的 getMessage 函数，并通过 console.log 将返回值打印到控制台：

contractInstance.getMessage().then(message => {
  console.log(message);
});

此操作将执行 getMessage 函数，并输出合约中存储的 message 变量的当前值。需要注意的是，如果 getMessage 函数需要支付 gas 费用，则需要配置相应的账户和 gas 限制。

除了读取合约状态，还可以调用合约的写入函数来修改链上数据。调用写入函数通常需要发送交易，因此需要一个有效的签名账户，并且需要支付 gas 费用。在 Truffle Console 中，可以使用 accounts 变量访问可用的账户，并使用 from 选项指定发送交易的账户。

还可以使用 Remix IDE 连接到 Avalanche 网络，并与部署的合约进行交互。Remix IDE 提供了一个图形化的界面，可以方便地浏览合约的 ABI，并生成相应的函数调用界面。对于更复杂的应用程序，可以使用 Web3.js 或 Ethers.js 等库，通过编程方式与合约进行交互。

通过本文，你应该了解了如何使用欧易进行 AVAX 合约开发。 包括环境搭建、合约编写、编译、部署和测试。 希望本文能帮助你在 Avalanche 上开发出优秀的智能合约应用。