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