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

FreeBSD Manual Pages

  
 
  

home | help
LIGHTNING-ASKRENE-INFORM-CHANNEL(7)	   LIGHTNING-ASKRENE-INFORM-CHANNEL(7)

NAME
       askrene-inform-channel  -- Command to add channel capacity restrictions
       to layer

SYNOPSIS
       askrene-inform-channel layer short_channel_id_dir amount_msat inform

DESCRIPTION
       Command added in	v24.11.

       The askrene-inform-channel RPC command tells askrene about channels  we
       used  so	 it can	update its capacity estimates.	For most accuracy, you
       should remove your own reservations before calling this.	 It can	be ap-
       plied whether the current channel exists	or not.

         layer	(string): The name of the layer	to apply this change to.
         short_channel_id_dir (short_channel_id_dir): The  short  channel  id
	  and direction	to apply this change to.
         amount_msat (msat): The amount we used on the	channel
         inform   (string)  (one  of  "constrained",  "unconstrained",	 "suc-
	  ceeded"): Whether this payment passed	(implying capacity of at least
	  that amount),	failed (implying maximum capacity of one  msat	less),
	  or succeeded (implying capacity has been reduced in this direction)

RETURN VALUE
       On  success, an object containing constraints is	returned. It is	an ar-
       ray of objects, where each object contains:

         short_channel_id_dir (short_channel_id_dir): The  short  channel  id
	  and direction
         layer	(string): The name of the layer	to apply this change to.
         timestamp  (u64):  The  UNIX timestamp when this constraint was cre-
	  ated.
         maximum_msat (msat, optional): The maximum value which this  channel
	  could	pass.
         minimum_msat	(msat, optional): The minimum value which this channel
	  could	pass.

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

SEE ALSO
       lightning-getroutes(7),	lightning-askrene-disable-node(7),  lightning-
       askrene-create-channel(7),  lightning-askrene-listlayers(7), lightning-
       askrene-age(7)

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

EXAMPLES
       Example 1:

       Request:

       $ lightning-cli askrene-inform-channel -k "layer"="test_layers" "short_channel_id_dir"="0x0x1/1"	"amount_msat"=100000 "inform"="unconstrained"

       {
	 "id": "example:askrene-inform-channel#1",
	 "method": "askrene-inform-channel",
	 "params": {
	   "layer": "test_layers",
	   "short_channel_id_dir": "0x0x1/1",
	   "amount_msat": 100000,
	   "inform": "unconstrained"
	 }
       }

       Response:

       {
	 "constraints":	[
	   {
	     "layer": "test_layers",
	     "short_channel_id_dir": "0x0x1/1",
	     "timestamp": 1738000000,
	     "minimum_msat": 100000
	   }
	 ]
       }

Core Lightning v25.09			   LIGHTNING-ASKRENE-INFORM-CHANNEL(7)

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

home | help