Make dependencies for Ledger support optional (#1474)

* Make dependencies for Ledger support optional

* Cleanup typehints

* Fix checks.yml workflow

* Fix code block in docs

* checks.yml: SETUP section, python setup, consistent matrix use

* Skip [ledger] for doc tests

* Revert unrelated changes

---------

Co-authored-by: Franciszek Job <[email protected]>

Author: droserasprout

.github/workflows/checks.yml

@@ -41,7 +41,7 @@ jobs:
 
       - name: Install dependencies
         run: |
-          poetry install
+          poetry install -E ledger
 
       - name: Check poetry.lock
         run: |
@@ -175,7 +175,7 @@ jobs:
 
       - name: Install dependencies
         run: |
-          poetry install
+          poetry install -E ledger
 
       # ====================== SETUP DEVNET ====================== #
 
@@ -287,7 +287,7 @@ jobs:
 
       - name: Install dependencies
         run: |
-          poetry install
+          poetry install -E ledger
 
       # ====================== SETUP DEVNET ====================== #
 
@@ -374,7 +374,7 @@ jobs:
 
       - name: Install dependencies
         run: |
-          poetry install
+          poetry install -E ledger
 
       # ====================== RUN TESTS ====================== #
 

.readthedocs.yml

@@ -9,7 +9,7 @@ build:
   jobs:
     pre_install:
       - pip install poetry
-      - poetry export -f requirements.txt --output requirements.txt --without-hashes --extras docs
+      - poetry export -f requirements.txt --output requirements.txt --without-hashes -E docs -E ledger
 
 sphinx:
   configuration: docs/conf.py

docs/api/signer.rst

@@ -36,6 +36,12 @@ KeyPair
 LedgerSigner
 ------------
 
+To use LedgerSigner, you need to install starknetpy with `ledger` extra like this:
+
+.. code-block:: bash
+
+    poetry add starknet_py[ledger]
+
 .. py:module:: starknet_py.net.signer.ledger_signer
 
 .. autoclass:: LedgerSigner

docs/development.rst

@@ -37,7 +37,7 @@ Dependencies
 
 .. code-block:: bash
 
-    poetry install
+    poetry install -E ledger
 
 Contracts
 ^^^^^^^^^
@@ -64,7 +64,7 @@ Documentation
 .. code-block:: bash
 
     # Install additional dependencies for docs
-    poetry install -E docs
+    poetry install -E ledger -E docs
 
     # Generate HTML documentation
     poe docs_create

poetry.lock

@@ -29,11 +29,12 @@ furo = { version = "^2024.5.6", optional = true }
 pycryptodome = "^3.17"
 crypto-cpp-py = "1.4.4"
 eth-keyfile = "^0.8.1"
-ledgerwallet = "^0.5.0"
-bip-utils = "^2.9.3"
+ledgerwallet = { version = "^0.5.0", optional = true }
+bip-utils = { version = "^2.9.3", optional = true }
 
 [tool.poetry.extras]
 docs = ["sphinx", "enum-tools", "furo"]
+ledger = ["ledgerwallet", "bip-utils"]
 
 [tool.poetry.group.dev.dependencies]
 pytest = "^8.2.2"

pyproject.toml

@@ -1,7 +1,4 @@
-from typing import List
-
-from bip_utils import Bip32KeyIndex, Bip32Path, Bip32Utils
-from ledgerwallet.client import LedgerClient
+from typing import TYPE_CHECKING, List
 
 from starknet_py.constants import (
     EIP_2645_PATH_LENGTH,
@@ -17,6 +14,27 @@
 from starknet_py.utils.typed_data import TypedData
 
 
+class LateException:
+    def __init__(self, exc: Exception):
+        self.exc = exc
+
+    def __getattr__(self, item):
+        raise self.exc
+
+    def __call__(self, *args, **kwargs):
+        self.__getattr__("exc")
+
+
+try:
+    from bip_utils import Bip32KeyIndex, Bip32Path, Bip32Utils
+    from ledgerwallet.client import LedgerClient
+except ImportError as e:
+    if TYPE_CHECKING:
+        raise
+    dummy = LateException(e)
+    Bip32KeyIndex, Bip32Path, Bip32Utils, LedgerClient = dummy, dummy, dummy, dummy
+
+
 class LedgerStarknetApp:
     def __init__(self):
         self.client: LedgerClient = LedgerClient(cla=STARKNET_CLA)