Class UnsupportedDomainsManager

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

Implements

Constructors

constructor

Methods

affiliateBuy affiliateRenew batch bid buy claimReverseRecord commit getAcquisitionInfo getBidderBalance getCommitment getTldConfiguration getTokenId renew setChildRecord settle transfer updateRecord updateReverseRecord withdraw

Constructors

constructor

Methods

affiliateBuy

  • affiliateBuy(): Promise<TransactionWalletOperation>

  • Returns Promise<TransactionWalletOperation>

affiliateRenew

  • affiliateRenew(): Promise<TransactionWalletOperation>

  • Returns Promise<TransactionWalletOperation>

batch

  • batch(): Promise<WalletOperation>

  • Execute multiple Tezos Domains operations in a batch.

    Returns Promise<WalletOperation>

bid

  • bid(): Promise<TransactionWalletOperation>

  • Placed a bid on the specified domain label in an auction.

    Returns Promise<TransactionWalletOperation>

buy

  • buy(): Promise<TransactionWalletOperation>

  • 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.

    Returns Promise<TransactionWalletOperation>

claimReverseRecord

  • claimReverseRecord(): Promise<TransactionWalletOperation>

  • 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).

    Returns Promise<TransactionWalletOperation>

commit

  • commit(): Promise<TransactionWalletOperation>

  • Creates and stores a commitment as a first phase of the Commitment scheme to buy a domain using FIFS model.

    Returns Promise<TransactionWalletOperation>

getAcquisitionInfo

  • getAcquisitionInfo(): Promise<DomainAcquisitionInfo>

  • 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.

    Returns Promise<DomainAcquisitionInfo>

getBidderBalance

  • getBidderBalance(): Promise<number>

  • 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]].

    Returns Promise<number>

getCommitment

getTldConfiguration

  • getTldConfiguration(): Promise<TLDConfiguration>

  • Gets the configuration of the specified TLD registrar.

    Returns Promise<TLDConfiguration>

getTokenId

  • getTokenId(): Promise<null | number>

  • Gets the NFT token id for a specified domain name.

    Returns Promise<null | number>

renew

  • renew(): Promise<TransactionWalletOperation>

  • Renews the specified domain registration for the specified duration.

    Returns Promise<TransactionWalletOperation>

setChildRecord

  • setChildRecord(): Promise<TransactionWalletOperation>

  • 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.

    Returns Promise<TransactionWalletOperation>

settle

  • settle(): Promise<TransactionWalletOperation>

  • Claims the specified domain after an auction was won.

    Returns Promise<TransactionWalletOperation>

transfer

  • transfer(): Promise<TransactionWalletOperation>

  • Transfers the domain NFT token to a new owner.

    Returns Promise<TransactionWalletOperation>

updateRecord

  • updateRecord(): Promise<TransactionWalletOperation>

  • Updates an existing owned domain.

    Returns Promise<TransactionWalletOperation>

updateReverseRecord

withdraw

  • withdraw(): Promise<TransactionWalletOperation>

  • Withdraws all funds stored in the contract under the senders balance (see [[getBidderBalance]]) and sends them to the specified recipient address.

    Returns Promise<TransactionWalletOperation>

Settings

Member Visibility

On This Page

Constructors
Methods