Class DWEBName

constructor

• new DWEBName(options): DWEBName

• Parameters

  • options: NameConfig

  Returns DWEBName

Readonly features

Readonly name

Readonly namehash

Readonly network

clearDNS

• clearDNS(): Promise<TransactionResponse>

• Remove all DNS records for name

  Returns Promise<TransactionResponse>

getAddress

• getAddress(coinId?): Promise<null | string>

• Get Ethereum or other blockchain address associated with name

  Parameters

  • Optional coinId: string

  Returns Promise<null | string>

getAddressBatch

• getAddressBatch(coinIds): Promise<{
      address: string;
      id: string;
      success: boolean;
      type: number;
  }[]>

• Get multiple coin addresses associated with name

  Parameters

  • coinIds: string[]

    array of coinIds ['ETH', 'BTC']

  Returns Promise<{
      address: string;
      id: string;
      success: boolean;
      type: number;
  }[]>

getContenthash

• getContenthash(): Promise<null | string>

• Returns Promise<null | string>

getDNS

• getDNS(type): Promise<null | Buffer>

• Get DNS records of given type. Records are in binary format.

  Parameters

  • type: number

  Returns Promise<null | Buffer>

getExpirationDate

• getExpirationDate(): Promise<null | Date>

• Get expiration date of the domain. Returns null if the domain has no expiration date.

  Returns Promise<null | Date>

getOwner

• getOwner(): Promise<string>

• Returns Promise<string>

getResolver

• getResolver(writable?): Promise<null | Contract>

• Get resolver contract instance

  Parameters

  • writable: boolean = false

    writable instance will allow calling methods that change data

  Returns Promise<null | Contract>

getResolverAddr

• getResolverAddr(forceRefresh?): Promise<null | string>

• Return resolver contract address

  Parameters

  • forceRefresh: boolean = false

    if true will query blockchain for address even if we have it

  Returns Promise<null | string>

getTTL

• getTTL(): Promise<number>

• Get time to live for the records in seconds. Note that DNS records have TTL specified in the records themselves.

  Returns Promise<number>

getText

• getText(key): Promise<string>

• Parameters

  • key: string

  Returns Promise<string>

hasDNS

• hasDNS(): Promise<any>

• Returns Promise<any>

hasResolver

• hasResolver(): Promise<boolean>

• Returns Promise<boolean>

setAddress

• setAddress(coinId, address): Promise<TransactionResponse>

• Parameters

  • coinId: string

  • address: string

  Returns Promise<TransactionResponse>

setAddressBatch

• setAddressBatch(data): Promise<TransactionResponse>

• Set multiple coin addresses associated with name in a single transaction.

  Parameters

  • data: Record<string, string>

    map of coinId to address {'ETH': '0x1234', 'BTC': 'bc1q...'}

  Returns Promise<TransactionResponse>

setContenthash

• setContenthash(contentUrl): Promise<TransactionResponse>

• Samples:

  1. IPFS ipfs://QmRAQB6YaCyidP37UdDnjFY5vQuiBrcqdyoW1CuDgwxkD4
  2. Swarm bzz://d1de9994b4d039f6548d191eb26786769f580809256b4685ef316805265ea162

  Parameters

  • contentUrl: null | string

  Returns Promise<TransactionResponse>

setDNS

• setDNS(data): Promise<TransactionResponse>

• Write DNS data in binary wire format

  Parameters

  • data: Buffer

    DNS records encoded in binary format

  Returns Promise<TransactionResponse>

setText

• setText(key, value): Promise<TransactionResponse>

• Parameters

  • key: string

  • value: string

  Returns Promise<TransactionResponse>