@cardano-foundation/ledgerjs-hw-app-cardano

@cardano-foundation/ledgerjs-hw-app-cardano

JS Library for communication with Ledger Hardware Wallets. This library is compatible with the Cardano ADA Ledger Application.

Note: this project comes with both Typescript and Flow type definitions, but only the Typescript ones are checked for correctness.

Example code

Example code interacting with hw-app-cardano is provided in example-node directory. You can execute it with the yarn run-example command.

Tests

Automated tests are provided. There are two types of tests

1. yarn test-integration. Tests JS api.
2. yarn test-direct. Mostly tests for different corner cases. There are some extensive tests which are disabled by default, see tests source code.

Note that for these tests it is advisable to install the developer build of the Cardano app with headless mode enabled unless you want to verify the UI flows, otherwise you will need a significant amount of time to manually confirm all prompts on the device.

Documentation

• you can build the docs by running yarn gen-docs and then navigate to docs_generated/index.html
• generated docs can also be found at (https://vacuumlabs.github.io/ledgerjs-cardano-shelley)
• CHANGELOG

Changelog

4.0.0 - [October 27th 2021]

Support for script elements in transactions and addresses.

Added

• support for address types with script hashes (all Shelley address types are now supported)
• support for script elements in transactions via a new TransactionSigningMode.MULTISIG_TRANSACTION
• support for mint field in transaction body
• native script hash derivation call
• validation of canonical ordering of cbor map keys compliant with CIP 21 (withdrawals, token policy ids in outputs and mint, asset names within an asset group)

Changed

• API changes: replacing paths with stake credentials in various address and transaction parameters breaks compatibility