Change cairo_version into Account property (#1183)

* add cairo_version property, remove it from arguments in methods

* change cairo_version

* update Account.deploy_account

* add tests

* add precompiled contracts

* update docs

* deprecate cairo_version parameter from previous impl

* change previous parameter into Optional

* update BaseAccount interface

* update migration guide

* update docs code snippets

* check docs

* formatting

* docs

* fix devnet version on windows checks

* docstrings once again

* add todos

* add test for codecov

* formatting

* add a helper comment

* remove cairo_version from Account constructor, change cairo_version property

* remove unnecessary pyright comment

* change cairo_version into async property

* fix tests

* another tests fix

* another tests fix

* woops

Author: tomek0123456789

.github/workflows/checks.yml

@@ -340,7 +340,7 @@ jobs:
           apt-get install -y python3-pip
           sudo apt install -y libgmp3-dev
           sudo apt-get install -y git
-          pip3 install git+https://github.com/0xSpaceShard/starknet-devnet.git@v0.5.5
+          pip3 install git+https://github.com/0xSpaceShard/starknet-devnet.git@v0.6.2
 
       # ====================== SETUP PYTHON ====================== #
 
@@ -492,7 +492,7 @@ jobs:
           apt-get install -y python3-pip
           sudo apt install -y libgmp3-dev
           sudo apt-get install -y git
-          pip3 install git+https://github.com/0xSpaceShard/starknet-devnet.git@v0.5.5
+          pip3 install git+https://github.com/0xSpaceShard/starknet-devnet.git@v0.6.2
 
       # ====================== SETUP PYTHON ====================== #
 

docs/migration_guide.rst

@@ -6,6 +6,8 @@ Migration guide
 **********************
 
 Version 0.18.2 of **starknet.py** comes with support of `RPC v0.4.0 <https://github.com/starkware-libs/starknet-specs/releases/tag/v0.4.0>`_ Trace API!
+Additionally, you can now `properly` use Cairo1 accounts! ``starknet.py`` automatically checks if your account is in Cairo1 and
+sets the calldata encoding accordingly.
 
 0.18.2 Targeted versions
 ------------------------
@@ -21,6 +23,14 @@ Version 0.18.2 of **starknet.py** comes with support of `RPC v0.4.0 <https://git
 1. :meth:`Client.get_block_traces` has been renamed to :meth:`Client.trace_block_transactions` in order to match RPC specification.
 
 
+0.18.2 Deprecations
+-------------------
+
+.. currentmodule:: starknet_py.net.account.account
+
+1. ``cairo_version`` parameter in :meth:`Account.sign_invoke_transaction` and :meth:`Account.execute` has been deprecated.
+
+
 0.18.2 Minor changes
 --------------------
 
@@ -30,6 +40,10 @@ Version 0.18.2 of **starknet.py** comes with support of `RPC v0.4.0 <https://git
 
 2. ``include_block`` parameter in :meth:`GatewayClient.get_state_update` now works on gateway mainnet.
 
+.. currentmodule:: starknet_py.net.account.account
+
+3. :class:`BaseAccount` interface and :class:`Account` now have an additional **async** property - ``cairo_version``.
+
 
 0.18.2 Development-related changes
 ----------------------------------

starknet_py/net/account/account.py

@@ -18,8 +18,11 @@
     EstimatedFee,
     Hash,
     SentTransactionResponse,
+    SierraContractClass,
     Tag,
 )
+from starknet_py.net.full_node_client import FullNodeClient
+from starknet_py.net.gateway_client import GatewayClient
 from starknet_py.net.models import AddressRepresentation, StarknetChainId, parse_address
 from starknet_py.net.models.transaction import (
     AccountTransaction,
@@ -74,6 +77,7 @@ def __init__(
         """
         self._address = parse_address(address)
         self._client = client
+        self._cairo_version = None
 
         if signer is not None and key_pair is not None:
             raise ValueError("Arguments signer and key_pair are mutually exclusive.")
@@ -96,6 +100,23 @@ def __init__(
     def address(self) -> int:
         return self._address
 
+    @property
+    async def cairo_version(self) -> int:
+        if self._cairo_version is None:
+            if isinstance(self._client, GatewayClient):
+                contract_class = await self._client.get_full_contract(
+                    contract_address=self._address
+                )
+            else:
+                assert isinstance(self._client, FullNodeClient)
+                contract_class = await self._client.get_class_at(
+                    contract_address=self._address
+                )
+            self._cairo_version = (
+                1 if isinstance(contract_class, SierraContractClass) else 0
+            )
+        return self._cairo_version
+
     @property
     def client(self) -> Client:
         return self._client
@@ -137,7 +158,6 @@ async def _prepare_invoke(
         nonce: Optional[int] = None,
         max_fee: Optional[int] = None,
         auto_estimate: bool = False,
-        cairo_version: int = 0,
     ) -> Invoke:
         """
         Takes calls and creates Invoke from them.
@@ -150,7 +170,7 @@ async def _prepare_invoke(
         if nonce is None:
             nonce = await self.get_nonce()
 
-        if cairo_version == 1:
+        if await self.cairo_version == 1:
             parsed_calls = _parse_calls_v2(ensure_iterable(calls))
             wrapped_calldata = _execute_payload_serializer_v2.serialize(
                 {"calls": parsed_calls}
@@ -253,14 +273,22 @@ async def sign_invoke_transaction(
         nonce: Optional[int] = None,
         max_fee: Optional[int] = None,
         auto_estimate: bool = False,
-        cairo_version: int = 0,
+        # TODO (#1184): remove that
+        cairo_version: Optional[int] = None,
     ) -> Invoke:
+        # TODO (#1184): remove that
+        if cairo_version is not None:
+            warnings.warn(
+                "Parameter 'cairo_version' has been deprecated. It is calculated automatically based on your account's "
+                "contract class.",
+                category=DeprecationWarning,
+            )
+
         execute_tx = await self._prepare_invoke(
             calls,
             nonce=nonce,
             max_fee=max_fee,
             auto_estimate=auto_estimate,
-            cairo_version=cairo_version,
         )
         signature = self.signer.sign_transaction(execute_tx)
         return _add_signature_to_transaction(execute_tx, signature)
@@ -387,14 +415,22 @@ async def execute(
         nonce: Optional[int] = None,
         max_fee: Optional[int] = None,
         auto_estimate: bool = False,
-        cairo_version: int = 0,
+        # TODO (#1184): remove that
+        cairo_version: Optional[int] = None,
     ) -> SentTransactionResponse:
+        # TODO (#1184): remove that
+        if cairo_version is not None:
+            warnings.warn(
+                "Parameter 'cairo_version' has been deprecated. It is calculated automatically based on your account's "
+                "contract class.",
+                category=DeprecationWarning,
+            )
+
         execute_transaction = await self.sign_invoke_transaction(
             calls,
             nonce=nonce,
             max_fee=max_fee,
             auto_estimate=auto_estimate,
-            cairo_version=cairo_version,
         )
         return await self._client.send_transaction(execute_transaction)
 
@@ -464,7 +500,10 @@ async def deploy_account(
             )
 
         account = Account(
-            address=address, client=client, key_pair=key_pair, chain=chain
+            address=address,
+            client=client,
+            key_pair=key_pair,
+            chain=chain,
         )
 
         deploy_account_tx = await account.sign_deploy_account_transaction(

starknet_py/net/account/base_account.py

@@ -28,6 +28,13 @@ def address(self) -> int:
         Get the address of the account
         """
 
+    @property
+    @abstractmethod
+    async def cairo_version(self) -> int:
+        """
+        Get Cairo version of the account.
+        """
+
     @property
     @abstractmethod
     def client(self) -> Client:
@@ -102,6 +109,8 @@ async def sign_invoke_transaction(
         nonce: Optional[int] = None,
         max_fee: Optional[int] = None,
         auto_estimate: bool = False,
+        # TODO (#1184): remove that and docstring
+        cairo_version: Optional[int] = None,
     ) -> Invoke:
         """
         Takes calls and creates signed Invoke.
@@ -110,6 +119,12 @@ async def sign_invoke_transaction(
         :param nonce: Nonce of the transaction.
         :param max_fee: Max amount of Wei to be paid when executing transaction.
         :param auto_estimate: Use automatic fee estimation, not recommend as it may lead to high costs.
+        :param cairo_version:
+            Cairo version of the account used.
+
+            .. deprecated:: 0.18.2
+                Parameter `cairo_version` has been deprecated - it is calculated automatically based on
+                your account's contract class.
         :return: Invoke created from the calls.
         """
 
@@ -188,6 +203,8 @@ async def execute(
         nonce: Optional[int] = None,
         max_fee: Optional[int] = None,
         auto_estimate: bool = False,
+        # TODO (#1184): remove that and docstring
+        cairo_version: Optional[int] = None,
     ) -> SentTransactionResponse:
         """
         Takes calls and executes transaction.
@@ -196,6 +213,12 @@ async def execute(
         :param nonce: Nonce of the transaction.
         :param max_fee: Max amount of Wei to be paid when executing transaction.
         :param auto_estimate: Use automatic fee estimation, not recommend as it may lead to high costs.
+        :param cairo_version:
+            Cairo version of the account used.
+
+            .. deprecated:: 0.18.2
+                Parameter `cairo_version` has been deprecated - it is calculated automatically based on
+                your account's contract class.
         :return: SentTransactionResponse.
         """
 

starknet_py/tests/e2e/account/account_test.py

@@ -15,6 +15,7 @@
     DeployAccountTransaction,
     DeployAccountTransactionResponse,
     EstimatedFee,
+    SierraContractClass,
     TransactionStatus,
 )
 from starknet_py.net.full_node_client import FullNodeClient
@@ -591,3 +592,107 @@ async def test_sign_transaction_custom_nonce(account, cairo1_hello_starknet_clas
 
     assert invoke_tx.nonce == deploy_tx.nonce + 1
     assert result == [new_balance]
+
+
+@pytest.mark.asyncio
+async def test_argent_cairo1_account_deploy(
+    full_node_client,
+    argent_cairo1_account_class_hash,
+    deploy_account_details_factory,
+):
+    address, key_pair, salt, class_hash = await deploy_account_details_factory.get(
+        class_hash=argent_cairo1_account_class_hash, argent_calldata=True
+    )
+
+    deploy_result = await Account.deploy_account(
+        address=address,
+        class_hash=class_hash,
+        salt=salt,
+        key_pair=key_pair,
+        client=full_node_client,
+        constructor_calldata=[key_pair.public_key, 0],
+        chain=StarknetChainId.TESTNET,
+        max_fee=int(1e16),
+    )
+    await deploy_result.wait_for_acceptance()
+    account = deploy_result.account
+
+    assert isinstance(account, BaseAccount)
+    assert await account.cairo_version == 1
+
+    account_contract_class = await full_node_client.get_class_at(
+        contract_address=account.address, block_number="latest"
+    )
+
+    assert isinstance(account_contract_class, SierraContractClass)
+
+
+@pytest.mark.asyncio
+async def test_argent_cairo1_account_execute(
+    deployed_balance_contract,
+    argent_cairo1_account: BaseAccount,
+):
+    # verify that initial balance is 0
+    get_balance_call = Call(
+        to_addr=deployed_balance_contract.address,
+        selector=get_selector_from_name("get_balance"),
+        calldata=[],
+    )
+    get_balance = await argent_cairo1_account.client.call_contract(
+        call=get_balance_call, block_number="latest"
+    )
+
+    assert get_balance[0] == 0
+
+    value = 20
+    increase_balance_by_20_call = Call(
+        to_addr=deployed_balance_contract.address,
+        selector=get_selector_from_name("increase_balance"),
+        calldata=[value],
+    )
+    execute = await argent_cairo1_account.execute(
+        calls=increase_balance_by_20_call, max_fee=int(1e16)
+    )
+    await argent_cairo1_account.client.wait_for_tx(tx_hash=execute.transaction_hash)
+    receipt = await argent_cairo1_account.client.get_transaction_receipt(
+        tx_hash=execute.transaction_hash
+    )
+
+    # TODO (#1179): devnet 0.3.0 still return STATUS instead of FINALITY_STATUS
+    assert receipt.status == TransactionStatus.ACCEPTED_ON_L2
+
+    # verify that the previous call was executed
+    get_balance_call = Call(
+        to_addr=deployed_balance_contract.address,
+        selector=get_selector_from_name("get_balance"),
+        calldata=[],
+    )
+    get_balance = await argent_cairo1_account.client.call_contract(
+        call=get_balance_call, block_number="latest"
+    )
+
+    assert get_balance[0] == value
+
+
+# TODO (#1184): remove that
+@pytest.mark.asyncio
+async def test_cairo1_account_deprecations(
+    deployed_balance_contract,
+    argent_cairo1_account: BaseAccount,
+):
+    call = Call(
+        to_addr=deployed_balance_contract.address,
+        selector=get_selector_from_name("increase_balance"),
+        calldata=[20],
+    )
+    with pytest.warns(
+        DeprecationWarning,
+        match="Parameter 'cairo_version' has been deprecated. It is calculated automatically based on your account's "
+        "contract class.",
+    ):
+        _ = await argent_cairo1_account.execute(
+            calls=call, max_fee=int(1e16), cairo_version=1
+        )
+        _ = await argent_cairo1_account.sign_invoke_transaction(
+            calls=call, max_fee=int(1e16), cairo_version=1
+        )

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

@@ -20,9 +20,7 @@ async def test_account_sign_without_execute(account, map_compiled_contract):
     call = Call(to_addr=address, selector=selector, calldata=calldata)
     invoke_transaction = await account.sign_invoke_transaction(call, max_fee=max_fee)
     # Or if you're using Cairo1 account with new calldata encoding
-    invoke_transaction = await account.sign_invoke_transaction(
-        call, max_fee=max_fee, cairo_version=1
-    )
+    invoke_transaction = await account.sign_invoke_transaction(call, max_fee=max_fee)
 
     # Create a signed Declare transaction
     declare_transaction = await account.sign_declare_transaction(

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

@@ -6,11 +6,11 @@
 
 
 @pytest.mark.asyncio
-async def test_custom_nonce(full_node_client):
+async def test_custom_nonce(full_node_account):
     # pylint: disable=import-outside-toplevel
-    address = 0x1
-    client = full_node_client
-    private_key = 0x1
+    client = full_node_account.client
+    address = full_node_account.address
+    private_key = full_node_account.signer.key_pair.private_key
 
     # docs: start
     from starknet_py.net.account.account import Account