lighstorm 0.0.1 → 0.0.3

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
@@ -27,6 +27,18 @@ module Lighstorm
         Node.new({ public_key: public_key }, myself: myself)
       end
 
+      def self.all
+        response = LND.instance.middleware('lightning.describe_graph') do
+          LND.instance.client.lightning.describe_graph
+        end
+
+        myself_public_key = myself.public_key
+
+        response.nodes.map do |raw_node|
+          Node.new({ describe_graph: raw_node }, myself: raw_node.pub_key == myself_public_key)
+        end
+      end
+
       def myself?
         @myself
       end
@@ -36,45 +48,98 @@ module Lighstorm
       end
 
       def channels
-        raise 'cannot list channels from a node that is not yours' unless myself?
-
-        Channel.all
+        if myself?
+          Channel.mine
+        else
+          Channel.all
+        end
       end
 
       def raw
         {
-          get_node_info: @data[:get_node_info].to_h
+          get_node_info: @data[:get_node_info].to_h,
+          describe_graph: @data[:describe_graph].to_h
         }
       end
 
       def to_h
-        {
-          alias: @alias,
-          public_key: @public_key,
-          color: @color,
-          platform: platform.to_h
-        }
+        if (@data[:get_node_info] || @data[:describe_graph]) && myself?
+          {
+            alias: @alias,
+            public_key: @public_key,
+            color: @color,
+            platform: platform.to_h
+          }
+        elsif @data[:get_node_info] || @data[:describe_graph]
+          {
+            alias: @alias,
+            public_key: @public_key,
+            color: @color
+          }
+        else
+          {
+            public_key: @public_key
+          }
+        end
       end
 
-      private
+      def myself
+        return @myself unless @myself.nil?
 
-      def initialize(params, myself: false)
-        response = Cache.for(
-          'lightning.get_node_info',
-          ttl: 5 * 60, 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])
+        response_get_info = Cache.for('lightning.get_info') do
+          LND.instance.middleware('lightning.get_info') do
+            LND.instance.client.lightning.get_info
           end
         end
 
-        @data = { get_node_info: response }
+        @myself = public_key == response_get_info.identity_pubkey
+      end
+
+      def error?
+        !@data[:error].nil?
+      end
+
+      def error
+        @data[:error]
+      end
+
+      def initialize(params, myself: false, fetch: true)
+        if params[:public_key] && fetch
+          begin
+            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
+
+            @data = { get_node_info: response }
+            @raw_node = response.node
+          rescue StandardError => e
+            @data = { get_node_info: nil, error: e }
+            @public_key = params[:public_key]
+          end
+        elsif params[:describe_graph]
+          @data = { describe_graph: params[:describe_graph] }
+
+          @raw_node = params[:describe_graph]
+        else
+          @data = {}
+        end
+
+        @myself = myself
+
+        if params[:public_key] && !fetch
+          @public_key = params[:public_key]
+          return
+        end
 
         @myself = myself
 
-        @alias = @data[:get_node_info].node.alias
-        @public_key = @data[:get_node_info].node.pub_key
-        @color = @data[:get_node_info].node.color
+        return unless @raw_node
+
+        @alias = @raw_node.alias
+        @public_key = @raw_node.pub_key
+        @color = @raw_node.color
       end
     end
   end

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/ports/dsl/lighstorm.rb

@@ -4,6 +4,8 @@ require 'dotenv/load'
 
 require_relative '../../static/spec'
 
+require_relative '../../models/satoshis'
+
 require_relative '../../models/nodes/node'
 
 require_relative '../../models/edges/channel'

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.3',
       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.3
 platform: ruby
 authors:
 - icebaker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-02-05 00:00:00.000000000 Z
+date: 2023-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -36,14 +36,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.4
+        version: 0.0.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.4
+        version: 0.0.5
 - !ruby/object:Gem::Dependency
   name: zache
   requirement: !ruby/object:Gem::Requirement
@@ -78,12 +78,15 @@ files:
 - models/connections/channel_node/accounting.rb
 - models/connections/channel_node/constraints.rb
 - models/connections/channel_node/fee.rb
+- models/connections/channel_node/htlc.rb
 - models/connections/channel_node/policy.rb
 - models/connections/forward_channel.rb
 - models/connections/payment_channel.rb
 - 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 +94,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: