History

Simon Warta e4968eee76 Set version 0.29.0-alpha.1		2022-08-05 15:31:54 +02:00
..
demo	Refactor we demo and add show address functionality	2022-01-26 13:45:20 +01:00
src	Remove the usage of the simapp42 backend	2022-08-03 18:43:06 +02:00
.eslintignore	Rename launchpad-ledger package -> ledger-amino	2021-01-21 12:53:31 +00:00
.eslintrc.js	Disable @typescript-eslint/explicit-module-boundary-types for .js files	2022-01-26 13:45:20 +01:00
.gitignore	Rename launchpad-ledger package -> ledger-amino	2021-01-21 12:53:31 +00:00
.nycrc.yml	ledger-amino: Add missing .nycrc.yml	2021-05-18 15:16:02 +02:00
jasmine-testrunner.js	Remove executable flag from jasmine testrunners	2021-06-01 10:50:02 +02:00
package.json	Set version 0.29.0-alpha.1	2022-08-05 15:31:54 +02:00
README.md	Remove the usage of the simapp42 backend	2022-08-03 18:43:06 +02:00
tsconfig.eslint.json	Sort out eslint	2021-05-18 15:16:03 +02:00
tsconfig.json	Bump target to es2018	2022-01-27 23:45:05 +01:00
typedoc.js	Upgrade typedoc to 0.20	2021-03-11 15:38:48 +01:00
webpack.demo.config.js	Refactor we demo and add show address functionality	2022-01-26 13:45:20 +01:00

README.md

@cosmjs/ledger-amino

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

Serve the project locally:

# 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.

Running tests

The tests in this package require a Ledger device initialized with the mnemonic from scripts/wasmd/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.

Stargate tests

Start a local Stargate blockchain as described in scripts/simapp44/README.md and execute:

export LEDGER_ENABLED=1
export SIMAPP44_ENABLED=1
yarn test

License

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