Skip to content

Commit

Permalink
lightningd: deprecate experimental-offers option.
Browse files Browse the repository at this point in the history
Signed-off-by: Rusty Russell <[email protected]>
Changelog-Deprecated: Config: `experimental-offers` (it's now the default).
  • Loading branch information
rustyrussell authored and vincenzopalazzo committed Nov 18, 2024
1 parent 0cc52bc commit 1b41350
Show file tree
Hide file tree
Showing 9 changed files with 44 additions and 39 deletions.
4 changes: 2 additions & 2 deletions .msggen.json
Original file line number Diff line number Diff line change
Expand Up @@ -7071,7 +7071,7 @@
},
"ListConfigs.configs.experimental-offers": {
"added": "pre-v0.10.1",
"deprecated": null
"deprecated": "v24.11"
},
"ListConfigs.configs.experimental-offers.set": {
"added": "pre-v0.10.1",
Expand All @@ -7083,7 +7083,7 @@
},
"ListConfigs.configs.experimental-onion-messages": {
"added": "pre-v0.10.1",
"deprecated": null
"deprecated": "v24.08"
},
"ListConfigs.configs.experimental-onion-messages.set": {
"added": "pre-v0.10.1",
Expand Down
38 changes: 20 additions & 18 deletions cln-rpc/src/model.rs

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 8 additions & 0 deletions contrib/msggen/msggen/schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -18687,6 +18687,10 @@
}
},
"experimental-onion-messages": {
"deprecated": [
"v24.08",
"v25.02"
],
"type": "object",
"additionalProperties": false,
"required": [
Expand All @@ -18711,6 +18715,10 @@
"experimental-offers": {
"type": "object",
"additionalProperties": false,
"deprecated": [
"v24.11",
"v25.05"
],
"required": [
"set",
"source"
Expand Down
1 change: 1 addition & 0 deletions doc/developers-guide/deprecations.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ hidden: false
| decodepay | Command | v24.11 | v25.11 | Use `decode` which is more powerful (since v23.05) |
| close.tx | Field | v24.11 | v25.11 | Use txs array instead |
| close.txid | Field | v24.11 | v25.11 | Use txids array instead |
| experimental-offers | Config | v24.11 | v25.05 | Now the default |

Inevitably there are features which need to change: either to be generalized, or removed when they can no longer be supported.

Expand Down
2 changes: 0 additions & 2 deletions doc/developers-guide/plugin-development/hooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -596,8 +596,6 @@ Because this is a chained hook, the daemon expects the result to be `{'result':

### `onion_message_recv` and `onion_message_recv_secret`

> 🚧 experimental-offers only
These two hooks are almost identical, in that they are called when an onion message is received.

`onion_message_recv` is used for unsolicited messages (where the source knows that it is sending to this node), and `onion_message_recv_secret` is used for messages which use a blinded path we supplied. The latter hook will have a `pathsecret` field, the former never will.
Expand Down
11 changes: 0 additions & 11 deletions doc/getting-started/getting-started/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -492,17 +492,6 @@ Supported features can be listed with `lightningd --list-features-only`

A build _with_ `--enable-experimental-features` flag hard-codes some of below options as enabled, ignoring their command line flag. It may also add support for even more features. The safest way to determine the active configuration is by checking `listconfigs` or by looking at `our_features` (bits) in `getinfo`.

- **experimental-onion-messages**

Specifying this enables sending, forwarding and receiving onion messages, which are in draft status in the [bolt](https://github.com/lightning/bolts) specifications (PR #759). A build with `--enable-experimental-features` usually enables this via
experimental-offers, see below.

- **experimental-offers**

Specifying this enables the `offers` and `fetchinvoice` plugins and corresponding functionality, which are in draft status [bolt](https://github.com/lightning/bolts)#798 as [bolt12](https://github.com/rustyrussell/lightning-rfc/blob/guilt/offers/12-offer-encoding.md).
A build with `--enable-experimental-features` enables this permanently and usually
enables experimental-onion-messages as well.

- **fetchinvoice-noconnect**

Specifying this prevents `fetchinvoice` and `sendinvoice` from trying to connect directly to the offering node as a last resort.
Expand Down
4 changes: 0 additions & 4 deletions doc/lightningd-config.5.md
Original file line number Diff line number Diff line change
Expand Up @@ -770,10 +770,6 @@ Experimental options are subject to breakage between releases: they
are made available for advanced users who want to test proposed
features.

* **experimental-offers**

Specifying this enables `offers` functionality, which is in draft status ([bolt][bolt] #798) as [bolt12][bolt12].

* **fetchinvoice-noconnect**

Specifying this prevents `fetchinvoice`, `sendinvoice` and replying
Expand Down
8 changes: 8 additions & 0 deletions doc/schemas/lightning-listconfigs.json
Original file line number Diff line number Diff line change
Expand Up @@ -552,6 +552,10 @@
}
},
"experimental-onion-messages": {
"deprecated": [
"v24.08",
"v25.02"
],
"type": "object",
"additionalProperties": false,
"required": [
Expand All @@ -576,6 +580,10 @@
"experimental-offers": {
"type": "object",
"additionalProperties": false,
"deprecated": [
"v24.11",
"v25.05"
],
"required": [
"set",
"source"
Expand Down
7 changes: 5 additions & 2 deletions lightningd/options.c
Original file line number Diff line number Diff line change
Expand Up @@ -1312,7 +1312,10 @@ static char *opt_set_anchor_zero_fee_htlc_tx(struct lightningd *ld)

static char *opt_set_offers(struct lightningd *ld)
{
/* FIXME: Deprecate */
if (!opt_deprecated_ok(ld, "experimental-offers", NULL,
"v24.11", "v25.05"))
return "--experimental-offers has been deprecated (now the default)";

return NULL;
}

Expand Down Expand Up @@ -1499,7 +1502,7 @@ static void register_opts(struct lightningd *ld)
opt_hidden);
opt_register_early_noarg("--experimental-offers",
opt_set_offers, ld,
"EXPERIMENTAL: enable send and receive of offers");
opt_hidden);
opt_register_early_noarg("--experimental-shutdown-wrong-funding",
opt_set_shutdown_wrong_funding, ld,
"EXPERIMENTAL: allow shutdown with alternate txids");
Expand Down

0 comments on commit 1b41350

Please sign in to comment.