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

FreeBSD Manual Pages

  
 
  

home | help 
LIGHTNING-DELFORWARD(7)				       LIGHTNING-DELFORWARD(7)

NAME
       lightning-delforward -- Command for removing a forwarding entry

SYNOPSIS
       delforward in_channel in_htlc_id	status

DESCRIPTION
       The  delforward RPC command removes a single forward from listforwards,
       using the uniquely-identifying in_channel and  in_htlc_id  (and,	 as  a
       sanity check, the status) given by that command.

       This  command  is  mainly used by the autoclean plugin (see lightningd-
       config(7)), As these database entries are only kept for your own	analy-
       sis, removing them has no effect	on the running of your node.

       •  in_channel (short_channel_id): Only the  matching  forwards  on  the
	  given	 inbound  channel  are deleted.	Note: for listforwards entries
	  without an in_htlc_id	entry (no longer created in  v22.11,  but  can
	  exist	 from  older versions),	a value	of 18446744073709551615	can be
	  used,	but then it will delete	all  entries  without  in_htlc_id  for
	  this in_channel and status.
       •  in_htlc_id  (u64):  The  unique  HTLC	 id  the sender	gave this (not
	  present if incoming channel was closed before	upgrade	to v22.11).
       •  status (string) (one of "settled",  "local_failed",  "failed"):  The
	  status  of  the  forward to delete. You cannot delete	forwards which
	  have status offered (i.e. are	currently active).

RETURN VALUE
       On success, an empty object is returned.

ERRORS
       The following errors may	be reported:

       •  1401:	The forward specified does not exist.

AUTHOR
       Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible.

SEE ALSO
       lightning-autoclean(7)

RESOURCES
       Main web	site: <https://github.com/ElementsProject/lightning>

EXAMPLES
       Example 1:

       Request:

       $ lightning-cli delforward -k "in_channel"="109x1x1" "in_htlc_id"=4 "status"="local_failed"

       {
	 "id": "example:delforward#1",
	 "method": "delforward",
	 "params": {
	   "in_channel": "109x1x1",
	   "in_htlc_id": 4,
	   "status": "local_failed"
	 }
       }

       Response:

       {}

       Example 2:

       Request:

       $ lightning-cli delforward -k "in_channel"="109x1x1" "in_htlc_id"=21 "status"="failed"

       {
	 "id": "example:delforward#2",
	 "method": "delforward",
	 "params": {
	   "in_channel": "109x1x1",
	   "in_htlc_id": 21,
	   "status": "failed"
	 }
       }

       Response:

       {}

Core Lightning v25.02				       LIGHTNING-DELFORWARD(7)

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

home | help