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

FreeBSD Manual Pages

  
 
  

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

NAME
       lightning-askrene-reserve -- Command for	informing askrene that you are
       trying a	path

SYNOPSIS
       askrene-reserve path

DESCRIPTION
       Command added in	v24.11.

       The  askrene-reserve RPC	command	tells askrene that a path is being at-
       tempted.	 This allows it	to take	that into account when other getroutes
       calls are made.	You should call	askrene-unreserve  after  the  attempt
       has completed (and before calling askrene-inform).

       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-unreserve(7),   lightning-
       askrene-listreservations(7)

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

EXAMPLES
       Example 1:

       Request:

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

       {
	 "id": "example:askrene-reserve#1",
	 "method": "askrene-reserve",
	 "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-reserve -k "path"='[{"short_channel_id_dir": "109x1x1/1", "amount_msat":	1250000000000},	{"short_channel_id_dir": "123x1x1/0", "amount_msat": 1250000000000}]'

       {
	 "id": "example:askrene-reserve#2",
	 "method": "askrene-reserve",
	 "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-RESERVE(7)

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

home | help