LIGHTNING-ENABLEOFFER(7)

πŸ“¦
version 26.06.9 Β· 2 versions
, in nixpkgs unstable

πŸ’… LIGHTNING-ENABLEOFFER(7)

ok so bestie, welcome to the glow-up era of this lil page β€” it's the manual for lightning-enableoffer, and yes the name is a mouthful, we're coping 🫢


✨ NAME ✨

enableoffer β€” the command that un-disables your offer, i.e. the "jk, come back πŸ₯Ί" of offers.


πŸŽ€ SYNOPSIS πŸŽ€

enableoffer offer_id

🌸 DESCRIPTION 🌸

okay so first thing: this command was added in v24.08. mark your calendars, she's new-ish πŸ’–

The enableoffer RPC command enables an offer, after it has been disabled. That's it. That's the whole vibe. You had an offer, you hit the off switch, now you want it back on β€” this is the button.

  • offer_id (hash) β€” the id we use to identify this offer. it's the little name tag your offer wears so we know which one you mean πŸ’…

πŸ¦‹ RETURN VALUE πŸ¦‹

note: the returned object is the same format as listoffers. On success, an object is returned, containing:
  • offer_id (hash) β€” the merkle hash of the offer. very demure, very merkle.
  • active (boolean) (always true) β€” whether the offer can produce invoices/payments. and bestie, it's always true here, that's literally the point of the command πŸ₯³
  • single_use (boolean) β€” whether the offer is disabled after first successful use.
  • force_paths (boolean) β€” True if fronting_nodes (or the payment-fronting-node configuration entry) is set: implies any invoice issued for this offer must use a subset of the same blinded paths. (added v26.04)
  • bolt12 (string) β€” the bolt12 string representing this offer. the iconic long string, she's back ✨
  • used (boolean) β€” whether the offer has had an invoice paid / payment made.
  • description (string, optional) β€” the user-specified bolt 12 description. (added v26.04)
  • label (string, optional) β€” the label provided when offer was created.

😭 ERRORS 😭

on failure, one of the following error codes may be returned β€” read these, they're your group chat receipts:
  • -32602 β€” Error in given parameters. check ur args bestie πŸ’€
  • 1006 β€” offer already enabled. she's already up, no need to do all that πŸ™ˆ

πŸ‘‘ AUTHOR πŸ‘‘

Rusty Russell rusty@rustcorp.com.au is mainly responsible. (the main character, tbh πŸ”₯)


🌈 SEE ALSO 🌈

lightning-offer(7), lightning-disableoffer(7), lightning-listoffers(7)


🧚 RESOURCES 🧚

Main web site: https://github.com/ElementsProject/lightning


⭐ EXAMPLES ⭐

Example 1:

Request:

$ lightning-cli enableoffer -k "offer_id"="offeridl23000002300000230000023000002300000230000023000002300000"

{
  "id": "example:enableoffer#1",
  "method": "enableoffer",
  "params": {
    "offer_id": "offeridl23000002300000230000023000002300000230000023000002300000"
  }
}

Response:

{
  "offer_id": "offeridl23000002300000230000023000002300000230000002300000",
  "active": true,
  "single_use": false,
  "bolt12": "lno1qgsq000bolt230002300023000230002300023000230002300023000230002300023000230002300023000230002300023000230002300023000230002300023000",
  "description": "Movie ticket",
  "used": false
}

aaand that's the whole page, bestie πŸŽ€ ok bye, this was LIGHTNING-ENABLEOFFER(7) from Core Lightning v26.06.9 β€” mwah, go enable some offers, ily πŸ’œπŸ¦‹πŸ“

πŸ“¦ where this page comes from