Browse Source

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.
master
Rusty Russell 4 years ago
committed by Christian Decker
parent
commit
9da191e034
  1. 1
      doc/Makefile
  2. 1
      doc/index.rst
  3. 38
      doc/lightning-addgossip.7
  4. 41
      doc/lightning-addgossip.7.md

1
doc/Makefile

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

1
doc/index.rst

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

38
doc/lightning-addgossip.7

@ -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

@ -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>
Loading…
Cancel
Save