Skip to content
AlgoKit Utils Python

algokit_utils.protocols.typed_clients

algokit_utils.protocols.typed_clients

Section titled “algokit_utils.protocols.typed_clients”

Classes

Section titled “Classes”
TypedAppClientProtocolApp Client protocol
TypedAppFactoryProtocolApp factory protocol

Module Contents

Section titled “Module Contents”

class TypedAppClientProtocol(*, app_id: int, app_name: str | None = None, default_sender: str | None = None, default_signer: TransactionSigner | None = None, algorand: AlgorandClient, approval_source_map: ProgramSourceMap | None = None, clear_source_map: ProgramSourceMap | None = None)

Section titled “class TypedAppClientProtocol(*, app_id: int, app_name: str | None = None, default_sender: str | None = None, default_signer: TransactionSigner | None = None, algorand: AlgorandClient, approval_source_map: ProgramSourceMap | None = None, clear_source_map: ProgramSourceMap | None = None)”

Bases: Protocol

App Client protocol

classmethod from_creator_and_name(*, creator_address: str, app_name: str, default_sender: str | None = None, default_signer: TransactionSigner | None = None, ignore_cache: bool | None = None, app_lookup_cache: ApplicationLookup | None = None, algorand: AlgorandClient) → Self

Section titled “classmethod from_creator_and_name(*, creator_address: str, app_name: str, default_sender: str | None = None, default_signer: TransactionSigner | None = None, ignore_cache: bool | None = None, app_lookup_cache: ApplicationLookup | None = None, algorand: AlgorandClient) → Self”

classmethod from_network(*, app_name: str | None = None, default_sender: str | None = None, default_signer: TransactionSigner | None = None, approval_source_map: ProgramSourceMap | None = None, clear_source_map: ProgramSourceMap | None = None, algorand: AlgorandClient) → Self

Section titled “classmethod from_network(*, app_name: str | None = None, default_sender: str | None = None, default_signer: TransactionSigner | None = None, approval_source_map: ProgramSourceMap | None = None, clear_source_map: ProgramSourceMap | None = None, algorand: AlgorandClient) → Self”

class TypedAppFactoryProtocol(algorand: AlgorandClient, **kwargs: Any)

Section titled “class TypedAppFactoryProtocol(algorand: AlgorandClient, **kwargs: Any)”

Bases: Protocol, Generic[CreateParamsT, UpdateParamsT, DeleteParamsT]

App factory protocol

deploy(*, on_update: OnUpdate | None = None, on_schema_break: OnSchemaBreak | None = None, create_params: CreateParamsT | None = None, update_params: UpdateParamsT | None = None, delete_params: DeleteParamsT | None = None, existing_deployments: ApplicationLookup | None = None, ignore_cache: bool = False, app_name: str | None = None, send_params: SendParams | None = None, compilation_params: AppClientCompilationParams | None = None) → tuple[TypedAppClientProtocol, AppFactoryDeployResult]

Section titled “deploy(*, on_update: OnUpdate | None = None, on_schema_break: OnSchemaBreak | None = None, create_params: CreateParamsT | None = None, update_params: UpdateParamsT | None = None, delete_params: DeleteParamsT | None = None, existing_deployments: ApplicationLookup | None = None, ignore_cache: bool = False, app_name: str | None = None, send_params: SendParams | None = None, compilation_params: AppClientCompilationParams | None = None) → tuple[TypedAppClientProtocol, AppFactoryDeployResult]”