Skip to content

readme: fix config doc for eclair #296

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

readme: fix config doc for eclair #296

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
31f65f6
fix: correct doc for eclair config
Abdulkbk Jul 5, 2025
21c767c
fix(doc): additional config for CLN to eclair
Abdulkbk Jul 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

* Eclair: `-Declair.features.keysend=optional`
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

tested on a local eclair setup and it works 🎉


NOTE: for CLN `keysend` to work with eclair, you need to add additional config to eclair:
```
-Declair.channel.min-final-expiry-delta-blocks=N
-Declair.channel.fulfill-safety-before-timeout-blocks=M
```
where N and M are numbers, and N must be larger than M (N must be 22, CLN's default, or more)

## Getting Started

Expand Down