mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2024-11-20 02:27:51 +01:00
Code Issues Projects Releases Wiki Activity
0ed7c0d083
core-lightning/doc/lightning-openchannel_bump.7.md
niftynei fc9e72b62b df-doc: add docs for openchannel_bump, more checks for valid psbt 
Add docs for openchannel_bump, plus some checks that were missed for
verifying the amount is valid.
2021-03-12 14:00:19 +10:30

2.4 KiB
Raw Blame History

lightning-openchannel_bump -- Command to initiate a channel RBF

SYNOPSIS

openchannel_bump channel_id amount initalpsbt

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.

id is the id of the channel to RBF.

amount is the satoshi value that we will contribute to the channel. This value will be added to the provided PSBT in the output which is encumbered by the 2-of-2 script for this channel.

initialpsbt is the funded, incomplete PSBT that specifies the UTXOs and change output for our channel contribution. It can be updated, see openchannel_update; initialpsbt must have at least one input. Must have the Non-Witness UTXO (PSBT_IN_NON_WITNESS_UTXO) set for every input. An error (code 309) will be returned if this requirement is not met.

RETURN VALUE

On success, returns the channel_id for this channel; an updated incomplete initialpsbt for this funding transaction; and the flag commitments_secured, which indiciates the completeness of the passed back psbt. (Will always be false). Also returns the funding_serial, indicating the serial_id of the funding output in the 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.

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