Skip to content

AnyTransactionComposeFields

Algorand TypeScript


Algorand TypeScript / index / AnyTransactionComposeFields

Defined in: itxn-compose.ts:26

optional accounts: readonly (Account | bytes)[]

Defined in: itxn.ts:951

Accounts listed in the ApplicationCall transaction

Index of the account to get

ApplicationCallFields.accounts


optional amount: uint64

Defined in: itxn.ts:621

microalgos

PaymentFields.amount


optional appArgs: readonly unknown[]

Defined in: itxn.ts:946

Arguments passed to the application in the ApplicationCall transaction

Index of the arg to get

ApplicationCallFields.appArgs


optional appId: uint64 | Application

Defined in: itxn.ts:907

ApplicationID from ApplicationCall transaction

ApplicationCallFields.appId


optional approvalProgram: bytes | readonly bytes[]

Defined in: itxn.ts:936

All approval program pages

Index of the page to get

ApplicationCallFields.approvalProgram


optional apps: readonly (uint64 | Application)[]

Defined in: itxn.ts:961

Foreign Apps listed in the ApplicationCall transaction

Index of the application to get

ApplicationCallFields.apps


optional assetAmount: uint64

Defined in: itxn.ts:811

value in Asset’s units

AssetTransferFields.assetAmount


optional assetCloseTo: Account | bytes

Defined in: itxn.ts:823

32 byte address

AssetTransferFields.assetCloseTo


optional assetName: string | bytes

Defined in: itxn.ts:745

The asset name

AssetConfigFields.assetName


optional assetReceiver: Account | bytes

Defined in: itxn.ts:819

32 byte address

AssetTransferFields.assetReceiver


optional assets: readonly (uint64 | Asset)[]

Defined in: itxn.ts:956

Foreign Assets listed in the ApplicationCall transaction

Index of the asset to get

ApplicationCallFields.assets


optional assetSender: Account | bytes

Defined in: itxn.ts:815

32 byte address. Source of assets if Sender is the Asset’s Clawback address.

AssetTransferFields.assetSender


optional clawback: Account | bytes

Defined in: itxn.ts:769

32 byte address

AssetConfigFields.clawback


optional clearStateProgram: bytes | readonly bytes[]

Defined in: itxn.ts:941

All clear state program pages

Index of the page to get

ApplicationCallFields.clearStateProgram


optional closeRemainderTo: Account | bytes

Defined in: itxn.ts:625

32 byte address

PaymentFields.closeRemainderTo


optional configAsset: uint64 | Asset

Defined in: itxn.ts:725

Asset ID in asset config transaction

AssetConfigFields.configAsset


optional decimals: uint64

Defined in: itxn.ts:733

Number of digits to display after the decimal place when displaying the asset

AssetConfigFields.decimals


optional defaultFrozen: boolean

Defined in: itxn.ts:737

Whether the asset’s slots are frozen by default or not, 0 or 1

AssetConfigFields.defaultFrozen


optional extraProgramPages: uint64

Defined in: itxn.ts:931

Number of additional pages for each of the application’s approval and clear state program

ApplicationCallFields.extraProgramPages


optional fee: uint64

Defined in: itxn.ts:589

microalgos

ApplicationCallFields.fee


optional firstValid: uint64

Defined in: itxn.ts:593

round number

ApplicationCallFields.firstValid


optional firstValidTime: uint64

Defined in: itxn.ts:597

UNIX timestamp of block before txn.FirstValid. Fails if negative

ApplicationCallFields.firstValidTime


optional freeze: Account | bytes

Defined in: itxn.ts:765

32 byte address

AssetConfigFields.freeze


optional freezeAccount: Account | bytes

Defined in: itxn.ts:865

32 byte address of the account whose asset slot is being frozen or un-frozen

AssetFreezeFields.freezeAccount


optional freezeAsset: uint64 | Asset

Defined in: itxn.ts:861

Asset ID being frozen or un-frozen

AssetFreezeFields.freezeAsset


optional frozen: boolean

Defined in: itxn.ts:869

The new frozen value

AssetFreezeFields.frozen


optional globalNumBytes: uint64

Defined in: itxn.ts:919

Number of global state byteslices this application makes use of.

ApplicationCallFields.globalNumBytes


optional globalNumUint: uint64

Defined in: itxn.ts:915

Number of global state integers this application makes use of.

ApplicationCallFields.globalNumUint


optional lastValid: uint64

Defined in: itxn.ts:601

round number

ApplicationCallFields.lastValid


optional lease: bytes<32>

Defined in: itxn.ts:609

32 byte lease value

ApplicationCallFields.lease


optional localNumBytes: uint64

Defined in: itxn.ts:927

Number of local state byteslices this application makes use of.

ApplicationCallFields.localNumBytes


optional localNumUint: uint64

Defined in: itxn.ts:923

Number of local state integers this application makes use of.

ApplicationCallFields.localNumUint


optional manager: Account | bytes

Defined in: itxn.ts:757

32 byte address

AssetConfigFields.manager


optional metadataHash: bytes<32>

Defined in: itxn.ts:753

32 byte commitment to unspecified asset metadata

AssetConfigFields.metadataHash


optional nonparticipation: boolean

Defined in: itxn.ts:683

Marks an account nonparticipating for rewards

KeyRegistrationFields.nonparticipation


optional note: string | bytes

Defined in: itxn.ts:605

Any data up to 1024 bytes

ApplicationCallFields.note


optional onCompletion: OnCompleteAction

Defined in: itxn.ts:911

ApplicationCall transaction on completion action

ApplicationCallFields.onCompletion


optional receiver: Account | bytes

Defined in: itxn.ts:617

32 byte address

PaymentFields.receiver


optional rejectVersion: uint64

Defined in: itxn.ts:965

Application version for which the txn must reject

ApplicationCallFields.rejectVersion


optional rekeyTo: Account | bytes

Defined in: itxn.ts:613

32 byte Sender’s new AuthAddr

ApplicationCallFields.rekeyTo


optional reserve: Account | bytes

Defined in: itxn.ts:761

32 byte address

AssetConfigFields.reserve


optional selectionKey: bytes<32>

Defined in: itxn.ts:667

32 byte address

KeyRegistrationFields.selectionKey


optional sender: Account | bytes

Defined in: itxn.ts:585

32 byte address

ApplicationCallFields.sender


optional stateProofKey: bytes<64>

Defined in: itxn.ts:687

64 byte state proof public key

KeyRegistrationFields.stateProofKey


optional total: uint64

Defined in: itxn.ts:729

Total number of units of this asset created

AssetConfigFields.total


type: TransactionType

Defined in: itxn-compose.ts:33


optional unitName: string | bytes

Defined in: itxn.ts:741

Unit name of the asset

AssetConfigFields.unitName


optional url: string | bytes

Defined in: itxn.ts:749

URL

AssetConfigFields.url


optional voteFirst: uint64

Defined in: itxn.ts:671

The first round that the participation key is valid.

KeyRegistrationFields.voteFirst


optional voteKey: bytes<32>

Defined in: itxn.ts:663

32 byte address

KeyRegistrationFields.voteKey


optional voteKeyDilution: uint64

Defined in: itxn.ts:679

Dilution for the 2-level participation key

KeyRegistrationFields.voteKeyDilution


optional voteLast: uint64

Defined in: itxn.ts:675

The last round that the participation key is valid.

KeyRegistrationFields.voteLast


optional xferAsset: uint64 | Asset

Defined in: itxn.ts:807

Asset ID

AssetTransferFields.xferAsset