lnd-client 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8858aaa4661fcc83da3c661a1b05d9be7d8513eeda78ace138f9d92948e345df
-  data.tar.gz: 8006682ff281b1fc745562deb2a58a464c9a09a4c47b564c2db67819fe8224bc
+  metadata.gz: 390eda187c9b089d9231353dde80b2ce4ac24c06623ffde24000bdd8c8581d2d
+  data.tar.gz: 6f6aef6e66df47d1b174a7ff2b2d5f18ee2a0a062501b7c4eda1b4b006be27df
 SHA512:
-  metadata.gz: 41b85876608369aa56185424294a7c10e5a39938ceba028bc8326312adbe23d51c285a074eff5b3f5646b541c60673c00c27508674dc3beff88184a8eca2fdc2
-  data.tar.gz: 57df549dcc4b4c63c5a0f873393cc731e1242e2abddd030c95d64e16bb330998d26343061993b9ffa14c51a29e7181829a64453d82b6804254c0ff10d41cf1ad
+  metadata.gz: 3b0fe7dd402b9f180758df35897603a08a88042d7f024b66204508e3d09166f9a539d64a3919b1cde41696f5ebab4001a80c7278c159f7e60b09c4520a973905
+  data.tar.gz: 169d3a0f322e22bec0e955d8ad66d4e3139e99a2677688adac2c7854cd62cec942c868d95f6eec5ecdfb48b5e441ebf561dece46fbafd7eabbcca3d115765b58

data/.env.example

@@ -0,0 +1 @@
+LND_CLIENT_DELETE_UNUSED_TEST_DATA=false

data/.github/workflows/ruby-rspec-tests.yml

@@ -0,0 +1,39 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+# GitHub recommends pinning actions to a commit SHA.
+# To get a newer version, you will need to update the SHA.
+# You can also reference a tag or branch, but the action may change without warning.
+
+name: RSpec Tests
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  rspec:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/cache@v3
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-gems-
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@359bebbc29cbe6c87da6bc9ea3bc930432750108
+        with:
+          ruby-version: '3.0.0'
+          bundler-cache: true
+      - name: Install Dependencies
+        run: bundle install
+      - name: Run RSpec Tests
+        run: bundle exec rspec

data/.gitignore

@@ -1,2 +1,3 @@
 *.gem
+.env
 temp/

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -12,4 +12,6 @@ Naming/FileName:
   Exclude:
     - 'ports/dsl/lnd-client.rb'
 
-require: rubocop-rake
+require:
+  - rubocop-rake
+  - rubocop-rspec

data/Gemfile

@@ -5,7 +5,14 @@ source 'https://rubygems.org'
 gemspec
 
 group :test, :development do
+  gem 'babosa', '~> 2.0'
+  gem 'dotenv', '~> 2.8', '>= 2.8.1'
   gem 'pry-byebug', '~> 3.10', '>= 3.10.1'
-  gem 'rubocop', '~> 1.45', '>= 1.45.1'
+  gem 'rainbow', '~> 3.1', '>= 3.1.1'
+  gem 'rake', '~> 13.0', '>= 13.0.6'
+  gem 'rspec', '~> 3.12'
+  gem 'rubocop', '~> 1.48'
   gem 'rubocop-rake', '~> 0.6.0'
+  gem 'rubocop-rspec', '~> 2.19'
+  gem 'ruby-progressbar', '~> 1.8', '>= 1.8.1'
 end

data/Gemfile.lock

@@ -1,16 +1,19 @@
 PATH
   remote: .
   specs:
-    lnd-client (0.0.5)
+    lnd-client (0.0.6)
       grpc (~> 1.52)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
+    babosa (2.0.0)
     byebug (11.1.3)
     coderay (1.1.3)
-    google-protobuf (3.21.12)
+    diff-lcs (1.5.0)
+    dotenv (2.8.1)
+    google-protobuf (3.22.2-x86_64-linux)
     googleapis-common-protos-types (1.5.0)
       google-protobuf (~> 3.14)
     grpc (1.52.0-x86_64-linux)
@@ -19,7 +22,7 @@ GEM
     json (2.6.3)
     method_source (1.0.0)
     parallel (1.22.1)
-    parser (3.2.1.0)
+    parser (3.2.1.1)
       ast (~> 2.4.1)
     pry (0.14.2)
       coderay (~> 1.1)
@@ -28,33 +31,59 @@ GEM
       byebug (~> 11.0)
       pry (>= 0.13, < 0.15)
     rainbow (3.1.1)
+    rake (13.0.6)
     regexp_parser (2.7.0)
     rexml (3.2.5)
-    rubocop (1.45.1)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.48.1)
       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)
+    rubocop-ast (1.27.0)
       parser (>= 3.2.1.0)
+    rubocop-capybara (2.17.1)
+      rubocop (~> 1.41)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    ruby-progressbar (1.11.0)
+    rubocop-rspec (2.19.0)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
+    ruby-progressbar (1.13.0)
     unicode-display_width (2.4.2)
 
 PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
+  babosa (~> 2.0)
+  dotenv (~> 2.8, >= 2.8.1)
   lnd-client!
   pry-byebug (~> 3.10, >= 3.10.1)
-  rubocop (~> 1.45, >= 1.45.1)
+  rainbow (~> 3.1, >= 3.1.1)
+  rake (~> 13.0, >= 13.0.6)
+  rspec (~> 3.12)
+  rubocop (~> 1.48)
   rubocop-rake (~> 0.6.0)
+  rubocop-rspec (~> 2.19)
+  ruby-progressbar (~> 1.8, >= 1.8.1)
 
 BUNDLED WITH
    2.4.4

data/README.md

@@ -1,14 +1,14 @@
-# Ruby _Lightning Network Daemon_ Client
+# lnd-client [![Gem Version](https://badge.fury.io/rb/lnd-client.svg)](https://badge.fury.io/rb/lnd-client) ![RSpec Tests Status](https://github.com/icebaker/lnd-client/actions/workflows/ruby-rspec-tests.yml/badge.svg)
 
-> ⚠️ Warning: Early-stage, breaking changes are expected.
+Ruby Lightning Network Daemon Client: Straightforward access to [lnd](https://github.com/lightningnetwork/lnd) [gRPC API](https://lightning.engineering/api-docs/api/lnd/#grpc)
 
 This is a low-level client library. For a better experience, you may want to check out the [Lighstorm](https://github.com/icebaker/lighstorm) abstraction.
 
 - [Usage](#usage)
-  - [Channel Arguments](#channel-arguments)
-  - [Documentation](#documentation)
+  - [Documentation](https://icebaker.github.io/lnd-client)
 - [Development](#development)
   - [Upgrading gRPC Proto Files](#upgrading-grpc-proto-files)
+  - [Generating Documentation](#generating-documentation)
   - [Publish to RubyGems](#publish-to-rubygems)
 
 ## Usage
@@ -16,29 +16,30 @@ This is a low-level client library. For a better experience, you may want to che
 Add to your `Gemfile`:
 
 ```ruby
-gem 'lnd-client', '~> 0.0.5'
+gem 'lnd-client', '~> 0.0.6'
 ```
 
 ```ruby
 require 'lnd-client'
 
-puts LNDClient.version # => 0.0.5
+puts LNDClient.version # => 0.0.6
 
 client = LNDClient.new(
-  certificate_path: '/lnd/tls.cert',
-  macaroon_path: '/lnd/data/chain/bitcoin/mainnet/admin.macaroon',
-  socket_address: '127.0.0.1:10009'
+  'lndconnect://127.0.0.1:10009?cert=MIICJz...JBEERQ&macaroon=AgEDbG...45ukJ4'
 )
 
 client.lightning.wallet_balance.total_balance # => 101527
 
 client.lightning.wallet_balance.to_h # =>
-# {:total_balance=>101527,
-#  :confirmed_balance=>101527,
-#  :unconfirmed_balance=>0,
-#  :locked_balance=>0,
-#  :reserved_balance_anchor_chan=>20000,
-#  :account_balance=>{"default"=>{:confirmed_balance=>101527, :unconfirmed_balance=>0}}}
+# { total_balance: 101_527,
+#   confirmed_balance: 101_527,
+#   unconfirmed_balance: 0,
+#   locked_balance: 0,
+#   reserved_balance_anchor_chan: 20_000,
+#   account_balance: {
+#     'default' => {
+#       confirmed_balance: 101_527,
+#       unconfirmed_balance: 0 } } }
 
 client.lightning.get_node_info(
   pub_key: '02d3c80335a8ccb2ed364c06875f32240f36f7edb37d80f8dbe321b4c364b6e997'
@@ -53,74 +54,12 @@ client.router.subscribe_htlc_events do |data|
 end
 ```
 
-### Channel Arguments
-
-```ruby
-require 'lnd-client'
-
-puts LNDClient.version # => 0.0.5
-
-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
-
-```ruby
-require 'lnd-client'
-
-puts LNDClient.version # => 0.0.5
-
-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.doc.services # => ['lightning', 'router']
-
-client.lightning.doc.available_methods # =>
-# ['abandon_channel',
-#  'add_invoice',
-#  'bake_macaroon',
-#  'batch_open_channel',
-#  'channel_acceptor',
-#  'channel_balance',
-#  'check_macaroon_permissions',
-#  'close_channel',
-#  'closed_channels',
-#  # ...
-#  'get_node_info'
-# ]
-
-client.lightning.doc.describe(:get_node_info) # =>
-# { method: 'get_node_info',
-#    input: { pub_key: '', include_channels: false},
-#   output: { node: nil, num_channels: 0, total_capacity: 0, channels: []}}
-
-client.lightning.doc.grpc(:get_node_info)
-# #<struct GRPC::RpcDesc
-#  name=:GetNodeInfo,
-#  input=Lnrpc::NodeInfoRequest,
-#  output=Lnrpc::NodeInfo,
-#  marshal_method=:encode,
-#  unmarshal_method=:decode>
-```
+Check the [full documentation](https://icebaker.github.io/lnd-client).
 
 ## Development
 
+Copy the `.env.example` file to `.env` and provide the required data.
+
 ```ruby
 # Gemfile
 gem 'lnd-client', path: '/home/user/lnd-client'
@@ -141,6 +80,17 @@ rubocop -A
 ```sh
 bundle exec rake grpc:upgrade
 ```
+
+### Generating Documentation
+
+```sh
+bundle exec rake grpc:docs
+
+npm i docsify-cli -g
+
+docsify serve ./docs
+```
+
 ### Publish to RubyGems
 
 ```sh
@@ -148,5 +98,5 @@ gem build lnd-client.gemspec
 
 gem signin
 
-gem push lnd-client-0.0.5.gem
+gem push lnd-client-0.0.6.gem
 ```

data/Rakefile

@@ -1,8 +1,15 @@
 # frozen_string_literal: true
 
+require_relative './controllers/documentation'
 require_relative './controllers/grpc_generator'
 
 namespace :grpc do
+  desc 'Generate gRPC Documentation'
+  task :docs do
+    require 'ruby-progressbar'
+    LNDClientInternal::DocumentationController.generate!
+  end
+
   desc 'Upgrade lnd Protocol Buffers for gGRPC'
   task :upgrade do
     LNDClientInternal::GrpcGeneratorController.upgrade!

data/controllers/client.rb

@@ -1,19 +1,21 @@
 # frozen_string_literal: true
 
 require_relative '../components/grpc'
-require_relative 'config'
+
 require_relative 'service'
 
 module LNDClientInternal
   class ClientController
-    attr_reader :config, :doc
+    attr_reader :connection, :doc
 
-    def initialize(options)
-      @config = LNDClientInternal::ConfigController.new(self, options)
+    def initialize(connection)
+      @connection = connection
       @services = {}
 
       doc = Struct.new(:services)
       @doc = doc.new(LNDClientInternal::GRPC::SERVICES.keys.map(&:to_s))
+
+      lightning(**connection[:lightning]) if connection[:lightning]
     end
 
     def respond_to_missing?(method_name, include_private = false)

data/controllers/connection.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+require 'uri'
+require 'base64'
+require 'singleton'
+
+require 'grpc'
+
+require_relative '../models/errors'
+
+module LNDClientInternal
+  class Connection
+    def self.validate_params!(connection)
+      raise LNDClient::Errors::TooManyArgumentsError if connection.key?(:address) && connection.key?(:host)
+      raise LNDClient::Errors::TooManyArgumentsError if connection.key?(:address) && connection.key?(:port)
+      if connection.key?(:certificate_path) && connection.key?(:certificate)
+        raise LNDClient::Errors::TooManyArgumentsError
+      end
+      raise LNDClient::Errors::TooManyArgumentsError if connection.key?(:macaroon_path) && connection.key?(:macaroon)
+    end
+
+    def self.expand(*params, &vcr)
+      connection = if is_lndconnect?(*params)
+                     exapand_lndconnect(*params)
+                   else
+                     params.first
+                   end
+
+      validate_params!(connection)
+
+      connection[:certificate] = load_file(connection[:certificate_path], &vcr) if connection[:certificate_path]
+
+      connection[:macaroon] = load_file(connection[:macaroon_path], &vcr) if connection[:macaroon_path]
+
+      if !connection.key?(:address) && connection.key?(:host) && connection.key?(:port)
+        connection[:address] = "#{connection[:host]}:#{connection[:port]}"
+      elsif !connection.key?(:address)
+        raise LNDClient::Errors::ArgumentError, 'missing :address or :host + :port'
+      end
+
+      connection[:certificate] = decode_certificate(connection[:certificate])
+      connection[:macaroon] = decode_macaroon(connection[:macaroon])
+
+      if params.is_a?(Array)
+        params.each do |param|
+          connection[:lightning] = param[:lightning] if param.is_a?(Hash) && param.key?(:lightning)
+        end
+      end
+
+      connection
+    end
+
+    def self.decode_macaroon(macaroon)
+      if !macaroon.dup.force_encoding(Encoding::UTF_8).valid_encoding?
+        macaroon.unpack1('H*')
+      elsif hex?(macaroon)
+        macaroon
+      elsif base64?(macaroon)
+        Base64.decode64(macaroon).unpack1('H*')
+      end
+    end
+
+    def self.decode_certificate(certificate)
+      if hex?(certificate)
+        [certificate].pack('H*')
+      elsif base64?(certificate)
+        Base64.decode64(certificate)
+      else
+        certificate
+      end
+    end
+
+    def self.base64?(value)
+      (value.length % 4).zero? && value.match(%r{\A[A-Za-z0-9+/]+={0,3}\z})
+    end
+
+    def self.hex?(value)
+      value.match(/\A[\da-fA-F]+\z/)
+    end
+
+    def self.exapand_lndconnect(*params)
+      parsed_uri = URI.parse(params.first)
+      host = parsed_uri.host
+      port = parsed_uri.port || 10_009
+
+      params = URI.decode_www_form(parsed_uri.query).to_h
+      certificate = params['cert'].tr('-_', '+/')
+      macaroon = Base64.urlsafe_decode64(params['macaroon'])
+
+      certificate = "-----BEGIN CERTIFICATE-----\n#{certificate.gsub(/(.{64})/, "\\1\n")}\n-----END CERTIFICATE-----\n"
+
+      {
+        host: host,
+        port: port,
+        certificate: certificate,
+        macaroon: macaroon
+      }
+    end
+
+    def self.is_lndconnect?(*params)
+      params.is_a?(Array) &&
+        params.first.is_a?(String) &&
+        params.first.start_with?('lndconnect://')
+    end
+
+    def self.standalone(*params, &vcr)
+      connection = Connection.expand(*params, &vcr)
+      connection[:credentials] = ::GRPC::Core::ChannelCredentials.new(connection[:certificate])
+      connection
+    end
+
+    def self.load_file(path, &vcr)
+      vcr.nil? ? File.read(path) : vcr.call(-> { File.read(path) }, path)
+    end
+  end
+end

data/controllers/documentation.rb

@@ -1,13 +1,92 @@
 # frozen_string_literal: true
 
+require 'securerandom'
+
 require_relative '../logic/string'
+require_relative '../components/grpc'
 
 module LNDClientInternal
   class DocumentationController
+    PROGRESS = true
+    PATH = 'docs/README.md'
+    KEY = '<!-- [INJECT:GRP:DOCS] -->'
+
     attr_reader :available_methods
 
-    def initialize(service)
-      @service = service
+    def self.format(code)
+      id = SecureRandom.hex(32)
+      path = "temp/#{id}.rb"
+      File.write("temp/#{id}.rb", code.gsub(', ', ",\n"))
+      `rubocop -A -c docs/.rubocop.yml #{path}`
+      output = File.read("temp/#{id}.rb")
+      File.delete("temp/#{id}.rb")
+      output.strip
+    end
+
+    def self.generate!
+      services = LNDClientInternal::GRPC::SERVICES.keys.map(&:to_sym)
+
+      if PROGRESS
+        total = services.sum do |service|
+          new(
+            LNDClientInternal::GRPC::SERVICES[service].const_get(:Service)
+          ).available_methods.size * 2
+        end
+        progressbar = ProgressBar.create(total: total, format: '%a %e |%b>>%i| %P% | %c of %C')
+      end
+
+      content = ''
+
+      services.each do |service|
+        content += "## #{service}\n"
+        doc = new(LNDClientInternal::GRPC::SERVICES[service].const_get(:Service))
+
+        doc.available_methods.each do |method_name|
+          content += "\n### #{method_name}\n"
+
+          url = "https://lightning.engineering/api-docs/api/lnd/#{service}/#{method_name.gsub('_', '-')}/index.html"
+
+          content += "\n[lightning.engineering/#{service}/#{method_name.gsub('_', '-')}](#{url})\n"
+
+          description = doc.describe(method_name)
+          content += "\n```ruby\n"
+
+          code = "client.#{service}.#{method_name}"
+
+          code += "(\n#{description[:input].inspect}\n)" if !description[:input].nil? && !description[:input].empty?
+
+          code += " do |data|\n  puts data.inspect # => { ... }\nend" if method_name =~ /^subscribe/
+
+          content += if !description[:input].nil? && !description[:input].empty?
+                       "#{self.format(code)}\n```\n"
+                     else
+                       "#{code}\n```\n"
+                     end
+
+          progressbar.increment if PROGRESS
+
+          if !description[:output].nil? && !description[:output].empty?
+            code = self.format(description[:output].inspect)
+            content += "\nOutput:\n```ruby\n#{code}\n```\n"
+          end
+
+          progressbar.increment if PROGRESS
+        end
+      end
+
+      document = File.read(PATH)
+
+      parts = document.split(KEY)
+
+      File.write(PATH, "#{parts[0]}#{KEY}\n\n#{content}\n#{KEY}#{parts[2]}")
+
+      progressbar.finish
+
+      puts "\nDocumentation updated: #{PATH}\n"
+    end
+
+    def initialize(grpc_service)
+      @grpc_service = grpc_service
       @descriptions = {}
       @grpc = {}
 
@@ -15,7 +94,7 @@ module LNDClientInternal
     end
 
     def build!
-      @available_methods = @service.service.rpc_descs.values.map do |desc|
+      @available_methods = @grpc_service.rpc_descs.values.map do |desc|
         method_name = LNDClientInternal::StringLogic.underscore(desc.name.to_s)
 
         build_description!(method_name, desc)

data/controllers/multiclient.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'singleton'
+
+require_relative 'connection'
+
+require_relative 'client'
+
+module LNDClientInternal
+  class Multiclient
+    include Singleton
+
+    def initialize
+      @clients = {}
+    end
+
+    def add_connection!(id, *params)
+      @clients[id] = ClientController.new(Connection.standalone(*params))
+    end
+
+    def remove_connection!(id)
+      @clients.delete(id)
+    end
+
+    def as(id)
+      @clients[id]
+    end
+
+    def clear!
+      @clients = {}
+    end
+
+    def connections
+      @clients.keys
+    end
+  end
+end

data/controllers/service.rb

@@ -11,17 +11,17 @@ module LNDClientInternal
       @rpc = rpc
       @service = rpc.const_get(:Service)
       @stub = rpc.const_get(:Stub).new(
-        client.config.socket_address,
-        client.config.credentials,
+        client.connection[:address],
+        client.connection[:credentials],
         **params
       )
-      @doc = LNDClientInternal::DocumentationController.new(self)
+      @doc = LNDClientInternal::DocumentationController.new(@service)
     end
 
     def call!(method_key, desc, *args, &block)
       @stub.method(method_key).call(
         desc.input.new(*args),
-        { metadata: { macaroon: @client.config.macaroon } },
+        { metadata: { macaroon: @client.connection[:macaroon] } },
         &block
       )
     end

data/lnd-client.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.summary = LNDClientInternal::Static::SPEC[:summary]
   spec.description = LNDClientInternal::Static::SPEC[:description]
 
-  spec.homepage = LNDClientInternal::Static::SPEC[:github]
+  spec.homepage = LNDClientInternal::Static::SPEC[:documentation]
 
   spec.license = LNDClientInternal::Static::SPEC[:license]
 
@@ -20,10 +20,12 @@ Gem::Specification.new do |spec|
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = LNDClientInternal::Static::SPEC[:github]
+  spec.metadata['documentation_uri'] = LNDClientInternal::Static::SPEC[:documentation]
+  spec.metadata['bug_tracker_uri'] = LNDClientInternal::Static::SPEC[:issues]
 
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject do |f|
-      f.match(%r{\A(?:test|spec|features)/})
+      f.match(%r{\A(?:test|spec|docs|features)/})
     end
   end
 

data/models/errors.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module LNDClient
+  module Errors
+    class LNDClientError < StandardError; end
+
+    class TooManyArgumentsError < LNDClientError; end
+    class ArgumentError < LNDClientError; end
+  end
+end

data/ports/dsl/lnd-client/errors.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require_relative '../../../models/errors'
+
+include LNDClient::Errors

data/ports/dsl/lnd-client.rb

@@ -1,11 +1,31 @@
 # frozen_string_literal: true
 
+require_relative '../../controllers/connection'
 require_relative '../../controllers/client'
+require_relative '../../controllers/multiclient'
 require_relative '../../static/spec'
 
 module LNDClient
-  def self.new(params)
-    LNDClientInternal::ClientController.new(params)
+  def self.new(...)
+    LNDClientInternal::ClientController.new(
+      LNDClientInternal::Connection.standalone(...)
+    )
+  end
+
+  def self.add_connection!(...)
+    LNDClientInternal::Multiclient.instance.add_connection!(...)
+  end
+
+  def self.connections(...)
+    LNDClientInternal::Multiclient.instance.connections(...)
+  end
+
+  def self.as(...)
+    LNDClientInternal::Multiclient.instance.as(...)
+  end
+
+  def self.remove_connection!(...)
+    LNDClientInternal::Multiclient.instance.remove_connection!(...)
   end
 
   def self.version

data/static/spec.rb

@@ -4,11 +4,13 @@ module LNDClientInternal
   module Static
     SPEC = {
       name: 'lnd-client',
-      version: '0.0.5',
+      version: '0.0.6',
       author: 'icebaker',
       summary: 'Ruby Lightning Network Daemon (lnd) Client',
       description: 'Ruby Lightning Network Daemon (lnd) Client',
       github: 'https://github.com/icebaker/lnd-client',
+      documentation: 'https://icebaker.github.io/lnd-client',
+      issues: 'https://github.com/icebaker/lnd-client/issues',
       license: 'MIT'
     }.freeze
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lnd-client
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - icebaker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-02-12 00:00:00.000000000 Z
+date: 2023-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grpc
@@ -30,7 +30,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".env.example"
+- ".github/workflows/ruby-rspec-tests.yml"
 - ".gitignore"
+- ".rspec"
 - ".rubocop.yml"
 - Gemfile
 - Gemfile.lock
@@ -72,21 +75,26 @@ files:
 - components/grpc/wtclientrpc/wtclient_pb.rb
 - components/grpc/wtclientrpc/wtclient_services_pb.rb
 - controllers/client.rb
-- controllers/config.rb
+- controllers/connection.rb
 - controllers/documentation.rb
 - controllers/grpc_generator.rb
+- controllers/multiclient.rb
 - controllers/service.rb
 - lnd-client.gemspec
 - logic/string.rb
+- models/errors.rb
 - ports/dsl/lnd-client.rb
+- ports/dsl/lnd-client/errors.rb
 - static/spec.rb
-homepage: https://github.com/icebaker/lnd-client
+homepage: https://icebaker.github.io/lnd-client
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-  homepage_uri: https://github.com/icebaker/lnd-client
+  homepage_uri: https://icebaker.github.io/lnd-client
   source_code_uri: https://github.com/icebaker/lnd-client
+  documentation_uri: https://icebaker.github.io/lnd-client
+  bug_tracker_uri: https://github.com/icebaker/lnd-client/issues
   rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []

data/controllers/config.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-require 'grpc'
-
-module LNDClientInternal
-  class ConfigController
-    attr_reader :socket_address, :credentials, :certificate, :macaroon
-
-    def initialize(client, options)
-      @client = client
-
-      @certificate_path = options[:certificate_path]
-      @certificate = options[:certificate]
-
-      @macaroon_path = options[:macaroon_path]
-      @macaroon = options[:macaroon]
-
-      @socket_address = options[:socket_address] || '127.0.0.1:10009'
-
-      setup_certificate!
-      setup_macaroon!
-    end
-
-    def setup_certificate!
-      raise 'conflicting options for certificate' if @certificate && @certificate_path
-
-      @certificate = File.read(@certificate_path) if @certificate_path
-      @credentials = ::GRPC::Core::ChannelCredentials.new(@certificate)
-    end
-
-    def setup_macaroon!
-      raise 'conflicting options for macaroon' if @macaroon && @macaroon_path
-
-      @macaroon = File.read(@macaroon_path).unpack('H*') if @macaroon_path
-    end
-  end
-end