Skip to content

Commit 8d3e399

Browse files
committed
update readme with ldk-server info
1 parent 526eb15 commit 8d3e399

1 file changed

Lines changed: 25 additions & 1 deletion

File tree

README.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ lightning network development. It may be useful to you if you are:
1616
* LND ✅
1717
* CLN ✅
1818
* Eclair ✅️
19-
* LDK-node 🏗️
19+
* LDK-server ✅
2020

2121
See our [tracking issue](https://github.com/bitcoin-dev-project/sim-ln/issues/26)
2222
for updates on implementation support (contributions welcome!).
@@ -36,6 +36,7 @@ of the simulator uses keysend to execute payments, which must be enabled as foll
3636
* LND: `--accept-keysend`
3737
* CLN: enabled by default
3838
* Eclair: `-Declair.features.keysend=optional` (or `--features.keysend=optional` if you're using Polar)
39+
* LDK-server: enabled by default via `spontaneous_send`
3940

4041
NOTE: for CLN `keysend` to work with eclair, you need to add additional config to eclair:
4142
```
@@ -44,6 +45,11 @@ NOTE: for CLN `keysend` to work with eclair, you need to add additional config t
4445
```
4546
where N and M are numbers, and N must be larger than M (N must be 22, CLN's default, or more)
4647

48+
NOTE: ldk-server enforces a minimum final CLTV expiry of 144 blocks on inbound keysend payments.
49+
If you are sending from LND or CLN, set their final CLTV delta to at least 150:
50+
* LND: `bitcoin.timelockdelta=150` in `lnd.conf`
51+
* CLN: `cltv-final=150` in `config`
52+
4753
## Getting Started
4854

4955
Once you have all the pre-requisites installed, clone the repo:
@@ -98,6 +104,18 @@ The required access details will depend on the node implementation.
98104
"api_password": <password_to_authorize>
99105
}
100106
```
107+
* LDK-server:
108+
```
109+
{
110+
"address": <ip:port or domain:port>,
111+
"api_key": <hex_encoded_api_key>,
112+
"cert": <path_to_tls_cert>,
113+
"network": <bitcoin|testnet|signet|regtest>
114+
}
115+
```
116+
The `api_key` is the raw bytes of `~/.ldk-server/<network>/api_key` hex-encoded.
117+
Unlike other backends, ldk-server does not require an `id` field — the node's
118+
public key is fetched automatically on startup.
101119

102120
Payment activity can be simulated in two different ways:
103121
* [Random activity](#setup---random-activity): generate random activity on the `nodes` provided,
@@ -135,6 +153,12 @@ to send and receive payments when running with random activity.
135153
"base_url": "127.0.0.1:8286",
136154
"api_username": "",
137155
"api_password": "eclairpw"
156+
},
157+
{
158+
"address": "localhost:3536",
159+
"api_key": "ldk_server_hex_encoded_api_key",
160+
"cert": "/path/tls.crt",
161+
"network": "signet"
138162
}
139163
]
140164
}

0 commit comments

Comments
 (0)