The web3.eth.ens functions let you interacting with ENS. We recommend reading the documentation ENS is providing to get deeper insights about the internals of the name service.
The registryAddress property can be used to define a custom registry address when you are connected to an unknown chain.
Note
If no address is defined will it try to detect the registry on the chain you are currently connected with and on the call of setProvider in the Eth module will it keep the defined address and use it for the ENS module.
String - The address of the custom registry.
Returns the network specific ENS registry.
Registry - The current ENS registry.
contract: Contract- TheRegistrycontract with the interface we know from theContract <eth-contract>object.owner(name, callback): Promise- Deprecated please usegetOwnergetOwner(name, callback): PromisesetOwner(name, address, txConfig, callback): PromiEventresolver(name, callback): Promise- Deprecated please usegetResolvergetResolver(name, callback): PromisesetResolver(name, address, txConfig, callback): PromiEventgetTTL(name, callback): PromisesetTTL(name, ttl, txConfig, callback): PromiEventsetSubnodeOwner(name, label, address, txConfig, callback): PromiEventsetRecord(name, owner, resolver, ttl, txConfig, callback): PromiEventsetSubnodeRecord(name, label, owner, resolver, ttl, txConfig, callback): PromiEventsetApprovalForAll(operator, approved, txConfig, callback): PromiEventisApprovedForAll(owner, operator, callback): PromiserecordExists(name, callback): Promise
web3.eth.ens.registry;
> {
contract: Contract,
owner: Function(name, callback), // Deprecated
getOwner: Function(name, callback),
setOwner: Function(name, address, txConfig, callback),
resolver: Function(name, callback), // Deprecated
getResolver: Function(name, callback),
setResolver: Function(name, address, txConfig, callback),
getTTL: Function(name, callback),
setTTL: Function(name, ttl, txConfig, callback),
setSubnodeOwner: Function(name, label, address, txConfig, callback),
setRecord(name, owner, resolver, ttl, txConfig, callback),
setSubnodeRecord(name, label, owner, resolver, ttl, txConfig, callback),
setApprovalForAll(operator, approved, txConfig, callback),
isApprovedForAll(owner, operator, txConfig, callback),
recordExists(name, callback)
}Returns the resolver contract to an Ethereum address.
Note
This method is deprecated please use getResolver
name-String: The ENS name.callback-Function: (optional) Optional callback
Promise<Resolver> - The ENS resolver for this name.
Returns the resolver contract to an Ethereum address.
name-String: The ENS name.callback-Function: (optional) Optional callback
Promise<Resolver> - The ENS resolver for this name.
Does set the resolver contract address of a name.
name-String: The ENS name.address-String: The contract address of the deployedResolvercontract.txConfig-Object: (optional) The transaction options as described ::ref::here <eth-sendtransaction>callback-Function: (optional) Optional callback
PromiEvent<TransactionReceipt | TransactionRevertInstructionError>
Returns the owner of a name.
name-String: The ENS name.callback-Function: (optional) Optional callback
Promise<String>` - The address of the registrar (EOA or CA).
Does set the owner of the given name.
name-String: The ENS name.txConfig-Object: (optional) The transaction options as described ::ref::here <eth-sendtransaction>callback-Function: (optional) Optional callback
PromiEvent<TransactionReceipt | TransactionRevertInstructionError>
Returns the caching TTL (time-to-live) of a name.
name-String: The ENS name.callback-Function: (optional) Optional callback
Promise<Number>
Does set the caching TTL (time-to-live) of a name.
name-String: The ENS name.ttl-Number: The TTL value (uint64)txConfig-Object: (optional) The transaction options as described ::ref::here <eth-sendtransaction>callback-Function: (optional) Optional callback
PromiEvent<TransactionReceipt | TransactionRevertInstructionError>
Creates a new subdomain of the given node, assigning ownership of it to the specified owner
name-String: The ENS name.label-String: The name of the sub-domain or the sha3 hash of itaddress-String: The registrar of this sub-domaintxConfig-Object: (optional) The transaction options as described ::ref::here <eth-sendtransaction>callback-Function: (optional) Optional callback
PromiEvent<TransactionReceipt | TransactionRevertInstructionError>
Sets the owner, resolver, and TTL for an ENS record in a single operation.
name-String: The ENS name.owner-String: The owner of the name recordresolver-String: The resolver address of the name recordttl-String | Number: Time to live value (uint64)txConfig-Object: (optional) The transaction options as described ::ref::here <eth-sendtransaction>callback-Function: (optional) Optional callback
PromiEvent<TransactionReceipt | TransactionRevertInstructionError>
Sets the owner, resolver and TTL for a subdomain, creating it if necessary.
name-String: The ENS name.label-String: The name of the sub-domain or the sha3 hash of itowner-String: The owner of the name recordresolver-String: The resolver address of the name recordttl-String | Number: Time to live value (uint64)txConfig-Object: (optional) The transaction options as described ::ref::here <eth-sendtransaction>callback-Function: (optional) Optional callback
PromiEvent<TransactionReceipt | TransactionRevertInstructionError>
Sets or clears an approval. Approved accounts can execute all ENS registry operations on behalf of the caller.
operator-String: The operator addressapproved-BooleantxConfig-Object: (optional) The transaction options as described ::ref::here <eth-sendtransaction>callback-Function: (optional) Optional callback
PromiEvent<TransactionReceipt | TransactionRevertInstructionError>
Returns true if the operator is approved to make ENS registry operations on behalf of the owner.
owner-String: The owner address.operator-String: The operator address.callback-Function: (optional) Optional callback
Promise<Boolean>
Returns true if node exists in this ENS registry. This will return false for records that are in the legacy ENS registry but have not yet been migrated to the new one.
name-String: The ENS name.callback-Function: (optional) Optional callback
Promise<Boolean>
Resolves an ENS name to an Ethereum address.
ENSName-String: The ENS name to resolve.callback-Function: (optional) Optional callback
String - The Ethereum address of the given name.
Sets the address of an ENS name in his resolver.
ENSName-String: The ENS name.address-String: The address to set.txConfig-Object: (optional) The transaction options as described ::ref::here <eth-sendtransaction>callback-Function: (optional) Optional callback
Emits an AddrChanged event.
PromiEvent<TransactionReceipt | TransactionRevertInstructionError>
web3.eth.ens.setAddress(
'ethereum.eth',
'0xfB6916095ca1df60bB79Ce92cE3Ea74c37c5d359',
{
from: '0x9CC9a2c777605Af16872E0997b3Aeb91d96D5D8c'
}
).then(function (result) {
console.log(result.events);
});
> AddrChanged(...)
// Or using the event emitter
web3.eth.ens.setAddress(
'ethereum.eth',
'0xfB6916095ca1df60bB79Ce92cE3Ea74c37c5d359',
{
from: '0x9CC9a2c777605Af16872E0997b3Aeb91d96D5D8c'
}
)
.on('transactionHash', function(hash){
...
})
.on('confirmation', function(confirmationNumber, receipt){
...
})
.on('receipt', function(receipt){
...
})
.on('error', console.error);
// Or listen to the AddrChanged event on the resolver
web3.eth.ens.resolver('ethereum.eth').then(function (resolver) {
resolver.events.AddrChanged({fromBlock: 0}, function(error, event) {
console.log(event);
})
.on('data', function(event){
console.log(event);
})
.on('changed', function(event){
// remove event from local database
})
.on('error', console.error);
});For further information on the handling of contract events please see here <contract-events>.
Returns the X and Y coordinates of the curve point for the public key.
ENSName-String: The ENS name.callback-Function: (optional) Optional callback
Promise<Object<String, String>> - The X and Y coordinates.
web3.eth.ens.getPubkey('ethereum.eth').then(function (result) {
console.log(result)
});
> {
"0": "0x0000000000000000000000000000000000000000000000000000000000000000",
"1": "0x0000000000000000000000000000000000000000000000000000000000000000",
"x": "0x0000000000000000000000000000000000000000000000000000000000000000",
"y": "0x0000000000000000000000000000000000000000000000000000000000000000"
}Sets the SECP256k1 public key associated with an ENS node
ENSName-String: The ENS name.x-String: The X coordinate of the public key.y-String: The Y coordinate of the public key.txConfig-Object: (optional) The transaction options as described ::ref::here <eth-sendtransaction>callback-Function: (optional) Optional callback
Emits an PubkeyChanged event.
PromiEvent<TransactionReceipt | TransactionRevertInstructionError>
web3.eth.ens.setPubkey(
'ethereum.eth',
'0x0000000000000000000000000000000000000000000000000000000000000000',
'0x0000000000000000000000000000000000000000000000000000000000000000',
{
from: '0x9CC9a2c777605Af16872E0997b3Aeb91d96D5D8c'
}
).then(function (result) {
console.log(result.events);
});
> PubkeyChanged(...)
// Or using the event emitter
web3.eth.ens.setPubkey(
'ethereum.eth',
'0x0000000000000000000000000000000000000000000000000000000000000000',
'0x0000000000000000000000000000000000000000000000000000000000000000',
{
from: '0x9CC9a2c777605Af16872E0997b3Aeb91d96D5D8c'
}
)
.on('transactionHash', function(hash){
...
})
.on('confirmation', function(confirmationNumber, receipt){
...
})
.on('receipt', function(receipt){
...
})
.on('error', console.error);
// Or listen to the PubkeyChanged event on the resolver
web3.eth.ens.resolver('ethereum.eth').then(function (resolver) {
resolver.events.PubkeyChanged({fromBlock: 0}, function(error, event) {
console.log(event);
})
.on('data', function(event){
console.log(event);
})
.on('changed', function(event){
// remove event from local database
})
.on('error', console.error);
});For further information on the handling of contract events please see here <contract-events>.
Returns the content hash associated with an ENS node.
ENSName-String: The ENS name.callback-Function: (optional) Optional callback
Promise<String> - The content hash associated with an ENS node.
Sets the content hash associated with an ENS node.
ENSName-String: The ENS name.hash-String: The content hash to set.txConfig-Object: (optional) The transaction options as described ::ref::here <eth-sendtransaction>callback-Function: (optional) Optional callback
Emits an ContentChanged event.
PromiEvent<TransactionReceipt | TransactionRevertInstructionError>
web3.eth.ens.setContent(
'ethereum.eth',
'0x0000000000000000000000000000000000000000000000000000000000000000',
{
from: '0x9CC9a2c777605Af16872E0997b3Aeb91d96D5D8c'
}
).then(function (result) {
console.log(result.events);
});
> ContentChanged(...)
// Or using the event emitter
web3.eth.ens.setContent(
'ethereum.eth',
'0x0000000000000000000000000000000000000000000000000000000000000000',
{
from: '0x9CC9a2c777605Af16872E0997b3Aeb91d96D5D8c'
}
)
.on('transactionHash', function(hash){
...
})
.on('confirmation', function(confirmationNumber, receipt){
...
})
.on('receipt', function(receipt){
...
})
.on('error', console.error);
// Or listen to the ContentChanged event on the resolver
web3.eth.ens.resolver('ethereum.eth').then(function (resolver) {
resolver.events.ContentChanged({fromBlock: 0}, function(error, event) {
console.log(event);
})
.on('data', function(event){
console.log(event);
})
.on('changed', function(event){
// remove event from local database
})
.on('error', console.error);
});For further information on the handling of contract events please see here <contract-events>.
Returns the multihash associated with an ENS node.
ENSName-String: The ENS name.callback-Function: (optional) Optional callback
Promise<String> - The associated multihash.
Returns true if the related Resolver does support the given signature or interfaceId.
name-String: The ENS name.interfaceId-String: The signature of the function or the interfaceId as described in the ENS documentationcallback-Function: (optional) Optional callback
Promise<Boolean>
Sets the multihash associated with an ENS node.
ENSName-String: The ENS name.hash-String: The multihash to set.txConfig-Object: (optional) The transaction options as described ::ref::here <eth-sendtransaction>callback-Function: (optional) Optional callback
Emits an MultihashChangedevent.
PromiEvent<TransactionReceipt | TransactionRevertInstructionError>
web3.eth.ens.setMultihash(
'ethereum.eth',
'QmXpSwxdmgWaYrgMUzuDWCnjsZo5RxphE3oW7VhTMSCoKK',
{
from: '0x9CC9a2c777605Af16872E0997b3Aeb91d96D5D8c'
}
).then(function (result) {
console.log(result.events);
});
> MultihashChanged(...)
// Or using the event emitter
web3.eth.ens.setMultihash(
'ethereum.eth',
'QmXpSwxdmgWaYrgMUzuDWCnjsZo5RxphE3oW7VhTMSCoKK',
{
from: '0x9CC9a2c777605Af16872E0997b3Aeb91d96D5D8c'
}
)
.on('transactionHash', function(hash){
...
})
.on('confirmation', function(confirmationNumber, receipt){
...
})
.on('receipt', function(receipt){
...
})
.on('error', console.error);For further information on the handling of contract events please see here <contract-events>.
The ENS API provides the possibility for listening to all ENS related events.
------------Known resolver events ------------
- AddrChanged(node bytes32, a address)
- ContentChanged(node bytes32, hash bytes32)
- NameChanged(node bytes32, name string)
- ABIChanged(node bytes32, contentType uint256)
- PubkeyChanged(node bytes32, x bytes32, y bytes32)
PromiEvent<TransactionReceipt | TransactionRevertInstructionError>
web3.eth.ens.resolver('ethereum.eth').then(function (resolver) {
resolver.events.AddrChanged({fromBlock: 0}, function(error, event) {
console.log(event);
})
.on('data', function(event){
console.log(event);
})
.on('changed', function(event){
// remove event from local database
})
.on('error', console.error);
});
> {
returnValues: {
node: '0x123456789...',
a: '0x123456789...',
},
raw: {
data: '0x7f9fade1c0d57a7af66ab4ead79fade1c0d57a7af66ab4ead7c2c2eb7b11a91385',
topics: [
'0xfd43ade1c09fade1c0d57a7af66ab4ead7c2c2eb7b11a91ffdd57a7af66ab4ead7',
'0x7f9fade1c0d57a7af66ab4ead79fade1c0d57a7af66ab4ead7c2c2eb7b11a91385'
]
},
event: 'AddrChanged',
signature: '0xfd43ade1c09fade1c0d57a7af66ab4ead7c2c2eb7b11a91ffdd57a7af66ab4ead7',
logIndex: 0,
transactionIndex: 0,
transactionHash: '0x7f9fade1c0d57a7af66ab4ead79fade1c0d57a7af66ab4ead7c2c2eb7b11a91385',
blockHash: '0xfd43ade1c09fade1c0d57a7af66ab4ead7c2c2eb7b11a91ffdd57a7af66ab4ead7',
blockNumber: 1234,
address: '0xde0B295669a9FD93d5F28D9Ec85E40f4cb697BAe'
}------------Known registry events ------------
- Transfer(node bytes32, owner address)
- NewOwner(node bytes32, label bytes32, owner address)
- NewResolver(node bytes32, resolver address)
- NewTTL(node bytes32, ttl uint64)
web3.eth.ens.resistry.then(function (registry) {
registry.events.Transfer({fromBlock: 0}, , function(error, event) {
console.log(event);
})
.on('data', function(event){
console.log(event);
})
.on('changed', function(event){
// remove event from local database
})
.on('error', console.error);
});
> {
returnValues: {
node: '0x123456789...',
owner: '0x123456789...',
},
raw: {
data: '0x7f9fade1c0d57a7af66ab4ead79fade1c0d57a7af66ab4ead7c2c2eb7b11a91385',
topics: [
'0xfd43ade1c09fade1c0d57a7af66ab4ead7c2c2eb7b11a91ffdd57a7af66ab4ead7',
'0x7f9fade1c0d57a7af66ab4ead79fade1c0d57a7af66ab4ead7c2c2eb7b11a91385'
]
},
event: 'Transfer',
signature: '0xfd43ade1c09fade1c0d57a7af66ab4ead7c2c2eb7b11a91ffdd57a7af66ab4ead7',
logIndex: 0,
transactionIndex: 0,
transactionHash: '0x7f9fade1c0d57a7af66ab4ead79fade1c0d57a7af66ab4ead7c2c2eb7b11a91385',
blockHash: '0xfd43ade1c09fade1c0d57a7af66ab4ead7c2c2eb7b11a91ffdd57a7af66ab4ead7',
blockNumber: 1234,
address: '0xde0B295669a9FD93d5F28D9Ec85E40f4cb697BAe'
}For further information on the handling of contract events please see here <contract-events>.