Merge pull request #225 from aeternity/release/4.2.0

Release/4.2.0

Author: noandrea

.gitignore

@@ -2,7 +2,6 @@ venv
 .idea
 **/*.pyc
 .pytest_cache
-/epoch/
 .vscode
 aepp_sdk.egg-info
 dist
@@ -11,3 +10,6 @@ coverage.xml
 docker-compose.override.yml
 test-results.xml
 .coverage
+private
+.DS_Store
+.envrc

CHANGELOG.md

@@ -1,9 +1,38 @@
 # Changelog
+
 All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+
+## [4.2.0](https://github.com/aeternity/aepp-sdk-python/releases/tag/4.2.0) ([compare](https://github.com/aeternity/aepp-sdk-python/compare/4.0.0...4.2.0)) - 2019-08-15
+
+### Bug Fixes
+- fix: improve error handling ([3e96065](https://github.com/aeternity/aepp-sdk-python/commit/3e960652380571284e9a0ca5a1810719f0069573)).
+- fix: contract bytecode decoding function call in main ([0fa8fd3](https://github.com/aeternity/aepp-sdk-python/commit/0fa8fd385d65cc29206ad9aeaa6712b03210c8ce)).
+
+### Code Refactoring
+- refactor: Imporove vm/abi detection ([bb3fcf1](https://github.com/aeternity/aepp-sdk-python/commit/bb3fcf14318ac930b0ff46f96ede7579bcd6661c)).
+- refactor: improve consistency of api calls ([62472f5](https://github.com/aeternity/aepp-sdk-python/commit/62472f57a4aebcb18d9cfc3dbb6a1f0bb791000b)).
+- refactor: improve reliability of the hashing submodule ([777f0a7](https://github.com/aeternity/aepp-sdk-python/commit/777f0a7c80090baf09357a84ae44cc5796e41c06)).
+- refactor: move vm and abi retrieval to the node subm ([9b2488b](https://github.com/aeternity/aepp-sdk-python/commit/9b2488b09667055e57699fecc7166e849edc8198)).
+- refactor: remove legacy unused code ([872cc02](https://github.com/aeternity/aepp-sdk-python/commit/872cc02e875539bdfc28c59160f074c0cc428530)).
+
+### Features
+- feat(contract): add ability to unpack a compiled contract ([39d9f44](https://github.com/aeternity/aepp-sdk-python/commit/39d9f4414d844eb4d9ba32bf93bfe2256a98c761)).
+- feat(ga): add support to generalized accounts ([9e8c02c](https://github.com/aeternity/aepp-sdk-python/commit/9e8c02c8e96aaa326ebf01fb861cab61ede7c527)).
+- feat(ga): detect ga account when signing from a node client ([ae542b2](https://github.com/aeternity/aepp-sdk-python/commit/ae542b2285f4888e10b55601291bf0a7398114b5)).
+- feat(state-channels): added settle method support ([efd2ced](https://github.com/aeternity/aepp-sdk-python/commit/efd2cedd2e22036b399dd2427376a6fbd4d42308)).
+- feat(state-channels): state channels ga awareness ([42c233f](https://github.com/aeternity/aepp-sdk-python/commit/42c233fa84b73509ed1854a49716361d382d7436)).
+- feat: add function to decode a compiled/encoded contract object ([59afdaf](https://github.com/aeternity/aepp-sdk-python/commit/59afdafa526333092a3c3f3739a619cd72d14a94)).
+- feat: add compiler v3.2.0 support ([65759dc](https://github.com/aeternity/aepp-sdk-python/commit/65759dca1538045c44540b975adff38fb1c94c7f)).
+
+### Docs
+
+- docs: add documentation for ga in the docs folder
+
+
 ## [4.1.0](https://github.com/aeternity/aepp-sdk-python/releases/tag/4.1.0) ([compare](https://github.com/aeternity/aepp-sdk-python/compare/4.0.0...4.1.0))
 
 ### Features

Makefile

@@ -12,8 +12,7 @@ build: build-dist
 
 build-dist:
 	@echo build 
-	python setup.py sdist
-	python setup.py bdist_wheel
+	poetry build
 	@echo done
 
 test: test-all

README.md

@@ -4,7 +4,7 @@
 [![Build Status](https://ci.aepps.com/buildStatus/icon?job=aepp-sdk-python/develop)](https://ci.aepps.com/job/aepp-sdk-python/job/develop/)
 [![PyPI version](https://badge.fury.io/py/aepp-sdk.svg)](https://badge.fury.io/py/aepp-sdk)
 
-## Introduction
+## Introduction 
 
 [This repo](https://github.com/aeternity/aepp-sdk-python) is for developing apps for the æternity blockchain in Python. Please see the [main dev site](https://dev.aepps.com) for instructions on accessing the testnet, and for running a local æternity node.
 

aeternity/__main__.py

@@ -13,7 +13,6 @@
 from aeternity.identifiers import NETWORK_ID_MAINNET
 from . import utils, signing, aens, defaults, exceptions
 from aeternity.contract import CompilerClient
-
 from datetime import datetime, timezone
 
 
@@ -833,6 +832,9 @@ def inspect(obj, height, force, wait, json_):
         elif obj.startswith("tx_"):
             v = _node_cli().verify(obj)
             _print_object(v, title="tx")
+        elif obj.startswith("cb_"):
+            v = CompilerClient.decode_bytecode(obj)
+            _print_object(v, title="contract")
         elif obj.isdigit() and int(obj) >= 0:
             v = _node_cli().get_key_block_by_height(height=int(obj))
             _print_object(v, title="block")

aeternity/channel.py

@@ -59,7 +59,7 @@ def __init__(self, **kwargs):
                                                     Applicable only for initiator (default: timeout_accept value)
         :param timeout_awaiting_open (int): The time frame the initiator has to start an outgoing noise session to the responder's node.
                                                         Applicable only for responder (default: timeout_idle's value)
-        :param sign (function): Function which verifies and signs transactions
+        :param sign (TxSigner): Instance of TxSigner
         :param offchain_message_handler (function): Callback method to receive off-chain messages.
                                                                 If not provided, all the incoming messages will be ignored.
         :param error_handler (function): Callback method to receive error messages.
@@ -112,7 +112,7 @@ async def __message_handler(self):
                 if msg['method'] == 'channels.message' and ChannelState.MESSAGE in self.handlers:
                     self.handlers[ChannelState.MESSAGE](msg)
                 if msg['method'].startswith('channels.sign'):
-                    tx = msg['params']['data']['tx']
+                    tx = msg['params']['data']['signed_tx']
                     if msg['method'] == f'channels.sign.{self.params.role}_sign':
                         self.__sign_channel_tx(f'channels.{self.params.role}_sign', tx)
                     else:
@@ -182,11 +182,11 @@ def __sign_channel_tx(self, method, tx):
         """
         Sign the transactions received over channel by the provided sign method
         """
-        signedTx = self.sign(tx)
+        encoded_tx = self.sign.cosign_encode_transaction(tx).tx
         self.__enqueue_action({
             'method': method,
             'params': {
-                'tx': signedTx.tx
+                'signed_tx': encoded_tx
             }
         })
 

aeternity/contract.py

@@ -1,8 +1,6 @@
 from aeternity import exceptions, __compiler_compatibility__
 from aeternity import utils, defaults, hashing, openapi, identifiers
-import requests
 import namedtupled
-from requests import ConnectionError
 
 
 class CompilerError(exceptions.AException):
@@ -21,20 +19,6 @@ def __init__(self, compiler_url='http://localhost:3080'):
         self.compiler_url = compiler_url
         self.compiler_cli = openapi.OpenAPICli(compiler_url, compatibility_version_range=__compiler_compatibility__)
 
-    def _post(self, path, body, _response_object_name="CompilerReply"):
-        """
-        Execute the post request to the compiler
-        """
-        http_reply = None
-        try:
-            http_reply = requests.post(f'{self.compiler_url}{path}', json=body)
-            object_reply = namedtupled.map(http_reply.json(), _nt_name=_response_object_name)
-            if http_reply.status_code == 200:
-                return object_reply
-            raise CompilerError(f"Error: {http_reply.desc}", code=http_reply.status_code)
-        except ConnectionError as e:
-            raise Exception(f"Connection error to the compiler at {self.compiler_url}", e)
-
     def compile(self, source_code, compiler_options={}):
         body = dict(
             code=source_code,
@@ -83,6 +67,52 @@ def decode_calldata_with_sourcecode(self, sourcecode, function, encoded_calldata
         }
         return self.compiler_cli.decode_calldata_source(body=body)
 
+    @staticmethod
+    def decode_bytecode(compiled):
+        """
+        Decode an encoded contract to it's components
+        :param compiled: the encoded bytecode to decode as got from the 'compile' function
+        :return: a named tuple with a decoded contract
+        """
+        if isinstance(compiled, str):
+            if not utils.prefix_match(identifiers.BYTECODE, compiled):
+                raise ValueError(f"Invalid input, expecting {identifiers.BYTECODE}_ prefix")
+            # unpack the transaction
+            raw_contract = hashing.decode_rlp(compiled)
+        elif isinstance(compiled, bytes):
+            # unpack the transaction
+            raw_contract = hashing.decode_rlp(compiled)
+        else:
+            raise ValueError(f"Invalid input type")
+
+        if not isinstance(raw_contract, list) or len(raw_contract) < 6:
+            raise ValueError(f"Invalid contract structure")
+
+        # print(raw_contract)
+        tag = hashing._int_decode(raw_contract[0])
+        vsn = hashing._int_decode(raw_contract[1])
+        if tag != identifiers.OBJECT_TAG_SOPHIA_BYTE_CODE:
+            raise ValueError(f"Invalid input, expecting object type {identifiers.OBJECT_TAG_SOPHIA_BYTE_CODE}, got {tag}")
+        # this is the hash
+        contract_data = dict(
+            raw=raw_contract,
+            tag=tag,
+            vsn=vsn,
+            src_hash=raw_contract[2],
+            type_info=[],
+            bytecode=raw_contract[4],
+            compiler_version=hashing._binary_decode(raw_contract[5], str),
+        )
+        # print(type_info)
+        for t in raw_contract[3]:
+            contract_data["type_info"].append(dict(
+                fun_hash=t[0],
+                fun_name=hashing._binary_decode(t[1], str),
+                arg_type=t[2],
+                out_type=t[3],
+            ))
+        return namedtupled.map(contract_data, _nt_name="ContractBin")
+
 
 class ContractError(Exception):
     pass
@@ -118,7 +148,6 @@ def call(self, contract_id,
              gas=defaults.CONTRACT_GAS,
              gas_price=defaults.CONTRACT_GAS_PRICE,
              fee=defaults.FEE,
-             vm_version=None,
              abi_version=None,
              tx_ttl=defaults.TX_TTL):
         """Call a sophia contract"""
@@ -128,13 +157,12 @@ def call(self, contract_id,
         # check if the contract exists
         try:
             self.client.get_contract(pubkey=contract_id)
-        except exceptions.OpenAPIClientException:
+        except openapi.OpenAPIClientException:
             raise ContractError(f"Contract {contract_id} not found")
 
         try:
             # retrieve the correct vm/abi version
-            vm, abi = self._get_vm_abi_versions()
-            vm_version = vm if vm_version is None else vm_version
+            _, abi = self.client.get_vm_abi_versions()
             abi_version = abi if abi_version is None else abi_version
             # get the transaction builder
             txb = self.client.tx_builder
@@ -149,7 +177,7 @@ def call(self, contract_id,
             # post the transaction to the chain
             self.client.broadcast_transaction(tx_signed.tx, tx_signed.hash)
             return tx_signed
-        except exceptions.OpenAPIClientException as e:
+        except openapi.OpenAPIClientException as e:
             raise ContractError(e)
 
     def get_call_object(self, tx_hash):
@@ -182,7 +210,7 @@ def create(self,
         """
         try:
             # retrieve the correct vm/abi version
-            vm, abi = self._get_vm_abi_versions()
+            vm, abi = self.client.get_vm_abi_versions()
             vm_version = vm if vm_version is None else vm_version
             abi_version = abi if abi_version is None else abi_version
             # get the transaction builder
@@ -193,7 +221,7 @@ def create(self,
             tx = txb.tx_contract_create(account.get_address(), bytecode, init_calldata,
                                         amount, deposit, gas, gas_price, vm_version, abi_version,
                                         fee, ttl, nonce)
-            # store the contract address in the instance variabl
+            # store the contract address in the instance variable
             self.address = hashing.contract_id(account.get_address(), nonce)
             # sign the transaction
             tx_signed = self.client.sign_transaction(account, tx, metadata={"contract_id": self.address})
@@ -202,16 +230,3 @@ def create(self,
             return tx_signed
         except openapi.OpenAPIClientException as e:
             raise ContractError(e)
-
-    def _get_vm_abi_versions(self):
-        """
-        Check the version of the node and retrieve the correct values for abi and vm version
-        """
-        protocol_version = self.client.get_consensus_protocol_version()
-        if protocol_version == identifiers.PROTOCOL_ROMA:
-            return identifiers.CONTRACT_ROMA_VM, identifiers.CONTRACT_ROMA_ABI
-        if protocol_version == identifiers.PROTOCOL_MINERVA:
-            return identifiers.CONTRACT_MINERVA_VM, identifiers.CONTRACT_MINERVA_ABI
-        if protocol_version == identifiers.PROTOCOL_FORTUNA:
-            return identifiers.CONTRACT_FORTUNA_VM, identifiers.CONTRACT_FORTUNA_ABI
-        raise exceptions.UnsupportedNodeVersion(f"Version {self.client.api_version} is not supported")

aeternity/defaults.py

@@ -16,7 +16,7 @@
 TX_TTL = 0
 FEE = 0
 # contracts
-CONTRACT_GAS = 1000000000
+CONTRACT_GAS = 10000
 CONTRACT_GAS_PRICE = 1000000000
 CONTRACT_DEPOSIT = 0
 CONTRACT_AMOUNT = 0
@@ -44,3 +44,7 @@
 # channels
 CHANNEL_ENDPOINT = 'channel'
 CHANNEL_URL = 'ws://127.0.0.1:3014'
+# Generalized accounts
+GA_AUTH_FUNCTION = "authorize"
+GA_MAX_AUTH_FUN_GAS = 50000
+GA_ACCOUNTS_NONCE = 0  # for tx in ga transactions the nonce must be 0

aeternity/hashing.py

@@ -8,7 +8,7 @@
 from nacl.hash import blake2b
 from nacl.encoding import RawEncoder
 
-from aeternity import identifiers, utils
+from aeternity import identifiers
 
 
 def _base58_encode(data):
@@ -70,16 +70,18 @@ def encode(prefix: str, data) -> str:
 
 def decode(data):
     """
-    Decode data using the default encoding/decoding algorithm
+    Decode data using the default encoding/decoding algorithm.
+    It will raise ValueError if the input data is not recognized and cannot be decoded
     :param data: a encoded and prefixed string (ex tx_..., sg_..., ak_....)
     :return: the raw bytes
     """
-
-    if data is None or len(data.strip()) < 3 or data[2] != '_':
+    if data is None or len(data.strip()) <= 3 or data[2] != '_':
         raise ValueError('Invalid hash')
     if data[0:2] in identifiers.IDENTIFIERS_B64:
         return _base64_decode(data[3:])
-    return _base58_decode(data[3:])
+    if data[0:2] in identifiers.IDENTIFIERS_B58:
+        return _base58_decode(data[3:])
+    raise ValueError(f"Unrecognized prefix {data[0:2]}")
 
 
 def encode_rlp(prefix, data):
@@ -176,7 +178,10 @@ def _binary(val):
         s = int(math.ceil(val.bit_length() / 8))
         return val.to_bytes(s, 'big')
     if isinstance(val, str):
-        return val.encode("utf-8")
+        try:
+            return decode(val)
+        except ValueError:
+            return val.encode("utf-8")
     if isinstance(val, bytes):
         return val
     raise ValueError("Byte serialization not supported")
@@ -194,9 +199,11 @@ def _binary_decode(data, data_type=None):
 
 
 def _id(id_str):
-    """Utility function to create and _id type"""
-    if not utils.is_valid_hash(id_str):
-        raise ValueError(f"Unrecognized entity {id_str}")
+    """
+    Utility function to create an _id type
+    """
+    # if not utils.is_valid_hash(id_str):
+    #     raise ValueError(f"Unrecognized entity {id_str}")
     id_tag = identifiers.ID_PREFIX_TO_TAG.get(id_str[0:2])
     if id_tag is None:
         raise ValueError(f"Unrecognized prefix {id_str[0:2]}")