lnrpc 0.8.0 → 0.12.1

data/lib/grpc_services/walletunlocker_pb.rb

@@ -0,0 +1,57 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: walletunlocker.proto
+
+require 'google/protobuf'
+
+require 'rpc_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("walletunlocker.proto", :syntax => :proto3) do
+    add_message "lnrpc.GenSeedRequest" do
+      optional :aezeed_passphrase, :bytes, 1
+      optional :seed_entropy, :bytes, 2
+    end
+    add_message "lnrpc.GenSeedResponse" do
+      repeated :cipher_seed_mnemonic, :string, 1
+      optional :enciphered_seed, :bytes, 2
+    end
+    add_message "lnrpc.InitWalletRequest" do
+      optional :wallet_password, :bytes, 1
+      repeated :cipher_seed_mnemonic, :string, 2
+      optional :aezeed_passphrase, :bytes, 3
+      optional :recovery_window, :int32, 4
+      optional :channel_backups, :message, 5, "lnrpc.ChanBackupSnapshot"
+      optional :stateless_init, :bool, 6
+    end
+    add_message "lnrpc.InitWalletResponse" do
+      optional :admin_macaroon, :bytes, 1
+    end
+    add_message "lnrpc.UnlockWalletRequest" do
+      optional :wallet_password, :bytes, 1
+      optional :recovery_window, :int32, 2
+      optional :channel_backups, :message, 3, "lnrpc.ChanBackupSnapshot"
+      optional :stateless_init, :bool, 4
+    end
+    add_message "lnrpc.UnlockWalletResponse" do
+    end
+    add_message "lnrpc.ChangePasswordRequest" do
+      optional :current_password, :bytes, 1
+      optional :new_password, :bytes, 2
+      optional :stateless_init, :bool, 3
+      optional :new_macaroon_root_key, :bool, 4
+    end
+    add_message "lnrpc.ChangePasswordResponse" do
+      optional :admin_macaroon, :bytes, 1
+    end
+  end
+end
+
+module Lnrpc
+  GenSeedRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.GenSeedRequest").msgclass
+  GenSeedResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.GenSeedResponse").msgclass
+  InitWalletRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.InitWalletRequest").msgclass
+  InitWalletResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.InitWalletResponse").msgclass
+  UnlockWalletRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.UnlockWalletRequest").msgclass
+  UnlockWalletResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.UnlockWalletResponse").msgclass
+  ChangePasswordRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.ChangePasswordRequest").msgclass
+  ChangePasswordResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.ChangePasswordResponse").msgclass
+end

data/lib/grpc_services/walletunlocker_services_pb.rb

@@ -0,0 +1,72 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: walletunlocker.proto for package 'lnrpc'
+
+require 'grpc'
+require 'walletunlocker_pb'
+
+module Lnrpc
+  module WalletUnlocker
+    #
+    # Comments in this file will be directly parsed into the API
+    # Documentation as descriptions of the associated method, message, or field.
+    # These descriptions should go right above the definition of the object, and
+    # can be in either block or // comment format.
+    #
+    # An RPC method can be matched to an lncli command by placing a line in the
+    # beginning of the description in exactly the following format:
+    # lncli: `methodname`
+    #
+    # Failure to specify the exact name of the command will cause documentation
+    # generation to fail.
+    #
+    # More information on how exactly the gRPC documentation is generated from
+    # this proto file can be found here:
+    # https://github.com/lightninglabs/lightning-api
+    #
+    # WalletUnlocker is a service that is used to set up a wallet password for
+    # lnd at first startup, and unlock a previously set up wallet.
+    class Service
+
+      include ::GRPC::GenericService
+
+      self.marshal_class_method = :encode
+      self.unmarshal_class_method = :decode
+      self.service_name = 'lnrpc.WalletUnlocker'
+
+      #
+      # GenSeed is the first method that should be used to instantiate a new lnd
+      # instance. This method allows a caller to generate a new aezeed cipher seed
+      # given an optional passphrase. If provided, the passphrase will be necessary
+      # to decrypt the cipherseed to expose the internal wallet seed.
+      #
+      # Once the cipherseed is obtained and verified by the user, the InitWallet
+      # method should be used to commit the newly generated seed, and create the
+      # wallet.
+      rpc :GenSeed, ::Lnrpc::GenSeedRequest, ::Lnrpc::GenSeedResponse
+      #
+      # InitWallet is used when lnd is starting up for the first time to fully
+      # initialize the daemon and its internal wallet. At the very least a wallet
+      # password must be provided. This will be used to encrypt sensitive material
+      # on disk.
+      #
+      # In the case of a recovery scenario, the user can also specify their aezeed
+      # mnemonic and passphrase. If set, then the daemon will use this prior state
+      # to initialize its internal wallet.
+      #
+      # Alternatively, this can be used along with the GenSeed RPC to obtain a
+      # seed, then present it to the user. Once it has been verified by the user,
+      # the seed can be fed into this RPC in order to commit the new wallet.
+      rpc :InitWallet, ::Lnrpc::InitWalletRequest, ::Lnrpc::InitWalletResponse
+      # lncli: `unlock`
+      # UnlockWallet is used at startup of lnd to provide a password to unlock
+      # the wallet database.
+      rpc :UnlockWallet, ::Lnrpc::UnlockWalletRequest, ::Lnrpc::UnlockWalletResponse
+      # lncli: `changepassword`
+      # ChangePassword changes the password of the encrypted wallet. This will
+      # automatically unlock the wallet database if successful.
+      rpc :ChangePassword, ::Lnrpc::ChangePasswordRequest, ::Lnrpc::ChangePasswordResponse
+    end
+
+    Stub = Service.rpc_stub_class
+  end
+end

data/lib/grpc_services/watchtowerrpc/watchtower_pb.rb

@@ -0,0 +1,21 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: watchtowerrpc/watchtower.proto
+
+require 'google/protobuf'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("watchtowerrpc/watchtower.proto", :syntax => :proto3) do
+    add_message "watchtowerrpc.GetInfoRequest" do
+    end
+    add_message "watchtowerrpc.GetInfoResponse" do
+      optional :pubkey, :bytes, 1
+      repeated :listeners, :string, 2
+      repeated :uris, :string, 3
+    end
+  end
+end
+
+module Watchtowerrpc
+  GetInfoRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("watchtowerrpc.GetInfoRequest").msgclass
+  GetInfoResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("watchtowerrpc.GetInfoResponse").msgclass
+end

data/lib/grpc_services/watchtowerrpc/watchtower_services_pb.rb

@@ -0,0 +1,28 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: watchtowerrpc/watchtower.proto for package 'watchtowerrpc'
+
+require 'grpc'
+require 'watchtowerrpc/watchtower_pb'
+
+module Watchtowerrpc
+  module Watchtower
+    # Watchtower is a service that grants access to the watchtower server
+    # functionality of the daemon.
+    class Service
+
+      include ::GRPC::GenericService
+
+      self.marshal_class_method = :encode
+      self.unmarshal_class_method = :decode
+      self.service_name = 'watchtowerrpc.Watchtower'
+
+      # lncli: tower info
+      # GetInfo returns general information concerning the companion watchtower
+      # including its public key and URIs where the server is currently
+      # listening for clients.
+      rpc :GetInfo, ::Watchtowerrpc::GetInfoRequest, ::Watchtowerrpc::GetInfoResponse
+    end
+
+    Stub = Service.rpc_stub_class
+  end
+end

data/lib/grpc_services/wtclientrpc/wtclient_pb.rb

@@ -0,0 +1,81 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: wtclientrpc/wtclient.proto
+
+require 'google/protobuf'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("wtclientrpc/wtclient.proto", :syntax => :proto3) do
+    add_message "wtclientrpc.AddTowerRequest" do
+      optional :pubkey, :bytes, 1
+      optional :address, :string, 2
+    end
+    add_message "wtclientrpc.AddTowerResponse" do
+    end
+    add_message "wtclientrpc.RemoveTowerRequest" do
+      optional :pubkey, :bytes, 1
+      optional :address, :string, 2
+    end
+    add_message "wtclientrpc.RemoveTowerResponse" do
+    end
+    add_message "wtclientrpc.GetTowerInfoRequest" do
+      optional :pubkey, :bytes, 1
+      optional :include_sessions, :bool, 2
+    end
+    add_message "wtclientrpc.TowerSession" do
+      optional :num_backups, :uint32, 1
+      optional :num_pending_backups, :uint32, 2
+      optional :max_backups, :uint32, 3
+      optional :sweep_sat_per_byte, :uint32, 4
+    end
+    add_message "wtclientrpc.Tower" do
+      optional :pubkey, :bytes, 1
+      repeated :addresses, :string, 2
+      optional :active_session_candidate, :bool, 3
+      optional :num_sessions, :uint32, 4
+      repeated :sessions, :message, 5, "wtclientrpc.TowerSession"
+    end
+    add_message "wtclientrpc.ListTowersRequest" do
+      optional :include_sessions, :bool, 1
+    end
+    add_message "wtclientrpc.ListTowersResponse" do
+      repeated :towers, :message, 1, "wtclientrpc.Tower"
+    end
+    add_message "wtclientrpc.StatsRequest" do
+    end
+    add_message "wtclientrpc.StatsResponse" do
+      optional :num_backups, :uint32, 1
+      optional :num_pending_backups, :uint32, 2
+      optional :num_failed_backups, :uint32, 3
+      optional :num_sessions_acquired, :uint32, 4
+      optional :num_sessions_exhausted, :uint32, 5
+    end
+    add_message "wtclientrpc.PolicyRequest" do
+      optional :policy_type, :enum, 1, "wtclientrpc.PolicyType"
+    end
+    add_message "wtclientrpc.PolicyResponse" do
+      optional :max_updates, :uint32, 1
+      optional :sweep_sat_per_byte, :uint32, 2
+    end
+    add_enum "wtclientrpc.PolicyType" do
+      value :LEGACY, 0
+      value :ANCHOR, 1
+    end
+  end
+end
+
+module Wtclientrpc
+  AddTowerRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("wtclientrpc.AddTowerRequest").msgclass
+  AddTowerResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("wtclientrpc.AddTowerResponse").msgclass
+  RemoveTowerRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("wtclientrpc.RemoveTowerRequest").msgclass
+  RemoveTowerResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("wtclientrpc.RemoveTowerResponse").msgclass
+  GetTowerInfoRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("wtclientrpc.GetTowerInfoRequest").msgclass
+  TowerSession = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("wtclientrpc.TowerSession").msgclass
+  Tower = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("wtclientrpc.Tower").msgclass
+  ListTowersRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("wtclientrpc.ListTowersRequest").msgclass
+  ListTowersResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("wtclientrpc.ListTowersResponse").msgclass
+  StatsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("wtclientrpc.StatsRequest").msgclass
+  StatsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("wtclientrpc.StatsResponse").msgclass
+  PolicyRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("wtclientrpc.PolicyRequest").msgclass
+  PolicyResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("wtclientrpc.PolicyResponse").msgclass
+  PolicyType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("wtclientrpc.PolicyType").enummodule
+end

data/lib/grpc_services/wtclientrpc/wtclient_services_pb.rb

@@ -0,0 +1,43 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: wtclientrpc/wtclient.proto for package 'wtclientrpc'
+
+require 'grpc'
+require 'wtclientrpc/wtclient_pb'
+
+module Wtclientrpc
+  module WatchtowerClient
+    # WatchtowerClient is a service that grants access to the watchtower client
+    # functionality of the daemon.
+    class Service
+
+      include ::GRPC::GenericService
+
+      self.marshal_class_method = :encode
+      self.unmarshal_class_method = :decode
+      self.service_name = 'wtclientrpc.WatchtowerClient'
+
+      #
+      # AddTower adds a new watchtower reachable at the given address and
+      # considers it for new sessions. If the watchtower already exists, then
+      # any new addresses included will be considered when dialing it for
+      # session negotiations and backups.
+      rpc :AddTower, ::Wtclientrpc::AddTowerRequest, ::Wtclientrpc::AddTowerResponse
+      #
+      # RemoveTower removes a watchtower from being considered for future session
+      # negotiations and from being used for any subsequent backups until it's added
+      # again. If an address is provided, then this RPC only serves as a way of
+      # removing the address from the watchtower instead.
+      rpc :RemoveTower, ::Wtclientrpc::RemoveTowerRequest, ::Wtclientrpc::RemoveTowerResponse
+      # ListTowers returns the list of watchtowers registered with the client.
+      rpc :ListTowers, ::Wtclientrpc::ListTowersRequest, ::Wtclientrpc::ListTowersResponse
+      # GetTowerInfo retrieves information for a registered watchtower.
+      rpc :GetTowerInfo, ::Wtclientrpc::GetTowerInfoRequest, ::Wtclientrpc::Tower
+      # Stats returns the in-memory statistics of the client since startup.
+      rpc :Stats, ::Wtclientrpc::StatsRequest, ::Wtclientrpc::StatsResponse
+      # Policy returns the active watchtower client policy configuration.
+      rpc :Policy, ::Wtclientrpc::PolicyRequest, ::Wtclientrpc::PolicyResponse
+    end
+
+    Stub = Service.rpc_stub_class
+  end
+end

data/lib/lnrpc.rb

@@ -1,10 +1,26 @@
-require "lnrpc/version"
-require "lnrpc/rpc_services_pb"
+require 'lnrpc/version'
+
+# require GRPC services
+Dir[File.join(File.expand_path(File.dirname(__FILE__)), 'grpc_services/**/*_services_pb.rb')].each do |file|
+  require file
+end
+
+require 'securerandom'
 
 module Lnrpc
   class Error < StandardError; end
   autoload :Client, 'lnrpc/client'
+  autoload :GrpcWrapper, 'lnrpc/grpc_wrapper'
   autoload :MacaroonInterceptor, 'lnrpc/macaroon_interceptor'
-end
 
+  PREIMAGE_BYTE_LENGTH = 32
+  KEY_SEND_PREIMAGE_TYPE = 5482373484
+
+  def self.create_preimage
+    SecureRandom.random_bytes(PREIMAGE_BYTE_LENGTH)
+  end
 
+  def self.to_byte_array(str)
+    [str].pack("H*")
+  end
+end

data/lib/lnrpc/client.rb

@@ -3,37 +3,18 @@ require "lnrpc/macaroon_interceptor"
 module Lnrpc
   class Client
     attr_accessor :address, :credentials, :macaroon
-    attr_writer :grpc_client
 
     LND_HOME_DIR = ENV['LND_HOME'] || "~/.lnd"
     DEFAULT_ADDRESS = 'localhost:10009'
     DEFAULT_CREDENTIALS_PATH = "#{LND_HOME_DIR}/tls.cert"
     DEFAULT_MACAROON_PATH = "#{LND_HOME_DIR}/data/chain/bitcoin/mainnet/admin.macaroon"
 
-    NON_CONVENTION_REQUEST_CLASSES = {
-      add_invoice: Lnrpc::Invoice,
-      send_payment: Lnrpc::SendRequest,
-      send_payment_sync: Lnrpc::SendRequest,
-      open_channel_sync: Lnrpc::OpenChannelRequest,
-      send_to_route_sync: Lnrpc::SendToRouteRequest,
-      lookup_invoice: Lnrpc::PaymentHash,
-      decode_pay_req: Lnrpc::PayReqString,
-      describe_graph: Lnrpc::ChannelGraphRequest,
-      get_chan_info: Lnrpc::ChanInfoRequest,
-      get_node_info: Lnrpc::NodeInfoRequest,
-      get_network_info: Lnrpc::NetworkInfoRequest,
-      stop_daemon: Lnrpc::StopRequest,
-      update_channel_policy: Lnrpc::PolicyUpdateResponse,
-      subscribe_channel_graph: Lnrpc::GraphTopologySubscription,
-      subscribe_invoices: Lnrpc::InvoiceSubscription,
-      subscribe_transactions: Lnrpc::GetTransactionsRequest
-    }
-
     def initialize(options={})
       self.address = options[:address] || DEFAULT_ADDRESS
 
       if options.has_key?(:credentials)
-        self.credentials = options[:credentials]
+        # if there are non hex values prvided we assume it's the certificate file as string otherwise we assume it's the hex value
+        self.credentials = options[:credentials].match?(/\H/) ? options[:credentials] : [options[:credentials]].pack('H*')
       elsif File.exists?(::File.expand_path(options[:credentials_path] || DEFAULT_CREDENTIALS_PATH))
         self.credentials = ::File.read(::File.expand_path(options[:credentials_path] || DEFAULT_CREDENTIALS_PATH))
       else
@@ -46,42 +27,77 @@ module Lnrpc
       self.macaroon = options[:macaroon]
     end
 
-    def grpc_client
-      @grpc_client ||= Lnrpc::Lightning::Stub.new(self.address,
-                                                    GRPC::Core::ChannelCredentials.new(self.credentials),
-                                                    interceptors: [Lnrpc::MacaroonInterceptor.new(self.macaroon)]
-                                                  )
+    def lightning
+      @lightning ||= grpc_wrapper_for(Lnrpc::Lightning)
     end
 
-    def pay(payreq)
-      self.send_payment_sync(Lnrpc::SendRequest.new(payment_request: payreq))
+    def autopilot
+      @autopilot ||= grpc_wrapper_for(Autopilotrpc::Autopilot)
     end
 
-    def method_missing(m, *args, &block)
-      if self.grpc_client.respond_to?(m)
-        params  = args[0]
+    def chain_notifier
+      @chain_notifier ||= grpc_wrapper_for(Chainrpc::ChainNotifier)
+    end
 
-        args[0] = params.nil? ? request_class_for(m).new : request_class_for(m).new(params)
-        self.grpc_client.send(m, *args, &block)
-      else
-        super
-      end
+    def invoices
+      @invoices ||= grpc_wrapper_for(Invoicesrpc::Invoices)
+    end
+
+    def router
+      @router ||= grpc_wrapper_for(Routerrpc::Router)
+    end
+
+    def signer
+      @signer ||= grpc_wrapper_for(Signrpc::Signer)
+    end
+
+    def versioner
+      @versioner ||= grpc_wrapper_for(Verrpc::Versioner)
+    end
+
+    def wallet_kit
+      @wallet_kit ||= grpc_wrapper_for(Walletrpc::WalletKit)
+    end
+
+    def wallet_unlocker
+      @wallet_unlocker ||= grpc_wrapper_for(Lnrpc::WalletUnlocker)
+    end
+
+    def watchtower
+      @watchtower ||= grpc_wrapper_for(Watchtowerrpc::Watchtower)
+    end
+
+    def watchtower_client
+      @watchtower_client ||= grpc_wrapper_for(Wtclientrpc::WatchtowerClient)
+    end
+
+    def keysend(args)
+      args[:dest_custom_records] ||= {}
+      args[:dest_custom_records][Lnrpc::KEY_SEND_PREIMAGE_TYPE] ||= Lnrpc.create_preimage
+      args[:payment_hash] ||= Digest::SHA256.digest(args[:dest_custom_records][Lnrpc::KEY_SEND_PREIMAGE_TYPE])
+      args[:timeout_seconds] ||= 60
+      router.send_payment_v2(args)
+    end
+
+    def pay(args)
+      args[:timeout_seconds] ||= 60
+      router.send_payment_v2(args)
     end
 
     def inspect
-      "#{self.to_s} @address=\"#{self.address}\""
+      "#{self} @address=\"#{address}\""
     end
 
     private
-    def request_class_for(method_name)
-      if NON_CONVENTION_REQUEST_CLASSES.key?(method_name.to_sym)
-        NON_CONVENTION_REQUEST_CLASSES[method_name.to_sym]
-      else
-        klass = method_name.to_s.sub(/^[a-z\d]*/) { |match| match.capitalize }
-        klass.gsub!(/(?:_|(\/))([a-z\d]*)/i) { "#{$1}#{$2.capitalize}" }
-        Lnrpc.const_get("#{klass}Request")
-      end
+
+    def grpc_wrapper_for(grpc_module)
+      stub = grpc_module.const_get(:Stub)
+      service = grpc_module.const_get(:Service)
+      GrpcWrapper.new(service: service,
+                      grpc: stub.new(address,
+                                GRPC::Core::ChannelCredentials.new(credentials),
+                                interceptors: [Lnrpc::MacaroonInterceptor.new(macaroon)]
+                              ))
     end
   end
 end
-