Search for %metadata big_map in nested sturctures (#285)

.github/workflows/release.yml

@@ -2,7 +2,7 @@ name: Release
 on:
   push:
     tags:
-      - '*.*.*'
+      - '*.*.0'
 
 jobs:
   build:

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 3.3.5 - 2022-02-27
+
+### Fixed
+
+* Metadata big map can be located in a nested structure, not necessarily on the top-level (as per TZIP-16)
+
 ## 3.3.4 - 2021-12-23
 
 ### Fixed

src/pytezos/contract/interface.py

@@ -27,6 +27,7 @@
 from pytezos.michelson.program import MichelsonProgram
 from pytezos.michelson.sections import ViewSection
 from pytezos.michelson.types.base import generate_pydoc
+from pytezos.michelson.types import BigMapType, BytesType
 from pytezos.operation.group import OperationGroup
 from pytezos.rpc import ShellQuery
 
@@ -402,10 +403,19 @@ def _get_token_metadata_from_view(self, token_id: int) -> Optional[ContractToken
     @cached_property
     def metadata_url(self) -> Optional[str]:
         try:
-            return self.storage['metadata']['']().decode()
+            metadata = self.storage.data.find(lambda x: x.field_name == 'metadata' and isinstance(x, BigMapType))
+            if metadata is not None:
+                metadata_url = metadata['']
+                if isinstance(metadata_url, BytesType):
+                    return metadata_url.value.decode()
+                else:
+                    self._logger.info('Empty string key is not found in metadata big map')
+            else:
+                self._logger.info('Metadata big map not found')
         # FIXME: Dirty
         except (KeyError, AssertionError):
-            return None
+            self._logger.info('Failed to get metadata URI')
+        return None
 
     @property
     def parameter(self) -> ContractEntrypoint:

src/pytezos/michelson/types/base.py

@@ -1,5 +1,15 @@
 from copy import copy, deepcopy
-from typing import Any, List, Optional, Tuple, Type, Union, cast
+from collections.abc import Iterable
+from typing import (
+    Any,
+    List,
+    Optional,
+    Tuple,
+    Type,
+    Union,
+    cast,
+    Callable,
+)
 
 from pytezos.context.abstract import AbstractContext  # type: ignore
 from pytezos.michelson.forge import forge_micheline, unforge_micheline
@@ -214,6 +224,17 @@ def aggregate_lazy_diff(self, lazy_diff: List[dict], mode='readable') -> 'Michel
         assert len(self.args) == 0 or self.prim in ['contract', 'lambda', 'ticket', 'set']
         return copy(self)
 
+    def find(self, predicate: Callable[['MichelsonType'], bool]) -> Optional['MichelsonType']:
+        if predicate(self):
+            return self
+        if isinstance(self, Iterable):
+            for item in self:
+                if isinstance(item, MichelsonType):
+                    res = item.find(predicate)
+                    if res is not None:
+                        return res
+        return None
+
     def forge(self, mode='readable') -> bytes:
         val_expr = self.to_micheline_value(mode=mode)
         return forge_micheline(val_expr)

src/pytezos/michelson/types/big_map.py

@@ -1,6 +1,13 @@
 from copy import copy, deepcopy
-from typing import Dict, Generator, List, Optional, Tuple, Type, Union
-
+from typing import (
+    Callable,
+    Generator,
+    List,
+    Optional,
+    Tuple,
+    Type,
+    Union,
+)
 from pytezos.context.abstract import AbstractContext  # type: ignore
 from pytezos.michelson.forge import forge_script_expr
 from pytezos.michelson.micheline import Micheline, MichelineLiteral, MichelineSequence, parse_micheline_literal
@@ -192,6 +199,11 @@ def make_update(key: MichelsonType, val: Optional[MichelsonType]) -> dict:
         res.context = self.context
         return res
 
+    def find(self, predicate: Callable[['MichelsonType'], bool]) -> Optional['MichelsonType']:
+        if predicate(self):
+            return self
+        return None
+
     def attach_context(self, context: AbstractContext, big_map_copy=False):
         assert self.context is None, f'context already attached'
         self.context = context

src/pytezos/michelson/types/map.py

@@ -1,5 +1,11 @@
-from typing import Generator, List, Optional, Tuple, Type
-
+from typing import (
+    Generator,
+    List,
+    Optional,
+    Tuple,
+    Type,
+    Callable,
+)
 from pytezos.context.abstract import AbstractContext  # type: ignore
 from pytezos.michelson.micheline import Micheline, MichelineSequence, parse_micheline_value
 from pytezos.michelson.types.base import MichelsonType
@@ -124,6 +130,15 @@ def aggregate_lazy_diff(self, lazy_diff: List[dict], mode='readable'):
         items = [(key, val.aggregate_lazy_diff(lazy_diff, mode=mode)) for key, val in self.items]
         return type(self)(items)
 
+    def find(self, predicate: Callable[['MichelsonType'], bool]) -> Optional['MichelsonType']:
+        if predicate(self):
+            return self
+        for _, item in self:
+            res = item.find(predicate)
+            if res:
+                return res
+        return None
+
     def attach_context(self, context: AbstractContext, big_map_copy=False):
         for _, val in self.items:
             val.attach_context(context, big_map_copy=big_map_copy)

src/pytezos/michelson/types/option.py

@@ -1,4 +1,4 @@
-from typing import List, Optional, Type
+from typing import List, Optional, Type, Callable
 
 from pytezos.context.abstract import AbstractContext  # type: ignore
 from pytezos.michelson.micheline import Micheline, parse_micheline_value
@@ -113,3 +113,10 @@ def aggregate_lazy_diff(self, lazy_diff: List[dict], mode='readable') -> 'Michel
     def attach_context(self, context: AbstractContext, big_map_copy=False):
         if not self.is_none():
             self.item.attach_context(context, big_map_copy=big_map_copy)  # type: ignore
+
+    def find(self, predicate: Callable[['MichelsonType'], bool]) -> Optional['MichelsonType']:
+        if predicate(self):
+            return self
+        if self.item is not None:
+            return self.item.find(predicate)
+        return None

tests/integration_tests/test_metadata.py

@@ -15,3 +15,8 @@ def test_1(self):
         contract = client.contract("KT1Tg6WFuTU47Z8rPeBhDbgx1DmX1SWCZcZq")
         balance = contract.metadata.getBalance(("tz1WkYQMi1LSvge2ksaWtx5t4eqqLqgEskUM", 0)).storage_view()
         assert int(balance) > 0
+
+    def test_domains(self):
+        td = pytezos.using('mainnet').contract('KT1GBZmSxmnKJXGMdMLbugPfLyUPmuLSMwKS')
+        res = td.metadata.resolveAddress('tz1PN9FWDGoASBTvgppaQbbPdGhkrnTNmcVz').storage_view()
+        self.assertEqual('tz1PN9FWDGoASBTvgppaQbbPdGhkrnTNmcVz', res['address'])