Metadata-Version: 2.1
Name: ledgereth
Version: 0.10.0
Summary: Library to interface with ledger-app-eth on Ledger hardware wallets
Author-email: Mike Shultz <mike@mikeshultz.com>
License: MIT License
        
        Copyright (c) 2019 Mike Shultz
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: source, https://github.com/mikeshultz/ledger-eth-lib
Keywords: ethereum,evm,blockchain,development,ledger
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: eth-utils<6,>=2.1.0
Requires-Dist: ledgerblue==0.1.48
Requires-Dist: rlp~=4.0.1
Provides-Extra: dev
Requires-Dist: build~=1.2.2; extra == "dev"
Requires-Dist: eth-account>=0.13.1; extra == "dev"
Requires-Dist: pyright~=1.1.385; extra == "dev"
Requires-Dist: pytest>=5.3.2; extra == "dev"
Requires-Dist: ruff~=0.7.0; extra == "dev"
Requires-Dist: setuptools>=61.0.0; extra == "dev"
Requires-Dist: twine>=3.1.1; extra == "dev"
Requires-Dist: web3[tester]~=7.3.1; extra == "dev"
Requires-Dist: wheel>=0.33.6; extra == "dev"
Provides-Extra: docs
Requires-Dist: sphinx~=8.1.3; extra == "docs"
Requires-Dist: sphinx-autobuild~=2024.10.3; extra == "docs"
Requires-Dist: sphinx-rtd-theme~=3.0.1; extra == "docs"

# ledgereth

[![Documentation Status](https://readthedocs.org/projects/ledgereth/badge/?version=latest)](https://ledgereth.readthedocs.io/en/latest/?badge=latest)

**This library is beta.  Please [report any bugs](https://github.com/mikeshultz/ledger-eth-lib/issues/new) you find.**

This is a library to interact with [app-ethereum](https://github.com/LedgerHQ/app-ethereum), the Ethereum app for the [Ledger hardware wallets](https://www.ledger.com/).  It's goal is to make interfacing with the Ledger easy.

## Quickstart

Here’s the quickest way to get started.

    pip install ledgereth

Please see [the ledgereth documentation](https://ledgereth.readthedocs.io/) for more detailed information.

## Compatability

### Ledger Devices

This lib has been tested to work on Ledger Nano S and Nano X.  It will probalby work with Ledger Blue and any devices the [`ledgerblue` library](https://github.com/LedgerHQ/blue-loader-python) and [app-ethereum](https://github.com/LedgerHQ/app-ethereum) supports.

### Ledger Account Derivations

The Ledger-provided desktop apps have changed the way accounts are derived with the release of Ledger Live.  If you created your Ledger account(s) with the older Chrome app and want to use those account(s) with this library, you will need to set the `LEDGER_LEGACY_ACCOUNTS` env var. You can only use one or the other at a time.  See [the notes in source for more information](https://github.com/mikeshultz/ledger-eth-lib/blob/master/ledgereth/web3.py#L8-L34).
