Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help 
LIGHTNING-BKPR-...PTIONBYPAYMENTID(7)	 LIGHTNING-BKPR-...PTIONBYPAYMENTID(7)

NAME
       lightning-bkpr-editdescriptionbypaymentid  -- Command to	change the de-
       scription for events with {payment_id} after they're made

SYNOPSIS
       bkpr-editdescriptionbypaymentid payment_id description

DESCRIPTION
       The bkpr-editdescriptionbypaymentid RPC command updates all  chain  and
       channel	events that match the {payment_id} with	the provided {descrip-
       tion}

       •  payment_id (string): The payment hash	(payment_id) to	update the de-
	  scription for.
       •  description (string):	The description	to update to

RETURN VALUE
       On success, an object containing	updated	is returned. It	is 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

       If  type	 is  "chain":  -  outpoint  (string): The txid:outnum for this
       event.  - blockheight (u32): For	chain events, blockheight this occured
       at.  - 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.

SEE ALSO
       lightning-bkpr-editdescriptionbyoutpoint(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-editdescriptionbypaymentid -k "payment_id"="paymentid0000202020202020202020202020202020202020202020202020202" "description"="edited	invoice	description from description send some sats l2 to l3"

       {
	 "id": "example:bkpr-editdescriptionbypaymentid#1",
	 "method": "bkpr-editdescriptionbypaymentid",
	 "params": {
	   "payment_id": "paymentid0000202020202020202020202020202020202020202020202020202",
	   "description": "edited invoice description from description send some sats l2 to l3"
	 }
       }

       Response:

       {
	 "updated": [
	   {
	     "account":	"channelid0230000230000230000230000230000230000230000230000230000",
	     "type": "channel",
	     "tag": "invoice",
	     "credit_msat": 500000000,
	     "debit_msat": 0,
	     "currency": "bcrt",
	     "payment_id": "paymentid0000202020202020202020202020202020202020202020202020202",
	     "part_id":	0,
	     "timestamp": 1738520000,
	     "description": "edited invoice description	from description send some sats	l2 to l3",
	     "is_rebalance": false
	   }
	 ]
       }

       Example 2:

       Request:

       $ lightning-cli bkpr-editdescriptionbypaymentid -k "payment_id"="c000010101010101010101010101010101010101010101010101010101010101" "description"="edited	invoice	description for	non existing payment id"

       {
	 "id": "example:bkpr-editdescriptionbypaymentid#2",
	 "method": "bkpr-editdescriptionbypaymentid",
	 "params": {
	   "payment_id": "c000010101010101010101010101010101010101010101010101010101010101",
	   "description": "edited invoice description for non existing payment id"
	 }
       }

       Response:

       {
	 "updated": []
       }

Core Lightning v25.02			 LIGHTNING-BKPR-...PTIONBYPAYMENTID(7)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=lightning-bkpr-editdescriptionbypaymentid&sektion=7&manpath=FreeBSD+Ports+14.3.quarterly>

home | help