lighstorm 0.0.4 → 0.0.6

data/docs/README.md

@@ -23,7 +23,7 @@ Lighstorm::Channel.mine.first.myself.node.alias
 Add to your `Gemfile`:
 
 ```ruby
-gem 'lighstorm', '~> 0.0.4'
+gem 'lighstorm', '~> 0.0.6'
 ```
 
 Run `bundle install`.
@@ -56,7 +56,7 @@ Lighstorm.config!(
 ```ruby
 require 'lighstorm'
 
-puts Lighstorm.version # => 0.0.4
+puts Lighstorm.version # => 0.0.6
 
 Lighstorm::Satoshis.new(
   milisatoshis: 75_621_650
@@ -251,16 +251,23 @@ end
 ```ruby
 LighstormError
 
+IncoherentGossipError
+
+TooManyArgumentsError
 MissingCredentialsError
+MissingGossipHandlerError
 MissingMilisatoshisError
 MissingPartsPerMillionError
 MissingTTLError
+
 NegativeNotAllowedError
+
 NotYourChannelError
 NotYourNodeError
+UnknownChannelError
+
 OperationNotAllowedError
 UnexpectedNumberOfHTLCsError
-UnknownChannelError
 UpdateChannelPolicyError
 ```
 
@@ -327,7 +334,8 @@ channel.mine?
 channel.id
 channel.opened_at
 channel.up_at
-channel.active
+channel.state
+channel.active?
 channel.exposure
 
 channel.accounting.capacity.milisatoshis
@@ -345,31 +353,39 @@ channel.partners[1]
 channel.partners[1].node.alias
 
 # Channels that belong to you:
-channel.myself
-channel.myself.node.alias
-
 channel.transaction.funding.id
 channel.transaction.funding.index
 
 channel.partner
-channel.partner.node.alias
+channel.partner.state
+channel.partner.active?
 
-channel.partner.accounting.balance.milisatoshis
-channel.partner.node.alias
 channel.partner.node.public_key
+channel.partner.node.alias
 channel.partner.node.color
+
+channel.partner.accounting.balance.milisatoshis
+
 channel.partner.policy.fee.base.milisatoshis
 channel.partner.policy.fee.rate.parts_per_million
+
 channel.partner.policy.htlc.minimum.milisatoshis
 channel.partner.policy.htlc.maximum.milisatoshis
 channel.partner.policy.htlc.blocks.delta.minimum
 
-channel.myself.accounting.balance.milisatoshis
-channel.myself.node.alias
+channel.myself
+channel.myself.state
+channel.myself.active?
+
 channel.myself.node.public_key
+channel.myself.node.alias
 channel.myself.node.color
+
+channel.myself.accounting.balance.milisatoshis
+
 channel.myself.policy.fee.base.milisatoshis
 channel.myself.policy.fee.rate.parts_per_million
+
 channel.myself.policy.htlc.minimum.milisatoshis
 channel.myself.policy.htlc.maximum.milisatoshis
 channel.myself.policy.htlc.blocks.delta.minimum
@@ -380,6 +396,8 @@ channel.myself.policy.htlc.blocks.delta.minimum
 ```ruby
 channel = Lighstorm::Channel.mine.first
 
+# 'preview' let you check the expected operation
+# before actually performing it for debug purposes
 channel.myself.policy.fee.update(
   { rate: { parts_per_million: 25 } }, preview: true
 )
@@ -399,6 +417,8 @@ channel.myself.policy.fee.update(
 
 ## Invoice
 
+[Understanding Lightning Invoices](https://docs.lightning.engineering/the-lightning-network/payment-lifecycle/understanding-lightning-invoices)
+
 ```ruby
 Lighstorm::Invoice
 Lighstorm::Invoice.all
@@ -436,6 +456,22 @@ invoice.request.secret.hash
 invoice.request.address
 ```
 
+### Operations
+
+[Understanding Lightning Invoices](https://docs.lightning.engineering/the-lightning-network/payment-lifecycle/understanding-lightning-invoices)
+
+```ruby
+# 'preview' let you check the expected operation
+# before actually performing it for debug purposes
+invoice = Lighstorm::Invoice.create(
+  milisatoshis: 1000, description: 'Coffee', preview: true
+)
+
+invoice = Lighstorm::Invoice.create(
+  milisatoshis: 1000, description: 'Piña Colada'
+)
+```
+
 ## Payment
 
 [![This is an image representing Payment as a graph.](https://raw.githubusercontent.com/icebaker/assets/main/lighstorm/graph-payment.png)](https://raw.githubusercontent.com/icebaker/assets/main/lighstorm/graph-payment.png)
@@ -537,6 +573,17 @@ payment.hops[0].channel.entry.public_key
 payment.hops[0].channel.entry.alias
 payment.hops[0].channel.entry.color
 ```
+### Performance
+Avoid fetching data that you don't need:
+```ruby
+Lighstorm::Payment.all(
+  fetch: {
+    get_node_info: false,
+    lookup_invoice: false,
+    decode_pay_req: false,
+    get_chan_info: false }
+)
+```
 
 ## Forward
 
@@ -625,6 +672,55 @@ group.channel.partner.node.public_key
 group.channel.partner.node.color
 ```
 
+## Gossip
+
+[The Gossip Network](https://docs.lightning.engineering/the-lightning-network/the-gossip-network)
+
+### Node
+
+```ruby
+gossip = {
+  'identityKey' => '02d3c80335a8ccb2ed364c06875f32240f36f7edb37d80f8dbe321b4c364b6e997',
+  'alias' => 'icebaker',
+  'color' => '#eb34a4'
+}
+
+Lighstorm::Node.adapt(gossip: gossip)
+
+node = Lighstorm::Node.find_by_public_key(
+  '02d3c80335a8ccb2ed364c06875f32240f36f7edb37d80f8dbe321b4c364b6e997'
+)
+
+diff = node.apply!(gossip: gossip)
+
+Lighstorm::Node.adapt(dump: node.dump)
+```
+
+### Channel
+
+```ruby
+gossip = {
+  'chanId' => '850099509773795329',
+  'capacity' => '5000000',
+  'routingPolicy' => {
+    'timeLockDelta' => 144,
+    'minHtlc' => '1000',
+    'feeBaseMsat' => '1000',
+    'feeRateMilliMsat' => '300',
+    'maxHtlcMsat' => '4950000000'
+  },
+  'advertisingNode' => '02d3c80335a8ccb2ed364c06875f32240f36f7edb37d80f8dbe321b4c364b6e997'
+}
+
+Lighstorm::Channel.adapt(gossip: gossip)
+
+channel = Lighstorm::Channel.find_by_id('850099509773795329')
+
+diff = channel.apply!(gossip: gossip)
+
+Lighstorm::Channel.adapt(dump: channel.dump)
+```
+
 ## Satoshis
 
 ```ruby
@@ -647,7 +743,7 @@ satoshis.parts_per_million(reference_in_milisatoshis)
 _________________
 
 <center>
-  lighstorm 0.0.4
+  lighstorm 0.0.6
   |
   <a href="https://github.com/icebaker/lighstorm" rel="noopener noreferrer" target="_blank">GitHub</a>
   |

data/docs/_coverpage.md

@@ -5,7 +5,7 @@
 - Make your Satoshis flow.
 - Unleash the power of Graphs.
 
-0.0.4
+0.0.6
 
 [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.4',
+      name: 'Lighstorm 0.0.6',
       repo: 'https://github.com/icebaker/lighstorm'
     }
   </script>

data/models/concerns/protectable.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Lighstorm
+  module Models
+    module Protectable
+      def prepare_token!(token)
+        @token = token
+      end
+
+      def protect!(value)
+        validate_token!(value)
+      end
+
+      def validate_token!(value)
+        token = value.is_a?(Hash) ? value[:token] : nil
+
+        raise OperationNotAllowedError if token.nil? || @token.nil? || token != @token
+
+        @token = nil
+      end
+    end
+  end
+end

data/models/connections/channel_node/accounting.rb

@@ -16,6 +16,10 @@ module Lighstorm
       def to_h
         { balance: balance.to_h }
       end
+
+      def dump
+        Marshal.load(Marshal.dump(@data))
+      end
     end
   end
 end

data/models/connections/channel_node/fee.rb

@@ -4,6 +4,7 @@ require 'securerandom'
 
 require_relative '../../satoshis'
 require_relative '../../rate'
+require_relative '../../concerns/protectable'
 
 require_relative '../../../components/lnd'
 require_relative '../../../controllers/channel/actions/update_fee'
@@ -11,24 +12,38 @@ require_relative '../../../controllers/channel/actions/update_fee'
 module Lighstorm
   module Models
     class Fee
+      include Protectable
+
       def initialize(policy, data)
         @policy = policy
         @data = data
       end
 
       def base
+        return nil unless @data[:base]
+
         @base ||= Satoshis.new(milisatoshis: @data[:base][:milisatoshis])
       end
 
       def rate
+        return nil unless @data[:rate]
+
         @rate ||= Rate.new(parts_per_million: @data[:rate][:parts_per_million])
       end
 
       def to_h
-        {
-          base: base.to_h,
-          rate: rate.to_h
-        }
+        result = {}
+
+        result[:base] = base.to_h if @data[:base]
+        result[:rate] = rate.to_h if @data[:rate]
+
+        return nil if result.empty?
+
+        result
+      end
+
+      def dump
+        Marshal.load(Marshal.dump(@data))
       end
 
       def update(params, preview: false, fake: false)
@@ -38,29 +53,23 @@ module Lighstorm
       end
 
       def base=(value)
-        validate_token!(value)
+        protect!(value)
 
         @base = value[:value]
-      end
 
-      def rate=(value)
-        validate_token!(value)
+        @data[:base] = { milisatoshis: @base.milisatoshis }
 
-        @rate = value[:value]
+        base
       end
 
-      def prepare_token!(token)
-        @token = token
-      end
-
-      private
+      def rate=(value)
+        protect!(value)
 
-      def validate_token!(value)
-        token = value.is_a?(Hash) ? value[:token] : nil
+        @rate = value[:value]
 
-        raise OperationNotAllowedError if token.nil? || @token.nil? || token != @token
+        @data[:rate] = { parts_per_million: @rate.parts_per_million }
 
-        @token = nil
+        rate
       end
     end
   end

data/models/connections/channel_node/htlc/blocks/delta.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative '../../../../concerns/protectable'
+
+module Lighstorm
+  module Models
+    class BlocksDelta
+      include Protectable
+
+      def initialize(data)
+        @data = data
+      end
+
+      def minimum
+        @minimum ||= @data[:minimum]
+      end
+
+      def to_h
+        {
+          minimum: minimum
+        }
+      end
+
+      def dump
+        Marshal.load(Marshal.dump(@data))
+      end
+
+      def minimum=(value)
+        protect!(value)
+
+        @minimum = value[:value]
+
+        @data[:minimum] = @minimum
+
+        minimum
+      end
+    end
+  end
+end

data/models/connections/channel_node/htlc.rb

@@ -2,42 +2,48 @@
 
 require_relative '../../satoshis'
 require_relative '../../rate'
-
-require_relative '../../../components/lnd'
+require_relative '../../concerns/protectable'
+require_relative 'htlc/blocks/delta'
 
 module Lighstorm
   module Models
     class HTLC
+      include Protectable
+
       def initialize(data)
         @data = data
       end
 
       def minimum
-        @minimum ||= Satoshis.new(milisatoshis: @data[:minimum][:milisatoshis])
+        @minimum ||= if @data[:minimum]
+                       Satoshis.new(
+                         milisatoshis: @data[:minimum][:milisatoshis]
+                       )
+                     end
       end
 
       def maximum
-        @maximum ||= Satoshis.new(milisatoshis: @data[:maximum][:milisatoshis])
+        @maximum ||= if @data[:maximum]
+                       Satoshis.new(
+                         milisatoshis: @data[:maximum][:milisatoshis]
+                       )
+                     end
       end
 
       def blocks
         @blocks ||= Struct.new(:data) do
           def delta
-            Struct.new(:data) do
-              def minimum
-                data[:minimum]
-              end
-
-              def to_h
-                { minimum: minimum }
-              end
-            end.new(data[:delta])
+            @delta ||= BlocksDelta.new(data[:delta] || {})
+          end
+
+          def dump
+            { delta: delta.dump }
           end
 
           def to_h
             { delta: delta.to_h }
           end
-        end.new(@data[:blocks])
+        end.new(@data[:blocks] || {})
       end
 
       def to_h
@@ -47,6 +53,34 @@ module Lighstorm
           blocks: blocks.to_h
         }
       end
+
+      def dump
+        result = Marshal.load(Marshal.dump(@data))
+
+        result = result.merge({ blocks: blocks.dump }) if @data[:blocks]
+
+        result
+      end
+
+      def minimum=(value)
+        protect!(value)
+
+        @minimum = value[:value]
+
+        @data[:minimum] = { milisatoshis: @minimum.milisatoshis }
+
+        minimum
+      end
+
+      def maximum=(value)
+        protect!(value)
+
+        @maximum = value[:value]
+
+        @data[:maximum] = { milisatoshis: @maximum.milisatoshis }
+
+        maximum
+      end
     end
   end
 end

data/models/connections/channel_node/policy.rb

@@ -14,16 +14,25 @@ module Lighstorm
       end
 
       def fee
-        @fee ||= @data ? Fee.new(self, @data[:fee]) : nil
+        @fee ||= Fee.new(self, @data ? @data[:fee] : {})
       end
 
       def htlc
-        @htlc ||= @data ? HTLC.new(@data[:htlc]) : nil
+        @htlc ||= HTLC.new(@data ? @data[:htlc] : {})
       end
 
       def to_h
         { fee: fee.to_h, htlc: htlc.to_h }
       end
+
+      def dump
+        result = Marshal.load(Marshal.dump(@data))
+
+        result = result.merge({ fee: fee.dump }) if @data && @data[:fee]
+        result = result.merge({ htlc: htlc.dump }) if @data && @data[:htlc]
+
+        result
+      end
     end
   end
 end

data/models/connections/channel_node.rb

@@ -9,12 +9,21 @@ require_relative '../errors'
 module Lighstorm
   module Models
     class ChannelNode
+      include Protectable
+
+      attr_reader :state
+
       def initialize(data, is_mine, transaction)
         @data = data
+        @state = data[:state]
         @is_mine = is_mine
         @transaction = transaction
       end
 
+      def active?
+        state == 'active'
+      end
+
       def node
         @node ||= Node.new(@data[:node])
       end
@@ -30,13 +39,36 @@ module Lighstorm
       end
 
       def to_h
-        restult = { node: node.to_h }
+        restult = { state: state, node: node.to_h }
 
         restult[:accounting] = accounting.to_h if @is_mine
         restult[:policy] = policy.to_h if @data[:policy]
 
         restult
       end
+
+      def dump
+        result = Marshal.load(Marshal.dump(@data)).merge(
+          {
+            node: node.dump,
+            policy: policy.dump
+          }
+        )
+
+        result[:accounting] = accounting.dump if @is_mine
+        result.delete(:policy) if result[:policy].nil?
+
+        result
+      end
+
+      def state=(value)
+        protect!(value)
+
+        @state = value[:value]
+        @data[:state] = @state
+
+        state
+      end
     end
   end
 end

data/models/edges/channel/accounting.rb

@@ -2,10 +2,13 @@
 
 require_relative '../../satoshis'
 require_relative '../../errors'
+require_relative '../../concerns/protectable'
 
 module Lighstorm
   module Models
     class ChannelAccounting
+      include Protectable
+
       def initialize(data, is_mine)
         @data = data
         @is_mine = is_mine
@@ -63,6 +66,20 @@ module Lighstorm
           }
         end
       end
+
+      def dump
+        Marshal.load(Marshal.dump(@data))
+      end
+
+      def capacity=(value)
+        protect!(value)
+
+        @capacity = value[:value]
+
+        @data[:capacity][:milisatoshis] = @capacity.milisatoshis
+
+        capacity
+      end
     end
   end
 end