Remove keyring tag - zenroom improvements/fixes (#291)

* removed keyring tag from zenroom tests
* removed keyring tag mishandling (zenroom) from cryptoconditions. using cyptoconditions 1.1.0 from now on
* fixed doc-build
* fixed docstring issue
* removed doc-building workflow and tox usage
* fixed import issue
* fixed connectionerror obj resolution in tests

Signed-off-by: Jürgen Eckel <juergen@riddleandcode.com>

.github/workflows/documenation.yml

@@ -1,35 +0,0 @@
-# Copyright © 2020 Interplanetary Database Association e.V.,
-# Planetmint and IPDB software contributors.
-# SPDX-License-Identifier: (Apache-2.0 AND CC-BY-4.0)
-# Code is Apache-2.0 and docs are CC-BY-4.0
-
-name: Documentation
-on: [push, pull_request]
-
-jobs:
-  documentation:
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Check out repository code
-        uses: actions/checkout@v3
-
-      - name: Setup python
-        uses: actions/setup-python@v4
-        with:
-          python-version: 3.9
-
-      - name: Install tox
-        run: python -m pip install --upgrade tox tox-gh-actions
-
-      - name: Install dependencies
-        run: pip install .'[dev]'
-
-      - name: Run tox
-        run: tox -e docsroot
-
-        
-
-      
-
-       

.gitignore

@@ -53,7 +53,6 @@ pip-delete-this-directory.txt
 
 # Unit test / coverage reports
 htmlcov/
-.tox/
 .coverage
 .coverage.*
 .cache

CHANGELOG.md

@@ -25,6 +25,9 @@ For reference, the possible headings are:
 * **Known Issues**
 * **Notes**
 
+## [1.4.1] - 2022-21-12
+* **fixed** inconsistent cryptocondition keyring tag handling. Using cryptoconditions > 1.1.0 from now on.
+
 ## [1.4.0] - 2022-12-12
 * **Added** added upgrade compatibility to older nodes to support v2.0 TX validity for nodes supporting v3.0 transactions (planetmint-transactions >= 0.4.1)
 

docker-compose.yml

@@ -41,7 +41,6 @@ services:
       - ./setup.py:/usr/src/app/setup.py
       - ./setup.cfg:/usr/src/app/setup.cfg
       - ./pytest.ini:/usr/src/app/pytest.ini
-      - ./tox.ini:/usr/src/app/tox.ini
     environment:
       PLANETMINT_DATABASE_BACKEND: tarantool_db 
       PLANETMINT_DATABASE_HOST: tarantool

docs/root/source/conf.py

@@ -54,13 +54,13 @@ import sphinx_rtd_theme
 
 extensions = [
     "myst_parser",
+    "sphinx.ext.napoleon",
     "sphinx.ext.autosectionlabel",
     "sphinx.ext.autodoc",
     "sphinx.ext.intersphinx",
     "sphinx.ext.coverage",
     "sphinx.ext.viewcode",
     "sphinx.ext.todo",
-    "sphinx.ext.napoleon",
     "sphinxcontrib.httpdomain",
     "aafigure.sphinxext",
     #'sphinx_toolbox.collapse',

docs/root/source/connecting/http-samples/api-index-response.http

@@ -4,7 +4,7 @@ Content-Type: application/json
 {
   "assets": "/assets/",
   "blocks": "/blocks/",
-  "docs": "https://docs.planetmint.io/projects/server/en/v1.3.1/http-client-server-api.html",
+  "docs": "https://docs.planetmint.io/projects/server/en/v1.4.1/http-client-server-api.html",
   "metadata": "/metadata/",
   "outputs": "/outputs/",
   "streamedblocks": "ws://localhost:9985/api/v1/streams/valid_blocks",

docs/root/source/connecting/http-samples/get-block-response.http

@@ -7,15 +7,13 @@ Content-Type: application/json
     {
       "assets": [
         {
-          "data": {
+          "data": "QmQP5C3PmhH9oB84n7YqSY4WVqmYatdoo1BdwhH4zmcwqM"
-            "msg": "Hello Planetmint!"
-          }
         }
       ],
-      "id": "61e1312b80705e0dabb948c9d78dae7f62d64832abda822b13d89c4a7305d4ac",
+      "id": "0fdeb547670bbea980389df53cf5a91e60159339084c6b0b5cc0b5494a679530",
       "inputs": [
         {
-          "fulfillment": "pGSAIDE5i63cn4X8T8N1sZ2mGkJD5lNRnBM4PZgI_zvzbr-cgUCWcUaLa2U-nkmZ6oYj14aeV6B4TJH2NvZ8k2ZTwcGiaiCGXDQT2dEPfMCFwM8lwSousafCu4c7EgVZ1GzUDjsN",
+          "fulfillment": "pGSAIDE5i63cn4X8T8N1sZ2mGkJD5lNRnBM4PZgI_zvzbr-cgUDklzRb5aUQz9slbaqSWap1AfC-cacTCN3CGtFy2LPK7JKEqKG2b0KQXnUcFksk_KH_v6ImFXHsclKSp1OJkIEI",
           "fulfills": null,
           "owners_before": [
             "4K9sWUMFwTgaDGPfdynrbxWqWS6sWmKbZoTjxLtVUibD"
@@ -39,7 +37,7 @@ Content-Type: application/json
           ]
         }
       ],
-      "version": "2.0"
+      "version": "3.0"
     }
   ]
 }

docs/root/source/connecting/http-samples/get-block-txid-request.http

@@ -1,3 +1,3 @@
-GET /api/v1/blocks?transaction_id=61e1312b80705e0dabb948c9d78dae7f62d64832abda822b13d89c4a7305d4ac HTTP/1.1
+GET /api/v1/blocks?transaction_id=0fdeb547670bbea980389df53cf5a91e60159339084c6b0b5cc0b5494a679530 HTTP/1.1
 Host: example.com
 

docs/root/source/connecting/http-samples/get-tx-by-asset-request.http

@@ -1,3 +1,3 @@
-GET /api/v1/transactions?operation=TRANSFER&asset_id=61e1312b80705e0dabb948c9d78dae7f62d64832abda822b13d89c4a7305d4ac HTTP/1.1
+GET /api/v1/transactions?operation=TRANSFER&asset_id=0fdeb547670bbea980389df53cf5a91e60159339084c6b0b5cc0b5494a679530 HTTP/1.1
 Host: example.com
 

docs/root/source/connecting/http-samples/get-tx-by-asset-response.http

@@ -4,16 +4,16 @@ Content-Type: application/json
 [{
   "assets": [
     {
-      "id": "61e1312b80705e0dabb948c9d78dae7f62d64832abda822b13d89c4a7305d4ac"
+      "id": "0fdeb547670bbea980389df53cf5a91e60159339084c6b0b5cc0b5494a679530"
     }
   ],
-  "id": "b6e1ab3d48bbbbb0e40b952e70ec5d439b2745e0ba0c44b4ee877657e9ac33f0",
+  "id": "8d11fe2bd91c4747a41e0c3dbe1400c511175be42f008d6cff92cbfa9e04f799",
   "inputs": [
     {
-      "fulfillment": "pGSAIDE5i63cn4X8T8N1sZ2mGkJD5lNRnBM4PZgI_zvzbr-cgUA4BB4fxDXK3CQTbKpH5gTAN76NG-iopNuuDEfBbZ1Fl-ipNU46t8VCvK9ghm9Q53aFRW6DDiW5wcWXxY0sS4EJ",
+      "fulfillment": "pGSAIDE5i63cn4X8T8N1sZ2mGkJD5lNRnBM4PZgI_zvzbr-cgUCh-rpO-xqDm2fngjzxnKc39G16FpFMo0y50sHT7_uo1Itzvh4jsxnSGco2HjG6ZF-lSiGsASZ4uIIHuPM57yUI",
       "fulfills": {
         "output_index": 0,
-        "transaction_id": "61e1312b80705e0dabb948c9d78dae7f62d64832abda822b13d89c4a7305d4ac"
+        "transaction_id": "0fdeb547670bbea980389df53cf5a91e60159339084c6b0b5cc0b5494a679530"
       },
       "owners_before": [
         "4K9sWUMFwTgaDGPfdynrbxWqWS6sWmKbZoTjxLtVUibD"
@@ -37,21 +37,21 @@ Content-Type: application/json
       ]
     }
   ],
-  "version": "2.0"
+  "version": "3.0"
 },
 {
   "assets": [
     {
-      "id": "61e1312b80705e0dabb948c9d78dae7f62d64832abda822b13d89c4a7305d4ac"
+      "id": "0fdeb547670bbea980389df53cf5a91e60159339084c6b0b5cc0b5494a679530"
     }
   ],
-  "id": "e43d3f93d90d22ef11c21607e3415bfcda4e0c7dd60412fbb55daf32978a3126",
+  "id": "45c929b66d1b10db6c3c3e6b1adddc0778b473fced4a1f403c2646b25f3fd983",
   "inputs": [
     {
-      "fulfillment": "pGSAICw7Ul-c2lG6NFbHp3FbKRC7fivQcNGO7GS4wV3A-1QggUBjj_XTjB3yJdG8JMNKnkkHvcX_BTOkl-YacRD4yKqxUCeL-VTgbrLgi5a3gGxNJcTkZP1gF0nsby8cgV4xmOcB",
+      "fulfillment": "pGSAICw7Ul-c2lG6NFbHp3FbKRC7fivQcNGO7GS4wV3A-1QggUAc6OAQcXppDxCazw0UK2nwghctKNiZYDDsSOkAn0eQE8QjZ7GLzJpVb92oGXw_4FF7cLE0gg3nNxu7taQ8xakE",
       "fulfills": {
         "output_index": 0,
-        "transaction_id": "b6e1ab3d48bbbbb0e40b952e70ec5d439b2745e0ba0c44b4ee877657e9ac33f0"
+        "transaction_id": "8d11fe2bd91c4747a41e0c3dbe1400c511175be42f008d6cff92cbfa9e04f799"
       },
       "owners_before": [
         "3yfQPHeWAa1MxTX9Zf9176QqcpcnWcanVZZbaHb8B3h9"
@@ -75,5 +75,5 @@ Content-Type: application/json
       ]
     }
   ],
-  "version": "2.0"
+  "version": "3.0"
 }]

docs/root/source/connecting/http-samples/get-tx-id-request.http

@@ -1,3 +1,3 @@
-GET /api/v1/transactions/61e1312b80705e0dabb948c9d78dae7f62d64832abda822b13d89c4a7305d4ac HTTP/1.1
+GET /api/v1/transactions/0fdeb547670bbea980389df53cf5a91e60159339084c6b0b5cc0b5494a679530 HTTP/1.1
 Host: example.com
 

docs/root/source/connecting/http-samples/get-tx-id-response.http

@@ -4,15 +4,13 @@ Content-Type: application/json
 {
   "assets": [
     {
-      "data": {
+      "data": "QmQP5C3PmhH9oB84n7YqSY4WVqmYatdoo1BdwhH4zmcwqM"
-        "msg": "Hello Planetmint!"
-      }
     }
   ],
-  "id": "61e1312b80705e0dabb948c9d78dae7f62d64832abda822b13d89c4a7305d4ac",
+  "id": "0fdeb547670bbea980389df53cf5a91e60159339084c6b0b5cc0b5494a679530",
   "inputs": [
     {
-      "fulfillment": "pGSAIDE5i63cn4X8T8N1sZ2mGkJD5lNRnBM4PZgI_zvzbr-cgUCWcUaLa2U-nkmZ6oYj14aeV6B4TJH2NvZ8k2ZTwcGiaiCGXDQT2dEPfMCFwM8lwSousafCu4c7EgVZ1GzUDjsN",
+      "fulfillment": "pGSAIDE5i63cn4X8T8N1sZ2mGkJD5lNRnBM4PZgI_zvzbr-cgUDklzRb5aUQz9slbaqSWap1AfC-cacTCN3CGtFy2LPK7JKEqKG2b0KQXnUcFksk_KH_v6ImFXHsclKSp1OJkIEI",
       "fulfills": null,
       "owners_before": [
         "4K9sWUMFwTgaDGPfdynrbxWqWS6sWmKbZoTjxLtVUibD"
@@ -36,5 +34,5 @@ Content-Type: application/json
       ]
     }
   ],
-  "version": "2.0"
+  "version": "3.0"
 }

docs/root/source/connecting/http-samples/index-response.http

@@ -6,7 +6,7 @@ Content-Type: application/json
     "v1": {
       "assets": "/api/v1/assets/",
       "blocks": "/api/v1/blocks/",
-      "docs": "https://docs.planetmint.io/projects/server/en/v1.2.2/http-client-server-api.html",
+      "docs": "https://docs.planetmint.io/projects/server/en/v1.4.1/http-client-server-api.html",
       "metadata": "/api/v1/metadata/",
       "outputs": "/api/v1/outputs/",
       "streamedblocks": "ws://localhost:9985/api/v1/streams/valid_blocks",
@@ -15,7 +15,7 @@ Content-Type: application/json
       "validators": "/api/v1/validators"
     }
   },
-  "docs": "https://docs.planetmint.io/projects/server/en/v1.2.2/",
+  "docs": "https://docs.planetmint.io/projects/server/en/v1.4.1/",
   "software": "Planetmint",
-  "version": "1.3.1"
+  "version": "1.4.1"
 }

docs/root/source/connecting/http-samples/post-tx-request.http

@@ -5,15 +5,13 @@ Content-Type: application/json
 {
   "assets": [
     {
-      "data": {
+      "data": "QmQP5C3PmhH9oB84n7YqSY4WVqmYatdoo1BdwhH4zmcwqM"
-        "msg": "Hello Planetmint!"
-      }
     }
   ],
-  "id": "61e1312b80705e0dabb948c9d78dae7f62d64832abda822b13d89c4a7305d4ac",
+  "id": "0fdeb547670bbea980389df53cf5a91e60159339084c6b0b5cc0b5494a679530",
   "inputs": [
     {
-      "fulfillment": "pGSAIDE5i63cn4X8T8N1sZ2mGkJD5lNRnBM4PZgI_zvzbr-cgUCWcUaLa2U-nkmZ6oYj14aeV6B4TJH2NvZ8k2ZTwcGiaiCGXDQT2dEPfMCFwM8lwSousafCu4c7EgVZ1GzUDjsN",
+      "fulfillment": "pGSAIDE5i63cn4X8T8N1sZ2mGkJD5lNRnBM4PZgI_zvzbr-cgUDklzRb5aUQz9slbaqSWap1AfC-cacTCN3CGtFy2LPK7JKEqKG2b0KQXnUcFksk_KH_v6ImFXHsclKSp1OJkIEI",
       "fulfills": null,
       "owners_before": [
         "4K9sWUMFwTgaDGPfdynrbxWqWS6sWmKbZoTjxLtVUibD"
@@ -37,5 +35,5 @@ Content-Type: application/json
       ]
     }
   ],
-  "version": "2.0"
+  "version": "3.0"
 }

docs/root/source/connecting/http-samples/post-tx-response.http

@@ -4,15 +4,13 @@ Content-Type: application/json
 {
   "assets": [
     {
-      "data": {
+      "data": "QmQP5C3PmhH9oB84n7YqSY4WVqmYatdoo1BdwhH4zmcwqM"
-        "msg": "Hello Planetmint!"
-      }
     }
   ],
-  "id": "61e1312b80705e0dabb948c9d78dae7f62d64832abda822b13d89c4a7305d4ac",
+  "id": "0fdeb547670bbea980389df53cf5a91e60159339084c6b0b5cc0b5494a679530",
   "inputs": [
     {
-      "fulfillment": "pGSAIDE5i63cn4X8T8N1sZ2mGkJD5lNRnBM4PZgI_zvzbr-cgUCWcUaLa2U-nkmZ6oYj14aeV6B4TJH2NvZ8k2ZTwcGiaiCGXDQT2dEPfMCFwM8lwSousafCu4c7EgVZ1GzUDjsN",
+      "fulfillment": "pGSAIDE5i63cn4X8T8N1sZ2mGkJD5lNRnBM4PZgI_zvzbr-cgUDklzRb5aUQz9slbaqSWap1AfC-cacTCN3CGtFy2LPK7JKEqKG2b0KQXnUcFksk_KH_v6ImFXHsclKSp1OJkIEI",
       "fulfills": null,
       "owners_before": [
         "4K9sWUMFwTgaDGPfdynrbxWqWS6sWmKbZoTjxLtVUibD"
@@ -36,5 +34,5 @@ Content-Type: application/json
       ]
     }
   ],
-  "version": "2.0"
+  "version": "3.0"
 }

planetmint/backend/connection.py

@@ -3,14 +3,12 @@
 # SPDX-License-Identifier: (Apache-2.0 AND CC-BY-4.0)
 # Code is Apache-2.0 and docs are CC-BY-4.0
 
-import tarantool
 import logging
 
 from itertools import repeat
 from importlib import import_module
 from transactions.common.exceptions import ConfigurationError
 from planetmint.config import Config
-from planetmint.backend.exceptions import ConnectionError
 
 BACKENDS = {
     "tarantool_db": "planetmint.backend.tarantool.connection.TarantoolDBConnection",
@@ -69,6 +67,7 @@ class DBConnection(metaclass=DBSingleton):
         **kwargs
     ):
         """Create a new :class:`~.Connection` instance.
+
         Args:
             host (str): the host to connect to.
             port (int): the port to connect to.

planetmint/backend/query.py

@@ -27,12 +27,12 @@ def store_asset(asset: dict, connection):
 @singledispatch
 def store_assets(assets: list, connection):
     """Write a list of assets to the assets table.
-    backend
-        Args:
-            assets (list): a list of assets to write.
 
-        Returns:
+    Args:
-            The database response.
+        assets (list): a list of assets to write.
+
+    Returns:
+        The database response.
     """
 
     raise NotImplementedError
@@ -193,6 +193,7 @@ def get_metadata(connection, transaction_ids):
 @singledispatch
 def get_assets(connection, asset_ids) -> list:
     """Get a list of assets from the assets table.
+
     Args:
         asset_ids (list): a list of ids for the assets to be retrieved from
         the database.

planetmint/backend/tarantool/connection.py

@@ -9,7 +9,8 @@ import tarantool
 from planetmint.config import Config
 from transactions.common.exceptions import ConfigurationError
 from planetmint.utils import Lazy
-from planetmint.backend.connection import DBConnection, ConnectionError
+from planetmint.backend.connection import DBConnection
+from planetmint.backend.exceptions import ConnectionError
 
 logger = logging.getLogger(__name__)
 

planetmint/lib.py

@@ -579,7 +579,7 @@ class Planetmint(object):
         asset from the asset table and reconstructs the transaction.
 
         Args:
-            tx_dict_list (:list:`dict` or :obj:`dict`): The transaction dict or
+            tx_dict_list (:obj:`list` of :dict: or :obj:`dict`): The transaction dict or
                 list of transaction dict as returned from the database.
 
         Returns:

planetmint/version.py

@@ -3,7 +3,7 @@
 # SPDX-License-Identifier: (Apache-2.0 AND CC-BY-4.0)
 # Code is Apache-2.0 and docs are CC-BY-4.0
 
-__version__ = "1.4.0"
+__version__ = "1.4.1"
 __short_version__ = "1.4"
 
 # Supported Tendermint versions

setup.py

@@ -103,7 +103,6 @@ tests_require = [
     "pytest-flask",
     "pytest-aiohttp",
     "pytest-asyncio",
-    "tox",
 ] + docs_require
 
 install_requires = [
@@ -130,7 +129,7 @@ install_requires = [
     "planetmint-ipld>=0.0.3",
     "pyasn1>=0.4.8",
     "python-decouple",
-    "planetmint-transactions>=0.4.1",
+    "planetmint-transactions>=0.5.0",
 ]
 
 setup(

tests/assets/test_zenroom_signing.py

@@ -56,11 +56,11 @@ def test_zenroom_signing():
     biolabs = generate_key_pair()
     version = "3.0"
 
-    alice = json.loads(zencode_exec(GENERATE_KEYPAIR).output)["keyring"]
+    alice = json.loads(zencode_exec(GENERATE_KEYPAIR).output)
-    bob = json.loads(zencode_exec(GENERATE_KEYPAIR).output)["keyring"]
+    bob = json.loads(zencode_exec(GENERATE_KEYPAIR).output)
 
-    zen_public_keys = json.loads(zencode_exec(SK_TO_PK.format("Alice"), keys=json.dumps({"keyring": alice})).output)
+    zen_public_keys = json.loads(zencode_exec(SK_TO_PK.format("Alice"), keys=json.dumps(alice)).output)
-    zen_public_keys.update(json.loads(zencode_exec(SK_TO_PK.format("Bob"), keys=json.dumps({"keyring": bob})).output))
+    zen_public_keys.update(json.loads(zencode_exec(SK_TO_PK.format("Bob"), keys=json.dumps(bob)).output))
 
     zenroomscpt = ZenroomSha256(script=FULFILL_SCRIPT, data=INITIAL_STATE, keys=zen_public_keys)
     print(f"zenroom is: {zenroomscpt.script}")

tests/backend/test_connection.py

@@ -7,7 +7,7 @@ import pytest
 
 
 def test_get_connection_raises_a_configuration_error(monkeypatch):
-    from planetmint.backend.connection import ConnectionError
+    from planetmint.backend.exceptions import ConnectionError
     from planetmint.backend.tarantool.connection import TarantoolDBConnection
 
     with pytest.raises(ConnectionError):

tests/test_core.py

@@ -9,7 +9,8 @@ from planetmint.version import __tm_supported_versions__
 from transactions.types.assets.create import Create
 from transactions.types.assets.transfer import Transfer
 from transactions.common.exceptions import ConfigurationError
-from planetmint.backend.connection import Connection, ConnectionError
+from planetmint.backend.connection import Connection
+from planetmint.backend.exceptions import ConnectionError
 
 
 @pytest.fixture

tox.ini

@@ -1,31 +0,0 @@
-[tox]
-skipsdist = true
-envlist = py{39}, docsroot
-
-[gh-actions]
-python =
-    3.9 = docsroot
-
-[base]
-basepython = python3.9
-deps = pip>=9.0.1
-
-[testenv]
-usedevelop = True
-setenv =
-    PYTHONPATH={toxinidir}:{toxinidir}/planetmint
-deps = {[base]deps}
-install_command = pip install {opts} {packages}
-extras = test
-commands = pytest -v -n auto --cov=planetmint --basetemp={envtmpdir}
-
-[testenv:docsroot]
-basepython = {[base]basepython}
-changedir = docs/root/source
-deps =
-    {[base]deps}
-    typing-extensions
-    -r{toxinidir}/docs/root/requirements.txt
-extras = None
-commands = sphinx-build -b html -d {envtmpdir}/doctrees . {envtmpdir}/html
-