algokit-utils 4.0.2b1__py3-none-any.whl → 4.1.0b1__py3-none-any.whl

algokit_utils/__init__.py

@@ -9,6 +9,10 @@ For more specific functionality, import directly from the relevant submodules:
     etc.
 """
 
+import importlib.util
+
+_EXPERIMENTAL_DEPENDENCIES_INSTALLED: bool | None = importlib.util.find_spec("algokit_algod_api") is not None
+
 # Core types and utilities that are commonly used
 from algokit_utils.applications import *  # noqa: F403
 from algokit_utils.assets import *  # noqa: F403

algokit_utils/clients/_algokit_core_bridge.py

@@ -0,0 +1,52 @@
+import base64
+from collections.abc import Iterable
+
+from algosdk.encoding import msgpack_encode
+from algosdk.transaction import GenericSignedTransaction
+from algosdk.v2client.algod import AlgodClient
+
+from algokit_utils import _EXPERIMENTAL_DEPENDENCIES_INSTALLED
+
+if not _EXPERIMENTAL_DEPENDENCIES_INSTALLED:
+    raise ImportError(
+        "Installing experimental dependencies is necessary to use AlgodClientWithCore. "
+        "Install this package with --group=experimental"
+    )
+
+import algokit_algod_api
+
+
+class AlgodClientWithCore:
+    """
+    A decorator for AlgodClient that extends its functionality with algokit_algod_api capabilities.
+    This class wraps an AlgodClient instance while maintaining the same interface.
+    """
+
+    def __init__(self, algod_client: AlgodClient):
+        self._algod_client = algod_client
+
+        configuration = algokit_algod_api.Configuration(
+            host=algod_client.algod_address, api_key={"api_key": self._algod_client.algod_token}
+        )
+        api_client = algokit_algod_api.ApiClient(configuration)
+        self._algod_core_client = algokit_algod_api.AlgodApi(api_client=api_client)
+
+    def send_raw_transaction(self, txn):
+        """
+        Override the method to send a raw transaction using algokit_algod_api.
+        """
+        return self._algod_core_client.raw_transaction(base64.b64decode(txn))
+
+    def send_transactions(self, txns: Iterable[GenericSignedTransaction]):
+        """
+        Override the method to send multiple transactions using algokit_algod_api.
+        """
+        return self.send_raw_transaction(
+            base64.b64encode(b"".join(base64.b64decode(msgpack_encode(txn)) for txn in txns))
+        )
+
+    def __getattr__(self, name):
+        """
+        Delegate all other method calls to the wrapped AlgodClient instance.
+        """
+        return getattr(self._algod_client, name)

algokit_utils/clients/client_manager.py

@@ -13,6 +13,7 @@ from algosdk.transaction import SuggestedParams
 from algosdk.v2client.algod import AlgodClient
 from algosdk.v2client.indexer import IndexerClient
 
+from algokit_utils import _EXPERIMENTAL_DEPENDENCIES_INSTALLED
 from algokit_utils._legacy_v2.application_specification import ApplicationSpecification
 from algokit_utils.applications.app_deployer import ApplicationLookup
 from algokit_utils.applications.app_spec.arc56 import Arc56Contract
@@ -119,7 +120,12 @@ class ClientManager:
                 if clients_or_configs.kmd_config
                 else None,
             )
-        self._algod = _clients.algod
+        if not _EXPERIMENTAL_DEPENDENCIES_INSTALLED:
+            self._algod = _clients.algod
+        else:
+            from algokit_utils.clients._algokit_core_bridge import AlgodClientWithCore
+
+            self._algod = AlgodClientWithCore(_clients.algod)  # type: ignore[assignment]
         self._indexer = _clients.indexer
         self._kmd = _clients.kmd
         self._algorand = algorand_client

algokit_utils/errors/logic_error.py

@@ -33,7 +33,7 @@ class LogicErrorData(TypedDict):
 def parse_logic_error(
     error_str: str,
 ) -> LogicErrorData | None:
-    match = re.match(LOGIC_ERROR, error_str)
+    match = re.search(LOGIC_ERROR, error_str, re.DOTALL)
     if match is None:
         return None
 

algokit_utils/transactions/_algokit_core_bridge.py

@@ -0,0 +1,76 @@
+import base64
+from typing import cast
+
+import algosdk.transaction
+from algokit_transact import (
+    FeeParams,
+    PaymentTransactionFields,
+    Transaction,
+    TransactionType,
+    address_from_string,
+    assign_fee,
+    encode_transaction_raw,
+)
+
+
+def build_payment_with_core(  # noqa: PLR0913
+    sender,
+    sp,
+    receiver,
+    amt,
+    close_remainder_to=None,
+    note=None,
+    lease=None,
+    rekey_to=None,
+    static_fee=None,
+    max_fee=None,
+    extra_fee=None,
+) -> algosdk.transaction.PaymentTxn:
+    # Determine static fee based on parameters or suggested params
+    static_fee_value = None
+    if static_fee is not None:
+        static_fee_value = static_fee
+    elif sp.flat_fee:
+        static_fee_value = sp.fee
+
+    txn = Transaction(
+        transaction_type=TransactionType.PAYMENT,
+        sender=address_from_string(sender),
+        fee=static_fee_value,
+        first_valid=sp.first,
+        last_valid=sp.last,
+        genesis_hash=base64.b64decode(sp.gh),
+        genesis_id=sp.gen,
+        note=note,
+        lease=lease,
+        rekey_to=address_from_string(rekey_to) if rekey_to else None,
+        payment=PaymentTransactionFields(
+            receiver=address_from_string(receiver),
+            amount=amt,
+            close_remainder_to=address_from_string(close_remainder_to) if close_remainder_to else None,
+        ),
+    )
+
+    if txn.fee is not None:
+        # Static fee is already set, encode and return directly
+        return cast(
+            algosdk.transaction.PaymentTxn,
+            algosdk.encoding.msgpack_decode(base64.b64encode(encode_transaction_raw(txn)).decode("utf-8")),
+        )
+    else:
+        # Use assign_fee with fee parameters
+        min_fee = sp.min_fee or algosdk.constants.MIN_TXN_FEE
+        txn_with_fee = assign_fee(
+            txn,
+            FeeParams(
+                fee_per_byte=sp.fee,
+                min_fee=min_fee,
+                max_fee=max_fee,
+                extra_fee=extra_fee,
+            ),
+        )
+
+        return cast(
+            algosdk.transaction.PaymentTxn,
+            algosdk.encoding.msgpack_decode(base64.b64encode(encode_transaction_raw(txn_with_fee)).decode("utf-8")),
+        )

algokit_utils/transactions/transaction_composer.py

@@ -22,6 +22,7 @@ from algosdk.v2client.algod import AlgodClient
 from algosdk.v2client.models.simulate_request import SimulateRequest
 from typing_extensions import deprecated
 
+from algokit_utils import _EXPERIMENTAL_DEPENDENCIES_INSTALLED
 from algokit_utils.applications.abi import ABIReturn, ABIValue
 from algokit_utils.applications.app_manager import AppManager
 from algokit_utils.applications.app_spec.arc56 import Method as Arc56Method
@@ -30,6 +31,9 @@ from algokit_utils.models.state import BoxIdentifier, BoxReference
 from algokit_utils.models.transaction import SendParams, TransactionWrapper
 from algokit_utils.protocols.account import TransactionSignerAccountProtocol
 
+if _EXPERIMENTAL_DEPENDENCIES_INSTALLED:
+    from algokit_utils.transactions._algokit_core_bridge import build_payment_with_core
+
 if TYPE_CHECKING:
     from collections.abc import Callable
 
@@ -1861,6 +1865,17 @@ class TransactionComposer:
             )
         except algosdk.error.AlgodHTTPError as e:
             raise Exception(f"Transaction failed: {e}") from e
+        # We need this code to handle separately an exception thrown by the experimental AlgoKit Algod Client.
+        # However, we can't just import the dependency (as it may not be there) and
+        # we still need to re-throw the exception in all other cases.
+        except Exception as e:
+            if _EXPERIMENTAL_DEPENDENCIES_INSTALLED:
+                from algokit_algod_api.exceptions import BadRequestException
+
+                if isinstance(e, BadRequestException):
+                    raise Exception(f"Transaction failed: {e}") from e
+                raise e
+            raise e
 
     def _handle_simulate_error(self, simulate_response: SimulateAtomicTransactionResponse) -> None:
         # const failedGroup = simulateResponse?.txnGroups[0]
@@ -2250,7 +2265,10 @@ class TransactionComposer:
             "close_remainder_to": params.close_remainder_to,
         }
 
-        return self._common_txn_build_step(lambda x: algosdk.transaction.PaymentTxn(**x), params, txn_params)
+        if _EXPERIMENTAL_DEPENDENCIES_INSTALLED:
+            return self._common_txn_build_step(lambda x: build_payment_with_core(**x), params, txn_params)
+        else:
+            return self._common_txn_build_step(lambda x: algosdk.transaction.PaymentTxn(**x), params, txn_params)
 
     def _build_asset_create(
         self, params: AssetCreateParams, suggested_params: algosdk.transaction.SuggestedParams

{algokit_utils-4.0.2b1.dist-info → algokit_utils-4.1.0b1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: algokit-utils
-Version: 4.0.2b1
+Version: 4.1.0b1
 Summary: Utilities for Algorand development for use by AlgoKit
 License: MIT
 Author: Algorand Foundation

{algokit_utils-4.0.2b1.dist-info → algokit_utils-4.1.0b1.dist-info}/RECORD

@@ -1,4 +1,4 @@
-algokit_utils/__init__.py,sha256=he0sKUGvOgN2ROlXJ_6GOBqElfoDy3c5_XgVA3BYACU,1039
+algokit_utils/__init__.py,sha256=G7rlh_8PtTQMZpL3Ja0_qTT2gN6D_rG8AiAFmFBqzMM,1173
 algokit_utils/_debugging.py,sha256=nAiC10WXiZsvc0RPWOrMLpjJQZT_ItgcMl7D9Z4DfYc,11703
 algokit_utils/_legacy_v2/__init__.py,sha256=WcRE30axWjGnBB09bJCeTw9NT-2_jDN_CVJITFcIDc8,4689
 algokit_utils/_legacy_v2/_ensure_funded.py,sha256=k52b56CfWttPiu2gy09HIEiXl0eIz5WKQy-iuhxpSQg,6909
@@ -38,14 +38,15 @@ algokit_utils/beta/algorand_client.py,sha256=xDFvsMSha0Ki42BGvKvfScQWT_W9y4GeP_R
 algokit_utils/beta/client_manager.py,sha256=xDFvsMSha0Ki42BGvKvfScQWT_W9y4GeP_RWXjc3vnE,213
 algokit_utils/beta/composer.py,sha256=xDFvsMSha0Ki42BGvKvfScQWT_W9y4GeP_RWXjc3vnE,213
 algokit_utils/clients/__init__.py,sha256=qUuKBvfLnw4z6ZU9x7mc-mLjfnnXC9UcvtoeU33ZLJ8,136
-algokit_utils/clients/client_manager.py,sha256=eTkgaDVRl-auRnd_t3tQQzdrpLky6I1rQLR_1ZUXmrw,28615
+algokit_utils/clients/_algokit_core_bridge.py,sha256=qFgkcuYlf2Lw-2uZFA-TORPWU5CY02t6tS8mOvh9lfc,1882
+algokit_utils/clients/client_manager.py,sha256=p0pGx3rMrCR698L8cZVR0yNq21Y7j856vIjtiFlwV7s,28927
 algokit_utils/clients/dispenser_api_client.py,sha256=3TgbnQsDmC9zSfDIykwNKDadbXLhQKZxUSbPwTDJISY,7336
 algokit_utils/common.py,sha256=5wl83vWw91RYdEC4hTTufqaptKiFtgjKLIyONDmRSH0,300
 algokit_utils/config.py,sha256=CvDH5B8uPWnm6wCHHlMsl-0lONzq26vPLvwmnbw7c-k,6048
 algokit_utils/deploy.py,sha256=UUtSDI6JcBUuto62FuirhUlDcjZwQyLkiERgDMx8P7A,330
 algokit_utils/dispenser_api.py,sha256=-EO4Dq3q_v4kSMey43kXJfoX8uCBPJpjEMTlLI7xn_I,324
 algokit_utils/errors/__init__.py,sha256=CmuiLVjzMAOYxPaIIwmYCNArsso_RtS2ssFoNdp5CMs,61
-algokit_utils/errors/logic_error.py,sha256=uxqUOU9-D1R5TrKturCbmmWRVlB024Ca4CfVi8x_sgo,4104
+algokit_utils/errors/logic_error.py,sha256=iDCyPTSK_aP8Pzjk-7PDcWqC1R764IJks6tle-d7znc,4116
 algokit_utils/logic_error.py,sha256=3duw-l6tBr-DeapO0e0tYHoa9rOxP-QZZ6QWmN8L9tc,305
 algokit_utils/models/__init__.py,sha256=0aB_c5pnkqKl1Z0hkxM9qbKn2qVdizZE2DvziN9ObqM,465
 algokit_utils/models/account.py,sha256=eqGJvExzd7gDm3--DBDaIq6pJarxMPHZ-UySxZ9Qznk,6778
@@ -61,10 +62,11 @@ algokit_utils/protocols/account.py,sha256=CowaVY7ErBP84TWBHNvBjkZy18whPb8HIlMZtJ
 algokit_utils/protocols/typed_clients.py,sha256=UrQrHbN2SvS8pEFJ8JQodvouoWeBrQOQGZGyBQx1KLM,3322
 algokit_utils/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 algokit_utils/transactions/__init__.py,sha256=7fYF3m6DyOGzbV36MT5svo0wSkj9AIz496kWgIWSAlk,225
-algokit_utils/transactions/transaction_composer.py,sha256=eK-6l2W1CkbKID1ezi-zCs_TxA2i5ZTm3YTl8sT2Zfw,103995
+algokit_utils/transactions/_algokit_core_bridge.py,sha256=Q9Mf86fo-mOVu-8i1MeA91AkwhBnEjsx-4w3uVoY5dg,2191
+algokit_utils/transactions/transaction_composer.py,sha256=yHpL9FqYEFevh3WRIwHcBZ2ukEXPFmkzYK8nJev83i4,104959
 algokit_utils/transactions/transaction_creator.py,sha256=cuP6Xm-fhGoCc2FNSbLiEg3iQRwW38rfdTzsqPyEcpM,29053
 algokit_utils/transactions/transaction_sender.py,sha256=4u2FON3YM4_DKPde6gSkZFAH1wp7FC8E65HpQ803RNo,50056
-algokit_utils-4.0.2b1.dist-info/LICENSE,sha256=J5i7U1Q9Q2c7saUzlvFRmrCCFhQyXb5Juz_LO5omNUw,1076
-algokit_utils-4.0.2b1.dist-info/METADATA,sha256=_voF9wDpeJ2vIPFXZixsmX6V8F2bFDthSwR4NLOKQ-o,2421
-algokit_utils-4.0.2b1.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
-algokit_utils-4.0.2b1.dist-info/RECORD,,
+algokit_utils-4.1.0b1.dist-info/LICENSE,sha256=J5i7U1Q9Q2c7saUzlvFRmrCCFhQyXb5Juz_LO5omNUw,1076
+algokit_utils-4.1.0b1.dist-info/METADATA,sha256=BJDqaXQJcgIC_Kw-yVTv9W0h9bpvvItguxwNMbQYv8Q,2421
+algokit_utils-4.1.0b1.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+algokit_utils-4.1.0b1.dist-info/RECORD,,