0.11.0 (2022-09-15) (#60)

* 0.11.0 (2022-09-15)
------------------
Changed
^^^^^^^
* Breaking: fixed the faulty default placemnt of the "data"-tag into assets. Thereby caused obfuscation got removed.
* Breaking: adjusted to the IPLD definitions of planetmint.

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

* blackified

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

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

Author: eckelj

.vscode/settings.json

@@ -0,0 +1,4 @@
+{
+    "python.testing.unittestEnabled": false,
+    "python.testing.pytestEnabled": true
+}

CHANGELOG.rst

@@ -6,6 +6,12 @@
 Changelog
 =========
 
+0.11.0 (2022-09-15)
+------------------
+Changed
+^^^^^^^
+* Breaking: fixed the faulty default placemnt of the "data"-tag into assets. Thereby caused obfuscation got removed.
+* Breaking: adjusted to the IPLD definitions of planetmint. 
 
 0.6.2 (2022-09-08)
 ------------------

planetmint_driver/__init__.py

@@ -7,4 +7,4 @@
 
 __author__ = "Planetmint"
 __email__ = "devs@planetmint.com"
-__version__ = "0.6.2"
+__version__ = "0.11.0"

planetmint_driver/common/transaction.py

@@ -561,8 +561,8 @@ def __init__(
         if inputs and not isinstance(inputs, list):
             raise TypeError("`inputs` must be a list instance or None")
 
-        if metadata is not None and not isinstance(metadata, dict):
-            raise TypeError("`metadata` must be a dict or None")
+        if metadata is not None and not isinstance(metadata, str):
+            raise TypeError("`metadata` must be a str or None")
 
         self.version = version if version is not None else self.VERSION
         self.operation = operation
@@ -662,7 +662,7 @@ def create(cls, tx_signers, recipients, metadata=None, asset=None):
         # generate inputs
         inputs.append(Input.generate(tx_signers))
 
-        return cls(cls.CREATE, {"data": asset}, inputs, outputs, metadata)
+        return cls(cls.CREATE, asset, inputs, outputs, metadata)
 
     @classmethod
     def transfer(cls, inputs, recipients, asset_id, metadata=None):

planetmint_driver/offchain.py

@@ -182,7 +182,7 @@ def prepare_create_transaction(*, signers, recipients=None, asset=None, metadata
         signers,
         recipients,
         metadata=metadata,
-        asset=asset["data"] if asset else None,
+        asset=asset,
     )
     return transaction.to_dict()
 

setup.py

@@ -34,6 +34,7 @@
     "pytest-sugar",
     "pytest-xdist",
     "responses~=0.5.1",
+    "planetmint-ipld>=0.0.3",
 ]
 
 dev_require = ["ipdb", "ipython", "pre-commit", "jinja2==3.0.0"]
@@ -51,7 +52,7 @@
 
 setup(
     name="planetmint_driver",
-    version="0.10.0",
+    version="0.11.0",
     description="Python driver for Planetmint",
     long_description=readme + "\n\n" + changelog,
     long_description_content_type="text/x-rst",

tests/conftest.py

@@ -12,6 +12,7 @@
 from cryptoconditions import Ed25519Sha256
 from pytest import fixture
 from sha3 import sha3_256
+from ipld import multihash, marshal
 
 from planetmint_driver.common.transaction import Transaction, _fulfillment_to_details
 
@@ -232,7 +233,7 @@ def alice_transaction_obj(alice_pubkey):
     return Transaction.create(
         tx_signers=[alice_pubkey],
         recipients=[([alice_pubkey], 1)],
-        asset={"serial_number": serial_number},
+        asset={"data": multihash(marshal({"serial_number": serial_number}))},
     )
 
 
@@ -263,7 +264,7 @@ def persisted_random_transaction(alice_pubkey, alice_privkey):
     from uuid import uuid4
     from planetmint_driver.common.transaction import Transaction
 
-    asset = {"data": {"x": str(uuid4())}}
+    asset = {"data": multihash(marshal({"x": str(uuid4())}))}
     tx = Transaction.create(
         tx_signers=[alice_pubkey],
         recipients=[([alice_pubkey], 1)],
@@ -277,7 +278,7 @@ def sent_persisted_random_transaction(alice_pubkey, alice_privkey, transactions_
     from uuid import uuid4
     from planetmint_driver.common.transaction import Transaction
 
-    asset = {"data": {"x": str(uuid4())}}
+    asset = {"data": multihash(marshal({"x": str(uuid4())}))}
     tx = Transaction.create(
         tx_signers=[alice_pubkey],
         recipients=[([alice_pubkey], 1)],
@@ -322,7 +323,7 @@ def prepared_carol_bicycle_transaction(carol_keypair, bicycle_data):
     fulfillment = make_fulfillment(carol_keypair.public_key)
     tx = {
         "asset": {
-            "data": bicycle_data,
+            "data": multihash(marshal(bicycle_data)),
         },
         "metadata": None,
         "operation": "CREATE",
@@ -360,7 +361,7 @@ def prepared_carol_car_transaction(carol_keypair, car_data):
     fulfillment = make_fulfillment(carol_keypair.public_key)
     tx = {
         "asset": {
-            "data": car_data,
+            "data": multihash(marshal(car_data)),
         },
         "metadata": None,
         "operation": "CREATE",
@@ -515,7 +516,7 @@ def persisted_transfer_dimi_car_to_ewy(
 def unsigned_transaction():
     return {
         "operation": "CREATE",
-        "asset": {"data": {"serial_number": "NNP43x-DaYoSWg=="}},
+        "asset": {"data": multihash(marshal({"serial_number": "NNP43x-DaYoSWg=="}))},
         "version": "2.0",
         "outputs": [
             {
@@ -546,7 +547,17 @@ def unsigned_transaction():
 
 
 @fixture
-def text_search_assets(api_root, transactions_api_full_url, alice_pubkey, alice_privkey):
+def search_assets():
+    assets = [
+        {"data": multihash(marshal({"msg": "Hello Planetmint 1!"}))},
+        {"data": multihash(marshal({"msg": "Hello Planetmint 2!"}))},
+        {"data": multihash(marshal({"msg": "Hello Planetmint 3!"}))},
+    ]
+    return assets
+
+
+@fixture
+def text_search_assets(api_root, transactions_api_full_url, alice_pubkey, alice_privkey, search_assets):
     # check if the fixture was already executed
     response = requests.get(api_root + "/assets", params={"search": "planetmint"})
     response = response.json()
@@ -557,20 +568,15 @@ def text_search_assets(api_root, transactions_api_full_url, alice_pubkey, alice_
         return assets
 
     # define the assets that will be used by text_search tests
-    assets = [
-        {"msg": "Hello Planetmint 1!"},
-        {"msg": "Hello Planetmint 2!"},
-        {"msg": "Hello Planetmint 3!"},
-    ]
 
     # write the assets to Planetmint
     assets_by_txid = {}
-    for asset in assets:
+    for asset in search_assets:
         tx = Transaction.create(
             tx_signers=[alice_pubkey],
             recipients=[([alice_pubkey], 1)],
             asset=asset,
-            metadata={"But here's my number": "So call me maybe"},
+            metadata="So call me maybe",
         )
         tx_signed = tx.sign([alice_privkey])
         requests.post(transactions_api_full_url, json=tx_signed.to_dict())

tests/test_driver.py

@@ -11,6 +11,7 @@
 from requests.utils import default_headers
 from sha3 import sha3_256
 from cryptoconditions import Ed25519Sha256
+from ipld import multihash, marshal
 
 
 class TestPlanetmint:
@@ -190,12 +191,16 @@ def create_transaction():
                 operation="CREATE",
                 signers=carol.public_key,
                 asset={
-                    "data": {
-                        "asset": {
-                            "serial_number": str(uuid.uuid4()),
-                            "manufacturer": str(uuid.uuid4()),
-                        },
-                    },
+                    "data": multihash(
+                        marshal(
+                            {
+                                "asset": {
+                                    "serial_number": str(uuid.uuid4()),
+                                    "manufacturer": str(uuid.uuid4()),
+                                },
+                            },
+                        )
+                    )
                 },
             )
 
@@ -269,21 +274,36 @@ def test_assets_get_search_no_results(self, driver):
         response = driver.assets.get(search="abcdef")
         assert response == []
 
-    @mark.parametrize("search", [("Planetmint"), ("Planetmint")])
-    def test_assets_get_search(self, driver, text_search_assets, search):
+    @mark.parametrize(
+        "search",
+        [
+            (multihash(marshal({"msg": "Hello Planetmint 1!"}))),
+            (multihash(marshal({"msg": "Hello Planetmint 2!"}))),
+            (multihash(marshal({"msg": "Hello Planetmint 3!"}))),
+        ],
+    )
+    def test_assets_get_search(self, driver, text_search_assets, search, search_assets):
         # we have 3 assets that match 'planetmint' in text_search_assets
-        response = driver.assets.get(search=search)
-        assert len(response) == 3
+        for asset in search_assets:
+            response = driver.assets.get(search=asset["data"])
+            assert len(response) == 1
 
         for asset in response:
-            assert text_search_assets[asset["id"]] == asset["data"]
+            assert text_search_assets[asset["id"]]["data"] == asset["data"]
 
-    @mark.parametrize("search", [("Planetmint"), ("Planetmint")])
+    @mark.parametrize(
+        "search",
+        [
+            (multihash(marshal({"msg": "Hello Planetmint 1!"}))),
+            (multihash(marshal({"msg": "Hello Planetmint 2!"}))),
+            (multihash(marshal({"msg": "Hello Planetmint 3!"}))),
+        ],
+    )
     def test_assets_get_search_limit(self, driver, search):
         # we have 3 assets that match 'planetmint' in text_search_assets but
         # we are limiting the number of returned results to 2
         response = driver.assets.get(search=search, limit=2)
-        assert len(response) == 2
+        assert len(response) == 1
 
     def test_metadata_get_search_no_results(self, driver):
         # no metadata matches the search string

tests/test_offchain.py

@@ -42,7 +42,7 @@ def test_prepare_create_transaction_default(alice_pubkey):
     assert "id" in create_transaction
     assert "version" in create_transaction
     assert "asset" in create_transaction
-    assert create_transaction["asset"] == {"data": None}
+    assert create_transaction["asset"] == None
     assert "outputs" in create_transaction
     assert "inputs" in create_transaction
     assert "metadata" in create_transaction