LIGHTNING-SIGNINVOICE(7)

📦
version 26.06.9 · 2 versions
, in nixpkgs unstable

🌸 NAME 🌸

okay so this page is all about lightning-signinvoice(7) — literally low-level invoice signing 💅 it's the deep-lore manpage bestie, and it's here to explain signinvoice in full ✨

🦋 SYNOPSIS 🦋

signinvoice invstring

💜 DESCRIPTION 💜

so this command got added in v23.02 — vintage-ish but still serving 🎀

the signinvoice RPC command signs an invoice. and here's the part where it's not like createinvoice, bestie: it does not save the invoice into the database, and because of that it does not require the preimage. no preimage, no storage, no problem 💅

  • invstring (string) — Bolt11 form, but the final signature is ignored. and lowkey only minimal sanity checks are done on it, so don't expect a full vibe check 😭

⭐ RETURN VALUE ⭐

when it works? you get an object back, containing:

  • bolt11 (string) — The bolt11 string. that's it, that's the whole payload 🫶

💀 ERRORS 💀

these error codes may show up:

  • -1 — Catchall nonspecific error. yep, the classic "something happened, don't ask me what" 🙈

👑 AUTHOR 👑

Carl Dong contact@carldong.me is mainly responsible. main character energy fr fr 🌈

🔥 SEE ALSO 🔥

🌈 RESOURCES 🌈

Main web site: https://github.com/ElementsProject/lightning — go be nosy, iykyk 🦋

🍓 EXAMPLES 🍓

✨ Example 1 ✨

Request:

$ lightning-cli signinvoice -k "invstring"="lnbcrt100n1pnt2bolt11invl010200000000bolt11invl010200000000bolt11invl010200000000bolt11invl010200000000bolt11invl010200000000bolt11invl010200000000bolt11invl010200000000bolt11invl010200000000bolt11invl010200000000bolt11invl010200000000"

{
  "id": "example:signinvoice#1",
  "method": "signinvoice",
  "params": {
    "invstring": "lnbcrt100n1pnt2bolt11invl010200000000bolt11invl010200000000bolt11invl010200000000bolt11invl010200000000bolt11invl010200000000bolt11invl010200000000bolt11invl010200000000bolt11invl010200000000bolt11invl010200000000bolt11invl010200000000"
  }
}

Response:

{
  "bolt11": "lnbcrt100n1pnt2bolt11invl060600000000bolt11invl060600000000bolt11invl060600000000bolt11invl060600000000bolt11invl060600000000bolt11invl060600000000bolt11invl060600000000bolt11invl060600000000bolt11invl060600000000bolt11invl060600000000"
}

💖 Example 2 💖

Request:

$ lightning-cli signinvoice "lnbcrt100n1pnt2bolt11invl020600000000bolt11invl020600000000bolt11invl020600000000bolt11invl020600000000bolt11invl020600000000bolt11invl020600000000bolt11invl020600000000bolt11invl020600000000bolt11invl020600000000bolt11invl020600000000"

{
  "id": "example:signinvoice#2",
  "method": "signinvoice",
  "params": [
    "lnbcrt100n1pnt2bolt11invl020600000000bolt11invl020600000000bolt11invl020600000000bolt11invl020600000000bolt11invl020600000000bolt11invl020600000000bolt11invl020600000000bolt11invl020600000000bolt11invl020600000000bolt11invl020600000000"
  ]
}

Response:

{
  "bolt11": "lnbcrt100n1pnt2bolt11invl060700000000bolt11invl060700000000bolt11invl060700000000bolt11invl060700000000bolt11invl060700000000bolt11invl060700000000bolt11invl060700000000bolt11invl060700000000bolt11invl060700000000bolt11invl060700000000"
}
ngl those bolt11 strings are long long, but that's the whole point — sign it, hand it back, no database drama 💅

and that's the page!! this lil fairy godmother of a manpage is from Core Lightning v26.06.9, LIGHTNING-SIGNINVOICE(7), mwah 💋 slay, go sign some invoices 🧚‍♀️💜

📦 where this page comes from