Class Name

constructor

• new Name(
      value: `${string}.chain`,
      options: { onAccount: AccountBase; onNode: Node } & Omit<
          NameRevokeOptions & NameUpdateOptions & NameTransferOptions & NamePreclaimOptions & NameClaimOptions,
          "version",
      >,
  ): Name

  Parameters

  • value: `${string}.chain`

    AENS name
  • options: { onAccount: AccountBase; onNode: Node } & Omit<
        NameRevokeOptions & NameUpdateOptions & NameTransferOptions & NamePreclaimOptions & NameClaimOptions,
        "version",
    >

    Options

    • onAccount: AccountBase

      Account to use

    • onNode: Node

      Node to use

    • onNode

      Node to use

    • onAccount

      Account to use

  Returns Name

options

Readonlyvalue

id

• get id(): `nm_${string}`

  Name ID encoded as nm_-prefixed string

  Returns `nm_${string}`

bid

• bid(
      nameFee: string | number | BigNumber,
      options?: Omit<NameClaimOptions, "nameFee">,
  ): Promise<SendTransactionReturnType>

  Bid to name auction

  Parameters

  • nameFee: string | number | BigNumber

    Name fee (bid fee)
  • options: Omit<NameClaimOptions, "nameFee"> = {}

    Options

  Returns Promise<SendTransactionReturnType>

  mined transaction details

  Example

  const bidFee = computeBidFee(name.value, { startFee, increment: 0.42 })
  await name.bid(213109412839123, { ttl, fee, nonce })
  Copy

claim

• claim(options?: NameClaimOptions): Promise<SendTransactionReturnType>

  Claim a name.

  Since the Ceres protocol upgrade, it is possible to claim a name without preclaiming it. If you preclaim, wait for at least 1 key block to be mined before exposing a name in the NameClaimTx to ensure that nobody can front-run the claim.

  Parameters

  • options: NameClaimOptions = {}

    options

  Returns Promise<SendTransactionReturnType>

  mined transaction details

  Example

  await name.claim({ ttl, fee, nonce, nameFee })
  Copy

extendTtl

• extendTtl(
      nameTtl?: number,
      options?: Omit<undefined | NameUpdateOptions, "nameTtl" | "extendPointers">,
  ): Promise<SendTransactionReturnType>

  Parameters

  • OptionalnameTtl: number

    represents in number of blocks (max and default is 180000)
  • options: Omit<undefined | NameUpdateOptions, "nameTtl" | "extendPointers"> = {}

    Options

  Returns Promise<SendTransactionReturnType>

  mined transaction details

getAuctionState

• getAuctionState(
      options?: { onNode?: Node },
  ): Promise<
      AuctionEntry & { highestBidder: `ak_${string}`; id: `nm_${string}` },
  >

  Query the AENS auction info from the node and return the object with info

  Parameters

  • options: { onNode?: Node } = {}

    Options

  Returns Promise<AuctionEntry & { highestBidder: `ak_${string}`; id: `nm_${string}` }>

  Example

  const auctionEntry = await name.getAuctionState()
  console.log(auctionEntry.highestBidder)
  Copy

getState

• getState(
      options?: { onNode?: Node },
  ): Promise<NameEntry & { id: `nm_${string}`; owner: `ak_${string}` }>

  Query the AENS name info from the node and return the object with info

  Parameters

  • options: { onNode?: Node } = {}

    Options

  Returns Promise<NameEntry & { id: `nm_${string}`; owner: `ak_${string}` }>

  Example

  const nameEntry = await name.getState()
  console.log(nameEntry.owner)
  Copy

preclaim

• preclaim(
      options?: NamePreclaimOptions,
  ): Promise<SendTransactionReturnType & { nameSalt: number }>

  Preclaim a name. This sends a commitment hash (derived from the name and a random salt) to the node. Preclaiming was required to claim a name before the Ceres protocol upgrade. After the upgrade, preclaiming is optional but still available for added security if you want to claim a non-auction name.

  Parameters

  • options: NamePreclaimOptions = {}

    Options

  Returns Promise<SendTransactionReturnType & { nameSalt: number }>

  Example

  await name.preclaim({ ttl, fee, nonce })
  Copy

revoke

• revoke(options?: NameRevokeOptions): Promise<SendTransactionReturnType>

  Revoke a name

  Parameters

  • options: NameRevokeOptions = {}

    Options

  Returns Promise<SendTransactionReturnType>

  mined transaction details

  Example

  await name.revoke({ fee, ttl, nonce })
  Copy

transfer

• transfer(
      address: `ak_${string}`,
      options?: NameTransferOptions,
  ): Promise<SendTransactionReturnType>

  Transfer a name to another account

  Parameters

  • address: `ak_${string}`

    Recipient account public key
  • options: NameTransferOptions = {}

    Options

  Returns Promise<SendTransactionReturnType>

  mined transaction details

  Example

  await name.transfer('ak_asd23dasdas...', { ttl, fee, nonce })
  Copy

update

• update(
      pointers: KeyPointers,
      options?: NameUpdateOptions,
  ): Promise<SendTransactionReturnType>

  Update a name

  Parameters

  • pointers: KeyPointers

    Map of pointer keys to corresponding addresses
  • options: NameUpdateOptions = {}

    Options

  Returns Promise<SendTransactionReturnType>

  Example

  const name = 'test.chain'
  const channel = 'ch_2519mBs...'
  const pointers = {
    account_pubkey: 'ak_asd23dasdas...,',
    contract_pubkey: 'ct_asdf34fasdasd...',
    [getDefaultPointerKey(channel)]: channel,
  }
  await name.update(pointers, { nameTtl, ttl, fee, nonce, clientTtl })
  Copy