feat: spike out what unit testing puyapy contracts could look like

.pre-commit-config.yaml

@@ -1,31 +1,31 @@
 repos:
-  - repo: local
-    hooks:
-      - id: black
-        name: black
-        description: "Black: The uncompromising Python code formatter"
-        entry: poetry run black .
-        pass_filenames: false
-        require_serial: true
-        language: system
-        minimum_pre_commit_version: 2.9.2
-        types_or: [ python, pyi ]
-      - id: ruff
-        name: ruff
-        description: "Run 'ruff' for extremely fast Python linting"
-        entry: poetry run ruff
-        language: system
-        'types': [python]
-        args: [--fix, --no-cache]
-        additional_dependencies: []
-        minimum_pre_commit_version: '0'
-      - id: mypy
-        name: mypy
-        description: '`mypy` will check Python types for correctness'
-        entry: poetry run mypy
-        language: system
-        types_or: [ python, pyi ]
-        require_serial: true
-        additional_dependencies: [ ]
-        minimum_pre_commit_version: '2.9.2'
-        exclude: '^src/puya/(_vendor|_typeshed)/'
+    - repo: local
+      hooks:
+          - id: black
+            name: black
+            description: "Black: The uncompromising Python code formatter"
+            entry: poetry run black .
+            pass_filenames: false
+            require_serial: true
+            language: system
+            minimum_pre_commit_version: 2.9.2
+            types_or: [python, pyi]
+          - id: ruff
+            name: ruff
+            description: "Run 'ruff' for extremely fast Python linting"
+            entry: poetry run ruff
+            language: system
+            "types": [python]
+            args: [--fix, --no-cache]
+            additional_dependencies: []
+            minimum_pre_commit_version: "0"
+          - id: mypy
+            name: mypy
+            description: "`mypy` will check Python types for correctness"
+            entry: poetry run mypy
+            language: system
+            types_or: [python, pyi]
+            require_serial: true
+            additional_dependencies: []
+            minimum_pre_commit_version: "2.9.2"
+            exclude: "^src/(puya/_vendor|puya/_typeshed|puyapy)/"

examples/amm/contract.py

@@ -358,9 +358,14 @@ def tokens_to_swap(*, in_amount: UInt64, in_supply: UInt64, out_supply: UInt64)
 
 @subroutine
 def do_asset_transfer(*, receiver: Account, asset: Asset, amount: UInt64) -> None:
+    balance_before = op.AssetHoldingGet.asset_balance(receiver, asset.asset_id)
+
     itxn.AssetTransfer(
         xfer_asset=asset,
         asset_amount=amount,
         asset_receiver=receiver,
         fee=0,
     ).submit()
+
+    balance_after = op.AssetHoldingGet.asset_balance(receiver, asset.asset_id)
+    assert balance_before[0] + amount == balance_after[0], "Balance not updated correctly"

examples/amm/out/ConstantProductAMM.approval.teal

@@ -479,7 +479,13 @@ do_asset_transfer:
     // @subroutine
     // def do_asset_transfer(*, receiver: Account, asset: Asset, amount: UInt64) -> None:
     proto 3 0
-    // amm/contract.py:361-366
+    // amm/contract.py:361
+    // balance_before = op.AssetHoldingGet.asset_balance(receiver, asset.asset_id)
+    frame_dig -3
+    frame_dig -2
+    asset_holding_get AssetBalance
+    pop
+    // amm/contract.py:363-368
     // itxn.AssetTransfer(
     //     xfer_asset=asset,
     //     asset_amount=amount,
@@ -489,26 +495,39 @@ do_asset_transfer:
     itxn_begin
     frame_dig -2
     itxn_field XferAsset
-    // amm/contract.py:361
+    // amm/contract.py:363
     // itxn.AssetTransfer(
     int axfer
     itxn_field TypeEnum
-    // amm/contract.py:365
+    // amm/contract.py:367
     // fee=0,
     int 0
     itxn_field Fee
     frame_dig -3
     itxn_field AssetReceiver
     frame_dig -1
     itxn_field AssetAmount
-    // amm/contract.py:361-366
+    // amm/contract.py:363-368
     // itxn.AssetTransfer(
     //     xfer_asset=asset,
     //     asset_amount=amount,
     //     asset_receiver=receiver,
     //     fee=0,
     // ).submit()
     itxn_submit
+    // amm/contract.py:370
+    // balance_after = op.AssetHoldingGet.asset_balance(receiver, asset.asset_id)
+    frame_dig -3
+    frame_dig -2
+    asset_holding_get AssetBalance
+    pop
+    // amm/contract.py:371
+    // assert balance_before[0] + amount == balance_after[0], "Balance not updated correctly"
+    swap
+    frame_dig -1
+    +
+    ==
+    assert // Balance not updated correctly
     retsub
 
 

examples/amm/out_O2/ConstantProductAMM.approval.teal

@@ -289,6 +289,10 @@ _do_opt_in:
 // examples.amm.contract.do_asset_transfer(receiver: bytes, asset: uint64, amount: uint64) -> void:
 do_asset_transfer:
     proto 3 0
+    frame_dig -3
+    frame_dig -2
+    asset_holding_get AssetBalance
+    pop
     itxn_begin
     frame_dig -2
     itxn_field XferAsset
@@ -301,6 +305,15 @@ do_asset_transfer:
     frame_dig -1
     itxn_field AssetAmount
     itxn_submit
+    frame_dig -3
+    frame_dig -2
+    asset_holding_get AssetBalance
+    pop
+    swap
+    frame_dig -1
+    +
+    ==
+    assert // Balance not updated correctly
     retsub
 
 

examples/amm/out_unoptimized/ConstantProductAMM.approval.teal

@@ -519,7 +519,13 @@ do_asset_transfer:
     // @subroutine
     // def do_asset_transfer(*, receiver: Account, asset: Asset, amount: UInt64) -> None:
     proto 3 0
-    // amm/contract.py:361-366
+    // amm/contract.py:361
+    // balance_before = op.AssetHoldingGet.asset_balance(receiver, asset.asset_id)
+    frame_dig -3
+    frame_dig -2
+    asset_holding_get AssetBalance
+    pop
+    // amm/contract.py:363-368
     // itxn.AssetTransfer(
     //     xfer_asset=asset,
     //     asset_amount=amount,
@@ -531,10 +537,10 @@ do_asset_transfer:
     // def do_asset_transfer(*, receiver: Account, asset: Asset, amount: UInt64) -> None:
     frame_dig -1
     frame_dig -3
-    // amm/contract.py:365
+    // amm/contract.py:367
     // fee=0,
     int 0
-    // amm/contract.py:361
+    // amm/contract.py:363
     // itxn.AssetTransfer(
     int axfer
     // amm/contract.py:360
@@ -545,14 +551,28 @@ do_asset_transfer:
     itxn_field Fee
     itxn_field AssetReceiver
     itxn_field AssetAmount
-    // amm/contract.py:361-366
+    // amm/contract.py:363-368
     // itxn.AssetTransfer(
     //     xfer_asset=asset,
     //     asset_amount=amount,
     //     asset_receiver=receiver,
     //     fee=0,
     // ).submit()
     itxn_submit
+    // amm/contract.py:370
+    // balance_after = op.AssetHoldingGet.asset_balance(receiver, asset.asset_id)
+    frame_dig -3
+    frame_dig -2
+    asset_holding_get AssetBalance
+    pop
+    // amm/contract.py:371
+    // assert balance_before[0] + amount == balance_after[0], "Balance not updated correctly"
+    swap
+    frame_dig -1
+    +
+    swap
+    ==
+    assert // Balance not updated correctly
     retsub