lighstorm 0.0.10 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed188ef291ac08a9cc6f91dca92931be2c88257ee184416fd0f40a3224740b20
-  data.tar.gz: 1be060a12d9e755354764cc8151da8a26e114fcc9a0ecac470e9fe9b685a60a4
+  metadata.gz: 026ad34b202b5f4367e287568b22126ba4850145b9d3e9398cdfd2f70d9e25d7
+  data.tar.gz: 63b0809d04e688ceab5c7a3ff5e9ee05588c8fece0a7b6323f96b8f0a871f9eb
 SHA512:
-  metadata.gz: b37802f04bae65416f4e80590506518025d62f1ca9b502b97db3cc108792b13a077f2ebb89c3e0be4cf311fb10a53f916a3c37e2f6c729b9bf01f187b0ab4892
-  data.tar.gz: ac5f5a1f5f4ff271ab2ddef517763f380f1868b71339bcf1758975e35c7e520ddd65fddb9d210539fedde2dc3830912db8b0bbdbfed1aa454e781c8a6e43e948
+  metadata.gz: 00ba8bf8fa6f5930abb796bdb00434401a31d30db6d26397ea1cebeb587ce404b942777dd0df6eed38d8e24fec5f6574afaf3d343108379f1d359f7def4a80ba
+  data.tar.gz: 39ebcc45331f332c5aa85e824245aec7e707bed958625d123cdb655f250610a361ae56a6dc0a8657ec34dcda977bd7e0630b47e82f0edb511b5cbf3a16b584bd

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lighstorm (0.0.10)
+    lighstorm (0.0.12)
       dotenv (~> 2.8, >= 2.8.1)
       lnd-client (~> 0.0.5)
       zache (~> 0.12.0)
@@ -47,7 +47,7 @@ GEM
     rspec-expectations (3.12.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.3)
+    rspec-mocks (3.12.4)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.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.10'
+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.10
+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/invoice/find_by_code.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require_relative '../../ports/grpc'
+require_relative '../../adapters/invoice'
+require_relative '../../models/invoice'
+
+module Lighstorm
+  module Controllers
+    module Invoice
+      module FindByCode
+        def self.fetch(code)
+          at = Time.now
+
+          decoded = Ports::GRPC.lightning.decode_pay_req(pay_req: code).to_h
+
+          { response: {
+            at: at,
+            decode_pay_req: decoded,
+            lookup_invoice: Ports::GRPC.lightning.lookup_invoice(r_hash_str: decoded[:payment_hash]).to_h
+          }, exception: nil }
+        rescue StandardError => e
+          { exception: e }
+        end
+
+        def self.adapt(raw)
+          raise 'missing at' if raw[:at].nil?
+
+          {
+            lookup_invoice: Lighstorm::Adapter::Invoice.lookup_invoice(
+              raw[:lookup_invoice],
+              raw[:at]
+            )
+          }
+        end
+
+        def self.transform(adapted)
+          adapted[:lookup_invoice][:known] = true
+          adapted[:lookup_invoice]
+        end
+
+        def self.data(code, &vcr)
+          raw = vcr.nil? ? fetch(code) : vcr.call(-> { fetch(code) })
+
+          raise_error_if_exists!(raw)
+
+          adapted = adapt(raw[:response])
+
+          transform(adapted)
+        end
+
+        def self.model(data)
+          Lighstorm::Models::Invoice.new(data)
+        end
+
+        def self.raise_error_if_exists!(response)
+          return if response[:exception].nil?
+
+          if response[:exception].is_a?(GRPC::NotFound)
+            raise NoInvoiceFoundError.new(
+              "Invoice not found. Try using Invoice.decode if you don't own the invoice.",
+              grpc: response[:exception]
+            )
+          end
+
+          raise LighstormError.new(grpc: response[:exception])
+        end
+      end
+    end
+  end
+end

data/controllers/invoice/find_by_secret_hash.rb

@@ -9,10 +9,12 @@ module Lighstorm
     module Invoice
       module FindBySecretHash
         def self.fetch(secret_hash)
-          {
+          { response: {
             at: Time.now,
             lookup_invoice: Ports::GRPC.lightning.lookup_invoice(r_hash_str: secret_hash).to_h
-          }
+          }, exception: nil }
+        rescue StandardError => e
+          { exception: e }
         end
 
         def self.adapt(raw)
@@ -34,7 +36,7 @@ module Lighstorm
         def self.data(secret_hash, &vcr)
           raw = vcr.nil? ? fetch(secret_hash) : vcr.call(-> { fetch(secret_hash) })
 
-          adapted = adapt(raw)
+          adapted = adapt(raw[:response])
 
           transform(adapted)
         end

data/controllers/invoice.rb

@@ -3,6 +3,7 @@
 require_relative './invoice/all'
 require_relative './invoice/decode'
 require_relative './invoice/find_by_secret_hash'
+require_relative './invoice/find_by_code'
 require_relative './invoice/actions/create'
 
 module Lighstorm
@@ -20,8 +21,12 @@ module Lighstorm
         All.model(All.data).last
       end
 
-      def self.find_by_secret_hash(secret_hash)
-        FindBySecretHash.model(FindBySecretHash.data(secret_hash))
+      def self.find_by_secret_hash(secret_hash, &vcr)
+        FindBySecretHash.model(FindBySecretHash.data(secret_hash, &vcr))
+      end
+
+      def self.find_by_code(code, &vcr)
+        FindByCode.model(FindByCode.data(code, &vcr))
       end
 
       def self.decode(code, &vcr)

data/controllers/payment/all.rb

@@ -12,7 +12,7 @@ module Lighstorm
   module Controllers
     module Payment
       module All
-        def self.fetch(purpose: nil, limit: nil, fetch: {})
+        def self.fetch(purpose: nil, invoice_code: nil, secret_hash: nil, limit: nil, fetch: {})
           at = Time.now
 
           grpc = Ports::GRPC.session
@@ -31,6 +31,10 @@ module Lighstorm
             response.payments.each do |payment|
               payment = payment.to_h
 
+              next unless invoice_code.nil? || payment[:payment_request] == invoice_code
+
+              next unless secret_hash.nil? || payment[:payment_hash] == secret_hash
+
               payment_purpose = Adapter::Purpose.list_payments(payment, get_info)
 
               case purpose
@@ -391,11 +395,22 @@ module Lighstorm
           list_payments
         end
 
-        def self.data(purpose: nil, limit: nil, fetch: {}, &vcr)
+        def self.data(
+          purpose: nil, invoice_code: nil, secret_hash: nil, limit: nil,
+          fetch: {}, &vcr
+        )
           raw = if vcr.nil?
-                  self.fetch(purpose: purpose, limit: limit, fetch: fetch)
+                  self.fetch(
+                    purpose: purpose, invoice_code: invoice_code, secret_hash: secret_hash,
+                    limit: limit, fetch: fetch
+                  )
                 else
-                  vcr.call(-> { self.fetch(purpose: purpose, limit: limit, fetch: fetch) })
+                  vcr.call(lambda {
+                             self.fetch(
+                               purpose: purpose, invoice_code: invoice_code, secret_hash: secret_hash,
+                               limit: limit, fetch: fetch
+                             )
+                           })
                 end
 
           adapted = adapt(raw)

data/controllers/payment.rb

@@ -16,6 +16,14 @@ module Lighstorm
       def self.last(purpose: nil, fetch: {})
         All.model(All.data(purpose: purpose, fetch: fetch)).last
       end
+
+      def self.find_by_secret_hash(secret_hash, &vcr)
+        All.model(All.data(secret_hash: secret_hash, &vcr)).first
+      end
+
+      def self.find_by_invoice_code(invoice_code, &vcr)
+        All.model(All.data(invoice_code: invoice_code, &vcr)).first
+      end
     end
   end
 end

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.10'
+gem 'lighstorm', '~> 0.0.12'
 ```
 
 Run `bundle install`.
@@ -60,7 +60,7 @@ Lighstorm.config!(
 ```ruby
 require 'lighstorm'
 
-puts Lighstorm.version # => 0.0.10
+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
@@ -462,6 +466,12 @@ Lighstorm::Invoice.find_by_secret_hash(
   '1d438b8100518c9fba0a607e3317d6b36f74ceef3a6591836eb2f679c6853501'
 )
 
+invoice = Lighstorm::Invoice.find_by_code('lnbc20n1pj...0eqps7h0k9')
+
+invoice.secret.valid_proof?(
+  'c504f73f83e3772b802844b54021e44e071c03011eeda476b198f7a093bcb09e'
+) # => true
+
 # _key is helpful for reactive javascript frameworks.
 # Please don't consider it as a unique identifier
 # for the item. Instead, use it as a volatile key for
@@ -526,6 +536,19 @@ action.response
 invoice = action.result
 ```
 
+### Proof of Payment
+
+[Making Payments](https://docs.lightning.engineering/the-lightning-network/multihop-payments)
+
+
+```ruby
+invoice = Lighstorm::Invoice.find_by_code('lnbc20n1pj...0eqps7h0k9')
+
+invoice.secret.valid_proof?(
+  'c504f73f83e3772b802844b54021e44e071c03011eeda476b198f7a093bcb09e'
+) # => true
+```
+
 ### Pay
 
 [Understanding Lightning Invoices](https://docs.lightning.engineering/the-lightning-network/payment-lifecycle/understanding-lightning-invoices)
@@ -547,6 +570,8 @@ payment = action.result
 payment.at
 payment.state
 
+payment.secret.proof
+
 payment.amount.millisatoshis
 payment.fee.millisatoshis
 payment.fee.parts_per_million(
@@ -622,6 +647,7 @@ rescue PaymentError => error
   error.result
 end
 ```
+
 ## Payment
 
 [![This is an image representing Payment as a graph.](https://raw.githubusercontent.com/icebaker/assets/main/lighstorm/graph-payment.png)](https://raw.githubusercontent.com/icebaker/assets/main/lighstorm/graph-payment.png)
@@ -642,6 +668,12 @@ Lighstorm::Payment.all(limit: 10, purpose: 'rebalance')
 # 'self-payment', 'peer-to-peer',
 # 'rebalance', 'payment'
 
+Lighstorm::Payment.find_by_invoice_code('lnbc20n1pj...0eqps7h0k9')
+
+Lighstorm::Payment.find_by_secret_hash(
+  '1d438b8100518c9fba0a607e3317d6b36f74ceef3a6591836eb2f679c6853501'
+)
+
 # _key is helpful for reactive javascript frameworks.
 # Please don't consider it as a unique identifier
 # for the item. Instead, use it as a volatile key for
@@ -671,6 +703,7 @@ payment.purpose
 # https://docs.lightning.engineering/the-lightning-network/multihop-payments
 payment.secret.preimage
 payment.secret.hash
+payment.secret.proof
 
 payment.invoice.created_at
 payment.invoice.expires_at
@@ -747,6 +780,18 @@ payment.hops[0].channel.entry.public_key
 payment.hops[0].channel.entry.alias
 payment.hops[0].channel.entry.color
 ```
+
+### Proof of Payment
+
+[Making Payments](https://docs.lightning.engineering/the-lightning-network/multihop-payments)
+
+```ruby
+payment = Lighstorm::Invoice.decode('lnbc20m1pv...qqdhhwkj').pay.result
+
+payment.secret.proof
+# => 'c504f73f83e3772b802844b54021e44e071c03011eeda476b198f7a093bcb09e'
+```
+
 ### Performance
 Avoid fetching data that you don't need:
 ```ruby
@@ -1003,7 +1048,7 @@ gem 'lighstorm', path: '/home/user/lighstorm'
 # demo.rb
 require 'lighstorm'
 
-puts Lighstorm.version # => 0.0.10
+puts Lighstorm.version # => 0.0.12
 ```
 
 ```sh
@@ -1240,13 +1285,13 @@ gem build lighstorm.gemspec
 
 gem signin
 
-gem push lighstorm-0.0.10.gem
+gem push lighstorm-0.0.12.gem
 ```
 
 _________________
 
 <center>
-  lighstorm 0.0.10
+  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.10
+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.10',
+      name: 'Lighstorm 0.0.12',
       repo: 'https://github.com/icebaker/lighstorm'
     }
   </script>

data/models/errors.rb

@@ -2,7 +2,21 @@
 
 module Lighstorm
   module Errors
-    class LighstormError < StandardError; end
+    class LighstormError < StandardError
+      attr_reader :grpc
+
+      def initialize(message = nil, grpc: nil)
+        super(message)
+        @grpc = grpc
+      end
+
+      def to_h
+        output = { class: self.class, message: message }
+        output[:grpc] = grpc.message unless grpc.nil?
+
+        output
+      end
+    end
 
     class ToDoError < LighstormError; end
 
@@ -19,6 +33,7 @@ module Lighstorm
     class OperationNotAllowedError < LighstormError; end
     class UnexpectedNumberOfHTLCsError < LighstormError; end
     class UnknownChannelError < LighstormError; end
+    class NoInvoiceFoundError < LighstormError; end
 
     class InvoiceMayHaveMultiplePaymentsError < LighstormError; end
 

data/models/secret.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative '../controllers/secret/valid_proof'
+
 require 'digest'
 
 module Lighstorm
@@ -26,6 +28,16 @@ module Lighstorm
         @hash = data[:hash]
       end
 
+      def proof
+        @preimage
+      end
+
+      def valid_proof?(candidate_preimage, &vcr)
+        return true if candidate_preimage == preimage
+
+        Controllers::Secret::ValidProof.data(@hash, candidate_preimage, &vcr)
+      end
+
       def to_h
         {
           preimage: preimage,

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.10',
+      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.10
+  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
@@ -103,6 +103,7 @@ files:
 - controllers/invoice/actions/pay_through_route.rb
 - controllers/invoice/all.rb
 - controllers/invoice/decode.rb
+- controllers/invoice/find_by_code.rb
 - controllers/invoice/find_by_secret_hash.rb
 - controllers/node.rb
 - controllers/node/actions/apply_gossip.rb
@@ -113,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