Resolution | Unstoppabledomains resolution library

Blockchain domain Resolution library - Resolution.

example

import Resolution from '@unstoppabledomains/resolution';

let resolution = new Resolution({ blockchain: {
       uns: {
          url: "https://eth-mainnet.alchemyapi.io/v2/GmQ8X1FHf-WDEry0BBSn0RgjVhjHkRmS",
          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 | SourceConfig }): Resolution

- Defined in src/Resolution.ts:62
Parameters
- Default value __namedParameters: { sourceConfig: undefined | SourceConfig } = {}
  - sourceConfig: undefined | SourceConfig
Returns Resolution

Methods

addr

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

- Defined in src/Resolution.ts:431
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

allNonEmptyRecords

allNonEmptyRecords(domain: string): Promise<CryptoRecords>

- Defined in src/Resolution.ts:720
Parameters
- domain: string
Returns Promise<CryptoRecords>

allRecords

allRecords(domain: string): Promise<CryptoRecords>

- Defined in src/Resolution.ts:713
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

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

chatId

chatId(domain: string): Promise<string>

- Defined in src/Resolution.ts:476
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:486
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:642
Parameters
- parent: string
  
  namehash of a parent domain
- label: string
  
  subdomain name
- namingService: NamingServiceName
  
  "UNS" or "ZNS" (uses keccak256 or sha256 algorithm respectively)
- 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:731
Parameters
- domain: string
- types: DnsRecordType[]
Returns Promise<DnsRecord[]>

email

email(domain: string): Promise<string>

- Defined in src/Resolution.ts:523
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:508
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:495
Resolves the IPFS hash configured for domain records on ZNS

throws

ResolutionError

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

isAvailable

isAvailable(domain: string): Promise<boolean>

- Defined in src/Resolution.ts:599
Parameters
- domain: string
  
  domain name
Returns Promise<boolean>

A Promise of whether or not the domain is available

isRegistered

isRegistered(domain: string): Promise<boolean>

- Defined in src/Resolution.ts:583
Parameters
- domain: string
  
  domain name
Returns Promise<boolean>

A Promise of whether or not the domain belongs to a wallet

isSupportedDomain

isSupportedDomain(domain: string): Promise<boolean>

- Defined in src/Resolution.ts:696
Checks if the domain name is valid according to naming service rules for valid domain names.

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

isValidHash

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

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

Parameters
- domain: string
  
  domain name to check against
- hash: string
  
  hash obtained from the blockchain
- namingService: NamingServiceName
  
  "UNS" or "ZNS" (uses keccak256 or sha256 algorithm respectively)
Returns boolean

locations

locations(domains: string[]): Promise<Locations>

- Defined in src/Resolution.ts:797
Retrieves address of registry contract used for domain

Parameters
- domains: string[]
  
  domain name
Returns Promise<Locations>

Promise - A map of domain name and Location (a set of attributes like blockchain,

multiChainAddr

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

- Defined in src/Resolution.ts:444
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, namingService: NamingServiceName, options?: NamehashOptions): string

- Defined in src/Resolution.ts:619
throws

ResolutionError with UnsupportedDomain error code if domain extension is unknown

Parameters
- domain: string
  
  domain name to be converted
- namingService: NamingServiceName
  
  "UNS" or "ZNS" (uses keccak256 or sha256 algorithm respectively)
- 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 UNS.

owner

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

- Defined in src/Resolution.ts:548
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:560
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:572
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

registryAddress

registryAddress(domain: string): Promise<string>

- Defined in src/Resolution.ts:770
Retrieves address of registry contract used for domain

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

Registry contract address

resolver

resolver(domain: string): Promise<string>

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

the resolver address for a specific domain

reverse

reverse(address: string, options?: ReverseResolutionOptions): Promise<string | null>

- Defined in src/Resolution.ts:854
Returns the domain that is the primary resolution of the provided address

Parameters
- address: string
  
  owner's address
- Optional options: ReverseResolutionOptions
Returns Promise<string | null>

Promise - domain URL that is the primary resolution of the provided addresss

reverseTokenId

reverseTokenId(address: string, options?: ReverseResolutionOptions): Promise<string>

- Defined in src/Resolution.ts:841
Returns the token ID that is the primary resolution of the provided address

Parameters
- address: string
  
  owner's address
- Optional options: ReverseResolutionOptions
Returns Promise<string>

Promise - token ID that is the primary resolution of the provided address

tokenURI

tokenURI(domain: string): Promise<string>

- Defined in src/Resolution.ts:746
Retrieves the tokenURI from the registry smart contract.

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

the ERC721Metadata#tokenURI contract method result

tokenURIMetadata

tokenURIMetadata(domain: string): Promise<TokenUriMetadata>

- Defined in src/Resolution.ts:760
Retrieves the data from the endpoint provided by tokenURI from the registry smart contract.

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

the JSON response of the token URI endpoint

twitter

twitter(domain: string): Promise<string>

- Defined in src/Resolution.ts:463
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

unhash

unhash(hash: string, service: NamingServiceName): Promise<string>

- Defined in src/Resolution.ts:783
Retrieves the domain name from tokenId by parsing registry smart contract event logs.

throws

{ResolutionError} if returned domain name doesn't match the original namhash.

Parameters
- hash: string
  
  domain hash
- service: NamingServiceName
  
  nameservice which is used for lookup
Returns Promise<string>

the domain name retrieved from token metadata

Static alchemy

alchemy(alchemy: string, networks?: undefined | { uns?: undefined | { locations: { Layer1: { network: UnsSupportedNetwork }; Layer2: { network: UnsSupportedNetwork } } } }): Resolution

- Defined in src/Resolution.ts:163
Creates a resolution with configured alchemy API keys for uns

Parameters
- alchemy: string
  
  alchemy API keys
- Optional networks: undefined | { uns?: undefined | { locations: { Layer1: { network: UnsSupportedNetwork }; Layer2: { network: UnsSupportedNetwork } } } }
  
  an optional object that describes what network to use when connecting UNS default is mainnet
Returns Resolution

Static autoNetwork

autoNetwork(sourceConfig: AutoNetworkConfigs): Promise<Resolution>

- Defined in src/Resolution.ts:97
AutoConfigure the blockchain network for UNS We make a "net_version" JSON RPC call to the blockchain either via url or with the help of given provider.

Parameters
- sourceConfig: AutoNetworkConfigs
  
  configuration object for uns
Returns Promise<Resolution>

configured Resolution object

Static fromEthereumEip1193Provider

fromEthereumEip1193Provider(networks: { uns?: undefined | { locations: { Layer1: { network?: undefined | string; provider: Provider }; Layer2: { network?: undefined | string; provider: Provider } } } }): Resolution

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

see

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

Parameters
- networks: { uns?: undefined | { locations: { Layer1: { network?: undefined | string; provider: Provider }; Layer2: { network?: undefined | string; provider: Provider } } } }
  
  an object that describes what network to use when connecting UNS default is mainnet
  - Optional uns?: undefined | { locations: { Layer1: { network?: undefined | string; provider: Provider }; Layer2: { network?: undefined | string; provider: Provider } } }
Returns Resolution

Static fromEthersProvider

fromEthersProvider(networks: { uns?: undefined | { locations: { Layer1: { network: string; provider: EthersProvider }; Layer2: { network: string; provider: EthersProvider } } } }): Resolution

- Defined in src/Resolution.ts:387
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
- networks: { uns?: undefined | { locations: { Layer1: { network: string; provider: EthersProvider }; Layer2: { network: string; provider: EthersProvider } } } }
  
  an object that describes what network to use when connecting UNS default is mainnet
  - Optional uns?: undefined | { locations: { Layer1: { network: string; provider: EthersProvider }; Layer2: { network: string; provider: EthersProvider } } }
Returns Resolution

Static fromResolutionProvider

fromResolutionProvider(networks: { uns?: undefined | { locations: { Layer1: { network: string; provider: Provider }; Layer2: { network: string; provider: Provider } } }; zns?: undefined | { network: string; provider: Provider } }): Resolution

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

see

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

Parameters
- networks: { uns?: undefined | { locations: { Layer1: { network: string; provider: Provider }; Layer2: { network: string; provider: Provider } } }; zns?: undefined | { network: string; provider: Provider } }
  
  an object that describes what network to use when connecting UNS or ZNS default is mainnet
  - Optional uns?: undefined | { locations: { Layer1: { network: string; provider: Provider }; Layer2: { network: string; provider: Provider } } }
  - Optional zns?: undefined | { network: string; provider: Provider }
Returns Resolution

Static fromWeb3Version0Provider

fromWeb3Version0Provider(networks: { uns?: undefined | { locations: { Layer1: { network: string; provider: Web3Version0Provider }; Layer2: { network: string; provider: Web3Version0Provider } } } }): Resolution

- Defined in src/Resolution.ts:300
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
- networks: { uns?: undefined | { locations: { Layer1: { network: string; provider: Web3Version0Provider }; Layer2: { network: string; provider: Web3Version0Provider } } } }
  
  Ethereum network configuration with 0.x version provider from web3 ( must implement sendAsync(payload, callback) )
  - Optional uns?: undefined | { locations: { Layer1: { network: string; provider: Web3Version0Provider }; Layer2: { network: string; provider: Web3Version0Provider } } }
Returns Resolution

Static fromWeb3Version1Provider

fromWeb3Version1Provider(networks: { uns?: undefined | { locations: { Layer1: { network: string; provider: Web3Version1Provider }; Layer2: { network: string; provider: Web3Version1Provider } } } }): Resolution

- Defined in src/Resolution.ts:342
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
- networks: { uns?: undefined | { locations: { Layer1: { network: string; provider: Web3Version1Provider }; Layer2: { network: string; provider: Web3Version1Provider } } } }
  
  an optional object with 1.x version provider from web3 ( must implement send(payload, callback) ) that describes what network to use when connecting UNS default is mainnet
  - Optional uns?: undefined | { locations: { Layer1: { network: string; provider: Web3Version1Provider }; Layer2: { network: string; provider: Web3Version1Provider } } }
Returns Resolution

Static fromZilliqaProvider

fromZilliqaProvider(provider: Provider, networks?: undefined | { zns?: undefined | { network: string } }): Resolution

- Defined in src/Resolution.ts:280
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 | { zns?: undefined | { network: string } }
  
  an optional object that describes what network to use when connecting ZNS default is mainnet
Returns Resolution

Static infura

infura(infura: string, networks?: undefined | { uns?: undefined | { locations: { Layer1: { network: UnsSupportedNetwork }; Layer2: { network: UnsSupportedNetwork } } } }): Resolution

- Defined in src/Resolution.ts:118
Creates a resolution with configured infura id for uns

Parameters
- infura: string
  
  infura project id
- Optional networks: undefined | { uns?: undefined | { locations: { Layer1: { network: UnsSupportedNetwork }; Layer2: { network: UnsSupportedNetwork } } } }
  
  an optional object that describes what network to use when connecting UNS default is mainnet
Returns Resolution

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Default value __namedParameters: { sourceConfig: undefined | SourceConfig } = {}

sourceConfig: undefined | SourceConfig

Returns Resolution

Methods

addr

Parameters

domain: string

ticker: string

Returns Promise<string>

allNonEmptyRecords

Parameters

domain: string

Returns Promise<CryptoRecords>

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>

isAvailable

Parameters

domain: string

Returns Promise<boolean>

isRegistered

Parameters

domain: string

Returns Promise<boolean>

isSupportedDomain

Parameters

domain: string

Returns Promise<boolean>

isValidHash

Parameters

domain: string

hash: string

namingService: NamingServiceName

Returns boolean

locations

Parameters

domains: string[]

Returns Promise<Locations>

multiChainAddr

Parameters