LNBits Bitcoin Lightning Vouchers

Python Script to generate as much Bitcoin Lightning Vouchers you want.

Report Bug · Request Feature

Table of Contents

1. About The Project
2. Getting Started
   • Installation
   • Usage
3. Roadmap
4. Contributing
5. License
6. Contact

About The Project

LNbits a free and open-source lightning wallet that offers a lot of extension. LNbits can run on any lightning-network funding source, currently supporting LND, c-lightning, OpenNode, lntxbot, LNPay and even LNbits itself!

You can run LNbits for yourself, or easily take the service from LNBits.

Each wallet has its own API keys and there is no limit to the number of wallets you can make.

Extensions add extra functionality to LNbits so it is possible to experiment with a range of cutting-edge technologies on the lightning network. One of the extension ist LNURL-withdraw.

You can generate LNURL-withdraw links wich are also available in form of QR-Codes. With this QR-Codes every wallet that supports LNURL-withdraw can remain the amount which is defined.

Generating vouchers in large quantities by the GUI is painful. Therefore you can use this script.

(back to top)

Getting Started

Installation

1. Clone the repo

   git clone https://github.com/f418me/LNbitsVoucherGenerator.git

2. Install Pyhton Packages:

   pip install -r requirements.txt

(back to top)

Usage

Setup an LNBits Wallet and activate the LNURL-withdraw extension. Do the configuration in the config.ini file. Maybe you also like to change the desing of the voucher. Just define an other background image.

  python main.py

(back to top)

Roadmap

• Add Changelog
• Add Logging
• Add Docker Compose
• Add possibility to use CSV-Files as Input to generate the vouchers

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

LNBitsVoucherGenerator is released under the terms of the MIT license. See https://opensource.org/licenses/MIT for further information.

(back to top)

Contact

f418.me - f418_me - [email protected]

Project Link: https://github.com/f418me/LNBitsVoucherGenerator

(back to top)