lighstorm 0.0.12 → 0.0.14

data/models/connections/channel_node.rb

@@ -13,9 +13,11 @@ module Lighstorm
 
       attr_reader :state
 
-      def initialize(data, is_mine, transaction)
+      def initialize(data, components, is_mine, transaction)
         @data = data
+        @components = components
         @state = data[:state]
+        @initiator = data[:initiator]
         @is_mine = is_mine
         @transaction = transaction
       end
@@ -24,12 +26,16 @@ module Lighstorm
         state == 'active'
       end
 
+      def initiator?
+        @initiator
+      end
+
       def node
-        @node ||= Node.new(@data[:node])
+        @node ||= Node.new(@data[:node], @components)
       end
 
       def policy
-        @policy ||= Policy.new(@data[:policy], @transaction)
+        @policy ||= Policy.new(@data[:policy], @components, @transaction)
       end
 
       def accounting
@@ -39,7 +45,11 @@ module Lighstorm
       end
 
       def to_h
-        restult = { state: state, node: node.to_h }
+        restult = {
+          state: state,
+          initiator: @initiator,
+          node: node.to_h
+        }
 
         restult[:accounting] = accounting.to_h if @is_mine
         restult[:policy] = policy.to_h if @data[:policy]

data/models/connections/forward_channel.rb

@@ -5,8 +5,9 @@ require_relative '../edges/channel'
 module Lighstorm
   module Models
     class ForwardChannel
-      def initialize(data)
+      def initialize(data, components)
         @data = data
+        @components = components
       end
 
       def amount
@@ -14,7 +15,7 @@ module Lighstorm
       end
 
       def channel
-        @channel ||= Channel.new(@data[:channel])
+        @channel ||= Channel.new(@data[:channel], @components)
       end
 
       def to_h

data/models/edges/channel/hop.rb

@@ -8,7 +8,7 @@ module Lighstorm
       def initialize(data, payment)
         @hop_data = data
         @payment = payment
-        super(data[:channel])
+        super(data[:channel], nil)
       end
 
       def target

data/models/edges/channel.rb

@@ -5,9 +5,6 @@ require 'time'
 require_relative '../../ports/grpc'
 require_relative '../../adapters/edges/channel'
 
-require_relative '../../components/lnd'
-require_relative '../../components/cache'
-
 require_relative '../nodes/node'
 require_relative './channel/accounting'
 
@@ -22,8 +19,9 @@ module Lighstorm
     class Channel
       attr_reader :data, :_key, :id
 
-      def initialize(data)
+      def initialize(data, components)
         @data = data
+        @components = components
 
         @_key = data[:_key]
         @id = data[:id]
@@ -78,7 +76,7 @@ module Lighstorm
       def partners
         @partners ||= if @data[:partners]
                         @data[:partners].map do |data|
-                          ChannelNode.new(data, known? ? mine? : nil, transaction)
+                          ChannelNode.new(data, @components, known? ? mine? : nil, transaction)
                         end
                       else
                         []
@@ -170,9 +168,9 @@ module Lighstorm
         raise ArgumentError, 'missing gossip: or dump:' if gossip.nil? && dump.nil?
 
         if !gossip.nil?
-          new(Adapter::Channel.subscribe_channel_graph(gossip))
+          new(Adapter::Channel.subscribe_channel_graph(gossip), nil)
         elsif !dump.nil?
-          new(dump)
+          new(dump, nil)
         end
       end
 

data/models/edges/forward.rb

@@ -12,8 +12,9 @@ module Lighstorm
     class Forward
       attr_reader :_key, :at
 
-      def initialize(data)
+      def initialize(data, components)
         @data = data
+        @components = components
 
         @_key = data[:_key]
         @at = data[:at]
@@ -24,11 +25,11 @@ module Lighstorm
       end
 
       def in
-        @in ||= ForwardChannel.new(@data[:in])
+        @in ||= ForwardChannel.new(@data[:in], @components)
       end
 
       def out
-        @out ||= ForwardChannel.new(@data[:out])
+        @out ||= ForwardChannel.new(@data[:out], @components)
       end
 
       def to_h

data/models/edges/groups/channel_forwards.rb

@@ -8,8 +8,9 @@ module Lighstorm
     class ChannelForwardsGroup
       attr_reader :_key, :last_at
 
-      def initialize(data)
+      def initialize(data, components)
         @data = data
+        @components = components
 
         @_key = data[:_key]
         @last_at = data[:last_at]
@@ -20,7 +21,7 @@ module Lighstorm
       end
 
       def channel
-        @channel ||= Channel.new(@data[:channel])
+        @channel ||= Channel.new(@data[:channel], @components)
       end
 
       def to_h

data/models/edges/payment.rb

@@ -14,8 +14,9 @@ module Lighstorm
     class Payment
       attr_reader :_key, :at, :state, :secret, :purpose, :through, :message
 
-      def initialize(data)
+      def initialize(data, components)
         @data = data
+        @components = components
 
         @_key = data[:_key]
         @at = data[:at]
@@ -30,7 +31,7 @@ module Lighstorm
       end
 
       def invoice
-        @invoice ||= !spontaneous? && @data[:invoice] ? Invoice.new(@data[:invoice]) : nil
+        @invoice ||= !spontaneous? && @data[:invoice] ? Invoice.new(@data[:invoice], @components) : nil
       end
 
       def amount
@@ -42,7 +43,7 @@ module Lighstorm
       end
 
       def secret
-        @secret ||= @data[:secret] ? Secret.new(@data[:secret]) : nil
+        @secret ||= @data[:secret] ? Secret.new(@data[:secret], @components) : nil
       end
 
       def hops

data/models/errors.rb

@@ -3,23 +3,18 @@
 module Lighstorm
   module Errors
     class LighstormError < StandardError
-      attr_reader :grpc
-
-      def initialize(message = nil, grpc: nil)
+      def initialize(message = nil)
         super(message)
-        @grpc = grpc
       end
 
       def to_h
-        output = { class: self.class, message: message }
-        output[:grpc] = grpc.message unless grpc.nil?
-
-        output
+        { class: self.class, message: message }
       end
     end
 
     class ToDoError < LighstormError; end
 
+    class MissingComponentsError < LighstormError; end
     class ArgumentError < LighstormError; end
     class TooManyArgumentsError < LighstormError; end
     class IncoherentGossipError < LighstormError; end
@@ -31,45 +26,42 @@ module Lighstorm
     class NotYourChannelError < LighstormError; end
     class NotYourNodeError < LighstormError; end
     class OperationNotAllowedError < LighstormError; end
-    class UnexpectedNumberOfHTLCsError < LighstormError; end
     class UnknownChannelError < LighstormError; end
-    class NoInvoiceFoundError < LighstormError; end
 
     class InvoiceMayHaveMultiplePaymentsError < LighstormError; end
 
-    class PaymentError < LighstormError
-      attr_reader :response, :result, :grpc
+    class RequestError < LighstormError
+      attr_reader :request, :response, :result, :grpc
 
-      def initialize(message, response: nil, result: nil, grpc: nil)
+      def initialize(message, request: nil, response: nil, result: nil, grpc: nil)
         super(message)
+        @request = request
         @response = response
         @result = result
         @grpc = grpc
       end
 
       def to_h
-        output = { message: message }
+        output = { class: self.class, message: message }
 
+        output[:request] = request unless request.nil?
         output[:response] = response unless response.nil?
         output[:result] = result.to_h unless result.nil?
-        output[:grpc] = grpc.message unless grpc.nil?
+        output[:grpc] = { class: grpc.class, message: grpc.message } unless grpc.nil?
 
         output
       end
     end
 
+    class UpdateChannelPolicyError < RequestError; end
+
+    class NoInvoiceFoundError < RequestError; end
+
+    class PaymentError < RequestError; end
+
     class NoRouteFoundError < PaymentError; end
     class AlreadyPaidError < PaymentError; end
     class AmountForNonZeroError < PaymentError; end
     class MissingMillisatoshisError < PaymentError; end
-
-    class UpdateChannelPolicyError < LighstormError
-      attr_reader :response
-
-      def initialize(message, response)
-        super(message)
-        @response = response
-      end
-    end
   end
 end

data/models/invoice.rb

@@ -12,8 +12,9 @@ module Lighstorm
     class Invoice
       attr_reader :_key, :created_at, :expires_at, :settled_at, :state, :payable, :code
 
-      def initialize(data)
+      def initialize(data, components)
         @data = data
+        @components = components
 
         @_key = data[:_key]
         @created_at = data[:created_at]
@@ -35,7 +36,7 @@ module Lighstorm
       end
 
       def payments
-        @payments ||= @data[:payments]&.map { |data| Payment.new(data) }
+        @payments ||= @data[:payments]&.map { |data| Payment.new(data, @components) }
       end
 
       def amount
@@ -47,7 +48,7 @@ module Lighstorm
       end
 
       def secret
-        @secret ||= Secret.new(@data[:secret])
+        @secret ||= Secret.new(@data[:secret], @components)
       end
 
       def description
@@ -89,10 +90,15 @@ module Lighstorm
         times_out_in: { seconds: 5 },
         preview: false
       )
+        raise MissingComponentsError if @components.nil?
+
         if route
-          Controllers::Invoice::PayThroughRoute.perform(self, route: route, preview: preview)
+          Controllers::Invoice::PayThroughRoute.perform(
+            @components, self, route: route, preview: preview
+          )
         else
           Controllers::Invoice::Pay.perform(
+            @components,
             code: code,
             amount: amount,
             fee: fee,

data/models/nodes/node.rb

@@ -16,8 +16,9 @@ module Lighstorm
 
       attr_reader :data, :_key, :alias, :public_key, :color
 
-      def initialize(data)
+      def initialize(data, components)
         @data = data
+        @components = components
 
         @_key = @data[:_key]
         @alias = @data[:alias]
@@ -36,7 +37,9 @@ module Lighstorm
       def channels
         raise Errors::NotYourNodeError unless myself?
 
-        Controllers::Channel.mine
+        raise MissingComponentsError if @components.nil?
+
+        Controllers::Channel.mine(@components)
       end
 
       def to_h
@@ -87,9 +90,9 @@ module Lighstorm
         raise ArgumentError, 'missing gossip: or dump:' if gossip.nil? && dump.nil?
 
         if !gossip.nil?
-          new(Adapter::Node.subscribe_channel_graph(gossip))
+          new(Adapter::Node.subscribe_channel_graph(gossip), nil)
         elsif !dump.nil?
-          new(dump)
+          new(dump, nil)
         end
       end
 
@@ -121,7 +124,10 @@ module Lighstorm
         times_out_in: { seconds: 5 }, through: 'amp',
         preview: false
       )
+        raise MissingComponentsError if @components.nil?
+
         Controllers::Node::Pay.perform(
+          @components,
           public_key: public_key,
           amount: amount,
           fee: fee,

data/models/secret.rb

@@ -15,14 +15,15 @@ module Lighstorm
         data
       end
 
-      def self.create(&vcr)
+      def self.create(components = nil, &vcr)
         data = vcr.nil? ? generate : vcr.call(-> { generate })
 
-        Secret.new(data)
+        Secret.new(data, components)
       end
 
-      def initialize(data)
+      def initialize(data, components)
         @data = data
+        @components = components
 
         @preimage = data[:preimage]
         @hash = data[:hash]
@@ -33,9 +34,14 @@ module Lighstorm
       end
 
       def valid_proof?(candidate_preimage, &vcr)
+        raise MissingComponentsError if @components.nil?
+
         return true if candidate_preimage == preimage
 
-        Controllers::Secret::ValidProof.data(@hash, candidate_preimage, &vcr)
+        Controllers::Secret::ValidProof.data(
+          @components,
+          @hash, candidate_preimage, &vcr
+        )
       end
 
       def to_h

data/models/transaction.rb

@@ -1,43 +1,38 @@
 # frozen_string_literal: true
 
-require_relative 'invoice'
+require_relative './satoshis'
 
 module Lighstorm
   module Models
     class Transaction
-      attr_reader :direction, :at, :message, :how, :_key
+      attr_reader :_key, :at, :hash, :label
 
       def initialize(data)
         @data = data
 
         @_key = @data[:_key]
         @at = @data[:at]
-        @direction = @data[:direction]
-        @how = @data[:how]
-        @message = @data[:message]
+        @hash = @data[:hash]
+        @label = @data[:label]
       end
 
       def amount
         @amount ||= Satoshis.new(millisatoshis: @data[:amount][:millisatoshis])
       end
 
-      def invoice
-        @invoice ||= @data[:data][:invoice].nil? ? nil : Invoice.new(@data[:data][:invoice])
+      def fee
+        @fee ||= Satoshis.new(millisatoshis: @data[:fee][:millisatoshis])
       end
 
       def to_h
-        output = {
+        {
           _key: _key,
           at: at,
-          direction: direction,
+          hash: hash,
           amount: amount.to_h,
-          how: how,
-          message: message
+          fee: fee.to_h,
+          label: label
         }
-
-        output[:invoice] = invoice.to_h unless invoice.nil?
-
-        output
       end
     end
   end

data/models/wallet.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative './satoshis'
+
+module Lighstorm
+  module Models
+    class Wallet
+      attr_reader :_key, :at
+
+      def initialize(data)
+        @data = data
+
+        @_key = @data[:_key]
+        @at = @data[:at]
+      end
+
+      def lightning
+        @lightning ||= Satoshis.new(millisatoshis: @data[:lightning][:millisatoshis])
+      end
+
+      def bitcoin
+        @bitcoin ||= Satoshis.new(millisatoshis: @data[:bitcoin][:millisatoshis])
+      end
+
+      def total
+        @total ||= Satoshis.new(millisatoshis: @data[:total][:millisatoshis])
+      end
+
+      def to_h
+        {
+          _key: _key,
+          at: at,
+          lightning: lightning.to_h,
+          bitcoin: bitcoin.to_h,
+          total: total.to_h
+        }
+      end
+    end
+  end
+end

data/ports/dsl/lighstorm.rb

@@ -11,7 +11,9 @@ require_relative '../../controllers/channel'
 require_relative '../../controllers/payment'
 require_relative '../../controllers/forward'
 require_relative '../../controllers/invoice'
-require_relative '../../controllers/transaction'
+require_relative '../../controllers/activity'
+require_relative '../../controllers/connection'
+require_relative '../../controllers/wallet'
 
 module Lighstorm
   Node = Controllers::Node
@@ -19,12 +21,14 @@ module Lighstorm
   Payment = Controllers::Payment
   Forward = Controllers::Forward
   Invoice = Controllers::Invoice
-  Transaction = Controllers::Transaction
+  Activity = Controllers::Activity
+  Connection = Controllers::Connection
+  Wallet = Controllers::Wallet
 
   Satoshis = Models::Satoshis
 
-  def self.config!(config)
-    LND.instance.config = config
+  def self.connect!(...)
+    Controllers::Connection.connect!(...)
   end
 
   def self.inject_middleware!(middleware_lambda)

data/ports/grpc.rb

@@ -7,14 +7,42 @@ require_relative 'grpc/session'
 module Lighstorm
   module Ports
     class GRPC
-      def initialize(service, service_key, &handler)
+      class Impersonatable
+        def initialize(id)
+          @id = id
+        end
+
+        def session
+          GRPCSession.new(self)
+        end
+
+        def method_missing(method_name, *_args, &block)
+          service_key = method_name.to_sym
+
+          unless LND.instance.as(@id).respond_to?(service_key)
+            raise ArgumentError,
+                  "Method `#{method_name}` doesn't exist."
+          end
+
+          GRPC.new(LND.instance.as(@id).send(service_key), service_key, @id, &block)
+        end
+
+        def respond_to_missing?(method_name, include_private = false)
+          service_key = method_name.to_sym
+
+          LND.instance.as(@id).respond_to?(service_key) || super
+        end
+      end
+
+      def initialize(service, service_key, as = nil, &handler)
         @service = service
         @service_key = service_key
         @handler = handler
+        @as = as
       end
 
       def call!(call_key, *args, &block)
-        key = "#{@service_key}.#{call_key}"
+        key = "[#{@as}]:#{@service_key}.#{call_key}"
 
         if block.nil?
           response = Cache.for(key, params: args&.first) do

data/static/cache.rb

@@ -3,6 +3,9 @@
 module Lighstorm
   module Static
     CACHE = {
+      lightning_channel_balance: false,
+      lightning_wallet_balance: false,
+      lightning_get_transactions: false,
       lightning_update_channel_policy: false,
       lightning_add_invoice: false,
       router_send_payment_v2: false,

data/static/spec.rb

@@ -4,7 +4,7 @@ module Lighstorm
   module Static
     SPEC = {
       name: 'lighstorm',
-      version: '0.0.12',
+      version: '0.0.14',
       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.12
+  version: 0.0.14
 platform: ruby
 authors:
 - icebaker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-13 00:00:00.000000000 Z
+date: 2023-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -36,14 +36,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.5
+        version: 0.0.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.5
+        version: 0.0.7
 - !ruby/object:Gem::Dependency
   name: zache
   requirement: !ruby/object:Gem::Requirement
@@ -85,15 +85,21 @@ files:
 - adapters/edges/payment/purpose.rb
 - adapters/invoice.rb
 - adapters/nodes/node.rb
+- adapters/transaction.rb
+- adapters/wallet.rb
 - components/cache.rb
 - components/lnd.rb
 - controllers/action.rb
+- controllers/activity.rb
+- controllers/activity/all.rb
 - controllers/channel.rb
 - controllers/channel/actions/apply_gossip.rb
 - controllers/channel/actions/update_fee.rb
 - controllers/channel/all.rb
 - controllers/channel/find_by_id.rb
 - controllers/channel/mine.rb
+- controllers/concerns/impersonatable.rb
+- controllers/connection.rb
 - controllers/forward.rb
 - controllers/forward/all.rb
 - controllers/forward/group_by_channel.rb
@@ -117,7 +123,8 @@ files:
 - controllers/secret/valid_proof.rb
 - controllers/transaction.rb
 - controllers/transaction/all.rb
-- deleted.sh
+- controllers/wallet.rb
+- controllers/wallet/balance.rb
 - docs/.nojekyll
 - docs/README.md
 - docs/_coverpage.md
@@ -130,6 +137,7 @@ files:
 - docs/vendor/prismjs/prism-tomorrow.min.css
 - helpers/time_expression.rb
 - lighstorm.gemspec
+- models/activity.rb
 - models/concerns/protectable.rb
 - models/connections/channel_node.rb
 - models/connections/channel_node/accounting.rb
@@ -155,6 +163,7 @@ files:
 - models/satoshis.rb
 - models/secret.rb
 - models/transaction.rb
+- models/wallet.rb
 - ports/dsl/lighstorm.rb
 - ports/dsl/lighstorm/errors.rb
 - ports/grpc.rb

data/deleted.sh

@@ -1 +0,0 @@
-	deleted.sh