The Ledger Live JavaScript ecosystem
We are hiring, join us! 👨💻👩💻
About
ledger-live is a monorepository whose purpose is to centralize all the JavaScript code related to the Ledger Live applications in one place.
Ledger Live is our platform of apps and services integrated specifically to work with your Nano device. It functions as a secure gateway to the crypto ecosystem. This means accessing a variety of crypto, NFT and DeFi based services directly and seamlessly from your hardware wallet – a better, simpler user experience that bypasses a major security concern known as blind signing.
Developers looking to integrate their blockchain in Ledger Live are invited to head to the Developer Portal where they will find the section Blockchain Support.
Installation
In order to interact with any package contained in this repository you will need to install the following:
This is only a minimal setup. You will need to perform additional installation steps depending on the package you want to work on, please refer to its nested readme file.
Then, clone the repository and install the dependencies:
git clone git@github.com:LedgerHQ/ledger-live.git
cd ledger-live
pnpm i
# Alternatively, if you want to bypass the postinstall scripts which can be long to run
# pnpm i --ignore-scriptsNote: multiple postinstall steps will be triggered and fail if the applications prerequisites are not met. You can safely ignore the errors if you do not plan to work on those apps.
Usage
Important: All the commands should be run at the root of the monorepo.
Tools
We use pnpm workspaces and turborepo under the hood to handle local and external dependencies, orchestrate tasks and perform various optimizations like package hoisting or remote caching.
For changelog generation releases and package publishing we rely on the changesets library.
Root scripts
The scripts that are defined inside the root /package.json file will use turborepo under the hood and automatically perform needed tasks before running the action.
# This command will first build all the local dependencies needed in the right order.
# Only then it will attempt to build the `Ledger Live Desktop` app.
pnpm build:lldAliases
To run nested scripts which are not covered at the root, you should not change your working directory.
Every package has an alias defined (see application or library tables or check out the package.json file) that you can use as a prefix when running the script from the root.
# `pnpm desktop` is one of the shorthands written to avoid changing the working directory.
# The following command will run the nested `test` script.
# `test` is defined inside the `./apps/ledger-live-desktop/package.json` file.
pnpm desktop testNote that when using these kinds of scripts you will have to make sure that the dependencies are built beforehand.
Scoping
You can scope any pnpm or turborepo based script by using the --filter flag.
This is a very powerful feature that you should look into if you are a frequent contributor.
Please check out the pnpm or turborepo documentation for more details (the syntax is almost similar albeit pnpm being a bit more powerful).
Here are some examples:
# Install all the dependencies needed for the packages under ./libs
pnpm i -F "{libs/**}..."
# Run lint only on packages that have been changed compared to origin/develop
pnpm lint --filter=[origin/develop]
# Test every package that has been changed since the last commit excluding the applications
pnpm run test --continue --filter="!./apps/*" --filter="...[HEAD~1]"
# Run typechecks for the Ledger Live Mobile project
pnpm typecheck --filter="live-mobile"Documentation
Each project folder has a README.md file which contains basic documentation.
It includes background info about the project and how to setup, run and build it.
Please check the wiki for additional documentation.
Structure
The sub-packages are (roughly) split into three categories.
/app - Applications
The applications are user-facing programs which depend on one or more libraries.
Ledger Live Applications
| Name | Alias | Download |
|---|---|---|
| Ledger Live Desktop | pnpm desktop |
Website |
| Ledger Live Mobile | pnpm mobile |
Android / iOS |
/libs - Libraries
Libraries are public packages which purpose is to be consumed by other libraries or applications.
They are deployed to the official npm repository under the @ledgerhq organization.
Ledger Live Libraries
/tools - Tools
⚠️ Tools are meant to be used internally and are undocumented for the most part.
A tool can be a github action, a shell script or a piece of JavaScript code that is used throughout this repository.
Contributing
Please check the general guidelines for contributing to Ledger Live projects: CONTRIBUTING.md.
Each separate project may also contain specific guidelines inside its own folder.
In the meantime here are some important highlights:
- Follow the git workflow, prefix your branches and do not create unneeded merge commits.
- Be mindful when creating Pull Requests, specify the reason of the change clearly and write tests if needed.
- Ledger Applications are mostly accepting bugfix contributions. For features we may reject them based on the fact that they do not fit our roadmap or our long-term goals.
Nightly Releases
Every night a github action merges the develop branch into the nightly branch.
For more information on the nightly releases, have a look at our wiki.
Ledger Live Desktop
- Every commit triggers a workflow that will build and attach the application binaries to the run.
- For Ledger Employees: Nightly releases are built every night under the protected ledger-live-build repository.
Ledger Live Mobile
- Every commit triggers a workflow that will build and attach the
Androidapk to the run. - For Ledger Employees: Nightly releases are built and published every night to Testflight and the Google Play Console.
Libraries
Nightly versions of library packages are pushed every night to npm.
To install a nightly library use the @nightly dist-tag.
npm i @ledgerhq/live-common@nightlyLicense
Please check each project LICENSE file, most of them are under the MIT license.