Split deprecated schemas to their respective classes based on versions (#1259)

* issue 1249: split deprecated schemas to their respective classes based on versions

* Issue-1249: remove InvokeTransaction object from tests

Author: Jonatan-Chaverri

starknet_py/net/client_models.py

@@ -191,16 +191,25 @@ def __post_init__(self):
 
 
 @dataclass
-class InvokeTransaction(DeprecatedTransaction):
+class InvokeTransactionV0(DeprecatedTransaction):
     """
-    Dataclass representing invoke transaction.
+    Dataclass representing invoke transaction v0.
     """
 
-    sender_address: int
     calldata: List[int]
-    # This field is always None for transactions with version = 1
-    entry_point_selector: Optional[int] = None
-    nonce: Optional[int] = None
+    contract_address: int
+    entry_point_selector: int
+
+
+@dataclass
+class InvokeTransactionV1(DeprecatedTransaction):
+    """
+    Dataclass representing invoke transaction v1.
+    """
+
+    calldata: List[int]
+    sender_address: int
+    nonce: int
 
 
 @dataclass
@@ -209,22 +218,43 @@ class InvokeTransactionV3(TransactionV3):
     Dataclass representing invoke transaction v3.
     """
 
-    sender_address: int
     calldata: List[int]
+    sender_address: int
+    nonce: int
     account_deployment_data: List[int]
+
+
+@dataclass
+class DeclareTransactionV0(DeprecatedTransaction):
+    """
+    Dataclass representing declare transaction v0.
+    """
+
+    sender_address: int
+    class_hash: int
+
+
+@dataclass
+class DeclareTransactionV1(DeprecatedTransaction):
+    """
+    Dataclass representing declare transaction v1.
+    """
+
+    sender_address: int
+    class_hash: int
     nonce: int
 
 
 @dataclass
-class DeclareTransaction(DeprecatedTransaction):
+class DeclareTransactionV2(DeprecatedTransaction):
     """
-    Dataclass representing declare transaction.
+    Dataclass representing declare transaction v2.
     """
 
-    class_hash: int  # Responses to getBlock and getTransaction include the class hash
     sender_address: int
-    compiled_class_hash: Optional[int] = None  # only in DeclareV2, hence Optional
-    nonce: Optional[int] = None
+    class_hash: int
+    compiled_class_hash: int
+    nonce: int
 
 
 @dataclass
@@ -233,10 +263,10 @@ class DeclareTransactionV3(TransactionV3):
     Dataclass representing declare transaction v3.
     """
 
+    sender_address: int
     class_hash: int
     compiled_class_hash: int
     nonce: int
-    sender_address: int
     account_deployment_data: List[int]
 
 
@@ -252,15 +282,15 @@ class DeployTransaction(Transaction):
 
 
 @dataclass
-class DeployAccountTransaction(DeprecatedTransaction):
+class DeployAccountTransactionV1(DeprecatedTransaction):
     """
-    Dataclass representing deploy account transaction.
+    Dataclass representing deploy account transaction v1.
     """
 
+    nonce: int
     contract_address_salt: int
-    class_hash: int
     constructor_calldata: List[int]
-    nonce: int
+    class_hash: int
 
 
 @dataclass
@@ -269,10 +299,10 @@ class DeployAccountTransactionV3(TransactionV3):
     Dataclass representing deploy account transaction v3.
     """
 
+    nonce: int
     contract_address_salt: int
-    class_hash: int
     constructor_calldata: List[int]
-    nonce: int
+    class_hash: int
 
 
 @dataclass

starknet_py/net/schemas/rpc.py

@@ -10,13 +10,15 @@
     ContractsNonce,
     DAMode,
     DeclaredContractHash,
-    DeclareTransaction,
     DeclareTransactionResponse,
     DeclareTransactionTrace,
+    DeclareTransactionV0,
+    DeclareTransactionV1,
+    DeclareTransactionV2,
     DeclareTransactionV3,
-    DeployAccountTransaction,
     DeployAccountTransactionResponse,
     DeployAccountTransactionTrace,
+    DeployAccountTransactionV1,
     DeployAccountTransactionV3,
     DeployedContract,
     DeployTransaction,
@@ -28,8 +30,9 @@
     ExecutionResources,
     FeePayment,
     FunctionInvocation,
-    InvokeTransaction,
     InvokeTransactionTrace,
+    InvokeTransactionV0,
+    InvokeTransactionV1,
     InvokeTransactionV3,
     L1HandlerTransaction,
     L1HandlerTransactionTrace,
@@ -74,10 +77,7 @@
     Uint64,
     Uint128,
 )
-from starknet_py.net.schemas.utils import (
-    _extract_tx_version,
-    _replace_invoke_contract_address_with_sender_address,
-)
+from starknet_py.net.schemas.utils import _extract_tx_version
 
 # pylint: disable=unused-argument, no-self-use
 
@@ -253,50 +253,77 @@ class TransactionV3Schema(TransactionSchema):
     )
 
 
-class DeprecatedInvokeTransactionSchema(DeprecatedTransactionSchema):
-    contract_address = Felt(data_key="contract_address", load_default=None)
-    sender_address = Felt(data_key="sender_address", load_default=None)
-    entry_point_selector = Felt(data_key="entry_point_selector", load_default=None)
+class InvokeTransactionV0Schema(DeprecatedTransactionSchema):
     calldata = fields.List(Felt(), data_key="calldata", required=True)
-    nonce = Felt(data_key="nonce", load_default=None)
+    contract_address = Felt(data_key="contract_address", required=True)
+    entry_point_selector = Felt(data_key="entry_point_selector", required=True)
 
     @post_load
-    def make_transaction(self, data, **kwargs) -> InvokeTransaction:
-        _replace_invoke_contract_address_with_sender_address(data)
-        return InvokeTransaction(**data)
+    def make_transaction(self, data, **kwargs) -> InvokeTransactionV0:
+        return InvokeTransactionV0(**data)
 
 
-class InvokeTransactionV3Schema(TransactionV3Schema):
+class InvokeTransactionV1Schema(DeprecatedTransactionSchema):
+    calldata = fields.List(Felt(), data_key="calldata", required=True)
     sender_address = Felt(data_key="sender_address", required=True)
+    nonce = Felt(data_key="nonce", required=True)
+
+    @post_load
+    def make_transaction(self, data, **kwargs) -> InvokeTransactionV1:
+        return InvokeTransactionV1(**data)
+
+
+class InvokeTransactionV3Schema(TransactionV3Schema):
     calldata = fields.List(Felt(), data_key="calldata", required=True)
+    sender_address = Felt(data_key="sender_address", required=True)
+    nonce = Felt(data_key="nonce", required=True)
     account_deployment_data = fields.List(
-        Felt(), data_key="account_deployment_data", load_default=[]
+        Felt(), data_key="account_deployment_data", required=True
     )
-    nonce = Felt(data_key="nonce", required=True)
 
     @post_load
     def make_transaction(self, data, **kwargs) -> InvokeTransactionV3:
         return InvokeTransactionV3(**data)
 
 
-class DeprecatedDeclareTransactionSchema(DeprecatedTransactionSchema):
+class DeclareTransactionV0Schema(DeprecatedTransactionSchema):
+    sender_address = Felt(data_key="sender_address", required=True)
     class_hash = Felt(data_key="class_hash", required=True)
+
+    @post_load
+    def make_dataclass(self, data, **kwargs) -> DeclareTransactionV0:
+        return DeclareTransactionV0(**data)
+
+
+class DeclareTransactionV1Schema(DeprecatedTransactionSchema):
     sender_address = Felt(data_key="sender_address", required=True)
-    nonce = Felt(data_key="nonce", load_default=None)
-    compiled_class_hash = Felt(data_key="compiled_class_hash", load_default=None)
+    class_hash = Felt(data_key="class_hash", required=True)
+    nonce = Felt(data_key="nonce", required=True)
 
     @post_load
-    def make_dataclass(self, data, **kwargs) -> DeclareTransaction:
-        return DeclareTransaction(**data)
+    def make_dataclass(self, data, **kwargs) -> DeclareTransactionV1:
+        return DeclareTransactionV1(**data)
 
 
-class DeclareTransactionV3Schema(TransactionV3Schema):
+class DeclareTransactionV2Schema(DeprecatedTransactionSchema):
+    sender_address = Felt(data_key="sender_address", required=True)
     class_hash = Felt(data_key="class_hash", required=True)
-    compiled_class_hash = Felt(data_key="compiled_class_hash", load_default=None)
+    compiled_class_hash = Felt(data_key="compiled_class_hash", required=True)
     nonce = Felt(data_key="nonce", required=True)
+
+    @post_load
+    def make_dataclass(self, data, **kwargs) -> DeclareTransactionV2:
+        return DeclareTransactionV2(**data)
+
+
+class DeclareTransactionV3Schema(TransactionV3Schema):
     sender_address = Felt(data_key="sender_address", required=True)
+    class_hash = Felt(data_key="class_hash", required=True)
+
+    compiled_class_hash = Felt(data_key="compiled_class_hash", required=True)
+    nonce = Felt(data_key="nonce", required=True)
     account_deployment_data = fields.List(
-        Felt(), data_key="account_deployment_data", load_default=[]
+        Felt(), data_key="account_deployment_data", required=True
     )
 
     @post_load
@@ -316,26 +343,26 @@ def make_dataclass(self, data, **kwargs) -> DeployTransaction:
         return DeployTransaction(**data)
 
 
-class DeprecatedDeployAccountTransactionSchema(DeprecatedTransactionSchema):
+class DeployAccountTransactionV1Schema(DeprecatedTransactionSchema):
+    nonce = Felt(data_key="nonce", required=True)
     contract_address_salt = Felt(data_key="contract_address_salt", required=True)
     constructor_calldata = fields.List(
         Felt(), data_key="constructor_calldata", required=True
     )
     class_hash = Felt(data_key="class_hash", required=True)
-    nonce = Felt(data_key="nonce", load_default=None)
 
     @post_load
-    def make_dataclass(self, data, **kwargs) -> DeployAccountTransaction:
-        return DeployAccountTransaction(**data)
+    def make_dataclass(self, data, **kwargs) -> DeployAccountTransactionV1:
+        return DeployAccountTransactionV1(**data)
 
 
 class DeployAccountTransactionV3Schema(TransactionV3Schema):
+    nonce = Felt(data_key="nonce", required=True)
     contract_address_salt = Felt(data_key="contract_address_salt", required=True)
     constructor_calldata = fields.List(
         Felt(), data_key="constructor_calldata", required=True
     )
     class_hash = Felt(data_key="class_hash", required=True)
-    nonce = Felt(data_key="nonce", required=True)
 
     @post_load
     def make_dataclass(self, data, **kwargs) -> DeployAccountTransactionV3:
@@ -344,9 +371,9 @@ def make_dataclass(self, data, **kwargs) -> DeployAccountTransactionV3:
 
 class DeclareTransactionSchema(OneOfSchema):
     type_schemas = {
-        0: DeprecatedDeclareTransactionSchema,
-        1: DeprecatedDeclareTransactionSchema,
-        2: DeprecatedDeclareTransactionSchema,
+        0: DeclareTransactionV0Schema,
+        1: DeclareTransactionV1Schema,
+        2: DeclareTransactionV2Schema,
         3: DeclareTransactionV3Schema,
     }
 
@@ -356,8 +383,8 @@ def get_data_type(self, data):
 
 class InvokeTransactionSchema(OneOfSchema):
     type_schemas = {
-        0: DeprecatedInvokeTransactionSchema,
-        1: DeprecatedInvokeTransactionSchema,
+        0: InvokeTransactionV0Schema,
+        1: InvokeTransactionV1Schema,
         3: InvokeTransactionV3Schema,
     }
 
@@ -367,7 +394,7 @@ def get_data_type(self, data):
 
 class DeployAccountTransactionSchema(OneOfSchema):
     type_schemas = {
-        1: DeprecatedDeployAccountTransactionSchema,
+        1: DeployAccountTransactionV1Schema,
         3: DeployAccountTransactionV3Schema,
     }
 

starknet_py/net/schemas/utils.py

@@ -3,17 +3,6 @@
 from starknet_py.constants import QUERY_VERSION_BASE
 
 
-def _replace_invoke_contract_address_with_sender_address(data: dict):
-    data["sender_address"] = data.get("sender_address") or data.get("contract_address")
-
-    if data["sender_address"] is None:
-        raise ValueError(
-            "Missing field `contract_address` or `sender_address` for InvokeTransactionSchema."
-        )
-
-    del data["contract_address"]
-
-
 def _extract_tx_version(version: Union[int, str]):
     if isinstance(version, str):
         version = int(version, 16)

starknet_py/tests/e2e/account/account_test.py

@@ -11,8 +11,8 @@
 from starknet_py.net.client_errors import ClientError
 from starknet_py.net.client_models import (
     Call,
-    DeployAccountTransaction,
     DeployAccountTransactionResponse,
+    DeployAccountTransactionV1,
     DeployAccountTransactionV3,
     EstimatedFee,
     InvokeTransactionV3,
@@ -466,7 +466,7 @@ async def test_deploy_account_v1(client, deploy_account_details_factory, map_con
     assert account.address == address
 
     transaction = await client.get_transaction(tx_hash=deploy_result.hash)
-    assert isinstance(transaction, DeployAccountTransaction)
+    assert isinstance(transaction, DeployAccountTransactionV1)
     assert transaction.constructor_calldata == [key_pair.public_key]
 
     res = await account.execute_v1(
@@ -615,7 +615,7 @@ async def test_deploy_account_uses_custom_calldata(
     )
 
     tx = await client.get_transaction(deploy_result.hash)
-    assert isinstance(tx, DeployAccountTransaction)
+    assert isinstance(tx, DeployAccountTransactionV1)
     assert tx.constructor_calldata == calldata