lnurl 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d576622de24d8f1ed23c5b91359bbdda2baba77ec45c7cf0fb75f4ecc2f1a438
-  data.tar.gz: ab19bea6f40250cd7dbc094dadeb5107d36cfcc7d8c08211b651f086b36519fc
+  metadata.gz: f06941b90b37171d472eeec93f3decbd39f266dfcd561dc7a9e2b40169941e89
+  data.tar.gz: 548acd35d90b87c560a259f4efeba41ddd265197969c5e74acf0aa22d67bd999
 SHA512:
-  metadata.gz: 8bf871e746f0c8285987c347b7fa6af4c8000753e750f3e7d40327e710308e72fbf2b3e2936635e11734462a6008d9754cd2e40ae8d7821fe06905e7dfff1f81
-  data.tar.gz: 9a0bc6a54b49261ba146e3c348d85b1886cec3779cc2a5c4cd6ccc44ee3c2cd6e62432c85620640eb9741ba2e2f510b6cfecfa6cef7fa944991caec91f89ec65
+  metadata.gz: ac21021140798716061f2505fd4486624004c9d9fae2178cfc77d1fcb5a927c06dd62f580eb198b67fbcfa37b29b07364e9367d6519d80e482b3314549518b90
+  data.tar.gz: aba3f442248206c0aea044ba39b5cb25772db51094b7942bf15888f01da3093fc5f528e88f3709cb98c1670521b3eddc0c9d1b335491d6c60e20e207761c62a4

data/Gemfile.lock

@@ -1,13 +1,13 @@
 PATH
   remote: .
   specs:
-    lnurl (0.1.1)
-      bech32 (~> 1.2.0)
+    lnurl (1.1.0)
+      bech32 (~> 1.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    bech32 (1.2.1)
+    bech32 (1.4.2)
       thor (>= 1.1.0)
     diff-lcs (1.4.4)
     rake (12.3.3)
@@ -24,7 +24,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
-    thor (1.1.0)
+    thor (1.2.2)
 
 PLATFORMS
   ruby
@@ -35,4 +35,4 @@ DEPENDENCIES
   rspec (~> 3.0)
 
 BUNDLED WITH
-   2.2.23
+   2.4.4

data/README.md

@@ -42,6 +42,18 @@ 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:
+```ruby
+lnurl = Lnurl.decode(a_short_lnurl, 90)
+```
+
+### [Lightning Address](https://github.com/andrerfneves/lightning-address)
+
+```ruby
+lnurl = Lnurl.from_lightning_address('user@lnurl.com')
+lnurl.uri # => #<URI::HTTPS https://lnurl.com/.well-known/lnurlp/user>
+```
+
 ### LNURL responses
 
 ```ruby

data/lib/lnurl.rb

@@ -4,7 +4,11 @@ require 'json'
 require 'ostruct'
 
 class Lnurl
-  VERSION = '1.0.0'.freeze
+  VERSION = '1.1.0'.freeze
+
+  # Maximum integer size
+  # Useful for max_length when decoding
+  MAX_INTEGER = 2**31 - 1
 
   InvoiceResponse = Class.new(OpenStruct)
   LnurlResponse = Class.new(OpenStruct) do
@@ -61,17 +65,26 @@ class Lnurl
     return decoded.match?(URI.regexp) # check if the URI is valid
   end
 
-  def self.decode(lnurl)
-    Lnurl.new(decode_raw(lnurl))
+  def self.decode(lnurl, max_length = MAX_INTEGER)
+    Lnurl.new(decode_raw(lnurl, max_length))
   end
 
-  def self.decode_raw(lnurl)
+  def self.decode_raw(lnurl, max_length = MAX_INTEGER)
     lnurl = lnurl.gsub(/^lightning:/, '')
-    hrp, data, sepc = Bech32.decode(lnurl)
+    hrp, data, sepc = Bech32.decode(lnurl, max_length)
     # raise 'no lnurl' if hrp != HRP
     convert_bits(data, 5, 8, false).pack('C*').force_encoding('utf-8')
   end
 
+  def self.from_lightning_address(lightning_address)
+    Lnurl.new(decode_lightning_address(lightning_address))
+  end
+
+  def self.decode_lightning_address(lightning_address)
+    username, domain = lightning_address.split('@')
+    "https://#{domain}/.well-known/lnurlp/#{username}"
+  end
+
   # FROM: https://github.com/azuchi/bech32rb/blob/master/lib/bech32/segwit_addr.rb
   def self.convert_bits(data, from, to, padding=true)
     acc = 0

data/lnurl.gemspec

@@ -27,5 +27,5 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency 'bech32', '~> 1.2.0'
+  spec.add_runtime_dependency 'bech32', '~> 1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lnurl
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Michael Bumann
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-13 00:00:00.000000000 Z
+date: 2023-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bech32
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: '1.1'
 description: A collection of tools to work with LNURLs - the protocol for interaction
   between Lightning wallets and third-party services.
 email:
@@ -51,7 +51,7 @@ metadata:
   homepage_uri: https://github.com/bumi/lnurl-ruby
   source_code_uri: https://github.com/bumi/lnurl-ruby
   funding: lightning:02ad33d99d0bb3bf3bb8ec8e089cbefa8fd7de23a13cfa59aec9af9730816be76f
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -66,8 +66,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.23
-signing_key: 
+rubygems_version: 3.4.1
+signing_key:
 specification_version: 4
 summary: LNURL implementation for ruby
 test_files: []