Add parsed_abi property to SierraContractClass (#1313)

* Add parsed_abi property to SierraContractClass

Author: tkumor3

docs/migration_guide.rst

@@ -31,6 +31,7 @@ Version 0.21.0 of **starknet.py** comes with support for RPC 0.7.0-rc2!
 3. :class:`InvokeTransactionTrace`, :class:`DeclareTransactionTrace` and :class:`DeployAccountTransactionTrace` have a new required field ``execution_resources``
 4. :class:`EstimatedFee` has new required fields ``data_gas_consumed`` and ``data_gas_price``
 5. :class:`StarknetBlock`, :class:`PendingStarknetBlock`, :class:`StarknetBlockWithTxHashes`, :class:`PendingStarknetBlockWithTxHashes` have new required fields ``l1_data_gas_price`` and ``l1_da_mode``
+6. :class:`SierraContractClass` has an additional propery ``parsed_abi``
 
 **********************
 0.20.0 Migration guide

starknet_py/contract.py

@@ -1,7 +1,6 @@
 from __future__ import annotations
 
 import dataclasses
-import json
 from abc import ABC, abstractmethod
 from dataclasses import dataclass
 from functools import cached_property
@@ -280,7 +279,8 @@ def _get_abi(self) -> List:
                 sierra_compiled_contract = create_sierra_compiled_contract(
                     compiled_contract=self.compiled_contract
                 )
-                abi = json.loads(sierra_compiled_contract.abi)
+                abi = sierra_compiled_contract.parsed_abi
+
             except Exception as exc:
                 raise ValueError(
                     "Contract's ABI can't be converted to format List[Dict]. "

starknet_py/net/client_models.py

@@ -3,14 +3,28 @@
 They need to stay backwards compatible for old transactions/blocks to be fetchable.
 """
 
+import json
 from abc import ABC
 from dataclasses import dataclass, field
 from enum import Enum
-from typing import Any, Iterable, List, Optional, Union
+from typing import Any, Iterable, List, Literal, Optional, Union, cast
 
-from typing_extensions import Literal
+from marshmallow import EXCLUDE
 
 from starknet_py.abi.v0.shape import AbiDictList
+from starknet_py.abi.v1.schemas import (
+    ContractAbiEntrySchema as ContractAbiEntrySchemaV1,
+)
+from starknet_py.abi.v1.shape import AbiDictEntry as AbiDictEntryV1
+from starknet_py.abi.v1.shape import AbiDictList as AbiDictListV1
+from starknet_py.abi.v2.schemas import (
+    ContractAbiEntrySchema as ContractAbiEntrySchemaV2,
+)
+from starknet_py.abi.v2.shape import AbiDictEntry as AbiDictEntryV2
+from starknet_py.abi.v2.shape import AbiDictList as AbiDictListV2
+from starknet_py.utils.constructor_args_translator import _is_abi_v2
+
+# pylint: disable=too-many-lines
 
 Hash = Union[int, str]
 Tag = Literal["pending", "latest"]
@@ -764,6 +778,27 @@ class SierraContractClass:
     entry_points_by_type: SierraEntryPointsByType
     abi: Optional[str] = None
 
+    @property
+    def parsed_abi(self) -> Union[AbiDictListV2, AbiDictListV1]:
+        if self.abi is None:
+            return []
+
+        load_abi: List = json.loads(self.abi)
+
+        if _is_abi_v2(load_abi):
+            return [
+                cast(
+                    AbiDictEntryV2,
+                    ContractAbiEntrySchemaV2(unknown=EXCLUDE).load(entry),
+                )
+                for entry in load_abi
+            ]
+
+        return [
+            cast(AbiDictEntryV1, ContractAbiEntrySchemaV1(unknown=EXCLUDE).load(entry))
+            for entry in load_abi
+        ]
+
 
 @dataclass
 class SierraCompiledContract(SierraContractClass):

starknet_py/tests/e2e/client/client_test.py

@@ -534,6 +534,7 @@ async def test_get_class_by_hash_sierra_program(
         class_hash=cairo1_hello_starknet_class_hash
     )
 
+    assert isinstance(contract_class.parsed_abi, list)
     assert isinstance(contract_class, SierraContractClass)
     assert contract_class.contract_class_version == "0.1.0"
     assert isinstance(contract_class.sierra_program, list)

starknet_py/tests/e2e/contract_interaction/deploy_test.py

@@ -1,5 +1,4 @@
 import dataclasses
-import json
 import re
 from unittest.mock import Mock
 
@@ -97,12 +96,14 @@ async def test_throws_on_wrong_abi(account, cairo1_minimal_contract_class_hash:
 @pytest.mark.asyncio
 async def test_deploy_contract_v1(account, cairo1_hello_starknet_class_hash: int):
     compiled_contract = read_contract("hello_starknet_compiled.json")
-    abi = create_sierra_compiled_contract(compiled_contract=compiled_contract).abi
+    abi = create_sierra_compiled_contract(
+        compiled_contract=compiled_contract
+    ).parsed_abi
 
     deploy_result = await Contract.deploy_contract_v1(
         class_hash=cairo1_hello_starknet_class_hash,
         account=account,
-        abi=json.loads(abi),
+        abi=abi,
         max_fee=MAX_FEE,
         cairo_version=1,
     )
@@ -125,12 +126,14 @@ async def test_deploy_contract_v1(account, cairo1_hello_starknet_class_hash: int
 @pytest.mark.asyncio
 async def test_deploy_contract_v3(account, cairo1_hello_starknet_class_hash: int):
     compiled_contract = read_contract("hello_starknet_compiled.json")
-    abi = create_sierra_compiled_contract(compiled_contract=compiled_contract).abi
+    abi = create_sierra_compiled_contract(
+        compiled_contract=compiled_contract
+    ).parsed_abi
 
     deploy_result = await Contract.deploy_contract_v3(
         class_hash=cairo1_hello_starknet_class_hash,
         account=account,
-        abi=json.loads(abi),
+        abi=abi,
         l1_resource_bounds=MAX_RESOURCE_BOUNDS_L1,
         cairo_version=1,
     )

starknet_py/tests/e2e/docs/guide/test_simple_deploy_cairo1.py

@@ -1,4 +1,3 @@
-import json
 import sys
 
 import pytest
@@ -28,7 +27,9 @@ async def test_simple_deploy_cairo1(account, cairo1_erc20_class_hash):
     class_hash = cairo1_erc20_class_hash
 
     # docs: start
-    abi = create_sierra_compiled_contract(compiled_contract=compiled_contract).abi
+    abi = create_sierra_compiled_contract(
+        compiled_contract=compiled_contract
+    ).parsed_abi
 
     constructor_args = {
         "name_": encode_shortstring("erc20_basic"),
@@ -41,7 +42,7 @@ async def test_simple_deploy_cairo1(account, cairo1_erc20_class_hash):
     deploy_result = await Contract.deploy_contract_v1(
         account=account,
         class_hash=class_hash,
-        abi=json.loads(abi),
+        abi=abi,
         constructor_args=constructor_args,
         max_fee=int(1e16),
         cairo_version=1,  # note the `cairo_version` parameter

starknet_py/tests/e2e/fixtures/contracts.py

@@ -1,5 +1,4 @@
 # pylint: disable=redefined-outer-name
-import json
 from typing import Any, Dict, List, Optional, Tuple
 
 import pytest
@@ -139,10 +138,7 @@ async def deploy_v1_contract(
     :returns: Instance of the deployed contract.
     """
     contract_sierra = read_contract(contract_file_name + "_compiled.json")
-    sierra_compiled_contract = create_sierra_compiled_contract(
-        compiled_contract=contract_sierra
-    )
-    abi = json.loads(sierra_compiled_contract.abi)
+    abi = create_sierra_compiled_contract(compiled_contract=contract_sierra).parsed_abi
 
     deployer = Deployer()
     deploy_call, address = deployer.create_contract_deployment(