mirrors/bitcoin-s
1
0
Fork 0
mirror of https://github.com/bitcoin-s/bitcoin-s.git synced 2025-03-20 05:53:06 +01:00
Code Issues Projects Releases Packages Wiki Activity
bitcoin-s/api/walletrpc/WalletKit.html

143 lines
75 KiB
HTML
Raw Normal View History

Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
<!DOCTYPE html ><html><head><meta http-equiv="X-UA-Compatible" content="IE=edge"/><meta content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no" name="viewport"/><title></title><meta content="" name="description"/><meta content="" name="keywords"/><meta http-equiv="content-type" content="text/html; charset=UTF-8"/><link href="../lib/index.css" media="screen" type="text/css" rel="stylesheet"/><link href="../lib/template.css" media="screen" type="text/css" rel="stylesheet"/><link href="../lib/print.css" media="print" type="text/css" rel="stylesheet"/><link href="../lib/diagrams.css" media="screen" type="text/css" rel="stylesheet" id="diagrams-css"/><script type="text/javascript" src="../lib/jquery.min.js"></script><script type="text/javascript" src="../lib/index.js"></script><script type="text/javascript" src="../index.js"></script><script type="text/javascript" src="../lib/scheduler.js"></script><script type="text/javascript" src="../lib/template.js"></script><script type="text/javascript">/* this variable can be used by the JS to determine the path to the root document */
Deploy website Deploy website version based on 2a30232181538e19fe10927b2345534617def9d4
2022-10-18 15:12:45 +00:00
var toRoot = '../';</script></head><body><div id="search"><span id="doc-title"><span id="doc-version"></span></span> <span class="close-results"><span class="left">&lt;</span> Back</span><div id="textfilter"><span class="input"><input autocapitalize="none" placeholder="Search" id="index-input" type="text" accesskey="/"/><i class="clear material-icons"></i><i id="search-icon" class="material-icons"></i></span></div></div><div id="search-results"><div id="search-progress"><div id="progress-fill"></div></div><div id="results-content"><div id="entity-results"></div><div id="member-results"></div></div></div><div id="content-scroll-container" style="-webkit-overflow-scrolling: touch;"><div id="content-container" style="-webkit-overflow-scrolling: touch;"><div id="subpackage-spacer"><div id="packages"><h1>Packages</h1><ul><li class="indented0 " name="_root_.root" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="_root_" class="anchorToMember"></a><a id="root:_root_" class="anchorToMember"></a> <span class="permalink"><a href="../index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../index.html" title=""><span class="name">root</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../index.html" name="_root_" id="_root_" class="extype">root</a></dd></dl></div></li><li class="indented1 " name="_root_.walletrpc" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="walletrpc" class="anchorToMember"></a><a id="walletrpc:walletrpc" class="anchorToMember"></a> <span class="permalink"><a href="../walletrpc/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="index.html" title=""><span class="name">walletrpc</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../index.html" name="_root_" id="_root_" class="extype">root</a></dd></dl></div></li><li class="current-entities indented1"><a href="Account$.html" title="" class="object"></a> <a href="Account.html" title="" class="class"></a><a href="Account.html" title="">Account</a></li><li class="current-entities indented1"><a href="AddrRequest$.html" title="" class="object"></a> <a href="AddrRequest.html" title="" class="class"></a><a href="AddrRequest.html" title="">AddrRequest</a></li><li class="current-entities indented1"><a href="AddrResponse$.html" title="" class="object"></a> <a href="AddrResponse.html" title="" class="class"></a><a href="AddrResponse.html" title="">AddrResponse</a></li><li class="current-entities indented1"><a href="AddressType$.html" title="" class="object"></a> <a href="AddressType.html" title="" class="class"></a><a href="AddressType.html" title="">AddressType</a></li><li class="current-entities indented1"><a href="BumpFeeRequest$.html" title="" class="object"></a> <a href="BumpFeeRequest.html" title="" class="class"></a><a href="BumpFeeRequest.html" title="">BumpFeeRequest</a></li><li class="current-entities indented1"><a href="BumpFeeResponse$.html" title="" class="object"></a> <a href="BumpFeeResponse.html" title="" class="class"></a><a href="BumpFeeResponse.html" title="">BumpFeeResponse</a></li><li class="current-entities indented1"><a href="EstimateFeeRequest$.html" title="" class="object"></a> <a href="EstimateFeeRequest.html" title="" class="class"></a><a href="EstimateFeeRequest.html" title="">EstimateFeeRequest</a></li><li class="current-entities indented1"><a href="EstimateFeeResponse$.html" title="" class="object"></a> <a href="EstimateFeeResponse.html" title="" class="class"></a><a href="EstimateFeeResponse.html" title="">EstimateFeeResponse</a></li><li class="current-entities indented1"><a href="FinalizePsbtRequest$.html" title="" class="object"></a> <a href="FinalizePsbtRequest.html" ti
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
daemon's wallet.
Deploy website Deploy website version based on dbd54ca55f9cf28ebd4388a30da85f2a1ff48605
2022-11-16 18:32:38 +00:00
</p></div><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@AkkaGrpcGenerated</span><span class="args">()</span> </dd></dl><div class="toggleContainer"><div class="toggle block"><span>Linear Supertypes</span><div class="superTypes hiddenContent"><a href="../scala/index.html#AnyRef=Object" name="scala.AnyRef" id="scala.AnyRef" class="extmbr">AnyRef</a>, <a href="https://www.scala-lang.org/api/2.13.10/scala/Any.html#scala.Any" name="scala.Any" id="scala.Any" class="extype">Any</a></div></div></div><div class="toggleContainer"><div class="toggle block"><span>Known Subclasses</span><div class="subClasses hiddenContent"><a href="WalletKitClient.html" name="walletrpc.WalletKitClient" id="walletrpc.WalletKitClient" class="extype">WalletKitClient</a></div></div></div></div><div id="mbrsel"><div class="toggle"></div><div id="memberfilter"><i class="material-icons arrow"></i><span class="input"><input placeholder="Filter all members" id="mbrsel-input" type="text" accesskey="/"/></span><i class="clear material-icons"></i></div><div id="filterby"><div id="order"><span class="filtertype">Ordering</span><ol><li class="alpha in"><span>Alphabetic</span></li><li class="inherit out"><span>By Inheritance</span></li></ol></div><div class="ancestors"><span class="filtertype">Inherited<br/></span><ol id="linearization"><li class="in" name="walletrpc.WalletKit"><span>WalletKit</span></li><li class="in" name="scala.AnyRef"><span>AnyRef</span></li><li class="in" name="scala.Any"><span>Any</span></li></ol></div><div class="ancestors"><span class="filtertype"></span><ol><li class="hideall out"><span>Hide All</span></li><li class="showall in"><span>Show All</span></li></ol></div><div id="visbl"><span class="filtertype">Visibility</span><ol><li class="public in"><span>Public</span></li><li class="protected out"><span>Protected</span></li></ol></div></div></div><div id="template"><div id="allMembers"><div class="values members"><h3>Abstract Value Members</h3><ol><li class="indented0 " name="walletrpc.WalletKit#bumpFee" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="bumpFee(in:walletrpc.BumpFeeRequest):scala.concurrent.Future[walletrpc.BumpFeeResponse]" class="anchorToMember"></a><a id="bumpFee(BumpFeeRequest):Future[BumpFeeResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../walletrpc/WalletKit.html#bumpFee(in:walletrpc.BumpFeeRequest):scala.concurrent.Future[walletrpc.BumpFeeResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">bumpFee</span><span class="params">(<span name="in">in: <a href="BumpFeeRequest.html" name="walletrpc.BumpFeeRequest" id="walletrpc.BumpFeeRequest" class="extype">BumpFeeRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.10/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="BumpFeeResponse.html" name="walletrpc.BumpFeeResponse" id="walletrpc.BumpFeeResponse" class="extype">BumpFeeResponse</a>]</span></span><p class="shortcomment cmt">BumpFee bumps the fee of an arbitrary input within a transaction.</p><div class="fullcomment"><div class="comment cmt"><p>BumpFee bumps the fee of an arbitrary input within a transaction. This RPC
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
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.
Deploy website Deploy website version based on dbd54ca55f9cf28ebd4388a30da85f2a1ff48605
2022-11-16 18:32:38 +00:00
</p></div></div></li><li class="indented0 " name="walletrpc.WalletKit#deriveKey" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="deriveKey(in:signrpc.KeyLocator):scala.concurrent.Future[signrpc.KeyDescriptor]" class="anchorToMember"></a><a id="deriveKey(KeyLocator):Future[KeyDescriptor]" class="anchorToMember"></a> <span class="permalink"><a href="../walletrpc/WalletKit.html#deriveKey(in:signrpc.KeyLocator):scala.concurrent.Future[signrpc.KeyDescriptor]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">deriveKey</span><span class="params">(<span name="in">in: <a href="../signrpc/KeyLocator.html" name="signrpc.KeyLocator" id="signrpc.KeyLocator" class="extype">KeyLocator</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.10/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="../signrpc/KeyDescriptor.html" name="signrpc.KeyDescriptor" id="signrpc.KeyDescriptor" class="extype">KeyDescriptor</a>]</span></span><p class="shortcomment cmt">DeriveKey attempts to derive an arbitrary key specified by the passed
KeyLocator.</p></li><li class="indented0 " name="walletrpc.WalletKit#deriveNextKey" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="deriveNextKey(in:walletrpc.KeyReq):scala.concurrent.Future[signrpc.KeyDescriptor]" class="anchorToMember"></a><a id="deriveNextKey(KeyReq):Future[KeyDescriptor]" class="anchorToMember"></a> <span class="permalink"><a href="../walletrpc/WalletKit.html#deriveNextKey(in:walletrpc.KeyReq):scala.concurrent.Future[signrpc.KeyDescriptor]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">deriveNextKey</span><span class="params">(<span name="in">in: <a href="KeyReq.html" name="walletrpc.KeyReq" id="walletrpc.KeyReq" class="extype">KeyReq</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.10/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="../signrpc/KeyDescriptor.html" name="signrpc.KeyDescriptor" id="signrpc.KeyDescriptor" class="extype">KeyDescriptor</a>]</span></span><p class="shortcomment cmt">DeriveNextKey attempts to derive the *next* key within the key family
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
(account in BIP43) specified.</p><div class="fullcomment"><div class="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
child within this branch.
Deploy website Deploy website version based on dbd54ca55f9cf28ebd4388a30da85f2a1ff48605
2022-11-16 18:32:38 +00:00
</p></div></div></li><li class="indented0 " name="walletrpc.WalletKit#estimateFee" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="estimateFee(in:walletrpc.EstimateFeeRequest):scala.concurrent.Future[walletrpc.EstimateFeeResponse]" class="anchorToMember"></a><a id="estimateFee(EstimateFeeRequest):Future[EstimateFeeResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../walletrpc/WalletKit.html#estimateFee(in:walletrpc.EstimateFeeRequest):scala.concurrent.Future[walletrpc.EstimateFeeResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">estimateFee</span><span class="params">(<span name="in">in: <a href="EstimateFeeRequest.html" name="walletrpc.EstimateFeeRequest" id="walletrpc.EstimateFeeRequest" class="extype">EstimateFeeRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.10/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="EstimateFeeResponse.html" name="walletrpc.EstimateFeeResponse" id="walletrpc.EstimateFeeResponse" class="extype">EstimateFeeResponse</a>]</span></span><p class="shortcomment cmt">EstimateFee attempts to query the internal fee estimator of the wallet to
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
determine the fee (in sat/kw) to attach to a transaction in order to
Deploy website Deploy website version based on dbd54ca55f9cf28ebd4388a30da85f2a1ff48605
2022-11-16 18:32:38 +00:00
achieve the confirmation target.</p></li><li class="indented0 " name="walletrpc.WalletKit#finalizePsbt" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="finalizePsbt(in:walletrpc.FinalizePsbtRequest):scala.concurrent.Future[walletrpc.FinalizePsbtResponse]" class="anchorToMember"></a><a id="finalizePsbt(FinalizePsbtRequest):Future[FinalizePsbtResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../walletrpc/WalletKit.html#finalizePsbt(in:walletrpc.FinalizePsbtRequest):scala.concurrent.Future[walletrpc.FinalizePsbtResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">finalizePsbt</span><span class="params">(<span name="in">in: <a href="FinalizePsbtRequest.html" name="walletrpc.FinalizePsbtRequest" id="walletrpc.FinalizePsbtRequest" class="extype">FinalizePsbtRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.10/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="FinalizePsbtResponse.html" name="walletrpc.FinalizePsbtResponse" id="walletrpc.FinalizePsbtResponse" class="extype">FinalizePsbtResponse</a>]</span></span><p class="shortcomment cmt">FinalizePsbt expects a partial transaction with all inputs and outputs fully
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
declared and tries to sign all inputs that belong to the wallet.</p><div class="fullcomment"><div class="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.
Deploy website Deploy website version based on dbd54ca55f9cf28ebd4388a30da85f2a1ff48605
2022-11-16 18:32:38 +00:00
</p></div></div></li><li class="indented0 " name="walletrpc.WalletKit#fundPsbt" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="fundPsbt(in:walletrpc.FundPsbtRequest):scala.concurrent.Future[walletrpc.FundPsbtResponse]" class="anchorToMember"></a><a id="fundPsbt(FundPsbtRequest):Future[FundPsbtResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../walletrpc/WalletKit.html#fundPsbt(in:walletrpc.FundPsbtRequest):scala.concurrent.Future[walletrpc.FundPsbtResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">fundPsbt</span><span class="params">(<span name="in">in: <a href="FundPsbtRequest.html" name="walletrpc.FundPsbtRequest" id="walletrpc.FundPsbtRequest" class="extype">FundPsbtRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.10/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="FundPsbtResponse.html" name="walletrpc.FundPsbtResponse" id="walletrpc.FundPsbtResponse" class="extype">FundPsbtResponse</a>]</span></span><p class="shortcomment cmt">FundPsbt creates a fully populated PSBT that contains enough inputs to fund
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
the outputs specified in the template.</p><div class="fullcomment"><div class="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
an error on the caller's side.
Deploy website Deploy website version based on dbd54ca55f9cf28ebd4388a30da85f2a1ff48605
2022-11-16 18:32:38 +00:00
</p></div></div></li><li class="indented0 " name="walletrpc.WalletKit#importAccount" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="importAccount(in:walletrpc.ImportAccountRequest):scala.concurrent.Future[walletrpc.ImportAccountResponse]" class="anchorToMember"></a><a id="importAccount(ImportAccountRequest):Future[ImportAccountResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../walletrpc/WalletKit.html#importAccount(in:walletrpc.ImportAccountRequest):scala.concurrent.Future[walletrpc.ImportAccountResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">importAccount</span><span class="params">(<span name="in">in: <a href="ImportAccountRequest.html" name="walletrpc.ImportAccountRequest" id="walletrpc.ImportAccountRequest" class="extype">ImportAccountRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.10/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="ImportAccountResponse.html" name="walletrpc.ImportAccountResponse" id="walletrpc.ImportAccountResponse" class="extype">ImportAccountResponse</a>]</span></span><p class="shortcomment cmt">ImportAccount imports an account backed by an account extended public key.</p><div class="fullcomment"><div class="comment cmt"><p>ImportAccount imports an account backed by an account extended public key.
Deploy website Deploy website version based on fafc564da81cf3fcdc739299a215f0a139dbcb7c
2021-06-21 21:43:03 +00:00
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.
Deploy website Deploy website version based on dbd54ca55f9cf28ebd4388a30da85f2a1ff48605
2022-11-16 18:32:38 +00:00
</p></div></div></li><li class="indented0 " name="walletrpc.WalletKit#importPublicKey" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="importPublicKey(in:walletrpc.ImportPublicKeyRequest):scala.concurrent.Future[walletrpc.ImportPublicKeyResponse]" class="anchorToMember"></a><a id="importPublicKey(ImportPublicKeyRequest):Future[ImportPublicKeyResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../walletrpc/WalletKit.html#importPublicKey(in:walletrpc.ImportPublicKeyRequest):scala.concurrent.Future[walletrpc.ImportPublicKeyResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">importPublicKey</span><span class="params">(<span name="in">in: <a href="ImportPublicKeyRequest.html" name="walletrpc.ImportPublicKeyRequest" id="walletrpc.ImportPublicKeyRequest" class="extype">ImportPublicKeyRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.10/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="ImportPublicKeyResponse.html" name="walletrpc.ImportPublicKeyResponse" id="walletrpc.ImportPublicKeyResponse" class="extype">ImportPublicKeyResponse</a>]</span></span><p class="shortcomment cmt">ImportPublicKey imports a public key as watch-only into the wallet.</p><div class="fullcomment"><div class="comment cmt"><p>ImportPublicKey imports a public key as watch-only into the wallet.
Deploy website Deploy website version based on fafc564da81cf3fcdc739299a215f0a139dbcb7c
2021-06-21 21:43:03 +00:00
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.
Deploy website Deploy website version based on dbd54ca55f9cf28ebd4388a30da85f2a1ff48605
2022-11-16 18:32:38 +00:00
</p></div></div></li><li class="indented0 " name="walletrpc.WalletKit#labelTransaction" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="labelTransaction(in:walletrpc.LabelTransactionRequest):scala.concurrent.Future[walletrpc.LabelTransactionResponse]" class="anchorToMember"></a><a id="labelTransaction(LabelTransactionRequest):Future[LabelTransactionResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../walletrpc/WalletKit.html#labelTransaction(in:walletrpc.LabelTransactionRequest):scala.concurrent.Future[walletrpc.LabelTransactionResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">labelTransaction</span><span class="params">(<span name="in">in: <a href="LabelTransactionRequest.html" name="walletrpc.LabelTransactionRequest" id="walletrpc.LabelTransactionRequest" class="extype">LabelTransactionRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.10/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="LabelTransactionResponse.html" name="walletrpc.LabelTransactionResponse" id="walletrpc.LabelTransactionResponse" class="extype">LabelTransactionResponse</a>]</span></span><p class="shortcomment cmt">LabelTransaction adds a label to a transaction.</p><div class="fullcomment"><div class="comment cmt"><p>LabelTransaction adds a label to a transaction. If the transaction already
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
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.
Deploy website Deploy website version based on dbd54ca55f9cf28ebd4388a30da85f2a1ff48605
2022-11-16 18:32:38 +00:00
</p></div></div></li><li class="indented0 " name="walletrpc.WalletKit#leaseOutput" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="leaseOutput(in:walletrpc.LeaseOutputRequest):scala.concurrent.Future[walletrpc.LeaseOutputResponse]" class="anchorToMember"></a><a id="leaseOutput(LeaseOutputRequest):Future[LeaseOutputResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../walletrpc/WalletKit.html#leaseOutput(in:walletrpc.LeaseOutputRequest):scala.concurrent.Future[walletrpc.LeaseOutputResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">leaseOutput</span><span class="params">(<span name="in">in: <a href="LeaseOutputRequest.html" name="walletrpc.LeaseOutputRequest" id="walletrpc.LeaseOutputRequest" class="extype">LeaseOutputRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.10/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="LeaseOutputResponse.html" name="walletrpc.LeaseOutputResponse" id="walletrpc.LeaseOutputResponse" class="extype">LeaseOutputResponse</a>]</span></span><p class="shortcomment cmt">LeaseOutput locks an output to the given ID, preventing it from being
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
available for any future coin selection attempts.</p><div class="fullcomment"><div class="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
expiration through <code>ReleaseOutput</code>.
Deploy website Deploy website version based on dbd54ca55f9cf28ebd4388a30da85f2a1ff48605
2022-11-16 18:32:38 +00:00
</p></div></div></li><li class="indented0 " name="walletrpc.WalletKit#listAccounts" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="listAccounts(in:walletrpc.ListAccountsRequest):scala.concurrent.Future[walletrpc.ListAccountsResponse]" class="anchorToMember"></a><a id="listAccounts(ListAccountsRequest):Future[ListAccountsResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../walletrpc/WalletKit.html#listAccounts(in:walletrpc.ListAccountsRequest):scala.concurrent.Future[walletrpc.ListAccountsResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">listAccounts</span><span class="params">(<span name="in">in: <a href="ListAccountsRequest.html" name="walletrpc.ListAccountsRequest" id="walletrpc.ListAccountsRequest" class="extype">ListAccountsRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.10/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="ListAccountsResponse.html" name="walletrpc.ListAccountsResponse" id="walletrpc.ListAccountsResponse" class="extype">ListAccountsResponse</a>]</span></span><p class="shortcomment cmt">ListAccounts retrieves all accounts belonging to the wallet by default.</p><div class="fullcomment"><div class="comment cmt"><p>ListAccounts retrieves all accounts belonging to the wallet by default. A
Deploy website Deploy website version based on fafc564da81cf3fcdc739299a215f0a139dbcb7c
2021-06-21 21:43:03 +00:00
name and key scope filter can be provided to filter through all of the
wallet accounts and return only those matching.
Deploy website Deploy website version based on dbd54ca55f9cf28ebd4388a30da85f2a1ff48605
2022-11-16 18:32:38 +00:00
</p></div></div></li><li class="indented0 " name="walletrpc.WalletKit#listLeases" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="listLeases(in:walletrpc.ListLeasesRequest):scala.concurrent.Future[walletrpc.ListLeasesResponse]" class="anchorToMember"></a><a id="listLeases(ListLeasesRequest):Future[ListLeasesResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../walletrpc/WalletKit.html#listLeases(in:walletrpc.ListLeasesRequest):scala.concurrent.Future[walletrpc.ListLeasesResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">listLeases</span><span class="params">(<span name="in">in: <a href="ListLeasesRequest.html" name="walletrpc.ListLeasesRequest" id="walletrpc.ListLeasesRequest" class="extype">ListLeasesRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.10/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="ListLeasesResponse.html" name="walletrpc.ListLeasesResponse" id="walletrpc.ListLeasesResponse" class="extype">ListLeasesResponse</a>]</span></span><p class="shortcomment cmt">ListLeases lists all currently locked utxos.</p></li><li class="indented0 " name="walletrpc.WalletKit#listSweeps" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="listSweeps(in:walletrpc.ListSweepsRequest):scala.concurrent.Future[walletrpc.ListSweepsResponse]" class="anchorToMember"></a><a id="listSweeps(ListSweepsRequest):Future[ListSweepsResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../walletrpc/WalletKit.html#listSweeps(in:walletrpc.ListSweepsRequest):scala.concurrent.Future[walletrpc.ListSweepsResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">listSweeps</span><span class="params">(<span name="in">in: <a href="ListSweepsRequest.html" name="walletrpc.ListSweepsRequest" id="walletrpc.ListSweepsRequest" class="extype">ListSweepsRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.10/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="ListSweepsResponse.html" name="walletrpc.ListSweepsResponse" id="walletrpc.ListSweepsResponse" class="extype">ListSweepsResponse</a>]</span></span><p class="shortcomment cmt">ListSweeps returns a list of the sweep transactions our node has produced.</p><div class="fullcomment"><div class="comment cmt"><p>ListSweeps returns a list of the sweep transactions our node has produced.
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
Note that these sweeps may not be confirmed yet, as we record sweeps on
broadcast, not confirmation.
Deploy website Deploy website version based on dbd54ca55f9cf28ebd4388a30da85f2a1ff48605
2022-11-16 18:32:38 +00:00
</p></div></div></li><li class="indented0 " name="walletrpc.WalletKit#listUnspent" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="listUnspent(in:walletrpc.ListUnspentRequest):scala.concurrent.Future[walletrpc.ListUnspentResponse]" class="anchorToMember"></a><a id="listUnspent(ListUnspentRequest):Future[ListUnspentResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../walletrpc/WalletKit.html#listUnspent(in:walletrpc.ListUnspentRequest):scala.concurrent.Future[walletrpc.ListUnspentResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">listUnspent</span><span class="params">(<span name="in">in: <a href="ListUnspentRequest.html" name="walletrpc.ListUnspentRequest" id="walletrpc.ListUnspentRequest" class="extype">ListUnspentRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.10/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="ListUnspentResponse.html" name="walletrpc.ListUnspentResponse" id="walletrpc.ListUnspentResponse" class="extype">ListUnspentResponse</a>]</span></span><p class="shortcomment cmt">ListUnspent returns a list of all utxos spendable by the wallet with a
Deploy website Deploy website version based on 42564bc810874b7f7d77478462b2cc509ba3f079
2022-06-28 15:54:09 +00:00
number of confirmations between the specified minimum and maximum.</p><div class="fullcomment"><div class="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
the unconfirmed_only to true.
Deploy website Deploy website version based on dbd54ca55f9cf28ebd4388a30da85f2a1ff48605
2022-11-16 18:32:38 +00:00
</p></div></div></li><li class="indented0 " name="walletrpc.WalletKit#nextAddr" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="nextAddr(in:walletrpc.AddrRequest):scala.concurrent.Future[walletrpc.AddrResponse]" class="anchorToMember"></a><a id="nextAddr(AddrRequest):Future[AddrResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../walletrpc/WalletKit.html#nextAddr(in:walletrpc.AddrRequest):scala.concurrent.Future[walletrpc.AddrResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">nextAddr</span><span class="params">(<span name="in">in: <a href="AddrRequest.html" name="walletrpc.AddrRequest" id="walletrpc.AddrRequest" class="extype">AddrRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.10/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="AddrResponse.html" name="walletrpc.AddrResponse" id="walletrpc.AddrResponse" class="extype">AddrResponse</a>]</span></span><p class="shortcomment cmt">NextAddr returns the next unused address within the wallet.</p></li><li class="indented0 " name="walletrpc.WalletKit#pendingSweeps" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="pendingSweeps(in:walletrpc.PendingSweepsRequest):scala.concurrent.Future[walletrpc.PendingSweepsResponse]" class="anchorToMember"></a><a id="pendingSweeps(PendingSweepsRequest):Future[PendingSweepsResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../walletrpc/WalletKit.html#pendingSweeps(in:walletrpc.PendingSweepsRequest):scala.concurrent.Future[walletrpc.PendingSweepsResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">pendingSweeps</span><span class="params">(<span name="in">in: <a href="PendingSweepsRequest.html" name="walletrpc.PendingSweepsRequest" id="walletrpc.PendingSweepsRequest" class="extype">PendingSweepsRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.10/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="PendingSweepsResponse.html" name="walletrpc.PendingSweepsResponse" id="walletrpc.PendingSweepsResponse" class="extype">PendingSweepsResponse</a>]</span></span><p class="shortcomment cmt">PendingSweeps returns lists of on-chain outputs that lnd is currently
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
attempting to sweep within its central batching engine.</p><div class="fullcomment"><div class="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
the UtxoSweeper, so things may change.
Deploy website Deploy website version based on dbd54ca55f9cf28ebd4388a30da85f2a1ff48605
2022-11-16 18:32:38 +00:00
</p></div></div></li><li class="indented0 " name="walletrpc.WalletKit#publishTransaction" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="publishTransaction(in:walletrpc.Transaction):scala.concurrent.Future[walletrpc.PublishResponse]" class="anchorToMember"></a><a id="publishTransaction(Transaction):Future[PublishResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../walletrpc/WalletKit.html#publishTransaction(in:walletrpc.Transaction):scala.concurrent.Future[walletrpc.PublishResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">publishTransaction</span><span class="params">(<span name="in">in: <a href="Transaction.html" name="walletrpc.Transaction" id="walletrpc.Transaction" class="extype">Transaction</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.10/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="PublishResponse.html" name="walletrpc.PublishResponse" id="walletrpc.PublishResponse" class="extype">PublishResponse</a>]</span></span><p class="shortcomment cmt">PublishTransaction attempts to publish the passed transaction to the
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
network.</p><div class="fullcomment"><div class="comment cmt"><p>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.
Deploy website Deploy website version based on dbd54ca55f9cf28ebd4388a30da85f2a1ff48605
2022-11-16 18:32:38 +00:00
</p></div></div></li><li class="indented0 " name="walletrpc.WalletKit#releaseOutput" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="releaseOutput(in:walletrpc.ReleaseOutputRequest):scala.concurrent.Future[walletrpc.ReleaseOutputResponse]" class="anchorToMember"></a><a id="releaseOutput(ReleaseOutputRequest):Future[ReleaseOutputResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../walletrpc/WalletKit.html#releaseOutput(in:walletrpc.ReleaseOutputRequest):scala.concurrent.Future[walletrpc.ReleaseOutputResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">releaseOutput</span><span class="params">(<span name="in">in: <a href="ReleaseOutputRequest.html" name="walletrpc.ReleaseOutputRequest" id="walletrpc.ReleaseOutputRequest" class="extype">ReleaseOutputRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.10/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="ReleaseOutputResponse.html" name="walletrpc.ReleaseOutputResponse" id="walletrpc.ReleaseOutputResponse" class="extype">ReleaseOutputResponse</a>]</span></span><p class="shortcomment cmt">ReleaseOutput unlocks an output, allowing it to be available for coin
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
selection if it remains unspent.</p><div class="fullcomment"><div class="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
originally lock the output.
Deploy website Deploy website version based on dbd54ca55f9cf28ebd4388a30da85f2a1ff48605
2022-11-16 18:32:38 +00:00
</p></div></div></li><li class="indented0 " name="walletrpc.WalletKit#requiredReserve" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="requiredReserve(in:walletrpc.RequiredReserveRequest):scala.concurrent.Future[walletrpc.RequiredReserveResponse]" class="anchorToMember"></a><a id="requiredReserve(RequiredReserveRequest):Future[RequiredReserveResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../walletrpc/WalletKit.html#requiredReserve(in:walletrpc.RequiredReserveRequest):scala.concurrent.Future[walletrpc.RequiredReserveResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">requiredReserve</span><span class="params">(<span name="in">in: <a href="RequiredReserveRequest.html" name="walletrpc.RequiredReserveRequest" id="walletrpc.RequiredReserveRequest" class="extype">RequiredReserveRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.10/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="RequiredReserveResponse.html" name="walletrpc.RequiredReserveResponse" id="walletrpc.RequiredReserveResponse" class="extype">RequiredReserveResponse</a>]</span></span><p class="shortcomment cmt">RequiredReserve returns the minimum amount of satoshis that should be kept
Deploy website Deploy website version based on 2a30232181538e19fe10927b2345534617def9d4
2022-10-18 15:12:45 +00:00
in the wallet in order to fee bump anchor channels if necessary.</p><div class="fullcomment"><div class="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.
Deploy website Deploy website version based on dbd54ca55f9cf28ebd4388a30da85f2a1ff48605
2022-11-16 18:32:38 +00:00
</p></div></div></li><li class="indented0 " name="walletrpc.WalletKit#sendOutputs" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="sendOutputs(in:walletrpc.SendOutputsRequest):scala.concurrent.Future[walletrpc.SendOutputsResponse]" class="anchorToMember"></a><a id="sendOutputs(SendOutputsRequest):Future[SendOutputsResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../walletrpc/WalletKit.html#sendOutputs(in:walletrpc.SendOutputsRequest):scala.concurrent.Future[walletrpc.SendOutputsResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">sendOutputs</span><span class="params">(<span name="in">in: <a href="SendOutputsRequest.html" name="walletrpc.SendOutputsRequest" id="walletrpc.SendOutputsRequest" class="extype">SendOutputsRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.10/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="SendOutputsResponse.html" name="walletrpc.SendOutputsResponse" id="walletrpc.SendOutputsResponse" class="extype">SendOutputsResponse</a>]</span></span><p class="shortcomment cmt">SendOutputs is similar to the existing sendmany call in Bitcoind, and
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
allows the caller to create a transaction that sends to several outputs at
once.</p><div class="fullcomment"><div class="comment cmt"><p>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.
Deploy website Deploy website version based on dbd54ca55f9cf28ebd4388a30da85f2a1ff48605
2022-11-16 18:32:38 +00:00
</p></div></div></li><li class="indented0 " name="walletrpc.WalletKit#signPsbt" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="signPsbt(in:walletrpc.SignPsbtRequest):scala.concurrent.Future[walletrpc.SignPsbtResponse]" class="anchorToMember"></a><a id="signPsbt(SignPsbtRequest):Future[SignPsbtResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../walletrpc/WalletKit.html#signPsbt(in:walletrpc.SignPsbtRequest):scala.concurrent.Future[walletrpc.SignPsbtResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">signPsbt</span><span class="params">(<span name="in">in: <a href="SignPsbtRequest.html" name="walletrpc.SignPsbtRequest" id="walletrpc.SignPsbtRequest" class="extype">SignPsbtRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.10/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="SignPsbtResponse.html" name="walletrpc.SignPsbtResponse" id="walletrpc.SignPsbtResponse" class="extype">SignPsbtResponse</a>]</span></span><p class="shortcomment cmt">SignPsbt expects a partial transaction with all inputs and outputs fully
Deploy website Deploy website version based on 142612f0342f3bd1fc9021b72c384bae9b9475ba
2022-02-04 12:38:32 +00:00
declared and tries to sign all unsigned inputs that have all required fields
(UTXO information, BIP32 derivation information, witness or sig scripts)
set.</p><div class="fullcomment"><div class="comment cmt"><p>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.
Deploy website Deploy website version based on dbd54ca55f9cf28ebd4388a30da85f2a1ff48605
2022-11-16 18:32:38 +00:00
</p></div></div></li></ol></div><div class="values members"><h3>Concrete Value Members</h3><ol><li class="indented0 " name="scala.AnyRef#!=" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="!=(x$1:Any):Boolean" class="anchorToMember"></a><a id="!=(Any):Boolean" class="anchorToMember"></a> <span class="permalink"><a href="../walletrpc/WalletKit.html#!=(x$1:Any):Boolean" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name" title="gt4s: $bang$eq">!=</span><span class="params">(<span name="arg0">arg0: <a href="https://www.scala-lang.org/api/2.13.10/scala/Any.html#scala.Any" name="scala.Any" id="scala.Any" class="extype">Any</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.10/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div></li><li class="indented0 " name="scala.AnyRef###" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="##:Int" class="anchorToMember"></a> <span class="permalink"><a href="../walletrpc/WalletKit.html###:Int" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name" title="gt4s: $hash$hash">##</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.10/scala/Int.html#scala.Int" name="scala.Int" id="scala.Int" class="extype">Int</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div></li><li class="indented0 " name="scala.AnyRef#==" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="==(x$1:Any):Boolean" class="anchorToMember"></a><a id="==(Any):Boolean" class="anchorToMember"></a> <span class="permalink"><a href="../walletrpc/WalletKit.html#==(x$1:Any):Boolean" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name" title="gt4s: $eq$eq">==</span><span class="params">(<span name="arg0">arg0: <a href="https://www.scala-lang.org/api/2.13.10/scala/Any.html#scala.Any" name="scala.Any" id="scala.Any" class="extype">Any</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.10/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div></li><li class="indented0 " name="scala.Any#asInstanceOf" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="asInstanceOf[T0]:T0" class="anchorToMember"></a> <span class="permalink"><a href="../walletrpc/WalletKit.html#asInstanceOf[T0]:T0" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">asInstanceOf</span><span class="tparams">[<span name="T0">T0</span>]</span><span class="result">: <span name="scala.Any.asInstanceOf.T0" class="extype">T0</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>Any</dd></dl></div></li><li class="indented0 " name="scala.AnyRef#clone" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="prt"><a id="clone():Object" class="anchorToMember"></a><a id="clone():AnyRef" class="anchorToMember"></a> <span class="permalink"><a href="../walletrpc/WalletKit.html#clone():Object" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</
Reference in a new issue Copy permalink