Skip to content
This repository has been archived by the owner on Feb 17, 2022. It is now read-only.

persistenceOne/ledger-amino

Repository files navigation

⛔️ DEPRECATED ⛔️

@cosmjs/ledger-amino

This library is a fork of cosmjs/ledger-amino.
It is required by persistence due to unique coin-type 750 that persistence uses.
From cosmjs 26.3 onwards cosmjs adds support for custom coin-type which can be used to connect to ledger, making this repository obsolete.

npm version

Supported platforms

This library must be provided with a Ledger transport, and has been tested with appropriate transports for Node.js as well as certain browsers. In our demo code we use @ledgerhq/hw-transport-node-hid to connect to Ledger devices from Node.js. We use the @ledgerhq/hw-transport-webusb library to connect to Ledger devices from the browser via USB. You can check the support status of this library here.

Running the demo

Node.js

Connect the Ledger device via USB, open the Cosmos app, then run the demo (this will also build the package):

yarn demo-node

Browser

Build the package for web:

yarn pack-web

Host the ledger-amino package directory, for example using Python 3:

python3 -m http.server

Visit the demo page in a browser, for example if using the Python 3 option: http://localhost:8000/demo.

Then follow the instructions on that page.

Runnng tests

The tests in this package require a Ledger device initialized with the mnemonic from scripts/launchpad/README.md#preset-accounts (see "Ledger: accounts for Ledger based demos and tests") with an installed "Cosmos (ATOM)" app. The device must be connected via USB, unlocked and the Cosmos app must be opened. The tests require the user to manually approve transactions. Start a local Launchpad blockchain as described in scripts/launchpad/README.md and execute:

export LEDGER_ENABLED=1
export LAUNCHPAD_ENABLED=1
yarn test

License

This package is part of the cosmjs repository, licensed under the Apache License 2.0 (see NOTICE and LICENSE).