Merge branch 'development'

Author: franciszekjob

.github/workflows/checks.yml

@@ -361,7 +361,7 @@ jobs:
       - name: Install devnet
         run: |
           $DEVNET_INSTALL_DIR = "$(git rev-parse --show-toplevel)/starknet_py/tests/e2e/devnet"
-          cargo install --git https://github.com/0xSpaceShard/starknet-devnet-rs.git --locked --rev 3ad81456092a2da939be1f590855cea2c18ce40c --root $DEVNET_INSTALL_DIR
+          cargo install --git https://github.com/0xSpaceShard/starknet-devnet-rs.git --locked --rev 7e7dbb5 --root $DEVNET_INSTALL_DIR
 
       # ====================== SETUP PYTHON ====================== #
 
@@ -515,7 +515,7 @@ jobs:
       - name: Install devnet
         run: |
           $DEVNET_INSTALL_DIR = "$(git rev-parse --show-toplevel)/starknet_py/tests/e2e/devnet"
-          cargo install --git https://github.com/0xSpaceShard/starknet-devnet-rs.git --locked --rev 3ad81456092a2da939be1f590855cea2c18ce40c --root $DEVNET_INSTALL_DIR
+          cargo install --git https://github.com/0xSpaceShard/starknet-devnet-rs.git --locked --rev 7e7dbb5 --root $DEVNET_INSTALL_DIR
 
       # ====================== RUN TESTS ====================== #
 

docs/devnet_utils.rst

@@ -0,0 +1,6 @@
+Devnet Utils
+============
+
+.. toctree::
+
+    devnet_utils/mocking_interaction_with_l1

docs/devnet_utils/mocking_interaction_with_l1.rst

@@ -0,0 +1,65 @@
+Mocking interaction with L1
+===========================
+
+Abstract
+--------
+
+In order to test interaction with L1 contracts, devnet client provides a way to mock the L1 interaction.
+Before taking a look at the examples, please get familiar with the `devnet postman docs <https://0xspaceshard.github.io/starknet-devnet-rs/docs/postman>`_ and messaging mechanism:
+
+- `Writing messaging contracts <https://book.cairo-lang.org/ch16-04-L1-L2-messaging.html>`_
+- `Mechanism overview <https://docs.starknet.io/architecture-and-concepts/network-architecture/messaging-mechanism/>`_
+- `StarkGate example <https://docs.starknet.io/architecture-and-concepts/network-architecture/messaging-mechanism/>`_
+
+L1 network setup
+----------------
+
+First of all you should deploy `messaging contract <https://github.com/0xSpaceShard/starknet-devnet-rs/blob/138120b355c44ae60269167b326d1a267f7af0a8/contracts/l1-l2-messaging/solidity/src/MockStarknetMessaging.sol>`_
+on ethereum network or load the existing one.
+
+.. codesnippet:: ../../starknet_py/tests/e2e/docs/devnet_utils/test_l1_integration.py
+    :language: python
+    :dedent: 4
+
+
+L2 -> L1
+--------
+
+Deploying L2 interaction contract
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Interaction with L1 is done by sending a message using `send_message_to_l1_syscall` function.
+So in order to test it, you need to deploy a contract that has this functionality.
+Example contract: `l1_l2.cairo <https://github.com/0xSpaceShard/starknet-devnet-js/blob/5069ec3397f31a408d3df2734ae40d93b42a0f7f/test/data/l1_l2.cairo>`_
+
+.. codesnippet:: ../../starknet_py/tests/e2e/docs/devnet_utils/test_l1_integration.py
+    :language: python
+    :dedent: 4
+    :start-after: docs: messaging-contract-start
+    :end-before: docs: messaging-contract-end
+
+
+Consuming message
+^^^^^^^^^^^^^^^^^
+
+After deploying the contract, you need to flush the messages to the L1 network.
+And then you can consume the message on the L1 network.
+
+.. codesnippet:: ../../starknet_py/tests/e2e/docs/devnet_utils/test_l1_integration.py
+    :language: python
+    :dedent: 4
+    :start-after: docs: flush-1-start
+    :end-before: docs: flush-1-end
+
+L1 -> L2
+--------
+
+Sending mock transactions from L1 to L2 does not require L1 node to be running.
+
+.. codesnippet:: ../../starknet_py/tests/e2e/docs/devnet_utils/test_l1_integration.py
+    :language: python
+    :dedent: 4
+    :start-after: docs: send-l2-start
+    :end-before: docs: send-l2-end
+
+

docs/index.rst

@@ -19,6 +19,7 @@ Starknet SDK for Python
    account_creation
    quickstart
    guide
+   devnet_utils
    api
    development
    migration_guide

docs/migration_guide.rst

@@ -1,6 +1,32 @@
 Migration guide
 ===============
 
+******************************
+0.24.0 Migration guide
+******************************
+
+.. currentmodule:: starknet_py.devnet_utils.devnet_client
+
+1. :class:`DevnetClient` has been implemented to interact with additional features of the `starknet-devnet-rs <https://github.com/0xSpaceShard/starknet-devnet-rs>`_
+
+.. currentmodule:: starknet_py.net.signer.ledger_signer
+
+2. :class:`LedgerSigner` has been implemented to enable signing with Ledger hardware wallet
+
+0.24.0 Targeted versions
+------------------------
+
+- Starknet - `0.13.1.1 <https://docs.starknet.io/documentation/starknet_versions/version_notes/#version0.13.1.1>`_
+- RPC - `0.7.1 <https://github.com/starkware-libs/starknet-specs/releases/tag/v0.7.1>`_
+
+0.24.0 Breaking changes
+-----------------------
+
+.. currentmodule:: starknet_py.net.client_models
+
+1. :class:`CompiledContract` and :class:`ContractClass` have been renamed to :class:`DeprecatedCompiledContract` and :class:`DeprecatedContractClass`.
+2. :class:`ContractClassSchema` have been renamed to :class:`DeprecatedContractClassSchema`
+
 ******************************
 0.23.0 Migration guide
 ******************************
@@ -31,8 +57,6 @@ 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
 ******************************