LightningMailFaucet

Email Faucet, which pays Bitcoin Lightning invoices instantly.

LightningMailFaucet

Python E-Mail Faucet which can pay Bitcoin Lightning invoices.

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

During Lightning Workshops we often use a faucet to give the participants some satoshis to play around with.

There are other possibility to do that with LNURL-withdraw QR-Codes. But we recognized that it is better to first only use the protocol layer when explaining the lightning network. Therefore we decided to use a faucet which can pay invoices directly.

We use Alby Wallet as a backend for the faucet.

You can also use LNBits as a backend. Currently you can use Tag 0.1.0 for that. Or work on the Branch feature-lnbits.

In addition an e-mail address is required to check the invoices which are send to you. To send back a respone e-mail we use the GMail API. This is also configurable in the .env file. Not using the GMail API is also possible. You can also use your SMTP Server. We use GMail API because we can avoid some problems with the spam filter.

Getting Started

Installation

1. Clone the repo

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

2. Install Pyhton Packages:

   pip install -r requirements.txt

Usage

Setup an LNBits Wallet and configure the script using .env file or environment variables. You have to config the access to the wallet and the access to a Mailbox. We use a GMail Account to send the responses. Maybe you also like to change the design and the text of mail responses. Than just run the script in the background.

  nohup python ln_mail_faucet.py &

Roadmap

• Add Changelog
• Docker Image
• Support of LNURLPay
• Support for Lightning addresses

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

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

License

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

Contact

f418.me - f418_me - [email protected]

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