Resolution | @unstoppabledomains/resolution

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.address(domain, "eth").then(addr => console.log(addr));;

Hierarchy

Resolution

Index

Constructors

constructor

Properties

blockchain

Constructors

constructor

new Resolution(__namedParameters?: { api: { url: string }; blockchain: false | true | { cns?: NamingServiceSource; ens?: NamingServiceSource; web3Provider?: Provider; zns?: NamingServiceSource } }): Resolution

- Defined in src/Resolution.ts:55
Parameters
- Default value __namedParameters: { api: { url: string }; blockchain: false | true | { cns?: NamingServiceSource; ens?: NamingServiceSource; web3Provider?: Provider; zns?: NamingServiceSource } } = {}
  - api: { url: string }
    - url: string
  - blockchain: false | true | { cns?: NamingServiceSource; ens?: NamingServiceSource; web3Provider?: Provider; zns?: NamingServiceSource }
Returns Resolution

Properties

Readonly blockchain

blockchain: boolean

returns: true if weather resolution library is configured to use blockchain for resolution.

Methods

address

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

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

async

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

A promise that resolves in an address or null

addressOrThrow

addressOrThrow(domain: string, currencyTicker: string): Promise<string>

- Defined in src/Resolution.ts:263
throws

ResolutionError if address is not found

Parameters
- domain: string
  
  domain name
- currencyTicker: string
  currency ticker such as
  - ZIL
  - BTC
  - ETH
Returns Promise<string>

A specific currency address or throws an error

chatId

chatId(domain: string): Promise<string>

- Defined in src/Resolution.ts:189
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:201
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: nodeHash, label: string, method: NamingServiceName): nodeHash

- Defined in src/Resolution.ts:333
Parameters
- parent: nodeHash
  
  namehash of a parent domain
- label: string
  
  subdomain name
- method: NamingServiceName
  
  "ENS", "CNS" or "ZNS"
Returns nodeHash

a namehash of a subdomain with name label

email

email(domain: string): Promise<string>

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

throws

ResolutionError

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

ipfsRedirect

ipfsRedirect(domain: string): Promise<string>

- Defined in src/Resolution.ts:233
Resolves the ipfs redirect url for a supported domain records

deprecated

use Resolution#httpUrl instead

throws

ResolutionError

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

A Promise that resolves in redirect url

isSupportedDomain

isSupportedDomain(domain: string): boolean

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

isSupportedDomainInNetwork

isSupportedDomainInNetwork(domain: string): boolean

- Defined in src/Resolution.ts:366
Checks if the domain is supported by the specified network as well as if it is in valid format

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

isValidHash

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

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

namehash

namehash(domain: string): string

- Defined in src/Resolution.ts:322
throws

ResolutionError with UnsupportedDomain error code if domain extension is unknown

Parameters
- domain: string
  
  domain name to be converted
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:285
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:296
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

resolve

resolve(domain: string): Promise<ResolutionResponse>

- Defined in src/Resolution.ts:153
Resolves the given domain

async

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

A promise that resolves in an object

resolver

resolver(domain: string): Promise<string>

- Defined in src/Resolution.ts:276
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:309
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): NamingServiceName

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

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

Static fromEip1193Provider

fromEip1193Provider(provider: Provider): Resolution

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

see

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

Parameters
- provider: Provider
  
  any provider compatible with EIP-1193
Returns Resolution

Static fromEthersProvider

fromEthersProvider(provider: EthersProvider): Resolution

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

Static fromWeb3Version0Provider

fromWeb3Version0Provider(provider: Web3Version0Provider): Resolution

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

Static fromWeb3Version1Provider

fromWeb3Version1Provider(provider: Web3Version1Provider): Resolution

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

Static infura

infura(infura: string, network?: string): Resolution

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

Parameters
- infura: string
  
  infura project id
- Default value network: string = "mainnet"
  
  ethereum network name
Returns Resolution

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Default value __namedParameters: { api: { url: string }; blockchain: false | true | { cns?: NamingServiceSource; ens?: NamingServiceSource; web3Provider?: Provider; zns?: NamingServiceSource } } = {}

api: { url: string }

url: string

blockchain: false | true | { cns?: NamingServiceSource; ens?: NamingServiceSource; web3Provider?: Provider; zns?: NamingServiceSource }

Returns Resolution

Properties

Readonly blockchain

Methods

address

Parameters

domain: string

currencyTicker: string

Returns Promise<string | null>

addressOrThrow

Parameters

domain: string

currencyTicker: string

Returns Promise<string>

chatId

Parameters

domain: string

Returns Promise<string>

chatPk

Parameters

domain: string

Returns Promise<string>

childhash

Parameters

parent: nodeHash

label: string

method: NamingServiceName

Returns nodeHash

email

Parameters

domain: string

Returns Promise<string>

httpUrl

Parameters

domain: string

Returns Promise<string>

ipfsHash

Parameters

domain: string

Returns Promise<string>

ipfsRedirect

Parameters

domain: string

Returns Promise<string>

isSupportedDomain

Parameters

domain: string

Returns boolean

isSupportedDomainInNetwork

Parameters

domain: string

Returns boolean

isValidHash

Parameters

domain: string

hash: string

Returns boolean

namehash

Parameters

domain: string

Returns string

owner

Parameters

domain: string

Returns Promise<string | null>

record

Parameters

domain: string