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

Please see the contributing guide 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.

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.2.1.tar.gz (30.6 kB view hashes)

Uploaded source

Built Distribution

ape_ledger-0.2.1-py3-none-any.whl (19.3 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page