Move Abi V0 files to starknet_py/abi/v0 (#1299)

tkumor3 · ddoktorski · web-flow · commit 303212e948a7 · 2024-02-23T09:46:11.000+01:00
* Move abi v0 to proper place

* fix imports

* Add information about many AbiParser versions

* update docs imports

* fix imports in docs

* add imports, update docs

* clean up

* Update docs/guide/serialization.rst

Co-authored-by: ddoktorski &lt;45050160+ddoktorski@users.noreply.github.com&gt;

* Update docs/migration_guide.rst

Co-authored-by: ddoktorski &lt;45050160+ddoktorski@users.noreply.github.com&gt;

* add alias

* add sections in docs

* clean up

* lint

---------

Co-authored-by: ddoktorski &lt;45050160+ddoktorski@users.noreply.github.com&gt;
diff --git a/docs/api/abi.rst b/docs/api/abi.rst
@@ -3,30 +3,86 @@ Abi
 
 Module containing representation of contract abi and parser for creating it from parsed json.
 
-.. py:module:: starknet_py.abi
+.. py:module:: starknet_py.abi.v2
 
-Parsing abi
------------
+Parsing abi v2
+--------------
 
 .. autoclass:: AbiParser
     :members: parse
 
 .. autoclass:: AbiParsingError
     :exclude-members: __init__, __new__
 
-Model
------------
+Model v2
+--------
+
+.. autoclass:: Abi
+    :exclude-members: __init__, __new__
+    :members: defined_structures, functions, constructor, l1_handler, events, defined_enums, interfaces, implementations
+
+.. autoclass:: starknet_py.abi.v2.Abi.Function
+    :members:
+    :undoc-members:
+    :member-order: groupwise
+
+.. autoclass:: starknet_py.abi.v2.Abi.Event
+    :members:
+    :undoc-members:
+    :member-order: groupwise
+
+.. py:module:: starknet_py.abi.v1
+
+Parsing abi v1
+--------------
+
+.. autoclass:: AbiParser
+    :members: parse
+
+.. autoclass:: AbiParsingError
+    :exclude-members: __init__, __new__
+
+Model v1
+--------
+
+.. autoclass:: Abi
+    :exclude-members: __init__, __new__
+    :members: defined_structures, functions, events, defined_enums
+
+.. autoclass:: starknet_py.abi.v1.Abi.Function
+    :members:
+    :undoc-members:
+    :member-order: groupwise
+
+.. autoclass:: starknet_py.abi.v1.Abi.Event
+    :members:
+    :undoc-members:
+    :member-order: groupwise
+
+.. py:module:: starknet_py.abi.v0
+
+Parsing abi v0
+--------------
+
+.. autoclass:: AbiParser
+    :members: parse
+
+.. autoclass:: AbiParsingError
+    :exclude-members: __init__, __new__
+
+Model v0
+--------
 
 .. autoclass:: Abi
     :exclude-members: __init__, __new__
     :members: defined_structures, functions, constructor, l1_handler, events
 
-.. autoclass:: starknet_py.abi.Abi.Function
+.. autoclass:: starknet_py.abi.v0.Abi.Function
     :members:
     :undoc-members:
     :member-order: groupwise
 
-.. autoclass:: starknet_py.abi.Abi.Event
+.. autoclass:: starknet_py.abi.v0.Abi.Event
     :members:
     :undoc-members:
     :member-order: groupwise
diff --git a/docs/guide/serialization.rst b/docs/guide/serialization.rst
@@ -88,9 +88,10 @@ For most use cases using high level :obj:`Contract <starknet_py.contract.Contrac
 and deserialization for you. If you need more flexibility you can use lower level serialization API, see :ref:`Serializers`
 for more details.
 
-:obj:`AbiParser <starknet_py.net.models.abi.parser.AbiParser>` transforms ABI into
-:obj:`Abi dataclass <starknet_py.net.models.abi.model.Abi>` that can be used for creating serializers. This way you can
-easily deserialize events or serialize function's inputs.
+:obj:`AbiParser <starknet_py.abi.v2.parser.AbiParser>` transforms ABI into
+:obj:`Abi class <starknet_py.abi.v2.model.Abi>` that can be used for creating serializers. This way you can
+easily deserialize events or serialize function's inputs. Remember to use the proper version of `AbiParser`
+which depends on parsed ABI version.
 
 Serializing function inputs and outputs
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
diff --git a/docs/migration_guide.rst b/docs/migration_guide.rst
@@ -9,6 +9,7 @@ Migration guide
 -----------------------
 
 1. :class:`StarknetEthProxyCheck` has been removed from the Proxy checks
+2. In :ref:`Abi` module the code related to Cairo 0 has been moved from ``starknet_py.abi`` to ``starknet_py.abi.v0``
 
 **********************
 0.19.0 Migration guide
diff --git a/starknet_py/abi/v0/__init__.py b/starknet_py/abi/v0/__init__.py
diff --git a/starknet_py/abi/v0/model.py b/starknet_py/abi/v0/model.py
diff --git a/starknet_py/abi/v0/parser.py b/starknet_py/abi/v0/parser.py
@@ -7,9 +7,9 @@
 
 from marshmallow import EXCLUDE
 
-from starknet_py.abi.model import Abi
-from starknet_py.abi.schemas import ContractAbiEntrySchema
-from starknet_py.abi.shape import (
+from starknet_py.abi.v0 import Abi
+from starknet_py.abi.v0.schemas import ContractAbiEntrySchema
+from starknet_py.abi.v0.shape import (
     CONSTRUCTOR_ENTRY,
     EVENT_ENTRY,
     FUNCTION_ENTRY,
diff --git a/starknet_py/abi/v0/parser_test.py b/starknet_py/abi/v0/parser_test.py
@@ -3,7 +3,7 @@
 import pytest
 
 import starknet_py.tests.e2e.fixtures.abi_structures as fixtures
-from starknet_py.abi.parser import AbiParser, AbiParsingError
+from starknet_py.abi.v0 import AbiParser, AbiParsingError
 from starknet_py.cairo.type_parser import UnknownCairoTypeError
 from starknet_py.tests.e2e.fixtures.constants import CONTRACTS_COMPILED_V0_DIR
 from starknet_py.tests.e2e.fixtures.misc import read_contract
diff --git a/starknet_py/abi/v0/schemas.py b/starknet_py/abi/v0/schemas.py
@@ -1,7 +1,7 @@
 from marshmallow import Schema, fields
 from marshmallow_oneofschema import OneOfSchema
 
-from starknet_py.abi.shape import (
+from starknet_py.abi.v0.shape import (
     CONSTRUCTOR_ENTRY,
     EVENT_ENTRY,
     FUNCTION_ENTRY,
diff --git a/starknet_py/abi/v0/schemas_test.py b/starknet_py/abi/v0/schemas_test.py
@@ -2,7 +2,7 @@
 
 from marshmallow import EXCLUDE
 
-from starknet_py.abi.schemas import ContractAbiEntrySchema
+from starknet_py.abi.v0.schemas import ContractAbiEntrySchema
 from starknet_py.tests.e2e.fixtures.constants import CONTRACTS_COMPILED_V0_DIR
 from starknet_py.tests.e2e.fixtures.misc import read_contract
 
diff --git a/starknet_py/abi/v0/shape.py b/starknet_py/abi/v0/shape.py
diff --git a/starknet_py/abi/v1/__init__.py b/starknet_py/abi/v1/__init__.py
@@ -0,0 +1,2 @@
+from .model import Abi
+from .parser import AbiParser, AbiParsingError
diff --git a/starknet_py/abi/v2/__init__.py b/starknet_py/abi/v2/__init__.py
@@ -0,0 +1,2 @@
+from .model import Abi
+from .parser import AbiParser, AbiParsingError
diff --git a/starknet_py/abi/v2/parser.py b/starknet_py/abi/v2/parser.py
@@ -7,7 +7,7 @@
 
 from marshmallow import EXCLUDE
 
-from starknet_py.abi.v2.model import Abi
+from starknet_py.abi.v2 import Abi
 from starknet_py.abi.v2.schemas import ContractAbiEntrySchema
 from starknet_py.abi.v2.shape import (
     CONSTRUCTOR_ENTRY,
diff --git a/starknet_py/abi/v2/parser_test.py b/starknet_py/abi/v2/parser_test.py
@@ -2,8 +2,7 @@
 
 import pytest
 
-from starknet_py.abi.v2.model import Abi
-from starknet_py.abi.v2.parser import AbiParser
+from starknet_py.abi.v2 import Abi, AbiParser
 from starknet_py.tests.e2e.fixtures.constants import CONTRACTS_COMPILED_V2_DIR
 from starknet_py.tests.e2e.fixtures.misc import read_contract
 
diff --git a/starknet_py/contract.py b/starknet_py/contract.py
@@ -9,12 +9,12 @@
 
 from marshmallow import ValidationError
 
-from starknet_py.abi import Abi as AbiV0
-from starknet_py.abi import AbiParser as AbiV0Parser
-from starknet_py.abi.v1.model import Abi as AbiV1
-from starknet_py.abi.v1.parser import AbiParser as AbiV1Parser
-from starknet_py.abi.v2.model import Abi as AbiV2
-from starknet_py.abi.v2.parser import AbiParser as AbiV2Parser
+from starknet_py.abi.v0 import Abi as AbiV0
+from starknet_py.abi.v0 import AbiParser as AbiParserV0
+from starknet_py.abi.v1 import Abi as AbiV1
+from starknet_py.abi.v1 import AbiParser as AbiParserV1
+from starknet_py.abi.v2 import Abi as AbiV2
+from starknet_py.abi.v2 import AbiParser as AbiParserV2
 from starknet_py.abi.v2.shape import (
     FUNCTION_ENTRY,
     IMPL_ENTRY,
@@ -76,9 +76,9 @@ def parsed_abi(self) -> Union[AbiV0, AbiV1, AbiV2]:
         """
         if self.cairo_version == 1:
             if _is_abi_v2(self.abi):
-                return AbiV2Parser(self.abi).parse()
-            return AbiV1Parser(self.abi).parse()
-        return AbiV0Parser(self.abi).parse()
+                return AbiParserV2(self.abi).parse()
+            return AbiParserV1(self.abi).parse()
+        return AbiParserV0(self.abi).parse()
 
     @staticmethod
     def from_abi(address: int, abi: ABI, cairo_version: int = 0) -> ContractData:
diff --git a/starknet_py/net/client_models.py b/starknet_py/net/client_models.py
@@ -10,7 +10,7 @@
 
 from typing_extensions import Literal
 
-from starknet_py.abi.shape import AbiDictList
+from starknet_py.abi.v0.shape import AbiDictList
 
 Hash = Union[int, str]
 Tag = Literal["pending", "latest"]
diff --git a/starknet_py/net/schemas/rpc.py b/starknet_py/net/schemas/rpc.py
@@ -1,7 +1,7 @@
 from marshmallow import EXCLUDE, Schema, fields, post_load
 from marshmallow_oneofschema import OneOfSchema
 
-from starknet_py.abi.schemas import ContractAbiEntrySchema
+from starknet_py.abi.v0.schemas import ContractAbiEntrySchema
 from starknet_py.net.client_models import (
     BlockHashAndNumber,
     BlockStateUpdate,
diff --git a/starknet_py/net/udc_deployer/deployer.py b/starknet_py/net/udc_deployer/deployer.py
@@ -3,7 +3,7 @@
 import random
 from typing import List, NamedTuple, Optional, Union, cast
 
-from starknet_py.abi.parser import AbiParser
+from starknet_py.abi.v0 import AbiParser
 from starknet_py.common import int_from_hex
 from starknet_py.constants import DEFAULT_DEPLOYER_ADDRESS, FIELD_PRIME
 from starknet_py.hash.address import compute_address
diff --git a/starknet_py/proxy/contract_abi_resolver.py b/starknet_py/proxy/contract_abi_resolver.py
@@ -3,7 +3,7 @@
 from enum import Enum
 from typing import AsyncGenerator, List, Tuple, TypedDict, Union, cast
 
-from starknet_py.abi.shape import AbiDictList
+from starknet_py.abi.v0.shape import AbiDictList
 from starknet_py.constants import (
     RPC_CLASS_HASH_NOT_FOUND_ERROR,
     RPC_CONTRACT_ERROR,
diff --git a/starknet_py/serialization/factory.py b/starknet_py/serialization/factory.py
@@ -3,9 +3,9 @@
 from collections import OrderedDict
 from typing import Dict, List, Union
 
-from starknet_py.abi.model import Abi
-from starknet_py.abi.v1.model import Abi as AbiV1
-from starknet_py.abi.v2.model import Abi as AbiV2
+from starknet_py.abi.v0 import Abi as AbiV0
+from starknet_py.abi.v1 import Abi as AbiV1
+from starknet_py.abi.v2 import Abi as AbiV2
 from starknet_py.cairo.data_types import (
     ArrayType,
     BoolType,
@@ -151,7 +151,7 @@ def serializer_for_outputs(payload: List[CairoType]) -> OutputSerializer:
     )
 
 
-EventV0 = Abi.Event
+EventV0 = AbiV0.Event
 EventV1 = AbiV1.Event
 EventV2 = EventType
 
@@ -170,7 +170,9 @@ def serializer_for_event(event: EventV0 | EventV1 | EventV2) -> PayloadSerialize
     return serializer_for_payload(event.types)
 
 
-def serializer_for_function(abi_function: Abi.Function) -> FunctionSerializationAdapter:
+def serializer_for_function(
+    abi_function: AbiV0.Function,
+) -> FunctionSerializationAdapter:
     """
     Create FunctionSerializationAdapter for serializing function inputs and deserializing function outputs.
 
diff --git a/starknet_py/serialization/factory_test.py b/starknet_py/serialization/factory_test.py
@@ -2,7 +2,7 @@
 
 import pytest
 
-from starknet_py.abi.model import Abi
+from starknet_py.abi.v0 import Abi
 from starknet_py.cairo.data_types import FeltType, NamedTupleType, StructType, TupleType
 from starknet_py.serialization.data_serializers.array_serializer import ArraySerializer
 from starknet_py.serialization.data_serializers.felt_serializer import FeltSerializer
diff --git a/starknet_py/serialization/serialization_test.py b/starknet_py/serialization/serialization_test.py
@@ -4,9 +4,9 @@
 import json
 from typing import NamedTuple
 
-from starknet_py.abi.parser import AbiParser
-from starknet_py.abi.v1.parser import AbiParser as AbiParserV1
-from starknet_py.abi.v2.parser import AbiParser as AbiParserV2
+from starknet_py.abi.v0 import AbiParser as AbiParserV0
+from starknet_py.abi.v1 import AbiParser as AbiParserV1
+from starknet_py.abi.v2 import AbiParser as AbiParserV2
 from starknet_py.cairo.felt import encode_shortstring
 from starknet_py.serialization.factory import (
     serializer_for_event,
@@ -107,7 +107,7 @@ class Education(NamedTuple):
 abi = json.loads(
     read_contract("complex_abi_abi.json", directory=CONTRACTS_COMPILED_V0_DIR)
 )
-parsed_abi = AbiParser(abi).parse()
+parsed_abi = AbiParserV0(abi).parse()
 
 abi_v1 = json.loads(
     read_contract("erc20_compiled.json", directory=CONTRACTS_COMPILED_V1_DIR)
diff --git a/starknet_py/tests/e2e/docs/guide/test_serializing.py b/starknet_py/tests/e2e/docs/guide/test_serializing.py
@@ -24,7 +24,7 @@ def test_abi_parsing():
         "erc20_abi.json", directory=CONTRACTS_COMPILED_V0_DIR
     )
     # docs-serializer: start
-    from starknet_py.abi import AbiParser
+    from starknet_py.abi.v0 import AbiParser
 
     """
     @external
diff --git a/starknet_py/tests/e2e/fixtures/abi_structures.py b/starknet_py/tests/e2e/fixtures/abi_structures.py
@@ -2,7 +2,7 @@
 
 from collections import OrderedDict
 
-from starknet_py.abi.model import Abi
+from starknet_py.abi.v0 import Abi
 from starknet_py.cairo.data_types import ArrayType, FeltType, StructType
 
 uint256_dict = {
diff --git a/starknet_py/tests/e2e/fixtures/abi_v2_structures.py b/starknet_py/tests/e2e/fixtures/abi_v2_structures.py
@@ -1,7 +1,7 @@
 # data from cairo repository: crates/cairo-lang-starknet/src/abi_test.rs
 from collections import OrderedDict
 
-from starknet_py.abi.v2.model import Abi
+from starknet_py.abi.v2 import Abi
 from starknet_py.cairo.data_types import EventType, StructType, UintType
 
 pool_id_struct = StructType("PoolId", OrderedDict(value=UintType(256)))
diff --git a/starknet_py/tests/e2e/fixtures/environment_check.py b/starknet_py/tests/e2e/fixtures/environment_check.py
@@ -1,6 +1,6 @@
 import pytest
 
-from starknet_py.abi.parser import AbiParser
+from starknet_py.abi.v0 import AbiParser
 from starknet_py.constants import DEFAULT_DEPLOYER_ADDRESS
 from starknet_py.net.udc_deployer.deployer import _deployer_abi
 
diff --git a/starknet_py/utils/constructor_args_translator.py b/starknet_py/utils/constructor_args_translator.py
@@ -1,9 +1,9 @@
 from typing import List, Optional, Union
 
 import starknet_py.abi.v2.shape as ShapeV2
-from starknet_py.abi.parser import AbiParser
-from starknet_py.abi.v1.parser import AbiParser as AbiV1Parser
-from starknet_py.abi.v2.parser import AbiParser as AbiV2Parser
+from starknet_py.abi.v0 import AbiParser as AbiParserV0
+from starknet_py.abi.v1 import AbiParser as AbiParserV1
+from starknet_py.abi.v2 import AbiParser as AbiParserV2
 from starknet_py.serialization import (
     FunctionSerializationAdapter,
     serializer_for_function,
@@ -41,15 +41,15 @@ def translate_constructor_args(
 
 def _get_constructor_serializer_v1(abi: List) -> Optional[FunctionSerializationAdapter]:
     if _is_abi_v2(abi):
-        parsed = AbiV2Parser(abi).parse()
+        parsed = AbiParserV2(abi).parse()
         constructor = parsed.constructor
 
         if constructor is None or not constructor.inputs:
             return None
 
         return serializer_for_constructor_v2(constructor)
 
-    parsed = AbiV1Parser(abi).parse()
+    parsed = AbiParserV1(abi).parse()
     constructor = parsed.functions.get("constructor", None)
 
     # Constructor might not accept any arguments
@@ -77,7 +77,7 @@ def _is_abi_v2(abi: List) -> bool:
 
 
 def _get_constructor_serializer_v0(abi: List) -> Optional[FunctionSerializationAdapter]:
-    parsed = AbiParser(abi).parse()
+    parsed = AbiParserV0(abi).parse()
 
     # Constructor might not accept any arguments
     if not parsed.constructor or not parsed.constructor.inputs:
