Documentation

Documentation »API »Providers »ENS Resolver

ENS Resolver

About ENS Resolver

Types
AvatarLinkage
AvatarResult
BasicMulticoinProviderPlugin
EnsResolver
MulticoinProviderPlugin

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

<src>interface AvatarLinkage

An individual record for each step during avatar resolution.

<src>avatarLinkage.type⇒ AvatarLinkageType

<src>avatarLinkage.value⇒ string

<src>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.

<src>avatarResult.linkage⇒ Array< AvatarLinkage >

<src>avatarResult.url⇒ null | string

<src>class BasicMulticoinProviderPlugin

inherits fromMulticoinProviderPlugin, AbstractProviderPlugin

A basic multicoin provider plugin.

<src>new BasicMulticoinProviderPlugin()

<src>class EnsResolver

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

<src>ensResolver.address⇒ string

The address of the resolver.

<src>ensResolver.name⇒ string

The name this resovler was resolved against.

<src>ensResolver.provider⇒ AbstractProvider

The connected provider.

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

<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._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 >

Resovles to the EIP-643 text record for key, or null if unconfigured.

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

Resolves to true if the resolver supports wildcard resolution.

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

<src>abstract class MulticoinProviderPlugin

inherits fromAbstractProviderPlugin

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

<src>new MulticoinProviderPlugin(name: string)

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

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

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