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

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

SYNOPSIS
     askrene-bias-node layer node direction bias [description] [relative]

DESCRIPTION
     Command added in v25.12.

     The  askrene-bias-node  RPC  command tells askrene to favor or disfavor all
     outgoing or incoming channels of a node when considering them for routing.

     *	layer (string): The name of the layer to apply this bias to.
     *	node (pubkey): The node to which this bias applies.  It does not need to
	exist.
     *	direction (string): Either in or out to specify if the bias  applies  to
	incoming or outgoing channels with respect to this node.
     *	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.

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

     *	layer (string): The name of the layer this bias applies to.
     *	node (pubkey): The id of the biased node.
     *	in_bias (integer): The bias (-100 to +100) on incoming channels.
     *	out_bias (integer): The bias (-100 to +100) on outgoing channels.
     *	timestamp  (u64):  The UNIX timestamp when this bias was created or last
	updated.
     *	description (string, optional): A human readable annotation.

AUTHOR
     Lagrange lagrang3@protonmail.com is mainly responsible.

SEE ALSO
     lightning-askrene-bias-channel(7),    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-node -k "layer"="test_layers" "node"="nodeid030303030303030303030303030303030303030303030303030303030303" "direction"="out" "bias"=1

     {
       "id": "example:askrene-bias-node#1",
       "method": "askrene-bias-node",
       "params": {
	 "layer": "test_layers",
	 "node": "nodeid030303030303030303030303030303030303030303030303030303030303",
	 "direction": "out",
	 "bias": 1
       }
     }

     Response:

     {
       "node_biases": [
	 {
	   "layer": "test_layers",
	   "node": "nodeid030303030303030303030303030303030303030303030303030303030303",
	   "in_bias": 0,
	   "out_bias": 1
	 }
       ]
     }

     Example 2:

     Request:

     $ lightning-cli askrene-bias-node "test_layers" "nodeid030303030303030303030303030303030303030303030303030303030303" "out" "-5" "this node is unreliable"

     {
       "id": "example:askrene-bias-node#2",
       "method": "askrene-bias-node",
       "params": [
	 "test_layers",
	 "nodeid030303030303030303030303030303030303030303030303030303030303",
	 "out",
	 -5,
	 "this node is unreliable"
       ]
     }

     Response:

     {
       "node_biases": [
	 {
	   "layer": "test_layers",
	   "node": "nodeid030303030303030303030303030303030303030303030303030303030303",
	   "description": "this is node is unreliable",
	   "in_bias": 0,
	   "out_bias": -5
	 }
       ]
     }

Core Lightning v26.06.1 			  LIGHTNING-ASKRENE-BIAS-NODE(7)
home | help