mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2025-02-21 14:24:09 +01:00
Code Issues Projects Releases Wiki Activity

docs: document addgossip API.

Browse source 
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
Changelog-Added: JSON-RPC: `addgossip` allows direct injection of network gossip messages.
This commit is contained in:
Rusty Russell 2021-02-02 15:46:22 +10:30 • committed by Christian Decker
parent 1a85edd207
commit 9da191e034
4 changed files with 81 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
doc/Makefile
View file

@ -7,6 +7,7 @@ doc-wrongdir:
MANPAGES := doc/lightning-cli.1 \ MANPAGES := doc/lightning-cli.1 \
doc/lightningd.8 \ doc/lightningd.8 \
doc/lightningd-config.5 \ doc/lightningd-config.5 \
doc/lightning-addgossip.7 \
doc/lightning-autocleaninvoice.7 \ doc/lightning-autocleaninvoice.7 \
doc/lightning-check.7 \ doc/lightning-check.7 \
doc/lightning-checkmessage.7 \ doc/lightning-checkmessage.7 \

1
doc/index.rst
View file

@ -29,6 +29,7 @@ c-lightning Documentation
:maxdepth: 1 :maxdepth: 1
:caption: Manpages :caption: Manpages
lightning-addgossip <lightning-addgossip.7.md>
lightning-autocleaninvoice <lightning-autocleaninvoice.7.md> lightning-autocleaninvoice <lightning-autocleaninvoice.7.md>
lightning-check <lightning-check.7.md> lightning-check <lightning-check.7.md>
lightning-checkmessage <lightning-checkmessage.7.md> lightning-checkmessage <lightning-checkmessage.7.md>

38
doc/lightning-addgossip.7 generated Normal file
View file

@ -0,0 +1,38 @@
.TH "LIGHTNING-ADDGOSSIP" "7" "" "" "lightning-addgossip"
.SH NAME
lightning-addgossip - Command for injecting a gossip message (low-level)
.SH SYNOPSIS
\fBaddgossip\fR \fImessage\fR
.SH DESCRIPTION
The \fBaddgossip\fR 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\.
This is particularly used by plugins which may receive channel_update
messages within error replies\.
.SH RETURN VALUE
On success, an empty object is returned\.
.SH AUTHOR
Rusty Russell \fI<rusty@rustcorp.com.au\fR> is mainly responsible\.
.SH SEE ALSO
\fBlightning-pay\fR(7)
.SH RESOURCES
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
\" SHA256STAMP:40440e0a1159025d8fac68fc127029bf8539b103c0473d6bfaacd7cef5b56bea

41
doc/lightning-addgossip.7.md Normal file
View file

@ -0,0 +1,41 @@
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.
This is particularly used by plugins which may receive channel_update
messages within error replies.
RETURN VALUE
------------
On success, an empty object is returned.
AUTHOR
------
Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible.
SEE ALSO
--------
lightning-pay(7)
RESOURCES
---------
Main web site: <https://github.com/ElementsProject/lightning>