ens

Documentation

Index

• Variables
• type Address
• type Client
  • func NewClient(opts ...Option) *Client
  • func (c *Client) Close() error
  • func (c *Client) Connect(ep string) error
  • func (c *Client) IsConnected() bool
  • func (c *Client) Resolve(name string) (Address, error)
• type Option

Variables

var (
	// ErrInvalidContentHash denotes that the value of the contenthash record is
	// not valid.
	ErrInvalidContentHash = errors.New("invalid swarm content hash")
	// ErrResolveFailed is returned when a name could not be resolved.
	ErrResolveFailed = errors.New("resolve failed")
	// ErrNameNotFound is returned when a name resolves to an empty contenthash
	// record.
	ErrNameNotFound = errors.New("name not found")
)

Types

type Address

type Address = swarm.Address

Address is the swarm bzz address.

type Client

type Client struct {
	Endpoint string
	// contains filtered or unexported fields
}

Client is a name resolution client that can connect to ENS via an Ethereum endpoint.

func NewClient

func NewClient(opts ...Option) *Client

NewClient will return a new Client.

func (*Client) Close

func (c *Client) Close() error

Close closes the RPC connection with the client, terminating all unfinished requests. Function obtains a write lock while interacting with the Ethereum client.

func (*Client) Connect

func (c *Client) Connect(ep string) error

Connect implements the resolver.Client interface.

func (*Client) IsConnected

func (c *Client) IsConnected() bool

IsConnected returns true if there is an active RPC connection with an Ethereum node at the configured endpoint. Function obtains a write lock while interacting with the Ethereum client.

func (*Client) Resolve

func (c *Client) Resolve(name string) (Address, error)

Resolve implements the resolver.Client interface. Function obtains a read lock while interacting with the Ethereum client.

type Option

type Option func(*Client)

Option is a function that applies an option to a Client.