lighstorm 0.0.12 → 0.0.14

data/controllers/transaction/all.rb

@@ -1,103 +1,59 @@
 # frozen_string_literal: true
 
-require_relative '../invoice/all'
-require_relative '../payment/all'
-require_relative '../forward/all'
+require_relative '../../ports/grpc'
+require_relative '../../adapters/transaction'
 require_relative '../../models/transaction'
 
 module Lighstorm
   module Controllers
     module Transaction
       module All
-        def self.fetch(direction: nil, how: nil, limit: nil)
-          transactions = []
-
-          if direction.nil? || direction == 'in'
-            Invoice::All.data(spontaneous: true).filter do |invoice|
-              !invoice[:payments].nil? && invoice[:payments].size.positive?
-            end.each do |invoice|
-              transaction_how = invoice[:code].nil? ? 'spontaneously' : 'with-invoice'
-
-              next if !how.nil? && how != transaction_how
-
-              # TODO: Improve performance by reducing invoice fields and removing payments?
-              invoice[:payments].each do |payment|
-                transactions << {
-                  direction: 'in',
-                  at: payment[:at],
-                  amount: payment[:amount],
-                  how: transaction_how,
-                  message: payment[:message],
-                  data: { invoice: invoice }
-                }
-              end
-            end
-
-            Forward::All.data.each do |forward|
-              next if !how.nil? && how != 'forwarding'
-
-              transactions << {
-                direction: 'in',
-                at: forward[:at],
-                amount: forward[:fee],
-                how: 'forwarding',
-                message: nil,
-                data: {}
-              }
-            end
-          end
+        def self.fetch(components, limit: nil)
+          at = Time.now
 
-          if direction.nil? || direction == 'out'
-            Payment::All.data(
-              fetch: {
-                get_node_info: false,
-                lookup_invoice: false,
-                decode_pay_req: true,
-                get_chan_info: false
-              }
-            )[:data].each do |payment|
-              transaction_how = payment[:invoice][:code].nil? ? 'spontaneously' : 'with-invoice'
+          transactions = []
 
-              next if !how.nil? && how != transaction_how
+          response = components[:grpc].lightning.get_transactions
 
-              # TODO: Improve performance by reducing invoice fields?
-              transactions << {
-                direction: 'out',
-                at: payment[:at],
-                amount: payment[:amount],
-                how: transaction_how,
-                message: payment[:message],
-                data: { invoice: payment[:invoice] }
-              }
-            end
+          response.transactions.each do |transaction|
+            transactions << transaction.to_h
           end
 
-          transactions = transactions.sort_by { |transaction| -transaction[:at].to_i }
+          transactions = transactions.sort_by { |raw_transaction| -raw_transaction[:time_stamp] }
 
           transactions = transactions[0..limit - 1] unless limit.nil?
 
-          { transactions: transactions }
+          { at: at, get_transactions: transactions }
         end
 
-        def self.transform(raw)
-          raw[:transactions].map do |transaction|
-            transaction[:_key] = SecureRandom.hex
-            transaction
-          end
+        def self.adapt(raw)
+          {
+            get_transactions: raw[:get_transactions].map do |raw_transaction|
+              Lighstorm::Adapter::Transaction.get_transactions(raw_transaction)
+            end
+          }
         end
 
-        def self.data(direction: nil, how: nil, limit: nil, &vcr)
+        def self.transform(adapted)
+          adapted[:get_transactions]
+        end
+
+        def self.data(components, limit: nil, &vcr)
           raw = if vcr.nil?
-                  fetch(direction: direction, how: how, limit: limit)
+                  fetch(components, limit: limit)
                 else
-                  vcr.call(-> { fetch(direction: direction, how: how, limit: limit) })
+                  vcr.call(-> { fetch(components, limit: limit) })
                 end
 
-          transform(raw)
+          adapted = adapt(raw)
+
+          transform(adapted)
         end
 
         def self.model(data)
-          data.map { |data| Models::Transaction.new(data) }
+          data.map do |transaction_data|
+            Lighstorm::Models::Transaction.new(transaction_data)
+          end
         end
       end
     end

data/controllers/transaction.rb

@@ -1,16 +1,24 @@
 # frozen_string_literal: true
 
+require_relative './concerns/impersonatable'
+
 require_relative './transaction/all'
 
 module Lighstorm
   module Controllers
     module Transaction
-      def self.all(direction: nil, how: nil, limit: nil)
-        All.model(All.data(
-                    direction: direction,
-                    how: how,
-                    limit: limit
-                  ))
+      extend Impersonatable
+
+      class DSL < Impersonatable::DSL
+        def all(direction: nil, how: nil, layer: nil, limit: nil)
+          All.model(All.data(
+                      components,
+                      direction: direction,
+                      how: how,
+                      layer: layer,
+                      limit: limit
+                    ))
+        end
       end
     end
   end

data/controllers/wallet/balance.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative '../../adapters/wallet'
+require_relative '../../models/wallet'
+
+module Lighstorm
+  module Controllers
+    module Wallet
+      module Balance
+        def self.fetch(components)
+          {
+            at: Time.now,
+            wallet_balance: components[:grpc].lightning.wallet_balance.to_h,
+            channel_balance: components[:grpc].lightning.channel_balance.to_h
+          }
+        end
+
+        def self.adapt(raw)
+          Adapter::Wallet.balance(raw)
+        end
+
+        def self.data(components, &vcr)
+          raw = vcr.nil? ? fetch(components) : vcr.call(-> { fetch(components) })
+
+          adapt(raw)
+        end
+
+        def self.model(data)
+          Models::Wallet.new(data)
+        end
+      end
+    end
+  end
+end

data/controllers/wallet.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative './concerns/impersonatable'
+
+require_relative './wallet/balance'
+
+module Lighstorm
+  module Controllers
+    module Wallet
+      extend Impersonatable
+
+      class DSL < Impersonatable::DSL
+        def balance
+          Balance.model(Balance.data(components))
+        end
+      end
+    end
+  end
+end

data/docs/README.md

@@ -27,40 +27,16 @@ Lighstorm::Channel.mine.first.myself.node.alias
 Add to your `Gemfile`:
 
 ```ruby
-gem 'lighstorm', '~> 0.0.12'
+gem 'lighstorm', '~> 0.0.14'
 ```
 
 Run `bundle install`.
 
-## Credentials
-
-Set the following _Environment Variables_ or create a `.env` file:
-```bash
-LIGHSTORM_LND_ADDRESS=127.0.0.1:10009
-LIGHSTORM_CERTIFICATE_PATH=/lnd/tls.cert
-LIGHSTORM_MACAROON_PATH=/lnd/data/chain/bitcoin/mainnet/admin.macaroon
-```
-
-It will automatically load your credentials.
-
-Alternatively, you can set the credentials at runtime:
-
-```ruby
-require 'lighstorm'
-
-Lighstorm.config!(
-  lnd_address: '127.0.0.1:10009',
-  certificate_path: '/lnd/tls.cert',
-  macaroon_path: '/lnd/data/chain/bitcoin/mainnet/admin.macaroon',
-)
-
-```
-
 ## Examples
 ```ruby
 require 'lighstorm'
 
-puts Lighstorm.version # => 0.0.12
+puts Lighstorm.version # => 0.0.14
 
 Lighstorm::Invoice.create(
   description: 'Coffee', amount: { millisatoshis: 1000 }, payable: 'once'
@@ -116,6 +92,180 @@ Lighstorm::Satoshis.new(
 
 - [Getting Started with Lightning Payments in Ruby](https://mirror.xyz/icebaker.eth/4RUF8umW_KRfVWHHvC2jz0c7YJqzv3RUUvLN-Mln5IU)
 
+# Connecting
+
+## Environment Variables
+
+Choose a method and set the following _Environment Variables_, or create a `.env` file. This will automatically load your credentials.
+
+### lndconnect
+
+Read more about [lnd connect URL](https://github.com/LN-Zap/lndconnect/blob/master/lnd_connect_uri.md).
+
+```bash
+LIGHSTORM_LND_CONNECT=lndconnect://127.0.0.1:10009?cert=MIICJz...JBEERQ&macaroon=AgEDbG...45ukJ4
+```
+
+### File Path
+
+```bash
+LIGHSTORM_LND_ADDRESS=127.0.0.1:10009
+LIGHSTORM_LND_CERTIFICATE_PATH=/lnd/tls.cert
+LIGHSTORM_LND_MACAROON_PATH=/lnd/data/chain/bitcoin/mainnet/admin.macaroon
+```
+
+### Base64
+
+```bash
+LIGHSTORM_LND_ADDRESS=127.0.0.1:10009
+LIGHSTORM_LND_CERTIFICATE=LS0tLS1CRU...UtLS0tLQo=
+LIGHSTORM_LND_MACAROON=AgEDbG5kAv...inv45ukJ4=
+```
+
+### Hex
+
+```bash
+LIGHSTORM_LND_ADDRESS=127.0.0.1:10009
+LIGHSTORM_LND_CERTIFICATE=2d2d2d2d2d...2d2d2d2d0a
+LIGHSTORM_LND_MACAROON=0201036c6e...bf8e6e909e
+```
+
+## Runtime
+Alternatively, you can set the credentials at runtime:
+
+### lndconnect
+
+Read more about [lnd connect URL](https://github.com/LN-Zap/lndconnect/blob/master/lnd_connect_uri.md).
+
+```ruby
+require 'lighstorm'
+
+Lighstorm.connect!(
+  'lndconnect://127.0.0.1:10009?cert=MIICJz...JBEERQ&macaroon=AgEDbG...45ukJ4'
+)
+```
+
+### File Path
+
+```ruby
+require 'lighstorm'
+
+Lighstorm.connect!(
+  address: '127.0.0.1:10009',
+  certificate_path: '/lnd/tls.cert',
+  macaroon_path: '/lnd/data/chain/bitcoin/mainnet/admin.macaroon'
+)
+```
+
+### Base64
+
+```ruby
+require 'lighstorm'
+
+Lighstorm.connect!(
+  address: '127.0.0.1:10009',
+  certificate: 'LS0tLS1CRU...UtLS0tLQo=',
+  macaroon: 'AgEDbG5kAv...inv45ukJ4='
+)
+```
+
+### Hex
+
+```ruby
+require 'lighstorm'
+
+Lighstorm.connect!(
+  address: '127.0.0.1:10009',
+  certificate: '2d2d2d2d2d...2d2d2d2d0a',
+  macaroon: '0201036c6e...bf8e6e909e'
+)
+```
+
+### Raw
+
+```ruby
+require 'lighstorm'
+
+Lighstorm.connect!(
+  address: '127.0.0.1:10009',
+  certificate: File.read('/lnd/tls.cert'),
+  macaroon: File.read('/lnd/data/chain/bitcoin/mainnet/admin.macaroon')
+)
+```
+
+## Multiclient
+
+Multiclient allows you to establish connections with multiple nodes and effortlessly switch between them.
+
+```ruby
+require 'lighstorm'
+
+Lighstorm::Connection.connect!(
+  address: '127.0.0.1:10009',
+  certificate_path: '/lnd/tls.cert',
+  macaroon_path: '/lnd/data/chain/bitcoin/mainnet/admin.macaroon'
+)
+
+Lighstorm::Connection.add!(
+  'alice',
+  'lndconnect://127.0.0.2:10009?cert=MIICJz...JBEERQ&macaroon=AgEDbG...45ukJ4'
+)
+
+Lighstorm::Connection.add!(
+  'bob',
+  address: '127.0.0.3:10009',
+  certificate: 'LS0tLS1CRU...UtLS0tLQo=',
+  macaroon: 'AgEDbG5kAv...inv45ukJ4='
+)
+
+Lighstorm::Connection.default[:address] # => '127.0.0.1:10009'
+Lighstorm::Connection.for('alice')[:address] # => '127.0.0.2:10009'
+Lighstorm::Connection.for('bob')[:address] # => '127.0.0.3:10009'
+
+Lighstorm::Node.myself.alias # => 'icebaker/old-stone'
+Lighstorm::Node.as('alice').myself.alias # => alice
+Lighstorm::Node.as('bob').myself.alias # => bob
+
+Lighstorm::Connection.all # => ['alice', 'bob']
+
+Lighstorm::Connection.remove!('bob')
+
+Lighstorm::Connection.all # => ['alice']
+```
+
+## Docker and Remote Access
+
+To connect to an LND node through a Docker container or remote host, you may need to adjust your certificate settings. Follow these steps:
+
+1. Stop your LND node.
+
+2. Remove or backup existing certificate files (`tls.cert` and `tls.key`) in the LND directory.
+
+3. Modify `lnd.conf` to include the relevant `tlsextraip` and/or `tlsextradomain` settings:
+
+Option A: Accept any IP or domain (Warning: high security risk):
+
+```conf
+tlsextraip=0.0.0.0
+```
+
+Option B: Accept only your Docker host (172.17.0.1):
+```conf
+tlsextraip=172.17.0.1
+```
+
+Option C: Accept a specific remote domain and host:
+```config
+tlsextraip=<your_remote_host_ip>
+tlsextradomain=<your_domain_name>
+```
+
+4. Save and restart your LND node. New tls.cert and tls.key files will be generated.
+
+5. Update your LND client configuration with the new certificate.
+
+Choose the option that best suits your needs and environment while considering security implications.
+
 # Data Modeling
 
 ## Graph Theory
@@ -147,6 +297,8 @@ channel.partner.policy.fee.rate.parts_per_million
 channel.myself.accounting.balance.millisatoshis
 channel.myself.node.alias
 channel.myself.policy.fee.rate.parts_per_million
+
+channel.myself.initiator?
 ```
 
 [![This is an image representing Channel as a graph.](https://raw.githubusercontent.com/icebaker/assets/main/lighstorm/graph-channel.png)](https://raw.githubusercontent.com/icebaker/assets/main/lighstorm/graph-channel.png)
@@ -410,6 +562,7 @@ channel.partner.policy.htlc.blocks.delta.minimum
 channel.myself
 channel.myself.state
 channel.myself.active?
+channel.myself.initiator?
 
 channel.myself.node.public_key
 channel.myself.node.alias
@@ -804,6 +957,21 @@ Lighstorm::Payment.all(
 )
 ```
 
+## Wallet
+
+```ruby
+balance = Lighstorm::Wallet.balance
+
+balance.at
+
+balance.lightning.millisatoshis
+balance.bitcoin.millisatoshis
+
+balance.total.millisatoshis
+
+balance.to_h
+```
+
 ## Forward
 
 [![This is an image representing Forward as a graph.](https://raw.githubusercontent.com/icebaker/assets/main/lighstorm/graph-forward.png)](https://raw.githubusercontent.com/icebaker/assets/main/lighstorm/graph-forward.png)
@@ -1017,19 +1185,24 @@ LighstormError
 
 ArgumentError
 IncoherentGossipError
+InvoiceMayHaveMultiplePaymentsError
+MissingComponentsError
 MissingCredentialsError
 MissingGossipHandlerError
 MissingPartsPerMillionError
+MissingTTLError
 NegativeNotAllowedError
 NotYourChannelError
 NotYourNodeError
 OperationNotAllowedError
 TooManyArgumentsError
-UnexpectedNumberOfHTLCsError
 UnknownChannelError
-UpdateChannelPolicyError
 
+RequestError
+
+NoInvoiceFoundError
 PaymentError
+UpdateChannelPolicyError
 
 AlreadyPaidError
 AmountForNonZeroError
@@ -1048,7 +1221,7 @@ gem 'lighstorm', path: '/home/user/lighstorm'
 # demo.rb
 require 'lighstorm'
 
-puts Lighstorm.version # => 0.0.12
+puts Lighstorm.version # => 0.0.14
 ```
 
 ```sh
@@ -1285,13 +1458,13 @@ gem build lighstorm.gemspec
 
 gem signin
 
-gem push lighstorm-0.0.12.gem
+gem push lighstorm-0.0.14.gem
 ```
 
 _________________
 
 <center>
-  lighstorm 0.0.12
+  lighstorm 0.0.14
   |
   <a href="https://github.com/icebaker/lighstorm" rel="noopener noreferrer" target="_blank">GitHub</a>
   |

data/docs/_coverpage.md

@@ -8,7 +8,7 @@
 - Built for maximum **reliability**.
 - Optimized for programmer **happiness**.
 
-0.0.12
+0.0.14
 
 ⚠️ _Warning: Early-stage, breaking changes are expected._
 

data/docs/index.html

@@ -18,7 +18,7 @@
   <script>
     window.$docsify = {
       coverpage: true,
-      name: 'Lighstorm 0.0.12',
+      name: 'Lighstorm 0.0.14',
       repo: 'https://github.com/icebaker/lighstorm'
     }
   </script>

data/lighstorm.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['ports/dsl']
 
   spec.add_dependency 'dotenv', '~> 2.8', '>= 2.8.1'
-  spec.add_dependency 'lnd-client', '~> 0.0.5'
+  spec.add_dependency 'lnd-client', '~> 0.0.7'
   spec.add_dependency 'zache', '~> 0.12.0'
 
   spec.metadata['rubygems_mfa_required'] = 'true'

data/models/activity.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require_relative 'invoice'
+require_relative 'transaction'
+
+module Lighstorm
+  module Models
+    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 : Invoice.new(@data[:data][:invoice], nil)
+      end
+
+      def transaction
+        @transaction ||= @data[:data][:transaction].nil? ? nil : 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

data/models/connections/channel_node/fee.rb

@@ -6,7 +6,6 @@ require_relative '../../satoshis'
 require_relative '../../rate'
 require_relative '../../concerns/protectable'
 
-require_relative '../../../components/lnd'
 require_relative '../../../controllers/channel/actions/update_fee'
 
 module Lighstorm
@@ -14,8 +13,9 @@ module Lighstorm
     class Fee
       include Protectable
 
-      def initialize(policy, data)
+      def initialize(policy, components, data)
         @policy = policy
+        @components = components
         @data = data
       end
 
@@ -47,7 +47,10 @@ module Lighstorm
       end
 
       def update(params, preview: false, &vcr)
+        raise MissingComponentsError if @components.nil?
+
         Controllers::Channel::UpdateFee.perform(
+          @components,
           @policy, @policy.transaction, params,
           preview: preview, &vcr
         )

data/models/connections/channel_node/policy.rb

@@ -8,13 +8,14 @@ module Lighstorm
     class Policy
       attr_reader :transaction
 
-      def initialize(data, transaction)
+      def initialize(data, components, transaction)
         @data = data
+        @components = components
         @transaction = transaction
       end
 
       def fee
-        @fee ||= Fee.new(self, @data ? @data[:fee] : {})
+        @fee ||= Fee.new(self, @components, @data ? @data[:fee] : {})
       end
 
       def htlc