lighstorm 0.0.11 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6072337300f3fd850fbca3ba5c7c804842c275d5f35fa288dfb83747fa0b1a56
-  data.tar.gz: 8a16d83cb96f0ed911ebd55e12707b20f0aac00a0acac8d176e544a68abad647
+  metadata.gz: 026ad34b202b5f4367e287568b22126ba4850145b9d3e9398cdfd2f70d9e25d7
+  data.tar.gz: 63b0809d04e688ceab5c7a3ff5e9ee05588c8fece0a7b6323f96b8f0a871f9eb
 SHA512:
-  metadata.gz: 3ccb6cef3322fcd1c0efb1439ddaf756e631113fbc7544218d10d6f71d08ca2ad80cf08b029ae4145e6916dcefc9ee3683124567bb952b02bf70793cc794616b
-  data.tar.gz: 2755ec9d8c2bf041459be7292983103c880f032e5e1e315ce2da2cc97ff945bbfb9f4083259a0c88ec22df8cd0301282c8ea376d63371a438ad58677b7f3d9e6
+  metadata.gz: 00ba8bf8fa6f5930abb796bdb00434401a31d30db6d26397ea1cebeb587ce404b942777dd0df6eed38d8e24fec5f6574afaf3d343108379f1d359f7def4a80ba
+  data.tar.gz: 39ebcc45331f332c5aa85e824245aec7e707bed958625d123cdb655f250610a361ae56a6dc0a8657ec34dcda977bd7e0630b47e82f0edb511b5cbf3a16b584bd

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lighstorm (0.0.11)
+    lighstorm (0.0.12)
       dotenv (~> 2.8, >= 2.8.1)
       lnd-client (~> 0.0.5)
       zache (~> 0.12.0)

data/README.md

@@ -15,6 +15,7 @@ Lighstorm::Channel.mine.first.myself.node.alias
 - [About](#about)
 - [Usage](#usage)
   - [Documentation](https://icebaker.github.io/lighstorm)
+  - [Tutorials and Articles](#tutorials-and-articles)
 - [Development](https://icebaker.github.io/lighstorm/#/README?id=development)
 
 ## About
@@ -34,7 +35,7 @@ Although it tries to stay close to [Lightning's terminologies](https://docs.ligh
 Add to your `Gemfile`:
 
 ```ruby
-gem 'lighstorm', '~> 0.0.11'
+gem 'lighstorm', '~> 0.0.12'
 ```
 
 ```ruby
@@ -46,7 +47,7 @@ Lighstorm.config!(
   macaroon_path: '/lnd/data/chain/bitcoin/mainnet/admin.macaroon',
 )
 
-puts Lighstorm.version # => 0.0.11
+puts Lighstorm.version # => 0.0.12
 
 Lighstorm::Node.myself.alias # => icebaker/old-stone
 
@@ -69,6 +70,10 @@ Lighstorm::Satoshis.new(
 
 Check the [full documentation](https://icebaker.github.io/lighstorm).
 
+## Tutorials and Articles
+
+- [Getting Started with Lightning Payments in Ruby](https://mirror.xyz/icebaker.eth/4RUF8umW_KRfVWHHvC2jz0c7YJqzv3RUUvLN-Mln5IU)
+
 ## Development
 
 Check the [development documentation](https://icebaker.github.io/lighstorm/#/README?id=development).

data/controllers/secret/valid_proof.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require_relative '../../ports/grpc'
+require_relative '../../adapters/invoice'
+require_relative '../../models/invoice'
+
+module Lighstorm
+  module Controllers
+    module Secret
+      module ValidProof
+        def self.fetch(invoice_main_secret_hash)
+          { response: {
+            at: Time.now,
+            lookup_invoice: Ports::GRPC.lightning.lookup_invoice(r_hash_str: invoice_main_secret_hash).to_h
+          }, exception: nil }
+        rescue StandardError => e
+          { exception: e }
+        end
+
+        def self.adapt(raw)
+          {
+            lookup_invoice: Lighstorm::Adapter::Invoice.lookup_invoice(
+              raw[:lookup_invoice],
+              raw[:at]
+            )
+          }
+        end
+
+        def self.transform(adapted, proof)
+          return true if adapted[:lookup_invoice][:secret][:preimage] == proof
+
+          return false if adapted[:lookup_invoice][:payments].nil? ||
+                          adapted[:lookup_invoice][:payments].empty?
+
+          !adapted[:lookup_invoice][:payments].find do |payment|
+            next if payment[:secret].nil?
+
+            payment[:secret][:preimage] == proof
+          end.nil?
+        end
+
+        def self.data(invoice_main_secret_hash, proof, &vcr)
+          raise 'Invalid proof' if proof.size != 64
+
+          raw = if vcr.nil?
+                  fetch(invoice_main_secret_hash)
+                else
+                  vcr.call(-> { fetch(invoice_main_secret_hash) })
+                end
+
+          adapted = adapt(raw[:response])
+
+          transform(adapted, proof)
+        end
+      end
+    end
+  end
+end

data/controllers/transaction/all.rb

@@ -1,26 +1,73 @@
 # frozen_string_literal: true
 
 require_relative '../invoice/all'
+require_relative '../payment/all'
+require_relative '../forward/all'
 require_relative '../../models/transaction'
 
 module Lighstorm
   module Controllers
     module Transaction
       module All
-        def self.fetch(limit: nil)
+        def self.fetch(direction: nil, how: nil, limit: nil)
           transactions = []
 
-          Invoice::All.data(spontaneous: true).filter do |invoice|
-            !invoice[:payments].nil? && invoice[:payments].size.positive?
-          end.each do |invoice|
-            invoice[:payments].each do |payment|
+          if direction.nil? || direction == 'in'
+            Invoice::All.data(spontaneous: true).filter do |invoice|
+              !invoice[:payments].nil? && invoice[:payments].size.positive?
+            end.each do |invoice|
+              transaction_how = invoice[:code].nil? ? 'spontaneously' : 'with-invoice'
+
+              next if !how.nil? && how != transaction_how
+
+              # TODO: Improve performance by reducing invoice fields and removing payments?
+              invoice[:payments].each do |payment|
+                transactions << {
+                  direction: 'in',
+                  at: payment[:at],
+                  amount: payment[:amount],
+                  how: transaction_how,
+                  message: payment[:message],
+                  data: { invoice: invoice }
+                }
+              end
+            end
+
+            Forward::All.data.each do |forward|
+              next if !how.nil? && how != 'forwarding'
+
               transactions << {
                 direction: 'in',
+                at: forward[:at],
+                amount: forward[:fee],
+                how: 'forwarding',
+                message: nil,
+                data: {}
+              }
+            end
+          end
+
+          if direction.nil? || direction == 'out'
+            Payment::All.data(
+              fetch: {
+                get_node_info: false,
+                lookup_invoice: false,
+                decode_pay_req: true,
+                get_chan_info: false
+              }
+            )[:data].each do |payment|
+              transaction_how = payment[:invoice][:code].nil? ? 'spontaneously' : 'with-invoice'
+
+              next if !how.nil? && how != transaction_how
+
+              # TODO: Improve performance by reducing invoice fields?
+              transactions << {
+                direction: 'out',
                 at: payment[:at],
                 amount: payment[:amount],
+                how: transaction_how,
                 message: payment[:message],
-                kind: 'invoice',
-                data: invoice
+                data: { invoice: payment[:invoice] }
               }
             end
           end
@@ -39,8 +86,12 @@ module Lighstorm
           end
         end
 
-        def self.data(limit: nil, &vcr)
-          raw = vcr.nil? ? fetch(limit: limit) : vcr.call(-> { fetch(limit: limit) })
+        def self.data(direction: nil, how: nil, limit: nil, &vcr)
+          raw = if vcr.nil?
+                  fetch(direction: direction, how: how, limit: limit)
+                else
+                  vcr.call(-> { fetch(direction: direction, how: how, limit: limit) })
+                end
 
           transform(raw)
         end

data/controllers/transaction.rb

@@ -5,8 +5,12 @@ require_relative './transaction/all'
 module Lighstorm
   module Controllers
     module Transaction
-      def self.all(limit: nil)
-        All.model(All.data(limit: limit))
+      def self.all(direction: nil, how: nil, limit: nil)
+        All.model(All.data(
+                    direction: direction,
+                    how: how,
+                    limit: limit
+                  ))
       end
     end
   end

data/docs/README.md

@@ -27,7 +27,7 @@ Lighstorm::Channel.mine.first.myself.node.alias
 Add to your `Gemfile`:
 
 ```ruby
-gem 'lighstorm', '~> 0.0.11'
+gem 'lighstorm', '~> 0.0.12'
 ```
 
 Run `bundle install`.
@@ -60,7 +60,7 @@ Lighstorm.config!(
 ```ruby
 require 'lighstorm'
 
-puts Lighstorm.version # => 0.0.11
+puts Lighstorm.version # => 0.0.12
 
 Lighstorm::Invoice.create(
   description: 'Coffee', amount: { millisatoshis: 1000 }, payable: 'once'
@@ -112,6 +112,10 @@ Lighstorm::Satoshis.new(
 ).satoshis # => 75621.65
 ```
 
+## Tutorials and Articles
+
+- [Getting Started with Lightning Payments in Ruby](https://mirror.xyz/icebaker.eth/4RUF8umW_KRfVWHHvC2jz0c7YJqzv3RUUvLN-Mln5IU)
+
 # Data Modeling
 
 ## Graph Theory
@@ -1044,7 +1048,7 @@ gem 'lighstorm', path: '/home/user/lighstorm'
 # demo.rb
 require 'lighstorm'
 
-puts Lighstorm.version # => 0.0.11
+puts Lighstorm.version # => 0.0.12
 ```
 
 ```sh
@@ -1281,13 +1285,13 @@ gem build lighstorm.gemspec
 
 gem signin
 
-gem push lighstorm-0.0.11.gem
+gem push lighstorm-0.0.12.gem
 ```
 
 _________________
 
 <center>
-  lighstorm 0.0.11
+  lighstorm 0.0.12
   |
   <a href="https://github.com/icebaker/lighstorm" rel="noopener noreferrer" target="_blank">GitHub</a>
   |

data/docs/_coverpage.md

@@ -8,7 +8,7 @@
 - Built for maximum **reliability**.
 - Optimized for programmer **happiness**.
 
-0.0.11
+0.0.12
 
 ⚠️ _Warning: Early-stage, breaking changes are expected._
 

data/docs/index.html

@@ -18,7 +18,7 @@
   <script>
     window.$docsify = {
       coverpage: true,
-      name: 'Lighstorm 0.0.11',
+      name: 'Lighstorm 0.0.12',
       repo: 'https://github.com/icebaker/lighstorm'
     }
   </script>

data/models/secret.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative '../controllers/secret/valid_proof'
+
 require 'digest'
 
 module Lighstorm
@@ -30,8 +32,10 @@ module Lighstorm
         @preimage
       end
 
-      def valid_proof?(candidate_preimage)
-        candidate_preimage == preimage
+      def valid_proof?(candidate_preimage, &vcr)
+        return true if candidate_preimage == preimage
+
+        Controllers::Secret::ValidProof.data(@hash, candidate_preimage, &vcr)
       end
 
       def to_h

data/models/transaction.rb

@@ -5,7 +5,7 @@ require_relative 'invoice'
 module Lighstorm
   module Models
     class Transaction
-      attr_reader :direction, :at, :message, :_key
+      attr_reader :direction, :at, :message, :how, :_key
 
       def initialize(data)
         @data = data
@@ -13,6 +13,7 @@ module Lighstorm
         @_key = @data[:_key]
         @at = @data[:at]
         @direction = @data[:direction]
+        @how = @data[:how]
         @message = @data[:message]
       end
 
@@ -21,7 +22,7 @@ module Lighstorm
       end
 
       def invoice
-        @invoice ||= @data[:kind] == 'invoice' ? Invoice.new(@data[:data]) : nil
+        @invoice ||= @data[:data][:invoice].nil? ? nil : Invoice.new(@data[:data][:invoice])
       end
 
       def to_h
@@ -30,6 +31,7 @@ module Lighstorm
           at: at,
           direction: direction,
           amount: amount.to_h,
+          how: how,
           message: message
         }
 

data/static/spec.rb

@@ -4,7 +4,7 @@ module Lighstorm
   module Static
     SPEC = {
       name: 'lighstorm',
-      version: '0.0.11',
+      version: '0.0.12',
       author: 'icebaker',
       summary: 'API for interacting with a Lightning Node.',
       description: 'Lighstorm is an opinionated abstraction layer on top of the lnd-client for interacting with a Lightning Node.',

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lighstorm
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 0.0.12
 platform: ruby
 authors:
 - icebaker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-12 00:00:00.000000000 Z
+date: 2023-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -114,6 +114,7 @@ files:
 - controllers/payment.rb
 - controllers/payment/actions/pay.rb
 - controllers/payment/all.rb
+- controllers/secret/valid_proof.rb
 - controllers/transaction.rb
 - controllers/transaction/all.rb
 - deleted.sh