Merge pull request #51 from tinymanorg/app-call-notes

Add transaction note for integrations
tinymanorg · Jan 3, 2023 · b86a321 · b86a321
2 parents 34df539 + 17e0579
commit b86a321
Show file tree

Hide file tree

Showing 31 changed files with 330 additions and 18 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,22 @@
 # Change Log
 
+## Unreleased
+
+### Added
+
+* Added `client_name` attribute to `TinymanClient` classes. [#51](https://github.com/tinymanorg/tinyman-py-sdk/pull/51)
+* Added note to application call transactions. The note (`tinyman/<v1|v2>:j{"origin":"<client-name>"}`) follows [Algorand Transaction Note Field Conventions ARC-2](https://github.com/algorandfoundation/ARCs/blob/main/ARCs/arc-0002.md). [#51](https://github.com/tinymanorg/tinyman-py-sdk/pull/51)
+* Added `version` property and `generate_app_call_note` method to `TinymanClient` classes. [#51](https://github.com/tinymanorg/tinyman-py-sdk/pull/51)
+* Added `get_version` and `generate_app_call_note` to `tinyman.utils`. [#51](https://github.com/tinymanorg/tinyman-py-sdk/pull/51)
+
+### Changed
+
+* ...
+
+### Removed
+* ...
+
+
 ## 2.0.0
 
 ### Added

diff --git a/README.md b/README.md
@@ -27,6 +27,16 @@ tinyman-py-sdk is not released on PYPI. It can be installed directly from this r
 
 `pip install git+https://github.com/tinymanorg/tinyman-py-sdk.git`
 
+
+## Integration
+
+If you are integrating your project into Tinyman, you can provide `client_name` while setting up Tinyman Client classes.
+The client name will be added to the application call transaction's note field. It is recommended and completely optional.
+
+```python
+client = TinymanV2MainnetClient(..., client_name="project name", ...)
+```
+
 ## V2
 
 ## Sneak Preview

diff --git a/tests/test.py b/tests/test.py
@@ -0,0 +1,53 @@
+from base64 import b64encode
+from unittest import TestCase
+
+from tinyman.utils import generate_app_call_note, parse_app_call_note
+
+
+class BaseTestCase(TestCase):
+    maxDiff = None
+
+    def test_app_call_note(self):
+        note = generate_app_call_note(
+            version="v2", client_name="unit-test", extra_data={"extra": "some text"}
+        )
+        expected_result = {
+            "version": "v2",
+            "data": {"extra": "some text", "origin": "unit-test"},
+        }
+
+        # test possible versions
+        string_note = note
+        bytes_note = string_note.encode()
+        base64_note = b64encode(bytes_note).decode()
+
+        result = parse_app_call_note(string_note)
+        self.assertDictEqual(
+            result,
+            expected_result,
+        )
+
+        result = parse_app_call_note(base64_note)
+        self.assertDictEqual(
+            result,
+            expected_result,
+        )
+
+        result = parse_app_call_note(base64_note)
+        self.assertDictEqual(
+            result,
+            expected_result,
+        )
+
+        result = parse_app_call_note("invalid format")
+        self.assertEqual(result, None)
+        result = parse_app_call_note(
+            "INVALID+dGlueW1hbi92MjpqeyJvcmlnaW4iOiJ0aW55bWFuLXB5dGhvbi1zZGsifQ=="
+        )
+        self.assertEqual(result, None)
+        result = parse_app_call_note(b"invalid format")
+        self.assertEqual(result, None)
+        result = parse_app_call_note(
+            b'INVALID+tinyman/v2:j{"origin":"tinyman-python-sdk"}'
+        )
+        self.assertEqual(result, None)
diff --git a/tests/v2/__init__.py b/tests/v2/__init__.py
@@ -44,3 +44,7 @@ def get_pool_state(
         }
         state.update(**kwargs)
         return state
+
+    @classmethod
+    def app_call_note(cls):
+        return b'tinyman/v2:j{"origin":"tinyman-py-sdk"}'
diff --git a/tests/v2/test_add_liquidity.py b/tests/v2/test_add_liquidity.py
@@ -15,6 +15,7 @@
     ADD_LIQUIDITY_APP_ARGUMENT,
     ADD_LIQUIDITY_FLEXIBLE_MODE_APP_ARGUMENT,
     ADD_LIQUIDITY_SINGLE_MODE_APP_ARGUMENT,
+    TESTNET_VALIDATOR_APP_ID_V2,
 )
 from tinyman.v2.contracts import get_pool_logicsig
 from tinyman.v2.pools import Pool
@@ -28,7 +29,7 @@
 class InitialAddLiquidityTestCase(BaseTestCase):
     @classmethod
     def setUpClass(cls):
-        cls.VALIDATOR_APP_ID = 12345
+        cls.VALIDATOR_APP_ID = TESTNET_VALIDATOR_APP_ID_V2
         cls.sender_private_key, cls.user_address = generate_account()
         cls.asset_1_id = 10
         cls.asset_2_id = 8
@@ -121,14 +122,15 @@ def test_add_liquidity(self):
                 "lv": ANY,
                 "snd": decode_address(self.user_address),
                 "type": APPCALL_TXN,
+                "note": self.app_call_note(),
             },
         )
 
 
 class AddLiquidityTestCase(BaseTestCase):
     @classmethod
     def setUpClass(cls):
-        cls.VALIDATOR_APP_ID = 12345
+        cls.VALIDATOR_APP_ID = TESTNET_VALIDATOR_APP_ID_V2
         cls.sender_private_key, cls.user_address = generate_account()
         cls.asset_1_id = 10
         cls.asset_2_id = 8
@@ -240,6 +242,7 @@ def test_flexible_add_liquidity(self):
                 "lv": ANY,
                 "snd": decode_address(self.user_address),
                 "type": APPCALL_TXN,
+                "note": self.app_call_note(),
             },
         )
 
@@ -311,5 +314,6 @@ def test_single_asset_add_liquidity(self):
                 "lv": ANY,
                 "snd": decode_address(self.user_address),
                 "type": APPCALL_TXN,
+                "note": self.app_call_note(),
             },
         )
diff --git a/tests/v2/test_bootstrap.py b/tests/v2/test_bootstrap.py
@@ -7,15 +7,15 @@
 from algosdk.logic import get_application_address
 
 from tests.v2 import BaseTestCase
-from tinyman.v2.constants import BOOTSTRAP_APP_ARGUMENT
+from tinyman.v2.constants import BOOTSTRAP_APP_ARGUMENT, TESTNET_VALIDATOR_APP_ID_V2
 from tinyman.v2.contracts import get_pool_logicsig
 from tinyman.v2.pools import Pool
 
 
 class BootstrapTestCase(BaseTestCase):
     @classmethod
     def setUpClass(cls):
-        cls.VALIDATOR_APP_ID = 12345
+        cls.VALIDATOR_APP_ID = TESTNET_VALIDATOR_APP_ID_V2
         cls.application_address = get_application_address(cls.VALIDATOR_APP_ID)
 
         cls.sender_private_key, cls.user_address = generate_account()
@@ -74,6 +74,7 @@ def test_bootstrap(self):
                 "rekey": decode_address(self.application_address),
                 "snd": decode_address(self.pool_address),
                 "type": APPCALL_TXN,
+                "note": self.app_call_note(),
             },
         )
 
@@ -101,14 +102,15 @@ def test_pool_is_already_funded(self):
                 "rekey": decode_address(self.application_address),
                 "snd": decode_address(self.pool_address),
                 "type": APPCALL_TXN,
+                "note": self.app_call_note(),
             },
         )
 
 
 class BootstrapAlgoPoolTestCase(BaseTestCase):
     @classmethod
     def setUpClass(cls):
-        cls.VALIDATOR_APP_ID = 12345
+        cls.VALIDATOR_APP_ID = TESTNET_VALIDATOR_APP_ID_V2
         cls.application_address = get_application_address(cls.VALIDATOR_APP_ID)
 
         cls.sender_private_key, cls.user_address = generate_account()
@@ -167,6 +169,7 @@ def test_bootstrap(self):
                 "rekey": decode_address(self.application_address),
                 "snd": decode_address(self.pool_address),
                 "type": APPCALL_TXN,
+                "note": self.app_call_note(),
             },
         )
 
@@ -194,5 +197,6 @@ def test_pool_is_already_funded(self):
                 "rekey": decode_address(self.application_address),
                 "snd": decode_address(self.pool_address),
                 "type": APPCALL_TXN,
+                "note": self.app_call_note(),
             },
         )
diff --git a/tests/v2/test_flash_loan.py b/tests/v2/test_flash_loan.py
@@ -9,7 +9,11 @@
 from tests.v2 import BaseTestCase
 from tinyman.assets import AssetAmount
 from tinyman.utils import int_to_bytes
-from tinyman.v2.constants import FLASH_LOAN_APP_ARGUMENT, VERIFY_FLASH_LOAN_APP_ARGUMENT
+from tinyman.v2.constants import (
+    FLASH_LOAN_APP_ARGUMENT,
+    VERIFY_FLASH_LOAN_APP_ARGUMENT,
+    TESTNET_VALIDATOR_APP_ID_V2,
+)
 from tinyman.v2.contracts import get_pool_logicsig
 from tinyman.v2.pools import Pool
 from tinyman.v2.quotes import FlashLoanQuote
@@ -18,7 +22,7 @@
 class FlashLoanTestCase(BaseTestCase):
     @classmethod
     def setUpClass(cls):
-        cls.VALIDATOR_APP_ID = 12345
+        cls.VALIDATOR_APP_ID = TESTNET_VALIDATOR_APP_ID_V2
         cls.sender_private_key, cls.user_address = generate_account()
         cls.asset_1_id = 10
         cls.asset_2_id = 8
@@ -98,6 +102,7 @@ def test_flash_loan(self):
                 "lv": ANY,
                 "snd": decode_address(self.user_address),
                 "type": APPCALL_TXN,
+                "note": self.app_call_note(),
             },
         )
 
@@ -134,5 +139,6 @@ def test_flash_loan(self):
                 "lv": ANY,
                 "snd": decode_address(self.user_address),
                 "type": APPCALL_TXN,
+                "note": self.app_call_note(),
             },
         )
diff --git a/tests/v2/test_flash_swap.py b/tests/v2/test_flash_swap.py
@@ -8,7 +8,11 @@
 
 from tests.v2 import BaseTestCase
 from tinyman.utils import int_to_bytes
-from tinyman.v2.constants import FLASH_SWAP_APP_ARGUMENT, VERIFY_FLASH_SWAP_APP_ARGUMENT
+from tinyman.v2.constants import (
+    FLASH_SWAP_APP_ARGUMENT,
+    VERIFY_FLASH_SWAP_APP_ARGUMENT,
+    TESTNET_VALIDATOR_APP_ID_V2,
+)
 from tinyman.v2.contracts import get_pool_logicsig
 from tinyman.v2.flash_swap import prepare_flash_swap_transactions
 from tinyman.v2.pools import Pool
@@ -17,7 +21,7 @@
 class FlashSwapTestCase(BaseTestCase):
     @classmethod
     def setUpClass(cls):
-        cls.VALIDATOR_APP_ID = 12345
+        cls.VALIDATOR_APP_ID = TESTNET_VALIDATOR_APP_ID_V2
         cls.sender_private_key, cls.user_address = generate_account()
         cls.asset_1_id = 10
         cls.asset_2_id = 8
@@ -49,6 +53,7 @@ def test_flash_swap(self):
             transactions=[],
             sender=self.user_address,
             suggested_params=self.get_suggested_params(),
+            app_call_note=self.app_call_note().decode(),
         )
 
         transactions = txn_group.transactions
@@ -73,6 +78,7 @@ def test_flash_swap(self):
                 "lv": ANY,
                 "snd": decode_address(self.user_address),
                 "type": APPCALL_TXN,
+                "note": self.app_call_note(),
             },
         )
 
@@ -95,5 +101,6 @@ def test_flash_swap(self):
                 "lv": ANY,
                 "snd": decode_address(self.user_address),
                 "type": APPCALL_TXN,
+                "note": self.app_call_note(),
             },
         )
diff --git a/tests/v2/test_remove_liquidity.py b/tests/v2/test_remove_liquidity.py
@@ -9,7 +9,10 @@
 from tests.v2 import BaseTestCase
 from tinyman.assets import AssetAmount
 from tinyman.utils import int_to_bytes
-from tinyman.v2.constants import REMOVE_LIQUIDITY_APP_ARGUMENT
+from tinyman.v2.constants import (
+    REMOVE_LIQUIDITY_APP_ARGUMENT,
+    TESTNET_VALIDATOR_APP_ID_V2,
+)
 from tinyman.v2.contracts import get_pool_logicsig
 from tinyman.v2.pools import Pool
 from tinyman.v2.quotes import RemoveLiquidityQuote, SingleAssetRemoveLiquidityQuote
@@ -18,7 +21,7 @@
 class RemoveLiquidityTestCase(BaseTestCase):
     @classmethod
     def setUpClass(cls):
-        cls.VALIDATOR_APP_ID = 12345
+        cls.VALIDATOR_APP_ID = TESTNET_VALIDATOR_APP_ID_V2
         cls.sender_private_key, cls.user_address = generate_account()
         cls.asset_1_id = 10
         cls.asset_2_id = 8
@@ -112,6 +115,7 @@ def test_remove_liquidity(self):
                 "lv": ANY,
                 "snd": decode_address(self.user_address),
                 "type": APPCALL_TXN,
+                "note": self.app_call_note(),
             },
         )
 
@@ -184,5 +188,6 @@ def test_single_asset_remove_liquidity(self):
                 "lv": ANY,
                 "snd": decode_address(self.user_address),
                 "type": APPCALL_TXN,
+                "note": self.app_call_note(),
             },
         )
diff --git a/tests/v2/test_swap.py b/tests/v2/test_swap.py
@@ -13,6 +13,7 @@
     SWAP_APP_ARGUMENT,
     FIXED_INPUT_APP_ARGUMENT,
     FIXED_OUTPUT_APP_ARGUMENT,
+    TESTNET_VALIDATOR_APP_ID_V2,
 )
 from tinyman.v2.contracts import get_pool_logicsig
 from tinyman.v2.pools import Pool
@@ -22,7 +23,7 @@
 class SwapTestCase(BaseTestCase):
     @classmethod
     def setUpClass(cls):
-        cls.VALIDATOR_APP_ID = 12345
+        cls.VALIDATOR_APP_ID = TESTNET_VALIDATOR_APP_ID_V2
         cls.sender_private_key, cls.user_address = generate_account()
         cls.asset_1_id = 10
         cls.asset_2_id = 8
@@ -103,6 +104,7 @@ def test_fixed_input_swap(self):
                 "lv": ANY,
                 "snd": decode_address(self.user_address),
                 "type": APPCALL_TXN,
+                "note": self.app_call_note(),
             },
         )
 
@@ -166,5 +168,6 @@ def test_fixed_output_swap(self):
                 "lv": ANY,
                 "snd": decode_address(self.user_address),
                 "type": APPCALL_TXN,
+                "note": self.app_call_note(),
             },
         )