b0da807700
This commit will remove parameter descriptions from RPC markdown but we will fix it in next commits by reading these descriptions directly from json. - Removing parameter description text - Adding/removing newlines for cleaner formatting - Adding ERRORS title wherever needed - Updating titles for consistency - Adding resources links
2.7 KiB
lightning-openchannel_bump -- Command to initiate a channel RBF
SYNOPSIS
openchannel_bump channel_id amount initalpsbt [funding_feerate]
DESCRIPTION
openchannel_bump is a RPC command which initiates a channel
RBF (Replace-By-Fee) for the specified channel. It uses the openchannel protocol
which allows for interactive transaction construction.
Warning: bumping a leased channel will lose the lease.
RETURN VALUE
On success, an object is returned, containing:
- channel_id (hex): the channel id of the channel (always 64 characters)
- 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")
- bits (array of u32s): Each bit set in this channel_type (added v24.02):
- psbt (string): the (incomplete) PSBT of the RBF transaction
- commitments_secured (boolean): whether the psbt is complete (always false)
- funding_serial (u64): the serial_id of the funding output in the psbt
- requires_confirmed_inputs (boolean, optional): Does peer require confirmed inputs in psbt?
If the peer does not support option_dual_fund, this command
will return an error.
If the channel is not in a state that is eligible for RBF, this command will return an error.
ERRORS
On error the returned object will contain code and message properties,
with code being one of the following:
- -32602: If the given parameters are wrong.
- -1: Catchall nonspecific error.
- 300: The amount exceeded the maximum configured funding amount.
- 301: The provided PSBT cannot afford the funding amount.
- 305: Peer is not connected.
- 309: PSBT missing required fields
- 311: Unknown channel id.
- 312: Channel in an invalid state
SEE ALSO
lightning-openchannel_init(7), lightning-openchannel_update(7), lightning-openchannel_signed(7), lightning-openchannel_abort(7), lightning-fundchannel_start(7), lightning-fundchannel_complete(7), lightning-fundchannel(7), lightning-fundpsbt(7), lightning-utxopsbt(7), lightning-multifundchannel(7)
AUTHOR
@niftynei <niftynei@gmail.com> is mainly responsible.
RESOURCES
Main web site: https://github.com/ElementsProject/lightning