Split RPC schemas into multiple files (#1385)

* schemas moved to trace_api.py

* schemas moved to transactions.py

* add schemas/rpc/block.py

* delete duplicates

* file rename

* rename ContractClass -> DeprecatedContractClass

* event schema moved to event.py

* everything moved from gateway.py

* rm gateway.py

* styling

* StarknetBlockWithTxHashesSchema moved to block.py

* lint

* change List field type in SierraContractClassSchema

* add breaking changes in migration guide

* circular import fix, general.py added

Author: kkawula

docs/migration_guide.rst

@@ -31,6 +31,8 @@ Version 0.23.0 of **starknet.py** comes with support for `SNIP-12 <https://githu
 2. :meth:`Account.verify_message` now accepts parameter ``typed_data`` as both  :class:`~starknet_py.utils.typed_data.TypedData` and :class:`~starknet_py.net.models.typed_data.TypedDataDict`
 3. :meth:`~starknet_py.net.signer.stark_curve_signer.KeyPair.from_keystore` has been added
 
+3. :class:`CompiledContract`, :class:`ContractClass` and :class:`ContractClassSchema` have been renamed to :class:`DeprecatedCompiledContract`, :class:`DeprecatedContractClass` and :class:`DeprecatedContractClassSchema`
+
 ******************************
 0.22.0 Migration guide
 ******************************

starknet_py/common.py

@@ -5,29 +5,32 @@
 
 from starknet_py.net.client_models import (
     CasmClass,
-    CompiledContract,
-    ContractClass,
+    DeprecatedCompiledContract,
+    DeprecatedContractClass,
     SierraCompiledContract,
 )
-from starknet_py.net.schemas.gateway import (
+from starknet_py.net.schemas.rpc.contract import (
     CasmClassSchema,
-    CompiledContractSchema,
     ContractClassSchema,
+    DeprecatedCompiledContractSchema,
     SierraCompiledContractSchema,
 )
 
 
 def create_compiled_contract(
     compiled_contract: str,
-) -> CompiledContract:
+) -> DeprecatedCompiledContract:
     """
     Creates CompiledContract instance.
 
     :param compiled_contract: compiled contract string.
     :return: CompiledContract instance.
     """
 
-    return cast(CompiledContract, CompiledContractSchema().loads(compiled_contract))
+    return cast(
+        DeprecatedCompiledContract,
+        DeprecatedCompiledContractSchema().loads(compiled_contract),
+    )
 
 
 def create_sierra_compiled_contract(compiled_contract: str) -> SierraCompiledContract:
@@ -45,7 +48,7 @@ def create_sierra_compiled_contract(compiled_contract: str) -> SierraCompiledCon
 
 def create_contract_class(
     compiled_contract: str,
-) -> ContractClass:
+) -> DeprecatedContractClass:
     """
     Creates ContractClass from already compiled contract.
 
@@ -60,7 +63,7 @@ def create_contract_class(
         "Consider using create_compiled_contract instead.",
         category=DeprecationWarning,
     )
-    return cast(ContractClass, ContractClassSchema().loads(compiled_contract))
+    return cast(DeprecatedContractClass, ContractClassSchema().loads(compiled_contract))
 
 
 def create_casm_class(compiled_contract: str) -> CasmClass:

starknet_py/hash/class_hash.py

@@ -6,10 +6,10 @@
 from starknet_py.cairo.felt import encode_shortstring
 from starknet_py.constants import API_VERSION
 from starknet_py.hash.utils import _starknet_keccak, compute_hash_on_elements
-from starknet_py.net.client_models import ContractClass, EntryPoint
+from starknet_py.net.client_models import DeprecatedContractClass, EntryPoint
 
 
-def compute_class_hash(contract_class: ContractClass) -> int:
+def compute_class_hash(contract_class: DeprecatedContractClass) -> int:
     """
     Calculate class hash of a ContractClass.
     """
@@ -59,7 +59,7 @@ def _entry_points_array(entry_points: List[EntryPoint]) -> List[int]:
     return entry_points_array
 
 
-def _compute_hinted_class_hash(contract_class: ContractClass) -> int:
+def _compute_hinted_class_hash(contract_class: DeprecatedContractClass) -> int:
     program = contract_class.program
     program["debug_info"] = None
 

starknet_py/hash/sierra_class_hash.py

@@ -31,8 +31,7 @@ def compute_sierra_class_hash(sierra_contract_class: SierraContractClass) -> int
     assert sierra_contract_class.abi is not None
     abi_hash = _starknet_keccak(bytes(sierra_contract_class.abi, "utf-8"))
 
-    _sierra_program = [int(val, 0) for val in sierra_contract_class.sierra_program]
-    sierra_program_hash = poseidon_hash_many(_sierra_program)
+    sierra_program_hash = poseidon_hash_many(sierra_contract_class.sierra_program)
 
     return poseidon_hash_many(
         [

starknet_py/hash/transaction.py

@@ -11,8 +11,8 @@
 from starknet_py.hash.sierra_class_hash import compute_sierra_class_hash
 from starknet_py.hash.utils import compute_hash_on_elements
 from starknet_py.net.client_models import (
-    ContractClass,
     DAMode,
+    DeprecatedContractClass,
     ResourceBoundsMapping,
     SierraContractClass,
 )
@@ -256,7 +256,7 @@ def compute_deploy_account_v3_transaction_hash(
 
 
 def compute_declare_transaction_hash(
-    contract_class: ContractClass,
+    contract_class: DeprecatedContractClass,
     chain_id: int,
     sender_address: int,
     max_fee: int,

starknet_py/net/client.py

@@ -9,9 +9,9 @@
     BlockStateUpdate,
     BlockTransactionTrace,
     Call,
-    ContractClass,
     DeclareTransactionResponse,
     DeployAccountTransactionResponse,
+    DeprecatedContractClass,
     EstimatedFee,
     Hash,
     SentTransactionResponse,
@@ -278,7 +278,7 @@ async def get_class_hash_at(
     @abstractmethod
     async def get_class_by_hash(
         self, class_hash: Hash
-    ) -> Union[ContractClass, SierraContractClass]:
+    ) -> Union[DeprecatedContractClass, SierraContractClass]:
         """
         Get the contract class for given class hash
 

starknet_py/net/client_models.py

@@ -762,7 +762,7 @@ class EntryPointsByType:
 
 
 @dataclass
-class ContractClass:
+class DeprecatedContractClass:
     """
     Dataclass representing contract declared to Starknet.
     """
@@ -773,7 +773,7 @@ class ContractClass:
 
 
 @dataclass
-class CompiledContract(ContractClass):
+class DeprecatedCompiledContract(DeprecatedContractClass):
     """
     Dataclass representing ContractClass with required abi.
     """
@@ -812,7 +812,7 @@ class SierraContractClass:
     """
 
     contract_class_version: str
-    sierra_program: List[str]
+    sierra_program: List[int]
     entry_points_by_type: SierraEntryPointsByType
     abi: Optional[str] = None
 

starknet_py/net/full_node_client.py

@@ -12,9 +12,9 @@
     BlockStateUpdate,
     BlockTransactionTrace,
     Call,
-    ContractClass,
     DeclareTransactionResponse,
     DeployAccountTransactionResponse,
+    DeprecatedContractClass,
     EstimatedFee,
     EventsChunk,
     Hash,
@@ -51,29 +51,35 @@
     DeployAccount,
     Invoke,
 )
-from starknet_py.net.schemas.rpc import (
+from starknet_py.net.schemas.rpc.block import (
     BlockHashAndNumberSchema,
     BlockStateUpdateSchema,
-    BlockTransactionTraceSchema,
-    ContractClassSchema,
-    DeclareTransactionResponseSchema,
-    DeployAccountTransactionResponseSchema,
-    EstimatedFeeSchema,
-    EventsChunkSchema,
     PendingBlockStateUpdateSchema,
     PendingStarknetBlockSchema,
     PendingStarknetBlockWithReceiptsSchema,
     PendingStarknetBlockWithTxHashesSchema,
-    SentTransactionSchema,
-    SierraContractClassSchema,
-    SimulatedTransactionSchema,
     StarknetBlockSchema,
     StarknetBlockWithReceiptsSchema,
     StarknetBlockWithTxHashesSchema,
+)
+from starknet_py.net.schemas.rpc.contract import (
+    DeprecatedContractClassSchema,
+    SierraContractClassSchema,
     SyncStatusSchema,
+)
+from starknet_py.net.schemas.rpc.event import EventsChunkSchema
+from starknet_py.net.schemas.rpc.general import EstimatedFeeSchema
+from starknet_py.net.schemas.rpc.trace_api import (
+    BlockTransactionTraceSchema,
+    SimulatedTransactionSchema,
+    TransactionTraceSchema,
+)
+from starknet_py.net.schemas.rpc.transactions import (
+    DeclareTransactionResponseSchema,
+    DeployAccountTransactionResponseSchema,
+    SentTransactionSchema,
     TransactionReceiptSchema,
     TransactionStatusResponseSchema,
-    TransactionTraceSchema,
     TypesOfTransactionsSchema,
 )
 from starknet_py.transaction_errors import TransactionNotReceivedError
@@ -548,7 +554,7 @@ async def get_class_by_hash(
         class_hash: Hash,
         block_hash: Optional[Union[Hash, Tag]] = None,
         block_number: Optional[Union[int, Tag]] = None,
-    ) -> Union[SierraContractClass, ContractClass]:
+    ) -> Union[SierraContractClass, DeprecatedContractClass]:
         block_identifier = get_block_identifier(
             block_hash=block_hash, block_number=block_number
         )
@@ -566,7 +572,7 @@ async def get_class_by_hash(
                 SierraContractClass,
                 SierraContractClassSchema().load(res),
             )
-        return cast(ContractClass, ContractClassSchema().load(res))
+        return cast(DeprecatedContractClass, DeprecatedContractClassSchema().load(res))
 
     # Only RPC methods
 
@@ -625,7 +631,7 @@ async def get_class_at(
         contract_address: Hash,
         block_hash: Optional[Union[Hash, Tag]] = None,
         block_number: Optional[Union[int, Tag]] = None,
-    ) -> Union[SierraContractClass, ContractClass]:
+    ) -> Union[SierraContractClass, DeprecatedContractClass]:
         """
         Get the contract class definition in the given block at the given address
 
@@ -651,7 +657,7 @@ async def get_class_at(
                 SierraContractClass,
                 SierraContractClassSchema().load(res),
             )
-        return cast(ContractClass, ContractClassSchema().load(res))
+        return cast(DeprecatedContractClass, DeprecatedContractClassSchema().load(res))
 
     async def get_contract_nonce(
         self,

starknet_py/net/models/transaction.py

@@ -29,14 +29,14 @@
     compute_invoke_v3_transaction_hash,
 )
 from starknet_py.net.client_models import (
-    ContractClass,
     DAMode,
+    DeprecatedContractClass,
     ResourceBoundsMapping,
     SierraContractClass,
     TransactionType,
 )
 from starknet_py.net.schemas.common import Felt, TransactionTypeField
-from starknet_py.net.schemas.gateway import (
+from starknet_py.net.schemas.rpc.contract import (
     ContractClassSchema,
     SierraContractClassSchema,
 )
@@ -186,7 +186,7 @@ class DeclareV1(_DeprecatedAccountTransaction):
     """
 
     # The class to be declared, included for all methods involving execution (estimateFee, simulateTransactions)
-    contract_class: ContractClass = field(
+    contract_class: DeprecatedContractClass = field(
         metadata={"marshmallow_field": fields.Nested(ContractClassSchema())}
     )
     # The address of the account contract sending the declaration transaction.

starknet_py/net/schemas/broadcasted_txn.py

@@ -3,11 +3,11 @@
 
 from starknet_py.net.client_models import TransactionType
 from starknet_py.net.models.transaction import compress_program, decompress_program
-from starknet_py.net.schemas.gateway import (
+from starknet_py.net.schemas.rpc.contract import (
     ContractClassSchema,
     SierraCompiledContractSchema,
 )
-from starknet_py.net.schemas.rpc import (
+from starknet_py.net.schemas.rpc.transactions import (
     DeclareTransactionV1Schema,
     DeclareTransactionV2Schema,
     DeclareTransactionV3Schema,