lighstorm 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc2a22398ed869fa9709af719d701c1fa00f5475f8de245111b40d602211e84d
-  data.tar.gz: c41b6c9d08350d0e4717242eb663b6e85aa9c9c714f46974e4969e340d13a033
+  metadata.gz: 5255fb12e5463a29335c433ca7ccc20cdc6154a686f25c1272d4bf608e71764b
+  data.tar.gz: 7865931e5f6ee408a810481f1f809edcdf3d5fabfcd31e76bf3e3cad1dfabe64
 SHA512:
-  metadata.gz: f560d47006a324f3468122cc719a89595523cfb639b8ad6dc45cf4ee7bc4d3bb2befb0a5ec5b02f84d8810bd7364322ef78f224611097a407999aaab571fd8c6
-  data.tar.gz: 1ae71460fae62e5022eeff6f3a91e15dadd23ef382162efb068b74d61cd7ae714b68182165a463b6d035eb6daa0fb5dde5ef0aa1e7c660f91e77a85f42f8f0f7
+  metadata.gz: 7c7793a2361ffe29f9e97b1be00500274054f58acea841bb025fac94ebac969117c09f69cc644219825e06883df93a400cebce0db1f72f1b72e75ab3296e37b6
+  data.tar.gz: 81ce8ce6fcc5d564ae5b0a51c99080d0f301ecbf9a5fb6da45bd8f633a4d35eea6adb1b77f1f0a2ecebb9bf4c8e11c0185aca35f688f21f2118ff73a0f5ac1ab

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lighstorm (0.0.1)
+    lighstorm (0.0.2)
       dotenv (~> 2.8, >= 2.8.1)
       lnd-client (~> 0.0.4)
       zache (~> 0.12.0)
@@ -16,7 +16,7 @@ GEM
     google-protobuf (3.21.12)
     googleapis-common-protos-types (1.5.0)
       google-protobuf (~> 3.14)
-    grpc (1.51.0)
+    grpc (1.52.0-x86_64-linux)
       google-protobuf (~> 3.21)
       googleapis-common-protos-types (~> 1.0)
     json (2.6.3)
@@ -24,7 +24,7 @@ GEM
       grpc (~> 1.51)
     method_source (1.0.0)
     parallel (1.22.1)
-    parser (3.2.0.0)
+    parser (3.2.1.0)
       ast (~> 2.4.1)
     pry (0.14.2)
       coderay (~> 1.1)
@@ -33,9 +33,9 @@ GEM
       byebug (~> 11.0)
       pry (>= 0.13, < 0.15)
     rainbow (3.1.1)
-    regexp_parser (2.6.2)
+    regexp_parser (2.7.0)
     rexml (3.2.5)
-    rubocop (1.44.1)
+    rubocop (1.45.1)
       json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.2.0.0)

data/README.md

@@ -33,7 +33,7 @@ _Lighstorm_ is an opinionated abstraction layer on top of the [lnd-client](https
 
 It brings an [object-oriented](https://en.wikipedia.org/wiki/Object-oriented_programming) approach for interacting with a [Lightning Node](https://github.com/lightningnetwork/lnd), influenced by the [Active Record Pattern](https://www.martinfowler.com/eaaCatalog/activeRecord.html) and [Active Record Models](https://guides.rubyonrails.org/active_record_basics.html) conventions.
 
-Although it tries to stay close to [Lightning's terminologies](https://docs.lightning.engineering/lightning-network-tools/lnd), it brings its own vocabulary and data modeling, optimizing for [programmer happiness](https://rubyonrails.org/doctrine).
+Although it tries to stay close to [Lightning's terminologies](https://docs.lightning.engineering/lightning-network-tools/lnd), it brings its own vocabulary and [data modeling](#data-modeling), optimizing for [programmer happiness](https://rubyonrails.org/doctrine).
 
 ## Usage
 
@@ -42,7 +42,7 @@ Although it tries to stay close to [Lightning's terminologies](https://docs.ligh
 Add to your `Gemfile`:
 
 ```ruby
-gem 'lighstorm', '~> 0.0.1'
+gem 'lighstorm', '~> 0.0.2'
 ```
 
 Run `bundle install`.
@@ -90,6 +90,7 @@ node.channels
 node.alias
 node.public_key
 node.color
+node.myself?
 
 node.platform.blockchain
 node.platform.network
@@ -129,6 +130,14 @@ channel.myself.node.color
 channel.myself.policy.fee.base.milisatoshis
 channel.myself.policy.fee.rate.parts_per_million
 
+channel.myself.policy.fee.update(
+  { rate: { parts_per_million: 25 } }, preview: true
+)
+
+channel.myself.policy.fee.update(
+  { rate: { parts_per_million: 25 } }
+)
+
 Lighstorm::Forward
 Lighstorm::Forward.all
 Lighstorm::Forward.first
@@ -141,7 +150,9 @@ forward.id
 forward.at
 
 forward.fee.milisatoshis
-forward.fee.parts_per_million
+forward.fee.parts_per_million(
+  forward.in.amount.milisatoshis
+)
 
 forward.in.amount.milisatoshis
 
@@ -155,6 +166,37 @@ forward.out.channel.partner.node.alias
 forward.out.channel.partner.node.public_key
 forward.out.channel.partner.node.color
 
+Lighstorm::Forward.group_by_channel(direction: :in, hours_ago: 24, limit: 5)
+
+group.to_h
+
+group.last_at
+group.analysis.count
+group.analysis.sums.amount.milisatoshis
+group.analysis.sums.fee.milisatoshis
+group.analysis.averages.amount.milisatoshis
+group.analysis.averages.fee.milisatoshis
+group.analysis.averages.fee.parts_per_million(
+  group.analysis.averages.amount.milisatoshis
+)
+
+group.in.id
+group.in.partner.node.alias
+group.in.partner.node.public_key
+group.in.partner.node.color
+
+Lighstorm::Forward.group_by_channel(direction: :out)
+
+group.to_h
+
+group.last_at
+group.analysis.count
+
+group.out.id
+group.out.partner.node.alias
+group.out.partner.node.public_key
+group.out.partner.node.color
+
 Lighstorm::Payment
 Lighstorm::Payment.all
 Lighstorm::Payment.first
@@ -168,12 +210,17 @@ payment.purpose
 payment.status
 payment.amount.milisatoshis
 payment.fee.milisatoshis
-payment.fee.parts_per_million
+payment.fee.parts_per_million(
+  payment.amount.milisatoshis
+)
 
 payment.from.hop
 payment.from.amount.milisatoshis
 payment.from.fee.milisatoshis
-payment.from.fee.parts_per_million
+payment.from.fee.parts_per_million(
+  payment.from.amount.milisatoshis
+)
+
 payment.from.channel.id
 payment.from.channel.partner.node.alias
 payment.from.channel.partner.node.public_key
@@ -182,7 +229,10 @@ payment.from.channel.partner.node.color
 payment.to.hop
 payment.to.amount.milisatoshis
 payment.to.fee.milisatoshis
-payment.to.fee.parts_per_million
+payment.to.fee.parts_per_million(
+  payment.to.amount.milisatoshis
+)
+
 payment.to.channel.id
 payment.to.channel.partner.node.alias
 payment.to.channel.partner.node.public_key
@@ -193,7 +243,10 @@ payment.hops.size
 payment.hops[0].hop
 payment.hops[0].amount.milisatoshis
 payment.hops[0].fee.milisatoshis
-payment.hops[0].fee.parts_per_million
+payment.hops[0].fee.parts_per_million(
+  payment.hops[0].amount.milisatoshis
+)
+
 payment.hops[0].channel.id
 payment.hops[0].channel.partner.node.alias
 payment.hops[0].channel.partner.node.public_key
@@ -221,7 +274,7 @@ satoshis.parts_per_million(reference_in_milisatoshis)
 ```ruby
 require 'lighstorm'
 
-puts Lighstorm.version # => 0.0.1
+puts Lighstorm.version # => 0.0.2
 
 Lighstorm::Satoshis.new(
   milisatoshis: 75621650
@@ -343,7 +396,7 @@ gem 'lighstorm', path: '/home/user/lighstorm'
 # demo.rb
 require 'lighstorm'
 
-puts Lighstorm.version # => 0.0.1
+puts Lighstorm.version # => 0.0.2
 ```
 
 ```sh
@@ -358,5 +411,5 @@ gem build lighstorm.gemspec
 
 gem signin
 
-gem push lighstorm-0.0.1.gem
+gem push lighstorm-0.0.2.gem
 ```

data/components/cache.rb

@@ -4,6 +4,8 @@ require 'singleton'
 
 require 'zache'
 
+require_relative '../static/cache'
+
 module Lighstorm
   class Cache
     include Singleton
@@ -18,7 +20,14 @@ module Lighstorm
       @client = Zache.new
     end
 
-    def for(key, ttl: 1, params: {}, &block)
+    def for(key, ttl: nil, params: {}, &block)
+      if ttl.nil?
+        ttl = Lighstorm::Static::CACHE[key.sub('lightning.', '').to_sym]
+        raise "missing ttl for #{key}" if ttl.nil?
+
+        ttl = ttl[:ttl]
+      end
+
       key = build_key_for(key, params)
 
       @client.get(key, lifetime: ttl) do

data/models/connections/channel_node/fee.rb

@@ -3,10 +3,16 @@
 require_relative '../../satoshis'
 require_relative '../../rate'
 
+require_relative '../../../components/lnd'
+
 module Lighstorm
   module Models
     class Fee
+      attr_reader :rate, :base
+
       def initialize(policy, channel, node)
+        @channel = channel
+        @policy = policy
         if node.myself?
           @base = Satoshis.new(
             milisatoshis: channel.data[:fee_report][:channel_fees].first.base_fee_msat
@@ -22,6 +28,46 @@ module Lighstorm
         end
       end
 
+      def update(params, preview: false)
+        chan_point = @channel.data[:get_chan_info].chan_point.split(':')
+
+        # add_message "lnrpc.PolicyUpdateRequest" do
+        #   optional :base_fee_msat, :int64, 3
+        #   optional :fee_rate, :double, 4
+        #   optional :fee_rate_ppm, :uint32, 9
+        #   optional :time_lock_delta, :uint32, 5
+        #   optional :max_htlc_msat, :uint64, 6
+        #   optional :min_htlc_msat, :uint64, 7
+        #   optional :min_htlc_msat_specified, :bool, 8
+        #   oneof :scope do
+        #     optional :global, :bool, 1
+        #     optional :chan_point, :message, 2, "lnrpc.ChannelPoint"
+        #   end
+        # end
+
+        grpc_request = {
+          method: :update_channel_policy,
+          params: {
+            chan_point: {
+              funding_txid_str: chan_point[0],
+              output_index: chan_point[1].to_i
+            },
+            fee_rate_ppm: @policy.data.fee_rate_milli_msat,
+            base_fee_msat: @policy.data.fee_base_msat,
+            time_lock_delta: @policy.data.time_lock_delta,
+            max_htlc_msat: @policy.data.max_htlc_msat
+          }
+        }
+
+        grpc_request[:params][:fee_rate_ppm] = params[:rate][:parts_per_million]
+
+        return grpc_request if preview
+
+        LND.instance.middleware("lightning.#{grpc_request[:method]}") do
+          LND.instance.client.lightning.send(grpc_request[:method], grpc_request[:params])
+        end
+      end
+
       def to_h
         {
           base: @base.to_h,

data/models/connections/channel_node/policy.rb

@@ -18,12 +18,12 @@ module Lighstorm
                   end
       end
 
-      def fees
-        @fees ||= Fee.new(self, @channel, @node)
+      def fee
+        @fee ||= Fee.new(self, @channel, @node)
       end
 
       def to_h
-        { fee: fees.to_h }
+        { fee: fee.to_h }
       end
     end
   end

data/models/connections/forward_channel.rb

@@ -7,21 +7,14 @@ module Lighstorm
     class ForwardChannel
       KIND = :connection
 
-      def initialize(direction, forward)
+      def initialize(direction, forward, respond_info: true)
+        @respond_info = respond_info
         @direction = direction
         @forward = forward
       end
 
       def channel
-        @channel ||= if @direction == :in
-                       Channel.find_by_id(
-                         @forward.data[:forwarding_history][:forwarding_events].first.chan_id_in
-                       )
-                     else
-                       Channel.find_by_id(
-                         @forward.data[:forwarding_history][:forwarding_events].first.chan_id_out
-                       )
-                     end
+        @channel ||= Channel.find_by_id(channel_id)
       end
 
       def amount
@@ -35,19 +28,35 @@ module Lighstorm
       end
 
       def to_h
-        {
+        response = {
           amount: amount.to_h,
-          channel: {
-            id: channel.id,
-            partner: {
-              node: {
-                alias: channel.partner&.node&.alias,
-                public_key: channel.partner&.node&.public_key,
-                color: channel.partner&.node&.color
-              }
+          channel: { id: channel_id }
+        }
+
+        return response unless @respond_info
+
+        response[:channel] = {
+          id: channel.id,
+          partner: {
+            node: {
+              alias: channel.partner&.node&.alias,
+              public_key: channel.partner&.node&.public_key,
+              color: channel.partner&.node&.color
             }
           }
         }
+
+        response
+      end
+
+      private
+
+      def channel_id
+        if @direction == :in
+          @forward.data[:forwarding_history][:forwarding_events].first.chan_id_in.to_s
+        else
+          @forward.data[:forwarding_history][:forwarding_events].first.chan_id_out.to_s
+        end
       end
     end
   end

data/models/connections/payment_channel.rb

@@ -8,13 +8,16 @@ module Lighstorm
     class PaymentChannel
       KIND = :connection
 
-      def initialize(raw_hop, hop_index)
+      def initialize(raw_hop, hop_index, respond_info: true)
+        @respond_info = respond_info
         @raw_hop = raw_hop
-        @index = hop_index
+        @hop = hop_index
       end
 
+      attr_reader :hop
+
       def channel
-        @channel ||= Channel.find_by_id(@raw_hop.chan_id)
+        Channel.find_by_id(@raw_hop.chan_id)
       end
 
       def amount
@@ -34,24 +37,35 @@ module Lighstorm
       end
 
       def to_h
-        {
-          hop: @index,
+        response = {
+          hop: hop,
           amount: amount.to_h,
           fee: {
             milisatoshis: fee.milisatoshis,
             parts_per_million: fee.parts_per_million(amount.milisatoshis)
           },
           channel: {
-            id: channel.id,
-            partner: {
-              node: {
-                alias: partner_node&.alias,
-                public_key: partner_node&.public_key,
-                color: partner_node&.color
-              }
+            id: @raw_hop.chan_id.to_s,
+            node: {
+              public_key: @raw_hop.pub_key
             }
           }
         }
+
+        return response unless @respond_info
+
+        response[:channel] = {
+          id: channel.id,
+          partner: {
+            node: {
+              alias: partner_node&.alias,
+              public_key: partner_node&.public_key,
+              color: partner_node&.color
+            }
+          }
+        }
+
+        response
       end
     end
   end

data/models/edges/channel.rb

@@ -17,17 +17,17 @@ module Lighstorm
     class Channel
       KIND = :edge
 
-      attr_reader :id, :data
+      attr_reader :data
 
       def self.all
-        response = Cache.for('lightning.list_channels', ttl: 1) do
+        response = Cache.for('lightning.list_channels') do
           LND.instance.middleware('lightning.list_channels') do
             LND.instance.client.lightning.list_channels
           end
         end
 
         response.channels.map do |channel|
-          Channel.find_by_id(channel.chan_id)
+          Channel.find_by_id(channel.chan_id.to_s)
         end
       end
 
@@ -43,21 +43,23 @@ module Lighstorm
         Channel.new({ id: id })
       end
 
+      def id
+        # Standard JSON don't support BigInt, so, a String is safer.
+        @id.to_s
+      end
+
       def initialize(params)
         begin
-          response = Cache.for(
-            'lightning.get_chan_info',
-            ttl: 1, params: { chan_id: params[:id] }
-          ) do
+          response = Cache.for('lightning.get_chan_info', params: { chan_id: params[:id].to_i }) do
             LND.instance.middleware('lightning.get_chan_info') do
-              LND.instance.client.lightning.get_chan_info(chan_id: params[:id])
+              LND.instance.client.lightning.get_chan_info(chan_id: params[:id].to_i)
             end
           end
 
           @data = { get_chan_info: response }
           @id = @data[:get_chan_info].channel_id
-        rescue StandardError => _e
-          @data = { get_chan_info: nil }
+        rescue StandardError => e
+          @data = { get_chan_info: nil, error: e }
           @id = params[:id]
         end
 
@@ -67,6 +69,10 @@ module Lighstorm
         calculate_times_after_list_channels!
       end
 
+      def error
+        @data[:error]
+      end
+
       def active
         @data[:list_channels] ? @data[:list_channels][:channels].first.active : nil
       end
@@ -141,7 +147,7 @@ module Lighstorm
 
       # Ensure that we are getting fresh up-date data about our own fees.
       def fetch_from_fee_report!
-        response = Cache.for('lightning.fee_report', ttl: 1) do
+        response = Cache.for('lightning.fee_report') do
           LND.instance.middleware('lightning.fee_report') do
             LND.instance.client.lightning.fee_report
           end
@@ -156,7 +162,7 @@ module Lighstorm
       end
 
       def fetch_from_list_channels!
-        response = Cache.for('lightning.list_channels', ttl: 1) do
+        response = Cache.for('lightning.list_channels') do
           LND.instance.middleware('lightning.list_channels') do
             LND.instance.client.lightning.list_channels
           end

data/models/edges/forward.rb

@@ -7,6 +7,7 @@ require 'date'
 require_relative '../satoshis'
 
 require_relative '../connections/forward_channel'
+require_relative 'groups/channel_forwards'
 
 module Lighstorm
   module Models
@@ -15,16 +16,21 @@ module Lighstorm
 
       attr_reader :data
 
-      def self.all(limit: nil)
+      def self.all(limit: nil, raw: false, info: true)
         last_offset = 0
 
         forwards = []
 
         loop do
-          response = LND.instance.middleware('lightning.forwarding_history') do
-            LND.instance.client.lightning.forwarding_history(
-              peer_alias_lookup: true, index_offset: last_offset
-            )
+          response = Cache.for(
+            'lightning.forwarding_history',
+            params: { peer_alias_lookup: true, index_offset: last_offset }
+          ) do
+            LND.instance.middleware('lightning.forwarding_history') do
+              LND.instance.client.lightning.forwarding_history(
+                peer_alias_lookup: true, index_offset: last_offset
+              )
+            end
           end
 
           response.forwarding_events.each { |raw_forward| forwards << raw_forward }
@@ -41,7 +47,9 @@ module Lighstorm
 
         forwards = forwards[0..limit - 1] unless limit.nil?
 
-        forwards.map { |raw_forward| Forward.new(raw_forward) }
+        return forwards if raw
+
+        forwards.map { |raw_forward| Forward.new(raw_forward, respond_info: info) }
       end
 
       def self.first
@@ -52,7 +60,52 @@ module Lighstorm
         all.last
       end
 
-      def initialize(raw)
+      def self.group_by_channel(direction: :out, hours_ago: nil, limit: nil, info: true)
+        raw_forwards = all(raw: true)
+
+        direction = direction.to_sym
+
+        groups = {}
+
+        raw_forwards.each do |raw_forward|
+          channel_id = direction == :in ? raw_forward.chan_id_in : raw_forward.chan_id_out
+
+          if hours_ago
+            forward_hours_ago = (
+              Time.now - Time.at(raw_forward.timestamp_ns / 1e+9)
+            ).to_f / 3600
+
+            next if forward_hours_ago > hours_ago
+          end
+
+          unless groups[channel_id]
+            groups[channel_id] = {
+              last_at: nil,
+              analysis: { count: 0, sums: { amount: 0, fee: 0 } },
+              direction => { id: channel_id }
+            }
+          end
+
+          groups[channel_id][:analysis][:count] += 1
+          groups[channel_id][:analysis][:sums][:amount] += raw_forward.amt_in_msat
+          groups[channel_id][:analysis][:sums][:fee] += raw_forward.fee_msat
+
+          if groups[channel_id][:last_at].nil? || raw_forward.timestamp_ns > groups[channel_id][:last_at]
+            groups[channel_id][:last_at] = raw_forward.timestamp_ns
+            groups[channel_id][:sample] = raw_forward
+          end
+        end
+
+        groups = groups.values.sort_by { |group| - group[:last_at] }
+                       .sort_by { |group| - group[:analysis][:count] }
+
+        groups = groups[0..limit - 1] unless limit.nil?
+
+        groups.map { |raw_group| ChannelForwardsGroup.new(direction, raw_group) }
+      end
+
+      def initialize(raw, respond_info: true)
+        @respond_info = respond_info
         @data = { forwarding_history: { forwarding_events: [raw] } }
       end
 
@@ -63,7 +116,9 @@ module Lighstorm
       end
 
       def at
-        DateTime.parse(Time.at(@data[:forwarding_history][:forwarding_events].first.timestamp).to_s)
+        DateTime.parse(Time.at(
+          @data[:forwarding_history][:forwarding_events].first.timestamp_ns / 1e+9
+        ).to_s)
       end
 
       def fee
@@ -71,11 +126,11 @@ module Lighstorm
       end
 
       def in
-        @in ||= ForwardChannel.new(:in, self)
+        @in ||= ForwardChannel.new(:in, self, respond_info: @respond_info)
       end
 
       def out
-        @out ||= ForwardChannel.new(:out, self)
+        @out ||= ForwardChannel.new(:out, self, respond_info: @respond_info)
       end
 
       def to_h

data/models/edges/groups/analysis.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Lighstorm
+  module Models
+    class ChannelForwardsGroup
+      Analysis = Struct.new(:analysis) do
+        def count
+          analysis[:count]
+        end
+
+        def sums
+          Struct.new(:sums) do
+            def amount
+              Satoshis.new(milisatoshis: sums[:amount])
+            end
+
+            def fee
+              Satoshis.new(milisatoshis: sums[:fee])
+            end
+
+            def to_h
+              {
+                amount: amount.to_h,
+                fee: {
+                  milisatoshis: fee.milisatoshis,
+                  parts_per_million: fee.parts_per_million(amount.milisatoshis)
+                }
+              }
+            end
+          end.new(analysis[:sums])
+        end
+
+        def averages
+          Struct.new(:analysis) do
+            def amount
+              Satoshis.new(
+                milisatoshis: analysis[:sums][:amount].to_f / analysis[:count]
+              )
+            end
+
+            def fee
+              Satoshis.new(
+                milisatoshis: analysis[:sums][:fee].to_f / analysis[:count]
+              )
+            end
+
+            def to_h
+              {
+                amount: amount.to_h,
+                fee: {
+                  milisatoshis: fee.milisatoshis,
+                  parts_per_million: fee.parts_per_million(amount.milisatoshis)
+                }
+              }
+            end
+          end.new(analysis)
+        end
+
+        def to_h
+          {
+            count: count,
+            sums: sums.to_h,
+            averages: averages.to_h
+          }
+        end
+      end
+    end
+  end
+end

data/models/edges/groups/channel_forwards.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require_relative '../../satoshis'
+require_relative 'analysis'
+
+module Lighstorm
+  module Models
+    class ChannelForwardsGroup
+      def initialize(direction, data)
+        @direction = direction
+        @data = data
+      end
+
+      def last_at
+        @last_at ||= DateTime.parse(Time.at(@data[:last_at].to_f / 1e+9).to_s)
+      end
+
+      def analysis
+        Analysis.new(@data[:analysis])
+      end
+
+      def in
+        return @in if @in
+
+        raise raise ArgumentError, "Method `in` doesn't exist." unless @direction == :in
+
+        @in = Channel.new({ id: @data[:in][:id] })
+      end
+
+      def out
+        return @out if @out
+
+        raise raise ArgumentError, "Method `out` doesn't exist." unless @direction == :out
+
+        @out = Channel.new({ id: @data[:out][:id] })
+      end
+
+      # def capacity
+      #   @capacity ||= Satoshis.new(milisatoshis: @channel.data[:get_chan_info].capacity * 1000)
+      # end
+
+      def to_h
+        {
+          last_at: last_at,
+          analysis: analysis.to_h,
+          @direction => {
+            id: channel.id,
+            partner: {
+              node: {
+                alias: channel&.partner&.node&.alias,
+                public_key: channel&.partner&.node&.public_key,
+                color: channel&.partner&.node&.color
+              }
+            }
+          }
+        }
+      end
+
+      private
+
+      def channel
+        @channel ||= @direction == :in ? self.in : out
+      end
+    end
+  end
+end

data/models/edges/payment.rb

@@ -15,14 +15,16 @@ module Lighstorm
 
       attr_reader :data
 
-      def self.all(limit: nil, purpose: nil, hops: true)
+      def self.all(limit: nil, purpose: nil, hops: true, info: true)
         last_offset = 0
 
         payments = []
 
         loop do
-          response = LND.instance.middleware('lightning.list_payments') do
-            LND.instance.client.lightning.list_payments(index_offset: last_offset)
+          response = Cache.for('lightning.list_payments', params: { index_offset: last_offset }) do
+            LND.instance.middleware('lightning.list_payments') do
+              LND.instance.client.lightning.list_payments(index_offset: last_offset)
+            end
           end
 
           response.payments.each do |raw_payment|
@@ -57,7 +59,7 @@ module Lighstorm
         payments = payments[0..limit - 1] unless limit.nil?
 
         payments.map do |raw_payment|
-          Payment.new(raw_payment, respond_hops: hops)
+          Payment.new(raw_payment, respond_hops: hops, respond_info: info)
         end
       end
 
@@ -69,8 +71,9 @@ module Lighstorm
         all.last
       end
 
-      def initialize(raw, respond_hops: true)
+      def initialize(raw, respond_hops: true, respond_info: true)
         @respond_hops = respond_hops
+        @respond_info = respond_info
         @data = { list_payments: { payments: [raw] } }
       end
 
@@ -163,7 +166,7 @@ module Lighstorm
 
         @from = PaymentChannel.new(
           @data[:list_payments][:payments].first.htlcs.first.route.hops.first,
-          1
+          1, respond_info: @respond_info
         )
 
         @from
@@ -185,12 +188,14 @@ module Lighstorm
                   @data[:list_payments][:payments].first.htlcs.first.route.hops[
                     @data[:list_payments][:payments].first.htlcs.first.route.hops.size - 2
                   ],
-                  @data[:list_payments][:payments].first.htlcs.first.route.hops.size - 1
+                  @data[:list_payments][:payments].first.htlcs.first.route.hops.size - 1,
+                  respond_info: @respond_info
                 )
               else
                 PaymentChannel.new(
                   @data[:list_payments][:payments].first.htlcs.first.route.hops.last,
-                  @data[:list_payments][:payments].first.htlcs.first.route.hops.size
+                  @data[:list_payments][:payments].first.htlcs.first.route.hops.size,
+                  respond_info: @respond_info
                 )
               end
 
@@ -203,7 +208,7 @@ module Lighstorm
         validated_htlcs_number!
 
         @hops = @data[:list_payments][:payments].first.htlcs.first.route.hops.map.with_index do |raw_hop, i|
-          PaymentChannel.new(raw_hop, i + 1)
+          PaymentChannel.new(raw_hop, i + 1, respond_info: @respond_info)
         end
       end
 

data/models/nodes/node/lightning.rb

@@ -5,6 +5,8 @@ require_relative '../../../components/lnd'
 module Lighstorm
   module Models
     class Lightning
+      IMPLEMENTATION = 'lnd'
+
       def initialize(platform, node)
         raise 'cannot provide platform details for a node that is not yours' unless node.myself?
 
@@ -19,9 +21,13 @@ module Lighstorm
         { get_info: @data[:get_info].to_h }
       end
 
+      def implementation
+        @implementation ||= IMPLEMENTATION
+      end
+
       def to_h
         {
-          implementation: 'lnd',
+          implementation: implementation,
           version: version
         }
       end

data/models/nodes/node/platform.rb

@@ -12,7 +12,7 @@ module Lighstorm
       def initialize(node)
         @node = node
 
-        response = Cache.for('lightning.get_info', ttl: 1) do
+        response = Cache.for('lightning.get_info') do
           LND.instance.middleware('lightning.get_info') do
             LND.instance.client.lightning.get_info
           end

data/models/nodes/node.rb

@@ -14,7 +14,7 @@ module Lighstorm
       attr_reader :alias, :public_key, :color
 
       def self.myself
-        response = Cache.for('lightning.get_info', ttl: 1) do
+        response = Cache.for('lightning.get_info') do
           LND.instance.middleware('lightning.get_info') do
             LND.instance.client.lightning.get_info
           end
@@ -59,15 +59,22 @@ module Lighstorm
       private
 
       def initialize(params, myself: false)
-        response = Cache.for(
-          'lightning.get_node_info',
-          ttl: 5 * 60, params: { pub_key: params[:public_key] }
-        ) do
+        response = Cache.for('lightning.get_node_info', params: { pub_key: params[:public_key] }) do
           LND.instance.middleware('lightning.get_node_info') do
             LND.instance.client.lightning.get_node_info(pub_key: params[:public_key])
           end
         end
 
+        unless myself
+          response_get_info = Cache.for('lightning.get_info') do
+            LND.instance.middleware('lightning.get_info') do
+              LND.instance.client.lightning.get_info
+            end
+          end
+
+          myself = true if params[:public_key] == response_get_info.identity_pubkey
+        end
+
         @data = { get_node_info: response }
 
         @myself = myself

data/models/rate.rb

@@ -3,6 +3,8 @@
 module Lighstorm
   module Models
     class Rate
+      attr_reader :parts_per_million
+
       # https://en.wikipedia.org/wiki/Parts-per_notation
       def initialize(parts_per_million: nil)
         raise 'missing parts_per_million' if parts_per_million.nil?

data/static/cache.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Lighstorm
+  module Static
+    CACHE = {
+      fee_report: {
+        ttl: 0.01,
+        properties: %i[
+          base_fee_msat fee_per_mil
+        ]
+      },
+      forwarding_history: {
+        ttl: 1,
+        properties: %i[
+          amt_in_msat
+          amt_out_msat
+          chan_id_in
+          chan_id_out
+          fee_msat
+          timestamp_ns
+        ]
+      },
+      get_chan_info: {
+        ttl: 5 * 60,
+        properties: %i[
+          channel_id
+          chan_point
+          node1_pub
+          node1_policy
+          node2_pub
+          node2_policy
+          capacity
+        ]
+      },
+      get_info: {
+        ttl: 5 * 60,
+        properties: %i[identity_pubkey version chains chain network]
+      },
+      get_node_info: {
+        ttl: 5 * 60,
+        properties: %i[alias pub_key color]
+      },
+      list_channels: {
+        ttl: 1,
+        properties: %i[
+          local_balance remote_balance unsettled_balance
+          local_constraints remote_constraints
+          active private
+          lifetime uptime
+          total_satoshis_sent total_satoshis_received
+        ]
+      },
+      list_payments: {
+        ttl: 1,
+        properties: %i[
+          creation_date payment_hash status
+          value_msat fee_msat
+          htlcs route hops
+          chan_id pub_key
+          amt_to_forward_msat fee_msat
+        ]
+      }
+    }.freeze
+  end
+end

data/static/spec.rb

@@ -4,7 +4,7 @@ module Lighstorm
   module Static
     SPEC = {
       name: 'lighstorm',
-      version: '0.0.1',
+      version: '0.0.2',
       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.1
+  version: 0.0.2
 platform: ruby
 authors:
 - icebaker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-02-05 00:00:00.000000000 Z
+date: 2023-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -84,6 +84,8 @@ files:
 - models/edges/channel.rb
 - models/edges/channel/accounting.rb
 - models/edges/forward.rb
+- models/edges/groups/analysis.rb
+- models/edges/groups/channel_forwards.rb
 - models/edges/payment.rb
 - models/nodes/node.rb
 - models/nodes/node/lightning.rb
@@ -91,6 +93,7 @@ files:
 - models/rate.rb
 - models/satoshis.rb
 - ports/dsl/lighstorm.rb
+- static/cache.rb
 - static/spec.rb
 homepage: https://github.com/icebaker/lighstorm
 licenses: