Rust core lightning plugin crate

Crate that provides a procedural API to develop cln plugins.

Project Homepage

GitHub Workflow Status (branch) Crates.io Crates.io docs.rs

Crate that provides a procedural macros implementation to make easy to develop a plugin developer to build a plugin.

```rust extern crate clightningrpc_plugin;

use clightningrpcplugin::types::LogLevel; use clightningrpcplugin::{commands::RPCCommand, plugin::Plugin}; use serde_json::{json, Value};

[derive(Clone)]

struct PluginState(());

/// HelloRPC is used to register the RPC method

[derive(Clone)]

struct HelloRPC {}

/// Implementation of the RPC method impl RPCCommand for HelloRPC { fn call<'c>(&self, plugin: &mut Plugin, _request: &'c Value) -> Value { plugin.log(LogLevel::Debug, "call the custom rpc method from rust"); json!({ "language": "Hello from rust" }) } }

[derive(Clone)]

struct OnChannelOpened {}

impl RPCCommand for OnChannelOpened { fn call_void<'c>(&self, _plugin: &mut Plugin, _request: &'c Value) { _plugin.log(LogLevel::Debug, "A new channel was opened!"); } }

fn main() { let mut plugin = Plugin::::new(PluginState(()), true) .addrpcmethod( "hello", "", "show how is possible add a method", HelloRPC {}, ) .addopt( "foo", "flag", None, "An example of command line option", false, ) .registernotification("channel_opened", OnChannelOpened {}) .clone(); plugin.start(); } ```

Contributing guidelines

Read our Hacking guide

Supports

If you want support this library consider to donate with the following methods