lighstorm 0.0.6 → 0.0.7

data/docs/_coverpage.md

@@ -4,8 +4,13 @@
 
 - Make your Satoshis flow.
 - Unleash the power of Graphs.
+- Easy-to-use **intuitive** API.
+- Built for maximum **reliability**.
+- Optimized for programmer **happiness**.
 
-0.0.6
+0.0.7
+
+⚠️ _Warning: Early-stage, breaking changes are expected._
 
 [Documentation](README)
 [GitHub](https://github.com/icebaker/lighstorm)

data/docs/index.html

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

data/models/connections/channel_node/accounting.rb

@@ -10,7 +10,7 @@ module Lighstorm
       end
 
       def balance
-        @balance ||= Satoshis.new(milisatoshis: @data[:balance][:milisatoshis])
+        @balance ||= Satoshis.new(millisatoshis: @data[:balance][:millisatoshis])
       end
 
       def to_h

data/models/connections/channel_node/fee.rb

@@ -22,7 +22,7 @@ module Lighstorm
       def base
         return nil unless @data[:base]
 
-        @base ||= Satoshis.new(milisatoshis: @data[:base][:milisatoshis])
+        @base ||= Satoshis.new(millisatoshis: @data[:base][:millisatoshis])
       end
 
       def rate
@@ -46,9 +46,10 @@ module Lighstorm
         Marshal.load(Marshal.dump(@data))
       end
 
-      def update(params, preview: false, fake: false)
+      def update(params, preview: false, &vcr)
         Controllers::Channel::UpdateFee.perform(
-          @policy, params, preview: preview, fake: fake
+          @policy, @policy.transaction, params,
+          preview: preview, &vcr
         )
       end
 
@@ -57,7 +58,7 @@ module Lighstorm
 
         @base = value[:value]
 
-        @data[:base] = { milisatoshis: @base.milisatoshis }
+        @data[:base] = { millisatoshis: @base.millisatoshis }
 
         base
       end

data/models/connections/channel_node/htlc.rb

@@ -17,7 +17,7 @@ module Lighstorm
       def minimum
         @minimum ||= if @data[:minimum]
                        Satoshis.new(
-                         milisatoshis: @data[:minimum][:milisatoshis]
+                         millisatoshis: @data[:minimum][:millisatoshis]
                        )
                      end
       end
@@ -25,7 +25,7 @@ module Lighstorm
       def maximum
         @maximum ||= if @data[:maximum]
                        Satoshis.new(
-                         milisatoshis: @data[:maximum][:milisatoshis]
+                         millisatoshis: @data[:maximum][:millisatoshis]
                        )
                      end
       end
@@ -67,7 +67,7 @@ module Lighstorm
 
         @minimum = value[:value]
 
-        @data[:minimum] = { milisatoshis: @minimum.milisatoshis }
+        @data[:minimum] = { millisatoshis: @minimum.millisatoshis }
 
         minimum
       end
@@ -77,7 +77,7 @@ module Lighstorm
 
         @maximum = value[:value]
 
-        @data[:maximum] = { milisatoshis: @maximum.milisatoshis }
+        @data[:maximum] = { millisatoshis: @maximum.millisatoshis }
 
         maximum
       end

data/models/connections/forward_channel.rb

@@ -10,7 +10,7 @@ module Lighstorm
       end
 
       def amount
-        @amount ||= Satoshis.new(milisatoshis: @data[:amount][:milisatoshis])
+        @amount ||= Satoshis.new(millisatoshis: @data[:amount][:millisatoshis])
       end
 
       def channel

data/models/connections/payment_channel.rb

@@ -24,11 +24,11 @@ module Lighstorm
       end
 
       def amount
-        @amount ||= Satoshis.new(milisatoshis: @data[:amount][:milisatoshis])
+        @amount ||= Satoshis.new(millisatoshis: @data[:amount][:millisatoshis])
       end
 
       def fee
-        @fee ||= Satoshis.new(milisatoshis: @data[:fee][:milisatoshis])
+        @fee ||= Satoshis.new(millisatoshis: @data[:fee][:millisatoshis])
       end
 
       def channel
@@ -40,8 +40,8 @@ module Lighstorm
           hop: hop,
           amount: amount.to_h,
           fee: {
-            milisatoshis: fee.milisatoshis,
-            parts_per_million: fee.parts_per_million(amount.milisatoshis)
+            millisatoshis: fee.millisatoshis,
+            parts_per_million: fee.parts_per_million(amount.millisatoshis)
           },
           channel: channel.to_h
         }

data/models/edges/channel/accounting.rb

@@ -17,7 +17,7 @@ module Lighstorm
       def capacity
         @capacity ||= if @data[:capacity]
                         Satoshis.new(
-                          milisatoshis: @data[:capacity][:milisatoshis]
+                          millisatoshis: @data[:capacity][:millisatoshis]
                         )
                       end
       end
@@ -27,7 +27,7 @@ module Lighstorm
 
         @sent ||= if @data[:sent]
                     Satoshis.new(
-                      milisatoshis: @data[:sent][:milisatoshis]
+                      millisatoshis: @data[:sent][:millisatoshis]
                     )
                   end
       end
@@ -37,7 +37,7 @@ module Lighstorm
 
         @received ||= if @data[:received]
                         Satoshis.new(
-                          milisatoshis: @data[:received][:milisatoshis]
+                          millisatoshis: @data[:received][:millisatoshis]
                         )
                       end
       end
@@ -47,7 +47,7 @@ module Lighstorm
 
         @unsettled ||= if @data[:unsettled]
                          Satoshis.new(
-                           milisatoshis: @data[:unsettled][:milisatoshis]
+                           millisatoshis: @data[:unsettled][:millisatoshis]
                          )
                        end
       end
@@ -76,7 +76,7 @@ module Lighstorm
 
         @capacity = value[:value]
 
-        @data[:capacity][:milisatoshis] = @capacity.milisatoshis
+        @data[:capacity][:millisatoshis] = @capacity.millisatoshis
 
         capacity
       end

data/models/edges/forward.rb

@@ -20,7 +20,7 @@ module Lighstorm
       end
 
       def fee
-        @fee ||= Satoshis.new(milisatoshis: @data[:fee][:milisatoshis])
+        @fee ||= Satoshis.new(millisatoshis: @data[:fee][:millisatoshis])
       end
 
       def in
@@ -36,8 +36,8 @@ module Lighstorm
           _key: _key,
           at: at,
           fee: {
-            milisatoshis: fee.milisatoshis,
-            parts_per_million: fee.parts_per_million(self.in.amount.milisatoshis)
+            millisatoshis: fee.millisatoshis,
+            parts_per_million: fee.parts_per_million(self.in.amount.millisatoshis)
           },
           in: self.in.to_h,
           out: out.to_h

data/models/edges/groups/channel_forwards/analysis.rb

@@ -11,19 +11,19 @@ module Lighstorm
         def sums
           Struct.new(:sums) do
             def amount
-              Satoshis.new(milisatoshis: sums[:amount][:milisatoshis])
+              Satoshis.new(millisatoshis: sums[:amount][:millisatoshis])
             end
 
             def fee
-              Satoshis.new(milisatoshis: sums[:fee][:milisatoshis])
+              Satoshis.new(millisatoshis: sums[:fee][:millisatoshis])
             end
 
             def to_h
               {
                 amount: amount.to_h,
                 fee: {
-                  milisatoshis: fee.milisatoshis,
-                  parts_per_million: fee.parts_per_million(amount.milisatoshis)
+                  millisatoshis: fee.millisatoshis,
+                  parts_per_million: fee.parts_per_million(amount.millisatoshis)
                 }
               }
             end
@@ -34,13 +34,13 @@ module Lighstorm
           Struct.new(:data) do
             def amount
               Satoshis.new(
-                milisatoshis: data[:sums][:amount][:milisatoshis].to_f / data[:count]
+                millisatoshis: data[:sums][:amount][:millisatoshis].to_f / data[:count]
               )
             end
 
             def fee
               Satoshis.new(
-                milisatoshis: data[:sums][:fee][:milisatoshis].to_f / data[:count]
+                millisatoshis: data[:sums][:fee][:millisatoshis].to_f / data[:count]
               )
             end
 
@@ -48,8 +48,8 @@ module Lighstorm
               {
                 amount: amount.to_h,
                 fee: {
-                  milisatoshis: fee.milisatoshis,
-                  parts_per_million: fee.parts_per_million(amount.milisatoshis)
+                  millisatoshis: fee.millisatoshis,
+                  parts_per_million: fee.parts_per_million(amount.millisatoshis)
                 }
               }
             end

data/models/edges/payment.rb

@@ -28,7 +28,7 @@ module Lighstorm
       end
 
       def fee
-        @fee ||= Satoshis.new(milisatoshis: @data[:fee][:milisatoshis])
+        @fee ||= Satoshis.new(millisatoshis: @data[:fee][:millisatoshis])
       end
 
       def hops
@@ -56,8 +56,8 @@ module Lighstorm
           settled_at: settled_at,
           purpose: purpose,
           fee: {
-            milisatoshis: fee.milisatoshis,
-            parts_per_million: fee.parts_per_million(request.amount.milisatoshis)
+            millisatoshis: fee.millisatoshis,
+            parts_per_million: fee.parts_per_million(request.amount.millisatoshis)
           },
           request: request.to_h,
           from: from.to_h,

data/models/errors.rb

@@ -10,7 +10,7 @@ module Lighstorm
     class IncoherentGossipError < LighstormError; end
     class MissingGossipHandlerError < LighstormError; end
     class MissingCredentialsError < LighstormError; end
-    class MissingMilisatoshisError < LighstormError; end
+    class MissingMillisatoshisError < LighstormError; end
     class MissingPartsPerMillionError < LighstormError; end
     class MissingTTLError < LighstormError; end
     class NegativeNotAllowedError < LighstormError; end

data/models/payment_request.rb

@@ -12,7 +12,7 @@ module Lighstorm
         @data = data
 
         @_key = data[:_key] || Digest::SHA256.hexdigest(
-          data[:code] || "#{data[:code][:amount][:milisatoshis]}#{Time.now}"
+          data[:code] || "#{data[:code][:amount][:millisatoshis]}#{Time.now}"
         )
 
         @code = data[:code]
@@ -21,7 +21,7 @@ module Lighstorm
       end
 
       def amount
-        @amount ||= Satoshis.new(milisatoshis: @data[:amount][:milisatoshis])
+        @amount ||= Satoshis.new(millisatoshis: @data[:amount][:millisatoshis])
       end
 
       def description

data/models/satoshis.rb

@@ -5,34 +5,34 @@ require_relative '../ports/dsl/lighstorm/errors'
 module Lighstorm
   module Models
     class Satoshis
-      def initialize(milisatoshis: nil)
-        raise MissingMilisatoshisError, 'missing milisatoshis' if milisatoshis.nil?
+      def initialize(millisatoshis: nil)
+        raise MissingMillisatoshisError, 'missing millisatoshis' if millisatoshis.nil?
 
-        @amount_in_milisatoshis = milisatoshis
+        @amount_in_millisatoshis = millisatoshis
       end
 
-      def parts_per_million(reference_milisatoshis)
+      def parts_per_million(reference_millisatoshis)
         (
           (
-            if reference_milisatoshis.zero?
+            if reference_millisatoshis.zero?
               0
             else
-              @amount_in_milisatoshis.to_f / reference_milisatoshis
+              @amount_in_millisatoshis.to_f / reference_millisatoshis
             end
           ) * 1_000_000.0
         )
       end
 
-      def milisatoshis
-        @amount_in_milisatoshis
+      def millisatoshis
+        @amount_in_millisatoshis
       end
 
       def satoshis
-        @amount_in_milisatoshis.to_f / 1000.0
+        @amount_in_millisatoshis.to_f / 1000.0
       end
 
       def bitcoins
-        @amount_in_milisatoshis.to_f / 100_000_000_000
+        @amount_in_millisatoshis.to_f / 100_000_000_000
       end
 
       def sats
@@ -40,7 +40,7 @@ module Lighstorm
       end
 
       def msats
-        milisatoshis
+        millisatoshis
       end
 
       def btc
@@ -49,7 +49,7 @@ module Lighstorm
 
       def to_h
         {
-          milisatoshis: milisatoshis
+          millisatoshis: millisatoshis
         }
       end
     end

data/static/cache.rb

@@ -3,6 +3,8 @@
 module Lighstorm
   module Static
     CACHE = {
+      update_channel_policy: false,
+      add_invoice: false,
       fee_report: {
         ttl: 0.01,
         properties: %i[

data/static/spec.rb

@@ -4,7 +4,7 @@ module Lighstorm
   module Static
     SPEC = {
       name: 'lighstorm',
-      version: '0.0.6',
+      version: '0.0.7',
       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.6
+  version: 0.0.7
 platform: ruby
 authors:
 - icebaker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-02-25 00:00:00.000000000 Z
+date: 2023-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -87,6 +87,7 @@ files:
 - adapters/payment_request.rb
 - components/cache.rb
 - components/lnd.rb
+- controllers/action.rb
 - controllers/channel.rb
 - controllers/channel/actions/apply_gossip.rb
 - controllers/channel/actions/update_fee.rb