Documentation

Documentation »API »Providers »ENS Resolver

ENS Resolver

ENS is a service which allows easy-to-remember names to map to network addresses.

TYPES

The type of data found during a steip during avatar resolution.

interface AvatarLinkage

An individual record for each step during avatar resolution.

PROPERTIES

<src>avatarLinkage.type⇒ AvatarLinkageType

The type of linkage.

<src>avatarLinkage.value⇒ string

The linkage value.

interface AvatarResult

When resolving an avatar for an ENS name, there are many steps involved, fetching metadata, validating results, et cetera.

Some applications may wish to analyse this data, or use this data to diagnose promblems, so an AvatarResult provides details of each completed step during avatar resolution.

PROPERTIES

<src>avatarResult.linkage⇒ Array< AvatarLinkage >

How the url was arrived at, resolving the many steps required for an avatar URL.

<src>avatarResult.url⇒ null | string

The avatar URL or null if the avatar was not set, or there was an issue during validation (such as the address not owning the avatar or a metadata error).

class BasicMulticoinProviderPlugin

inherits from MulticoinProviderPlugin, AbstractProviderPlugin

A BasicMulticoinProviderPlugin provides service for common coin types, which do not require additional libraries to encode or decode.

CREATING INSTANCES

<src>new BasicMulticoinProviderPlugin()

Creates a new BasicMulticoinProviderPlugin.

class EnsResolver

A connected object to a resolved ENS name resolver, which can be used to query additional details.

PROPERTIES

<src>ensResolver.address⇒ string

The address of the resolver.

<src>ensResolver.name⇒ string

The name this resolver was resolved against.

<src>ensResolver.provider⇒ AbstractProvider

The connected provider.

CREATING INSTANCES

<src>new EnsResolver(provider: AbstractProvider, address: string, name: string)

METHODS

<src>ensResolver._getAvatar()⇒ Promise< AvatarResult >

When resolving an avatar, there are many steps involved, such fetching metadata and possibly validating ownership of an NFT.

This method can be used to examine each step and the value it was working from.

<src>ensResolver.getAddress(coinType?: number)⇒ Promise< null | string >

Resolves to the address for coinType or null if the provided coinType has not been configured.

<src>ensResolver.getAvatar()⇒ Promise< null | string >

Resolves to the avatar url or null if the avatar is either unconfigured or incorrectly configured (e.g. references an NFT not owned by the address).

If diagnosing issues with configurations, the _getAvatar method may be useful.

<src>ensResolver.getContentHash()⇒ Promise< null | string >

Rsolves to the content-hash or null if unconfigured.

<src>ensResolver.getText(key: string)⇒ Promise< null | string >

Resolves to the EIP-634 text record for key, or null if unconfigured.

<src>ensResolver.supportsWildcard()⇒ Promise< boolean >

Resolves to true if the resolver supports wildcard resolution.

STATIC METHODS

<src>EnsResolver.fromName(provider: AbstractProvider, name: string)⇒ Promise< null | EnsResolver >

Resolve to the ENS resolver for name using provider or null if unconfigured.

<src>EnsResolver.getEnsAddress(provider: Provider)⇒ Promise< string >

abstract class MulticoinProviderPlugin

inherits from AbstractProviderPlugin

A provider plugin super-class for processing multicoin address types.

PROPERTIES

<src>multicoinProviderPlugin.name⇒ stringread-only

The name.

CREATING INSTANCES

<src>new MulticoinProviderPlugin(name: string)

Creates a new MulticoinProviderPluing for name.

METHODS

<src>multicoinProviderPlugin.decodeAddress(coinType: number, data: BytesLike)⇒ Promise< string >

Resovles to the decoded data for coinType.

<src>multicoinProviderPlugin.encodeAddress(coinType: number, address: string)⇒ Promise< string >

Resovles to the encoded address for coinType.

<src>multicoinProviderPlugin.supportsCoinType(coinType: number)⇒ boolean

Returns true if coinType is supported by this plugin.