andrerfneves / lnurl-rfc

lnurl specifications

LNURL Documents

These are all the individual documents describing each small piece of protocol that can be implemented under the LNURL umbrella. Different wallets and services may implement different sets of protocols.

Number	Description	Wallets (in alphabetical order)
01	Base LNURL encoding and decoding.	Alby, Blixt, BlueWallet, Breez, coinos, LNbits, @lntxbot, Muun, Phoenix, ShockWallet, SimpleBitcoinWallet, ThunderHub, Wallet of Satoshi, Zap Android, Zap Desktop, Zap iOS, ZBD Discord, ZBD Extension, ZBD Telegram, ZEBEDEE, Zeus
02	channelRequest base spec.	Blixt, Breez, SimpleBitcoinWallet, Zap Android, Zap Desktop, Zeus
03	withdrawRequest base spec.	Blixt, BlueWallet, Breez, coinos, LNbits, @lntxbot, Muun, Phoenix, ShockWallet, SimpleBitcoinWallet, ThunderHub, Wallet of Satoshi, Zap Android, Zap Desktop, Zap iOS, ZBD Discord, ZBD Extension, ZBD Telegram, ZEBEDEE, Zeus
04	Auth base spec.	Alby, Blixt, Breez, coinos, LNbits, @lntxbot, Phoenix, SimpleBitcoinWallet, ThunderHub, Zap Desktop, Zeus
05	BIP32-based seed generation for auth protocol.	SimpleBitcoinWallet
06	payRequest base spec.	Alby, Blixt, BlueWallet, Breez, coinos, LNbits, @lntxbot, Phoenix, ShockWallet, SimpleBitcoinWallet, ThunderHub, Wallet of Satoshi, Zap Android, ZBD Discord, ZBD Extension, ZBD Telegram, ZEBEDEE, Zeus
07	hostedChannelRequest base spec.	SimpleBitcoinWallet
08	Fast withdrawRequest.	@lntxbot, SimpleBitcoinWallet, ZBD Extension
09	successAction field for payRequest.	Alby, Blixt, BlueWallet, Breez, coinos, LNbits, @lntxbot, Phoenix, ShockWallet, SimpleBitcoinWallet, ThunderHub, Wallet of Satoshi, Zap Android, ZBD Discord, ZBD Extension, ZBD Telegram, ZEBEDEE, Zeus
10	aes success action in payRequest.	Alby, Blixt, BlueWallet, Breez, coinos, LNbits, @lntxbot, Phoenix, ShockWallet, SimpleBitcoinWallet, ThunderHub, Wallet of Satoshi, Zap Android, Zeus
11	Disposable and storeable payRequests.	Blixt, SimpleBitcoinWallet, ZBD Extension
12	Comments in payRequest.	Alby, Blixt, BlueWallet, Breez, LNbits, @lntxbot, Phoenix, ThunderHub, Wallet of Satoshi, ZBD Discord, ZBD Extension, ZBD Telegram, ZEBEDEE, Zeus
13	signMessage-based seed generation for auth protocol.	Alby, Blixt, Zeus
14	balanceCheck: reusable withdrawRequests.	Blixt, LNbits, @lntxbot
15	balanceNotify: services hurrying up the withdraw process.	LNbits, @lntxbot
16	Paying to static internet identifiers.	Alby, Blixt, LNbits, @lntxbot, Phoenix, Zap Android, ZBD Discord, ZBD Extension, ZBD Telegram, ZEBEDEE
17	Scheme prefixes and raw (non bech32-encoded) URLs.	Blixt
18	Payer identity in payRequest protocol.	Blixt, SimpleBitcoinWallet
19	Mutually discoverable pay and withdraw links.
20	Long payment description for pay protocol.	Blixt
22	Webhook notification support in payRequest.

Dependency Tree

The entire idea of the suite of LNURL protocols is that they are optional. Each new LUD may be implemented by some wallets and not others, some services and not others, but they should still maintain compatibility at all times (except, of course, if the service requires the new functionality).

There is also a hierarchy of internal dependencies between the LUDs -- for example, you cannot implement sending comments in payRequests if you haven't implemented the base payRequest spec also. The following graph displays that hierarchy of internal dependencies (you can safely ignore it though).

How to add your own document

Open a pull request with your proposal. Pick the next unreserved number for your proposal. To be accepted it just have to be generally decent and make sense and be implemented or currently being implemented by 2 or more wallets.

Join https://t.me/lnurl if you just want to talk about your ideas or chat about LNURL protocols in general.