ens

README

Swarm ENS interface

Usage

Full documentation for the Ethereum Name Service can be found as EIP 137. This package offers a simple binding that streamlines the registration of arbitrary UTF8 domain names to swarm content hashes.

Development

The SOL file in contract subdirectory implements the ENS root registry, a simple first-in, first-served registrar for the root namespace, and a simple resolver contract; they're used in tests, and can be used to deploy these contracts for your own purposes.

The solidity source code can be found at github.com/arachnid/ens/.

The go bindings for ENS contracts are generated using abigen via the go generator:

go generate ./contracts/ens

Documentation

Index

• Variables
• func EnsNode(name string) common.Hash
• type ENS
  • func DeployENS(transactOpts *bind.TransactOpts, contractBackend bind.ContractBackend) (common.Address, *ENS, error)
  • func NewENS(transactOpts *bind.TransactOpts, contractAddr common.Address, ...) (*ENS, error)
  • func (ens *ENS) Addr(name string) (common.Address, error)
  • func (ens *ENS) Register(name string) (*types.Transaction, error)
  • func (ens *ENS) Resolve(name string) (common.Hash, error)
  • func (ens *ENS) SetAddr(name string, addr common.Address) (*types.Transaction, error)
  • func (ens *ENS) SetContentHash(name string, hash common.Hash) (*types.Transaction, error)

Variables

var (
	MainNetAddress = common.MustBech32ToAddress("atp1x9q4jfjamrdmxyry97v02rqxv9euzfvm0sc0dx")
	TestNetAddress = common.MustBech32ToAddress("atx1zy3rg32u8ge06yfrp3pw00xdf2zwqgqstk8wlv")
)

Functions

func EnsNode

func EnsNode(name string) common.Hash

Types

type ENS

type ENS struct {
	*contract.ENSSession
	// contains filtered or unexported fields
}

ENS is the swarm domain name registry and resolver

func DeployENS

func DeployENS(transactOpts *bind.TransactOpts, contractBackend bind.ContractBackend) (common.Address, *ENS, error)

DeployENS deploys an instance of the ENS nameservice, with a 'first-in, first-served' root registrar.

func NewENS

func NewENS(transactOpts *bind.TransactOpts, contractAddr common.Address, contractBackend bind.ContractBackend) (*ENS, error)

NewENS creates a struct exposing convenient high-level operations for interacting with the Ethereum Name Service.

func (*ENS) Addr

func (ens *ENS) Addr(name string) (common.Address, error)

Addr is a non-transactional call that returns the address associated with a name.

func (*ENS) Register

func (ens *ENS) Register(name string) (*types.Transaction, error)

Register registers a new domain name for the caller, making them the owner of the new name. Only works if the registrar for the parent domain implements the FIFS registrar protocol.

func (*ENS) Resolve

func (ens *ENS) Resolve(name string) (common.Hash, error)

Resolve is a non-transactional call that returns the content hash associated with a name.

func (*ENS) SetAddr

func (ens *ENS) SetAddr(name string, addr common.Address) (*types.Transaction, error)

SetAddress sets the address associated with a name. Only works if the caller owns the name, and the associated resolver implements a `setAddress` function.

func (*ENS) SetContentHash

func (ens *ENS) SetContentHash(name string, hash common.Hash) (*types.Transaction, error)

SetContentHash sets the content hash associated with a name. Only works if the caller owns the name, and the associated resolver implements a `setContent` function.