2023-05-09 10:41:40 +02:00
# LNbits
2020-04-27 19:01:53 +02:00
[![license-badge]](LICENSE)
2020-09-03 19:53:22 +02:00
[![docs-badge]][docs]
2020-04-23 22:40:51 +02:00
2020-04-27 19:01:53 +02:00
2023-03-01 20:39:40 +01:00
# LNbits v0.10 BETA, free and open-source Lightning wallet accounts system
2020-06-12 20:58:37 +02:00
2021-07-10 18:57:05 +02:00
(Join us on [https://t.me/lnbits ](https://t.me/lnbits ))
2022-03-01 20:07:21 +01:00
2023-01-08 12:16:39 +01:00
LNbits is beta, for responsible disclosure of any concerns please contact lnbits@pm.me
2021-07-10 18:59:14 +02:00
2022-07-13 01:15:48 +02:00
Use [legend.lnbits.com ](https://legend.lnbits.com ), or run your own LNbits server!
2020-06-12 20:58:37 +02:00
2023-01-08 12:16:39 +01:00
LNbits is a Python server that sits on top of any funding source. It can be used as:
2019-12-16 16:07:21 +01:00
2023-05-09 10:41:40 +02:00
- Accounts system to mitigate the risk of exposing applications to your full balance via unique API keys for each wallet
- Extendable platform for exploring Lightning network functionality via the LNbits extension framework
- Part of a development stack via LNbits API
- Fallback wallet for the LNURL scheme
- Instant wallet for LN demonstrations
2019-12-09 22:39:02 +01:00
2023-02-23 12:41:44 +01:00
LNbits can run on top of any Lightning funding source. It supports LND, CLN, Eclair, Spark, LNpay, OpenNode, LightningTipBot, and with more being added regularly.
2020-06-12 20:58:37 +02:00
2023-03-08 18:15:58 +01:00
See [LNbits Wiki ](https://github.com/lnbits/lnbits/wiki/ ) for more detailed documentation.
2019-12-13 15:51:40 +01:00
2020-08-10 20:27:37 +02:00
Checkout the LNbits [YouTube ](https://www.youtube.com/playlist?list=PLPj3KCksGbSYG0ciIQUWJru1dWstPHshe ) video series.
2020-08-10 12:54:28 +02:00
2023-01-08 12:16:39 +01:00
LNbits is inspired by all the great work of [opennode.com ](https://www.opennode.com/ ), and in particular [lnpay.co ](https://lnpay.co/ ). Both work as funding sources for LNbits.
2020-08-08 22:16:01 +02:00
2020-10-16 04:12:32 +02:00
## Running LNbits
2020-09-08 10:30:23 +02:00
2023-07-11 10:34:21 +02:00
See the [install guide ](https://github.com/lnbits/lnbits/blob/main/docs/guide/installation.md ) for details on installation and setup.
2020-09-08 10:30:23 +02:00
2019-12-16 16:07:21 +01:00
## LNbits as an account system
2019-12-09 22:39:02 +01:00
2020-06-12 20:58:37 +02:00
LNbits is packaged with tools to help manage funds, such as a table of transactions, line chart of spending, export to csv + more to come..
2019-12-09 22:39:02 +01:00
2020-04-23 22:46:00 +02:00
2019-12-09 22:39:02 +01:00
2020-06-12 20:58:37 +02:00
Each wallet also comes with its own API keys, to help partition the exposure of your funding source.
2019-12-16 16:07:21 +01:00
2020-06-12 20:58:37 +02:00
(LNbits M5StackSats available here https://github.com/arcbtc/M5StackSats)
2019-12-16 16:07:21 +01:00
2020-04-23 22:47:48 +02:00
2019-12-13 15:08:53 +01:00
2019-12-13 15:15:28 +01:00
## LNbits as an LNURL-withdraw fallback
2020-06-12 20:58:37 +02:00
LNURL has a fallback scheme, so if scanned by a regular QR code reader it can default to a URL. LNbits exploits this to generate an instant wallet using the [LNURL-withdraw ](https://github.com/btcontract/lnurl-rfc/blob/master/lnurl-withdraw.md ).
2019-12-13 15:15:28 +01:00
2019-12-13 15:18:42 +01:00
2019-12-13 15:08:53 +01:00
2020-06-12 20:58:37 +02:00
Using **lnbits.com/?lightning="LNURL-withdraw"** will trigger a withdraw that builds an LNbits wallet.
2022-08-03 10:03:01 +02:00
Example use would be an ATM, which utilises LNURL, if the user scans the QR with a regular QR code scanner app, they will still be able to access the funds.
2019-12-13 15:34:21 +01:00
2019-12-13 15:08:53 +01:00
2023-01-08 12:16:39 +01:00
## LNbits as an instant wallet
2020-06-12 20:58:37 +02:00
2023-05-09 10:41:40 +02:00
Wallets can be easily generated and given out to people at events. "Go to this website", has a lot less friction than "Download this app".
2019-12-16 16:07:21 +01:00
2020-04-23 22:51:55 +02:00
2019-12-16 16:07:21 +01:00
2021-02-19 00:51:04 +01:00
## Tip us
2020-04-27 19:01:53 +02:00
2023-01-08 12:16:39 +01:00
If you like this project [send some tip love ](https://legend.lnbits.com/paywall/GAqKguK5S8f6w5VNjS9DfK )!
2020-04-27 19:01:53 +02:00
2023-02-24 14:48:50 +01:00
[docs]: https://github.com/lnbits/lnbits/wiki
2020-09-03 19:53:22 +02:00
[docs-badge]: https://img.shields.io/badge/docs-lnbits.org-673ab7.svg
2020-09-03 23:02:15 +02:00
[github-mypy]: https://github.com/lnbits/lnbits/actions?query=workflow%3Amypy
[github-mypy-badge]: https://github.com/lnbits/lnbits/workflows/mypy/badge.svg
[github-tests]: https://github.com/lnbits/lnbits/actions?query=workflow%3Atests
[github-tests-badge]: https://github.com/lnbits/lnbits/workflows/tests/badge.svg
2020-04-27 19:01:53 +02:00
[codecov]: https://codecov.io/gh/lnbits/lnbits
[codecov-badge]: https://codecov.io/gh/lnbits/lnbits/branch/master/graph/badge.svg
[license-badge]: https://img.shields.io/badge/license-MIT-blue.svg
