Fix parsing parameter with an optional value (#201)

Author: droserasprout

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 Please use [this](https://docs.gitlab.com/ee/development/changelog.html) document as guidelines to keep a changelog.
 
+## [unreleased]
+
+### Fixed
+
+* tzkt: Fixed parsing parameter with an optional value.
+
 ## 4.0.2 - 2022-01-06
 
 ### Added
@@ -12,7 +18,7 @@ Please use [this](https://docs.gitlab.com/ee/development/changelog.html) documen
 
 * tzkt: Fixed crash due to unprocessed pysignalr exception.
 * tzkt: Fixed parsing `OperationData.amount` field.
-* tzkt: Fixed parsing storage with top-level boolean fields
+* tzkt: Fixed parsing storage with top-level boolean fields.
 
 ## 4.0.1 - 2021-12-30
 

scripts/init_tests.sh

@@ -1,9 +1,10 @@
 #$/bin/bash
 cd tests/test_dipdup
-for name in "asdf" "qwer" "hjkl" "zxcv" "rewq" "hen_subjkt"
+for name in "asdf" "qwer" "hjkl" "zxcv" "rewq" "hen_subjkt" "kolibri_ovens"
 do
     dipdup -c $name.yml init
     mkdir -p types/$name/
     mv $name/types/$name/storage.py types/$name/storage.py
+    mv $name/types/$name/parameter/set_delegate.py types/$name/set_delegate.py || true
     rm -r $name
 done

src/dipdup/datasources/tzkt/datasource.py

@@ -703,9 +703,10 @@ def convert_operation(cls, operation_json: Dict[str, Any], type_: Optional[str]
             # NOTE: TzKT returns None for `default` entrypoint
             if entrypoint is None:
                 entrypoint = 'default'
-            # NOTE: Empty parameter in this case means `{"prim": "Unit"}`
-            if parameter is None:
-                parameter = {}
+
+                # NOTE: Empty parameter in this case means `{"prim": "Unit"}`
+                if parameter is None:
+                    parameter = {}
 
         return OperationData(
             type=type_ or operation_json['type'],

tests/test_dipdup/kolibri_ovens.json

@@ -0,0 +1,65 @@
+[
+    {
+        "type": "transaction",
+        "id": 44936407,
+        "level": 1416383,
+        "timestamp": "2021-04-05T22:44:41Z",
+        "block": "BLgbUHkPeeegP2jxEYBkY1Zf6erXmWckBNBK7kuZePUdQHSvFp9",
+        "hash": "oos6a4U5DhAEaSLqxLmuiytwpP6VZTwESWxosWRzAy6e5emhm8r",
+        "counter": 12504503,
+        "sender": {
+            "address": "tz1aD4DmnnGyqxL7neCZ5JMQ6UnpcrKCpajE"
+        },
+        "gasLimit": 15600,
+        "gasUsed": 14500,
+        "storageLimit": 0,
+        "storageUsed": 0,
+        "bakerFee": 1868,
+        "storageFee": 0,
+        "allocationFee": 0,
+        "target": {
+            "address": "KT1TdV4PMVk2ssQhEw8ch4PNnnVv11JqAzn7"
+        },
+        "amount": 0,
+        "parameter": {
+            "entrypoint": "setDelegate",
+            "value": null
+        },
+        "storage": {
+            "owner": "tz1aD4DmnnGyqxL7neCZ5JMQ6UnpcrKCpajE",
+            "isLiquidated": false,
+            "interestIndex": "1012163739772748415",
+            "borrowedTokens": "250000000000000000000",
+            "stabilityFeeTokens": "0",
+            "ovenProxyContractAddress": "KT1JdufSdfg3WyxWJcCRNsBFV9V3x9TQBkJ2"
+        },
+        "status": "applied",
+        "hasInternals": true,
+        "parameters": "{\"entrypoint\":\"setDelegate\",\"value\":{\"prim\":\"None\"}}"
+    },
+    {
+        "type": "delegation",
+        "id": 44936408,
+        "level": 1416383,
+        "timestamp": "2021-04-05T22:44:41Z",
+        "block": "BLgbUHkPeeegP2jxEYBkY1Zf6erXmWckBNBK7kuZePUdQHSvFp9",
+        "hash": "oos6a4U5DhAEaSLqxLmuiytwpP6VZTwESWxosWRzAy6e5emhm8r",
+        "counter": 12504503,
+        "initiator": {
+            "address": "tz1aD4DmnnGyqxL7neCZ5JMQ6UnpcrKCpajE"
+        },
+        "sender": {
+            "address": "KT1TdV4PMVk2ssQhEw8ch4PNnnVv11JqAzn7"
+        },
+        "nonce": 12,
+        "gasLimit": 0,
+        "gasUsed": 1000,
+        "bakerFee": 0,
+        "amount": 100000000,
+        "prevDelegate": {
+            "alias": "Tessellated Geometry",
+            "address": "tz1abmz7jiCV2GH2u81LRrGgAFFgvQgiDiaf"
+        },
+        "status": "applied"
+    }
+]

tests/test_dipdup/kolibri_ovens.yml

@@ -0,0 +1,24 @@
+spec_version: 1.2
+package: kolibri_ovens
+
+contracts:
+  kolibri_ovens:
+    address: KT1KV31DTzktr8t7edCLUzzgEN54cQtksJou
+    typename: kolibri_ovens
+
+datasources:
+  tzkt:
+    kind: tzkt
+    url: https://api.tzkt.io
+
+indexes:
+  kolibri_ovens:
+    kind: operation
+    datasource: tzkt
+    contracts:
+      - kolibri_ovens
+    handlers:
+      - callback: on_set_delegate
+        pattern:
+          - destination: kolibri_ovens
+            entrypoint: setDelegate

tests/test_dipdup/test_models.py

@@ -18,6 +18,8 @@
 from tests.test_dipdup.types.ftzfun.storage import FtzFunStorage
 from tests.test_dipdup.types.hen_subjkt.storage import HenSubjktStorage
 from tests.test_dipdup.types.hjkl.storage import HjklStorage
+from tests.test_dipdup.types.kolibri_ovens.set_delegate import SetDelegateParameter
+from tests.test_dipdup.types.kolibri_ovens.storage import KolibriOvensStorage
 from tests.test_dipdup.types.listofmaps.storage import ListOfMapsStorage
 from tests.test_dipdup.types.qwer.storage import QwerStorage
 from tests.test_dipdup.types.rewq.storage import RewqStorage
@@ -334,3 +336,17 @@ def test_hen_subjkt(self) -> None:
         self.assertIsInstance(storage_obj, HenSubjktStorage)
         self.assertIsInstance(storage_obj.entries, dict)
         self.assertEqual(storage_obj.entries['tz1Y1j7FK1X9Rrv2VdPz5bXoU7SszF8W1RnK'], True)  # type: ignore
+
+    def test_kolibri_ovens(self) -> None:
+        with open(join(dirname(__file__), 'kolibri_ovens.json')) as f:
+            operations_json = json.load(f)
+
+        # Act
+        operations = [TzktDatasource.convert_operation(op) for op in operations_json]
+        storage_obj = deserialize_storage(operations[0], KolibriOvensStorage)
+        parameter_obj = SetDelegateParameter.parse_obj(operations[0].parameter_json)
+
+        # Assert
+        self.assertIsInstance(storage_obj, KolibriOvensStorage)
+        self.assertIsInstance(parameter_obj, SetDelegateParameter)
+        self.assertEqual(parameter_obj.__root__, None)

tests/test_dipdup/types/kolibri_ovens/__init__.py

@@ -0,0 +1,12 @@
+# generated by datamodel-codegen:
+#   filename:  setDelegate.json
+
+from __future__ import annotations
+
+from typing import Optional
+
+from pydantic import BaseModel
+
+
+class SetDelegateParameter(BaseModel):
+    __root__: Optional[str]

tests/test_dipdup/types/kolibri_ovens/set_delegate.py

@@ -0,0 +1,19 @@
+# generated by datamodel-codegen:
+#   filename:  storage.json
+
+from __future__ import annotations
+
+from pydantic import BaseModel
+from pydantic import Extra
+
+
+class KolibriOvensStorage(BaseModel):
+    class Config:
+        extra = Extra.forbid
+
+    borrowedTokens: str
+    interestIndex: str
+    isLiquidated: bool
+    ovenProxyContractAddress: str
+    owner: str
+    stabilityFeeTokens: str