Skip to content

Commit ea0b804

Browse files
committed
doc: include delnetworkevent in generated documentation, and grpc.
Also added missing "added" annotation. This meant that I had to manually change contrib/msggen/msggen/patch.py to insert that added notation where it was missing from .msggen.json. Signed-off-by: Rusty Russell <[email protected]> Changelog-None: introduced this release.
1 parent b4ef5d9 commit ea0b804

File tree

13 files changed

+208
-36
lines changed

13 files changed

+208
-36
lines changed

.msggen.json

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1552,6 +1552,9 @@
15521552
"DelInvoice.status": 7,
15531553
"DelInvoice.updated_index": 13
15541554
},
1555+
"DelnetworkeventRequest": {
1556+
"DelNetworkEvent.created_index": 1
1557+
},
15551558
"DelpayPayments": {
15561559
"DelPay.payments[].amount_msat": 8,
15571560
"DelPay.payments[].amount_sent_msat": 5,
@@ -6841,6 +6844,14 @@
68416844
"added": "v23.08",
68426845
"deprecated": null
68436846
},
6847+
"DelNetworkEvent": {
6848+
"added": "v25.12",
6849+
"deprecated": null
6850+
},
6851+
"DelNetworkEvent.created_index": {
6852+
"added": "v25.12",
6853+
"deprecated": null
6854+
},
68446855
"DelPay": {
68456856
"added": "pre-v0.10.1",
68466857
"deprecated": null

cln-grpc/proto/node.proto

Lines changed: 8 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

cln-grpc/src/convert.rs

Lines changed: 26 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

cln-grpc/src/server.rs

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4594,6 +4594,38 @@ impl Node for Server
45944594

45954595
}
45964596

4597+
async fn del_network_event(
4598+
&self,
4599+
request: tonic::Request<pb::DelnetworkeventRequest>,
4600+
) -> Result<tonic::Response<pb::DelnetworkeventResponse>, tonic::Status> {
4601+
let req = request.into_inner();
4602+
let req: requests::DelnetworkeventRequest = req.into();
4603+
debug!("Client asked for del_network_event");
4604+
trace!("del_network_event request: {:?}", req);
4605+
let mut rpc = ClnRpc::new(&self.rpc_path)
4606+
.await
4607+
.map_err(|e| Status::new(Code::Internal, e.to_string()))?;
4608+
let result = rpc.call(Request::DelNetworkEvent(req))
4609+
.await
4610+
.map_err(|e| Status::new(
4611+
Code::Unknown,
4612+
format!("Error calling method DelNetworkEvent: {:?}", e)))?;
4613+
match result {
4614+
Response::DelNetworkEvent(r) => {
4615+
trace!("del_network_event response: {:?}", r);
4616+
Ok(tonic::Response::new(r.into()))
4617+
},
4618+
r => Err(Status::new(
4619+
Code::Internal,
4620+
format!(
4621+
"Unexpected result {:?} to method call DelNetworkEvent",
4622+
r
4623+
)
4624+
)),
4625+
}
4626+
4627+
}
4628+
45974629

45984630

45994631
type SubscribeBlockAddedStream = NotificationStream<pb::BlockAddedNotification>;

cln-rpc/src/model.rs

Lines changed: 39 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

contrib/msggen/msggen/schema.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10786,6 +10786,7 @@
1078610786
"type": "object",
1078710787
"rpc": "delnetworkevent",
1078810788
"title": "Command for removing a listnetworkevents entry",
10789+
"added": "v25.12",
1078910790
"description": [
1079010791
"The **delnetworkevent** RPC command removes a single event from **listnetworkevents**, using the uniquely-identifying *created_index*.",
1079110792
"",

contrib/msggen/msggen/utils/utils.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@
150150
"ListChannelMoves",
151151
"ListChainMoves",
152152
"ListNetworkEvents",
153-
# "DelNetworkEvent",
153+
"DelNetworkEvent",
154154
]
155155

156156
grpc_notification_names = [

contrib/pyln-grpc-proto/pyln/grpc/node_pb2.py

Lines changed: 39 additions & 35 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

contrib/pyln-grpc-proto/pyln/grpc/node_pb2_grpc.py

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -739,6 +739,11 @@ def __init__(self, channel):
739739
request_serializer=node__pb2.ListnetworkeventsRequest.SerializeToString,
740740
response_deserializer=node__pb2.ListnetworkeventsResponse.FromString,
741741
_registered_method=True)
742+
self.DelNetworkEvent = channel.unary_unary(
743+
'/cln.Node/DelNetworkEvent',
744+
request_serializer=node__pb2.DelnetworkeventRequest.SerializeToString,
745+
response_deserializer=node__pb2.DelnetworkeventResponse.FromString,
746+
_registered_method=True)
742747
self.SubscribeBlockAdded = channel.unary_stream(
743748
'/cln.Node/SubscribeBlockAdded',
744749
request_serializer=node__pb2.StreamBlockAddedRequest.SerializeToString,
@@ -1620,6 +1625,12 @@ def ListNetworkEvents(self, request, context):
16201625
context.set_details('Method not implemented!')
16211626
raise NotImplementedError('Method not implemented!')
16221627

1628+
def DelNetworkEvent(self, request, context):
1629+
"""Missing associated documentation comment in .proto file."""
1630+
context.set_code(grpc.StatusCode.UNIMPLEMENTED)
1631+
context.set_details('Method not implemented!')
1632+
raise NotImplementedError('Method not implemented!')
1633+
16231634
def SubscribeBlockAdded(self, request, context):
16241635
"""Missing associated documentation comment in .proto file."""
16251636
context.set_code(grpc.StatusCode.UNIMPLEMENTED)
@@ -2364,6 +2375,11 @@ def add_NodeServicer_to_server(servicer, server):
23642375
request_deserializer=node__pb2.ListnetworkeventsRequest.FromString,
23652376
response_serializer=node__pb2.ListnetworkeventsResponse.SerializeToString,
23662377
),
2378+
'DelNetworkEvent': grpc.unary_unary_rpc_method_handler(
2379+
servicer.DelNetworkEvent,
2380+
request_deserializer=node__pb2.DelnetworkeventRequest.FromString,
2381+
response_serializer=node__pb2.DelnetworkeventResponse.SerializeToString,
2382+
),
23672383
'SubscribeBlockAdded': grpc.unary_stream_rpc_method_handler(
23682384
servicer.SubscribeBlockAdded,
23692385
request_deserializer=node__pb2.StreamBlockAddedRequest.FromString,
@@ -6212,6 +6228,33 @@ def ListNetworkEvents(request,
62126228
metadata,
62136229
_registered_method=True)
62146230

6231+
@staticmethod
6232+
def DelNetworkEvent(request,
6233+
target,
6234+
options=(),
6235+
channel_credentials=None,
6236+
call_credentials=None,
6237+
insecure=False,
6238+
compression=None,
6239+
wait_for_ready=None,
6240+
timeout=None,
6241+
metadata=None):
6242+
return grpc.experimental.unary_unary(
6243+
request,
6244+
target,
6245+
'/cln.Node/DelNetworkEvent',
6246+
node__pb2.DelnetworkeventRequest.SerializeToString,
6247+
node__pb2.DelnetworkeventResponse.FromString,
6248+
options,
6249+
channel_credentials,
6250+
insecure,
6251+
call_credentials,
6252+
compression,
6253+
wait_for_ready,
6254+
timeout,
6255+
metadata,
6256+
_registered_method=True)
6257+
62156258
@staticmethod
62166259
def SubscribeBlockAdded(request,
62176260
target,

contrib/pyln-testing/pyln/testing/grpc2py.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3371,6 +3371,11 @@ def listnetworkevents2py(m):
33713371
})
33723372

33733373

3374+
def delnetworkevent2py(m):
3375+
return remove_default({
3376+
})
3377+
3378+
33743379
def decodekeysend_routes2py(m): # manual override
33753380
return remove_default({
33763381
"expirydelta": m.expirydelta,

0 commit comments

Comments
 (0)