Skip to content

Commit 6275dd3

Browse files
committed
lightningd: deprecate listconfigs direct fields.
Changelog-Deprecated: JSON-RPC: `listconfigs` direct fields, use `configs` sub-object and `set`, `value_bool`, `value_str`, `value_int`, or `value_msat` fields. Signed-off-by: Rusty Russell <[email protected]>
1 parent 8d02f33 commit 6275dd3

File tree

4 files changed

+137
-70
lines changed

4 files changed

+137
-70
lines changed

doc/lightning-listconfigs.7.md

Lines changed: 65 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -255,80 +255,80 @@ On success, an object is returned, containing:
255255
- **commit-fee** (object, optional):
256256
- **value\_int** (u64): field from config or cmdline, or default
257257
- **source** (string): source of configuration setting
258-
- **# version** (string, optional): Special field indicating the current version
259-
- **plugins** (array of objects, optional):
258+
- **# version** (string, optional): Special field indicating the current version **deprecated, removal in v24.05**
259+
- **plugins** (array of objects, optional) **deprecated, removal in v24.05**:
260260
- **path** (string): Full path of the plugin
261261
- **name** (string): short name of the plugin
262262
- **options** (object, optional): Specific options set for this plugin:
263-
- **important-plugins** (array of objects, optional):
263+
- **important-plugins** (array of objects, optional) **deprecated, removal in v24.05**:
264264
- **path** (string): Full path of the plugin
265265
- **name** (string): short name of the plugin
266266
- **options** (object, optional): Specific options set for this plugin:
267-
- **conf** (string, optional): `conf` field from cmdline, or default
268-
- **lightning-dir** (string, optional): `lightning-dir` field from config or cmdline, or default
269-
- **network** (string, optional): `network` field from config or cmdline, or default
270-
- **allow-deprecated-apis** (boolean, optional): `allow-deprecated-apis` field from config or cmdline, or default
271-
- **rpc-file** (string, optional): `rpc-file` field from config or cmdline, or default
272-
- **disable-plugin** (array of strings, optional):
267+
- **conf** (string, optional): `conf` field from cmdline, or default **deprecated, removal in v24.05**
268+
- **lightning-dir** (string, optional): `lightning-dir` field from config or cmdline, or default **deprecated, removal in v24.05**
269+
- **network** (string, optional): `network` field from config or cmdline, or default **deprecated, removal in v24.05**
270+
- **allow-deprecated-apis** (boolean, optional): `allow-deprecated-apis` field from config or cmdline, or default **deprecated, removal in v24.05**
271+
- **rpc-file** (string, optional): `rpc-file` field from config or cmdline, or default **deprecated, removal in v24.05**
272+
- **disable-plugin** (array of strings, optional) **deprecated, removal in v24.05**:
273273
- `disable-plugin` field from config or cmdline
274-
- **bookkeeper-dir** (string, optional): `bookkeeper-dir` field from config or cmdline, or default
275-
- **bookkeeper-db** (string, optional): `bookkeeper-db` field from config or cmdline, or default
276-
- **always-use-proxy** (boolean, optional): `always-use-proxy` field from config or cmdline, or default
277-
- **daemon** (boolean, optional): `daemon` field from config or cmdline, or default
278-
- **wallet** (string, optional): `wallet` field from config or cmdline default
279-
- **large-channels** (boolean, optional): `large-channels` field from config or cmdline, or default
280-
- **experimental-dual-fund** (boolean, optional): `experimental-dual-fund` field from config or cmdline, or default
281-
- **experimental-onion-messages** (boolean, optional): `experimental-onion-messages` field from config or cmdline, or default
282-
- **experimental-offers** (boolean, optional): `experimental-offers` field from config or cmdline, or default
283-
- **experimental-shutdown-wrong-funding** (boolean, optional): `experimental-shutdown-wrong-funding` field from config or cmdline, or default
284-
- **experimental-websocket-port** (u16, optional): `experimental-websocket-port` field from config or cmdline, or default
285-
- **experimental-peer-storage** (boolean, optional): `experimental-peer-storage` field from config or cmdline, or default *(added v23.02)*
286-
- **experimental-quiesce** (boolean, optional): `experimental-quiesce` field from config or cmdline, or default *(added v23.08)*
287-
- **experimental-upgrade-protocol** (boolean, optional): `experimental-upgrade-protocol` field from config or cmdline, or default *(added v23.08)*
288-
- **database-upgrade** (boolean, optional): `database-upgrade` field from config or cmdline
289-
- **rgb** (hex, optional): `rgb` field from config or cmdline, or default (always 6 characters)
290-
- **alias** (string, optional): `alias` field from config or cmdline, or default
291-
- **pid-file** (string, optional): `pid-file` field from config or cmdline, or default
292-
- **ignore-fee-limits** (boolean, optional): `ignore-fee-limits` field from config or cmdline, or default
293-
- **watchtime-blocks** (u32, optional): `watchtime-blocks` field from config or cmdline, or default
294-
- **max-locktime-blocks** (u32, optional): `max-locktime-blocks` field from config or cmdline, or default
295-
- **funding-confirms** (u32, optional): `funding-confirms` field from config or cmdline, or default
296-
- **cltv-delta** (u32, optional): `cltv-delta` field from config or cmdline, or default
297-
- **cltv-final** (u32, optional): `cltv-final` field from config or cmdline, or default
298-
- **commit-time** (u32, optional): `commit-time` field from config or cmdline, or default
299-
- **fee-base** (u32, optional): `fee-base` field from config or cmdline, or default
300-
- **rescan** (integer, optional): `rescan` field from config or cmdline, or default
301-
- **fee-per-satoshi** (u32, optional): `fee-per-satoshi` field from config or cmdline, or default
302-
- **max-concurrent-htlcs** (u32, optional): `max-concurrent-htlcs` field from config or cmdline, or default
303-
- **htlc-minimum-msat** (msat, optional): `htlc-minimum-msat` field from config or cmdline, or default
304-
- **htlc-maximum-msat** (msat, optional): `htlc-maximum-msat` field from config or cmdline, or default
305-
- **max-dust-htlc-exposure-msat** (msat, optional): `max-dust-htlc-exposure-mast` field from config or cmdline, or default
306-
- **min-capacity-sat** (u64, optional): `min-capacity-sat` field from config or cmdline, or default
307-
- **addr** (string, optional): `addr` field from config or cmdline (can be more than one)
308-
- **announce-addr** (string, optional): `announce-addr` field from config or cmdline (can be more than one)
309-
- **bind-addr** (string, optional): `bind-addr` field from config or cmdline (can be more than one)
310-
- **offline** (boolean, optional): `true` if `offline` was set in config or cmdline
311-
- **autolisten** (boolean, optional): `autolisten` field from config or cmdline, or default
312-
- **proxy** (string, optional): `proxy` field from config or cmdline, or default
313-
- **disable-dns** (boolean, optional): `true` if `disable-dns` was set in config or cmdline
274+
- **bookkeeper-dir** (string, optional): `bookkeeper-dir` field from config or cmdline, or default **deprecated, removal in v24.05**
275+
- **bookkeeper-db** (string, optional): `bookkeeper-db` field from config or cmdline, or default **deprecated, removal in v24.05**
276+
- **always-use-proxy** (boolean, optional): `always-use-proxy` field from config or cmdline, or default **deprecated, removal in v24.05**
277+
- **daemon** (boolean, optional): `daemon` field from config or cmdline, or default **deprecated, removal in v24.05**
278+
- **wallet** (string, optional): `wallet` field from config or cmdline default **deprecated, removal in v24.05**
279+
- **large-channels** (boolean, optional): `large-channels` field from config or cmdline, or default **deprecated, removal in v24.05**
280+
- **experimental-dual-fund** (boolean, optional): `experimental-dual-fund` field from config or cmdline, or default **deprecated, removal in v24.05**
281+
- **experimental-onion-messages** (boolean, optional): `experimental-onion-messages` field from config or cmdline, or default **deprecated, removal in v24.05**
282+
- **experimental-offers** (boolean, optional): `experimental-offers` field from config or cmdline, or default **deprecated, removal in v24.05**
283+
- **experimental-shutdown-wrong-funding** (boolean, optional): `experimental-shutdown-wrong-funding` field from config or cmdline, or default **deprecated, removal in v24.05**
284+
- **experimental-websocket-port** (u16, optional): `experimental-websocket-port` field from config or cmdline, or default **deprecated, removal in v24.05**
285+
- **experimental-peer-storage** (boolean, optional): `experimental-peer-storage` field from config or cmdline, or default **deprecated, removal in v24.05** *(added v23.02)*
286+
- **experimental-quiesce** (boolean, optional): `experimental-quiesce` field from config or cmdline, or default **deprecated, removal in v24.05** *(added v23.08)*
287+
- **experimental-upgrade-protocol** (boolean, optional): `experimental-upgrade-protocol` field from config or cmdline, or default **deprecated, removal in v24.05** *(added v23.08)*
288+
- **database-upgrade** (boolean, optional): `database-upgrade` field from config or cmdline **deprecated, removal in v24.05**
289+
- **rgb** (hex, optional): `rgb` field from config or cmdline, or default (always 6 characters) **deprecated, removal in v24.05**
290+
- **alias** (string, optional): `alias` field from config or cmdline, or default **deprecated, removal in v24.05**
291+
- **pid-file** (string, optional): `pid-file` field from config or cmdline, or default **deprecated, removal in v24.05**
292+
- **ignore-fee-limits** (boolean, optional): `ignore-fee-limits` field from config or cmdline, or default **deprecated, removal in v24.05**
293+
- **watchtime-blocks** (u32, optional): `watchtime-blocks` field from config or cmdline, or default **deprecated, removal in v24.05**
294+
- **max-locktime-blocks** (u32, optional): `max-locktime-blocks` field from config or cmdline, or default **deprecated, removal in v24.05**
295+
- **funding-confirms** (u32, optional): `funding-confirms` field from config or cmdline, or default **deprecated, removal in v24.05**
296+
- **cltv-delta** (u32, optional): `cltv-delta` field from config or cmdline, or default **deprecated, removal in v24.05**
297+
- **cltv-final** (u32, optional): `cltv-final` field from config or cmdline, or default **deprecated, removal in v24.05**
298+
- **commit-time** (u32, optional): `commit-time` field from config or cmdline, or default **deprecated, removal in v24.05**
299+
- **fee-base** (u32, optional): `fee-base` field from config or cmdline, or default **deprecated, removal in v24.05**
300+
- **rescan** (integer, optional): `rescan` field from config or cmdline, or default **deprecated, removal in v24.05**
301+
- **fee-per-satoshi** (u32, optional): `fee-per-satoshi` field from config or cmdline, or default **deprecated, removal in v24.05**
302+
- **max-concurrent-htlcs** (u32, optional): `max-concurrent-htlcs` field from config or cmdline, or default **deprecated, removal in v24.05**
303+
- **htlc-minimum-msat** (msat, optional): `htlc-minimum-msat` field from config or cmdline, or default **deprecated, removal in v24.05**
304+
- **htlc-maximum-msat** (msat, optional): `htlc-maximum-msat` field from config or cmdline, or default **deprecated, removal in v24.05**
305+
- **max-dust-htlc-exposure-msat** (msat, optional): `max-dust-htlc-exposure-mast` field from config or cmdline, or default **deprecated, removal in v24.05**
306+
- **min-capacity-sat** (u64, optional): `min-capacity-sat` field from config or cmdline, or default **deprecated, removal in v24.05**
307+
- **addr** (string, optional): `addr` field from config or cmdline (can be more than one) **deprecated, removal in v24.05**
308+
- **announce-addr** (string, optional): `announce-addr` field from config or cmdline (can be more than one) **deprecated, removal in v24.05**
309+
- **bind-addr** (string, optional): `bind-addr` field from config or cmdline (can be more than one) **deprecated, removal in v24.05**
310+
- **offline** (boolean, optional): `true` if `offline` was set in config or cmdline **deprecated, removal in v24.05**
311+
- **autolisten** (boolean, optional): `autolisten` field from config or cmdline, or default **deprecated, removal in v24.05**
312+
- **proxy** (string, optional): `proxy` field from config or cmdline, or default **deprecated, removal in v24.05**
313+
- **disable-dns** (boolean, optional): `true` if `disable-dns` was set in config or cmdline **deprecated, removal in v24.05**
314314
- **disable-ip-discovery** (boolean, optional): `true` if `disable-ip-discovery` was set in config or cmdline **deprecated, removal in v23.11**
315-
- **announce-addr-discovered** (string, optional): `true`/`false`/`auto` depending on how `announce-addr-discovered` was set in config or cmdline *(added v23.02)*
316-
- **announce-addr-discovered-port** (integer, optional): Sets the announced TCP port for dynamically discovered IPs. *(added v23.02)*
317-
- **encrypted-hsm** (boolean, optional): `true` if `encrypted-hsm` was set in config or cmdline
318-
- **rpc-file-mode** (string, optional): `rpc-file-mode` field from config or cmdline, or default
319-
- **log-level** (string, optional): `log-level` field from config or cmdline, or default
320-
- **log-prefix** (string, optional): `log-prefix` field from config or cmdline, or default
321-
- **log-file** (string, optional): `log-file` field from config or cmdline, or default
322-
- **log-timestamps** (boolean, optional): `log-timestamps` field from config or cmdline, or default
323-
- **force-feerates** (string, optional): force-feerate configuration setting, if any
324-
- **subdaemon** (string, optional): `subdaemon` fields from config or cmdline if any (can be more than one)
325-
- **fetchinvoice-noconnect** (boolean, optional): `fetchinvoice-noconnect` fields from config or cmdline, or default
315+
- **announce-addr-discovered** (string, optional): `true`/`false`/`auto` depending on how `announce-addr-discovered` was set in config or cmdline **deprecated, removal in v24.05** *(added v23.02)*
316+
- **announce-addr-discovered-port** (integer, optional): Sets the announced TCP port for dynamically discovered IPs. **deprecated, removal in v24.05** *(added v23.02)*
317+
- **encrypted-hsm** (boolean, optional): `true` if `encrypted-hsm` was set in config or cmdline **deprecated, removal in v24.05**
318+
- **rpc-file-mode** (string, optional): `rpc-file-mode` field from config or cmdline, or default **deprecated, removal in v24.05**
319+
- **log-level** (string, optional): `log-level` field from config or cmdline, or default **deprecated, removal in v24.05**
320+
- **log-prefix** (string, optional): `log-prefix` field from config or cmdline, or default **deprecated, removal in v24.05**
321+
- **log-file** (string, optional): `log-file` field from config or cmdline, or default **deprecated, removal in v24.05**
322+
- **log-timestamps** (boolean, optional): `log-timestamps` field from config or cmdline, or default **deprecated, removal in v24.05**
323+
- **force-feerates** (string, optional): force-feerate configuration setting, if any **deprecated, removal in v24.05**
324+
- **subdaemon** (string, optional): `subdaemon` fields from config or cmdline if any (can be more than one) **deprecated, removal in v24.05**
325+
- **fetchinvoice-noconnect** (boolean, optional): `fetchinvoice-noconnect` fields from config or cmdline, or default **deprecated, removal in v24.05**
326326
- **accept-htlc-tlv-types** (string, optional): `accept-htlc-tlv-types` field from config or cmdline, or not present **deprecated, removal in v24.05**
327-
- **tor-service-password** (string, optional): `tor-service-password` field from config or cmdline, if any
328-
- **dev-allowdustreserve** (boolean, optional): Whether we allow setting dust reserves
327+
- **tor-service-password** (string, optional): `tor-service-password` field from config or cmdline, if any **deprecated, removal in v24.05**
328+
- **dev-allowdustreserve** (boolean, optional): Whether we allow setting dust reserves **deprecated, removal in v24.05**
329329
- **announce-addr-dns** (boolean, optional): Whether we put DNS entries into node\_announcement **deprecated, removal in v24.05** *(added v22.11.1)*
330-
- **require-confirmed-inputs** (boolean, optional): Request peers to only send confirmed inputs (dual-fund only)
331-
- **commit-fee** (u64, optional): The percentage of the 6-block fee estimate to use for commitment transactions *(added v23.05)*
330+
- **require-confirmed-inputs** (boolean, optional): Request peers to only send confirmed inputs (dual-fund only) **deprecated, removal in v24.05**
331+
- **commit-fee** (u64, optional): The percentage of the 6-block fee estimate to use for commitment transactions **deprecated, removal in v24.05** *(added v23.05)*
332332

333333
[comment]: # (GENERATE-FROM-SCHEMA-END)
334334

@@ -446,4 +446,4 @@ RESOURCES
446446

447447
Main web site: <https://github.com/ElementsProject/lightning>
448448

449-
[comment]: # ( SHA256STAMP:a3d32b74eb78b014e39ea85c19b3366e0468087ae44da633e9d5a194d2fe11b6)
449+
[comment]: # ( SHA256STAMP:1702f7c62fe10d63612fbbf56eeaf043cdfef6fa874d4fdbdcb81bbbbe5c98d8)

0 commit comments

Comments
 (0)