⛔️ DEPRECATED

This repository is now deprecated. We moved to a new mono repository called the Wallet-API that you can find here.

Live App SDK

Integrate your application or service inside Ledger Live

Please read our contribution guidelines before getting started.

You need to have a recent Node.js and Yarn 1 (Classic) installed.

yarn

Build the SDK

yarn build

Check code formatting with

yarn format:check

Format source (src) files in-place with

yarn format:fix

Check code quality with

yarn lint:check

Automatically fix code quality problems with

yarn lint:fix

You can generate the project's documentation, either in html or in markdown.

For markdown use:

yarn doc

For html use:

yarn doc:html

The documentation will be generated in a docs/reference or docs/html folder depending on the chosen format.

You can find the entrypoint to the generated doc here.

This generated package is hosted on NPM here.

⚠️ Publishing can only be performed by members of the ledgerhq organization having the necessary rights to push to main branch ⚠️

In order to publish a new version of this package, please refer to the following steps:

create and setup you npm account (cf. npm doc) (you must be part of the ledgerhq organization to publish)
run yarn publish (cf. doc) on the commit / branch you want to publish (usually the main branch) (you will have to specify the new package version, following semver standard)
this will update the version in package.json, create a new bump commit, a new tag with the latests version and publish the updated package to npm
don't forget to push this newly generated commit as well as the tag (you must have the necessary rights to push to main)