Interface TransactionParams

A full list of all available transaction parameters

The full documentation is available at: https://developer.algorand.org/docs/get-details/transactions/transactions/#common-fields-header-and-type

interface TransactionParams {
    appCallParams?: ApplicationCallTransactionParams;
    assetConfigParams?: AssetConfigurationTransactionParams;
    assetFreezeParams?: AssetFreezeTransactionParams;
    assetTransferParams?: AssetTransferTransactionParams;
    keyregParams?: KeyRegistrationTransactionParams;
    lease?: Uint8Array;
    note?: Uint8Array;
    paymentParams?: PaymentTransactionParams;
    rekeyTo?: string | Address;
    sender: string | Address;
    stateProofParams?: StateProofTransactionParams;
    suggestedParams: SuggestedParams;
    type: TransactionType;
}

Properties

appCallParams? assetConfigParams? assetFreezeParams? assetTransferParams? keyregParams? lease? note? paymentParams? rekeyTo? sender stateProofParams? suggestedParams type

Properties

Optional appCallParams

appCallParams?: ApplicationCallTransactionParams

Application call transaction parameters. Only set if type is TransactionType.appl

Optional assetConfigParams

assetConfigParams?: AssetConfigurationTransactionParams

Asset configuration transaction parameters. Only set if type is TransactionType.acfg

Optional assetFreezeParams

assetFreezeParams?: AssetFreezeTransactionParams

Asset freeze transaction parameters. Only set if type is TransactionType.afrz

Optional assetTransferParams

assetTransferParams?: AssetTransferTransactionParams

Asset transfer transaction parameters. Only set if type is TransactionType.axfer

Optional keyregParams

keyregParams?: KeyRegistrationTransactionParams

Key registration transaction parameters. Only set if type is TransactionType.keyreg

Optional lease

lease?: Uint8Array

Optional, 32-byte lease to associate with this transaction.

The sender cannot send another transaction with the same lease until the last round of original transaction has passed.

Optional note

note?: Uint8Array

Optional, arbitrary data to be included in the transaction's note field

Optional paymentParams

paymentParams?: PaymentTransactionParams

Payment transaction parameters. Only set if type is TransactionType.pay

Optional rekeyTo

rekeyTo?: string | Address

The Algorand address that will be used to authorize all future transactions from the sender, if provided.

sender

sender: string | Address

Algorand address of sender

Optional stateProofParams

stateProofParams?: StateProofTransactionParams

State proof transaction parameters. Only set if type is TransactionType.stpf

suggestedParams

suggestedParams: SuggestedParams

Suggested parameters relevant to the network that will accept this transaction

type

type: TransactionType

Transaction type

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc