ENS API

Ethereum Name Service (ENS) has a friendly overview.

Continue below for the detailed specs on each method and class in the ens module.

ens.ens module

ens.async_ens module

ens.exceptions module

exception ens.exceptions.ENSException

Bases: Exception

Base class for all ENS Errors

exception ens.exceptions.AddressMismatch

Bases: ENSException

In order to set up reverse resolution correctly, the ENS name should first point to the address. This exception is raised if the name does not currently point to the address.

exception ens.exceptions.InvalidName

Bases: IDNAError, ENSException

This exception is raised if the provided name does not meet the syntax standards specified in EIP 137 name syntax.

For example: names may not start with a dot, or include a space.

exception ens.exceptions.UnauthorizedError

Bases: ENSException

Raised if the sending account is not the owner of the name you are trying to modify. Make sure to set from in the transact keyword argument to the owner of the name.

exception ens.exceptions.UnownedName

Bases: ENSException

Raised if you are trying to modify a name that no one owns.

If working on a subdomain, make sure the subdomain gets created first with setup_address().

exception ens.exceptions.ResolverNotFound

Bases: ENSException

Raised if no resolver was found for the name you are trying to resolve.

exception ens.exceptions.UnsupportedFunction

Bases: ENSException

Raised if a resolver does not support a particular method.

exception ens.exceptions.BidTooLow

Bases: ENSException

Raised if you bid less than the minimum amount

exception ens.exceptions.InvalidBidHash

Bases: ENSException

Raised if you supply incorrect data to generate the bid hash.

exception ens.exceptions.InvalidLabel

Bases: ENSException

Raised if you supply an invalid label

exception ens.exceptions.OversizeTransaction

Bases: ENSException

Raised if a transaction you are trying to create would cost so much gas that it could not fit in a block.

For example: when you try to start too many auctions at once.

exception ens.exceptions.UnderfundedBid

Bases: ENSException

Raised if you send less wei with your bid than you declared as your intent to bid.

exception ens.exceptions.ENSValidationError

Bases: ENSException, ValidationError

Raised if there is a validation error