LIGHTNING-BKPR-E...IPTIONBYOUTPOINT(7)

💅 LIGHTNING-BKPR-E...IPTIONBYOUTPOINT(7) ✨

okay so bestie, welcome to the manual page for LIGHTNING-BKPR-E...IPTIONBYOUTPOINT(7) — yes the name is a whole mouthful, no I did not choose it, but we're gonna slay this together 🫶

---

🌸 NAME 🌸

bkpr-editdescriptionbyoutpoint — the command that lets you change the description for events with {outpoint} after they're already made. retroactive glow-up, basically 💅

---

🎀 SYNOPSIS 🎀

bkpr-editdescriptionbyoutpoint outpoint description

---

🦋 DESCRIPTION 🦋

Command added in v24.11. yes she's new-ish, she's fresh, we love a recent addition ✨

The bkpr-editdescriptionbyoutpoint RPC command updates all chain and channel events that match the {outpoint} with the provided {description}. not just one — all of the matching ones, okay? the whole squad gets the new fit 👑

• outpoint (string) — the outpoint to update the description for.
• description (string) — the description to update to.

---

💖 RETURN VALUE 💖

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

• account (string) — the account name. If the account is a channel, the channel_id.
• type (string) (one of "chain", "channel") — coin movement type.
• tag (string) — description of movement.
• credit_msat (msat) — amount credited.
• debit_msat (msat) — amount debited.
• currency (string) — human-readable bech32 part for this coin type.
• timestamp (u32) — timestamp this event was recorded by the node. For consolidated events such as onchain_fees, the most recent timestamp.
• description (string) — the description of this event.

🌈 and then it gets conditional, stay with me

If type is "chain":

• outpoint (string) — the txid:outnum for this event.
• blockheight (u32) — for chain events, blockheight this occured at.
• description (string, optional) — a description of this outpoint.
• origin (string, optional) — the account this movement originated from.
• payment_id (hex, optional) — Lightning payment identifier. For an htlc, this will be the preimage.
• txid (txid, optional) — the txid of the transaction that created this event.

If type is "onchain_fee":

• txid (txid) — the txid of the transaction that created this event.

If type is "channel":

• fees_msat (msat, optional) — amount paid in fees.
• is_rebalance (boolean, optional) — is this payment part of a rebalance.
• payment_id (hex, optional) — Lightning payment identifier. For an htlc, this will be the preimage.
• part_id (u32, optional) — counter for multi-part payments.

---

👑 AUTHOR 👑

Lisa Neigut niftynei@gmail.com is mainly responsible. ty queen 🫶

---

⭐ SEE ALSO ⭐

• lightning-bkpr-editdescriptionbypaymentid(7)
• lightning-bkpr-listaccountevents(7)
• lightning-bkpr-listincome(7)

---

🧚 RESOURCES 🧚

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

---

🔥 EXAMPLES 🔥

💜 Example 1

Request:

$ lightning-cli bkpr-editdescriptionbyoutpoint -k "outpoint"="txidbk0101010101010101010101010101010101010101010101010101010101:1" "description"="edited utxo description"

{
  "id": "example:bkpr-editdescriptionbyoutpoint#1",
  "method": "bkpr-editdescriptionbyoutpoint",
  "params": {
    "outpoint": "txidbk0101010101010101010101010101010101010101010101010101010101:1",
    "description": "edited utxo description"
  }
}

Response:

{
  "updated": [
    {
      "account": "wallet",
      "type": "chain",
      "tag": "deposit",
      "credit_msat": 200000000000,
      "debit_msat": 0,
      "currency": "bcrt",
      "outpoint": "txidbk0101010101010101010101010101010101010101010101010101010101:1",
      "timestamp": 1738510000,
      "blockheight": 110,
      "description": "edited utxo description"
    }
  ]
}

🍓 Example 2

Request:

$ lightning-cli bkpr-editdescriptionbyoutpoint -k "outpoint"="abcd020202020202020202020202020202020202020202020202020202020202:1" "description"="edited utxo description for non existing outpoint"

{
  "id": "example:bkpr-editdescriptionbyoutpoint#2",
  "method": "bkpr-editdescriptionbyoutpoint",
  "params": {
    "outpoint": "abcd020202020202020202020202020202020202020202020202020202020202:1",
    "description": "edited utxo description for non existing outpoint"
  }
}

Response:

{
  "updated": []
}

ngl bestie, that empty updated array in Example 2 is not an error — the outpoint just didn't exist, so nothing got updated. no cap, that's just what the response looks like 💀

---

🌸 okay that's the whole page, you ate that. this was Core Lightning v26.06.9 — mwah, go touch some grass now 💖✨