add

ccxt/static_dependencies/starknet/cairo/v2/type_parser.py

@@ -0,0 +1,77 @@
+from __future__ import annotations
+
+from typing import Dict, Union
+
+from ...abi.v2.parser_transformer import parse
+from ..data_types import (
+    CairoType,
+    EnumType,
+    EventType,
+    StructType,
+    TypeIdentifier,
+)
+
+
+class UnknownCairoTypeError(ValueError):
+    """
+    Error thrown when TypeParser finds type that was not declared prior to parsing.
+    """
+
+    type_name: str
+
+    def __init__(self, type_name: str):
+        super().__init__(
+            # pylint: disable=line-too-long
+            f"Type '{type_name}' is not defined. Please report this issue at https://github.com/software-mansion/starknet.py/issues"
+        )
+        self.type_name = type_name
+
+
+class TypeParser:
+    """
+    Low level utility class for parsing Cairo types that can be used in external methods.
+    """
+
+    defined_types: Dict[str, Union[StructType, EnumType, EventType]]
+
+    def __init__(
+        self, defined_types: Dict[str, Union[StructType, EnumType, EventType]]
+    ):
+        """
+        TypeParser constructor.
+
+        :param defined_types: dictionary containing all defined types. For now, they can only be structures.
+        """
+        self.defined_types = defined_types
+        for name, defined_type in defined_types.items():
+            if name != defined_type.name:
+                raise ValueError(
+                    f"Keys must match name of type, '{name}' != '{defined_type.name}'."
+                )
+
+    def update_defined_types(
+        self, defined_types: Dict[str, Union[StructType, EnumType, EventType]]
+    ) -> None:
+        self.defined_types.update(defined_types)
+
+    def add_defined_type(
+        self, defined_type: Union[StructType, EnumType, EventType]
+    ) -> None:
+        self.defined_types.update({defined_type.name: defined_type})
+
+    def parse_inline_type(self, type_string: str) -> CairoType:
+        """
+        Inline type is one that can be used inline, for instance as return type. For instance
+        (core::felt252, (), (core::felt252,)). Structure can only be referenced in inline type, can't be defined
+        this way.
+
+        :param type_string: type to parse.
+        """
+        parsed = parse(type_string, self.defined_types)
+        if isinstance(parsed, TypeIdentifier):
+            for defined_name in self.defined_types.keys():
+                if parsed.name == defined_name.split("<")[0].strip(":"):
+                    return self.defined_types[defined_name]
+            raise UnknownCairoTypeError(parsed.name)
+
+        return parsed