Class DWEBRegistry

Hierarchy

DwebContractWrapper
- DWEBRegistry

Index

Constructors

Properties

chainId contract contractConfig network provider signer?

Accessors

Methods

assignDefaultResolver getOwnedDomains getReverseRecord name nameExists setResolver setReverseRecord

Constructors

constructor

new DWEBRegistry(options): DWEBRegistry
Parameters
- options: DwebConfig
Returns DWEBRegistry
Overrides DwebContractWrapper.constructor
- Defined in packages/core/src/DWEBRegistry.ts:12

Properties

`Readonly` chainId

chainId: number

`Protected` `Readonly` contract

contract: Contract

`Readonly` contractConfig

contractConfig: ContractConfig

`Readonly` network

network: Network

`Readonly` provider

provider: BaseProvider

`Optional` `Readonly` signer

signer?: Signer

Accessors

readonly

get readonly(): boolean
Returns boolean
Inherited from DwebContractWrapper.readonly
- Defined in packages/core/src/DwebContractWrapper.ts:39

Methods

assignDefaultResolver

assignDefaultResolver(name): Promise<TransactionResponse>
Assign default resolver contract to domain name. This is usually done during the registration process, but may be required if domain has no resolver set or if it is no compatible with Decentraweb.
Parameters
- name: string
Returns Promise<TransactionResponse>
- Defined in packages/core/src/DWEBRegistry.ts:51

getOwnedDomains

getOwnedDomains(address, skip, limit): Promise<{
    createdAt: Date;
    expiresAt: null | Date;
    isTLD: boolean;
    name: string;
    renewalFee: null | number;
}[]>
Get all domains owned by address on current network
Parameters
- address: string
  
  Ethereum address
- skip: number
- limit: number
Returns Promise<{
    createdAt: Date;
    expiresAt: null | Date;
    isTLD: boolean;
    name: string;
    renewalFee: null | number;
}[]>
- Defined in packages/core/src/DWEBRegistry.ts:126

getReverseRecord

getReverseRecord(address, skipForwardCheck?): Promise<null | string>
Get reverse record for address.

Important: address owner can set any name for his address, even if he doesn't own it, or it is not registered. To check that name is valid, we check that it resolves to the same address.
Parameters
- address: string
- skipForwardCheck: boolean = false
  
  by default we check that returned name resolves to the same address. Set this to true to skip this check.
Returns Promise<null | string>
- Defined in packages/core/src/DWEBRegistry.ts:77

name

name(name): DWEBName
Create instance of DWEBName to read/write data for specific domain name
Parameters
- name: string
  
  domain name you would like to work with
Returns DWEBName
- Defined in packages/core/src/DWEBRegistry.ts:20

nameExists

nameExists(name): Promise<boolean>
Check if domain name exists. Note that name could be located on Ethereum or Polygon network. If name is currently on Polygon, it will not exist on Ethereum and vice versa.
Parameters
- name: string
Returns Promise<boolean>
- Defined in packages/core/src/DWEBRegistry.ts:35

setResolver

setResolver(name, address): Promise<TransactionResponse>
Set resolver contract for domain name. May be used to assign domain custom resolver contract.

Be careful as this may break domain functionality if resolver contract is not compatible with Decentraweb.
Parameters
- name: string
  
  domain name you would like to work assign resolver to
- address: string
  
  address of resolver contract
Returns Promise<TransactionResponse>
- Defined in packages/core/src/DWEBRegistry.ts:64

setReverseRecord

setReverseRecord(name): Promise<TransactionResponse>
Set reverse record for signer address. Don't forget to also assign this address to name.
Parameters
- name: string
Returns Promise<TransactionResponse>
- Defined in packages/core/src/DWEBRegistry.ts:109

Generated using TypeDoc