DomainsManager | Tezos Domains

An interface that defines functions for buying and updating domains and reverse records.

Hierarchy

DomainsManager

Implemented by

Index

Methods

batch

batch(builder: (operationFactory: TezosDomainsOperationFactory<WalletTransferParams>) => Promise<WalletTransferParams[]>): Promise<WalletOperation>

- Defined in packages/manager/src/manager/domains-manager.ts:179
Execute multiple Tezos Domains operations in a batch.

Parameters
- builder: (operationFactory: TezosDomainsOperationFactory<WalletTransferParams>) => Promise<WalletTransferParams[]>
  - - (operationFactory: TezosDomainsOperationFactory<WalletTransferParams>): Promise<WalletTransferParams[]>
    - Parameters
      - operationFactory: TezosDomainsOperationFactory<WalletTransferParams>
      Returns Promise<WalletTransferParams[]>
Returns Promise<WalletOperation>

bid

bid(tld: string, request: Exact<BidRequest>, operationParams?: AdditionalOperationParams): Promise<TransactionWalletOperation>

- Defined in packages/manager/src/manager/domains-manager.ts:146
Placed a bid on the specified domain label in an auction.
- Associated contract: TLDRegistrar.Bid
- Associated endpoint: bid
Parameters
- tld: string
  
  The name of the top level domain (e.g. tez).
- request: Exact<BidRequest>
- Optional operationParams: AdditionalOperationParams
Returns Promise<TransactionWalletOperation>

buy

buy(tld: string, request: Exact<BuyRequest>, operationParams?: AdditionalOperationParams): Promise<TransactionWalletOperation>

- Defined in packages/manager/src/manager/domains-manager.ts:59
Buys the specified domain as a second phase of the Commitment scheme using FIFS model. Note that only after commit was called and a period of time that can be discovered from getCommitment has elapsed, buy can be executed.
- Associated contract: TLDRegistrar.Buy
- Associated endpoint: buy
Parameters
- tld: string
  
  The name of the top level domain (e.g. tez).
- request: Exact<BuyRequest>
- Optional operationParams: AdditionalOperationParams
Returns Promise<TransactionWalletOperation>

claimReverseRecord

claimReverseRecord(request: Exact<ReverseRecordRequest>, operationParams?: AdditionalOperationParams): Promise<TransactionWalletOperation>

- Defined in packages/manager/src/manager/domains-manager.ts:77
Either creates a reverse record for the sender address, or updates the reverse record related to the senders address (in case the sender is different from the reverse record owner).
- Associated contract: NameRegistry.ClaimReverseRecord
- Associated endpoint: claim_reverse_record
Parameters
- request: Exact<ReverseRecordRequest>
- Optional operationParams: AdditionalOperationParams
Returns Promise<TransactionWalletOperation>

commit

commit(tld: string, request: Exact<CommitmentRequest>, operationParams?: AdditionalOperationParams): Promise<TransactionWalletOperation>

- Defined in packages/manager/src/manager/domains-manager.ts:48
Creates and stores a commitment as a first phase of the Commitment scheme to buy a domain using FIFS model.
- Associated contract: TLDRegistrar.Commit
- Associated endpoint: commit
Parameters
- tld: string
  
  The name of the top level domain (e.g. tez).
- request: Exact<CommitmentRequest>
- Optional operationParams: AdditionalOperationParams
Returns Promise<TransactionWalletOperation>

getAcquisitionInfo

getAcquisitionInfo(name: string): Promise<DomainAcquisitionInfo>

- Defined in packages/manager/src/manager/domains-manager.ts:110
Gets the information about how domain can be acquired.

Possible states are:
- Unobtainable - TLD is disabled or auctions weren't launched yet
- Taken - The domain is already owned by someone
- CanBeAuctioned - An auction for this domain can be started
- AuctionInProgress - An auction for this domain is in progress (at least 1 bid has been placed)
- CanBeSettled - An auction for this domain has ended and the owner of the winning bid can claim it
- CanBeBought - This domain can be bought directly
The return value of this method also contains additional information about auction or buy/renewal where applicable.
Parameters
- name: string
  
  The name of the domain (e.g. alice.tez)
Returns Promise<DomainAcquisitionInfo>

getBidderBalance

getBidderBalance(tld: string, address: string): Promise<number>

- Defined in packages/manager/src/manager/domains-manager.ts:122
Gets so called 'bidder balance' of the specified address.

When a bid is placed in an auction and then outbid by another bid, the former bid amount is stored in the contract under it's senders address. The original bidder can then use this balance for another bid, or withdraw it by calling withdraw.

Parameters
- tld: string
  
  The name of the top level domain (e.g. tez).
- address: string
  
  The address for which to get the balance.
Returns Promise<number>

getCommitment

getCommitment(tld: string, request: Exact<CommitmentRequest>): Promise<CommitmentInfo | null>

- Defined in packages/manager/src/manager/domains-manager.ts:92
Gets the information about an existing commitment created via commit.

Parameters
- tld: string
  
  The name of the top level domain (e.g. tez).
- request: Exact<CommitmentRequest>
Returns Promise<CommitmentInfo | null>

getTldConfiguration

getTldConfiguration(tld: string): Promise<TLDConfiguration>

- Defined in packages/manager/src/manager/domains-manager.ts:129
Gets the configuration of the specified TLD registrar.

Parameters
- tld: string
  
  The name of the top level domain (e.g. tez).
Returns Promise<TLDConfiguration>

getTokenId

getTokenId(name: string): Promise<number | null>

- Defined in packages/manager/src/manager/domains-manager.ts:136
Gets the NFT token id for a specified domain name.

Parameters
- name: string
  
  The name of the domain (e.g. alice.tez)
Returns Promise<number | null>

renew

renew(tld: string, request: Exact<RenewRequest>, operationParams?: AdditionalOperationParams): Promise<TransactionWalletOperation>

- Defined in packages/manager/src/manager/domains-manager.ts:69
Renews the specified domain registration for the specified duration.
- Associated contract: TLDRegistrar.Renew
- Associated endpoint: renew
Parameters
- tld: string
  
  The name of the top level domain (e.g. tez).
- request: Exact<RenewRequest>
- Optional operationParams: AdditionalOperationParams
Returns Promise<TransactionWalletOperation>

setChildRecord

setChildRecord(request: Exact<SetChildRecordRequest>, operationParams?: AdditionalOperationParams): Promise<TransactionWalletOperation>

- Defined in packages/manager/src/manager/domains-manager.ts:30
Either creates a subdomain under an existing owned domain, or updates an existing domain if you own it's direct parent, but don't own the domain itself.
- Associated contract: NameRegistry.SetChildRecord
- Associated endpoint: set_child_record
Parameters
- request: Exact<SetChildRecordRequest>
- Optional operationParams: AdditionalOperationParams
Returns Promise<TransactionWalletOperation>

settle

settle(tld: string, request: Exact<SettleRequest>, operationParams?: AdditionalOperationParams): Promise<TransactionWalletOperation>

- Defined in packages/manager/src/manager/domains-manager.ts:156
Claims the specified domain after an auction was won.
- Associated contract: TLDRegistrar.Settle
- Associated endpoint: settle
Parameters
- tld: string
  
  The name of the top level domain (e.g. tez).
- request: Exact<SettleRequest>
- Optional operationParams: AdditionalOperationParams
Returns Promise<TransactionWalletOperation>

transfer

transfer(name: string, newOwner: string, operationParams?: AdditionalOperationParams): Promise<TransactionWalletOperation>

- Defined in packages/manager/src/manager/domains-manager.ts:176
Transfers the domain NFT token to a new owner.

Parameters
- name: string
  
  The name of the domain (e.g. alice.tez)
- newOwner: string
  
  The address to transfer the token to.
- Optional operationParams: AdditionalOperationParams
Returns Promise<TransactionWalletOperation>

updateRecord

updateRecord(request: Exact<UpdateRecordRequest>, operationParams?: AdditionalOperationParams): Promise<TransactionWalletOperation>

- Defined in packages/manager/src/manager/domains-manager.ts:38
Updates an existing owned domain.
- Associated contract: NameRegistry.UpdateRecord
- Associated endpoint: update_record
Parameters
- request: Exact<UpdateRecordRequest>
- Optional operationParams: AdditionalOperationParams
Returns Promise<TransactionWalletOperation>

updateReverseRecord

updateReverseRecord(request: Exact<UpdateReverseRecordRequest>, operationParams?: AdditionalOperationParams): Promise<TransactionWalletOperation>

- Defined in packages/manager/src/manager/domains-manager.ts:85
Updates an existing owned reverse record.
- Associated contract: NameRegistry.UpdateReverseRecord
- Associated endpoint: update_reverse_record
Parameters
- request: Exact<UpdateReverseRecordRequest>
- Optional operationParams: AdditionalOperationParams
Returns Promise<TransactionWalletOperation>

withdraw

withdraw(tld: string, recipient: string, operationParams?: AdditionalOperationParams): Promise<TransactionWalletOperation>

- Defined in packages/manager/src/manager/domains-manager.ts:168
Withdraws all funds stored in the contract under the senders balance (see getBidderBalance) and sends them to the specified recipient address.
- Associated contract: TLDRegistrar.Withdraw
- Associated endpoint: withdraw
Parameters
- tld: string
  
  The name of the top level domain (e.g. tez).
- recipient: string
  
  The address of the recipient of the withdrawn funds.
- Optional operationParams: AdditionalOperationParams
Returns Promise<TransactionWalletOperation>

Hierarchy

Implemented by

Index

Methods

Methods

batch

Parameters

builder: (operationFactory: TezosDomainsOperationFactory<WalletTransferParams>) => Promise<WalletTransferParams[]>

Parameters

operationFactory: TezosDomainsOperationFactory<WalletTransferParams>

Returns Promise<WalletTransferParams[]>

Returns Promise<WalletOperation>

bid

Parameters

tld: string

request: Exact<BidRequest>

Optional operationParams: AdditionalOperationParams

Returns Promise<TransactionWalletOperation>

buy

Parameters

tld: string

request: Exact<BuyRequest>

Optional operationParams: AdditionalOperationParams

Returns Promise<TransactionWalletOperation>

claimReverseRecord

Parameters

request: Exact<ReverseRecordRequest>

Optional operationParams: AdditionalOperationParams

Returns Promise<TransactionWalletOperation>

commit

Parameters

tld: string

request: Exact<CommitmentRequest>

Optional operationParams: AdditionalOperationParams

Returns Promise<TransactionWalletOperation>

getAcquisitionInfo

Parameters

name: string

Returns Promise<DomainAcquisitionInfo>

getBidderBalance

Parameters

tld: string

address: string

Returns Promise<number>

getCommitment

Parameters

tld: string

request: Exact<CommitmentRequest>

Returns Promise<CommitmentInfo | null>

getTldConfiguration

Parameters

tld: string

Returns Promise<TLDConfiguration>

getTokenId

Parameters

name: string

Returns Promise<number | null>

renew

Parameters

tld: string

request: Exact<RenewRequest>

Optional operationParams: AdditionalOperationParams

Returns Promise<TransactionWalletOperation>

setChildRecord

Parameters

request: Exact<SetChildRecordRequest>

Optional operationParams: AdditionalOperationParams

Returns Promise<TransactionWalletOperation>

settle

Parameters

tld: string

request: Exact<SettleRequest>

Optional operationParams: AdditionalOperationParams

Returns Promise<TransactionWalletOperation>

transfer

Parameters

name: string

newOwner: string

Optional operationParams: AdditionalOperationParams

Returns Promise<TransactionWalletOperation>