lighstorm 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc2a22398ed869fa9709af719d701c1fa00f5475f8de245111b40d602211e84d
-  data.tar.gz: c41b6c9d08350d0e4717242eb663b6e85aa9c9c714f46974e4969e340d13a033
+  metadata.gz: 4c585645f0ccf6b55a8b0840d5351900f701002a4616f351016f1b8d9f097ed4
+  data.tar.gz: fca5794bab41231c60400aab4ce82021bb649df52df63acf801ef4931bf5c53c
 SHA512:
-  metadata.gz: f560d47006a324f3468122cc719a89595523cfb639b8ad6dc45cf4ee7bc4d3bb2befb0a5ec5b02f84d8810bd7364322ef78f224611097a407999aaab571fd8c6
-  data.tar.gz: 1ae71460fae62e5022eeff6f3a91e15dadd23ef382162efb068b74d61cd7ae714b68182165a463b6d035eb6daa0fb5dde5ef0aa1e7c660f91e77a85f42f8f0f7
+  metadata.gz: 0717fc86e023d1591872b3c81c58338c713409030f3bc2351988ee62abb163b262df95e1357537c7530d3f3bd615208af99f68c92a0a53b6f6b784401d5c8e15
+  data.tar.gz: ff9bba186921987b3f301f95f82f1d3b7041feb4db92d8ca2a43c663915ea12e6d609615419805bc26cde7c2ba658702b713a603dd33c3f024de6b16794eca7e

data/Gemfile

@@ -6,5 +6,5 @@ gemspec
 
 group :test, :development do
   gem 'pry-byebug', '~> 3.10', '>= 3.10.1'
-  gem 'rubocop', '~> 1.44', '>= 1.44.1'
+  gem 'rubocop', '~> 1.45', '>= 1.45.1'
 end

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    lighstorm (0.0.1)
+    lighstorm (0.0.3)
       dotenv (~> 2.8, >= 2.8.1)
-      lnd-client (~> 0.0.4)
+      lnd-client (~> 0.0.5)
       zache (~> 0.12.0)
 
 GEM
@@ -16,15 +16,15 @@ 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)
-    lnd-client (0.0.4)
-      grpc (~> 1.51)
+    lnd-client (0.0.5)
+      grpc (~> 1.52)
     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)
@@ -45,8 +45,8 @@ GEM
       rubocop-ast (>= 1.24.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.24.1)
-      parser (>= 3.1.1.0)
+    rubocop-ast (1.26.0)
+      parser (>= 3.2.1.0)
     ruby-progressbar (1.11.0)
     unicode-display_width (2.4.2)
     zache (0.12.0)
@@ -57,7 +57,7 @@ PLATFORMS
 DEPENDENCIES
   lighstorm!
   pry-byebug (~> 3.10, >= 3.10.1)
-  rubocop (~> 1.44, >= 1.44.1)
+  rubocop (~> 1.45, >= 1.45.1)
 
 BUNDLED WITH
    2.4.4

data/README.md

@@ -7,7 +7,7 @@ API for interacting with a [Lightning Node](https://lightning.network).
 ![Lighstorm text written stylized with an illustration of a Graph connecting two Nodes.](https://raw.githubusercontent.com/icebaker/assets/main/lighstorm/lighstorm.png)
 
 ```ruby
-Lighstorm::Channel.first.myself.node.alias
+Lighstorm::Channel.mine.first.myself.node.alias
 ```
 
 ## Index
@@ -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.3'
 ```
 
 Run `bundle install`.
@@ -78,7 +78,8 @@ Lighstorm.config!(
 ```ruby
 Lighstorm::Node
 
-Lighstorm::Node.myself
+Lighstorm::Node.myself # Your Node.
+Lighstorm::Node.all # All 18k+ Nodes on the Network.
 Lighstorm::Node.find_by_public_key(
   '02d3c80335a8ccb2ed364c06875f32240f36f7edb37d80f8dbe321b4c364b6e997'
 )
@@ -90,6 +91,7 @@ node.channels
 node.alias
 node.public_key
 node.color
+node.myself?
 
 node.platform.blockchain
 node.platform.network
@@ -97,13 +99,14 @@ node.platform.lightning.implementation
 node.platform.lightning.version
 
 Lighstorm::Channel
-Lighstorm::Channel.all
-Lighstorm::Channel.first
-Lighstorm::Channel.last
-Lighstorm::Channel.find_by_id(850099509773795329)
+Lighstorm::Channel.mine # Your Node's Channels.
+Lighstorm::Channel.all # All 80k+ Channels on the Network.
+Lighstorm::Channel.find_by_id('850099509773795329')
 
 channel.to_h
 
+channel.mine?
+
 channel.id
 channel.opened_at
 channel.up_at
@@ -115,12 +118,30 @@ channel.accounting.sent.milisatoshis
 channel.accounting.received.milisatoshis
 channel.accounting.unsettled.milisatoshis
 
+# Channels that don't belong to you:
+channel.partners
+
+channel.partners[0]
+channel.partners[0].node.alias
+
+channel.partners[1]
+channel.partners[1].node.alias
+
+# Channels that belong to you:
+channel.myself
+channel.myself.node.alias
+
+channel.partner
+channel.partner.node.alias
+
 channel.partner.accounting.balance.milisatoshis
 channel.partner.node.alias
 channel.partner.node.public_key
 channel.partner.node.color
 channel.partner.policy.fee.base.milisatoshis
 channel.partner.policy.fee.rate.parts_per_million
+channel.partner.policy.htlc.minimum.milisatoshis
+channel.partner.policy.htlc.maximum.milisatoshis
 
 channel.myself.accounting.balance.milisatoshis
 channel.myself.node.alias
@@ -128,6 +149,24 @@ channel.myself.node.public_key
 channel.myself.node.color
 channel.myself.policy.fee.base.milisatoshis
 channel.myself.policy.fee.rate.parts_per_million
+channel.myself.policy.htlc.minimum.milisatoshis
+channel.myself.policy.htlc.maximum.milisatoshis
+
+channel.myself.policy.fee.update(
+  { rate: { parts_per_million: 25 } }, preview: true
+)
+
+channel.myself.policy.fee.update(
+  { base: { milisatoshis: 1 } }
+)
+
+channel.myself.policy.fee.update(
+  { rate: { parts_per_million: 25 } }
+)
+
+channel.myself.policy.fee.update(
+  { base: { milisatoshis: 1 }, rate: { parts_per_million: 25 } }
+)
 
 Lighstorm::Forward
 Lighstorm::Forward.all
@@ -141,7 +180,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 +196,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 +240,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 +259,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 +273,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 +304,7 @@ satoshis.parts_per_million(reference_in_milisatoshis)
 ```ruby
 require 'lighstorm'
 
-puts Lighstorm.version # => 0.0.1
+puts Lighstorm.version # => 0.0.3
 
 Lighstorm::Satoshis.new(
   milisatoshis: 75621650
@@ -234,7 +317,7 @@ Lighstorm::Node.myself.to_h #> { ... }
 
 Lighstorm::Node.myself.channels.count # => 5
 
-Lighstorm::Channel.all.first.partner.node.alias
+Lighstorm::Channel.mine.first.partner.node.alias
 
 forward = Lighstorm::Forward.all(limit: 10).first
 
@@ -268,7 +351,7 @@ So, we are going to think in terms of _Edges_, _Nodes_, and _Connections_:
 #### Channel
 
 ```ruby
-channel = Lighstorm::Channel.first
+channel = Lighstorm::Channel.mine.first
 
 channel.id
 
@@ -343,7 +426,7 @@ gem 'lighstorm', path: '/home/user/lighstorm'
 # demo.rb
 require 'lighstorm'
 
-puts Lighstorm.version # => 0.0.1
+puts Lighstorm.version # => 0.0.3
 ```
 
 ```sh
@@ -358,5 +441,5 @@ gem build lighstorm.gemspec
 
 gem signin
 
-gem push lighstorm-0.0.1.gem
+gem push lighstorm-0.0.3.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/lighstorm.gemspec

@@ -30,7 +30,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.4'
+  spec.add_dependency 'lnd-client', '~> 0.0.5'
   spec.add_dependency 'zache', '~> 0.12.0'
 
   spec.metadata['rubygems_mfa_required'] = 'true'

data/models/connections/channel_node/accounting.rb

@@ -11,6 +11,8 @@ module Lighstorm
       end
 
       def balance
+        return nil unless @channel.data[:list_channels]
+
         @balance ||= if @node.myself?
                        Satoshis.new(milisatoshis: (
                          @channel.data[:list_channels][:channels].first.local_balance.to_f * 1000.0

data/models/connections/channel_node/fee.rb

@@ -3,11 +3,17 @@
 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)
-        if node.myself?
+        @channel = channel
+        @policy = policy
+        if channel.data[:fee_report] && node.myself?
           @base = Satoshis.new(
             milisatoshis: channel.data[:fee_report][:channel_fees].first.base_fee_msat
           )
@@ -15,11 +21,77 @@ module Lighstorm
           @rate = Rate.new(
             parts_per_million: channel.data[:fee_report][:channel_fees].first.fee_per_mil
           )
-        else
-          @base = Satoshis.new(milisatoshis: policy.data.fee_base_msat)
+        elsif policy.data
+          @base = policy.data.fee_base_msat ? Satoshis.new(milisatoshis: policy.data.fee_base_msat) : nil
+
+          @rate = policy.data.fee_rate_milli_msat ? Rate.new(parts_per_million: policy.data.fee_rate_milli_msat) : nil
+        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
+          }
+        }
+
+        if params[:rate] && params[:rate][:parts_per_million]
+          if (params[:rate][:parts_per_million]).negative?
+            raise "fee rate can't be negative [#{params[:rate][:parts_per_million]}]"
+          end
+
+          grpc_request[:params][:fee_rate_ppm] = params[:rate][:parts_per_million]
+        end
+
+        if params[:base] && params[:base][:milisatoshis]
+          if (params[:base][:milisatoshis]).negative?
+            raise "fee base can't be negative [#{params[:base][:milisatoshis]}]"
+          end
+
+          grpc_request[:params][:base_fee_msat] = params[:base][:milisatoshis]
+        end
+
+        return grpc_request if preview
+
+        response = LND.instance.middleware("lightning.#{grpc_request[:method]}") do
+          LND.instance.client.lightning.send(grpc_request[:method], grpc_request[:params])
+        end
+
+        if response.failed_updates.empty?
+          @base = Satoshis.new(
+            milisatoshis: grpc_request[:params][:base_fee_msat]
+          )
 
-          @rate = Rate.new(parts_per_million: policy.data.fee_rate_milli_msat)
+          @rate = Rate.new(
+            parts_per_million: grpc_request[:params][:fee_rate_ppm]
+          )
         end
+
+        response
       end
 
       def to_h

data/models/connections/channel_node/htlc.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative '../../satoshis'
+require_relative '../../rate'
+
+require_relative '../../../components/lnd'
+
+module Lighstorm
+  module Models
+    class HTLC
+      attr_reader :minimum, :maximum
+
+      def initialize(policy, channel, _node)
+        @channel = channel
+        @policy = policy
+
+        return unless policy.data
+
+        @minimum = Satoshis.new(milisatoshis: policy.data.min_htlc)
+
+        @maximum = Satoshis.new(milisatoshis: policy.data.max_htlc_msat)
+      end
+
+      def to_h
+        {
+          minimum: @minimum.to_h,
+          maximum: @maximum.to_h
+        }
+      end
+    end
+  end
+end

data/models/connections/channel_node/policy.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'fee'
+require_relative 'htlc'
 
 module Lighstorm
   module Models
@@ -11,19 +12,29 @@ module Lighstorm
       end
 
       def data
-        @data ||= if @channel.data[:get_chan_info].node1_pub == @node.public_key
-                    @channel.data[:get_chan_info].node1_policy
+        return @data if @data
+
+        return if !@channel.data[:get_chan_info] && !@channel.data[:describe_graph]
+
+        key = @channel.data[:get_chan_info] ? :get_chan_info : :describe_graph
+
+        @data ||= if @channel.data[key].node1_pub == @node.public_key
+                    @channel.data[key].node1_policy
                   else
-                    @channel.data[:get_chan_info].node2_policy
+                    @channel.data[key].node2_policy
                   end
       end
 
-      def fees
-        @fees ||= Fee.new(self, @channel, @node)
+      def fee
+        @fee ||= Fee.new(self, @channel, @node)
+      end
+
+      def htlc
+        @htlc ||= HTLC.new(self, @channel, @node)
       end
 
       def to_h
-        { fee: fees.to_h }
+        { fee: fee.to_h, htlc: htlc.to_h }
       end
     end
   end

data/models/connections/channel_node.rb

@@ -29,12 +29,19 @@ module Lighstorm
       end
 
       def to_h
-        {
-          accounting: accounting.to_h,
-          node: @node.to_h,
-          policy: policy.to_h
-          # constraints: constraints.to_h
-        }
+        if @channel.data[:get_chan_info]
+          {
+            accounting: accounting.to_h,
+            node: @node.to_h,
+            policy: policy.to_h
+            # constraints: constraints.to_h
+          }
+        else
+          {
+            node: @node.to_h,
+            policy: policy.to_h
+          }
+        end
       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