a82f1feb3a
Category, description and long description from `json_command` and `plugin_command` have been removed in favour of getting them from json schema. Reference PR: Add categories in RPC documentation #7485 Deprecating them in pyln-client as well. They will remove completely in future releases. Changelog-Deprecated: pyln-client: category, description and long descriptions for RPC commands are deprecated now.
34 lines
1.4 KiB
Markdown
34 lines
1.4 KiB
Markdown
---
|
|
title: "JSON-RPC passthrough"
|
|
slug: "json-rpc-passthrough"
|
|
hidden: false
|
|
createdAt: "2023-02-03T08:53:50.840Z"
|
|
updatedAt: "2023-02-03T08:53:50.840Z"
|
|
---
|
|
Plugins may register their own JSON-RPC methods that are exposed through the JSON-RPC provided by `lightningd`. This provides users with a single interface to interact with, while allowing the addition of custom methods without having to modify the daemon itself.
|
|
|
|
JSON-RPC methods are registered as part of the `getmanifest` result. Each registered method must provide a `name`. This information is then added to the internal dispatch table, and used to return the help text when using `lightning-cli help`, and the methods can be called using the `name`.
|
|
|
|
For example, `getmanifest` result will register two methods, called `hello` and `gettime`:
|
|
|
|
```json
|
|
...
|
|
"rpcmethods": [
|
|
{
|
|
"name": "hello",
|
|
"usage": "[name]"
|
|
},
|
|
{
|
|
"name": "gettime",
|
|
"usage": "",
|
|
}
|
|
],
|
|
...
|
|
```
|
|
|
|
|
|
|
|
The RPC call will be passed through unmodified, with the exception of the JSON-RPC call `id`, which is internally remapped to a unique integer instead, in order to avoid collisions. When passing the result back the `id` field is restored to its original value.
|
|
|
|
Note that if your `result` for an RPC call includes `"format-hint":
|
|
"simple"`, then `lightning-cli` will default to printing your output in "human-readable" flat form. |