plugin/clnrest: Adding new config param as clnrest-swagger-root

- Updated config params and plugin - Updated documentation Changelog-Added: Added a new configuration for clnrest plugin to change the default Swagger UI path from `/` to custom url.
ElementsProject · Apr 25, 2024 · 4369f94 · 4369f94
1 parent 7317bb1
commit 4369f94
Show file tree

Hide file tree

Showing 15 changed files with 849 additions and 630 deletions.
diff --git a/.msggen.json b/.msggen.json
@@ -847,6 +847,17 @@
         "DelpayResponse": {
             "DelPay.payments[]": 1
         },
+        "DisableofferRequest": {
+            "DisableOffer.offer_id": 1
+        },
+        "DisableofferResponse": {
+            "DisableOffer.active": 2,
+            "DisableOffer.bolt12": 4,
+            "DisableOffer.label": 6,
+            "DisableOffer.offer_id": 1,
+            "DisableOffer.single_use": 3,
+            "DisableOffer.used": 5
+        },
         "DisconnectRequest": {
             "Disconnect.force": 2,
             "Disconnect.id": 1
@@ -3668,6 +3679,34 @@
             "added": "pre-v0.10.1",
             "deprecated": false
         },
+        "DisableOffer": {
+            "added": "pre-v0.10.1",
+            "deprecated": null
+        },
+        "DisableOffer.active": {
+            "added": "pre-v0.10.1",
+            "deprecated": false
+        },
+        "DisableOffer.bolt12": {
+            "added": "pre-v0.10.1",
+            "deprecated": false
+        },
+        "DisableOffer.label": {
+            "added": "pre-v0.10.1",
+            "deprecated": false
+        },
+        "DisableOffer.offer_id": {
+            "added": "pre-v0.10.1",
+            "deprecated": false
+        },
+        "DisableOffer.single_use": {
+            "added": "pre-v0.10.1",
+            "deprecated": false
+        },
+        "DisableOffer.used": {
+            "added": "pre-v0.10.1",
+            "deprecated": false
+        },
         "Disconnect": {
             "added": "pre-v0.10.1",
             "deprecated": null

diff --git a/cln-grpc/proto/node.proto b/cln-grpc/proto/node.proto
diff --git a/cln-grpc/src/convert.rs b/cln-grpc/src/convert.rs
diff --git a/cln-grpc/src/server.rs b/cln-grpc/src/server.rs
@@ -1466,6 +1466,38 @@ async fn del_forward(
 
 }
 
+async fn disable_offer(
+    &self,
+    request: tonic::Request<pb::DisableofferRequest>,
+) -> Result<tonic::Response<pb::DisableofferResponse>, tonic::Status> {
+    let req = request.into_inner();
+    let req: requests::DisableofferRequest = req.into();
+    debug!("Client asked for disable_offer");
+    trace!("disable_offer request: {:?}", req);
+    let mut rpc = ClnRpc::new(&self.rpc_path)
+        .await
+        .map_err(|e| Status::new(Code::Internal, e.to_string()))?;
+    let result = rpc.call(Request::DisableOffer(req))
+        .await
+        .map_err(|e| Status::new(
+           Code::Unknown,
+           format!("Error calling method DisableOffer: {:?}", e)))?;
+    match result {
+        Response::DisableOffer(r) => {
+           trace!("disable_offer response: {:?}", r);
+           Ok(tonic::Response::new(r.into()))
+        },
+        r => Err(Status::new(
+            Code::Internal,
+            format!(
+                "Unexpected result {:?} to method call DisableOffer",
+                r
+            )
+        )),
+    }
+
+}
+
 async fn disconnect(
     &self,
     request: tonic::Request<pb::DisconnectRequest>,

diff --git a/cln-rpc/src/model.rs b/cln-rpc/src/model.rs
diff --git a/contrib/msggen/msggen/utils/utils.py b/contrib/msggen/msggen/utils/utils.py
@@ -103,7 +103,7 @@ def load_jsonrpc_service():
         "Decode",
         "DelPay",
         "DelForward",
-        # "disableoffer",
+        "DisableOffer",
         "Disconnect",
         "Feerates",
         "FetchInvoice",

diff --git a/contrib/pyln-grpc-proto/pyln/grpc/node_pb2.py b/contrib/pyln-grpc-proto/pyln/grpc/node_pb2.py
diff --git a/contrib/pyln-grpc-proto/pyln/grpc/node_pb2_grpc.py b/contrib/pyln-grpc-proto/pyln/grpc/node_pb2_grpc.py
@@ -239,6 +239,11 @@ def __init__(self, channel):
                 request_serializer=node__pb2.DelforwardRequest.SerializeToString,
                 response_deserializer=node__pb2.DelforwardResponse.FromString,
                 )
+        self.DisableOffer = channel.unary_unary(
+                '/cln.Node/DisableOffer',
+                request_serializer=node__pb2.DisableofferRequest.SerializeToString,
+                response_deserializer=node__pb2.DisableofferResponse.FromString,
+                )
         self.Disconnect = channel.unary_unary(
                 '/cln.Node/Disconnect',
                 request_serializer=node__pb2.DisconnectRequest.SerializeToString,
@@ -669,6 +674,12 @@ def DelForward(self, request, context):
         context.set_details('Method not implemented!')
         raise NotImplementedError('Method not implemented!')
 
+    def DisableOffer(self, request, context):
+        """Missing associated documentation comment in .proto file."""
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
     def Disconnect(self, request, context):
         """Missing associated documentation comment in .proto file."""
         context.set_code(grpc.StatusCode.UNIMPLEMENTED)
@@ -1083,6 +1094,11 @@ def add_NodeServicer_to_server(servicer, server):
                     request_deserializer=node__pb2.DelforwardRequest.FromString,
                     response_serializer=node__pb2.DelforwardResponse.SerializeToString,
             ),
+            'DisableOffer': grpc.unary_unary_rpc_method_handler(
+                    servicer.DisableOffer,
+                    request_deserializer=node__pb2.DisableofferRequest.FromString,
+                    response_serializer=node__pb2.DisableofferResponse.SerializeToString,
+            ),
             'Disconnect': grpc.unary_unary_rpc_method_handler(
                     servicer.Disconnect,
                     request_deserializer=node__pb2.DisconnectRequest.FromString,
@@ -2013,6 +2029,23 @@ def DelForward(request,
             options, channel_credentials,
             insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
 
+    @staticmethod
+    def DisableOffer(request,
+            target,
+            options=(),
+            channel_credentials=None,
+            call_credentials=None,
+            insecure=False,
+            compression=None,
+            wait_for_ready=None,
+            timeout=None,
+            metadata=None):
+        return grpc.experimental.unary_unary(request, target, '/cln.Node/DisableOffer',
+            node__pb2.DisableofferRequest.SerializeToString,
+            node__pb2.DisableofferResponse.FromString,
+            options, channel_credentials,
+            insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
+
     @staticmethod
     def Disconnect(request,
             target,