lighstorm 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79b37e0a32c6d34ed5e4b05fc32eb894a808a08b9d2b6efea608be59644a94c9
-  data.tar.gz: ba7f317ff7699cdae5f9645f533e1779ca5de988aec3d8320172f2ec6807d0d1
+  metadata.gz: b9138a744ed51a4f15025f97f27e09ec5f3b100ef8def0a6d992895cb42f8b0c
+  data.tar.gz: 85435136bfbb78cc7c6baa74ea6a745e958d8eb3d3f08d42ef42d03a1d2230eb
 SHA512:
-  metadata.gz: b633147091290d526f184ca324964d9bc2fd13cb769a2009e7b732280ddd305fac82d63d2c9c735277ecc14f2fbdf4310d7b4d95611398753879746d170ed33b
-  data.tar.gz: e979df8953dd05ab5efceb268cde4f305190bc07d3304e304155ddef3ebf876f0444612b59420e2c7f24572d20b758e6521a7a569e3788eaf5b76037ee8ded7e
+  metadata.gz: e728481bdafde3c30dc23e85a8a48d0d3a5ac020410d14cbafe48b17d86661c2df86bab4f75a65099919adf09b3808ce19f410f915cb7287d2a7802884cc8f0a
+  data.tar.gz: 6efa2544e1d08c49966b322e10d8cc40f3d1de0238534665148bff8515686be8817abf039442308563d0cc6ee15d3cf71ef1486f55a946103dcdd663a735684b

data/.github/workflows/ruby-rspec-tests.yml

@@ -0,0 +1,39 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+# GitHub recommends pinning actions to a commit SHA.
+# To get a newer version, you will need to update the SHA.
+# You can also reference a tag or branch, but the action may change without warning.
+
+name: RSpec Tests
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  rspec:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/cache@v3
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-gems-
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@359bebbc29cbe6c87da6bc9ea3bc930432750108
+        with:
+          ruby-version: '3.0.0'
+          bundler-cache: true
+      - name: Install Dependencies
+        run: bundle install
+      - name: Run RSpec Tests
+        run: bundle exec rspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lighstorm (0.0.4)
+    lighstorm (0.0.5)
       dotenv (~> 2.8, >= 2.8.1)
       lnd-client (~> 0.0.5)
       zache (~> 0.12.0)

data/README.md

@@ -1,4 +1,4 @@
-# Lighstorm
+# Lighstorm [![Gem Version](https://badge.fury.io/rb/lighstorm.svg)](https://badge.fury.io/rb/lighstorm) ![RSpec Tests Status](https://github.com/icebaker/lighstorm/actions/workflows/ruby-rspec-tests.yml/badge.svg)
 
 > ⚠️ Warning: Early-stage, breaking changes are expected.
 
@@ -33,7 +33,7 @@ Although it tries to stay close to [Lightning's terminologies](https://docs.ligh
 Add to your `Gemfile`:
 
 ```ruby
-gem 'lighstorm', '~> 0.0.4'
+gem 'lighstorm', '~> 0.0.5'
 ```
 
 ```ruby
@@ -45,7 +45,7 @@ Lighstorm.config!(
   macaroon_path: '/lnd/data/chain/bitcoin/mainnet/admin.macaroon',
 )
 
-puts Lighstorm.version # => 0.0.4
+puts Lighstorm.version # => 0.0.5
 
 Lighstorm::Satoshis.new(
   milisatoshis: 75_621_650
@@ -67,7 +67,7 @@ gem 'lighstorm', path: '/home/user/lighstorm'
 # demo.rb
 require 'lighstorm'
 
-puts Lighstorm.version # => 0.0.4
+puts Lighstorm.version # => 0.0.5
 ```
 
 ```sh
@@ -100,5 +100,5 @@ gem build lighstorm.gemspec
 
 gem signin
 
-gem push lighstorm-0.0.4.gem
+gem push lighstorm-0.0.5.gem
 ```

data/adapters/connections/channel_node/policy.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Lighstorm
+  module Adapter
+    class Policy
+      def self.get_chan_info(grpc)
+        {
+          fee: {
+            base: { milisatoshis: grpc[:fee_base_msat] },
+            rate: { parts_per_million: grpc[:fee_rate_milli_msat] }
+          },
+          htlc: {
+            minimum: { milisatoshis: grpc[:min_htlc] },
+            maximum: { milisatoshis: grpc[:max_htlc_msat] },
+            # https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#cltv_expiry_delta-selection
+            blocks: {
+              delta: {
+                minimum: grpc[:time_lock_delta] # aka cltv_expiry_delta
+              }
+            }
+          }
+        }
+      end
+
+      def self.subscribe_channel_graph(json)
+        result = {
+          _source: :subscribe_channel_graph,
+          fee: {
+            base: { milisatoshis: json['routingPolicy']['feeBaseMsat'].to_i },
+            rate: { parts_per_million: json['routingPolicy']['feeRateMilliMsat'].to_i }
+          },
+          htlc: {
+            minimum: { milisatoshis: json['routingPolicy']['minHtlc'].to_i },
+            maximum: { milisatoshis: json['routingPolicy']['maxHtlcMsat'].to_i },
+            # https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#cltv_expiry_delta-selection
+            blocks: {
+              delta: {
+                minimum: json['routingPolicy']['timeLockDelta'].to_i # aka cltv_expiry_delta
+              }
+            }
+          }
+        }
+
+        policy = json['routingPolicy']
+
+        result[:fee].delete(:base) unless policy.key?('feeBaseMsat') && !policy['feeBaseMsat'].nil?
+        result[:fee].delete(:rate) unless policy.key?('feeRateMilliMsat') && !policy['feeRateMilliMsat'].nil?
+        result.delete(:fee) if result[:fee].empty?
+
+        result[:htlc].delete(:minimum) unless policy.key?('minHtlc') && !policy['minHtlc'].nil?
+        result[:htlc].delete(:maximum) unless policy.key?('maxHtlcMsat') && !policy['maxHtlcMsat'].nil?
+        result[:htlc].delete(:blocks) unless policy.key?('timeLockDelta') && !policy['timeLockDelta'].nil?
+        result.delete(:htlc) if result[:htlc].empty?
+
+        return nil unless result.key?(:fee) || result.key?(:htlc)
+
+        result
+      end
+    end
+  end
+end

data/adapters/connections/channel_node.rb

@@ -1,16 +1,22 @@
 # frozen_string_literal: true
 
 require_relative '../nodes/node'
+require_relative 'channel_node/policy'
 
 module Lighstorm
   module Adapter
     class ChannelNode
       def self.list_channels(grpc, key)
-        {
+        data = {
           _source: :list_channels,
+          state: grpc[:active] ? 'active' : 'inactive',
           accounting: { balance: { milisatoshis: grpc[:"#{key}_balance"] * 1000 } },
           node: Node.list_channels(grpc, key)
         }
+
+        data.delete(:node) if data[:node].nil?
+
+        data
       end
 
       def self.get_chan_info(grpc, index)
@@ -20,32 +26,48 @@ module Lighstorm
         }
 
         if grpc[:"node#{index}_policy"]
-          data[:policy] = {
-            fee: {
-              base: { milisatoshis: grpc[:"node#{index}_policy"][:fee_base_msat] },
-              rate: { parts_per_million: grpc[:"node#{index}_policy"][:fee_rate_milli_msat] }
-            },
-            htlc: {
-              minimum: { milisatoshis: grpc[:"node#{index}_policy"][:min_htlc] },
-              maximum: { milisatoshis: grpc[:"node#{index}_policy"][:max_htlc_msat] },
-              # https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#cltv_expiry_delta-selection
-              blocks: {
-                delta: {
-                  minimum: grpc[:"node#{index}_policy"][:time_lock_delta] # aka cltv_expiry_delta
-                }
-              }
-            }
-          }
+          data[:state] = grpc[:"node#{index}_policy"][:disabled] ? 'inactive' : 'active'
+          data[:policy] = Policy.get_chan_info(grpc[:"node#{index}_policy"])
         end
 
+        data.delete(:node) if data[:node].nil?
+
         data
       end
 
       def self.describe_graph(grpc, index)
-        {
+        data = {
           _source: :describe_graph,
           node: Node.describe_graph_from_channel(grpc, index)
         }
+
+        # TODO: No examples to validate the correctness of this scenario.
+        if grpc[:"node#{index}_policy"]
+          data[:state] = grpc[:"node#{index}_policy"][:disabled] ? 'inactive' : 'active'
+          data[:policy] = Policy.get_chan_info(grpc[:"node#{index}_policy"])
+        end
+
+        data.delete(:node) if data[:node].nil?
+
+        data
+      end
+
+      def self.subscribe_channel_graph(json)
+        data = {
+          _source: :subscribe_channel_graph,
+          node: {
+            public_key: json['advertisingNode']
+          },
+          policy: Policy.subscribe_channel_graph(json)
+        }
+
+        unless json['routingPolicy']['disabled'].nil?
+          data[:state] = json['routingPolicy']['disabled'] ? 'inactive' : 'active'
+        end
+
+        data.delete(:policy) if data[:policy].nil?
+
+        data
       end
     end
   end

data/adapters/edges/channel.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'date'
 require 'digest'
 
 require_relative '../connections/channel_node'
@@ -8,16 +7,16 @@ require_relative '../connections/channel_node'
 module Lighstorm
   module Adapter
     class Channel
-      def self._key(id, active)
+      def self._key(id, state)
         Digest::SHA256.hexdigest(
-          [id, active].join('/')
+          [id, state].join('/')
         )
       end
 
       def self.list_channels(grpc, at)
         {
           _source: :list_channels,
-          _key: _key(grpc[:chan_id], grpc[:active]),
+          _key: _key(grpc[:chan_id], grpc[:active] ? 'active' : 'inactive'),
           # Standard JSON don't support BigInt, so, a String is safer.
           id: grpc[:chan_id].to_s,
           transaction: {
@@ -26,9 +25,9 @@ module Lighstorm
               index: grpc[:channel_point].split(':').last.to_i
             }
           },
-          opened_at: DateTime.parse((at - grpc[:lifetime]).to_s),
-          up_at: DateTime.parse((at - grpc[:uptime]).to_s),
-          active: grpc[:active],
+          opened_at: at - grpc[:lifetime],
+          up_at: at - grpc[:uptime],
+          state: grpc[:active] ? 'active' : 'inactive',
           exposure: grpc[:private] ? 'private' : 'public',
           accounting: {
             capacity: { milisatoshis: grpc[:capacity] * 1000 },
@@ -75,6 +74,23 @@ module Lighstorm
           ]
         }
       end
+
+      def self.subscribe_channel_graph(json)
+        {
+          _source: :subscribe_channel_graph,
+          _key: _key(json['chanId'], nil),
+          id: json['chanId'],
+          accounting: {
+            capacity: { milisatoshis: json['capacity'].to_i * 1000 }
+          },
+          partners: [
+            ChannelNode.subscribe_channel_graph(json),
+            { node: {
+              public_key: json['connectingNode']
+            } }
+          ]
+        }
+      end
     end
   end
 end

data/adapters/edges/forward.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'date'
 require 'digest'
 
 module Lighstorm
@@ -10,7 +9,7 @@ module Lighstorm
         {
           _source: :forwarding_history,
           _key: _key(grpc),
-          at: DateTime.parse(Time.at(grpc[:timestamp_ns] / 1e+9).to_s),
+          at: Time.at(grpc[:timestamp_ns] / 1e+9),
           fee: { milisatoshis: grpc[:fee_msat] },
           in: {
             amount: { milisatoshis: grpc[:amt_in_msat] },

data/adapters/edges/payment/purpose.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'date'
-
 module Lighstorm
   module Adapter
     class Purpose

data/adapters/edges/payment.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'digest'
-require 'date'
 
 require_relative '../connections/payment_channel'
 require_relative 'payment/purpose'
@@ -30,7 +29,7 @@ module Lighstorm
         data = {
           _source: :list_payments,
           _key: _key(grpc),
-          created_at: DateTime.parse(Time.at(grpc[:creation_time_ns] / 1e+9).to_s),
+          created_at: Time.at(grpc[:creation_time_ns] / 1e+9),
           status: grpc[:status].to_s.downcase,
           fee: { milisatoshis: grpc[:fee_msat] },
           purpose: Purpose.list_payments(grpc, node_get_info),
@@ -42,9 +41,7 @@ module Lighstorm
           end
         }
 
-        if grpc[:htlcs].first[:resolve_time_ns]
-          data[:settled_at] = DateTime.parse(Time.at(grpc[:htlcs].first[:resolve_time_ns] / 1e+9).to_s)
-        end
+        data[:settled_at] = Time.at(grpc[:htlcs].first[:resolve_time_ns] / 1e+9) if grpc[:htlcs].first[:resolve_time_ns]
 
         data
       end

data/adapters/invoice.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'date'
 require 'digest'
 
 require_relative 'payment_request'
@@ -29,8 +28,8 @@ module Lighstorm
       def self.list_or_lookup(grpc)
         {
           _key: _key(grpc),
-          created_at: DateTime.parse(Time.at(grpc[:creation_date]).to_s),
-          settle_at: DateTime.parse(Time.at(grpc[:settle_date]).to_s),
+          created_at: Time.at(grpc[:creation_date]),
+          settle_at: Time.at(grpc[:settle_date]),
           state: grpc[:state].to_s.downcase
         }
       end

data/adapters/nodes/node.rb

@@ -20,15 +20,19 @@ module Lighstorm
       end
 
       def self.list_channels(grpc, key)
-        {
+        data = {
           _source: :list_channels,
           _key: _key(key == :remote ? grpc[:remote_pubkey] : nil),
           public_key: key == :remote ? grpc[:remote_pubkey] : nil
         }
+
+        return nil if data[:public_key].nil?
+
+        data
       end
 
       def self.get_info(grpc)
-        {
+        data = {
           _source: :get_info,
           _key: _key(grpc[:identity_pubkey]),
           public_key: grpc[:identity_pubkey],
@@ -43,34 +47,64 @@ module Lighstorm
             }
           }
         }
+
+        return nil if data[:public_key].nil? && data[:alias].nil? && data[:color].nil?
+
+        data
       end
 
       def self.get_node_info(grpc)
-        {
+        data = {
           _source: :get_node_info,
           _key: _key(grpc[:node][:pub_key]),
           public_key: grpc[:node][:pub_key],
           alias: grpc[:node][:alias],
           color: grpc[:node][:color]
         }
+
+        return nil if data[:public_key].nil? && data[:alias].nil? && data[:color].nil?
+
+        data
       end
 
       def self.describe_graph(grpc)
-        {
+        data = {
           _source: :describe_graph,
           _key: _key(grpc[:pub_key]),
           public_key: grpc[:pub_key],
           alias: grpc[:alias],
           color: grpc[:color]
         }
+
+        return nil if data[:public_key].nil? && data[:alias].nil? && data[:color].nil?
+
+        data
       end
 
       def self.describe_graph_from_channel(grpc, index)
-        {
+        data = {
           _source: :describe_graph,
           _key: _key(grpc[:"node#{index}_pub"]),
           public_key: grpc[:"node#{index}_pub"]
         }
+
+        return nil if data[:public_key].nil?
+
+        data
+      end
+
+      def self.subscribe_channel_graph(json)
+        data = {
+          _source: :subscribe_channel_graph,
+          _key: _key(json['identityKey']),
+          public_key: json['identityKey'],
+          alias: json['alias'],
+          color: json['color']
+        }
+
+        return nil if data[:public_key].nil? && data[:alias].nil? && data[:color].nil?
+
+        data
       end
     end
   end

data/adapters/payment_request.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'date'
 require 'digest'
 
 require_relative '../ports/dsl/lighstorm/errors'

data/controllers/channel/actions/apply_gossip.rb

@@ -0,0 +1,194 @@
+# frozen_string_literal: true
+
+require 'securerandom'
+
+require_relative '../../../ports/grpc'
+require_relative '../../../models/errors'
+require_relative '../../../models/edges/channel'
+require_relative '../../../adapters/edges/channel'
+
+module Lighstorm
+  module Controllers
+    module Channel
+      module ApplyGossip
+        SKIPABLE = [
+          '_key',
+          '_source',
+          'partners/0/_source',
+          'partners/0/policy/_source',
+          'partners/1/_source',
+          'partners/1/policy/_source'
+        ].freeze
+
+        NOT_ALLOWED = [
+          'id'
+        ].freeze
+
+        APPLICABLE = [
+          'accounting/capacity/milisatoshis',
+          'partners/0/policy/fee/base/milisatoshis',
+          'partners/0/state',
+          'partners/1/policy/fee/base/milisatoshis',
+          'partners/1/state',
+          'partners/1/policy/fee/rate/parts_per_million',
+          'partners/0/policy/fee/rate/parts_per_million',
+          'partners/0/policy/htlc/minimum/milisatoshis',
+          'partners/1/policy/htlc/minimum/milisatoshis',
+          'partners/0/policy/htlc/maximum/milisatoshis',
+          'partners/1/policy/htlc/maximum/milisatoshis',
+          'partners/0/policy/htlc/blocks/delta/minimum',
+          'partners/1/policy/htlc/blocks/delta/minimum'
+        ].freeze
+
+        def self.perform(actual, gossip)
+          updated = Models::Channel.new(Adapter::Channel.subscribe_channel_graph(gossip))
+
+          actual_dump = actual.dump
+          updated_dump = updated.dump
+
+          if actual.partners.first.node.public_key == updated.partners.last.node.public_key &&
+             actual.partners.last.node.public_key == updated.partners.first.node.public_key
+            a = updated_dump[:partners][0]
+            b = updated_dump[:partners][1]
+
+            updated_dump[:partners][0] = b
+            updated_dump[:partners][1] = a
+          end
+
+          diff = generate_diff(actual_dump, updated_dump)
+
+          diff.each do |change|
+            key = change[:path].join('/')
+            next unless NOT_ALLOWED.include?(key)
+
+            raise IncoherentGossipError, "Gossip doesn't belong to this Channel"
+          end
+
+          diff.filter do |change|
+            key = change[:path].join('/')
+            if SKIPABLE.include?(key)
+              false
+            elsif APPLICABLE.include?(key)
+              apply!(actual, key, change)
+              true
+            else
+              raise Lighstorm::Errors::MissingGossipHandlerError, "don't know how to apply '#{key}'"
+            end
+          end
+        end
+
+        def self.apply!(actual, key, change)
+          case key
+          when 'accounting/capacity/milisatoshis'
+            token = SecureRandom.hex
+            actual.accounting.prepare_token!(token)
+            actual.accounting.capacity = {
+              value: Models::Satoshis.new(milisatoshis: change[:to]),
+              token: token
+            }
+          when 'partners/0/policy/htlc/maximum/milisatoshis',
+                 'partners/1/policy/htlc/maximum/milisatoshis' then
+            policy = actual.partners[change[:path][1]].policy
+
+            token = SecureRandom.hex
+            policy.htlc.prepare_token!(token)
+            policy.htlc.maximum = {
+              value: Models::Satoshis.new(milisatoshis: change[:to]),
+              token: token
+            }
+          when 'partners/0/policy/htlc/minimum/milisatoshis',
+                 'partners/1/policy/htlc/minimum/milisatoshis' then
+            if actual.partners[change[:path][1]].policy.nil?
+              actual.partners[change[:path][1]].policy = Lighstorm::Models::Policy.new({})
+            end
+
+            policy = actual.partners[change[:path][1]].policy
+
+            token = SecureRandom.hex
+            policy.htlc.prepare_token!(token)
+            policy.htlc.minimum = {
+              value: Models::Satoshis.new(milisatoshis: change[:to]),
+              token: token
+            }
+          when 'partners/0/policy/htlc/blocks/delta/minimum',
+                'partners/1/policy/htlc/blocks/delta/minimum' then
+            if actual.partners[change[:path][1]].policy.nil?
+              actual.partners[change[:path][1]].policy = Lighstorm::Models::Policy.new({})
+            end
+
+            policy = actual.partners[change[:path][1]].policy
+
+            token = SecureRandom.hex
+            policy.htlc.blocks.delta.prepare_token!(token)
+            policy.htlc.blocks.delta.minimum = {
+              value: change[:to],
+              token: token
+            }
+          when 'partners/0/policy/fee/rate/parts_per_million',
+                 'partners/1/policy/fee/rate/parts_per_million' then
+            policy = actual.partners[change[:path][1]].policy
+
+            token = SecureRandom.hex
+            policy.fee.prepare_token!(token)
+            policy.fee.rate = {
+              value: Models::Rate.new(parts_per_million: change[:to]),
+              token: token
+            }
+          when 'partners/0/policy/fee/base/milisatoshis',
+                 'partners/1/policy/fee/base/milisatoshis' then
+            policy = actual.partners[change[:path][1]].policy
+
+            token = SecureRandom.hex
+            policy.fee.prepare_token!(token)
+            policy.fee.base = {
+              value: Models::Satoshis.new(milisatoshis: change[:to]),
+              token: token
+            }
+          when 'partners/0/state',
+               'partners/1/state' then
+            partner = actual.partners[change[:path][1]]
+
+            token = SecureRandom.hex
+            partner.prepare_token!(token)
+            partner.state = { value: change[:to], token: token }
+          else
+            raise Lighstorm::Errors::MissingGossipHandlerError, "don't know how to apply '#{key}'"
+          end
+        end
+
+        def self.generate_diff(actual, node, path = [], diff = [])
+          case node
+          when Hash
+            result = {}
+            node.each_key do |key|
+              result[key] = generate_diff(actual, node[key], path.dup.push(key), diff)
+            end
+          when Array
+            result = []
+            node.each_with_index do |value, i|
+              result << generate_diff(actual, value, path.dup.push(i), diff)
+            end
+          else
+            new_value = node
+
+            unless new_value.nil?
+              actual_value = actual
+              path.each do |key|
+                if actual_value[key]
+                  actual_value = actual_value[key]
+                else
+                  actual_value = nil
+                  break
+                end
+              end
+
+              diff << { path: path, from: actual_value, to: new_value } if actual_value != new_value
+            end
+          end
+
+          diff
+        end
+      end
+    end
+  end
+end