mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2025-02-22 06:41:44 +01:00
Code Issues Projects Releases Wiki Activity

doc: fix wording for fundchannel_complete

Browse source
This commit is contained in:
Damian Mee 2019-08-21 15:55:49 +07:00 • committed by neil saitug
parent 997af6f3f4
commit e4d0ef6e11
4 changed files with 24 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
doc/lightning-fundchannel_complete.7
View file

@ -12,10 +12,10 @@ establishment
.SH DESCRIPTION .SH DESCRIPTION
\fBfundchannel_complete\fR is a lower level RPC command\. It allows a user to \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\. \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\. \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 channel establishment has been successfully completed, as the commitment
transactions for this channel are not secured until this command 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 .SH RETURN VALUE
@ -53,4 +54,3 @@ Main web site: \fBNone\fR (\fIhttps://github.com/ElementsProject/lightning\fR)
.HL .HL
Last updated 2019-06-12 11:16:20 CEST Last updated 2019-06-12 11:16:20 CEST

9
doc/lightning-fundchannel_complete.7.md
View file

@ -12,18 +12,19 @@ DESCRIPTION
----------- -----------
`fundchannel_complete` is a lower level RPC command. It allows a user to `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. *txid* is the hex string of the funding transaction id.
*txout* is the integer outpoint of the funding output for this channel. *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 channel establishment has been successfully completed, as the commitment
transactions for this channel are not secured until this command 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 RETURN VALUE
------------ ------------

9
doc/lightning-fundchannel_start.7
View file

@ -27,7 +27,13 @@ will not encompass the correct channel value\.
commitment transactions\. 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 .SH RETURN VALUE
@ -52,4 +58,3 @@ Main web site: \fBNone\fR (\fIhttps://github.com/ElementsProject/lightning\fR)
.HL .HL
Last updated 2019-06-12 11:16:20 CEST Last updated 2019-06-12 11:16:20 CEST

8
doc/lightning-fundchannel_start.7.md
View file

@ -23,7 +23,13 @@ will not encompass the correct channel value.
*feerate* is an optional field. Sets the feerate for subsequent *feerate* is an optional field. Sets the feerate for subsequent
commitment transactions. 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 RETURN VALUE
------------ ------------