lighstorm 0.0.8 → 0.0.9

data/models/edges/payment.rb

@@ -6,33 +6,48 @@ require_relative '../satoshis'
 
 require_relative '../connections/payment_channel'
 require_relative '../nodes/node'
-require_relative '../payment_request'
+require_relative '../invoice'
+require_relative '../secret'
 
 module Lighstorm
   module Models
     class Payment
-      attr_reader :_key, :hash, :request, :status, :created_at, :settled_at, :purpose
+      attr_reader :_key, :at, :state, :secret, :purpose, :through, :message
 
       def initialize(data)
         @data = data
 
         @_key = data[:_key]
-        @status = data[:status]
-        @created_at = data[:created_at]
-        @settled_at = data[:settled_at]
+        @at = data[:at]
+        @state = data[:state]
         @purpose = data[:purpose]
+        @through = data[:through]
+        @message = data[:message]
       end
 
-      def request
-        @request ||= PaymentRequest.new(@data[:request])
+      def how
+        @how ||= spontaneous? ? 'spontaneously' : 'with-invoice'
+      end
+
+      def invoice
+        @invoice ||= !spontaneous? && @data[:invoice] ? Invoice.new(@data[:invoice]) : nil
+      end
+
+      def amount
+        @amount ||= @data[:amount] ? Satoshis.new(millisatoshis: @data[:amount][:millisatoshis]) : nil
       end
 
       def fee
-        @fee ||= Satoshis.new(millisatoshis: @data[:fee][:millisatoshis])
+        @fee ||= @data[:fee] ? Satoshis.new(millisatoshis: @data[:fee][:millisatoshis]) : nil
+      end
+
+      def secret
+        @secret ||= @data[:secret] ? Secret.new(@data[:secret]) : nil
       end
 
       def hops
         return @hops if @hops
+        return nil if @data[:hops].nil?
 
         @data[:hops].last[:is_last] = true
         @hops = @data[:hops].map do |hop|
@@ -41,29 +56,45 @@ module Lighstorm
       end
 
       def from
-        @from ||= hops.first
+        @from ||= @data[:hops].nil? ? nil : hops.first
       end
 
       def to
-        @to ||= hops.last
+        @to ||= @data[:hops].nil? ? nil : hops.last
       end
 
       def to_h
         response = {
           _key: _key,
-          status: status,
-          created_at: created_at,
-          settled_at: settled_at,
+          at: at,
+          state: state,
+          through: through,
           purpose: purpose,
-          fee: {
-            millisatoshis: fee.millisatoshis,
-            parts_per_million: fee.parts_per_million(request.amount.millisatoshis)
-          },
-          request: request.to_h,
+          how: how,
+          message: message,
+          invoice: invoice&.to_h,
           from: from.to_h,
-          to: to.to_h,
-          hops: hops.map(&:to_h)
+          to: to.to_h
         }
+
+        response[:secret] = secret.to_h if secret
+        response[:amount] = amount.to_h if amount
+        if fee
+          response[:fee] = {
+            millisatoshis: fee.millisatoshis,
+            parts_per_million: fee.parts_per_million(amount.millisatoshis)
+          }
+        end
+
+        response[:hops] = hops.map(&:to_h) unless hops.nil?
+
+        response
+      end
+
+      private
+
+      def spontaneous?
+        !@data[:invoice] || @data[:invoice][:code].nil?
       end
     end
   end

data/models/errors.rb

@@ -6,11 +6,11 @@ module Lighstorm
 
     class ToDoError < LighstormError; end
 
+    class ArgumentError < LighstormError; end
     class TooManyArgumentsError < LighstormError; end
     class IncoherentGossipError < LighstormError; end
     class MissingGossipHandlerError < LighstormError; end
     class MissingCredentialsError < LighstormError; end
-    class MissingMillisatoshisError < LighstormError; end
     class MissingPartsPerMillionError < LighstormError; end
     class MissingTTLError < LighstormError; end
     class NegativeNotAllowedError < LighstormError; end
@@ -20,6 +20,34 @@ module Lighstorm
     class UnexpectedNumberOfHTLCsError < LighstormError; end
     class UnknownChannelError < LighstormError; end
 
+    class InvoiceMayHaveMultiplePaymentsError < LighstormError; end
+
+    class PaymentError < LighstormError
+      attr_reader :response, :result, :grpc
+
+      def initialize(message, response: nil, result: nil, grpc: nil)
+        super(message)
+        @response = response
+        @result = result
+        @grpc = grpc
+      end
+
+      def to_h
+        output = { message: message }
+
+        output[:response] = response unless response.nil?
+        output[:result] = result.to_h unless result.nil?
+        output[:grpc] = grpc.message unless grpc.nil?
+
+        output
+      end
+    end
+
+    class NoRouteFoundError < PaymentError; end
+    class AlreadyPaidError < PaymentError; end
+    class AmountForNonZeroError < PaymentError; end
+    class MissingMillisatoshisError < PaymentError; end
+
     class UpdateChannelPolicyError < LighstormError
       attr_reader :response
 

data/models/invoice.rb

@@ -3,8 +3,6 @@
 require_relative 'satoshis'
 require 'securerandom'
 
-require_relative 'payment_request'
-
 require_relative '../controllers/invoice/actions/create'
 require_relative '../controllers/invoice/actions/pay'
 require_relative '../controllers/invoice/actions/pay_through_route'
@@ -12,36 +10,94 @@ require_relative '../controllers/invoice/actions/pay_through_route'
 module Lighstorm
   module Models
     class Invoice
-      attr_reader :_key, :created_at, :settle_at, :state
+      attr_reader :_key, :created_at, :expires_at, :settled_at, :state, :payable, :code
 
       def initialize(data)
         @data = data
 
         @_key = data[:_key]
         @created_at = data[:created_at]
-        @settle_at = data[:settle_at]
+        @expires_at = data[:expires_at]
+        @settled_at = data[:settled_at]
         @state = data[:state]
+
+        @payable = data[:payable]
+
+        @code = data[:code]
+      end
+
+      def payment
+        if payable != 'once' || @data[:payments].size > 1
+          raise InvoiceMayHaveMultiplePaymentsError, "payable: #{payable}, payments: #{@data[:payments].size.size}"
+        end
+
+        @payment ||= payments.first
+      end
+
+      def payments
+        @payments ||= @data[:payments]&.map { |data| Payment.new(data) }
       end
 
-      def request
-        @request ||= PaymentRequest.new(@data[:request])
+      def amount
+        @amount ||= @data[:amount] ? Satoshis.new(millisatoshis: @data[:amount][:millisatoshis]) : nil
+      end
+
+      def received
+        @received ||= @data[:received] ? Satoshis.new(millisatoshis: @data[:received][:millisatoshis]) : nil
+      end
+
+      def secret
+        @secret ||= Secret.new(@data[:secret])
+      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 to_h
-        {
+        result = {
           _key: _key,
           created_at: created_at,
-          settle_at: settle_at,
+          expires_at: expires_at,
+          settled_at: settled_at,
+          payable: payable,
           state: state,
-          request: request.to_h
+          code: code,
+          amount: amount&.to_h,
+          received: received&.to_h,
+          description: description.to_h,
+          secret: secret.to_h,
+          payments: payments&.map(&:to_h)
         }
       end
 
-      def pay!(route: nil, preview: false)
+      def pay(
+        millisatoshis: nil, message: nil, route: nil,
+        times_out_in: { seconds: 5 },
+        preview: false
+      )
         if route
           Controllers::Invoice::PayThroughRoute.perform(self, route: route, preview: preview)
         else
-          Controllers::Invoice::Pay.perform(self, preview: preview)
+          Controllers::Invoice::Pay.perform(
+            request_code: code,
+            millisatoshis: millisatoshis,
+            message: message,
+            times_out_in: times_out_in,
+            preview: preview
+          )
         end
       end
     end

data/models/nodes/node.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative '../../controllers/node/actions/apply_gossip'
+require_relative '../../controllers/node/actions/pay'
 require_relative '../../controllers/channel'
 require_relative '../../adapters/nodes/node'
 require_relative '../concerns/protectable'
@@ -97,6 +98,37 @@ module Lighstorm
           self, gossip
         )
       end
+
+      def send_message(
+        message, millisatoshis:, secret: nil,
+        times_out_in: { seconds: 5 }, through: 'amp',
+        preview: false
+      )
+        pay(
+          message: message,
+          millisatoshis: millisatoshis,
+          secret: secret,
+          times_out_in: times_out_in,
+          through: through,
+          preview: preview
+        )
+      end
+
+      def pay(
+        millisatoshis:, message: nil, secret: nil,
+        times_out_in: { seconds: 5 }, through: 'amp',
+        preview: false
+      )
+        Controllers::Node::Pay.perform(
+          public_key: public_key,
+          millisatoshis: millisatoshis,
+          through: through,
+          secret: secret,
+          message: message,
+          times_out_in: times_out_in,
+          preview: preview
+        )
+      end
     end
   end
 end

data/models/satoshis.rb

@@ -5,10 +5,18 @@ require_relative '../ports/dsl/lighstorm/errors'
 module Lighstorm
   module Models
     class Satoshis
-      def initialize(millisatoshis: nil)
-        raise MissingMillisatoshisError, 'missing millisatoshis' if millisatoshis.nil?
+      def initialize(millisatoshis: nil, bitcoins: nil)
+        if [millisatoshis, bitcoins].compact.empty?
+          raise MissingMillisatoshisError, 'missing millisatoshis'
+        elsif [millisatoshis, bitcoins].compact.size > 1
+          raise Errors::TooManyArgumentsError, 'you need to pass millisatoshis: or bitcoins:, not both'
+        end
 
-        @amount_in_millisatoshis = millisatoshis
+        if !millisatoshis.nil?
+          @amount_in_millisatoshis = millisatoshis
+        elsif !bitcoins.nil?
+          @amount_in_millisatoshis = (bitcoins.to_f * 100_000_000_000.0).to_i
+        end
       end
 
       def parts_per_million(reference_millisatoshis)

data/models/secret.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'digest'
+
+module Lighstorm
+  module Models
+    class Secret
+      attr_reader :preimage, :hash
+
+      def self.create
+        data = { preimage: SecureRandom.hex(32) }
+        data[:hash] = Digest::SHA256.hexdigest([data[:preimage]].pack('H*'))
+        Secret.new(data)
+      end
+
+      def initialize(data)
+        @data = data
+
+        @preimage = data[:preimage]
+        @hash = data[:hash]
+      end
+
+      def to_h
+        {
+          preimage: preimage,
+          hash: hash
+        }
+      end
+    end
+  end
+end

data/models/transaction.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require_relative 'invoice'
+
+module Lighstorm
+  module Models
+    class Transaction
+      attr_reader :direction, :at, :message, :_key
+
+      def initialize(data)
+        @data = data
+
+        @_key = @data[:_key]
+        @at = @data[:at]
+        @direction = @data[:direction]
+        @message = @data[:message]
+      end
+
+      def amount
+        @amount ||= Satoshis.new(millisatoshis: @data[:amount][:millisatoshis])
+      end
+
+      def invoice
+        @invoice ||= @data[:kind] == 'invoice' ? Invoice.new(@data[:data]) : nil
+      end
+
+      def to_h
+        output = {
+          _key: _key,
+          at: at,
+          direction: direction,
+          amount: amount.to_h,
+          message: message
+        }
+
+        output[:invoice] = invoice.to_h unless invoice.nil?
+
+        output
+      end
+    end
+  end
+end

data/ports/dsl/lighstorm.rb

@@ -11,6 +11,7 @@ require_relative '../../controllers/channel'
 require_relative '../../controllers/payment'
 require_relative '../../controllers/forward'
 require_relative '../../controllers/invoice'
+require_relative '../../controllers/transaction'
 
 module Lighstorm
   Node = Controllers::Node
@@ -18,6 +19,7 @@ module Lighstorm
   Payment = Controllers::Payment
   Forward = Controllers::Forward
   Invoice = Controllers::Invoice
+  Transaction = Controllers::Transaction
 
   Satoshis = Models::Satoshis
 

data/static/cache.rb

@@ -3,27 +3,28 @@
 module Lighstorm
   module Static
     CACHE = {
-      update_channel_policy: false,
-      add_invoice: false,
-      fee_report: {
+      lightning_update_channel_policy: false,
+      lightning_add_invoice: false,
+      router_send_payment_v2: false,
+      lightning_fee_report: {
         ttl: 0.01,
         properties: %i[
           base_fee_msat fee_per_mil
         ]
       },
-      decode_pay_req: {
+      lightning_decode_pay_req: {
         ttl: 5 * 60
       },
-      describe_graph: {
+      lightning_describe_graph: {
         ttl: 0
       },
-      lookup_invoice: {
+      lightning_lookup_invoice: {
         ttl: 1
       },
-      list_invoices: {
+      lightning_list_invoices: {
         ttl: 1
       },
-      forwarding_history: {
+      lightning_forwarding_history: {
         ttl: 1,
         properties: %i[
           amt_in_msat
@@ -34,7 +35,7 @@ module Lighstorm
           timestamp_ns
         ]
       },
-      get_chan_info: {
+      lightning_get_chan_info: {
         ttl: 5 * 60,
         properties: %i[
           channel_id
@@ -46,15 +47,15 @@ module Lighstorm
           capacity
         ]
       },
-      get_info: {
+      lightning_get_info: {
         ttl: 5 * 60,
         properties: %i[identity_pubkey version chains chain network]
       },
-      get_node_info: {
+      lightning_get_node_info: {
         ttl: 5 * 60,
         properties: %i[alias pub_key color]
       },
-      list_channels: {
+      lightning_list_channels: {
         ttl: 1,
         properties: %i[
           local_balance remote_balance unsettled_balance
@@ -64,7 +65,7 @@ module Lighstorm
           total_satoshis_sent total_satoshis_received
         ]
       },
-      list_payments: {
+      lightning_list_payments: {
         ttl: 1,
         properties: %i[
           creation_date payment_hash status

data/static/spec.rb

@@ -4,7 +4,7 @@ module Lighstorm
   module Static
     SPEC = {
       name: 'lighstorm',
-      version: '0.0.8',
+      version: '0.0.9',
       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.8
+  version: 0.0.9
 platform: ruby
 authors:
 - icebaker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-06 00:00:00.000000000 Z
+date: 2023-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -74,6 +74,7 @@ files:
 - Gemfile.lock
 - LICENSE
 - README.md
+- Rakefile
 - adapters/connections/channel_node.rb
 - adapters/connections/channel_node/fee.rb
 - adapters/connections/channel_node/policy.rb
@@ -84,7 +85,6 @@ files:
 - adapters/edges/payment/purpose.rb
 - adapters/invoice.rb
 - adapters/nodes/node.rb
-- adapters/payment_request.rb
 - components/cache.rb
 - components/lnd.rb
 - controllers/action.rb
@@ -106,11 +106,16 @@ files:
 - 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/transaction.rb
+- controllers/transaction/all.rb
+- deleted.sh
 - docs/.nojekyll
 - docs/README.md
 - docs/_coverpage.md
@@ -121,6 +126,7 @@ files:
 - docs/vendor/prismjs/prism-bash.min.js
 - docs/vendor/prismjs/prism-ruby.min.js
 - docs/vendor/prismjs/prism-tomorrow.min.css
+- helpers/time_expression.rb
 - lighstorm.gemspec
 - models/concerns/protectable.rb
 - models/connections/channel_node.rb
@@ -143,9 +149,10 @@ files:
 - models/nodes/node.rb
 - models/nodes/node/lightning.rb
 - models/nodes/node/platform.rb
-- models/payment_request.rb
 - models/rate.rb
 - models/satoshis.rb
+- models/secret.rb
+- models/transaction.rb
 - ports/dsl/lighstorm.rb
 - ports/dsl/lighstorm/errors.rb
 - ports/grpc.rb

data/adapters/payment_request.rb

@@ -1,87 +0,0 @@
-# frozen_string_literal: true
-
-require 'digest'
-
-require_relative '../ports/dsl/lighstorm/errors'
-
-module Lighstorm
-  module Adapter
-    class PaymentRequest
-      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)
-        {
-          _source: :decode_pay_req,
-          amount: { millisatoshis: grpc[:num_msat] },
-          description: {
-            memo: grpc[:description],
-            hash: grpc[:description_hash] == '' ? nil : grpc[:description_hash]
-          },
-          address: grpc[:payment_addr].unpack1('H*'),
-          secret: {
-            hash: grpc[:payment_hash]
-          }
-        }
-      end
-
-      def self.lookup_invoice(grpc)
-        adapted = list_or_lookup_invoice(grpc)
-        adapted[:_source] = :lookup_invoice
-        adapted
-      end
-
-      def self.list_invoices(grpc)
-        adapted = list_or_lookup_invoice(grpc)
-        adapted[:_source] = :list_invoices
-        adapted
-      end
-
-      def self.list_or_lookup_invoice(grpc)
-        {
-          code: grpc[:payment_request],
-          amount: { millisatoshis: grpc[:value_msat] },
-          description: {
-            memo: grpc[:memo],
-            hash: grpc[:description_hash] == '' ? nil : grpc[:description_hash]
-          },
-          address: grpc[:payment_addr].unpack1('H*'),
-          secret: {
-            preimage: grpc[:r_preimage].unpack1('H*'),
-            hash: grpc[:r_hash].unpack1('H*')
-          }
-        }
-      end
-
-      def self.list_payments(grpc)
-        raise UnexpectedNumberOfHTLCsError, "htlcs: #{grpc[:htlcs].size}" if grpc[:htlcs].size > 1
-
-        data = {
-          _source: :list_payments,
-          code: grpc[:payment_request],
-          amount: { millisatoshis: grpc[:value_msat] },
-          secret: {
-            preimage: grpc[:payment_preimage],
-            hash: grpc[:payment_hash]
-          }
-        }
-
-        grpc[:htlcs].first[:route][:hops].map do |raw_hop|
-          if raw_hop[:mpp_record] && raw_hop[:mpp_record][:payment_addr]
-            data[:address] = raw_hop[:mpp_record][:payment_addr].unpack1('H*')
-          end
-        end
-
-        data
-      end
-    end
-  end
-end