https://github.com/prusnak/suez

Tool for pretty printing and optimizing Lightning Network channels.
https://github.com/prusnak/suez

bitcoin lightning-network

Last synced: 13 days ago
JSON representation

Tool for pretty printing and optimizing Lightning Network channels.

• Host: GitHub
• URL: https://github.com/prusnak/suez
• Owner: prusnak
• License: gpl-3.0
• Created: 2021-05-31T15:01:10.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2023-05-26T13:40:10.000Z (over 1 year ago)
• Last Synced: 2024-10-10T18:59:01.053Z (30 days ago)
• Topics: bitcoin, lightning-network
• Language: Python
• Homepage:
• Size: 656 KB
• Stars: 78
• Watchers: 6
• Forks: 20
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: COPYING

Awesome Lists containing this project

• awesome-lightning-network - suez - Tool for pretty printing and optimizing Lightning Network channels (Applications / Command Line Interfaces)

README

        
# Suez

Tool for pretty printing and optimizing Lightning Network channels.

![screenshot](screenshot.png)

## Installation

1. Install [poetry](https://python-poetry.org/)

2. `poetry install`

3. `poetry run ./suez`

## Channel fee policy

You can set channel fees by passing `--base-fee` and `--fee-rate` parameters.

For example:

`poetry run ./suez --base-fee 1000 --fee-rate 200`

You can override the channel fee policy by changing the `FeePolicy` class.

Example implementation does the following:

* sets lower fee rate for channels with mostly local balance

* sets higher fee rate for channels with mostly remote balance

* sets medium (close to specified) fee rate for balanced channels

You control the spread via the `--fee-spread` argument. By default `--fee-spread` is set to 0.0 (no spread).

For example:

`poetry run ./suez --base-fee 1000 --fee-rate 500 --fee-spread 1.8`

This will set the fee rate above 500 for channels with mostly remote balance and below 500

for channels with mostly local balance.

## Lightning node support

Currently, Suez supports LND (both via `lncli` and via the REST API) and c-lightning.

By default it uses LND (`lncli`).

You can use it with c-lightning as follows:

`poetry run ./suez --client=c-lightning`

You can connect to LND using the REST API as follows:

`SSL_CERT_FILE= poetry run ./suez --client=lnd-rest --client-args=rpcserver=https://: --client-args=macaroonpath= --client-args=tlscertpath=`

If you need to pass additional options to the lncli/lightning-cli you can do so:

(single argument)

`poetry run ./suez --client=c-lightning --client-args=--conf=/usr/local/etc/lightningd-bitcoin.conf`

(multiple arguments)

`poetry run ./suez --client-args=--rpcserver=host:10009 --client-args=--macaroonpath=admin.macaroon --client-args=--tlscertpath=tls.cert`

Adding support requires writing a client similar to `lndclient.py` and instantiating it in `suez.py`.

## Donate

You can tip me some satoshis via [tippin.me/@pavolrusnak](https://tippin.me/@pavolrusnak)

or you can donate via Spontaneous AMP Payment (data field encodes `tip=suez`):

`lncli sendpayment --amt 10000 --amp --dest 0385218f0e307b6a0e989d2a717d346942d96b4fd550e937de5f8ffe1568510a18 --data 7629168=7375657a`

## License

This software is licensed under the [GNU General Public License v3](COPYING).