lighstorm 0.0.4 → 0.0.5

data/models/connections/channel_node/fee.rb

@@ -4,6 +4,7 @@ require 'securerandom'
 
 require_relative '../../satoshis'
 require_relative '../../rate'
+require_relative '../../concerns/protectable'
 
 require_relative '../../../components/lnd'
 require_relative '../../../controllers/channel/actions/update_fee'
@@ -11,24 +12,38 @@ require_relative '../../../controllers/channel/actions/update_fee'
 module Lighstorm
   module Models
     class Fee
+      include Protectable
+
       def initialize(policy, data)
         @policy = policy
         @data = data
       end
 
       def base
+        return nil unless @data[:base]
+
         @base ||= Satoshis.new(milisatoshis: @data[:base][:milisatoshis])
       end
 
       def rate
+        return nil unless @data[:rate]
+
         @rate ||= Rate.new(parts_per_million: @data[:rate][:parts_per_million])
       end
 
       def to_h
-        {
-          base: base.to_h,
-          rate: rate.to_h
-        }
+        result = {}
+
+        result[:base] = base.to_h if @data[:base]
+        result[:rate] = rate.to_h if @data[:rate]
+
+        return nil if result.empty?
+
+        result
+      end
+
+      def dump
+        Marshal.load(Marshal.dump(@data))
       end
 
       def update(params, preview: false, fake: false)
@@ -38,29 +53,23 @@ module Lighstorm
       end
 
       def base=(value)
-        validate_token!(value)
+        protect!(value)
 
         @base = value[:value]
-      end
 
-      def rate=(value)
-        validate_token!(value)
+        @data[:base] = { milisatoshis: @base.milisatoshis }
 
-        @rate = value[:value]
+        base
       end
 
-      def prepare_token!(token)
-        @token = token
-      end
-
-      private
+      def rate=(value)
+        protect!(value)
 
-      def validate_token!(value)
-        token = value.is_a?(Hash) ? value[:token] : nil
+        @rate = value[:value]
 
-        raise OperationNotAllowedError if token.nil? || @token.nil? || token != @token
+        @data[:rate] = { parts_per_million: @rate.parts_per_million }
 
-        @token = nil
+        rate
       end
     end
   end

data/models/connections/channel_node/htlc/blocks/delta.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative '../../../../concerns/protectable'
+
+module Lighstorm
+  module Models
+    class BlocksDelta
+      include Protectable
+
+      def initialize(data)
+        @data = data
+      end
+
+      def minimum
+        @minimum ||= @data[:minimum]
+      end
+
+      def to_h
+        {
+          minimum: minimum
+        }
+      end
+
+      def dump
+        Marshal.load(Marshal.dump(@data))
+      end
+
+      def minimum=(value)
+        protect!(value)
+
+        @minimum = value[:value]
+
+        @data[:minimum] = @minimum
+
+        minimum
+      end
+    end
+  end
+end

data/models/connections/channel_node/htlc.rb

@@ -2,42 +2,48 @@
 
 require_relative '../../satoshis'
 require_relative '../../rate'
-
-require_relative '../../../components/lnd'
+require_relative '../../concerns/protectable'
+require_relative 'htlc/blocks/delta'
 
 module Lighstorm
   module Models
     class HTLC
+      include Protectable
+
       def initialize(data)
         @data = data
       end
 
       def minimum
-        @minimum ||= Satoshis.new(milisatoshis: @data[:minimum][:milisatoshis])
+        @minimum ||= if @data[:minimum]
+                       Satoshis.new(
+                         milisatoshis: @data[:minimum][:milisatoshis]
+                       )
+                     end
       end
 
       def maximum
-        @maximum ||= Satoshis.new(milisatoshis: @data[:maximum][:milisatoshis])
+        @maximum ||= if @data[:maximum]
+                       Satoshis.new(
+                         milisatoshis: @data[:maximum][:milisatoshis]
+                       )
+                     end
       end
 
       def blocks
         @blocks ||= Struct.new(:data) do
           def delta
-            Struct.new(:data) do
-              def minimum
-                data[:minimum]
-              end
-
-              def to_h
-                { minimum: minimum }
-              end
-            end.new(data[:delta])
+            @delta ||= BlocksDelta.new(data[:delta] || {})
+          end
+
+          def dump
+            { delta: delta.dump }
           end
 
           def to_h
             { delta: delta.to_h }
           end
-        end.new(@data[:blocks])
+        end.new(@data[:blocks] || {})
       end
 
       def to_h
@@ -47,6 +53,34 @@ module Lighstorm
           blocks: blocks.to_h
         }
       end
+
+      def dump
+        result = Marshal.load(Marshal.dump(@data))
+
+        result = result.merge({ blocks: blocks.dump }) if @data[:blocks]
+
+        result
+      end
+
+      def minimum=(value)
+        protect!(value)
+
+        @minimum = value[:value]
+
+        @data[:minimum] = { milisatoshis: @minimum.milisatoshis }
+
+        minimum
+      end
+
+      def maximum=(value)
+        protect!(value)
+
+        @maximum = value[:value]
+
+        @data[:maximum] = { milisatoshis: @maximum.milisatoshis }
+
+        maximum
+      end
     end
   end
 end

data/models/connections/channel_node/policy.rb

@@ -14,16 +14,25 @@ module Lighstorm
       end
 
       def fee
-        @fee ||= @data ? Fee.new(self, @data[:fee]) : nil
+        @fee ||= Fee.new(self, @data ? @data[:fee] : {})
       end
 
       def htlc
-        @htlc ||= @data ? HTLC.new(@data[:htlc]) : nil
+        @htlc ||= HTLC.new(@data ? @data[:htlc] : {})
       end
 
       def to_h
         { fee: fee.to_h, htlc: htlc.to_h }
       end
+
+      def dump
+        result = Marshal.load(Marshal.dump(@data))
+
+        result = result.merge({ fee: fee.dump }) if @data && @data[:fee]
+        result = result.merge({ htlc: htlc.dump }) if @data && @data[:htlc]
+
+        result
+      end
     end
   end
 end

data/models/connections/channel_node.rb

@@ -9,12 +9,21 @@ require_relative '../errors'
 module Lighstorm
   module Models
     class ChannelNode
+      include Protectable
+
+      attr_reader :state
+
       def initialize(data, is_mine, transaction)
         @data = data
+        @state = data[:state]
         @is_mine = is_mine
         @transaction = transaction
       end
 
+      def active?
+        state == 'active'
+      end
+
       def node
         @node ||= Node.new(@data[:node])
       end
@@ -30,13 +39,36 @@ module Lighstorm
       end
 
       def to_h
-        restult = { node: node.to_h }
+        restult = { state: state, node: node.to_h }
 
         restult[:accounting] = accounting.to_h if @is_mine
         restult[:policy] = policy.to_h if @data[:policy]
 
         restult
       end
+
+      def dump
+        result = Marshal.load(Marshal.dump(@data)).merge(
+          {
+            node: node.dump,
+            policy: policy.dump
+          }
+        )
+
+        result[:accounting] = accounting.dump if @is_mine
+        result.delete(:policy) if result[:policy].nil?
+
+        result
+      end
+
+      def state=(value)
+        protect!(value)
+
+        @state = value[:value]
+        @data[:state] = @state
+
+        state
+      end
     end
   end
 end

data/models/edges/channel/accounting.rb

@@ -2,10 +2,13 @@
 
 require_relative '../../satoshis'
 require_relative '../../errors'
+require_relative '../../concerns/protectable'
 
 module Lighstorm
   module Models
     class ChannelAccounting
+      include Protectable
+
       def initialize(data, is_mine)
         @data = data
         @is_mine = is_mine
@@ -63,6 +66,20 @@ module Lighstorm
           }
         end
       end
+
+      def dump
+        Marshal.load(Marshal.dump(@data))
+      end
+
+      def capacity=(value)
+        protect!(value)
+
+        @capacity = value[:value]
+
+        @data[:capacity][:milisatoshis] = @capacity.milisatoshis
+
+        capacity
+      end
     end
   end
 end

data/models/edges/channel.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'time'
-require 'date'
 
 require_relative '../../ports/grpc'
 require_relative '../../adapters/edges/channel'
@@ -12,6 +11,7 @@ require_relative '../../components/cache'
 require_relative '../nodes/node'
 require_relative 'channel/accounting'
 
+require_relative '../../controllers/channel/actions/apply_gossip'
 require_relative '../connections/channel_node'
 require_relative '../satoshis'
 
@@ -20,7 +20,7 @@ require_relative '../errors'
 module Lighstorm
   module Models
     class Channel
-      attr_reader :data, :_key, :id, :opened_at, :up_at, :active, :exposure
+      attr_reader :data, :_key, :id
 
       def initialize(data)
         @data = data
@@ -57,10 +57,16 @@ module Lighstorm
         @data[:up_at]
       end
 
-      def active
+      def active?
         ensure_mine!
 
-        @data[:active]
+        @data[:state] == 'active'
+      end
+
+      def state
+        ensure_mine!
+
+        @data[:state]
       end
 
       def accounting
@@ -126,7 +132,7 @@ module Lighstorm
             id: id,
             opened_at: opened_at,
             up_at: up_at,
-            active: active,
+            state: state,
             exposure: exposure,
             accounting: accounting.to_h,
             partner: partner.to_h,
@@ -148,6 +154,34 @@ module Lighstorm
         end
       end
 
+      def dump
+        result = Marshal.load(Marshal.dump(@data)).merge(
+          { partners: partners.map(&:dump) }
+        )
+
+        result[:accounting] = accounting.dump if known?
+
+        result
+      end
+
+      def self.adapt(gossip: nil, dump: nil)
+        raise TooManyArgumentsError, 'you need to pass gossip: or dump:, not both' if !gossip.nil? && !dump.nil?
+
+        raise ArgumentError, 'missing gossip: or dump:' if gossip.nil? && dump.nil?
+
+        if !gossip.nil?
+          new(Adapter::Channel.subscribe_channel_graph(gossip))
+        elsif !dump.nil?
+          new(dump)
+        end
+      end
+
+      def apply!(gossip:)
+        Controllers::Channel::ApplyGossip.perform(
+          self, gossip
+        )
+      end
+
       private
 
       def ensure_known!

data/models/edges/forward.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'time'
-require 'date'
 
 require_relative '../satoshis'
 

data/models/edges/payment.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'time'
-require 'date'
 
 require_relative '../satoshis'
 

data/models/errors.rb

@@ -6,6 +6,9 @@ module Lighstorm
 
     class ToDoError < LighstormError; end
 
+    class TooManyArgumentsError < LighstormError; end
+    class IncoherentGossipError < LighstormError; end
+    class MissingGossipHandlerError < LighstormError; end
     class MissingCredentialsError < LighstormError; end
     class MissingMilisatoshisError < LighstormError; end
     class MissingPartsPerMillionError < LighstormError; end

data/models/nodes/node/lightning.rb

@@ -20,6 +20,12 @@ module Lighstorm
           version: version
         }
       end
+
+      def dump
+        Marshal.load(
+          Marshal.dump({ implementation: implementation, version: version })
+        )
+      end
     end
   end
 end

data/models/nodes/node/platform.rb

@@ -37,6 +37,12 @@ module Lighstorm
 
         response
       end
+
+      def dump
+        data = Marshal.load(Marshal.dump(@data))
+        data.merge(lightning: lightning.dump) if @node.myself?
+        data
+      end
     end
   end
 end

data/models/nodes/node.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
+require_relative '../../controllers/node/actions/apply_gossip'
 require_relative '../../controllers/channel'
+require_relative '../../adapters/nodes/node'
+require_relative '../concerns/protectable'
 require_relative '../errors'
 
 require_relative 'node/platform'
@@ -8,6 +11,8 @@ require_relative 'node/platform'
 module Lighstorm
   module Models
     class Node
+      include Protectable
+
       attr_reader :data, :_key, :alias, :public_key, :color
 
       def initialize(data)
@@ -46,6 +51,52 @@ module Lighstorm
 
         result
       end
+
+      def dump
+        result = Marshal.load(Marshal.dump(@data))
+
+        result[:platform] = platform.dump if @data[:platform]
+
+        result
+      end
+
+      def alias=(value)
+        protect!(value)
+
+        @alias = value[:value]
+
+        @data[:alias] = @alias
+
+        self.alias
+      end
+
+      def color=(value)
+        protect!(value)
+
+        @color = value[:value]
+
+        @data[:color] = @color
+
+        color
+      end
+
+      def self.adapt(gossip: nil, dump: nil)
+        raise TooManyArgumentsError, 'you need to pass gossip: or dump:, not both' if !gossip.nil? && !dump.nil?
+
+        raise ArgumentError, 'missing gossip: or dump:' if gossip.nil? && dump.nil?
+
+        if !gossip.nil?
+          new(Adapter::Node.subscribe_channel_graph(gossip))
+        elsif !dump.nil?
+          new(dump)
+        end
+      end
+
+      def apply!(gossip:)
+        Controllers::Node::ApplyGossip.perform(
+          self, gossip
+        )
+      end
     end
   end
 end

data/models/payment_request.rb

@@ -11,7 +11,10 @@ module Lighstorm
       def initialize(data)
         @data = data
 
-        @_key = Digest::SHA256.hexdigest(data[:code])
+        @_key = data[:_key] || Digest::SHA256.hexdigest(
+          data[:code] || "#{data[:code][:amount][:milisatoshis]}#{Time.now}"
+        )
+
         @code = data[:code]
 
         @address = data[:address]
@@ -34,7 +37,7 @@ module Lighstorm
           def to_h
             { memo: memo, hash: hash }
           end
-        end.new(@data[:description])
+        end.new(@data[:description] || {})
       end
 
       def secret
@@ -51,7 +54,7 @@ module Lighstorm
             # Don't expose 'secret' by default: Security
             { hash: hash }
           end
-        end.new(@data[:secret])
+        end.new(@data[:secret] || {})
       end
 
       def to_h

data/ports/grpc/session.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Lighstorm
+  module Ports
+    class GRPCSession
+      attr_reader :calls
+
+      def initialize(grpc)
+        @grpc = grpc
+        @calls = {}
+      end
+
+      def handler(key, &block)
+        @calls[key] = 0 unless @calls.key?(key)
+        @calls[key] += 1
+        block.call
+      end
+
+      def method_missing(method_name, *args)
+        @grpc.send(method_name, *args) do |key, &block|
+          handler(key, &block)
+        end
+      end
+    end
+  end
+end

data/ports/grpc.rb

@@ -2,13 +2,15 @@
 
 require_relative '../components/cache'
 require_relative '../components/lnd'
+require_relative 'grpc/session'
 
 module Lighstorm
   module Ports
     class GRPC
-      def initialize(service, service_key)
+      def initialize(service, service_key, &handler)
         @service = service
         @service_key = service_key
+        @handler = handler
       end
 
       def call!(call_key, *args, &block)
@@ -17,12 +19,24 @@ module Lighstorm
         if block.nil?
           response = Cache.for(key, params: args&.first) do
             LND.instance.middleware(key) do
-              @service.send(call_key, *args, &block)
+              if @handler
+                @handler.call(call_key) do
+                  @service.send(call_key, *args, &block)
+                end
+              else
+                @service.send(call_key, *args, &block)
+              end
             end
           end
         else
           LND.instance.middleware(key) do
-            @service.send(call_key, *args, &block)
+            if @handler
+              @handler.call(call_key) do
+                @service.send(call_key, *args, &block)
+              end
+            else
+              @service.send(call_key, *args, &block)
+            end
           end
         end
       end
@@ -41,7 +55,11 @@ module Lighstorm
         @service.respond_to?(call_key) || super
       end
 
-      def self.method_missing(method_name, *_args)
+      def self.session
+        GRPCSession.new(self)
+      end
+
+      def self.method_missing(method_name, *_args, &block)
         service_key = method_name.to_sym
 
         unless LND.instance.client.respond_to?(service_key)
@@ -49,7 +67,7 @@ module Lighstorm
                 "Method `#{method_name}` doesn't exist."
         end
 
-        new(LND.instance.client.send(service_key), service_key)
+        new(LND.instance.client.send(service_key), service_key, &block)
       end
 
       def self.respond_to_missing?(method_name, include_private = false)

data/static/spec.rb

@@ -4,7 +4,7 @@ module Lighstorm
   module Static
     SPEC = {
       name: 'lighstorm',
-      version: '0.0.4',
+      version: '0.0.5',
       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.',