home | help 
LIGHTNING-BKPR-E...IPTIONBYOUTPOINT(7)	  LIGHTNING-BKPR-E...IPTIONBYOUTPOINT(7)

NAME
     bkpr-editdescriptionbyoutpoint  --  Command  to  change the description for
     events with {outpoint} after they're made

SYNOPSIS
     bkpr-editdescriptionbyoutpoint outpoint description

DESCRIPTION
     Command added in v24.11.

     The bkpr-editdescriptionbyoutpoint RPC command updates all chain and  chan-
     nel events that match the {outpoint} with the provided {description}

     *	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 is an array of ob-
     jects, 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 con-
	solidated events such as onchain_fees, the most recent timestamp.
     *	description (string): The description of this event

     If type is "chain": - outpoint (string): The txid:outnum for this event.  -
     blockheight (u32): For chain events, blockheight this occured  at.   -  de-
     scription	(string,  optional):  A  description of this outpoint.	- origin
     (string, optional): The account this  movement  originated  from.	 -  pay-
     ment_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.

SEE ALSO
     lightning-bkpr-editdescriptionbypaymentid(7),    lightning-bkpr-listaccoun-
     tevents(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": []
     }

Core Lightning v26.06.1 		  LIGHTNING-BKPR-E...IPTIONBYOUTPOINT(7)
home | help