readme: fix config doc for eclair #296
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
In this commit we correct the doc for enabling `keysend` in eclair. Note: `--features.keysend=optional` is only usefull in Polar because of how eclair docker image is built. See: https://github.com/jamaljsr/polar/blob/master/docker/eclair/docker-entrypoint.sh#L25-L35
Without these configs CLN keysend payments to eclair will fail. This is because CLN uses 22 final expiry delta which is less than eclair's default (30).
f3r10
reviewed
Jul 9, 2025
| @@ -35,7 +35,14 @@ have permission to execute commands on. Note that the current version | |||
| of the simulator uses keysend to execute payments, which must be enabled as follows: | |||
| * LND: `--accept-keysend` | |||
| * CLN: enabled by default | |||
| * Eclair: `--features.keysend=optional` | |||
There was a problem hiding this comment.
Without this flag on polar keysend is not activated. Maybe it would be better to indicate that this flag only works with polar and the -Declair.features.keysend in other cases.
| @@ -35,7 +35,14 @@ have permission to execute commands on. Note that the current version | |||
| of the simulator uses keysend to execute payments, which must be enabled as follows: | |||
| * LND: `--accept-keysend` | |||
| * CLN: enabled by default | |||
| * Eclair: `--features.keysend=optional` | |||
| * Eclair: `-Declair.features.keysend=optional` | |||
There was a problem hiding this comment.
tested on a local eclair setup and it works 🎉
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In this PR, we update the eclair config to enable keysend. Initially, we are using a config that is only applicable for running Eclair in Polar.
--features.keysend=optionalworks only in polar SEE.We also add additional configuration to enable CLN to send keysend payments to Eclair. Without
the payment will fail because CLN uses 22 for keysend while Eclair's minimum default is 30.
is explicitly required when
-Declair.channel.min-final-expiry-delta-blocksis set and must be less than it. SEE