vincenzopalazzo
/
rgb-cln
1
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity
rgb-cln/doc/lightning-sendcustommsg.7.md

71 lines
2.7 KiB
Markdown
Raw Normal View History

sendcustommsg: promote to non-dev Enable non-dev builds to send custom messages. Preserves 'dev-' for compat-enabled builds. Changelog-Changed: JSON-RPC: moved dev-sendcustommsg to sendcustommsg
2021-07-13 22:04:30 +01:00
lightning-sendcustommsg -- Low-level interface to send protocol messages to peers
docs: Add manpage for dev-sendcustommsg It's a dev-* command for now, but better document it so people can use it rather than having them guess how it's supposed to work.
2019-12-09 15:32:49 +00:00
=====================================================================================
SYNOPSIS
--------
doc: escape more naughty underscores The only time underscores aren't special in Markdown is when they appear in preformatted text. We have gotten away with not escaping underscores where an asterisk-enclosed span or the paragraph ends before the next underscore appears, but this is fragile and bad practice. Conversely, there are many places where we have not escaped underscores but needed to. Escape all underscores that do not appear in preformatted blocks or preformatted spans and are not themselves delineating emphasized spans. The changes in this commit are exactly the result of executing the following Bash code: ```bash e=':x;' # begin loop e+='s/^' # anchor match at beginning of line e+='(' # begin capturing subexpression e+='(' # begin list of alternatives e+='[^`_\\]|' # any mundane character, or e+='`([^`\\]|\\.)*`|' # backtick-enclosed span, or e+='\b_|_\b|' # underscore at boundary, or e+='\\.' # backslash-escaped character e+=')*' # any number of the preceding alternatives e+=')' # end capturing subexpression e+='\B_\B/\1\\_/;' # escape non-formatting underscore e+='tx' # repeat loop if we escaped an underscore escape_underscores=( sed # use extended regular expressions -E # skip over indented blocks (following an empty line) -e '/^$/{:i;n;/^( {4,}|\t)/bi}' # skip over preformatted blocks -e '/^\s*```/,/^\s*```/{p;d}' # skip over generated sections -e '/GENERATE-FROM-SCHEMA-START/,/GENERATE-FROM-SCHEMA-END/{p;d}' # escape underscores -e "${e}" ) "${escape_underscores[@]}" -i doc/*.[0-9].md ``` Changelog-None
2022-11-11 01:44:56 +00:00
**sendcustommsg** *node\_id* *msg*
docs: Add manpage for dev-sendcustommsg It's a dev-* command for now, but better document it so people can use it rather than having them guess how it's supposed to work.
2019-12-09 15:32:49 +00:00
DESCRIPTION
-----------
sendcustommsg: promote to non-dev Enable non-dev builds to send custom messages. Preserves 'dev-' for compat-enabled builds. Changelog-Changed: JSON-RPC: moved dev-sendcustommsg to sendcustommsg
2021-07-13 22:04:30 +01:00
The `sendcustommsg` RPC method allows the user to inject a custom message
docs: Add manpage for dev-sendcustommsg It's a dev-* command for now, but better document it so people can use it rather than having them guess how it's supposed to work.
2019-12-09 15:32:49 +00:00
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.
The message must be a hex encoded well-formed message, including the 2-byte
type prefix, but excluding the length prefix which will be added by the RPC
lightningd: allow sending of even messages. It's your funeral! Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2023-10-23 12:30:51 +01:00
method. The message types may not be one of the internally handled
docs: Add manpage for dev-sendcustommsg It's a dev-* command for now, but better document it so people can use it rather than having them guess how it's supposed to work.
2019-12-09 15:32:49 +00:00
types, since that may cause issues with the internal state tracking of
lightningd: allow sending of even messages. It's your funeral! Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2023-10-23 12:30:51 +01:00
Core Lightning. We do (as of *v23.11*) allow sending of even types, but note that peers (as per the spec) will disconnect on receiving unknown even types.
docs: Add manpage for dev-sendcustommsg It's a dev-* command for now, but better document it so people can use it rather than having them guess how it's supposed to work.
2019-12-09 15:32:49 +00:00
The node specified by `node_id` must be a peer, i.e., it must have a direct
connection with the node receiving the RPC call, and the connection must be
established. For a method to send arbitrary messages over multiple hops,
including hops that do not understand the custom message, see the
`createonion` and `sendonion` RPC methods. Messages can only be injected if
the connection is handled by `openingd` or `channeld`. Messages cannot be
injected when the peer is handled by `onchaind` or `closingd` since these do
not have a connection, or are synchronous daemons that do not handle
spontaneous messages.
On the reveiving end a plugin may implement the `custommsg` plugin hook and
lightningd: allow sending of even messages. It's your funeral! Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2023-10-23 12:30:51 +01:00
get notified about incoming messages, and allow additional unknown even types in their getmanifest response.
docs: Add manpage for dev-sendcustommsg It's a dev-* command for now, but better document it so people can use it rather than having them guess how it's supposed to work.
2019-12-09 15:32:49 +00:00
RETURN VALUE
------------
The 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.
doc: schemas for everything else. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> Changelog-Fixed: doc: Epic documentation rewrite: each now lists complete and accurate JSON output, tested against testsuite.
2021-06-16 02:10:17 +01:00
[comment]: # (GENERATE-FROM-SCHEMA-START)
On success, an object is returned, containing:
doc: generate correct markdown from schemas. You can't start a list without a paragraph separator. ```diff --- /tmp/before 2022-07-20 22:02:23.485372596 +0930 +++ /tmp/after 2022-07-20 22:02:33.745528456 +0930 @@ -21,12 +21,16 @@ On startup of the daemon, no autoclean is set up. RETURN VALUE - On success, an object is returned, containing: - enabled (boolean): - whether invoice autocleaning is active + On success, an object is returned, containing: - If enabled is true: - expired_by (u64): how long an invoice must be ex‐ - pired (seconds) before we delete it - cycle_seconds (u64): how long an - invoice must be expired (seconds) before we delete it + • enabled (boolean): whether invoice autocleaning is active + + If enabled is true: + + • expired_by (u64): how long an invoice must be expired (seconds) be‐ + fore we delete it + • cycle_seconds (u64): how long an invoice must be expired (seconds) + before we delete it AUTHOR ZmnSCPxj <ZmnSCPxj@protonmail.com> is mainly responsible. ``` Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2022-09-05 22:33:09 +01:00
doc: schemas for everything else. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> Changelog-Fixed: doc: Epic documentation rewrite: each now lists complete and accurate JSON output, tested against testsuite.
2021-06-16 02:10:17 +01:00
- **status** (string): Information about where message was queued
doc: fix GH/readthedocs rendering of manual pages. They render the comment as if it's in the list. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-09-03 11:07:59 +01:00
doc: schemas for everything else. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> Changelog-Fixed: doc: Epic documentation rewrite: each now lists complete and accurate JSON output, tested against testsuite.
2021-06-16 02:10:17 +01:00
[comment]: # (GENERATE-FROM-SCHEMA-END)
docs: Add manpage for dev-sendcustommsg It's a dev-* command for now, but better document it so people can use it rather than having them guess how it's supposed to work.
2019-12-09 15:32:49 +00:00
AUTHOR
------
Christian Decker <<decker.christian@gmail.com>> is mainly responsible.
SEE ALSO
--------
lightning-createonion(7), lightning-sendonion(7)
RESOURCES
---------
Main web site: <https://github.com/ElementsProject/lightning>
doc: force refresh of all manpages. The idea is that you regenerate the man pages in the same commit you alter them: that's how we know whether to try regenerating them or not (git doesn't store timestamps, so it can't really tell). Travis will now check this, so force them all to sync to this commit. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2020-08-25 02:33:16 +01:00
schemas: deprecated is now a range. Don't assume removal is +6 months, but have a start deprecation/end support range. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2024-01-25 00:28:53 +00:00
[comment]: # ( SHA256STAMP:5603fac5f46c7f91c625b33d98df1a2a587262788465ebd1db24433989425a2e)