Skip to content

Commit 1754858

Browse files
ErikDeSmedtrustyrussell
authored andcommitted
Doc fix: dynamic options
When the value of a `dynamic` option is updated core Lightning will make a JSON-RPC request to the plugin. The documentation falsely mentioned the request has a method named `setvalue. It appears it is actually called `setconfig`.
1 parent 557b5fe commit 1754858

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

doc/developers-guide/plugin-development/a-day-in-the-life-of-a-plugin.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ The `getmanifest` method is required for all plugins and will be called on start
8989
}
9090
```
9191

92-
During startup the `options` will be added to the list of command line options that `lightningd` accepts. If any `options` "name" is already taken startup will abort. The above will add a `--greeting` option with a default value of `World` and the specified description. _Notice that currently string, integers, bool, and flag options are supported._ If an option specifies `dynamic`: `true`, then it should allow a `setvalue` call for that option after initialization.
92+
During startup the `options` will be added to the list of command line options that `lightningd` accepts. If any `options` "name" is already taken startup will abort. The above will add a `--greeting` option with a default value of `World` and the specified description. _Notice that currently string, integers, bool, and flag options are supported._ If an option specifies `dynamic`: `true`, then it should allow a `setconfig` call for that option after initialization.
9393

9494
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. Notice that the `name`, `description` and `usage` fields
9595
are mandatory, while the `long_description` can be omitted (it'll be set to `description` if it was not provided). `usage` should surround optional parameter names in `[]`.

0 commit comments

Comments
 (0)