public static interface WalletKitGrpc.AsyncService
WalletKit is a service that gives access to the core functionalities of the daemon's wallet.
| Modifier and Type | Method and Description |
|---|---|
default void |
bumpFee(WalletKitOuterClass.BumpFeeRequest request,
io.grpc.stub.StreamObserver<WalletKitOuterClass.BumpFeeResponse> responseObserver)
BumpFee bumps the fee of an arbitrary input within a transaction.
|
default void |
deriveKey(SignerOuterClass.KeyLocator request,
io.grpc.stub.StreamObserver<SignerOuterClass.KeyDescriptor> responseObserver)
DeriveKey attempts to derive an arbitrary key specified by the passed
KeyLocator.
|
default void |
deriveNextKey(WalletKitOuterClass.KeyReq request,
io.grpc.stub.StreamObserver<SignerOuterClass.KeyDescriptor> responseObserver)
DeriveNextKey attempts to derive the *next* key within the key family
(account in BIP43) specified.
|
default void |
estimateFee(WalletKitOuterClass.EstimateFeeRequest request,
io.grpc.stub.StreamObserver<WalletKitOuterClass.EstimateFeeResponse> responseObserver)
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.
|
default void |
finalizePsbt(WalletKitOuterClass.FinalizePsbtRequest request,
io.grpc.stub.StreamObserver<WalletKitOuterClass.FinalizePsbtResponse> responseObserver)
FinalizePsbt expects a partial transaction with all inputs and outputs fully
declared and tries to sign all inputs that belong to the wallet.
|
default void |
fundPsbt(WalletKitOuterClass.FundPsbtRequest request,
io.grpc.stub.StreamObserver<WalletKitOuterClass.FundPsbtResponse> responseObserver)
FundPsbt creates a fully populated PSBT that contains enough inputs to fund
the outputs specified in the template.
|
default void |
importAccount(WalletKitOuterClass.ImportAccountRequest request,
io.grpc.stub.StreamObserver<WalletKitOuterClass.ImportAccountResponse> responseObserver)
ImportAccount imports an account backed by an account extended public key.
|
default void |
importPublicKey(WalletKitOuterClass.ImportPublicKeyRequest request,
io.grpc.stub.StreamObserver<WalletKitOuterClass.ImportPublicKeyResponse> responseObserver)
ImportPublicKey imports a public key as watch-only into the wallet.
|
default void |
importTapscript(WalletKitOuterClass.ImportTapscriptRequest request,
io.grpc.stub.StreamObserver<WalletKitOuterClass.ImportTapscriptResponse> responseObserver)
ImportTapscript imports a Taproot script and internal key and adds the
resulting Taproot output key as a watch-only output script into the wallet.
|
default void |
labelTransaction(WalletKitOuterClass.LabelTransactionRequest request,
io.grpc.stub.StreamObserver<WalletKitOuterClass.LabelTransactionResponse> responseObserver)
LabelTransaction adds a label to a transaction.
|
default void |
leaseOutput(WalletKitOuterClass.LeaseOutputRequest request,
io.grpc.stub.StreamObserver<WalletKitOuterClass.LeaseOutputResponse> responseObserver)
LeaseOutput locks an output to the given ID, preventing it from being
available for any future coin selection attempts.
|
default void |
listAccounts(WalletKitOuterClass.ListAccountsRequest request,
io.grpc.stub.StreamObserver<WalletKitOuterClass.ListAccountsResponse> responseObserver)
ListAccounts retrieves all accounts belonging to the wallet by default.
|
default void |
listAddresses(WalletKitOuterClass.ListAddressesRequest request,
io.grpc.stub.StreamObserver<WalletKitOuterClass.ListAddressesResponse> responseObserver)
ListAddresses retrieves all the addresses along with their balance.
|
default void |
listLeases(WalletKitOuterClass.ListLeasesRequest request,
io.grpc.stub.StreamObserver<WalletKitOuterClass.ListLeasesResponse> responseObserver)
ListLeases lists all currently locked utxos.
|
default void |
listSweeps(WalletKitOuterClass.ListSweepsRequest request,
io.grpc.stub.StreamObserver<WalletKitOuterClass.ListSweepsResponse> responseObserver)
ListSweeps returns a list of the sweep transactions our node has produced.
|
default void |
listUnspent(WalletKitOuterClass.ListUnspentRequest request,
io.grpc.stub.StreamObserver<WalletKitOuterClass.ListUnspentResponse> responseObserver)
ListUnspent returns a list of all utxos spendable by the wallet with a
number of confirmations between the specified minimum and maximum.
|
default void |
nextAddr(WalletKitOuterClass.AddrRequest request,
io.grpc.stub.StreamObserver<WalletKitOuterClass.AddrResponse> responseObserver)
NextAddr returns the next unused address within the wallet.
|
default void |
pendingSweeps(WalletKitOuterClass.PendingSweepsRequest request,
io.grpc.stub.StreamObserver<WalletKitOuterClass.PendingSweepsResponse> responseObserver)
PendingSweeps returns lists of on-chain outputs that lnd is currently
attempting to sweep within its central batching engine.
|
default void |
publishTransaction(WalletKitOuterClass.Transaction request,
io.grpc.stub.StreamObserver<WalletKitOuterClass.PublishResponse> responseObserver)
PublishTransaction attempts to publish the passed transaction to the
network.
|
default void |
releaseOutput(WalletKitOuterClass.ReleaseOutputRequest request,
io.grpc.stub.StreamObserver<WalletKitOuterClass.ReleaseOutputResponse> responseObserver)
ReleaseOutput unlocks an output, allowing it to be available for coin
selection if it remains unspent.
|
default void |
requiredReserve(WalletKitOuterClass.RequiredReserveRequest request,
io.grpc.stub.StreamObserver<WalletKitOuterClass.RequiredReserveResponse> responseObserver)
RequiredReserve returns the minimum amount of satoshis that should be kept
in the wallet in order to fee bump anchor channels if necessary.
|
default void |
sendOutputs(WalletKitOuterClass.SendOutputsRequest request,
io.grpc.stub.StreamObserver<WalletKitOuterClass.SendOutputsResponse> responseObserver)
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.
|
default void |
signMessageWithAddr(WalletKitOuterClass.SignMessageWithAddrRequest request,
io.grpc.stub.StreamObserver<WalletKitOuterClass.SignMessageWithAddrResponse> responseObserver)
SignMessageWithAddr returns the compact signature (base64 encoded) created
with the private key of the provided address.
|
default void |
signPsbt(WalletKitOuterClass.SignPsbtRequest request,
io.grpc.stub.StreamObserver<WalletKitOuterClass.SignPsbtResponse> responseObserver)
SignPsbt expects a partial transaction with all inputs and outputs fully
declared and tries to sign all unsigned inputs that have all required fields
(UTXO information, BIP32 derivation information, witness or sig scripts)
set.
|
default void |
verifyMessageWithAddr(WalletKitOuterClass.VerifyMessageWithAddrRequest request,
io.grpc.stub.StreamObserver<WalletKitOuterClass.VerifyMessageWithAddrResponse> responseObserver)
VerifyMessageWithAddr returns the validity and the recovered public key of
the provided compact signature (base64 encoded).
|
default void listUnspent(WalletKitOuterClass.ListUnspentRequest request, io.grpc.stub.StreamObserver<WalletKitOuterClass.ListUnspentResponse> responseObserver)
ListUnspent returns a list of all utxos spendable by the wallet with a number of confirmations between the specified minimum and maximum. By default, all utxos are listed. To list only the unconfirmed utxos, set the unconfirmed_only to true.
default void leaseOutput(WalletKitOuterClass.LeaseOutputRequest request, io.grpc.stub.StreamObserver<WalletKitOuterClass.LeaseOutputResponse> responseObserver)
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`.
default void releaseOutput(WalletKitOuterClass.ReleaseOutputRequest request, io.grpc.stub.StreamObserver<WalletKitOuterClass.ReleaseOutputResponse> responseObserver)
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.
default void listLeases(WalletKitOuterClass.ListLeasesRequest request, io.grpc.stub.StreamObserver<WalletKitOuterClass.ListLeasesResponse> responseObserver)
ListLeases lists all currently locked utxos.
default void deriveNextKey(WalletKitOuterClass.KeyReq request, io.grpc.stub.StreamObserver<SignerOuterClass.KeyDescriptor> responseObserver)
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.
default void deriveKey(SignerOuterClass.KeyLocator request, io.grpc.stub.StreamObserver<SignerOuterClass.KeyDescriptor> responseObserver)
DeriveKey attempts to derive an arbitrary key specified by the passed KeyLocator.
default void nextAddr(WalletKitOuterClass.AddrRequest request, io.grpc.stub.StreamObserver<WalletKitOuterClass.AddrResponse> responseObserver)
NextAddr returns the next unused address within the wallet.
default void listAccounts(WalletKitOuterClass.ListAccountsRequest request, io.grpc.stub.StreamObserver<WalletKitOuterClass.ListAccountsResponse> responseObserver)
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.
default void requiredReserve(WalletKitOuterClass.RequiredReserveRequest request, io.grpc.stub.StreamObserver<WalletKitOuterClass.RequiredReserveResponse> responseObserver)
RequiredReserve returns the minimum amount of satoshis that should be kept in the wallet in order to fee bump anchor channels if necessary. The value scales with the number of public anchor channels but is capped at a maximum.
default void listAddresses(WalletKitOuterClass.ListAddressesRequest request, io.grpc.stub.StreamObserver<WalletKitOuterClass.ListAddressesResponse> responseObserver)
ListAddresses retrieves all the addresses along with their balance. An account name filter can be provided to filter through all of the wallet accounts and return the addresses of only those matching.
default void signMessageWithAddr(WalletKitOuterClass.SignMessageWithAddrRequest request, io.grpc.stub.StreamObserver<WalletKitOuterClass.SignMessageWithAddrResponse> responseObserver)
SignMessageWithAddr returns the compact signature (base64 encoded) created with the private key of the provided address. This requires the address to be solely based on a public key lock (no scripts). Obviously the internal lnd wallet has to possess the private key of the address otherwise an error is returned. This method aims to provide full compatibility with the bitcoin-core and btcd implementation. Bitcoin-core's algorithm is not specified in a BIP and only applicable for legacy addresses. This method enhances the signing for additional address types: P2WKH, NP2WKH, P2TR. For P2TR addresses this represents a special case. ECDSA is used to create a compact signature which makes the public key of the signature recoverable.
default void verifyMessageWithAddr(WalletKitOuterClass.VerifyMessageWithAddrRequest request, io.grpc.stub.StreamObserver<WalletKitOuterClass.VerifyMessageWithAddrResponse> responseObserver)
VerifyMessageWithAddr returns the validity and the recovered public key of the provided compact signature (base64 encoded). The verification is twofold. First the validity of the signature itself is checked and then it is verified that the recovered public key of the signature equals the public key of the provided address. There is no dependence on the private key of the address therefore also external addresses are allowed to verify signatures. Supported address types are P2PKH, P2WKH, NP2WKH, P2TR. This method is the counterpart of the related signing method (SignMessageWithAddr) and aims to provide full compatibility to bitcoin-core's implementation. Although bitcoin-core/btcd only provide this functionality for legacy addresses this function enhances it to the address types: P2PKH, P2WKH, NP2WKH, P2TR. The verification for P2TR addresses is a special case and requires the ECDSA compact signature to compare the reovered public key to the internal taproot key. The compact ECDSA signature format was used because there are still no known compact signature schemes for schnorr signatures.
default void importAccount(WalletKitOuterClass.ImportAccountRequest request, io.grpc.stub.StreamObserver<WalletKitOuterClass.ImportAccountResponse> responseObserver)
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.
default void importPublicKey(WalletKitOuterClass.ImportPublicKeyRequest request, io.grpc.stub.StreamObserver<WalletKitOuterClass.ImportPublicKeyResponse> responseObserver)
ImportPublicKey imports a public key as watch-only into the wallet. The public key is converted into a simple address of the given type and that address script is watched on chain. For Taproot keys, this will only watch the BIP-0086 style output script. Use ImportTapscript for more advanced key spend or script spend outputs. 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.
default void importTapscript(WalletKitOuterClass.ImportTapscriptRequest request, io.grpc.stub.StreamObserver<WalletKitOuterClass.ImportTapscriptResponse> responseObserver)
ImportTapscript imports a Taproot script and internal key and adds the resulting Taproot output key as a watch-only output script into the wallet. For BIP-0086 style Taproot keys (no root hash commitment and no script spend path) use ImportPublicKey. 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. NOTE: Taproot keys imported through this RPC currently _cannot_ be used for funding PSBTs. Only tracking the balance and UTXOs is currently supported.
default void publishTransaction(WalletKitOuterClass.Transaction request, io.grpc.stub.StreamObserver<WalletKitOuterClass.PublishResponse> responseObserver)
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.
default void sendOutputs(WalletKitOuterClass.SendOutputsRequest request, io.grpc.stub.StreamObserver<WalletKitOuterClass.SendOutputsResponse> responseObserver)
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.
default void estimateFee(WalletKitOuterClass.EstimateFeeRequest request, io.grpc.stub.StreamObserver<WalletKitOuterClass.EstimateFeeResponse> responseObserver)
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.
default void pendingSweeps(WalletKitOuterClass.PendingSweepsRequest request, io.grpc.stub.StreamObserver<WalletKitOuterClass.PendingSweepsResponse> responseObserver)
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.
default void bumpFee(WalletKitOuterClass.BumpFeeRequest request, io.grpc.stub.StreamObserver<WalletKitOuterClass.BumpFeeResponse> responseObserver)
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.
default void listSweeps(WalletKitOuterClass.ListSweepsRequest request, io.grpc.stub.StreamObserver<WalletKitOuterClass.ListSweepsResponse> responseObserver)
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.
default void labelTransaction(WalletKitOuterClass.LabelTransactionRequest request, io.grpc.stub.StreamObserver<WalletKitOuterClass.LabelTransactionResponse> responseObserver)
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.
default void fundPsbt(WalletKitOuterClass.FundPsbtRequest request, io.grpc.stub.StreamObserver<WalletKitOuterClass.FundPsbtResponse> responseObserver)
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.
default void signPsbt(WalletKitOuterClass.SignPsbtRequest request, io.grpc.stub.StreamObserver<WalletKitOuterClass.SignPsbtResponse> responseObserver)
SignPsbt expects a partial transaction with all inputs and outputs fully declared and tries to sign all unsigned inputs that have all required fields (UTXO information, BIP32 derivation information, witness or sig scripts) set. If no error is returned, the PSBT is ready to be given to the next signer or to be finalized if lnd was the last signer. NOTE: This RPC only signs inputs (and only those it can sign), it does not perform any other tasks (such as coin selection, UTXO locking or input/output/fee value validation, PSBT finalization). Any input that is incomplete will be skipped.
default void finalizePsbt(WalletKitOuterClass.FinalizePsbtRequest request, io.grpc.stub.StreamObserver<WalletKitOuterClass.FinalizePsbtResponse> responseObserver)
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.