Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/apeworx/ape-ledger
Ledger Nano S and X account plugin for the Ape Framework
https://github.com/apeworx/ape-ledger
ape apeworx ethereum ledger ledger-api-client ledger-plugin ledger-wallet python wallet web3
Last synced: 7 days ago
JSON representation
Ledger Nano S and X account plugin for the Ape Framework
- Host: GitHub
- URL: https://github.com/apeworx/ape-ledger
- Owner: ApeWorX
- License: apache-2.0
- Created: 2021-03-17T00:30:17.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-12-10T16:38:02.000Z (about 1 month ago)
- Last Synced: 2025-01-12T12:30:32.243Z (8 days ago)
- Topics: ape, apeworx, ethereum, ledger, ledger-api-client, ledger-plugin, ledger-wallet, python, wallet, web3
- Language: Python
- Homepage: https://www.apeworx.io/
- Size: 233 KB
- Stars: 6
- Watchers: 4
- Forks: 8
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Quick Start
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.9 up to 3.12.
## 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
```
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 --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
```
## 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.