algokit_utils.transactions.types
algokit_utils.transactions.types
Section titled “algokit_utils.transactions.types”Attributes
Section titled “Attributes”MethodCallParams | |
|---|---|
TxnParams |
Classes
Section titled “Classes”Module Contents
Section titled “Module Contents”class CommonTxnParams
Section titled “class CommonTxnParams”sender : str
Section titled “sender : str”signer : TransactionSigner | AddressWithTransactionSigner | None = None
Section titled “signer : TransactionSigner | AddressWithTransactionSigner | None = None”rekey_to : str | None = None
Section titled “rekey_to : str | None = None”note : bytes | None = None
Section titled “note : bytes | None = None”lease : bytes | None = None
Section titled “lease : bytes | None = None”static_fee : AlgoAmount | None = None
Section titled “static_fee : AlgoAmount | None = None”extra_fee : AlgoAmount | None = None
Section titled “extra_fee : AlgoAmount | None = None”max_fee : AlgoAmount | None = None
Section titled “max_fee : AlgoAmount | None = None”validity_window : int | None = None
Section titled “validity_window : int | None = None”first_valid_round : int | None = None
Section titled “first_valid_round : int | None = None”last_valid_round : int | None = None
Section titled “last_valid_round : int | None = None”class PaymentParams
Section titled “class PaymentParams”Bases: CommonTxnParams
receiver : str
Section titled “receiver : str”close_remainder_to : str | None = None
Section titled “close_remainder_to : str | None = None”class AssetCreateParams
Section titled “class AssetCreateParams”Bases: CommonTxnParams
total : int
Section titled “total : int”asset_name : str | None = None
Section titled “asset_name : str | None = None”unit_name : str | None = None
Section titled “unit_name : str | None = None”url : str | None = None
Section titled “url : str | None = None”decimals : int | None = None
Section titled “decimals : int | None = None”default_frozen : bool | None = None
Section titled “default_frozen : bool | None = None”manager : str | None = None
Section titled “manager : str | None = None”reserve : str | None = None
Section titled “reserve : str | None = None”freeze : str | None = None
Section titled “freeze : str | None = None”clawback : str | None = None
Section titled “clawback : str | None = None”metadata_hash : bytes | None = None
Section titled “metadata_hash : bytes | None = None”class AssetConfigParams
Section titled “class AssetConfigParams”Bases: CommonTxnParams
asset_id : int
Section titled “asset_id : int”manager : str | None = None
Section titled “manager : str | None = None”reserve : str | None = None
Section titled “reserve : str | None = None”freeze : str | None = None
Section titled “freeze : str | None = None”clawback : str | None = None
Section titled “clawback : str | None = None”class AssetFreezeParams
Section titled “class AssetFreezeParams”Bases: CommonTxnParams
asset_id : int
Section titled “asset_id : int”account : str
Section titled “account : str”frozen : bool
Section titled “frozen : bool”class AssetDestroyParams
Section titled “class AssetDestroyParams”Bases: CommonTxnParams
asset_id : int
Section titled “asset_id : int”class OnlineKeyRegistrationParams
Section titled “class OnlineKeyRegistrationParams”Bases: CommonTxnParams
vote_key : str
Section titled “vote_key : str”selection_key : str
Section titled “selection_key : str”state_proof_key : bytes | None = None
Section titled “state_proof_key : bytes | None = None”vote_first : int = 0
Section titled “vote_first : int = 0”vote_last : int = 0
Section titled “vote_last : int = 0”vote_key_dilution : int = 0
Section titled “vote_key_dilution : int = 0”nonparticipation : bool | None = None
Section titled “nonparticipation : bool | None = None”class OfflineKeyRegistrationParams
Section titled “class OfflineKeyRegistrationParams”Bases: CommonTxnParams
prevent_account_from_ever_participating_again : bool = True
Section titled “prevent_account_from_ever_participating_again : bool = True”class AssetTransferParams
Section titled “class AssetTransferParams”Bases: CommonTxnParams
asset_id : int
Section titled “asset_id : int”amount : int
Section titled “amount : int”receiver : str
Section titled “receiver : str”close_asset_to : str | None = None
Section titled “close_asset_to : str | None = None”clawback_target : str | None = None
Section titled “clawback_target : str | None = None”class AssetOptInParams
Section titled “class AssetOptInParams”Bases: CommonTxnParams
asset_id : int
Section titled “asset_id : int”class AssetOptOutParams
Section titled “class AssetOptOutParams”Bases: CommonTxnParams
asset_id : int
Section titled “asset_id : int”creator : str
Section titled “creator : str”class AppCallParams
Section titled “class AppCallParams”Bases: CommonTxnParams
app_id : int
Section titled “app_id : int”args : list[bytes] | None = None
Section titled “args : list[bytes] | None = None”account_references : list[str] | None = None
Section titled “account_references : list[str] | None = None”app_references : list[int] | None = None
Section titled “app_references : list[int] | None = None”asset_references : list[int] | None = None
Section titled “asset_references : list[int] | None = None”box_references : list[algokit_utils.models.state.BoxReference | BoxIdentifier] | None = None
Section titled “box_references : list[algokit_utils.models.state.BoxReference | BoxIdentifier] | None = None”on_complete : OnApplicationComplete | None = None
Section titled “on_complete : OnApplicationComplete | None = None”class AppCreateSchema
Section titled “class AppCreateSchema”Bases: TypedDict
dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object’s
(key, value) pairs
dict(iterable) -> new dictionary initialized as if via:
: d = {}
for k, v in iterable:
d[k] = v
dict(
**kwargs) -> new dictionary initialized with the name=value pairs : in the keyword argument list. For example: dict(one=1, two=2)
global_ints : int
Section titled “global_ints : int”global_byte_slices : int
Section titled “global_byte_slices : int”local_ints : int
Section titled “local_ints : int”local_byte_slices : int
Section titled “local_byte_slices : int”class AppCreateParams
Section titled “class AppCreateParams”Bases: CommonTxnParams
approval_program : str | bytes
Section titled “approval_program : str | bytes”clear_state_program : str | bytes
Section titled “clear_state_program : str | bytes”schema : AppCreateSchema | None = None
Section titled “schema : AppCreateSchema | None = None”on_complete : OnApplicationComplete | None = None
Section titled “on_complete : OnApplicationComplete | None = None”args : list[bytes] | None = None
Section titled “args : list[bytes] | None = None”account_references : list[str] | None = None
Section titled “account_references : list[str] | None = None”app_references : list[int] | None = None
Section titled “app_references : list[int] | None = None”asset_references : list[int] | None = None
Section titled “asset_references : list[int] | None = None”box_references : list[algokit_utils.models.state.BoxReference | BoxIdentifier] | None = None
Section titled “box_references : list[algokit_utils.models.state.BoxReference | BoxIdentifier] | None = None”extra_program_pages : int | None = None
Section titled “extra_program_pages : int | None = None”class AppUpdateParams
Section titled “class AppUpdateParams”Bases: CommonTxnParams
app_id : int
Section titled “app_id : int”approval_program : str | bytes
Section titled “approval_program : str | bytes”clear_state_program : str | bytes
Section titled “clear_state_program : str | bytes”args : list[bytes] | None = None
Section titled “args : list[bytes] | None = None”account_references : list[str] | None = None
Section titled “account_references : list[str] | None = None”app_references : list[int] | None = None
Section titled “app_references : list[int] | None = None”asset_references : list[int] | None = None
Section titled “asset_references : list[int] | None = None”box_references : list[algokit_utils.models.state.BoxReference | BoxIdentifier] | None = None
Section titled “box_references : list[algokit_utils.models.state.BoxReference | BoxIdentifier] | None = None”on_complete : OnApplicationComplete
Section titled “on_complete : OnApplicationComplete”class AppDeleteParams
Section titled “class AppDeleteParams”Bases: CommonTxnParams
app_id : int
Section titled “app_id : int”args : list[bytes] | None = None
Section titled “args : list[bytes] | None = None”account_references : list[str] | None = None
Section titled “account_references : list[str] | None = None”app_references : list[int] | None = None
Section titled “app_references : list[int] | None = None”asset_references : list[int] | None = None
Section titled “asset_references : list[int] | None = None”box_references : list[algokit_utils.models.state.BoxReference | BoxIdentifier] | None = None
Section titled “box_references : list[algokit_utils.models.state.BoxReference | BoxIdentifier] | None = None”on_complete : OnApplicationComplete | None = None
Section titled “on_complete : OnApplicationComplete | None = None”class AppMethodCallParams
Section titled “class AppMethodCallParams”Bases: CommonTxnParams
app_id : int
Section titled “app_id : int”method : Method
Section titled “method : Method”args : list[bytes] | None = None
Section titled “args : list[bytes] | None = None”on_complete : OnApplicationComplete | None = None
Section titled “on_complete : OnApplicationComplete | None = None”account_references : list[str] | None = None
Section titled “account_references : list[str] | None = None”app_references : list[int] | None = None
Section titled “app_references : list[int] | None = None”asset_references : list[int] | None = None
Section titled “asset_references : list[int] | None = None”box_references : list[algokit_utils.models.state.BoxReference | BoxIdentifier] | None = None
Section titled “box_references : list[algokit_utils.models.state.BoxReference | BoxIdentifier] | None = None”class AppCallMethodCallParams
Section titled “class AppCallMethodCallParams”Bases: _BaseAppMethodCall
app_id : int
Section titled “app_id : int”on_complete : OnApplicationComplete | None = None
Section titled “on_complete : OnApplicationComplete | None = None”class AppCreateMethodCallParams
Section titled “class AppCreateMethodCallParams”Bases: _BaseAppMethodCall
approval_program : str | bytes
Section titled “approval_program : str | bytes”clear_state_program : str | bytes
Section titled “clear_state_program : str | bytes”schema : AppCreateSchema | None = None
Section titled “schema : AppCreateSchema | None = None”on_complete : OnApplicationComplete | None = None
Section titled “on_complete : OnApplicationComplete | None = None”class AppUpdateMethodCallParams
Section titled “class AppUpdateMethodCallParams”Bases: _BaseAppMethodCall
app_id : int
Section titled “app_id : int”approval_program : str | bytes
Section titled “approval_program : str | bytes”clear_state_program : str | bytes
Section titled “clear_state_program : str | bytes”on_complete : OnApplicationComplete
Section titled “on_complete : OnApplicationComplete”class AppDeleteMethodCallParams
Section titled “class AppDeleteMethodCallParams”Bases: _BaseAppMethodCall