algopy.itxn

Module Contents

Classes

Name	Description
PaymentInnerTransaction	Payment inner transaction
KeyRegistrationInnerTransaction	Key Registration inner transaction
AssetConfigInnerTransaction	Asset Config inner transaction
AssetTransferInnerTransaction	Asset Transfer inner transaction
AssetFreezeInnerTransaction	Asset Freeze inner transaction
ApplicationCallInnerTransaction	Application Call inner transaction
InnerTransactionResult	An inner transaction of any type
InnerTransaction	Creates a set of fields used to submit an inner transaction of any type
Payment	Creates a set of fields used to submit a Payment inner transaction
KeyRegistration	Creates a set of fields used to submit a Key Registration inner transaction
AssetConfig	Creates a set of fields used to submit an Asset Config inner transaction
AssetTransfer	Creates a set of fields used to submit an Asset Transfer inner transaction
AssetFreeze	Creates a set of fields used to submit a Asset Freeze inner transaction
ApplicationCall	Creates a set of fields used to submit an Application Call inner transaction
ABIApplicationCallInnerTransaction	Application Call inner transaction
ABIApplicationCall

Functions

Name	Description
submit_txns	Submits a group of up to 16 inner transactions parameters
submit_staged	Submits all staged inner transactions

Data

Name	Description

API

class PaymentInnerTransaction

Payment inner transaction

property PaymentInnerTransaction.receiver : Account

32 byte address

property PaymentInnerTransaction.amount : UInt64

microalgos

property PaymentInnerTransaction.close_remainder_to : Account

32 byte address

property PaymentInnerTransaction.sender : Account

32 byte address

property PaymentInnerTransaction.fee : UInt64

microalgos

property PaymentInnerTransaction.first_valid : UInt64

round number

property PaymentInnerTransaction.first_valid_time : UInt64

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

property PaymentInnerTransaction.last_valid : UInt64

round number

property PaymentInnerTransaction.note : Bytes

Any data up to 1024 bytes

property PaymentInnerTransaction.lease : Bytes

32 byte lease value

property PaymentInnerTransaction.type_bytes : Bytes

Transaction type as bytes

property PaymentInnerTransaction.type : TransactionType

Transaction type as integer

property PaymentInnerTransaction.group_index : UInt64

Position of this transaction within an atomic transaction group. A stand-alone transaction is implicitly element 0 in a group of 1

property PaymentInnerTransaction.txn_id : Bytes

The computed ID for this transaction. 32 bytes.

property PaymentInnerTransaction.rekey_to : Account

32 byte Sender’s new AuthAddr

class KeyRegistrationInnerTransaction

Key Registration inner transaction

property KeyRegistrationInnerTransaction.vote_key : Bytes

32 byte address

property KeyRegistrationInnerTransaction.selection_key : Bytes

32 byte address

property KeyRegistrationInnerTransaction.vote_first : UInt64

The first round that the participation key is valid.

property KeyRegistrationInnerTransaction.vote_last : UInt64

The last round that the participation key is valid.

property KeyRegistrationInnerTransaction.vote_key_dilution : UInt64

Dilution for the 2-level participation key

property KeyRegistrationInnerTransaction.non_participation : bool

Marks an account nonparticipating for rewards

property KeyRegistrationInnerTransaction.state_proof_key : Bytes

64 byte state proof public key

property KeyRegistrationInnerTransaction.sender : Account

32 byte address

property KeyRegistrationInnerTransaction.fee : UInt64

microalgos

property KeyRegistrationInnerTransaction.first_valid : UInt64

round number

property KeyRegistrationInnerTransaction.first_valid_time : UInt64

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

property KeyRegistrationInnerTransaction.last_valid : UInt64

round number

property KeyRegistrationInnerTransaction.note : Bytes

Any data up to 1024 bytes

property KeyRegistrationInnerTransaction.lease : Bytes

32 byte lease value

property KeyRegistrationInnerTransaction.type_bytes : Bytes

Transaction type as bytes

property KeyRegistrationInnerTransaction.type : TransactionType

Transaction type as integer

property KeyRegistrationInnerTransaction.group_index : UInt64

Position of this transaction within an atomic transaction group. A stand-alone transaction is implicitly element 0 in a group of 1

property KeyRegistrationInnerTransaction.txn_id : Bytes

The computed ID for this transaction. 32 bytes.

property KeyRegistrationInnerTransaction.rekey_to : Account

32 byte Sender’s new AuthAddr

class AssetConfigInnerTransaction

Asset Config inner transaction

property AssetConfigInnerTransaction.config_asset : Asset

Asset ID in asset config transaction

property AssetConfigInnerTransaction.total : UInt64

Total number of units of this asset created

property AssetConfigInnerTransaction.decimals : UInt64

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

property AssetConfigInnerTransaction.default_frozen : bool

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

property AssetConfigInnerTransaction.unit_name : Bytes

Unit name of the asset

property AssetConfigInnerTransaction.asset_name : Bytes

The asset name

property AssetConfigInnerTransaction.url : Bytes

URL

property AssetConfigInnerTransaction.metadata_hash : Bytes

32 byte commitment to unspecified asset metadata

property AssetConfigInnerTransaction.manager : Account

32 byte address

property AssetConfigInnerTransaction.reserve : Account

32 byte address

property AssetConfigInnerTransaction.freeze : Account

32 byte address

property AssetConfigInnerTransaction.clawback : Account

32 byte address

property AssetConfigInnerTransaction.created_asset : Asset

Asset ID allocated by the creation of an ASA

property AssetConfigInnerTransaction.sender : Account

32 byte address

property AssetConfigInnerTransaction.fee : UInt64

microalgos

property AssetConfigInnerTransaction.first_valid : UInt64

round number

property AssetConfigInnerTransaction.first_valid_time : UInt64

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

property AssetConfigInnerTransaction.last_valid : UInt64

round number

property AssetConfigInnerTransaction.note : Bytes

Any data up to 1024 bytes

property AssetConfigInnerTransaction.lease : Bytes

32 byte lease value

property AssetConfigInnerTransaction.type_bytes : Bytes

Transaction type as bytes

property AssetConfigInnerTransaction.type : TransactionType

Transaction type as integer

property AssetConfigInnerTransaction.group_index : UInt64

Position of this transaction within an atomic transaction group. A stand-alone transaction is implicitly element 0 in a group of 1

property AssetConfigInnerTransaction.txn_id : Bytes

The computed ID for this transaction. 32 bytes.

property AssetConfigInnerTransaction.rekey_to : Account

32 byte Sender’s new AuthAddr

class AssetTransferInnerTransaction

Asset Transfer inner transaction

property AssetTransferInnerTransaction.xfer_asset : Asset

Asset ID

property AssetTransferInnerTransaction.asset_amount : UInt64

value in Asset’s units

property AssetTransferInnerTransaction.asset_sender : Account

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

property AssetTransferInnerTransaction.asset_receiver : Account

32 byte address

property AssetTransferInnerTransaction.asset_close_to : Account

32 byte address

property AssetTransferInnerTransaction.sender : Account

32 byte address

property AssetTransferInnerTransaction.fee : UInt64

microalgos

property AssetTransferInnerTransaction.first_valid : UInt64

round number

property AssetTransferInnerTransaction.first_valid_time : UInt64

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

property AssetTransferInnerTransaction.last_valid : UInt64

round number

property AssetTransferInnerTransaction.note : Bytes

Any data up to 1024 bytes

property AssetTransferInnerTransaction.lease : Bytes

32 byte lease value

property AssetTransferInnerTransaction.type_bytes : Bytes

Transaction type as bytes

property AssetTransferInnerTransaction.type : TransactionType

Transaction type as integer

property AssetTransferInnerTransaction.group_index : UInt64

Position of this transaction within an atomic transaction group. A stand-alone transaction is implicitly element 0 in a group of 1

property AssetTransferInnerTransaction.txn_id : Bytes

The computed ID for this transaction. 32 bytes.

property AssetTransferInnerTransaction.rekey_to : Account

32 byte Sender’s new AuthAddr

class AssetFreezeInnerTransaction

Asset Freeze inner transaction

property AssetFreezeInnerTransaction.freeze_asset : Asset

Asset ID being frozen or un-frozen

property AssetFreezeInnerTransaction.freeze_account : Account

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

property AssetFreezeInnerTransaction.frozen : bool

The new frozen value, 0 or 1

property AssetFreezeInnerTransaction.sender : Account

32 byte address

property AssetFreezeInnerTransaction.fee : UInt64

microalgos

property AssetFreezeInnerTransaction.first_valid : UInt64

round number

property AssetFreezeInnerTransaction.first_valid_time : UInt64

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

property AssetFreezeInnerTransaction.last_valid : UInt64

round number

property AssetFreezeInnerTransaction.note : Bytes

Any data up to 1024 bytes

property AssetFreezeInnerTransaction.lease : Bytes

32 byte lease value

property AssetFreezeInnerTransaction.type_bytes : Bytes

Transaction type as bytes

property AssetFreezeInnerTransaction.type : TransactionType

Transaction type as integer

property AssetFreezeInnerTransaction.group_index : UInt64

Position of this transaction within an atomic transaction group. A stand-alone transaction is implicitly element 0 in a group of 1

property AssetFreezeInnerTransaction.txn_id : Bytes

The computed ID for this transaction. 32 bytes.

property AssetFreezeInnerTransaction.rekey_to : Account

32 byte Sender’s new AuthAddr

class ApplicationCallInnerTransaction

Application Call inner transaction

property ApplicationCallInnerTransaction.app_id : Application

ApplicationID from ApplicationCall transaction

property ApplicationCallInnerTransaction.on_completion : OnCompleteAction

ApplicationCall transaction on completion action

property ApplicationCallInnerTransaction.num_app_args : UInt64

Number of ApplicationArgs

property ApplicationCallInnerTransaction.num_accounts : UInt64

Number of ApplicationArgs

property ApplicationCallInnerTransaction.approval_program : Bytes

Approval program

property ApplicationCallInnerTransaction.clear_state_program : Bytes

Clear State program

property ApplicationCallInnerTransaction.num_assets : UInt64

Number of Assets

property ApplicationCallInnerTransaction.num_apps : UInt64

Number of Applications

property ApplicationCallInnerTransaction.global_num_uint : UInt64

Number of global state integers in ApplicationCall

property ApplicationCallInnerTransaction.global_num_bytes : UInt64

Number of global state byteslices in ApplicationCall

property ApplicationCallInnerTransaction.local_num_uint : UInt64

Number of local state integers in ApplicationCall

property ApplicationCallInnerTransaction.local_num_bytes : UInt64

Number of local state byteslices in ApplicationCall

property ApplicationCallInnerTransaction.extra_program_pages : UInt64

Number of additional pages for each of the application’s approval and clear state programs. An ExtraProgramPages of 1 means 2048 more total bytes, or 1024 for each program.

property ApplicationCallInnerTransaction.last_log : Bytes

The last message emitted. Empty bytes if none were emitted. Application mode only

ApplicationCallInnerTransaction.logs

ApplicationCallInnerTransaction.logs(index: UInt64 | int) → Bytes

Log messages emitted by an application call

property ApplicationCallInnerTransaction.num_logs : UInt64

Number of logs

property ApplicationCallInnerTransaction.created_app : Application

ApplicationID allocated by the creation of an application

property ApplicationCallInnerTransaction.num_approval_program_pages : UInt64

Number of Approval Program pages

property ApplicationCallInnerTransaction.num_clear_state_program_pages : UInt64

Number of Clear State Program pages

ApplicationCallInnerTransaction.app_args

ApplicationCallInnerTransaction.app_args(index: UInt64 | int, /) → Bytes

Arguments passed to the application in the ApplicationCall transaction

ApplicationCallInnerTransaction.accounts

ApplicationCallInnerTransaction.accounts(index: UInt64 | int, /) → Account

Accounts listed in the ApplicationCall transaction

ApplicationCallInnerTransaction.assets

ApplicationCallInnerTransaction.assets(index: UInt64 | int, /) → Asset

Foreign Assets listed in the ApplicationCall transaction

ApplicationCallInnerTransaction.apps

ApplicationCallInnerTransaction.apps(index: UInt64 | int, /) → Application

Foreign Apps listed in the ApplicationCall transaction

ApplicationCallInnerTransaction.approval_program_pages

ApplicationCallInnerTransaction.approval_program_pages(index: UInt64 | int, /) → Bytes

Approval Program as an array of pages

ApplicationCallInnerTransaction.clear_state_program_pages

ApplicationCallInnerTransaction.clear_state_program_pages(index: UInt64 | int, /) → Bytes

Clear State Program as an array of pages

property ApplicationCallInnerTransaction.reject_version : UInt64

Application version for which the txn must reject

property ApplicationCallInnerTransaction.sender : Account

32 byte address

property ApplicationCallInnerTransaction.fee : UInt64

microalgos

property ApplicationCallInnerTransaction.first_valid : UInt64

round number

property ApplicationCallInnerTransaction.first_valid_time : UInt64

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

property ApplicationCallInnerTransaction.last_valid : UInt64

round number

property ApplicationCallInnerTransaction.note : Bytes

Any data up to 1024 bytes

property ApplicationCallInnerTransaction.lease : Bytes

32 byte lease value

property ApplicationCallInnerTransaction.type_bytes : Bytes

Transaction type as bytes

property ApplicationCallInnerTransaction.type : TransactionType

Transaction type as integer

property ApplicationCallInnerTransaction.group_index : UInt64

Position of this transaction within an atomic transaction group. A stand-alone transaction is implicitly element 0 in a group of 1

property ApplicationCallInnerTransaction.txn_id : Bytes

The computed ID for this transaction. 32 bytes.

property ApplicationCallInnerTransaction.rekey_to : Account

32 byte Sender’s new AuthAddr

class InnerTransactionResult

Bases: algopy.itxn.PaymentInnerTransaction, algopy.itxn.KeyRegistrationInnerTransaction, algopy.itxn.AssetConfigInnerTransaction, algopy.itxn.AssetTransferInnerTransaction, algopy.itxn.AssetFreezeInnerTransaction, algopy.itxn.ApplicationCallInnerTransaction

An inner transaction of any type

property InnerTransactionResult.sender : Account

32 byte address

property InnerTransactionResult.fee : UInt64

microalgos

property InnerTransactionResult.first_valid : UInt64

round number

property InnerTransactionResult.first_valid_time : UInt64

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

property InnerTransactionResult.last_valid : UInt64

round number

property InnerTransactionResult.note : Bytes

Any data up to 1024 bytes

property InnerTransactionResult.lease : Bytes

32 byte lease value

property InnerTransactionResult.type_bytes : Bytes

Transaction type as bytes

property InnerTransactionResult.type : TransactionType

Transaction type as integer

property InnerTransactionResult.group_index : UInt64

Position of this transaction within an atomic transaction group. A stand-alone transaction is implicitly element 0 in a group of 1

property InnerTransactionResult.txn_id : Bytes

The computed ID for this transaction. 32 bytes.

property InnerTransactionResult.rekey_to : Account

32 byte Sender’s new AuthAddr

property InnerTransactionResult.receiver : Account

32 byte address

property InnerTransactionResult.amount : UInt64

microalgos

property InnerTransactionResult.close_remainder_to : Account

32 byte address

property InnerTransactionResult.vote_key : Bytes

32 byte address

property InnerTransactionResult.selection_key : Bytes

32 byte address

property InnerTransactionResult.vote_first : UInt64

The first round that the participation key is valid.

property InnerTransactionResult.vote_last : UInt64

The last round that the participation key is valid.

property InnerTransactionResult.vote_key_dilution : UInt64

Dilution for the 2-level participation key

property InnerTransactionResult.non_participation : bool

Marks an account nonparticipating for rewards

property InnerTransactionResult.state_proof_key : Bytes

64 byte state proof public key

property InnerTransactionResult.config_asset : Asset

Asset ID in asset config transaction

property InnerTransactionResult.total : UInt64

Total number of units of this asset created

property InnerTransactionResult.decimals : UInt64

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

property InnerTransactionResult.default_frozen : bool

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

property InnerTransactionResult.unit_name : Bytes

Unit name of the asset

property InnerTransactionResult.asset_name : Bytes

The asset name

property InnerTransactionResult.url : Bytes

URL

property InnerTransactionResult.metadata_hash : Bytes

32 byte commitment to unspecified asset metadata

property InnerTransactionResult.manager : Account

32 byte address

property InnerTransactionResult.reserve : Account

32 byte address

property InnerTransactionResult.freeze : Account

32 byte address

property InnerTransactionResult.clawback : Account

32 byte address

property InnerTransactionResult.created_asset : Asset

Asset ID allocated by the creation of an ASA

property InnerTransactionResult.xfer_asset : Asset

Asset ID

property InnerTransactionResult.asset_amount : UInt64

value in Asset’s units

property InnerTransactionResult.asset_sender : Account

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

property InnerTransactionResult.asset_receiver : Account

32 byte address

property InnerTransactionResult.asset_close_to : Account

32 byte address

property InnerTransactionResult.freeze_asset : Asset

Asset ID being frozen or un-frozen

property InnerTransactionResult.freeze_account : Account

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

property InnerTransactionResult.frozen : bool

The new frozen value, 0 or 1

property InnerTransactionResult.app_id : Application

ApplicationID from ApplicationCall transaction

property InnerTransactionResult.on_completion : OnCompleteAction

ApplicationCall transaction on completion action

property InnerTransactionResult.num_app_args : UInt64

Number of ApplicationArgs

property InnerTransactionResult.num_accounts : UInt64

Number of ApplicationArgs

property InnerTransactionResult.approval_program : Bytes

Approval program

property InnerTransactionResult.clear_state_program : Bytes

Clear State program

property InnerTransactionResult.num_assets : UInt64

Number of Assets

property InnerTransactionResult.num_apps : UInt64

Number of Applications

property InnerTransactionResult.global_num_uint : UInt64

Number of global state integers in ApplicationCall

property InnerTransactionResult.global_num_bytes : UInt64

Number of global state byteslices in ApplicationCall

property InnerTransactionResult.local_num_uint : UInt64

Number of local state integers in ApplicationCall

property InnerTransactionResult.local_num_bytes : UInt64

Number of local state byteslices in ApplicationCall

property InnerTransactionResult.extra_program_pages : UInt64

Number of additional pages for each of the application’s approval and clear state programs. An ExtraProgramPages of 1 means 2048 more total bytes, or 1024 for each program.

property InnerTransactionResult.last_log : Bytes

The last message emitted. Empty bytes if none were emitted. Application mode only

InnerTransactionResult.logs

InnerTransactionResult.logs(index: UInt64 | int) → Bytes

Log messages emitted by an application call

property InnerTransactionResult.num_logs : UInt64

Number of logs

property InnerTransactionResult.created_app : Application

ApplicationID allocated by the creation of an application

property InnerTransactionResult.num_approval_program_pages : UInt64

Number of Approval Program pages

property InnerTransactionResult.num_clear_state_program_pages : UInt64

Number of Clear State Program pages

InnerTransactionResult.app_args

InnerTransactionResult.app_args(index: UInt64 | int, /) → Bytes

Arguments passed to the application in the ApplicationCall transaction

InnerTransactionResult.accounts

InnerTransactionResult.accounts(index: UInt64 | int, /) → Account

Accounts listed in the ApplicationCall transaction

InnerTransactionResult.assets

InnerTransactionResult.assets(index: UInt64 | int, /) → Asset

Foreign Assets listed in the ApplicationCall transaction

InnerTransactionResult.apps

InnerTransactionResult.apps(index: UInt64 | int, /) → Application

Foreign Apps listed in the ApplicationCall transaction

InnerTransactionResult.approval_program_pages

InnerTransactionResult.approval_program_pages(index: UInt64 | int, /) → Bytes

Approval Program as an array of pages

InnerTransactionResult.clear_state_program_pages

InnerTransactionResult.clear_state_program_pages(index: UInt64 | int, /) → Bytes

Clear State Program as an array of pages

property InnerTransactionResult.reject_version : UInt64

Application version for which the txn must reject

class InnerTransaction

InnerTransaction(*, type: TransactionType, receiver: Account | str = …, amount: UInt64 | int = …, close_remainder_to: Account | str = …, vote_key: Bytes | bytes = …, selection_key: Bytes | bytes = …, vote_first: UInt64 | int = …, vote_last: UInt64 | int = …, vote_key_dilution: UInt64 | int = …, non_participation: bool = …, state_proof_key: Bytes | bytes = …, config_asset: Asset | UInt64 | int = …, total: UInt64 | int = …, unit_name: String | Bytes | str | bytes = …, asset_name: String | Bytes | str | bytes = …, decimals: UInt64 | int = …, default_frozen: bool = …, url: String | Bytes | bytes | str = …, metadata_hash: Bytes | bytes = …, manager: Account | str = …, reserve: Account | str = …, freeze: Account | str = …, clawback: Account | str = …, xfer_asset: Asset | UInt64 | int = …, asset_amount: UInt64 | int = …, asset_sender: Account | str = …, asset_receiver: Account | str = …, asset_close_to: Account | str = …, freeze_asset: Asset | UInt64 | int = …, freeze_account: Account | str = …, frozen: bool = …, app_id: Application | UInt64 | int = …, approval_program: Bytes | bytes | tuple[Bytes, …] = …, clear_state_program: Bytes | bytes | tuple[Bytes, …] = …, on_completion: OnCompleteAction | UInt64 | int = …, global_num_uint: UInt64 | int = …, global_num_bytes: UInt64 | int = …, local_num_uint: UInt64 | int = …, local_num_bytes: UInt64 | int = …, extra_program_pages: UInt64 | int = …, app_args: tuple[object, …] = …, accounts: tuple[Account, …] = …, assets: tuple[Asset, …] = …, apps: tuple[Application, …] = …, reject_version: UInt64 | int = …, sender: Account | str = …, fee: UInt64 | int = 0, note: String | Bytes | str | bytes = …, rekey_to: Account | str = …)

Bases: algopy.itxn._InnerTransaction[algopy.itxn.InnerTransactionResult]

Creates a set of fields used to submit an inner transaction of any type

InnerTransaction.set

InnerTransaction.set(*, type: TransactionType = …, receiver: Account | str = …, amount: UInt64 | int = …, close_remainder_to: Account | str = …, vote_key: Bytes | bytes = …, selection_key: Bytes | bytes = …, vote_first: UInt64 | int = …, vote_last: UInt64 | int = …, vote_key_dilution: UInt64 | int = …, non_participation: bool = …, state_proof_key: Bytes | bytes = …, config_asset: Asset | UInt64 | int = …, total: UInt64 | int = …, unit_name: String | Bytes | str | bytes = …, asset_name: String | Bytes | str | bytes = …, decimals: UInt64 | int = …, default_frozen: bool = …, url: String | Bytes | bytes | str = …, metadata_hash: Bytes | bytes = …, manager: Account | str = …, reserve: Account | str = …, freeze: Account | str = …, clawback: Account | str = …, xfer_asset: Asset | UInt64 | int = …, asset_amount: UInt64 | int = …, asset_sender: Account | str = …, asset_receiver: Account | str = …, asset_close_to: Account | str = …, freeze_asset: Asset | UInt64 | int = …, freeze_account: Account | str = …, frozen: bool = …, app_id: Application | UInt64 | int = …, approval_program: Bytes | bytes | tuple[Bytes, …] = …, clear_state_program: Bytes | bytes | tuple[Bytes, …] = …, on_completion: OnCompleteAction | UInt64 | int = …, global_num_uint: UInt64 | int = …, global_num_bytes: UInt64 | int = …, local_num_uint: UInt64 | int = …, local_num_bytes: UInt64 | int = …, extra_program_pages: UInt64 | int = …, app_args: tuple[object, …] = …, accounts: tuple[Account, …] = …, assets: tuple[Asset, …] = …, apps: tuple[Application, …] = …, reject_version: UInt64 | int = …, sender: Account | str = …, fee: UInt64 | int = 0, note: String | Bytes | str | bytes = …, rekey_to: Account | str = …) → None

Updates inner transaction parameter values

InnerTransaction.stage

InnerTransaction.stage(*, begin_group: bool = False) → None

Stages inner transaction parameters for submission

• Parameters:
  • begin_group – If True, begins a new inner transaction group with this transaction as the first transaction in the group
• Note:
  • use algopy.itxn.submit_staged to submit all staged inner transaction parameters

InnerTransaction.submit

InnerTransaction.submit() → _TResult_co

Submits inner transaction parameters and returns the resulting inner transaction

InnerTransaction.copy

InnerTransaction.copy() → Self

Copies a set of inner transaction parameters

class Payment

Payment(*, receiver: Account | str, amount: UInt64 | int = …, close_remainder_to: Account | str = …, sender: Account | str = …, fee: UInt64 | int = 0, note: String | Bytes | str | bytes = …, rekey_to: Account | str = …)

Bases: algopy.itxn._InnerTransaction[algopy.itxn.PaymentInnerTransaction]

Creates a set of fields used to submit a Payment inner transaction

Payment.set

Payment.set(*, receiver: Account | str = …, amount: UInt64 | int = …, close_remainder_to: Account | str = …, sender: Account | str = …, fee: UInt64 | int = 0, note: String | Bytes | str | bytes = …, rekey_to: Account | str = …) → None

Updates inner transaction parameter values

Payment.stage

Payment.stage(*, begin_group: bool = False) → None

Stages inner transaction parameters for submission

• Parameters:
  • begin_group – If True, begins a new inner transaction group with this transaction as the first transaction in the group
• Note:
  • use algopy.itxn.submit_staged to submit all staged inner transaction parameters

Payment.submit

Payment.submit() → _TResult_co

Submits inner transaction parameters and returns the resulting inner transaction

Payment.copy

Payment.copy() → Self

Copies a set of inner transaction parameters

class KeyRegistration

KeyRegistration(*, vote_key: Bytes | bytes = …, selection_key: Bytes | bytes = …, vote_first: UInt64 | int = …, vote_last: UInt64 | int = …, vote_key_dilution: UInt64 | int = …, non_participation: bool = …, state_proof_key: Bytes | bytes = …, sender: Account | str = …, fee: UInt64 | int = 0, note: String | Bytes | str | bytes = …, rekey_to: Account | str = …)

Bases: algopy.itxn._InnerTransaction[algopy.itxn.KeyRegistrationInnerTransaction]

Creates a set of fields used to submit a Key Registration inner transaction

KeyRegistration.set

KeyRegistration.set(*, vote_key: Bytes | bytes = …, selection_key: Bytes | bytes = …, vote_first: UInt64 | int = …, vote_last: UInt64 | int = …, vote_key_dilution: UInt64 | int = …, non_participation: bool = …, state_proof_key: Bytes | bytes = …, sender: Account | str = …, fee: UInt64 | int = 0, note: String | Bytes | str | bytes = …, rekey_to: Account | str = …) → None

Updates inner transaction parameter values

KeyRegistration.stage

KeyRegistration.stage(*, begin_group: bool = False) → None

Stages inner transaction parameters for submission

• Parameters:
  • begin_group – If True, begins a new inner transaction group with this transaction as the first transaction in the group
• Note:
  • use algopy.itxn.submit_staged to submit all staged inner transaction parameters

KeyRegistration.submit

KeyRegistration.submit() → _TResult_co

Submits inner transaction parameters and returns the resulting inner transaction

KeyRegistration.copy

KeyRegistration.copy() → Self

Copies a set of inner transaction parameters

class AssetConfig

AssetConfig(*, config_asset: Asset | UInt64 | int = …, total: UInt64 | int = …, unit_name: String | Bytes | str | bytes = …, asset_name: String | Bytes | str | bytes = …, decimals: UInt64 | int = …, default_frozen: bool = …, url: String | Bytes | str | bytes = …, metadata_hash: Bytes | bytes = …, manager: Account | str = …, reserve: Account | str = …, freeze: Account | str = …, clawback: Account | str = …, sender: Account | str = …, fee: UInt64 | int = 0, note: String | Bytes | str | bytes = …, rekey_to: Account | str = …)

Bases: algopy.itxn._InnerTransaction[algopy.itxn.AssetConfigInnerTransaction]

Creates a set of fields used to submit an Asset Config inner transaction

AssetConfig.set

AssetConfig.set(*, config_asset: Asset | UInt64 | int = …, total: UInt64 | int = …, unit_name: String | Bytes | str | bytes = …, asset_name: String | Bytes | str | bytes = …, decimals: UInt64 | int = …, default_frozen: bool = …, url: String | Bytes | str | bytes = …, metadata_hash: Bytes | bytes = …, manager: Account | str = …, reserve: Account | str = …, freeze: Account | str = …, clawback: Account | str = …, sender: Account | str = …, fee: UInt64 | int = 0, note: String | Bytes | str | bytes = …, rekey_to: Account | str = …) → None

Updates inner transaction parameter values

AssetConfig.stage

AssetConfig.stage(*, begin_group: bool = False) → None

Stages inner transaction parameters for submission

• Parameters:
  • begin_group – If True, begins a new inner transaction group with this transaction as the first transaction in the group
• Note:
  • use algopy.itxn.submit_staged to submit all staged inner transaction parameters

AssetConfig.submit

AssetConfig.submit() → _TResult_co

Submits inner transaction parameters and returns the resulting inner transaction

AssetConfig.copy

AssetConfig.copy() → Self

Copies a set of inner transaction parameters

class AssetTransfer

AssetTransfer(*, xfer_asset: Asset | UInt64 | int, asset_receiver: Account | str, asset_amount: UInt64 | int = …, asset_sender: Account | str = …, asset_close_to: Account | str = …, sender: Account | str = …, fee: UInt64 | int = 0, note: String | Bytes | str | bytes = …, rekey_to: Account | str = …)

Bases: algopy.itxn._InnerTransaction[algopy.itxn.AssetTransferInnerTransaction]

Creates a set of fields used to submit an Asset Transfer inner transaction

AssetTransfer.set

AssetTransfer.set(*, xfer_asset: Asset | UInt64 | int = …, asset_amount: UInt64 | int = …, asset_sender: Account | str = …, asset_receiver: Account | str = …, asset_close_to: Account | str = …, sender: Account | str = …, fee: UInt64 | int = 0, note: String | Bytes | str | bytes = …, rekey_to: Account | str = …) → None

Updates transaction parameter values

AssetTransfer.stage

AssetTransfer.stage(*, begin_group: bool = False) → None

Stages inner transaction parameters for submission

• Parameters:
  • begin_group – If True, begins a new inner transaction group with this transaction as the first transaction in the group
• Note:
  • use algopy.itxn.submit_staged to submit all staged inner transaction parameters

AssetTransfer.submit

AssetTransfer.submit() → _TResult_co

Submits inner transaction parameters and returns the resulting inner transaction

AssetTransfer.copy

AssetTransfer.copy() → Self

Copies a set of inner transaction parameters

class AssetFreeze

AssetFreeze(*, freeze_asset: Asset | UInt64 | int, freeze_account: Account | str, frozen: bool, sender: Account | str = …, fee: UInt64 | int = 0, note: String | Bytes | str | bytes = …, rekey_to: Account | str = …)

Bases: algopy.itxn._InnerTransaction[algopy.itxn.AssetFreezeInnerTransaction]

Creates a set of fields used to submit a Asset Freeze inner transaction

AssetFreeze.set

AssetFreeze.set(*, freeze_asset: Asset | UInt64 | int = …, freeze_account: Account | str = …, frozen: bool = …, sender: Account | str = …, fee: UInt64 | int = 0, note: String | Bytes | str | bytes = …, rekey_to: Account | str = …) → None

Updates inner transaction parameter values

AssetFreeze.stage

AssetFreeze.stage(*, begin_group: bool = False) → None

Stages inner transaction parameters for submission

• Parameters:
  • begin_group – If True, begins a new inner transaction group with this transaction as the first transaction in the group
• Note:
  • use algopy.itxn.submit_staged to submit all staged inner transaction parameters

AssetFreeze.submit

AssetFreeze.submit() → _TResult_co

Submits inner transaction parameters and returns the resulting inner transaction

AssetFreeze.copy

AssetFreeze.copy() → Self

Copies a set of inner transaction parameters

class ApplicationCall

ApplicationCall(*, app_id: Application | UInt64 | int = …, approval_program: Bytes | bytes | tuple[Bytes, …] = …, clear_state_program: Bytes | bytes | tuple[Bytes, …] = …, on_completion: OnCompleteAction | UInt64 | int = …, global_num_uint: UInt64 | int = …, global_num_bytes: UInt64 | int = …, local_num_uint: UInt64 | int = …, local_num_bytes: UInt64 | int = …, extra_program_pages: UInt64 | int = …, app_args: tuple[object, …] = …, accounts: tuple[Account, …] = …, assets: tuple[Asset, …] = …, apps: tuple[Application, …] = …, reject_version: UInt64 | int = …, sender: Account | str = …, fee: UInt64 | int = 0, note: String | Bytes | str | bytes = …, rekey_to: Account | str = …)

Bases: algopy.itxn._InnerTransaction[algopy.itxn.ApplicationCallInnerTransaction]

Creates a set of fields used to submit an Application Call inner transaction

ApplicationCall.set

ApplicationCall.set(*, app_id: Application | UInt64 | int = …, approval_program: Bytes | bytes | tuple[Bytes, …] = …, clear_state_program: Bytes | bytes | tuple[Bytes, …] = …, on_completion: OnCompleteAction | UInt64 | int = …, global_num_uint: UInt64 | int = …, global_num_bytes: UInt64 | int = …, local_num_uint: UInt64 | int = …, local_num_bytes: UInt64 | int = …, extra_program_pages: UInt64 | int = …, app_args: tuple[object, …] = …, accounts: tuple[Account, …] = …, assets: tuple[Asset, …] = …, apps: tuple[Application, …] = …, reject_version: UInt64 | int = …, sender: Account | str = …, fee: UInt64 | int = 0, note: String | Bytes | str | bytes = …, rekey_to: Account | str = …) → None

Updates inner transaction parameter values

ApplicationCall.stage

ApplicationCall.stage(*, begin_group: bool = False) → None

Stages inner transaction parameters for submission

• Parameters:
  • begin_group – If True, begins a new inner transaction group with this transaction as the first transaction in the group
• Note:
  • use algopy.itxn.submit_staged to submit all staged inner transaction parameters

ApplicationCall.submit

ApplicationCall.submit() → _TResult_co

Submits inner transaction parameters and returns the resulting inner transaction

ApplicationCall.copy

ApplicationCall.copy() → Self

Copies a set of inner transaction parameters

submit_txns

submit_txns(_t1: _InnerTransaction[_T1], _t2: _InnerTransaction[_T2], _t3: _InnerTransaction[_T3], _t4: _InnerTransaction[_T4], _t5: _InnerTransaction[_T5], _t6: _InnerTransaction[_T6], _t7: _InnerTransaction[_T7], _t8: _InnerTransaction[_T8], _t9: _InnerTransaction[_T9], _t10: _InnerTransaction[_T10], _t11: _InnerTransaction[_T11], _t12: _InnerTransaction[_T12], _t13: _InnerTransaction[_T13], _t14: _InnerTransaction[_T14], _t15: _InnerTransaction[_T15], _t16: _InnerTransaction[_T16], /) → tuple[algopy.itxn._T1, _T2, _T3, _T4, _T5, _T6, _T7, _T8, _T9, _T10, _T11, _T12, _T13, _T14, _T15, _T16]

Submits a group of up to 16 inner transactions parameters

• Returns: A tuple of the resulting inner transactions

submit_staged

submit_staged() → None

Submits all staged inner transactions

• Note: op.GITxn.last_log(n) (and other methods on the GITxn object) can be used to read fields from the most recently submitted

transaction group where n is a compile time constant representing the index of the transaction in the group.

class ABIApplicationCallInnerTransaction

Bases: algopy.itxn.ApplicationCallInnerTransaction

Application Call inner transaction

property ABIApplicationCallInnerTransaction.result : T

property ABIApplicationCallInnerTransaction.app_id : Application

ApplicationID from ApplicationCall transaction

property ABIApplicationCallInnerTransaction.on_completion : OnCompleteAction

ApplicationCall transaction on completion action

property ABIApplicationCallInnerTransaction.num_app_args : UInt64

Number of ApplicationArgs

property ABIApplicationCallInnerTransaction.num_accounts : UInt64

Number of ApplicationArgs

property ABIApplicationCallInnerTransaction.approval_program : Bytes

Approval program

property ABIApplicationCallInnerTransaction.clear_state_program : Bytes

Clear State program

property ABIApplicationCallInnerTransaction.num_assets : UInt64

Number of Assets

property ABIApplicationCallInnerTransaction.num_apps : UInt64

Number of Applications

property ABIApplicationCallInnerTransaction.global_num_uint : UInt64

Number of global state integers in ApplicationCall

property ABIApplicationCallInnerTransaction.global_num_bytes : UInt64

Number of global state byteslices in ApplicationCall

property ABIApplicationCallInnerTransaction.local_num_uint : UInt64

Number of local state integers in ApplicationCall

property ABIApplicationCallInnerTransaction.local_num_bytes : UInt64

Number of local state byteslices in ApplicationCall

property ABIApplicationCallInnerTransaction.extra_program_pages : UInt64

Number of additional pages for each of the application’s approval and clear state programs. An ExtraProgramPages of 1 means 2048 more total bytes, or 1024 for each program.

property ABIApplicationCallInnerTransaction.last_log : Bytes

The last message emitted. Empty bytes if none were emitted. Application mode only

ABIApplicationCallInnerTransaction.logs

ABIApplicationCallInnerTransaction.logs(index: UInt64 | int) → Bytes

Log messages emitted by an application call

property ABIApplicationCallInnerTransaction.num_logs : UInt64

Number of logs

property ABIApplicationCallInnerTransaction.created_app : Application

ApplicationID allocated by the creation of an application

property ABIApplicationCallInnerTransaction.num_approval_program_pages : UInt64

Number of Approval Program pages

property ABIApplicationCallInnerTransaction.num_clear_state_program_pages : UInt64

Number of Clear State Program pages

ABIApplicationCallInnerTransaction.app_args

ABIApplicationCallInnerTransaction.app_args(index: UInt64 | int, /) → Bytes

Arguments passed to the application in the ApplicationCall transaction

ABIApplicationCallInnerTransaction.accounts

ABIApplicationCallInnerTransaction.accounts(index: UInt64 | int, /) → Account

Accounts listed in the ApplicationCall transaction

ABIApplicationCallInnerTransaction.assets

ABIApplicationCallInnerTransaction.assets(index: UInt64 | int, /) → Asset

Foreign Assets listed in the ApplicationCall transaction

ABIApplicationCallInnerTransaction.apps

ABIApplicationCallInnerTransaction.apps(index: UInt64 | int, /) → Application

Foreign Apps listed in the ApplicationCall transaction

ABIApplicationCallInnerTransaction.approval_program_pages

ABIApplicationCallInnerTransaction.approval_program_pages(index: UInt64 | int, /) → Bytes

Approval Program as an array of pages

ABIApplicationCallInnerTransaction.clear_state_program_pages

ABIApplicationCallInnerTransaction.clear_state_program_pages(index: UInt64 | int, /) → Bytes

Clear State Program as an array of pages

property ABIApplicationCallInnerTransaction.reject_version : UInt64

Application version for which the txn must reject

property ABIApplicationCallInnerTransaction.sender : Account

32 byte address

property ABIApplicationCallInnerTransaction.fee : UInt64

microalgos

property ABIApplicationCallInnerTransaction.first_valid : UInt64

round number

property ABIApplicationCallInnerTransaction.first_valid_time : UInt64

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

property ABIApplicationCallInnerTransaction.last_valid : UInt64

round number

property ABIApplicationCallInnerTransaction.note : Bytes

Any data up to 1024 bytes

property ABIApplicationCallInnerTransaction.lease : Bytes

32 byte lease value

property ABIApplicationCallInnerTransaction.type_bytes : Bytes

Transaction type as bytes

property ABIApplicationCallInnerTransaction.type : TransactionType

Transaction type as integer

property ABIApplicationCallInnerTransaction.group_index : UInt64

Position of this transaction within an atomic transaction group. A stand-alone transaction is implicitly element 0 in a group of 1

property ABIApplicationCallInnerTransaction.txn_id : Bytes

The computed ID for this transaction. 32 bytes.

property ABIApplicationCallInnerTransaction.rekey_to : Account

32 byte Sender’s new AuthAddr

class ABIApplicationCall

Bases: algopy.itxn._InnerTransaction[algopy.itxn.ABIApplicationCallInnerTransaction[algopy.itxn.ABIApplicationCall.T]]

ABIApplicationCall.stage

ABIApplicationCall.stage(*, begin_group: bool = False) → None

Stages inner transaction parameters for submission

• Parameters:
  • begin_group – If True, begins a new inner transaction group with this transaction as the first transaction in the group
• Note:
  • use algopy.itxn.submit_staged to submit all staged inner transaction parameters

ABIApplicationCall.submit

ABIApplicationCall.submit() → _TResult_co

Submits inner transaction parameters and returns the resulting inner transaction

ABIApplicationCall.copy

ABIApplicationCall.copy() → Self

Copies a set of inner transaction parameters