lnurl 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e23197258071b756215d4f300ea391232f225a85eca0690088b116f9a3a6510
-  data.tar.gz: ce09219efdb19a01f87ebf9e909a668e1c21129ad4faa00257d165c1b4f1b007
+  metadata.gz: fea4fd9e77664afe507942dc5617bae6c49a04a606112b42a23a9f97dd66df51
+  data.tar.gz: b2372cedd6cb920bf267ef6334e42ad4129f5573151c481874ac14f9cef50433
 SHA512:
-  metadata.gz: 9c7ce4fcb15cd1bf2e5f240cfd5c25469eee0d8b6f644d0ed037e587a8de3cf72a17eb45245a29e53347ad5e543cc8e0d501444a5e1cb1c4b1a043ac9222ba56
-  data.tar.gz: dc3a3fa4da4b54c3aaa5cd9ed89fc75ef51ef09c91e91a34d865e8fcb4093255ff7fe822dba2d13bf74faa3e65ff776d2079dc4208d78fb0231cb84e2510633a
+  metadata.gz: bda02e84e7604f33f4266bdf67805b8b531c9b2d6a0cd72f11cfaa6c7e813cd3b4e83f27fb53dd6023acddf1ec3c47c0216a32e5f0450ab54d0623121e9dd841
+  data.tar.gz: b34597fc4635bd7cdeac6a1a02e32427297a0eed8127e788b4566d81f181d255ba526b2b3c54bebf751db06f1a40f6233d172f795a32a1b345462815927ad3a3

data/.gitignore

@@ -1,3 +1,5 @@
+*.gem
+
 /.bundle/
 /.yardoc
 /_yardoc/

data/README.md

@@ -1,8 +1,16 @@
-# Lnurl
+# LNURL tools for Ruby
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/lnurl`. To experiment with that code, run `bin/console` for an interactive prompt.
+LNURL is a protocol for interaction between Lightning wallets and third-party services.
+
+This gem provides helpers to work with LNURLs from Ruby.
+
+
+## Links:
+
+* [LNURL: Lightning Network UX protocol RFC](https://github.com/btcontract/lnurl-rfc)
+* [Awesome LNURL - a curated list with things related to LNURL](https://github.com/fiatjaf/awesome-lnurl)
+* [LNURL pay flow](https://xn--57h.bigsun.xyz/lnurl-pay-flow.txt)
 
-TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
@@ -12,27 +20,55 @@ Add this line to your application's Gemfile:
 gem 'lnurl'
 ```
 
-And then execute:
-
-    $ bundle install
-
 Or install it yourself as:
 
     $ gem install lnurl
 
 ## Usage
 
-TODO: Write usage instructions here
+### Encoding
+
+```ruby
+lnurl = Lnurl.new('https://lnurl.com/pay')
+puts lnurl.to_bech32 # => LNURL1DP68GURN8GHJ7MRWW4EXCTNRDAKJ7URP0YVM59LW
+```
 
-## Development
+### Decoding
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+```ruby
+Lnurl.valid?('nolnurl') #=> false
+
+lnurl = Lnurl.decode('LNURL1DP68GURN8GHJ7MRWW4EXCTNRDAKJ7URP0YVM59LW')
+lnurl.uri # => #<URI::HTTPS https://lnurl.com/pay>
+```
+
+### LNURL responses
+
+```ruby
+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 # => [...]
+
+```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/lnurl.
+Bug reports and pull requests are welcome on GitHub at https://github.com/bumi/lnurl-ruby.
 
 
 ## License

data/lib/lnurl.rb

@@ -4,14 +4,18 @@ require 'json'
 require 'ostruct'
 
 class Lnurl
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.1.1'.freeze
 
   InvoiceResponse = Class.new(OpenStruct)
   LnurlResponse = Class.new(OpenStruct) do
-    def request_invoice(amount: nil, amt_msat: nil)
-      msats = amount ? amount * 1000 : amt_msat
+    # amount in msats
+    def request_invoice(args)
+      args.transform_keys!(&:to_s)
       callback_uri = URI(callback)
-      callback_uri.query = "amount=#{msats}&" + callback_uri.query.to_s
+      if callback_uri.query
+        args = Hash[URI.decode_www_form(callback_uri.query)].merge(args) # reverse merge
+      end
+      callback_uri.query = URI.encode_www_form(args)
       body = Net::HTTP.get(callback_uri)
       InvoiceResponse.new JSON.parse(body)
     end
@@ -49,17 +53,23 @@ class Lnurl
     request_invoice(amount: amount).pr
   end
 
-  def self.lnurl?(value)
-    value.to_s.downcase.match?(Regexp.new("^#{HRP}")) &&
-      decode(value) rescue false
+  def self.valid?(value)
+    return false unless value.to_s.downcase.match?(Regexp.new("^#{HRP}", 'i')) # false if the HRP does not match
+    decoded = decode_raw(value) rescue false # rescue any decoding errors
+    return false unless decoded # false if it could not get decoded
+
+    return decoded.match?(URI.regexp) # check if the URI is valid
   end
 
   def self.decode(lnurl)
+    Lnurl.new(decode_raw(lnurl))
+  end
+
+  def self.decode_raw(lnurl)
     lnurl = lnurl.gsub(/^lightning:/, '')
     hrp, data = Bech32.decode(lnurl, lnurl.length)
     # raise 'no lnurl' if hrp != HRP
-
-    Lnurl.new(convert_bits(data, 5, 8, false).pack('C*').force_encoding('utf-8'))
+    convert_bits(data, 5, 8, false).pack('C*').force_encoding('utf-8')
   end
 
   # FROM: https://github.com/azuchi/bech32rb/blob/master/lib/bech32/segwit_addr.rb

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lnurl
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Michael Bumann