当前位置: 首页 > 文档资料 > ENS 中文文档 >

控制器

优质
小牛编辑
135浏览
2023-12-01

源代码

本节要讲的是.eth注册中心控制器(ETHRegistrarController)的各个部分,这些内容与那些编写注册中心控制器交互工具的开发者息息相关。为简洁起见,省略了注册中心所有者特有的功能。

控制器只与明文标签一起工作(例如,"alice"代表"alice.eth")。

为了防止域名抢注,.eth注册中心控制器需要对新域名注册(但不需要对续期)执行一个"委托-揭示"的过程。要注册一个域名,用户必须:

  1. 利用待注册域名和一个秘密值生成一个固定长度的散列。
  2. 将第1步中生成的定长散列提交给控制器。
  3. 等待至少1分钟,但别超过24小时。
  4. 将这个域名的注册请求以及来自第1步的秘密值一起提交。

这个过程保证了注册不会被抢注,除非攻击者能够审查至少1分钟前用户委托注册域名的交易。

示例

域名注册

下面的示例演示了注册域名所需的步骤。

web3.js

const controller = web3.eth.contract(controller_abi).at(controller_address);
async function register(name, owner, duration) {
  // Generate a random value to mask our commitment
  const random = new Uint8Array(32);
  crypto.getRandomValues(random);
  const salt = "0x" + Array.from(random).map(b => b.toString(16).padStart(2, "0")).join("");
  // Submit our commitment to the smart contract
  const commitment = await controller.makeCommitment(name, owner, salt);
  // Add 10% to account for price fluctuation; the difference is refunded.
  const price = (await controller.rentPrice(name, duration)) * 1.1;
  // Wait 60 seconds before registering
  setTimeout(async () => {
    // Submit our registration request
    await controller.register(name, owner, duration, salt, {value: price});
  }, 60000);
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

For clarity, this example is written using async rather than callbacks. As a result, this example works in web3 1.0.x; note that it will not work in the web3 injected by MetaMask, as this presently is an older version lacking async support.

读取操作

获取最短委托时间

uint constant public MIN_COMMITMENT_AGE;
1

这个公共常量表示委托的最短时间(以秒为单位),一次委托只能在它被打包后至少经过这么多秒才能被揭示。

DApps应该获取这个常量,而不是对当前值进行硬编码,因为这个常量可能会在以后的升级中发生变化。

获取最长委托时间

uint constant public MAX_COMMITMENT_AGE;
1

这个公共常量表示委托的最长时间(以秒为单位),一个委托在它被打包后经过这么多秒之后就会失效,不能再用于注册域名。

DApps应该获取这个常量,而不是对当前值进行硬编码,因为这个常量可能会在以后的升级中发生变化。

获取最短注册时间

uint constant public MIN_REGISTRATION_DURATION;
1

这个公共常量表示注册的最短持续时间(以秒为单位),少于此期限的注册将被拒绝。

DApps应该获取这个常量,而不是对当前值进行硬编码,因为这个常量可能会在以后的升级中发生变化。

获取委托时间戳

mapping(bytes32=>uint) public commitments;
1

commitments存储了从每一份提交的委托到对应委托时间戳的映射。在提交注册交易之前,希望验证委托有效性的调用者应该先检查这个映射。

获取租金价格

function rentPrice(string name, uint duration) view public returns(uint);
1

rentPrice按照参数中提供的域名和时长,返回注册或续期所需的费用(以wei为单位)。调用者应该注意到这个价格可能随着时间的推移而变化,特别是价格预言机依赖于Fiat汇率的时候。

调用者应该使用这个函数来获取注册费用并显示给用户,而不是在应用程序内部计算这些费用,因为以后对价格预言机的变更或升级可能会产生不同的定价方案,而且每年的注册费用取决于域名长度、注册持续时间或其他变量。

检查域名的有效性

function valid(string name) public view returns(bool);
1

如果这个域名符合该控制器对注册的有效性要求(比如它满足长度要求),则valid返回true。

检查域名的可用性

function available(string name) public view returns(bool);
1

如果这个域名符合该控制器对注册的有效性要求,并且可以注册,则available返回true。在这个函数内部,使用了valid函数(上面的)和注册中心合约中的available函数,available函数同时检查域名在旧版ENS注册中心和当前ENS注册中心中的可用性。

调用者应该使用这个函数来检查域名是否可以注册,而不要用注册中心合约中的available函数,后者不检查域名的长度。

计算委托散列

function makeCommitment(string name, address owner, bytes32 secret) pure public returns(bytes32);
1

makeCommitment从域名标签(比如'myname',而不是'myname.eth')和秘密值生成并返回一个委托散列。

写入操作

提交委托

function commit(bytes32 commitment) public;
1

commit用于提交预委托,这个预委托是通过调用makeCommitment生成的。

注册域名

function register(string name, address owner, uint duration, bytes32 secret) public payable;
1

register用于注册域名,有效的注册请求必须符合下列准则:

  1. available(name) == true
  2. duration >= MIN_REGISTRATION_DURATION
  3. secret用于判定一个有效的委托(例如,commitments[makeCommitment(name, secret)])存在,并且在1分钟到24小时之间
  4. msg.value >= rentPrice(name, duration)

由于租金价格可能会随时间变化,所以建议调用者发送的租金略高于rentPrice返回的价格,5-10%的溢价应该就足够了,多余的资金都会返还给调用者。

调用成功会触发以下事件:

event NameRegistered(string name, bytes32 indexed label, address indexed owner, uint cost, uint expires);
1

调用成功还会连带注册中心触发一个域名注册事件,并连带ENS注册表触发一个NewOwner事件

延长域名有效期

function renew(string name, uint duration) external payable;
1

renew用于续期一个域名。只要提供足够的资金,任何人都可以调用这个函数。由于租金价格可能会随时间变化,所以建议调用者发送的租金略高于rentPrice返回的价格,5-10%的溢价应该就足够了,多余的资金都会返还给调用者。

调用成功会触发以下事件:

event NameRenewed(string name, bytes32 indexed label, uint cost, uint expires);
1

调用成功还会连带注册中心触发一个域名续期事件

进一步查看