lnrpc 0.9.0 → 0.13.0

data/lib/grpc_services/walletrpc/walletkit_services_pb.rb

@@ -0,0 +1,188 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: walletrpc/walletkit.proto for package 'walletrpc'
+
+require 'grpc'
+require 'walletrpc/walletkit_pb'
+
+module Walletrpc
+  module WalletKit
+    # WalletKit is a service that gives access to the core functionalities of the
+    # daemon's wallet.
+    class Service
+
+      include ::GRPC::GenericService
+
+      self.marshal_class_method = :encode
+      self.unmarshal_class_method = :decode
+      self.service_name = 'walletrpc.WalletKit'
+
+      #
+      # ListUnspent returns a list of all utxos spendable by the wallet with a
+      # number of confirmations between the specified minimum and maximum.
+      rpc :ListUnspent, ::Walletrpc::ListUnspentRequest, ::Walletrpc::ListUnspentResponse
+      #
+      # LeaseOutput locks an output to the given ID, preventing it from being
+      # available for any future coin selection attempts. The absolute time of the
+      # lock's expiration is returned. The expiration of the lock can be extended by
+      # successive invocations of this RPC. Outputs can be unlocked before their
+      # expiration through `ReleaseOutput`.
+      rpc :LeaseOutput, ::Walletrpc::LeaseOutputRequest, ::Walletrpc::LeaseOutputResponse
+      #
+      # ReleaseOutput unlocks an output, allowing it to be available for coin
+      # selection if it remains unspent. The ID should match the one used to
+      # originally lock the output.
+      rpc :ReleaseOutput, ::Walletrpc::ReleaseOutputRequest, ::Walletrpc::ReleaseOutputResponse
+      #
+      # ListLeases lists all currently locked utxos.
+      rpc :ListLeases, ::Walletrpc::ListLeasesRequest, ::Walletrpc::ListLeasesResponse
+      #
+      # DeriveNextKey attempts to derive the *next* key within the key family
+      # (account in BIP43) specified. This method should return the next external
+      # child within this branch.
+      rpc :DeriveNextKey, ::Walletrpc::KeyReq, ::Signrpc::KeyDescriptor
+      #
+      # DeriveKey attempts to derive an arbitrary key specified by the passed
+      # KeyLocator.
+      rpc :DeriveKey, ::Signrpc::KeyLocator, ::Signrpc::KeyDescriptor
+      #
+      # NextAddr returns the next unused address within the wallet.
+      rpc :NextAddr, ::Walletrpc::AddrRequest, ::Walletrpc::AddrResponse
+      #
+      # ListAccounts retrieves all accounts belonging to the wallet by default. A
+      # name and key scope filter can be provided to filter through all of the
+      # wallet accounts and return only those matching.
+      rpc :ListAccounts, ::Walletrpc::ListAccountsRequest, ::Walletrpc::ListAccountsResponse
+      #
+      # ImportAccount imports an account backed by an account extended public key.
+      # The master key fingerprint denotes the fingerprint of the root key
+      # corresponding to the account public key (also known as the key with
+      # derivation path m/). This may be required by some hardware wallets for
+      # proper identification and signing.
+      #
+      # The address type can usually be inferred from the key's version, but may be
+      # required for certain keys to map them into the proper scope.
+      #
+      # For BIP-0044 keys, an address type must be specified as we intend to not
+      # support importing BIP-0044 keys into the wallet using the legacy
+      # pay-to-pubkey-hash (P2PKH) scheme. A nested witness address type will force
+      # the standard BIP-0049 derivation scheme, while a witness address type will
+      # force the standard BIP-0084 derivation scheme.
+      #
+      # For BIP-0049 keys, an address type must also be specified to make a
+      # distinction between the standard BIP-0049 address schema (nested witness
+      # pubkeys everywhere) and our own BIP-0049Plus address schema (nested pubkeys
+      # externally, witness pubkeys internally).
+      #
+      # NOTE: Events (deposits/spends) for keys derived from an account will only be
+      # detected by lnd if they happen after the import. Rescans to detect past
+      # events will be supported later on.
+      rpc :ImportAccount, ::Walletrpc::ImportAccountRequest, ::Walletrpc::ImportAccountResponse
+      #
+      # ImportPublicKey imports a public key as watch-only into the wallet.
+      #
+      # NOTE: Events (deposits/spends) for a key will only be detected by lnd if
+      # they happen after the import. Rescans to detect past events will be
+      # supported later on.
+      rpc :ImportPublicKey, ::Walletrpc::ImportPublicKeyRequest, ::Walletrpc::ImportPublicKeyResponse
+      #
+      # PublishTransaction attempts to publish the passed transaction to the
+      # network. Once this returns without an error, the wallet will continually
+      # attempt to re-broadcast the transaction on start up, until it enters the
+      # chain.
+      rpc :PublishTransaction, ::Walletrpc::Transaction, ::Walletrpc::PublishResponse
+      #
+      # SendOutputs is similar to the existing sendmany call in Bitcoind, and
+      # allows the caller to create a transaction that sends to several outputs at
+      # once. This is ideal when wanting to batch create a set of transactions.
+      rpc :SendOutputs, ::Walletrpc::SendOutputsRequest, ::Walletrpc::SendOutputsResponse
+      #
+      # EstimateFee attempts to query the internal fee estimator of the wallet to
+      # determine the fee (in sat/kw) to attach to a transaction in order to
+      # achieve the confirmation target.
+      rpc :EstimateFee, ::Walletrpc::EstimateFeeRequest, ::Walletrpc::EstimateFeeResponse
+      #
+      # PendingSweeps returns lists of on-chain outputs that lnd is currently
+      # attempting to sweep within its central batching engine. Outputs with similar
+      # fee rates are batched together in order to sweep them within a single
+      # transaction.
+      #
+      # NOTE: Some of the fields within PendingSweepsRequest are not guaranteed to
+      # remain supported. This is an advanced API that depends on the internals of
+      # the UtxoSweeper, so things may change.
+      rpc :PendingSweeps, ::Walletrpc::PendingSweepsRequest, ::Walletrpc::PendingSweepsResponse
+      #
+      # BumpFee bumps the fee of an arbitrary input within a transaction. This RPC
+      # takes a different approach than bitcoind's bumpfee command. lnd has a
+      # central batching engine in which inputs with similar fee rates are batched
+      # together to save on transaction fees. Due to this, we cannot rely on
+      # bumping the fee on a specific transaction, since transactions can change at
+      # any point with the addition of new inputs. The list of inputs that
+      # currently exist within lnd's central batching engine can be retrieved
+      # through the PendingSweeps RPC.
+      #
+      # When bumping the fee of an input that currently exists within lnd's central
+      # batching engine, a higher fee transaction will be created that replaces the
+      # lower fee transaction through the Replace-By-Fee (RBF) policy. If it
+      #
+      # This RPC also serves useful when wanting to perform a Child-Pays-For-Parent
+      # (CPFP), where the child transaction pays for its parent's fee. This can be
+      # done by specifying an outpoint within the low fee transaction that is under
+      # the control of the wallet.
+      #
+      # The fee preference can be expressed either as a specific fee rate or a delta
+      # of blocks in which the output should be swept on-chain within. If a fee
+      # preference is not explicitly specified, then an error is returned.
+      #
+      # Note that this RPC currently doesn't perform any validation checks on the
+      # fee preference being provided. For now, the responsibility of ensuring that
+      # the new fee preference is sufficient is delegated to the user.
+      rpc :BumpFee, ::Walletrpc::BumpFeeRequest, ::Walletrpc::BumpFeeResponse
+      #
+      # ListSweeps returns a list of the sweep transactions our node has produced.
+      # Note that these sweeps may not be confirmed yet, as we record sweeps on
+      # broadcast, not confirmation.
+      rpc :ListSweeps, ::Walletrpc::ListSweepsRequest, ::Walletrpc::ListSweepsResponse
+      #
+      # LabelTransaction adds a label to a transaction. If the transaction already
+      # has a label the call will fail unless the overwrite bool is set. This will
+      # overwrite the exiting transaction label. Labels must not be empty, and
+      # cannot exceed 500 characters.
+      rpc :LabelTransaction, ::Walletrpc::LabelTransactionRequest, ::Walletrpc::LabelTransactionResponse
+      #
+      # FundPsbt creates a fully populated PSBT that contains enough inputs to fund
+      # the outputs specified in the template. There are two ways of specifying a
+      # template: Either by passing in a PSBT with at least one output declared or
+      # by passing in a raw TxTemplate message.
+      #
+      # If there are no inputs specified in the template, coin selection is
+      # performed automatically. If the template does contain any inputs, it is
+      # assumed that full coin selection happened externally and no additional
+      # inputs are added. If the specified inputs aren't enough to fund the outputs
+      # with the given fee rate, an error is returned.
+      #
+      # After either selecting or verifying the inputs, all input UTXOs are locked
+      # with an internal app ID.
+      #
+      # NOTE: If this method returns without an error, it is the caller's
+      # responsibility to either spend the locked UTXOs (by finalizing and then
+      # publishing the transaction) or to unlock/release the locked UTXOs in case of
+      # an error on the caller's side.
+      rpc :FundPsbt, ::Walletrpc::FundPsbtRequest, ::Walletrpc::FundPsbtResponse
+      #
+      # FinalizePsbt expects a partial transaction with all inputs and outputs fully
+      # declared and tries to sign all inputs that belong to the wallet. Lnd must be
+      # the last signer of the transaction. That means, if there are any unsigned
+      # non-witness inputs or inputs without UTXO information attached or inputs
+      # without witness data that do not belong to lnd's wallet, this method will
+      # fail. If no error is returned, the PSBT is ready to be extracted and the
+      # final TX within to be broadcast.
+      #
+      # NOTE: This method does NOT publish the transaction once finalized. It is the
+      # caller's responsibility to either publish the transaction on success or
+      # unlock/release any locked UTXOs in case of an error in this method.
+      rpc :FinalizePsbt, ::Walletrpc::FinalizePsbtRequest, ::Walletrpc::FinalizePsbtResponse
+    end
+
+    Stub = Service.rpc_stub_class
+  end
+end

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,83 @@
+# 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
+      optional :sweep_sat_per_vbyte, :uint32, 5
+    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
+      optional :sweep_sat_per_vbyte, :uint32, 3
+    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