LIGHTNING-FUNDCHANNEL_COMPLETE(7)

📦
version 26.06.9 · 2 versions
, in nixpkgs unstable

💅 LIGHTNING-FUNDCHANNEL_COMPLETE(7) ✨

okay so bestie, welcome to lightning-fundchannel_complete — it's a page from the Core Lightning manual, and it's literally the "finish the thing" button for channel establishment 🎀

🌸 NAME 🌸

fundchannel_complete — the command for completing channel establishment. that's it, that's the vibe 🦋

✨ SYNOPSIS ✨

fundchannel_complete id psbt [withhold]

💖 DESCRIPTION 💖

okay so fundchannel_complete is a lower level RPC command, meaning it's giving main-character energy for people who already know what they're doing 💅 it lets a user complete an initiated channel establishment with a connected peer.

⚠️ no cap, this is the important part: the funding transaction MUST NOT be broadcast until after channel establishment has been successfully completed, because the commitment transactions for this channel are not secured until this command successfully completes. broadcasting the transaction before that can lead to unrecoverable loss of funds 😭 like, actual money, gone, forever. please please please don't.

now the params, one by one, slay:

  • id (pubkey) — the node id of the remote peer 🫶
  • psbt (string) — the transaction to use for funding. it does not need to be signed, but it must be otherwise complete ✨
  • withhold (boolean, optional) — marks this channel 'withheld' so we know we haven't broadcast the funding transaction. if the channel is closed before we call sendpsbt on this psbt, it will simply be closed immediately 🏃‍♀️💨 (added in v25.12, iykyk)

🔥 RETURN VALUE 🔥

on success, an object comes back at you, containing:

  • channel_id (hash) — the channel_id of the resulting channel 👑
  • commitments_secured (boolean) (always true) — the indication that the channel is safe to use. yes bestie, safe 🫶

😭 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 💀
  • 305 — peer is not connected 🦋
  • 306 — unknown peer id 💜
  • 309 — PSBT does not have a unique, correct output to fund the channel ⭐

🎀 AUTHOR 🎀

Lisa Neigut niftynei@gmail.com is mainly responsible 💖 iconic behavior, honestly.

🌈 SEE ALSO 🌈

lightning-connect(7), lightning-fundchannel(7), lightning-multifundchannel(7), lightning-fundchannel_start(7), lightning-fundchannel_cancel(7), lightning-openchannel_init(7), lightning-openchannel_update(7), lightning-openchannel_signed(7), lightning-openchannel_bump(7), lightning-openchannel_abort(7)

🧚 RESOURCES 🧚

main web site: https://github.com/ElementsProject/lightning

💜 EXAMPLES 💜

🍓 Example 1

Request:

$ lightning-cli fundchannel_complete "nodeid101010101010101010101010101010101010101010101010101010101010" "cHNidP8BAgQCAAAAAQMEbwAAAAEEAQpsbt201000201000201000201000201000201000201000201000201000201000201000201000201000201000201000201000201000201000201000201000201000201000201000201000201000201000201000201000201000201000201000201000201000201000201000201000201000"
{
  "id": "example:fundchannel_complete#1",
  "method": "fundchannel_complete",
  "params": [
    "nodeid101010101010101010101010101010101010101010101010101010101010",
    "cHNidP8BAgQCAAAAAQMEbwAAAAEEAQpsbt201000201000201000201000201000201000201000201000201000201000201000201000201000201000201000201000201000201000201000201000201000201000201000201000201000201000201000201000201000201000201000201000201000201000201000201000"
  ]
}

Response:

{
  "channel_id": "channelid0910109101091010910109101091010910109101091010910109101",
  "commitments_secured": true
}

🍓 Example 2

Request:

$ lightning-cli fundchannel_complete -k "id"="nodeid101010101010101010101010101010101010101010101010101010101010" "psbt"="cHNidP8BAgQCAAAAAQMEbwAAAAEEAQpsbt401000401000401000401000401000401000401000401000401000401000401000401000401000401000401000401000401000401000401000401000401000401000401000401000401000401000401000401000401000401000401000401000401000401000401000401000401000401000401000401000"
{
  "id": "example:fundchannel_complete#2",
  "method": "fundchannel_complete",
  "params": {
    "id": "nodeid101010101010101010101010101010101010101010101010101010101010",
    "psbt": "cHNidP8BAgQCAAAAAQMEbwAAAAEEAQpsbt401000401000401000401000401000401000401000401000401000401000401000401000401000401000401000401000401000401000401000401000401000401000401000401000401000401000401000401000401000401000401000401000401000401000401000401000401000401000401000401000"
  }
}

Response:

{
  "channel_id": "channelid0910209102091020910209102091020910209102091020910209102",
  "commitments_secured": true
}

okay that's the whole page bestie, every single flag and every single error code, nothing skipped, we ate and left no crumbs 👑✨ this one's from Core Lightning v26.06.9 — go forth and complete those channels responsibly, mwah 💅💖🦋

📦 where this page comes from