lnrpc 0.8.0 → 0.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9481909a27ad229cd4d30887ef89068c0b90a8ff45c2113d89f5ae257052fb35
-  data.tar.gz: 12e72406128b26d54b1512f6bfa56d246916902c2526275a5098922c23ffaf65
+  metadata.gz: c75951f225bdf55afcec88b635e02f7677d35c850dce27702fe25713f3b26250
+  data.tar.gz: 64ed585674ccba14158abef3af4582ee85434fb9e9dbaf778a8458c085caee40
 SHA512:
-  metadata.gz: 442c9e2457ad6064fef6ccba011ff733272198a8fbc972fcabcc108e4e6f1d9b4f8c03300f56c5a854f47cfc5a8dc88c22cfdbae76e9d5020537c114c26f1ff1
-  data.tar.gz: 6bfc611d1450f059c065739a9c8ee36c39b4c90e9c718f04eb60188fefb1769db7a4fef932433d966d8e5f0c2813716570388108eb28ae3ad0f24b725c4d3860
+  metadata.gz: 5e6d026d4222dd01107fb35540ecc928f604f084d48befc47deb66e96e49fbf336e8863dbe4c6b556cbb243d1d9df7613c3f9a1bd0554492bac369595d3305e0
+  data.tar.gz: 83571ca31a4b21524a841cd9f1badd1934e15078b2265667c6bb3e7db2fd344cc451acaad255512803b50e1486f87b5b9e80f2ec713144fe31db544ed58491b6

data/.gitignore

@@ -11,3 +11,5 @@
 .rspec_status
 
 .ruby-version
+
+*.gem

data/Gemfile.lock

@@ -1,43 +1,43 @@
 PATH
   remote: .
   specs:
-    lnrpc (0.8.0.beta)
-      google-protobuf (>= 3.7)
-      grpc (>= 1.19.0)
+    lnrpc (0.11.1)
+      google-protobuf (>= 3.12)
+      grpc (>= 1.28.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    diff-lcs (1.3)
-    google-protobuf (3.9.2)
-    googleapis-common-protos-types (1.0.4)
-      google-protobuf (~> 3.0)
-    grpc (1.24.0)
-      google-protobuf (~> 3.8)
+    diff-lcs (1.4.4)
+    google-protobuf (3.17.3)
+    googleapis-common-protos-types (1.1.0)
+      google-protobuf (~> 3.14)
+    grpc (1.38.0)
+      google-protobuf (~> 3.15)
       googleapis-common-protos-types (~> 1.0)
-    rake (10.5.0)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.0)
-      rspec-support (~> 3.9.0)
-    rspec-expectations (3.9.0)
+    rake (13.0.6)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.17)
+  bundler (> 2.0)
   lnrpc!
-  rake (~> 10.0)
+  rake (~> 13.0)
   rspec (~> 3.0)
 
 BUNDLED WITH
-   1.17.3
+   2.1.4

data/README.md

@@ -3,13 +3,15 @@
 
 a [gRPC](https://grpc.io/) client for [LND, the Lightning Network Daemon](https://github.com/lightningnetwork/lnd/) packed as ruby gem.
 
-
 ## Installation
 
+Note: there is still an GRPC/protobuf [issue with Ruby 2.7](https://github.com/protocolbuffers/protobuf/issues/7070).
+So lnrpc requires Ruby < 2.7.
+
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'lnrpc', '~> 0.7.0'
+gem 'lnrpc', '~> 0.11.0'
 ```
 lnrpc follows the lnd versioning, thus it is recommended to specify the exact version you need for your lnd node as dependency (see [#Versioning](#Versioning)).
 
@@ -30,10 +32,12 @@ This gem makes the gRPC client classes created from the [LND service defintions]
 ```ruby
 require "lnrpc"
 
-# the gRPC client is available under the Lnrpc namespace, e.g.
+# With the changes in LND v.10.0 this load the `Lnrpc` and `Routerrpc` namespace
 
 Lnrpc::Lightning::Stub
+Routerrpc:::Routerrpc::Stub
 Lnrpc::GetInfoRequest
+...
 ```
 
 Learn more about [gRPC](https://grpc.io/) on [gRPC.io](https://grpc.io/).
@@ -55,17 +59,26 @@ client = Lnrpc::Lightning::Stub.new("localhost:10009", GRPC::Core::ChannelCreden
 request = Lnrpc::GetInfoRequest.new
 response = client.get_info(request, { metadata: { macaroon: macaroon } }) #=> Lnrpc::GetInfoResponse
 puts response.alias
+
+router = Routerprc::Router::Stub.new("localhost:10009", GRPC::Core::ChannelCredentials.new(self.credentials))
+...
+
 ```
 
 ### Client wrapper
 
+NOTE: v10.0 has breaking changes!
+
 An optional client wrapper ([Lnrpc::Client](https://github.com/bumi/lnrpc/blob/master/lib/lnrpc/client.rb)) makes
 initializing the gRPC client easier and removes the need for some boilerplate code for calling RPC methods.
 
 #### Example
 ```ruby
 lnd = Lnrpc::Client.new({credentials_path: '/path/to.cert.cls', macaroon_path: '/path/to/admin.macaroon'})
-lnd.get_info
+lnd.lightning # => Lnrpc::Lightning::Stub
+lnd.router # => Lnrpc::Router::Stub
+
+lnd.ligthning.get_info
 ```
 
 Also have a look at [examples.rb](https://github.com/bumi/lnrpc/blob/master/examples.rb)
@@ -96,7 +109,8 @@ lnd = Lnrpc::Client.new({
 })
 
 # the actual gRPC client is available through:
-lnd.grpc_client
+lnd.lightning.grpc
+lnd.router.grpc
 ```
 
 #### Calling RPC methods
@@ -108,19 +122,19 @@ If the first parameter is a hash or blank the corresponding gRPC request object
 Example:
 
 ```ruby
-client.get_info
+client.lightning.get_info
 # is the same as:
-client.grpc_client.get_info(Lnrpc::GetInfoRequest.new)
+client.lightning.grpc.get_info(Lnrpc::GetInfoRequest.new)
 
-client.list_channels(inactive_only: true)
+client.lightning.list_channels(inactive_only: true)
 # is the same as:
 request = Lnrpc::ListChannelsRequest.new(inactive_only: true)
-client.grpc_client.list_channels(request)
+client.lightning.grpc.list_channels(request)
 
-client.wallet_balance.total_balance
+client.lightning.wallet_balance.total_balance
 # is the same as:
 request = Lnrpc::WalletBalanceRequest.new()
-client.grpc_client.wallet_balance(request).total_balance
+client.lightning.grpc.wallet_balance(request).total_balance
 ```
 
 ## Using with BTC Pay Server
@@ -145,13 +159,13 @@ see [rubygems](https://rubygems.org/gems/lnrpc) for all available releases.
 
 ### Update service definitions
 
-1. Generate `prc_pb.rb` and `rpc_services_pb.rb`
-
-    $ grpc_tools_ruby_protoc -I/usr/local/include -I. -I$GOPATH/src/github.com/grpc-ecosystem/grpc-gateway/third_party/googleapis --ruby_out=plugins=grpc,paths=source_relative:. --grpc_out=. rpc.proto
+The script `generate-grpc-service-files.sh` can be used to generate the GRPC ruby files.
+The files will be stored in `lib/grpc_services`
 
-2. Copy `rpc.proto`, `rpc_pb.rb` and `rpc_services_pb.rb` to `lib`
+    $ ./generate-grpc-service-files.sh
 
-3. Update `rpc_services_pb.rb` to use `require_relative` to load `rpc_pb`
++ Make sure you have the [grpc-tools](https://rubygems.org/gems/grpc-tools) installed
++ Make sure you have the lnd source in your $GOPATH/src folder
 
 ## Other resources
 

data/examples.rb

@@ -1,24 +1,26 @@
 require "lnrpc"
 
-lnd = Lnrpc::Client.new({
-  credentials_path: '/home/bumi/lightning/bullet-testnet/2019-02-27/tls.cert',
-  macaroon_path: '/home/bumi/lightning/bullet-testnet/2019-02-27/admin.macaroon',
-  address: '79.137.71.183:10009'
-}) # use defaults for credentials, macaraoon and address
+lnd = Lnrpc::Client.new() # use defaults for credentials, macaraoon and address
 
-get_info_res = lnd.get_info
+get_info_res = lnd.lightning.get_info
 puts get_info_res.alias
 
-puts lnd.wallet_balance.total_balance
+puts lnd.lightning.wallet_balance.total_balance
 
-exit
 pay_request = "lntb50u1pw9mmndpp5nvnff958pxc9eqknwntyxapjw7l5grt5e2y70cmmnu0lljfa0sdqdpsgfkx7cmtwd68yetpd5s9xct5v4kxc6t5v5s8yatz0ysxwetdcqzysxqyz5vqjkhlyn40z76gyn7dx32p9j58dftve9xrlvnqqazht7w2fdauukhyhr9y4k3ngjn8s6srglj8swk7tm70ng54wdkq47ahytpwffvaeusp500csz"
-lnd.pay(pay_request) # or:
-lnd.send_payment_sync(payment_request: pay_request)
+lnd.pay(payment_request: pay_request) # or:
+lnd.router.send_payment_v2(payment_request: pay_request)
 
-invoice_res = lnd.add_invoice(value: 1000, memo: 'I :heart: ruby')
+dest = Lnrpc.to_byte_array('038474ec195f497cf4036e5994bd820dd365bb0aaa7fb42bd9b536913a1a2dcc9e')
+lnd.keysend(dest: dest, amt: 1000)
+
+invoice_res = lnd.lightning.add_invoice(value: 1000, memo: 'I :heart: ruby')
 puts invoice_res.payment_request
 
-lnd.subscribe_invoices(settle_index: 1).each do |invoice|
+puts lnd.versioner.get_version
+puts lnd.wallet_kit.estimate_fee(conf_target: 10)
+puts lnd.wallet_kit.next_addr
+
+lnd.lightning.subscribe_invoices(settle_index: 1).each do |invoice|
   puts invoice.payment_request
 end

data/generate-grpc-service-files.sh

@@ -0,0 +1,30 @@
+#!/bin/sh
+set -o xtrace
+
+FULL_PATH=$(realpath $0)
+GEM_DIR=$(dirname $FULL_PATH)
+LNRPC_TARGET_DIR="$GEM_DIR/lib/grpc_services"
+CURRENT_DIR=$(pwd)
+echo $CURRENT_DIR
+cd $GOPATH/src/github.com/lightningnetwork/lnd/lnrpc
+
+echo "Generating Ruby GRPC Service Files"
+
+PROTOS="rpc.proto walletunlocker.proto **/*.proto"
+
+# generate files for each proto
+for file in $PROTOS; do
+  DIRECTORY=$(dirname "${file}")
+  echo "Generating protos from ${file}, into ${LNRPC_TARGET_DIR}/${DIRECTORY}"
+
+  # writes all ruby files in the ruby directory
+  grpc_tools_ruby_protoc -I/usr/local/include \
+    -I. \
+    -I$GOPATH/src/github.com/grpc-ecosystem/grpc-gateway/third_party/googleapis \
+    -I$GOPATH/src/github.com/lightningnetwork/lnd/lnrpc \
+    --ruby_out=plugins=grpc,paths=source_relative:${LNRPC_TARGET_DIR} \
+    --grpc_out=${LNRPC_TARGET_DIR} "${file}"
+
+done
+
+cd $CURRENT_DIR

data/lib/grpc_services/autopilotrpc/autopilot_pb.rb

@@ -0,0 +1,48 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: autopilotrpc/autopilot.proto
+
+require 'google/protobuf'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("autopilotrpc/autopilot.proto", :syntax => :proto3) do
+    add_message "autopilotrpc.StatusRequest" do
+    end
+    add_message "autopilotrpc.StatusResponse" do
+      optional :active, :bool, 1
+    end
+    add_message "autopilotrpc.ModifyStatusRequest" do
+      optional :enable, :bool, 1
+    end
+    add_message "autopilotrpc.ModifyStatusResponse" do
+    end
+    add_message "autopilotrpc.QueryScoresRequest" do
+      repeated :pubkeys, :string, 1
+      optional :ignore_local_state, :bool, 2
+    end
+    add_message "autopilotrpc.QueryScoresResponse" do
+      repeated :results, :message, 1, "autopilotrpc.QueryScoresResponse.HeuristicResult"
+    end
+    add_message "autopilotrpc.QueryScoresResponse.HeuristicResult" do
+      optional :heuristic, :string, 1
+      map :scores, :string, :double, 2
+    end
+    add_message "autopilotrpc.SetScoresRequest" do
+      optional :heuristic, :string, 1
+      map :scores, :string, :double, 2
+    end
+    add_message "autopilotrpc.SetScoresResponse" do
+    end
+  end
+end
+
+module Autopilotrpc
+  StatusRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("autopilotrpc.StatusRequest").msgclass
+  StatusResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("autopilotrpc.StatusResponse").msgclass
+  ModifyStatusRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("autopilotrpc.ModifyStatusRequest").msgclass
+  ModifyStatusResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("autopilotrpc.ModifyStatusResponse").msgclass
+  QueryScoresRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("autopilotrpc.QueryScoresRequest").msgclass
+  QueryScoresResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("autopilotrpc.QueryScoresResponse").msgclass
+  QueryScoresResponse::HeuristicResult = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("autopilotrpc.QueryScoresResponse.HeuristicResult").msgclass
+  SetScoresRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("autopilotrpc.SetScoresRequest").msgclass
+  SetScoresResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("autopilotrpc.SetScoresResponse").msgclass
+end

data/lib/grpc_services/autopilotrpc/autopilot_services_pb.rb

@@ -0,0 +1,40 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: autopilotrpc/autopilot.proto for package 'autopilotrpc'
+
+require 'grpc'
+require 'autopilotrpc/autopilot_pb'
+
+module Autopilotrpc
+  module Autopilot
+    # Autopilot is a service that can be used to get information about the current
+    # state of the daemon's autopilot agent, and also supply it with information
+    # that can be used when deciding where to open channels.
+    class Service
+
+      include ::GRPC::GenericService
+
+      self.marshal_class_method = :encode
+      self.unmarshal_class_method = :decode
+      self.service_name = 'autopilotrpc.Autopilot'
+
+      #
+      # Status returns whether the daemon's autopilot agent is active.
+      rpc :Status, ::Autopilotrpc::StatusRequest, ::Autopilotrpc::StatusResponse
+      #
+      # ModifyStatus is used to modify the status of the autopilot agent, like
+      # enabling or disabling it.
+      rpc :ModifyStatus, ::Autopilotrpc::ModifyStatusRequest, ::Autopilotrpc::ModifyStatusResponse
+      #
+      # QueryScores queries all available autopilot heuristics, in addition to any
+      # active combination of these heruristics, for the scores they would give to
+      # the given nodes.
+      rpc :QueryScores, ::Autopilotrpc::QueryScoresRequest, ::Autopilotrpc::QueryScoresResponse
+      #
+      # SetScores attempts to set the scores used by the running autopilot agent,
+      # if the external scoring heuristic is enabled.
+      rpc :SetScores, ::Autopilotrpc::SetScoresRequest, ::Autopilotrpc::SetScoresResponse
+    end
+
+    Stub = Service.rpc_stub_class
+  end
+end

data/lib/grpc_services/chainrpc/chainnotifier_pb.rb

@@ -0,0 +1,67 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: chainrpc/chainnotifier.proto
+
+require 'google/protobuf'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("chainrpc/chainnotifier.proto", :syntax => :proto3) do
+    add_message "chainrpc.ConfRequest" do
+      optional :txid, :bytes, 1
+      optional :script, :bytes, 2
+      optional :num_confs, :uint32, 3
+      optional :height_hint, :uint32, 4
+    end
+    add_message "chainrpc.ConfDetails" do
+      optional :raw_tx, :bytes, 1
+      optional :block_hash, :bytes, 2
+      optional :block_height, :uint32, 3
+      optional :tx_index, :uint32, 4
+    end
+    add_message "chainrpc.Reorg" do
+    end
+    add_message "chainrpc.ConfEvent" do
+      oneof :event do
+        optional :conf, :message, 1, "chainrpc.ConfDetails"
+        optional :reorg, :message, 2, "chainrpc.Reorg"
+      end
+    end
+    add_message "chainrpc.Outpoint" do
+      optional :hash, :bytes, 1
+      optional :index, :uint32, 2
+    end
+    add_message "chainrpc.SpendRequest" do
+      optional :outpoint, :message, 1, "chainrpc.Outpoint"
+      optional :script, :bytes, 2
+      optional :height_hint, :uint32, 3
+    end
+    add_message "chainrpc.SpendDetails" do
+      optional :spending_outpoint, :message, 1, "chainrpc.Outpoint"
+      optional :raw_spending_tx, :bytes, 2
+      optional :spending_tx_hash, :bytes, 3
+      optional :spending_input_index, :uint32, 4
+      optional :spending_height, :uint32, 5
+    end
+    add_message "chainrpc.SpendEvent" do
+      oneof :event do
+        optional :spend, :message, 1, "chainrpc.SpendDetails"
+        optional :reorg, :message, 2, "chainrpc.Reorg"
+      end
+    end
+    add_message "chainrpc.BlockEpoch" do
+      optional :hash, :bytes, 1
+      optional :height, :uint32, 2
+    end
+  end
+end
+
+module Chainrpc
+  ConfRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("chainrpc.ConfRequest").msgclass
+  ConfDetails = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("chainrpc.ConfDetails").msgclass
+  Reorg = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("chainrpc.Reorg").msgclass
+  ConfEvent = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("chainrpc.ConfEvent").msgclass
+  Outpoint = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("chainrpc.Outpoint").msgclass
+  SpendRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("chainrpc.SpendRequest").msgclass
+  SpendDetails = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("chainrpc.SpendDetails").msgclass
+  SpendEvent = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("chainrpc.SpendEvent").msgclass
+  BlockEpoch = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("chainrpc.BlockEpoch").msgclass
+end

data/lib/grpc_services/chainrpc/chainnotifier_services_pb.rb

@@ -0,0 +1,51 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: chainrpc/chainnotifier.proto for package 'chainrpc'
+
+require 'grpc'
+require 'chainrpc/chainnotifier_pb'
+
+module Chainrpc
+  module ChainNotifier
+    # ChainNotifier is a service that can be used to get information about the
+    # chain backend by registering notifiers for chain events.
+    class Service
+
+      include ::GRPC::GenericService
+
+      self.marshal_class_method = :encode
+      self.unmarshal_class_method = :decode
+      self.service_name = 'chainrpc.ChainNotifier'
+
+      #
+      # RegisterConfirmationsNtfn is a synchronous response-streaming RPC that
+      # registers an intent for a client to be notified once a confirmation request
+      # has reached its required number of confirmations on-chain.
+      #
+      # A client can specify whether the confirmation request should be for a
+      # particular transaction by its hash or for an output script by specifying a
+      # zero hash.
+      rpc :RegisterConfirmationsNtfn, ::Chainrpc::ConfRequest, stream(::Chainrpc::ConfEvent)
+      #
+      # RegisterSpendNtfn is a synchronous response-streaming RPC that registers an
+      # intent for a client to be notification once a spend request has been spent
+      # by a transaction that has confirmed on-chain.
+      #
+      # A client can specify whether the spend request should be for a particular
+      # outpoint  or for an output script by specifying a zero outpoint.
+      rpc :RegisterSpendNtfn, ::Chainrpc::SpendRequest, stream(::Chainrpc::SpendEvent)
+      #
+      # RegisterBlockEpochNtfn is a synchronous response-streaming RPC that
+      # registers an intent for a client to be notified of blocks in the chain. The
+      # stream will return a hash and height tuple of a block for each new/stale
+      # block in the chain. It is the client's responsibility to determine whether
+      # the tuple returned is for a new or stale block in the chain.
+      #
+      # A client can also request a historical backlog of blocks from a particular
+      # point. This allows clients to be idempotent by ensuring that they do not
+      # missing processing a single block within the chain.
+      rpc :RegisterBlockEpochNtfn, ::Chainrpc::BlockEpoch, stream(::Chainrpc::BlockEpoch)
+    end
+
+    Stub = Service.rpc_stub_class
+  end
+end