Skip to content

doc: fix wording for fundchannel_complete #2984

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
niftynei merged 1 commit into from
Aug 23, 2019
Merged

doc: fix wording for fundchannel_complete #2984

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions doc/lightning-fundchannel_complete.7
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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\.
Expand All @@ -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

Expand All @@ -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 changes: 5 additions & 4 deletions doc/lightning-fundchannel_complete.7.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
------------
Expand Down
9 changes: 7 additions & 2 deletions doc/lightning-fundchannel_start.7
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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 changes: 7 additions & 1 deletion doc/lightning-fundchannel_start.7.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
------------
Expand Down