algokit-utils 5.0.0a3__py3-none-any.whl

algokit_algod_client/config.py

@@ -0,0 +1,36 @@
+# AUTO-GENERATED: oas_generator
+
+
+from dataclasses import dataclass, field
+
+
+@dataclass(slots=True)
+class ClientConfig:
+    """Runtime configuration for AlgodClient.
+
+    Attributes:
+        base_url: Base URL for the API endpoint.
+        token: Optional authentication token.
+        token_header: Header name for the authentication token.
+        timeout: Request timeout in seconds. Set to None for no timeout.
+        verify: SSL certificate verification. Can be a boolean or path to CA bundle.
+        extra_headers: Additional headers to include in all requests.
+        max_retries: Maximum number of retry attempts for transient failures.
+            Set to 0 to disable retries. Default is 4 (5 total attempts).
+            Note: Retries are automatically disabled when a custom http_client
+            is provided to avoid conflicts with the client's own retry mechanism.
+    """
+
+    base_url: str = "http://localhost:4001"
+    token: str | None = None
+    token_header: str = "X-Algo-API-Token"
+    timeout: float | None = 30.0
+    verify: bool | str = True
+    extra_headers: dict[str, str] = field(default_factory=dict)
+    max_retries: int = 4
+
+    def resolve_headers(self) -> dict[str, str]:
+        headers = dict(self.extra_headers)
+        if self.token:
+            headers[self.token_header] = self.token
+        return headers

algokit_algod_client/exceptions.py

@@ -0,0 +1,59 @@
+# AUTO-GENERATED: oas_generator
+
+from http import HTTPStatus
+from json import JSONDecodeError, loads
+
+
+class ApiError(RuntimeError):
+    """Base exception for errors raised by generated clients."""
+
+
+def _format_payload(payload: object) -> str | None:  # noqa: C901, PLR0912
+    """Extract a human-friendly message from a payload."""
+    if payload is None:
+        return None
+
+    text: str | None = None
+    if isinstance(payload, (bytes | bytearray | memoryview)):
+        try:
+            text = bytes(payload).decode("utf-8", errors="ignore")
+        except Exception:
+            text = None
+    if text is None:
+        text = str(payload)
+
+    result = text.strip()
+    if not result:
+        return None
+
+    try:
+        decoded = loads(result)
+    except (JSONDecodeError, TypeError):
+        return result
+
+    if isinstance(decoded, dict):
+        for key in ("message", "msg", "error", "detail", "description", "data"):
+            value = decoded.get(key)
+            if isinstance(value, str):
+                candidate = value.strip()
+                if candidate:
+                    result = candidate
+                    break
+
+    if isinstance(decoded, list) and decoded:
+        first = decoded[0]
+        if isinstance(first, str):
+            candidate = first.strip()
+            if candidate:
+                result = candidate
+
+    return result
+
+
+class UnexpectedStatusError(ApiError):
+    def __init__(self, status_code: int, payload: object) -> None:
+        message = _format_payload(payload)
+        description = f" {message}" if message else ""
+        super().__init__(f"Unexpected status code {status_code}{description}")
+        self.status_code = HTTPStatus(status_code)
+        self.payload = payload

algokit_algod_client/models/__init__.py

@@ -0,0 +1,229 @@
+# AUTO-GENERATED: oas_generator
+
+
+from algokit_transact.models.app_call import BoxReference, HoldingReference, LocalsReference
+from algokit_transact.models.signed_transaction import SignedTransaction
+
+from ._account import Account
+from ._account_application_response import AccountApplicationResponse
+from ._account_asset_response import AccountAssetResponse
+from ._account_participation import AccountParticipation
+from ._account_state_delta import AccountStateDelta
+from ._allocations_for_genesis_file import AllocationsForGenesisFile
+from ._allocations_for_genesis_file_state_model import AllocationsForGenesisFileStateModel
+from ._application import Application
+from ._application_initial_states import ApplicationInitialStates
+from ._application_kvstorage import ApplicationKvstorage
+from ._application_local_state import ApplicationLocalState
+from ._application_params import ApplicationParams
+from ._application_state_operation import ApplicationStateOperation
+from ._application_state_schema import ApplicationStateSchema
+from ._asset import Asset
+from ._asset_holding import AssetHolding
+from ._asset_params import AssetParams
+from ._avm_key_value import AvmKeyValue
+from ._avm_value import AvmValue
+from ._block import (
+    ApplyData,
+    Block,
+    BlockAccountStateDelta,
+    BlockAppEvalDelta,
+    BlockEvalDelta,
+    BlockHeader,
+    BlockResponse,
+    BlockStateDelta,
+    BlockStateProofTracking,
+    BlockStateProofTrackingData,
+    ParticipationUpdates,
+    RewardState,
+    SignedTxnInBlock,
+    SignedTxnWithAD,
+    TxnCommitments,
+    UpgradeState,
+    UpgradeVote,
+)
+from ._block_hash_response import BlockHashResponse
+from ._block_txids_response import BlockTxidsResponse
+from ._box import Box
+from ._box_descriptor import BoxDescriptor
+from ._boxes_response import BoxesResponse
+from ._build_version_contains_the_current_algod_build_version_information import (
+    BuildVersionContainsTheCurrentAlgodBuildVersionInformation,
+)
+from ._compile_response import CompileResponse
+from ._disassemble_response import DisassembleResponse
+from ._error_response import ErrorResponse
+from ._eval_delta import EvalDelta
+from ._eval_delta_key_value import EvalDeltaKeyValue
+from ._genesis_file_in_json import GenesisFileInJson
+from ._get_block_time_stamp_offset_response import GetBlockTimeStampOffsetResponse
+from ._get_sync_round_response import GetSyncRoundResponse
+from ._ledger_state_delta import (
+    GetTransactionGroupLedgerStateDeltasForRound,
+    LedgerAccountBaseData,
+    LedgerAccountData,
+    LedgerAccountDeltas,
+    LedgerAccountTotals,
+    LedgerAlgoCount,
+    LedgerAppLocalState,
+    LedgerAppLocalStateDelta,
+    LedgerAppParams,
+    LedgerAppParamsDelta,
+    LedgerAppResourceRecord,
+    LedgerAssetHolding,
+    LedgerAssetHoldingDelta,
+    LedgerAssetParams,
+    LedgerAssetParamsDelta,
+    LedgerAssetResourceRecord,
+    LedgerBalanceRecord,
+    LedgerIncludedTransactions,
+    LedgerKvValueDelta,
+    LedgerModifiedCreatable,
+    LedgerStateDelta,
+    LedgerStateDeltaForTransactionGroup,
+    LedgerStateSchema,
+    LedgerTealValue,
+    LedgerVotingData,
+)
+from ._light_block_header_proof import LightBlockHeaderProof
+from ._node_status_response import NodeStatusResponse
+from ._pending_transaction_response import PendingTransactionResponse
+from ._pending_transactions_response import PendingTransactionsResponse
+from ._post_transactions_response import PostTransactionsResponse
+from ._scratch_change import ScratchChange
+from ._simulate_initial_states import SimulateInitialStates
+from ._simulate_request import SimulateRequest
+from ._simulate_request_transaction_group import SimulateRequestTransactionGroup
+from ._simulate_response import SimulateResponse
+from ._simulate_trace_config import SimulateTraceConfig
+from ._simulate_transaction_group_result import SimulateTransactionGroupResult
+from ._simulate_transaction_result import SimulateTransactionResult
+from ._simulate_unnamed_resources_accessed import SimulateUnnamedResourcesAccessed
+from ._simulation_eval_overrides import SimulationEvalOverrides
+from ._simulation_opcode_trace_unit import SimulationOpcodeTraceUnit
+from ._simulation_transaction_exec_trace import SimulationTransactionExecTrace
+from ._source_map import SourceMap
+from ._state_delta import StateDelta
+from ._state_proof import StateProof
+from ._state_proof_message import StateProofMessage
+from ._supply_response import SupplyResponse
+from ._teal_key_value import TealKeyValue
+from ._teal_key_value_store import TealKeyValueStore
+from ._teal_value import TealValue
+from ._transaction_group_ledger_state_deltas_for_round_response import TransactionGroupLedgerStateDeltasForRoundResponse
+from ._transaction_parameters_response import TransactionParametersResponse
+from ._transaction_proof import TransactionProof
+from ._version_contains_the_current_algod_version import VersionContainsTheCurrentAlgodVersion
+from .suggested_params import SuggestedParams
+
+__all__ = [
+    "Account",
+    "AccountApplicationResponse",
+    "AccountAssetResponse",
+    "AccountParticipation",
+    "AccountStateDelta",
+    "AllocationsForGenesisFile",
+    "AllocationsForGenesisFileStateModel",
+    "Application",
+    "ApplicationInitialStates",
+    "ApplicationKvstorage",
+    "ApplicationLocalState",
+    "ApplicationParams",
+    "ApplicationStateOperation",
+    "ApplicationStateSchema",
+    "ApplyData",
+    "Asset",
+    "AssetHolding",
+    "AssetParams",
+    "AvmKeyValue",
+    "AvmValue",
+    "Block",
+    "BlockAccountStateDelta",
+    "BlockAppEvalDelta",
+    "BlockEvalDelta",
+    "BlockHashResponse",
+    "BlockHeader",
+    "BlockResponse",
+    "BlockStateDelta",
+    "BlockStateProofTracking",
+    "BlockStateProofTrackingData",
+    "BlockTxidsResponse",
+    "Box",
+    "BoxDescriptor",
+    "BoxReference",
+    "BoxesResponse",
+    "BuildVersionContainsTheCurrentAlgodBuildVersionInformation",
+    "CompileResponse",
+    "DisassembleResponse",
+    "ErrorResponse",
+    "EvalDelta",
+    "EvalDeltaKeyValue",
+    "GenesisFileInJson",
+    "GetBlockTimeStampOffsetResponse",
+    "GetSyncRoundResponse",
+    "GetTransactionGroupLedgerStateDeltasForRound",
+    "HoldingReference",
+    "LedgerAccountBaseData",
+    "LedgerAccountData",
+    "LedgerAccountDeltas",
+    "LedgerAccountTotals",
+    "LedgerAlgoCount",
+    "LedgerAppLocalState",
+    "LedgerAppLocalStateDelta",
+    "LedgerAppParams",
+    "LedgerAppParamsDelta",
+    "LedgerAppResourceRecord",
+    "LedgerAssetHolding",
+    "LedgerAssetHoldingDelta",
+    "LedgerAssetParams",
+    "LedgerAssetParamsDelta",
+    "LedgerAssetResourceRecord",
+    "LedgerBalanceRecord",
+    "LedgerIncludedTransactions",
+    "LedgerKvValueDelta",
+    "LedgerModifiedCreatable",
+    "LedgerStateDelta",
+    "LedgerStateDeltaForTransactionGroup",
+    "LedgerStateSchema",
+    "LedgerTealValue",
+    "LedgerVotingData",
+    "LightBlockHeaderProof",
+    "LocalsReference",
+    "NodeStatusResponse",
+    "ParticipationUpdates",
+    "PendingTransactionResponse",
+    "PendingTransactionsResponse",
+    "PostTransactionsResponse",
+    "RewardState",
+    "ScratchChange",
+    "SignedTransaction",
+    "SignedTxnInBlock",
+    "SignedTxnWithAD",
+    "SimulateInitialStates",
+    "SimulateRequest",
+    "SimulateRequestTransactionGroup",
+    "SimulateResponse",
+    "SimulateTraceConfig",
+    "SimulateTransactionGroupResult",
+    "SimulateTransactionResult",
+    "SimulateUnnamedResourcesAccessed",
+    "SimulationEvalOverrides",
+    "SimulationOpcodeTraceUnit",
+    "SimulationTransactionExecTrace",
+    "SourceMap",
+    "StateDelta",
+    "StateProof",
+    "StateProofMessage",
+    "SuggestedParams",
+    "SupplyResponse",
+    "TealKeyValue",
+    "TealKeyValueStore",
+    "TealValue",
+    "TransactionGroupLedgerStateDeltasForRoundResponse",
+    "TransactionParametersResponse",
+    "TransactionProof",
+    "TxnCommitments",
+    "UpgradeState",
+    "UpgradeVote",
+    "VersionContainsTheCurrentAlgodVersion",
+]

algokit_algod_client/models/_account.py

@@ -0,0 +1,150 @@
+# AUTO-GENERATED: oas_generator
+
+
+from dataclasses import dataclass, field
+
+from algokit_common.constants import ZERO_ADDRESS
+from algokit_common.serde import nested, wire
+
+from ._account_participation import AccountParticipation
+from ._application import Application
+from ._application_local_state import ApplicationLocalState
+from ._application_state_schema import ApplicationStateSchema
+from ._asset import Asset
+from ._asset_holding import AssetHolding
+from ._serde_helpers import decode_model_sequence, encode_model_sequence
+
+
+@dataclass(slots=True)
+class Account:
+    """
+    Account information at a given round.
+
+    Definition:
+    data/basics/userBalance.go : AccountData
+    """
+
+    address: str = field(
+        default=ZERO_ADDRESS,
+        metadata=wire("address"),
+    )
+    amount: int = field(
+        default=0,
+        metadata=wire("amount"),
+    )
+    amount_without_pending_rewards: int = field(
+        default=0,
+        metadata=wire("amount-without-pending-rewards"),
+    )
+    min_balance: int = field(
+        default=0,
+        metadata=wire("min-balance"),
+    )
+    pending_rewards: int = field(
+        default=0,
+        metadata=wire("pending-rewards"),
+    )
+    rewards: int = field(
+        default=0,
+        metadata=wire("rewards"),
+    )
+    round_: int = field(
+        default=0,
+        metadata=wire("round"),
+    )
+    status: str = field(
+        default="",
+        metadata=wire("status"),
+    )
+    total_apps_opted_in: int = field(
+        default=0,
+        metadata=wire("total-apps-opted-in"),
+    )
+    total_assets_opted_in: int = field(
+        default=0,
+        metadata=wire("total-assets-opted-in"),
+    )
+    total_created_apps: int = field(
+        default=0,
+        metadata=wire("total-created-apps"),
+    )
+    total_created_assets: int = field(
+        default=0,
+        metadata=wire("total-created-assets"),
+    )
+    apps_local_state: list[ApplicationLocalState] | None = field(
+        default=None,
+        metadata=wire(
+            "apps-local-state",
+            encode=encode_model_sequence,
+            decode=lambda raw: decode_model_sequence(lambda: ApplicationLocalState, raw),
+        ),
+    )
+    apps_total_extra_pages: int | None = field(
+        default=None,
+        metadata=wire("apps-total-extra-pages"),
+    )
+    apps_total_schema: ApplicationStateSchema | None = field(
+        default=None,
+        metadata=nested("apps-total-schema", lambda: ApplicationStateSchema),
+    )
+    assets: list[AssetHolding] | None = field(
+        default=None,
+        metadata=wire(
+            "assets",
+            encode=encode_model_sequence,
+            decode=lambda raw: decode_model_sequence(lambda: AssetHolding, raw),
+        ),
+    )
+    auth_addr: str | None = field(
+        default=None,
+        metadata=wire("auth-addr"),
+    )
+    created_apps: list[Application] | None = field(
+        default=None,
+        metadata=wire(
+            "created-apps",
+            encode=encode_model_sequence,
+            decode=lambda raw: decode_model_sequence(lambda: Application, raw),
+        ),
+    )
+    created_assets: list[Asset] | None = field(
+        default=None,
+        metadata=wire(
+            "created-assets",
+            encode=encode_model_sequence,
+            decode=lambda raw: decode_model_sequence(lambda: Asset, raw),
+        ),
+    )
+    incentive_eligible: bool | None = field(
+        default=None,
+        metadata=wire("incentive-eligible"),
+    )
+    last_heartbeat: int | None = field(
+        default=None,
+        metadata=wire("last-heartbeat"),
+    )
+    last_proposed: int | None = field(
+        default=None,
+        metadata=wire("last-proposed"),
+    )
+    participation: AccountParticipation | None = field(
+        default=None,
+        metadata=nested("participation", lambda: AccountParticipation),
+    )
+    reward_base: int | None = field(
+        default=None,
+        metadata=wire("reward-base"),
+    )
+    sig_type: str | None = field(
+        default=None,
+        metadata=wire("sig-type"),
+    )
+    total_box_bytes: int | None = field(
+        default=None,
+        metadata=wire("total-box-bytes"),
+    )
+    total_boxes: int | None = field(
+        default=None,
+        metadata=wire("total-boxes"),
+    )

algokit_algod_client/models/_account_application_response.py

@@ -0,0 +1,25 @@
+# AUTO-GENERATED: oas_generator
+
+
+from dataclasses import dataclass, field
+
+from algokit_common.serde import nested, wire
+
+from ._application_local_state import ApplicationLocalState
+from ._application_params import ApplicationParams
+
+
+@dataclass(slots=True)
+class AccountApplicationResponse:
+    round_: int = field(
+        default=0,
+        metadata=wire("round"),
+    )
+    app_local_state: ApplicationLocalState | None = field(
+        default=None,
+        metadata=nested("app-local-state", lambda: ApplicationLocalState),
+    )
+    created_app: ApplicationParams | None = field(
+        default=None,
+        metadata=nested("created-app", lambda: ApplicationParams),
+    )

algokit_algod_client/models/_account_asset_response.py

@@ -0,0 +1,25 @@
+# AUTO-GENERATED: oas_generator
+
+
+from dataclasses import dataclass, field
+
+from algokit_common.serde import nested, wire
+
+from ._asset_holding import AssetHolding
+from ._asset_params import AssetParams
+
+
+@dataclass(slots=True)
+class AccountAssetResponse:
+    round_: int = field(
+        default=0,
+        metadata=wire("round"),
+    )
+    asset_holding: AssetHolding | None = field(
+        default=None,
+        metadata=nested("asset-holding", lambda: AssetHolding),
+    )
+    created_asset: AssetParams | None = field(
+        default=None,
+        metadata=nested("created-asset", lambda: AssetParams),
+    )

algokit_algod_client/models/_account_participation.py

@@ -0,0 +1,53 @@
+# AUTO-GENERATED: oas_generator
+
+
+from dataclasses import dataclass, field
+
+from algokit_common.serde import wire
+
+from ._serde_helpers import decode_fixed_bytes_base64, encode_fixed_bytes_base64
+
+
+@dataclass(slots=True)
+class AccountParticipation:
+    """
+    AccountParticipation describes the parameters used by this account in consensus
+    protocol.
+    """
+
+    selection_participation_key: bytes = field(
+        default=b"",
+        metadata=wire(
+            "selection-participation-key",
+            encode=lambda v: encode_fixed_bytes_base64(v, 32),
+            decode=lambda raw: decode_fixed_bytes_base64(raw, 32),
+        ),
+    )
+    vote_first_valid: int = field(
+        default=0,
+        metadata=wire("vote-first-valid"),
+    )
+    vote_key_dilution: int = field(
+        default=0,
+        metadata=wire("vote-key-dilution"),
+    )
+    vote_last_valid: int = field(
+        default=0,
+        metadata=wire("vote-last-valid"),
+    )
+    vote_participation_key: bytes = field(
+        default=b"",
+        metadata=wire(
+            "vote-participation-key",
+            encode=lambda v: encode_fixed_bytes_base64(v, 32),
+            decode=lambda raw: decode_fixed_bytes_base64(raw, 32),
+        ),
+    )
+    state_proof_key: bytes | None = field(
+        default=None,
+        metadata=wire(
+            "state-proof-key",
+            encode=lambda v: encode_fixed_bytes_base64(v, 64),
+            decode=lambda raw: decode_fixed_bytes_base64(raw, 64),
+        ),
+    )

algokit_algod_client/models/_account_state_delta.py

@@ -0,0 +1,30 @@
+# AUTO-GENERATED: oas_generator
+
+
+from dataclasses import dataclass, field
+
+from algokit_common.constants import ZERO_ADDRESS
+from algokit_common.serde import wire
+
+from ._eval_delta_key_value import EvalDeltaKeyValue
+from ._serde_helpers import decode_model_sequence, encode_model_sequence
+
+
+@dataclass(slots=True)
+class AccountStateDelta:
+    """
+    Application state delta.
+    """
+
+    address: str = field(
+        default=ZERO_ADDRESS,
+        metadata=wire("address"),
+    )
+    delta: list[EvalDeltaKeyValue] = field(
+        default_factory=list,
+        metadata=wire(
+            "delta",
+            encode=encode_model_sequence,
+            decode=lambda raw: decode_model_sequence(lambda: EvalDeltaKeyValue, raw),
+        ),
+    )

algokit_algod_client/models/_allocations_for_genesis_file.py

@@ -0,0 +1,23 @@
+# AUTO-GENERATED: oas_generator
+
+
+from dataclasses import dataclass, field
+
+from algokit_common.serde import nested, wire
+
+from ._allocations_for_genesis_file_state_model import AllocationsForGenesisFileStateModel
+
+
+@dataclass(slots=True)
+class AllocationsForGenesisFile:
+    state: AllocationsForGenesisFileStateModel = field(
+        metadata=nested("state", lambda: AllocationsForGenesisFileStateModel, required=True),
+    )
+    addr: str = field(
+        default="",
+        metadata=wire("addr"),
+    )
+    comment: str = field(
+        default="",
+        metadata=wire("comment"),
+    )

algokit_algod_client/models/_allocations_for_genesis_file_state_model.py

@@ -0,0 +1,42 @@
+# AUTO-GENERATED: oas_generator
+
+
+from dataclasses import dataclass, field
+
+from algokit_common.serde import wire
+
+
+@dataclass(slots=True)
+class AllocationsForGenesisFileStateModel:
+    algo: int = field(
+        default=0,
+        metadata=wire("algo"),
+    )
+    onl: int = field(
+        default=0,
+        metadata=wire("onl"),
+    )
+    sel: str | None = field(
+        default=None,
+        metadata=wire("sel"),
+    )
+    stprf: str | None = field(
+        default=None,
+        metadata=wire("stprf"),
+    )
+    vote: str | None = field(
+        default=None,
+        metadata=wire("vote"),
+    )
+    vote_fst: int | None = field(
+        default=None,
+        metadata=wire("voteFst"),
+    )
+    vote_kd: int | None = field(
+        default=None,
+        metadata=wire("voteKD"),
+    )
+    vote_lst: int | None = field(
+        default=None,
+        metadata=wire("voteLst"),
+    )