ENS

Implementations for registrars and local resolvers for the Ethereum Name Service.

For documentation of the ENS system, see docs.ens.domains.

To run unit tests, clone this repository, and run:

$ npm install
$ npm test

npm package

This repo doubles as an npm package with the compiled JSON contracts

import {
  Deed,
  DeedImplementation,
  ENS,
  ENSRegistry,
  FIFSRegistrar,
  HashRegistrar,
  Migrations,
  Registrar,
  ReverseRegistrar,
  TestRegistrar
} from '@energi/ens'

ENSRegistry.sol

Implementation of the ENS Registry, the central contract used to look up resolvers and owners for domains.

FIFSRegistrar.sol

Implementation of a simple first-in-first-served registrar, which issues (sub-)domains to the first account to request them.

HashRegistrar.sol

Implementation of a registrar based on second-price blind auctions and funds held on deposit, with a renewal process that weights renewal costs according to the change in mean price of registering a domain. Largely untested!

HashRegistrarSimplified.sol

Simplified version of the above, with no support for renewals. This is the current proposal for interim registrar of the ENS system until a permanent registrar is decided on.

ENS Registry interface

The ENS registry is a single central contract that provides a mapping from domain names to owners and resolvers, as described in EIP 137.

The ENS operates on 'nodes' instead of human-readable names; a human readable name is converted to a node using the namehash algorithm, which is as follows:

def namehash(name):
  if name == '':
    return '\0' * 32
  else:
    label, _, remainder = name.partition('.')
    return sha3(namehash(remainder) + sha3(label))

The registry's interface is as follows:

owner(bytes32 node) constant returns (address)

Returns the owner of the specified node.

resolver(bytes32 node) constant returns (address)

Returns the resolver for the specified node.

setOwner(bytes32 node, address owner)

Updates the owner of a node. Only the current owner may call this function.

setSubnodeOwner(bytes32 node, bytes32 label, address owner)

Updates the owner of a subnode. For instance, the owner of "foo.com" may change the owner of "bar.foo.com" by calling setSubnodeOwner(namehash("foo.com"), sha3("bar"), newowner). Only callable by the owner of node.

setResolver(bytes32 node, address resolver)

Sets the resolver address for the specified node.

Resolvers

Resolvers can be found in the resolver specific repository.

Generating LLL ABI and binary data

ENS.lll.bin was generated with the following command, using the lllc packaged with Solidity 0.4.4:

$ lllc ENS.lll > ENS.lll.bin

The files in the abi directory were generated with the following command:

$ solc --abi -o abi AbstractENS.sol FIFSRegistrar.sol HashRegistrarSimplified.sol

Getting started

Install Truffle

$ npm install -g truffle

Launch the RPC client, for example TestRPC:

$ testrpc

COPY contents of config.example.js to config.js

$ cp config.example.js config.js

Contract Deployment

Create the following file in migrations folder 3_deploy_all_ens_contract.js, copy the code below and paste in the file before running the truffle migrate command

const ENS = artifacts.require("./ENSRegistry.sol");
const FIFSRegistrar = artifacts.require("./FIFSRegistrar.sol");
const ReverseRegistrar = artifacts.require("./ReverseRegistrar.sol");
const PublicResolver = artifacts.require("@energi/resolver/PublicResolver");

const { sha3 } = require('web3-utils');
const { hash } = require('eth-ens-namehash');

const tld = 'nrg';

module.exports = async (deployer, network, accounts) => {

  console.log(accounts)
  let ens;
  let resolver;
  let registrar;

  
  // ENS Registry
  deployer.deploy(ENS)
  // Resolver
  .then(function(ensInstance) {
    ens = ensInstance;
    return deployer.deploy(PublicResolver, ens.address);
  })
  .then(function(resolverInstance) {
    resolver = resolverInstance;
    return setupResolver(ens, resolver, accounts);
  })
  // Registrar
  .then(function() {
    return deployer.deploy(FIFSRegistrar, ens.address, hash(tld));
  })
  .then(function(registrarInstance) {
    registrar = registrarInstance;
    return setupRegistrar(ens, registrar);
  })
  // Reverse Registrar
  .then(function() {
    return deployer.deploy(ReverseRegistrar, ens.address, resolver.address);
  })
  .then(function(reverseRegistrarInstance) {
    return setupReverseRegistrar(ens, resolver, reverseRegistrarInstance, accounts);
  })
  .catch(function(err) {
    console.log(err)
  });
}

const setupResolver = async (ens, resolver, accounts) => {
  const resolverNode = hash("resolver");
  const resolverLabel = sha3("resolver");

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

const setupRegistrar = async (ens, registrar) => {
  await ens.setSubnodeOwner("0x0000000000000000000000000000000000000000", sha3(tld), registrar.address);
}

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

Deploy ENS and FIFSRegistrar to the private network, the deployment process is defined at here:

$ truffle migrate --network dev.fifs

alternatively, deploy the HashRegistrar:

$ truffle migrate --network dev.auction

Check the truffle documentation for more information.