Class TxnObject

Represents a transaction and its fields.

Hierarchy

TxnObject

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new TxnObject(txnType: (txnField: TxnField) => TxnExpr, txnaType: (txnField: TxnField, index: number) => TxnaExpr): TxnObject

- Defined in src/ast/Txn.ts:183
Parameters
- txnType: (txnField: TxnField) => TxnExpr
  - - (txnField: TxnField): TxnExpr
    - Parameters
      - txnField: TxnField
      Returns TxnExpr
- txnaType: (txnField: TxnField, index: number) => TxnaExpr
  - - (txnField: TxnField, index: number): TxnaExpr
    - Parameters
      - txnField: TxnField
      - index: number
      Returns TxnaExpr
Returns TxnObject

Properties

txnType

txnType: (txnField: TxnField) => TxnExpr

Type declaration

- (txnField: TxnField): TxnExpr
- Parameters
  - txnField: TxnField
  Returns TxnExpr

txnaType

txnaType: (txnField: TxnField, index: number) => TxnaExpr

Type declaration

- (txnField: TxnField, index: number): TxnaExpr
- Parameters
  - txnField: TxnField
  - index: number
  Returns TxnaExpr

Accessors

accounts

get accounts(): TxnArray

- Defined in src/ast/Txn.ts:644
The accounts array in an ApplicationCall transaction.

Returns TxnArray

applicationArgs

get applicationArgs(): TxnArray

- Defined in src/ast/Txn.ts:635
Application call arguments array.

Returns TxnArray

applications

get applications(): TxnArray

- Defined in src/ast/Txn.ts:666
The applications array in an ApplicationCall transaction.

Requires TEAL version 3 or higher.

Returns TxnArray

assets

get assets(): TxnArray

- Defined in src/ast/Txn.ts:655
The foreign asset array in an ApplicationCall transaction.

Requires TEAL version 3 or higher.

Returns TxnArray

Methods

amount

amount(): TxnExpr

- Defined in src/ast/Txn.ts:253
Get the amount of the transaction in micro Algos.

Only set when :any:type_enum() is :any:TxnType.Payment.

For more information, see https://developer.algorand.org/docs/reference/transactions/#amount

Returns TxnExpr

applicationId

applicationId(): TxnExpr

- Defined in src/ast/Txn.ts:404
Get the application ID from the ApplicationCall portion of the current transaction.

Only set when :any:type_enum() is :any:TxnType.ApplicationCall.

Returns TxnExpr

approvalProgram

approvalProgram(): TxnExpr

- Defined in src/ast/Txn.ts:420
Get the approval program.

Only set when :any:type_enum() is :any:TxnType.ApplicationCall.

Returns TxnExpr

assetAmount

assetAmount(): TxnExpr

- Defined in src/ast/Txn.ts:351
Get the amount of the asset being transferred, measured in the asset's units.

Only set when :any:type_enum() is :any:TxnType.AssetTransfer.

For more information, see https://developer.algorand.org/docs/reference/transactions/#assetamount

Returns TxnExpr

assetCloseTo

assetCloseTo(): TxnExpr

- Defined in src/ast/Txn.ts:381
Get the closeout address of the asset transfer.

Only set when :any:type_enum() is :any:TxnType.AssetTransfer.

For more information, see https://developer.algorand.org/docs/reference/transactions/#assetcloseto

Returns TxnExpr

assetReceiver

assetReceiver(): TxnExpr

- Defined in src/ast/Txn.ts:371
Get the recipient of the asset transfer.

Only set when :any:type_enum() is :any:TxnType.AssetTransfer.

For more information, see https://developer.algorand.org/docs/reference/transactions/#assetreceiver

Returns TxnExpr

assetSender

assetSender(): TxnExpr

- Defined in src/ast/Txn.ts:361
Get the 32 byte address of the subject of clawback.

Only set when :any:type_enum() is :any:TxnType.AssetTransfer.

For more information, see https://developer.algorand.org/docs/reference/transactions/#assetsender

Returns TxnExpr

clearStateProgram

clearStateProgram(): TxnExpr

- Defined in src/ast/Txn.ts:428
Get the clear state program.

Only set when :any:type_enum() is :any:TxnType.ApplicationCall.

Returns TxnExpr

closeRemainderTo

closeRemainderTo(): TxnExpr

- Defined in src/ast/Txn.ts:263
Get the 32 byte address of the CloseRemainderTo field.

Only set when :any:type_enum() is :any:TxnType.Payment.

For more information, see https://developer.algorand.org/docs/reference/transactions/#closeremainderto

Returns TxnExpr

configAsset

configAsset(): TxnExpr

- Defined in src/ast/Txn.ts:446
Get the asset ID in asset config transaction.

Only set when :any:type_enum() is :any:TxnType.AssetConfig.

For more information, see https://developer.algorand.org/docs/reference/transactions/#configasset

Returns TxnExpr

configAssetClawback

configAssetClawback(): TxnExpr

- Defined in src/ast/Txn.ts:556
Get the 32 byte asset clawback address.

Only set when :any:type_enum() is :any:TxnType.AssetConfig.

For more information, see https://developer.algorand.org/docs/reference/transactions/#clawbackaddr

Returns TxnExpr

configAssetDecimals

configAssetDecimals(): TxnExpr

- Defined in src/ast/Txn.ts:466
Get the number of digits to display after the decimal place when displaying the asset.

Only set when :any:type_enum() is :any:TxnType.AssetConfig.

For more information, see https://developer.algorand.org/docs/reference/transactions/#decimals

Returns TxnExpr

configAssetDefaultFrozen

configAssetDefaultFrozen(): TxnExpr

- Defined in src/ast/Txn.ts:476
Check if the asset's slots are frozen by default or not.

Only set when :any:type_enum() is :any:TxnType.AssetConfig.

For more information, see https://developer.algorand.org/docs/reference/transactions/#defaultfrozen

Returns TxnExpr

configAssetFreeze

configAssetFreeze(): TxnExpr

- Defined in src/ast/Txn.ts:546
Get the 32 byte asset freeze address.

Only set when :any:type_enum() is :any:TxnType.AssetConfig.

For more information, see https://developer.algorand.org/docs/reference/transactions/#freezeaddr

Returns TxnExpr

configAssetManager

configAssetManager(): TxnExpr

- Defined in src/ast/Txn.ts:526
Get the 32 byte asset manager address.

Only set when :any:type_enum() is :any:TxnType.AssetConfig.

For more information, see https://developer.algorand.org/docs/reference/transactions/#manageraddr

Returns TxnExpr

configAssetMetadataHash

configAssetMetadataHash(): TxnExpr

- Defined in src/ast/Txn.ts:516
Get the 32 byte commitment to some unspecified asset metdata.

Only set when :any:type_enum() is :any:TxnType.AssetConfig.

For more information, see https://developer.algorand.org/docs/reference/transactions/#metadatahash

Returns TxnExpr

configAssetName

configAssetName(): TxnExpr

- Defined in src/ast/Txn.ts:496
Get the asset name.

Only set when :any:type_enum() is :any:TxnType.AssetConfig.

For more information, see https://developer.algorand.org/docs/reference/transactions/#assetname

Returns TxnExpr

configAssetReserve

configAssetReserve(): TxnExpr

- Defined in src/ast/Txn.ts:536
Get the 32 byte asset reserve address.

Only set when :any:type_enum() is :any:TxnType.AssetConfig.

For more information, see https://developer.algorand.org/docs/reference/transactions/#reserveaddr

Returns TxnExpr

configAssetTotal

configAssetTotal(): TxnExpr

- Defined in src/ast/Txn.ts:456
Get the total number of units of this asset created.

Only set when :any:type_enum() is :any:TxnType.AssetConfig.

For more information, see https://developer.algorand.org/docs/reference/transactions/#total

Returns TxnExpr

configAssetUnitName

configAssetUnitName(): TxnExpr

- Defined in src/ast/Txn.ts:486
Get the unit name of the asset.

Only set when :any:type_enum() is :any:TxnType.AssetConfig.

For more information, see https://developer.algorand.org/docs/reference/transactions/#unitname

Returns TxnExpr

configAssetUrl

configAssetUrl(): TxnExpr

- Defined in src/ast/Txn.ts:506
Get the asset URL.

Only set when :any:type_enum() is :any:TxnType.AssetConfig.

For more information, see https://developer.algorand.org/docs/reference/transactions/#url

Returns TxnExpr

fee

fee(): TxnExpr

- Defined in src/ast/Txn.ts:201
Get the transaction fee in micro Algos.

For more information, see https://developer.algorand.org/docs/reference/transactions/#fee

Returns TxnExpr

firstValid

firstValid(): TxnExpr

- Defined in src/ast/Txn.ts:209
Get the first valid round number.

For more information, see https://developer.algorand.org/docs/reference/transactions/#firstvalid

Returns TxnExpr

freezeAsset

freezeAsset(): TxnExpr

- Defined in src/ast/Txn.ts:566
Get the asset ID being frozen or un-frozen.

Only set when :any:type_enum() is :any:TxnType.AssetFreeze.

For more information, see https://developer.algorand.org/docs/reference/transactions/#freezeasset

Returns TxnExpr

freezeAssetAccount

freezeAssetAccount(): TxnExpr

- Defined in src/ast/Txn.ts:576
Get the 32 byte address of the account whose asset slot is being frozen or un-frozen.

Only set when :any:type_enum() is :any:TxnType.AssetFreeze.

For more information, see https://developer.algorand.org/docs/reference/transactions/#freezeaccount

Returns TxnExpr

freezeAssetFrozen

freezeAssetFrozen(): TxnExpr

- Defined in src/ast/Txn.ts:586
Get the new frozen value for the asset.

Only set when :any:type_enum() is :any:TxnType.AssetFreeze.

For more information, see https://developer.algorand.org/docs/reference/transactions/#assetfrozen

Returns TxnExpr

globalNumByteSlices

globalNumByteSlices(): TxnExpr

- Defined in src/ast/Txn.ts:606
Get the schema count of global state byte slices in an application creation call.

Only set when :any:type_enum() is :any:TxnType.ApplicationCall and this is an app creation call.

Requires TEAL version 3 or higher.

Returns TxnExpr

globalNumUints

globalNumUints(): TxnExpr

- Defined in src/ast/Txn.ts:596
Get the schema count of global state integers in an application creation call.

Only set when :any:type_enum() is :any:TxnType.ApplicationCall and this is an app creation call.

Requires TEAL version 3 or higher.

Returns TxnExpr

groupIndex

groupIndex(): TxnExpr

- Defined in src/ast/Txn.ts:391
Get the position of the transaction within the atomic transaction group.

A stand-alone transaction is implictly element 0 in a group of 1.

For more information, see https://developer.algorand.org/docs/reference/transactions/#group

Returns TxnExpr

lastValid

lastValid(): TxnExpr

- Defined in src/ast/Txn.ts:217
Get the last valid round number.

For more information, see https://developer.algorand.org/docs/reference/transactions/#lastvalid

Returns TxnExpr

lease

lease(): TxnExpr

- Defined in src/ast/Txn.ts:233
Get the transaction lease.

For more information, see https://developer.algorand.org/docs/reference/transactions/#lease

Returns TxnExpr

localNumByteSlices

localNumByteSlices(): TxnExpr

- Defined in src/ast/Txn.ts:626
Get the schema count of local state byte slices in an application creation call.

Only set when :any:type_enum() is :any:TxnType.ApplicationCall and this is an app creation call.

Requires TEAL version 3 or higher.

Returns TxnExpr

localNumUints

localNumUints(): TxnExpr

- Defined in src/ast/Txn.ts:616
Get the schema count of local state integers in an application creation call.

Only set when :any:type_enum() is :any:TxnType.ApplicationCall and this is an app creation call.

Requires TEAL version 3 or higher.

Returns TxnExpr

note

note(): TxnExpr

- Defined in src/ast/Txn.ts:225
Get the transaction note.

For more information, see https://developer.algorand.org/docs/reference/transactions/#note

Returns TxnExpr

onCompletion

onCompletion(): TxnExpr

- Defined in src/ast/Txn.ts:412
Get the on completion action from the ApplicationCall portion of the transaction.

Only set when :any:type_enum() is :any:TxnType.ApplicationCall.

Returns TxnExpr

receiver

receiver(): TxnExpr

- Defined in src/ast/Txn.ts:243
Get the 32 byte address of the receiver.

Only set when :any:type_enum() is :any:TxnType.Payment.

For more information, see https://developer.algorand.org/docs/reference/transactions/#receiver

Returns TxnExpr

rekeyTo

rekeyTo(): TxnExpr

- Defined in src/ast/Txn.ts:436
Get the sender's new 32 byte AuthAddr.

For more information, see https://developer.algorand.org/docs/reference/transactions/#rekeyto

Returns TxnExpr

selectionPk

selectionPk(): TxnExpr

- Defined in src/ast/Txn.ts:283
Get the VRF public key.

Only set when :any:type_enum() is :any:TxnType.KeyRegistration.

For more information, see https://developer.algorand.org/docs/reference/transactions/#selectionpk

Returns TxnExpr

sender

sender(): TxnExpr

- Defined in src/ast/Txn.ts:193
Get the 32 byte address of the sender.

For more information, see https://developer.algorand.org/docs/reference/transactions/#sender

Returns TxnExpr

txId

txId(): TxnExpr

- Defined in src/ast/Txn.ts:396
Get the 32 byte computed ID for the transaction.

Returns TxnExpr

type

type(): TxnExpr

- Defined in src/ast/Txn.ts:323
Get the type of this transaction as a byte string.

In most cases it is preferable to use :any:type_enum() instead.

For more information, see https://developer.algorand.org/docs/reference/transactions/#type

Returns TxnExpr

typeEnum

typeEnum(): TxnExpr

- Defined in src/ast/Txn.ts:331
Get the type of this transaction.

See :any:TxnType for possible values.

Returns TxnExpr

voteFirst

voteFirst(): TxnExpr

- Defined in src/ast/Txn.ts:293
Get the first round that the participation key is valid.

Only set when :any:type_enum() is :any:TxnType.KeyRegistration.

For more information, see https://developer.algorand.org/docs/reference/transactions/#votefirst

Returns TxnExpr

voteKeyDilution

voteKeyDilution(): TxnExpr

- Defined in src/ast/Txn.ts:313
Get the dilution for the 2-level participation key.

Only set when :any:type_enum() is :any:TxnType.KeyRegistration.

For more information, see https://developer.algorand.org/docs/reference/transactions/#votekeydilution

Returns TxnExpr

voteLast

voteLast(): TxnExpr

- Defined in src/ast/Txn.ts:303
Get the last round that the participation key is valid.

Only set when :any:type_enum() is :any:TxnType.KeyRegistration.

For more information, see https://developer.algorand.org/docs/reference/transactions/#votelast

Returns TxnExpr

votePk

votePk(): TxnExpr

- Defined in src/ast/Txn.ts:273
Get the root participation public key.

Only set when :any:type_enum() is :any:TxnType.KeyRegistration.

For more information, see https://developer.algorand.org/docs/reference/transactions/#votepk

Returns TxnExpr

xferAsset

xferAsset(): TxnExpr

- Defined in src/ast/Txn.ts:341
Get the ID of the asset being transferred.

Only set when :any:type_enum() is :any:TxnType.AssetTransfer.

For more information, see https://developer.algorand.org/docs/reference/transactions/#xferasset

Returns TxnExpr

Generated using TypeDoc