Metadata-Version: 2.1
Name: ape-ledger
Version: 0.2.0
Summary: ape-ledger: Plugin for Ledger Hardware Wallet
Home-page: https://github.com/ApeWorX/ape-ledger
Author: ApeWorX Ltd.
Author-email: admin@apeworx.io
License: Apache-2.0
Keywords: ethereum
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Operating System :: MacOS
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Requires-Python: >=3.7.2,<4
Description-Content-Type: text/markdown
Requires-Dist: click (>=8.0.0)
Requires-Dist: hidapi (==0.10.1)
Requires-Dist: eth-ape (<0.3.0,>=0.2.1)
Requires-Dist: eth-account (<0.6.0,>=0.5.6)
Requires-Dist: eth-typing (>=2.2.2)
Requires-Dist: eth-utils (>=1.10.0)
Requires-Dist: hexbytes (==0.2.2)
Requires-Dist: importlib-metadata
Requires-Dist: rlp (>=2.0.1)
Provides-Extra: dev
Requires-Dist: pytest (<7.0,>=6.0) ; extra == 'dev'
Requires-Dist: pytest-xdist ; extra == 'dev'
Requires-Dist: pytest-cov ; extra == 'dev'
Requires-Dist: pytest-mock ; extra == 'dev'
Requires-Dist: eip712 ; extra == 'dev'
Requires-Dist: hypothesis (<7.0,>=6.2.0) ; extra == 'dev'
Requires-Dist: commitizen (<2.20,>=2.19) ; extra == 'dev'
Requires-Dist: black (<23.0,>=22.3.0) ; extra == 'dev'
Requires-Dist: mypy (<1.0,>=0.910) ; extra == 'dev'
Requires-Dist: flake8 (<4.0,>=3.8.3) ; extra == 'dev'
Requires-Dist: isort (<6.0,>=5.10.1) ; extra == 'dev'
Requires-Dist: setuptools ; extra == 'dev'
Requires-Dist: wheel ; extra == 'dev'
Requires-Dist: twine ; extra == 'dev'
Requires-Dist: pre-commit ; extra == 'dev'
Requires-Dist: pytest-watch ; extra == 'dev'
Requires-Dist: IPython ; extra == 'dev'
Requires-Dist: ipdb ; extra == 'dev'
Provides-Extra: lint
Requires-Dist: commitizen (<2.20,>=2.19) ; extra == 'lint'
Requires-Dist: black (<23.0,>=22.3.0) ; extra == 'lint'
Requires-Dist: mypy (<1.0,>=0.910) ; extra == 'lint'
Requires-Dist: flake8 (<4.0,>=3.8.3) ; extra == 'lint'
Requires-Dist: isort (<6.0,>=5.10.1) ; extra == 'lint'
Provides-Extra: release
Requires-Dist: setuptools ; extra == 'release'
Requires-Dist: wheel ; extra == 'release'
Requires-Dist: twine ; extra == 'release'
Provides-Extra: test
Requires-Dist: pytest (<7.0,>=6.0) ; extra == 'test'
Requires-Dist: pytest-xdist ; extra == 'test'
Requires-Dist: pytest-cov ; extra == 'test'
Requires-Dist: pytest-mock ; extra == 'test'
Requires-Dist: eip712 ; extra == 'test'
Requires-Dist: hypothesis (<7.0,>=6.2.0) ; extra == 'test'

# ape-ledger

Ape Ledger is a plugin for Ape Framework which integrates with Ledger devices 
to load and create accounts, sign messages, and sign transactions.

## Dependencies

* [python3](https://www.python.org/downloads) version 3.7 or greater, python3-dev

## Installation

### via `pip`

You can install the latest release via [`pip`](https://pypi.org/project/pip/):

```bash
pip install ape-ledger
```

### via `setuptools`

You can clone the repository and use [`setuptools`](https://github.com/pypa/setuptools) for the most up-to-date version:

```bash
git clone https://github.com/ApeWorX/ape-ledger.git
cd ape-ledger
python3 setup.py install
```

## Quick Usage

You must:

* have the Ledger USB device connected
* have the Ledger USB device unlocked (by entering the passcode)
* and have the Ethereum app open.

Then, add accounts:

```bash
ape ledger add <alias>
```

Ledger accounts have the following capabilities in `ape`:

1. Can sign transactions
2. Can sign messages using the default EIP-191 specification
3. Can sign messages using the EIP-712 specification

### Adjust HD Path

If you need to adjust your HD path, use the `--hd-path` flag when adding the account.

```bash
ape ledger add <alias> --hd-path "m/44'/60'/0'/0/{x}"
```

`{x}` indicates the account node. Note that excluding `{x}` assumes the account node is at the end
of the path.

The default HD path for the Ledger plugin is `m/44'/60'/{x}'/0/0`.
See https://github.com/MyCryptoHQ/MyCrypto/issues/2070 for more information.

## List accounts

To list just your Ledger accounts in `ape`, do:

```bash
ape ledger list
```

## Remove accounts

You can also remove accounts:

```bash
ape ledger delete <alias>
```

## Development

Please see the [contributing guide](CONTRIBUTING.md) to learn more how to contribute to this project.
Comments, questions, criticisms and pull requests are welcomed.

## License

This project is licensed under the [Apache 2.0](LICENSE).


