lighstorm 0.0.14 → 0.0.16

data/models/lightning/invoice.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+require 'securerandom'
+
+require_relative '../satoshis'
+require_relative '../../controllers/lightning/invoice/actions/create'
+require_relative '../../controllers/lightning/invoice/actions/pay'
+require_relative '../../controllers/lightning/invoice/actions/pay_through_route'
+
+module Lighstorm
+  module Model
+    module Lightning
+      class Invoice
+        attr_reader :_key, :created_at, :expires_at, :settled_at, :state, :payable, :code
+
+        def initialize(data, components)
+          @data = data
+          @components = components
+
+          @_key = data[:_key]
+          @created_at = data[:created_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, @components) }
+        end
+
+        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], @components)
+        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,
+            expires_at: expires_at,
+            settled_at: settled_at,
+            payable: payable,
+            state: state,
+            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(
+          amount: nil, message: nil, route: nil,
+          fee: nil,
+          times_out_in: { seconds: 5 },
+          preview: false
+        )
+          raise MissingComponentsError if @components.nil?
+
+          if route
+            Controller::Lightning::Invoice::PayThroughRoute.perform(
+              @components, self, route: route, preview: preview
+            )
+          else
+            Controller::Lightning::Invoice::Pay.perform(
+              @components,
+              code: code,
+              amount: amount,
+              fee: fee,
+              message: message,
+              times_out_in: times_out_in,
+              preview: preview
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/models/lightning/nodes/node/lightning.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Lighstorm
+  module Model
+    module Lightning
+      class Lightning
+        IMPLEMENTATION = 'lnd'
+
+        attr_reader :implementation, :version
+
+        def initialize(node)
+          raise Errors::NotYourNodeError unless node.myself?
+
+          @implementation = IMPLEMENTATION
+          @version = node.data[:platform][:lightning][:version]
+        end
+
+        def to_h
+          {
+            implementation: implementation,
+            version: version
+          }
+        end
+
+        def dump
+          Marshal.load(
+            Marshal.dump({ implementation: implementation, version: version })
+          )
+        end
+      end
+    end
+  end
+end

data/models/lightning/nodes/node/platform.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require_relative 'lightning'
+
+require_relative '../../../../ports/grpc'
+require_relative '../../../../adapters/lightning/nodes/node'
+
+module Lighstorm
+  module Model
+    module Lightning
+      class Platform
+        attr_reader :data
+
+        def initialize(node)
+          @node = node
+          @data = @node.data[:platform]
+        end
+
+        def blockchain
+          @blockchain ||= @data ? @data[:blockchain] : nil
+        end
+
+        def network
+          @network ||= @data ? @data[:network] : nil
+        end
+
+        def lightning
+          @lightning ||= Lightning.new(@node)
+        end
+
+        def to_h
+          response = {
+            blockchain: blockchain,
+            network: network
+          }
+
+          response[:lightning] = lightning.to_h if @node.myself?
+
+          response
+        end
+
+        def dump
+          data = Marshal.load(Marshal.dump(@data))
+          data.merge(lightning: lightning.dump) if @node.myself?
+          data
+        end
+      end
+    end
+  end
+end

data/models/lightning/nodes/node.rb

@@ -0,0 +1,145 @@
+# frozen_string_literal: true
+
+require_relative '../../../controllers/lightning/node/actions/apply_gossip'
+require_relative '../../../controllers/lightning/node/actions/pay'
+require_relative '../../../controllers/lightning/channel'
+require_relative '../../../adapters/lightning/nodes/node'
+require_relative '../../concerns/protectable'
+require_relative '../../errors'
+
+require_relative 'node/platform'
+
+module Lighstorm
+  module Model
+    module Lightning
+      class Node
+        include Protectable
+
+        attr_reader :data, :_key, :alias, :public_key, :color
+
+        def initialize(data, components)
+          @data = data
+          @components = components
+
+          @_key = @data[:_key]
+          @alias = @data[:alias]
+          @public_key = @data[:public_key]
+          @color = @data[:color]
+        end
+
+        def myself?
+          @data[:myself] == true
+        end
+
+        def platform
+          @platform ||= Platform.new(self)
+        end
+
+        def channels
+          raise Errors::NotYourNodeError unless myself?
+
+          raise MissingComponentsError if @components.nil?
+
+          Controller::Lightning::Channel.mine(@components)
+        end
+
+        def to_h
+          result = {
+            _key: _key,
+            public_key: public_key
+          }
+
+          result[:alias] = @alias unless self.alias.nil?
+          result[:color] = @color unless color.nil?
+
+          result[:platform] = platform.to_h if @data[:platform]
+
+          result
+        end
+
+        def dump
+          result = Marshal.load(Marshal.dump(@data))
+
+          result[:platform] = platform.dump if @data[:platform]
+
+          result
+        end
+
+        def alias=(value)
+          protect!(value)
+
+          @alias = value[:value]
+
+          @data[:alias] = @alias
+
+          self.alias
+        end
+
+        def color=(value)
+          protect!(value)
+
+          @color = value[:value]
+
+          @data[:color] = @color
+
+          color
+        end
+
+        def self.adapt(gossip: nil, dump: nil)
+          raise TooManyArgumentsError, 'you need to pass gossip: or dump:, not both' if !gossip.nil? && !dump.nil?
+
+          raise ArgumentError, 'missing gossip: or dump:' if gossip.nil? && dump.nil?
+
+          if !gossip.nil?
+            new(Adapter::Lightning::Node.subscribe_channel_graph(gossip), nil)
+          elsif !dump.nil?
+            new(dump, nil)
+          end
+        end
+
+        def apply!(gossip:)
+          Controller::Lightning::Node::ApplyGossip.perform(
+            self, gossip
+          )
+        end
+
+        def send_message(
+          message, amount:, fee: nil, secret: nil,
+          times_out_in: { seconds: 5 }, through: 'amp',
+          preview: false
+        )
+          pay(
+            message: message,
+            amount: amount,
+            fee: fee,
+            secret: secret,
+            times_out_in: times_out_in,
+            through: through,
+            preview: preview
+          )
+        end
+
+        def pay(
+          amount:, message: nil, secret: nil,
+          fee: nil,
+          times_out_in: { seconds: 5 }, through: 'amp',
+          preview: false
+        )
+          raise MissingComponentsError if @components.nil?
+
+          Controller::Lightning::Node::Pay.perform(
+            @components,
+            public_key: public_key,
+            amount: amount,
+            fee: fee,
+            through: through,
+            secret: secret,
+            message: message,
+            times_out_in: times_out_in,
+            preview: preview
+          )
+        end
+      end
+    end
+  end
+end

data/models/lightning/rate.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative '../../ports/dsl/lighstorm/errors'
+
+module Lighstorm
+  module Model
+    module Lightning
+      class Rate
+        attr_reader :parts_per_million
+
+        # https://en.wikipedia.org/wiki/Parts-per_notation
+        def initialize(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
+            # satoshis: satoshis,
+            # bitcoins: bitcoins
+          }
+        end
+      end
+    end
+  end
+end

data/models/lightning/secret.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require_relative '../../controllers/lightning/secret/valid_proof'
+
+require 'digest'
+
+module Lighstorm
+  module Model
+    module Lightning
+      class Secret
+        attr_reader :proof, :hash
+
+        def self.generate
+          data = { proof: SecureRandom.hex(32) }
+          data[:hash] = Digest::SHA256.hexdigest([data[:proof]].pack('H*'))
+          data
+        end
+
+        def self.create(components = nil, &vcr)
+          data = vcr.nil? ? generate : vcr.call(-> { generate })
+
+          Secret.new(data, components)
+        end
+
+        def initialize(data, components)
+          @data = data
+          @components = components
+
+          @proof = data[:proof]
+          @hash = data[:hash]
+        end
+
+        def preimage
+          @proof
+        end
+
+        def valid_proof?(candidate_proof, &vcr)
+          raise MissingComponentsError if @components.nil?
+
+          return true if proof && proof.size == 64 && candidate_proof == proof
+
+          Controller::Lightning::Secret::ValidProof.data(
+            @components,
+            @hash, candidate_proof, &vcr
+          )
+        end
+
+        def to_h
+          {
+            proof: proof,
+            hash: hash
+          }
+        end
+      end
+    end
+  end
+end

data/models/satoshis.rb

@@ -3,7 +3,7 @@
 require_relative '../ports/dsl/lighstorm/errors'
 
 module Lighstorm
-  module Models
+  module Model
     class Satoshis
       def initialize(millisatoshis: nil, bitcoins: nil)
         if [millisatoshis, bitcoins].compact.empty?

data/models/wallet/activity.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require_relative '../lightning/invoice'
+require_relative '../bitcoin/transaction'
+
+module Lighstorm
+  module Model
+    module Wallet
+      class Activity
+        attr_reader :direction, :at, :message, :layer, :how, :_key
+
+        def initialize(data)
+          @data = data
+
+          @_key = @data[:_key]
+          @at = @data[:at]
+          @direction = @data[:direction]
+          @layer = @data[:layer]
+          @how = @data[:how]
+          @message = @data[:message]
+        end
+
+        def amount
+          @amount ||= Satoshis.new(millisatoshis: @data[:amount][:millisatoshis])
+        end
+
+        def invoice
+          @invoice ||= @data[:data][:invoice].nil? ? nil : Lightning::Invoice.new(@data[:data][:invoice], nil)
+        end
+
+        def transaction
+          @transaction ||= @data[:data][:transaction].nil? ? nil : Bitcoin::Transaction.new(@data[:data][:transaction])
+        end
+
+        def to_h
+          output = {
+            _key: _key,
+            at: at,
+            direction: direction,
+            layer: layer,
+            how: how,
+            amount: amount.to_h,
+            message: message
+          }
+
+          output[:invoice] = invoice.to_h unless invoice.nil?
+          output[:transaction] = transaction.to_h unless transaction.nil?
+
+          output
+        end
+      end
+    end
+  end
+end

data/models/wallet/balance.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require_relative '../satoshis'
+
+module Lighstorm
+  module Model
+    module Wallet
+      class Balance
+        attr_reader :_key, :at
+
+        def initialize(data)
+          @data = data
+
+          @_key = @data[:_key]
+          @at = @data[:at]
+        end
+
+        def lightning
+          @lightning ||= Satoshis.new(millisatoshis: @data[:lightning][:millisatoshis])
+        end
+
+        def bitcoin
+          @bitcoin ||= Satoshis.new(millisatoshis: @data[:bitcoin][:millisatoshis])
+        end
+
+        def total
+          @total ||= Satoshis.new(millisatoshis: @data[:total][:millisatoshis])
+        end
+
+        def to_h
+          {
+            _key: _key,
+            at: at,
+            lightning: lightning.to_h,
+            bitcoin: bitcoin.to_h,
+            total: total.to_h
+          }
+        end
+      end
+    end
+  end
+end

data/ports/dsl/lighstorm.rb

@@ -6,29 +6,42 @@ require_relative '../../static/spec'
 
 require_relative '../../models/satoshis'
 
-require_relative '../../controllers/node'
-require_relative '../../controllers/channel'
-require_relative '../../controllers/payment'
-require_relative '../../controllers/forward'
-require_relative '../../controllers/invoice'
-require_relative '../../controllers/activity'
 require_relative '../../controllers/connection'
+
 require_relative '../../controllers/wallet'
+require_relative '../../controllers/wallet/activity'
+
+require_relative '../../controllers/lightning/node'
+require_relative '../../controllers/lightning/channel'
+require_relative '../../controllers/lightning/payment'
+require_relative '../../controllers/lightning/forward'
+require_relative '../../controllers/lightning/invoice'
+
+require_relative '../../controllers/bitcoin/transaction'
+require_relative '../../controllers/bitcoin/address'
 
 module Lighstorm
-  Node = Controllers::Node
-  Channel = Controllers::Channel
-  Payment = Controllers::Payment
-  Forward = Controllers::Forward
-  Invoice = Controllers::Invoice
-  Activity = Controllers::Activity
-  Connection = Controllers::Connection
-  Wallet = Controllers::Wallet
+  Connection = Controller::Connection
+
+  Wallet = Controller::Wallet
 
-  Satoshis = Models::Satoshis
+  Satoshis = Model::Satoshis
+
+  module Lightning
+    Node = Controller::Lightning::Node
+    Channel = Controller::Lightning::Channel
+    Invoice = Controller::Lightning::Invoice
+    Payment = Controller::Lightning::Payment
+    Forward = Controller::Lightning::Forward
+  end
+
+  module Bitcoin
+    Address = Controller::Bitcoin::Address
+    Transaction = Controller::Bitcoin::Transaction
+  end
 
   def self.connect!(...)
-    Controllers::Connection.connect!(...)
+    Controller::Connection.connect!(...)
   end
 
   def self.inject_middleware!(middleware_lambda)

data/static/cache.rb

@@ -3,6 +3,8 @@
 module Lighstorm
   module Static
     CACHE = {
+      lightning_send_coins: false,
+      lightning_new_address: false,
       lightning_channel_balance: false,
       lightning_wallet_balance: false,
       lightning_get_transactions: false,

data/static/spec.rb

@@ -4,7 +4,7 @@ module Lighstorm
   module Static
     SPEC = {
       name: 'lighstorm',
-      version: '0.0.14',
+      version: '0.0.16',
       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.',