Skip to main content

Hardhat mainnet forking：主網分叉 (1)

· 13 min read
Chuan-Chun Wang

本文章將展示怎麼使用知名開發工具 Hardhat 的主網分叉（mainnet forking），令開發者可任意指定欲分叉的區塊鏈高度，並與 Hardhat 內建的自定義 testnet（Hardhat Network）結合，享受最高仿真度、最簡便的開發環境。

在 Ethereum 開發 Dapp 少不了撰寫智能合約（smart contract）；除了使用 Go Ethereum（Geth）、OpenEthereum 等工具自建一條 local testnet，並將合約部屬在上面之外，還可將合約部屬到各大公開測試網（testnet）1。然而，這些方法雖然都使用與主網（mainnet）幾乎相同的2程式碼當作 L1 底層，但是與直接部屬在 mainnet 最大的差異就是：你幾乎無法讓你的 Dapp 與其他知名合約、DEX 做互動。

DeFi 之所以在近年受到全球矚目，其中一個原因莫過於其高度的互操作性（interoperability）；各個合約之間可以透過程式呼叫，輕鬆地與彼此互動，達成傳統金融所無法企及的巨大靈活能力。

然而，如果你正在開發的 Dapp/DeFi 專案，無法在極度仿真的環境當中，通過完整的測試即貿然上線，則此服務將暴露於巨大風險之下。

部屬合約於 (local) testnet 當中，為求最精緻的模擬環境，你將會耗費極大心力逐一複製所有第三方合約、DEX 的程式碼，並重新佈署於模擬環境當中，這完全不是一個可行的方法。

Hardhat 的說明文件是這麼介紹 mainnet forking：

You can start an instance of Hardhat Network that forks mainnet. This means that it will simulate having the same state as mainnet, but it will work as a local development network. 3

本文章將帶領各位讀者熟悉 mainnet forking 的使用方法，並在另一篇文章當中舉幾個例子讓讀者能體會 mainnet forking 的方便性，以期各位讀者都能善用此工具。

背景知識與環境​

Mainnet forking 背後的運作機制，概念上就是模擬一個仿造 Ethereum mainnet 的 local testnet，讓開發者誤以為自己是跟 mainnet 互動。

當開發者呼叫合約或發送 tx 時，如果該「仿造版」local testnet 查無資訊（該資訊可能是紀錄在某個歷史 block 當中），則 Hardhat 套件轉向歸檔節點（archive node）詢問資訊的內容，並將回傳的結果經過適當包裝後丟給開發者。因此，開發者必需主動提供兩個條件：(1) archive node (2) 指定的區塊高度（以此高度為基準劃分出何謂歷史 block）。

本文不會提供 Hardhat 與其他相關套件的安裝指引，相關操作細節可以參考 LunDAO 其他教學文章。若您已知道如何使用 Hardhat 部屬 ERC-20 合約，則本文深度恰巧適合您。以下為筆者已測試能夠成功運行本文章步驟的軟硬體條件，請讀者參酌使用。

  • Software
    • Windows
      • OS：Windows 10 Pro 21H1 (w/o WSL)
      • nodejs v14.17.4
      • yarn 1.22.17
    • Linux
      • OS：Ubuntu 20.04.4 LTS (GNU/Linux 5.4.0-1053-raspi aarch64)
      • 其他同 Windows 軟體配置
  • Hardware
    • 基本上無限制，下列為經過測試可行的組合
    • Windows：Intel Core i7-10510U (16GB) with 4G LTE cellular hotspot
    • Linux：Raspberry Pi 4B (4GB) with 1Gbps network

重要必備條件​

由於 mainnet forking 的運作過程需與 archive node 作互動；因此，你必需準備好 archive node 並將 Hardhat 連接上它。最直白地方式即透過 Geth、OpenEthereum 等工具自架節點5，或可使用市面上知名的數家 SaaS 節點供應商之服務6。本文為求過程輕鬆好學習，以下將搭配 Alchemy 提供的服務。

另外，由於 Hardhat Network 是 EVM-compatible blockchain，因此理論上任何 EVM-compatible chain 的歸檔節點皆有機會使用 mainnet forking，但實際上可能與 Ethereum mainnet 相比有所限制，筆者僅另外使用過 Polygon mainnet 亦可順利運作。

Step 1：建置環境​

目標：成功啟動 Hardhat Network

  1. 新增一個空白資料夾「hardhat_fork」
$ mkdir hardhat_fork
$ cd hardhat_fork
  1. 安裝必備的 JavaScript 套件
    • 為求所有讀者都能在第一次操作時成功完成，本文將所有套件已指定版本號安裝
    • 作者建議讀者學會之後，以使用最新 stable version 為佳
$ yarn init # 沒有想更動的部分，就按 Enter 鍵帶過即可
...
$ yarn add dotenv@16.0.0
$ yarn add hardhat@2.8.4
$ yarn add @nomiclabs/hardhat-waffle@2.0.2
$ yarn add @nomiclabs/hardhat-web3@2.0.0
$ yarn add @nomiclabs/hardhat-ethers@2.0.5
$ yarn add web3@1.7.0
$ yarn add ethers@5.5.4
...
  1. 啟動 Hardhat Network 初始化設定
$ yarn hardhat
yarn run v1.22.15
888    888                      888 888               888
888    888                      888 888               888
888    888                      888 888               888
8888888888  8888b.  888d888 .d88888 88888b.   8888b.  888888
888    888     "88b 888P"  d88" 888 888 "88b     "88b 888
888    888 .d888888 888    888  888 888  888 .d888888 888
888    888 888  888 888    Y88b 888 888  888 888  888 Y88b.
888    888 "Y888888 888     "Y88888 888  888 "Y888888  "Y888

Welcome to Hardhat v2.8.4

? What do you want to do? …
  Create a basic sample project
  Create an advanced sample project
  Create an advanced sample project that uses TypeScript
▸ Create an empty hardhat.config.js # 請選擇這個選項，並按 Enter
  Quit

$ ls
hardhat.config.js  node_modules  package.json  yarn.lock
  1. 你可以發現 hardhat_fork 資料夾底下多了一個名為 hardhat.config.js 的檔案；它就是用來調整 Hardhat Network 和其他 hardhat 套件運作模式的重要參數檔。

Step 2：調整 hardhat.config.js​

目標：設定進行 mainnet forking 所需的相關參數

  1. 在 hardhat_fork 資料夾，新增一個空白檔案叫做 .env，並以文字編輯器將以下內容插入其中
    • 記得先前往 Alchemy 註冊帳號，並創立一個空白 app 專案（預設可存取 archive node）
Mainnet = "https://eth-mainnet.alchemyapi.io/v2/<your_Alchemy_key>"
  1. 使用任何文字編輯器，對 hardhat.config.js 進行編輯，將檔案改成以下樣子（可以直接複製、貼上，取代全部檔案內容）
require("@nomiclabs/hardhat-waffle");
require("@nomiclabs/hardhat-web3");
require("@nomiclabs/hardhat-ethers");
require('dotenv').config();

task("height", "Print the current block height")
  .setAction(async (taskArgs) => {
    const block_height = await web3.eth.getBlockNumber();
    console.log(`The current block height is ${block_height}`);
  });

module.exports = {
  networks: {
    hardhat: {
      forking: {
        url: process.env.Mainnet,
        blockNumber: 14297759
      }
    }
  }
};
// 高度 14297759 發生在 2022-03-01 00:00:18 (UTC+0)，選擇此數字方便後續解說
  1. 為什麼要這樣設定呢？
    • task() 的程式片段目的是創造能印出目前區塊高度的指令（以 Hardhat Network 分叉出來的主網來看），關於 task 的編寫方法詳見文末的延伸閱讀
    • network 項目底下，我們設定 hardhat 網路的相關參數，包含 archive node 的存取網址與分叉高度
    • 由於 network 項目底下可以同時設定多個不同的網路，以下為簡易範例，詳細辦法請參見文末延伸閱讀
module.exports = {
  solidity: {...},
  networks: {
    arbitrum: {
      url: process.env.Arbitrum, 
      accounts: [process.env.PriKey0, process.env.PriKey1]
    },
    hardhat: {...}
  }
};

Step 3：使用自定義的 Hardhat task height​

目標：透過自定義的 height task 來確認 mainnet forking 可正常運作

  1. 列出所有可用的 Hardhat task
    • --network "hardhat" 代表命令 Hardhat 使用 Hardhat Network
    • 如果讀者在 hardhat.config.js 裡面設置其他網路，則可透過此參數隨時切換網路
    • 我們可以發現到「AVAILABLE TASKS」出現了一行 height Print the current block height 文字，與稍早我們在 hardhat.config.js 撰寫的內容一致
$ yarn hardhat --network "hardhat" help
yarn run v1.22.17
Hardhat version 2.8.4

Usage: hardhat [GLOBAL OPTIONS] <TASK> [TASK OPTIONS]

GLOBAL OPTIONS:
  --config              A Hardhat config file.
  --emoji               Use emoji in messages.
  --help                Shows this message, or a task's help if its name is provided
  --max-memory          The maximum amount of memory that Hardhat can use.
  --network             The network to connect to.
  --show-stack-traces   Show stack traces.
  --tsconfig            A TypeScript config file.
  --verbose             Enables Hardhat verbose logging
  --version             Shows hardhat's version.

AVAILABLE TASKS:
  check         Check whatever you need
  clean         Clears the cache and deletes all artifacts
  compile       Compiles the entire project, building all artifacts
  console       Opens a hardhat console
  flatten       Flattens and prints contracts and their dependencies
  height        Print the current block height
  help          Prints this message
  node          Starts a JSON-RPC server on top of Hardhat Network
  run           Runs a user-defined script after compiling the project
  test          Runs mocha tests
  1. 運行 height 指令
    • 由於目前 Ethereum 的最新區塊高度必定不只 14297759，因此可見我們已成功創造一個全新的 mainnet forking 環境
$ yarn hardhat --network "hardhat" height
yarn run v1.22.17
The current block height is 14297759
  1. 利用 node 指令，開始運作 Hardhat Network 節點
    • 請注意：這些地址與私鑰都由已知的 key derivation 過程7產生；換句話說，任何使用 Hardhat 的開發者皆知這些私鑰，因此切勿在公開網路將東西傳送進這些地址！
    • 前文已提過 Hardhat Network 預設提供 20 個各具 10000 ETH 的帳號供開發者自由使用
    • 搭配我們現已學會的 mainnet forking 技巧，則可開始使用這些幾乎用不完的 ETH ，在自己的 local testnet 做各類開發
$ yarn hardhat --network "hardhat" node
yarn run v1.22.17
Started HTTP and WebSocket JSON-RPC server at http://127.0.0.1:8545/

Accounts
========

WARNING: These accounts, and their private keys, are publicly known.
Any funds sent to them on Mainnet or any other live network WILL BE LOST.

Account #0: 0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266 (10000 ETH)
Private Key: ...

Account #1: 0x70997970c51812dc3a010c7d01b50e0d17dc79c8 (10000 ETH)
Private Key: ...

...

Account #19: 0x8626f6940e2eb28930efb4cef49b2d1f2c9c1199 (10000 ETH)
Private Key: ...

WARNING: These accounts, and their private keys, are publicly known.
Any funds sent to them on Mainnet or any other live network WILL BE LOST.

本文到此已完成所有步驟，恭喜各位讀者已學會如何使用 Hardhat 進行 mainnet forking。另一篇文章將操作簡單的範例，向有興趣的讀者展示 Hardhat Network 的有趣應用。

Further reading​

  1. 例如：Rinkeby、Goerli、Kintsugi 等↩
  2. 可能因不同 testnet 共識機制，而與主網略有差異，但是一般來說很罕見出現 Dapp 能夠運行於 testnet 卻無法運行於 mainnet，尤其所有網路的 EVM 實作細節均相同↩
  3. https://hardhat.org/hardhat-network/guides/mainnet-forking.html#mainnet-forking↩
  4. 透過樹梅派 4B 可以搭建歸檔節點，不以挖礦為目的來搭建歸檔節點非難事，只需要準備大容量的 SATA3 SSD 即可，詳細請參考文末的延伸閱讀 Ethereum on ARM↩
  5. Infura、Alchemy、QuickNode 均有提供存取歸檔節點的服務，其中 Alchemy 在作者撰文時為免費服務。↩
  6. 有興趣的讀者請參見這個連結 https://hardhat.org/hardhat-network/reference/#accounts↩