Class SubdomainRegistrar

Class that handles subdomain registration. Registration is done in 2 steps:

Calling approveSelfRegistration or approveOndemandRegistration to get registration approval.
Calling finishRegistration to finish registration.

Example

const subdomainRegistrar = new SubdomainRegistrar({
  network: network,
  provider: provider,
  signer: signer
});
const registration = await subdomainRegistrar.approveSelfRegistration({ name: 'wallet', label: 'john' });
const tx = await subdomainRegistrar.finishRegistration(registration);
await tx.wait(1);

Hierarchy

BaseRegistrar
- SubdomainRegistrar

Constructors

constructor

new SubdomainRegistrar(options): SubdomainRegistrar
Parameters
- options: RegistrarConfig
Returns SubdomainRegistrar
Inherited from BaseRegistrar.constructor
- Defined in packages/core/src/registrars/BaseRegistrar.ts:31

Properties

`Readonly` api

api: DecentrawebAPI

DecentraWeb API wrapper instance

`Readonly` chainId

chainId: number

`Protected` `Readonly` contract

contract: Contract

`Readonly` contractConfig

contractConfig: ContractConfig

`Readonly` dwebToken

dwebToken: Contract

DWEB token contract

`Readonly` network

network: Network

Current network name

`Readonly` provider

provider: BaseProvider

`Readonly` signer

signer: Signer

Ethers.js Ethereum signer for writing data to the blockchain

`Optional` `Readonly` wethToken

wethToken?: Contract

WETH token contract, only available on the Polygon network

Accessors

isMatic

get isMatic(): boolean
Is the registrar on the Polygon network

Returns boolean
Inherited from BaseRegistrar.isMatic
- Defined in packages/core/src/registrars/BaseRegistrar.ts:52

readonly

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

Methods

allowTokenUsage

allowTokenUsage(token): Promise<TransactionReceipt>
Approve unlimited token usage by the registrar contract, so no further approvals are needed
Parameters
- token: "DWEB" | "WETH"
  
  token name. WETH is only supported on the Polygon network
Returns Promise<TransactionReceipt>
Inherited from BaseRegistrar.allowTokenUsage
- Defined in packages/core/src/registrars/BaseRegistrar.ts:126

approveOndemandRegistration

approveOndemandRegistration(entry, isFeeInDWEB?, owner?): Promise<ApprovedRegistration>
Get subdomain registration approval for staked domain names
Parameters
- entry: OnDemandEntry | OnDemandEntry[]
- isFeeInDWEB: boolean = false
  
  if true, registration fee will be paid in DWEB tokens, otherwise in ETH
- owner: null | string = null
Returns Promise<ApprovedRegistration>
- Defined in packages/core/src/registrars/SubdomainRegistrar/index.ts:76

approveSelfRegistration

approveSelfRegistration(entry, isFeeInDWEB?, owner?): Promise<ApprovedRegistration>
Get subdomain registration approval for domain names owned by signer
Parameters
- entry: SelfRegEntry | SelfRegEntry[]
  
  list of domains and subdomains to register
- isFeeInDWEB: boolean = false
  
  if true, registration fee will be paid in DWEB tokens, otherwise in ETH
- owner: null | string = null
  
  ETH address of the owner of created subdomains, defaults to signer address
Returns Promise<ApprovedRegistration>
- Defined in packages/core/src/registrars/SubdomainRegistrar/index.ts:44

calculateTotalFee

calculateTotalFee(approval, isFeeInDWEB?): Promise<SubdomainFees>
Calculate total owner and service fee for approved subdomain registration
Parameters
- approval: SubdomainApproval
- isFeeInDWEB: boolean = false
Returns Promise<SubdomainFees>
- Defined in packages/core/src/registrars/SubdomainRegistrar/index.ts:215

finishRegistration

finishRegistration(__namedParameters): Promise<TransactionResponse>
Parameters
- __namedParameters: ApprovedRegistration
Returns Promise<TransactionResponse>
- Defined in packages/core/src/registrars/SubdomainRegistrar/index.ts:96

getRenewalServiceFee

getRenewalServiceFee(): Promise<number>
Get service fee for subdomain renewal.

Returns Promise<number>
- fee in USD
- Defined in packages/core/src/registrars/SubdomainRegistrar/index.ts:277

getServiceFee

getServiceFee(): Promise<number>
Get service fee for subdomain registration

Returns Promise<number>
- fee in USD
- Defined in packages/core/src/registrars/SubdomainRegistrar/index.ts:268

getTokenAllowance

getTokenAllowance(token): Promise<BigNumber>
Get DWEB/WETH token amount that can be used by the registrar contract
Parameters
- token: "DWEB" | "WETH"
  
  token name. WETH is only supported on the Polygon network
Returns Promise<BigNumber>
Inherited from BaseRegistrar.getTokenAllowance
- Defined in packages/core/src/registrars/BaseRegistrar.ts:88

getTokenBalance

getTokenBalance(token): Promise<BigNumber>
Get DWEB/WETH token balance of the signer
Parameters
- token: "DWEB" | "WETH"
  
  token name. WETH is only supported on the Polygon network
Returns Promise<BigNumber>
Inherited from BaseRegistrar.getTokenBalance
- Defined in packages/core/src/registrars/BaseRegistrar.ts:107

normalizeEntries

normalizeEntries(entry): Promise<SubdomainEntry[]>
Parameters
- entry: SubdomainEntry | SubdomainEntry[]
Returns Promise<SubdomainEntry[]>
- Defined in packages/core/src/registrars/SubdomainRegistrar/index.ts:252

setTokenAllowance

setTokenAllowance(token, amount): Promise<TransactionReceipt>
Approve the DWEB/WETH token amount that can be used by the registrar contract
Parameters
- token: "DWEB" | "WETH"
  
  token name. WETH is only supported on the Polygon network
- amount: BigNumber
  
  amount in wei
Returns Promise<TransactionReceipt>
Inherited from BaseRegistrar.setTokenAllowance
- Defined in packages/core/src/registrars/BaseRegistrar.ts:61

stakingStatus

stakingStatus(domains): Promise<StakingState[]>
Check staking status of a list of domains
Parameters
- domains: string[]
  
  list of domains to check
Returns Promise<StakingState[]>
Inherited from BaseRegistrar.stakingStatus
- Defined in packages/core/src/registrars/BaseRegistrar.ts:137

verifySignerBalance

verifySignerBalance(approval, isFeeInDWEB?): Promise<SubdomainBalanceVerificationResult>
Verify that signer has enough balance to pay for registration
Parameters
- approval: SubdomainApproval
- Optional isFeeInDWEB: boolean
Returns Promise<SubdomainBalanceVerificationResult>
- Defined in packages/core/src/registrars/SubdomainRegistrar/index.ts:142

Class SubdomainRegistrar

Example

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: RegistrarConfig

Returns SubdomainRegistrar

Properties

Readonly api

Readonly chainId

Protected Readonly contract

Readonly contractConfig

Readonly dwebToken

Readonly network

Readonly provider

Readonly signer

Optional Readonly wethToken

Accessors

isMatic

Returns boolean

readonly

Returns boolean

Methods

allowTokenUsage

Parameters

token: "DWEB" | "WETH"

Returns Promise<TransactionReceipt>

approveOndemandRegistration

Parameters

entry: OnDemandEntry | OnDemandEntry[]

isFeeInDWEB: boolean = false

owner: null | string = null

Returns Promise<ApprovedRegistration>

approveSelfRegistration

Parameters

entry: SelfRegEntry | SelfRegEntry[]

isFeeInDWEB: boolean = false

owner: null | string = null

Returns Promise<ApprovedRegistration>

calculateTotalFee

Parameters

approval: SubdomainApproval

isFeeInDWEB: boolean = false

Returns Promise<SubdomainFees>

finishRegistration

Parameters

__namedParameters: ApprovedRegistration

Returns Promise<TransactionResponse>

getRenewalServiceFee

Returns Promise<number>

getServiceFee

Returns Promise<number>

getTokenAllowance

Parameters

token: "DWEB" | "WETH"

Returns Promise<BigNumber>

getTokenBalance

Parameters

token: "DWEB" | "WETH"

Returns Promise<BigNumber>

normalizeEntries

Parameters

entry: SubdomainEntry | SubdomainEntry[]

Returns Promise<SubdomainEntry[]>

setTokenAllowance

Parameters

token: "DWEB" | "WETH"

amount: BigNumber

Returns Promise<TransactionReceipt>

stakingStatus

Parameters

domains: string[]

Returns Promise<StakingState[]>

verifySignerBalance

`Readonly` api

`Readonly` chainId

`Protected` `Readonly` contract

`Readonly` contractConfig

`Readonly` dwebToken

`Readonly` network

`Readonly` provider

`Readonly` signer

`Optional` `Readonly` wethToken

`Optional` isFeeInDWEB: boolean