GlcoinCore/cln-plugins
1
0
Fork 0
mirror of https://github.com/lightningd/plugins.git synced 2026-08-17 13:07:22 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 1
No description
107 commits 53 branches 0 tags 15 MiB
Find a file
Christian Decker 972ea8dfd5 travis: Add the travis badge to the readme
2019-12-09 14:31:14 +01:00
.travis travis: Add initial travis config 2019-12-09 14:31:14 +01:00
autopilot Specify startup-only plugins to be non-dynamic 2019-08-13 13:56:22 +02:00
autoreload Specify startup-only plugins to be non-dynamic 2019-08-13 13:56:22 +02:00
csvexportpays@e83c6227f3 csvexportpays: Added submodule to export payments as a CSV 2019-07-18 19:21:51 +02:00
donations build(deps): bump pillow from 5.4.1 to 6.2.0 in /donations 2019-10-27 12:20:52 +01:00
drain drain: cleanups 2019-11-18 11:31:39 +01:00
graphql@100978bc99 new change to graphql 2019-05-10 17:06:45 +02:00
helpme fix: making sum() of funds iteration did not work on non-numeric 2019-09-02 22:55:42 +02:00
jwt-factory@cf90ba3495 updated graphql submodule. Added new jwt-factory submodule 2019-05-10 17:06:45 +02:00
lightning-qt@6aaeed7419 Added lightning-qt as a submodule (#28) 2019-05-16 20:28:25 +02:00
monitor monitor: use human readable outputs 2019-09-06 17:25:35 +02:00
persistent-channels Add a 'requirements.txt' to probe plugin 2019-08-13 13:56:49 +02:00
probe probe: pass the request argument to thread 2019-10-24 15:18:13 +02:00
prometheus add lightningd blockheight metric 2019-05-13 21:21:36 +02:00
rebalance rebalance: restore Python3.5 compat 2019-09-06 17:26:23 +02:00
sendinvoiceless sendinvoiceless: restore Python3.5 compat 2019-09-30 13:30:34 +02:00
sitzprobe@84347d5519 sitzprobe: Add sitzprobe by @niftynei as a submodule 2019-04-01 18:35:39 +02:00
summary summary: Add dummy test to see that travis is working 2019-12-09 14:31:14 +01:00
.gitignore pytest: Preparing to run integration tests using pytest 2019-03-30 00:03:16 +01:00
.gitmodules csvexportpays: Change git URL to non-authenticated https scheme 2019-12-09 14:31:14 +01:00
.travis.yml travis: Add initial travis config 2019-12-09 14:31:14 +01:00
conftest.py pytest: Preparing to run integration tests using pytest 2019-03-30 00:03:16 +01:00
LICENSE Initial commit 2019-01-17 13:16:45 +01:00
pytest.ini pytest: Preparing to run integration tests using pytest 2019-03-30 00:03:16 +01:00
README.md travis: Add the travis badge to the readme 2019-12-09 14:31:14 +01:00

README.md

Plugins for c-lightning

Community curated plugins for c-lightning.

Build Status

Available plugins

Name Short description
autopilot An autopilot that suggests channels that should be established
autoreload A developer plugin that reloads a plugin under development when it changes
donations A simple donations page to accept donations from the web
graphql Exposes the c-lightning API over graphql
lightning-qt A bitcoin-qt-like GUI for lightningd
monitor helps you analyze the health of your peers and channels
persistent-channels Maintains a number of channels to peers
probe Regularly probes the network for stability
prometheus Lightning node exporter for the prometheus timeseries server
rebalance Keeps your channels balanced
reckless An experimental plugin manager (search/install plugins)
sendinvoiceless Sends some money without an invoice from the receiving node.
sitzprobe A Lightning Network payment rehearsal utility
summary Print a nice summary of the node status

Installation

To install and activate a plugin you need to stop your lightningd and restart it with the plugin argument like this:

lightningd --plugin=/path/to/plugin/directory/plugin_file_name.py

Notes:

  • The plugin_file_name.py must have executable permissions: chmod a+x plugin_file_name.py
  • A plugin can be written in any programming language, as it interacts with lightningd purely using stdin/stdout pipes.

Automatic plugin initialization

Alternatively, especially when you use multiple plugins, you can copy or symlink all plugin directories into your ~/.lightning/plugins directory. The daemon will load each executeable it finds in sub-directories as a plugin. In this case you don't need to manage all the --plugin=... parameters.

Pylightning

All python plugins depend on the pylightning library. It can be given in several ways:

  • Using pip tools: pip3 install pylightning
  • Using the PYTHONPATH environment variable to include your clightning's shipped pylightning library:
PYTHONPATH=/path/to/lightnind/contrib/pylightning lightningd

Additional dependencies

Additionally, some Python plugins come with a requirements.txt which can be used to install the plugin's dependencies using the pip tools:

pip3 install -r requirements.txt

Note: You might need to also specify the --user command line flag depending on your environment.

More Plugins from the Community

Plugin Builder Resources