History

willclarktech 53d7d34b8a Use convenience hash functions in codebase		2020-10-13 13:36:44 +02:00
..
custom_types	launchpad-ledger: Add basic type declaration for ledger-cosmos-js	2020-09-15 10:47:01 +02:00
demo	launchpad-ledger: Update demos for transport argument	2020-10-01 13:27:21 +02:00
nonces	Add nonces	2020-10-09 12:23:27 +02:00
src	Use convenience hash functions in codebase	2020-10-13 13:36:44 +02:00
types	launchpad-ledger: Finish aligning Ledger transport names	2020-10-06 16:50:38 +02:00
.eslintignore	launchpad-ledger: Add basic package setup	2020-09-15 10:46:57 +02:00
.gitignore	launchpad-ledger: Add basic package setup	2020-09-15 10:46:57 +02:00
jasmine-testrunner.js	Add initial Ledger tests	2020-09-30 14:36:33 +02:00
package.json	Use rm -rf in move-types scripts	2020-10-13 12:40:49 +02:00
README.md	launchpad-ledger: Update README for transport restructure	2020-10-06 13:53:43 +02:00
tsconfig.json	launchpad-ledger: Add basic type declaration for ledger-cosmos-js	2020-09-15 10:47:01 +02:00
typedoc.js	launchpad-ledger: Tidy auxiliary files	2020-09-15 15:03:16 +02:00
webpack.demo.config.js	launchpad-ledger: Add Node.js demo	2020-09-17 15:16:43 +02:00

README.md

@cosmjs/launchpad-ledger

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 launchpad-ledger 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/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. Start a local wasmd blockchain as described in scripts/wasmd/README.md and execute:

export LEDGER_ENABLED=1
export WASMD_ENABLED=1
yarn test

License

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