Resolution | Unstoppabledomains resolution library

Blockchain domain Resolution library - Resolution.

example

import Resolution from '@unstoppabledomains/resolution';

let resolution = new Resolution({ blockchain: {
       ens: {
          url: "https://mainnet.infura.io/v3/12351245223",
          network: "mainnet"
       }
     }
  });

let domain = "brad.zil";
resolution.addr(domain, "eth").then(addr => console.log(addr));;

Hierarchy

Resolution

Index

Constructors

constructor

Constructors

constructor

new Resolution(__namedParameters?: { sourceConfig: undefined | { cns?: CnsSource | Api; ens?: EnsSource | Api; zns?: ZnsSource | Api } }): Resolution

- Defined in src/Resolution.ts:51
Parameters
- Default value __namedParameters: { sourceConfig: undefined | { cns?: CnsSource | Api; ens?: EnsSource | Api; zns?: ZnsSource | Api } } = {}
  - sourceConfig: undefined | { cns?: CnsSource | Api; ens?: EnsSource | Api; zns?: ZnsSource | Api }
Returns Resolution

Methods

addr

addr(domain: string, ticker: string): Promise<string>

- Defined in src/Resolution.ts:167
Resolves given domain name to a specific currency address if exists

async

throws

ResolutionError if address is not found

Parameters
- domain: string
  
  domain name to be resolved
- ticker: string
  
  currency ticker like BTC, ETH, ZIL
Returns Promise<string>

A promise that resolves in an address

allRecords

allRecords(domain: string): Promise<CryptoRecords>

- Defined in src/Resolution.ts:412
Returns all record keys of the domain. This method is strongly unrecommended for production use due to lack of support for many ethereum service providers and low performance Method is not supported by ENS

Parameters
- domain: string
  
  domain name
Returns Promise<CryptoRecords>

chatId

chatId(domain: string): Promise<string>

- Defined in src/Resolution.ts:214
Resolve a chat id from the domain record

throws

ResolutionError

Parameters
- domain: string
  
  domain name to be resolved
Returns Promise<string>

A promise that resolves in chatId

chatPk

chatPk(domain: string): Promise<string>

- Defined in src/Resolution.ts:224
Resolve a gundb public key from the domain record

throws

ResolutionError

Parameters
- domain: string
  
  domain name to be resolved
Returns Promise<string>

a promise that resolves in gundb public key

childhash

childhash(parent: string, label: string, namingService: NamingServiceName, options?: NamehashOptions): string

- Defined in src/Resolution.ts:354
Parameters
- parent: string
  
  namehash of a parent domain
- label: string
  
  subdomain name
- namingService: NamingServiceName
  
  "ENS", "CNS" or "ZNS"
- Default value options: NamehashOptions = NamehashOptionsDefault
  
  formatting options
Returns string

a namehash of a subdomain with name label

dns

dns(domain: string, types: DnsRecordType[]): Promise<DnsRecord[]>

- Defined in src/Resolution.ts:417
Parameters
- domain: string
- types: DnsRecordType[]
Returns Promise<DnsRecord[]>

email

email(domain: string): Promise<string>

- Defined in src/Resolution.ts:261
Resolves the ipfs email field from whois configurations

throws

ResolutionError

Parameters
- domain: string
  
  domain name
Returns Promise<string>

A Promise that resolves in an email address configured for this domain whois

httpUrl

httpUrl(domain: string): Promise<string>

- Defined in src/Resolution.ts:246
Resolves the httpUrl attached to domain

Parameters
- domain: string
  
  domain name
Returns Promise<string>

ipfsHash

ipfsHash(domain: string): Promise<string>

- Defined in src/Resolution.ts:233
Resolves the IPFS hash configured for domain records on ZNS

throws

ResolutionError

Parameters
- domain: string
  
  domain name
Returns Promise<string>

isSupportedDomain

isSupportedDomain(domain: string): boolean

- Defined in src/Resolution.ts:392
Checks if the domain name is valid according to naming service rules for valid domain names. Example: ENS doesn't allow domains that start from '-' symbol.

Parameters
- domain: string
  
  domain name to be checked
Returns boolean

isValidHash

isValidHash(domain: string, hash: string): boolean

- Defined in src/Resolution.ts:381
Checks weather the domain name matches the hash

Parameters
- domain: string
  
  domain name to check againt
- hash: string
  
  hash obtained from the blockchain
Returns boolean

multiChainAddr

multiChainAddr(domain: string, ticker: string, chain: string): Promise<string>

- Defined in src/Resolution.ts:183
Read multi-chain currency address if exists

async

throws

ResolutionError if address is not found

Parameters
- domain: string
  
  domain name to be resolved
- ticker: string
  
  currency ticker (USDT, FTM, etc.)
- chain: string
  
  chain version, usually means blockchain ( ERC20, BEP2, OMNI, etc. )
Returns Promise<string>

A promise that resolves in an adress

namehash

namehash(domain: string, options?: NamehashOptions): string

- Defined in src/Resolution.ts:336
throws

ResolutionError with UnsupportedDomain error code if domain extension is unknown

Parameters
- domain: string
  
  domain name to be converted
- Default value options: NamehashOptions = NamehashOptionsDefault
  
  formatting options
Returns string

Produces a namehash from supported naming service in hex format with 0x prefix. Corresponds to ERC721 token id in case of Ethereum based naming service like ENS or CNS.

owner

owner(domain: string): Promise<string | null>

- Defined in src/Resolution.ts:284
Parameters
- domain: string
  
  domain name
Returns Promise<string | null>

An owner address of the domain

record

record(domain: string, recordKey: string): Promise<string>

- Defined in src/Resolution.ts:295
Parameters
- domain: string
  
  domain name
- recordKey: string
  
  a name of a record to be resolved
Returns Promise<string>

A record value promise for a given record name

records

records(domain: string, keys: string[]): Promise<CryptoRecords>

- Defined in src/Resolution.ts:306
Parameters
- domain: string
  
  domain name
- keys: string[]
  
  Array of record keys to be resolved
Returns Promise<CryptoRecords>

A Promise with key-value mapping of domain records

resolver

resolver(domain: string): Promise<string>

- Defined in src/Resolution.ts:269
Parameters
- domain: string
  
  domain to look for
Returns Promise<string>

the resolver address for a specific domain

reverse

reverse(address: string, currencyTicker: string): Promise<string | null>

- Defined in src/Resolution.ts:319
This method is only for ens at the moment. Reverse the ens address to a ens registered domain name

async

Parameters
- address: string
  
  address you wish to reverse
- currencyTicker: string
  
  currency ticker like BTC, ETH, ZIL
Returns Promise<string | null>

Domain name attached to this address

serviceName

serviceName(domain: string): ResolutionMethod

- Defined in src/Resolution.ts:401
Returns the name of the service for a domain ENS | CNS | ZNS

Parameters
- domain: string
  
  domain name to look for
Returns ResolutionMethod

twitter

twitter(domain: string): Promise<string>

- Defined in src/Resolution.ts:202
Resolves given domain name to a verified twitter handle

async

throws

ResolutionError if twitter is not found

Parameters
- domain: string
  
  domain name to be resolved
Returns Promise<string>

A promise that resolves in a verified twitter handle

Static fromEip1193Provider

fromEip1193Provider(provider: Provider, networks?: undefined | { cns?: undefined | { network: CnsSupportedNetworks }; ens?: undefined | { network: EnsSupportedNetworks } }): Resolution

- Defined in src/Resolution.ts:90
Creates a resolution instance with configured provider

see

https://eips.ethereum.org/EIPS/eip-1193

Parameters
- provider: Provider
  
  any provider compatible with EIP-1193
- Optional networks: undefined | { cns?: undefined | { network: CnsSupportedNetworks }; ens?: undefined | { network: EnsSupportedNetworks } }
  
  an optional object that describes what network to use when connecting ENS or CNS default is mainnet
Returns Resolution

Static fromEthersProvider

fromEthersProvider(provider: EthersProvider, networks?: undefined | { cns?: undefined | { network: CnsSupportedNetworks }; ens?: undefined | { network: EnsSupportedNetworks } }): Resolution

- Defined in src/Resolution.ts:148
Creates instance of resolution from provider that implements Ethers Provider#call interface. This wrapper support only eth_call method for now, which is enough for all the current Resolution functionality

see

https://github.com/ethers-io/ethers.js/blob/v4-legacy/providers/abstract-provider.d.ts#L91

see

https://github.com/ethers-io/ethers.js/blob/v5.0.4/packages/abstract-provider/src.ts/index.ts#L224

see

https://docs.ethers.io/ethers.js/v5-beta/api-providers.html#jsonrpcprovider-inherits-from-provider

see

https://github.com/ethers-io/ethers.js/blob/master/packages/providers/src.ts/json-rpc-provider.ts

Parameters
- provider: EthersProvider
  
  provider object
- Optional networks: undefined | { cns?: undefined | { network: CnsSupportedNetworks }; ens?: undefined | { network: EnsSupportedNetworks } }
  
  an optional object that describes what network to use when connecting ENS or CNS default is mainnet
Returns Resolution

Static fromWeb3Version0Provider

fromWeb3Version0Provider(provider: Web3Version0Provider, networks?: undefined | { cns?: undefined | { network: CnsSupportedNetworks }; ens?: undefined | { network: EnsSupportedNetworks } }): Resolution

- Defined in src/Resolution.ts:109
Create a resolution instance from web3 0.x version provider

see

https://github.com/ethereum/web3.js/blob/0.20.7/lib/web3/httpprovider.js#L116

Parameters
- provider: Web3Version0Provider
  
  an 0.x version provider from web3 ( must implement sendAsync(payload, callback) )
- Optional networks: undefined | { cns?: undefined | { network: CnsSupportedNetworks }; ens?: undefined | { network: EnsSupportedNetworks } }
  
  Ethereum network configuration
Returns Resolution

Static fromWeb3Version1Provider

fromWeb3Version1Provider(provider: Web3Version1Provider, networks?: undefined | { cns?: undefined | { network: CnsSupportedNetworks }; ens?: undefined | { network: EnsSupportedNetworks } }): Resolution

- Defined in src/Resolution.ts:127
Create a resolution instance from web3 1.x version provider

see

https://github.com/ethereum/web3.js/blob/1.x/packages/web3-core-helpers/types/index.d.ts#L165

see

https://github.com/ethereum/web3.js/blob/1.x/packages/web3-providers-http/src/index.js#L95

Parameters
- provider: Web3Version1Provider
  
  an 1.x version provider from web3 ( must implement send(payload, callback) )
- Optional networks: undefined | { cns?: undefined | { network: CnsSupportedNetworks }; ens?: undefined | { network: EnsSupportedNetworks } }
  
  an optional object that describes what network to use when connecting ENS or CNS default is mainnet
Returns Resolution

Static infura

infura(infura: string, networks?: undefined | { cns?: undefined | { network: CnsSupportedNetworks }; ens?: undefined | { network: EnsSupportedNetworks } }): Resolution

- Defined in src/Resolution.ts:71
Creates a resolution with configured infura id for ens and cns

Parameters
- infura: string
  
  infura project id
- Optional networks: undefined | { cns?: undefined | { network: CnsSupportedNetworks }; ens?: undefined | { network: EnsSupportedNetworks } }
  
  an optional object that describes what network to use when connecting ENS or CNS default is mainnet
Returns Resolution

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Default value __namedParameters: { sourceConfig: undefined | { cns?: CnsSource | Api; ens?: EnsSource | Api; zns?: ZnsSource | Api } } = {}

sourceConfig: undefined | { cns?: CnsSource | Api; ens?: EnsSource | Api; zns?: ZnsSource | Api }

Returns Resolution

Methods

addr

Parameters

domain: string

ticker: string

Returns Promise<string>

allRecords

Parameters

domain: string

Returns Promise<CryptoRecords>

chatId

Parameters

domain: string

Returns Promise<string>

chatPk

Parameters

domain: string

Returns Promise<string>

childhash

Parameters

parent: string

label: string

namingService: NamingServiceName

Default value options: NamehashOptions = NamehashOptionsDefault

Returns string

dns

Parameters

domain: string

types: DnsRecordType[]

Returns Promise<DnsRecord[]>

email

Parameters

domain: string

Returns Promise<string>

httpUrl

Parameters

domain: string

Returns Promise<string>

ipfsHash

Parameters

domain: string

Returns Promise<string>

isSupportedDomain

Parameters

domain: string

Returns boolean

isValidHash

Parameters

domain: string

hash: string

Returns boolean

multiChainAddr

Parameters

domain: string

ticker: string

chain: string

Returns Promise<string>

namehash

Parameters

domain: string

Default value options: NamehashOptions = NamehashOptionsDefault

Returns string

owner

Parameters

domain: string

Returns Promise<string | null>

record

Parameters

domain: string

recordKey: string