Technical Documentation
Dapp Developer Guide
Contract API Reference
Contract Developer Guide
ENS Migration (February 2020)
Managing Names
Transferring a Name
Each name in ENS has an owner. This account or contract is the only one that may make changes to the name in the ENS registry. The owner of a name can transfer ownership to any other account.
ensjs
go-ens
web3.py
1
await ens.name('alice.eth').setOwner('0x1234...');
Copied!
1
// opts are go-ethereum's bind.TransactOpts
2
err := registry.SetOwner(opts, "alice.eth", common.HexToAddress("0x1234..."))
Copied!
1
ns.setup_owner('alice.eth', '0x1234...')
Copied!
Creating Subdomains
The owner of any domain can configure subdomains as desired. This is achieved by creating a subdomain and setting its owner to the desired address - this can be the same as the owner of the parent domain, or any other address.
ensjs
go-ens
web3.py
1
await ens.name('alice.eth').createSubdomain('iam');
Copied!
1
// opts are go-ethereum's bind.TransactOpts
2
err := registry.SetSubdomainOwner(opts, "alice.eth", "iam", common.HexToAddress("0x1234..."))
Copied!
1
ns.setup_owner('iam.alice.eth', '0x1234...')
Copied!
Additionally, web3.py provides a convenience method to create a subdomain, set a resolver, and configure an address record all at once:
1
ns.setup_address('iam.alice.eth', '0x1234...')
Copied!
In the common case that the name should be pointed to the owner's address, the second argument is optional.
Setting a Resolver
Before a newly created domain or subdomain can be used, a resolver address must be set. You may also want to do this if an updated resolver implementation is available that supports features that you want to make use of.
Most commonly, names are set to use a 'standard' resolver called the public resolver, which provides commonly-used functionality, but anyone may write and deploy their own special-purpose resolver; see the resolver interface definition for details.
ensjs
go-ens
web3.py
1
await ens.name('iam.alice.eth').setResolver('0x1234');
Copied!
On mainnet and the Kovan test network, 'resolver.eth' is configured to point to the latest deployed version of the public resolver, making it possible to easily configure a name to use the public resolver:
1
const resolver = await ens.resolver('resolver.eth').addr();
2
await ens.setResolver('iam.alice.eth', resolver, {from: ...});
Copied!
1
// opts are go-ethereum's bind.TransactOpts
2
err := registry.SetResolver(opts, "iam.alice.eth", common.HexToAddress("0x1234..."))
Copied!
Not supported. web3.py automatically uses the public resolver when
setup_address is called, and does not support setting custom resolvers.Note that changing the resolver for a name will not automatically migrate records from the old resolver over; to do this you will need to follow the process outlined below for updating records.
Updating Records
To change the resources an address resolves to, it's necessary to update that name's records in its resolver.
Each resolver may specify its own mechanism for updating records, but a standard method is implemented by the public resolver and many others. Some libraries provide functionality for updating a resolver's records using this interface.
Updating the Address Record
ensjs
go-ens
web3.js
web3.py
1
await ens.name('iam.alice.eth').setAddr('ETH', '0x1234...');
Copied!
1
resolver, err := ens.NewResolver(client, "iam.alice.eth")
2
// opts are go-ethereum's bind.TransactOpts
3
err := resolver.SetAddress(opts, common.HexToAddress("0x1234..."))
Copied!
1
ens.setAddress('iam.alice.eth, '0x1234...', {from: ...});
Copied!
1
ns.setup_address('iam.alice.eth', '0x1234...')
Copied!
Updating Other Records
Some libraries - presently only ensjs, go-ens and web3.js - support updating other record types, such as content hashes and text records, using the same pattern. For example, to set or update a text record:
ensjs
go-ens
web3.js
1
ens.name('iam.alice.eth').setText('test', 'Test record');
Copied!
1
// opts are go-ethereum's bind.TransactOpts
2
err := resolver.SetContenthash(opts, []byte{0x12, 0x34...})
3
err := resolver.SetAbi(opts, "Sample", `[{"constant":true,"inputs":...}]`, big.NewInt(1))
4
err := resolver.SetText(opts, "Sample", `Hello, world`)
Copied!
1
ens.setText('iam.alice.eth', 'Test', 'Test record', {from: ...});
Copied!
Updating multiple records in one transaction
Public Resolver has
multicall that permits users to set multiple records in a single operation. Read PublicResolver section for more detail.Configuring Reverse Resolution
While 'regular' resolution involves mapping from a name to an address, reverse resolution maps from an address back to a name - or other metadata. ENS supports reverse resolution to allow applications to display ENS names in place of hexadecimal addresses.
Before this can be done, the owner of the address has to configure reverse resolution for their address. This is done by calling the
claim() method on the reverse resolver, found at the special name 'addr.reverse'.Most commonly this is accomplished via a user-interface such as the ENS Manager DApp. go-ens and web3.py also provide functionality for this:
go-ens
web3.py
1
reverseRegistrar, err := ens.NewReverseRegistrar(client)
2
// opts are go-ethereum's bind.TransactOpts
3
err := reverseRegistrar.SetName(opts, "iam.alice.eth")
Copied!
1
ns.setup_name('iam.alice.eth', '0x1234...')
Copied!