安装 Hardhat 和所需插件

使用以下命令安装 Hardhat：

npm install --save-dev hardhat

安装所需插件：

npm install --save-dev @nomiclabs/hardhat-truffle5 @nomiclabs/hardhat-web3 'web3@^1.0.0-beta.36'

创建 Hardhat 配置文件

创建 hardhat.config.js（或使用 TypeScript 时为 hardhat.config.ts），并确保其配置与 Truffle 的配置一致。请参考 Hardhat 文档，了解高级参数设置。

在配置文件中添加以下内容：

require("@nomiclabs/hardhat-truffle5");

创建 hardhat-truffle fixture

如果您的项目使用 Truffle 迁移来初始化测试环境（即测试中调用 Contract.deployed()），那么您需要将迁移调整为 hardhat-truffle fixture。

创建一个 test/truffle-fixture.js 文件，部署合约并调用 setAsDeployed() 方法以便测试。

例如，Truffle 中的迁移文件：

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

module.exports = function (deployer) {
  deployer.deploy(Greeter);
};

需要转换为以下 hardhat-truffle fixture 文件：

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

module.exports = async () => {
  const greeter = await Greeter.new();
  Greeter.setAsDeployed(greeter);
};

更多信息请参考 Hardhat fixtures 文档。

现在，您可以在 Hardhat 中编译、测试和部署合约。

安装 Hardhat

使用以下命令安装 Hardhat：

npm install --save-dev hardhat

更新文件夹结构

将 Truffle 文件夹结构更新为以下形式：

• 将 migrations 目录重命名为 scripts。
• 创建 hardhat.config.js 文件，添加网络和 Solidity 配置。更多高级参数设置请参阅 Hardhat 文档。

Truffle 和 Hardhat 的标准文件夹结构如下：

Truffle 文件夹结构 - truffle-config.js
- contracts/：用于存放合约的源文件 - migrations/：用于存放脚本文件，例如部署到链上的脚本 - test/：用于存放合约测试

Hardhat 文件夹结构 - hardhat.config.js - contracts/ - scripts/ - test/

编译、测试和部署合约

您可能需要将 Truffle 的 Web3.js 替换为 Hardhat 的 Web3.js 或 ethers.js 插件来部署合约。有关更多信息，请参考 Hardhat 文档。

使用以下步骤在 Hardhat 中编译、测试和部署合约：

• 安装项目中的依赖：

npm i

• 编译合约：

npx hardhat compile

• 测试合约：

npx hardhat test

• 测试合约的部署：

npx hardhat run scripts/deploy.js

Hardhat 在执行测试、脚本或任务时会自动启动一个内置的 Hardhat Network 节点。您也可以使用 --network 选项指定配置在 hardhat.config.js 文件中的网络，例如：

npx hardhat run --network <your-network> scripts/deploy.js

运行本地以太坊网络节点

由于 Ganache 不再可用作为本地以太坊网络节点，Hardhat 使用 Hardhat Network 作为其本地以太坊网络节点。

运行以下命令启动一个本地以太坊测试网络，向 Hardhat Network 暴露一个 JSON-RPC 接口：

npx hardhat node

您可以在 hardhat.config.js 文件中配置 Hardhat Network。例如，以下配置定义了一个名为 quickstart 的网络：

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

配置钱包

要在 Hardhat 中使用 HD（分层确定性）钱包，您需要在 hardhat.config.js 文件中设置 accounts 字段，例如：

module.exports = {
  networks: {
    sepolia: {
      url: "...",
      accounts: {
        mnemonic: "test test test test test test test test test test test junk",
        path: "m/44'/60'/0'/0",
        initialIndex: 0,
        count: 20,
        passphrase: "",
      },
    },
  },
};

您也可以通过 Ethers Signer 接口加载可访问的账户：

module.exports = {
  networks: {
    // 内置测试网络用于合约开发
    hardhat: {
      chainId: 1337
    },
    quickstart: {
      url: "http://127.0.0.1:8545",
      chainId: 1337,
      // 仅测试账户
      accounts: [
        "0x8f2a55949038a9610f50fb23b5883af3b4ecb3c3bb792cbcefbd1542c692be63",
        "0xc87509a1c067bbde78beb793e6fa76530b6382a4c0241e5e4a9ec0a0f44dc0d3",
        "0xae6ae8e5ccbfb04590405997ee2d52d2b330726137b875053c36d94e974d162f"
      ]
    },
  }
}

使用以下代码访问前两个账户：

const [owner, otherAccount] = await ethers.getSigners();

使用助记词生成钱包

您可以在代码中通过定义在 hardhat.config.js 文件中的助记词生成钱包：

import {ethers} = require("ethers");
import { HDNodeWallet } from 'ethers';
let node = ethers.HDNodeWallet.fromMnemonic(words);

连接 MetaMask

使用以下代码将 Hardhat 网络连接到您的 MetaMask 钱包：

const provider = new ethers.BrowserProvider(window.ethereum);

从现有私钥加载钱包

您可以通过指定的网络从现有私钥加载钱包，代码如下：

import { ethers } from "hardhat";
const provider = new ethers.JsonRpcApiProvider("JSON-RPC-http-endpoint");
const wallet = new ethers.Wallet("0xMY_PRIVATE_KEY");
const signer = wallet.connect(provider);

// 也可以直接使用 provider
const wallet = new ethers.Wallet("0xMY_PRIVATE_KEY", provider);

这样，您就可以轻松将您的 Truffle 项目迁移到 Hardhat。

安装 Node.js

注意： 如果想安装 npm 的最新版本，可以运行以下命令：

npm i -g npm

Node Package Manager (NPM) 建议使用 Node 版本管理器（如 nvm）来安装 Node.js 和 npm，以避免安装全局模块时出现权限错误。您可以根据自己的操作系统，按照 这个链接 提供的说明进行安装。

Truffle 需要 node-gyp 来编译 Node.js 的原生附加模块。为了避免在安装 Truffle 时出现错误，建议您根据 安装说明 安装 node-gyp。

使用 nvm 来安装与 Truffle 兼容的 Node.js 版本。例如，在 OSX 或 Linux 上安装 Node.js v18，可以运行以下命令：

nvm install 18

通过运行以下命令确认 Node.js 是否正确安装：

node --version

安装 Truffle

警告： 安装 Truffle 时，避免使用 sudo 命令，因为这可能会导致权限错误。

在终端中，使用 npm 安装 Truffle：

npm install -g truffle

在安装过程中，您可能会收到一些警告。为了确认 Truffle 是否安装正确，可以运行以下命令：

truffle version

如果命令成功执行并显示版本信息，说明 Truffle 已正确安装。

创建 Truffle 项目的新目录：

mkdir MetaCoin
cd MetaCoin

下载 MetaCoin box：

truffle unbox metacoin

注意： 你可以使用 truffle unbox <box-name> 命令下载任何其他 Truffle Boxes。

注意： 如果你想创建一个不包含智能合约的空 Truffle 项目，可以使用以下命令：

truffle init

注意： 你可以使用 --force 选项来在当前目录初始化项目，不论其状态如何（例如，即使它包含其他文件或目录）。此选项适用于 init 和 unbox 命令。请谨慎使用，因为这可能会覆盖目录中现有的文件。

完成该操作后，你将拥有如下项目结构：

• contracts/: 存放 Solidity 智能合约的目录
• migrations/: 存放脚本化部署文件的目录
• test/: 存放测试应用程序和智能合约的测试文件的目录
• truffle-config.js: Truffle 配置文件

位置

所有的智能合约文件位于项目的 contracts/ 目录中。由于合约是用 Solidity 编写的，所有包含智能合约的文件都使用 .sol 扩展名。相关的 Solidity 库也会使用 .sol 扩展名。

命令

要编译一个 Truffle 项目，请切换到项目所在目录的根目录，并在终端中输入以下命令：

truffle compile

首次运行时，所有合约都会被编译。随后的运行中，Truffle 只会编译自上次编译后发生更改的合约。如果你想覆盖此行为，可以在命令后加上 --all 选项，强制编译所有合约。

编译产物

编译后的产物会被放置在项目根目录下的 build/contracts/ 目录中（如果该目录不存在，Truffle 会自动创建）。生成的 .json 文件的名称并不反映源文件名，而是对应智能合约的名称。这意味着如果你更改了 artifacts.require 方法中的合约名称，而该名称与源文件中的合约定义名称不匹配，可能会导致错误提示：“Error: Could not find artifacts for {yourContract} from any sources”。

这些编译产物是 Truffle 内部工作机制的重要部分，影响着应用的成功部署。你不应手动编辑这些文件，因为它们会在合约编译和部署时被覆盖。

依赖

你可以使用 Solidity 的 import 命令声明合约依赖。Truffle 会按照正确的顺序编译合约，并确保所有依赖项都被发送到编译器。依赖可以通过两种方式指定：

通过文件名导入依赖¶

要从另一个文件导入合约，在你的 Solidity 源文件中添加以下代码：

import "./AnotherContract.sol";

这将使 AnotherContract.sol 文件中的所有合约可用。在此示例中，AnotherContract.sol 是相对于当前编写的合约路径的文件。

请注意，Solidity 允许其他导入语法。更多信息请参考 Solidity import 文档。

从外部包导入合约¶

Truffle 支持通过 NPM 安装的依赖项。要从依赖项中导入合约，使用以下语法：

import "somepackage/SomeContract.sol";

在这里，somepackage 代表通过 NPM 安装的包，而 SomeContract.sol 是该包提供的 Solidity 源文件。

更多关于如何使用 Truffle 的包管理功能的信息，请参考 Truffle NPM 文档。

Truffle 与 MetaMask¶

在浏览器中与智能合约交互之前，确保它们已经被编译和部署，并通过客户端 JavaScript 使用 web3 进行交互。我们推荐使用 @truffle/contract 库，因为它使得与合约的交互更加简单和稳健。

注意: 有关更多信息，包括如何使用 @truffle/contract，请参考我们的 Pet Shop 教程。

完成上述步骤后，你就可以开始使用 MetaMask 了。

什么是 MetaMask?¶

MetaMask 是最简单的方式来在浏览器中与去中心化应用（dApps）交互的工具。它是 Chrome 或 Firefox 的一个扩展，能够连接到以太坊网络而无需在浏览器的机器上运行完整节点。它可以连接到主以太坊网络、任何测试网络（如 Ropsten、Kovan 和 Rinkeby），或者本地区块链，例如由 Ganache 或 Truffle Develop 创建的本地区块链。

MetaMask

对于 Truffle 开发来说，这意味着我们可以以与用户在实际网络上交互 dApp 的相同方式使用 dApp。

安装 MetaMask¶

要在 Chrome 上安装 MetaMask，请访问 Chrome 网上应用店，然后点击 “Add to Chrome” 按钮。

要在 FireFox 上安装 MetaMask，请访问 Firefox 附加组件页面，然后点击 “Add to Firefox” 按钮。

当前端准备就绪且 MetaMask 安装完成后，你就可以看到你的 dApp 完整运行了。

使用 MetaMask 与 Ganache 交互¶

Ganache 是一个用于测试目的的区块链图形应用程序。它运行在 127.0.0.1:7545。

注意: 我们建议使用 127.0.0.1 而不是 localhost，因为该地址不需要网络连接，开发时更为合适。

// 是否存在注入的 web3 实例？
if (typeof web3 !== 'undefined') {
  App.web3Provider = web3.currentProvider;
  web3 = new Web3(web3.currentProvider);
} else {
  // 如果没有检测到注入的 web3 实例，回退到 Ganache。
  App.web3Provider = new web3.providers.HttpProvider('http://127.0.0.1:7545');
  web3 = new Web3(App.web3Provider);
}

// 是否存在注入的 web3 实例？
if (typeof web3 !== 'undefined') {
  App.web3Provider = web3.currentProvider;
  web3 = new Web3(web3.currentProvider);
} else {
  // 如果没有检测到注入的 web3 实例，回退到 Truffle Develop。
  App.web3Provider = new web3.providers.HttpProvider('http://127.0.0.1:9545');
  web3 = new Web3(App.web3Provider);
}

// 是否存在注入的 web3 实例？
if (typeof web3 !== 'undefined') {
  App.web3Provider = web3.currentProvider;
  web3 = new Web3(web3.currentProvider);
} else {
  // 如果没有检测到注入的 web3 实例，回退到 Ganache CLI。
  App.web3Provider = new web3.providers.HttpProvider('http://127.0.0.1:8545');
  web3 = new Web3(App.web3Provider);
}

运行迁移¶

迁移（Migrations）是帮助你将智能合约部署到以太坊网络的 JavaScript 文件。它们负责分阶段执行你的部署任务，假设随着项目的发展，你的部署需求会不断变化。随着项目的进化，你将创建新的迁移脚本，以将这些变化进一步应用到区块链上。之前运行的迁移历史会通过一个特殊的 Migrations 合约记录在链上，下面会详细介绍。

$ truffle migrate

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

module.exports = function(deployer) {
  // 部署步骤
  deployer.deploy(MyContract);
};

contract ContractOne {
  // ...
}

contract ContractTwo {
  // ...
}

var ContractTwo = artifacts.require("ContractTwo");

var ContractOne = artifacts.require("ContractOne");
var ContractTwo = artifacts.require("ContractTwo");

var SolidityContract = artifacts.require("SolidityContract");

module.exports = function(deployer) {
  // 部署 SolidityContract 合约，作为唯一的任务
  deployer.deploy(SolidityContract);
};

// 先部署 A，再部署 B
deployer.deploy(A);
deployer.deploy(B);

// 先部署 A，然后部署 B，并传入 A 的新部署地址
deployer.deploy(A).then(function() {
  return deployer.deploy(B, A.address);
});

module.exports = function(deployer, network) {
  if (network == "live") {
    // 针对名为 "live" 的网络执行特定操作
  } else {
    // 否则执行其他步骤
  }
}

module.exports = function(deployer, network, accounts) {
  // 在迁移中使用账户信息
}

与合约交互¶

pragma solidity >=0.4.25 <0.6.0;

import "./ConvertLib.sol";

contract MetaCoin {
    mapping (address => uint) balances;

    event Transfer(address indexed _from, address indexed _to, uint256 _value);

    constructor() public {
        balances[tx.origin] = 10000;
    }

    function sendCoin(address receiver, uint amount) public returns(bool sufficient) {
        if (balances[msg.sender] < amount) return false;
        balances[msg.sender] -= amount;
        balances[receiver] += amount;
        emit Transfer(msg.sender, receiver, amount);
        return true;
    }

    function getBalanceInEth(address addr) public view returns(uint){
        return ConvertLib.convert(getBalance(addr), 2);
    }

    function getBalance(address addr) public view returns(uint) {
        return balances[addr];
    }
}

truffle(develop)> let instance = await MetaCoin.deployed()
truffle(develop)> instance

truffle(develop)> let accounts = await web3.eth.getAccounts()
truffle(develop)> instance.sendCoin(accounts[1], 10, {from: accounts[0]})

truffle(develop)> let balance = await instance.getBalance(accounts[0])
truffle(develop)> balance.toNumber()

truffle(develop)> let result = await instance.sendCoin(accounts[1], 10, {from: accounts[0]})
truffle(develop)> result

truffle(develop)> result.logs[0]

truffle(develop)> let newInstance = await MetaCoin.new()

let specificInstance = await MetaCoin.at("0x1234...");

instance.sendTransaction({...}).then(function(result) {
  // 交易结果对象
});

instance.send(web3.utils.toWei("1", "ether")).then(function(result) {
  // 交易结果对象
});

instance.methods ;
instance.methods['setValue(uint256,uint256)'](11, 55);

contract ExampleContract {
  enum ExampleEnum {
    Option0,
    Option1,
    Option2
  }
}

ExampleContract.ExampleEnum.Option0

使用 Truffle Dashboard¶

在部署智能合约时，你需要指定一个拥有足够资金的以太坊账户，以支付部署时的交易费用。一个常见的方法是将助记词复制粘贴到 .env 文件中，这样可以与例如 @truffle/hdwallet-provider 等工具配合使用。然而，直接复制粘贴私钥并不是最佳实践，特别是当我们有像 MetaMask 这样的钱包可以直接发送交易时。

为了解决这个问题，Truffle 开发了 Truffle Dashboard，让你可以轻松使用现有的 MetaMask 钱包来进行部署和发送其他交易。由于 Truffle Dashboard 直接连接 MetaMask，因此你还可以结合硬件钱包（如 Ledger 或 Trezor）使用它。

启动 Dashboard¶

要启动 Truffle Dashboard，你需要在一个单独的终端窗口中运行以下命令：

truffle dashboard [--port <number>] [--host <string>] [--verbose]

默认情况下，上述命令会在 http://localhost:24012 启动一个 Dashboard，并在你的默认浏览器中打开该页面。Dashboard 会提示你连接钱包并确认你连接到正确的网络。在此时，应仔细检查连接的网络，因为在部署过程中切换网络可能会导致意外情况。

通过 Truffle Dashboard 连接你的钱包后，你可以使用 MetaMask 来处理交易。

配置 Dashboard¶

Truffle 配置文件 truffle-config.js 中可以配置 Dashboard 的端口和主机。例如：

module.exports = {
  // ... 其他 Truffle 配置

  dashboard: {
    port: 24012,
  },

  networks: {
    // ... 网络配置
  }
}

连接到 Dashboard¶

Truffle 中内置了一个名为 dashboard 的网络，该网络会自动使用 Dashboard 的端口和主机地址。你可以在部署合约或运行控制台时指定使用此网络：

truffle migrate --network dashboard
truffle console --network dashboard

这样，所有的以太坊 RPC 请求都会通过 Truffle 转发到 Truffle Dashboard，在 Dashboard 上用户可以检查请求并使用 MetaMask 处理它们。

如果你需要自定义网络选项，你可以在 truffle-config.js 中添加 dashboard 网络，并提供必要的网络参数。例如：

module.exports = {
  // ... 其他 Truffle 配置

  networks: {
    dashboard: {
      networkCheckTimeout: 120000,
    }
  },

  dashboard: {
    port: 24012,
    host: "localhost",
  }
}

解码请求¶

Truffle Dashboard 支持解码某些 RPC 调用，能够更直观地显示你和以太坊网络之间的通信。当前支持的方法包括 eth_sendTransaction、personal_sign、eth_signTypedData_v3 和 eth_signTypedData_v4。

每次运行 truffle compile 时，Truffle 都会将合约信息共享给 Truffle Dashboard，这样在调用方法时，Truffle Dashboard 会通过解码器将请求翻译成人类可读的格式。

例如，低级别请求看起来可能是这样的：

0xa0e9439c000000000000000000000000627306090abab3a6e1400e9345bc60c78a8bef570000000000000000000000000000000000000000000000000000000000000005

而在 Truffle Dashboard 上，它会显示为：

mint(myaccount.eth, 5)

与非 Truffle 工具一起使用¶

为了让 Truffle Dashboard 对所有开发者都可用，我们设计它时不依赖于特定工具。你可以将 Truffle Dashboard 与非 Truffle 工具（如 Hardhat）结合使用。

module.exports = {
  networks: {
    'truffle-dashboard': {
      url: "http://localhost:24012/rpc"
    }
  },
};

hardhat deploy --network truffle-dashboard