Skip to content
This repository has been archived by the owner on Nov 17, 2023. It is now read-only.

Latest commit

 

History

History
115 lines (70 loc) · 3.64 KB

ADVANCED.md

File metadata and controls

115 lines (70 loc) · 3.64 KB
Raw

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.

Connecting to lnd with lncli

It is possible to connect to the lnd instance that Zap runs using a standard lncli binary which you can download from the lnd releases page (lncli is bunded with the lnd download). Please be sure to download the version of lncli that corresponds with the version of lnd that Zap is running (you can find this out by navigating to the "Profile" screen when logged into your Zap wallet).

To connect to lnd using lncli you must have Zap open and logged into your wallet. Then, run lncli telling it the host and port where lnd is running and the location of the lnd data directory.

The lnd data directory will be located within:

  • %APPDATA%\Zap on Windows
  • $XDG_CONFIG_HOME/Zap or ~/.config/Zap on Linux
  • ~/Library/Application Support/Zap on macOS

For example, on a Mac:

lncli --rpcserver=localhost:11009 --lnddir=~/Library/Application\ Support/Zap/lnd/bitcoin/mainnet/wallet-2 getinfo

See lncli --help for help with lncli.

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:

yarn test

Running

To run Zap in development mode:

yarn dev

Linting

To check linting:

yarn lint

Packaging

To build a production ready version of the app for your target platform:

yarn package --mac // Build for mac
yarn package --win // Build for windows
yarn package --linux // Build for linux

Debugging

See DEBUGGING.md

Configuration

See CONFIG.md