Introduction à Hardhat
Dans cet article, nous allons introduire Hardhat et passer en revue ses principales fonctionnalités. Elles feront l'objet d'articles/tutoriels plus détaillés dans le futur.
Hardhat ?
Crée par Nomic Labs, Hardhat est un environment de développement pour les dApp tournant sur une EVM. Il vous aide à diverses étapes de votre travail telles que :
- compilation du code Solidity
- déploiement
- automatisation de tâches récurrentes
- tests
- débogage de votre smart contract
Hardhat amène sa propre version modifiée de l'EVM que vous pouvez utiliser lors de vos phases de tests. Cette EVM modifiée rajoute des aides utiles vous permettant de tester plus efficacement votre code.
Alternatives
Hardhat n'est pas le seul outil dans sa catégorie, vous connaissez peut-être Truffle qui possède des fonctionnalités assez semblables.
Brownie est un outil écrit en python qui possède des capacités similaires à Truffle. Si vous êtes plus à l'aise avec python alors cet outil est probablement un bon choix pour vous.
Il y a aussi Foundry un nouveau venu sur la scène des outils de développement web3. Il promet une plus grande rapidité d'exécution des tests . Ceci est surement dû au fait que contrairement à Hardhat ou truffle, qui sont écrit à l'aide de Javascript, Foundry utilise Rust.
Un dernier outil concurrent à Hardhat : dApp.tools.
On fera peut-être une série d'articles allant plus en profondeur sur ces outils dans le futur.
Forces
Globalement, Hardhat est plus facile d'utilisation. La possibilité de faire tourner ses tests en utilisant une copie de l'état d'une blockchain, à un certain block, est très puissante. Permettant d'effectuer ses tests de manière déterministe avec un temps de mise en place moindre. Il est aussi plus rapide lors de l'exécution des tests que Truffle, cela peut vous faire gagner pas mal de temps.
À noter que Foundry met en avant le fait qu'il soit plus rapide qu'Hardhat sur ce point.
Le système de plugins est très intéressant et permet d'étendre les fonctionnalités d'Hardhat. Par exemple, il existe un plugin qui calcul le cout de chaque transaction effectué lors de vos tests. Un autre vous permettra d'automatiquement vérifier vos smart contracts sur etherscan ou snowtrace. Nous vous recommandons de jeter un coup d'œil à cette page.
Il semblerait qu'Hardhat soit l'outil, à ce jour, le plus complet et performant vous permettant de développer et tester votre code Solidity.
Hardhat Network
Une des forces d'Hardhat est qu'il soit livré avec Hardhat Network, une version modifiée de l'EVM. Cette version incorpore des changements destinés à faciliter la vie des développeurs web3, en rajoutant par exemple des messages d'erreurs plus clairs lors de problèmes à l'exécution de vos transactions. Rajoutant des stack traces montrant précisément où celle-ci a rencontré un problème.
Voici un exemple de stack trace venant de la -au passage très bonne- documentation d'Hardhat.
Error: Transaction reverted: function selector was not recognized and there's no fallback function
at ERC721Mock.<unrecognized-selector> (contracts/mocks/ERC721Mock.sol:9)
at ERC721Mock._checkOnERC721Received (contracts/token/ERC721/ERC721.sol:334)
at ERC721Mock._safeTransferFrom (contracts/token/ERC721/ERC721.sol:196)
at ERC721Mock.safeTransferFrom (contracts/token/ERC721/ERC721.sol:179)
at ERC721Mock.safeTransferFrom (contracts/token/ERC721/ERC721.sol:162)
at TruffleContract.safeTransferFrom (node_modules/@nomiclabs/truffle-contract/lib/execute.js:157:24)
at Context.<anonymous> (test/token/ERC721/ERC721.behavior.js:321:26)
On voit ici que la stack trace montre clairement quel contract et à quelle ligne l'erreur est survenu. On peut aussi voir quel test l'a déclenché.
Un autre rajout essentiel est celui du console.log dans le code Solidity. Vous donnant la possibilité
d'avoir un aperçu de ce qui se passe dans votre code, vous aidant ainsi fortement dans votre processus de développement
et de test.
Il est aussi possible de démarrer Hardhat Network Node via votre terminal et de l'utiliser comme client RPC pour des applications telles que Metamask, un bot que vous développez ou n'importe quelle dApp (bien sûr le réseau en découlant sera un réseau destiné aux tests). Très utile pour des tests d'intégration en environnement contrôlé.
Il est intéressant de noter que par défaut ce réseau va miner un nouveau block à chaque transaction que vous allez effectuer dans vos tests. Ceci est entièrement configurable.
Hardhat Runner
C'est le CLI qui vous permettra d'intéragir avec Hardhat. Hardhat est orienté autours de tasks, chaque commande que vous lancerez sera en fait définie par une task.
Voici un example de commande:
npx hardhat test
Il n'y a pas de piège et cette commande va juste lancer l'exécution de tous les tests se trouvant dans votre dossier test.
Voici une liste des différentes tasks par 'default' :
$ npx hardhat
Hardhat version 2.0.8
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:
accounts Prints the list of accounts
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
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
To get help for a specific task run: npx hardhat help [task]
Tasks
Lorsque vous lancez une commande depuis le runner, vous utilisez une task.
Dans la section précédente nous avons vu qu'avec le CLI on peut lancer l'exécution de tasks. Celles-ci peuvent être
celles par défaut d'Hardhat telles que test , compile mais aussi des tasks que vous aurez défini vous-même.
Ces tasks personnalisés sont à définir dans le dossier /scripts en Typescript (je vous encourage vraiment à prendre le
temps de setup Hardhat avec Typescript et de ne pas utiliser directement Javascript). Elles pourront
ensuite être exécutées via la commande
npx hardhat run nomdelacommande. Cela peut être très utile pour effectuer des tâches récurrentes. Voici un exemple de
workflow possible :
- création d'un réseau hardhat network dans un terminal, basé sur l'état de la Cchain d'Avalanche à un block précis.
- exécution d'une task qui va envoyer des transactions à un smart contract déjà déployé sur la CChain, permettant ainsi de créer un environnement de test contrôlé
- test de l'application, se connectant au réseau hardhat (par défaut le rpc il sera disponible ici :
127.0.0.1:8545)
Voici une d'une task personnalisée, le fichier se nomme check_price.ts. Cela va simplement appeler la
fonction getReserves de la paire Wavax-USDT.e de Trader Joe et calculer le prix actuel, en USDT.e, d'un WAVAX.
import { ethers } from "hardhat";
import * as dotenv from "dotenv";
import { BigNumber, Wallet } from "ethers";
const main = async (): Promise<any> => {
const tjWavaxUsdtePair = await ethers.getContractAt("IJoePair", "0xed8cbd9f0ce3c6986b22002f03c6475ceb7a6256");
let reserves = await tjWavaxUsdtePair.getReserves();
let wavaxDecimal = reserves[0].div(BigNumber.from("1000000000000000000")).toNumber()
let usdteDecimal = reserves[1].div(BigNumber.from("1000000")).toNumber()
let timestamp = reserves[2]
console.log("Price in TJ : " + usdteDecimal / wavaxDecimal);
}
main()
.then(() => process.exit(0))
.catch(error => {
console.error(error)
process.exit(1)
})
On peut lancer l'exécution de cette task via npx hardhat run check_price
Plugins
Comme mentionné plus haut, une des forces d'Hardhat est sa modularité et son extensibilité. Les plugins sont utilisés pour intégrer à Hardhat les possibilités d'autres librairies.
Il existe quelques plugins "officiels" et d'autres fournit par la communauté.
Certain permettent de vérifier facilement vos smart contracts sur etherscan Un autre vous permet de voir le code coverage actuel de votre code Solidity.
Tests
Hardhat facilite grandement le testage de vos smart contracts et si vous avez déjà utilisé Mocha pour un projet "web2" vous ne serez pas trop dépaysés.
Voici un aperçu d'un test de smart contract avec Hardhat:
const { expect } = require("chai");
describe("Token contract", function () {
it("Deployment should assign the total supply of tokens to the owner", async function () {
const [owner] = await ethers.getSigners();
const Token = await ethers.getContractFactory("Token");
const hardhatToken = await Token.deploy();
const ownerBalance = await hardhatToken.balanceOf(owner.address);
expect(await hardhatToken.totalSupply()).to.equal(ownerBalance);
});
});