2020-04-27 17:01:53 +00:00
LNbits
======
2020-09-03 21:02:15 +00:00
[![github-tests-badge]][github-tests]
[![github-mypy-badge]][github-mypy]
2020-04-27 17:01:53 +00:00
[![codecov-badge]][codecov]
[![license-badge]](LICENSE)
2020-09-03 17:53:22 +00:00
[![docs-badge]][docs]
2019-12-16 15:07:21 +00:00
2020-04-23 20:40:51 +00:00
2020-04-27 17:01:53 +00:00
2020-06-12 18:58:37 +00:00
# LNbits v0.1 BETA, free and open-source lightning-network wallet/accounts system
Use [lnbits.com ](https://lnbits.com ), or run your own LNbits server!
LNbits is a very simple Python server that sits on top of any funding source, and can be used as:
2019-12-16 15:07:21 +00:00
2020-04-24 08:52:07 +00:00
* Accounts system to mitigate the risk of exposing applications to your full balance, via unique API keys for each wallet
2020-06-12 18:58:37 +00:00
* Extendable platform for exploring lightning-network functionality via LNbits extension framework
2020-04-24 08:52:07 +00:00
* Part of a development stack via LNbits API
2019-12-16 15:07:21 +00:00
* Fallback wallet for the LNURL scheme
2020-06-12 18:58:37 +00:00
* Instant wallet for LN demonstrations
2019-12-09 21:39:02 +00:00
2020-10-16 02:12:32 +00:00
The wallet can run on top of any lightning-network funding source, currently there is support for LND, c-lightning, Spark, LNpay, OpenNode, lntxbot, with more being added regularily.
2020-06-12 18:58:37 +00:00
See [lnbits.org ](https://lnbits.org ) for more detailed documentation.
2019-12-13 14:51:40 +00:00
2020-08-10 18:27:37 +00:00
Checkout the LNbits [YouTube ](https://www.youtube.com/playlist?list=PLPj3KCksGbSYG0ciIQUWJru1dWstPHshe ) video series.
2020-08-10 10:54:28 +00:00
2020-08-19 16:53:27 +00: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 excellent funding sources for LNbits.
2020-08-08 20:16:01 +00:00
2020-10-16 02:12:32 +00:00
## Running LNbits
2020-09-08 08:30:23 +00:00
2020-10-16 02:12:32 +00:00
See the [install guide ](docs/guide/installation.md ) for details on installation and setup.
### Contributing to LNbits
There's a [slightly different setup ](docs/devs/installation.md ) if you want to contribute to LNbits, but if your changes don't require adding or removing any package dependencies you don't have to bother with that, just follow the [normal installation ](docs/guide/installation.md ) steps.
2020-09-08 08:30:23 +00:00
2019-12-16 15:07:21 +00:00
## LNbits as an account system
2019-12-09 21:39:02 +00:00
2020-06-12 18:58:37 +00: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 21:39:02 +00:00
2020-04-23 20:46:00 +00:00
2019-12-09 21:39:02 +00:00
2020-06-12 18:58:37 +00:00
Each wallet also comes with its own API keys, to help partition the exposure of your funding source.
2019-12-16 15:07:21 +00:00
2020-06-12 18:58:37 +00:00
(LNbits M5StackSats available here https://github.com/arcbtc/M5StackSats)
2019-12-16 15:07:21 +00:00
2020-04-23 20:47:48 +00:00
2019-12-13 14:08:53 +00:00
2019-12-13 14:15:28 +00:00
## LNbits as an LNURL-withdraw fallback
2020-06-12 18:58:37 +00: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 14:15:28 +00:00
2019-12-13 14:18:42 +00:00
2019-12-13 14:08:53 +00:00
2020-06-12 18:58:37 +00:00
Using **lnbits.com/?lightning="LNURL-withdraw"** will trigger a withdraw that builds an LNbits wallet.
2019-12-16 15:07:21 +00: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 stilll be able to access the funds.
2019-12-13 14:34:21 +00:00
2019-12-13 14:08:53 +00:00
2019-12-16 15:07:21 +00:00
## LNbits as an insta-wallet
2020-06-12 18:58:37 +00:00
2019-12-16 15:07:21 +00:00
Wallets can be easily generated and given out to people at events (one click multi-wallet generation to be added soon).
"Go to this website", has a lot less friction than "Download this app".
2020-04-23 20:51:55 +00:00
2019-12-16 15:07:21 +00:00
2020-06-12 18:58:37 +00:00
## Tip me
2020-04-27 17:01:53 +00:00
2020-06-12 18:58:37 +00:00
If you like this project and might even use or extend it, why not [send some tip love ](https://lnbits.com/paywall/GAqKguK5S8f6w5VNjS9DfK )!
2020-04-27 17:01:53 +00:00
2020-09-03 17:53:22 +00:00
[docs]: https://lnbits.org/
[docs-badge]: https://img.shields.io/badge/docs-lnbits.org-673ab7.svg
2020-09-03 21:02:15 +00: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 17:01:53 +00: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
