hardhat-ens-mock

This plugin sets up ENS for use in Hardhat

What

As an EVM dev that likes to test his code, I often find myself working with hardhat forks from other chains, and then linking all sorts of applications that need orchestration, for example through docker. I 've always found it hard to make simple orchestrations work, mainly due to the ever changing nature of the blockchain state, I would always need to deploy some contracts, addresses may or may have not changed since the last run, I must copy them over in the form of environment variables to the rest of the apps, etc.

With this plugin, I intend to build a tool for hardhat that allows to bootstrap and manipulate a predictable ENS deployment that helps me in orchestrating this stuff. By providing a static, predictable layer, I can deploy a contract, ABI or any arbitrary data to an ENS name that is always live in the ENS registry at 0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e, without worrying of which address the contract had, or which tokenID, or if the ABI has changed, etc.

Installation

<A step-by-step guide on how to install the plugin>

npm install --save-dev hardhat-ens-mock

or

yarn add -D hardhat-ens-mock

Import the plugin in your hardhat.config.js:

require("hardhat-ens-mock");

Or if you are using TypeScript, in your hardhat.config.ts:

import "hardhat-ens-mock";

Tasks

This plugin creates no additional tasks.

Environment extensions

This plugin exposes ensMock in the HRE. This field exposes to things:

• server: Exposed while using task hardhat node, gives access to Hardhat 's internal EthereumProvider
• setDomainOwner(domain, owner): Use it to directly set an owner for a domain. You can take this is as a shortcut to implementing all the boilerplate logic down from the root node.
• setDomainResolver(domain, resolver): Same as above, for resolver

Configuration

This plugin extends the hardhat with an ensMock object whose default values are indicated below.

module.exports = {
  networks: {
    hardhat: {
      ensMock: {
        enabled: true,
        ensOwnerAccount: 0,
      },
    },
  },
};

Enabled

Self explanatory: if set to false, the plugin will be left without effect

ensOwnerAccount

Hardhat exposes a list of accounts. The owner of the root node 0x00 in ENS (from which you can spawn additional domains, like .eth, .test, .xyz, and subsequents children) will be set to the account located at the index of ensOwnerAccount.

For example, if this is the account list exposed by Hardhat:

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

Account #2: 0x3c44cdddb6a900fa2b585dd299e03d12fa4293bc (10000 ETH)
Private Key: 0x5de4111afa1a4b94908f83103eb1f1706367c2e68ca870fc3fb9a804cdab365a

Account #3: 0x90f79bf6eb2c4f870365e785982e1f101e93b906 (10000 ETH)
Private Key: 0x7c852118294e51e653712a81e05800f419141751be58f605c371e15141b007a6

Account #4: 0x15d34aaf54267db7d7c367839aaf71a00a2c6a65 (10000 ETH)
Private Key: 0x47e179ec197488593b187f80a00eb0da91f1b9d0b13f8733639f19c30a34926a

Account #5: 0x9965507d1a55bcc2695c58ba16fb37d819b0a4dc (10000 ETH)
Private Key: 0x8b3a350cf5c34c9194ca85829a2df0ec3153be0318b5e2d3348e872092edffba

Account #6: 0x976ea74026e726554db657fa54763abd0c3a0aa9 (10000 ETH)
Private Key: 0x92db14e403b83dfe3df233f83dfa3a0d7096f21ca9b0d6d6b8d88b2b4ec1564e

Account #7: 0x14dc79964da2c08b23698b3d3cc7ca32193d9955 (10000 ETH)
Private Key: 0x4bbbf85ce3377467afe5d46f804f221813b2bb87f24d81f60f1fcdbf7cbf4356

Account #8: 0x23618e81e3f5cdf7f54c3d65f7fbc0abf5b21e8f (10000 ETH)
Private Key: 0xdbda1821b80551c9d65939329250298aa3472ba22feea921c0cf5d620ea67b97

Account #9: 0xa0ee7a142d267c1f36714e4a8f75612f20a79720 (10000 ETH)
Private Key: 0x2a871d0798f97d79848a013d4936a73bf4cc922c825d33c1cf7073dff6d409c6

Account #10: 0xbcd4042de499d14e55001ccbb24a551f3b954096 (10000 ETH)
Private Key: 0xf214f2b2cd398c806f84e317254e0f0b801d0643303237d97a22a48e01628897

Account #11: 0x71be63f3384f5fb98995898a86b02fb2426c5788 (10000 ETH)
Private Key: 0x701b615bbdfb9de65240bc28bd21bbc0d996645a3dd57e7b12bc2bdf6f192c82

Account #12: 0xfabb0ac9d68b0b445fb7357272ff202c5651694a (10000 ETH)
Private Key: 0xa267530f49f8280200edf313ee7af6b827f2a8bce2897751d06a843f644967b1

Account #13: 0x1cbd3b2770909d4e10f157cabc84c7264073c9ec (10000 ETH)
Private Key: 0x47c99abed3324a2707c28affff1267e45918ec8c3f20b8aa892e8b065d2942dd

Account #14: 0xdf3e18d64bc6a983f673ab319ccae4f1a57c7097 (10000 ETH)
Private Key: 0xc526ee95bf44d8fc405a158bb884d9d1238d99f0612e9f33d006bb0789009aaa

Account #15: 0xcd3b766ccdd6ae721141f452c550ca635964ce71 (10000 ETH)
Private Key: 0x8166f546bab6da521a8369cab06c5d2b9e46670292d85c875ee9ec20e84ffb61

Account #16: 0x2546bcd3c84621e976d8185a91a922ae77ecec30 (10000 ETH)
Private Key: 0xea6c44ac03bff858b476bba40716402b03e41b8e97e276d1baec7c37d42484a0

Account #17: 0xbda5747bfd65f08deb54cb465eb87d40e51b197e (10000 ETH)
Private Key: 0x689af8efa8c651a91ad287602527f3af2fe9f6501a7ac4b061667b5a93e037fd

Account #18: 0xdd2fd4581271e230360230f9337d5c0430bf44c0 (10000 ETH)
Private Key: 0xde9be858da4a475276426320d5e9262ecfc3ba460bfac56360bfa6c4c28b4ee0

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

Setting ensOwnerAccount to 3 will make 0x90f79bf6eb2c4f870365e785982e1f101e93b906 the owner of the ENS 's root node.

Usage

You can now use ENS in your ethers or web3 framework as usual once the plugin is imported

Some resources used to build this plugin

https://programtheblockchain.com/posts/2018/03/09/understanding-ethereum-smart-contract-storage/ http://man.hubwiz.com/docset/Ethereum.docset/Contents/Resources/Documents/eth_getStorageAt.html https://www.npmjs.com/package/@ensdomains/ens-contracts https://docs.ens.domains/contract-api-reference/name-processing