</p></div><dlclass="attributes block"><dt>Annotations</dt><dd><spanclass="name">@AkkaGrpcGenerated</span><spanclass="args">()</span></dd></dl><divclass="toggleContainer"><divclass="toggle block"><span>Linear Supertypes</span><divclass="superTypes hiddenContent"><ahref="../scala/index.html#AnyRef=Object"name="scala.AnyRef"id="scala.AnyRef"class="extmbr">AnyRef</a>, <ahref="https://www.scala-lang.org/api/2.13.12/scala/Any.html#scala.Any"name="scala.Any"id="scala.Any"class="extype">Any</a></div></div></div><divclass="toggleContainer"><divclass="toggle block"><span>Known Subclasses</span><divclass="subClasses hiddenContent"><ahref="WalletKitClient.html"name="walletrpc.WalletKitClient"id="walletrpc.WalletKitClient"class="extype">WalletKitClient</a></div></div></div></div><divid="mbrsel"><divclass="toggle"></div><divid="memberfilter"><iclass="material-icons arrow"></i><spanclass="input"><inputplaceholder="Filter all members"id="mbrsel-input"type="text"accesskey="/"/></span><iclass="clear material-icons"></i></div><divid="filterby"><divid="order"><spanclass="filtertype">Ordering</span><ol><liclass="alpha in"><span>Alphabetic</span></li><liclass="inherit out"><span>By Inheritance</span></li></ol></div><divclass="ancestors"><spanclass="filtertype">Inherited<br/></span><olid="linearization"><liclass="in"name="walletrpc.WalletKit"><span>WalletKit</span></li><liclass="in"name="scala.AnyRef"><span>AnyRef</span></li><liclass="in"name="scala.Any"><span>Any</span></li></ol></div><divclass="ancestors"><spanclass="filtertype"></span><ol><liclass="hideall out"><span>Hide All</span></li><liclass="showall in"><span>Show All</span></li></ol></div><divid="visbl"><spanclass="filtertype">Visibility</span><ol><liclass="public in"><span>Public</span></li><liclass="protected out"><span>Protected</span></li></ol></div></div></div><divid="template"><divid="allMembers"><divclass="values members"><h3>Abstract Value Members</h3><ol><liclass="indented0 "name="walletrpc.WalletKit#bumpFee"group="Ungrouped"fullComment="yes"data-isabs="true"visbl="pub"><aid="bumpFee(in:walletrpc.BumpFeeRequest):scala.concurrent.Future[walletrpc.BumpFeeResponse]"class="anchorToMember"></a><aid="bumpFee(BumpFeeRequest):Future[BumpFeeResponse]"class="anchorToMember"></a><spanclass="permalink"><ahref="../walletrpc/WalletKit.html#bumpFee(in:walletrpc.BumpFeeRequest):scala.concurrent.Future[walletrpc.BumpFeeResponse]"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier">abstract </span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">bumpFee</span><spanclass="params">(<spanname="in">in: <ahref="BumpFeeRequest.html"name="walletrpc.BumpFeeRequest"id="walletrpc.BumpFeeRequest"class="extype">BumpFeeRequest</a></span>)</span><spanclass="result">: <ahref="https://www.scala-lang.org/api/2.13.12/scala/concurrent/Future.html#scala.concurrent.Future"name="scala.concurrent.Future"id="scala.concurrent.Future"class="extype">Future</a>[<ahref="BumpFeeResponse.html"name="walletrpc.BumpFeeResponse"id="walletrpc.BumpFeeResponse"class="extype">BumpFeeResponse</a>]</span></span><pclass="shortcomment cmt">BumpFee bumps the fee of an arbitrary input within a transaction.</p><divclass="fullcomment"><divclass="comment cmt"><p>BumpFee bumps the fee of an arbitrary input within a transaction. This RPC
</p></div></div></li><liclass="indented0 "name="walletrpc.WalletKit#deriveKey"group="Ungrouped"fullComment="no"data-isabs="true"visbl="pub"><aid="deriveKey(in:signrpc.KeyLocator):scala.concurrent.Future[signrpc.KeyDescriptor]"class="anchorToMember"></a><aid="deriveKey(KeyLocator):Future[KeyDescriptor]"class="anchorToMember"></a><spanclass="permalink"><ahref="../walletrpc/WalletKit.html#deriveKey(in:signrpc.KeyLocator):scala.concurrent.Future[signrpc.KeyDescriptor]"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier">abstract </span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">deriveKey</span><spanclass="params">(<spanname="in">in: <ahref="../signrpc/KeyLocator.html"name="signrpc.KeyLocator"id="signrpc.KeyLocator"class="extype">KeyLocator</a></span>)</span><spanclass="result">: <ahref="https://www.scala-lang.org/api/2.13.12/scala/concurrent/Future.html#scala.concurrent.Future"name="scala.concurrent.Future"id="scala.concurrent.Future"class="extype">Future</a>[<ahref="../signrpc/KeyDescriptor.html"name="signrpc.KeyDescriptor"id="signrpc.KeyDescriptor"class="extype">KeyDescriptor</a>]</span></span><pclass="shortcomment cmt">DeriveKey attempts to derive an arbitrary key specified by the passed
KeyLocator.</p></li><liclass="indented0 "name="walletrpc.WalletKit#deriveNextKey"group="Ungrouped"fullComment="yes"data-isabs="true"visbl="pub"><aid="deriveNextKey(in:walletrpc.KeyReq):scala.concurrent.Future[signrpc.KeyDescriptor]"class="anchorToMember"></a><aid="deriveNextKey(KeyReq):Future[KeyDescriptor]"class="anchorToMember"></a><spanclass="permalink"><ahref="../walletrpc/WalletKit.html#deriveNextKey(in:walletrpc.KeyReq):scala.concurrent.Future[signrpc.KeyDescriptor]"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier">abstract </span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">deriveNextKey</span><spanclass="params">(<spanname="in">in: <ahref="KeyReq.html"name="walletrpc.KeyReq"id="walletrpc.KeyReq"class="extype">KeyReq</a></span>)</span><spanclass="result">: <ahref="https://www.scala-lang.org/api/2.13.12/scala/concurrent/Future.html#scala.concurrent.Future"name="scala.concurrent.Future"id="scala.concurrent.Future"class="extype">Future</a>[<ahref="../signrpc/KeyDescriptor.html"name="signrpc.KeyDescriptor"id="signrpc.KeyDescriptor"class="extype">KeyDescriptor</a>]</span></span><pclass="shortcomment cmt">DeriveNextKey attempts to derive the *next* key within the key family
(account in BIP43) specified.</p><divclass="fullcomment"><divclass="comment cmt"><p>DeriveNextKey attempts to derive the *next* key within the key family
(account in BIP43) specified. This method should return the next external
</p></div></div></li><liclass="indented0 "name="walletrpc.WalletKit#estimateFee"group="Ungrouped"fullComment="no"data-isabs="true"visbl="pub"><aid="estimateFee(in:walletrpc.EstimateFeeRequest):scala.concurrent.Future[walletrpc.EstimateFeeResponse]"class="anchorToMember"></a><aid="estimateFee(EstimateFeeRequest):Future[EstimateFeeResponse]"class="anchorToMember"></a><spanclass="permalink"><ahref="../walletrpc/WalletKit.html#estimateFee(in:walletrpc.EstimateFeeRequest):scala.concurrent.Future[walletrpc.EstimateFeeResponse]"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier">abstract </span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">estimateFee</span><spanclass="params">(<spanname="in">in: <ahref="EstimateFeeRequest.html"name="walletrpc.EstimateFeeRequest"id="walletrpc.EstimateFeeRequest"class="extype">EstimateFeeRequest</a></span>)</span><spanclass="result">: <ahref="https://www.scala-lang.org/api/2.13.12/scala/concurrent/Future.html#scala.concurrent.Future"name="scala.concurrent.Future"id="scala.concurrent.Future"class="extype">Future</a>[<ahref="EstimateFeeResponse.html"name="walletrpc.EstimateFeeResponse"id="walletrpc.EstimateFeeResponse"class="extype">EstimateFeeResponse</a>]</span></span><pclass="shortcomment cmt">EstimateFee attempts to query the internal fee estimator of the wallet to
achieve the confirmation target.</p></li><liclass="indented0 "name="walletrpc.WalletKit#finalizePsbt"group="Ungrouped"fullComment="yes"data-isabs="true"visbl="pub"><aid="finalizePsbt(in:walletrpc.FinalizePsbtRequest):scala.concurrent.Future[walletrpc.FinalizePsbtResponse]"class="anchorToMember"></a><aid="finalizePsbt(FinalizePsbtRequest):Future[FinalizePsbtResponse]"class="anchorToMember"></a><spanclass="permalink"><ahref="../walletrpc/WalletKit.html#finalizePsbt(in:walletrpc.FinalizePsbtRequest):scala.concurrent.Future[walletrpc.FinalizePsbtResponse]"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier">abstract </span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">finalizePsbt</span><spanclass="params">(<spanname="in">in: <ahref="FinalizePsbtRequest.html"name="walletrpc.FinalizePsbtRequest"id="walletrpc.FinalizePsbtRequest"class="extype">FinalizePsbtRequest</a></span>)</span><spanclass="result">: <ahref="https://www.scala-lang.org/api/2.13.12/scala/concurrent/Future.html#scala.concurrent.Future"name="scala.concurrent.Future"id="scala.concurrent.Future"class="extype">Future</a>[<ahref="FinalizePsbtResponse.html"name="walletrpc.FinalizePsbtResponse"id="walletrpc.FinalizePsbtResponse"class="extype">FinalizePsbtResponse</a>]</span></span><pclass="shortcomment cmt">FinalizePsbt expects a partial transaction with all inputs and outputs fully
declared and tries to sign all inputs that belong to the wallet.</p><divclass="fullcomment"><divclass="comment cmt"><p>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.
</p></div></div></li><liclass="indented0 "name="walletrpc.WalletKit#fundPsbt"group="Ungrouped"fullComment="yes"data-isabs="true"visbl="pub"><aid="fundPsbt(in:walletrpc.FundPsbtRequest):scala.concurrent.Future[walletrpc.FundPsbtResponse]"class="anchorToMember"></a><aid="fundPsbt(FundPsbtRequest):Future[FundPsbtResponse]"class="anchorToMember"></a><spanclass="permalink"><ahref="../walletrpc/WalletKit.html#fundPsbt(in:walletrpc.FundPsbtRequest):scala.concurrent.Future[walletrpc.FundPsbtResponse]"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier">abstract </span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">fundPsbt</span><spanclass="params">(<spanname="in">in: <ahref="FundPsbtRequest.html"name="walletrpc.FundPsbtRequest"id="walletrpc.FundPsbtRequest"class="extype">FundPsbtRequest</a></span>)</span><spanclass="result">: <ahref="https://www.scala-lang.org/api/2.13.12/scala/concurrent/Future.html#scala.concurrent.Future"name="scala.concurrent.Future"id="scala.concurrent.Future"class="extype">Future</a>[<ahref="FundPsbtResponse.html"name="walletrpc.FundPsbtResponse"id="walletrpc.FundPsbtResponse"class="extype">FundPsbtResponse</a>]</span></span><pclass="shortcomment cmt">FundPsbt creates a fully populated PSBT that contains enough inputs to fund
the outputs specified in the template.</p><divclass="fullcomment"><divclass="comment cmt"><p>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
</p></div></div></li><liclass="indented0 "name="walletrpc.WalletKit#importAccount"group="Ungrouped"fullComment="yes"data-isabs="true"visbl="pub"><aid="importAccount(in:walletrpc.ImportAccountRequest):scala.concurrent.Future[walletrpc.ImportAccountResponse]"class="anchorToMember"></a><aid="importAccount(ImportAccountRequest):Future[ImportAccountResponse]"class="anchorToMember"></a><spanclass="permalink"><ahref="../walletrpc/WalletKit.html#importAccount(in:walletrpc.ImportAccountRequest):scala.concurrent.Future[walletrpc.ImportAccountResponse]"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier">abstract </span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">importAccount</span><spanclass="params">(<spanname="in">in: <ahref="ImportAccountRequest.html"name="walletrpc.ImportAccountRequest"id="walletrpc.ImportAccountRequest"class="extype">ImportAccountRequest</a></span>)</span><spanclass="result">: <ahref="https://www.scala-lang.org/api/2.13.12/scala/concurrent/Future.html#scala.concurrent.Future"name="scala.concurrent.Future"id="scala.concurrent.Future"class="extype">Future</a>[<ahref="ImportAccountResponse.html"name="walletrpc.ImportAccountResponse"id="walletrpc.ImportAccountResponse"class="extype">ImportAccountResponse</a>]</span></span><pclass="shortcomment cmt">ImportAccount imports an account backed by an account extended public key.</p><divclass="fullcomment"><divclass="comment cmt"><p>ImportAccount imports an account backed by an account extended public key.
</p></div></div></li><liclass="indented0 "name="walletrpc.WalletKit#importPublicKey"group="Ungrouped"fullComment="yes"data-isabs="true"visbl="pub"><aid="importPublicKey(in:walletrpc.ImportPublicKeyRequest):scala.concurrent.Future[walletrpc.ImportPublicKeyResponse]"class="anchorToMember"></a><aid="importPublicKey(ImportPublicKeyRequest):Future[ImportPublicKeyResponse]"class="anchorToMember"></a><spanclass="permalink"><ahref="../walletrpc/WalletKit.html#importPublicKey(in:walletrpc.ImportPublicKeyRequest):scala.concurrent.Future[walletrpc.ImportPublicKeyResponse]"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier">abstract </span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">importPublicKey</span><spanclass="params">(<spanname="in">in: <ahref="ImportPublicKeyRequest.html"name="walletrpc.ImportPublicKeyRequest"id="walletrpc.ImportPublicKeyRequest"class="extype">ImportPublicKeyRequest</a></span>)</span><spanclass="result">: <ahref="https://www.scala-lang.org/api/2.13.12/scala/concurrent/Future.html#scala.concurrent.Future"name="scala.concurrent.Future"id="scala.concurrent.Future"class="extype">Future</a>[<ahref="ImportPublicKeyResponse.html"name="walletrpc.ImportPublicKeyResponse"id="walletrpc.ImportPublicKeyResponse"class="extype">ImportPublicKeyResponse</a>]</span></span><pclass="shortcomment cmt">ImportPublicKey imports a public key as watch-only into the wallet.</p><divclass="fullcomment"><divclass="comment cmt"><p>ImportPublicKey imports a public key as watch-only into the wallet. The
</p></div></div></li><liclass="indented0 "name="walletrpc.WalletKit#importTapscript"group="Ungrouped"fullComment="yes"data-isabs="true"visbl="pub"><aid="importTapscript(in:walletrpc.ImportTapscriptRequest):scala.concurrent.Future[walletrpc.ImportTapscriptResponse]"class="anchorToMember"></a><aid="importTapscript(ImportTapscriptRequest):Future[ImportTapscriptResponse]"class="anchorToMember"></a><spanclass="permalink"><ahref="../walletrpc/WalletKit.html#importTapscript(in:walletrpc.ImportTapscriptRequest):scala.concurrent.Future[walletrpc.ImportTapscriptResponse]"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier">abstract </span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">importTapscript</span><spanclass="params">(<spanname="in">in: <ahref="ImportTapscriptRequest.html"name="walletrpc.ImportTapscriptRequest"id="walletrpc.ImportTapscriptRequest"class="extype">ImportTapscriptRequest</a></span>)</span><spanclass="result">: <ahref="https://www.scala-lang.org/api/2.13.12/scala/concurrent/Future.html#scala.concurrent.Future"name="scala.concurrent.Future"id="scala.concurrent.Future"class="extype">Future</a>[<ahref="ImportTapscriptResponse.html"name="walletrpc.ImportTapscriptResponse"id="walletrpc.ImportTapscriptResponse"class="extype">ImportTapscriptResponse</a>]</span></span><pclass="shortcomment cmt">ImportTapscript imports a Taproot script and internal key and adds the
resulting Taproot output key as a watch-only output script into the wallet.</p><divclass="fullcomment"><divclass="comment cmt"><p>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.
</p></div></div></li><liclass="indented0 "name="walletrpc.WalletKit#labelTransaction"group="Ungrouped"fullComment="yes"data-isabs="true"visbl="pub"><aid="labelTransaction(in:walletrpc.LabelTransactionRequest):scala.concurrent.Future[walletrpc.LabelTransactionResponse]"class="anchorToMember"></a><aid="labelTransaction(LabelTransactionRequest):Future[LabelTransactionResponse]"class="anchorToMember"></a><spanclass="permalink"><ahref="../walletrpc/WalletKit.html#labelTransaction(in:walletrpc.LabelTransactionRequest):scala.concurrent.Future[walletrpc.LabelTransactionResponse]"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier">abstract </span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">labelTransaction</span><spanclass="params">(<spanname="in">in: <ahref="LabelTransactionRequest.html"name="walletrpc.LabelTransactionRequest"id="walletrpc.LabelTransactionRequest"class="extype">LabelTransactionRequest</a></span>)</span><spanclass="result">: <ahref="https://www.scala-lang.org/api/2.13.12/scala/concurrent/Future.html#scala.concurrent.Future"name="scala.concurrent.Future"id="scala.concurrent.Future"class="extype">Future</a>[<ahref="LabelTransactionResponse.html"name="walletrpc.LabelTransactionResponse"id="walletrpc.LabelTransactionResponse"class="extype">LabelTransactionResponse</a>]</span></span><pclass="shortcomment cmt">LabelTransaction adds a label to a transaction.</p><divclass="fullcomment"><divclass="comment cmt"><p>LabelTransaction adds a label to a transaction. If the transaction already
</p></div></div></li><liclass="indented0 "name="walletrpc.WalletKit#leaseOutput"group="Ungrouped"fullComment="yes"data-isabs="true"visbl="pub"><aid="leaseOutput(in:walletrpc.LeaseOutputRequest):scala.concurrent.Future[walletrpc.LeaseOutputResponse]"class="anchorToMember"></a><aid="leaseOutput(LeaseOutputRequest):Future[LeaseOutputResponse]"class="anchorToMember"></a><spanclass="permalink"><ahref="../walletrpc/WalletKit.html#leaseOutput(in:walletrpc.LeaseOutputRequest):scala.concurrent.Future[walletrpc.LeaseOutputResponse]"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier">abstract </span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">leaseOutput</span><spanclass="params">(<spanname="in">in: <ahref="LeaseOutputRequest.html"name="walletrpc.LeaseOutputRequest"id="walletrpc.LeaseOutputRequest"class="extype">LeaseOutputRequest</a></span>)</span><spanclass="result">: <ahref="https://www.scala-lang.org/api/2.13.12/scala/concurrent/Future.html#scala.concurrent.Future"name="scala.concurrent.Future"id="scala.concurrent.Future"class="extype">Future</a>[<ahref="LeaseOutputResponse.html"name="walletrpc.LeaseOutputResponse"id="walletrpc.LeaseOutputResponse"class="extype">LeaseOutputResponse</a>]</span></span><pclass="shortcomment cmt">LeaseOutput locks an output to the given ID, preventing it from being
available for any future coin selection attempts.</p><divclass="fullcomment"><divclass="comment cmt"><p>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
</p></div></div></li><liclass="indented0 "name="walletrpc.WalletKit#listAccounts"group="Ungrouped"fullComment="yes"data-isabs="true"visbl="pub"><aid="listAccounts(in:walletrpc.ListAccountsRequest):scala.concurrent.Future[walletrpc.ListAccountsResponse]"class="anchorToMember"></a><aid="listAccounts(ListAccountsRequest):Future[ListAccountsResponse]"class="anchorToMember"></a><spanclass="permalink"><ahref="../walletrpc/WalletKit.html#listAccounts(in:walletrpc.ListAccountsRequest):scala.concurrent.Future[walletrpc.ListAccountsResponse]"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier">abstract </span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">listAccounts</span><spanclass="params">(<spanname="in">in: <ahref="ListAccountsRequest.html"name="walletrpc.ListAccountsRequest"id="walletrpc.ListAccountsRequest"class="extype">ListAccountsRequest</a></span>)</span><spanclass="result">: <ahref="https://www.scala-lang.org/api/2.13.12/scala/concurrent/Future.html#scala.concurrent.Future"name="scala.concurrent.Future"id="scala.concurrent.Future"class="extype">Future</a>[<ahref="ListAccountsResponse.html"name="walletrpc.ListAccountsResponse"id="walletrpc.ListAccountsResponse"class="extype">ListAccountsResponse</a>]</span></span><pclass="shortcomment cmt">ListAccounts retrieves all accounts belonging to the wallet by default.</p><divclass="fullcomment"><divclass="comment cmt"><p>ListAccounts retrieves all accounts belonging to the wallet by default. A
</p></div></div></li><liclass="indented0 "name="walletrpc.WalletKit#listAddresses"group="Ungrouped"fullComment="yes"data-isabs="true"visbl="pub"><aid="listAddresses(in:walletrpc.ListAddressesRequest):scala.concurrent.Future[walletrpc.ListAddressesResponse]"class="anchorToMember"></a><aid="listAddresses(ListAddressesRequest):Future[ListAddressesResponse]"class="anchorToMember"></a><spanclass="permalink"><ahref="../walletrpc/WalletKit.html#listAddresses(in:walletrpc.ListAddressesRequest):scala.concurrent.Future[walletrpc.ListAddressesResponse]"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier">abstract </span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">listAddresses</span><spanclass="params">(<spanname="in">in: <ahref="ListAddressesRequest.html"name="walletrpc.ListAddressesRequest"id="walletrpc.ListAddressesRequest"class="extype">ListAddressesRequest</a></span>)</span><spanclass="result">: <ahref="https://www.scala-lang.org/api/2.13.12/scala/concurrent/Future.html#scala.concurrent.Future"name="scala.concurrent.Future"id="scala.concurrent.Future"class="extype">Future</a>[<ahref="ListAddressesResponse.html"name="walletrpc.ListAddressesResponse"id="walletrpc.ListAddressesResponse"class="extype">ListAddressesResponse</a>]</span></span><pclass="shortcomment cmt">ListAddresses retrieves all the addresses along with their balance.</p><divclass="fullcomment"><divclass="comment cmt"><p>ListAddresses retrieves all the addresses along with their balance. An
</p></div></div></li><liclass="indented0 "name="walletrpc.WalletKit#listLeases"group="Ungrouped"fullComment="no"data-isabs="true"visbl="pub"><aid="listLeases(in:walletrpc.ListLeasesRequest):scala.concurrent.Future[walletrpc.ListLeasesResponse]"class="anchorToMember"></a><aid="listLeases(ListLeasesRequest):Future[ListLeasesResponse]"class="anchorToMember"></a><spanclass="permalink"><ahref="../walletrpc/WalletKit.html#listLeases(in:walletrpc.ListLeasesRequest):scala.concurrent.Future[walletrpc.ListLeasesResponse]"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier">abstract </span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">listLeases</span><spanclass="params">(<spanname="in">in: <ahref="ListLeasesRequest.html"name="walletrpc.ListLeasesRequest"id="walletrpc.ListLeasesRequest"class="extype">ListLeasesRequest</a></span>)</span><spanclass="result">: <ahref="https://www.scala-lang.org/api/2.13.12/scala/concurrent/Future.html#scala.concurrent.Future"name="scala.concurrent.Future"id="scala.concurrent.Future"class="extype">Future</a>[<ahref="ListLeasesResponse.html"name="walletrpc.ListLeasesResponse"id="walletrpc.ListLeasesResponse"class="extype">ListLeasesResponse</a>]</span></span><pclass="shortcomment cmt">ListLeases lists all currently locked utxos.</p></li><liclass="indented0 "name="walletrpc.WalletKit#listSweeps"group="Ungrouped"fullComment="yes"data-isabs="true"visbl="pub"><aid="listSweeps(in:walletrpc.ListSweepsRequest):scala.concurrent.Future[walletrpc.ListSweepsResponse]"class="anchorToMember"></a><aid="listSweeps(ListSweepsRequest):Future[ListSweepsResponse]"class="anchorToMember"></a><spanclass="permalink"><ahref="../walletrpc/WalletKit.html#listSweeps(in:walletrpc.ListSweepsRequest):scala.concurrent.Future[walletrpc.ListSweepsResponse]"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier">abstract </span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">listSweeps</span><spanclass="params">(<spanname="in">in: <ahref="ListSweepsRequest.html"name="walletrpc.ListSweepsRequest"id="walletrpc.ListSweepsRequest"class="extype">ListSweepsRequest</a></span>)</span><spanclass="result">: <ahref="https://www.scala-lang.org/api/2.13.12/scala/concurrent/Future.html#scala.concurrent.Future"name="scala.concurrent.Future"id="scala.concurrent.Future"class="extype">Future</a>[<ahref="ListSweepsResponse.html"name="walletrpc.ListSweepsResponse"id="walletrpc.ListSweepsResponse"class="extype">ListSweepsResponse</a>]</span></span><pclass="shortcomment cmt">ListSweeps returns a list of the sweep transactions our node has produced.</p><divclass="fullcomment"><divclass="comment cmt"><p>ListSweeps returns a list of the sweep transactions our node has produced.
</p></div></div></li><liclass="indented0 "name="walletrpc.WalletKit#listUnspent"group="Ungrouped"fullComment="yes"data-isabs="true"visbl="pub"><aid="listUnspent(in:walletrpc.ListUnspentRequest):scala.concurrent.Future[walletrpc.ListUnspentResponse]"class="anchorToMember"></a><aid="listUnspent(ListUnspentRequest):Future[ListUnspentResponse]"class="anchorToMember"></a><spanclass="permalink"><ahref="../walletrpc/WalletKit.html#listUnspent(in:walletrpc.ListUnspentRequest):scala.concurrent.Future[walletrpc.ListUnspentResponse]"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier">abstract </span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">listUnspent</span><spanclass="params">(<spanname="in">in: <ahref="ListUnspentRequest.html"name="walletrpc.ListUnspentRequest"id="walletrpc.ListUnspentRequest"class="extype">ListUnspentRequest</a></span>)</span><spanclass="result">: <ahref="https://www.scala-lang.org/api/2.13.12/scala/concurrent/Future.html#scala.concurrent.Future"name="scala.concurrent.Future"id="scala.concurrent.Future"class="extype">Future</a>[<ahref="ListUnspentResponse.html"name="walletrpc.ListUnspentResponse"id="walletrpc.ListUnspentResponse"class="extype">ListUnspentResponse</a>]</span></span><pclass="shortcomment cmt">ListUnspent returns a list of all utxos spendable by the wallet with a
number of confirmations between the specified minimum and maximum.</p><divclass="fullcomment"><divclass="comment cmt"><p>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
</p></div></div></li><liclass="indented0 "name="walletrpc.WalletKit#nextAddr"group="Ungrouped"fullComment="no"data-isabs="true"visbl="pub"><aid="nextAddr(in:walletrpc.AddrRequest):scala.concurrent.Future[walletrpc.AddrResponse]"class="anchorToMember"></a><aid="nextAddr(AddrRequest):Future[AddrResponse]"class="anchorToMember"></a><spanclass="permalink"><ahref="../walletrpc/WalletKit.html#nextAddr(in:walletrpc.AddrRequest):scala.concurrent.Future[walletrpc.AddrResponse]"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier">abstract </span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">nextAddr</span><spanclass="params">(<spanname="in">in: <ahref="AddrRequest.html"name="walletrpc.AddrRequest"id="walletrpc.AddrRequest"class="extype">AddrRequest</a></span>)</span><spanclass="result">: <ahref="https://www.scala-lang.org/api/2.13.12/scala/concurrent/Future.html#scala.concurrent.Future"name="scala.concurrent.Future"id="scala.concurrent.Future"class="extype">Future</a>[<ahref="AddrResponse.html"name="walletrpc.AddrResponse"id="walletrpc.AddrResponse"class="extype">AddrResponse</a>]</span></span><pclass="shortcomment cmt">NextAddr returns the next unused address within the wallet.</p></li><liclass="indented0 "name="walletrpc.WalletKit#pendingSweeps"group="Ungrouped"fullComment="yes"data-isabs="true"visbl="pub"><aid="pendingSweeps(in:walletrpc.PendingSweepsRequest):scala.concurrent.Future[walletrpc.PendingSweepsResponse]"class="anchorToMember"></a><aid="pendingSweeps(PendingSweepsRequest):Future[PendingSweepsResponse]"class="anchorToMember"></a><spanclass="permalink"><ahref="../walletrpc/WalletKit.html#pendingSweeps(in:walletrpc.PendingSweepsRequest):scala.concurrent.Future[walletrpc.PendingSweepsResponse]"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier">abstract </span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">pendingSweeps</span><spanclass="params">(<spanname="in">in: <ahref="PendingSweepsRequest.html"name="walletrpc.PendingSweepsRequest"id="walletrpc.PendingSweepsRequest"class="extype">PendingSweepsRequest</a></span>)</span><spanclass="result">: <ahref="https://www.scala-lang.org/api/2.13.12/scala/concurrent/Future.html#scala.concurrent.Future"name="scala.concurrent.Future"id="scala.concurrent.Future"class="extype">Future</a>[<ahref="PendingSweepsResponse.html"name="walletrpc.PendingSweepsResponse"id="walletrpc.PendingSweepsResponse"class="extype">PendingSweepsResponse</a>]</span></span><pclass="shortcomment cmt">PendingSweeps returns lists of on-chain outputs that lnd is currently
attempting to sweep within its central batching engine.</p><divclass="fullcomment"><divclass="comment cmt"><p>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
</p></div></div></li><liclass="indented0 "name="walletrpc.WalletKit#publishTransaction"group="Ungrouped"fullComment="yes"data-isabs="true"visbl="pub"><aid="publishTransaction(in:walletrpc.Transaction):scala.concurrent.Future[walletrpc.PublishResponse]"class="anchorToMember"></a><aid="publishTransaction(Transaction):Future[PublishResponse]"class="anchorToMember"></a><spanclass="permalink"><ahref="../walletrpc/WalletKit.html#publishTransaction(in:walletrpc.Transaction):scala.concurrent.Future[walletrpc.PublishResponse]"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier">abstract </span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">publishTransaction</span><spanclass="params">(<spanname="in">in: <ahref="Transaction.html"name="walletrpc.Transaction"id="walletrpc.Transaction"class="extype">Transaction</a></span>)</span><spanclass="result">: <ahref="https://www.scala-lang.org/api/2.13.12/scala/concurrent/Future.html#scala.concurrent.Future"name="scala.concurrent.Future"id="scala.concurrent.Future"class="extype">Future</a>[<ahref="PublishResponse.html"name="walletrpc.PublishResponse"id="walletrpc.PublishResponse"class="extype">PublishResponse</a>]</span></span><pclass="shortcomment cmt">PublishTransaction attempts to publish the passed transaction to the
</p></div></div></li><liclass="indented0 "name="walletrpc.WalletKit#releaseOutput"group="Ungrouped"fullComment="yes"data-isabs="true"visbl="pub"><aid="releaseOutput(in:walletrpc.ReleaseOutputRequest):scala.concurrent.Future[walletrpc.ReleaseOutputResponse]"class="anchorToMember"></a><aid="releaseOutput(ReleaseOutputRequest):Future[ReleaseOutputResponse]"class="anchorToMember"></a><spanclass="permalink"><ahref="../walletrpc/WalletKit.html#releaseOutput(in:walletrpc.ReleaseOutputRequest):scala.concurrent.Future[walletrpc.ReleaseOutputResponse]"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier">abstract </span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">releaseOutput</span><spanclass="params">(<spanname="in">in: <ahref="ReleaseOutputRequest.html"name="walletrpc.ReleaseOutputRequest"id="walletrpc.ReleaseOutputRequest"class="extype">ReleaseOutputRequest</a></span>)</span><spanclass="result">: <ahref="https://www.scala-lang.org/api/2.13.12/scala/concurrent/Future.html#scala.concurrent.Future"name="scala.concurrent.Future"id="scala.concurrent.Future"class="extype">Future</a>[<ahref="ReleaseOutputResponse.html"name="walletrpc.ReleaseOutputResponse"id="walletrpc.ReleaseOutputResponse"class="extype">ReleaseOutputResponse</a>]</span></span><pclass="shortcomment cmt">ReleaseOutput unlocks an output, allowing it to be available for coin
selection if it remains unspent.</p><divclass="fullcomment"><divclass="comment cmt"><p>ReleaseOutput unlocks an output, allowing it to be available for coin
selection if it remains unspent. The ID should match the one used to
</p></div></div></li><liclass="indented0 "name="walletrpc.WalletKit#requiredReserve"group="Ungrouped"fullComment="yes"data-isabs="true"visbl="pub"><aid="requiredReserve(in:walletrpc.RequiredReserveRequest):scala.concurrent.Future[walletrpc.RequiredReserveResponse]"class="anchorToMember"></a><aid="requiredReserve(RequiredReserveRequest):Future[RequiredReserveResponse]"class="anchorToMember"></a><spanclass="permalink"><ahref="../walletrpc/WalletKit.html#requiredReserve(in:walletrpc.RequiredReserveRequest):scala.concurrent.Future[walletrpc.RequiredReserveResponse]"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier">abstract </span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">requiredReserve</span><spanclass="params">(<spanname="in">in: <ahref="RequiredReserveRequest.html"name="walletrpc.RequiredReserveRequest"id="walletrpc.RequiredReserveRequest"class="extype">RequiredReserveRequest</a></span>)</span><spanclass="result">: <ahref="https://www.scala-lang.org/api/2.13.12/scala/concurrent/Future.html#scala.concurrent.Future"name="scala.concurrent.Future"id="scala.concurrent.Future"class="extype">Future</a>[<ahref="RequiredReserveResponse.html"name="walletrpc.RequiredReserveResponse"id="walletrpc.RequiredReserveResponse"class="extype">RequiredReserveResponse</a>]</span></span><pclass="shortcomment cmt">RequiredReserve returns the minimum amount of satoshis that should be kept
in the wallet in order to fee bump anchor channels if necessary.</p><divclass="fullcomment"><divclass="comment cmt"><p>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.
</p></div></div></li><liclass="indented0 "name="walletrpc.WalletKit#sendOutputs"group="Ungrouped"fullComment="yes"data-isabs="true"visbl="pub"><aid="sendOutputs(in:walletrpc.SendOutputsRequest):scala.concurrent.Future[walletrpc.SendOutputsResponse]"class="anchorToMember"></a><aid="sendOutputs(SendOutputsRequest):Future[SendOutputsResponse]"class="anchorToMember"></a><spanclass="permalink"><ahref="../walletrpc/WalletKit.html#sendOutputs(in:walletrpc.SendOutputsRequest):scala.concurrent.Future[walletrpc.SendOutputsResponse]"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier">abstract </span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">sendOutputs</span><spanclass="params">(<spanname="in">in: <ahref="SendOutputsRequest.html"name="walletrpc.SendOutputsRequest"id="walletrpc.SendOutputsRequest"class="extype">SendOutputsRequest</a></span>)</span><spanclass="result">: <ahref="https://www.scala-lang.org/api/2.13.12/scala/concurrent/Future.html#scala.concurrent.Future"name="scala.concurrent.Future"id="scala.concurrent.Future"class="extype">Future</a>[<ahref="SendOutputsResponse.html"name="walletrpc.SendOutputsResponse"id="walletrpc.SendOutputsResponse"class="extype">SendOutputsResponse</a>]</span></span><pclass="shortcomment cmt">SendOutputs is similar to the existing sendmany call in Bitcoind, and
with the private key of the provided address.</p><divclass="fullcomment"><divclass="comment cmt"><p>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.
</p></div></div></li><liclass="indented0 "name="walletrpc.WalletKit#signPsbt"group="Ungrouped"fullComment="yes"data-isabs="true"visbl="pub"><aid="signPsbt(in:walletrpc.SignPsbtRequest):scala.concurrent.Future[walletrpc.SignPsbtResponse]"class="anchorToMember"></a><aid="signPsbt(SignPsbtRequest):Future[SignPsbtResponse]"class="anchorToMember"></a><spanclass="permalink"><ahref="../walletrpc/WalletKit.html#signPsbt(in:walletrpc.SignPsbtRequest):scala.concurrent.Future[walletrpc.SignPsbtResponse]"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier">abstract </span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">signPsbt</span><spanclass="params">(<spanname="in">in: <ahref="SignPsbtRequest.html"name="walletrpc.SignPsbtRequest"id="walletrpc.SignPsbtRequest"class="extype">SignPsbtRequest</a></span>)</span><spanclass="result">: <ahref="https://www.scala-lang.org/api/2.13.12/scala/concurrent/Future.html#scala.concurrent.Future"name="scala.concurrent.Future"id="scala.concurrent.Future"class="extype">Future</a>[<ahref="SignPsbtResponse.html"name="walletrpc.SignPsbtResponse"id="walletrpc.SignPsbtResponse"class="extype">SignPsbtResponse</a>]</span></span><pclass="shortcomment cmt">SignPsbt expects a partial transaction with all inputs and outputs fully
</p></div></div></li><liclass="indented0 "name="walletrpc.WalletKit#verifyMessageWithAddr"group="Ungrouped"fullComment="yes"data-isabs="true"visbl="pub"><aid="verifyMessageWithAddr(in:walletrpc.VerifyMessageWithAddrRequest):scala.concurrent.Future[walletrpc.VerifyMessageWithAddrResponse]"class="anchorToMember"></a><aid="verifyMessageWithAddr(VerifyMessageWithAddrRequest):Future[VerifyMessageWithAddrResponse]"class="anchorToMember"></a><spanclass="permalink"><ahref="../walletrpc/WalletKit.html#verifyMessageWithAddr(in:walletrpc.VerifyMessageWithAddrRequest):scala.concurrent.Future[walletrpc.VerifyMessageWithAddrResponse]"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier">abstract </span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">verifyMessageWithAddr</span><spanclass="params">(<spanname="in">in: <ahref="VerifyMessageWithAddrRequest.html"name="walletrpc.VerifyMessageWithAddrRequest"id="walletrpc.VerifyMessageWithAddrRequest"class="extype">VerifyMessageWithAddrRequest</a></span>)</span><spanclass="result">: <ahref="https://www.scala-lang.org/api/2.13.12/scala/concurrent/Future.html#scala.concurrent.Future"name="scala.concurrent.Future"id="scala.concurrent.Future"class="extype">Future</a>[<ahref="VerifyMessageWithAddrResponse.html"name="walletrpc.VerifyMessageWithAddrResponse"id="walletrpc.VerifyMessageWithAddrResponse"class="extype">VerifyMessageWithAddrResponse</a>]</span></span><pclass="shortcomment cmt">VerifyMessageWithAddr returns the validity and the recovered public key of
the provided compact signature (base64 encoded).</p><divclass="fullcomment"><divclass="comment cmt"><p>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.