vincenzopalazzo
/
rgb-cln
1
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity

Warning added to PLUGIN documentation re: `stdin` 

Adds some warning/documentation about the `println!`/`dbg!` causing my bad times as a plugin developer.  =)
This commit is contained in:
Justin Litchfield 2022-06-09 10:23:41 -05:00 committed by Rusty Russell
parent 1eaec223b7
commit ed7624e4f9
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/PLUGINS.md
View File

@ -22,6 +22,18 @@ used as protocol on top of the two streams, with the plugin acting as
server and `lightningd` acting as client. The plugin file needs to be
executable (e.g. use `chmod a+x plugin_name`)
### Warning
As noted, `lightningd` uses `stdin` as an intake mechanism. This can
cause unexpected behavior if one is not careful. To wit, care should
be taken to ensure that debug/logging statements must be routed to
`stderr` or directly to a file. Activities that are benign in other
contexts (`println!`, `dbg!`, etc) will cause the plugin to be killed
with an error along the lines of:
`UNUSUAL plugin-cln-plugin-startup: Killing plugin: JSON-RPC message
does not contain "jsonrpc" field`
## A day in the life of a plugin
During startup of `lightningd` you can use the `--plugin=` option to