N.B. The code on the master branch represents a first prototype. We're currently in the process of rebuilding the app with simplicity, testability, and mobile (react-native) in mind. This effort is happening on the v2 branch. We will continue to support the current master until v2 reaches feature parity with the old version (at which time we will deprecate the old version). If you're interested in contributing or porting features over to v2, we will happily review any PRs! Just take a look at our GitHub Project board to find an issue to get started. Thanks :)
This repo houses a cross-platform Lightning desktop app powered by
lnd. The application is under
active development and currently only operates on the Bitcoin testnet chain.
First start by pulling down the git repo:
git clone https://github.com/lightninglabs/lightning-app.git
Then go inside the project folder and run the following commands (grab a coffee, this might take a while):
cd lightning-app
npm run setup
You can run the app in development mode in lieu of using the packaged app:
npm start
You can pass extra arguments to be passed to lnd daemon (note the extra --):
npm run start -- --peerport=10019 --rpcport=10017 --datadir=test_lnd --logdir=test_lnd
In development mode, the app will look for an lnd.conf in the default location for your platform. See lnd.conf details. A typical lnd.conf for running on simnet will look like the following:
debuglevel=debug
bitcoin.active=1
bitcoin.simnet=1
bitcoin.rpcuser=lnd
bitcoin.rpcpass=lnd
Running in development mode can allow you to run in full node mode instead of the default neutrino mode, and will also allow you to run in simnet node for testing.
Note that in order to run in simnet node, you will have also had to separately install and configure the roasbeef fork of btcd. Additional instructions for running simnet can be found here.
Also note that if you have installed and built lnd separately, if an instance is running when the app starts, the app will connect to the already running instance rather than attempt to start a new one.
If you want your lnd.conf to replicate the configuration used by the packaged app, you can use the following:
debuglevel=info
bitcoin.active=1
bitcoin.testnet=1
bitcoin.node=neutrino
neutrino.connect=btcd0.lightning.computer:18333
autopilot.active=1
To build the packaged version of the app for your current platform, run:
npm run package-electron
The packaged app will then be available in the lightning-app/release directory. The packaged version of the app will run on Bitcoin testnet. To debug a packaged app, go to localhost:9997 in your browser.
If the window doesn't load after running npm start: try clicking on dev tools window and hitting cmd-r to refresh the window.
Logs are written to the following locations:
- Linux:
~/.config/Lightning/log.log - OSX:
~/Library/Logs/Lightning/log.log - Windows:
%USERPROFILE%\AppData\Roaming\Lightning\log.log