adding multiclient support

Author: icebaker

README.md

@@ -1,4 +1,4 @@
-# lnd-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)
 
 Ruby Lightning Network Daemon Client: Straightforward access to [lnd](https://github.com/lightningnetwork/lnd) [gRPC API](https://lightning.engineering/api-docs/api/lnd/#grpc)
 
@@ -25,20 +25,21 @@ 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'
+  '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'

components/connector.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative '../components/grpc'
+
 require_relative 'service'
 
 module LNDClientInternal
@@ -13,6 +14,8 @@ def initialize(connection)
 
       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)

controllers/client.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

controllers/connection.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

controllers/multiclient.rb

@@ -10,7 +10,6 @@ def initialize(client, rpc, params = {})
       @client = client
       @rpc = rpc
       @service = rpc.const_get(:Service)
-      # require 'pry'; binding.pry
       @stub = rpc.const_get(:Stub).new(
         client.connection[:address],
         client.connection[:credentials],