C2C Feature and Testing (#268)

* Start ABI JSON interaction

* Add static annoation

* Fix Method argument parsing

* Add ABI Typing to Method arguments

* [WIP] Add AtomicTransactionComposer build functions

* [WIP] Sign and send atomic transaction groups

* Add unit tests for object parsing

* Clean up method calls

* Address PR comments on JSON objects

* Refactor ABI Type to ABIType so it can be exposed to outside world

* Add cucumber steps for ABI tests and update existing implementation so it can pass these tests

* Refactor TransactionSigner to Abstract class and merge signatures when signing

* Update testing to reflect json unit tests and composer tests

* Formatting and docstring fixes

* Add foreign types for method arguments

* Clean up imports

* Fix unit test for appId

* Add unit test for foreign array

* Refactor some names and add txn as an arg type

* Partially address PR comments

* Fix encoding args for foreign types

* Add some additional checks for safety

* Fix a step so we check for empty string instead of None

* Correct foreign app and account indices accounting for the implicit argument

* Resolve formatting

* Fix unit tests

* Fix foreign objects to compact duplicates and special values

* Refactor foreign objects, transactions, and address some new ABI changes

* ABI composer modifications and test updates

* Change Interface and Contract to newest ABI changes

* Fix some integration tests for composer

* Fix remaining composer tests

* Formatting changes

* Fix method json tests

* add an empty __init__.py

* add step to sanity check *.teal.tok against algod's compilation of *.teal

* Add the ability to create apps without the binary

* step for asserting ABI return type of return values

* temporararily adding unfounded mandate z_steps.py

* unit test for array_static of byte

* add context.app_ids - list of all app ids that have been added

* refeactor add_abi_method_call* using abi_method_adder()

* don't pass in schemas, unless a component has been defined

* With so many tags, let's create variables for easier selction of unit/integration tests

* Alphabetize tags and remove deprecated 'templates'

* add method using a non-current app

* place it back

* got to the point of a bug in randomByte

* wip

* use pathlib

* fix bad arg ordering in call

* 1. Return application's account address in app-info response
2. now passing 2-level tests for innter txn's
3. next up: 3 levels

* clean up unneeded step

* close but no cigar

* wip

* tests are failing where they _should be_

* all necessary functionality... but too many tests

* assertion about inner group ids also

* passing the megatest

* hash non-deterministic step for ABI method

* regex match step

* test c2c on circle

* grammar

* remove unused step

* route get_application_address() to application_address()

* dangit... we already have logic.get_application_address

* use logic.get_application_address()

* small import re-org (and msgpack not needed)

* alphabetize

* add type assertion to get_application_address()

* refactor v2_steps.py into smaller chuncks

* per cr suggestion, split with : not #

* per cr comments

* Per CR suggetions: remove from transactions_trace() from SDK, and make into a test utility function

* eval delta step - and adding glom to requirements

* 'Did you mean == ?' - yes i certainly did

* for completeness, provide tx_info even for non-appl txns

* steps more general than the indexer

* require the ability to calculate app addresses, but not from app_info

* revert algod changes (except for import re-org)

* remove file inadvertently added

* spacing

* formatting

* explicit nonce instead of nonce hook

* un-breakup v2_steps.py so it can be easier to see changes

* remove implmentation of redundant step

* as the Rolling Stones said "I want it painted black"

* per review suggestion

* per CR suggestion: send the request inside of a try block

* pytest for "with pytest.raises" context

* handle the void abi type

* per CR suggestions

* per CR comments. Call pending txn's at the top of the for-loop for method calls

* remove unused import

* spacing

* don't overwrite confirmed_round in subsequent pending txn calls

* comment in test method

* remove unused import

* Alas, poor Yorick...

* remove unused import

* import reorg

* re-kick off the tests

* implement "I rest the array of application IDs to remember."

* markdownlint

* deprecating templates and removing associated tests

* fix test

* Update README.md

a -> an and trigger new tests!

* Update algosdk/future/template.py

remove period and trigger new test

* todo about v2_steps being too big

Co-authored-by: algochoi <[email protected]>

Author: tzaffi

Makefile

@@ -1,8 +1,10 @@
+UNITS = "@unit.abijson or @unit.algod or @unit.applications or @unit.atomic_transaction_composer or @unit.dryrun or @unit.feetest or @unit.indexer or @unit.indexer.logs or @unit.offline or @unit.rekey or @unit.responses or @unit.responses.231 or @unit.tealsign or @unit.transactions or @unit.transactions.payment"
 unit:
-	behave --tags="@unit.offline or @unit.algod or @unit.indexer or @unit.rekey or @unit.tealsign or @unit.dryrun or @unit.applications or @unit.responses or @unit.transactions or @unit.transactions.payment or @unit.responses.231 or @unit.feetest or @unit.indexer.logs or @unit.abijson or @unit.atomic_transaction_composer" test -f progress2
+	behave --tags=$(UNITS) test -f progress2
 
+INTEGRATIONS = "@abi or @algod or @applications or @applications.verified or @assets or @auction or @c2c or @compile or @dryrun or @dryrun.testing or @indexer or @indexer.231 or @indexer.applications or @kmd or @rekey or @send"
 integration:
-	behave --tags="@algod or @assets or @auction or @kmd or @send or @template or @indexer or @indexer.applications or @rekey or @compile or @dryrun or @dryrun.testing or @applications or @applications.verified or @indexer.231 or @abi" test -f progress2
+	behave --tags=$(INTEGRATIONS) test -f progress2
 
 docker-test:
 	./run_integration.sh

README.md

@@ -1,27 +1,31 @@
 # py-algorand-sdk
-[![Build Status](https://travis-ci.com/algorand/py-algorand-sdk.svg?branch=master)](https://travis-ci.com/algorand/py-algorand-sdk) 
-[![PyPI version](https://badge.fury.io/py/py-algorand-sdk.svg)](https://badge.fury.io/py/py-algorand-sdk) 
-[![Documentation Status](https://readthedocs.org/projects/py-algorand-sdk/badge/?version=latest&style=flat)](https://py-algorand-sdk.readthedocs.io/en/latest) 
+
+[![Build Status](https://travis-ci.com/algorand/py-algorand-sdk.svg?branch=master)](https://travis-ci.com/algorand/py-algorand-sdk)
+[![PyPI version](https://badge.fury.io/py/py-algorand-sdk.svg)](https://badge.fury.io/py/py-algorand-sdk)
+[![Documentation Status](https://readthedocs.org/projects/py-algorand-sdk/badge/?version=latest&style=flat)](https://py-algorand-sdk.readthedocs.io/en/latest)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 
 A python library for interacting with the Algorand network.
 
 ## Installation
 
-Run ```$ pip3 install py-algorand-sdk``` to install the package.
+Run `$ pip3 install py-algorand-sdk` to install the package.
 
-Alternatively, choose a [distribution file](https://pypi.org/project/py-algorand-sdk/#files), and run ```$ pip3 install [file name]```.
+Alternatively, choose a [distribution file](https://pypi.org/project/py-algorand-sdk/#files), and run `$ pip3 install [file name]`.
 
 ## SDK Development
 
 Install dependencies
-* `pip install -r requirements.txt`
+
+- `pip install -r requirements.txt`
 
 Run tests
-* `make docker-test`
+
+- `make docker-test`
 
 Format code:
-* `black .`
+
+- `black .`
 
 ## Quick start
 
@@ -50,18 +54,18 @@ Follow the instructions in Algorand's [developer resources](https://developer.al
 
 Before running [example.py](https://github.com/algorand/py-algorand-sdk/blob/master/examples/example.py), start kmd on a private network or testnet node:
 
-```
-$ ./goal kmd start -d [data directory]
+```bash
+./goal kmd start -d [data directory]
 ```
 
 Next, create a wallet and an account:
 
-```
-$ ./goal wallet new [wallet name] -d [data directory]
+```bash
+./goal wallet new [wallet name] -d [data directory]
 ```
 
-```
-$ ./goal account new -d [data directory] -w [wallet name]
+```bash
+./goal account new -d [data directory] -w [wallet name]
 ```
 
 Visit the [Algorand dispenser](https://bank.testnet.algorand.network/) and enter the account address to fund your account.
@@ -71,7 +75,9 @@ Next, in [tokens.py](https://github.com/algorand/py-algorand-sdk/blob/master/exa
 You're now ready to run example.py!
 
 ## Documentation
+
 Documentation for the Python SDK is available at [py-algorand-sdk.readthedocs.io](https://py-algorand-sdk.readthedocs.io/en/latest/).
 
 ## License
-py-algorand-sdk is licensed under a MIT license. See the [LICENSE](https://github.com/algorand/py-algorand-sdk/blob/master/LICENSE) file for details.
+
+py-algorand-sdk is licensed under an MIT license. See the [LICENSE](https://github.com/algorand/py-algorand-sdk/blob/master/LICENSE) file for details.

algosdk/atomic_transaction_composer.py

@@ -495,26 +495,27 @@ def execute(
             raw_value = None
             return_value = None
             decode_error = None
+            tx_info = None
 
             if i not in self.method_dict:
                 continue
-            # Return is void
-            if self.method_dict[i].returns.type == abi.Returns.VOID:
-                method_results.append(
-                    ABIResult(
-                        tx_id=tx_id,
-                        raw_value=raw_value,
-                        return_value=return_value,
-                        decode_error=decode_error,
-                    )
-                )
-                continue
 
             # Parse log for ABI method return value
             try:
-                resp = client.pending_transaction_info(tx_id)
-                confirmed_round = resp["confirmed-round"]
-                logs = resp["logs"] if "logs" in resp else []
+                tx_info = client.pending_transaction_info(tx_id)
+                if self.method_dict[i].returns.type == abi.Returns.VOID:
+                    method_results.append(
+                        ABIResult(
+                            tx_id=tx_id,
+                            raw_value=raw_value,
+                            return_value=return_value,
+                            decode_error=decode_error,
+                            tx_info=tx_info,
+                        )
+                    )
+                    continue
+
+                logs = tx_info["logs"] if "logs" in tx_info else []
 
                 # Look for the last returned value in the log
                 if not logs:
@@ -543,6 +544,7 @@ def execute(
                 raw_value=raw_value,
                 return_value=return_value,
                 decode_error=decode_error,
+                tx_info=tx_info,
             )
             method_results.append(abi_result)
 
@@ -689,16 +691,18 @@ def __init__(
         raw_value: bytes,
         return_value: Any,
         decode_error: error,
+        tx_info: dict,
     ) -> None:
         self.tx_id = tx_id
         self.raw_value = raw_value
         self.return_value = return_value
         self.decode_error = decode_error
+        self.tx_info = tx_info
 
 
 class AtomicTransactionResponse:
     def __init__(
-        self, confirmed_round: int, tx_ids: List[str], results: ABIResult
+        self, confirmed_round: int, tx_ids: List[str], results: List[ABIResult]
     ) -> None:
         self.confirmed_round = confirmed_round
         self.tx_ids = tx_ids

algosdk/future/template.py

@@ -7,6 +7,10 @@
 
 
 class Template:
+    """
+    NOTE: This class is deprecated
+    """
+
     def get_address(self):
         """
         Return the address of the contract.
@@ -19,6 +23,8 @@ def get_program(self):
 
 class Split(Template):
     """
+    NOTE: This class is deprecated.
+
     Split allows locking algos in an account which allows transfering to two
     predefined addresses in a specified ratio such that for the given ratn and
     ratd parameters we have:
@@ -156,6 +162,8 @@ def get_split_funds_transaction(contract, amount: int, sp):
 
 class HTLC(Template):
     """
+    NOTE: This class is deprecated.
+
     Hash Time Locked Contract allows a user to recieve the Algo prior to a
     deadline (in terms of a round) by proving knowledge of a special value
     or to forfeit the ability to claim, returning it to the payer.
@@ -291,6 +299,8 @@ def get_transaction(contract, preimage, sp):
 
 class DynamicFee(Template):
     """
+    NOTE: This class is deprecated.
+
     DynamicFee contract allows you to create a transaction without
     specifying the fee. The fee will be determined at the moment of
     transfer.
@@ -416,6 +426,8 @@ def sign_dynamic_fee(self, private_key):
 
 class PeriodicPayment(Template):
     """
+    NOTE: This class is deprecated.
+
     PeriodicPayment contract enables creating an account which allows the
     withdrawal of a fixed amount of assets every fixed number of rounds to a
     specific Algrorand Address. In addition, the contract allows to add
@@ -528,6 +540,8 @@ def get_withdrawal_transaction(contract, sp):
 
 class LimitOrder(Template):
     """
+    NOTE: This class is deprecated.
+
     Limit Order allows to trade Algos for other assets given a specific ratio;
     for N Algos, swap for Rate * N Assets.
     ...

algosdk/logic.py

@@ -278,6 +278,12 @@ def get_application_address(appID: int) -> str:
     Returns:
         str: The address corresponding to that application's escrow account.
     """
+    assert isinstance(
+        appID, int
+    ), "(Expected an int for appID but got [{}] which has type [{}])".format(
+        appID, type(appID)
+    )
+
     to_sign = constants.APPID_PREFIX + appID.to_bytes(8, "big")
     checksum = encoding.checksum(to_sign)
     return encoding.encode_address(checksum)

algosdk/v2client/algod.py

@@ -1,14 +1,10 @@
-from urllib.request import Request, urlopen
+import base64
+import json
 from urllib import parse
 import urllib.error
-import json
-import base64
-from .. import error
-from .. import encoding
-from .. import constants
-from .. import future
-import msgpack
-from .. import util
+from urllib.request import Request, urlopen
+
+from .. import constants, encoding, error, future, logic, util
 
 api_version_path_prefix = "/v2"
 

requirements.txt

@@ -1,3 +1,5 @@
 .
 black==21.9b0
+glom==20.11.0
+pytest==6.2.5
 git+https://github.com/behave/behave

run_integration.sh

@@ -7,7 +7,7 @@ pushd $rootdir
 
 # Reset test harness
 rm -rf test-harness
-git clone --single-branch --branch master https://github.com/algorand/algorand-sdk-testing.git test-harness
+git clone --single-branch --branch zc2c https://github.com/algorand/algorand-sdk-testing.git test-harness
 
 ## Copy feature files into the project resources
 mkdir -p test/features

test/environment.py

@@ -32,7 +32,7 @@ def encode_bytes(d):
                 encode_bytes(d[i])
             else:
                 if isinstance(d[i], bytes):
-                    d[i] = base64.b64encode(v).decode()
+                    d[i] = base64.b64encode(d[i]).decode()
     return d