Browse Source
plugin: Update documentation of the rpcmethods
Suggested-by: Lisa Neigut <@niftynei>
Signed-off-by: Christian Decker <decker.christian@gmail.com>
plugin-3
Christian Decker
6 years ago
No known key found for this signature in database
GPG Key ID: 1416D83DC4F0E86D
1 changed files with
9 additions and
1 deletions
-
doc/plugins.md
|
|
|
@ -82,7 +82,15 @@ currently only string options are supported.* |
|
|
|
The `rpcmethods` are methods that will be exposed via `lightningd`'s |
|
|
|
JSON-RPC over Unix-Socket interface, just like the builtin |
|
|
|
commands. Any parameters given to the JSON-RPC calls will be passed |
|
|
|
through verbatim. |
|
|
|
through verbatim. Notice that the `name` and the `description` fields |
|
|
|
are mandatory, while the `long_description` can be omitted (it'll be |
|
|
|
set to `description` if it was not provided). |
|
|
|
|
|
|
|
Plugins are free to register any `name` for their `rpcmethod` as long |
|
|
|
as the name was not previously registered. This includes both built-in |
|
|
|
methods, such as `help` and `getinfo`, as well as methods registered |
|
|
|
by other plugins. If there is a conflict then `lightningd` will report |
|
|
|
an error and exit. |
|
|
|
|
|
|
|
### The `init` method |
|
|
|
|
|
|
|
|
