2.2 KiB
Advanced Usage
Table of Contents
Compiling Zap From Source
Note: If you have installation or compilation issues, please file a Github issue or ping us in Slack.
Prerequisites
To compile the Zap wallet, you will need:
Downloading Zap
After installing the above prerequisites, clone the repo via git:
git clone https://github.com/LN-Zap/zap-desktop.git
Installing Dependencies
Install all the dependencies with yarn:
cd zap-desktop
yarn
Lightning Network Daemon (lnd)
Option 1: default:
Zap installs lnd
for you as part of the installation process. Zap will automatically start the internal lnd
daemon for you when you select the default
connection type during the on-boarding process. In this mode we run lnd
as a light client called neutrino
(BIP 157 & BIP 158) which allows us to run lnd
without requiring a Bitcoin full node on your system - Instead, Zap will connect to one Zap's hosted BTC full nodes.
Option 2: custom:
To setup your own lnd
for use with Zap please follow the instructions on the lnd installation page. Select the custom
connection type during the on-boarding process to use your own lnd
with Zap.
Note: Your lnd
node must already be running and unlocked in order for Zap to connect to it. Ensure that lnd's RPC server is listening on an external interface and that your firewall permits access to it.
Running Zap
Testing
To test that everything has been installed correctly:
npm run build
npm run test
Running
To run Zap in development mode:
npm run dev
Linting
To check linting:
npm run lint