@unstoppabledomains/resolution

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

API

API: { url: string }

Type declaration

url: string

Bip44Constants

Bip44Constants: [number, string, string]

Blockchain

Blockchain: { cns?: NamingServiceSource; ens?: NamingServiceSource; web3Provider?: Provider; zns?: NamingServiceSource }

Main configurational object for Resolution instance

Type declaration

Optional cns?: NamingServiceSource
Optional ens?: NamingServiceSource
Optional web3Provider?: Provider
Optional zns?: NamingServiceSource

ConfigurationErrorHandler

ConfigurationErrorHandler: (error: ConfigurationErrorOptions) => string

Alias for Resolution error handler function

Type declaration

- (error: ConfigurationErrorOptions): string
- Parameters
  - error: ConfigurationErrorOptions
  Returns string

ConfigurationErrorOptions

ConfigurationErrorOptions: { method?: ResolutionMethod }

Explains Resolution Error options

Type declaration

Optional method?: ResolutionMethod

Dictionary

Dictionary<T>: {}

Type parameters

Type declaration

[k: string]: T

NamingServiceSource

NamingServiceSource: string | boolean | SourceDefinition

NamingServiceSource just an alias

ProviderMethod

ProviderMethod: (payload: JsonRpcPayload, callback: (error: Error | null, result?: JsonRpcResponse) => void) => void

Type declaration

- (payload: JsonRpcPayload, callback: (error: Error | null, result?: JsonRpcResponse) => void): void
- Parameters
  - payload: JsonRpcPayload
  - callback: (error: Error | null, result?: JsonRpcResponse) => void
    - - (error: Error | null, result?: JsonRpcResponse): void
      - Parameters
        
        error: Error | null
        
        Optional result: JsonRpcResponse
        
        Returns void
  Returns void

ProviderParams

ProviderParams: unknown[] | object

ResolutionErrorHandler

ResolutionErrorHandler: (error: ResolutionErrorOptions) => string

Alias for Resolution error handler function

Type declaration

- (error: ResolutionErrorOptions): string
- Parameters
  - error: ResolutionErrorOptions
  Returns string

ResolutionErrorOptions

ResolutionErrorOptions: { currencyTicker?: undefined | string; domain?: undefined | string; method?: ResolutionMethod; methodName?: undefined | string; providerMessage?: undefined | string; recordName?: undefined | string }

Explains Resolution Error options

Type declaration

Optional currencyTicker?: undefined | string
Optional domain?: undefined | string
Optional method?: ResolutionMethod
Optional methodName?: undefined | string
Optional providerMessage?: undefined | string
Optional recordName?: undefined | string

ResolutionMethod

ResolutionMethod: NamingServiceName | "UDAPI"

ResolutionResponse

ResolutionResponse: { addresses: {}; gundb?: undefined | { public_key?: undefined | string; username?: undefined | string }; ipfs?: undefined | { html?: undefined | string; redirect_domain?: undefined | string }; meta: { owner: string | null; ttl: number; type: string }; records?: undefined | {}; whois?: undefined | { email?: undefined | string; for_sale?: undefined | false | true } }

ResolutionResulution

property: {Object} addresses - Resolution addresses for various currency addresses attached to the domain
property: {Object} meta - meta information about the owner of the domain

Type declaration

addresses: {}
- [key: string]: string
Optional gundb?: undefined | { public_key?: undefined | string; username?: undefined | string }
Optional ipfs?: undefined | { html?: undefined | string; redirect_domain?: undefined | string }
meta: { owner: string | null; ttl: number; type: string }
- owner: string | null
- ttl: number
- type: string
Optional records?: undefined | {}
Optional whois?: undefined | { email?: undefined | string; for_sale?: undefined | false | true }

ZnsResolution

ZnsResolution: { crypto?: Dictionary<{ address?: undefined | string }>; ttl?: undefined | string }

Default structure of ZnsResolution records

Type declaration

[key: string]: any
Optional crypto?: Dictionary<{ address?: undefined | string }>
Optional ttl?: undefined | string

nodeHash

nodeHash: string

owner

owner: string

ttl

ttl: string

Variables

Const CHARSET

CHARSET: "qpzry9x8gf2tvdw0s3jn54khce6mua7l" = "qpzry9x8gf2tvdw0s3jn54khce6mua7l"

Const DefaultSource

DefaultSource: "https://api.zilliqa.com" = "https://api.zilliqa.com"

Const EthCoinIndex

EthCoinIndex: "60" = "60"

Const GENERATOR

GENERATOR: number[] = [0x3b6a57b2, 0x26508e6d, 0x1ea119fa, 0x3d4233dd, 0x2a1462b3]

Const HRP

HRP: "zil" = "zil"

Const NullAddress

NullAddress: "0x0000000000000000000000000000000000000000" = "0x0000000000000000000000000000000000000000"

Const OldResolverAddresses

OldResolverAddresses: string[] = ['0x5ffc014343cd971b7eb70732021e26c35b744cc4','0x1da022710df5002339274aadee8d58218e9d6ab5','0xda1756bb923af5d1a05e277cb1e54f1d0a127890',]

Const UDApiDefaultUrl

UDApiDefaultUrl: "https://unstoppabledomains.com/api/v1" = "https://unstoppabledomains.com/api/v1"

Const UNCLAIMED_DOMAIN_RESPONSE

UNCLAIMED_DOMAIN_RESPONSE: { addresses: {}; gundb?: undefined | { public_key?: undefined | string; username?: undefined | string }; ipfs?: undefined | { html?: undefined | string; redirect_domain?: undefined | string }; meta: { owner: string | null; ttl: number; type: string }; records?: undefined | {}; whois?: undefined | { email?: undefined | string; for_sale?: undefined | false | true } } = UnclaimedDomainResponse

deprecated: Use UnclaimedDomainResponse instead (deprecated since 0.3.4)

Type declaration

addresses: {}
- [key: string]: string
Optional gundb?: undefined | { public_key?: undefined | string; username?: undefined | string }
Optional ipfs?: undefined | { html?: undefined | string; redirect_domain?: undefined | string }
meta: { owner: string | null; ttl: number; type: string }
- owner: string | null
- ttl: number
- type: string
Optional records?: undefined | {}
Optional whois?: undefined | { email?: undefined | string; for_sale?: undefined | false | true }

Const configObject

configObject: { type: string; value: string } = getConfig()

Type declaration

type: string
value: string

Const secp256k1

secp256k1: any = new elliptic.ec('secp256k1')

Const tHRP

tHRP: "tzil" = "tzil"

Functions

Const UrlNetworkMap

UrlNetworkMap(url: string): any

- Defined in src/Zns.ts:39
Parameters
- url: string
Returns any

buildResolutionPackage

buildResolutionPackage(): Resolution

- Defined in src/cli/cli-helpers.ts:44
Returns Resolution

Const bytesLength

bytesLength(a: string): number

- Defined in src/utils/recoverSignature.ts:7
Parameters
- a: string
Returns number

Const bytesSlice

bytesSlice(i: number, j: number, bs: string): string

- Defined in src/utils/recoverSignature.ts:8
Parameters
- i: number
- j: number
- bs: string
Returns string

Const bytesToNumber

bytesToNumber(hex: string): number

- Defined in src/utils/recoverSignature.ts:10
Parameters
- hex: string
Returns number

commaSeparatedList

commaSeparatedList(value: any, dummyPrevious: any): any

- Defined in src/cli/cli-helpers.ts:23
Parameters
- value: any
- dummyPrevious: any
Returns any

convertBits

convertBits(data: Buffer, fromWidth: number, toWidth: number, pad?: boolean): null | Buffer

- Defined in src/zns/utils.ts:38
convertBits

groups buffers of a certain width to buffers of the desired width.

For example, converts byte buffers to buffers of maximum 5 bit numbers, padding those numbers as necessary. Necessary for encoding Ethereum-style addresses as bech32 ones.

Parameters
- data: Buffer
- fromWidth: number
- toWidth: number
- Default value pad: boolean = true
Returns null | Buffer

createChecksum

createChecksum(hrp: string, data: Buffer): Buffer

- Defined in src/zns/utils.ts:101
Parameters
- hrp: string
- data: Buffer
Returns Buffer

decode

decode(bechString: string): null | { data: Buffer; hrp: string }

- Defined in src/zns/utils.ts:130
Parameters
- bechString: string
Returns null | { data: Buffer; hrp: string }

Const decodeSignature

decodeSignature(hex: string): string[]

- Defined in src/utils/recoverSignature.ts:12
Parameters
- hex: string
Returns string[]

encode

encode(hrp: string, data: Buffer): string

- Defined in src/zns/utils.ts:120
Parameters
- hrp: string
- data: Buffer
Returns string

fromBech32Address

fromBech32Address(address: string, testnet?: boolean): string

- Defined in src/zns/utils.ts:243
fromBech32Address

Parameters
- address: string
  
  a valid Zilliqa bech32 address
- Default value testnet: boolean = false
Returns string

a canonical 20-byte Ethereum-style address

fromEthersProvider

fromEthersProvider(provider: EthersProvider): Provider

- Defined in src/utils/Eip1993Factories.ts:82
Creates a Provider instance from a 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 Provider

fromWeb3Version0Provider

fromWeb3Version0Provider(provider: Web3Version0Provider): Provider

- Defined in src/utils/Eip1993Factories.ts:23
Create a Provider 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 Provider

fromWeb3Version1Provider

fromWeb3Version1Provider(provider: Web3Version1Provider): Provider

- Defined in src/utils/Eip1993Factories.ts:51
Create a Provider 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 Provider

getConfig

getConfig(): { type: string; value: string }

- Defined in src/cli/cli-helpers.ts:64
Returns { type: string; value: string }
- type: string
- value: string

getEthereumUrl

getEthereumUrl(): string

- Defined in src/cli/cli-helpers.ts:33
Returns string

Const hashMessage

hashMessage(message: string): string

- Defined in src/utils/recoverSignature.ts:30
Parameters
- message: string
Returns string

hexToBytes

hexToBytes(hexString: string): number[]

- Defined in src/utils/index.ts:47
Parameters
- hexString: string
Returns number[]

hrpExpand

hrpExpand(hrp: string): Buffer

- Defined in src/zns/utils.ts:73
Parameters
- hrp: string
Returns Buffer

invert

invert(object: any): {}

- Defined in src/utils/index.ts:23
Should invert the object (keys becomes values and values becomes keys)

Parameters
- object: any
Returns {}

isAddress

isAddress(address: string): boolean

- Defined in src/zns/utils.ts:19
Parameters
- address: string
Returns boolean

isLegacyResolver

isLegacyResolver(resolverAddress: string): boolean

- Defined in src/utils/index.ts:40
Parameters
- resolverAddress: string
Returns boolean

isNullAddress

isNullAddress(key: string | null | undefined): key is undefined | null

- Defined in src/types.ts:246
Parameters
- key: string | null | undefined
Returns key is undefined | null

Const isValidTwitterSignature

isValidTwitterSignature(domain: string, owner: string, twitterHandle: string, validationSignature: string): Promise<boolean>

- Defined in src/utils/verifyTwitterSig.ts:6
Parameters
- domain: string
- owner: string
- twitterHandle: string
- validationSignature: string
Returns Promise<boolean>

parseConfig

parseConfig(value: string): { type: string; value: string }

- Defined in src/cli/cli-helpers.ts:53
Parameters
- value: string
Returns { type: string; value: string }
- type: string
- value: string

polymod

polymod(values: Buffer): number

- Defined in src/zns/utils.ts:86
Parameters
- values: Buffer
Returns number

Const recover

recover(message: string, signature: string): string

- Defined in src/utils/recoverSignature.ts:39
Parameters
- message: string
- signature: string
Returns string

set

set(object: any, key: any, value: any): any

- Defined in src/utils/index.ts:7
Parses object in format { "key.key2.key3" : value } into { key: { key2: {key3: value } } }

Parameters
- object: any
  
  object to parse
- key: any
  
  string to split
- value: any
  
  value to make it equal to
Returns any

signedInfuraLink

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

- Defined in src/utils/index.ts:33
Parameters
- infura: string
- Default value network: string = "mainnet"
Returns string

storeConfig

storeConfig(type: "infura" | "url", value: string): void

- Defined in src/cli/cli-helpers.ts:58
Parameters
- type: "infura" | "url"
- value: string
Returns void

toBech32Address

toBech32Address(address: string, testnet?: boolean): string

- Defined in src/zns/utils.ts:216
toBech32Address

Encodes a canonical 20-byte Ethereum-style address as a bech32 zilliqa address.

The expected format is zil1
where address and checksum are the result of bech32 encoding a Buffer containing the address bytes.

Parameters
- address: string
- Default value testnet: boolean = false
Returns string

38 char bech32 encoded zilliqa address

Const toChecksum

toChecksum(address: string): string

- Defined in src/utils/recoverSignature.ts:18
Parameters
- address: string
Returns string

Const toChecksumAddress

toChecksumAddress(address: string): string

- Defined in src/zns/utils.ts:178
toChecksumAddress

takes hex-encoded string and returns the corresponding address

Parameters
- address: string
Returns string

tryInfo

tryInfo(method: any, response: any, name: string): Promise<boolean>

- Defined in src/cli/cli-helpers.ts:5
Parameters
- method: any
- response: any
- name: string
Returns Promise<boolean>

verifyChecksum

verifyChecksum(hrp: string, data: Buffer): boolean

- Defined in src/zns/utils.ts:116
Parameters
- hrp: string
- data: Buffer
Returns boolean

wrapArray

wrapArray<T>(params?: T | T[]): T[]

- Defined in src/utils/Eip1993Factories.ts:108
Type parameters
- T
Parameters
- Default value params: T | T[] = []
Returns T[]

Object literals

Const DefaultAPI

DefaultAPI: object

url

url: string = UDApiDefaultUrl

Const Eip1993Factories

Eip1993Factories: object

fromEthersProvider

fromEthersProvider: fromEthersProvider

fromWeb3Version0Provider

fromWeb3Version0Provider: fromWeb3Version0Provider

fromWeb3Version1Provider

fromWeb3Version1Provider: fromWeb3Version1Provider

Const NetworkIdMap

NetworkIdMap: object

localnet

localnet: number = 111

mainnet

mainnet: number = 1

testnet

testnet: number = 333

Const ReaderMap

ReaderMap: object

1

1: string = "0x7ea9ee21077f84339eda9c80048ec6db678642b1"

42

42: string = "0xcf4318918fd18aca9bdc11445c01fbada4b448e3"

Const RegistryMap

RegistryMap: object

1

1: string = "zil1jcgu2wlx6xejqk9jw3aaankw6lsjzeunx2j0jz"

Const UnclaimedDomainResponse

UnclaimedDomainResponse: object

addresses

addresses: {}

Type declaration

owner

owner: null = null

ttl

ttl: number = 0

type

type: string = ""

Const UrlMap

UrlMap: object

1

1: string = "https://api.zilliqa.com"

111

111: string = "http://localhost:4201"

333

333: string = "https://dev-api.zilliqa.com"

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

API

Type declaration

url: string

Bip44Constants

Blockchain

Type declaration

Optional cns?: NamingServiceSource

Optional ens?: NamingServiceSource

Optional web3Provider?: Provider

Optional zns?: NamingServiceSource

ConfigurationErrorHandler

Type declaration

Parameters

error: ConfigurationErrorOptions

Returns string

ConfigurationErrorOptions

Type declaration

Optional method?: ResolutionMethod

Dictionary

Type parameters

T

Type declaration

[k: string]: T

NamingServiceSource

ProviderMethod

Type declaration

Parameters

payload: JsonRpcPayload

callback: (error: Error | null, result?: JsonRpcResponse) => void

Parameters

error: Error | null

Optional result: JsonRpcResponse

Returns void

Returns void

ProviderParams

ResolutionErrorHandler

Type declaration

Parameters

error: ResolutionErrorOptions

Returns string

ResolutionErrorOptions

Type declaration

Optional currencyTicker?: undefined | string

Optional domain?: undefined | string

Optional method?: ResolutionMethod

Optional methodName?: undefined | string

Optional providerMessage?: undefined | string

Optional recordName?: undefined | string

ResolutionMethod

ResolutionResponse

Type declaration

addresses: {}

[key: string]: string

Optional gundb?: undefined | { public_key?: undefined | string; username?: undefined | string }

Optional ipfs?: undefined | { html?: undefined | string; redirect_domain?: undefined | string }

meta: { owner: string | null; ttl: number; type: string }

owner: string | null

ttl: number

type: string

Optional records?: undefined | {}

Optional whois?: undefined | { email?: undefined | string; for_sale?: undefined | false | true }

ZnsResolution

Type declaration

[key: string]: any

Optional crypto?: Dictionary<{ address?: undefined | string }>

Optional ttl?: undefined | string

nodeHash

owner

ttl

Variables

Const CHARSET