LIGHTNING-OPENCHANNEL_ABORT(7)

📦
version 26.06.9 · 2 versions
, in nixpkgs unstable

✨ LIGHTNING-OPENCHANNEL_ABORT(7) ✨

okay bestie, welcome to the lightning-openchannel_abort page 💅 — yes it's a LIGHTNING-OPENCHANNEL_ABORT(7) manual page, and yes it's about hitting the abort button on a channel, so buckle up 🎀

💖 NAME 💖

openchannel_abort — the command that lets you ~abort~ a channel to a peer, no cap 🛑

🌸 SYNOPSIS 🌸

openchannel_abort channel_id

🦋 DESCRIPTION 🦋

so openchannel_abort is a low level RPC command, iykyk — it starts an abort for the channel you point at. it rides the openchannel protocol, the one that lets you build transactions interactively (very main character energy fr fr) ✨

  • channel_id (hash) — the channel id of the channel you wanna abort. that's the one. give it here 💌

🔥 RETURN VALUE 🔥

when it slays (aka on success), you get an object back with:

  • channel_id (hash) — the channel id of the aborted channel 🫶
  • channel_canceled (boolean) — whether this is completely canceled. heads up though: there may still be remaining in-flight transactions hanging around, so don't assume it's fully done just because of this 👀
  • reason (string) — usually "Abort requested", but if it happened to fail at the same time it could be something different. surprises happen 😭

💀 ERRORS 💀

on error the returned object comes with code and message properties, and code is one of these bad boys:

  • -32602 — if the given parameters are wrong 🙈
  • -1 — catchall nonspecific error, the classic "idk something broke" 💀
  • 305 — peer is not connected 🔌
  • 311 — unknown channel id 🕵️
  • 312 — channel in an invalid state 🚫

👑 AUTHOR 👑

Lisa Neigut niftynei@gmail.com is mainly responsible. queen behavior, we love to see it 💅👑

🌈 SEE ALSO 🌈

go read these next bestie, they're all linked:

⭐ RESOURCES ⭐

main web site, the mothership: https://github.com/ElementsProject/lightning 🌐

🍓 EXAMPLES 🍓

Example 1:

Request:

$ lightning-cli openchannel_abort -k "channel_id"="channelid0111200111200111200111200111200111200111200111200111200"

{
  "id": "example:openchannel_abort#1",
  "method": "openchannel_abort",
  "params": {
    "channel_id": "channelid0111200111200111200111200111200111200111200111200111200"
  }
}

Response:

{
  "channel_id": "channelid0111200111200111200111200111200111200111200111200111200",
  "channel_canceled": false,
  "reason": "Abort requested"
}

and that's the whole page bestie, you ate that 🫶 this little love letter is from Core Lightning v26.06.9 — mwah, go abort some channels responsibly 💜✨

📦 where this page comes from