LNURL is a protocol for interaction between Lightning wallets and third-party services.
This gem provides helpers to work with LNURLs from Ruby.
- LNURL: Lightning Network UX protocol RFC
- Awesome LNURL - a curated list with things related to LNURL
- LNURL pay flow
Add this line to your application's Gemfile:
gem 'lnurl'Or install it yourself as:
$ gem install lnurl
lnurl = Lnurl.new('https://lnurl.com/pay')
puts lnurl.to_bech32 # => LNURL1DP68GURN8GHJ7MRWW4EXCTNRDAKJ7URP0YVM59LWLnurl.valid?('nolnurl') #=> false
lnurl = Lnurl.decode('LNURL1DP68GURN8GHJ7MRWW4EXCTNRDAKJ7URP0YVM59LW')
lnurl.uri # => #<URI::HTTPS https://lnurl.com/pay>By default we accept long LNURLs but you can configure a custom max length:
lnurl = Lnurl.decode(a_short_lnurl, 90)lnurl = Lnurl.from_lightning_address('user@lnurl.com')
lnurl.uri # => #<URI::HTTPS https://lnurl.com/.well-known/lnurlp/user>lnurl = Lnurl.decode('LNURL1DP68GURN8GHJ7MRWW4EXCTNRDAKJ7URP0YVM59LW')
response = lnurl.response # => #<Lnurl::LnurlResponse status="OK" ...
response.status # => OK / ERROR
response.callback # => https://...
response.tag # => payRequest
response.maxSendable # => 100000000
response.minSendable # => 1000
response.metadata # => [...]
invoice = response.request_invoice(amount: 100000) # (amount in msats) #<Lnurl::InvoiceResponse status="OK"
# or:
invoice = lnurl.request_invoice(amount: 100000) # (amount in msats)
invoice.status # => OK / ERROR
invoice.pr # => lntb20u1p0tdr7mpp...
invoice.successAction # => {...}
invoice.routes # => [...]Bug reports and pull requests are welcome on GitHub at https://github.com/bumi/lnurl-ruby.
The gem is available as open source under the terms of the MIT License.