https://github.com/conscott/c-lightning-plugins
A collection of plugins for c-lightning
https://github.com/conscott/c-lightning-plugins
Last synced: 18 days ago
JSON representation
A collection of plugins for c-lightning
- Host: GitHub
- URL: https://github.com/conscott/c-lightning-plugins
- Owner: conscott
- Created: 2019-01-09T12:53:01.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2020-04-18T11:08:13.000Z (almost 5 years ago)
- Last Synced: 2024-10-31T17:39:17.252Z (6 months ago)
- Language: Python
- Size: 35.2 KB
- Stars: 15
- Watchers: 4
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-lightning-network - C-lightning-plugins - Collection of plugin scripts to control c-lightning (Developer Resources / Misc)
- awesome-lightning-network - C-lightning-plugins - Collection of plugin scripts to control c-lightning (Developer Resources / Misc)
README
# c-lightning-plugins
A collection of plugins for c-lightning to do convenient things. At the moment the utilities primarily perform useful filter and aggregation, but the embeded library can be extended for many things.
Please contribute ideas!
## Usage
Start lightningd with the `plugin-dir` option pointing to this repository
```bash
lightningd --plugin-dir
```
Alternatively you can add a line to the c-lightning config (~/.lightning/config)
```
...
plugin-dir=
...
```
## RPC Commands
* `balance` : Aggregated on-chain balance and channel balance information. Still a work in progress...
* `nodestats` : Get statistical information about a particular node, akin to [1ML](https://1ml.com) stats
* `channelstats` : Get stats about channels
* `invoicestats` : Get stats about invoices
* `paymentstats` : Get stats about payments
* `quickfund`: Use onchain funds to fund `amount` to `num_channels`, simply creating channels with top capacity nodes. This is not recommended for mainnet as it's a bad strategy.
* `closeall` : Close all active channels, with option to force close after timeout
* `getnetworkinfo` : Get statistical information about the current state of the network
* `filterchannels`: Filter channels by various parameters
## Pretty Print
To pretty print the JSON, simply pipe the output to [jq](https://stedolan.github.io/jq/)
```
lightning-cli balance | jq
```
## Future Command Ideas
* Create Circular Route
* Auto Balance Channels