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

FreeBSD Manual Pages

  
 
  

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

NAME
       askrene-bias-channel  --	Command	to apply a manual bias to a channel in
       a layer

SYNOPSIS
       askrene-bias-channel  layer  short_channel_id_dir  bias	 [description]
       [relative]

DESCRIPTION
       Command added in	v24.11.

       The askrene-bias-channel	RPC command tells askrene to favor or disfavor
       a channel when considering it for routing.

         layer	(string): The name of the layer	to apply this bias to.
         short_channel_id_dir	(short_channel_id_dir):	 The  short channel id
	  and direction	to apply this bias to.
         bias (integer): The bias, positive being good	and negative being bad
	  (0 being no bias).  Useful values are	 +/-1  through	+/-10,	though
	  -100 through +100 are	possible values.
         description (string, optional): Description/annotation to display in
	  askrene-listlayers(7)
         relative (boolean, optional):	The bias will be added to the previous
	  value. The default is	False. (added v25.05)

RETURN VALUE
       On  success, an object containing biases	is returned. It	is an array of
       objects,	where each object contains:

         layer	(string): The name of the layer	this bias applies to.
         short_channel_id_dir (short_channel_id_dir): The  short  channel  id
	  and direction
         bias (integer): The bias (-100 to +100)
         description (string, optional): The bias (-100 to +100)

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-bias-channel -k "layer"="test_layers" "short_channel_id_dir"="109x1x1/1"	"bias"=1

       {
	 "id": "example:askrene-bias-channel#1",
	 "method": "askrene-bias-channel",
	 "params": {
	   "layer": "test_layers",
	   "short_channel_id_dir": "109x1x1/1",
	   "bias": 1
	 }
       }

       Response:

       {
	 "biases": [
	   {
	     "layer": "test_layers",
	     "short_channel_id_dir": "109x1x1/1",
	     "bias": 1
	   }
	 ]
       }

       Example 2:

       Request:

       $ lightning-cli askrene-bias-channel "test_layers" "109x1x1/1" "-5" "bigger bias"

       {
	 "id": "example:askrene-bias-channel#2",
	 "method": "askrene-bias-channel",
	 "params": [
	   "test_layers",
	   "109x1x1/1",
	   -5,
	   "bigger bias"
	 ]
       }

       Response:

       {
	 "biases": [
	   {
	     "layer": "test_layers",
	     "short_channel_id_dir": "109x1x1/1",
	     "description": "bigger bias",
	     "bias": -5
	   }
	 ]
       }

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

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

home | help