lnbits/docs/guide/wallets.md

---
layout: default
title: Backend wallets
nav_order: 3
---


Backend wallets
===============

LNbits can run on top of many lightning-network funding sources. Currently there is support for CoreLightning, LND, LNbits, LNPay, lntxbot and OpenNode, with more being added regularly.

A backend wallet can be configured using the following LNbits environment variables:


### CoreLightning

- `LNBITS_BACKEND_WALLET_CLASS`: **CoreLightningWallet**
- `CORELIGHTNING_RPC`: /file/path/lightning-rpc

### Spark (c-lightning)

- `LNBITS_BACKEND_WALLET_CLASS`: **SparkWallet**
- `SPARK_URL`: http://10.147.17.230:9737/rpc
- `SPARK_TOKEN`: secret_access_key

### LND (REST)

- `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

or

- `LND_REST_MACAROON_ENCRYPTED`: eNcRyPtEdMaCaRoOn

### LND (gRPC)

- `LNBITS_BACKEND_WALLET_CLASS`: **LndWallet**
- `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

You can also use an AES-encrypted macaroon (more info) instead by using

- `LND_GRPC_MACAROON_ENCRYPTED`: eNcRyPtEdMaCaRoOn

To encrypt your macaroon, run `./venv/bin/python lnbits/wallets/macaroon/macaroon.py`.

### LNbits

- `LNBITS_BACKEND_WALLET_CLASS`: **LNbitsWallet**
- `LNBITS_ENDPOINT`: e.g. https://lnbits.com
- `LNBITS_KEY`: lnbitsAdminKey

### LNPay

For the invoice listener to work you have a publicly accessible URL in your LNbits and must set up [LNPay webhooks](https://dashboard.lnpay.co/webhook/) pointing to `<your LNbits host>/wallet/webhook` with the "Wallet Receive" event and no secret. For example, `https://mylnbits/wallet/webhook` will be the Endpoint Url that gets notified about the payment. 

- `LNBITS_BACKEND_WALLET_CLASS`: **LNPayWallet**
- `LNPAY_API_ENDPOINT`: https://api.lnpay.co/v1/
- `LNPAY_API_KEY`: sak_apiKey
- `LNPAY_WALLET_KEY`: waka_apiKey


### lntxbot

- `LNBITS_BACKEND_WALLET_CLASS`: **LntxbotWallet**
- `LNTXBOT_API_ENDPOINT`: https://lntxbot.com/
- `LNTXBOT_KEY`: lntxbotAdminApiKey


### OpenNode

For the invoice to work you must have a publicly accessible URL in your LNbits. No manual webhook setting is necessary.

- `LNBITS_BACKEND_WALLET_CLASS`: **OpenNodeWallet**
- `OPENNODE_API_ENDPOINT`: https://api.opennode.com/
- `OPENNODE_KEY`: opennodeAdminApiKey


### Cliche Wallet

- `CLICHE_ENDPOINT`: ws://127.0.0.1:12000
feat: use github pages and jekyll for docs 2020-05-04 15:20:36 +00:00			`---`
			`layout: default`
			`title: Backend wallets`
chore: remove `gunicorn` and `gevent` from minimum requirements It is now up to the user to install these (or other) for production deployment. More info: https://flask.palletsprojects.com/en/1.1.x/tutorial/deploy/#run-with-a-production-server 2020-09-03 17:53:22 +00:00			`nav_order: 3`
feat: use github pages and jekyll for docs 2020-05-04 15:20:36 +00:00			`---`


			`Backend wallets`
			`===============`

Updates to documentation (#574) * fix: rpc library install when using LND fixes #563 * chore: improve some out of date docs Co-authored-by: calle <93376500+callebtc@users.noreply.github.com> 2022-08-03 08:03:01 +00:00			`LNbits can run on top of many lightning-network funding sources. Currently there is support for CoreLightning, LND, LNbits, LNPay, lntxbot and OpenNode, with more being added regularly.`
feat: use github pages and jekyll for docs 2020-05-04 15:20:36 +00:00
			`A backend wallet can be configured using the following LNbits environment variables:`


Mega-merge 3: CLN update client lib with descriptionhash support (WIP) (#792) * CoreLightningWallet 2022-08-01 14:41:50 +00:00			`### CoreLightning`
feat: use github pages and jekyll for docs 2020-05-04 15:20:36 +00:00
Mega-merge 3: CLN update client lib with descriptionhash support (WIP) (#792) * CoreLightningWallet 2022-08-01 14:41:50 +00:00			- `LNBITS_BACKEND_WALLET_CLASS`: CoreLightningWallet
			- `CORELIGHTNING_RPC`: /file/path/lightning-rpc
feat: use github pages and jekyll for docs 2020-05-04 15:20:36 +00:00
add spark backend and fix c-lightning. 2020-08-29 15:23:01 +00:00			`### Spark (c-lightning)`

			- `LNBITS_BACKEND_WALLET_CLASS`: SparkWallet
			- `SPARK_URL`: http://10.147.17.230:9737/rpc
			- `SPARK_TOKEN`: secret_access_key
feat: use github pages and jekyll for docs 2020-05-04 15:20:36 +00:00
			`### LND (REST)`

			- `LNBITS_BACKEND_WALLET_CLASS`: LndRestWallet
Fixed docs about LND_REST_ENDPOINT There should be base URL, not only hostname. 2022-04-13 15:20:24 +00:00			- `LND_REST_ENDPOINT`: http://10.147.17.230:8080/
adjust docs to match 91853 2020-10-09 00:51:40 +00:00			- `LND_REST_CERT`: /file/path/tls.cert
Support for encrypted macaroons (#521) * encrypted macaroons * fix GRPC env entry * example config entry * add pycryptodomex to requirements * documentation * Added pycryptodomex to pip file Co-authored-by: Ben Arc <ben@arc.wales> 2022-02-14 16:54:05 +00:00			- `LND_REST_MACAROON`: /file/path/admin.macaroon or Bech64/Hex

			`or`
feat: use github pages and jekyll for docs 2020-05-04 15:20:36 +00:00
Support for encrypted macaroons (#521) * encrypted macaroons * fix GRPC env entry * example config entry * add pycryptodomex to requirements * documentation * Added pycryptodomex to pip file Co-authored-by: Ben Arc <ben@arc.wales> 2022-02-14 16:54:05 +00:00			- `LND_REST_MACAROON_ENCRYPTED`: eNcRyPtEdMaCaRoOn
feat: use github pages and jekyll for docs 2020-05-04 15:20:36 +00:00
Mega-merge 4: Reenable LndWallet gRPC and use TrackPaymentV2 (#745) * readd lndgrpc * debug logging * Use TrackPaymentV2 * /v2/router/track * lnd_router_grpc * flag for blocking check * error handling * fix name * regtest lndgrpc * new test pipeline * fix env * check for description hash * remove unnecessary asserts for clarity * assume that description_hash is a hash already * no lock * description hashing in backend * restore bolt11.py * /api/v1/payments with hex of description * comment * refactor wallets * forgot eclair * fix lnpay * bytes directly * make format * mypy check * make format * remove old code * WIP status check * LND GRPC docs * restore cln to main * fix regtest * import * remove unused import * format * do not expect ok * check ok * delete comments 2022-08-09 09:49:39 +00:00			`### LND (gRPC)`

			- `LNBITS_BACKEND_WALLET_CLASS`: LndWallet
			- `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

			`You can also use an AES-encrypted macaroon (more info) instead by using`

			- `LND_GRPC_MACAROON_ENCRYPTED`: eNcRyPtEdMaCaRoOn

			To encrypt your macaroon, run `./venv/bin/python lnbits/wallets/macaroon/macaroon.py`.

feat: use github pages and jekyll for docs 2020-05-04 15:20:36 +00:00			`### LNbits`

			- `LNBITS_BACKEND_WALLET_CLASS`: LNbitsWallet
chore: remove `gunicorn` and `gevent` from minimum requirements It is now up to the user to install these (or other) for production deployment. More info: https://flask.palletsprojects.com/en/1.1.x/tutorial/deploy/#run-with-a-production-server 2020-09-03 17:53:22 +00:00			- `LNBITS_ENDPOINT`: e.g. https://lnbits.com
adjust docs to match 91853 2020-10-09 00:51:40 +00:00			- `LNBITS_KEY`: lnbitsAdminKey
feat: use github pages and jekyll for docs 2020-05-04 15:20:36 +00:00
			`### LNPay`

Adding clarity for LNPay webhooks 2021-06-09 13:18:50 +00:00			For the invoice listener to work you have a publicly accessible URL in your LNbits and must set up [LNPay webhooks](https://dashboard.lnpay.co/webhook/) pointing to `<your LNbits host>/wallet/webhook` with the "Wallet Receive" event and no secret. For example, `https://mylnbits/wallet/webhook` will be the Endpoint Url that gets notified about the payment.
harden sse connections to backends a little. 2020-10-09 23:55:58 +00:00
feat: use github pages and jekyll for docs 2020-05-04 15:20:36 +00:00			- `LNBITS_BACKEND_WALLET_CLASS`: LNPayWallet
Update LNPay endpoint 2021-04-11 20:05:21 +00:00			- `LNPAY_API_ENDPOINT`: https://api.lnpay.co/v1/
adjust docs to match 91853 2020-10-09 00:51:40 +00:00			- `LNPAY_API_KEY`: sak_apiKey
			- `LNPAY_WALLET_KEY`: waka_apiKey
feat: use github pages and jekyll for docs 2020-05-04 15:20:36 +00:00

			`### lntxbot`

			- `LNBITS_BACKEND_WALLET_CLASS`: LntxbotWallet
lntxbot.bigsun.xyz will expire soon, use lntxbot.com instead See: https://twitter.com/lntxbot/status/1457341136918482945 2021-11-12 06:05:59 +00:00			- `LNTXBOT_API_ENDPOINT`: https://lntxbot.com/
adjust docs to match 91853 2020-10-09 00:51:40 +00:00			- `LNTXBOT_KEY`: lntxbotAdminApiKey
feat: use github pages and jekyll for docs 2020-05-04 15:20:36 +00:00

			`### OpenNode`

harden sse connections to backends a little. 2020-10-09 23:55:58 +00:00			`For the invoice to work you must have a publicly accessible URL in your LNbits. No manual webhook setting is necessary.`

feat: use github pages and jekyll for docs 2020-05-04 15:20:36 +00:00			- `LNBITS_BACKEND_WALLET_CLASS`: OpenNodeWallet
chore: remove `gunicorn` and `gevent` from minimum requirements It is now up to the user to install these (or other) for production deployment. More info: https://flask.palletsprojects.com/en/1.1.x/tutorial/deploy/#run-with-a-production-server 2020-09-03 17:53:22 +00:00			- `OPENNODE_API_ENDPOINT`: https://api.opennode.com/
adjust docs to match 91853 2020-10-09 00:51:40 +00:00			- `OPENNODE_KEY`: opennodeAdminApiKey
Add cliche wallet (#1071) 2022-10-24 09:46:32 +00:00

			`### Cliche Wallet`

			- `CLICHE_ENDPOINT`: ws://127.0.0.1:12000