refactor: update algokit utils dependency to v5

Author: boblat

pyproject.toml

@@ -55,7 +55,7 @@ dependencies = [
     "pytest-mock>=3.10.0",
     "pytest-xdist[psutil]>=3.3",
     "py-algorand-sdk>=2.4.0",
-    "algokit-utils>=4.0.0",
+    "algokit-utils>=5.0.0a5",
     "pytest-cov>=4.1.0",
     "prettytable>=3.9.0",
     "mypy==1.10",
@@ -131,7 +131,7 @@ dependencies = [
     "pytest-xdist[psutil]>=3.3",
     "pytest-cov>=4.1.0",
     "py-algorand-sdk>=2.4.0",
-    "algokit-utils>=4.0.0",
+    "algokit-utils>=5.0.0a5",
     "puyapy>=5",
 ]
 
@@ -188,7 +188,7 @@ dependencies = [
     "pytest-mock>=3.10.0",
     "pytest-xdist[psutil]>=3.3",
     "py-algorand-sdk>=2.4.0",
-    "algokit-utils>=4.0.0",
+    "algokit-utils>=5.0.0a5",
     "pytest-cov>=4.1.0",
     "mypy==1.10",
 ]

tests/arc4/test_arc4_method_signature.py

@@ -9,7 +9,6 @@
 import pytest
 from algokit_utils import AlgoAmount, AlgorandClient, AssetCreateParams, PaymentParams
 from algopy import arc4
-from algosdk.atomic_transaction_composer import TransactionWithSigner
 
 from tests.artifacts.Arc4ABIMethod.contract import (
     AnotherStruct,
@@ -43,10 +42,8 @@ def funded_account(algorand: AlgorandClient, context: _algopy_testing.AlgopyTest
         min_spending_balance=algokit_utils.AlgoAmount(micro_algo=_FUNDED_ACCOUNT_SPENDING),
     )
     # ensure context has the same account with matching balance
-    context.any.account(
-        account.address, balance=algopy.Global.min_balance + _FUNDED_ACCOUNT_SPENDING
-    )
-    return account.address
+    context.any.account(account.addr, balance=algopy.Global.min_balance + _FUNDED_ACCOUNT_SPENDING)
+    return account.addr
 
 
 @pytest.fixture()
@@ -130,15 +127,13 @@ def test_app_args_is_correct_with_txn(
     get_avm_result(
         "with_txn",
         value="hello",
-        pay=TransactionWithSigner(
-            txn=algorand.create_transaction.payment(
-                PaymentParams(
-                    sender=localnet_creator_address,
-                    receiver=localnet_creator_address,
-                    amount=AlgoAmount(micro_algo=123),
-                )
-            ),
-            signer=algorand.account.get_signer(localnet_creator_address),
+        pay=algorand.create_transaction.payment(
+            PaymentParams(
+                sender=localnet_creator_address,
+                receiver=localnet_creator_address,
+                amount=AlgoAmount(micro_algo=123),
+                signer=algorand.account.get_signer(localnet_creator_address),
+            )
         ),
         arr=[1, 2],
     )
@@ -174,9 +169,7 @@ def test_app_args_is_correct_with_asset(
             sender=localnet_creator_address,
             total=123,
         )
-    ).confirmation[
-        "asset-index"
-    ]  # type: ignore[call-overload]
+    ).asset_id
 
     # act
     get_avm_result("with_asset", value="hello", asset=asa_id, arr=[1, 2])
@@ -343,15 +336,13 @@ def test_prepare_txns_with_complex(
     get_avm_result(
         "complex_sig",
         struct1=((1, "2"), (1, "2"), 3, 4),
-        txn=TransactionWithSigner(
-            txn=algorand.create_transaction.payment(
-                PaymentParams(
-                    sender=localnet_creator_address,
-                    receiver=localnet_creator_address,
-                    amount=AlgoAmount(micro_algo=123),
-                )
+        txn=algorand.create_transaction.payment(
+            PaymentParams(
+                sender=localnet_creator_address,
+                receiver=localnet_creator_address,
+                amount=AlgoAmount(micro_algo=123),
+                signer=algorand.account.get_signer(localnet_creator_address),
             ),
-            signer=algorand.account.get_signer(localnet_creator_address),
         ),
         acc=funded_account,
         five=[5],
@@ -394,9 +385,7 @@ def test_app_args_is_correct_with_index_resource_encoding(  # noqa: PLR0913
             sender=localnet_creator_address,
             total=123,
         )
-    ).confirmation[
-        "asset-index"
-    ]  # type: ignore[call-overload]
+    ).asset_id
 
     # act
     contract.echo_resource_by_index(
@@ -424,7 +413,7 @@ def test_app_args_is_correct_with_index_resource_encoding(  # noqa: PLR0913
     ]
     assert app_args[0] == arc4.arc4_signature(SignaturesContract.echo_resource_by_index)
 
-    assert result == [asa_id, other_app_id, funded_account]
+    assert result == (asa_id, other_app_id, funded_account)
 
 
 def test_app_args_is_correct_with_value_resource_encoding(  # noqa: PLR0913
@@ -444,9 +433,7 @@ def test_app_args_is_correct_with_value_resource_encoding(  # noqa: PLR0913
             sender=localnet_creator_address,
             total=123,
         )
-    ).confirmation[
-        "asset-index"
-    ]  # type: ignore[call-overload]
+    ).asset_id
 
     asset = context.any.asset(asset_id=asa_id, total=algopy.UInt64(123))
     app = context.ledger.get_app(other_app_id)
@@ -477,4 +464,4 @@ def test_app_args_is_correct_with_value_resource_encoding(  # noqa: PLR0913
     ]
     assert app_args[0] == arc4.arc4_signature(SignaturesContract.echo_resource_by_value)
 
-    assert result == [asset.id, app.id, acc]
+    assert result == (asset.id, app.id, acc)

tests/arc4/test_emit.py

@@ -1,4 +1,3 @@
-import base64
 import typing
 from collections.abc import Generator
 
@@ -83,7 +82,7 @@ def test_emit(get_avm_result: AVMInvoker, context: AlgopyTestContext) -> None:
             arc4.DynamicArray(arc4.UInt16(1), arc4.UInt16(2), arc4.UInt16(3)),
             arc4.Tuple((arc4.UInt32(1), arc4.UInt64(2), arc4.String("hello"))),
         )
-        avm_result_ = get_avm_result(
+        avm_result = get_avm_result(
             "verify_emit",
             a=_test_data.a.value,
             b=_test_data.b,
@@ -102,8 +101,7 @@ def test_emit(get_avm_result: AVMInvoker, context: AlgopyTestContext) -> None:
             s=_test_data_arc4.s.bytes.value,
             t=_test_data_arc4.t.bytes.value,
         )
-        assert isinstance(avm_result_, list)
-        avm_result = [base64.b64decode(b) for b in avm_result_]
+        assert isinstance(avm_result, list)
 
         arc4.emit(_test_data_arc4)
         arc4.emit(

tests/arc4/test_ufixednxm.py

@@ -1,4 +1,5 @@
 import typing
+from decimal import Decimal
 
 import algokit_utils
 import pytest
@@ -11,7 +12,7 @@
 
 
 def _invalid_bytes_length_error(length: int) -> str:
-    return f"value string must be in bytes and correspond to a ufixed{length}"
+    return f"expected {length // 8} bytes for uint{length}"
 
 
 @pytest.mark.parametrize(
@@ -71,7 +72,7 @@ def test_bigufixednxm_bytes(get_avm_result: AVMInvoker, value: str) -> None:
 def test_ufixednxm_from_bytes(get_avm_result: AVMInvoker, value: bytes) -> None:
     avm_result = get_avm_result("verify_ufixednxm_from_bytes", a=value)
     result = arc4.UFixedNxM[typing.Literal[32], typing.Literal[8]].from_bytes(value)
-    assert avm_result == int.from_bytes(result.bytes.value)
+    assert avm_result == int_to_decimal(int.from_bytes(result.bytes.value), 32, 8)
 
 
 @pytest.mark.parametrize(
@@ -103,7 +104,8 @@ def test_ufixednxm_from_bytes_invalid_length(get_avm_result: AVMInvoker, value:
 def test_bigufixednxm_from_bytes(get_avm_result: AVMInvoker, value: bytes) -> None:
     avm_result = get_avm_result("verify_bigufixednxm_from_bytes", a=value)
     result = arc4.BigUFixedNxM[typing.Literal[256], typing.Literal[16]].from_bytes(value)
-    assert avm_result == int.from_bytes(result.bytes.value)
+
+    assert avm_result == int_to_decimal(int.from_bytes(result.bytes.value), 256, 16)
 
 
 @pytest.mark.parametrize(
@@ -137,8 +139,8 @@ def test_ufixednxm_from_log(get_avm_result: AVMInvoker, value: bytes, expected:
     result = arc4.UFixedNxM[typing.Literal[32], typing.Literal[8]].from_log(
         Bytes(ARC4_RETURN_PREFIX + value)
     )
-    assert avm_result == expected
-    assert avm_result == int.from_bytes(result.bytes.value)
+    assert avm_result == int_to_decimal(expected, 32, 8)
+    assert avm_result == int_to_decimal(int.from_bytes(result.bytes.value), 32, 8)
 
 
 @pytest.mark.parametrize(
@@ -192,8 +194,8 @@ def test_bigufixednxm_from_log(get_avm_result: AVMInvoker, value: bytes, expecte
     result = arc4.BigUFixedNxM[typing.Literal[256], typing.Literal[16]].from_log(
         Bytes(ARC4_RETURN_PREFIX + value)
     )
-    assert avm_result == expected
-    assert avm_result == int.from_bytes(result.bytes.value)
+    assert avm_result == int_to_decimal(expected, 256, 16)
+    assert avm_result == int_to_decimal(int.from_bytes(result.bytes.value), 256, 16)
 
 
 @pytest.mark.parametrize(
@@ -231,3 +233,9 @@ def test_bigufixednxm_from_log_invalid_length(get_avm_result: AVMInvoker, value:
         Bytes(ARC4_RETURN_PREFIX + value)
     )
     assert result.bytes == value
+
+
+def int_to_decimal(value: int, n: int, m: int) -> Decimal:
+    s = str(value)
+    d = n - m
+    return Decimal(("0" * d + s[:-m])[-d:] + "." + ("0" * m + s[-m:])[-m:])

tests/arc4/test_uintn.py

@@ -12,7 +12,7 @@
 
 
 def _invalid_bytes_length_error(length: int) -> str:
-    return f"value string must be in bytes and correspond to a uint{length}"
+    return f"expected {length // 8} bytes for uint{length}"
 
 
 @pytest.mark.parametrize(

tests/common.py

@@ -4,18 +4,18 @@
 import typing
 from pathlib import Path
 
-import algosdk
 from algokit_utils import (
+    AddressWithSigners,
     AlgorandClient,
     AppClient,
     AppClientMethodCallParams,
     AppFactory,
     AppFactoryCreateMethodCallParams,
     AppFactoryCreateParams,
     AppFactoryParams,
-    SigningAccount,
+    AssetCreateParams,
 )
-from algosdk.v2client.algod import AlgodClient
+from algokit_utils.transact import OnApplicationComplete
 
 INITIAL_BALANCE_MICRO_ALGOS = int(20e6)
 
@@ -31,7 +31,7 @@ def __init__(self, client: AppClient, factory: AppFactory):
     def __call__(
         self,
         method: str,
-        on_complete: algosdk.transaction.OnComplete = algosdk.transaction.OnComplete.NoOpOC,
+        on_complete: OnApplicationComplete | None = None,
         *,
         return_raw: bool = False,
         **kwargs: typing.Any,
@@ -53,13 +53,12 @@ def __call__(
         if return_raw and response.returns and len(response.returns) > 0:
             return response.returns[0].raw_value
         result = response.abi_return
-        if result is None and response.returns and len(response.returns) > 0:
-            assert response.returns[0].tx_info
-            return response.returns[0].tx_info.get("logs", None)
+        if result is None and response.confirmations and len(response.confirmations) > 0:
+            return response.confirmations[0].logs
         if isinstance(result, list) and all(
             isinstance(i, int) and i >= 0 and i <= 255 for i in result
         ):
-            return bytes(result)  # type: ignore[arg-type]
+            return bytes(result)
         return result
 
 
@@ -73,7 +72,7 @@ def create_avm_invoker(app_spec: Path, algorand: AlgorandClient) -> AVMInvoker:
         AppFactoryParams(
             algorand=algorand,
             app_spec=app_spec.read_text(),
-            default_sender=dispenser.address,
+            default_sender=dispenser.addr,
         ),
     )
     try:
@@ -90,8 +89,8 @@ def create_avm_invoker(app_spec: Path, algorand: AlgorandClient) -> AVMInvoker:
 
 def generate_test_asset(  # noqa: PLR0913
     *,
-    algod_client: AlgodClient,
-    sender: SigningAccount,
+    algorand: AlgorandClient,
+    sender: AddressWithSigners,
     total: int | None = None,
     decimals: int = 0,
     default_frozen: bool = False,
@@ -116,33 +115,24 @@ def generate_test_asset(  # noqa: PLR0913
             f"${math.floor(random.random() * 100) + 1}_${total}"
         )
 
-    params = algod_client.suggested_params()
-
-    txn = algosdk.transaction.AssetConfigTxn(
-        sender=sender.address,
-        sp=params,
-        total=total * 10**decimals,
-        decimals=decimals,
-        default_frozen=default_frozen,
-        unit_name=unit_name,
-        asset_name=asset_name,
-        manager=manager,
-        reserve=reserve,
-        freeze=freeze,
-        clawback=clawback,
-        url=url,
-        metadata_hash=metadata_hash,
-        note=note or _random_note(),
-        lease=lease,
-        strict_empty_address_check=False,
-        rekey_to=rekey_to,
-    )  # type: ignore[no-untyped-call, unused-ignore]
-
-    signed_transaction = txn.sign(sender.private_key)  # type: ignore[no-untyped-call, unused-ignore]
-    algod_client.send_transaction(signed_transaction)
-    ptx = algod_client.pending_transaction_info(txn.get_txid())  # type: ignore[no-untyped-call, unused-ignore]
-
-    if isinstance(ptx, dict) and "asset-index" in ptx and isinstance(ptx["asset-index"], int):
-        return ptx["asset-index"]
-    else:
-        raise ValueError("Unexpected response from pending_transaction_info")
+    result = algorand.send.asset_create(
+        AssetCreateParams(
+            sender=sender.addr,
+            total=total * 10**decimals,
+            decimals=decimals,
+            default_frozen=default_frozen,
+            unit_name=unit_name,
+            asset_name=asset_name,
+            manager=manager,
+            reserve=reserve,
+            freeze=freeze,
+            clawback=clawback,
+            url=url,
+            metadata_hash=metadata_hash,
+            note=note or _random_note(),
+            lease=lease,
+            rekey_to=rekey_to,
+            signer=sender.signer,
+        )
+    )
+    return result.asset_id

tests/conftest.py

@@ -16,7 +16,7 @@ def algorand() -> AlgorandClient:
 
 @pytest.fixture()
 def localnet_creator_address(algorand: AlgorandClient) -> str:
-    return algorand.account.localnet_dispenser().address
+    return algorand.account.localnet_dispenser().addr
 
 
 @pytest.fixture()