Interface DomainsManager

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

interface DomainsManager {
    batch(
        builder: (
            operationFactory: TezosDomainsOperationFactory<WalletTransferParams>,
        ) => Promise<WalletTransferParams[]>,
    ): Promise<WalletOperation>;
    bid(
        tld: string,
        request: Exact<BidRequest>,
        operationParams?: AdditionalOperationParams,
    ): Promise<TransactionWalletOperation>;
    buy(
        tld: string,
        request: Exact<BuyRequest | AffiliateBuyRequest>,
        operationParams?: AdditionalOperationParams,
    ): Promise<TransactionWalletOperation>;
    claimReverseRecord(
        request: Exact<ReverseRecordRequest>,
        operationParams?: AdditionalOperationParams,
    ): Promise<TransactionWalletOperation>;
    commit(
        tld: string,
        request: Exact<CommitmentRequest>,
        operationParams?: AdditionalOperationParams,
    ): Promise<TransactionWalletOperation>;
    getAcquisitionInfo(name: string): Promise<DomainAcquisitionInfo>;
    getBidderBalance(tld: string, address: string): Promise<number>;
    getCommitment(
        tld: string,
        request: Exact<CommitmentRequest>,
    ): Promise<null | CommitmentInfo>;
    getTldConfiguration(tld: string): Promise<TLDConfiguration>;
    getTokenId(name: string): Promise<null | number>;
    renew(
        tld: string,
        request: Exact<RenewRequest | AffiliateRenewRequest>,
        operationParams?: AdditionalOperationParams,
    ): Promise<TransactionWalletOperation>;
    setChildRecord(
        request: Exact<SetChildRecordRequest>,
        operationParams?: AdditionalOperationParams,
    ): Promise<TransactionWalletOperation>;
    settle(
        tld: string,
        request: Exact<SettleRequest>,
        operationParams?: AdditionalOperationParams,
    ): Promise<TransactionWalletOperation>;
    transfer(
        name: string,
        newOwner: string,
        operationParams?: AdditionalOperationParams,
    ): Promise<TransactionWalletOperation>;
    updateRecord(
        request: Exact<UpdateRecordRequest>,
        operationParams?: AdditionalOperationParams,
    ): Promise<TransactionWalletOperation>;
    updateReverseRecord(
        request: Exact<UpdateReverseRecordRequest>,
        operationParams?: AdditionalOperationParams,
    ): Promise<TransactionWalletOperation>;
    withdraw(
        tld: string,
        recipient: string,
        operationParams?: AdditionalOperationParams,
    ): Promise<TransactionWalletOperation>;
}

Implemented by

Methods

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

Methods

batch

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

  • Execute multiple Tezos Domains operations in a batch.

    Parameters

    Returns Promise<WalletOperation>

bid

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

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

    Parameters

    • tld: string

      The name of the top level domain (e.g. tez).

    • request: Exact<BidRequest>
    • OptionaloperationParams: AdditionalOperationParams

    Returns Promise<TransactionWalletOperation>

buy

  • buy(
        tld: string,
        request: Exact<BuyRequest | AffiliateBuyRequest>,
        operationParams?: AdditionalOperationParams,
    ): 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.

    Parameters

    • tld: string

      The name of the top level domain (e.g. tez).

    • request: Exact<BuyRequest | AffiliateBuyRequest>
    • OptionaloperationParams: AdditionalOperationParams

    Returns Promise<TransactionWalletOperation>

claimReverseRecord

  • claimReverseRecord(
        request: Exact<ReverseRecordRequest>,
        operationParams?: AdditionalOperationParams,
    ): 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).

    Parameters

    Returns Promise<TransactionWalletOperation>

commit

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

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

    Parameters

    • tld: string

      The name of the top level domain (e.g. tez).

    • request: Exact<CommitmentRequest>
    • OptionaloperationParams: AdditionalOperationParams

    Returns Promise<TransactionWalletOperation>

getAcquisitionInfo

  • getAcquisitionInfo(name: string): 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.

    Parameters

    • name: string

      The name of the domain (e.g. alice.tez)

    Returns Promise<DomainAcquisitionInfo>

getBidderBalance

  • getBidderBalance(tld: string, address: string): 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]].

    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<null | CommitmentInfo>

  • 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<null | CommitmentInfo>

getTldConfiguration

  • getTldConfiguration(tld: string): Promise<TLDConfiguration>

  • 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<null | number>

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

    Parameters

    • name: string

      The name of the domain (e.g. alice.tez)

    Returns Promise<null | number>

renew

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

  • Renews the specified domain registration for the specified duration.

    Parameters

    • tld: string

      The name of the top level domain (e.g. tez).

    • request: Exact<RenewRequest | AffiliateRenewRequest>
    • OptionaloperationParams: AdditionalOperationParams

    Returns Promise<TransactionWalletOperation>

setChildRecord

  • setChildRecord(
        request: Exact<SetChildRecordRequest>,
        operationParams?: AdditionalOperationParams,
    ): 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.

    Parameters

    Returns Promise<TransactionWalletOperation>

settle

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

  • Claims the specified domain after an auction was won.

    Parameters

    • tld: string

      The name of the top level domain (e.g. tez).

    • request: Exact<SettleRequest>
    • OptionaloperationParams: AdditionalOperationParams

    Returns Promise<TransactionWalletOperation>

transfer

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

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

    • OptionaloperationParams: AdditionalOperationParams

    Returns Promise<TransactionWalletOperation>

updateRecord

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

  • Updates an existing owned domain.

    Parameters

    Returns Promise<TransactionWalletOperation>

updateReverseRecord

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

  • Updates an existing owned reverse record.

    Parameters

    Returns Promise<TransactionWalletOperation>

withdraw

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

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

    Parameters

    • tld: string

      The name of the top level domain (e.g. tez).

    • recipient: string

      The address of the recipient of the withdrawn funds.

    • OptionaloperationParams: AdditionalOperationParams

    Returns Promise<TransactionWalletOperation>

Settings

Member Visibility

On This Page

Methods