df-open: use channel_id for openchannel_update and openchannel_signed

Be as specific as possible is a good rule for things, I think
This commit is contained in:
niftynei
2020-09-17 15:28:46 -05:00
committed by Rusty Russell
parent 085c590a51
commit b696ec89a5
11 changed files with 89 additions and 52 deletions

View File

@@ -3,7 +3,7 @@
lightning-openchannel_signed - Command to conclude a channel open
.SH SYNOPSIS
\fBopenchannel_signed\fR \fIid\fR \fIsigned_psbt\fR
\fBopenchannel_signed\fR \fIchannel_id\fR \fIsigned_psbt\fR
.SH DESCRIPTION
@@ -20,7 +20,7 @@ This command will broadcast the finalized funding transaction,
if we receive valid signatures from the peer\.
\fIid\fR is the node id of the remote peer\.
\fIchannel_id\fR is the id of the channel\.
\fIsigned_psbt\fR is the PSBT returned from \fBopenchannel_update\fR (where
@@ -45,9 +45,9 @@ with \fBcode\fR being one of the following:
.IP \[bu]
303: Funding transaction broadcast failed\.
.IP \[bu]
306: Unknown peer id\.
.IP \[bu]
309: PSBT missing required fields\.
.IP \[bu]
311: Unknown channel id\.
.RE
.SH SEE ALSO
@@ -65,4 +65,4 @@ lightning-fundchannel_\fBstart\fR(7), lightning-fundchannel_\fBcomplete\fR(7),
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
\" SHA256STAMP:68fb78430a5ee3707fdb1324ba46373dd3dfaf325fe4e1bd3dcdc1589d80435c
\" SHA256STAMP:93ad9dfed532d0de1481a2f5d3b2030dbaf2f67df69dfcc3724e934d86d332b5

View File

@@ -4,7 +4,7 @@ lightning-openchannel\_signed -- Command to conclude a channel open
SYNOPSIS
--------
**openchannel_signed** *id* *signed_psbt*
**openchannel_signed** *channel_id* *signed_psbt*
DESCRIPTION
-----------
@@ -19,7 +19,7 @@ This command should be called after `openchannel_update` returns
This command will broadcast the finalized funding transaction,
if we receive valid signatures from the peer.
*id* is the node id of the remote peer.
*channel_id* is the id of the channel.
*signed_psbt* is the PSBT returned from `openchannel_update` (where
*commitments_secured* was true) with partial signatures or finalized
@@ -38,8 +38,8 @@ with `code` being one of the following:
- -32602: If the given parameters are wrong.
- -1: Catchall nonspecific error.
- 303: Funding transaction broadcast failed.
- 306: Unknown peer id.
- 309: PSBT missing required fields.
- 311: Unknown channel id.
SEE ALSO
--------

View File

@@ -3,12 +3,12 @@
lightning-openchannel_update - Command to update a collab channel open
.SH SYNOPSIS
\fBopenchannel_update\fR \fIid\fR \fIpsbt\fR
\fBopenchannel_update\fR \fIchannel_id\fR \fIpsbt\fR
.SH DESCRIPTION
\fBopenchannel_update\fR is a low level RPC command which continues an open
channel with peer, as specified by \fIid\fR\. An updated \fIpsbt\fR is passed in; any
channel, as specified by \fIchannel_id\fR\. An updated \fIpsbt\fR is passed in; any
changes from the PSBT last returned (either from \fBopenchannel_init\fR or
a previous call to \fBopenchannel_update\fR) will be communicated to the peer\.
@@ -21,7 +21,7 @@ Must be called until \fIcommitments_secured\fR is returned as true, at which poi
returned by the last call to \fBopenchannel_update\fR\.
\fIid\fR is the node id of the remote peer\.
\fIchannel_id\fR is the id of the channel\.
\fIpsbt\fR is the updated PSBT to be sent to the peer\. May be identical to
@@ -43,9 +43,9 @@ returned PSBT and calling \fBopenchannel_signed\fR to complete the channel open\
.IP \[bu]
305: Peer is not connected\.
.IP \[bu]
306: Unknown peer id\.
.IP \[bu]
309: PSBT missing required fields
.IP \[bu]
311: Unknown channel id\.
.RE
.SH SEE ALSO
@@ -63,4 +63,4 @@ lightning-fundchannel_\fBstart\fR(7), lightning-fundchannel_\fBcomplete\fR(7),
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
\" SHA256STAMP:dcf253e7b1658e71a9721fccee76a6bb07af7579ca4b0413428d2a1e8c9613bc
\" SHA256STAMP:ab3d19be91c8b2e651a6f4a23552f21323c4f0096ceda8026bb2450c2f9c616c

View File

@@ -4,13 +4,13 @@ lightning-openchannel\_update -- Command to update a collab channel open
SYNOPSIS
--------
**openchannel_update** *id* *psbt*
**openchannel_update** *channel_id* *psbt*
DESCRIPTION
-----------
`openchannel_update` is a low level RPC command which continues an open
channel with peer, as specified by *id*. An updated *psbt* is passed in; any
channel, as specified by *channel_id*. An updated *psbt* is passed in; any
changes from the PSBT last returned (either from `openchannel_init` or
a previous call to `openchannel_update`) will be communicated to the peer.
@@ -20,7 +20,7 @@ Must be called until *commitments_secured* is returned as true, at which point
`openchannel_signed` should be called with a signed version of the PSBT
returned by the last call to `openchannel_update`.
*id* is the node id of the remote peer.
*channel_id* is the id of the channel.
*psbt* is the updated PSBT to be sent to the peer. May be identical to
the PSBT last returned by either `openchannel_init` or `openchannel_update`.
@@ -37,8 +37,8 @@ returned PSBT and calling `openchannel_signed` to complete the channel open.
- -32602: If the given parameters are wrong.
- -1: Catchall nonspecific error.
- 305: Peer is not connected.
- 306: Unknown peer id.
- 309: PSBT missing required fields
- 311: Unknown channel id.
SEE ALSO
--------