Skip to main content

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

Installation

via pip

You can install the latest release via pip:

pip install ape-ledger

via setuptools

You can clone the repository and use setuptools for the most up-to-date version:

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:

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.

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:

ape ledger list

Remove accounts

You can also remove accounts:

ape ledger delete <alias>

Development

Please see the contributing guide to learn more how to contribute to this project. Comments, questions, criticisms and pull requests are welcomed.

Metadata

Release files for ape-ledger 0.8.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ape-ledger 0.8.4
File Size Uploaded
ape_ledger-0.8.4.tar.gz 29.6 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for ape-ledger 0.8.4
File Interpreter ABI Platform
ape_ledger-0.8.4-py3-none-any.whl Python 3 none any Details

Total release size: 46.6 kB

Release files / ape_ledger-0.8.4.tar.gz

Download URL ape_ledger-0.8.4.tar.gz
Size 29.6 kB
Tags Source
SHA-256 checksum
How to use checksums
59c28ec274e2f354be7d41f6010ae3e172e442a947ffbe71576a411ec8307d35
BLAKE2b-256 checksum
How to use checksums
ea4488186bd8a003d8f1fdb42a4884f8167dd688e58d5559ca1110a2844021df
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.0.1 CPython/3.10.20

Release files / ape_ledger-0.8.4-py3-none-any.whl

Download URL ape_ledger-0.8.4-py3-none-any.whl
Size 17.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
7a74430739e2ada00327c6cda59a77dfa167f6e02b8db659eb3584a352deb203
BLAKE2b-256 checksum
How to use checksums
94d034ce57001dac265f39c119ff583cf9d851438de8d9a20435aa1181bd23be
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.0.1 CPython/3.10.20
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page