Signer
======

--------------------
BaseSigner interface
--------------------

.. py:module:: starknet_py.net.signer

.. autoclass:: BaseSigner
    :members:
    :member-order: groupwise

---------------------------------
BaseSigner default implementation
---------------------------------

By default, starknet.py uses ``StarkCurveSigner`` which works with OpenZeppelin's account contract.

.. py:module:: starknet_py.net.signer.stark_curve_signer

.. autoclass:: StarkCurveSigner
    :members:
    :member-order: groupwise

-------
KeyPair
-------

.. autoclass:: KeyPair
    :members:
    :undoc-members:
    :member-order: groupwise

.. warning::
    **Not Audited:** The ``KeyPair.generate()`` function has not been audited for cryptographic security. Use at your own risk.

------------
LedgerSigner
------------

To use LedgerSigner, you need to install starknetpy with ``ledger`` extra like this:

.. code-block:: bash

    poetry add starknet_py[ledger]

Under a Debian or Ubuntu based system, you will need to install additional packages:

.. code-block:: bash

    sudo apt install python3-dev libusb-1.0-0-dev libudev-dev

They are needed for compiling HIDAPI. Read official `ledgerctl installation guide <https://github.com/LedgerHQ/ledgerctl?tab=readme-ov-file#quick-install)>`_ for more details.

.. py:module:: starknet_py.net.signer.ledger_signer

.. autoclass:: LedgerSigner
    :members:
    :member-order: groupwise

-----------------
LedgerSigningMode
-----------------

.. autoclass:: LedgerSigningMode
    :members:
    :member-order: groupwise

---------
EthSigner
---------

Signer compatible with the Ethereum signature.

.. py:module:: starknet_py.net.signer.eth_signer

.. autoclass:: EthSigner
    :members:
    :member-order: groupwise