- Related: ledger-live-mobile
Ledger Live is a new generation wallet desktop application providing a unique interface to maintain multiple cryptocurrencies for your Ledger Nano S / Blue. Manage your device, create accounts, receive and send cryptoassets, ...and many more.
Ledger Live is an hybrid desktop application built with Electron, React, Redux, RxJS,.. and highly optimized with ledger-core C++ library to deal with blockchains (sync, broadcast,..) via ledger-core-node-bindings. It communicates to Ledger hardware wallet devices (Nano S / Blue) to verify address and sign transactions with ledgerjs. Some logic is shared with live-common.
- supported by ledger-core (C++) implementation: BTC BCH LTC DASH QTUM ZEC BTG STRAT DOGE DGB HSR KMD PIVX ZEN VTC PPC VIA XST POSW CLUB
- supported by JavaScript implementation: ETH, ETC, XRP
- NodeJS LTS
- Yarn LTS
- Python v2.7.10 (used by node-gyp to build native addons)
- You will also need a C++ compiler
- In the application we use
Museo Sans
font. To include it in the app, you need to have a zip filemuseosans.zip
which you should extract and place inside thestatic/fonts/museosans
directory
# install dependencies
yarn
# launch the app
yarn start
# Build & package the whole app
# Creates a .dmg for Mac, .exe installer for Windows, or .AppImage for Linux
# Output files will be created in dist/ folder
yarn dist
Note: Use yarn dist:dir
to speed up the process: it will skip the packaging step. Handy for debugging builds. You can also use BUNDLE_ANALYZER=1 yarn dist:dir
to generate webpack-bundle-analyzer report.
(you can use a .env or export environment variables)
DEV_TOOLS_MODE=bottom # devtools position Options: right, bottom, undocked, detach
HIDE_DEV_WINDOW=0
## flags for development purpose
DEBUG_DEVICE=1
DEBUG_NETWORK=1
DEBUG_COMMANDS=1
DEBUG_DB=1
DEBUG_ACTION=1
DEBUG_TAB_KEY=1
DEBUG_LIBCORE=1
DEBUG_WS=1
LEDGER_DEBUG_ALL_LANGS=1
SKIP_GENUINE=1
SKIP_ONBOARDING=1
SHOW_LEGACY_NEW_ACCOUNT=1
HIGHLIGHT_I18N=1
EXPERIMENTAL_WS_EXPORT=0
## constants
GET_CALLS_TIMEOUT=30000
GET_CALLS_RETRY=2
SYNC_MAX_CONCURRENT=6
SYNC_BOOT_DELAY=2000
SYNC_ALL_INTERVAL=60000
CHECK_APP_INTERVAL_WHEN_INVALID=600
CHECK_APP_INTERVAL_WHEN_VALID=1200
CHECK_UPDATE_DELAY=5000
We use storybook for UI development.
yarn storybook
yarn lint # launch eslint
yarn prettier # launch prettier
yarn flow # launch flow
yarn test # launch unit tests
# clear the dev electron user data directory
# it remove sqlite db, accounts, settings
# useful to start from a fresh state
yarn reset-files
.
├── dist : output folder generate by the build
├── scripts : commands (for building, releasing,...)
├── src
│ ├── internals : code that run on the 'internal' thread.
│ ├── main : code that run on the 'main' thread.
│ ├── renderer : code that run on the 'renderer' thread
│ ├── components : all the React components
| └── modals : sub levels for the modals
│ ├── api : related to HTTP APIs
│ ├── bridge : an abstraction on top of blockchains apis (libcore / js impls)
│ ├── commands : an abstraction to run code over the internal thread
│ ├── icons : all the icons of our app, as React components.
│ ├── config : contains the constants,...
│ ├── helpers : generic folder for our business logic (might be reorganized in the future)
│ ├── middlewares : redux middlewares
│ ├── actions : redux actions
│ ├── reducers : redux reducers
│ ├── sentry : for our bug tracker
│ ├── stories : for storybook
│ ├── styles : theme
│ ├── logger.js : abstraction for all our console.log s
│ └── types : global flow types
├── static
│ ├── docs
│ ├── fonts
│ ├── i18n
│ ├── images
│ └── videos
├── webpack : build configuration
└── yarn.lock
You will need to install the python gyp module
pip install git+https://chromium.googlesource.com/external/gyp