LIGHTNING-BKPR-INSPECT(7)

πŸ“¦
version 26.06.9 Β· 2 versions
, in nixpkgs unstable

πŸ’– LIGHTNING-BKPR-INSPECT(7) πŸ’–

okay so this is the lightning-bkpr-inspect page, bestie β€” yes the name at the top is all shouty caps but we're keeping it cute and keeping every single fact, no cap ✨


🌸 NAME 🌸

bkpr-inspect β€” the command that shows you the onchain footprint of a channel πŸ‘£πŸ’…


πŸ¦‹ SYNOPSIS πŸ¦‹

bkpr-inspect account

✨ DESCRIPTION ✨

The bkpr-inspect RPC command lists all known on-chain transactions and the associated events for the account you hand it. It's literally the glow-up inspection montage for your channel πŸŽ€

It's useful for inspecting unilateral closes for a given channel account β€” iykyk, that's when you really wanna see what went down.

⚠️ Heads up bestie: this is only valid for channel accounts. Not a channel account? Not your moment, sorry 😭
  • account (string) β€” the channel account to inspect. That's the one and only thing you pass in 🫢

πŸ‘‘ RETURN VALUE πŸ‘‘

On success, an object containing txs is returned. It's an array of objects, and each object contains:

  • txid (txid) β€” transaction id πŸ”₯
  • fees_paid_msat (msat) β€” amount paid in sats for this tx πŸ’Έ
  • outputs (array of objects) β€” the outputs, and each one has:
    • account (string) β€” account this output affected 🎯
    • outnum (u32) β€” index of output πŸ”’
    • output_value_msat (msat) β€” value of the output πŸ’°
    • currency (string) β€” human-readable bech32 part for this coin type πŸͺ™
    • credit_msat (msat, optional) β€” amount credited to account βž•
    • debit_msat (msat, optional) β€” amount debited from account βž–
    • originating_account (string, optional) β€” account this output originated from 🌱
    • output_tag (string, optional) β€” description of output creation event 🏷️
    • spend_tag (string, optional) β€” description of output spend event πŸ›οΈ
    • spending_txid (txid, optional) β€” transaction this output was spent in πŸ”—
    • payment_id (hex, optional) β€” Lightning payment identifier. For an htlc, this will be the preimage 🧚
  • blockheight (u32, optional) β€” blockheight of transaction 🧱

🌈 AUTHOR 🌈

Lisa Neigut niftynei@gmail.com is mainly responsible. giving main character energy fr fr πŸ‘‘


πŸ’œ SEE ALSO πŸ’œ


⭐ RESOURCES ⭐

Main web site: https://github.com/ElementsProject/lightning β€” go lurk, it's iconic πŸ¦‹


πŸ“ EXAMPLES πŸ“

Example 1:

Request:

$ lightning-cli bkpr-inspect -k "account"="channelid0230200230200230200230200230200230200230200230200230200"

{
  "id": "example:bkpr-inspect#1",
  "method": "bkpr-inspect",
  "params": {
    "account": "channelid0230200230200230200230200230200230200230200230200230200"
  }
}

Response:

{
  "txs": [
    {
      "txid": "channeltxid230200230200230200230200230200230200230200230200230200",
      "blockheight": 123,
      "fees_paid_msat": 5020000,
      "outputs": [
        {
          "account": "channelid0230200230200230200230200230200230200230200230200230200",
          "outnum": 1,
          "output_tag": "channel_open",
          "output_value_msat": 1000000000,
          "credit_msat": 1000000000,
          "currency": "bcrt"
        }
      ]
    }
  ]
}

and that's the whole page, bestie β€” you ate that πŸ’…βœ¨

this lil guide ships with Core Lightning v26.06.9, so go forth and inspect those channels, mwah πŸ’–πŸŽ€πŸ¦‹

πŸ“¦ where this page comes from