Skip to main content

ape-ledger: Plugin for Ledger Hardware Wallet

Project description

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 version 3.7 or greater, python3-dev

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

This project is in early development and should be considered an alpha. Things might not work, breaking changes are likely. Comments, questions, criticisms and pull requests are welcomed.

License

This project is licensed under the Apache 2.0.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ape-ledger-0.1.0a2.tar.gz (26.7 kB view details)

Uploaded Source

Built Distribution

ape_ledger-0.1.0a2-py3-none-any.whl (17.9 kB view details)

Uploaded Python 3

File details

Details for the file ape-ledger-0.1.0a2.tar.gz.

File metadata

  • Download URL: ape-ledger-0.1.0a2.tar.gz
  • Upload date:
  • Size: 26.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.5.0 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.12

File hashes

Hashes for ape-ledger-0.1.0a2.tar.gz
Algorithm Hash digest
SHA256 153d87e95a3e0f9a6070e242797dcccef20c1747b54507c8c6b81e5a7b0e8a67
MD5 4b56553afebfa7cdc37e0543cb321f6a
BLAKE2b-256 cbc580aec5ca82425d43b48fddec3821bfb583a2fe1b6f5bb7bdb7604fc22427

See more details on using hashes here.

File details

Details for the file ape_ledger-0.1.0a2-py3-none-any.whl.

File metadata

  • Download URL: ape_ledger-0.1.0a2-py3-none-any.whl
  • Upload date:
  • Size: 17.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.5.0 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.12

File hashes

Hashes for ape_ledger-0.1.0a2-py3-none-any.whl
Algorithm Hash digest
SHA256 298670dc1716d92724ce3e0762641df6e918668c310138800907c09ce051ef69
MD5 f6d4f990ded5a0b9b92739047527107c
BLAKE2b-256 6a0237358d293a0a57c4db513de015fd56b938d1bff35322d240bf40b41d482f

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page