algokit-utils 5.0.0a3__py3-none-any.whl

algokit_utils/transact.py

@@ -0,0 +1,195 @@
+"""Transaction and signing types - user-facing facade for algokit_transact.
+
+Users should import from this module instead of algokit_transact directly.
+"""
+
+from algokit_transact import (
+    # Signer protocols and types
+    Addressable,
+    AddressWithDelegatedLsigSigner,
+    AddressWithMxBytesSigner,
+    AddressWithProgramDataSigner,
+    AddressWithSigners,
+    AddressWithTransactionSigner,
+    # Exceptions
+    AlgokitTransactError,
+    # Transaction field types
+    AppCallTransactionFields,
+    AssetConfigTransactionFields,
+    AssetFreezeTransactionFields,
+    AssetTransferTransactionFields,
+    BoxReference,
+    BytesSigner,
+    DelegatedLsigSigner,
+    # State proof types
+    FalconSignatureStruct,
+    FalconVerifier,
+    HashFactory,
+    HeartbeatProof,
+    HeartbeatTransactionFields,
+    HoldingReference,
+    KeyRegistrationTransactionFields,
+    LocalsReference,
+    # Logic signature
+    LogicSigAccount,
+    LogicSignature,
+    MerkleArrayProof,
+    MerkleSignatureVerifier,
+    # Multisig types
+    MultisigAccount,
+    MultisigMetadata,
+    MultisigSignature,
+    MultisigSubsignature,
+    MxBytesSigner,
+    # Transaction types
+    OnApplicationComplete,
+    Participant,
+    PaymentTransactionFields,
+    ProgramDataSigner,
+    ResourceReference,
+    Reveal,
+    SignedTransaction,
+    SigslotCommit,
+    StateProof,
+    StateProofMessage,
+    StateProofTransactionFields,
+    StateSchema,
+    Transaction,
+    TransactionSigner,
+    TransactionType,
+    TransactionValidationError,
+    # Validation types
+    ValidationIssue,
+    ValidationIssueCode,
+    # Multisig functions
+    address_from_multisig_signature,
+    apply_multisig_subsignature,
+    # Fee functions
+    assign_fee,
+    # Signer functions
+    bytes_to_sign_for_delegation,
+    calculate_fee,
+    # Codec functions
+    decode_logic_signature,
+    decode_signed_transaction,
+    decode_signed_transactions,
+    decode_transaction,
+    decode_transactions,
+    encode_signed_transaction,
+    encode_signed_transactions,
+    encode_transaction,
+    encode_transaction_raw,
+    encode_transactions,
+    estimate_transaction_size,
+    from_transaction_dto,
+    generate_address_with_signers,
+    get_encoded_transaction_type,
+    # ID functions
+    get_transaction_id,
+    get_transaction_id_raw,
+    # Group functions
+    group_transactions,
+    make_basic_account_transaction_signer,
+    make_empty_transaction_signer,
+    merge_multisignatures,
+    new_multisig_signature,
+    participants_from_multisig_signature,
+    program_data_to_sign,
+    # Validation functions
+    sanity_check_program,
+    to_transaction_dto,
+    validate_app_call_fields,
+    validate_asset_config_fields,
+    validate_asset_freeze_fields,
+    validate_asset_transfer_fields,
+    validate_key_registration_fields,
+    validate_transaction,
+)
+
+__all__ = [
+    "AddressWithDelegatedLsigSigner",
+    "AddressWithMxBytesSigner",
+    "AddressWithProgramDataSigner",
+    "AddressWithSigners",
+    "AddressWithTransactionSigner",
+    "Addressable",
+    "AlgokitTransactError",
+    "AppCallTransactionFields",
+    "AssetConfigTransactionFields",
+    "AssetFreezeTransactionFields",
+    "AssetTransferTransactionFields",
+    "BoxReference",
+    "BytesSigner",
+    "DelegatedLsigSigner",
+    "FalconSignatureStruct",
+    "FalconVerifier",
+    "HashFactory",
+    "HeartbeatProof",
+    "HeartbeatTransactionFields",
+    "HoldingReference",
+    "KeyRegistrationTransactionFields",
+    "LocalsReference",
+    "LogicSigAccount",
+    "LogicSignature",
+    "MerkleArrayProof",
+    "MerkleSignatureVerifier",
+    "MultisigAccount",
+    "MultisigMetadata",
+    "MultisigSignature",
+    "MultisigSubsignature",
+    "MxBytesSigner",
+    "OnApplicationComplete",
+    "Participant",
+    "PaymentTransactionFields",
+    "ProgramDataSigner",
+    "ResourceReference",
+    "Reveal",
+    "SignedTransaction",
+    "SigslotCommit",
+    "StateProof",
+    "StateProofMessage",
+    "StateProofTransactionFields",
+    "StateSchema",
+    "Transaction",
+    "TransactionSigner",
+    "TransactionType",
+    "TransactionValidationError",
+    "ValidationIssue",
+    "ValidationIssueCode",
+    "address_from_multisig_signature",
+    "apply_multisig_subsignature",
+    "assign_fee",
+    "bytes_to_sign_for_delegation",
+    "calculate_fee",
+    "decode_logic_signature",
+    "decode_signed_transaction",
+    "decode_signed_transactions",
+    "decode_transaction",
+    "decode_transactions",
+    "encode_signed_transaction",
+    "encode_signed_transactions",
+    "encode_transaction",
+    "encode_transaction_raw",
+    "encode_transactions",
+    "estimate_transaction_size",
+    "from_transaction_dto",
+    "generate_address_with_signers",
+    "get_encoded_transaction_type",
+    "get_transaction_id",
+    "get_transaction_id_raw",
+    "group_transactions",
+    "make_basic_account_transaction_signer",
+    "make_empty_transaction_signer",
+    "merge_multisignatures",
+    "new_multisig_signature",
+    "participants_from_multisig_signature",
+    "program_data_to_sign",
+    "sanity_check_program",
+    "to_transaction_dto",
+    "validate_app_call_fields",
+    "validate_asset_config_fields",
+    "validate_asset_freeze_fields",
+    "validate_asset_transfer_fields",
+    "validate_key_registration_fields",
+    "validate_transaction",
+]

algokit_utils/transactions/__init__.py

@@ -0,0 +1,3 @@
+from algokit_utils.transactions.transaction_composer import *  # noqa: F403
+from algokit_utils.transactions.transaction_creator import *  # noqa: F403
+from algokit_utils.transactions.transaction_sender import *  # noqa: F403

algokit_utils/transactions/builders/__init__.py

@@ -0,0 +1,67 @@
+from .app import (
+    build_app_call_transaction,
+    build_app_create_transaction,
+    build_app_delete_transaction,
+    build_app_method_call_transaction,
+    build_app_update_transaction,
+)
+from .asset import (
+    build_asset_config_transaction,
+    build_asset_create_transaction,
+    build_asset_destroy_transaction,
+    build_asset_freeze_transaction,
+    build_asset_opt_in_transaction,
+    build_asset_opt_out_transaction,
+    build_asset_transfer_transaction,
+)
+from .common import (
+    BuiltTransaction,
+    FeeConfig,
+    SuggestedParamsLike,
+    TransactionHeader,
+    apply_transaction_fees,
+    build_transaction,
+    build_transaction_header,
+    encode_lease,
+)
+from .keyreg import (
+    build_offline_key_registration_transaction,
+    build_online_key_registration_transaction,
+)
+from .method_call import (
+    build_app_call_method_call_transaction,
+    build_app_create_method_call_transaction,
+    build_app_delete_method_call_transaction,
+    build_app_update_method_call_transaction,
+)
+from .payment import build_payment_transaction
+
+__all__ = [
+    "BuiltTransaction",
+    "FeeConfig",
+    "SuggestedParamsLike",
+    "TransactionHeader",
+    "apply_transaction_fees",
+    "build_app_call_method_call_transaction",
+    "build_app_call_transaction",
+    "build_app_create_method_call_transaction",
+    "build_app_create_transaction",
+    "build_app_delete_method_call_transaction",
+    "build_app_delete_transaction",
+    "build_app_method_call_transaction",
+    "build_app_update_method_call_transaction",
+    "build_app_update_transaction",
+    "build_asset_config_transaction",
+    "build_asset_create_transaction",
+    "build_asset_destroy_transaction",
+    "build_asset_freeze_transaction",
+    "build_asset_opt_in_transaction",
+    "build_asset_opt_out_transaction",
+    "build_asset_transfer_transaction",
+    "build_offline_key_registration_transaction",
+    "build_online_key_registration_transaction",
+    "build_payment_transaction",
+    "build_transaction",
+    "build_transaction_header",
+    "encode_lease",
+]

algokit_utils/transactions/builders/app.py

@@ -0,0 +1,248 @@
+from collections.abc import Sequence
+
+from algokit_transact.models.app_call import AppCallTransactionFields
+from algokit_transact.models.app_call import BoxReference as TxBoxReference
+from algokit_transact.models.common import OnApplicationComplete, StateSchema
+from algokit_transact.models.transaction import TransactionType
+from algokit_utils.applications.app_manager import AppManager
+from algokit_utils.models.state import BoxIdentifier, BoxReference
+from algokit_utils.transactions.builders.common import (
+    BuiltTransaction,
+    SuggestedParamsLike,
+    apply_transaction_fees,
+    build_transaction,
+    build_transaction_header,
+)
+from algokit_utils.transactions.helpers import calculate_extra_program_pages
+from algokit_utils.transactions.types import (
+    AppCallParams,
+    AppCreateParams,
+    AppCreateSchema,
+    AppDeleteParams,
+    AppMethodCallParams,
+    AppUpdateParams,
+)
+
+AppParams = AppCallParams | AppCreateParams | AppDeleteParams | AppMethodCallParams | AppUpdateParams
+
+__all__ = [
+    "build_app_call_transaction",
+    "build_app_create_transaction",
+    "build_app_delete_transaction",
+    "build_app_method_call_transaction",
+    "build_app_update_transaction",
+]
+
+
+def build_app_create_transaction(
+    params: AppCreateParams,
+    suggested_params: SuggestedParamsLike,
+    *,
+    app_manager: AppManager,
+    default_validity_window: int,
+    default_validity_window_is_explicit: bool,
+    is_localnet: bool,
+) -> BuiltTransaction:
+    approval = _compile_program(app_manager, params.approval_program)
+    clear = _compile_program(app_manager, params.clear_state_program)
+
+    schema = params.schema or AppCreateSchema(
+        global_ints=0,
+        global_byte_slices=0,
+        local_ints=0,
+        local_byte_slices=0,
+    )
+    global_schema = StateSchema(num_uints=schema["global_ints"], num_byte_slices=schema["global_byte_slices"])
+    local_schema = StateSchema(num_uints=schema["local_ints"], num_byte_slices=schema["local_byte_slices"])
+
+    fields = _build_app_call_fields(
+        params,
+        app_id=0,
+        approval_program=approval,
+        clear_state_program=clear,
+        global_state_schema=global_schema,
+        local_state_schema=local_schema,
+        extra_program_pages=params.extra_program_pages or calculate_extra_program_pages(approval, clear),
+        app_manager=app_manager,
+    )
+    return _build_app_transaction(
+        params=params,
+        suggested_params=suggested_params,
+        fields=fields,
+        default_validity_window=default_validity_window,
+        default_validity_window_is_explicit=default_validity_window_is_explicit,
+        is_localnet=is_localnet,
+    )
+
+
+def build_app_update_transaction(
+    params: AppUpdateParams,
+    suggested_params: SuggestedParamsLike,
+    *,
+    app_manager: AppManager,
+    default_validity_window: int,
+    default_validity_window_is_explicit: bool,
+    is_localnet: bool,
+) -> BuiltTransaction:
+    approval = _compile_program(app_manager, params.approval_program)
+    clear = _compile_program(app_manager, params.clear_state_program)
+    fields = _build_app_call_fields(
+        params,
+        app_id=params.app_id,
+        approval_program=approval,
+        clear_state_program=clear,
+        app_manager=app_manager,
+    )
+    return _build_app_transaction(
+        params=params,
+        suggested_params=suggested_params,
+        fields=fields,
+        default_validity_window=default_validity_window,
+        default_validity_window_is_explicit=default_validity_window_is_explicit,
+        is_localnet=is_localnet,
+    )
+
+
+def build_app_delete_transaction(
+    params: AppDeleteParams,
+    suggested_params: SuggestedParamsLike,
+    *,
+    app_manager: AppManager,
+    default_validity_window: int,
+    default_validity_window_is_explicit: bool,
+    is_localnet: bool,
+) -> BuiltTransaction:
+    fields = _build_app_call_fields(
+        params,
+        app_id=params.app_id,
+        app_manager=app_manager,
+    )
+    return _build_app_transaction(
+        params=params,
+        suggested_params=suggested_params,
+        fields=fields,
+        default_validity_window=default_validity_window,
+        default_validity_window_is_explicit=default_validity_window_is_explicit,
+        is_localnet=is_localnet,
+    )
+
+
+def build_app_call_transaction(
+    params: AppCallParams,
+    suggested_params: SuggestedParamsLike,
+    *,
+    app_manager: AppManager,
+    default_validity_window: int,
+    default_validity_window_is_explicit: bool,
+    is_localnet: bool,
+) -> BuiltTransaction:
+    fields = _build_app_call_fields(
+        params,
+        app_id=params.app_id,
+        app_manager=app_manager,
+    )
+    return _build_app_transaction(
+        params=params,
+        suggested_params=suggested_params,
+        fields=fields,
+        default_validity_window=default_validity_window,
+        default_validity_window_is_explicit=default_validity_window_is_explicit,
+        is_localnet=is_localnet,
+    )
+
+
+def build_app_method_call_transaction(
+    params: AppMethodCallParams,
+    suggested_params: SuggestedParamsLike,
+    *,
+    app_manager: AppManager,
+    default_validity_window: int,
+    default_validity_window_is_explicit: bool,
+    is_localnet: bool,
+) -> BuiltTransaction:
+    fields = _build_app_call_fields(
+        params,
+        app_id=params.app_id,
+        app_manager=app_manager,
+    )
+    return _build_app_transaction(
+        params=params,
+        suggested_params=suggested_params,
+        fields=fields,
+        default_validity_window=default_validity_window,
+        default_validity_window_is_explicit=default_validity_window_is_explicit,
+        is_localnet=is_localnet,
+    )
+
+
+def _build_app_transaction(
+    params: AppParams,
+    suggested_params: SuggestedParamsLike,
+    *,
+    fields: AppCallTransactionFields,
+    default_validity_window: int,
+    default_validity_window_is_explicit: bool,
+    is_localnet: bool,
+) -> BuiltTransaction:
+    header, fee_config = build_transaction_header(
+        params,
+        suggested_params,
+        default_validity_window=default_validity_window,
+        default_validity_window_is_explicit=default_validity_window_is_explicit,
+        is_localnet=is_localnet,
+    )
+    txn = build_transaction(TransactionType.AppCall, header, application_call=fields)
+    return apply_transaction_fees(txn, params, fee_config)
+
+
+def _build_app_call_fields(
+    params: AppParams,
+    *,
+    app_id: int,
+    app_manager: AppManager,
+    approval_program: bytes | None = None,
+    clear_state_program: bytes | None = None,
+    global_state_schema: StateSchema | None = None,
+    local_state_schema: StateSchema | None = None,
+    extra_program_pages: int | None = None,
+) -> AppCallTransactionFields:
+    return AppCallTransactionFields(
+        app_id=app_id,
+        on_complete=params.on_complete or OnApplicationComplete.NoOp,
+        approval_program=approval_program,
+        clear_state_program=clear_state_program,
+        global_state_schema=global_state_schema,
+        local_state_schema=local_state_schema,
+        args=_to_tuple(params.args),
+        account_references=_to_tuple(params.account_references),
+        app_references=_to_tuple(params.app_references),
+        asset_references=_to_tuple(params.asset_references),
+        extra_program_pages=extra_program_pages,
+        box_references=_convert_box_references(params.box_references, app_manager),
+    )
+
+
+def _compile_program(app_manager: AppManager, program: bytes | str) -> bytes:
+    if isinstance(program, bytes):
+        return program
+    compiled = app_manager.compile_teal(program)
+    return compiled.compiled_base64_to_bytes
+
+
+def _to_tuple(items: Sequence | None) -> list | None:
+    if not items:
+        return None
+    return list(items)
+
+
+def _convert_box_references(
+    box_refs: list[BoxReference | BoxIdentifier] | None,
+    app_manager: AppManager,
+) -> list[TxBoxReference] | None:
+    if not box_refs:
+        return None
+    converted: list[TxBoxReference] = []
+    for ref in box_refs:
+        app_id, name = app_manager.get_box_reference(ref)
+        converted.append(TxBoxReference(app_id=app_id, name=name))
+    return converted if converted else None