lighstorm 0.0.15 → 0.0.16

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lighstorm
 version: !ruby/object:Gem::Version
-  version: 0.0.15
+  version: 0.0.16
 platform: ruby
 authors:
 - icebaker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-26 00:00:00.000000000 Z
+date: 2023-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -75,55 +75,60 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- adapters/connections/channel_node.rb
-- adapters/connections/channel_node/fee.rb
-- adapters/connections/channel_node/policy.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/transaction.rb
+- adapters/bitcoin/address.rb
+- adapters/bitcoin/transaction.rb
+- adapters/lightning/connections/channel_node.rb
+- adapters/lightning/connections/channel_node/fee.rb
+- adapters/lightning/connections/channel_node/policy.rb
+- adapters/lightning/connections/payment_channel.rb
+- adapters/lightning/edges/channel.rb
+- adapters/lightning/edges/forward.rb
+- adapters/lightning/edges/payment.rb
+- adapters/lightning/edges/payment/purpose.rb
+- adapters/lightning/invoice.rb
+- adapters/lightning/nodes/node.rb
 - adapters/wallet.rb
 - components/cache.rb
 - components/lnd.rb
 - controllers/action.rb
-- controllers/activity.rb
-- controllers/activity/all.rb
-- controllers/channel.rb
-- controllers/channel/actions/apply_gossip.rb
-- controllers/channel/actions/update_fee.rb
-- controllers/channel/all.rb
-- controllers/channel/find_by_id.rb
-- controllers/channel/mine.rb
+- controllers/bitcoin/address.rb
+- controllers/bitcoin/address/actions/create.rb
+- controllers/bitcoin/address/actions/pay.rb
+- controllers/bitcoin/transaction.rb
+- controllers/bitcoin/transaction/all.rb
 - controllers/concerns/impersonatable.rb
 - controllers/connection.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/decode.rb
-- controllers/invoice/find_by_code.rb
-- controllers/invoice/find_by_secret_hash.rb
-- controllers/node.rb
-- controllers/node/actions/apply_gossip.rb
-- controllers/node/actions/pay.rb
-- controllers/node/all.rb
-- controllers/node/find_by_public_key.rb
-- controllers/node/myself.rb
-- controllers/payment.rb
-- controllers/payment/actions/pay.rb
-- controllers/payment/all.rb
-- controllers/secret/valid_proof.rb
-- controllers/transaction.rb
-- controllers/transaction/all.rb
+- controllers/lightning/channel.rb
+- controllers/lightning/channel/actions/apply_gossip.rb
+- controllers/lightning/channel/actions/update_fee.rb
+- controllers/lightning/channel/all.rb
+- controllers/lightning/channel/find_by_id.rb
+- controllers/lightning/channel/mine.rb
+- controllers/lightning/forward.rb
+- controllers/lightning/forward/all.rb
+- controllers/lightning/forward/group_by_channel.rb
+- controllers/lightning/invoice.rb
+- controllers/lightning/invoice/actions/create.rb
+- controllers/lightning/invoice/actions/pay.rb
+- controllers/lightning/invoice/actions/pay_through_route.rb
+- controllers/lightning/invoice/all.rb
+- controllers/lightning/invoice/decode.rb
+- controllers/lightning/invoice/find_by_code.rb
+- controllers/lightning/invoice/find_by_secret_hash.rb
+- controllers/lightning/node.rb
+- controllers/lightning/node/actions/apply_gossip.rb
+- controllers/lightning/node/actions/pay.rb
+- controllers/lightning/node/all.rb
+- controllers/lightning/node/find_by_public_key.rb
+- controllers/lightning/node/myself.rb
+- controllers/lightning/payment.rb
+- controllers/lightning/payment/actions/pay.rb
+- controllers/lightning/payment/all.rb
+- controllers/lightning/secret.rb
+- controllers/lightning/secret/valid_proof.rb
 - controllers/wallet.rb
+- controllers/wallet/activity.rb
+- controllers/wallet/activity/all.rb
 - controllers/wallet/balance.rb
 - docs/.nojekyll
 - docs/README.md
@@ -137,33 +142,34 @@ files:
 - docs/vendor/prismjs/prism-tomorrow.min.css
 - helpers/time_expression.rb
 - lighstorm.gemspec
-- models/activity.rb
+- models/bitcoin/address.rb
+- models/bitcoin/transaction.rb
 - models/concerns/protectable.rb
-- models/connections/channel_node.rb
-- models/connections/channel_node/accounting.rb
-- models/connections/channel_node/fee.rb
-- models/connections/channel_node/htlc.rb
-- models/connections/channel_node/htlc/blocks/delta.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/channel/hop.rb
-- models/edges/forward.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/rate.rb
+- models/lightning/connections/channel_node.rb
+- models/lightning/connections/channel_node/accounting.rb
+- models/lightning/connections/channel_node/fee.rb
+- models/lightning/connections/channel_node/htlc.rb
+- models/lightning/connections/channel_node/htlc/blocks/delta.rb
+- models/lightning/connections/channel_node/policy.rb
+- models/lightning/connections/forward_channel.rb
+- models/lightning/connections/payment_channel.rb
+- models/lightning/edges/channel.rb
+- models/lightning/edges/channel/accounting.rb
+- models/lightning/edges/channel/hop.rb
+- models/lightning/edges/forward.rb
+- models/lightning/edges/groups/channel_forwards.rb
+- models/lightning/edges/groups/channel_forwards/analysis.rb
+- models/lightning/edges/payment.rb
+- models/lightning/invoice.rb
+- models/lightning/nodes/node.rb
+- models/lightning/nodes/node/lightning.rb
+- models/lightning/nodes/node/platform.rb
+- models/lightning/rate.rb
+- models/lightning/secret.rb
 - models/satoshis.rb
-- models/secret.rb
-- models/transaction.rb
-- models/wallet.rb
+- models/wallet/activity.rb
+- models/wallet/balance.rb
 - ports/dsl/lighstorm.rb
 - ports/dsl/lighstorm/errors.rb
 - ports/grpc.rb

data/adapters/connections/channel_node/fee.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-module Lighstorm
-  module Adapter
-    class Fee
-      def self.fee_report(grpc)
-        {
-          _source: :fee_report,
-          id: grpc[:chan_id].to_s,
-          partner: {
-            policy: {
-              fee: {
-                base: {
-                  millisatoshis: grpc[:base_fee_msat]
-                },
-                rate: {
-                  parts_per_million: grpc[:fee_per_mil]
-                }
-              }
-            }
-          }
-        }
-      end
-    end
-  end
-end

data/adapters/connections/channel_node/policy.rb

@@ -1,61 +0,0 @@
-# frozen_string_literal: true
-
-module Lighstorm
-  module Adapter
-    class Policy
-      def self.get_chan_info(grpc)
-        {
-          fee: {
-            base: { millisatoshis: grpc[:fee_base_msat] },
-            rate: { parts_per_million: grpc[:fee_rate_milli_msat] }
-          },
-          htlc: {
-            minimum: { millisatoshis: grpc[:min_htlc] },
-            maximum: { millisatoshis: 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: { millisatoshis: json['routingPolicy']['feeBaseMsat'].to_i },
-            rate: { parts_per_million: json['routingPolicy']['feeRateMilliMsat'].to_i }
-          },
-          htlc: {
-            minimum: { millisatoshis: json['routingPolicy']['minHtlc'].to_i },
-            maximum: { millisatoshis: 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,75 +0,0 @@
-# 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',
-          initiator: grpc[:initiator] && key == :local,
-          accounting: { balance: { millisatoshis: 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)
-        data = {
-          _source: :get_chan_info,
-          node: Node.get_chan_info(grpc, index)
-        }
-
-        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.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
-end

data/adapters/connections/payment_channel.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-require 'digest'
-
-module Lighstorm
-  module Adapter
-    class PaymentChannel
-      def self.list_payments(grpc, index)
-        {
-          _source: :list_payments,
-          hop: index + 1,
-          amount: { millisatoshis: grpc[:amt_to_forward_msat] },
-          fee: { millisatoshis: grpc[:fee_msat] },
-          channel: {
-            _key: Digest::SHA256.hexdigest(grpc[:chan_id].to_s),
-            id: grpc[:chan_id].to_s,
-            partners: [
-              node: {
-                _key: Digest::SHA256.hexdigest(grpc[:pub_key].to_s),
-                public_key: grpc[:pub_key]
-              }
-            ]
-          }
-        }
-      end
-    end
-  end
-end

data/adapters/edges/channel.rb

@@ -1,96 +0,0 @@
-# frozen_string_literal: true
-
-require 'digest'
-
-require_relative '../connections/channel_node'
-
-module Lighstorm
-  module Adapter
-    class Channel
-      def self._key(id, state)
-        Digest::SHA256.hexdigest(
-          [id, state].join('/')
-        )
-      end
-
-      def self.list_channels(grpc, at)
-        {
-          _source: :list_channels,
-          _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: {
-            funding: {
-              id: grpc[:channel_point].split(':').first,
-              index: grpc[:channel_point].split(':').last.to_i
-            }
-          },
-          opened_at: at - grpc[:lifetime],
-          up_at: at - grpc[:uptime],
-          state: grpc[:active] ? 'active' : 'inactive',
-          exposure: grpc[:private] ? 'private' : 'public',
-          accounting: {
-            capacity: { millisatoshis: grpc[:capacity] * 1000 },
-            sent: { millisatoshis: grpc[:total_satoshis_sent] * 1000 },
-            received: { millisatoshis: grpc[:total_satoshis_received] * 1000 },
-            unsettled: { millisatoshis: grpc[:unsettled_balance] * 1000 }
-          },
-          partners: [
-            ChannelNode.list_channels(grpc, :local),
-            ChannelNode.list_channels(grpc, :remote)
-          ]
-        }
-      end
-
-      def self.get_chan_info(grpc)
-        {
-          _source: :get_chan_info,
-          _key: _key(grpc[:channel_id], nil),
-          # Standard JSON don't support BigInt, so, a String is safer.
-          id: grpc[:channel_id].to_s,
-          accounting: {
-            capacity: { millisatoshis: grpc[:capacity] * 1000 }
-          },
-          partners: [
-            ChannelNode.get_chan_info(grpc, 1),
-            ChannelNode.get_chan_info(grpc, 2)
-          ]
-        }
-      end
-
-      def self.describe_graph(grpc)
-        {
-          _source: :describe_graph,
-          _key: _key(grpc[:channel_id], nil),
-          # Standard JSON don't support BigInt, so, a String is safer.
-          id: grpc[:channel_id].to_s,
-          exposure: 'public',
-          accounting: {
-            capacity: { millisatoshis: grpc[:capacity] * 1000 }
-          },
-          partners: [
-            ChannelNode.describe_graph(grpc, 1),
-            ChannelNode.describe_graph(grpc, 2)
-          ]
-        }
-      end
-
-      def self.subscribe_channel_graph(json)
-        {
-          _source: :subscribe_channel_graph,
-          _key: _key(json['chanId'], nil),
-          id: json['chanId'],
-          accounting: {
-            capacity: { millisatoshis: 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,40 +0,0 @@
-# frozen_string_literal: true
-
-require 'digest'
-
-module Lighstorm
-  module Adapter
-    class Forward
-      def self.forwarding_history(grpc)
-        {
-          _source: :forwarding_history,
-          _key: _key(grpc),
-          at: Time.at(grpc[:timestamp_ns] / 1e+9),
-          fee: { millisatoshis: grpc[:fee_msat] },
-          in: {
-            amount: { millisatoshis: grpc[:amt_in_msat] },
-            channel: {
-              id: grpc[:chan_id_in].to_s
-            }
-          },
-          out: {
-            amount: { millisatoshis: grpc[:amt_out_msat] },
-            channel: {
-              id: grpc[:chan_id_out].to_s
-            }
-          }
-        }
-      end
-
-      def self._key(grpc)
-        Digest::SHA256.hexdigest(
-          [
-            grpc[:timestamp_ns],
-            grpc[:chan_id_in], grpc[:chan_id_out],
-            grpc[:amt_in_msat], grpc[:fee_msat]
-          ].join('/')
-        )
-      end
-    end
-  end
-end

data/adapters/edges/payment/purpose.rb

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-module Lighstorm
-  module Adapter
-    class Purpose
-      def self.send_payment_v2(grpc, node_get_info)
-        return 'unknown' if grpc[:payment_route][:hops].empty?
-
-        return 'self-payment' if self_payment?(grpc[:payment_route][:hops])
-        return 'peer-to-peer' if peer_to_peer?(grpc[:payment_route][:hops])
-        return 'rebalance' if rebalance?(grpc[:payment_route][:hops], node_get_info)
-
-        'payment'
-      end
-
-      def self.list_payments(grpc, node_get_info)
-        return 'unknown' if grpc[:htlcs].empty?
-
-        return 'self-payment' if self_payment?(grpc[:htlcs].last[:route][:hops])
-        return 'peer-to-peer' if peer_to_peer?(grpc[:htlcs].last[:route][:hops])
-        return 'rebalance' if rebalance?(grpc[:htlcs].last[:route][:hops], node_get_info)
-
-        'payment'
-      end
-
-      def self.self_payment?(hops)
-        hops.size == 2 && hops[0][:chan_id] == hops[1][:chan_id]
-      end
-
-      def self.peer_to_peer?(hops)
-        hops.size == 1
-      end
-
-      def self.rebalance?(hops, node_get_info)
-        return false if hops.size <= 2
-
-        destination_public_key = hops.last[:pub_key]
-
-        node_get_info[:identity_pubkey] == destination_public_key
-      end
-    end
-  end
-end

data/adapters/edges/payment.rb

@@ -1,87 +0,0 @@
-# frozen_string_literal: true
-
-require 'digest'
-
-require_relative '../connections/payment_channel'
-require_relative 'payment/purpose'
-
-require_relative '../invoice'
-
-require_relative '../../ports/dsl/lighstorm/errors'
-
-module Lighstorm
-  module Adapter
-    class Payment
-      def self._key(grpc)
-        Digest::SHA256.hexdigest(
-          [
-            grpc[:payment_request],
-            grpc[:creation_time_ns],
-            grpc[:resolve_time_ns],
-            grpc[:status]
-          ].join('/')
-        )
-      end
-
-      def self.send_payment_v2(grpc, node_myself, invoice_decode)
-        adapted = list_payments(grpc, node_myself, invoice_decode)
-        adapted[:_source] = :send_payment_v2
-        adapted
-      end
-
-      def self.list_payments(grpc, node_myself, invoice_decode = nil)
-        data = {
-          _source: :list_payments,
-          _key: _key(grpc),
-          at: Time.at(grpc[:creation_time_ns] / 1e+9),
-          state: grpc[:status].to_s.downcase,
-          fee: { millisatoshis: grpc[:fee_msat] },
-          amount: { millisatoshis: grpc[:value_msat] },
-          purpose: Purpose.list_payments(grpc, node_myself),
-          invoice: Invoice.list_payments(grpc, invoice_decode)
-        }
-
-        data[:secret] = data[:invoice][:secret]
-
-        htlc = grpc[:htlcs].last
-
-        return data if htlc.nil?
-
-        data[:hops] = htlc[:route][:hops].map.with_index do |raw_hop, i|
-          hop = PaymentChannel.list_payments(raw_hop, i)
-          hop[:channel][:target] = { public_key: raw_hop[:pub_key] }
-          hop
-        end
-
-        data[:invoice][:settled_at] = Time.at(htlc[:resolve_time_ns] / 1e+9) if htlc[:resolve_time_ns]
-
-        last_hop = htlc[:route][:hops].last
-
-        return data if last_hop.nil?
-
-        # https://github.com/satoshisstream/satoshis.stream/blob/main/TLV_registry.md
-        if last_hop[:custom_records][34_349_334]
-          data[:message] = last_hop[:custom_records][34_349_334].dup
-
-          unless data[:message].force_encoding('UTF-8').valid_encoding?
-            data[:message] = data[:message].unpack1('H*')
-
-            data[:message] = data[:message].scrub('?') unless data[:message].force_encoding('UTF-8').valid_encoding?
-          end
-        end
-
-        if data[:invoice] && data[:invoice][:code] && !data[:invoice][:code].nil? && !data[:invoice][:code].empty?
-          data[:through] = if data[:invoice][:payable] == 'indefinitely'
-                             'amp'
-                           else
-                             'non-amp'
-                           end
-        else
-          data[:through] = last_hop[:mpp_record] ? 'amp' : 'keysend'
-        end
-
-        data
-      end
-    end
-  end
-end