lighstorm 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9138a744ed51a4f15025f97f27e09ec5f3b100ef8def0a6d992895cb42f8b0c
-  data.tar.gz: 85435136bfbb78cc7c6baa74ea6a745e958d8eb3d3f08d42ef42d03a1d2230eb
+  metadata.gz: bea078c4355c1f245ed7800a6d235763e325d3c4cf71e42f14589513eb69a429
+  data.tar.gz: 026c1c57b2dc8a6d06cebc2155f32189b7d998574d1e802b8e64f90ae63938ae
 SHA512:
-  metadata.gz: e728481bdafde3c30dc23e85a8a48d0d3a5ac020410d14cbafe48b17d86661c2df86bab4f75a65099919adf09b3808ce19f410f915cb7287d2a7802884cc8f0a
-  data.tar.gz: 6efa2544e1d08c49966b322e10d8cc40f3d1de0238534665148bff8515686be8817abf039442308563d0cc6ee15d3cf71ef1486f55a946103dcdd663a735684b
+  metadata.gz: d69e4361ef42951fa5d316a476ce7f2ac63b9ee307198646a2b263601ec0e79d75792b99985767f61a38942401a4e3d24d8ff5b938b7e4fddcb8d427b566d2b4
+  data.tar.gz: 85de98976d458ba9279291f37ae4cda03c8aa3965a53751932360a546b406004915d5035666bf6b45f624e1eaa8c0e2d2b8b135632cdee3b8c622b83e94b6631

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lighstorm (0.0.5)
+    lighstorm (0.0.6)
       dotenv (~> 2.8, >= 2.8.1)
       lnd-client (~> 0.0.5)
       zache (~> 0.12.0)
@@ -50,14 +50,14 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.0)
-    rubocop (1.45.1)
+    rubocop (1.46.0)
       json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.2.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.24.1, < 2.0)
+      rubocop-ast (>= 1.26.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
     rubocop-ast (1.26.0)

data/README.md

@@ -33,7 +33,7 @@ Although it tries to stay close to [Lightning's terminologies](https://docs.ligh
 Add to your `Gemfile`:
 
 ```ruby
-gem 'lighstorm', '~> 0.0.5'
+gem 'lighstorm', '~> 0.0.6'
 ```
 
 ```ruby
@@ -45,7 +45,7 @@ Lighstorm.config!(
   macaroon_path: '/lnd/data/chain/bitcoin/mainnet/admin.macaroon',
 )
 
-puts Lighstorm.version # => 0.0.5
+puts Lighstorm.version # => 0.0.6
 
 Lighstorm::Satoshis.new(
   milisatoshis: 75_621_650
@@ -67,7 +67,7 @@ gem 'lighstorm', path: '/home/user/lighstorm'
 # demo.rb
 require 'lighstorm'
 
-puts Lighstorm.version # => 0.0.5
+puts Lighstorm.version # => 0.0.6
 ```
 
 ```sh
@@ -100,5 +100,5 @@ gem build lighstorm.gemspec
 
 gem signin
 
-gem push lighstorm-0.0.5.gem
+gem push lighstorm-0.0.6.gem
 ```

data/adapters/invoice.rb

@@ -29,7 +29,7 @@ module Lighstorm
         {
           _key: _key(grpc),
           created_at: Time.at(grpc[:creation_date]),
-          settle_at: Time.at(grpc[:settle_date]),
+          settle_at: grpc[:settle_date].nil? || !grpc[:settle_date].positive? ? nil : Time.at(grpc[:settle_date]),
           state: grpc[:state].to_s.downcase
         }
       end

data/controllers/invoice/actions/create.rb

@@ -2,14 +2,13 @@
 
 require_relative '../../../ports/grpc'
 require_relative '../../../models/errors'
+require_relative '../../invoice'
 
 module Lighstorm
   module Controllers
     module Invoice
       module Create
-        def self.perform(description: nil, milisatoshis: nil, preview: false, fake: false)
-          raise Errors::ToDoError, self
-
+        def self.perform(description: nil, milisatoshis: nil, preview: false, fake: nil)
           grpc_request = {
             service: :lightning,
             method: :add_invoice,
@@ -22,13 +21,15 @@ module Lighstorm
           return grpc_request if preview
 
           # expiry: Default is 86400 (24 hours).
-          response = LND.instance.middleware("lightning.#{grpc_request[:method]}") do
-            LND.instance.client.lightning.send(grpc_request[:method], grpc_request[:params])
-          end
+          response = if fake.nil?
+                       LND.instance.middleware("lightning.#{grpc_request[:method]}") do
+                         LND.instance.client.lightning.send(grpc_request[:method], grpc_request[:params])
+                       end.to_h
+                     else
+                       fake
+                     end
 
-          # TODO
-          # find_by_secret_hash(invoice.r_hash.unpack1('H*'))
-          # response
+          Invoice.find_by_secret_hash(response[:r_hash].unpack1('H*'))
         end
       end
     end

data/controllers/invoice.rb

@@ -23,7 +23,7 @@ module Lighstorm
         FindBySecretHash.model(FindBySecretHash.data(secret_hash))
       end
 
-      def self.create(description: nil, milisatoshis: nil, preview: false, fake: false)
+      def self.create(description: nil, milisatoshis: nil, preview: false, fake: nil)
         Create.perform(
           description: description,
           milisatoshis: milisatoshis,

data/docs/README.md

@@ -23,7 +23,7 @@ Lighstorm::Channel.mine.first.myself.node.alias
 Add to your `Gemfile`:
 
 ```ruby
-gem 'lighstorm', '~> 0.0.5'
+gem 'lighstorm', '~> 0.0.6'
 ```
 
 Run `bundle install`.
@@ -56,7 +56,7 @@ Lighstorm.config!(
 ```ruby
 require 'lighstorm'
 
-puts Lighstorm.version # => 0.0.5
+puts Lighstorm.version # => 0.0.6
 
 Lighstorm::Satoshis.new(
   milisatoshis: 75_621_650
@@ -396,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
 )
@@ -415,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
@@ -452,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)
@@ -723,7 +743,7 @@ satoshis.parts_per_million(reference_in_milisatoshis)
 _________________
 
 <center>
-  lighstorm 0.0.5
+  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.5
+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.5',
+      name: 'Lighstorm 0.0.6',
       repo: 'https://github.com/icebaker/lighstorm'
     }
   </script>

data/static/spec.rb

@@ -4,7 +4,7 @@ module Lighstorm
   module Static
     SPEC = {
       name: 'lighstorm',
-      version: '0.0.5',
+      version: '0.0.6',
       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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lighstorm
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - icebaker