lighstorm 0.0.3 → 0.0.4

data/models/nodes/node/platform.rb

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
 
-require_relative '../../../components/lnd'
-
 require_relative 'lightning'
 
+require_relative '../../..//ports/grpc'
+require_relative '../../../adapters/nodes/node'
+
 module Lighstorm
   module Models
     class Platform
@@ -11,26 +12,19 @@ module Lighstorm
 
       def initialize(node)
         @node = node
-
-        response = Cache.for('lightning.get_info') do
-          LND.instance.middleware('lightning.get_info') do
-            LND.instance.client.lightning.get_info
-          end
-        end
-
-        @data = { get_info: response }
+        @data = @node.data[:platform]
       end
 
       def blockchain
-        @blockchain ||= @data[:get_info].chains.first.chain
+        @blockchain ||= @data ? @data[:blockchain] : nil
       end
 
       def network
-        @network ||= @data[:get_info].chains.first.network
+        @network ||= @data ? @data[:network] : nil
       end
 
       def lightning
-        @lightning ||= Lightning.new(self, @node)
+        @lightning ||= Lightning.new(@node)
       end
 
       def to_h

data/models/nodes/node.rb

@@ -1,46 +1,26 @@
 # frozen_string_literal: true
 
-require_relative '../../components/lnd'
-
-require_relative '../edges/channel'
+require_relative '../../controllers/channel'
+require_relative '../errors'
 
 require_relative 'node/platform'
 
 module Lighstorm
   module Models
     class Node
-      KIND = :node
-
-      attr_reader :alias, :public_key, :color
+      attr_reader :data, :_key, :alias, :public_key, :color
 
-      def self.myself
-        response = Cache.for('lightning.get_info') do
-          LND.instance.middleware('lightning.get_info') do
-            LND.instance.client.lightning.get_info
-          end
-        end
-
-        Node.find_by_public_key(response.identity_pubkey, myself: true)
-      end
+      def initialize(data)
+        @data = data
 
-      def self.find_by_public_key(public_key, myself: false)
-        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
+        @_key = @data[:_key]
+        @alias = @data[:alias]
+        @public_key = @data[:public_key]
+        @color = @data[:color]
       end
 
       def myself?
-        @myself
+        @data[:myself] == true
       end
 
       def platform
@@ -48,98 +28,23 @@ module Lighstorm
       end
 
       def channels
-        if myself?
-          Channel.mine
-        else
-          Channel.all
-        end
-      end
+        raise Errors::NotYourNodeError unless myself?
 
-      def raw
-        {
-          get_node_info: @data[:get_node_info].to_h,
-          describe_graph: @data[:describe_graph].to_h
-        }
+        Controllers::Channel.mine
       end
 
       def 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
-
-      def myself
-        return @myself unless @myself.nil?
-
-        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 = 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
+        result = {
+          _key: _key,
+          public_key: public_key
+        }
 
-        @myself = myself
+        result[:alias] = @alias unless self.alias.nil?
+        result[:color] = @color unless color.nil?
 
-        return unless @raw_node
+        result[:platform] = platform.to_h if @data[:platform]
 
-        @alias = @raw_node.alias
-        @public_key = @raw_node.pub_key
-        @color = @raw_node.color
+        result
       end
     end
   end

data/models/payment_request.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require 'digest'
+require_relative 'satoshis'
+
+module Lighstorm
+  module Models
+    class PaymentRequest
+      attr_reader :_key, :code, :address
+
+      def initialize(data)
+        @data = data
+
+        @_key = Digest::SHA256.hexdigest(data[:code])
+        @code = data[:code]
+
+        @address = data[:address]
+      end
+
+      def amount
+        @amount ||= Satoshis.new(milisatoshis: @data[:amount][:milisatoshis])
+      end
+
+      def description
+        @description ||= Struct.new(:data) do
+          def memo
+            data[:memo]
+          end
+
+          def hash
+            data[:hash]
+          end
+
+          def to_h
+            { memo: memo, hash: hash }
+          end
+        end.new(@data[:description])
+      end
+
+      def secret
+        @secret ||= Struct.new(:data) do
+          def preimage
+            data[:preimage]
+          end
+
+          def hash
+            data[:hash]
+          end
+
+          def to_h
+            # Don't expose 'secret' by default: Security
+            { hash: hash }
+          end
+        end.new(@data[:secret])
+      end
+
+      def to_h
+        # Don't expose 'address' by default: Privacy
+        {
+          _key: _key,
+          code: code,
+          amount: amount.to_h,
+          description: description.to_h,
+          secret: secret.to_h
+        }
+      end
+    end
+  end
+end

data/models/rate.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative '../ports/dsl/lighstorm/errors'
+
 module Lighstorm
   module Models
     class Rate
@@ -7,12 +9,20 @@ module Lighstorm
 
       # https://en.wikipedia.org/wiki/Parts-per_notation
       def initialize(parts_per_million: nil)
-        raise 'missing parts_per_million' if parts_per_million.nil?
+        raise MissingPartsPerMillionError, 'missing parts_per_million' if parts_per_million.nil?
 
         # TODO
         @parts_per_million = parts_per_million
       end
 
+      def ppm
+        @parts_per_million
+      end
+
+      def percentage
+        @percentage ||= @parts_per_million.to_f / 10_000
+      end
+
       def to_h
         {
           parts_per_million: @parts_per_million

data/models/satoshis.rb

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
 
+require_relative '../ports/dsl/lighstorm/errors'
+
 module Lighstorm
   module Models
     class Satoshis
       def initialize(milisatoshis: nil)
-        raise 'missing milisatoshis' if milisatoshis.nil?
+        raise MissingMilisatoshisError, 'missing milisatoshis' if milisatoshis.nil?
 
         @amount_in_milisatoshis = milisatoshis
       end
@@ -15,8 +17,7 @@ module Lighstorm
             if reference_milisatoshis.zero?
               0
             else
-              @amount_in_milisatoshis.to_f /
-                        reference_milisatoshis
+              @amount_in_milisatoshis.to_f / reference_milisatoshis
             end
           ) * 1_000_000.0
         )
@@ -27,7 +28,7 @@ module Lighstorm
       end
 
       def satoshis
-        (@amount_in_milisatoshis.to_f / 1000.0).to_i
+        @amount_in_milisatoshis.to_f / 1000.0
       end
 
       def bitcoins
@@ -49,8 +50,6 @@ module Lighstorm
       def to_h
         {
           milisatoshis: milisatoshis
-          # satoshis: satoshis,
-          # bitcoins: bitcoins
         }
       end
     end

data/ports/dsl/lighstorm/errors.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require_relative '../../../models/errors'
+
+include Lighstorm::Errors

data/ports/dsl/lighstorm.rb

@@ -6,17 +6,19 @@ require_relative '../../static/spec'
 
 require_relative '../../models/satoshis'
 
-require_relative '../../models/nodes/node'
-
-require_relative '../../models/edges/channel'
-require_relative '../../models/edges/forward'
-require_relative '../../models/edges/payment'
+require_relative '../../controllers/node'
+require_relative '../../controllers/channel'
+require_relative '../../controllers/payment'
+require_relative '../../controllers/forward'
+require_relative '../../controllers/invoice'
 
 module Lighstorm
-  Node = Models::Node
-  Channel = Models::Channel
-  Forward = Models::Forward
-  Payment = Models::Payment
+  Node = Controllers::Node
+  Channel = Controllers::Channel
+  Payment = Controllers::Payment
+  Forward = Controllers::Forward
+  Invoice = Controllers::Invoice
+
   Satoshis = Models::Satoshis
 
   def self.config!(config)

data/ports/grpc.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require_relative '../components/cache'
+require_relative '../components/lnd'
+
+module Lighstorm
+  module Ports
+    class GRPC
+      def initialize(service, service_key)
+        @service = service
+        @service_key = service_key
+      end
+
+      def call!(call_key, *args, &block)
+        key = "#{@service_key}.#{call_key}"
+
+        if block.nil?
+          response = Cache.for(key, params: args&.first) do
+            LND.instance.middleware(key) do
+              @service.send(call_key, *args, &block)
+            end
+          end
+        else
+          LND.instance.middleware(key) do
+            @service.send(call_key, *args, &block)
+          end
+        end
+      end
+
+      def method_missing(method_name, *args, &block)
+        call_key = method_name.to_sym
+
+        raise ArgumentError, "Method `#{method_name}` doesn't exist." unless @service.respond_to?(call_key)
+
+        call!(call_key, *args, &block)
+      end
+
+      def respond_to_missing?(method_name, include_private = false)
+        call_key = method_name.to_sym
+
+        @service.respond_to?(call_key) || super
+      end
+
+      def self.method_missing(method_name, *_args)
+        service_key = method_name.to_sym
+
+        unless LND.instance.client.respond_to?(service_key)
+          raise ArgumentError,
+                "Method `#{method_name}` doesn't exist."
+        end
+
+        new(LND.instance.client.send(service_key), service_key)
+      end
+
+      def self.respond_to_missing?(method_name, include_private = false)
+        service_key = method_name.to_sym
+
+        LND.instance.client.respond_to?(service_key) || super
+      end
+    end
+  end
+end

data/static/cache.rb

@@ -9,6 +9,18 @@ module Lighstorm
           base_fee_msat fee_per_mil
         ]
       },
+      decode_pay_req: {
+        ttl: 5 * 60
+      },
+      describe_graph: {
+        ttl: 0
+      },
+      lookup_invoice: {
+        ttl: 1
+      },
+      list_invoices: {
+        ttl: 1
+      },
       forwarding_history: {
         ttl: 1,
         properties: %i[

data/static/spec.rb

@@ -4,11 +4,13 @@ module Lighstorm
   module Static
     SPEC = {
       name: 'lighstorm',
-      version: '0.0.3',
+      version: '0.0.4',
       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.',
       github: 'https://github.com/icebaker/lighstorm',
+      documentation: 'https://icebaker.github.io/lighstorm',
+      issues: 'https://github.com/icebaker/lighstorm/issues',
       license: 'MIT'
     }.freeze
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lighstorm
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - icebaker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-02-12 00:00:00.000000000 Z
+date: 2023-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -65,18 +65,59 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".env.example"
 - ".gitignore"
+- ".rspec"
 - ".rubocop.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE
 - README.md
+- adapters/connections/channel_node.rb
+- adapters/connections/channel_node/fee.rb
+- adapters/connections/payment_channel.rb
+- adapters/edges/channel.rb
+- adapters/edges/forward.rb
+- adapters/edges/payment.rb
+- adapters/edges/payment/purpose.rb
+- adapters/invoice.rb
+- adapters/nodes/node.rb
+- adapters/payment_request.rb
 - components/cache.rb
 - components/lnd.rb
+- controllers/channel.rb
+- controllers/channel/actions/update_fee.rb
+- controllers/channel/all.rb
+- controllers/channel/find_by_id.rb
+- controllers/channel/mine.rb
+- controllers/forward.rb
+- controllers/forward/all.rb
+- controllers/forward/group_by_channel.rb
+- controllers/invoice.rb
+- controllers/invoice/actions/create.rb
+- controllers/invoice/actions/pay.rb
+- controllers/invoice/actions/pay_through_route.rb
+- controllers/invoice/all.rb
+- controllers/invoice/find_by_secret_hash.rb
+- controllers/node.rb
+- controllers/node/all.rb
+- controllers/node/find_by_public_key.rb
+- controllers/node/myself.rb
+- controllers/payment.rb
+- controllers/payment/all.rb
+- docs/.nojekyll
+- docs/README.md
+- docs/_coverpage.md
+- docs/index.html
+- docs/vendor/docsify-themeable/theme-simple-dark.css
+- docs/vendor/docsify-themeable/theme-simple-dark.css.map
+- docs/vendor/docsify/docsify@4.js
+- docs/vendor/prismjs/prism-bash.min.js
+- docs/vendor/prismjs/prism-ruby.min.js
+- docs/vendor/prismjs/prism-tomorrow.min.css
 - lighstorm.gemspec
 - models/connections/channel_node.rb
 - 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
@@ -84,25 +125,33 @@ files:
 - models/connections/payment_channel.rb
 - models/edges/channel.rb
 - models/edges/channel/accounting.rb
+- models/edges/channel/hop.rb
 - models/edges/forward.rb
-- models/edges/groups/analysis.rb
 - models/edges/groups/channel_forwards.rb
+- models/edges/groups/channel_forwards/analysis.rb
 - models/edges/payment.rb
+- models/errors.rb
+- models/invoice.rb
 - models/nodes/node.rb
 - models/nodes/node/lightning.rb
 - models/nodes/node/platform.rb
+- models/payment_request.rb
 - models/rate.rb
 - models/satoshis.rb
 - ports/dsl/lighstorm.rb
+- ports/dsl/lighstorm/errors.rb
+- ports/grpc.rb
 - static/cache.rb
 - static/spec.rb
-homepage: https://github.com/icebaker/lighstorm
+homepage: https://icebaker.github.io/lighstorm
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-  homepage_uri: https://github.com/icebaker/lighstorm
+  homepage_uri: https://icebaker.github.io/lighstorm
   source_code_uri: https://github.com/icebaker/lighstorm
+  documentation_uri: https://icebaker.github.io/lighstorm
+  bug_tracker_uri: https://github.com/icebaker/lighstorm/issues
   rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []

data/models/connections/channel_node/constraints.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-module Lighstorm
-  module Models
-    class Constraints
-      def initialize(channel, node)
-        @channel = channel
-        @node = node
-      end
-
-      def data
-        @data ||= if @node.myself?
-                    @channel.data[:list_channels][:channels].first.local_constraints
-                  else
-                    @channel.data[:list_channels][:channels].first.remote_constraints
-                  end
-      end
-
-      def to_h
-        data.to_h
-      end
-    end
-  end
-end