Hardhat (твердая шляпа, каска) - фреймворк для компиляции, тестирования и деплоя смарт-контракта в локальной сети hardhat network. Этот проект содержит начальный код и инструкции для создания распределенного приложения на основе react и hardhat.
Структура проекта включает в себя основные директории:
/app- фронтенд наReact;/contracts- файлы с исходным кодом смарт-контрактов;/test- файлы для тестирования смарт-контрактов.
Для работы понадобится nodejs 20 версии, git и редактор VS Code. Настоятельно рекомендуем работать в среде linux или macOS. Стабильность работы в среде WSL windows не гарантируется.
Клонируйте репозиторий и установите зависимости для hardhat:
git clone https://github.com/labintsev/hardhat-tutorial
cd hardhat-tutorial
npm iСоздайте новое приложение с помощью vite
npm create vite@latest app --template reactУстановите зависимости, запустите приложение, проверьте его работу.
cd app
npm i
npm run devПосле этого можно остановить приложение, нажав в терминале CTRL-C.
Откройте новый терминал и в корневой папке проекта выполните инициализацию с пустым файлом hardhat.config.js
Для этого выполните команду:
npx hardhat initС помощью стрелок выберите пункт Create an empty hardhat.config.js и нажмите ввод.
В созданном файле hardhat.config.js добавьте следующие настройки:
require("@nomicfoundation/hardhat-toolbox");
/** @type import('hardhat/config').HardhatUserConfig */
module.exports = {
solidity: "0.8.19",
paths: {
artifacts: "./app/src/artifacts",
},
};Здесь мы определяем версию компилятора solidity, который используется для компиляции смарт-контрактов в этом проекте.
Важно отметить, что hardhat использует реализацию solcjs независимо от системного solc.
Переменная paths: { artifacts: "./app/src/artifacts", }, отвечает за тот путь, в который будут размещаться результаты компиляции (артифакты) смарт-контрактов.
Мы размещаем их в папке фронтенд приложения, т.к. деплой и обращение к публичным методам смарт-контракта будут проводиться из пользовательского интерфейса.
Напишем простой смарт-контракт, который выдает токены всем желающим.
Здесь под токеном мы понимаем некоторую условную единицу, например виртуальную шоколадку в вендинговой машине.
Сам токен ничего не стоит, однако необходимо уплатить комиссию за размещение (деплой) смарт-контракта и вызов его публичных методов.
При размещении смарт-контракта в локальной или тестовой сети эта комиссия ничего не стоит.
Однако при размещении в настоящей сети Ethereum mainnet за каждую транзакцию нужно расплачиваться реальной криптовалютой ETH.
В корне проекта создайте директорию contracts/, а в ней файл Token.sol.
Наполните содержимое этого файла:
//SPDX-License-Identifier: UNLICENSED
// Solidity files have to start with this pragma.
// It will be used by the Solidity compiler to validate its version.
pragma solidity ^0.8.0;
// This is the main building block for smart contracts.
contract Token {
// Some string type variables to identify the token.
string public name = "My Hardhat Token";
string public symbol = "MHT";
// The fixed amount of tokens, stored in an unsigned integer type variable.
uint256 public totalSupply = 1000000;
// An address type variable is used to store ethereum accounts.
address public owner;
// A mapping is a key/value map. Here we store each account's balance.
mapping(address => uint256) balances;
// The Transfer event helps off-chain applications understand
// what happens within your contract.
event Transfer(address indexed _from, address indexed _to, uint256 _value);
/**
* Contract initialization.
*/
constructor() {
// The totalSupply is assigned to the transaction sender, which is the
// account that is deploying the contract.
balances[msg.sender] = totalSupply;
owner = msg.sender;
}
/**
* A function to transfer tokens.
*
* The `external` modifier makes a function *only* callable from *outside*
* the contract.
*/
function transfer(address to, uint256 amount) external {
// Check if the transaction sender has enough tokens.
// If `require`'s first argument evaluates to `false` then the
// transaction will revert.
require(balances[msg.sender] >= amount, "Not enough tokens");
// Transfer the amount.
balances[msg.sender] -= amount;
balances[to] += amount;
// Notify off-chain applications of the transfer.
emit Transfer(msg.sender, to, amount);
}
/**
* Read only function to retrieve the token balance of a given account.
*
* The `view` modifier indicates that it doesn't modify the contract's
* state, which allows us to call it without executing a transaction.
*/
function balanceOf(address account) external view returns (uint256) {
return balances[account];
}
}Внимательно ознакомьтесь с содержимыми этого файла.
Для подсветки синтаксиса и других полезностей установите расширение hardhat для VSCode.
Скомпилируйте контракт командой:
npx hardhat compileВ консоли должно появиться сообщение об успешной компиляции:
Compiled 1 Solidity file successfully (evm target: paris).В корне проекта появится папка cache, а в папке app/src/artifacts - результаты компиляции.
Перед размещением контракта в тестовой сети полезно протестировать его инструментами hardhat.
Проблема заключается в том, что взаимодействие с контрактом осуществляется через интерфейс сторонней библиотеки, например ethers или web3.
В hardhat эта проблема решается с помощью собственной реализации интерфейса библиотеки ethers, которая эмулирует наличие тестовой сети.
В корне проекта создайте папку test, а в ней файл Token.js.
Наполните его содержимое:
const { expect } = require("chai");
const { ethers } = require("hardhat");
describe("Token contract", function () {
it("Deployment should assign the total supply of tokens to the owner", async function () {
const [owner] = await ethers.getSigners();
const hardhatToken = await ethers.deployContract("Token");
const ownerBalance = await hardhatToken.balanceOf(owner.address);
expect(await hardhatToken.totalSupply()).to.equal(ownerBalance);
});
});Обратите внимание, что в зависимостях корневого проекта package.json нет библиотеки ethers, они импортируется из пакета hardhat.
Метод ethers.getSigners() возвращает фиктивный аккаунт владельца, который затем используется для проверки деплоя и вызова публичного метода смарт-контракта.
Запустите тест командой:
npx hardhat testВ консоли должно появиться сообщение об успешном выполнении теста:
Token contract
✔ Deployment should assign the total supply of tokens to the ownerДобавьте еще один тест для проверки перемещения токенов между аккаунтами и выполните его:
describe("Token contract", function () {
// ...previous test...
it("Should transfer tokens between accounts", async function() {
const [owner, addr1, addr2] = await ethers.getSigners();
const hardhatToken = await ethers.deployContract("Token");
// Transfer 50 tokens from owner to addr1
await hardhatToken.transfer(addr1.address, 50);
expect(await hardhatToken.balanceOf(addr1.address)).to.equal(50);
// Transfer 50 tokens from addr1 to addr2
await hardhatToken.connect(addr1).transfer(addr2.address, 50);
expect(await hardhatToken.balanceOf(addr2.address)).to.equal(50);
});
});Помимо заглушки библиотеки ethers, hardhat предоставляет более продвинутый инструмент тестирования.
Hardhat Network - это эмулятор полноценного узла сети Ethereum, который запускается на локальной машине.
Запустите эмулятор в отдельном терминале:
npx hardhat nodeВ консоли должно появиться сообщение о запуске JSON-RPC сервера и доступных аккаунтах:
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: 0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80
Account #1: 0x70997970C51812dc3A010C7d01b50e0d17dc79C8 (10000 ETH)
Private Key: 0x59c6995e998f97a5a0044966f0945389dc9e86dae88c7a8412f4603b6b78690dДля отправки запросов можно воспользоваться любым инструментом, например curl:
curl --data '{"jsonrpc":"2.0","method":"eth_getBalance", "params": ["0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266", "latest"], "id":2}' -H "Content-Type: application/json" localhost:8545На windows используйте curl.exe с явным преобразованием строки в json
$body = '{"jsonrpc":"2.0","method":"eth_getBalance", "params": ["0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266", "latest"], "id":2}' | ConvertTo-Json
curl.exe -d $body localhost:8545Для совершения транзакций есть более удобные инструменты, например geth или та же библиотека ethers. Однако самым удобным для пользователей, пожалуй, является кошелек, который устанавливается как расширение браузера.
Рекомендуем использовать MetaMask, т.к. он лучше всего подходит для децентрализованных приложений.
Настройка кошелька Создайте новую сеть вручную с параметрами
Network name: hardhat
New RPC URL: http://127.0.0.1:8545/
Chain ID: 31337
Currency symbol: HETH
Импортируйте аккаунт с помощью приватного ключа из консоли, например '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266'
Переведите 10 HETH на другой аккаунт, например 0x70997970C51812dc3A010C7d01b50e0d17dc79C8.
После этого добавьте второй аккаунт в кошелек с помощью команды Add account > Import account
Введите приватный ключ и проверьте, что баланс увеличился.
В консоли с запущенной сетью hardhat будут выводиться сообщения, которые обрабатываются узлом.
Транзакции могут не выполняться с ошибкой:
Nonce too high. Expected nonce to be 0 but got 2. Note that transactions can't be queued when automining.
Это связано с тем, что в кеше кошелька хранится количество совершенных транзакций аккаунта.
Сеть hardhat при каждом новом запуске создает новый блокчейн.
Поэтому счетчики nonce для блокчейна и кошелька могут не совпадать.
Это можно исправить, если в настройках кошелька очистить кеш: Settings > Advanced > Clear activity tab data.
Для размещения в смарт-контрактов в сети Ethereum мы будем использовать инструмент Hardhat Ignition.
Это декларативная система, которая упрощает деплой смарт-контрактов не только в тестовой, но и в основной сети.
Для описания порядка размещения смарт-контракта используются модули Ignition Modules.
Это обычные js-файлы, в которых описывается логика деплоя смарт-контракта.
Установите пакет Hardhat Ignition:
npm install --save-dev @nomicfoundation/hardhat-ignition-ethersВ файле конфигурации hardhat.config.js добавьте строку
require("@nomicfoundation/hardhat-ignition-ethers");Создайте папку ingnition/modules
mkdir ignition
mkdir ignition/modulesВ папке ingnition/modules определите модуль деплоя TokenDeploy.js
const { buildModule } = require("@nomicfoundation/hardhat-ignition/modules");
module.exports = buildModule("TokenDeploy", (mbuilder) => {
const account0 = mbuilder.getAccount(0); // or account = "0x123..."
const erc20_smart_contract = mbuilder.contract("Token", [], {from: account0});
return { erc20_smart_contract };
});Выполнените команду
npx hardhat ignition deploy ignition/modules/TokenDeploy.js --network localhostВ консоли должно появиться сообщение с адресом размещенного смарт-контракта
[ TokenDeploy ] successfully deployed 🚀
Deployed Addresses
TokenDeploy#Token - 0xe7f1725E7734CE288F8367e1Bb143E90bb3F0512
Этот адрес понадобится для покупки MyHardhatToken через пользовательский интерфейс.
Владельцем смарт-контракта по умолчанию является нулевой аккаунт сети hardhat.
Это свойство можно переопределить через вызов метода getAccount или задать адрес в виде строки.
Откройте код приложения src/App.js и замените содержимое на следующий код.
import { useState } from 'react'
import './App.css'
function App() {
const [account, setAccount] = useState('')
const [tokens, setTokens] = useState('no')
return (
<>
<h1>Token vending machine</h1>
<h3>Current account {account} has {tokens} Tokens</h3>
</>
)
}
export default AppВ папке app добавьте в зависимости package.json стабильную версию библиотеки ethers 5.7.2
"dependencies": {
...
"ethers": "^5.7.2"
}Обновите зависимости, запустите приложение и проверьте его работу.
Добавьте кнопку для обновления баланса токенов аккаунта
<button
onClick={(e) => {
e.preventDefault();
updateAccount();
}}
>Update Balance
</button>Добавьте метод, который читает баланс токенов из смарт-контракта, размещенного в сети hardhat.
import { ethers } from 'ethers';
const provider = new ethers.providers.Web3Provider(window.ethereum);
const ABI = [
// ERC20 Standart Read-Only Functions
"function balanceOf(address owner) view returns (uint256)",
"function decimals() view returns (uint8)",
"function symbol() view returns (string)",
// Authenticated Functions
"function transfer(address to, uint amount) returns (bool)",
// Events
"event Transfer(address indexed from, address indexed to, uint amount)"
];
// This can be an address or an ENS name
const CONTRACT_ADDRESS = "0xe7f1725E7734CE288F8367e1Bb143E90bb3F0512";
async function updateAccount() {
const accounts = await provider.send('eth_requestAccounts', []);
console.log("Available accounts: ", accounts);
const account = accounts[0];
setAccount(account);
const signer = provider.getSigner();
setSigner(signer);
console.log("Signer: ", signer);
const contract = new ethers.Contract(CONTRACT_ADDRESS, ABI, signer);
console.log("Contract: ", contract);
setContract(contract);
if (contract){
const tokens = await contract.balanceOf(account);
console.log("Tokens: ", tokens);
setTokens(tokens.toString());
}
} Переключите кошелек на другой аккаунт и проверьте баланс токенов. Верните обратно аккаунт владельца смарт-контракта и снова обновите баланс.
Добавьте поле ввода и кнопку для передачи токенов другому аккаунту.
<div>
<label>Send to:
<input type="text" id="address"/>
</label>
<label>Amount:
<input type="text" id="amount"/>
</label>
<button
onClick={(e) => {
e.preventDefault();
transferToken();
}}
> Transfer
</button>
</div>Добавьте стили в App.css
label {
display: flex;
flex-direction: column;
text-transform: uppercase;
color: #aaa;
margin: 20px;
}
input[type="text"] {
padding: 6px;
font-size: 18px;
}Добавьте функцию обработки транзакции
async function transferToken(){
const address = document.getElementById("address").value;
const amount = document.getElementById("amount").value;
console.log("Signer: ", signer);
console.log("Contract: ", contract);
const trx = await contract.connect(signer).transfer(address, amount);
console.log("Transaction: ", trx);
await trx.wait();
updateAccount();
}