5步搞定！狗狗币BSC链开发教程：从入门到精通
欧易狗狗币BSC链开发实战
环境准备
在开始狗狗币BSC链上的开发之前，充分的环境准备至关重要。以下步骤将引导你配置所有必要的工具和资源，确保开发流程的顺利进行。
- Node.js 和 npm (或 yarn)： 用于运行 JavaScript 代码和管理项目依赖。Node.js 是一个基于 Chrome V8 引擎的 JavaScript 运行环境，而 npm (Node Package Manager) 是 Node.js 的默认包管理器，用于安装、更新和管理项目依赖。Yarn 是另一个流行的包管理器，提供了更快的速度和更可靠的依赖管理。建议安装最新稳定版本的 Node.js，npm 通常会随 Node.js 一起安装。你可以访问 Node.js 官网 (https://nodejs.org/) 下载并安装。安装完成后，使用 `node -v` 和 `npm -v` 命令验证安装是否成功。
-
Truffle 或 Hardhat：
这是一个以太坊开发框架，可以简化智能合约的开发、编译、测试和部署。Truffle 和 Hardhat 都是流行的以太坊开发框架，但 Hardhat 具有更现代化的设计和更强大的功能，例如内置的 Solidity 覆盖率工具和更灵活的插件系统。本文将以 Hardhat 为例，因为它提供了更便捷的开发体验。
安装 Hardhat：
打开你的终端或命令提示符，运行以下命令全局安装 Hardhat：
npm install -g hardhat安装完成后，使用 `hardhat --version` 命令验证安装是否成功。
- MetaMask 或其他 Web3 钱包： 用于与 BSC 链进行交互，包括发送交易、查看余额、部署智能合约以及与 DApp (去中心化应用程序) 进行交互。MetaMask 是一个浏览器扩展，允许你安全地管理你的以太坊账户并与 Web3 应用程序进行交互。除了 MetaMask，还有其他 Web3 钱包，如 Trust Wallet 和 Binance Chain Wallet。确保已安装 MetaMask 或其他 Web3 钱包，并配置好 Binance Smart Chain 测试网络。你需要添加 BSC 测试网络的网络信息到你的钱包中，包括网络名称、RPC URL、链 ID 和符号。这些信息可以在 Chainlist (https://chainlist.org/) 上找到，或者使用官方提供的 RPC URL。
-
BSC 测试网 RPC URL：
Hardhat 需要一个 RPC URL 来连接到 BSC 测试网。RPC URL 是一个 HTTP(S) 端点，允许你通过 JSON-RPC 与区块链网络进行通信。Chainlist (https://chainlist.org/) 是一个方便的网站，可以找到各种区块链网络的 RPC URL，包括 BSC 测试网。你也可以使用 Binance 官方提供的测试网 RPC URL。一些常用的 BSC 测试网 RPC URL 包括：
- https://data-seed-prebsc-testnet.binance.org:8545
- https://bsc-testnet.nodereal.io/v1/{YOUR_API_KEY} (需要注册 Nodereal 账户)
- 测试网 BNB： 在 BSC 测试网上进行交易需要 BNB 作为 Gas Fee。Gas Fee 是执行交易所需的计算资源成本，以 BNB 支付。可以通过 BSC 官方水龙头获取免费的测试网 BNB。访问 BSC 测试网水龙头 (例如：https://testnet.binance.org/faucet-smart) 并按照说明操作，将测试网 BNB 发送到你的 MetaMask 钱包地址。请注意，每个水龙头的可用 BNB 数量有限，并且可能需要你完成一些验证步骤。
项目初始化
项目启动的第一步是建立一个专属的项目目录，并利用 Hardhat 工具进行初始化，为后续的智能合约开发奠定基础。
bash
mkdir doge-bsc
cd doge-bsc
npm init -y
npm install --save-dev hardhat @nomicfoundation/hardhat-toolbox dotenv
npx hardhat
在执行
npx hardhat
命令时，建议选择 "Create a basic sample project" 选项，Hardhat 将自动生成一个包含基本结构和示例合约的初始项目框架，极大地简化了开发流程。
为了支持合约的编译、部署以及与前端应用的无缝集成，需要安装一些额外的依赖包。这些依赖包提供了诸如合约安全审计、以太坊交互等关键功能。
bash
npm install --save-dev @openzeppelin/contracts
npm install --save ethers @nomiclabs/hardhat-ethers
在项目根目录下创建名为
.env
的环境变量文件，用于安全地存储敏感信息，如私钥和 BSC 测试网络 RPC URL。这样做可以避免将敏感信息直接暴露在代码中，提高安全性。
PRIVATE_KEY="YOUR_PRIVATE_KEY"
BSC_TESTNET_RPC="YOUR_BSC_TESTNET_RPC_URL"
务必将
YOUR_PRIVATE_KEY
和
YOUR_BSC_TESTNET_RPC_URL
替换为您自己的实际私钥和 RPC URL。
注意：务必妥善保管您的私钥，切勿泄露给任何第三方！ 私钥是访问和控制您区块链资产的唯一凭证。
您可以通过 MetaMask 等钱包生成私钥，并通过区块链服务提供商获取测试网 RPC URL。
为了让 Hardhat 能够连接到 BSC 测试网络并进行部署，需要对
hardhat.config.js
文件进行相应的配置。
javascript
require("@nomicfoundation/hardhat-toolbox");
require("dotenv").config();
const PRIVATE_KEY = process.env.PRIVATE_KEY || "";
const BSC_TESTNET_RPC = process.env.BSC_TESTNET_RPC || "";
module.exports = {
solidity: "0.8.4",
networks: {
bscTestnet: {
url: BSC_TESTNET_RPC,
chainId: 97,
accounts: [PRIVATE_KEY],
},
},
};
这段配置代码首先引入了 Hardhat 工具箱和 dotenv 模块。 然后，它从
.env
文件中读取私钥和 BSC 测试网 RPC URL。
networks
部分定义了 BSC 测试网络的配置，包括 RPC URL、链 ID (97) 以及用于部署合约的账户 (通过私钥指定)。 如果没有在
.env
文件中设置环境变量，则赋予空字符串作为默认值。 请注意，
solidity: "0.8.4"
指定了用于编译智能合约的 Solidity 编译器版本。
编写智能合约
我们将创建一个简化的狗狗币（DogeCoin）智能合约，其核心功能在于允许指定账户铸造（mint）和转移代币。为了实现这个目标，需要在Solidity开发环境中，于项目的
contracts
目录下新建一个名为
DogeCoin.sol
的文件。此文件将包含合约的全部源代码。
代码示例如下（Solidity）：
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import "@openzeppelin/contracts/token/ERC20/ERC20.sol";
contract DogeCoin is ERC20 {
uint256 public constant INITIAL_SUPPLY = 100000000 * (10 ** 18); // 初始发行量为1亿个狗狗币，精确到18位小数
constructor() ERC20("DogeCoin", "DOGE") {
_mint(msg.sender, INITIAL_SUPPLY);
}
function mint(address to, uint256 amount) public {
// 仅合约部署者（owner）才能增发新的代币
require(msg.sender == owner(), "Only owner can mint");
_mint(to, amount);
}
function owner() public view returns (address) {
return msg.sender;
}
}
上述
DogeCoin
合约通过
is ERC20
关键字继承了 OpenZeppelin 库提供的 ERC20 标准合约。该标准合约已经实现了代币的基本功能，例如余额管理和代币转移。我们自定义了一个
mint
函数，用于增发新的代币。该函数受到访问控制限制，只有最初部署该合约的账户（即
owner
）才能够调用。通过
require(msg.sender == owner(), "Only owner can mint")
语句确保只有合约的拥有者才能调用
mint
函数，保障代币增发的安全性。
编译智能合约
使用 Hardhat 编译智能合约是将 Solidity 代码转换为以太坊虚拟机 (EVM) 可以执行的字节码的过程。Hardhat 提供了一个内置的编译任务，可以方便地完成这一任务。执行以下命令来编译你的合约：
npx hardhat compile
这条命令会指示 Hardhat 查找项目中的所有 Solidity 文件 (通常位于
contracts
目录下)，并使用配置的 Solidity 编译器版本（可在
hardhat.config.js
文件中指定）进行编译。
在编译过程中，Hardhat 会执行一系列检查，例如语法分析、类型检查和代码优化。如果编译成功，Hardhat 将生成一个
artifacts
目录。这个目录包含了编译后的合约 ABI (Application Binary Interface) 和 bytecode，以及调试信息。
artifacts
目录的结构如下：
-
artifacts/contracts: 包含编译后的合约 JSON 文件，每个合约对应一个文件。 -
每个合约的 JSON 文件包含了：
-
abi: ABI 是一个 JSON 格式的接口描述，定义了合约的函数和事件，以及如何与合约进行交互。 -
bytecode: bytecode 是 EVM 可以执行的十六进制代码，包含了合约的逻辑。 -
deployedBytecode: 已部署的合约的字节码，通常与 bytecode 略有不同。 -
sourceName: 源代码的文件名。 -
contractName: 合约的名称。
-
这些编译后的文件对于部署合约到区块链以及与合约进行交互至关重要。ABI 允许客户端应用程序（例如 Web3.js 或 ethers.js）了解合约的接口，而 bytecode 则用于在区块链上创建合约实例。确保妥善保管
artifacts
目录，因为它包含了所有必要的信息。
部署智能合约
为了将你的 DogeCoin 智能合约部署到区块链上，我们需要创建一个部署脚本。在你的
scripts
目录下创建一个名为
deploy.js
的文件，该脚本将负责合约的编译和部署过程。
以下是
deploy.js
文件的内容，它利用 Hardhat 提供的 ethers.js 库与区块链交互：
javascript
const { ethers } = require("hardhat");
async function main() {
// 获取部署合约的账户。 Hardhat 在运行时会提供预先配置好的账户。
const [deployer] = await ethers.getSigners();
console.log("正在使用以下账户部署合约:", deployer.address);
// 检查账户余额，确保有足够的资金支付 gas 费用。
const balance = await deployer.getBalance();
console.log("账户余额:", balance.toString());
// 获取 DogeCoin 合约的工厂。 这允许我们创建合约的实例。
const DogeCoin = await ethers.getContractFactory("DogeCoin");
// 使用合约工厂部署 DogeCoin 合约。构造函数参数（如果存在）应该在这里传递。
const dogeCoin = await DogeCoin.deploy();
// 等待合约完成部署。 这确保了交易被挖掘并确认。
await dogeCoin.deployed();
// 打印已部署合约的地址。 这是与合约交互所需的地址。
console.log("DogeCoin 合约已部署至:", dogeCoin.address);
}
main()
.then(() => process.exit(0))
.catch((error) => {
console.error(error);
process.exit(1);
});
现在，使用 Hardhat 部署合约到 BSC 测试网络。 确保你已经在
hardhat.config.js
文件中正确配置了
bscTestnet
网络。 这包括设置 URL (BSC 测试网的 RPC 端点) 和你的私钥（用于授权部署交易）。
使用以下命令执行部署脚本。
--network bscTestnet
参数指定了要使用的网络。 确保你安装了 Hardhat CLI 工具 (通常是通过
npm install --save-dev hardhat
)。
bash
npx hardhat run scripts/deploy.js --network bscTestnet
如果部署成功，控制台将输出已部署的 DogeCoin 合约的地址。将此地址保存好，因为你需要它与合约进行交互，例如铸造代币、转移代币或调用其他合约函数。你也可以在 BSC 测试网的区块浏览器上使用此地址来查看合约详情和交易历史。
验证合约 (可选)
为了提高透明度并方便社区成员审查和验证智能合约代码，建议将合约发布到 BscScan 区块链浏览器上。这允许用户直接在 BscScan 上查看合约的源代码、ABI 以及相关的交易历史记录。
需要安装 `hardhat-verify` 插件，这是一个 Hardhat 的插件，专门用于简化合约验证流程。使用 npm 包管理器安装此插件：
npm install --save-dev @nomiclabs/hardhat-etherscan
安装完成后，需要在 Hardhat 的配置文件 `hardhat.config.js` 中添加该插件，并配置 BscScan API 密钥。BscScan API 密钥用于授权 Hardhat 插件访问 BscScan 的 API，以便能够自动提交合约源代码进行验证。
require("@nomiclabs/hardhat-etherscan");
module.exports = {
// ... other configurations
etherscan: {
apiKey: "YOUR_BSCSCAN_API_KEY",
},
};
请务必将代码中的 `YOUR_BSCSCAN_API_KEY` 替换为你自己的 BscScan API 密钥。你可以在 BscScan 官方网站上注册并申请 API 密钥。通常，免费的 API 密钥足以用于合约验证，但如果需要更高的 API 调用频率，可能需要考虑购买付费计划。API 密钥是敏感信息，请妥善保管，不要泄露。
配置完成后，就可以使用以下命令来验证你的合约：
npx hardhat verify --network bscTestnet DEPLOYED_CONTRACT_ADDRESS
将命令中的 `DEPLOYED_CONTRACT_ADDRESS` 替换为你部署合约时得到的合约地址。`--network bscTestnet` 参数指定了要验证合约的网络。如果你的合约部署在 Binance Smart Chain 主网上，则需要将该参数改为 `--network bscMainnet`。确保选择与你合约部署网络相匹配的网络参数，否则验证将会失败。验证过程可能需要一些时间，取决于合约的复杂程度和 BscScan 的服务器负载。成功验证后，你将能够在 BscScan 上查看到经过验证的合约源代码。
与合约交互
为了方便与部署在币安智能链（BSC）上的合约进行交互，可以使用功能强大的 JavaScript 库 ethers.js。该库提供了一系列 API，简化了与智能合约的交互过程，包括读取合约状态、调用合约函数以及监听合约事件。通过 ethers.js，开发者能够轻松构建与合约交互的前端或后端应用程序。
例如，以下代码展示了如何使用 ethers.js 获取合约的名称、符号和总供应量等基本信息。这些信息对于了解合约的基本属性至关重要，尤其是在集成到用户界面或第三方应用程序时。
javascript
const { ethers } = require("ethers");
// 替换为你的合约地址
const contractAddress = "YOUR_CONTRACT_ADDRESS";
// 替换为你的 BSC 测试网 RPC URL，例如：https://data-seed-prebsc-1-s1.binance.org:8545
const provider = new ethers.providers.JsonRpcProvider("YOUR_BSC_TESTNET_RPC_URL");
const abi = [
"function name() view returns (string)",
"function symbol() view returns (string)",
"function totalSupply() view returns (uint256)",
];
async function main() {
const contract = new ethers.Contract(contractAddress, abi, provider);
const name = await contract.name();
const symbol = await contract.symbol();
const totalSupply = await contract.totalSupply();
console.log("Name:", name);
console.log("Symbol:", symbol);
console.log("Total Supply:", totalSupply.toString());
}
main();
上述代码片段首先引入了 ethers.js 库，然后定义了合约地址和 BSC 测试网的 RPC URL。
contractAddress
变量应替换为已部署合约的实际地址，
provider
变量使用
JsonRpcProvider
连接到 BSC 测试网。 ABI (应用程序二进制接口) 定义了与合约交互所需的函数签名，包含了
name
,
symbol
和
totalSupply
函数的声明。
main
函数创建了一个
Contract
实例，并使用该实例调用合约的函数。将获取到的名称、符号和总供应量打印到控制台。
保存以上代码为
interact.js
并通过 Node.js 环境执行：
bash
node interact.js
在执行脚本之前，务必将
YOUR_CONTRACT_ADDRESS
和
YOUR_BSC_TESTNET_RPC_URL
替换为实际的合约地址和 RPC URL。 建议使用Infura、Alchemy或币安提供的公共 RPC 节点，以便快速连接到 BSC 测试网络。确保已安装 Node.js 和 npm，并使用 npm 安装 ethers.js 库：
npm install ethers
。
除了使用代码进行交互，还可以利用 MetaMask 等 Web3 钱包连接到 BSC 测试网，并将合约地址导入到 MetaMask 中。 这样，可以直接在 MetaMask 界面中查看和管理代币，进行转账等操作。 通过 MetaMask 的图形界面，用户可以更直观地与合约进行交互，而无需编写代码。
前端集成 (可选)
为了提供更友好的用户体验，您可以选择使用流行的前端框架，例如 React、Vue 或 Angular，来构建一个直观的用户界面，使用户能够轻松地与您的狗狗币智能合约进行交互。 这个用户界面可以实现多种关键功能，例如：
- 铸造狗狗币： 允许用户在满足特定条件（例如支付一定费用）后创建新的狗狗币。
- 转账狗狗币： 用户可以将狗狗币发送给其他地址，实现价值转移。
- 查询余额： 用户可以查看自己账户中持有的狗狗币数量。
- 查看交易历史： 显示与用户地址相关的狗狗币交易记录，包括转入和转出。
与智能合约进行交互的核心是使用 JavaScript 库。 Web3.js 和 ethers.js 是两个广泛使用的 JavaScript 库，它们提供了与以太坊区块链和兼容区块链进行交互所需的工具。 这些库允许您的前端代码连接到区块链节点，调用合约函数，并监听合约事件。
Web3.js: 是一个成熟且广泛使用的库，提供了丰富的功能和详细的文档。 它允许你连接到本地或远程的以太坊节点，发送交易，读取合约状态，并订阅合约事件。
Ethers.js: 是一个更轻量级且模块化的库，它专注于安全性和易用性。 Ethers.js 简化了与智能合约的交互，并提供了更好的类型安全性和性能。 它也支持各种钱包和签名者，并提供了高级的加密功能。
在前端应用中集成 Web3.js 或 ethers.js 时，需要注意以下几点：
- 连接到区块链： 你需要配置库以连接到合适的区块链网络（例如，主网、测试网或本地开发网络）。 这通常涉及到指定一个区块链节点的 URL 或使用一个 MetaMask 等钱包提供商。
- 获取合约实例： 你需要使用合约的 ABI (Application Binary Interface) 和合约地址来创建一个合约实例。 ABI 定义了合约的函数和事件，而合约地址指定了合约在区块链上的位置。
- 调用合约函数： 你可以使用合约实例来调用合约的函数。 调用函数可能需要用户授权（例如，使用 MetaMask），并且可能需要支付 gas 费用。
- 监听合约事件： 你可以订阅合约事件，以便在合约状态发生变化时收到通知。 例如，你可以监听 "Transfer" 事件来跟踪狗狗币的转账情况。