lnurl 0.1.0

checksums.yaml

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

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in lnurl.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Michael Bumann
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,40 @@
+# Lnurl
+
+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.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'lnurl'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install lnurl
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+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.
+
+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.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "lnurl"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/lnurl.rb

@@ -0,0 +1,88 @@
+require 'bech32'
+require 'net/http'
+require 'json'
+require 'ostruct'
+
+class Lnurl
+  VERSION = '0.1.0'.freeze
+
+  InvoiceResponse = Class.new(OpenStruct)
+  LnurlResponse = Class.new(OpenStruct) do
+    def request_invoice(amount: nil, amt_msat: nil)
+      msats = amount ? amount * 1000 : amt_msat
+      callback_uri = URI(callback)
+      callback_uri.query = "amount=#{msats}&" + callback_uri.query.to_s
+      body = Net::HTTP.get(callback_uri)
+      InvoiceResponse.new JSON.parse(body)
+    end
+  end
+
+  HRP = 'lnurl'.freeze
+
+  attr_reader :uri
+
+  def initialize(uri)
+    @uri = URI(uri)
+  end
+
+  def to_bech32
+    Bech32.encode(HRP, data).upcase
+  end
+  alias encode to_bech32
+
+  def data
+    self.class.convert_bits(uri.to_s.codepoints, 8, 5, true)
+  end
+
+  def response
+    @response ||= begin
+                    body = Net::HTTP.get(uri) # TODO: redirects?
+                    LnurlResponse.new JSON.parse(body)
+                  end
+  end
+
+  def request_invoice(amount:)
+    response.request_invoice(amount: amount)
+  end
+
+  def payment_request(amount:)
+    request_invoice(amount: amount).pr
+  end
+
+  def self.lnurl?(value)
+    value.to_s.downcase.match?(Regexp.new("^#{HRP}")) &&
+      decode(value) rescue false
+  end
+
+  def self.decode(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'))
+  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
+    bits = 0
+    ret = []
+    maxv = (1 << to) - 1
+    max_acc = (1 << (from + to - 1)) - 1
+    data.each do |v|
+      return nil if v < 0 || (v >> from) != 0
+      acc = ((acc << from) | v) & max_acc
+      bits += from
+      while bits >= to
+        bits -= to
+        ret << ((acc >> bits) & maxv)
+      end
+    end
+    if padding
+      ret << ((acc << (to - bits)) & maxv) unless bits == 0
+    elsif bits >= from || ((acc << (to - bits)) & maxv) != 0
+      return nil
+    end
+    ret
+  end
+end

data/lnurl.gemspec

@@ -0,0 +1,31 @@
+require_relative 'lib/lnurl'
+
+Gem::Specification.new do |spec|
+  spec.name          = "lnurl"
+  spec.version       = Lnurl::VERSION
+  spec.authors       = ["Michael Bumann"]
+  spec.email         = ["hello@michaelbumann.com"]
+
+  spec.summary       = %q{LNURL implementation for ruby}
+  spec.description   = %q{A collection of tools to work with LNURLs - the protocol for interaction between Lightning wallets and third-party services.}
+  spec.homepage      = "https://github.com/bumi/lnurl-ruby"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/bumi/lnurl-ruby"
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  spec.metadata['funding'] = 'lightning:02ad33d99d0bb3bf3bb8ec8e089cbefa8fd7de23a13cfa59aec9af9730816be76f'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'bech32'
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: lnurl
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michael Bumann
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bech32
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A collection of tools to work with LNURLs - the protocol for interaction
+  between Lightning wallets and third-party services.
+email:
+- hello@michaelbumann.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/lnurl.rb
+- lnurl.gemspec
+homepage: https://github.com/bumi/lnurl-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/bumi/lnurl-ruby
+  source_code_uri: https://github.com/bumi/lnurl-ruby
+  funding: lightning:02ad33d99d0bb3bf3bb8ec8e089cbefa8fd7de23a13cfa59aec9af9730816be76f
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: LNURL implementation for ruby
+test_files: []