LIGHTNING-ASKRENE-UNRESERVE(7)

📦
version 26.06.9 · 2 versions
, in nixpkgs unstable

💅 lightning-askrene-unreserve(7) — the "k, I'm done trying that path" page

okay so bestie, this is lightning-askrene-unreserve, a page from the Core Lightning manual fam (section 7, RPC-adjacent vibes). it's short, it's sweet, and it's literally just you telling askrene "hey girl, that path attempt? finished. you can let go now." 🫶

✨ NAME ✨

askrene-unreserve — the command for telling askrene that you are no longer trying a path. that's it, that's the whole personality. 🎀

🦋 SYNOPSIS 🦋

askrene-unreserve path

🌸 DESCRIPTION 🌸

okay so first things first: this command was added in v24.11. mark your calendars, note the version, it matters. ✨

The askrene-unreserve RPC command tells askrene that a path attempt has finished. the vibe check here is timing, bestie: it should only be called after a successful askrene-reserve call. no reserving, no unreserving. that's the rule. 💅

ngl this is the important bit: it should only be called after a successful askrene-reserve call. like, that's not optional, that's the whole contract. 😭

Also, iconic behaviour alert: any additional properties inside the path elements are ignored. which is lowkey super useful when you're feeding it the result of getroutes — you don't have to hand-pick things out, it just shrugs off the extras. main character energy fr fr. 👑

so, the path param is an array of objects, and each object looks like this:

  • path (array of objects):
    • short_channel_id_dir (short_channel_id_dir): the channel and direction joining these nodes.
    • amount_msat (msat): the amount to send into this hop.
    • layer (string, optional): the layer to restrict this reservation to — highkey useful for fake channels. (added v25.12) ⭐

💖 RETURN VALUE 💖

On success, an empty object is returned. that's it. {}. the most minimalist slay. 🎀

🌈 AUTHOR 🌈

Rusty Russell rusty@rustcorp.com.au is mainly responsible. thank you king 🫶

🔥 SEE ALSO 🔥

like, read the whole askrene friend group, they're all connected iykyk 💜

🧚 RESOURCES 🧚

Main web site: https://github.com/ElementsProject/lightning — go be nosy, it's a good time 🌸

💀 EXAMPLES 💀

Example 1:

Request:

$ lightning-cli askrene-unreserve -k "path"='[{"short_channel_id_dir": "109x1x1/1", "amount_msat": 1250000}, {"short_channel_id_dir": "123x1x1/0", "amount_msat": 1250001}]'
{
  "id": "example:askrene-unreserve#1",
  "method": "askrene-unreserve",
  "params": {
    "path": [
      {
        "short_channel_id_dir": "109x1x1/1",
        "amount_msat": 1250000
      },
      {
        "short_channel_id_dir": "123x1x1/0",
        "amount_msat": 1250001
      }
    ]
  }
}

Response:

{}

Example 2:

Request:

$ lightning-cli askrene-unreserve -k "path"='[{"short_channel_id_dir": "109x1x1/1", "amount_msat": 1250000000000}, {"short_channel_id_dir": "123x1x1/0", "amount_msat": 1250000000000}]'
{
  "id": "example:askrene-unreserve#2",
  "method": "askrene-unreserve",
  "params": {
    "path": [
      {
        "short_channel_id_dir": "109x1x1/1",
        "amount_msat": 1250000000000
      },
      {
        "short_channel_id_dir": "123x1x1/0",
        "amount_msat": 1250000000000
      }
    ]
  }
}

Response:

{}

and that's the whole page bestie, go forth and unreserve responsibly 💅

this has been LIGHTNING-ASKRENE-UNRESERVE(7) from Core Lightning v26.06.9 — mwah, catch you in the next manpage 🎀✨

📦 where this page comes from