mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2024-11-19 18:11:28 +01:00
Code Issues Projects Releases Wiki Activity
3e57496af9
core-lightning/doc/lightning-addgossip.7.md

46 lines
1.0 KiB
Markdown
Raw Normal View History

docs: document addgossip API. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> Changelog-Added: JSON-RPC: `addgossip` allows direct injection of network gossip messages.
2021-02-02 06:16:22 +01:00
lightning-addgossip -- Command for injecting a gossip message (low-level)
===============================================================
SYNOPSIS
--------
**addgossip** *message*
DESCRIPTION
-----------
The **addgossip** RPC command injects a hex-encoded gossip message into
the gossip daemon. It may return an error if it is malformed, or may
update its internal state using the gossip message.
Note that currently some paths will still silently reject the gossip: it
is best effort.
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 02:44:56 +01:00
This is particularly used by plugins which may receive channel\_update
docs: document addgossip API. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> Changelog-Added: JSON-RPC: `addgossip` allows direct injection of network gossip messages.
2021-02-02 06:16:22 +01:00
messages within error replies.
RETURN VALUE
------------
doc/schemas: add some simple schemas and generate manpages from them addgossip, check, createinvoice, createonion. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-05-26 07:50:01 +02:00
[comment]: # (GENERATE-FROM-SCHEMA-START)
docs: document addgossip API. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> Changelog-Added: JSON-RPC: `addgossip` allows direct injection of network gossip messages.
2021-02-02 06:16:22 +01:00
On success, an empty object is returned.
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 12:07:59 +02:00
doc/schemas: add some simple schemas and generate manpages from them addgossip, check, createinvoice, createonion. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-05-26 07:50:01 +02:00
[comment]: # (GENERATE-FROM-SCHEMA-END)
docs: document addgossip API. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> Changelog-Added: JSON-RPC: `addgossip` allows direct injection of network gossip messages.
2021-02-02 06:16:22 +01:00
AUTHOR
------
Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible.
SEE ALSO
--------
lightning-pay(7)
RESOURCES
---------
Main web site: <https://github.com/ElementsProject/lightning>
tools/fromschema.py: don't try to handle more complex cases. We only handle top-level objects with an array of objects: make sure it is one before we call the routines. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2023-01-30 07:24:16 +01:00
[comment]: # ( SHA256STAMP:41d0ca6a956520453538c8ad5c5afce681540f4ce26017570cdc2356c3aab599)
Reference in New Issue Copy Permalink