You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

76 lines
3.0 KiB

5 years ago
![Lightning network wallet](https://i.imgur.com/EHvK6Lq.png)
5 years ago
# LNbits v0.1 BETA, free and open-source lightning-network wallet/accounts system
5 years ago
https://lnbits.com, or run your own LNbits server!
5 years ago
LNbits is a very simple Python server that sits on top of any funding source, and can be used as:
5 years ago
* 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 LNbits extension framework
* Part of a development stack via LNbits API
* Fallback wallet for the LNURL scheme
* Instant wallet for LN demonstrations
5 years ago
5 years ago
The wallet can run on top of any lightning-network funding source, currently there is support for LND, CLightning, Lntxbot, LNpay, OpenNode, with more being added regularily.
5 years ago
## LNbits as an account system
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..
5 years ago
5 years ago
![Lightning network wallet](https://i.imgur.com/w8jdGpF.png)
5 years ago
Each wallet also comes with its own API keys, to help partition the exposure of your funding source.
(LNbits M5StackSats available here https://github.com/arcbtc/M5StackSats)
5 years ago
![lnurl ATM](https://i.imgur.com/WfCg8wY.png)
5 years ago
5 years ago
## LNbits as an LNURL-withdraw fallback
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.
5 years ago
5 years ago
![lnurl fallback](https://i.imgur.com/CPBKHIv.png)
5 years ago
https://github.com/btcontract/lnurl-rfc/blob/master/spec.md
5 years ago
5 years ago
Adding **/lnurlwallet?lightning="LNURL-withdraw"** will trigger a withdraw that builds an LNbits wallet.
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.
5 years ago
![lnurl ATM](https://i.imgur.com/Gi6bn3L.jpg)
5 years ago
## LNbits as an insta-wallet
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".
5 years ago
![lnurl ATM](https://i.imgur.com/xFWDnwy.png)
# Running LNbits locally
Download this repo
5 years ago
LNbits uses [Flask](http://flask.pocoo.org/).
Feel free to contribute to the project.
Application dependencies
------------------------
The application uses [Pipenv][pipenv] to manage Python packages.
While in development, you will need to install all dependencies:
$ pipenv shell
$ pipenv install --dev
5 years ago
You will need to set the variables in .env.example, and rename the file to .env
![lnurl ATM](https://i.imgur.com/ri2zOe8.png)
5 years ago
Running the server
------------------
$ flask migrate
5 years ago
$ flask run
5 years ago
There is an environment variable called `FLASK_ENV` that has to be set to `development`
if you want to run Flask in debug mode with autoreload
5 years ago
[pipenv]: https://docs.pipenv.org/#install-pipenv-today
5 years ago
# Tip me
If you like this project and might even use or extend it, why not send some tip love!
https://paywall.link/to/f4e4e