Merge branch 'release/v1.16.0'

Author: algojack

.circleci/config.yml

@@ -25,7 +25,7 @@ jobs:
       - checkout
       - run: pip install -r requirements.txt
       - run: black --check .
-      - run: python3 test_unit.py
+      - run: pytest tests/unit_tests
   integration-test:
     parameters:
       python-version:

.github/release.yml

@@ -0,0 +1,20 @@
+changelog:
+  exclude:
+    labels:
+      - Skip-Release-Notes
+  categories:
+    - title: Bugfixes
+      labels:
+        - Bug-Fix
+    - title: New Features
+      labels:
+        - New Feature
+    - title: Enhancements
+      labels:
+        - Enhancement
+    - title: Not Yet Enabled
+      labels:
+        - Not-Yet-Enabled
+    - title: Other
+      labels:
+        - "*"

.github/workflows/pr-type-category.yml

@@ -0,0 +1,24 @@
+name: Check PR category and type
+on:
+  pull_request:
+    branches:
+      - develop
+    types: [opened, synchronize, reopened, labeled, unlabeled, edited]
+jobs:
+  check_label:
+    runs-on: ubuntu-latest
+    name: Check PR Category and Type
+    steps:
+      - name: Checking for correct number of required github pr labels
+        uses: mheap/github-action-required-labels@v2
+        with:
+          mode: exactly
+          count: 1
+          labels: "New Feature, Enhancement, Bug-Fix, Not-Yet-Enabled, Skip-Release-Notes"
+
+      - name: "Checking for PR Category in PR title. Should be like '<category>: <pr title>'."
+        run: |
+          if [[ ! "${{ github.event.pull_request.title }}" =~ ^.{2,}\:.{2,} ]]; then
+            echo "## PR Category is missing from PR title. Please add it like '<category>: <pr title>'." >> GITHUB_STEP_SUMMARY
+            exit 1
+          fi

.gitignore

@@ -114,7 +114,7 @@ venv.bak/
 
 # Testing files
 *.feature
-test/features
+tests/features
 test-harness
 
 # Build files

CHANGELOG.md

@@ -1,5 +1,23 @@
 # Changelog
 
+# v1.16.0
+
+## What's Changed
+
+### New Features
+* Dev Tools: Source map decoder by @barnjamin in https://github.com/algorand/py-algorand-sdk/pull/353
+
+### Enhancements
+* Github-Actions: Adding pr title and label checks by @algojack in https://github.com/algorand/py-algorand-sdk/pull/358
+
+### Other
+* Implement new step asserting that AtomicTransactionComposer's attempt to add a method can fail with a particular error by @tzaffi in https://github.com/algorand/py-algorand-sdk/pull/347
+* Split up  unit test files and rename tests directory to test by @algochoi in https://github.com/algorand/py-algorand-sdk/pull/351
+* App page const by @barnjamin in https://github.com/algorand/py-algorand-sdk/pull/357
+
+**Full Changelog**: https://github.com/algorand/py-algorand-sdk/compare/v1.15.0...v1.16.0
+
+
 # v1.15.0
 
 ## What's Changed

Makefile

@@ -1,10 +1,10 @@
-UNITS = "@unit.abijson or @unit.abijson.byname or @unit.algod or @unit.algod.ledger_refactoring or @unit.applications or @unit.atomic_transaction_composer or @unit.dryrun or @unit.dryrun.trace.application or @unit.feetest or @unit.indexer or @unit.indexer.ledger_refactoring or @unit.indexer.logs or @unit.offline or @unit.rekey or @unit.transactions.keyreg or @unit.responses or @unit.responses.231 or @unit.tealsign or @unit.transactions or @unit.transactions.payment or @unit.responses.unlimited_assets"
+UNITS = "@unit.abijson or @unit.abijson.byname or @unit.algod or @unit.algod.ledger_refactoring or @unit.applications or @unit.atc_method_args or @unit.atomic_transaction_composer or @unit.dryrun or @unit.dryrun.trace.application or @unit.feetest or @unit.indexer or @unit.indexer.ledger_refactoring or @unit.indexer.logs or @unit.offline or @unit.rekey or @unit.transactions.keyreg or @unit.responses or @unit.responses.231 or @unit.tealsign or @unit.transactions or @unit.transactions.payment or @unit.responses.unlimited_assets or @unit.sourcemap"
 unit:
-	behave --tags=$(UNITS) test -f progress2
+	behave --tags=$(UNITS) tests -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.keyregtxn or @send"
+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.keyregtxn or @send or @compile.sourcemap"
 integration:
-	behave --tags=$(INTEGRATIONS) test -f progress2
+	behave --tags=$(INTEGRATIONS) tests -f progress2
 
 PYTHON_VERSION ?= 3.8
 docker-test:

algosdk/__init__.py

@@ -16,5 +16,6 @@
 from . import v2client
 from . import wallet
 from . import wordlist
+from . import source_map
 
 name = "algosdk"

algosdk/constants.py

@@ -89,6 +89,9 @@
 LOGIC_SIG_MAX_SIZE = 1000
 """int: max size of a teal program and its arguments in bytes"""
 
+APP_PAGE_MAX_SIZE = 2048
+"""int: max size of a page for an application in bytes"""
+
 ZERO_ADDRESS = "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAY5HFKQ"
 """str: algorand encoded address of 32 zero bytes"""
 
@@ -130,3 +133,4 @@
 max_asset_decimals = MAX_ASSET_DECIMALS
 logic_sig_max_cost = LOGIC_SIG_MAX_COST
 logic_sig_max_size = LOGIC_SIG_MAX_SIZE
+app_page_max_size = APP_PAGE_MAX_SIZE

algosdk/error.py

@@ -222,3 +222,11 @@ def __init__(self, msg):
 class AtomicTransactionComposerError(Exception):
     def __init__(self, msg):
         super().__init__(msg)
+
+
+class SourceMapVersionError(Exception):
+    def __init__(self, version):
+        Exception.__init__(
+            self,
+            "Only SourceMap version 3 is supported, got: {}".format(version),
+        )

algosdk/source_map.py

@@ -0,0 +1,85 @@
+from typing import Dict, Any, List, Tuple
+
+from algosdk.error import SourceMapVersionError
+
+
+class SourceMap:
+    """
+    Decodes a VLQ-encoded source mapping between PC values and TEAL source code lines.
+    Spec available here: https://sourcemaps.info/spec.html
+
+    Args:
+        source_map (dict(str, Any)): source map JSON from algod
+    """
+
+    def __init__(self, source_map: Dict[str, Any]):
+
+        self.version: int = source_map["version"]
+
+        if self.version != 3:
+            raise SourceMapVersionError(self.version)
+
+        self.sources: List[str] = source_map["sources"]
+
+        self.mappings: str = source_map["mappings"]
+
+        pc_list = [
+            _decode_int_value(raw_val) for raw_val in self.mappings.split(";")
+        ]
+
+        self.pc_to_line: Dict[int, int] = {}
+        self.line_to_pc: Dict[int, List[int]] = {}
+
+        last_line = 0
+        for index, line_delta in enumerate(pc_list):
+            # line_delta is None if the line number has not changed
+            # or if the line is empty
+            if line_delta is not None:
+                last_line = last_line + line_delta
+
+            if last_line not in self.line_to_pc:
+                self.line_to_pc[last_line] = []
+
+            self.line_to_pc[last_line].append(index)
+            self.pc_to_line[index] = last_line
+
+    def get_line_for_pc(self, pc: int) -> int:
+        return self.pc_to_line.get(pc, None)
+
+    def get_pcs_for_line(self, line: int) -> List[int]:
+        return self.line_to_pc.get(line, None)
+
+
+def _decode_int_value(value: str) -> int:
+    # Mappings may have up to 5 segments:
+    # Third segment represents the zero-based starting line in the original source represented.
+    decoded_value = _base64vlq_decode(value)
+    return decoded_value[2] if decoded_value else None
+
+
+"""
+Source taken from: https://gist.github.com/mjpieters/86b0d152bb51d5f5979346d11005588b
+"""
+
+_b64chars = b"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/"
+_b64table = [None] * (max(_b64chars) + 1)
+for i, b in enumerate(_b64chars):
+    _b64table[b] = i
+
+shiftsize, flag, mask = 5, 1 << 5, (1 << 5) - 1
+
+
+def _base64vlq_decode(vlqval: str) -> Tuple[int]:
+    """Decode Base64 VLQ value"""
+    results = []
+    shift = value = 0
+    # use byte values and a table to go from base64 characters to integers
+    for v in map(_b64table.__getitem__, vlqval.encode("ascii")):
+        value += (v & mask) << shift
+        if v & flag:
+            shift += shiftsize
+            continue
+        # determine sign and add to results
+        results.append((value >> 1) * (-1 if value & 1 else 1))
+        shift = value = 0
+    return results

algosdk/v2client/algod.py

@@ -347,7 +347,7 @@ def suggested_params(self, **kwargs):
             res["min-fee"],
         )
 
-    def compile(self, source, **kwargs):
+    def compile(self, source, source_map=False, **kwargs):
         """
         Compile TEAL source with remote algod.
 
@@ -365,9 +365,9 @@ def compile(self, source, **kwargs):
             {"Content-Type": "application/x-binary"},
         )
         kwargs["headers"] = headers
-
+        params = {"sourcemap": source_map}
         return self.algod_request(
-            "POST", req, data=source.encode("utf-8"), **kwargs
+            "POST", req, params=params, data=source.encode("utf-8"), **kwargs
         )
 
     def dryrun(self, drr, **kwargs):

run_integration.sh

@@ -10,8 +10,8 @@ rm -rf test-harness
 git clone --single-branch --branch master https://github.com/algorand/algorand-sdk-testing.git test-harness
 
 ## Copy feature files into the project resources
-mkdir -p test/features
-cp -r test-harness/features/* test/features
+mkdir -p tests/features
+cp -r test-harness/features/* tests/features
 
 # Build SDK testing environment
 docker build -t py-sdk-testing --build-arg PYTHON_VERSION="${PYTHON_VERSION}" -f Dockerfile "$(pwd)"

setup.py

@@ -9,7 +9,7 @@
     description="Algorand SDK in Python",
     author="Algorand",
     author_email="pypiservice@algorand.com",
-    version="v1.15.0",
+    version="v1.16.0",
     long_description=long_description,
     long_description_content_type="text/markdown",
     license="MIT",