chore: utils-v3 migration (#18)

## Proposed Changes

- Updating tests to rely on utils-v3

## TODO

- Update to production release after prod utils v3 is available on pypi
- @lempira no major bumps in semantic version needed, as it doesn't
affect production code, only the testing stack itself. However note,
that I also removed semantic releases dependency as well as dependency
on algokit_utils from the prod dependencies list -> i assume they were
added there by accident. Algokit utils isn't utilized within the src
codebase, only the testing stack.

Author: lempira

README.md

@@ -168,7 +168,7 @@ from algokit_subscriber import AlgorandSubscriber
 from algokit_subscriber.types import SubscribedTransaction
 from algokit_utils import AlgorandClient
 
-algorand = AlgorandClient.main_net()
+algorand = AlgorandClient.mainnet()
 
 # The watermark is used to track how far the subscriber has processed transactions
 watermark = 0

examples/payments/payments.py

@@ -1,8 +1,8 @@
 from algokit_subscriber.subscriber import AlgorandSubscriber
 from algokit_subscriber.types.subscription import SubscribedTransaction
-from algokit_utils.beta.algorand_client import AlgorandClient
+from algokit_utils import AlgorandClient
 
-algorand = AlgorandClient.main_net()
+algorand = AlgorandClient.mainnet()
 
 # The watermark is used to track how far the subscriber has processed transactions
 # In this example, we are starting at round 41651683

examples/usdc/usdc.py

@@ -1,8 +1,8 @@
 from algokit_subscriber.subscriber import AlgorandSubscriber
 from algokit_subscriber.types.subscription import SubscribedTransaction
-from algokit_utils.beta.algorand_client import AlgorandClient
+from algokit_utils import AlgorandClient
 
-algorand = AlgorandClient.main_net()
+algorand = AlgorandClient.mainnet()
 
 # The watermark is used to track how far the subscriber has processed transactions
 # In this example, we are starting at round 41651683

poetry.lock

@@ -8,10 +8,10 @@ readme = "README.md"
 [tool.poetry.dependencies]
 python = "^3.12"
 py-algorand-sdk = "^2.7.0"
-algokit-utils = "^2.3.0"
-python-semantic-release = "^9.19.1"
 
 [tool.poetry.group.dev.dependencies]
+algokit-utils = "^3.0.0"
+python-semantic-release = "^9.8.8"
 mypy = "^1.10.1"
 ruff = "^0.5.0"
 pytest = "^8.2.2"
@@ -26,6 +26,7 @@ sphinx-copybutton = "^0.5.2"
 sphinx-autobuild = "^2024.4.16"
 sphinx-mermaid = "^0.0.8"
 poethepoet = "^0.24.4"
+pytest-sugar = "^1.0.0"
 
 [build-system]
 requires = ["poetry-core"]
@@ -178,4 +179,3 @@ upload_to_vcs_release = true
 
 [tool.semantic_release.remote.token]
 env = "GITHUB_TOKEN"
-

pyproject.toml

@@ -1,11 +1,14 @@
-from algokit_utils.beta.algorand_client import AlgorandClient
-from algokit_utils.beta.composer import PayParams
+from algokit_utils import AlgoAmount, AlgorandClient, PaymentParams
 
 
 def generate_account(algorand: AlgorandClient, amount: int = int(5e6)) -> str:
-    dispsener = algorand.account.dispenser().address
+    dispsener = algorand.account.localnet_dispenser().address
     addr = algorand.account.random().address
 
-    algorand.send.payment(PayParams(sender=dispsener, receiver=addr, amount=amount))
+    algorand.send.payment(
+        PaymentParams(
+            sender=dispsener, receiver=addr, amount=AlgoAmount(micro_algo=amount)
+        )
+    )
 
     return addr

tests/accounts.py

@@ -5,7 +5,7 @@
     SubscribedTransaction,
     TransactionSubscriptionResult,
 )
-from algokit_utils.beta.algorand_client import AlgorandClient
+from algokit_utils import AlgorandClient
 
 from .transactions import get_subscribed_transactions_for_test, send_x_transactions
 
@@ -21,7 +21,7 @@ def filter_synthetic_transactions(t: SubscribedTransaction) -> bool:
 
 @pytest.fixture()
 def filter_fixture() -> dict:
-    localnet = AlgorandClient.default_local_net()
+    localnet = AlgorandClient.default_localnet()
     localnet.set_default_validity_window(1000)
 
     def subscribe_algod(

tests/filter_fixture.py

@@ -4,13 +4,14 @@
     AlgorandSubscriberConfig,
     BalanceChangeRole,
 )
-from algokit_utils.beta.algorand_client import AlgorandClient
-from algokit_utils.beta.composer import (
+from algokit_utils import (
+    AlgoAmount,
+    AlgorandClient,
     AssetCreateParams,
     AssetDestroyParams,
     AssetOptInParams,
     AssetTransferParams,
-    PayParams,
+    PaymentParams,
 )
 
 from .accounts import generate_account
@@ -25,9 +26,11 @@ def test_asset_create_txns(filter_fixture: dict) -> None:
     txns = (
         localnet.new_group()
         .add_asset_create(
-            AssetCreateParams(sender=sender, static_fee=2000, total=100_000_000)
+            AssetCreateParams(
+                sender=sender, static_fee=AlgoAmount(micro_algo=2000), total=100_000_000
+            )
         )
-        .execute()
+        .send()
     )
     confirmations = get_confirmations(localnet, txns.tx_ids)
     asset = confirmations[0]["asset-index"]
@@ -64,19 +67,24 @@ def test_asset_destroy_txns(filter_fixture: dict) -> None:
         localnet.new_group()
         .add_asset_create(
             AssetCreateParams(
-                sender=sender, static_fee=2000, total=100_000_000, manager=sender
+                sender=sender,
+                static_fee=AlgoAmount(micro_algo=2000),
+                total=100_000_000,
+                manager=sender,
             )
         )
-        .execute()
+        .send()
     )
     asset = get_confirmations(localnet, create_asset_txns.tx_ids)[0]["asset-index"]
 
     txns = (
         localnet.new_group()
         .add_asset_destroy(
-            AssetDestroyParams(sender=sender, static_fee=2000, asset_id=asset)
+            AssetDestroyParams(
+                sender=sender, static_fee=AlgoAmount(micro_algo=2000), asset_id=asset
+            )
         )
-        .execute()
+        .send()
     )
 
     subscription = filter_fixture["subscribe_and_verify"](
@@ -112,18 +120,26 @@ def test_balance_change_filter_on_fee(filter_fixture: dict) -> None:
     txns = (
         localnet.new_group()
         .add_asset_create(
-            AssetCreateParams(sender=random_account, static_fee=3000, total=1)
+            AssetCreateParams(
+                sender=random_account, static_fee=AlgoAmount(micro_algo=3000), total=1
+            )
         )
         .add_asset_create(
-            AssetCreateParams(sender=test_account, static_fee=1000, total=1)
+            AssetCreateParams(
+                sender=test_account, static_fee=AlgoAmount(micro_algo=1000), total=1
+            )
         )
         .add_asset_create(
-            AssetCreateParams(sender=test_account, static_fee=3000, total=1)
+            AssetCreateParams(
+                sender=test_account, static_fee=AlgoAmount(micro_algo=3000), total=1
+            )
         )
         .add_asset_create(
-            AssetCreateParams(sender=test_account, static_fee=5000, total=1)
+            AssetCreateParams(
+                sender=test_account, static_fee=AlgoAmount(micro_algo=5000), total=1
+            )
         )
-        .execute()
+        .send()
     )
 
     filter_fixture["subscribe_and_verify_filter"](
@@ -155,54 +171,89 @@ def test_various_filters_on_payments(filter_fixture: dict) -> None:
     txns = (
         localnet.new_group()
         .add_payment(
-            PayParams(amount=1000, sender=account, receiver=account2, static_fee=1000)
+            PaymentParams(
+                amount=AlgoAmount(micro_algo=1000),
+                sender=account,
+                receiver=account2,
+                static_fee=AlgoAmount(micro_algo=1000),
+            )
         )
         .add_payment(
-            PayParams(amount=1000, sender=account2, receiver=account, static_fee=1000)
+            PaymentParams(
+                amount=AlgoAmount(micro_algo=1000),
+                sender=account2,
+                receiver=account,
+                static_fee=AlgoAmount(micro_algo=1000),
+            )
         )
         .add_payment(
-            PayParams(amount=2000, sender=account, receiver=account2, static_fee=1000)
+            PaymentParams(
+                amount=AlgoAmount(micro_algo=2000),
+                sender=account,
+                receiver=account2,
+                static_fee=AlgoAmount(micro_algo=1000),
+            )
         )
         .add_payment(
-            PayParams(amount=2000, sender=account2, receiver=account, static_fee=1000)
+            PaymentParams(
+                amount=AlgoAmount(micro_algo=2000),
+                sender=account2,
+                receiver=account,
+                static_fee=AlgoAmount(micro_algo=1000),
+            )
         )
         .add_payment(
-            PayParams(amount=3000, sender=account, receiver=account2, static_fee=1000)
+            PaymentParams(
+                amount=AlgoAmount(micro_algo=3000),
+                sender=account,
+                receiver=account2,
+                static_fee=AlgoAmount(micro_algo=1000),
+            )
         )
         .add_payment(
-            PayParams(amount=3000, sender=account2, receiver=account, static_fee=1000)
+            PaymentParams(
+                amount=AlgoAmount(micro_algo=3000),
+                sender=account2,
+                receiver=account,
+                static_fee=AlgoAmount(micro_algo=1000),
+            )
         )
         .add_payment(
-            PayParams(
-                amount=100_000,
+            PaymentParams(
+                amount=AlgoAmount(micro_algo=100_000),
                 sender=account,
                 receiver=account2,
-                static_fee=1000,
+                static_fee=AlgoAmount(micro_algo=1000),
                 close_remainder_to=account3,
             )
         )
         .add_payment(
-            PayParams(
-                amount=100_000,
+            PaymentParams(
+                amount=AlgoAmount(micro_algo=100_000),
                 sender=account2,
                 receiver=account,
-                static_fee=1000,
+                static_fee=AlgoAmount(micro_algo=1000),
                 close_remainder_to=account,
             )
         )
         .add_payment(
-            PayParams(
-                amount=100_000,
+            PaymentParams(
+                amount=AlgoAmount(micro_algo=100_000),
                 sender=account3,
                 receiver=account2,
-                static_fee=2000,
+                static_fee=AlgoAmount(micro_algo=2000),
                 close_remainder_to=account,
             )
         )
         .add_payment(
-            PayParams(amount=0, sender=account, receiver=account, static_fee=0)
+            PaymentParams(
+                amount=AlgoAmount(micro_algo=0),
+                sender=account,
+                receiver=account,
+                static_fee=AlgoAmount(micro_algo=0),
+            )
         )
-        .execute()
+        .send()
     )
 
     subscribe_and_verify_filter(
@@ -471,10 +522,10 @@ def test_various_filters_on_axfers(filter_fixture: dict) -> None:  # noqa: PLR09
 
     asset1 = localnet.send.asset_create(
         AssetCreateParams(sender=test_account, total=1000, clawback=test_account)
-    )["confirmation"]["asset-index"]
+    ).confirmation["asset-index"]
     asset2 = localnet.send.asset_create(
         AssetCreateParams(sender=test_account, total=1001, clawback=test_account)
-    )["confirmation"]["asset-index"]
+    ).confirmation["asset-index"]
 
     localnet.send.asset_opt_in(AssetOptInParams(sender=account, asset_id=asset1))
     localnet.send.asset_opt_in(AssetOptInParams(sender=account2, asset_id=asset1))
@@ -588,7 +639,7 @@ def test_various_filters_on_axfers(filter_fixture: dict) -> None:  # noqa: PLR09
                 sender=account2, receiver=account, asset_id=asset2, amount=23
             )
         )
-        .execute()
+        .send()
     )
 
     subscribe_and_verify_filter(
@@ -861,7 +912,7 @@ def test_various_filters_on_axfers(filter_fixture: dict) -> None:  # noqa: PLR09
 
 
 def test_block_payouts() -> None:
-    algorand = AlgorandClient.main_net()
+    algorand = AlgorandClient.mainnet()
     payout_round = 46838092
     watermark: int = payout_round - 1