lighstorm 0.0.15 → 0.0.16

data/adapters/lightning/invoice.rb

@@ -0,0 +1,186 @@
+# frozen_string_literal: true
+
+require 'digest'
+
+require_relative '../../ports/dsl/lighstorm/errors'
+
+module Lighstorm
+  module Adapter
+    module Lightning
+      class Invoice
+        def self.add_invoice(grpc)
+          {
+            _source: :add_invoice,
+            code: grpc[:payment_request],
+            address: grpc[:payment_addr].unpack1('H*'),
+            secret: {
+              hash: grpc[:r_hash].unpack1('H*')
+            }
+          }
+        end
+
+        def self.decode_pay_req(grpc, code = nil)
+          adapted = {
+            _source: :decode_pay_req,
+            _key: Digest::SHA256.hexdigest(
+              [
+                grpc[:payment_hash],
+                grpc[:num_satoshis],
+                grpc[:timestamp],
+                grpc[:payment_addr]
+              ].join('/')
+            ),
+            payable: 'once',
+            created_at: Time.at(grpc[:timestamp]),
+            expires_at: Time.at(grpc[:timestamp] + grpc[:expiry]),
+            amount: (grpc[:num_msat]).zero? ? nil : { millisatoshis: grpc[:num_msat] },
+            description: {
+              memo: grpc[:description].empty? ? nil : grpc[:description],
+              hash: grpc[:description_hash] == '' ? nil : grpc[:description_hash]
+            },
+            address: grpc[:payment_addr].unpack1('H*'),
+            secret: {
+              hash: grpc[:payment_hash]
+            }
+          }
+
+          adapted[:code] = code unless code.nil?
+
+          if grpc[:features].key?(30) && grpc[:features][30][:is_required]
+            raise "unexpected feature[30] name #{grpc[:features][30][:name]}" if grpc[:features][30][:name] != 'amp'
+
+            adapted[:payable] = 'indefinitely'
+          end
+
+          adapted
+        end
+
+        def self.lookup_invoice(grpc, at)
+          adapted = list_or_lookup_invoice(grpc, at)
+          adapted[:_source] = :lookup_invoice
+          adapted
+        end
+
+        def self.list_invoices(grpc, at)
+          adapted = list_or_lookup_invoice(grpc, at)
+          adapted[:_source] = :list_invoices
+          adapted
+        end
+
+        def self.list_or_lookup_invoice(grpc, at)
+          raise 'missing at' if at.nil?
+
+          adapted = {
+            _key: _key(grpc),
+            created_at: Time.at(grpc[:creation_date]),
+            expires_at: Time.at(grpc[:creation_date] + grpc[:expiry]),
+            settled_at: grpc[:settle_date].nil? || !grpc[:settle_date].positive? ? nil : Time.at(grpc[:settle_date]),
+            state: grpc[:state].to_s.downcase,
+            code: grpc[:payment_request].empty? ? nil : grpc[:payment_request],
+            payable: grpc[:is_amp] == true ? 'indefinitely' : 'once',
+            description: {
+              memo: grpc[:memo].empty? ? nil : grpc[:memo],
+              hash: grpc[:description_hash].empty? ? nil : grpc[:description_hash]
+            },
+            address: grpc[:payment_addr].unpack1('H*'),
+            secret: {
+              proof: grpc[:r_preimage].empty? ? nil : grpc[:r_preimage].unpack1('H*'),
+              hash: grpc[:r_hash].empty? ? nil : grpc[:r_hash].unpack1('H*')
+            }
+          }
+
+          adapted[:amount] = { millisatoshis: grpc[:value_msat] } if grpc[:value_msat] != 0
+
+          adapted[:received] = { millisatoshis: grpc[:amt_paid_msat] } if grpc[:amt_paid_msat] != 0
+
+          if adapted[:state] == 'settled' &&
+             adapted[:payable] == 'indefinitely' &&
+             adapted[:expires_at] > at
+            adapted[:state] = 'open'
+          end
+
+          raise 'todo: received with canceled' if !adapted[:received].nil? && adapted[:state] == 'canceled'
+
+          adapted[:payments] = []
+
+          grpc[:htlcs].each do |htlc|
+            next unless htlc[:state] == :SETTLED
+
+            payment = {
+              amount: { millisatoshis: htlc[:amt_msat] },
+              hops: [{ channel: { id: htlc[:chan_id] } }],
+              at: Time.at(htlc[:resolve_time])
+            }
+
+            if grpc[:is_amp]
+              payment[:secret] = {
+                proof: htlc[:amp][:preimage].unpack1('H*'),
+                hash: htlc[:amp][:hash].unpack1('H*')
+              }
+            end
+
+            # https://github.com/satoshisstream/satoshis.stream/blob/main/TLV_registry.md
+            if htlc[:custom_records][34_349_334]
+              payment[:message] = htlc[:custom_records][34_349_334].dup
+
+              unless payment[:message].force_encoding('UTF-8').valid_encoding?
+                payment[:message] = payment[:message].unpack1('H*')
+
+                unless payment[:message].force_encoding('UTF-8').valid_encoding?
+                  payment[:message] = payment[:message].scrub('?')
+                end
+              end
+            end
+
+            adapted[:payments] << payment
+          end
+
+          adapted[:payments] = adapted[:payments].sort_by { |payment| -payment[:at].to_i }
+
+          adapted.delete(:payments) if adapted[:payments].empty?
+
+          adapted
+        end
+
+        def self.list_payments(grpc, invoice_decode = nil)
+          data = {
+            _key: _key(grpc),
+            _source: :list_payments,
+            created_at: Time.at(grpc[:creation_date]),
+            settled_at: grpc[:settle_date].nil? || !grpc[:settle_date].positive? ? nil : Time.at(grpc[:settle_date]),
+            state: nil,
+            payable: grpc[:is_amp] == true ? 'indefinitely' : 'once',
+            code: grpc[:payment_request].empty? ? nil : grpc[:payment_request],
+            amount: { millisatoshis: grpc[:value_msat] },
+            description: {
+              memo: grpc[:memo],
+              hash: grpc[:description_hash] == '' ? nil : grpc[:description_hash]
+            },
+            secret: {
+              proof: grpc[:payment_preimage],
+              hash: grpc[:payment_hash]
+            }
+          }
+
+          unless invoice_decode.nil?
+            data[:payable] = invoice_decode[:payable]
+            data[:expires_at] = invoice_decode[:expires_at]
+          end
+
+          data
+        end
+
+        def self._key(grpc)
+          Digest::SHA256.hexdigest(
+            [
+              grpc[:creation_date],
+              grpc[:settle_date],
+              grpc[:payment_request],
+              grpc[:state]
+            ].join('/')
+          )
+        end
+      end
+    end
+  end
+end

data/adapters/lightning/nodes/node.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+require 'digest'
+
+module Lighstorm
+  module Adapter
+    module Lightning
+      class Node
+        def self._key(public_key)
+          Digest::SHA256.hexdigest(
+            [public_key].join('/')
+          )
+        end
+
+        def self.get_chan_info(grpc, index)
+          {
+            _source: :get_chan_info,
+            _key: _key(grpc[:"node#{index}_pub"]),
+            public_key: grpc[:"node#{index}_pub"]
+          }
+        end
+
+        def self.list_channels(grpc, key)
+          data = {
+            _source: :list_channels,
+            _key: _key(key == :remote ? grpc[:remote_pubkey] : nil),
+            public_key: key == :remote ? grpc[:remote_pubkey] : nil
+          }
+
+          return nil if data[:public_key].nil?
+
+          data
+        end
+
+        def self.get_info(grpc)
+          data = {
+            _source: :get_info,
+            _key: _key(grpc[:identity_pubkey]),
+            public_key: grpc[:identity_pubkey],
+            alias: grpc[:alias],
+            color: grpc[:color],
+            platform: {
+              blockchain: grpc[:chains][0][:chain],
+              network: grpc[:chains][0][:network],
+              lightning: {
+                implementation: 'lnd',
+                version: grpc[:version]
+              }
+            }
+          }
+
+          return nil if data[:public_key].nil? && data[:alias].nil? && data[:color].nil?
+
+          data
+        end
+
+        def self.get_node_info(grpc)
+          data = {
+            _source: :get_node_info,
+            _key: _key(grpc[:node][:pub_key]),
+            public_key: grpc[:node][:pub_key],
+            alias: grpc[:node][:alias],
+            color: grpc[:node][:color]
+          }
+
+          return nil if data[:public_key].nil? && data[:alias].nil? && data[:color].nil?
+
+          data
+        end
+
+        def self.describe_graph(grpc)
+          data = {
+            _source: :describe_graph,
+            _key: _key(grpc[:pub_key]),
+            public_key: grpc[:pub_key],
+            alias: grpc[:alias],
+            color: grpc[:color]
+          }
+
+          return nil if data[:public_key].nil? && data[:alias].nil? && data[:color].nil?
+
+          data
+        end
+
+        def self.describe_graph_from_channel(grpc, index)
+          data = {
+            _source: :describe_graph,
+            _key: _key(grpc[:"node#{index}_pub"]),
+            public_key: grpc[:"node#{index}_pub"]
+          }
+
+          return nil if data[:public_key].nil?
+
+          data
+        end
+
+        def self.subscribe_channel_graph(json)
+          data = {
+            _source: :subscribe_channel_graph,
+            _key: _key(json['identityKey']),
+            public_key: json['identityKey'],
+            alias: json['alias'],
+            color: json['color']
+          }
+
+          return nil if data[:public_key].nil? && data[:alias].nil? && data[:color].nil?
+
+          data
+        end
+      end
+    end
+  end
+end

data/controllers/action.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Lighstorm
-  module Controllers
+  module Controller
     module Action
       Output = Struct.new(:data) do
         def request

data/controllers/bitcoin/address/actions/create.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require_relative '../../../../ports/grpc'
+require_relative '../../../../adapters/bitcoin/address'
+require_relative '../../../../models/bitcoin/address'
+require_relative '../../../action'
+
+module Lighstorm
+  module Controller
+    module Bitcoin
+      module Address
+        module Create
+          def self.call(components, grpc_request)
+            {
+              at: Time.now,
+              new_address: components[:grpc].send(grpc_request[:service]).send(
+                grpc_request[:method], grpc_request[:params]
+              ).to_h
+            }
+          end
+
+          def self.prepare
+            # WITNESS_PUBKEY_HASH (0)
+            # A modern and efficient Bitcoin address type. It uses less space in transactions,
+            # so it has lower fees. Addresses usually start with "bc1" (mainnet) or "tb1" (testnet).
+
+            # NESTED_PUBKEY_HASH (1)
+            # \A backward-compatible version of the modern address. It works with older wallets and
+            # services but has slightly higher fees. Addresses usually start with "3" (mainnet)
+            # or "2" (testnet).
+
+            # UNUSED_WITNESS_PUBKEY_HASH (2)
+            # An unused version of the modern address. It's like having a reserved spot for a future
+            # address, but it's not being used right now.
+
+            # UNUSED_NESTED_PUBKEY_HASH (3)
+            # An unused version of the backward-compatible address. Similar to the unused modern
+            # address, it's a reserved spot for a future address but not in use currently.
+
+            # TAPROOT_PUBKEY (4): A new type of Bitcoin address that comes with the Taproot upgrade.
+            # It improves privacy and supports more complex transactions (like smart contracts).
+            # Addresses usually start with "bc1p" (mainnet) or "tb1p" (testnet).
+
+            # UNUSED_TAPROOT_PUBKEY (5)
+            # An unused version of the Taproot address. Like the other unused addresses, it's a
+            # reserved spot for a future address but not in use at the moment.
+            {
+              service: :lightning,
+              method: :new_address,
+              params: {
+                type: :WITNESS_PUBKEY_HASH
+              }
+            }
+          end
+
+          def self.dispatch(components, grpc_request, &vcr)
+            if vcr.nil?
+              call(components, grpc_request)
+            else
+              vcr.call(-> { call(components, grpc_request) }, :dispatch)
+            end
+          end
+
+          def self.adapt(response)
+            Lighstorm::Adapter::Bitcoin::Address.new_address(response[:new_address]).merge(
+              created_at: response[:at]
+            )
+          end
+
+          def self.model(data, components)
+            Model::Bitcoin::Address.new(data, components)
+          end
+
+          def self.perform(components, preview: false, &vcr)
+            grpc_request = prepare
+
+            return grpc_request if preview
+
+            response = dispatch(components, grpc_request, &vcr)
+
+            adapted = adapt(response)
+
+            model = self.model(adapted, components)
+
+            Action::Output.new({ request: grpc_request, response: response[:new_address], result: model })
+          end
+        end
+      end
+    end
+  end
+end

data/controllers/bitcoin/address/actions/pay.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+require_relative '../../../../ports/grpc'
+require_relative '../../../../models/errors'
+require_relative '../../../../adapters/bitcoin/transaction'
+require_relative '../../../../controllers/bitcoin/transaction/all'
+require_relative '../../../action'
+
+module Lighstorm
+  module Controller
+    module Bitcoin
+      module Address
+        module Pay
+          def self.call(components, grpc_request)
+            response = components[:grpc].send(grpc_request[:service]).send(
+              grpc_request[:method], grpc_request[:params]
+            ).to_h
+
+            { response: response, exception: nil }
+          rescue StandardError => e
+            { exception: e }
+          end
+
+          def self.prepare(address_code:, amount:, fee:, description:, required_confirmations:)
+            # required_confirmations:
+            #    1: Fast and low-value transactions, such as buying a cup of coffee
+            #    2: Low-value transactions that require faster processing, such as online purchases
+            #    3: Moderate-value transactions, such as purchasing a computer or paying a bill
+            #    6: High-value transactions, such as buying a car or real estate
+            #  12+: Extremely high-value transactions, such as purchasing a private island or artwork
+
+            # GRPC::Unknown: 2:transaction output is dust.
+            # dust_limit = 3 * 25 * 31 = 2325 satoshis
+            # This formula doesn't seem to be working...
+            request = {
+              service: :lightning,
+              method: :send_coins,
+              params: {
+                addr: address_code,
+                amount: (amount[:millisatoshis].to_f / 1000.0).to_i,
+                sat_per_vbyte: fee[:satoshis_per_vitual_byte],
+                min_confs: required_confirmations
+              }
+            }
+
+            request[:params][:label] = description if !description.nil? && !description.empty?
+
+            request
+          end
+
+          def self.dispatch(components, grpc_request, &vcr)
+            if vcr.nil?
+              call(components, grpc_request)
+            else
+              vcr.call(-> { call(components, grpc_request) }, :dispatch)
+            end
+          end
+
+          def self.adapt(response)
+            Adapter::Bitcoin::Transaction.send_coins(response[:response])
+          end
+
+          def self.fetch(components, adapted, &vcr)
+            Controller::Bitcoin::Transaction::All.data(
+              components, hash: adapted[:hash], limit: 1, &vcr
+            )
+          end
+
+          def self.model(data)
+            Controller::Bitcoin::Transaction::All.model(data)
+          end
+
+          def self.perform(
+            components,
+            address_code:, amount:, fee:, description: nil, required_confirmations: 6,
+            preview: false, &vcr
+          )
+            grpc_request = prepare(
+              address_code: address_code,
+              amount: amount,
+              fee: fee,
+              description: description,
+              required_confirmations: required_confirmations
+            )
+
+            return grpc_request if preview
+
+            response = dispatch(components, grpc_request, &vcr)
+
+            raise_error_if_exists!(grpc_request, response)
+
+            adapted = adapt(response)
+
+            data = fetch(components, adapted, &vcr)
+            model = self.model(data).first
+
+            Action::Output.new({ request: grpc_request, response: response[:response], result: model })
+          end
+
+          def self.raise_error_if_exists!(request, response)
+            return if response[:exception].nil?
+
+            if response[:exception].message =~ /transaction output is dust/
+              raise AmountBelowDustLimitError.new(
+                "Amount is too low and considered dust (#{request[:params][:amount]} satoshis).",
+                request: request, grpc: response[:exception]
+              )
+            end
+
+            raise RequestError.new(
+              response[:exception].message,
+              request: request, grpc: response[:exception]
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/controllers/bitcoin/address.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative '../concerns/impersonatable'
+require_relative './address/actions/create'
+
+module Lighstorm
+  module Controller
+    module Bitcoin
+      module Address
+        extend Impersonatable
+
+        class DSL < Impersonatable::DSL
+          def new(code:)
+            Model::Bitcoin::Address.new({ code: code }, components)
+          end
+
+          def create(preview: false, &vcr)
+            Create.perform(components, preview: preview, &vcr)
+          end
+        end
+      end
+    end
+  end
+end

data/controllers/bitcoin/transaction/all.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require_relative '../../../ports/grpc'
+require_relative '../../../adapters/bitcoin/transaction'
+require_relative '../../../models/bitcoin/transaction'
+
+module Lighstorm
+  module Controller
+    module Bitcoin
+      module Transaction
+        module All
+          def self.fetch(components, hash: nil, limit: nil)
+            at = Time.now
+
+            transactions = []
+
+            response = components[:grpc].lightning.get_transactions
+
+            response.transactions.each do |transaction|
+              next unless hash.nil? || transaction.to_h[:tx_hash] == hash
+
+              transactions << transaction.to_h
+            end
+
+            transactions = transactions.sort_by { |raw_transaction| -raw_transaction[:time_stamp] }
+
+            transactions = transactions[0..limit - 1] unless limit.nil?
+
+            { at: at, get_transactions: transactions }
+          end
+
+          def self.adapt(raw)
+            {
+              get_transactions: raw[:get_transactions].map do |raw_transaction|
+                Adapter::Bitcoin::Transaction.get_transactions(raw_transaction)
+              end
+            }
+          end
+
+          def self.transform(adapted)
+            adapted[:get_transactions]
+          end
+
+          def self.data(components, hash: nil, limit: nil, &vcr)
+            raw = if vcr.nil?
+                    fetch(components, hash: hash, limit: limit)
+                  else
+                    vcr.call(-> { fetch(components, hash: hash, limit: limit) })
+                  end
+
+            adapted = adapt(raw)
+
+            transform(adapted)
+          end
+
+          def self.model(data)
+            data.map do |transaction_data|
+              Model::Bitcoin::Transaction.new(transaction_data)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/controllers/bitcoin/transaction.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative '../concerns/impersonatable'
+
+require_relative './transaction/all'
+
+module Lighstorm
+  module Controller
+    module Bitcoin
+      module Transaction
+        extend Impersonatable
+
+        class DSL < Impersonatable::DSL
+          def all(limit: nil)
+            All.model(All.data(components, limit: limit))
+          end
+
+          def find_by_hash(hash, &vcr)
+            All.model(All.data(components, hash: hash, limit: 1, &vcr)).first
+          end
+        end
+      end
+    end
+  end
+end

data/controllers/concerns/impersonatable.rb

@@ -3,9 +3,11 @@
 require_relative '../../ports/grpc'
 
 module Lighstorm
-  module Controllers
+  module Controller
     module Impersonatable
       class DSL
+        alias _send send
+
         attr_reader :components
 
         def initialize(components = nil)
@@ -19,9 +21,9 @@ module Lighstorm
 
       def method_missing(method_name, *args, &block)
         if args.size == 1 && args.first.is_a?(Hash)
-          self::DSL.new.send(method_name, **args.first, &block)
+          self::DSL.new._send(method_name, **args.first, &block)
         else
-          self::DSL.new.send(method_name, *args, &block)
+          self::DSL.new._send(method_name, *args, &block)
         end
       end
 

data/controllers/connection.rb

@@ -3,7 +3,7 @@
 require_relative './concerns/impersonatable'
 
 module Lighstorm
-  module Controllers
+  module Controller
     module Connection
       def self.connect!(...)
         LND.instance.connect!(...)