LIGHTNING-ASKRENE-INFORM-CHANNEL(7)

📦
version 26.06.9 · 2 versions
, in nixpkgs unstable

🦋 LIGHTNING-ASKRENE-INFORM-CHANNEL(7) 🦋

okay bestie, welcome to the manual page for askrene-inform-channel, which lives in section 7 of the Core Lightning manuals. this one's literally the "hey queen, here's what actually happened on this channel" command and it's lowkey iconic 💅

✨ NAME ✨

askrene-inform-channel — the command that adds channel capacity restrictions to a layer. periodt.

🎀 SYNOPSIS 🎀

askrene-inform-channel layer short_channel_id_dir amount_msat inform

💖 DESCRIPTION 💖

so, this command was added in v24.11 (yes, we've been thriving since then 🫶).

The askrene-inform-channel RPC command tells askrene about channels we used, so it can update its capacity estimates. it's giving "receipts, but for liquidity" ngl.

For most accuracy, you should remove your own reservations before calling this. like, clean up your room first, then invite guests, yk? 🧹

and the cute part: it can be applied whether the current channel exists or not. 💀 channel? never heard of her. doesn't matter, still works.

  • layer (string) — the name of the layer to apply this change to. also causes us to consider any reservations which are local to that layer (which is super useful for fake channels where layer is set in an askrene-reserve path object). 👑
  • 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", "succeeded". this is the vibe check on the payment: 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).
ngl that inform list is doing a little bit of a chaotic dance — three literal values, and the explanation describes them as passed / failed / succeeded. bestie, just copy the values exactly and you'll slay. 🔥

🌸 RETURN VALUE 🌸

On success, an object containing constraints is returned. it's an array 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 created. ⏰
  • 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. (main character energy fr fr 👑)

🌈 SEE ALSO 🌈

⭐ 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
    }
  ]
}

look at that response — clean, minimal, minimum_msat: 100000 because we told it the payment was unconstrained. ate and left no crumbs 🍓

and that's the whole page bestie! this lil masterpiece is from Core Lightning v26.06.9 — go forth and inform those channels, no cap 💜✨

📦 where this page comes from