algopy.gtxn
Classes
ApplicationCallTransaction | Application call group transaction |
|---|---|
AssetConfigTransaction | Asset config group transaction |
AssetFreezeTransaction | Asset freeze group transaction |
AssetTransferTransaction | Asset transfer group transaction |
KeyRegistrationTransaction | Key registration group transaction |
PaymentTransaction | Payment group transaction |
Transaction | Group Transaction of any type |
TransactionBase | Shared transaction properties |
API
class algopy.gtxn.ApplicationCallTransaction
ApplicationCallTransaction(group_index: algopy.UInt64 | int)
Application call group transaction
Initialization
accounts
accounts(index: algopy.UInt64 | int, /) → algopy.Account
Accounts listed in the ApplicationCall transaction
app_args
app_args(index: algopy.UInt64 | int, /) → algopy.Bytes
Arguments passed to the application in the ApplicationCall transaction
property app_id
app_id : algopy.Application
ApplicationID from ApplicationCall transaction
property approval_program
approval_program : algopy.Bytes
Approval program
approval_program_pages
approval_program_pages(index: algopy.UInt64 | int, /) → algopy.Bytes
Approval Program as an array of pages
apps
apps(index: algopy.UInt64 | int, /) → algopy.Application
Foreign Apps listed in the ApplicationCall transaction
assets
assets(index: algopy.UInt64 | int, /) → algopy.Asset
Foreign Assets listed in the ApplicationCall transaction
property clear_state_program
clear_state_program : algopy.Bytes
Clear State program
clear_state_program_pages
clear_state_program_pages(index: algopy.UInt64 | int, /) → algopy.Bytes
Clear State Program as an array of pages
property created_app
created_app : algopy.Application
ApplicationID allocated by the creation of an application
property extra_program_pages
extra_program_pages : algopy.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 fee
fee : algopy.UInt64
microalgos
property first_valid
first_valid : algopy.UInt64
round number
property first_valid_time
first_valid_time : algopy.UInt64
UNIX timestamp of block before txn.FirstValid. Fails if negative
property global_num_bytes
global_num_bytes : algopy.UInt64
Number of global state byteslices in ApplicationCall
property global_num_uint
global_num_uint : algopy.UInt64
Number of global state integers in ApplicationCall
property group_index
group_index : algopy.UInt64
Position of this transaction within an atomic transaction group. A stand-alone transaction is implicitly element 0 in a group of 1
property last_log
last_log : algopy.Bytes
The last message emitted. Empty bytes if none were emitted. Application mode only
property last_valid
last_valid : algopy.UInt64
round number
property lease
lease : algopy.Bytes
32 byte lease value
property local_num_bytes
local_num_bytes : algopy.UInt64
Number of local state byteslices in ApplicationCall
property local_num_uint
local_num_uint : algopy.UInt64
Number of local state integers in ApplicationCall
logs
logs(index: algopy.UInt64 | int) → algopy.Bytes
Log messages emitted by an application call
property note
note : algopy.Bytes
Any data up to 1024 bytes
property num_accounts
num_accounts : algopy.UInt64
Number of ApplicationArgs
property num_app_args
num_app_args : algopy.UInt64
Number of ApplicationArgs
property num_approval_program_pages
num_approval_program_pages : algopy.UInt64
Number of Approval Program pages
property num_apps
num_apps : algopy.UInt64
Number of Applications
property num_assets
num_assets : algopy.UInt64
Number of Assets
property num_clear_state_program_pages
num_clear_state_program_pages : algopy.UInt64
Number of Clear State Program pages
property num_logs
num_logs : algopy.UInt64
Number of logs
property on_completion
on_completion : algopy.OnCompleteAction
ApplicationCall transaction on completion action
property rekey_to
rekey_to : algopy.Account
32 byte Sender’s new AuthAddr
property sender
sender : algopy.Account
32 byte address
property txn_id
txn_id : algopy.Bytes
The computed ID for this transaction. 32 bytes.
property type
type : algopy.TransactionType
Transaction type as integer
property type_bytes
type_bytes : algopy.Bytes
Transaction type as bytes
class algopy.gtxn.AssetConfigTransaction
AssetConfigTransaction(group_index: algopy.UInt64 | int)
Asset config group transaction
Initialization
property asset_name
asset_name : algopy.Bytes
The asset name
property clawback
clawback : algopy.Account
32 byte address
property config_asset
config_asset : algopy.Asset
Asset ID in asset config transaction
property created_asset
created_asset : algopy.Asset
Asset ID allocated by the creation of an ASA
property decimals
decimals : algopy.UInt64
Number of digits to display after the decimal place when displaying the asset
property default_frozen
default_frozen : bool
Whether the asset’s slots are frozen by default or not, 0 or 1
property fee
fee : algopy.UInt64
microalgos
property first_valid
first_valid : algopy.UInt64
round number
property first_valid_time
first_valid_time : algopy.UInt64
UNIX timestamp of block before txn.FirstValid. Fails if negative
property freeze
freeze : algopy.Account
32 byte address
property group_index
group_index : algopy.UInt64
Position of this transaction within an atomic transaction group. A stand-alone transaction is implicitly element 0 in a group of 1
property last_valid
last_valid : algopy.UInt64
round number
property lease
lease : algopy.Bytes
32 byte lease value
property manager
manager : algopy.Account
32 byte address
property metadata_hash
metadata_hash : algopy.Bytes
32 byte commitment to unspecified asset metadata
property note
note : algopy.Bytes
Any data up to 1024 bytes
property rekey_to
rekey_to : algopy.Account
32 byte Sender’s new AuthAddr
property reserve
reserve : algopy.Account
32 byte address
property sender
sender : algopy.Account
32 byte address
property total
total : algopy.UInt64
Total number of units of this asset created
property txn_id
txn_id : algopy.Bytes
The computed ID for this transaction. 32 bytes.
property type
type : algopy.TransactionType
Transaction type as integer
property type_bytes
type_bytes : algopy.Bytes
Transaction type as bytes
property unit_name
unit_name : algopy.Bytes
Unit name of the asset
property url
url : algopy.Bytes
URL
class algopy.gtxn.AssetFreezeTransaction
AssetFreezeTransaction(group_index: algopy.UInt64 | int)
Asset freeze group transaction
Initialization
property fee
fee : algopy.UInt64
microalgos
property first_valid
first_valid : algopy.UInt64
round number
property first_valid_time
first_valid_time : algopy.UInt64
UNIX timestamp of block before txn.FirstValid. Fails if negative
property freeze_account
freeze_account : algopy.Account
32 byte address of the account whose asset slot is being frozen or un-frozen
property freeze_asset
freeze_asset : algopy.Asset
Asset ID being frozen or un-frozen
property frozen
frozen : bool
The new frozen value, 0 or 1
property group_index
group_index : algopy.UInt64
Position of this transaction within an atomic transaction group. A stand-alone transaction is implicitly element 0 in a group of 1
property last_valid
last_valid : algopy.UInt64
round number
property lease
lease : algopy.Bytes
32 byte lease value
property note
note : algopy.Bytes
Any data up to 1024 bytes
property rekey_to
rekey_to : algopy.Account
32 byte Sender’s new AuthAddr
property sender
sender : algopy.Account
32 byte address
property txn_id
txn_id : algopy.Bytes
The computed ID for this transaction. 32 bytes.
property type
type : algopy.TransactionType
Transaction type as integer
property type_bytes
type_bytes : algopy.Bytes
Transaction type as bytes
class algopy.gtxn.AssetTransferTransaction
AssetTransferTransaction(group_index: algopy.UInt64 | int)
Asset transfer group transaction
Initialization
property asset_amount
asset_amount : algopy.UInt64
value in Asset’s units
property asset_close_to
asset_close_to : algopy.Account
32 byte address
property asset_receiver
asset_receiver : algopy.Account
32 byte address
property asset_sender
asset_sender : algopy.Account
32 byte address. Source of assets if Sender is the Asset’s Clawback address.
property fee
fee : algopy.UInt64
microalgos
property first_valid
first_valid : algopy.UInt64
round number
property first_valid_time
first_valid_time : algopy.UInt64
UNIX timestamp of block before txn.FirstValid. Fails if negative
property group_index
group_index : algopy.UInt64
Position of this transaction within an atomic transaction group. A stand-alone transaction is implicitly element 0 in a group of 1
property last_valid
last_valid : algopy.UInt64
round number
property lease
lease : algopy.Bytes
32 byte lease value
property note
note : algopy.Bytes
Any data up to 1024 bytes
property rekey_to
rekey_to : algopy.Account
32 byte Sender’s new AuthAddr
property sender
sender : algopy.Account
32 byte address
property txn_id
txn_id : algopy.Bytes
The computed ID for this transaction. 32 bytes.
property type
type : algopy.TransactionType
Transaction type as integer
property type_bytes
type_bytes : algopy.Bytes
Transaction type as bytes
property xfer_asset
xfer_asset : algopy.Asset
Asset ID
class algopy.gtxn.KeyRegistrationTransaction
KeyRegistrationTransaction(group_index: algopy.UInt64 | int)
Key registration group transaction
Initialization
property fee
fee : algopy.UInt64
microalgos
property first_valid
first_valid : algopy.UInt64
round number
property first_valid_time
first_valid_time : algopy.UInt64
UNIX timestamp of block before txn.FirstValid. Fails if negative
property group_index
group_index : algopy.UInt64
Position of this transaction within an atomic transaction group. A stand-alone transaction is implicitly element 0 in a group of 1
property last_valid
last_valid : algopy.UInt64
round number
property lease
lease : algopy.Bytes
32 byte lease value
property non_participation
non_participation : bool
Marks an account nonparticipating for rewards
property note
note : algopy.Bytes
Any data up to 1024 bytes
property rekey_to
rekey_to : algopy.Account
32 byte Sender’s new AuthAddr
property selection_key
selection_key : algopy.Bytes
32 byte address
property sender
sender : algopy.Account
32 byte address
property state_proof_key
state_proof_key : algopy.Bytes
64 byte state proof public key
property txn_id
txn_id : algopy.Bytes
The computed ID for this transaction. 32 bytes.
property type
type : algopy.TransactionType
Transaction type as integer
property type_bytes
type_bytes : algopy.Bytes
Transaction type as bytes
property vote_first
vote_first : algopy.UInt64
The first round that the participation key is valid.
property vote_key
vote_key : algopy.Bytes
32 byte address
property vote_key_dilution
vote_key_dilution : algopy.UInt64
Dilution for the 2-level participation key
property vote_last
vote_last : algopy.UInt64
The last round that the participation key is valid.
class algopy.gtxn.PaymentTransaction
PaymentTransaction(group_index: algopy.UInt64 | int)
Payment group transaction
Initialization
property amount
amount : algopy.UInt64
microalgos
property close_remainder_to
close_remainder_to : algopy.Account
32 byte address
property fee
fee : algopy.UInt64
microalgos
property first_valid
first_valid : algopy.UInt64
round number
property first_valid_time
first_valid_time : algopy.UInt64
UNIX timestamp of block before txn.FirstValid. Fails if negative
property group_index
group_index : algopy.UInt64
Position of this transaction within an atomic transaction group. A stand-alone transaction is implicitly element 0 in a group of 1
property last_valid
last_valid : algopy.UInt64
round number
property lease
lease : algopy.Bytes
32 byte lease value
property note
note : algopy.Bytes
Any data up to 1024 bytes
property receiver
receiver : algopy.Account
32 byte address
property rekey_to
rekey_to : algopy.Account
32 byte Sender’s new AuthAddr
property sender
sender : algopy.Account
32 byte address
property txn_id
txn_id : algopy.Bytes
The computed ID for this transaction. 32 bytes.
property type
type : algopy.TransactionType
Transaction type as integer
property type_bytes
type_bytes : algopy.Bytes
Transaction type as bytes
class algopy.gtxn.Transaction
Transaction(group_index: algopy.UInt64 | int)
Group Transaction of any type
Initialization
accounts
accounts(index: algopy.UInt64 | int, /) → algopy.Account
Accounts listed in the ApplicationCall transaction
property amount
amount : algopy.UInt64
microalgos
app_args
app_args(index: algopy.UInt64 | int, /) → algopy.Bytes
Arguments passed to the application in the ApplicationCall transaction
property app_id
app_id : algopy.Application
ApplicationID from ApplicationCall transaction
property approval_program
approval_program : algopy.Bytes
Approval program
approval_program_pages
approval_program_pages(index: algopy.UInt64 | int, /) → algopy.Bytes
Approval Program as an array of pages
apps
apps(index: algopy.UInt64 | int, /) → algopy.Application
Foreign Apps listed in the ApplicationCall transaction
property asset_amount
asset_amount : algopy.UInt64
value in Asset’s units
property asset_close_to
asset_close_to : algopy.Account
32 byte address
property asset_name
asset_name : algopy.Bytes
The asset name
property asset_receiver
asset_receiver : algopy.Account
32 byte address
property asset_sender
asset_sender : algopy.Account
32 byte address. Source of assets if Sender is the Asset’s Clawback address.
assets
assets(index: algopy.UInt64 | int, /) → algopy.Asset
Foreign Assets listed in the ApplicationCall transaction
property clawback
clawback : algopy.Account
32 byte address
property clear_state_program
clear_state_program : algopy.Bytes
Clear State program
clear_state_program_pages
clear_state_program_pages(index: algopy.UInt64 | int, /) → algopy.Bytes
Clear State Program as an array of pages
property close_remainder_to
close_remainder_to : algopy.Account
32 byte address
property config_asset
config_asset : algopy.Asset
Asset ID in asset config transaction
property created_app
created_app : algopy.Application
ApplicationID allocated by the creation of an application
property created_asset
created_asset : algopy.Asset
Asset ID allocated by the creation of an ASA
property decimals
decimals : algopy.UInt64
Number of digits to display after the decimal place when displaying the asset
property default_frozen
default_frozen : bool
Whether the asset’s slots are frozen by default or not, 0 or 1
property extra_program_pages
extra_program_pages : algopy.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 fee
fee : algopy.UInt64
microalgos
property first_valid
first_valid : algopy.UInt64
round number
property first_valid_time
first_valid_time : algopy.UInt64
UNIX timestamp of block before txn.FirstValid. Fails if negative
property freeze
freeze : algopy.Account
32 byte address
property freeze_account
freeze_account : algopy.Account
32 byte address of the account whose asset slot is being frozen or un-frozen
property freeze_asset
freeze_asset : algopy.Asset
Asset ID being frozen or un-frozen
property frozen
frozen : bool
The new frozen value, 0 or 1
property global_num_bytes
global_num_bytes : algopy.UInt64
Number of global state byteslices in ApplicationCall
property global_num_uint
global_num_uint : algopy.UInt64
Number of global state integers in ApplicationCall
property group_index
group_index : algopy.UInt64
Position of this transaction within an atomic transaction group. A stand-alone transaction is implicitly element 0 in a group of 1
property last_log
last_log : algopy.Bytes
The last message emitted. Empty bytes if none were emitted. Application mode only
property last_valid
last_valid : algopy.UInt64
round number
property lease
lease : algopy.Bytes
32 byte lease value
property local_num_bytes
local_num_bytes : algopy.UInt64
Number of local state byteslices in ApplicationCall
property local_num_uint
local_num_uint : algopy.UInt64
Number of local state integers in ApplicationCall
logs
logs(index: algopy.UInt64 | int) → algopy.Bytes
Log messages emitted by an application call
property manager
manager : algopy.Account
32 byte address
property metadata_hash
metadata_hash : algopy.Bytes
32 byte commitment to unspecified asset metadata
property non_participation
non_participation : bool
Marks an account nonparticipating for rewards
property note
note : algopy.Bytes
Any data up to 1024 bytes
property num_accounts
num_accounts : algopy.UInt64
Number of ApplicationArgs
property num_app_args
num_app_args : algopy.UInt64
Number of ApplicationArgs
property num_approval_program_pages
num_approval_program_pages : algopy.UInt64
Number of Approval Program pages
property num_apps
num_apps : algopy.UInt64
Number of Applications
property num_assets
num_assets : algopy.UInt64
Number of Assets
property num_clear_state_program_pages
num_clear_state_program_pages : algopy.UInt64
Number of Clear State Program pages
property num_logs
num_logs : algopy.UInt64
Number of logs
property on_completion
on_completion : algopy.OnCompleteAction
ApplicationCall transaction on completion action
property receiver
receiver : algopy.Account
32 byte address
property rekey_to
rekey_to : algopy.Account
32 byte Sender’s new AuthAddr
property reserve
reserve : algopy.Account
32 byte address
property selection_key
selection_key : algopy.Bytes
32 byte address
property sender
sender : algopy.Account
32 byte address
property state_proof_key
state_proof_key : algopy.Bytes
64 byte state proof public key
property total
total : algopy.UInt64
Total number of units of this asset created
property txn_id
txn_id : algopy.Bytes
The computed ID for this transaction. 32 bytes.
property type
type : algopy.TransactionType
Transaction type as integer
property type_bytes
type_bytes : algopy.Bytes
Transaction type as bytes
property unit_name
unit_name : algopy.Bytes
Unit name of the asset
property url
url : algopy.Bytes
URL
property vote_first
vote_first : algopy.UInt64
The first round that the participation key is valid.
property vote_key
vote_key : algopy.Bytes
32 byte address
property vote_key_dilution
vote_key_dilution : algopy.UInt64
Dilution for the 2-level participation key
property vote_last
vote_last : algopy.UInt64
The last round that the participation key is valid.
property xfer_asset
xfer_asset : algopy.Asset
Asset ID
class algopy.gtxn.TransactionBase
TransactionBase
Shared transaction properties
property fee
fee : algopy.UInt64
microalgos
property first_valid
first_valid : algopy.UInt64
round number
property first_valid_time
first_valid_time : algopy.UInt64
UNIX timestamp of block before txn.FirstValid. Fails if negative
property group_index
group_index : algopy.UInt64
Position of this transaction within an atomic transaction group. A stand-alone transaction is implicitly element 0 in a group of 1
property last_valid
last_valid : algopy.UInt64
round number
property lease
lease : algopy.Bytes
32 byte lease value
property note
note : algopy.Bytes
Any data up to 1024 bytes
property rekey_to
rekey_to : algopy.Account
32 byte Sender’s new AuthAddr
property sender
sender : algopy.Account
32 byte address
property txn_id
txn_id : algopy.Bytes
The computed ID for this transaction. 32 bytes.
property type
type : algopy.TransactionType
Transaction type as integer
property type_bytes
type_bytes : algopy.Bytes
Transaction type as bytes