feat: Spark L2 (#3715)

Co-authored-by: blackcoffeexbt <87530449+blackcoffeexbt@users.noreply.github.com> Co-authored-by: Vlad Stan <stan.v.vlad@gmail.com>
2026-02-17 12:25:38 +01:00
parent 42962308e6
commit 83ef05696e
8 changed files with 422 additions and 4 deletions
@@ -41,6 +41,7 @@ A backend wallet is selected and configured entirely through LNbits environment
 | [CoreLightning](#corelightning)                 | [LND (gRPC)](#lnd-grpc)               | [Blink](#blink)                                   |
 | [CoreLightning REST](#corelightning-rest)       | [LNbits](#lnbits)                     | [Alby](#alby)                                     |
 | [Spark (Core Lightning)](#spark-core-lightning) | [LNPay](#lnpay)                       | [Boltz](#boltz)                                   |
+| [Spark (L2)](#spark-l2)                         |                                       |                                                   |
 | [Cliche Wallet](#cliche-wallet)                 | [ZBD](#zbd)                           | [Phoenixd](#phoenixd)                             |
 | [Breez SDK](#breez-sdk)                         | [Breez Liquid SDK](#breez-liquid-sdk) | [Nostr Wallet Connect](#nostr-wallet-connect-nwc) |
 | [Strike](#strike)                               | [Eclair (ACINQ)](#eclair-acinq)       | [LN.tips](#lntips)                                |
@@ -52,7 +53,7 @@ A backend wallet is selected and configured entirely through LNbits environment

 ### CLNRest (using [runes](https://docs.corelightning.org/reference/lightning-createrune))

-[Core Lightning REST API docs](https://docs.corelightning.org/docs/rest)  
+[Core Lightning REST API docs](https://docs.corelightning.org/docs/rest)
 Should also work with the [Rust version of CLNRest](https://github.com/daywalker90/clnrest-rs)

 **Environment variables**
@@ -127,6 +128,47 @@ Old REST interface using [RTL c-lightning-REST](https://github.com/Ride-The-Ligh
 - `SPARK_URL`: `http://10.147.17.230:9737/rpc`
 - `SPARK_TOKEN`: `secret_access_key`

+## Spark (L2)
+
+Spark L2 is a self-custodial funding source that uses a small Node.js sidecar to talk to the Spark network and expose an HTTP API. You can let LNbits run the sidecar internally, or run it yourself and point LNbits at it.
+
+**Required env vars**
+
+- `LNBITS_BACKEND_WALLET_CLASS`: `SparkL2Wallet`
+
+**Internal sidecar (LNbits-managed)**
+
+- `SPARK_L2_INTERNAL_SIDECAR_VERSION`: `0.1.1`
+- `SPARK_L2_MNEMONIC`: `...` (optional; auto-generated if blank)
+- `SPARK_L2_NETWORK`: `MAINNET`
+
+Optional tuning:
+
+- `SPARK_L2_PAY_WAIT_MS`: `4000`
+- `SPARK_L2_PAY_POLL_MS`: `500`
+- `SPARK_L2_STREAM_KEEPALIVE_MS`: `15000`
+
+**External sidecar**
+
+- `SPARK_L2_EXTERNAL_ENDPOINT`: `http://127.0.0.1:8765`
+- `SPARK_L2_EXTERNAL_API_KEY`: `...` (if your sidecar requires auth)
+
+Example: run the sidecar manually (external mode)
+
+```bash
+git clone https://github.com/lnbits/spark_sidecar.git
+cd spark_sidecar
+npm install
+
+SPARK_MNEMONIC="bottom bottom bottom bottom bottom bottom bottom bottom bottom bottom bottom bottom" \
+SPARK_NETWORK=MAINNET \
+SPARK_SIDECAR_PORT=8765 \
+SPARK_PAY_WAIT_MS=20000 \
+node server.mjs
+```
+
+For testing, you can generate a 12-word mnemonic at `https://iancoleman.io/bip39/`. Store it securely — it controls your funds. Then select **Spark (L2)** as the funding source in LNbits.
+
 ## LND (REST)

 **Required env vars**