aboutsummaryrefslogtreecommitdiffstats
path: root/patches/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'patches/README.md')
-rw-r--r--patches/README.md41
1 files changed, 41 insertions, 0 deletions
diff --git a/patches/README.md b/patches/README.md
new file mode 100644
index 00000000..b3bf1322
--- /dev/null
+++ b/patches/README.md
@@ -0,0 +1,41 @@
+# patches
+
+## `@asoltys+clightning-client+0.1.10.patch`
+
+Fixes the reconnect logic in `@asoltys/clightning-client` (v0.1.10) so a dropped
+cl RPC connection actually recovers.
+
+**Bug:** `reconnect()` called `this.client.connect()` on the *same* socket that
+had already emitted `error`/`close`. A destroyed socket can't be reconnected, so
+after a `cl` restart the client wedged, looping `connect ENOENT …/lightning-rpc`
+forever — spamming logs and leaking a socket+timer each time — and never
+recovered. (If `connect()` threw, `reconnectTimeout` was also left set, which
+permanently blocked every future `reconnect()`.)
+
+**Fix:** factor the socket+readline+handlers setup into `_setup()` which builds a
+**fresh** socket each (re)connection and renews `clientConnectionPromise` (so
+`call()` blocks until the reconnect is live). `reconnect()` now clears its guard
+*before* reconnecting and retries on failure.
+
+This is defense-in-depth: the app already neutralises the broken loop in
+`lib/ln.ts` (`dropClient()` tears the dead client down and the proxy makes a fresh
+`LightningClient`). This patch fixes the library itself for any path that relies
+on its own reconnect.
+
+### How to wire it in (bun)
+
+`bun patch` couldn't run in this checkout (node_modules link EEXIST), so this
+patch was generated by hand and verified to apply cleanly (`git apply --check`).
+To register it so `bun install` re-applies it, in a clean checkout:
+
+```sh
+bun patch @asoltys/clightning-client
+# copy patches/clightning-client-index.fixed.js over the printed editable
+# node_modules/@asoltys/clightning-client/index.js
+bun patch --commit node_modules/@asoltys/clightning-client
+```
+
+That writes bun's own `patches/…` file and the `patchedDependencies` entry in
+`package.json`. Alternatively, apply this patch directly in the image build:
+`git apply patches/@asoltys+clightning-client+0.1.10.patch` against the installed
+package. `clightning-client-index.fixed.js` is the full patched file for reference.