Merge branch 'development'

Author: franciszekjob

.github/workflows/checks.yml

@@ -2,7 +2,7 @@ name: Checks
 
 env:
   CAIRO_LANG_VERSION: "0.13.1"
-  DEVNET_VERSION: "0.0.5"
+  DEVNET_VERSION: "0.1.2"
 
 on:
   push:
@@ -134,6 +134,7 @@ jobs:
         if: steps.cache-contracts.outputs.cache-hit != 'true'
         run: |
           pip install --upgrade setuptools
+          pip install sympy==1.11.1
           pip install cairo-lang==${{ env.CAIRO_LANG_VERSION }}
 
       - name: Compile contracts v0
@@ -159,6 +160,10 @@ jobs:
       fail-fast: false
       matrix:
         python-version: [ "3.8", "3.9", "3.10", "3.11", "3.12" ]
+    env:
+      LEDGER_PROXY_ADDRESS: 127.0.0.1
+      LEDGER_PROXY_PORT: 9999
+      SEPOLIA_RPC_URL: ${{ secrets.SEPOLIA_RPC_URL }}
     steps:
       - uses: actions/checkout@v4
 
@@ -196,6 +201,48 @@ jobs:
       - name: Install devnet
         run: ./starknet_py/tests/install_devnet.sh
 
+      # ====================== SETUP LEDGER SPECULOS ====================== #
+
+      - name: Pull speculos image
+        run: docker pull ghcr.io/ledgerhq/ledger-app-builder/ledger-app-dev-tools
+
+
+      - name: Clone LedgerHQ Starknet app repository
+        run: git clone https://github.com/LedgerHQ/app-starknet.git
+
+      - name: Build the app inside Docker container
+        uses: addnab/docker-run-action@v3
+        with:
+          image: ghcr.io/ledgerhq/ledger-app-builder/ledger-app-dev-tools
+          options: --rm -v ${{ github.workspace }}:/apps
+          run: |
+            cd /apps/app-starknet
+            cargo clean
+            cargo ledger build nanox
+
+      - name: Start Speculos emulator container
+        uses: addnab/docker-run-action@v3
+        with:
+          image: ghcr.io/ledgerhq/ledger-app-builder/ledger-app-dev-tools
+          options: --rm -d --name speculos-emulator -v ${{ github.workspace }}:/apps --publish 5000:5000 --publish 9999:9999
+          run: |
+            speculos \
+            -m nanox \
+            --apdu-port 9999 \
+            --api-port 5000 \
+            --display headless \
+            /apps/app-starknet/target/nanox/release/starknet
+
+      - name: Wait for Speculos to start
+        run: sleep 5
+
+      - name: Update automation rules
+        working-directory: starknet_py/tests/unit/signer
+        run: |
+          curl -X POST http://127.0.0.1:5000/automation \
+          -H "Content-Type: application/json" \
+          -d @speculos_automation.json
+
       # ====================== RUN TESTS ====================== #
 
       - name: Check circular imports
@@ -219,18 +266,15 @@ jobs:
   # ---------------------------------------------------------- #
 
   run-tests-on-networks:
-    name: Tests on networks (testnet and integration)
+    name: Tests on networks (testnet)
     needs: setup-tests
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
     env:
-      SEPOLIA_INTEGRATION_RPC_URL: ${{ secrets.SEPOLIA_INTEGRATION_RPC_URL }}
       SEPOLIA_RPC_URL: ${{ secrets.SEPOLIA_RPC_URL }}
       SEPOLIA_ACCOUNT_ADDRESS: ${{ secrets.SEPOLIA_ACCOUNT_ADDRESS }}
       SEPOLIA_ACCOUNT_PRIVATE_KEY: ${{ secrets.SEPOLIA_ACCOUNT_PRIVATE_KEY }}
-      SEPOLIA_INTEGRATION_ACCOUNT_PRIVATE_KEY: ${{ secrets.SEPOLIA_INTEGRATION_ACCOUNT_PRIVATE_KEY }}
-      SEPOLIA_INTEGRATION_ACCOUNT_ADDRESS: ${{ secrets.SEPOLIA_INTEGRATION_ACCOUNT_ADDRESS }}
     steps:
       - uses: actions/checkout@v4
 
@@ -293,11 +337,13 @@ jobs:
       fail-fast: false
       matrix:
         python-version: [ "3.8", "3.9", "3.10", "3.11", "3.12" ]
+    env:
+      SEPOLIA_RPC_URL: ${{ secrets.SEPOLIA_RPC_URL }}
     steps:
       - uses: actions/checkout@v4
       - uses: dtolnay/rust-toolchain@dc6353516c68da0f06325f42ad880f76a5e77ec9
         with:
-          toolchain: stable
+          toolchain: 1.79.0  # Doesn't work with "stable"
 
       - name: Download contracts
         uses: actions/download-artifact@v3
@@ -315,7 +361,7 @@ jobs:
       - name: Install devnet
         run: |
           $DEVNET_INSTALL_DIR = "$(git rev-parse --show-toplevel)/starknet_py/tests/e2e/devnet"
-          cargo install starknet-devnet --version ${{ env.DEVNET_VERSION }} --root $DEVNET_INSTALL_DIR
+          cargo install --git https://github.com/0xSpaceShard/starknet-devnet-rs.git --locked --rev 3ad81456092a2da939be1f590855cea2c18ce40c --root $DEVNET_INSTALL_DIR
 
       # ====================== SETUP PYTHON ====================== #
 
@@ -433,7 +479,7 @@ jobs:
       - uses: actions/checkout@v4
       - uses: dtolnay/rust-toolchain@dc6353516c68da0f06325f42ad880f76a5e77ec9
         with:
-          toolchain: stable
+          toolchain: 1.79.0 # Doesn't work with "stable"
 
       - name: Download contracts
         uses: actions/download-artifact@v3
@@ -469,7 +515,7 @@ jobs:
       - name: Install devnet
         run: |
           $DEVNET_INSTALL_DIR = "$(git rev-parse --show-toplevel)/starknet_py/tests/e2e/devnet"
-          cargo install starknet-devnet --version ${{ env.DEVNET_VERSION }} --root $DEVNET_INSTALL_DIR
+          cargo install --git https://github.com/0xSpaceShard/starknet-devnet-rs.git --locked --rev 3ad81456092a2da939be1f590855cea2c18ce40c --root $DEVNET_INSTALL_DIR
 
       # ====================== RUN TESTS ====================== #
 

docs/api.rst

@@ -4,6 +4,7 @@ API
 
    api/client
    api/full_node_client
+   api/devnet_client
    api/account
    api/client_models
    api/client_errors

docs/api/devnet_client.rst

@@ -0,0 +1,8 @@
+DevnetClient
+============
+
+.. py:module:: starknet_py.devnet_utils.devnet_client
+
+.. autoclass-with-examples:: DevnetClient
+    :members:
+    :member-order: groupwise

docs/api/signer.rst

@@ -32,3 +32,12 @@ KeyPair
     :undoc-members:
     :member-order: groupwise
 
+------------
+LedgerSigner
+------------
+
+.. py:module:: starknet_py.net.signer.ledger_signer
+
+.. autoclass:: LedgerSigner
+    :members:
+    :member-order: groupwise

docs/development.rst

@@ -23,12 +23,12 @@ To install `starknet-devnet-rs <https://github.com/0xSpaceShard/starknet-devnet-
 Environment variables
 ^^^^^^^^^^^^^^^^^^^^^
 
-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:
+In order to be able to run devnet client tests (``starknet_py/tests/e2e/client_devnet``) you must set environmental variable:
 
-    - ``SEPOLIA_INTEGRATION_RPC_URL``
     - ``SEPOLIA_RPC_URL``
-    - ``SEPOLIA_INTEGRATION_ACCOUNT_PRIVATE_KEY``
-    - ``SEPOLIA_INTEGRATION_ACCOUNT_ADDRESS``
+
+To run tests on testnet network (``starknet_py/tests/e2e/tests_on_networks/``) additionally you must set:
+
     - ``SEPOLIA_ACCOUNT_PRIVATE_KEY``
     - ``SEPOLIA_ACCOUNT_ADDRESS``
 

docs/guide/signing.rst

@@ -12,6 +12,21 @@ signing algorithm, it is possible to create ``Account`` with custom
     :language: python
     :dedent: 4
 
+Signing with Ledger
+-------------------
+:ref:`LedgerSigner` allows you to sign transactions using a Ledger device. The device must be unlocked and Starknet app needs to be open.
+
+.. codesnippet:: ../../starknet_py/tests/unit/signer/test_ledger_signer.py
+    :language: python
+    :dedent: 4
+
+Deploying account and transferring STRK
+---------------------------------------
+.. codesnippet:: ../../starknet_py/tests/unit/signer/test_ledger_signer.py
+    :language: python
+    :dedent: 4
+    :start-after: docs-deploy-account-and-transfer: start
+    :end-before: docs-deploy-account-and-transfer: end
 
 Signing off-chain messages
 -------------------------------

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
 ******************************