Skip to content

Commit 4b3295e

Browse files
Clean up README for external audience
- Remove LSPS4/JIT channel mention from description - Remove regtest-only env vars section - Remove regtest and testnet from supported networks - Simplify local dev section to just staging
1 parent 6de70ad commit 4b3295e

1 file changed

Lines changed: 1 addition & 40 deletions

File tree

README.md

Lines changed: 1 addition & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# mdkd
22

33
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.
55

66
## Building from source
77

@@ -139,19 +139,6 @@ checked. If neither is present the process exits with an error.
139139
| `--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. |
140140
| `--webhook-secret-fd N` | `MDK_WEBHOOK_SECRET` | Hex-encoded secret for HMAC-signing outgoing webhook payloads. Must be valid hex, any length. |
141141

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-
155142
### Generating secrets
156143

157144
**MDK_ACCESS_TOKEN** -- sign in to [moneydevkit.com](https://moneydevkit.com),
@@ -189,8 +176,6 @@ openssl rand -hex 32
189176
|---------|-------------------|-----|
190177
| `bitcoin` (mainnet) | Hard-coded | Hard-coded |
191178
| `signet` (mutinynet) | Hard-coded | Hard-coded |
192-
| `regtest` | Env vars | `MDK_VSS_URL` env var |
193-
| `testnet` | Not yet supported | -- |
194179

195180
## Storage
196181

@@ -231,30 +216,6 @@ updated when the tag is the highest semver.
231216

232217
## Local development
233218

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-
237219
```
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
255220
just dev-staging # signet against staging.moneydevkit.com
256-
just e2e # full end-to-end test
257221
```
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

Comments
 (0)