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.0a1.tar.gz (27.1 kB view details)

Uploaded Source

Built Distribution

ape_ledger-0.1.0a1-py3-none-any.whl (18.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ape-ledger-0.1.0a1.tar.gz
  • Upload date:
  • Size: 27.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 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.0a1.tar.gz
Algorithm Hash digest
SHA256 5a62b5140f7009bea362487a81371b1597048f5da87cd87ecfb757b7105a2650
MD5 a0e0db08a2e1d8ce578ded0daf32cf82
BLAKE2b-256 c359f3e544925cf81fd280e356073ec1f9a9fa0a6ab684abef858293bc478733

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ape_ledger-0.1.0a1-py3-none-any.whl
  • Upload date:
  • Size: 18.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 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.0a1-py3-none-any.whl
Algorithm Hash digest
SHA256 b452c535690db3e4fe59e0eba7a612ff6946f1bcf87b46d42b9d8fdb202112d0
MD5 7812c8c4fec177f9292c41273f857754
BLAKE2b-256 dbca7065fdbe5225c07fe31c450dec89984b8c9993b4e7a9dce76730e417333a

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