add clnrest object to plugin manifest

Author: gudnuf

.msggen.json

@@ -1871,10 +1871,17 @@
         },
         "HelpHelp": {
             "Help.help[].category": 2,
+            "Help.help[].clnrest": 5,
             "Help.help[].command": 1,
             "Help.help[].description": 3,
             "Help.help[].verbose": 4
         },
+        "HelpHelpClnrest": {
+            "Help.help[].clnrest.content_type": 3,
+            "Help.help[].clnrest.method": 2,
+            "Help.help[].clnrest.path": 1,
+            "Help.help[].clnrest.rune": 4
+        },
         "HelpRequest": {
             "Help.command": 1
         },
@@ -7676,6 +7683,26 @@
             "added": "pre-v0.10.1",
             "deprecated": null
         },
+        "Help.help[].clnrest": {
+            "added": "v24.08",
+            "deprecated": null
+        },
+        "Help.help[].clnrest.content_type": {
+            "added": "v24.08",
+            "deprecated": null
+        },
+        "Help.help[].clnrest.method": {
+            "added": "v24.08",
+            "deprecated": null
+        },
+        "Help.help[].clnrest.path": {
+            "added": "v24.08",
+            "deprecated": null
+        },
+        "Help.help[].clnrest.rune": {
+            "added": "v24.08",
+            "deprecated": null
+        },
         "Help.help[].command": {
             "added": "pre-v0.10.1",
             "deprecated": null

cln-grpc/proto/node.proto

@@ -15298,6 +15298,34 @@
                   "description": [
                     "The command."
                   ]
+                },
+                "clnrest": {
+                  "type": "object",
+                  "additionalProperties": false,
+                  "required": [],
+                  "added": "v24.08",
+                  "properties": {
+                    "path": {
+                      "type": "string",
+                      "description": "the path to the HTTP endpoint for this command",
+                      "added": "v24.08"
+                    },
+                    "method": {
+                      "type": "string",
+                      "description": "the HTTP method for this command",
+                      "added": "v24.08"
+                    },
+                    "content_type": {
+                      "type": "string",
+                      "description": "http content-type that clnrest should return",
+                      "added": "v24.08"
+                    },
+                    "rune": {
+                      "type": "boolean",
+                      "description": "whether or not this command requires a rune for authentication",
+                      "added": "v24.08"
+                    }
+                  }
                 }
               }
             }

cln-grpc/src/convert.rs

@@ -12,7 +12,7 @@
 from dataclasses import dataclass
 from enum import Enum
 from threading import RLock
-from typing import Any, Callable, Dict, List, Optional, Tuple, Union
+from typing import Any, Callable, Dict, List, Optional, Tuple, Union, TypedDict
 
 from .lightning import LightningRpc, Millisatoshi
 
@@ -38,6 +38,13 @@ class RequestState(Enum):
     FAILED = 'failed'
 
 
+class CLNRestData(TypedDict):
+    path: str
+    method: str
+    content_type: str
+    rune: bool
+
+
 class Method(object):
     """Description of methods that are registered with the plugin.
 
@@ -49,7 +56,8 @@ class Method(object):
     def __init__(self, name: str, func: Callable[..., JSONType],
                  mtype: MethodType = MethodType.RPCMETHOD,
                  deprecated: Union[bool, List[str]] = None,
-                 description: str = None):
+                 description: str = None,
+                 clnrest_data: CLNRestData = None):
         self.name = name
         self.func = func
         self.mtype = mtype
@@ -58,6 +66,7 @@ def __init__(self, name: str, func: Callable[..., JSONType],
         self.description = description
         self.before: List[str] = []
         self.after: List[str] = []
+        self.clnrest = clnrest_data
 
     def get_usage(self):
         # Handles out-of-order use of parameters like:
@@ -357,7 +366,8 @@ def convert_featurebits(
     def add_method(self, name: str, func: Callable[..., Any],
                    background: bool = False,
                    deprecated: Optional[Union[bool, List[str]]] = None,
-                   description: str = None) -> None:
+                   description: str = None,
+                   clnrest_data: CLNRestData = None) -> None:
         """Add a plugin method to the dispatch table.
 
         The function will be expected at call time (see `_dispatch`)
@@ -394,7 +404,7 @@ def add_method(self, name: str, func: Callable[..., Any],
             )
 
         # Register the function with the name
-        method = Method(name, func, MethodType.RPCMETHOD, deprecated, description)
+        method = Method(name, func, MethodType.RPCMETHOD, deprecated, description, clnrest_data)
         method.background = background
         self.methods[name] = method
 
@@ -511,7 +521,8 @@ def get_option(self, name: str) -> Optional[Any]:
     def async_method(self, method_name: str, category: Optional[str] = None,
                      desc: Optional[str] = None,
                      long_desc: Optional[str] = None,
-                     deprecated: Optional[Union[bool, List[str]]] = None) -> NoneDecoratorType:
+                     deprecated: Optional[Union[bool, List[str]]] = None,
+                     clnrest_data: CLNRestData = None) -> NoneDecoratorType:
         """Decorator to add an async plugin method to the dispatch table.
 
         Internally uses add_method.
@@ -520,15 +531,16 @@ def decorator(f: Callable[..., None]) -> Callable[..., None]:
             for attr, attr_name in [(category, "Category"), (desc, "Description"), (long_desc, "Long description")]:
                 if attr is not None:
                     self.log("{} is deprecated but defined in method {}; it will be ignored by Core Lightning".format(attr_name, method_name), level="warn")
-            self.add_method(method_name, f, background=True, deprecated=deprecated)
+            self.add_method(method_name, f, background=True, deprecated=deprecated, clnrest_data=clnrest_data)
             return f
         return decorator
 
     def method(self, method_name: str, category: Optional[str] = None,
                desc: Optional[str] = None,
                long_desc: Optional[str] = None,
                deprecated: Union[bool, List[str]] = None,
-               description: str = None) -> JsonDecoratorType:
+               description: str = None,
+               clnrest_data: Optional[CLNRestData] = None) -> JsonDecoratorType:
         """Decorator to add a plugin method to the dispatch table.
 
         Internally uses add_method.
@@ -537,7 +549,7 @@ def decorator(f: Callable[..., JSONType]) -> Callable[..., JSONType]:
             for attr, attr_name in [(category, "Category"), (desc, "Description"), (long_desc, "Long description")]:
                 if attr is not None:
                     self.log("{} is deprecated but defined in method {}; it will be ignored by Core Lightning".format(attr_name, method_name), level="warn")
-            self.add_method(method_name, f, background=False, deprecated=deprecated, description=f.__doc__)
+            self.add_method(method_name, f, background=False, deprecated=deprecated, description=f.__doc__, clnrest_data=clnrest_data)
             return f
         return decorator
 
@@ -951,6 +963,9 @@ def _getmanifest(self, **kwargs) -> JSONType:
                 'usage': method.get_usage(),
                 'description': description,
             })
+            if method.clnrest:
+                m = methods[len(methods) - 1]
+                m["clnrest"] = method.clnrest
 
         manifest = {
             'options': list(d.json() for d in self.options.values()),

cln-rpc/src/model.rs

@@ -2656,6 +2656,15 @@ def stop2py(m):
     })
 
 
+def help_help_clnrest2py(m):
+    return remove_default({
+        "content_type": m.content_type,  # PrimitiveField in generate_composite
+        "method": m.method,  # PrimitiveField in generate_composite
+        "path": m.path,  # PrimitiveField in generate_composite
+        "rune": m.rune,  # PrimitiveField in generate_composite
+    })
+
+
 def help_help2py(m):
     return remove_default({
         "command": m.command,  # PrimitiveField in generate_composite

contrib/msggen/msggen/schema.json

@@ -40,6 +40,34 @@
               "description": [
                 "The command."
               ]
+            },
+            "clnrest": {
+              "type": "object",
+              "additionalProperties": false,
+              "required": [],
+              "added": "v24.08",
+              "properties": {
+                "path": {
+                  "type": "string",
+                  "description": "the path to the HTTP endpoint for this command",
+                  "added": "v24.08"
+                },
+                "method": {
+                  "type": "string",
+                  "description": "the HTTP method for this command",
+                  "added": "v24.08"
+                },
+                "content_type": {
+                  "type": "string",
+                  "description": "http content-type that clnrest should return",
+                  "added": "v24.08"
+                },
+                "rune": {
+                  "type": "boolean",
+                  "description": "whether or not this command requires a rune for authentication",
+                  "added": "v24.08"
+                }
+              }
             }
           }
         }

contrib/pyln-client/pyln/client/plugin.py

@@ -462,6 +462,23 @@ static void json_add_help_command(struct command *cmd,
 				   json_command->name));
 	json_object_start(response, NULL);
 	json_add_string(response, "command", usage);
+
+	if (json_command->clnrest) {
+			json_object_start(response, "clnrest");
+			if (json_command->clnrest->method) {
+					json_add_string(response, "method", json_command->clnrest->method);
+			}
+			if (json_command->clnrest->path) {
+					json_add_string(response, "path", json_command->clnrest->path);
+			}
+			if (json_command->clnrest->content_type) {
+					json_add_string(response, "content_type", json_command->clnrest->content_type);
+			}
+			if (json_command->clnrest->rune) {
+					json_add_bool(response, "rune", *json_command->clnrest->rune);
+			}
+			json_object_end(response);
+	}
 	json_object_end(response);
 }
 
@@ -1360,14 +1377,39 @@ static void destroy_json_command(struct json_command *command, struct jsonrpc *r
 	abort();
 }
 
-static bool command_add(struct jsonrpc *rpc, struct json_command *command)
+static bool command_add(struct jsonrpc *rpc, struct json_command *command,
+			char **collision_name)
 {
 	size_t count = tal_count(rpc->commands);
 
 	/* Check that we don't clobber a method */
-	for (size_t i = 0; i < count; i++)
-		if (streq(rpc->commands[i]->name, command->name))
+	for (size_t i = 0; i < count; i++) {
+
+		if (streq(rpc->commands[i]->name, command->name)) {
+			if (collision_name) {
+				*collision_name =
+				    tal_strdup(tmpctx, rpc->commands[i]->name);
+			}
 			return false;
+		}
+
+		/* Check for clnrest conflict */
+		if (command->clnrest && rpc->commands[i]->clnrest) {
+			bool method_match =
+			    streq(command->clnrest->method,
+				  rpc->commands[i]->clnrest->method);
+			bool path_match =
+			    streq(command->clnrest->path,
+				  rpc->commands[i]->clnrest->path);
+			if (method_match && path_match) {
+				if (collision_name) {
+					*collision_name = tal_strdup(
+					    tmpctx, rpc->commands[i]->name);
+				}
+				return false;
+			}
+		}
+	}
 
 	tal_arr_expand(&rpc->commands, command);
 	return true;
@@ -1391,12 +1433,12 @@ static void setup_command_usage(struct lightningd *ld,
 }
 
 bool jsonrpc_command_add(struct jsonrpc *rpc, struct json_command *command,
-			 const char *usage TAKES)
+			 const char *usage TAKES, char **collision_name)
 {
 	struct json_escape *esc;
 	const char *unescaped;
 
-	if (!command_add(rpc, command))
+	if (!command_add(rpc, command, collision_name))
 		return false;
 
 	esc = json_escape_string_(tmpctx, usage, strlen(usage));
@@ -1417,7 +1459,7 @@ static bool jsonrpc_command_add_perm(struct lightningd *ld,
 				     struct jsonrpc *rpc,
 				     struct json_command *command)
 {
-	if (!command_add(rpc, command))
+	if (!command_add(rpc, command, NULL))
 		return false;
 	setup_command_usage(ld, command);
 	return true;