{"id":13569743,"url":"https://github.com/prusnak/suez","last_synced_at":"2025-04-07T11:01:20.580Z","repository":{"id":40510588,"uuid":"372544318","full_name":"prusnak/suez","owner":"prusnak","description":"Tool for pretty printing and optimizing Lightning Network channels.","archived":false,"fork":false,"pushed_at":"2025-01-19T12:32:37.000Z","size":642,"stargazers_count":79,"open_issues_count":1,"forks_count":20,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-03-31T10:01:32.602Z","etag":null,"topics":["bitcoin","lightning-network"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/prusnak.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"COPYING","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-05-31T15:01:10.000Z","updated_at":"2025-02-06T10:41:58.000Z","dependencies_parsed_at":"2025-02-23T08:09:12.905Z","dependency_job_id":"5b9f75ea-c683-47c3-b30e-5fba6f01dc3b","html_url":"https://github.com/prusnak/suez","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prusnak%2Fsuez","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prusnak%2Fsuez/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prusnak%2Fsuez/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prusnak%2Fsuez/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/prusnak","download_url":"https://codeload.github.com/prusnak/suez/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247640459,"owners_count":20971556,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bitcoin","lightning-network"],"created_at":"2024-08-01T14:00:43.611Z","updated_at":"2025-04-07T11:01:20.515Z","avatar_url":"https://github.com/prusnak.png","language":"Python","readme":"# Suez\n\nTool for pretty printing and optimizing Lightning Network channels.\n\n![screenshot](screenshot.png)\n\n## Installation\n\n1. Install [poetry](https://python-poetry.org/)\n2. `poetry install`\n3. `poetry run ./suez`\n\n## Channel fee policy\n\nYou can set channel fees by passing `--base-fee` and `--fee-rate` parameters.\n\nFor example:\n\n`poetry run ./suez --base-fee 1000 --fee-rate 200`\n\nYou can override the channel fee policy by changing the `FeePolicy` class.\n\nExample implementation does the following:\n\n* sets lower fee rate for channels with mostly local balance\n* sets higher fee rate for channels with mostly remote balance\n* sets medium (close to specified) fee rate for balanced channels\n\nYou control the spread via the `--fee-spread` argument. By default `--fee-spread` is set to 0.0 (no spread).\n\nFor example:\n\n`poetry run ./suez --base-fee 1000 --fee-rate 500 --fee-spread 1.8`\n\nThis will set the fee rate above 500 for channels with mostly remote balance and below 500\nfor channels with mostly local balance.\n\n## Lightning node support\n\nCurrently, Suez supports LND (both via `lncli` and via the REST API) and c-lightning.\n\nBy default it uses LND (`lncli`).\n\nYou can use it with c-lightning as follows:\n\n`poetry run ./suez --client=c-lightning`\n\nYou can connect to LND using the REST API as follows:\n\n`SSL_CERT_FILE=\u003c/path/to/tls.cert\u003e poetry run ./suez --client=lnd-rest --client-args=rpcserver=https://\u003crpc-ip\u003e:\u003crpc-port\u003e --client-args=macaroonpath=\u003c/path/to/admin.macaroon\u003e --client-args=tlscertpath=\u003c/path/to/tls.cert\u003e`\n\nIf you need to pass additional options to the lncli/lightning-cli you can do so:\n\n(single argument)\n\n`poetry run ./suez --client=c-lightning --client-args=--conf=/usr/local/etc/lightningd-bitcoin.conf`\n\n(multiple arguments)\n\n`poetry run ./suez --client-args=--rpcserver=host:10009 --client-args=--macaroonpath=admin.macaroon --client-args=--tlscertpath=tls.cert`\n\nAdding support requires writing a client similar to `lndclient.py` and instantiating it in `suez.py`.\n\n## Donate\n\nYou can tip me some satoshis via [tippin.me/@pavolrusnak](https://tippin.me/@pavolrusnak)\n\nor you can donate via Spontaneous AMP Payment (data field encodes `tip=suez`):\n\n`lncli sendpayment --amt 10000 --amp --dest 0385218f0e307b6a0e989d2a717d346942d96b4fd550e937de5f8ffe1568510a18 --data 7629168=7375657a`\n\n## License\n\nThis software is licensed under the [GNU General Public License v3](COPYING).\n","funding_links":[],"categories":["Applications"],"sub_categories":["Command Line Interfaces"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprusnak%2Fsuez","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprusnak%2Fsuez","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprusnak%2Fsuez/lists"}