LIGHTNING-ASKRENE-BIAS-NODE(7)

📦
version 26.06.9 · 2 versions
, in nixpkgs unstable

💅 NAME 💅

okay so this is the manual for lightning-askrene-bias-node — the page is LIGHTNING-ASKRENE-BIAS-NODE(7) bestie, and it's literally the command that slaps a manual bias on a node inside a layer. That's it. That's the whole vibe. 🎀

✨ SYNOPSIS ✨

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

🦋 DESCRIPTION 🦋

So this command was added in v25.12 (yes, it's giving baby-of-the-family energy 🌸).

askrene-bias-node is the RPC command that tells askrene to favor or disfavor all the outgoing or incoming channels of a node when it's out here considering them for routing. Basically you're telling the router "hey girl, this one's a queen" or "hmm, not this one". 👑

Here's the rundown on the arguments, no cap:

  • layer (string) — the name of the layer you're applying this bias to.
  • node (pubkey) — the node this bias applies to. It does not need to exist, so don't even worry about it bestie 🫶.
  • direction (string) — either in or out, to specify if the bias applies to incoming or outgoing channels with respect to this node. Pick a side, main character.
  • bias (integer) — the bias itself. Positive is good, negative is bad, and 0 is literally no bias at all. Useful values are +/-1 through +/-10, though -100 through +100 are possible values. So like, you can go to -100, it's just a lot. 😭
  • description (string, optional) — a description/annotation to display in askrene-listlayers(7). Cute lil label, we love a paper trail ✨.
  • relative (boolean, optional) — the bias will be added to the previous value. The default is False. Lowkey important, highkey useful.

🌈 RETURN VALUE 🌈

When it works (and it will 💅), an object containing node_biases comes back. It's an array of objects, and every single object in there 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 for when this bias was created or last updated. Time-stamped, iconic. ⏰
  • description (string, optional) — a human readable annotation.

🧚 AUTHOR 🧚

Lagrange lagrang3@protonmail.com is mainly responsible. Give her her flowers fr fr 💐.

🔥 SEE ALSO 🔥

⭐ 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
    }
  ]
}
ngl bestie, peep that "this is node is unreliable" — that's exactly how it's printed in the original, so we're keeping it character for character. Not me fixing it, no ma'am 🙈.

that's the whole page, bestie!! 💖 this was Core Lightning v26.06.9, page LIGHTNING-ASKRENE-BIAS-NODE(7) — go forth and bias responsibly, mwah 🎀✨💜

📦 where this page comes from