![]() |
![]()
| ![]() |
![]()
NAMElightning-sendcustommsg -- Low-level interface to send protocol messages to peers SYNOPSISsendcustommsg node_id msg DESCRIPTIONCommand added in v0.10.1. The sendcustommsg RPC method allows the user to inject a custom message into the communication with the peer with the given node_id. This is intended as a low-level interface to implement custom protocol extensions on top, not for direct use by end-users. On the receiving end a plugin may implement the custommsg plugin hook and get notified about incoming messages, and allow additional unknown even types in their getmanifest response.
RETURN VALUEThe method will validate the arguments and queue the message for delivery through the daemon that is currently handling the connection. Queuing provides best effort guarantees and the message may not be delivered if the connection is terminated while the message is queued. The RPC method will return as soon as the message is queued. If any of the above limitations is not respected the method returns an explicit error message stating the issue. On success, an object is returned, containing:
AUTHORChristian Decker <decker.christian@gmail.com> is mainly responsible. SEE ALSOlightning-createonion(7), lightning-sendonion(7) RESOURCESMain web site: https://github.com/ElementsProject/lightning EXAMPLESExample 1: Request: $ lightning-cli sendcustommsg -k "node_id"="nodeid030303030303030303030303030303030303030303030303030303030303" "msg"="77770012" { Response: {
|