https://github.com/kristapsk/cln-scripts
Various shell scripts for CLN (Core Lightning / c-lightning).
https://github.com/kristapsk/cln-scripts
c-lightning lightning lightning-network lightningd
Last synced: 7 months ago
JSON representation
Various shell scripts for CLN (Core Lightning / c-lightning).
- Host: GitHub
- URL: https://github.com/kristapsk/cln-scripts
- Owner: kristapsk
- License: mit
- Created: 2022-04-04T19:19:21.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-04-12T20:46:45.000Z (about 2 years ago)
- Last Synced: 2024-04-13T04:07:16.826Z (about 2 years ago)
- Topics: c-lightning, lightning, lightning-network, lightningd
- Language: Shell
- Homepage:
- Size: 74.2 KB
- Stars: 12
- Watchers: 2
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# cln-scripts
Various shell scripts for [CLN (Core Lightning / c-lightning)](https://github.com/ElementsProject/lightning). I also have [some scripts for Bitcoin Core](https://github.com/kristapsk/bitcoin-scripts).
## Installation
Dependencies: `bash`, `lightning-cli` (comes with CLN), `bc`, [`jq`](https://github.com/stedolan/jq).
Gentoo Linux users can use [my portage overlay](https://github.com/kristapsk/portage-overlay):
```sh
# eselect repository add kristapsk git https://github.com/kristapsk/portage-overlay.git
# emerge -av cln-scripts
```
Otherwise, use provided `install.sh` script, which will install everything in `/opt/cln-scripts` with symlinks in `/usr/local/bin` (so that they are on `PATH`).
## Usage
All scripts support `-h`/`--help` for usage information.
| Script | Description |
| --- | --- |
| `cln-amboss-ping` | Send node health check ping to Amboss, see [docs](https://docs.amboss.space/api/monitoring/health-checks). |
| `cln-channelbalance` | Returns the sum of the total available channel balance across all open channels, like `lncli channelbalance` of LND. |
| `cln-feereport` | Display the current fee policies of all active channels, like `lncli feereport` of LND. |
| `cln-prune-protector` | Protect CLN against Bitcoin Core pruning too much. |
| `cln-routing-summary` | Display routing summary for a given period. |
| `cln-random-traffic-gen` | Generate random (decoy) LN traffic between you and your peers to fight traffic analysis. Has lock protection against running multiple instances at the same time so can safely be just added to crontab. |
| `cln-walletbalance` | Compute and display the onchain wallet's current balance, like `lncli walletbalance` of LND. |
## Support
If you want to support my work on this project and other free software (I am also maintainer of [JoinMarket](https://github.com/JoinMarket-Org/joinmarket-clientserver) and do other Bitcoin stuff), you can send some sats (Bitcoin) either [here](https://donate.kristapsk.lv/) (that's my self-hosted [SatSale](https://github.com/nickfarrow/SatSale) instance) or to my WoS LN address [tritejogging43@walletofsatoshi.com](lightning:tritejogging43@walletofsatoshi.com) (my old public CLN node is temporary down).