algokit-utils 5.0.0a3__py3-none-any.whl

algokit_kmd_client/config.py

@@ -0,0 +1,36 @@
+# AUTO-GENERATED: oas_generator
+
+
+from dataclasses import dataclass, field
+
+
+@dataclass(slots=True)
+class ClientConfig:
+    """Runtime configuration for KmdClient.
+
+    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:7833"
+    token: str | None = None
+    token_header: str = "X-KMD-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_kmd_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_kmd_client/models/__init__.py

@@ -0,0 +1,112 @@
+# AUTO-GENERATED: oas_generator
+
+
+from ._classical_signatures import ClassicalSignatures
+from ._create_wallet_request import CreateWalletRequest
+from ._create_wallet_response import CreateWalletResponse
+from ._delete_key_request import DeleteKeyRequest
+from ._delete_multisig_request import DeleteMultisigRequest
+from ._digest_represents_a32_byte_value_holding_the256_bit_hash_digest import (
+    DigestRepresentsA32ByteValueHoldingThe256BitHashDigest,
+)
+from ._ed25519_public_key import Ed25519PublicKey
+from ._export_key_request import ExportKeyRequest
+from ._export_key_response import ExportKeyResponse
+from ._export_master_key_request import ExportMasterKeyRequest
+from ._export_master_key_response import ExportMasterKeyResponse
+from ._export_multisig_request import ExportMultisigRequest
+from ._export_multisig_response import ExportMultisigResponse
+from ._generate_key_request import GenerateKeyRequest
+from ._generate_key_response import GenerateKeyResponse
+from ._import_key_request import ImportKeyRequest
+from ._import_key_response import ImportKeyResponse
+from ._import_multisig_request import ImportMultisigRequest
+from ._import_multisig_response import ImportMultisigResponse
+from ._init_wallet_handle_token_request import InitWalletHandleTokenRequest
+from ._init_wallet_handle_token_response import InitWalletHandleTokenResponse
+from ._list_keys_request import ListKeysRequest
+from ._list_keys_response import ListKeysResponse
+from ._list_multisig_request import ListMultisigRequest
+from ._list_multisig_response import ListMultisigResponse
+from ._list_wallets_request import ListWalletsRequest
+from ._list_wallets_response import ListWalletsResponse
+from ._master_derivation_key import MasterDerivationKey
+from ._multisig_sig import MultisigSig
+from ._multisig_subsig import MultisigSubsig
+from ._public_key import PublicKey
+from ._release_wallet_handle_token_request import ReleaseWalletHandleTokenRequest
+from ._rename_wallet_request import RenameWalletRequest
+from ._rename_wallet_response import RenameWalletResponse
+from ._renew_wallet_handle_token_request import RenewWalletHandleTokenRequest
+from ._renew_wallet_handle_token_response import RenewWalletHandleTokenResponse
+from ._sign_multisig_response import SignMultisigResponse
+from ._sign_multisig_txn_request import SignMultisigTxnRequest
+from ._sign_program_multisig_request import SignProgramMultisigRequest
+from ._sign_program_multisig_response import SignProgramMultisigResponse
+from ._sign_program_request import SignProgramRequest
+from ._sign_program_response import SignProgramResponse
+from ._sign_transaction_response import SignTransactionResponse
+from ._sign_txn_request import SignTxnRequest
+from ._signature import Signature
+from ._tx_type import TxType
+from ._versions_request import VersionsRequest
+from ._versions_response import VersionsResponse
+from ._wallet import Wallet
+from ._wallet_handle import WalletHandle
+from ._wallet_info_request import WalletInfoRequest
+from ._wallet_info_response import WalletInfoResponse
+
+__all__ = [
+    "ClassicalSignatures",
+    "CreateWalletRequest",
+    "CreateWalletResponse",
+    "DeleteKeyRequest",
+    "DeleteMultisigRequest",
+    "DigestRepresentsA32ByteValueHoldingThe256BitHashDigest",
+    "Ed25519PublicKey",
+    "ExportKeyRequest",
+    "ExportKeyResponse",
+    "ExportMasterKeyRequest",
+    "ExportMasterKeyResponse",
+    "ExportMultisigRequest",
+    "ExportMultisigResponse",
+    "GenerateKeyRequest",
+    "GenerateKeyResponse",
+    "ImportKeyRequest",
+    "ImportKeyResponse",
+    "ImportMultisigRequest",
+    "ImportMultisigResponse",
+    "InitWalletHandleTokenRequest",
+    "InitWalletHandleTokenResponse",
+    "ListKeysRequest",
+    "ListKeysResponse",
+    "ListMultisigRequest",
+    "ListMultisigResponse",
+    "ListWalletsRequest",
+    "ListWalletsResponse",
+    "MasterDerivationKey",
+    "MultisigSig",
+    "MultisigSubsig",
+    "PublicKey",
+    "ReleaseWalletHandleTokenRequest",
+    "RenameWalletRequest",
+    "RenameWalletResponse",
+    "RenewWalletHandleTokenRequest",
+    "RenewWalletHandleTokenResponse",
+    "SignMultisigResponse",
+    "SignMultisigTxnRequest",
+    "SignProgramMultisigRequest",
+    "SignProgramMultisigResponse",
+    "SignProgramRequest",
+    "SignProgramResponse",
+    "SignTransactionResponse",
+    "SignTxnRequest",
+    "Signature",
+    "TxType",
+    "VersionsRequest",
+    "VersionsResponse",
+    "Wallet",
+    "WalletHandle",
+    "WalletInfoRequest",
+    "WalletInfoResponse",
+]

algokit_kmd_client/models/_classical_signatures.py

@@ -0,0 +1,4 @@
+# AUTO-GENERATED: oas_generator
+
+
+ClassicalSignatures = list[int]

algokit_kmd_client/models/_create_wallet_request.py

@@ -0,0 +1,30 @@
+# AUTO-GENERATED: oas_generator
+
+
+from dataclasses import dataclass, field
+
+from algokit_common.serde import wire
+
+
+@dataclass(slots=True)
+class CreateWalletRequest:
+    """
+    The request for `POST /v1/wallet`
+    """
+
+    wallet_name: str = field(
+        default="",
+        metadata=wire("wallet_name"),
+    )
+    wallet_password: str = field(
+        default="",
+        metadata=wire("wallet_password"),
+    )
+    master_derivation_key: list[int] | None = field(
+        default=None,
+        metadata=wire("master_derivation_key"),
+    )
+    wallet_driver_name: str | None = field(
+        default="sqlite",
+        metadata=wire("wallet_driver_name"),
+    )

algokit_kmd_client/models/_create_wallet_response.py

@@ -0,0 +1,19 @@
+# AUTO-GENERATED: oas_generator
+
+
+from dataclasses import dataclass, field
+
+from algokit_common.serde import nested
+
+from ._wallet import Wallet
+
+
+@dataclass(slots=True)
+class CreateWalletResponse:
+    """
+    CreateWalletResponse is the response to `POST /v1/wallet`
+    """
+
+    wallet: Wallet = field(
+        metadata=nested("wallet", lambda: Wallet, required=True),
+    )

algokit_kmd_client/models/_delete_key_request.py

@@ -0,0 +1,27 @@
+# AUTO-GENERATED: oas_generator
+
+
+from dataclasses import dataclass, field
+
+from algokit_common.constants import ZERO_ADDRESS
+from algokit_common.serde import wire
+
+
+@dataclass(slots=True)
+class DeleteKeyRequest:
+    """
+    The request for `DELETE /v1/key`
+    """
+
+    address: str = field(
+        default=ZERO_ADDRESS,
+        metadata=wire("address"),
+    )
+    wallet_handle_token: str = field(
+        default="",
+        metadata=wire("wallet_handle_token"),
+    )
+    wallet_password: str | None = field(
+        default=None,
+        metadata=wire("wallet_password"),
+    )

algokit_kmd_client/models/_delete_multisig_request.py

@@ -0,0 +1,27 @@
+# AUTO-GENERATED: oas_generator
+
+
+from dataclasses import dataclass, field
+
+from algokit_common.constants import ZERO_ADDRESS
+from algokit_common.serde import wire
+
+
+@dataclass(slots=True)
+class DeleteMultisigRequest:
+    """
+    The request for `DELETE /v1/multisig`
+    """
+
+    address: str = field(
+        default=ZERO_ADDRESS,
+        metadata=wire("address"),
+    )
+    wallet_handle_token: str = field(
+        default="",
+        metadata=wire("wallet_handle_token"),
+    )
+    wallet_password: str | None = field(
+        default=None,
+        metadata=wire("wallet_password"),
+    )

algokit_kmd_client/models/_digest_represents_a32_byte_value_holding_the256_bit_hash_digest.py

@@ -0,0 +1,4 @@
+# AUTO-GENERATED: oas_generator
+
+
+DigestRepresentsA32ByteValueHoldingThe256BitHashDigest = list[int]

algokit_kmd_client/models/_ed25519_public_key.py

@@ -0,0 +1,4 @@
+# AUTO-GENERATED: oas_generator
+
+
+Ed25519PublicKey = list[int]

algokit_kmd_client/models/_export_key_request.py

@@ -0,0 +1,27 @@
+# AUTO-GENERATED: oas_generator
+
+
+from dataclasses import dataclass, field
+
+from algokit_common.constants import ZERO_ADDRESS
+from algokit_common.serde import wire
+
+
+@dataclass(slots=True)
+class ExportKeyRequest:
+    """
+    The request for `POST /v1/key/export`
+    """
+
+    address: str = field(
+        default=ZERO_ADDRESS,
+        metadata=wire("address"),
+    )
+    wallet_handle_token: str = field(
+        default="",
+        metadata=wire("wallet_handle_token"),
+    )
+    wallet_password: str | None = field(
+        default=None,
+        metadata=wire("wallet_password"),
+    )

algokit_kmd_client/models/_export_key_response.py

@@ -0,0 +1,24 @@
+# AUTO-GENERATED: oas_generator
+
+
+from dataclasses import dataclass, field
+
+from algokit_common.serde import wire
+
+from ._serde_helpers import decode_bytes_base64, encode_bytes_base64
+
+
+@dataclass(slots=True)
+class ExportKeyResponse:
+    """
+    ExportKeyResponse is the response to `POST /v1/key/export`
+    """
+
+    private_key: bytes = field(
+        default=b"",
+        metadata=wire(
+            "private_key",
+            encode=encode_bytes_base64,
+            decode=decode_bytes_base64,
+        ),
+    )

algokit_kmd_client/models/_export_master_key_request.py

@@ -0,0 +1,22 @@
+# AUTO-GENERATED: oas_generator
+
+
+from dataclasses import dataclass, field
+
+from algokit_common.serde import wire
+
+
+@dataclass(slots=True)
+class ExportMasterKeyRequest:
+    """
+    The request for `POST /v1/master-key/export`
+    """
+
+    wallet_handle_token: str = field(
+        default="",
+        metadata=wire("wallet_handle_token"),
+    )
+    wallet_password: str | None = field(
+        default=None,
+        metadata=wire("wallet_password"),
+    )

algokit_kmd_client/models/_export_master_key_response.py

@@ -0,0 +1,18 @@
+# AUTO-GENERATED: oas_generator
+
+
+from dataclasses import dataclass, field
+
+from algokit_common.serde import wire
+
+
+@dataclass(slots=True)
+class ExportMasterKeyResponse:
+    """
+    ExportMasterKeyResponse is the response to `POST /v1/master-key/export`
+    """
+
+    master_derivation_key: list[int] = field(
+        default_factory=list,
+        metadata=wire("master_derivation_key"),
+    )

algokit_kmd_client/models/_export_multisig_request.py

@@ -0,0 +1,23 @@
+# AUTO-GENERATED: oas_generator
+
+
+from dataclasses import dataclass, field
+
+from algokit_common.constants import ZERO_ADDRESS
+from algokit_common.serde import wire
+
+
+@dataclass(slots=True)
+class ExportMultisigRequest:
+    """
+    The request for `POST /v1/multisig/export`
+    """
+
+    address: str = field(
+        default=ZERO_ADDRESS,
+        metadata=wire("address"),
+    )
+    wallet_handle_token: str = field(
+        default="",
+        metadata=wire("wallet_handle_token"),
+    )

algokit_kmd_client/models/_export_multisig_response.py

@@ -0,0 +1,26 @@
+# AUTO-GENERATED: oas_generator
+
+
+from dataclasses import dataclass, field
+
+from algokit_common.serde import wire
+
+
+@dataclass(slots=True)
+class ExportMultisigResponse:
+    """
+    ExportMultisigResponse is the response to `POST /v1/multisig/export`
+    """
+
+    multisig_version: int = field(
+        default=0,
+        metadata=wire("multisig_version"),
+    )
+    public_keys: list[list[int]] = field(
+        default_factory=list,
+        metadata=wire("pks"),
+    )
+    threshold: int = field(
+        default=0,
+        metadata=wire("threshold"),
+    )

algokit_kmd_client/models/_generate_key_request.py

@@ -0,0 +1,18 @@
+# AUTO-GENERATED: oas_generator
+
+
+from dataclasses import dataclass, field
+
+from algokit_common.serde import wire
+
+
+@dataclass(slots=True)
+class GenerateKeyRequest:
+    """
+    The request for `POST /v1/key`
+    """
+
+    wallet_handle_token: str = field(
+        default="",
+        metadata=wire("wallet_handle_token"),
+    )

algokit_kmd_client/models/_generate_key_response.py

@@ -0,0 +1,19 @@
+# AUTO-GENERATED: oas_generator
+
+
+from dataclasses import dataclass, field
+
+from algokit_common.constants import ZERO_ADDRESS
+from algokit_common.serde import wire
+
+
+@dataclass(slots=True)
+class GenerateKeyResponse:
+    """
+    GenerateKeyResponse is the response to `POST /v1/key`
+    """
+
+    address: str = field(
+        default=ZERO_ADDRESS,
+        metadata=wire("address"),
+    )

algokit_kmd_client/models/_import_key_request.py

@@ -0,0 +1,28 @@
+# AUTO-GENERATED: oas_generator
+
+
+from dataclasses import dataclass, field
+
+from algokit_common.serde import wire
+
+from ._serde_helpers import decode_bytes_base64, encode_bytes_base64
+
+
+@dataclass(slots=True)
+class ImportKeyRequest:
+    """
+    The request for `POST /v1/key/import`
+    """
+
+    private_key: bytes = field(
+        default=b"",
+        metadata=wire(
+            "private_key",
+            encode=encode_bytes_base64,
+            decode=decode_bytes_base64,
+        ),
+    )
+    wallet_handle_token: str = field(
+        default="",
+        metadata=wire("wallet_handle_token"),
+    )

algokit_kmd_client/models/_import_key_response.py

@@ -0,0 +1,19 @@
+# AUTO-GENERATED: oas_generator
+
+
+from dataclasses import dataclass, field
+
+from algokit_common.constants import ZERO_ADDRESS
+from algokit_common.serde import wire
+
+
+@dataclass(slots=True)
+class ImportKeyResponse:
+    """
+    ImportKeyResponse is the response to `POST /v1/key/import`
+    """
+
+    address: str = field(
+        default=ZERO_ADDRESS,
+        metadata=wire("address"),
+    )

algokit_kmd_client/models/_import_multisig_request.py

@@ -0,0 +1,30 @@
+# AUTO-GENERATED: oas_generator
+
+
+from dataclasses import dataclass, field
+
+from algokit_common.serde import wire
+
+
+@dataclass(slots=True)
+class ImportMultisigRequest:
+    """
+    The request for `POST /v1/multisig/import`
+    """
+
+    multisig_version: int = field(
+        default=0,
+        metadata=wire("multisig_version"),
+    )
+    public_keys: list[list[int]] = field(
+        default_factory=list,
+        metadata=wire("pks"),
+    )
+    threshold: int = field(
+        default=0,
+        metadata=wire("threshold"),
+    )
+    wallet_handle_token: str = field(
+        default="",
+        metadata=wire("wallet_handle_token"),
+    )

algokit_kmd_client/models/_import_multisig_response.py

@@ -0,0 +1,19 @@
+# AUTO-GENERATED: oas_generator
+
+
+from dataclasses import dataclass, field
+
+from algokit_common.constants import ZERO_ADDRESS
+from algokit_common.serde import wire
+
+
+@dataclass(slots=True)
+class ImportMultisigResponse:
+    """
+    ImportMultisigResponse is the response to `POST /v1/multisig/import`
+    """
+
+    address: str = field(
+        default=ZERO_ADDRESS,
+        metadata=wire("address"),
+    )

algokit_kmd_client/models/_init_wallet_handle_token_request.py

@@ -0,0 +1,22 @@
+# AUTO-GENERATED: oas_generator
+
+
+from dataclasses import dataclass, field
+
+from algokit_common.serde import wire
+
+
+@dataclass(slots=True)
+class InitWalletHandleTokenRequest:
+    """
+    The request for `POST /v1/wallet/init`
+    """
+
+    wallet_id: str = field(
+        default="",
+        metadata=wire("wallet_id"),
+    )
+    wallet_password: str = field(
+        default="",
+        metadata=wire("wallet_password"),
+    )

algokit_kmd_client/models/_init_wallet_handle_token_response.py

@@ -0,0 +1,18 @@
+# AUTO-GENERATED: oas_generator
+
+
+from dataclasses import dataclass, field
+
+from algokit_common.serde import wire
+
+
+@dataclass(slots=True)
+class InitWalletHandleTokenResponse:
+    """
+    InitWalletHandleTokenResponse is the response to `POST /v1/wallet/init`
+    """
+
+    wallet_handle_token: str = field(
+        default="",
+        metadata=wire("wallet_handle_token"),
+    )

algokit_kmd_client/models/_list_keys_request.py

@@ -0,0 +1,18 @@
+# AUTO-GENERATED: oas_generator
+
+
+from dataclasses import dataclass, field
+
+from algokit_common.serde import wire
+
+
+@dataclass(slots=True)
+class ListKeysRequest:
+    """
+    The request for `POST /v1/key/list`
+    """
+
+    wallet_handle_token: str = field(
+        default="",
+        metadata=wire("wallet_handle_token"),
+    )