Browse Source

doc: fix wording for fundchannel_complete

pull/2938/head
Damian Mee 6 years ago
committed by neil saitug
parent
commit
e4d0ef6e11
  1. 10
      doc/lightning-fundchannel_complete.7
  2. 9
      doc/lightning-fundchannel_complete.7.md
  3. 9
      doc/lightning-fundchannel_start.7
  4. 8
      doc/lightning-fundchannel_start.7.md

10
doc/lightning-fundchannel_complete.7

@ -12,10 +12,10 @@ establishment
.SH DESCRIPTION
\fBfundchannel_complete\fR is a lower level RPC command\. It allows a user to
complete an initiated channel establishment with a connected peer
complete an initiated channel establishment with a connected peer\.
\fIid\fR is the node id of the remote peer
\fIid\fR is the node id of the remote peer\.
\fItxid\fR is the hex string of the funding transaction id\.
@ -24,10 +24,11 @@ complete an initiated channel establishment with a connected peer
\fItxout\fR is the integer outpoint of the funding output for this channel\.
Note that the funding transaction should not be broadcast until after
Note that the funding transaction MUST NOT be broadcast until after
channel establishment has been successfully completed, as the commitment
transactions for this channel are not secured until this command
succesfully completes\.
successfully completes\. Broadcasting transaction before can lead to
unrecoverable loss of funds\.
.SH RETURN VALUE
@ -53,4 +54,3 @@ Main web site: \fBNone\fR (\fIhttps://github.com/ElementsProject/lightning\fR)
.HL
Last updated 2019-06-12 11:16:20 CEST

9
doc/lightning-fundchannel_complete.7.md

@ -12,18 +12,19 @@ DESCRIPTION
-----------
`fundchannel_complete` is a lower level RPC command. It allows a user to
complete an initiated channel establishment with a connected peer
complete an initiated channel establishment with a connected peer.
*id* is the node id of the remote peer
*id* is the node id of the remote peer.
*txid* is the hex string of the funding transaction id.
*txout* is the integer outpoint of the funding output for this channel.
Note that the funding transaction should not be broadcast until after
Note that the funding transaction MUST NOT be broadcast until after
channel establishment has been successfully completed, as the commitment
transactions for this channel are not secured until this command
succesfully completes.
successfully completes. Broadcasting transaction before can lead to
unrecoverable loss of funds.
RETURN VALUE
------------

9
doc/lightning-fundchannel_start.7

@ -27,7 +27,13 @@ will not encompass the correct channel value\.
commitment transactions\.
\fIannounce\fR whether or not to annouce this channel\.
\fIannounce\fR whether or not to announce this channel\.
Note that the funding transaction MUST NOT be broadcast until after
channel establishment has been successfully completed by running
\fBfundchannel_complete\fR, as the commitment transactions for this channel
are not secured until the complete command succeeds. Broadcasting
transaction before that can lead to unrecoverable loss of funds\.
.SH RETURN VALUE
@ -52,4 +58,3 @@ Main web site: \fBNone\fR (\fIhttps://github.com/ElementsProject/lightning\fR)
.HL
Last updated 2019-06-12 11:16:20 CEST

8
doc/lightning-fundchannel_start.7.md

@ -23,7 +23,13 @@ will not encompass the correct channel value.
*feerate* is an optional field. Sets the feerate for subsequent
commitment transactions.
*announce* whether or not to annouce this channel.
*announce* whether or not to announce this channel.
Note that the funding transaction MUST NOT be broadcast until after
channel establishment has been successfully completed by running
`fundchannel_complete`, as the commitment transactions for this channel
are not secured until the complete command succeeds. Broadcasting
transaction before that can lead to unrecoverable loss of funds.
RETURN VALUE
------------

Loading…
Cancel
Save