https://github.com/vulpemventures/lightning-rebalancer
⚡️ Rebalance your LN channel using onchain BTC
https://github.com/vulpemventures/lightning-rebalancer
Last synced: 8 months ago
JSON representation
⚡️ Rebalance your LN channel using onchain BTC
- Host: GitHub
- URL: https://github.com/vulpemventures/lightning-rebalancer
- Owner: vulpemventures
- License: mit
- Created: 2018-12-29T20:57:54.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-01-05T16:28:55.000Z (over 7 years ago)
- Last Synced: 2025-06-30T15:57:01.950Z (12 months ago)
- Language: Go
- Homepage:
- Size: 20.5 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](#release)
### Prerequisites
* [Go 1.10+](https://golang.org/dl/)
* [Dep 0.5+](https://github.com/golang/dep#installation)
### Installing
* Clone the git repository
```bash
$ git clone git@github.com:vulpemventures/lightning-rebalancer.git
$ cd lightning-rebalancer
```
* Install development/test dependencies
```bash
$ ./scripts/install
```
* Build lightning-rebalancer (on MacOSX)
```bash
$ ./scripts/build darwin amd64
```
* Build lightning-rebalancer (on Linux amd64 platform)
```bash
$ ./scripts/build linux amd64
```
* Build lightning-rebalancer for Linux armv7 using Docker
```bash
$ ./scripts/buildarm
```
#### Run Server
```bash
$ ./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