Class AssetConfigTxBuilder

This is used to create, configure and destroy an asset depending on which fields are set.

See

AlgorandTransactionCrafter

Example

// Builder
const tx = new AssetConfigTxBuilder("GENESIS_ID", "GENESIS_HASH")
         .addAssetId(1234)
         .get()

Implements

  • IAssetConfigTxBuilder

Constructors

constructor

Methods

addAssetId addAssetParams addFee addFirstValidRound addGroup addLastValidRound addLease addNote addRekey addSender get

Constructors

constructor

Methods

addAssetId

  • addAssetId(caid): IAssetConfigTxBuilder

  • Add Asset ID

    Parameters

    • caid: number | bigint

      For re-configure or destroy transactions, this is the unique asset ID. On asset creation, the ID is set to zero.

    Returns IAssetConfigTxBuilder

    Remarks

    required, except on create

addAssetParams

  • addAssetParams(params): IAssetConfigTxBuilder

  • Add Asset Parameters

    Parameters

    Returns IAssetConfigTxBuilder

    Remarks

    required, except on destroy

addFee

  • addFee(fee): IAssetConfigTxBuilder

  • Add Fee

    Parameters

    • fee: number | bigint

      Paid by the sender to the FeeSink to prevent denial-of-service. The minimum fee on Algorand is currently 1000 microAlgos.

    Returns IAssetConfigTxBuilder

addFirstValidRound

  • addFirstValidRound(fv): IAssetConfigTxBuilder

  • Add First Valid Round

    Parameters

    • fv: number | bigint

      The first round for when the transaction is valid. If the transaction is sent prior to this round it will be rejected by the network.

    Returns IAssetConfigTxBuilder

addGroup

  • addGroup(grp): IAssetConfigTxBuilder

  • Add Group

    Parameters

    • grp: Uint8Array

      The group specifies that the transaction is part of a group and, if so, specifies the hash of the transaction group.

    Returns IAssetConfigTxBuilder

addLastValidRound

  • addLastValidRound(lv): IAssetConfigTxBuilder

  • Add Last Valid Round

    Parameters

    • lv: number | bigint

      The ending round for which the transaction is valid. After this round, the transaction will be rejected by the network.

    Returns IAssetConfigTxBuilder

addLease

  • addLease(lx): IAssetConfigTxBuilder

  • Add Lease

    Parameters

    • lx: Uint8Array

      A lease enforces mutual exclusion of transactions. If this field is nonzero, then once the transaction is confirmed, it acquires the lease identified by the (Sender, Lease) pair of the transaction until the LastValid round passes.

    Returns IAssetConfigTxBuilder

addNote

  • addNote(note, encoding?): IAssetConfigTxBuilder

  • Add Note

    Parameters

    • note: string

      Any data up to 1000 bytes.

    • encoding: BufferEncoding = "utf8"

    Returns IAssetConfigTxBuilder

addRekey

  • addRekey(rekey): IAssetConfigTxBuilder

  • Add Rekey Address

    Parameters

    • rekey: string

      Specifies the authorized address. This address will be used to authorize all future transactions.

    Returns IAssetConfigTxBuilder

addSender

  • addSender(sender): IAssetConfigTxBuilder

  • Add Sender

    Parameters

    • sender: string

      The address of the account that pays the fee and amount.

    Returns IAssetConfigTxBuilder

get

Settings

Member Visibility

On This Page

Constructors
Methods