|
1 | 1 | # mdkd |
2 | 2 |
|
3 | 3 | Lightning payment server built on LDK. Connects to the MoneyDevKit platform |
4 | | -for checkout management and uses LSPS4 for JIT channel liquidity. |
| 4 | +for checkout management. |
5 | 5 |
|
6 | 6 | ## Building from source |
7 | 7 |
|
@@ -139,19 +139,6 @@ checked. If neither is present the process exits with an error. |
139 | 139 | | `--password-read-only-fd N` | `MDK_HTTP_PASSWORD_READ_ONLY` | HTTP Basic Auth password granting read-only access (node info, invoice lookup). You choose this value. | |
140 | 140 | | `--webhook-secret-fd N` | `MDK_WEBHOOK_SECRET` | Hex-encoded secret for HMAC-signing outgoing webhook payloads. Must be valid hex, any length. | |
141 | 141 |
|
142 | | -#### Regtest only |
143 | | - |
144 | | -| Variable | Description | |
145 | | -|----------|-------------| |
146 | | -| `MDK_LSP_NODE_ID` | Public key of the MoneyDevKit lightning node. | |
147 | | -| `MDK_LSP_ADDRESS` | `host:port` of the MoneyDevKit lightning P2P socket. | |
148 | | -| `MDK_API_BASE_URL` | Base URL of the MoneyDevKit RPC API (e.g. `http://localhost:3900/rpc`). | |
149 | | -| `MDK_BITCOIND_RPC_HOST` | Hostname of the bitcoind RPC server. | |
150 | | -| `MDK_BITCOIND_RPC_PORT` | Port of the bitcoind RPC server. | |
151 | | -| `MDK_BITCOIND_RPC_USER` | Bitcoind RPC username. | |
152 | | -| `MDK_BITCOIND_RPC_PASSWORD` | Bitcoind RPC password. | |
153 | | -| `MDK_VSS_URL` | URL of the VSS instance (e.g. `http://localhost:8080/vss`). | |
154 | | - |
155 | 142 | ### Generating secrets |
156 | 143 |
|
157 | 144 | **MDK_ACCESS_TOKEN** -- sign in to [moneydevkit.com](https://moneydevkit.com), |
@@ -189,8 +176,6 @@ openssl rand -hex 32 |
189 | 176 | |---------|-------------------|-----| |
190 | 177 | | `bitcoin` (mainnet) | Hard-coded | Hard-coded | |
191 | 178 | | `signet` (mutinynet) | Hard-coded | Hard-coded | |
192 | | -| `regtest` | Env vars | `MDK_VSS_URL` env var | |
193 | | -| `testnet` | Not yet supported | -- | |
194 | 179 |
|
195 | 180 | ## Storage |
196 | 181 |
|
@@ -231,30 +216,6 @@ updated when the tag is the highest semver. |
231 | 216 |
|
232 | 217 | ## Local development |
233 | 218 |
|
234 | | -Enter the dev shell with `nix develop` (or use direnv). This gives you the |
235 | | -Rust toolchain, cargo-nextest, protobuf, and the `just` recipes below. |
236 | | - |
237 | 219 | ``` |
238 | | -just check # fmt + clippy + unit tests (nix-based) |
239 | | -just fmt # cargo fmt + nixfmt |
240 | | -just clippy # cargo clippy via nix |
241 | | -just unit-test # unit tests via nix |
242 | | -just test # cargo nextest (all tests) |
243 | | -just build-static # musl static binary |
244 | | -just build-image # nix docker image, loaded into local docker |
245 | | -just clean # cargo clean |
246 | | -``` |
247 | | - |
248 | | -### Running against the LSP stack |
249 | | - |
250 | | -Full local development (regtest, e2e tests) requires the |
251 | | -private LSP docker-compose stack. |
252 | | - |
253 | | -``` |
254 | | -just dev # regtest against local lightning-node stack |
255 | 220 | just dev-staging # signet against staging.moneydevkit.com |
256 | | -just e2e # full end-to-end test |
257 | 221 | ``` |
258 | | - |
259 | | -`just dev-config` writes `config.toml` and `.env` from the running |
260 | | -docker-compose stack. `just dev` calls it automatically. |
0 commit comments