Skip to content

vulpemventures/lightning-rebalancer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

lightning-rebalancer

⚡️ Rebalance your Lightning Network channel using onchain BTC

This server implements a REST API interface for given LND gRPC daemon It provides endpoint to:

  • Recieve a LN payment using BTC onchain
  • Pay a LN invoice to receive BTC onchain

Development

These instructions are intended to facilitate the development and testing of Rebalancer. Operators interested in deploying Rebalancer should install the appropriate binary as released

Prerequisites

Installing

  • Clone the git repository
$ git clone git@github.com:vulpemventures/lightning-rebalancer.git
$ cd lightning-rebalancer
  • Install development/test dependencies
$ ./scripts/install
  • Build lightning-rebalancer (on MacOSX)
$ ./scripts/build darwin amd64
  • Build lightning-rebalancer (on Linux amd64 platform)
$ ./scripts/build linux amd64
  • Build lightning-rebalancer for Linux armv7 using Docker
$ ./scripts/buildarm

Run Server

$ ./build/rebalancer-linux-amd64

The following is the list of variables that can be set to change the default configuration:

  • LND_HOST - LND gRPC host
  • LND_PORT - LND gRPC port
  • HTTP_PORT - HTTP server port to run
  • TLS_PATH - absolute path of the TLS Certificate
  • MAC_PATH - absolute path of the Macaroon path

API

TBD