BSC智能合约开发：新手入门指南，一文搞定！

Bitfinex 智能链 (BSC) 开发指南

简介

Bitfinex 智能链（BSC，这里指与币安智能链兼容的链，而非特指 Bitfinex 官方链）提供了一个与以太坊虚拟机（EVM）兼容的环境，极大地降低了开发者迁移和部署现有以太坊智能合约的门槛。这种兼容性意味着开发者可以复用熟悉的 Solidity 编程语言，以及 Truffle、Hardhat、Remix 等以太坊开发工具和基础设施。BSC 采用权益证明（PoS）共识机制的变体，相比以太坊的工作量证明（PoW）机制，提供了更快的交易确认速度和更低的交易费用，更适合高频交易和去中心化应用（DApp）的普及。本指南旨在帮助开发者快速入门 BSC 上的智能合约开发，涵盖环境搭建、合约编写、部署与测试等关键步骤，助力开发者充分利用 BSC 的优势。

前提条件

在开始之前，请确保您的开发环境已配置妥当，并已安装以下关键工具，它们是构建和部署基于币安智能链 (BSC) 的智能合约的必要组件：

• Node.js 和 npm (或 Yarn)： Node.js 是一个 JavaScript 运行时环境，允许您在服务器端运行 JavaScript 代码。npm (Node Package Manager) 是 Node.js 的默认包管理器，而 Yarn 是一个替代的包管理器，它们都用于安装和管理项目依赖的 JavaScript 包和库。您需要 Node.js 来运行 Truffle 或 Hardhat 等开发工具，以及安装 Web3.js 或 ethers.js 等库，以便与区块链进行交互。建议安装最新稳定版本的 Node.js 和 npm (或 Yarn)。
• Truffle 或 Hardhat： 这两个是以太坊开发框架，提供了一整套工具和环境，用于简化智能合约的开发、编译、部署和测试流程。Truffle 和 Hardhat 都支持 Solidity 智能合约语言，并提供了命令行界面和配置文件，方便您管理项目、定义网络配置、以及执行自动化测试。您可以根据个人偏好选择其中一个框架。Truffle 以其成熟的生态系统和丰富的插件而闻名，而 Hardhat 则以其速度、灵活性和内置的调试工具而著称。
• MetaMask 或类似 Web3 钱包： MetaMask 是一个浏览器扩展，充当了您与 BSC 网络之间的桥梁。它允许您安全地管理您的以太坊地址和私钥，并授权交易和与去中心化应用 (DApps) 进行交互。除了 MetaMask，还有其他类似的 Web3 钱包，例如 Trust Wallet、Coinbase Wallet 等。重要的是，您选择的钱包需要支持连接到 BSC 网络。您需要在钱包中配置 BSC 的网络参数，以便与 BSC 网络进行交互，例如 RPC URL、Chain ID 和 Currency Symbol。

配置开发环境

1. 设置开发环境

为你的智能合约开发创建一个独立的项目目录，并使用 npm (Node Package Manager) 初始化一个新的 Node.js 项目。这将帮助你管理项目依赖和脚本。

操作步骤：

1. 创建项目目录: 使用 mkdir 命令创建一个新的目录，作为你项目的根目录。例如，我们将目录命名为 bsc-dev 。
2. 进入项目目录: 使用 cd 命令进入刚刚创建的目录。这是你所有项目文件存放的地方。
3. 初始化 npm 项目: 使用 npm init -y 命令初始化一个新的 npm 项目。 -y 标志表示使用默认配置，这会创建一个 package. 文件，其中包含项目的元数据和依赖信息。你也可以省略 -y 标志，然后按照提示逐步配置项目。

代码示例：

mkdir bsc-dev
cd bsc-dev
npm init -y

代码解释：

• mkdir bsc-dev : 创建名为 bsc-dev 的新目录。
• cd bsc-dev : 将当前工作目录更改为 bsc-dev 。
• npm init -y : 使用默认配置初始化一个新的 npm 项目，并在 bsc-dev 目录中生成一个 package. 文件。

package. 文件在项目的开发过程中扮演着重要角色，它记录了项目名称、版本、描述、入口文件、作者、许可证，以及最重要的：项目依赖。后续安装的库和框架都将记录在此文件中，方便项目管理和部署。

2. 安装 Hardhat

Hardhat 是一个备受欢迎的以太坊集成开发环境（IDE），它简化了智能合约的开发、测试和部署流程。 Hardhat 提供了一套强大的工具，包括本地开发网络、合约编译、测试框架和部署脚本，从而显著提升开发效率。

使用 npm（Node Package Manager）全局安装 Hardhat 作为开发依赖：

npm install --save-dev hardhat
npx hardhat

执行 npx hardhat 命令将初始化 Hardhat 项目。在项目初始化过程中，选择 "Create a basic sample project" 选项。 Hardhat 将自动生成一个基础项目结构，包含一个示例的智能合约（通常是 Greeter.sol ）、相应的测试脚本（位于 /test 目录下）和部署脚本（位于 /scripts 目录下）。 这些示例文件可以帮助你快速了解 Hardhat 的基本用法和开发流程。

项目的标准目录结构通常包括：

• contracts/ : 存放 Solidity 智能合约源代码。
• scripts/ : 包含用于部署智能合约的 JavaScript 脚本。
• test/ : 存放用于测试智能合约的 JavaScript 测试脚本。
• hardhat.config.js : Hardhat 配置文件，用于配置编译器版本、网络设置和插件等。

3. 安装 Hardhat 相关插件

为了更高效地与币安智能链（BSC）集成，并增强开发体验，需要安装以下 Hardhat 插件及相关依赖：

npm install --save-dev @nomiclabs/hardhat-ethers ethers @nomiclabs/hardhat-waffle chai ethereum-waffle
npm install --save-dev dotenv

• @nomiclabs/hardhat-ethers : 这是一个 Hardhat 插件，它集成了 ethers.js 库。ethers.js 是一个强大且全面的 JavaScript 库，简化了与以太坊区块链及其兼容链（如 BSC）的交互。通过此插件，你可以在 Hardhat 环境中使用 ethers.js 的所有功能，例如签署交易、部署合约、调用合约函数等。它提供了类型安全的接口，降低了出错的风险。
• ethers : 即 ethers.js 库本身。虽然 @nomiclabs/hardhat-ethers 提供了 Hardhat 的集成，但你仍然需要安装 ethers.js 库。 它提供了一组完整的工具，用于创建钱包、签署交易、与合约交互以及监听区块链事件。
• @nomiclabs/hardhat-waffle : 此插件将 Waffle 测试框架集成到 Hardhat 环境中。Waffle 是一个专为以太坊智能合约设计的测试框架，它提供了一组有用的匹配器和工具，用于编写简洁且易于理解的测试用例。 它使得智能合约的单元测试变得更加容易。
• chai : Chai 是一个流行的 JavaScript 断言库，用于编写单元测试。 它可以与 Waffle 和其他测试框架配合使用，以验证智能合约的行为是否符合预期。Chai 提供了多种断言风格，例如 `expect`、`should` 和 `assert`，允许你选择最适合你的偏好。
• ethereum-waffle : ethereum-waffle 提供了一个专门为以太坊测试定制的 Waffle 提供者。 它扩展了 Waffle 的功能，使其更易于测试智能合约。 它简化了测试设置和清理过程，并提供了一些有用的辅助函数，例如用于模拟交易和部署合约。
• dotenv : dotenv 是一个用于将环境变量从 `.env` 文件加载到 `process.env` 中的零依赖模块。 这对于保护敏感信息（如私钥和 API 密钥）免受源代码泄露至关重要。通过使用 dotenv，你可以将这些信息存储在 `.env` 文件中，并将其排除在版本控制之外。

4. 配置 Hardhat 网络

编辑 hardhat.config.js 文件，以便 Hardhat 能够与 Binance Smart Chain (BSC) 进行交互。 此步骤至关重要，因为它定义了 Hardhat 如何连接到 BSC 网络，并允许你部署和测试智能合约。你需要添加 BSC 测试网和主网的网络配置。 获取这些网络配置信息，需要 BSC 的 RPC URL 和 Chain ID。 你可以选择使用 BSC 的官方节点，或利用第三方提供的公共 RPC 服务，例如 Ankr、QuickNode 或 Alchemy，它们提供了稳定且高性能的节点服务。 不同 RPC 提供商可能会提供不同的服务等级和费用，请根据你的需求选择。

为了配置网络，你需要安装必要的 Hardhat 插件，并加载环境变量。确保已经安装了 @nomiclabs/hardhat-waffle 插件，它提供了用于编写和运行以太坊智能合约测试的工具。同时，使用 dotenv 包来安全地管理你的私钥和 API 密钥。

require("@nomiclabs/hardhat-waffle");
require('dotenv').config()

接下来，定义一个变量来存储你的私钥。 务必注意：永远不要将私钥直接硬编码到代码中！ 应该从环境变量中读取私钥，并确保你的 .env 文件被正确地添加到 .gitignore 文件中，以防止泄露敏感信息。

const privateKey = process.env.PRIVATE_KEY || "0000000000000000000000000000000000000000000000000000000000000001";  // 替换为你的私钥

然后，在 module.exports 对象中配置你的网络。 此配置包括指定 Solidity 编译器的版本，以及定义不同的网络（例如，BSC 测试网和主网）及其相应的参数。

module.exports = {
    solidity: "0.8.4",
   networks: {
     bscTestnet: {
        url: "https://data-seed-prebsc-1-s1.binance.org:8545", // 替换为 BSC 测试网 RPC URL
         chainId: 97,  // BSC 测试网 Chain ID
        gasPrice: 20000000000,
         accounts: [privateKey]
    },
     bscMainnet: {
         url: "https://bsc-dataseed.binance.org/",  //  替换为 BSC 主网 RPC URL
      chainId: 56, //  BSC 主网 Chain ID
       gasPrice: 5000000000,
      accounts: [privateKey]
       }
   }
};

• 安全注意事项： 请务必将 PRIVATE_KEY 环境变量设置为你的钱包私钥。 永远不要将私钥硬编码到代码中！ 使用 .env 文件存储私钥，并确保将 .env 文件添加到 .gitignore 文件中，以避免将私钥上传到代码仓库，造成安全风险。
• 网络配置： 根据你的需求，灵活地添加或修改 bscTestnet 和 bscMainnet 的配置。 可以根据实际情况调整 url 、 chainId 和 gasPrice 等参数。
• Gas 价格： 注意 gasPrice 的设置， gasPrice 以 wei 为单位。 合理设置 Gas 价格，能够确保交易能够被快速确认。 过低的 Gas 价格可能导致交易长时间pending甚至失败，而过高的 Gas 价格则会增加交易成本。 你可以参考当前 BSC 网络的 Gas 价格，并根据交易的紧急程度进行调整。 一些工具如 GasNow 可以帮助你估计合适的 Gas 价格。

编写智能合约

在您的 Hardhat 项目的 contracts 目录下，创建一个新的智能合约文件。为了更好地组织和管理您的项目，您可以选择一个有意义的文件名，例如 MyToken.sol 。该文件将包含定义您的 ERC20 代币行为的 Solidity 代码。

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

import "@openzeppelin/contracts/token/ERC20/ERC20.sol";

contract MyToken is ERC20 {
    constructor(string memory name, string memory symbol) ERC20(name, symbol) {
        _mint(msg.sender, 1000000 * 10 ** decimals());
    }
}
    

上述 Solidity 代码定义了一个名为 MyToken 的智能合约，它继承了 OpenZeppelin 提供的 ERC20 标准合约。 ERC20 合约提供了一套预定义的函数和事件，用于处理代币的创建、转移和余额查询。构造函数接收代币的名称和符号作为参数，并调用父合约 ERC20 的构造函数进行初始化。随后，它调用 _mint 函数，向部署合约的账户（ msg.sender ）铸造 100 万个代币。 decimals() 函数返回代币的小数位数，通常为 18，用于确保代币的总量精度。

为了使您的智能合约能够正常工作，您需要安装 OpenZeppelin 提供的 ERC20 合约库。OpenZeppelin 提供了一系列安全可靠的智能合约，可以帮助您快速构建符合行业标准的 DApp。

npm install @openzeppelin/contracts
    

这条命令使用 npm（Node Package Manager）来安装 OpenZeppelin 的 contracts 包。这将下载并将 ERC20 合约和其他相关合约安装到您的项目的 node_modules 目录下。安装完成后，您就可以在您的智能合约中使用 import 语句导入 OpenZeppelin 的合约，例如 import "@openzeppelin/contracts/token/ERC20/ERC20.sol"; 。

编译智能合约

使用 Hardhat 编译你的智能合约，这是开发流程中的关键一步，它将人类可读的Solidity代码转换为以太坊虚拟机（EVM）可以执行的字节码。

执行以下命令来启动编译过程：

npx hardhat compile

这条命令会指示 Hardhat 查找项目中的Solidity合约文件（通常位于 contracts 目录下），并使用配置的Solidity编译器版本（可以在 hardhat.config.js 中指定）将其编译成EVM字节码。 npx 确保你使用的是本地安装的 Hardhat 版本，避免了全局版本冲突的问题。

如果编译过程中出现错误，Hardhat 将会提供详细的错误信息，帮助你定位和解决问题，例如语法错误、类型不匹配或者使用了不兼容的Solidity版本等。仔细阅读错误信息，并参考Solidity官方文档，可以有效地解决大部分编译问题。

成功编译后，Hardhat 将会在 artifacts 目录下生成合约的 ABI (Application Binary Interface) 和 bytecode 文件。ABI 是一个JSON格式的文件，描述了合约的接口，包括函数名称、参数类型和返回值类型等。bytecode 则是合约的EVM字节码，它是实际部署到以太坊区块链上的代码。这两个文件对于后续的合约部署、交互和验证至关重要。

更具体地说，在 artifacts 目录下，你会找到一个以合约名称命名的子目录，其中包含一个 . 文件。这个 . 文件包含了合约的ABI、bytecode，以及其他元数据，例如编译器的版本信息。开发者可以使用这些信息来在DApp中与已部署的智能合约进行交互，例如使用web3.js或ethers.js等库。

部署智能合约

编辑 scripts/deploy.js 文件，修改部署脚本以适应你的合约。 部署脚本是使用编程方式与智能合约交互的关键，它允许你在区块链上自动执行合约的创建和初始化过程。你需要仔细检查并调整脚本中的参数，以确保其与你合约的逻辑和预期行为完全一致。

scripts/deploy.js 范例代码：

javascript

async function main() {
  const [deployer] = await ethers.getSigners();

  console.log(
    "Deploying contracts with the account:",
    deployer.address
  );

  console.log("Account balance:", (await deployer.getBalance()).toString());

  const MyToken = await ethers.getContractFactory("MyToken");
  const myToken = await MyToken.deploy("MyToken", "MTK");

  await myToken.deployed();

  console.log("MyToken address:", myToken.address);
}

main()
  .then(() => process.exit(0))
  .catch((error) => {
    console.error(error);
    process.exit(1);
  });

代码解释：

• ethers.getSigners() ：获取用于部署合约的账户。通常，第一个账户被用作部署者。
• deployer.address ：打印部署者的地址，用于验证部署操作的来源。
• deployer.getBalance() ：检查部署账户的余额，确保有足够的资金支付 gas 费用。
• ethers.getContractFactory("MyToken") ：获取合约 "MyToken" 的工厂实例，用于创建合约实例。
• MyToken.deploy("MyToken", "MTK") ：使用构造函数参数部署合约。在本例中，合约名称为 "MyToken"，符号为 "MTK"。 确保这些参数与你的合约构造函数匹配。
• myToken.deployed() ：等待合约部署完成。
• myToken.address ：打印已部署合约的地址，这是与合约交互的唯一标识符。
• 异常处理：通过 .catch() 捕获部署过程中可能发生的错误，并打印错误信息。

• 确保合约名称（例如： "MyToken" ）和构造函数参数（例如： "MyToken", "MTK" ）与你的合约定义完全匹配。如果不匹配，部署将失败或导致不可预测的行为。

使用 Hardhat 部署你的智能合约到 BSC 测试网（例如： bscTestnet ）或主网（例如： bscMainnet ）：

bash

npx hardhat run scripts/deploy.js --network bscTestnet

或者

bash

npx hardhat run scripts/deploy.js --network bscMainnet

• --network bscTestnet 或 --network bscMainnet 标志指定了要将合约部署到的网络。 请确保已在 hardhat.config.js 文件中正确配置了这些网络，包括 RPC URL 和私钥。
• 在部署之前，务必仔细检查你的钱包中是否有足够的 BNB 来支付 gas 费用。 Gas 费用根据网络的拥塞程度而变化。 你可以使用像 BSCScan 这样的区块链浏览器来估算当前的 gas 价格。
• 成功部署后，合约地址将会打印在控制台上。 保存好这个地址，因为它将用于与你的智能合约进行交互，例如调用函数、查询状态等。 验证合约地址是确保部署成功的关键步骤。

与智能合约交互

与部署在币安智能链（BSC）上的智能合约进行交互，主要依赖于Web3钱包，如 MetaMask。 MetaMask 作为浏览器扩展，允许用户安全地管理其以太坊地址及其私钥，并与去中心化应用（DApps）进行交互。要开始交互，首先需要将 MetaMask 连接到相应的 BSC 网络，这可以是测试网络（如 BSC Testnet）或主网络（BSC Mainnet）。连接后，导入部署智能合约时使用的账户，确保该账户拥有足够的 BNB 用于支付 Gas 费用，执行合约函数。

除了使用Web3钱包，Hardhat 提供了一个强大的控制台工具，方便开发者直接与智能合约交互。通过以下命令启动 Hardhat 控制台，并指定要连接的网络：

bash
npx hardhat console --network bscTestnet

在 Hardhat 控制台中，可以利用 ethers 库来获取已部署合约的实例，并调用其公开的函数。 ethers 库是 JavaScript 中用于与以太坊区块链交互的常用库，它提供了丰富的功能，包括合约交互、交易签名、事件监听等。

javascript
const MyToken = await ethers.getContractFactory("MyToken");
const myToken = await MyToken.attach("YOUR_CONTRACT_ADDRESS"); // 替换为你的合约地址

上述代码首先使用 ethers.getContractFactory 方法获取名为 "MyToken" 的合约工厂。合约工厂是一个抽象概念，它包含了合约的 ABI (Application Binary Interface) 和 bytecode，用于创建和部署合约实例。 然后，使用 attach 方法将合约工厂与已部署的合约地址关联起来，从而获得一个合约实例 myToken 。 务必将 YOUR_CONTRACT_ADDRESS 替换为实际的已部署合约地址。

javascript
const balance = await myToken.balanceOf("YOUR_ACCOUNT_ADDRESS"); // 替换为你的账户地址
console.log("Balance:", balance.toString());

这段代码展示了如何调用合约的 balanceOf 函数来查询指定账户的代币余额。将 YOUR_ACCOUNT_ADDRESS 替换为要查询余额的账户地址。 balanceOf 函数通常接受一个地址作为参数，并返回该地址所拥有的代币数量。由于 Solidity 中的数值类型是 uint256 ，为了方便在 JavaScript 中处理，需要使用 toString() 方法将返回的余额转换为字符串格式。

测试智能合约

编辑 test/sample-test.js 文件，该文件位于项目的测试目录下。通过编写单元测试，你可以系统地验证智能合约的各项功能是否符合预期，确保其在部署后的行为正确无误。单元测试是软件开发中的重要环节，对于智能合约而言，它能帮助你及早发现潜在的漏洞和错误，降低安全风险。

在测试文件中，你需要引入必要的库和模块，例如 chai 用于断言， hardhat 提供的 ethers 对象用于与以太坊网络交互。

javascript const { expect } = require("chai"); const { ethers } = require("hardhat");

使用 describe 函数定义一个测试套件，它将一组相关的测试用例组织在一起。在本例中，测试套件的名称为 "MyToken"，对应于你正在测试的智能合约名称。

describe("MyToken", function () { it("Should return the right name and symbol", async function () { // 获取合约工厂 const MyToken = await ethers.getContractFactory("MyToken"); // 部署合约 const myToken = await MyToken.deploy("MyToken", "MTK"); // 等待合约部署完成 await myToken.deployed();

// 使用断言验证合约的名称和符号
expect(await myToken.name()).to.equal("MyToken");
expect(await myToken.symbol()).to.equal("MTK");

});

使用 it 函数定义一个测试用例，它用于验证合约的特定功能。在本例中，第一个测试用例验证合约是否能正确返回其名称和符号。第二个测试用例验证合约是否能够将初始代币分配给合约所有者。

it("Should mint tokens to the owner", async function () { // 获取部署者/所有者账户 const [owner] = await ethers.getSigners(); // 获取合约工厂 const MyToken = await ethers.getContractFactory("MyToken"); // 部署合约 const myToken = await MyToken.deploy("MyToken", "MTK"); // 等待合约部署完成 await myToken.deployed();

// 使用断言验证所有者的余额是否等于初始代币数量（1000000 * 10 ** 18，其中 10 ** 18 表示 18 位小数）
expect(await  myToken.balanceOf(owner.address)).to.equal(1000000 * 10 ** 18);

}); });

编写完测试用例后，你可以使用以下命令来运行测试。Hardhat 将会自动编译你的合约，部署到本地的 Hardhat 网络，并执行你编写的测试用例。

运行测试：

bash npx hardhat test

验证智能合约

在 BSCScan 上验证你的智能合约至关重要，它能显著提高项目的透明度和社区信任度。经过验证的智能合约允许用户直接在区块链浏览器上查看合约的源代码，确保代码的真实性和功能性。

1. 注册 BSCScan 账户： 访问 BSCScan 网站并创建一个账户。拥有账户是获取 API 密钥的前提。
2. 获取 API 密钥： 登录 BSCScan 账户，在个人资料设置或 API 密钥管理页面生成一个新的 API 密钥。该密钥用于授权 Hardhat 插件与 BSCScan 的交互，以便验证你的智能合约。

3. 安装 Hardhat Etherscan 插件： 使用 npm 安装 @nomiclabs/hardhat-etherscan 插件。该插件简化了智能合约验证过程，允许你直接从 Hardhat 环境中与 BSCScan 交互。

   bash npm install --save-dev @nomiclabs/hardhat-etherscan

4. 配置 Hardhat 插件： 在你的 hardhat.config.js 文件中配置 etherscan 选项。将你的 BSCScan API 密钥添加到 apiKey 字段中。确保替换 YOUR_BSCSCAN_API_KEY 为你实际的 API 密钥。

   javascript require("@nomiclabs/hardhat-etherscan"); module.exports = { // ... 其他配置 etherscan: { apiKey: "YOUR_BSCSCAN_API_KEY" // 替换为你的 BSCScan API 密钥 } };

5. 运行验证命令： 使用 Hardhat 验证命令将你的智能合约提交到 BSCScan 进行验证。你需要提供已部署合约的地址，以及合约构造函数的参数（如果需要）。 确保替换 DEPLOYED_CONTRACT_ADDRESS 为你已部署的合约地址, 并根据你的合约构造函数调整参数。

   bash npx hardhat verify --network bscTestnet DEPLOYED_CONTRACT_ADDRESS "MyToken" "MTK" // 替换为你的合约地址和构造函数参数

   注意：

   • --network bscTestnet 参数指定了你要验证合约的网络。 将其更改为 bscMainnet 以验证主网上的合约。
   • 如果你的合约没有构造函数，则可以省略构造函数参数。
   • 如果构造函数需要多个参数，请按照它们在合约中定义的顺序提供它们，用空格分隔。

成功验证后，你的智能合约代码将在 BSCScan 上公开可用。用户可以查看合约的源代码、ABI 和其他相关信息。 这有助于建立信任，并允许审计人员和安全研究人员评估合约的安全性。

通过本指南，您已经了解了如何在 BSC 上设置开发环境、编写、编译、部署、测试和验证智能合约。 您可以利用这些知识构建更复杂的去中心化应用程序。