Unstoppabledomains resolution library

Index

Enumerations

Classes

Interfaces

Variables

Functions

isApi

Object literals

UnclaimedDomainResponse

Type aliases

Api

Api: { api: true; network?: undefined | number; url?: undefined | string }

Type declaration

api: true
Optional network?: undefined | number
Optional url?: undefined | string

AutoNetworkConfigs

AutoNetworkConfigs: { ens?: { url: string } | { provider: Provider }; uns?: undefined | { locations: { Layer1: { url: string } | { provider: Provider }; Layer2: { url: string } | { provider: Provider } } }; zns?: { url: string } | { provider: Provider } }

Type declaration

Optional ens?: { url: string } | { provider: Provider }
Optional uns?: undefined | { locations: { Layer1: { url: string } | { provider: Provider }; Layer2: { url: string } | { provider: Provider } } }
Optional zns?: { url: string } | { provider: Provider }

ConfigurationErrorOptions

ConfigurationErrorOptions: { config?: undefined | string; dependency?: undefined | string; field?: undefined | string; method?: ResolutionMethod; version?: undefined | string }

Explains Resolution Error options

Type declaration

Optional config?: undefined | string
Optional dependency?: undefined | string
Optional field?: undefined | string
Optional method?: ResolutionMethod
Optional version?: undefined | string

CryptoRecords

CryptoRecords: Record<string, string>

DnsRecordsErrorHandler

DnsRecordsErrorHandler: (error: DnsRecordsErrorOptions) => string

Type declaration

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

DnsRecordsErrorOptions

DnsRecordsErrorOptions: { recordType?: DnsRecordType }

Explains DnsRecords Error options

Type declaration

Optional recordType?: DnsRecordType

DomainData

DomainData: { location: UnsLocation; owner: string; records: CryptoRecords; resolver: string }

Type declaration

location: UnsLocation
owner: string
records: CryptoRecords
resolver: string

DomainLocation

DomainLocation: { blockchain: BlockchainType; blockchainProviderUrl: string; networkId: number; ownerAddress: string; registryAddress: string; resolverAddress: string }

Type declaration

blockchain: BlockchainType
blockchainProviderUrl: string
networkId: number
ownerAddress: string
registryAddress: string
resolverAddress: string

EnsSource

EnsSource: NamingServiceSource & { network: string; proxyServiceApiKey?: undefined | string; registryAddress?: undefined | string }

Locations

Locations: Record<string, DomainLocation | null>

NamehashOptions

NamehashOptions: { format?: "dec" | "hex"; prefix?: undefined | false | true; zns?: undefined | false | true }

Type declaration

Optional Readonly format?: "dec" | "hex"
Optional Readonly prefix?: undefined | false | true
Optional Readonly zns?: undefined | false | true

NamingServiceSource

NamingServiceSource: { url?: undefined | string } | { provider?: Provider }

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

ResolutionConfig

ResolutionConfig: { apiKey?: undefined | string; sourceConfig?: SourceConfig }

Type declaration

Optional apiKey?: undefined | string
Optional sourceConfig?: SourceConfig

ResolutionErrorOptions

ResolutionErrorOptions: { config?: ResolutionConfig; currencyTicker?: undefined | string; domain?: undefined | string; errorMessage?: undefined | string; location?: UnsLocation; method?: ResolutionMethod; methodName?: undefined | string; namingService?: undefined | string; providerMessage?: undefined | string; recordName?: undefined | string; tokenUri?: undefined | string }

Explains Resolution Error options

Type declaration

Optional config?: ResolutionConfig
Optional currencyTicker?: undefined | string
Optional domain?: undefined | string
Optional errorMessage?: undefined | string
Optional location?: UnsLocation
Optional method?: ResolutionMethod
Optional methodName?: undefined | string
Optional namingService?: undefined | string
Optional providerMessage?: undefined | string
Optional recordName?: undefined | string
Optional tokenUri?: undefined | string

ResolutionMethod

ResolutionMethod: NamingServiceName | UnsLocation | "UDAPI"

ResolutionResponse

ResolutionResponse: { addresses: {}; meta: { blockchain: BlockchainType | null; domain: string; namehash: string; owner: string | null; resolver: string; ttl: number; type: string }; records: {} }

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
meta: { blockchain: BlockchainType | null; domain: string; namehash: string; owner: string | null; resolver: string; ttl: number; type: string }
- blockchain: BlockchainType | null
- domain: string
- namehash: string
- owner: string | null
- resolver: string
- ttl: number
- type: string
records: {}
- [key: string]: string

ReverseResolutionOptions

ReverseResolutionOptions: { location?: UnsLocation }

Type declaration

Optional location?: UnsLocation

ServicesEntry

ServicesEntry: { native: NamingService; usedServices: NamingService[] }

Type declaration

native: NamingService
usedServices: NamingService[]

SourceConfig

SourceConfig: { ens?: EnsSource | Api; uns?: UnsSource | Api; zns?: ZnsSource | Api }

Type declaration

Optional ens?: EnsSource | Api
Optional uns?: UnsSource | Api
Optional zns?: ZnsSource | Api

TokenUriMetadataAttribute

TokenUriMetadataAttribute: { value: string | number } | { trait_type: string; value: string | number } | { display_type: "number" | "date" | "boost_number" | "boost_percentage" | "ranking"; trait_type: string; value: number }

UnsLayerSource

UnsLayerSource: NamingServiceSource & { network: string; proxyReaderAddress?: undefined | string; proxyServiceApiKey?: undefined | string }

UnsSource

UnsSource: { locations: { Layer1: UnsLayerSource; Layer2: UnsLayerSource } }

Type declaration

locations: { Layer1: UnsLayerSource; Layer2: UnsLayerSource }
- Layer1: UnsLayerSource
- Layer2: UnsLayerSource

ZnsSource

ZnsSource: NamingServiceSource & { network: string; registryAddress?: undefined | string }

Variables

Const DEFAULT_UNS_PROXY_SERVICE_URL

DEFAULT_UNS_PROXY_SERVICE_URL: "https://api.unstoppabledomains.com/resolve" = "https://api.unstoppabledomains.com/resolve"

Const NamehashOptionsDefault

NamehashOptionsDefault: { format: "hex"; prefix: true; zns: false } = {format: 'hex',prefix: true,zns: false,} as const

Type declaration

format: "hex"
prefix: true
zns: false

Const UDApiDefaultUrl

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

Functions

isApi

isApi(obj: any): obj is Api

- Defined in src/Resolution.ts:1233
Parameters
- obj: any
Returns obj is Api

Object literals

Const UnclaimedDomainResponse

UnclaimedDomainResponse: object

addresses

addresses: {}

Type declaration

records

records: {}

Type declaration

blockchain

blockchain: null = null

domain

domain: string = ""

namehash

namehash: string = ""

owner

owner: null = null

resolver

resolver: string = ""

ttl

ttl: number = 0

type

type: string = ""

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

Api

Type declaration

api: true

Optional network?: undefined | number

Optional url?: undefined | string

AutoNetworkConfigs

Type declaration

Optional ens?: { url: string } | { provider: Provider }

Optional uns?: undefined | { locations: { Layer1: { url: string } | { provider: Provider }; Layer2: { url: string } | { provider: Provider } } }

Optional zns?: { url: string } | { provider: Provider }

ConfigurationErrorOptions

Type declaration

Optional config?: undefined | string

Optional dependency?: undefined | string

Optional field?: undefined | string

Optional method?: ResolutionMethod

Optional version?: undefined | string

CryptoRecords

DnsRecordsErrorHandler

Type declaration

Parameters

error: DnsRecordsErrorOptions

Returns string

DnsRecordsErrorOptions

Type declaration

Optional recordType?: DnsRecordType

DomainData

Type declaration

location: UnsLocation

owner: string

records: CryptoRecords

resolver: string

DomainLocation

Type declaration

blockchain: BlockchainType

blockchainProviderUrl: string

networkId: number

ownerAddress: string

registryAddress: string

resolverAddress: string

EnsSource

Locations

NamehashOptions

Type declaration

Optional Readonly format?: "dec" | "hex"

Optional Readonly prefix?: undefined | false | true

Optional Readonly zns?: undefined | false | true

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

ResolutionConfig

Type declaration

Optional apiKey?: undefined | string

Optional sourceConfig?: SourceConfig

ResolutionErrorOptions

Type declaration

Optional config?: ResolutionConfig

Optional currencyTicker?: undefined | string

Optional domain?: undefined | string

Optional errorMessage?: undefined | string

Optional location?: UnsLocation

Optional method?: ResolutionMethod

Optional methodName?: undefined | string