Trace API

.github/workflows/checks.yml

@@ -227,15 +227,22 @@ jobs:
         uses: codecov/codecov-action@v3
 
   # ---------------------------------------------------------- #
-  # ..................RUN-TESTS-INTEGRATION................... #
+  # ..................RUN-TESTS-ON-NETWORKS................... #
   # ---------------------------------------------------------- #
 
-  run-tests-integration:
-    name: Tests on integration
+  run-tests-on-networks:
+    name: Tests on networks (testnet and integration)
     needs: setup-tests
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
+    env:
+      INTEGRATION_RPC_URL: ${{ secrets.INTEGRATION_RPC_URL }}
+      TESTNET_RPC_URL: ${{ secrets.TESTNET_RPC_URL }}
+      INTEGRATION_ACCOUNT_PRIVATE_KEY: ${{ secrets.INTEGRATION_ACCOUNT_PRIVATE_KEY }}
+      INTEGRATION_ACCOUNT_ADDRESS: ${{ secrets.INTEGRATION_ACCOUNT_ADDRESS }}
+      TESTNET_ACCOUNT_PRIVATE_KEY: ${{ secrets.TESTNET_ACCOUNT_PRIVATE_KEY }}
+      TESTNET_ACCOUNT_ADDRESS: ${{ secrets.TESTNET_ACCOUNT_ADDRESS }}
     steps:
       - uses: actions/checkout@v3
 
@@ -281,8 +288,8 @@ jobs:
 
       - name: Run tests
         run: |
-          poetry run poe test_ci_integration_full_node
-          poetry run poe test_ci_integration_gateway
+          poetry run poe test_ci_on_networks_full_node
+          poetry run poe test_ci_on_networks_gateway
 
       - name: Generate coverage in XML
         run: |

.gitignore

@@ -154,3 +154,4 @@ cython_debug/
 
 # Cairo1 compiler manifest
 /starknet_py/tests/e2e/manifest-path
+/starknet_py/tests/e2e/test-variables.env

docs/development.rst

@@ -15,13 +15,31 @@ Make sure running ``poetry run python --version`` returns ``Python 3.9.x``.
 Setup
 -----
 
+In order to run Cairo1 devnet tests and compile contracts in Cairo1 via poetry command,
+you need to create ``manifest-path`` file in ``starknet_py/tests/e2e/`` directory and pass the path in it to Cairo compiler.
+An example file - ``manifest-path.template`` is in the same directory. Additional info can be found in `devnet docs <https://0xspaceshard.github.io/starknet-devnet/docs/guide/cairo1-support>`_.
+
+In order to be able to run tests on testnet and integration networks (``starknet_py/tests/e2e/tests_on_networks/``), you must set some environmental variables:
+
+    - ``INTEGRATION_RPC_URL``
+    - ``TESTNET_RPC_URL``
+    - ``INTEGRATION_ACCOUNT_PRIVATE_KEY``
+    - ``INTEGRATION_ACCOUNT_ADDRESS``
+    - ``TESTNET_ACCOUNT_PRIVATE_KEY``
+    - ``TESTNET_ACCOUNT_ADDRESS``
+
+The best way to do that is to create ``test-variables.env`` file in ``starknet_py/tests/e2e/`` directory, so they can be loaded by the ``python-dotenv`` library.
+You can find an example file ``test-variables.env.template`` in the same directory with the format of how it should look like.
+
 .. code-block:: bash
 
     # Install dependencies
     poetry install
 
     # Compile contracts
     poe compile_contracts
+    poe compile_contracts_v1
+    poe compile_contracts_v2
 
     # Make sure everything was installed properly
     poe test

docs/migration_guide.rst

@@ -1,6 +1,91 @@
 Migration guide
 ===============
 
+**********************
+0.18.2 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!
+
+0.18.2 Targeted versions
+------------------------
+
+- Starknet - `0.12.2 <https://community.starknet.io/t/introducing-p2p-authentication-and-mismatch-resolution-in-v0-12-2/97993>`_
+- RPC - `0.4.0 <https://github.com/starkware-libs/starknet-specs/releases/tag/v0.4.0>`_
+
+0.18.2 Breaking changes
+-----------------------
+
+.. currentmodule:: starknet_py.net.client
+
+1. :meth:`Client.get_block_traces` has been renamed to :meth:`Client.trace_block_transactions` in order to match RPC specification.
+
+
+0.18.2 Minor changes
+--------------------
+
+1. :meth:`Client.trace_block_transactions` return type has been changed from ``BlockTransactionTraces`` to ``Union[BlockTransactionTraces, List[BlockTransactionTrace]]``.
+
+.. currentmodule:: starknet_py.net.gateway_client
+
+2. ``include_block`` parameter in :meth:`GatewayClient.get_state_update` now works on gateway mainnet.
+
+
+0.18.2 Development-related changes
+----------------------------------
+
+1. In order to be able to run tests, you must set some environmental variables:
+
+    - ``INTEGRATION_RPC_URL``
+    - ``TESTNET_RPC_URL``
+    - ``INTEGRATION_ACCOUNT_PRIVATE_KEY``
+    - ``INTEGRATION_ACCOUNT_ADDRESS``
+    - ``TESTNET_ACCOUNT_PRIVATE_KEY``
+    - ``TESTNET_ACCOUNT_ADDRESS``
+
+The best way to do that is to create ``test-variables.env`` file in ``starknet_py/tests/e2e/`` directory, so they can be loaded by the ``python-dotenv`` library.
+You can find an example file ``test-variables.env.template`` in the same directory with the format of how it should look like.
+
+
+|
+
+.. raw:: html
+
+  <hr>
+
+|
+
+**********************
+0.18.1 Migration guide
+**********************
+
+.. currentmodule:: starknet_py.net.gateway_client
+
+This version contains a quick fix to :meth:`GatewayClient.get_state_update` method (mainnet wasn't updated to 0.12.2 then).
+
+.. currentmodule:: starknet_py.net.account.account
+
+Additionally, accounts in Cairo1 are now supported! You can pass additional argument ``cairo_version`` to :meth:`Account.sign_invoke_transaction` method.
+
+
+0.18.1 Minor changes
+--------------------
+
+1. Parameter ``include_block`` in :meth:`GatewayClient.get_state_update` doesn't work on mainnet gateway (an error is thrown).
+
+.. currentmodule:: starknet_py.net.account.account
+
+2. :meth:`Account.sign_invoke_transaction` now accepts additional parameter ``cairo_version``, which allows specifying which type of calldata encoding should be used.
+
+|
+
+.. raw:: html
+
+  <hr>
+
+|
+
+
 **********************
 0.18.0 Migration guide
 **********************