2020-09-10 20:43:40 +01:00
lightning-openchannel\_update -- Command to update a collab channel open
========================================================================
SYNOPSIS
--------
2022-11-11 01:44:56 +00:00
**openchannel\_update** *channel\_id* *psbt*
2020-09-10 20:43:40 +01:00
DESCRIPTION
-----------
`openchannel_update` is a low level RPC command which continues an open
2022-11-11 01:44:56 +00:00
channel, as specified by *channel\_id* . An updated *psbt* is passed in; any
2020-09-10 20:43:40 +01:00
changes from the PSBT last returned (either from `openchannel_init` or
a previous call to `openchannel_update` ) will be communicated to the peer.
Must be called after `openchannel_init` and before `openchannel_signed` .
2022-11-11 01:44:56 +00:00
Must be called until *commitments\_secured* is returned as true, at which point
2020-09-10 20:43:40 +01:00
`openchannel_signed` should be called with a signed version of the PSBT
returned by the last call to `openchannel_update` .
2022-11-11 01:44:56 +00:00
*channel\_id* is the id of the channel.
2020-09-10 20:43:40 +01:00
*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` .
RETURN VALUE
------------
2021-06-16 02:10:17 +01:00
[comment]: # (GENERATE-FROM-SCHEMA-START)
On success, an object is returned, containing:
2022-09-05 22:33:09 +01:00
2022-09-05 22:45:06 +01:00
- **channel\_id** (hex): the channel id of the channel (always 64 characters)
2024-01-28 23:38:40 +00:00
- **channel\_type** (object): channel\_type as negotiated with peer *(added v24.02)* :
- **bits** (array of u32s): Each bit set in this channel\_type *(added v24.02)* :
- Bit number
- **names** (array of strings): Feature name for each bit set in this channel\_type *(added v24.02)* :
- Name of feature bit (one of "static\_remotekey/even", "anchor\_outputs/even", "anchors\_zero\_fee\_htlc\_tx/even", "scid\_alias/even", "zeroconf/even")
2021-06-16 02:10:17 +01:00
- **psbt** (string): the PSBT of the funding transaction
2022-09-05 22:45:06 +01:00
- **commitments\_secured** (boolean): whether the *psbt* is complete (if true, sign *psbt* and call `openchannel_signed` to complete the channel open)
- **funding\_outnum** (u32): The index of the funding output in the psbt
- **close\_to** (hex, optional): scriptPubkey which we have to close to if we mutual close
2023-01-10 21:03:44 +00:00
- **requires\_confirmed\_inputs** (boolean, optional): Does peer require confirmed inputs in psbt?
2021-09-03 11:07:59 +01:00
2021-06-16 02:10:17 +01:00
[comment]: # (GENERATE-FROM-SCHEMA-END)
2020-09-10 20:43:40 +01:00
2022-11-11 01:44:56 +00:00
If *commitments\_secured* is true, will also return:
2023-10-14 09:09:05 +01:00
2022-11-11 01:44:56 +00:00
- The derived *channel\_id* .
- A *close\_to* script, iff a `close_to` address was provided to
2020-10-26 19:40:00 +00:00
`openchannel_init` and the peer supports `option_upfront_shutdownscript` .
2022-11-11 01:44:56 +00:00
- The *funding\_outnum* , the index of the funding output for this channel
2020-10-26 19:40:00 +00:00
in the funding transaction.
2023-10-14 09:09:05 +01:00
On error, the returned object will contain `code` and `message` properties,
with `code` being one of the following:
2020-10-26 19:40:00 +00:00
2020-09-10 20:43:40 +01:00
- -32602: If the given parameters are wrong.
- -1: Catchall nonspecific error.
- 305: Peer is not connected.
- 309: PSBT missing required fields
2020-09-17 21:28:46 +01:00
- 311: Unknown channel id.
2021-03-11 04:32:48 +00:00
- 312: Channel in an invalid state
2020-09-10 20:43:40 +01:00
SEE ALSO
--------
2021-03-11 04:33:47 +00:00
lightning-openchannel\_init(7), lightning-openchannel\_signed(7),
2022-12-09 07:10:12 +00:00
lightning-openchannel\_bump(7), lightning-openchannel\_abort(7),
2021-03-09 21:14:08 +00:00
lightning-fundchannel\_start(7), lightning-fundchannel\_complete(7),
lightning-fundchannel(7), lightning-fundpsbt(7), lightning-utxopsbt(7),
lightning-multifundchannel(7)
2020-09-10 20:43:40 +01:00
AUTHOR
------
@niftynei < < niftynei @ gmail . com > > is mainly responsible.
RESOURCES
---------
Main web site: < https: / / github . com / ElementsProject / lightning >
2022-12-09 07:10:12 +00:00
2024-01-28 23:38:40 +00:00
[comment]: # ( SHA256STAMP:13df70a54c29a3ac4b8f44a0d2f4cdc47928417b7c810bc19ec35fe820558730)