Skip to content

Add hook schemas with msggen and crate integration #9058

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
daywalker90 wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Add hook schemas with msggen and crate integration #9058

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
be2eede
schemas: add schemas for all plugin hooks
daywalker90 Apr 13, 2026
72cb97f
crates: add JsonObjectOrArray and JsonScalar types for raw json rpc p…
daywalker90 Apr 13, 2026
5fc3ee5
msggen: add generation for hook schemas
daywalker90 Apr 13, 2026
1586e51
crates: add convenience typed methods for hook subscriptions
daywalker90 Apr 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1,000 changes: 923 additions & 77 deletions .msggen.json
View file
Open in desktop

Large diffs are not rendered by default.

1 change: 0 additions & 1 deletion cln-grpc/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ tokio = { version = "1.36.0", features = ["sync"] }
futures-core = "0.3.30"
tokio-util = "0.7.10"

[dev-dependencies]
serde_json = "1.0.72"

[build-dependencies]
Expand Down
37 changes: 37 additions & 0 deletions cln-grpc/proto/primitives.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,3 +147,40 @@ enum PluginSubcommand {
STARTDIR = 3;
LIST = 4;
}

message JsonObjectOrArray {
oneof structure {
JsonObject object = 1;
JsonArray array = 2;
}
}

message JsonObject {
map<string, JsonValue> fields = 1;
}

message JsonArray {
repeated JsonValue values = 1;
}

message JsonValue {
oneof kind {
bool bool_value = 1;
int64 int_value = 2;
uint64 uint_value = 3;
double double_value = 4;
string string_value = 5;
JsonArray array = 6;
JsonObject object = 7;
}
}

message JsonScalar {
oneof scalar {
bool bool_value = 1;
int64 int_value = 2;
uint64 uint_value = 3;
double double_value = 4;
string string_value = 5;
}
}
146 changes: 145 additions & 1 deletion cln-grpc/src/pb.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@ mod convert {

use cln_rpc::primitives::{
Amount as JAmount, AmountOrAll as JAmountOrAll, AmountOrAny as JAmountOrAny,
Feerate as JFeerate, Outpoint as JOutpoint, OutputDesc as JOutputDesc,
Feerate as JFeerate, JsonObjectOrArray as JJsonObjectOrArray, JsonScalar as JJsonScalar,
Outpoint as JOutpoint, OutputDesc as JOutputDesc,
};

impl From<JAmount> for Amount {
Expand Down Expand Up @@ -281,6 +282,149 @@ mod convert {
}
}

impl From<serde_json::Value> for JsonValue {
fn from(v: serde_json::Value) -> Self {
let kind = match v {
serde_json::Value::Null => None,
serde_json::Value::Bool(b) => Some(json_value::Kind::BoolValue(b)),
serde_json::Value::Number(n) => {
if let Some(u) = n.as_u64() {
Some(json_value::Kind::UintValue(u))
} else if let Some(i) = n.as_i64() {
Some(json_value::Kind::IntValue(i))
} else if let Some(f) = n.as_f64() {
Some(json_value::Kind::DoubleValue(f))
} else {
let error = format!("Failed to parse number: `{}`", n);
println!(
"{}",
serde_json::json!({"jsonrpc": "2.0",
"method": "log",
"params": {"level":"warn", "message": error}})
);
std::process::exit(1);
}
}
serde_json::Value::String(s) => Some(json_value::Kind::StringValue(s)),
serde_json::Value::Array(arr) => Some(json_value::Kind::Array(JsonArray {
values: arr.into_iter().map(JsonValue::from).collect(),
})),
serde_json::Value::Object(obj) => Some(json_value::Kind::Object(JsonObject {
fields: obj
.into_iter()
.map(|(k, v)| (k, JsonValue::from(v)))
.collect(),
})),
};
JsonValue { kind }
}
}

impl From<JJsonObjectOrArray> for JsonObjectOrArray {
fn from(v: JJsonObjectOrArray) -> Self {
let structure = match v {
JJsonObjectOrArray::Array(arr) => {
Some(json_object_or_array::Structure::Array(JsonArray {
values: arr.into_iter().map(JsonValue::from).collect(),
}))
}
JJsonObjectOrArray::Object(obj) => {
Some(json_object_or_array::Structure::Object(JsonObject {
fields: obj
.into_iter()
.map(|(k, v)| (k, JsonValue::from(v)))
.collect(),
}))
}
};
JsonObjectOrArray { structure }
}
}

impl From<JsonValue> for serde_json::Value {
fn from(v: JsonValue) -> Self {
match v.kind {
None => serde_json::Value::Null,
Some(json_value::Kind::BoolValue(b)) => serde_json::Value::Bool(b),
Some(json_value::Kind::UintValue(u)) => serde_json::Value::Number(u.into()),
Some(json_value::Kind::IntValue(i)) => serde_json::Value::Number(i.into()),
Some(json_value::Kind::DoubleValue(f)) => match serde_json::Number::from_f64(f) {
Some(num) => serde_json::Value::Number(num),
None => {
let error = format!("Failed to parse number: `{}`", f);
println!(
"{}",
serde_json::json!({"jsonrpc": "2.0",
"method": "log",
"params": {"level":"warn", "message": error}})
);
std::process::exit(1);
}
},
Some(json_value::Kind::StringValue(s)) => serde_json::Value::String(s),
Some(json_value::Kind::Array(arr)) => serde_json::Value::Array(
arr.values
.into_iter()
.map(serde_json::Value::from)
.collect(),
),
Some(json_value::Kind::Object(obj)) => serde_json::Value::Object(
obj.fields
.into_iter()
.map(|(k, v)| (k, serde_json::Value::from(v)))
.collect(),
),
}
}
}

impl From<JsonObjectOrArray> for JJsonObjectOrArray {
fn from(v: JsonObjectOrArray) -> Self {
match v.structure {
Some(json_object_or_array::Structure::Array(arr)) => JJsonObjectOrArray::Array(
arr.values
.into_iter()
.map(serde_json::Value::from)
.collect(),
),
Some(json_object_or_array::Structure::Object(obj)) => JJsonObjectOrArray::Object(
obj.fields
.into_iter()
.map(|(k, v)| (k, serde_json::Value::from(v)))
.collect(),
),
None => JJsonObjectOrArray::Array(vec![]), // or handle as error
}
}
}

impl From<JsonScalar> for JJsonScalar {
fn from(v: JsonScalar) -> Self {
match v.scalar {
None => JJsonScalar::Null,
Some(json_scalar::Scalar::BoolValue(b)) => JJsonScalar::Bool(b),
Some(json_scalar::Scalar::IntValue(i)) => JJsonScalar::Number(i.into()),
Some(json_scalar::Scalar::DoubleValue(d)) => {
match serde_json::Number::from_f64(d) {
Some(num) => JJsonScalar::Number(num),
None => {
let error = format!("Failed to parse number: `{}`", d);
println!(
"{}",
serde_json::json!({"jsonrpc": "2.0",
"method": "log",
"params": {"level":"warn", "message": error}})
);
std::process::exit(1);
}
}
}
Some(json_scalar::Scalar::UintValue(u)) => JJsonScalar::Number(u.into()),
Some(json_scalar::Scalar::StringValue(s)) => JJsonScalar::String(s),
}
}
}

#[cfg(test)]
mod test {
use super::*;
Expand Down
2 changes: 1 addition & 1 deletion cln-rpc/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ cln-rpc-wrongdir:
$(MAKE) -C .. cln-rpc-all

CLN_RPC_EXAMPLES := target/${RUST_PROFILE}/examples/cln-rpc-getinfo
CLN_RPC_GENALL = cln-rpc/src/model.rs cln-rpc/src/notifications.rs
CLN_RPC_GENALL = cln-rpc/src/model.rs cln-rpc/src/notifications.rs cln-rpc/src/hooks.rs
CLN_RPC_SOURCES = $(shell find cln-rpc -name *.rs) ${CLN_RPC_GENALL}
DEFAULT_TARGETS += $(CLN_RPC_EXAMPLES) $(CLN_RPC_GENALL)

Expand Down
Loading
Loading