lighstorm 0.0.14 → 0.0.16

data/docs/_coverpage.md

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

data/docs/index.html

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

data/lighstorm.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['ports/dsl']
 
   spec.add_dependency 'dotenv', '~> 2.8', '>= 2.8.1'
-  spec.add_dependency 'lnd-client', '~> 0.0.7'
+  spec.add_dependency 'lnd-client', '~> 0.0.9'
   spec.add_dependency 'zache', '~> 0.12.0'
 
   spec.metadata['rubygems_mfa_required'] = 'true'

data/models/bitcoin/address.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require_relative '../../controllers/bitcoin/address/actions/pay'
+
+module Lighstorm
+  module Model
+    module Bitcoin
+      class Address
+        attr_reader :_key, :created_at, :code
+
+        def initialize(data, components)
+          @data = data
+          @components = components
+
+          @_key = @data[:_key]
+          @created_at = @data[:created_at]
+          @code = @data[:code]
+        end
+
+        def pay(
+          amount:, fee:,
+          description: nil, required_confirmations: 6,
+          preview: false, &vcr
+        )
+          Controller::Bitcoin::Address::Pay.perform(
+            @components,
+            address_code: code,
+            amount: amount, fee: fee, description: description,
+            required_confirmations: required_confirmations,
+            preview: preview,
+            &vcr
+          )
+        end
+
+        def to_h
+          if created_at || _key
+            {
+              _key: _key,
+              created_at: created_at,
+              code: code
+            }
+          else
+            { code: code }
+          end
+        end
+      end
+    end
+  end
+end

data/models/bitcoin/transaction.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative '../satoshis'
+
+module Lighstorm
+  module Model
+    module Bitcoin
+      class Transaction
+        attr_reader :_key, :at, :hash, :description
+
+        def initialize(data)
+          @data = data
+
+          @_key = @data[:_key]
+          @at = @data[:at]
+          @hash = @data[:hash]
+          @description = @data[:description]
+        end
+
+        def amount
+          @amount ||= Satoshis.new(millisatoshis: @data[:amount][:millisatoshis])
+        end
+
+        def fee
+          @fee ||= Satoshis.new(millisatoshis: @data[:fee][:millisatoshis])
+        end
+
+        def to_h
+          {
+            _key: _key,
+            at: at,
+            hash: hash,
+            amount: amount.to_h,
+            fee: fee.to_h,
+            description: description
+          }
+        end
+      end
+    end
+  end
+end

data/models/concerns/protectable.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Lighstorm
-  module Models
+  module Model
     module Protectable
       def prepare_token!(token)
         @token = token

data/models/errors.rb

@@ -14,22 +14,21 @@ module Lighstorm
 
     class ToDoError < LighstormError; end
 
-    class MissingComponentsError < LighstormError; end
     class ArgumentError < LighstormError; end
-    class TooManyArgumentsError < LighstormError; end
     class IncoherentGossipError < LighstormError; end
-    class MissingGossipHandlerError < LighstormError; end
+    class InvoiceMayHaveMultiplePaymentsError < LighstormError; end
+    class MissingComponentsError < LighstormError; end
     class MissingCredentialsError < LighstormError; end
+    class MissingGossipHandlerError < LighstormError; end
     class MissingPartsPerMillionError < LighstormError; end
     class MissingTTLError < LighstormError; end
     class NegativeNotAllowedError < LighstormError; end
     class NotYourChannelError < LighstormError; end
     class NotYourNodeError < LighstormError; end
     class OperationNotAllowedError < LighstormError; end
+    class TooManyArgumentsError < LighstormError; end
     class UnknownChannelError < LighstormError; end
 
-    class InvoiceMayHaveMultiplePaymentsError < LighstormError; end
-
     class RequestError < LighstormError
       attr_reader :request, :response, :result, :grpc
 
@@ -53,15 +52,15 @@ module Lighstorm
       end
     end
 
-    class UpdateChannelPolicyError < RequestError; end
-
+    class AmountBelowDustLimitError < RequestError; end
     class NoInvoiceFoundError < RequestError; end
+    class UpdateChannelPolicyError < RequestError; end
 
     class PaymentError < RequestError; end
 
-    class NoRouteFoundError < PaymentError; end
     class AlreadyPaidError < PaymentError; end
     class AmountForNonZeroError < PaymentError; end
     class MissingMillisatoshisError < PaymentError; end
+    class NoRouteFoundError < PaymentError; end
   end
 end

data/models/lightning/connections/channel_node/accounting.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative '../../../satoshis'
+
+module Lighstorm
+  module Model
+    module Lightning
+      class ChannelNodeAccounting
+        def initialize(data)
+          @data = data
+        end
+
+        def balance
+          @balance ||= Satoshis.new(millisatoshis: @data[:balance][:millisatoshis])
+        end
+
+        def to_h
+          { balance: balance.to_h }
+        end
+
+        def dump
+          Marshal.load(Marshal.dump(@data))
+        end
+      end
+    end
+  end
+end

data/models/lightning/connections/channel_node/fee.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require 'securerandom'
+
+require_relative '../../../satoshis'
+require_relative '../../rate'
+require_relative '../../../concerns/protectable'
+
+require_relative '../../../../controllers/lightning/channel/actions/update_fee'
+
+module Lighstorm
+  module Model
+    module Lightning
+      class Fee
+        include Protectable
+
+        def initialize(policy, components, data)
+          @policy = policy
+          @components = components
+          @data = data
+        end
+
+        def base
+          return nil unless @data[:base]
+
+          @base ||= Satoshis.new(millisatoshis: @data[:base][:millisatoshis])
+        end
+
+        def rate
+          return nil unless @data[:rate]
+
+          @rate ||= Rate.new(parts_per_million: @data[:rate][:parts_per_million])
+        end
+
+        def 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, &vcr)
+          raise MissingComponentsError if @components.nil?
+
+          Controller::Lightning::Channel::UpdateFee.perform(
+            @components,
+            @policy, @policy.transaction, params,
+            preview: preview, &vcr
+          )
+        end
+
+        def base=(value)
+          protect!(value)
+
+          @base = value[:value]
+
+          @data[:base] = { millisatoshis: @base.millisatoshis }
+
+          base
+        end
+
+        def rate=(value)
+          protect!(value)
+
+          @rate = value[:value]
+
+          @data[:rate] = { parts_per_million: @rate.parts_per_million }
+
+          rate
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative '../../../../../concerns/protectable'
+
+module Lighstorm
+  module Model
+    module Lightning
+      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
+end

data/models/lightning/connections/channel_node/htlc.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require_relative '../../../satoshis'
+require_relative '../../rate'
+require_relative '../../../concerns/protectable'
+require_relative 'htlc/blocks/delta'
+
+module Lighstorm
+  module Model
+    module Lightning
+      class HTLC
+        include Protectable
+
+        def initialize(data)
+          @data = data
+        end
+
+        def minimum
+          @minimum ||= if @data[:minimum]
+                         Satoshis.new(
+                           millisatoshis: @data[:minimum][:millisatoshis]
+                         )
+                       end
+        end
+
+        def maximum
+          @maximum ||= if @data[:maximum]
+                         Satoshis.new(
+                           millisatoshis: @data[:maximum][:millisatoshis]
+                         )
+                       end
+        end
+
+        def blocks
+          @blocks ||= Struct.new(:data) do
+            def 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
+
+        def to_h
+          {
+            minimum: minimum.to_h,
+            maximum: maximum.to_h,
+            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] = { millisatoshis: @minimum.millisatoshis }
+
+          minimum
+        end
+
+        def maximum=(value)
+          protect!(value)
+
+          @maximum = value[:value]
+
+          @data[:maximum] = { millisatoshis: @maximum.millisatoshis }
+
+          maximum
+        end
+      end
+    end
+  end
+end

data/models/lightning/connections/channel_node/policy.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative 'fee'
+require_relative 'htlc'
+
+module Lighstorm
+  module Model
+    module Lightning
+      class Policy
+        attr_reader :transaction
+
+        def initialize(data, components, transaction)
+          @data = data
+          @components = components
+          @transaction = transaction
+        end
+
+        def fee
+          @fee ||= Fee.new(self, @components, @data ? @data[:fee] : {})
+        end
+
+        def htlc
+          @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
+end

data/models/lightning/connections/channel_node.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require_relative 'channel_node/policy'
+require_relative 'channel_node/accounting'
+
+require_relative '../nodes/node'
+require_relative '../../errors'
+
+module Lighstorm
+  module Model
+    module Lightning
+      class ChannelNode
+        include Protectable
+
+        attr_reader :state
+
+        def initialize(data, components, is_mine, transaction)
+          @data = data
+          @components = components
+          @state = data[:state]
+          @initiator = data[:initiator]
+          @is_mine = is_mine
+          @transaction = transaction
+        end
+
+        def active?
+          state == 'active'
+        end
+
+        def initiator?
+          @initiator
+        end
+
+        def node
+          @node ||= Node.new(@data[:node], @components)
+        end
+
+        def policy
+          @policy ||= Policy.new(@data[:policy], @components, @transaction)
+        end
+
+        def accounting
+          raise Errors::NotYourChannelError unless @is_mine
+
+          @accounting ||= @data[:accounting] ? ChannelNodeAccounting.new(@data[:accounting]) : nil
+        end
+
+        def 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]
+
+          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
+end

data/models/lightning/connections/forward_channel.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative '../edges/channel'
+
+module Lighstorm
+  module Model
+    module Lightning
+      class ForwardChannel
+        def initialize(data, components)
+          @data = data
+          @components = components
+        end
+
+        def amount
+          @amount ||= Satoshis.new(millisatoshis: @data[:amount][:millisatoshis])
+        end
+
+        def channel
+          @channel ||= Channel.new(@data[:channel], @components)
+        end
+
+        def to_h
+          {
+            amount: amount.to_h,
+            channel: channel.to_h
+          }
+        end
+      end
+    end
+  end
+end

data/models/lightning/connections/payment_channel.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require_relative '../edges/channel/hop'
+require_relative '../nodes/node'
+
+module Lighstorm
+  module Model
+    module Lightning
+      class PaymentChannel
+        attr_reader :hop
+
+        def initialize(data, payment)
+          @data = data
+
+          @hop = data[:hop]
+          @payment = payment
+        end
+
+        def first?
+          @hop == 1
+        end
+
+        def last?
+          @data[:is_last] == true
+        end
+
+        def amount
+          @amount ||= @data[:amount] ? Satoshis.new(millisatoshis: @data[:amount][:millisatoshis]) : nil
+        end
+
+        def fee
+          @fee ||= @data[:fee] ? Satoshis.new(millisatoshis: @data[:fee][:millisatoshis]) : nil
+        end
+
+        def channel
+          @channel ||= HopChannel.new(@data, @payment)
+        end
+
+        def to_h
+          result = {
+            hop: hop,
+            channel: channel.to_h
+          }
+
+          result[:amount] = amount.to_h if amount
+          if fee
+            result[:fee] = {
+              millisatoshis: fee.millisatoshis,
+              parts_per_million: fee.parts_per_million(amount.millisatoshis)
+            }
+          end
+
+          result
+        end
+      end
+    end
+  end
+end