在私有链上部署 ENS

如果你希望在自己的网络上部署 ENS,或者在公共网络上部署自己的 ENS 副本,本指南将向你展示如何进行部署。如果你想使用现有的 ENS 部署,请参阅 域名解析域名管理域名注册和续费

为了简单起见,在本页面我们会用到 Javascript 、Web3 和 npm 上的 Hardhat。完整的部署文件示例可以 在这个页面的底部 查看。

另外,现有的框架,比如 waffleembark 也支持本地 ENS 部署。

引用合约

ENS 的基础合约已经以 npm 模块 的方式发布,你可以在你的 npm 项目中,通过 npm install @ensdomains/ens-contracts 这条命令来安装它们。现在,你还可以在部署脚本中按照下面的方式请求它们(与 npm 和 artifacts 包进行交互的详细信息请参阅 Truffle Documentation

import {
ENS, ENSRegistry, PublicResolver
} from '@ensdomains/ens-contracts'

在你的智能合约中引用 ENS 合约的方式如下:

import '@ensdomains/ens-contracts/contracts/registry/ENS.sol'

ENS 只包含了接口信息,而 ENSRegistry 则包含着实际的实现.

部署注册表

注册表是 ENS 的核心组件并存储着 ENS 的关键信息,其中包括谁拥有哪个域名等信息。这里有一个利用 ethers 和 hardhat 来实现的示例:

const ENSRegistry = await ethers.getContractFactory("ENSRegistry")
await ENSRegistry.deploy()

完成部署后,将会产生一个新的 ENS 注册表,它的根节点由实施部署事务的帐户拥有。该帐户对 ENS 注册表拥有完全的控制权,它可以创建和替换整个域名树中的任何节点。

进行到这一步,已经可以像 域名管理 中所描述的那样,通过直接操作注册表来创建和管理域名。但是,你可能还想要 部署一个解析器,然后再 部署一个注册器,以便于其他用户注册域名。

部署解析器

注册表中的记录可以指向解析器合约,而解析器合约中存储着域名的一些相关信息,其中最常见的用例是存储域名的地址,但是也可以存储合约的 ABI 或文本。有一个不受限制的通用解析器,对于私有网络上的大多数用途来说是很方便的。部署一个解析器也很简单:

const ZERO_ADDRESS = "0x0000000000000000000000000000000000000000";
const ENSRegistry = await ethers.getContractFactory("ENSRegistry")
const registry = await ENSRegistry.deploy()
await registry.deployed()
const PublicResolver = await ethers.getContractFactory("PublicResolver")
const resolver = await PublicResolver.deploy(registry.address, ZERO_ADDRESS);
await resolver.deployed()

公共解析器 PublicResolver 需要在注册表中查询域名的所有权,因此部署解析器时需要用到注册表的地址信息。

为便于使用,我们可以给这个解析器起个名:

const namehash = require('eth-ens-namehash');

async function setupResolver(ens, resolver, accounts) {
const resolverNode = namehash.hash("resolver");
const resolverLabel = labelhash("resolver");

await ens.setSubnodeOwner("0x0000000000000000000000000000000000000000", resolverLabel, accounts[0]);
await ens.setResolver(resolverNode, resolver.address);
await resolver.setAddr(resolverNode, resolver.address);
}

在上面的代码中,我们首先创建一个新的顶级域名 “resolver” ,然后将其解析器的地址设置为新部署的公共解析器,然后我们为 “resolver” 建立了一个域名解析记录,这个记录又指向了公共解析器地址。实际上,公共解析器返回的是关于其自身地址的查询结果。这样,每个人都可以通过这个专用的 ENS 域名 “resolver” 找到公共解析器。完成公共解析器部署后,我们会在 .then() 代码块中调用这个解析器设置函数。

部署注册器

进行到这一步,域名还只能由注册表中根节点的所有者来手动注册。幸运的是,合约也可以成为节点的所有者,也就是说我们可以在注册表中将一个注册器合约设置为节点的所有者(如 “test” 的所有者),这样,子域名的分发(如 “mycontract.test”)就可以由注册器合约来自动完成。这种机制使得我们能够以基于分布式的链上控制逻辑来管理域名的分发。在获得一个(子)节点的所有权之后,我们便能够以这种方式为其配置注册器。假设你是 “myorg” 组织的成员,你注册了 “myorg.test” 并将它指向了自定义注册器,这个注册器可以设置为只允许经过组织认证的成员才能申请像 “bob.myorg.test” 这样的子域名。对于示例中的私有网络,我们使用了较为简单的即时注册器 FIFSRegistrar ,并在部署脚本中将其设置为顶级域名 “test” 的所有者:

...
const registrar = await FIFSRegistrar.deploy(ens.address, ens.address, namehash.hash("test"));
await registrar.deployed();
await ens.setSubnodeOwner("0x0000000000000000000000000000000000000000", sha3("test"), registrar.address);
...

部署反向注册器

如果你希望在部署 ENS 时启用反向解析,就需要部署反向注册器:

...
const reverseRegistrar = await ReverseRegistrar.deploy(ens.address, resolver.address);
await reverseRegistrar.deployed();
setupReverseRegistrar(ens, resolver, reverseRegistrar, accounts);
...
})

async function setupReverseRegistrar(ens, resolver, reverseRegistrar, accounts) {
await ens.setSubnodeOwner("0x0000000000000000000000000000000000000000", utils.sha3("reverse"), accounts[0]);
await ens.setSubnodeOwner(namehash.hash("reverse"), utils.sha3("addr"), reverseRegistrar.address);
}

部署文件示例

我们可以将上述步骤合并到一个 hardhat 文件中,以便于一次性完成 ENS 部署:

contracts/deps.sol

//SPDX-License-Identifier: MIT
// These imports are here to force Hardhat to compile contracts we depend on in our tests but don't need anywhere else.
import "@ensdomains/ens-contracts/contracts/registry/ENSRegistry.sol";
import "@ensdomains/ens-contracts/contracts/registry/FIFSRegistrar.sol";
import "@ensdomains/ens-contracts/contracts/resolvers/PublicResolver.sol";

script/deploy.js

const hre = require("hardhat");
const namehash = require('eth-ens-namehash');
const tld = "test";
const ethers = hre.ethers;
const utils = ethers.utils;
const labelhash = (label) => utils.keccak256(utils.toUtf8Bytes(label))
const ZERO_ADDRESS = "0x0000000000000000000000000000000000000000";
const ZERO_HASH = "0x0000000000000000000000000000000000000000000000000000000000000000";
async function main() {
const ENSRegistry = await ethers.getContractFactory("ENSRegistry")
const FIFSRegistrar = await ethers.getContractFactory("FIFSRegistrar")
const ReverseRegistrar = await ethers.getContractFactory("ReverseRegistrar")
const PublicResolver = await ethers.getContractFactory("PublicResolver")
const signers = await ethers.getSigners();
const accounts = signers.map(s => s.address)
const ens = await ENSRegistry.deploy()
await ens.deployed()
const resolver = await PublicResolver.deploy(ens.address, ZERO_ADDRESS);
await resolver.deployed()
await setupResolver(ens, resolver, accounts)
const registrar = await FIFSRegistrar.deploy(ens.address, namehash.hash(tld));
await registrar.deployed()
await setupRegistrar(ens, registrar);
const reverseRegistrar = await ReverseRegistrar.deploy(ens.address, resolver.address);
await reverseRegistrar.deployed()
await setupReverseRegistrar(ens, registrar, reverseRegistrar, accounts);
};
async function setupResolver(ens, resolver, accounts) {
const resolverNode = namehash.hash("resolver");
const resolverLabel = labelhash("resolver");
await ens.setSubnodeOwner(ZERO_HASH, resolverLabel, accounts[0]);
await ens.setResolver(resolverNode, resolver.address);
await resolver['setAddr(bytes32,address)'](resolverNode, resolver.address);
}
async function setupRegistrar(ens, registrar) {
await ens.setSubnodeOwner(ZERO_HASH, labelhash(tld), registrar.address);
}
async function setupReverseRegistrar(ens, registrar, reverseRegistrar, accounts) {
await ens.setSubnodeOwner(ZERO_HASH, labelhash("reverse"), accounts[0]);
await ens.setSubnodeOwner(namehash.hash("reverse"), labelhash("addr"), reverseRegistrar.address);
}
// We recommend this pattern to be able to use async/await everywhere
// and properly handle errors.
main()
.then(() => process.exit(0))
.catch((error) => {
console.error(error);
process.exit(1);
});

要在 hardhat 上执行部署,请运行以下命令:

npx hardhat run scripts/deploy.js

一次性完成 ENS 部署

在有些情况下,你可能希望一次性完成注册器及其依赖的部署工作,这在单元测试中很有用,因为我们都希望单元测试是个从头开始的完整测试。而且在很多情况下,整体部署也比提交一系列单独的事务要快。

我们可以创建一个新的合约,并在该合约的构造函数中创建和设置所需的ENS合约,然后通过部署这个新合约来实现一次性部署。下面的合约代码中包含了所有必要的 ENS 合约,并将 eth 这一顶级域名的所有权分配给了 FIFS 注册器,这样任何 eth 域名都可以在这个单元测试中进行注册。

pragma solidity >=0.8.4;
import {INameWrapper, PublicResolver} from '@ensdomains/ens-contracts/contracts/resolvers/PublicResolver.sol';
import '@ensdomains/ens-contracts/contracts/registry/ENSRegistry.sol';
import '@ensdomains/ens-contracts/contracts/registry/FIFSRegistrar.sol';
import {NameResolver, ReverseRegistrar} from '@ensdomains/ens-contracts/contracts/registry/ReverseRegistrar.sol';
// Construct a set of test ENS contracts.
contract ENSDeployer {
bytes32 public constant TLD_LABEL = keccak256('eth');
bytes32 public constant RESOLVER_LABEL = keccak256('resolver');
bytes32 public constant REVERSE_REGISTRAR_LABEL = keccak256('reverse');
bytes32 public constant ADDR_LABEL = keccak256('addr');
ENSRegistry public ens;
FIFSRegistrar public fifsRegistrar;
ReverseRegistrar public reverseRegistrar;
PublicResolver public publicResolver;
function namehash(bytes32 node, bytes32 label) public pure returns (bytes32) {
return keccak256(abi.encodePacked(node, label));
}
constructor() public {
ens = new ENSRegistry();
publicResolver = new PublicResolver(ens, INameWrapper(address(0)));
// Set up the resolver
bytes32 resolverNode = namehash(bytes32(0), RESOLVER_LABEL);
ens.setSubnodeOwner(bytes32(0), RESOLVER_LABEL, address(this));
ens.setResolver(resolverNode, address(publicResolver));
publicResolver.setAddr(resolverNode, address(publicResolver));
// Create a FIFS registrar for the TLD
fifsRegistrar = new FIFSRegistrar(ens, namehash(bytes32(0), TLD_LABEL));
ens.setSubnodeOwner(bytes32(0), TLD_LABEL, address(fifsRegistrar));
// Construct a new reverse registrar and point it at the public resolver
reverseRegistrar = new ReverseRegistrar(
ens,
NameResolver(address(publicResolver))
);
// Set up the reverse registrar
ens.setSubnodeOwner(bytes32(0), REVERSE_REGISTRAR_LABEL, address(this));
ens.setSubnodeOwner(
namehash(bytes32(0), REVERSE_REGISTRAR_LABEL),
ADDR_LABEL,
address(reverseRegistrar)
);
}
}
转载本站内容请注明出处和链接。咨询 ENS 问题或加入 ENS 中文社区请联系 我们