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

FreeBSD Manual Pages

  
 
  

home | help 
LIGHTNING-ASKRENE-UNRESERVE(7)			LIGHTNING-ASKRENE-UNRESERVE(7)

NAME
       lightning-askrene-unreserve  --	Command	for informing askrene that you
       are no longer trying a path

SYNOPSIS
       askrene-unreserve path

DESCRIPTION
       Command added in	v24.11.

       The askrene-unreserve RPC command tells askrene that a path attempt has
       finished: it should only	be called after	a  successful  askrene-reserve
       call.

       Note  that  additional properties inside	the path elements are ignored,
       which is	useful when used with the result of getroutes.

       •  path (array of objects):

	  •  short_channel_id_dir (short_channel_id_dir): The channel and  di-
	     rection joining these nodes.
	  •  amount_msat (msat): The amount to send into this hop.

RETURN VALUE
       On success, an empty object is returned.

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

SEE ALSO
       lightning-getroutes(7),	   lightning-askrene-reserve(7),    lightning-
       askrene-listreservations(7)

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

EXAMPLES
       Example 1:

       Request:

       $ lightning-cli askrene-unreserve -k "path"='[{"short_channel_id_dir": "109x1x1/1", "amount_msat": 1250000}, {"short_channel_id_dir": "123x1x1/0", "amount_msat": 1250001}]'

       {
	 "id": "example:askrene-unreserve#1",
	 "method": "askrene-unreserve",
	 "params": {
	   "path": [
	     {
	       "short_channel_id_dir": "109x1x1/1",
	       "amount_msat": 1250000
	     },
	     {
	       "short_channel_id_dir": "123x1x1/0",
	       "amount_msat": 1250001
	     }
	   ]
	 }
       }

       Response:

       {}

       Example 2:

       Request:

       $ lightning-cli askrene-unreserve -k "path"='[{"short_channel_id_dir": "109x1x1/1", "amount_msat": 1250000000000}, {"short_channel_id_dir": "123x1x1/0",	"amount_msat": 1250000000000}]'

       {
	 "id": "example:askrene-unreserve#2",
	 "method": "askrene-unreserve",
	 "params": {
	   "path": [
	     {
	       "short_channel_id_dir": "109x1x1/1",
	       "amount_msat": 1250000000000
	     },
	     {
	       "short_channel_id_dir": "123x1x1/0",
	       "amount_msat": 1250000000000
	     }
	   ]
	 }
       }

       Response:

       {}

Core Lightning v25.02				LIGHTNING-ASKRENE-UNRESERVE(7)

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

home | help