listconfigs -- Command to list all configuration options.

SYNOPSIS

listconfigs [config]

DESCRIPTION

The listconfigs RPC command to list all configuration options, or with config only one.

• config (string, optional): Configuration option name to restrict return.

RETURN VALUE

The returned values reflect the current configuration, including showing default values (dev- options are not shown unless specified as config explicitly).

Note: as plugins can add options, not all configuration settings are listed here! The format of each entry is as follows:

• source (string): source of configuration setting (file:linenum)
• dynamic (boolean, optional): true if this option is settable via setconfig
• plugin (string, optional): set if this is from a plugin

Depending on the option type, exactly one of the following is present:

• set (boolean, optional): for simple flag options

• value_str (string, optional): for string options

• value_msat (msat, optional): for msat options

• value_int (integer, optional): for integer options

• value_bool (boolean, optional): for boolean options
  On success, an object containing configs is returned. It is an object containing:

• conf (object, optional):

  • value_str (string): Field from cmdline.
  • source (string) (always "cmdline"): Source of configuration setting.

• developer (object, optional) (added v23.08):

  • set (boolean): true if set in config or cmdline.
  • source (string): Source of configuration setting.

• clear-plugins (object, optional):

  • set (boolean): true if set in config or cmdline.
  • source (string): Source of configuration setting.

• disable-mpp (object, optional):

  • set (boolean): true if set in config or cmdline.
  • source (string): Source of configuration setting.
  • plugin (string, optional): Plugin which registered this configuration setting.

• mainnet (object, optional):

  • set (boolean): true if set in config or cmdline.
  • source (string): Source of configuration setting.

• regtest (object, optional):

  • set (boolean): true if set in config or cmdline.
  • source (string): Source of configuration setting.

• signet (object, optional):

  • set (boolean): true if set in config or cmdline.
  • source (string): Source of configuration setting.

• testnet (object, optional):

  • set (boolean): true if set in config or cmdline.
  • source (string): Source of configuration setting.

• important-plugin (object, optional):

  • values_str (array of strings):
    • (string, optional): Field from config or cmdline.
  • sources (array of strings):
    • (string, optional): Source of configuration setting.

• plugin (object, optional):

  • values_str (array of strings):
    • (string, optional): Field from config or cmdline.
  • sources (array of strings):
    • (string, optional): Source of configuration setting.

• plugin-dir (object, optional):

  • values_str (array of strings):
    • (string, optional): Field from config or cmdline.
  • sources (array of strings):
    • (string, optional): Source of configuration setting.

• lightning-dir (object, optional):

  • value_str (string): Field from config or cmdline, or default.
  • source (string): Source of configuration setting.

• network (object, optional):

  • value_str (string): Field from config or cmdline, or default (can also be changed by testnet, signet, regtest options!).
  • source (string): Source of configuration setting.

• allow-deprecated-apis (object, optional):

  • value_bool (boolean): Field from config or cmdline, or default.
  • source (string): Source of configuration setting.

• rpc-file (object, optional):

  • value_str (string): Field from config or cmdline, or default.
  • source (string): Source of configuration setting.

• disable-plugin (object, optional):

  • values_str (array of strings):
    • (string, optional): Field from config or cmdline.
  • sources (array of strings):
    • (string, optional): Source of configuration setting.

• always-use-proxy (object, optional):

  • value_bool (boolean): Field from config or cmdline, or default.
  • source (string): Source of configuration setting.

• daemon (object, optional):

  • set (boolean): true if set in config or cmdline.
  • source (string): Source of configuration setting.

• wallet (object, optional):

  • value_str (string): Field from config or cmdline, or default.
  • source (string): Source of configuration setting.

• large-channels (object, optional):

  • set (boolean): true if set in config or cmdline.
  • source (string): Source of configuration setting.

• experimental-dual-fund (object, optional):

  • set (boolean): true if set in config or cmdline.
  • source (string): Source of configuration setting.

• experimental-splicing (object, optional) (added v23.08):

  • set (boolean): true if set in config or cmdline.
  • source (string): Source of configuration setting.

• experimental-onion-messages (object, optional) deprecated in v24.08, removed after v25.02:

  • set (boolean): true if set in config or cmdline.
  • source (string): Source of configuration setting.

• experimental-offers (object, optional) deprecated in v24.11, removed after v25.05:

  • set (boolean): true if set in config or cmdline.
  • source (string): Source of configuration setting.

• experimental-shutdown-wrong-funding (object, optional):

  • set (boolean): true if set in config or cmdline.
  • source (string): Source of configuration setting.

• experimental-peer-storage (object, optional) (added v23.02):

  • set (boolean): true if set in config or cmdline.
  • source (string): Source of configuration setting.

• experimental-anchors (object, optional) (added v23.08):

  • set (boolean): true if set in config or cmdline.
  • source (string): Source of configuration setting.

• database-upgrade (object, optional):

  • value_bool (boolean): Field from config or cmdline, or default.
  • source (string): Source of configuration setting.

• rgb (object, optional):

  • value_str (hex) (always 6 characters): Field from config or cmdline, or default.
  • source (string): Source of configuration setting.

• alias (object, optional):

  • value_str (string): Field from config or cmdline, or default.
  • source (string): Source of configuration setting.

• pid-file (object, optional):

  • value_str (string): Field from config or cmdline, or default.
  • source (string): Source of configuration setting.

• ignore-fee-limits (object, optional):

  • value_bool (boolean): Field from config or cmdline, or default.
  • source (string): Source of configuration setting.

• watchtime-blocks (object, optional):

  • value_int (u32): Field from config or cmdline, or default.
  • source (string): Source of configuration setting.

• max-locktime-blocks (object, optional) deprecated in v24.05, removed after v24.11:

  • value_int (u32): Field from config or cmdline, or default.
  • source (string): Source of configuration setting.

• funding-confirms (object, optional):

  • value_int (u32): Field from config or cmdline, or default.
  • source (string): Source of configuration setting.

• cltv-delta (object, optional):

  • value_int (u32): Field from config or cmdline, or default.
  • source (string): Source of configuration setting.

• cltv-final (object, optional):

  • value_int (u32): Field from config or cmdline, or default.
  • source (string): Source of configuration setting.

• commit-time (object, optional):

  • value_int (u32): Field from config or cmdline, or default.
  • source (string): Source of configuration setting.

• fee-base (object, optional):

  • value_int (u32): Field from config or cmdline, or default.
  • source (string): Source of configuration setting.

• rescan (object, optional):

  • value_int (integer): Field from config or cmdline, or default.
  • source (string): Source of configuration setting.

• fee-per-satoshi (object, optional):

  • value_int (u32): Field from config or cmdline, or default.
  • source (string): Source of configuration setting.

• max-concurrent-htlcs (object, optional):

  • value_int (u32): Field from config or cmdline, or default.
  • source (string): Source of configuration setting.

• htlc-minimum-msat (object, optional):

  • value_msat (msat): Field from config or cmdline, or default.
  • source (string): Source of configuration setting.

• htlc-maximum-msat (object, optional):

  • value_msat (msat): Field from config or cmdline, or default.
  • source (string): Source of configuration setting.

• max-dust-htlc-exposure-msat (object, optional):

  • value_msat (msat): Field from config or cmdline, or default.
  • source (string): Source of configuration setting.

• min-capacity-sat (object, optional):

  • value_int (u64): Field from config or cmdline, or default.
  • source (string): Source of configuration setting.
  • dynamic (boolean, optional) (always true): Can this be set by setconfig().

• addr (object, optional):

  • values_str (array of strings):
    • (string, optional): Field from config or cmdline.
  • sources (array of strings):
    • (string, optional): Source of configuration setting.

• announce-addr (object, optional):

  • values_str (array of strings):
    • (string, optional): Field from config or cmdline.
  • sources (array of strings):
    • (string, optional): Source of configuration setting.

• bind-addr (object, optional):

  • values_str (array of strings):
    • (string, optional): Field from config or cmdline.
  • sources (array of strings):
    • (string, optional): Source of configuration setting.

• offline (object, optional):

  • set (boolean): true if set in config or cmdline.
  • source (string): Source of configuration setting.

• autolisten (object, optional):

  • value_bool (boolean): Field from config or cmdline, or default.
  • source (string): Source of configuration setting.

• proxy (object, optional):

  • value_str (string): Field from config or cmdline, or default.
  • source (string): Source of configuration setting.

• disable-dns (object, optional):

  • set (boolean): true if set in config or cmdline.
  • source (string): Source of configuration setting.

• announce-addr-discovered (object, optional) (added v23.02):

  • value_str (string) (one of "true", "false", "auto"): Field from config or cmdline, or default.
  • source (string): Source of configuration setting.

• announce-addr-discovered-port (object, optional) (added v23.02):

  • value_int (u32): Field from config or cmdline, or default.
  • source (string): Source of configuration setting.

• encrypted-hsm (object, optional):

  • set (boolean): true if set in config or cmdline.
  • source (string): Source of configuration setting.

• rpc-file-mode (object, optional):

  • value_str (string): Field from config or cmdline, or default.
  • source (string): Source of configuration setting.

• log-level (object, optional):

  • value_str (string): Field from config or cmdline, or default.
  • source (string): Source of configuration setting.

• log-prefix (object, optional):

  • value_str (string): Field from config or cmdline, or default.
  • source (string): Source of configuration setting.

• log-file (object, optional):

  • values_str (array of strings):
    • (string, optional): Field from config or cmdline.
  • sources (array of strings):
    • (string, optional): Source of configuration setting.

• log-timestamps (object, optional):

  • value_bool (boolean): Field from config or cmdline, or default.
  • source (string): Source of configuration setting.

• force-feerates (object, optional):

  • value_str (string): Field from config or cmdline, or default.
  • source (string): Source of configuration setting.

• subdaemon (object, optional):

  • values_str (array of strings):
    • (string, optional): Field from config or cmdline.
  • sources (array of strings):
    • (string, optional): Source of configuration setting.

• fetchinvoice-noconnect (object, optional):

  • set (boolean): true if set in config or cmdline.
  • source (string): Source of configuration setting.
  • plugin (string, optional): Plugin which registered this configuration setting. (added v23.08)

• tor-service-password (object, optional):

  • value_str (string): Field from config or cmdline, or default.
  • source (string): Source of configuration setting.

• announce-addr-dns (object, optional):

  • value_bool (boolean): Field from config or cmdline, or default.
  • source (string): Source of configuration setting.

• require-confirmed-inputs (object, optional):

  • value_bool (boolean): Field from config or cmdline, or default.
  • source (string): Source of configuration setting.

• commit-fee (object, optional):

  • value_int (u64): Field from config or cmdline, or default.
  • source (string): Source of configuration setting.

• commit-feerate-offset (object, optional):

  • value_int (u32): Field from config or cmdline, or default.
  • source (string): Source of configuration setting.

• autoconnect-seeker-peers (object, optional) (added v24.11):

  • value_int (u32): Field from config or cmdline, or default. (added v24.11)
  • source (string): Source of configuration setting. (added v24.11)

ERRORS

On failure, one of the following error codes may be returned:

• -32602: Error in given parameters or field with config name doesn't exist.

AUTHOR

Vincenzo Palazzo <[email protected]> wrote the initial version of this man page,
but many others did the hard work of actually implementing this rpc command.

SEE ALSO

lightning-getinfo(7), lightningd-config(5)

RESOURCES

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

EXAMPLES

Example 1:

Request:

lightning-cli listconfigs -k "config"="network"

{
  "id": "example:listconfigs#1",
  "method": "listconfigs",
  "params": {
    "config": "network"
  }
}

Response:

{
  "configs": {
    "network": {
      "value_str": "regtest",
      "source": "cmdline"
    }
  }
}

Example 2:

Request:

lightning-cli listconfigs -k "config"="experimental-dual-fund"

{
  "id": "example:listconfigs#2",
  "method": "listconfigs",
  "params": {
    "config": "experimental-dual-fund"
  }
}

Response:

{
  "configs": {
    "experimental-dual-fund": {
      "set": true,
      "source": "cmdline"
    }
  }
}

Example 3:

Request:

lightning-cli listconfigs

{
  "id": "example:listconfigs#3",
  "method": "listconfigs",
  "params": {}
}

Response:

{
  "configs": {
    "accept-htlc-tlv-type": {
      "values_int": [],
      "sources": []
    },
    "addr": {
      "values_str": [
        "127.0.0.1:19735"
      ],
      "sources": [
        "cmdline"
      ]
    },
    "alias": {
      "value_str": "SILENTARTIST",
      "source": "default"
    },
    "allow-deprecated-apis": {
      "value_bool": true,
      "source": "cmdline"
    },
    "always-use-proxy": {
      "value_bool": false,
      "source": "default"
    },
    "announce-addr": {
      "values_str": [],
      "sources": []
    },
    "announce-addr-discovered": {
      "value_str": "auto",
      "source": "default"
    },
    "announce-addr-discovered-port": {
      "value_int": 19846,
      "source": "default"
    },
    "autoclean-cycle": {
      "value_int": 3600,
      "source": "default",
      "plugin": "/root/lightning/plugins/autoclean",
      "dynamic": true
    },
    "autoclean-expiredinvoices-age": {
      "value_int": 300,
      "source": "/tmp/.lightning/regtest/config.setconfig:2",
      "plugin": "/root/lightning/plugins/autoclean",
      "dynamic": true
    },
    "autoconnect-seeker-peers": {
      "value_int": 0,
      "source": "cmdline"
    },
    "autolisten": {
      "value_bool": false,
      "source": "default"
    },
    "bind-addr": {
      "values_str": [],
      "sources": []
    },
    "bitcoin-datadir": {
      "value_str": "/tmp/.lightning/",
      "source": "cmdline",
      "plugin": "/root/lightning/plugins/bcli"
    },
    "bitcoin-retry-timeout": {
      "value_int": 60,
      "source": "default",
      "plugin": "/root/lightning/plugins/bcli"
    },
    "bitcoin-rpcclienttimeout": {
      "value_int": 60,
      "source": "default",
      "plugin": "/root/lightning/plugins/bcli"
    },
    "bitcoin-rpcpassword": {
      "value_str": "rpcpass",
      "source": "cmdline",
      "plugin": "/root/lightning/plugins/bcli"
    },
    "bitcoin-rpcport": {
      "value_int": 18332,
      "source": "cmdline",
      "plugin": "/root/lightning/plugins/bcli"
    },
    "bitcoin-rpcuser": {
      "value_str": "rpcuser",
      "source": "cmdline",
      "plugin": "/root/lightning/plugins/bcli"
    },
    "clear-plugins": {
      "set": false,
      "source": "default"
    },
    "cltv-delta": {
      "value_int": 6,
      "source": "cmdline"
    },
    "cltv-final": {
      "value_int": 5,
      "source": "cmdline"
    },
    "commit-fee": {
      "value_int": 100,
      "source": "default"
    },
    "commit-feerate-offset": {
      "value_int": 5,
      "source": "default"
    },
    "commit-time": {
      "value_int": 10,
      "source": "default"
    },
    "daemon": {
      "set": false,
      "source": "default"
    },
    "dev-autoclean-max-batch": {
      "value_int": 100,
      "source": "default",
      "plugin": "/root/lightning/plugins/autoclean",
      "dynamic": true
    },
    "dev-bitcoind-poll": {
      "value_int": 3,
      "source": "cmdline"
    },
    "dev-crash-after": {
      "value_str": "3600",
      "source": "cmdline"
    },
    "dev-fail-on-subdaemon-fail": {
      "set": true,
      "source": "cmdline"
    },
    "dev-fast-gossip": {
      "set": true,
      "source": "cmdline"
    },
    "dev-hsmd-no-preapprove-check": {
      "set": true,
      "source": "cmdline"
    },
    "dev-invoice-bpath-scid": {
      "set": false,
      "source": "default",
      "plugin": "/root/lightning/plugins/offers"
    },
    "dev-no-plugin-checksum": {
      "set": true,
      "source": "cmdline"
    },
    "dev-no-version-checks": {
      "set": true,
      "source": "cmdline"
    },
    "developer": {
      "set": true,
      "source": "cmdline"
    },
    "disable-dns": {
      "set": true,
      "source": "cmdline"
    },
    "disable-mpp": {
      "set": false,
      "source": "default",
      "plugin": "/root/lightning/plugins/pay"
    },
    "disable-plugin": {
      "values_str": [],
      "sources": []
    },
    "encrypted-hsm": {
      "set": false,
      "source": "default"
    },
    "experimental-dual-fund": {
      "set": true,
      "source": "cmdline"
    },
    "experimental-quiesce": {
      "set": false,
      "source": "default"
    },
    "experimental-shutdown-wrong-funding": {
      "set": false,
      "source": "default"
    },
    "experimental-splicing": {
      "set": false,
      "source": "default"
    },
    "experimental-upgrade-protocol": {
      "set": false,
      "source": "default"
    },
    "exposesecret-passphrase": {
      "value_str": "...",
      "source": "default",
      "plugin": "/root/lightning/plugins/exposesecret"
    },
    "fee-base": {
      "value_int": 1,
      "source": "default"
    },
    "fee-per-satoshi": {
      "value_int": 10,
      "source": "default"
    },
    "fetchinvoice-noconnect": {
      "set": false,
      "source": "default",
      "plugin": "/root/lightning/plugins/offers"
    },
    "funder-fund-probability": {
      "value_int": 100,
      "source": "default",
      "plugin": "/root/lightning/plugins/funder"
    },
    "funder-fuzz-percent": {
      "value_int": 0,
      "source": "default",
      "plugin": "/root/lightning/plugins/funder"
    },
    "funder-lease-requests-only": {
      "value_bool": true,
      "source": "default",
      "plugin": "/root/lightning/plugins/funder"
    },
    "funder-max-their-funding": {
      "value_str": "4294967295sat",
      "source": "default",
      "plugin": "/root/lightning/plugins/funder"
    },
    "funder-min-their-funding": {
      "value_str": "10000sat",
      "source": "default",
      "plugin": "/root/lightning/plugins/funder"
    },
    "funder-per-channel-max": {
      "value_str": "4294967295sat",
      "source": "default",
      "plugin": "/root/lightning/plugins/funder"
    },
    "funder-per-channel-min": {
      "value_str": "10000sat",
      "source": "default",
      "plugin": "/root/lightning/plugins/funder"
    },
    "funder-policy": {
      "value_str": "fixed",
      "source": "default",
      "plugin": "/root/lightning/plugins/funder"
    },
    "funder-policy-mod": {
      "value_str": "0",
      "source": "default",
      "plugin": "/root/lightning/plugins/funder"
    },
    "funder-reserve-tank": {
      "value_str": "0sat",
      "source": "default",
      "plugin": "/root/lightning/plugins/funder"
    },
    "funding-confirms": {
      "value_int": 1,
      "source": "default"
    },
    "grpc-host": {
      "value_str": "127.0.0.1",
      "source": "default",
      "plugin": "/root/lightning/plugins/cln-grpc"
    },
    "grpc-msg-buffer-size": {
      "value_int": 1024,
      "source": "default",
      "plugin": "/root/lightning/plugins/cln-grpc"
    },
    "grpc-port": {
      "value_int": 9736,
      "source": "cmdline",
      "plugin": "/root/lightning/plugins/cln-grpc"
    },
    "htlc-maximum-msat": {
      "value_msat": 18446744073709552000,
      "source": "default"
    },
    "htlc-minimum-msat": {
      "value_msat": 0,
      "source": "default"
    },
    "i-promise-to-fix-broken-api-user": {
      "values_str": [],
      "sources": []
    },
    "ignore-fee-limits": {
      "value_bool": false,
      "source": "cmdline"
    },
    "important-plugin": {
      "values_str": [],
      "sources": []
    },
    "invoices-onchain-fallback": {
      "set": false,
      "source": "default"
    },
    "lightning-dir": {
      "value_str": "/tmp/.lightning/",
      "source": "cmdline"
    },
    "log-file": {
      "values_str": [
        "-",
        "/tmp/.lightning/log"
      ],
      "sources": [
        "cmdline",
        "cmdline"
      ]
    },
    "log-level": {
      "value_str": "debug",
      "source": "cmdline"
    },
    "log-prefix": {
      "value_str": "lightningd-2 ",
      "source": "cmdline"
    },
    "log-timestamps": {
      "value_bool": true,
      "source": "default"
    },
    "mainnet": {
      "set": false,
      "source": "default"
    },
    "max-concurrent-htlcs": {
      "value_int": 483,
      "source": "default"
    },
    "max-dust-htlc-exposure-msat": {
      "value_msat": 50000000,
      "source": "default"
    },
    "min-capacity-sat": {
      "value_int": 500000,
      "source": "/tmp/.lightning/regtest/config.setconfig:3",
      "dynamic": true
    },
    "min-emergency-msat": {
      "value_msat": 25000000,
      "source": "default"
    },
    "network": {
      "value_str": "regtest",
      "source": "cmdline"
    },
    "offline": {
      "set": false,
      "source": "default"
    },
    "pid-file": {
      "value_str": "/tmp/.lightning/lightningd-regtest.pid",
      "source": "default"
    },
    "plugin": {
      "values_str": [],
      "sources": []
    },
    "plugin-dir": {
      "values_str": [],
      "sources": []
    },
    "regtest": {
      "set": false,
      "source": "default"
    },
    "renepay-debug-mcf": {
      "set": false,
      "source": "default",
      "plugin": "/root/lightning/plugins/cln-renepay"
    },
    "renepay-debug-payflow": {
      "set": false,
      "source": "default",
      "plugin": "/root/lightning/plugins/cln-renepay"
    },
    "require-confirmed-inputs": {
      "value_bool": false,
      "source": "default"
    },
    "rescan": {
      "value_int": 1,
      "source": "cmdline"
    },
    "rgb": {
      "value_str": "022d22",
      "source": "default"
    },
    "rpc-file": {
      "value_str": "lightning-rpc",
      "source": "default"
    },
    "rpc-file-mode": {
      "value_str": "0600",
      "source": "default"
    },
    "signet": {
      "set": false,
      "source": "default"
    },
    "subdaemon": {
      "values_str": [],
      "sources": []
    },
    "testnet": {
      "set": false,
      "source": "default"
    },
    "testnet4": {
      "set": false,
      "source": "default"
    },
    "watchtime-blocks": {
      "value_int": 5,
      "source": "cmdline"
    },
    "xpay-handle-pay": {
      "value_bool": false,
      "source": "default",
      "plugin": "/root/lightning/plugins/cln-xpay",
      "dynamic": true
    },
    "xpay-slow-mode": {
      "value_bool": false,
      "source": "default",
      "plugin": "/root/lightning/plugins/cln-xpay",
      "dynamic": true
    }
  }
}