lighstorm 0.0.13 → 0.0.14

data/docs/README.md

@@ -27,7 +27,7 @@ Lighstorm::Channel.mine.first.myself.node.alias
 Add to your `Gemfile`:
 
 ```ruby
-gem 'lighstorm', '~> 0.0.13'
+gem 'lighstorm', '~> 0.0.14'
 ```
 
 Run `bundle install`.
@@ -36,7 +36,7 @@ Run `bundle install`.
 ```ruby
 require 'lighstorm'
 
-puts Lighstorm.version # => 0.0.13
+puts Lighstorm.version # => 0.0.14
 
 Lighstorm::Invoice.create(
   description: 'Coffee', amount: { millisatoshis: 1000 }, payable: 'once'
@@ -193,6 +193,46 @@ Lighstorm.connect!(
 )
 ```
 
+## Multiclient
+
+Multiclient allows you to establish connections with multiple nodes and effortlessly switch between them.
+
+```ruby
+require 'lighstorm'
+
+Lighstorm::Connection.connect!(
+  address: '127.0.0.1:10009',
+  certificate_path: '/lnd/tls.cert',
+  macaroon_path: '/lnd/data/chain/bitcoin/mainnet/admin.macaroon'
+)
+
+Lighstorm::Connection.add!(
+  'alice',
+  'lndconnect://127.0.0.2:10009?cert=MIICJz...JBEERQ&macaroon=AgEDbG...45ukJ4'
+)
+
+Lighstorm::Connection.add!(
+  'bob',
+  address: '127.0.0.3:10009',
+  certificate: 'LS0tLS1CRU...UtLS0tLQo=',
+  macaroon: 'AgEDbG5kAv...inv45ukJ4='
+)
+
+Lighstorm::Connection.default[:address] # => '127.0.0.1:10009'
+Lighstorm::Connection.for('alice')[:address] # => '127.0.0.2:10009'
+Lighstorm::Connection.for('bob')[:address] # => '127.0.0.3:10009'
+
+Lighstorm::Node.myself.alias # => 'icebaker/old-stone'
+Lighstorm::Node.as('alice').myself.alias # => alice
+Lighstorm::Node.as('bob').myself.alias # => bob
+
+Lighstorm::Connection.all # => ['alice', 'bob']
+
+Lighstorm::Connection.remove!('bob')
+
+Lighstorm::Connection.all # => ['alice']
+```
+
 ## Docker and Remote Access
 
 To connect to an LND node through a Docker container or remote host, you may need to adjust your certificate settings. Follow these steps:
@@ -257,6 +297,8 @@ channel.partner.policy.fee.rate.parts_per_million
 channel.myself.accounting.balance.millisatoshis
 channel.myself.node.alias
 channel.myself.policy.fee.rate.parts_per_million
+
+channel.myself.initiator?
 ```
 
 [![This is an image representing Channel as a graph.](https://raw.githubusercontent.com/icebaker/assets/main/lighstorm/graph-channel.png)](https://raw.githubusercontent.com/icebaker/assets/main/lighstorm/graph-channel.png)
@@ -520,6 +562,7 @@ channel.partner.policy.htlc.blocks.delta.minimum
 channel.myself
 channel.myself.state
 channel.myself.active?
+channel.myself.initiator?
 
 channel.myself.node.public_key
 channel.myself.node.alias
@@ -914,6 +957,21 @@ Lighstorm::Payment.all(
 )
 ```
 
+## Wallet
+
+```ruby
+balance = Lighstorm::Wallet.balance
+
+balance.at
+
+balance.lightning.millisatoshis
+balance.bitcoin.millisatoshis
+
+balance.total.millisatoshis
+
+balance.to_h
+```
+
 ## Forward
 
 [![This is an image representing Forward as a graph.](https://raw.githubusercontent.com/icebaker/assets/main/lighstorm/graph-forward.png)](https://raw.githubusercontent.com/icebaker/assets/main/lighstorm/graph-forward.png)
@@ -1127,19 +1185,24 @@ LighstormError
 
 ArgumentError
 IncoherentGossipError
+InvoiceMayHaveMultiplePaymentsError
+MissingComponentsError
 MissingCredentialsError
 MissingGossipHandlerError
 MissingPartsPerMillionError
+MissingTTLError
 NegativeNotAllowedError
 NotYourChannelError
 NotYourNodeError
 OperationNotAllowedError
 TooManyArgumentsError
-UnexpectedNumberOfHTLCsError
 UnknownChannelError
-UpdateChannelPolicyError
 
+RequestError
+
+NoInvoiceFoundError
 PaymentError
+UpdateChannelPolicyError
 
 AlreadyPaidError
 AmountForNonZeroError
@@ -1158,7 +1221,7 @@ gem 'lighstorm', path: '/home/user/lighstorm'
 # demo.rb
 require 'lighstorm'
 
-puts Lighstorm.version # => 0.0.13
+puts Lighstorm.version # => 0.0.14
 ```
 
 ```sh
@@ -1395,13 +1458,13 @@ gem build lighstorm.gemspec
 
 gem signin
 
-gem push lighstorm-0.0.13.gem
+gem push lighstorm-0.0.14.gem
 ```
 
 _________________
 
 <center>
-  lighstorm 0.0.13
+  lighstorm 0.0.14
   |
   <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.13
+0.0.14
 
 ⚠️ _Warning: Early-stage, breaking changes are expected._
 

data/docs/index.html

@@ -18,7 +18,7 @@
   <script>
     window.$docsify = {
       coverpage: true,
-      name: 'Lighstorm 0.0.13',
+      name: 'Lighstorm 0.0.14',
       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.6'
+  spec.add_dependency 'lnd-client', '~> 0.0.7'
   spec.add_dependency 'zache', '~> 0.12.0'
 
   spec.metadata['rubygems_mfa_required'] = 'true'

data/models/activity.rb

@@ -24,7 +24,7 @@ module Lighstorm
       end
 
       def invoice
-        @invoice ||= @data[:data][:invoice].nil? ? nil : Invoice.new(@data[:data][:invoice])
+        @invoice ||= @data[:data][:invoice].nil? ? nil : Invoice.new(@data[:data][:invoice], nil)
       end
 
       def transaction
@@ -36,8 +36,9 @@ module Lighstorm
           _key: _key,
           at: at,
           direction: direction,
-          amount: amount.to_h,
+          layer: layer,
           how: how,
+          amount: amount.to_h,
           message: message
         }
 

data/models/connections/channel_node/fee.rb

@@ -6,7 +6,6 @@ require_relative '../../satoshis'
 require_relative '../../rate'
 require_relative '../../concerns/protectable'
 
-require_relative '../../../components/lnd'
 require_relative '../../../controllers/channel/actions/update_fee'
 
 module Lighstorm
@@ -14,8 +13,9 @@ module Lighstorm
     class Fee
       include Protectable
 
-      def initialize(policy, data)
+      def initialize(policy, components, data)
         @policy = policy
+        @components = components
         @data = data
       end
 
@@ -47,7 +47,10 @@ module Lighstorm
       end
 
       def update(params, preview: false, &vcr)
+        raise MissingComponentsError if @components.nil?
+
         Controllers::Channel::UpdateFee.perform(
+          @components,
           @policy, @policy.transaction, params,
           preview: preview, &vcr
         )

data/models/connections/channel_node/policy.rb

@@ -8,13 +8,14 @@ module Lighstorm
     class Policy
       attr_reader :transaction
 
-      def initialize(data, transaction)
+      def initialize(data, components, transaction)
         @data = data
+        @components = components
         @transaction = transaction
       end
 
       def fee
-        @fee ||= Fee.new(self, @data ? @data[:fee] : {})
+        @fee ||= Fee.new(self, @components, @data ? @data[:fee] : {})
       end
 
       def htlc

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