msggen: Include AddPsbtOutput to RPC list and meta field map; regener…

…ate libraries
ElementsProject · Feb 27, 2024 · 7b4a4d3 · 7b4a4d3
1 parent 87f6ceb
commit 7b4a4d3
Show file tree

Hide file tree

Showing 10 changed files with 649 additions and 422 deletions.
diff --git a/.msggen.json b/.msggen.json
@@ -360,6 +360,17 @@
         "AddgossipRequest": {
             "AddGossip.message": 1
         },
+        "AddpsbtoutputRequest": {
+            "AddPsbtOutput.destination": 4,
+            "AddPsbtOutput.initialpsbt": 3,
+            "AddPsbtOutput.locktime": 2,
+            "AddPsbtOutput.satoshi": 1
+        },
+        "AddpsbtoutputResponse": {
+            "AddPsbtOutput.estimated_added_weight": 2,
+            "AddPsbtOutput.outnum": 3,
+            "AddPsbtOutput.psbt": 1
+        },
         "AutocleaninvoiceRequest": {
             "AutoCleanInvoice.cycle_seconds": 2,
             "AutoCleanInvoice.expired_by": 1
@@ -1854,6 +1865,38 @@
             "added": "pre-v0.10.1",
             "deprecated": false
         },
+        "AddPsbtOutput": {
+            "added": "v23.11",
+            "deprecated": false
+        },
+        "AddPsbtOutput.destination": {
+            "added": "v23.11",
+            "deprecated": false
+        },
+        "AddPsbtOutput.estimated_added_weight": {
+            "added": "v23.11",
+            "deprecated": false
+        },
+        "AddPsbtOutput.initialpsbt": {
+            "added": "v23.11",
+            "deprecated": false
+        },
+        "AddPsbtOutput.locktime": {
+            "added": "v23.11",
+            "deprecated": false
+        },
+        "AddPsbtOutput.outnum": {
+            "added": "v23.11",
+            "deprecated": false
+        },
+        "AddPsbtOutput.psbt": {
+            "added": "v23.11",
+            "deprecated": false
+        },
+        "AddPsbtOutput.satoshi": {
+            "added": "v23.11",
+            "deprecated": false
+        },
         "AutoCleanInvoice": {
             "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
@@ -218,6 +218,38 @@ async fn add_gossip(
 
 }
 
+async fn add_psbt_output(
+    &self,
+    request: tonic::Request<pb::AddpsbtoutputRequest>,
+) -> Result<tonic::Response<pb::AddpsbtoutputResponse>, tonic::Status> {
+    let req = request.into_inner();
+    let req: requests::AddpsbtoutputRequest = req.into();
+    debug!("Client asked for add_psbt_output");
+    trace!("add_psbt_output 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::AddPsbtOutput(req))
+        .await
+        .map_err(|e| Status::new(
+           Code::Unknown,
+           format!("Error calling method AddPsbtOutput: {:?}", e)))?;
+    match result {
+        Response::AddPsbtOutput(r) => {
+           trace!("add_psbt_output response: {:?}", r);
+           Ok(tonic::Response::new(r.into()))
+        },
+        r => Err(Status::new(
+            Code::Internal,
+            format!(
+                "Unexpected result {:?} to method call AddPsbtOutput",
+                r
+            )
+        )),
+    }
+
+}
+
 async fn auto_clean_invoice(
     &self,
     request: tonic::Request<pb::AutocleaninvoiceRequest>,

diff --git a/cln-rpc/src/model.rs b/cln-rpc/src/model.rs
diff --git a/contrib/msggen/msggen/schema.json b/contrib/msggen/msggen/schema.json
@@ -29,17 +29,20 @@
     "added": "v23.11",
     "properties": {
       "satoshi": {
-        "type": "msat"
+        "type": "msat",
+        "description": "The satoshi value of the output. It can be a whole number, a whole number ending in sat, a whole number ending in 000msat, or a number with 1 to 8 decimal places ending in btc."
       },
       "locktime": {
-        "type": "u32"
+        "type": "u32",
+        "description": "An optional locktime: if not set, it is set to a recent block height (if no initial psbt is specified)."
       },
       "initialpsbt": {
         "type": "string",
-        "description": "the (optional) base 64 encoded PSBT to begin with. If not specified, one will be generated automatically"
+        "description": "The (optional) base 64 encoded PSBT to begin with. If not specified, one will be generated automatically."
       },
       "destination": {
-        "type": "string"
+        "type": "string",
+        "description": "If not set, an internal address is generated."
       }
     }
   },
@@ -56,15 +59,15 @@
     "properties": {
       "psbt": {
         "type": "string",
-        "description": "Unsigned PSBT which fulfills the parameters given"
+        "description": "The unsigned PSBT which fulfills the parameters given."
       },
       "estimated_added_weight": {
         "type": "u32",
-        "description": "The estimated weight of the added output"
+        "description": "The estimated weight of the added output."
       },
       "outnum": {
         "type": "u32",
-        "description": "The 0-based number where the output was placed"
+        "description": "The 0-based number where the output was placed."
       }
     }
   },

diff --git a/contrib/msggen/msggen/utils/utils.py b/contrib/msggen/msggen/utils/utils.py
@@ -57,13 +57,16 @@ def load_jsonrpc_method(name):
 
 
 def load_jsonrpc_service():
+    # FIXME: Maybe this list should be located somewhere other than utils so
+    #  it's more intuitive to remember to update when new RPC calls are added?
     method_names = [
         "Getinfo",
         "ListPeers",
         "ListFunds",
         "SendPay",
         "ListChannels",
         "AddGossip",
+        "AddPsbtOutput",
         "AutoCleanInvoice",
         "CheckMessage",
         "Close",

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
@@ -44,6 +44,11 @@ def __init__(self, channel):
                 request_serializer=node__pb2.AddgossipRequest.SerializeToString,
                 response_deserializer=node__pb2.AddgossipResponse.FromString,
                 )
+        self.AddPsbtOutput = channel.unary_unary(
+                '/cln.Node/AddPsbtOutput',
+                request_serializer=node__pb2.AddpsbtoutputRequest.SerializeToString,
+                response_deserializer=node__pb2.AddpsbtoutputResponse.FromString,
+                )
         self.AutoCleanInvoice = channel.unary_unary(
                 '/cln.Node/AutoCleanInvoice',
                 request_serializer=node__pb2.AutocleaninvoiceRequest.SerializeToString,
@@ -375,6 +380,12 @@ def AddGossip(self, request, context):
         context.set_details('Method not implemented!')
         raise NotImplementedError('Method not implemented!')
 
+    def AddPsbtOutput(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 AutoCleanInvoice(self, request, context):
         """Missing associated documentation comment in .proto file."""
         context.set_code(grpc.StatusCode.UNIMPLEMENTED)
@@ -756,6 +767,11 @@ def add_NodeServicer_to_server(servicer, server):
                     request_deserializer=node__pb2.AddgossipRequest.FromString,
                     response_serializer=node__pb2.AddgossipResponse.SerializeToString,
             ),
+            'AddPsbtOutput': grpc.unary_unary_rpc_method_handler(
+                    servicer.AddPsbtOutput,
+                    request_deserializer=node__pb2.AddpsbtoutputRequest.FromString,
+                    response_serializer=node__pb2.AddpsbtoutputResponse.SerializeToString,
+            ),
             'AutoCleanInvoice': grpc.unary_unary_rpc_method_handler(
                     servicer.AutoCleanInvoice,
                     request_deserializer=node__pb2.AutocleaninvoiceRequest.FromString,
@@ -1158,6 +1174,23 @@ def AddGossip(request,
             options, channel_credentials,
             insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
 
+    @staticmethod
+    def AddPsbtOutput(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/AddPsbtOutput',
+            node__pb2.AddpsbtoutputRequest.SerializeToString,
+            node__pb2.AddpsbtoutputResponse.FromString,
+            options, channel_credentials,
+            insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
+
     @staticmethod
     def AutoCleanInvoice(request,
             target,

diff --git a/contrib/pyln-testing/pyln/testing/grpc2py.py b/contrib/pyln-testing/pyln/testing/grpc2py.py
@@ -285,6 +285,14 @@ def addgossip2py(m):
     })
 
 
+def addpsbtoutput2py(m):
+    return remove_default({
+        "psbt": m.psbt,  # PrimitiveField in generate_composite
+        "estimated_added_weight": m.estimated_added_weight,  # PrimitiveField in generate_composite
+        "outnum": m.outnum,  # PrimitiveField in generate_composite
+    })
+
+
 def autocleaninvoice2py(m):
     return remove_default({
         "enabled": m.enabled,  # PrimitiveField in generate_composite