lnd-client 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4bf57c02d8b4aae6f9412c31c10316ef4ed0baa92e6bca2ed23ea37c448ff010
-  data.tar.gz: 6d0c315784f3f56909528d4cab5fe5dab1874fc5221a710c56c87f64b7c9dffc
+  metadata.gz: a4f21139f58c13fceea576b5df5c9d799e24591281e4bd6a9132fd7a719fc549
+  data.tar.gz: fb569472611c466c28cf03519e1c756dee704bdf22b21381c3c355cfa983c573
 SHA512:
-  metadata.gz: 55b36ccae8ae9daf7d0533278e79cd69b2a6fed17a7e4799fc22bf5e2cade28d4c30c9ebe34cb9738b4403ff78ee9775774427f3b3d6e68b8635fa12f66a0961
-  data.tar.gz: e0d9068fc28938c8a27df8e897effb727a94ab271daa63fb48303861e3418bc5d6941858f4156d9ab4bac154edafc4c575a278d43f240ea1ef981b7fd28039e3
+  metadata.gz: 83f2cce7e6334695e3118ac9dd3ed6bb4c76a1aefdbacafba6a4af785d239e0c475faadf6104392cde059928409e0603e42a84e9fa91bc180a7ccd56a55a7eaa
+  data.tar.gz: cd147a319c1f02c50e19fb220b6dedbe7357d0680530b8a305f083d50c731c2afb8da5ac90d67b7984b1022c61e398cd2326f1fd27e050af4d471375fc3e720a

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 3.2.0
+  TargetRubyVersion: 3.0.0
   NewCops: enable
   Exclude:
     - 'components/grpc/*'

data/Gemfile

@@ -1,16 +1,11 @@
 # frozen_string_literal: true
 
-ruby '3.2.0'
-
 source 'https://rubygems.org'
 
-gem 'grpc', '~> 1.50'
+gemspec
 
 group :test, :development do
-  gem 'grpc-tools', '~> 1.50'
   gem 'pry-byebug', '~> 3.10', '>= 3.10.1'
-  gem 'rainbow', '~> 3.1', '>= 3.1.1'
-  gem 'rake', '~> 13.0', '>= 13.0.6'
-  gem 'rubocop', '~> 1.43'
+  gem 'rubocop', '~> 1.44', '>= 1.44.1'
   gem 'rubocop-rake', '~> 0.6.0'
 end

data/Gemfile.lock

@@ -1,3 +1,9 @@
+PATH
+  remote: .
+  specs:
+    lnd-client (0.0.3)
+      grpc (~> 1.51)
+
 GEM
   remote: https://rubygems.org/
   specs:
@@ -7,10 +13,9 @@ GEM
     google-protobuf (3.21.12)
     googleapis-common-protos-types (1.5.0)
       google-protobuf (~> 3.14)
-    grpc (1.50.0)
+    grpc (1.51.0)
       google-protobuf (~> 3.21)
       googleapis-common-protos-types (~> 1.0)
-    grpc-tools (1.50.0)
     json (2.6.3)
     method_source (1.0.0)
     parallel (1.22.1)
@@ -23,10 +28,9 @@ GEM
       byebug (~> 11.0)
       pry (>= 0.13, < 0.15)
     rainbow (3.1.1)
-    rake (13.0.6)
     regexp_parser (2.6.2)
     rexml (3.2.5)
-    rubocop (1.43.0)
+    rubocop (1.44.1)
       json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.2.0.0)
@@ -47,16 +51,10 @@ PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
-  grpc (~> 1.50)
-  grpc-tools (~> 1.50)
+  lnd-client!
   pry-byebug (~> 3.10, >= 3.10.1)
-  rainbow (~> 3.1, >= 3.1.1)
-  rake (~> 13.0, >= 13.0.6)
-  rubocop (~> 1.43)
+  rubocop (~> 1.44, >= 1.44.1)
   rubocop-rake (~> 0.6.0)
 
-RUBY VERSION
-   ruby 3.2.0p0
-
 BUNDLED WITH
    2.4.4

data/README.md

@@ -1,6 +1,9 @@
 # Ruby _Lightning Network Daemon_ Client
 
+> ⚠️ Warning: Early-stage, breaking changes are expected.
+
 - [Usage](#usage)
+  - [Channel Arguments](#channel-arguments)
   - [Documentation](#documentation)
 - [Development](#development)
   - [Upgrading gRPC Proto Files](#upgrading-grpc-proto-files)
@@ -11,13 +14,13 @@
 Add to your `Gemfile`:
 
 ```ruby
-gem 'lnd-client', '~> 0.0.1'
+gem 'lnd-client', '~> 0.0.3'
 ```
 
 ```ruby
 require 'lnd-client'
 
-puts LNDClient.version # => 0.0.1
+puts LNDClient.version # => 0.0.3
 
 client = LNDClient.new(
   certificate_path: '/lnd/tls.cert',
@@ -38,6 +41,37 @@ client.lightning.wallet_balance.to_h # =>
 client.lightning.get_node_info(
   pub_key: '02d3c80335a8ccb2ed364c06875f32240f36f7edb37d80f8dbe321b4c364b6e997'
 ).node.alias # => 'icebaker/old-stone'
+
+client.lightning.subscribe_channel_graph do |data|
+  puts data.inspect # => { ... }
+end
+
+client.router.subscribe_htlc_events do |data|
+  puts data.inspect # => { ... }
+end
+```
+
+### Channel Arguments
+
+```ruby
+require 'lnd-client'
+
+puts LNDClient.version # => 0.0.3
+
+client = LNDClient.new(
+  certificate_path: '/lnd/tls.cert',
+  macaroon_path: '/lnd/data/chain/bitcoin/mainnet/admin.macaroon',
+  socket_address: '127.0.0.1:10009'
+)
+
+client.lightning(
+  channel_args: { 'grpc.max_receive_message_length' => 1024 * 1024 * 50 }
+)
+
+graph = client.lightning.describe_graph
+
+graph.nodes # => [...]
+graph.edges # => [...]
 ```
 
 ### Documentation
@@ -45,7 +79,7 @@ client.lightning.get_node_info(
 ```ruby
 require 'lnd-client'
 
-puts LNDClient.version # => 0.0.1
+puts LNDClient.version # => 0.0.3
 
 client = LNDClient.new(
   certificate_path: '/lnd/tls.cert',
@@ -53,7 +87,7 @@ client = LNDClient.new(
   socket_address: '127.0.0.1:10009'
 )
 
-client.doc.services # => ['lightning']
+client.doc.services # => ['lightning', 'router']
 
 client.lightning.doc.available_methods # =>
 # ['abandon_channel',
@@ -95,6 +129,11 @@ require 'lnd-client'
 puts LNDClient.version
 ```
 
+```sh
+bundle
+rubocop -A
+```
+
 ### Upgrading gRPC Proto Files
 
 ```sh
@@ -103,5 +142,9 @@ bundle exec rake grpc:upgrade
 ### Publish to RubyGems
 
 ```sh
-gem build lnd-client.gemspec 
+gem build lnd-client.gemspec
+
+gem signin
+
+gem push lnd-client-0.0.3.gem
 ```

data/components/grpc/routerrpc/router_pb.rb

@@ -3,7 +3,7 @@
 
 require 'google/protobuf'
 
-require_relative 'lightning_pb'
+require_relative '../lightning_pb'
 
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("routerrpc/router.proto", :syntax => :proto3) do

data/components/grpc/routerrpc/router_services_pb.rb

@@ -2,7 +2,7 @@
 # Source: routerrpc/router.proto for package 'routerrpc'
 
 require 'grpc'
-require_relative 'routerrpc/router_pb'
+require_relative './router_pb'
 
 module Routerrpc
   module Router

data/components/grpc.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
 require_relative './grpc/lightning_services_pb'
+require_relative './grpc/routerrpc/router_services_pb'
 
 module GRPC
   SERVICES = {
-    lightning: Lnrpc::Lightning
+    lightning: Lnrpc::Lightning,
+    router: Routerrpc::Router
   }.freeze
 end

data/controllers/client.rb

@@ -21,11 +21,11 @@ class ClientController
     GRPC::SERVICES.include?(service_key) || super
   end
 
-  def method_missing(method_name, *_args)
+  def method_missing(method_name, *args)
     service_key = method_name.to_sym
 
     raise ArgumentError, "Method `#{method_name}` doesn't exist." unless GRPC::SERVICES.include?(service_key)
 
-    @services[service_key] ||= ServiceController.new(self, GRPC::SERVICES[service_key])
+    @services[service_key] ||= ServiceController.new(self, GRPC::SERVICES[service_key], *args)
   end
 end

data/controllers/service.rb

@@ -5,18 +5,23 @@ require_relative './documentation'
 class ServiceController
   attr_reader :doc, :service
 
-  def initialize(client, rpc)
+  def initialize(client, rpc, params = {})
     @client = client
     @rpc = rpc
     @service = rpc.const_get(:Service)
-    @stub = rpc.const_get(:Stub).new(client.config.socket_address, client.config.credentials)
+    @stub = rpc.const_get(:Stub).new(
+      client.config.socket_address,
+      client.config.credentials,
+      **params
+    )
     @doc = DocumentationController.new(self)
   end
 
-  def call!(method_key, desc, *args)
+  def call!(method_key, desc, *args, &block)
     @stub.method(method_key).call(
       desc.input.new(*args),
-      { metadata: { macaroon: @client.config.macaroon } }
+      { metadata: { macaroon: @client.config.macaroon } },
+      &block
     )
   end
 
@@ -25,11 +30,11 @@ class ServiceController
     (desc && @stub.respond_to?(method_name)) || super
   end
 
-  def method_missing(method_name, *args, &)
+  def method_missing(method_name, *args, &block)
     desc = @doc.grpc(method_name)
 
     raise ArgumentError, "Method `#{method_name}` doesn't exist." unless desc && @stub.respond_to?(method_name)
 
-    call!(method_name, desc, *args, &)
+    call!(method_name, desc, *args, &block)
   end
 end

data/lnd-client.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |spec|
 
   spec.license = Static::SPEC[:license]
 
-  spec.required_ruby_version = Gem::Requirement.new('>= 3.2.0')
+  spec.required_ruby_version = Gem::Requirement.new('>= 3.0.0')
 
   spec.metadata['allowed_push_host'] = 'https://rubygems.org'
 
@@ -29,7 +29,7 @@ Gem::Specification.new do |spec|
 
   spec.require_paths = ['ports/dsl']
 
-  spec.add_dependency 'grpc', '~> 1.50'
+  spec.add_dependency 'grpc', '~> 1.51'
 
   spec.metadata['rubygems_mfa_required'] = 'true'
 end

data/static/spec.rb

@@ -3,7 +3,7 @@
 module Static
   SPEC = {
     name: 'lnd-client',
-    version: '0.0.1',
+    version: '0.0.3',
     author: 'icebaker',
     summary: 'Ruby Lightning Network Daemon (lnd) Client',
     description: 'Ruby Lightning Network Daemon (lnd) Client',

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lnd-client
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - icebaker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-22 00:00:00.000000000 Z
+date: 2023-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grpc
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.50'
+        version: '1.51'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.50'
+        version: '1.51'
 description: Ruby Lightning Network Daemon (lnd) Client
 email: 
 executables: []
@@ -96,7 +96,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.2.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="