Class PayTxBuilder

Implements

  • IPayTxBuilder

Constructors

Methods

  • Add Amount

    Parameters

    • amount: number | bigint

      The total amount to be sent in microAlgos.

    Returns IPayTxBuilder

  • Add Close Remainder To

    Parameters

    • close: string

      Indicates that the transaction is requesting that the Sender account should be closed.

    Returns IPayTxBuilder

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

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

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

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

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

  • Add Note

    Parameters

    • note: string

      Any data up to 1000 bytes.

    • encoding: BufferEncoding = "utf8"

    Returns IPayTxBuilder

  • Add Receiver

    Parameters

    • receiver: string

      The address of the account that receives the amount.

    Returns IPayTxBuilder

  • Add Rekey Address

    Parameters

    • rekey: string

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

    Returns IPayTxBuilder

  • Add Sender

    Parameters

    • sender: string

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

    Returns IPayTxBuilder