https://github.com/lnbits/free-lnaddress-extension
Give out free lnaddress
https://github.com/lnbits/free-lnaddress-extension
Last synced: 8 months ago
JSON representation
Give out free lnaddress
- Host: GitHub
- URL: https://github.com/lnbits/free-lnaddress-extension
- Owner: lnbits
- License: mit
- Created: 2023-02-02T12:35:55.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-03-17T19:31:26.000Z (about 3 years ago)
- Last Synced: 2024-04-14T18:48:51.589Z (about 2 years ago)
- Language: Python
- Size: 63.5 KB
- Stars: 3
- Watchers: 4
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Free Lightning Address extends LNURLp
## CAVEAT: Use this extension if your lnbits is older than February 2023, and be sure to read the release notes
## If you have the latest Lnbits, just use the new LNURLp extension
- Basically extends Lnurlp functionality with [LN Addresses](https://lightningaddress.com/)
- See also [LUD-16: Paying to static internet identifiers.](https://github.com/lnurl/luds/blob/luds/16.md)
- The `` is limited to `a-z0-9-_.`. Please note that this is way more strict than common email addresses as it allows fewer symbols and only lowercase characters.
## Purpose and Contraints
- This is an admin extension
- This extension is for small projects, games, applications
- This extensions is not meant for production or for high volume applications
- No Cloudflare. No separate domain, uses the current LNBits domain only.
- All LN addresses are free.
- Users can add, delete or modify their LN Address.
- LNaddress must be unique name per wallet that follows naming specification
## Usage Notes
**IMPORTANT: Edit your .env to be the following:**
```
# Disable extensions for all users, use "all" to disable all extensions
# lnaddress (paid lightning address extension) and lnaddy (free lightning address extension)
# cannot be used at the same time. To avoid conflict, one or the other must be disabled.
LNBITS_DISABLED_EXTENSIONS="amilk, lnaddress"
```
## Create a static QR code people can use to pay over Lightning Network
LNURL is a range of lightning-network standards that allow us to use lightning-network differently. An LNURL-pay is a link that wallets use to fetch an invoice from a server on-demand. The link or QR code is fixed, but each time it is read by a compatible wallet a new invoice is issued by the service and sent to the wallet.
[**Wallets supporting LNURL**](https://github.com/fiatjaf/awesome-lnurl#wallets)
## Usage
1. Create a Lightning Address with LNURLp (New Pay link)\
- select your wallets
- Pick a unique username for lightning address
- make a small description
- enter amount
- if _Fixed amount_ is unchecked you'll have the option to configure a Max and Min amount
- you can set the currency to something different than sats. For example if you choose EUR, the satoshi amount will be calculated when a user scans the LNURLp
- You can ask the user to send a comment that will be sent along with the payment (for example a comment to a blog post)
- Webhook URL allows to call an URL when the LNURLp is paid
- Success mesage, will send a message back to the user after a successful payment, for example a thank you note
- Success URL, will send back a clickable link to the user. Access to some hidden content, or a download link
2. Use the shareable link or view the LNURLp you just created
- you can now open your LNURLp and copy the LNURL, get the shareable link or print it\
