Skip to content

Latest commit

 

History

History
83 lines (53 loc) · 1.82 KB

README.md

File metadata and controls

83 lines (53 loc) · 1.82 KB
Raw

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 MyCryptoHQ/MyCrypto#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.