From 0b3d5bbe0eb6a239977275291e6041c4db2632db Mon Sep 17 00:00:00 2001 From: callebtc <93376500+callebtc@users.noreply.github.com> Date: Tue, 12 Sep 2023 12:14:47 +0200 Subject: [PATCH] [CORE] Document CoreLightningRestWallet (#1920) * document CoreLightningRestWallet * pushed to comment * fixed base64 comment --------- Co-authored-by: Ben --- .env.example | 11 ++++++----- docs/guide/wallets.md | 10 ++++++++-- 2 files changed, 14 insertions(+), 7 deletions(-) diff --git a/.env.example b/.env.example index 6771412d3..62ee7d95c 100644 --- a/.env.example +++ b/.env.example @@ -91,6 +91,12 @@ SPARK_TOKEN=myaccesstoken # CoreLightningWallet CORELIGHTNING_RPC="/home/bob/.lightning/bitcoin/lightning-rpc" +# CoreLightningRestWallet +CORELIGHTNING_REST_URL=http://127.0.0.1:8185/ +# Path or BASE64/HEX STRING +CORELIGHTNING_REST_MACAROON="/path/to/clnrest/access.macaroon" +CORELIGHTNING_REST_CERT="/path/to/clnrest/tls.cert" + # LnbitsWallet LNBITS_ENDPOINT=https://legend.lnbits.com LNBITS_KEY=LNBITS_ADMIN_KEY @@ -133,8 +139,3 @@ ECLAIR_PASS=eclairpw # Enter /api in LightningTipBot to get your key LNTIPS_API_KEY=LNTIPS_ADMIN_KEY LNTIPS_API_ENDPOINT=https://ln.tips - -# Cashu Mint -# Use a long-enough random (!) private key. -# Once set, you cannot change this key as for now. -CASHU_PRIVATE_KEY="SuperSecretPrivateKey" diff --git a/docs/guide/wallets.md b/docs/guide/wallets.md index 3ec06f459..b226a563d 100644 --- a/docs/guide/wallets.md +++ b/docs/guide/wallets.md @@ -18,6 +18,12 @@ A backend wallet can be configured using the following LNbits environment variab - `LNBITS_BACKEND_WALLET_CLASS`: **CoreLightningWallet** - `CORELIGHTNING_RPC`: /file/path/lightning-rpc +### CoreLightning REST +- `LNBITS_BACKEND_WALLET_CLASS`: **CoreLightningRestWallet** +- `CORELIGHTNING_REST_URL`: http://127.0.0.1:8185/ +- `CORELIGHTNING_REST_MACAROON`: /file/path/admin.macaroon or Base64/Hex +- `CORELIGHTNING_REST_CERT`: /home/lightning/clnrest/tls.cert + ### Spark (Core Lightning) - `LNBITS_BACKEND_WALLET_CLASS`: **SparkWallet** @@ -29,7 +35,7 @@ A backend wallet can be configured using the following LNbits environment variab - `LNBITS_BACKEND_WALLET_CLASS`: **LndRestWallet** - `LND_REST_ENDPOINT`: http://10.147.17.230:8080/ - `LND_REST_CERT`: /file/path/tls.cert -- `LND_REST_MACAROON`: /file/path/admin.macaroon or Bech64/Hex +- `LND_REST_MACAROON`: /file/path/admin.macaroon or Base64/Hex or @@ -41,7 +47,7 @@ or - `LND_GRPC_ENDPOINT`: ip_address - `LND_GRPC_PORT`: port - `LND_GRPC_CERT`: /file/path/tls.cert -- `LND_GRPC_MACAROON`: /file/path/admin.macaroon or Bech64/Hex +- `LND_GRPC_MACAROON`: /file/path/admin.macaroon or Base64/Hex You can also use an AES-encrypted macaroon (more info) instead by using