mirror of
https://github.com/ACINQ/eclair.git
synced 2025-03-01 17:06:59 +01:00
Created new files for pages that were in the wiki, but not already in the docs directory. Also made following fixes to README.md and existing files in the docs directory: * update bolt links to avoid redirect * link to logging guide from logging section (README.md) * fixed typo in Backup section and capitalization of Bitcoin Core (README.md) * Alice does not need trampoline feature enabled (TrampolinePayments.md) * link to 2021 edition of Trampoline PR (TrampolinePayments.md) * fixed API examples and removed quotes from password (API.md) * use --nodeIds for sendtoroute examples (TrampolinePayments.md and MultipartPayments.md) * update CLI example 3 to use jq (Usage.md) * fix typo in docs/FAQ.md * updated Guide.md to point to all pages that are guides
53 lines
No EOL
1.7 KiB
Markdown
53 lines
No EOL
1.7 KiB
Markdown
# Customize Features
|
|
|
|
Eclair ships with a set of features that are activated by default, and some experimental or optional features that can be activated by users.
|
|
The list of supported features can be found in the [reference configuration](https://github.com/ACINQ/eclair/blob/master/eclair-core/src/main/resources/reference.conf).
|
|
|
|
To enable a non-default feature, you simply need to add the following to your `eclair.conf`:
|
|
|
|
```conf
|
|
eclair.features {
|
|
official_feature_name = optional|mandatory
|
|
}
|
|
```
|
|
|
|
For example, to activate `option_static_remotekey`:
|
|
|
|
```conf
|
|
eclair.features {
|
|
option_static_remotekey = optional
|
|
}
|
|
```
|
|
|
|
Note that you can also disable some default features:
|
|
|
|
```conf
|
|
eclair.features {
|
|
initial_routing_sync = disabled
|
|
}
|
|
```
|
|
|
|
It's usually risky to activate non-default features or disable default features: make sure you fully understand a feature (and the current implementation status, detailed in the release notes) before doing so.
|
|
|
|
Eclair supports per-peer features. Suppose you are connected to Alice and Bob, you can use a different set of features with Alice than the one you use with Bob. When experimenting with non-default features, we recommend using this to scope the peers you want to experiment with.
|
|
|
|
This is done with the `override-features` configuration parameter in your `eclair.conf`:
|
|
|
|
```conf
|
|
eclair.override-features = [
|
|
{
|
|
nodeId = "03864ef025fde8fb587d989186ce6a4a186895ee44a926bfc370e2c366597a3f8f"
|
|
features {
|
|
initial_routing_sync = disabled
|
|
option_static_remotekey = optional
|
|
}
|
|
},
|
|
{
|
|
nodeId = "<another nodeId>"
|
|
features {
|
|
option_static_remotekey = optional
|
|
option_support_large_channel = optional
|
|
}
|
|
},
|
|
]
|
|
``` |