models.state
Attributes
Section titled “Attributes”TealTemplateParams | |
|---|---|
BoxIdentifier |
Classes
Section titled “Classes”BoxName | The name of the box |
|---|---|
BoxValue | The value of the box |
DataTypeFlag | Enum where members are also (and must be) ints |
BoxReference | Represents a box reference with a foreign app index and the box name. |
Module Contents
Section titled “Module Contents”class algokit_utils.models.state.BoxName
Section titled “class algokit_utils.models.state.BoxName”The name of the box
name : str
Section titled “name : str”The name of the box as a string. If the name can’t be decoded from UTF-8, the string representation of the bytes is returned instead.
name*raw *: bytes_
Section titled “name*raw *: bytes_”The name of the box as raw bytes
name*base64 *: str_
Section titled “name*base64 *: str_”The name of the box as a base64 encoded string
class algokit_utils.models.state.BoxValue
Section titled “class algokit_utils.models.state.BoxValue”The value of the box
The name of the box
value : bytes
Section titled “value : bytes”The value of the box as raw bytes
class algokit_utils.models.state.DataTypeFlag
Section titled “class algokit_utils.models.state.DataTypeFlag”Bases: enum.IntEnum
Enum where members are also (and must be) ints
BYTES = 1
Section titled “BYTES = 1”UINT = 2
Section titled “UINT = 2”type algokit*utils.models.state.TealTemplateParams *= Mapping[str, str | int | bytes] | dict[str, str | int | bytes]_
Section titled “type algokit*utils.models.state.TealTemplateParams *= Mapping[str, str | int | bytes] | dict[str, str | int | bytes]_”type algokit*utils.models.state.BoxIdentifier *= str | bytes | AccountTransactionSigner_
Section titled “type algokit*utils.models.state.BoxIdentifier *= str | bytes | AccountTransactionSigner_”class algokit_utils.models.state.BoxReference(app_id: int, name: bytes | str)
Section titled “class algokit_utils.models.state.BoxReference(app_id: int, name: bytes | str)”Bases: algosdk.box_reference.BoxReference
Represents a box reference with a foreign app index and the box name.
Args: : app_index (int): index of the application in the foreign app array name (bytes): key for the box in bytes