mirrors/bitcoin-s
1
0
Fork 0
mirror of https://github.com/bitcoin-s/bitcoin-s.git synced 2025-03-13 19:37:30 +01:00
Code Issues Projects Releases Packages Wiki Activity
bitcoin-s/api/org/bitcoins/rpc/client/common/BitcoindRpcClient.html

106 lines
614 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 7ef60866733ead77f03ffc2b836f826b267f899d
2024-04-27 20:12:24 +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_.org" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="org" class="anchorToMember"></a><a id="org:org" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../org/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">org</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="indented2 " name="org.bitcoins" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="bitcoins" class="anchorToMember"></a><a id="bitcoins:bitcoins" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../org/bitcoins/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">bitcoins</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../../../index.html" name="org" id="org" class="extype">org</a></dd></dl></div></li><li class="indented3 " name="org.bitcoins.rpc" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="rpc" class="anchorToMember"></a><a id="rpc:rpc" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../org/bitcoins/rpc/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">rpc</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../../index.html" name="org.bitcoins" id="org.bitcoins" class="extype">bitcoins</a></dd></dl></div></li><li class="indented4 " name="org.bitcoins.rpc.client" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="client" class="anchorToMember"></a><a id="client:client" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../org/bitcoins/rpc/client/index.html" title="Permalink"><i class="material-icons"></i></a>
Deploy website Deploy website version based on afddf73c48d12515d44d11e959ac6d995fdbe61f
2024-04-21 01:15:38 +00:00
Bitcoin Core. It implements RPC calls that are similar across different
versions. If you need RPC calls specific to a version, check out</p><p>If a RPC call fails for any reason, a
Deploy website Deploy website version based on 4471f74ccfff26a07f47b55bea53784a50a2fbe9
2024-10-12 15:10:32 +00:00
<span name="BitcoindException" class="extype">BitcoindException</span> is thrown. This is a sealed abstract
class, so you can pattern match easily on the errors, and handle them as you
see fit.
Deploy website Deploy website version based on a911d53eaec63caec699ee8098acd153677379ad
2025-01-17 15:39:32 +00:00
</p></div><div class="toggleContainer"><div class="toggle block"><span>Linear Supertypes</span><div class="superTypes hiddenContent"><a href="../v20/V20MultisigRpc.html" name="org.bitcoins.rpc.client.v20.V20MultisigRpc" id="org.bitcoins.rpc.client.v20.V20MultisigRpc" class="extype">V20MultisigRpc</a>, <a href="DescriptorRpc.html" name="org.bitcoins.rpc.client.common.DescriptorRpc" id="org.bitcoins.rpc.client.common.DescriptorRpc" class="extype">DescriptorRpc</a>, <a href="../v18/V18AssortedRpc.html" name="org.bitcoins.rpc.client.v18.V18AssortedRpc" id="org.bitcoins.rpc.client.v18.V18AssortedRpc" class="extype">V18AssortedRpc</a>, <a href="UtilRpc.html" name="org.bitcoins.rpc.client.common.UtilRpc" id="org.bitcoins.rpc.client.common.UtilRpc" class="extype">UtilRpc</a>, <a href="PsbtRpc.html" name="org.bitcoins.rpc.client.common.PsbtRpc" id="org.bitcoins.rpc.client.common.PsbtRpc" class="extype">PsbtRpc</a>, <a href="WalletRpc.html" name="org.bitcoins.rpc.client.common.WalletRpc" id="org.bitcoins.rpc.client.common.WalletRpc" class="extype">WalletRpc</a>, <a href="UTXORpc.html" name="org.bitcoins.rpc.client.common.UTXORpc" id="org.bitcoins.rpc.client.common.UTXORpc" class="extype">UTXORpc</a>, <a href="TransactionRpc.html" name="org.bitcoins.rpc.client.common.TransactionRpc" id="org.bitcoins.rpc.client.common.TransactionRpc" class="extype">TransactionRpc</a>, <a href="RawTransactionRpc.html" name="org.bitcoins.rpc.client.common.RawTransactionRpc" id="org.bitcoins.rpc.client.common.RawTransactionRpc" class="extype">RawTransactionRpc</a>, <a href="P2PRpc.html" name="org.bitcoins.rpc.client.common.P2PRpc" id="org.bitcoins.rpc.client.common.P2PRpc" class="extype">P2PRpc</a>, <a href="NodeRpc.html" name="org.bitcoins.rpc.client.common.NodeRpc" id="org.bitcoins.rpc.client.common.NodeRpc" class="extype">NodeRpc</a>, <a href="MultisigRpc.html" name="org.bitcoins.rpc.client.common.MultisigRpc" id="org.bitcoins.rpc.client.common.MultisigRpc" class="extype">MultisigRpc</a>, <a href="MiningRpc.html" name="org.bitcoins.rpc.client.common.MiningRpc" id="org.bitcoins.rpc.client.common.MiningRpc" class="extype">MiningRpc</a>, <a href="MempoolRpc.html" name="org.bitcoins.rpc.client.common.MempoolRpc" id="org.bitcoins.rpc.client.common.MempoolRpc" class="extype">MempoolRpc</a>, <a href="MessageRpc.html" name="org.bitcoins.rpc.client.common.MessageRpc" id="org.bitcoins.rpc.client.common.MessageRpc" class="extype">MessageRpc</a>, <a href="BlockchainRpc.html" name="org.bitcoins.rpc.client.common.BlockchainRpc" id="org.bitcoins.rpc.client.common.BlockchainRpc" class="extype">BlockchainRpc</a>, <a href="../../../core/api/chain/ChainApi.html" name="org.bitcoins.core.api.chain.ChainApi" id="org.bitcoins.core.api.chain.ChainApi" class="extype">ChainApi</a>, <a href="../../../core/api/chain/ChainQueryApi.html" name="org.bitcoins.core.api.chain.ChainQueryApi" id="org.bitcoins.core.api.chain.ChainQueryApi" class="extype">ChainQueryApi</a>, <a href="../../../core/api/node/NodeApi.html" name="org.bitcoins.core.api.node.NodeApi" id="org.bitcoins.core.api.node.NodeApi" class="extype">NodeApi</a>, <a href="../../../core/api/feeprovider/FeeRateApi.html" name="org.bitcoins.core.api.feeprovider.FeeRateApi" id="org.bitcoins.core.api.feeprovider.FeeRateApi" class="extype">FeeRateApi</a>, <a href="Client.html" name="org.bitcoins.rpc.client.common.Client" id="org.bitcoins.rpc.client.common.Client" class="extype">Client</a>, <a href="../../../commons/util/NativeProcessFactory.html" name="org.bitcoins.commons.util.NativeProcessFactory" id="org.bitcoins.commons.util.NativeProcessFactory" class="extype">NativeProcessFactory</a>, <a href="../../../core/util/StartStopAsync.html" name="org.bitcoins.core.util.StartStopAsync" id="org.bitcoins.core.util.StartStopAsync" class="extype">StartStopAsync</a>[<a href="" name="org.bitcoins.rpc.client.common.BitcoindRpcClient" id="org.bitcoins.rpc.client.common.BitcoindRpcClient" class="extype">BitcoindRpcClient</a>], <a href="../../../core/util/StartStop.html" name="org.bitcoins.core.util.StartStop" id="org.bitcoins.core.util.Start
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
</p><div class="fullcomment"><div class="comment cmt"><p>Broadcasts the given transaction over the P2P network
Deploy website Deploy website version based on 0fd33dd4ea0a91c26007191e2cdb2898d325071e
2025-01-16 22:15:49 +00:00
</p></div><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../../core/api/node/NodeApi.html" name="org.bitcoins.core.api.node.NodeApi" id="org.bitcoins.core.api.node.NodeApi" class="extype">NodeApi</a></dd></dl></div></li><li class="indented0 " name="org.bitcoins.rpc.client.common.BitcoindRpcClient#broadcastTransactions" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="broadcastTransactions(transactions:Vector[org.bitcoins.core.protocol.transaction.Transaction]):scala.concurrent.Future[Unit]" class="anchorToMember"></a><a id="broadcastTransactions(Vector[Transaction]):Future[Unit]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../org/bitcoins/rpc/client/common/BitcoindRpcClient.html#broadcastTransactions(transactions:Vector[org.bitcoins.core.protocol.transaction.Transaction]):scala.concurrent.Future[Unit]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">broadcastTransactions</span><span class="params">(<span name="transactions">transactions: <a href="../../../../../scala/index.html#Vector[+A]=scala.collection.immutable.Vector[A]" name="scala.Vector" id="scala.Vector" class="extmbr">Vector</a>[<a href="../../../core/protocol/transaction/Transaction.html" name="org.bitcoins.core.protocol.transaction.Transaction" id="org.bitcoins.core.protocol.transaction.Transaction" class="extype">Transaction</a>]</span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.16/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="https://www.scala-lang.org/api/2.13.16/scala/Unit.html#scala.Unit" name="scala.Unit" id="scala.Unit" class="extype">Unit</a>]</span></span><p class="shortcomment cmt">Broadcasts the given transactions over the P2P network
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
</p><div class="fullcomment"><div class="comment cmt"><p>Broadcasts the given transactions over the P2P network
Deploy website Deploy website version based on 0fd33dd4ea0a91c26007191e2cdb2898d325071e
2025-01-16 22:15:49 +00:00
</p></div><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="" name="org.bitcoins.rpc.client.common.BitcoindRpcClient" id="org.bitcoins.rpc.client.common.BitcoindRpcClient" class="extype">BitcoindRpcClient</a> → <a href="../../../core/api/node/NodeApi.html" name="org.bitcoins.core.api.node.NodeApi" id="org.bitcoins.core.api.node.NodeApi" class="extype">NodeApi</a></dd></dl></div></li><li class="indented0 " name="org.bitcoins.rpc.client.common.Client#buildRequest" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="prt"><a id="buildRequest(instance:org.bitcoins.rpc.config.BitcoindInstance,methodName:String,params:play.api.libs.json.JsArray,uriExtensionOpt:Option[String]):org.apache.pekko.http.scaladsl.model.HttpRequest" class="anchorToMember"></a><a id="buildRequest(BitcoindInstance,String,JsArray,Option[String]):HttpRequest" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../org/bitcoins/rpc/client/common/BitcoindRpcClient.html#buildRequest(instance:org.bitcoins.rpc.config.BitcoindInstance,methodName:String,params:play.api.libs.json.JsArray,uriExtensionOpt:Option[String]):org.apache.pekko.http.scaladsl.model.HttpRequest" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">buildRequest</span><span class="params">(<span name="instance">instance: <a href="../../config/BitcoindInstance.html" name="org.bitcoins.rpc.config.BitcoindInstance" id="org.bitcoins.rpc.config.BitcoindInstance" class="extype">BitcoindInstance</a></span>, <span name="methodName">methodName: <span name="scala.Predef.String" class="extype">String</span></span>, <span name="params">params: <a href="https://www.playframework.com/documentation/latest/api/scala/play/api/libs/json/JsArray.html#play.api.libs.json.JsArray" name="play.api.libs.json.JsArray" id="play.api.libs.json.JsArray" class="extype">JsArray</a></span>, <span name="uriExtensionOpt">uriExtensionOpt: <a href="https://www.scala-lang.org/api/2.13.16/scala/Option.html#scala.Option" name="scala.Option" id="scala.Option" class="extype">Option</a>[<span name="scala.Predef.String" class="extype">String</span>] = <span class="symbol"><span class="name"><a href="../../../../../scala/index.html">None</a></span></span></span>)</span><span class="result">: <a href="https://pekko.apache.org/api/pekko-http/1.1.0/org/apache/pekko/http/scaladsl/model/HttpRequest.html#org.apache.pekko.http.scaladsl.model.HttpRequest" name="org.apache.pekko.http.scaladsl.model.HttpRequest" id="org.apache.pekko.http.scaladsl.model.HttpRequest" class="extype">HttpRequest</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Attributes</dt><dd>protected </dd><dt>Definition Classes</dt><dd><a href="Client.html" name="org.bitcoins.rpc.client.common.Client" id="org.bitcoins.rpc.client.common.Client" class="extype">Client</a></dd></dl></div></li><li class="indented0 " name="org.bitcoins.rpc.client.common.TransactionRpc#bumpFee" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="bumpFee(txid:org.bitcoins.crypto.DoubleSha256Digest,confTarget:Int,totalFee:Option[org.bitcoins.core.currency.Satoshis],replaceable:Boolean,estimateMode:String):scala.concurrent.Future[org.bitcoins.commons.jsonmodels.bitcoind.BumpFeeResult]" class="anchorToMember"></a><a id="bumpFee(DoubleSha256Digest,Int,Option[Satoshis],Boolean,String):Future[BumpFeeResult]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../org/bitcoins/rpc/client/common/BitcoindRpcClient.html#bumpFee(txid:org.bitcoins.crypto.DoubleSha256Digest,confTarget:Int,totalFee:Option[org.bitcoins.core.currency.Satoshis],replaceable:Boolean,estimateMode:String):scala.concurrent.Future[org.bitcoins.commons.jsonmodels.bitcoind.BumpFeeResult]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">
Deploy website Deploy website version based on afddf73c48d12515d44d11e959ac6d995fdbe61f
2024-04-21 01:15:38 +00:00
file is the underlying instance is <span name="BitcoindInstanceLocal" class="extype">BitcoindInstanceLocal</span> and None if
the underlying instance is <span name="BitcoindInstanceRemote" class="extype">BitcoindInstanceRemote</span>
</p><div class="fullcomment"><div class="comment cmt"><p>The configuration file of the Bitcoin Core daemon This returns the conf
file is the underlying instance is <span name="BitcoindInstanceLocal" class="extype">BitcoindInstanceLocal</span> and None if
the underlying instance is <span name="BitcoindInstanceRemote" class="extype">BitcoindInstanceRemote</span>
Deploy website Deploy website version based on 0fd33dd4ea0a91c26007191e2cdb2898d325071e
2025-01-16 22:15:49 +00:00
</p></div><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="Client.html" name="org.bitcoins.rpc.client.common.Client" id="org.bitcoins.rpc.client.common.Client" class="extype">Client</a></dd></dl></div></li><li class="indented0 " name="org.bitcoins.rpc.client.common.PsbtRpc#convertToPsbt" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="convertToPsbt(rawTx:org.bitcoins.core.protocol.transaction.Transaction,permitSigData:Boolean,isWitness:Option[Boolean]):scala.concurrent.Future[org.bitcoins.core.psbt.PSBT]" class="anchorToMember"></a><a id="convertToPsbt(Transaction,Boolean,Option[Boolean]):Future[PSBT]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../org/bitcoins/rpc/client/common/BitcoindRpcClient.html#convertToPsbt(rawTx:org.bitcoins.core.protocol.transaction.Transaction,permitSigData:Boolean,isWitness:Option[Boolean]):scala.concurrent.Future[org.bitcoins.core.psbt.PSBT]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">convertToPsbt</span><span class="params">(<span name="rawTx">rawTx: <a href="../../../core/protocol/transaction/Transaction.html" name="org.bitcoins.core.protocol.transaction.Transaction" id="org.bitcoins.core.protocol.transaction.Transaction" class="extype">Transaction</a></span>, <span name="permitSigData">permitSigData: <a href="https://www.scala-lang.org/api/2.13.16/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a> = <span class="symbol">false</span></span>, <span name="isWitness">isWitness: <a href="https://www.scala-lang.org/api/2.13.16/scala/Option.html#scala.Option" name="scala.Option" id="scala.Option" class="extype">Option</a>[<a href="https://www.scala-lang.org/api/2.13.16/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a>] = <span class="symbol"><span class="name"><a href="../../../../../scala/index.html">None</a></span></span></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.16/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="../../../core/psbt/PSBT.html" name="org.bitcoins.core.psbt.PSBT" id="org.bitcoins.core.psbt.PSBT" class="extype">PSBT</a>]</span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="PsbtRpc.html" name="org.bitcoins.rpc.client.common.PsbtRpc" id="org.bitcoins.rpc.client.common.PsbtRpc" class="extype">PsbtRpc</a></dd></dl></div></li><li class="indented0 " name="org.bitcoins.rpc.client.v20.V20MultisigRpc#createMultiSig" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="createMultiSig(minSignatures:Int,keys:Vector[org.bitcoins.crypto.ECPublicKey],addressType:org.bitcoins.commons.jsonmodels.bitcoind.RpcOpts.AddressType,walletName:String):scala.concurrent.Future[org.bitcoins.commons.jsonmodels.bitcoind.MultiSigResultPostV20]" class="anchorToMember"></a><a id="createMultiSig(Int,Vector[ECPublicKey],AddressType,String):Future[MultiSigResultPostV20]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../org/bitcoins/rpc/client/common/BitcoindRpcClient.html#createMultiSig(minSignatures:Int,keys:Vector[org.bitcoins.crypto.ECPublicKey],addressType:org.bitcoins.commons.jsonmodels.bitcoind.RpcOpts.AddressType,walletName:String):scala.concurrent.Future[org.bitcoins.commons.jsonmodels.bitcoind.MultiSigResultPostV20]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">createMultiSig</span><span class="params">(<span name="minSignatures">minSignatures: <a href="https://www.scala-lang.org/api/2.13.16/scala/Int.html#scala.Int" name="scala.Int" id="scala.Int" class="extype">Int</a></span>, <span name="k
Deploy website Deploy website version based on afddf73c48d12515d44d11e959ac6d995fdbe61f
2024-04-21 01:15:38 +00:00
Not available to versions before v19</p></dd><dt class="param">passphrase</dt><dd class="cmt"><p>
Deploy website Deploy website version based on 0fd33dd4ea0a91c26007191e2cdb2898d325071e
2025-01-16 22:15:49 +00:00
Not available to versions before v19</p></dd></dl><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="WalletRpc.html" name="org.bitcoins.rpc.client.common.WalletRpc" id="org.bitcoins.rpc.client.common.WalletRpc" class="extype">WalletRpc</a></dd></dl></div></li><li class="indented0 " name="org.bitcoins.rpc.client.common.WalletRpc#createWalletDescriptor" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="createWalletDescriptor(addressType:org.bitcoins.commons.jsonmodels.bitcoind.RpcOpts.AddressType,options:Option[org.bitcoins.commons.jsonmodels.bitcoind.RpcOpts.CreateWalletDescriptorOptions],walletName:String):scala.concurrent.Future[org.bitcoins.commons.jsonmodels.bitcoind.CreateWalletDescriptorResult]" class="anchorToMember"></a><a id="createWalletDescriptor(AddressType,Option[CreateWalletDescriptorOptions],String):Future[CreateWalletDescriptorResult]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../org/bitcoins/rpc/client/common/BitcoindRpcClient.html#createWalletDescriptor(addressType:org.bitcoins.commons.jsonmodels.bitcoind.RpcOpts.AddressType,options:Option[org.bitcoins.commons.jsonmodels.bitcoind.RpcOpts.CreateWalletDescriptorOptions],walletName:String):scala.concurrent.Future[org.bitcoins.commons.jsonmodels.bitcoind.CreateWalletDescriptorResult]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">createWalletDescriptor</span><span class="params">(<span name="addressType">addressType: <a href="../../../commons/jsonmodels/bitcoind/RpcOpts$$AddressType.html" name="org.bitcoins.commons.jsonmodels.bitcoind.RpcOpts.AddressType" id="org.bitcoins.commons.jsonmodels.bitcoind.RpcOpts.AddressType" class="extype">AddressType</a></span>, <span name="options">options: <a href="https://www.scala-lang.org/api/2.13.16/scala/Option.html#scala.Option" name="scala.Option" id="scala.Option" class="extype">Option</a>[<a href="../../../commons/jsonmodels/bitcoind/RpcOpts$$CreateWalletDescriptorOptions.html" name="org.bitcoins.commons.jsonmodels.bitcoind.RpcOpts.CreateWalletDescriptorOptions" id="org.bitcoins.commons.jsonmodels.bitcoind.RpcOpts.CreateWalletDescriptorOptions" class="extype">CreateWalletDescriptorOptions</a>] = <span class="symbol"><span class="name"><a href="../../../../../scala/index.html">None</a></span></span></span>, <span name="walletName">walletName: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">DEFAULT_WALLET</span></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.16/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="../../../commons/jsonmodels/bitcoind/CreateWalletDescriptorResult.html" name="org.bitcoins.commons.jsonmodels.bitcoind.CreateWalletDescriptorResult" id="org.bitcoins.commons.jsonmodels.bitcoind.CreateWalletDescriptorResult" class="extype">CreateWalletDescriptorResult</a>]</span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="WalletRpc.html" name="org.bitcoins.rpc.client.common.WalletRpc" id="org.bitcoins.rpc.client.common.WalletRpc" class="extype">WalletRpc</a></dd></dl></div></li><li class="indented0 " name="org.bitcoins.rpc.client.common.PsbtRpc#decodePsbt" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="decodePsbt(psbt:org.bitcoins.core.psbt.PSBT):scala.concurrent.Future[org.bitcoins.commons.jsonmodels.bitcoind.DecodePsbtResult]" class="anchorToMember"></a><a id="decodePsbt(PSBT):Future[DecodePsbtResult]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../org/bitcoins/rpc/client/common/BitcoindRpcClient.html#decodePsbt(psbt:org.bitcoins.core.psbt.PSBT):scala.concurrent.Future[org.bitcoins.commons.jsonmodels.bitcoind.DecodePsbtResult]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifie
Deploy website Deploy website version based on afddf73c48d12515d44d11e959ac6d995fdbe61f
2024-04-21 01:15:38 +00:00
and feed the blocks to <a href="../../../node/NodeCallbacks.html" name="org.bitcoins.node.NodeCallbacks" id="org.bitcoins.node.NodeCallbacks" class="extype">org.bitcoins.node.NodeCallbacks</a>.</p><div class="fullcomment"><div class="comment cmt"><p>Request the underlying node to download the given blocks from its peers
and feed the blocks to <a href="../../../node/NodeCallbacks.html" name="org.bitcoins.node.NodeCallbacks" id="org.bitcoins.node.NodeCallbacks" class="extype">org.bitcoins.node.NodeCallbacks</a>.
Deploy website Deploy website version based on 0fd33dd4ea0a91c26007191e2cdb2898d325071e
2025-01-16 22:15:49 +00:00
</p></div><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="" name="org.bitcoins.rpc.client.common.BitcoindRpcClient" id="org.bitcoins.rpc.client.common.BitcoindRpcClient" class="extype">BitcoindRpcClient</a> → <a href="../../../core/api/node/NodeApi.html" name="org.bitcoins.core.api.node.NodeApi" id="org.bitcoins.core.api.node.NodeApi" class="extype">NodeApi</a></dd></dl></div></li><li class="indented0 " name="org.bitcoins.rpc.client.common.UTXORpc#dumpTxOutSet" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="dumpTxOutSet(path:java.nio.file.Path):scala.concurrent.Future[org.bitcoins.commons.jsonmodels.bitcoind.DumpTxOutSetResult]" class="anchorToMember"></a><a id="dumpTxOutSet(Path):Future[DumpTxOutSetResult]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../org/bitcoins/rpc/client/common/BitcoindRpcClient.html#dumpTxOutSet(path:java.nio.file.Path):scala.concurrent.Future[org.bitcoins.commons.jsonmodels.bitcoind.DumpTxOutSetResult]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">dumpTxOutSet</span><span class="params">(<span name="path">path: <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html#java.nio.file.Path" name="java.nio.file.Path" id="java.nio.file.Path" class="extype">Path</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.16/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="../../../commons/jsonmodels/bitcoind/DumpTxOutSetResult.html" name="org.bitcoins.commons.jsonmodels.bitcoind.DumpTxOutSetResult" id="org.bitcoins.commons.jsonmodels.bitcoind.DumpTxOutSetResult" class="extype">DumpTxOutSetResult</a>]</span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="UTXORpc.html" name="org.bitcoins.rpc.client.common.UTXORpc" id="org.bitcoins.rpc.client.common.UTXORpc" class="extype">UTXORpc</a></dd></dl></div></li><li class="indented0 " name="org.bitcoins.rpc.client.common.Client#eCPrivateKeyBytesWrites" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="eCPrivateKeyBytesWrites:play.api.libs.json.Writes[org.bitcoins.crypto.ECPrivateKeyBytes]" class="anchorToMember"></a><a id="eCPrivateKeyBytesWrites:Writes[ECPrivateKeyBytes]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../org/bitcoins/rpc/client/common/BitcoindRpcClient.html#eCPrivateKeyBytesWrites:play.api.libs.json.Writes[org.bitcoins.crypto.ECPrivateKeyBytes]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">implicit </span> <span class="kind">val</span></span> <span class="symbol"><span class="name">eCPrivateKeyBytesWrites</span><span class="result">: <a href="https://www.playframework.com/documentation/latest/api/scala/play/api/libs/json/Writes.html#play.api.libs.json.Writes" name="play.api.libs.json.Writes" id="play.api.libs.json.Writes" class="extype">Writes</a>[<a href="../../../crypto/ECPrivateKeyBytes.html" name="org.bitcoins.crypto.ECPrivateKeyBytes" id="org.bitcoins.crypto.ECPrivateKeyBytes" class="extype">ECPrivateKeyBytes</a>]</span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="Client.html" name="org.bitcoins.rpc.client.common.Client" id="org.bitcoins.rpc.client.common.Client" class="extype">Client</a></dd></dl></div></li><li class="indented0 " name="org.bitcoins.rpc.client.common.Client#eCPrivateKeyWrites" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="eCPrivateKeyWrites:play.api.libs.json.Writes[org.bitcoins.crypto.ECPrivateKey]" class="anchorToMember"></a><a id="eCPrivateKeyWrites:Writes[ECPrivateKey]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../org/bitcoins/rpc/client/common/BitcoindRpcClient.html#
Deploy website Deploy website version based on afddf73c48d12515d44d11e959ac6d995fdbe61f
2024-04-21 01:15:38 +00:00
means in practice is the latest filter header we have received from our
peer.</p><div class="fullcomment"><div class="comment cmt"><p>Finds the "best" filter header we have stored in our database What this
means in practice is the latest filter header we have received from our
peer. Returns none if we have no filters in the database
Deploy website Deploy website version based on 0fd33dd4ea0a91c26007191e2cdb2898d325071e
2025-01-16 22:15:49 +00:00
</p></div><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="BlockchainRpc.html" name="org.bitcoins.rpc.client.common.BlockchainRpc" id="org.bitcoins.rpc.client.common.BlockchainRpc" class="extype">BlockchainRpc</a> → <a href="../../../core/api/chain/ChainApi.html" name="org.bitcoins.core.api.chain.ChainApi" id="org.bitcoins.core.api.chain.ChainApi" class="extype">ChainApi</a></dd></dl></div></li><li class="indented0 " name="org.bitcoins.core.api.chain.ChainQueryApi#getBestHashBlockHeight" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="getBestHashBlockHeight()(implicitec:scala.concurrent.ExecutionContext):scala.concurrent.Future[Int]" class="anchorToMember"></a><a id="getBestHashBlockHeight()(ExecutionContext):Future[Int]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../org/bitcoins/rpc/client/common/BitcoindRpcClient.html#getBestHashBlockHeight()(implicitec:scala.concurrent.ExecutionContext):scala.concurrent.Future[Int]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">getBestHashBlockHeight</span><span class="params">()</span><span class="params">(<span class="implicit">implicit </span><span name="ec">ec: <a href="https://www.scala-lang.org/api/2.13.16/scala/concurrent/ExecutionContext.html#scala.concurrent.ExecutionContext" name="scala.concurrent.ExecutionContext" id="scala.concurrent.ExecutionContext" class="extype">ExecutionContext</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.16/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="https://www.scala-lang.org/api/2.13.16/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><a href="../../../core/api/chain/ChainQueryApi.html" name="org.bitcoins.core.api.chain.ChainQueryApi" id="org.bitcoins.core.api.chain.ChainQueryApi" class="extype">ChainQueryApi</a></dd></dl></div></li><li class="indented0 " name="org.bitcoins.rpc.client.common.BlockchainRpc#getBlock" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="getBlock(headerHash:org.bitcoins.crypto.DoubleSha256Digest):scala.concurrent.Future[org.bitcoins.commons.jsonmodels.bitcoind.GetBlockResult]" class="anchorToMember"></a><a id="getBlock(DoubleSha256Digest):Future[GetBlockResult]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../org/bitcoins/rpc/client/common/BitcoindRpcClient.html#getBlock(headerHash:org.bitcoins.crypto.DoubleSha256Digest):scala.concurrent.Future[org.bitcoins.commons.jsonmodels.bitcoind.GetBlockResult]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">getBlock</span><span class="params">(<span name="headerHash">headerHash: <a href="../../../crypto/DoubleSha256Digest.html" name="org.bitcoins.crypto.DoubleSha256Digest" id="org.bitcoins.crypto.DoubleSha256Digest" class="extype">DoubleSha256Digest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.16/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="../../../commons/jsonmodels/bitcoind/GetBlockResult.html" name="org.bitcoins.commons.jsonmodels.bitcoind.GetBlockResult" id="org.bitcoins.commons.jsonmodels.bitcoind.GetBlockResult" class="extype">GetBlockResult</a>]</span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="BlockchainRpc.html" name="org.bitcoins.rpc.client.common.BlockchainRpc" id="org.bitcoins.rpc.client.common.BlockchainRpc" class="extype">BlockchainRpc</a></dd></dl></div></li><li class=
</p></div><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="BlockchainRpc.html" name="org.bitcoins.rpc.client.common.BlockchainRpc" id="org.bitcoins.rpc.client.common.BlockchainRpc" class="extype">BlockchainRpc</a> → <a href="../../../core/api/chain/ChainApi.html" name="org.bitcoins.core.api.chain.ChainApi" id="org.bitcoins.core.api.chain.ChainApi" class="extype">ChainApi</a></dd></dl></div></li><li class="indented0 " name="org.bitcoins.rpc.client.common.BlockchainRpc#getFilterCount" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="getFilterCount():scala.concurrent.Future[Int]" class="anchorToMember"></a><a id="getFilterCount():Future[Int]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../org/bitcoins/rpc/client/common/BitcoindRpcClient.html#getFilterCount():scala.concurrent.Future[Int]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">getFilterCount</span><span class="params">()</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.16/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="https://www.scala-lang.org/api/2.13.16/scala/Int.html#scala.Int" name="scala.Int" id="scala.Int" class="extype">Int</a>]</span></span><p class="shortcomment cmt">Gets the number of compact filters in the database</p><div class="fullcomment"><div class="comment cmt"><p>Gets the number of compact filters in the database</p></div><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="BlockchainRpc.html" name="org.bitcoins.rpc.client.common.BlockchainRpc" id="org.bitcoins.rpc.client.common.BlockchainRpc" class="extype">BlockchainRpc</a> → <a href="../../../core/api/chain/ChainApi.html" name="org.bitcoins.core.api.chain.ChainApi" id="org.bitcoins.core.api.chain.ChainApi" class="extype">ChainApi</a> → <a href="../../../core/api/chain/ChainQueryApi.html" name="org.bitcoins.core.api.chain.ChainQueryApi" id="org.bitcoins.core.api.chain.ChainQueryApi" class="extype">ChainQueryApi</a></dd></dl></div></li><li class="indented0 " name="org.bitcoins.rpc.client.common.BlockchainRpc#getFilterHeader" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="getFilterHeader(blockHash:org.bitcoins.crypto.DoubleSha256DigestBE):scala.concurrent.Future[Option[org.bitcoins.core.api.chain.db.CompactFilterHeaderDb]]" class="anchorToMember"></a><a id="getFilterHeader(DoubleSha256DigestBE):Future[Option[CompactFilterHeaderDb]]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../org/bitcoins/rpc/client/common/BitcoindRpcClient.html#getFilterHeader(blockHash:org.bitcoins.crypto.DoubleSha256DigestBE):scala.concurrent.Future[Option[org.bitcoins.core.api.chain.db.CompactFilterHeaderDb]]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">getFilterHeader</span><span class="params">(<span name="blockHash">blockHash: <a href="../../../crypto/DoubleSha256DigestBE.html" name="org.bitcoins.crypto.DoubleSha256DigestBE" id="org.bitcoins.crypto.DoubleSha256DigestBE" class="extype">DoubleSha256DigestBE</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.16/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="https://www.scala-lang.org/api/2.13.16/scala/Option.html#scala.Option" name="scala.Option" id="scala.Option" class="extype">Option</a>[<a href="../../../core/api/chain/db/CompactFilterHeaderDb.html" name="org.bitcoins.core.api.chain.db.CompactFilterHeaderDb" id="org.bitcoins.core.api.chain.db.CompactFilterHeaderDb" class="extype">CompactFilterHeaderDb</a>]]</span></span><p class="shortcomment cmt">Looks up a com
</p></div><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="BlockchainRpc.html" name="org.bitcoins.rpc.client.common.BlockchainRpc" id="org.bitcoins.rpc.client.common.BlockchainRpc" class="extype">BlockchainRpc</a> → <a href="../../../core/api/chain/ChainApi.html" name="org.bitcoins.core.api.chain.ChainApi" id="org.bitcoins.core.api.chain.ChainApi" class="extype">ChainApi</a></dd></dl></div></li><li class="indented0 " name="org.bitcoins.rpc.client.common.BlockchainRpc#getFilterHeaderCount" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="getFilterHeaderCount():scala.concurrent.Future[Int]" class="anchorToMember"></a><a id="getFilterHeaderCount():Future[Int]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../org/bitcoins/rpc/client/common/BitcoindRpcClient.html#getFilterHeaderCount():scala.concurrent.Future[Int]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">getFilterHeaderCount</span><span class="params">()</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.16/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="https://www.scala-lang.org/api/2.13.16/scala/Int.html#scala.Int" name="scala.Int" id="scala.Int" class="extype">Int</a>]</span></span><p class="shortcomment cmt">Gets the number of compact filter headers in the database</p><div class="fullcomment"><div class="comment cmt"><p>Gets the number of compact filter headers in the database</p></div><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="BlockchainRpc.html" name="org.bitcoins.rpc.client.common.BlockchainRpc" id="org.bitcoins.rpc.client.common.BlockchainRpc" class="extype">BlockchainRpc</a> → <a href="../../../core/api/chain/ChainApi.html" name="org.bitcoins.core.api.chain.ChainApi" id="org.bitcoins.core.api.chain.ChainApi" class="extype">ChainApi</a></dd></dl></div></li><li class="indented0 " name="org.bitcoins.rpc.client.common.BlockchainRpc#getFilterHeadersAtHeight" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="getFilterHeadersAtHeight(height:Int):scala.concurrent.Future[Vector[org.bitcoins.core.api.chain.db.CompactFilterHeaderDb]]" class="anchorToMember"></a><a id="getFilterHeadersAtHeight(Int):Future[Vector[CompactFilterHeaderDb]]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../org/bitcoins/rpc/client/common/BitcoindRpcClient.html#getFilterHeadersAtHeight(height:Int):scala.concurrent.Future[Vector[org.bitcoins.core.api.chain.db.CompactFilterHeaderDb]]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">getFilterHeadersAtHeight</span><span class="params">(<span name="height">height: <a href="https://www.scala-lang.org/api/2.13.16/scala/Int.html#scala.Int" name="scala.Int" id="scala.Int" class="extype">Int</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.16/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="../../../../../scala/index.html#Vector[+A]=scala.collection.immutable.Vector[A]" name="scala.Vector" id="scala.Vector" class="extmbr">Vector</a>[<a href="../../../core/api/chain/db/CompactFilterHeaderDb.html" name="org.bitcoins.core.api.chain.db.CompactFilterHeaderDb" id="org.bitcoins.core.api.chain.db.CompactFilterHeaderDb" class="extype">CompactFilterHeaderDb</a>]]</span></span><p class="shortcomment cmt">Looks up a compact filter header by its height.</p><div class="fullcomment"><div class="comment cmt"><p>Looks up a compact filter header by its height.
</p></div><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="BlockchainRpc.html" name="org.bitcoins.rpc.client.common.BlockchainRpc" id="org.bitcoins.rpc.client.common.BlockchainRpc" class="extype">BlockchainRpc</a> → <a href="../../../core/api/chain/ChainApi.html" name="org.bitcoins.core.api.chain.ChainApi" id="org.bitcoins.core.api.chain.ChainApi" class="extype">ChainApi</a></dd></dl></div></li><li class="indented0 " name="org.bitcoins.rpc.client.common.BlockchainRpc#getFiltersAtHeight" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="getFiltersAtHeight(height:Int):scala.concurrent.Future[Vector[org.bitcoins.core.api.chain.db.CompactFilterDb]]" class="anchorToMember"></a><a id="getFiltersAtHeight(Int):Future[Vector[CompactFilterDb]]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../org/bitcoins/rpc/client/common/BitcoindRpcClient.html#getFiltersAtHeight(height:Int):scala.concurrent.Future[Vector[org.bitcoins.core.api.chain.db.CompactFilterDb]]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">getFiltersAtHeight</span><span class="params">(<span name="height">height: <a href="https://www.scala-lang.org/api/2.13.16/scala/Int.html#scala.Int" name="scala.Int" id="scala.Int" class="extype">Int</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.16/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="../../../../../scala/index.html#Vector[+A]=scala.collection.immutable.Vector[A]" name="scala.Vector" id="scala.Vector" class="extmbr">Vector</a>[<a href="../../../core/api/chain/db/CompactFilterDb.html" name="org.bitcoins.core.api.chain.db.CompactFilterDb" id="org.bitcoins.core.api.chain.db.CompactFilterDb" class="extype">CompactFilterDb</a>]]</span></span><p class="shortcomment cmt">Looks up a compact filter by its height.</p><div class="fullcomment"><div class="comment cmt"><p>Looks up a compact filter by its height.
</p></div><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="BlockchainRpc.html" name="org.bitcoins.rpc.client.common.BlockchainRpc" id="org.bitcoins.rpc.client.common.BlockchainRpc" class="extype">BlockchainRpc</a> → <a href="../../../core/api/chain/ChainApi.html" name="org.bitcoins.core.api.chain.ChainApi" id="org.bitcoins.core.api.chain.ChainApi" class="extype">ChainApi</a></dd></dl></div></li><li class="indented0 " name="org.bitcoins.rpc.client.common.BlockchainRpc#getFiltersBetweenHeights" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="getFiltersBetweenHeights(startHeight:Int,endHeight:Int):scala.concurrent.Future[Vector[org.bitcoins.core.api.chain.ChainQueryApi.FilterResponse]]" class="anchorToMember"></a><a id="getFiltersBetweenHeights(Int,Int):Future[Vector[FilterResponse]]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../org/bitcoins/rpc/client/common/BitcoindRpcClient.html#getFiltersBetweenHeights(startHeight:Int,endHeight:Int):scala.concurrent.Future[Vector[org.bitcoins.core.api.chain.ChainQueryApi.FilterResponse]]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">getFiltersBetweenHeights</span><span class="params">(<span name="startHeight">startHeight: <a href="https://www.scala-lang.org/api/2.13.16/scala/Int.html#scala.Int" name="scala.Int" id="scala.Int" class="extype">Int</a></span>, <span name="endHeight">endHeight: <a href="https://www.scala-lang.org/api/2.13.16/scala/Int.html#scala.Int" name="scala.Int" id="scala.Int" class="extype">Int</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.16/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="../../../../../scala/index.html#Vector[+A]=scala.collection.immutable.Vector[A]" name="scala.Vector" id="scala.Vector" class="extmbr">Vector</a>[<a href="../../../core/api/chain/ChainQueryApi$$FilterResponse.html" name="org.bitcoins.core.api.chain.ChainQueryApi.FilterResponse" id="org.bitcoins.core.api.chain.ChainQueryApi.FilterResponse" class="extype">FilterResponse</a>]]</span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="BlockchainRpc.html" name="org.bitcoins.rpc.client.common.BlockchainRpc" id="org.bitcoins.rpc.client.common.BlockchainRpc" class="extype">BlockchainRpc</a> → <a href="../../../core/api/chain/ChainQueryApi.html" name="org.bitcoins.core.api.chain.ChainQueryApi" id="org.bitcoins.core.api.chain.ChainQueryApi" class="extype">ChainQueryApi</a></dd></dl></div></li><li class="indented0 " name="org.bitcoins.rpc.client.common.WalletRpc#getHDKeys" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="getHDKeys(walletName:String):scala.concurrent.Future[Vector[org.bitcoins.commons.jsonmodels.bitcoind.GetHDKeysResult]]" class="anchorToMember"></a><a id="getHDKeys(String):Future[Vector[GetHDKeysResult]]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../org/bitcoins/rpc/client/common/BitcoindRpcClient.html#getHDKeys(walletName:String):scala.concurrent.Future[Vector[org.bitcoins.commons.jsonmodels.bitcoind.GetHDKeysResult]]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">getHDKeys</span><span class="params">(<span name="walletName">walletName: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">DEFAULT_WALLET</span></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.16/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="../../../../../scala/index.html#Vector[+A]=scala.collection.immutable.Vector[A]" name
Deploy website Deploy website version based on afddf73c48d12515d44d11e959ac6d995fdbe61f
2024-04-21 01:15:38 +00:00
database
</p><div class="fullcomment"><div class="comment cmt"><p>Gets a <a href="../../../core/api/chain/db/BlockHeaderDb.html" name="org.bitcoins.core.api.chain.db.BlockHeaderDb" id="org.bitcoins.core.api.chain.db.BlockHeaderDb" class="extype">org.bitcoins.core.api.chain.db.BlockHeaderDb</a> from the chain's
database
Deploy website Deploy website version based on 0fd33dd4ea0a91c26007191e2cdb2898d325071e
2025-01-16 22:15:49 +00:00
</p></div><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="" name="org.bitcoins.rpc.client.common.BitcoindRpcClient" id="org.bitcoins.rpc.client.common.BitcoindRpcClient" class="extype">BitcoindRpcClient</a> → <a href="../../../core/api/chain/ChainApi.html" name="org.bitcoins.core.api.chain.ChainApi" id="org.bitcoins.core.api.chain.ChainApi" class="extype">ChainApi</a></dd></dl></div></li><li class="indented0 " name="org.bitcoins.rpc.client.common.BitcoindRpcClient#getHeaders" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="getHeaders(hashes:Vector[org.bitcoins.crypto.DoubleSha256DigestBE]):scala.concurrent.Future[Vector[Option[org.bitcoins.core.api.chain.db.BlockHeaderDb]]]" class="anchorToMember"></a><a id="getHeaders(Vector[DoubleSha256DigestBE]):Future[Vector[Option[BlockHeaderDb]]]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../org/bitcoins/rpc/client/common/BitcoindRpcClient.html#getHeaders(hashes:Vector[org.bitcoins.crypto.DoubleSha256DigestBE]):scala.concurrent.Future[Vector[Option[org.bitcoins.core.api.chain.db.BlockHeaderDb]]]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">getHeaders</span><span class="params">(<span name="hashes">hashes: <a href="../../../../../scala/index.html#Vector[+A]=scala.collection.immutable.Vector[A]" name="scala.Vector" id="scala.Vector" class="extmbr">Vector</a>[<a href="../../../crypto/DoubleSha256DigestBE.html" name="org.bitcoins.crypto.DoubleSha256DigestBE" id="org.bitcoins.crypto.DoubleSha256DigestBE" class="extype">DoubleSha256DigestBE</a>]</span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.16/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="../../../../../scala/index.html#Vector[+A]=scala.collection.immutable.Vector[A]" name="scala.Vector" id="scala.Vector" class="extmbr">Vector</a>[<a href="https://www.scala-lang.org/api/2.13.16/scala/Option.html#scala.Option" name="scala.Option" id="scala.Option" class="extype">Option</a>[<a href="../../../core/api/chain/db/BlockHeaderDb.html" name="org.bitcoins.core.api.chain.db.BlockHeaderDb" id="org.bitcoins.core.api.chain.db.BlockHeaderDb" class="extype">BlockHeaderDb</a>]]]</span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="" name="org.bitcoins.rpc.client.common.BitcoindRpcClient" id="org.bitcoins.rpc.client.common.BitcoindRpcClient" class="extype">BitcoindRpcClient</a> → <a href="../../../core/api/chain/ChainApi.html" name="org.bitcoins.core.api.chain.ChainApi" id="org.bitcoins.core.api.chain.ChainApi" class="extype">ChainApi</a></dd></dl></div></li><li class="indented0 " name="org.bitcoins.rpc.client.common.BitcoindRpcClient#getHeadersAtHeight" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="getHeadersAtHeight(height:Int):scala.concurrent.Future[Vector[org.bitcoins.core.api.chain.db.BlockHeaderDb]]" class="anchorToMember"></a><a id="getHeadersAtHeight(Int):Future[Vector[BlockHeaderDb]]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../org/bitcoins/rpc/client/common/BitcoindRpcClient.html#getHeadersAtHeight(height:Int):scala.concurrent.Future[Vector[org.bitcoins.core.api.chain.db.BlockHeaderDb]]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">getHeadersAtHeight</span><span class="params">(<span name="height">height: <a href="https://www.scala-lang.org/api/2.13.16/scala/Int.html#scala.Int" name="scala.Int" id="scala.Int" class="extype">Int</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.16/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.con
Deploy website Deploy website version based on afddf73c48d12515d44d11e959ac6d995fdbe61f
2024-04-21 01:15:38 +00:00
height
</p><div class="fullcomment"><div class="comment cmt"><p>Gets all <a href="../../../core/api/chain/db/BlockHeaderDb.html" name="org.bitcoins.core.api.chain.db.BlockHeaderDb" id="org.bitcoins.core.api.chain.db.BlockHeaderDb" class="extype">org.bitcoins.core.api.chain.db.BlockHeaderDb</a>s at a given
height
Deploy website Deploy website version based on 0fd33dd4ea0a91c26007191e2cdb2898d325071e
2025-01-16 22:15:49 +00:00
</p></div><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="" name="org.bitcoins.rpc.client.common.BitcoindRpcClient" id="org.bitcoins.rpc.client.common.BitcoindRpcClient" class="extype">BitcoindRpcClient</a> → <a href="../../../core/api/chain/ChainApi.html" name="org.bitcoins.core.api.chain.ChainApi" id="org.bitcoins.core.api.chain.ChainApi" class="extype">ChainApi</a></dd></dl></div></li><li class="indented0 " name="org.bitcoins.rpc.client.common.BitcoindRpcClient#getHeadersBetween" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="getHeadersBetween(from:org.bitcoins.core.api.chain.db.BlockHeaderDb,to:org.bitcoins.core.api.chain.db.BlockHeaderDb):scala.concurrent.Future[Vector[org.bitcoins.core.api.chain.db.BlockHeaderDb]]" class="anchorToMember"></a><a id="getHeadersBetween(BlockHeaderDb,BlockHeaderDb):Future[Vector[BlockHeaderDb]]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../org/bitcoins/rpc/client/common/BitcoindRpcClient.html#getHeadersBetween(from:org.bitcoins.core.api.chain.db.BlockHeaderDb,to:org.bitcoins.core.api.chain.db.BlockHeaderDb):scala.concurrent.Future[Vector[org.bitcoins.core.api.chain.db.BlockHeaderDb]]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">getHeadersBetween</span><span class="params">(<span name="from">from: <a href="../../../core/api/chain/db/BlockHeaderDb.html" name="org.bitcoins.core.api.chain.db.BlockHeaderDb" id="org.bitcoins.core.api.chain.db.BlockHeaderDb" class="extype">BlockHeaderDb</a></span>, <span name="to">to: <a href="../../../core/api/chain/db/BlockHeaderDb.html" name="org.bitcoins.core.api.chain.db.BlockHeaderDb" id="org.bitcoins.core.api.chain.db.BlockHeaderDb" class="extype">BlockHeaderDb</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.16/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="../../../../../scala/index.html#Vector[+A]=scala.collection.immutable.Vector[A]" name="scala.Vector" id="scala.Vector" class="extmbr">Vector</a>[<a href="../../../core/api/chain/db/BlockHeaderDb.html" name="org.bitcoins.core.api.chain.db.BlockHeaderDb" id="org.bitcoins.core.api.chain.db.BlockHeaderDb" class="extype">BlockHeaderDb</a>]]</span></span><p class="shortcomment cmt">Fetchs the block headers between from and to (inclusive).</p><div class="fullcomment"><div class="comment cmt"><p>Fetchs the block headers between from and to (inclusive).</p></div><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="" name="org.bitcoins.rpc.client.common.BitcoindRpcClient" id="org.bitcoins.rpc.client.common.BitcoindRpcClient" class="extype">BitcoindRpcClient</a> → <a href="../../../core/api/chain/ChainApi.html" name="org.bitcoins.core.api.chain.ChainApi" id="org.bitcoins.core.api.chain.ChainApi" class="extype">ChainApi</a></dd></dl></div></li><li class="indented0 " name="org.bitcoins.rpc.client.common.BitcoindRpcClient#getHeightByBlockStamp" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="getHeightByBlockStamp(blockStamp:org.bitcoins.core.protocol.BlockStamp):scala.concurrent.Future[Int]" class="anchorToMember"></a><a id="getHeightByBlockStamp(BlockStamp):Future[Int]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../org/bitcoins/rpc/client/common/BitcoindRpcClient.html#getHeightByBlockStamp(blockStamp:org.bitcoins.core.protocol.BlockStamp):scala.concurrent.Future[Int]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">getHeightByBlockStamp</span><span class="params">(<span name="blockStamp">blockStamp: <a href="../../../core/protocol/BlockStamp.html" name="org.bitcoins.core.protocol.BlockStamp" id="org.bitcoins.core.protocol
Deploy website Deploy website version based on afddf73c48d12515d44d11e959ac6d995fdbe61f
2024-04-21 01:15:38 +00:00
only used for printing diagnostics if things go belly-up.
Deploy website Deploy website version based on 9d84ff5d035e0dea1c6eb536f60d9d7b5a80a4a0
2025-02-14 19:33:58 +00:00
</p></div><dl class="attributes block"><dt>Attributes</dt><dd>protected </dd><dt>Definition Classes</dt><dd><a href="Client.html" name="org.bitcoins.rpc.client.common.Client" id="org.bitcoins.rpc.client.common.Client" class="extype">Client</a></dd></dl></div></li><li class="indented0 " name="org.bitcoins.rpc.client.common.P2PRpc#getPeerInfo" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="getPeerInfo:scala.concurrent.Future[Vector[org.bitcoins.commons.jsonmodels.bitcoind.PeerInfoResponseV25]]" class="anchorToMember"></a><a id="getPeerInfo:Future[Vector[PeerInfoResponseV25]]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../org/bitcoins/rpc/client/common/BitcoindRpcClient.html#getPeerInfo:scala.concurrent.Future[Vector[org.bitcoins.commons.jsonmodels.bitcoind.PeerInfoResponseV25]]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">getPeerInfo</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.16/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="../../../../../scala/index.html#Vector[+A]=scala.collection.immutable.Vector[A]" name="scala.Vector" id="scala.Vector" class="extmbr">Vector</a>[<a href="../../../commons/jsonmodels/bitcoind/PeerInfoResponseV25.html" name="org.bitcoins.commons.jsonmodels.bitcoind.PeerInfoResponseV25" id="org.bitcoins.commons.jsonmodels.bitcoind.PeerInfoResponseV25" class="extype">PeerInfoResponseV25</a>]]</span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="P2PRpc.html" name="org.bitcoins.rpc.client.common.P2PRpc" id="org.bitcoins.rpc.client.common.P2PRpc" class="extype">P2PRpc</a></dd></dl></div></li><li class="indented0 " name="org.bitcoins.rpc.client.common.MiningRpc#getPrioritisedTransactions" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="getPrioritisedTransactions():scala.concurrent.Future[Map[org.bitcoins.crypto.DoubleSha256DigestBE,org.bitcoins.commons.jsonmodels.bitcoind.PrioritisedTransaction]]" class="anchorToMember"></a><a id="getPrioritisedTransactions():Future[Map[DoubleSha256DigestBE,PrioritisedTransaction]]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../org/bitcoins/rpc/client/common/BitcoindRpcClient.html#getPrioritisedTransactions():scala.concurrent.Future[Map[org.bitcoins.crypto.DoubleSha256DigestBE,org.bitcoins.commons.jsonmodels.bitcoind.PrioritisedTransaction]]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">getPrioritisedTransactions</span><span class="params">()</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.16/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<span name="scala.Predef.Map" class="extype">Map</span>[<a href="../../../crypto/DoubleSha256DigestBE.html" name="org.bitcoins.crypto.DoubleSha256DigestBE" id="org.bitcoins.crypto.DoubleSha256DigestBE" class="extype">DoubleSha256DigestBE</a>, <a href="../../../commons/jsonmodels/bitcoind/PrioritisedTransaction.html" name="org.bitcoins.commons.jsonmodels.bitcoind.PrioritisedTransaction" id="org.bitcoins.commons.jsonmodels.bitcoind.PrioritisedTransaction" class="extype">PrioritisedTransaction</a>]]</span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="MiningRpc.html" name="org.bitcoins.rpc.client.common.MiningRpc" id="org.bitcoins.rpc.client.common.MiningRpc" class="extype">MiningRpc</a></dd></dl></div></li><li class="indented0 " name="org.bitcoins.rpc.client.common.WalletRpc#getRawChangeAddress" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="getRawCh
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
</p><div class="fullcomment"><div class="comment cmt"><p>Checks whether the underlying bitcoind daemon is running
Deploy website Deploy website version based on 0fd33dd4ea0a91c26007191e2cdb2898d325071e
2025-01-16 22:15:49 +00:00
</p></div><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="Client.html" name="org.bitcoins.rpc.client.common.Client" id="org.bitcoins.rpc.client.common.Client" class="extype">Client</a></dd></dl></div></li><li class="indented0 " name="org.bitcoins.rpc.client.common.Client#isStoppedF" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="isStoppedF:scala.concurrent.Future[Boolean]" class="anchorToMember"></a><a id="isStoppedF:Future[Boolean]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../org/bitcoins/rpc/client/common/BitcoindRpcClient.html#isStoppedF:scala.concurrent.Future[Boolean]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">isStoppedF</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.16/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="https://www.scala-lang.org/api/2.13.16/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a>]</span></span><p class="shortcomment cmt">Checks whether the underlyind bitcoind daemon is stopped</p><div class="fullcomment"><div class="comment cmt"><p>Checks whether the underlyind bitcoind daemon is stopped</p></div><dl class="paramcmts block"><dt>returns</dt><dd class="cmt"><p>
A future boolean which represents isstopped or not</p></dd></dl><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="Client.html" name="org.bitcoins.rpc.client.common.Client" id="org.bitcoins.rpc.client.common.Client" class="extype">Client</a></dd></dl></div></li><li class="indented0 " name="org.bitcoins.rpc.client.common.BitcoindRpcClient#isSyncing" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="isSyncing():scala.concurrent.Future[Boolean]" class="anchorToMember"></a><a id="isSyncing():Future[Boolean]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../org/bitcoins/rpc/client/common/BitcoindRpcClient.html#isSyncing():scala.concurrent.Future[Boolean]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">isSyncing</span><span class="params">()</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.16/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="https://www.scala-lang.org/api/2.13.16/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><a href="" name="org.bitcoins.rpc.client.common.BitcoindRpcClient" id="org.bitcoins.rpc.client.common.BitcoindRpcClient" class="extype">BitcoindRpcClient</a> → <a href="../../../core/api/chain/ChainApi.html" name="org.bitcoins.core.api.chain.ChainApi" id="org.bitcoins.core.api.chain.ChainApi" class="extype">ChainApi</a></dd></dl></div></li><li class="indented0 " name="org.bitcoins.rpc.client.common.BitcoindRpcClient#isTipStale" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="isTipStale():scala.concurrent.Future[Boolean]" class="anchorToMember"></a><a id="isTipStale():Future[Boolean]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../org/bitcoins/rpc/client/common/BitcoindRpcClient.html#isTipStale():scala.concurrent.Future[Boolean]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">isTipStale</span><span class="params">()</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.16/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="https://www.scala-lang.org/api/2.13.16/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a>]</span></span><p class="shortcomment cmt">Checks if our chain tip is stale</p><div class="fullcomment"><div class="comment cmt"><p>Checks if our chain tip is stale</p></div><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="" name="org.bitcoins.rpc.client.common.BitcoindRpcClient" id="org.bitcoins.rpc.client.common.BitcoindRpcClient" class="extype">BitcoindRpcClient</a> → <a href="../../../core/api/chain/ChainApi.html" name="org.bitcoins.core.api.chain.ChainApi" id="org.bitcoins.core.api.chain.ChainApi" class="extype">ChainApi</a></dd><dt>See also</dt><dd><span class="cmt"><p>
<a href="https://github.com/bitcoin/bitcoin/blob/664500fc71a32d5066db8cb4a19ddc7005a1c9e9/src/net_processing.cpp#L1235" target="_blank">https://github.com/bitcoin/bitcoin/blob/664500fc71a32d5066db8cb4a19ddc7005a1c9e9/src/net_processing.cpp#L1235</a></p></span></dd></dl></div></li><li class="indented0 " name="org.bitcoins.rpc.client.common.PsbtRpc#joinPsbts" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="joinPsbts(psbts:Seq[org.bitcoins.core.psbt.PSBT]):scala.concurrent.Future[org.bitcoins.core.psbt.PSBT]" class="anchorToMember"></a><a id="joinPsbts(Seq[PSBT]):Future[PSBT]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../org/bitcoins/rpc/client/common/BitcoindRpcClient.html#joinPsbts(psbts:Seq[org.bitcoins.core.psbt.PSBT]):scala.concurrent.Future[org.bitcoins.core.psbt.PSBT]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">joinPsbts</span><span class="params">(<span name="psbts">psbts: <a href="../../../../../scala/index.html#Seq[+A]=Seq[A]" name="scala.Seq" id="scala.Seq" class="extmbr">Seq</a>[<a href="../../../core/psbt/PSBT.html" name="org.bitcoins.core.psbt.PSBT" id="org.bitcoins.core.psbt.PSBT" class="extype">PSBT</a>]</span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.16/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="../../../core/psbt/PSBT.html" name="org.bitcoins.core.psbt.PSBT" id="org.bitcoins.core.psbt.PSBT" class="extype">PSBT</a>]</span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="PsbtRpc.html" name="org.bitcoins.rpc.client.common.PsbtRpc" id="org.bitcoins.rpc.client.common.PsbtRpc" class="extype">PsbtRpc</a></dd></dl></div></li><li class="indented0 " name="org.bitcoins.rpc.client.common.WalletRpc#keyPoolRefill" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="keyPoolRefill(keyPoolSize:Int,walletName:String):scala.concurrent.Future[Unit]" class="anchorToMember"></a><a id="keyPoolRefill(Int,String):Future[Unit]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../org/bitcoins/rpc/client/common/BitcoindRpcClient.html#keyPoolRefill(keyPoolSize:Int,walletName:String):scala.concurrent.Future[Unit]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">keyPoolRefill</span><span class="params">(<span name="keyPoolSize">keyPoolSize: <a href="https://www.scala-lang.org/api/2.13.16/scala/Int.html#scala.Int" name="scala.Int" id="scala.Int" class="extype">Int</a> = <span class="symbol">100</span></span>, <span name="walletName">walletName: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">DEFAULT_WALLET</span></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.16/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="https://www.scala-lang.org/api/2.13.16/scala/Unit.html#scala.Unit" name="scala.Unit" id="scala.Unit" class="extype">Unit</a>]</span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="WalletRpc.html" name="org.bitcoins.rpc.client.common.WalletRpc" id="org.bitcoins.rpc.client.common.WalletRpc" class="extype">WalletRpc</a></dd></dl></div></li><li class="indented0 " name="org.bitcoins.rpc.client.common.WalletRpc#listAddressGroupings" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="listAddressGroupings(walletName:String):scala.concurrent.Future[Vector[Vector[org.bitcoins.commons.jsonmodels.bitcoind.RpcAddress]]]" class="anchorToMember"></
Deploy website Deploy website version based on afddf73c48d12515d44d11e959ac6d995fdbe61f
2024-04-21 01:15:38 +00:00
underlying instance is <a href="../../config/BitcoindInstanceLocal.html" name="org.bitcoins.rpc.config.BitcoindInstanceLocal" id="org.bitcoins.rpc.config.BitcoindInstanceLocal" class="extype">org.bitcoins.rpc.config.BitcoindInstanceLocal</a>,
and None if the underlying instance is <span name="BitcoindInstanceRemote" class="extype">BitcoindInstanceRemote</span>
Deploy website Deploy website version based on 0fd33dd4ea0a91c26007191e2cdb2898d325071e
2025-01-16 22:15:49 +00:00
</p></div><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="Client.html" name="org.bitcoins.rpc.client.common.Client" id="org.bitcoins.rpc.client.common.Client" class="extype">Client</a></dd></dl></div></li><li class="indented0 " name="org.bitcoins.commons.util.BitcoinSLogger#logger" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="logger:org.slf4j.Logger" class="anchorToMember"></a><a id="logger:Logger" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../org/bitcoins/rpc/client/common/BitcoindRpcClient.html#logger:org.slf4j.Logger" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">logger</span><span class="result">: <a href="https://javadoc.io/page/org.slf4j/slf4j-api/1.7.36/org/slf4j/Logger.html#org.slf4j.Logger" name="org.slf4j.Logger" id="org.slf4j.Logger" class="extype">Logger</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../../commons/util/BitcoinSLogger.html" name="org.bitcoins.commons.util.BitcoinSLogger" id="org.bitcoins.commons.util.BitcoinSLogger" class="extype">BitcoinSLogger</a></dd></dl></div></li><li class="indented0 " name="org.bitcoins.rpc.client.common.NodeRpc#logging" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="logging(include:Vector[String],exclude:Vector[String]):scala.concurrent.Future[Map[String,Boolean]]" class="anchorToMember"></a><a id="logging(Vector[String],Vector[String]):Future[Map[String,Boolean]]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../org/bitcoins/rpc/client/common/BitcoindRpcClient.html#logging(include:Vector[String],exclude:Vector[String]):scala.concurrent.Future[Map[String,Boolean]]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">logging</span><span class="params">(<span name="include">include: <a href="../../../../../scala/index.html#Vector[+A]=scala.collection.immutable.Vector[A]" name="scala.Vector" id="scala.Vector" class="extmbr">Vector</a>[<span name="scala.Predef.String" class="extype">String</span>] = <span class="symbol"><span class="name"><a href="../../../../../scala/index.html">Vector.empty</a></span></span></span>, <span name="exclude">exclude: <a href="../../../../../scala/index.html#Vector[+A]=scala.collection.immutable.Vector[A]" name="scala.Vector" id="scala.Vector" class="extmbr">Vector</a>[<span name="scala.Predef.String" class="extype">String</span>] = <span class="symbol"><span class="name"><a href="../../../../../scala/index.html">Vector.empty</a></span></span></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.16/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<span name="scala.Predef.Map" class="extype">Map</span>[<span name="scala.Predef.String" class="extype">String</span>, <a href="https://www.scala-lang.org/api/2.13.16/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><a href="NodeRpc.html" name="org.bitcoins.rpc.client.common.NodeRpc" id="org.bitcoins.rpc.client.common.NodeRpc" class="extype">NodeRpc</a></dd></dl></div></li><li class="indented0 " name="org.bitcoins.rpc.client.common.NodeRpc#logging" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="logging:scala.concurrent.Future[Map[String,Boolean]]" class="anchorToMember"></a><a id="logging:Future[Map[String,Boolean]]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../org/bitcoins/rpc/client/common/BitcoindRpcClient.html#logging:scala.concurrent.Future[Map[String,Boolean]]" title="Permalink">
Deploy website Deploy website version based on afddf73c48d12515d44d11e959ac6d995fdbe61f
2024-04-21 01:15:38 +00:00
stop hash.</p><div class="fullcomment"><div class="comment cmt"><p>Generates a block range in form of (startHeight, stopHash) by the given
stop hash. Returns None if we are synced
</p></div><dl class="paramcmts block"><dt class="param">prevStopHash</dt><dd class="cmt"><p>
our previous block hash where filter header sync stopped</p></dd><dt class="param">stopHash</dt><dd class="cmt"><p>
the block hash we want to sync the new batch of filters to</p></dd><dt class="param">batchSize</dt><dd class="cmt"><p>
Deploy website Deploy website version based on 0fd33dd4ea0a91c26007191e2cdb2898d325071e
2025-01-16 22:15:49 +00:00
the batch size of filter headers</p></dd></dl><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="" name="org.bitcoins.rpc.client.common.BitcoindRpcClient" id="org.bitcoins.rpc.client.common.BitcoindRpcClient" class="extype">BitcoindRpcClient</a> → <a href="../../../core/api/chain/ChainApi.html" name="org.bitcoins.core.api.chain.ChainApi" id="org.bitcoins.core.api.chain.ChainApi" class="extype">ChainApi</a></dd></dl></div></li><li class="indented0 " name="org.bitcoins.rpc.client.common.BitcoindRpcClient#nextFilterHeaderBatchRange" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="nextFilterHeaderBatchRange(stopBlockHash:org.bitcoins.crypto.DoubleSha256DigestBE,batchSize:Int,startHeightOpt:Option[Int]):scala.concurrent.Future[Option[org.bitcoins.core.api.chain.FilterSyncMarker]]" class="anchorToMember"></a><a id="nextFilterHeaderBatchRange(DoubleSha256DigestBE,Int,Option[Int]):Future[Option[FilterSyncMarker]]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../org/bitcoins/rpc/client/common/BitcoindRpcClient.html#nextFilterHeaderBatchRange(stopBlockHash:org.bitcoins.crypto.DoubleSha256DigestBE,batchSize:Int,startHeightOpt:Option[Int]):scala.concurrent.Future[Option[org.bitcoins.core.api.chain.FilterSyncMarker]]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">nextFilterHeaderBatchRange</span><span class="params">(<span name="stopBlockHash">stopBlockHash: <a href="../../../crypto/DoubleSha256DigestBE.html" name="org.bitcoins.crypto.DoubleSha256DigestBE" id="org.bitcoins.crypto.DoubleSha256DigestBE" class="extype">DoubleSha256DigestBE</a></span>, <span name="batchSize">batchSize: <a href="https://www.scala-lang.org/api/2.13.16/scala/Int.html#scala.Int" name="scala.Int" id="scala.Int" class="extype">Int</a></span>, <span name="startHeightOpt">startHeightOpt: <a href="https://www.scala-lang.org/api/2.13.16/scala/Option.html#scala.Option" name="scala.Option" id="scala.Option" class="extype">Option</a>[<a href="https://www.scala-lang.org/api/2.13.16/scala/Int.html#scala.Int" name="scala.Int" id="scala.Int" class="extype">Int</a>]</span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.16/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="https://www.scala-lang.org/api/2.13.16/scala/Option.html#scala.Option" name="scala.Option" id="scala.Option" class="extype">Option</a>[<a href="../../../core/api/chain/FilterSyncMarker.html" name="org.bitcoins.core.api.chain.FilterSyncMarker" id="org.bitcoins.core.api.chain.FilterSyncMarker" class="extype">FilterSyncMarker</a>]]</span></span><p class="shortcomment cmt">Generates a query for a range of compact filters</p><div class="fullcomment"><div class="comment cmt"><p>Generates a query for a range of compact filters</p></div><dl class="paramcmts block"><dt class="param">stopBlockHash</dt><dd class="cmt"><p>
Deploy website Deploy website version based on afddf73c48d12515d44d11e959ac6d995fdbe61f
2024-04-21 01:15:38 +00:00
the block hash to stop receiving filters at</p></dd><dt class="param">startHeightOpt</dt><dd class="cmt"><p>
the block height to start syncing filters from. If None, we query our
Deploy website Deploy website version based on 0fd33dd4ea0a91c26007191e2cdb2898d325071e
2025-01-16 22:15:49 +00:00
chainstate for the last filter we've seen</p></dd></dl><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="" name="org.bitcoins.rpc.client.common.BitcoindRpcClient" id="org.bitcoins.rpc.client.common.BitcoindRpcClient" class="extype">BitcoindRpcClient</a> → <a href="../../../core/api/chain/ChainApi.html" name="org.bitcoins.core.api.chain.ChainApi" id="org.bitcoins.core.api.chain.ChainApi" class="extype">ChainApi</a></dd></dl></div></li><li class="indented0 " name="org.bitcoins.core.api.chain.ChainApi#nextFilterHeaderBatchRange" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="nextFilterHeaderBatchRange(stopBlockHash:org.bitcoins.crypto.DoubleSha256DigestBE,batchSize:Int):scala.concurrent.Future[Option[org.bitcoins.core.api.chain.FilterSyncMarker]]" class="anchorToMember"></a><a id="nextFilterHeaderBatchRange(DoubleSha256DigestBE,Int):Future[Option[FilterSyncMarker]]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../org/bitcoins/rpc/client/common/BitcoindRpcClient.html#nextFilterHeaderBatchRange(stopBlockHash:org.bitcoins.crypto.DoubleSha256DigestBE,batchSize:Int):scala.concurrent.Future[Option[org.bitcoins.core.api.chain.FilterSyncMarker]]" 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">nextFilterHeaderBatchRange</span><span class="params">(<span name="stopBlockHash">stopBlockHash: <a href="../../../crypto/DoubleSha256DigestBE.html" name="org.bitcoins.crypto.DoubleSha256DigestBE" id="org.bitcoins.crypto.DoubleSha256DigestBE" class="extype">DoubleSha256DigestBE</a></span>, <span name="batchSize">batchSize: <a href="https://www.scala-lang.org/api/2.13.16/scala/Int.html#scala.Int" name="scala.Int" id="scala.Int" class="extype">Int</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.16/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="https://www.scala-lang.org/api/2.13.16/scala/Option.html#scala.Option" name="scala.Option" id="scala.Option" class="extype">Option</a>[<a href="../../../core/api/chain/FilterSyncMarker.html" name="org.bitcoins.core.api.chain.FilterSyncMarker" id="org.bitcoins.core.api.chain.FilterSyncMarker" class="extype">FilterSyncMarker</a>]]</span></span><p class="shortcomment cmt">Generates a filter header range in form of (startHeight, stopHash) by the
Deploy website Deploy website version based on afddf73c48d12515d44d11e959ac6d995fdbe61f
2024-04-21 01:15:38 +00:00
given stop hash.</p><div class="fullcomment"><div class="comment cmt"><p>Generates a filter header range in form of (startHeight, stopHash) by the
given stop hash.
Deploy website Deploy website version based on 0fd33dd4ea0a91c26007191e2cdb2898d325071e
2025-01-16 22:15:49 +00:00
</p></div><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../../core/api/chain/ChainApi.html" name="org.bitcoins.core.api.chain.ChainApi" id="org.bitcoins.core.api.chain.ChainApi" class="extype">ChainApi</a></dd></dl></div></li><li class="indented0 " name="scala.AnyRef#notify" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="notify():Unit" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../org/bitcoins/rpc/client/common/BitcoindRpcClient.html#notify():Unit" 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">notify</span><span class="params">()</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.16/scala/Unit.html#scala.Unit" name="scala.Unit" id="scala.Unit" class="extype">Unit</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd><span class="name">@native</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="scala.AnyRef#notifyAll" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="notifyAll():Unit" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../org/bitcoins/rpc/client/common/BitcoindRpcClient.html#notifyAll():Unit" 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">notifyAll</span><span class="params">()</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.16/scala/Unit.html#scala.Unit" name="scala.Unit" id="scala.Unit" class="extype">Unit</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd><span class="name">@native</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="org.bitcoins.rpc.client.common.Client#ping" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ping():scala.concurrent.Future[Unit]" class="anchorToMember"></a><a id="ping():Future[Unit]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../org/bitcoins/rpc/client/common/BitcoindRpcClient.html#ping():scala.concurrent.Future[Unit]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">ping</span><span class="params">()</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.16/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="https://www.scala-lang.org/api/2.13.16/scala/Unit.html#scala.Unit" name="scala.Unit" id="scala.Unit" class="extype">Unit</a>]</span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="Client.html" name="org.bitcoins.rpc.client.common.Client" id="org.bitcoins.rpc.client.common.Client" class="extype">Client</a></dd></dl></div></li><li class="indented0 " name="org.bitcoins.rpc.client.common.BlockchainRpc#preciousBlock" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="preciousBlock(headerHash:org.bitcoins.crypto.DoubleSha256Digest):scala.concurrent.Future[Unit]" class="anchorToMember"></a><a id="preciousBlock(DoubleSha256Digest):Future[Unit]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../org/bitcoins/rpc/client/common/BitcoindRpcClient.html#preciousBlock(headerHash:org.bitcoins.crypto.DoubleSha256Digest):scala.concurrent.Future[Unit]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">preciou
</p></div><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../../core/api/chain/ChainApi.html" name="org.bitcoins.core.api.chain.ChainApi" id="org.bitcoins.core.api.chain.ChainApi" class="extype">ChainApi</a></dd></dl></div></li><li class="indented0 " name="org.bitcoins.rpc.client.common.BitcoindRpcClient#processCheckpoints" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="processCheckpoints(checkpoints:Vector[org.bitcoins.crypto.DoubleSha256DigestBE],blockHash:org.bitcoins.crypto.DoubleSha256DigestBE):scala.concurrent.Future[org.bitcoins.core.api.chain.ChainApi]" class="anchorToMember"></a><a id="processCheckpoints(Vector[DoubleSha256DigestBE],DoubleSha256DigestBE):Future[ChainApi]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../org/bitcoins/rpc/client/common/BitcoindRpcClient.html#processCheckpoints(checkpoints:Vector[org.bitcoins.crypto.DoubleSha256DigestBE],blockHash:org.bitcoins.crypto.DoubleSha256DigestBE):scala.concurrent.Future[org.bitcoins.core.api.chain.ChainApi]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">processCheckpoints</span><span class="params">(<span name="checkpoints">checkpoints: <a href="../../../../../scala/index.html#Vector[+A]=scala.collection.immutable.Vector[A]" name="scala.Vector" id="scala.Vector" class="extmbr">Vector</a>[<a href="../../../crypto/DoubleSha256DigestBE.html" name="org.bitcoins.crypto.DoubleSha256DigestBE" id="org.bitcoins.crypto.DoubleSha256DigestBE" class="extype">DoubleSha256DigestBE</a>]</span>, <span name="blockHash">blockHash: <a href="../../../crypto/DoubleSha256DigestBE.html" name="org.bitcoins.crypto.DoubleSha256DigestBE" id="org.bitcoins.crypto.DoubleSha256DigestBE" class="extype">DoubleSha256DigestBE</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.16/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="../../../core/api/chain/ChainApi.html" name="org.bitcoins.core.api.chain.ChainApi" id="org.bitcoins.core.api.chain.ChainApi" class="extype">ChainApi</a>]</span></span><p class="shortcomment cmt">Process all compact filter header check points.</p><div class="fullcomment"><div class="comment cmt"><p>Process all compact filter header check points.
</p></div><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="" name="org.bitcoins.rpc.client.common.BitcoindRpcClient" id="org.bitcoins.rpc.client.common.BitcoindRpcClient" class="extype">BitcoindRpcClient</a> → <a href="../../../core/api/chain/ChainApi.html" name="org.bitcoins.core.api.chain.ChainApi" id="org.bitcoins.core.api.chain.ChainApi" class="extype">ChainApi</a></dd></dl></div></li><li class="indented0 " name="org.bitcoins.core.api.chain.ChainApi#processFilter" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="processFilter(message:org.bitcoins.core.p2p.CompactFilterMessage):scala.concurrent.Future[org.bitcoins.core.api.chain.ChainApi]" class="anchorToMember"></a><a id="processFilter(CompactFilterMessage):Future[ChainApi]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../org/bitcoins/rpc/client/common/BitcoindRpcClient.html#processFilter(message:org.bitcoins.core.p2p.CompactFilterMessage):scala.concurrent.Future[org.bitcoins.core.api.chain.ChainApi]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">processFilter</span><span class="params">(<span name="message">message: <a href="../../../core/p2p/CompactFilterMessage.html" name="org.bitcoins.core.p2p.CompactFilterMessage" id="org.bitcoins.core.p2p.CompactFilterMessage" class="extype">CompactFilterMessage</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.16/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="../../../core/api/chain/ChainApi.html" name="org.bitcoins.core.api.chain.ChainApi" id="org.bitcoins.core.api.chain.ChainApi" class="extype">ChainApi</a>]</span></span><p class="shortcomment cmt">Adds a compact filter into the filter database.</p><div class="fullcomment"><div class="comment cmt"><p>Adds a compact filter into the filter database.
</p></div><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../../core/api/chain/ChainApi.html" name="org.bitcoins.core.api.chain.ChainApi" id="org.bitcoins.core.api.chain.ChainApi" class="extype">ChainApi</a></dd></dl></div></li><li class="indented0 " name="org.bitcoins.core.api.chain.ChainApi#processFilterHeader" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="processFilterHeader(filterHeader:org.bitcoins.core.gcs.FilterHeader,blockHash:org.bitcoins.crypto.DoubleSha256DigestBE):scala.concurrent.Future[org.bitcoins.core.api.chain.ChainApi]" class="anchorToMember"></a><a id="processFilterHeader(FilterHeader,DoubleSha256DigestBE):Future[ChainApi]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../org/bitcoins/rpc/client/common/BitcoindRpcClient.html#processFilterHeader(filterHeader:org.bitcoins.core.gcs.FilterHeader,blockHash:org.bitcoins.crypto.DoubleSha256DigestBE):scala.concurrent.Future[org.bitcoins.core.api.chain.ChainApi]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">processFilterHeader</span><span class="params">(<span name="filterHeader">filterHeader: <a href="../../../core/gcs/FilterHeader.html" name="org.bitcoins.core.gcs.FilterHeader" id="org.bitcoins.core.gcs.FilterHeader" class="extype">FilterHeader</a></span>, <span name="blockHash">blockHash: <a href="../../../crypto/DoubleSha256DigestBE.html" name="org.bitcoins.crypto.DoubleSha256DigestBE" id="org.bitcoins.crypto.DoubleSha256DigestBE" class="extype">DoubleSha256DigestBE</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.16/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="../../../core/api/chain/ChainApi.html" name="org.bitcoins.core.api.chain.ChainApi" id="org.bitcoins.core.api.chain.ChainApi" class="extype">ChainApi</a>]</span></span><p class="shortcomment cmt">Adds a compact filter header into the filter header chain and returns a
Deploy website Deploy website version based on afddf73c48d12515d44d11e959ac6d995fdbe61f
2024-04-21 01:15:38 +00:00
new <span name="ChainApi" class="extype">chain api</span> that contains this header
</p><div class="fullcomment"><div class="comment cmt"><p>Adds a compact filter header into the filter header chain and returns a
new <span name="ChainApi" class="extype">chain api</span> that contains this header
Deploy website Deploy website version based on 0fd33dd4ea0a91c26007191e2cdb2898d325071e
2025-01-16 22:15:49 +00:00
</p></div><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../../core/api/chain/ChainApi.html" name="org.bitcoins.core.api.chain.ChainApi" id="org.bitcoins.core.api.chain.ChainApi" class="extype">ChainApi</a></dd></dl></div></li><li class="indented0 " name="org.bitcoins.rpc.client.common.BitcoindRpcClient#processFilterHeaders" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="processFilterHeaders(filterHeaders:Vector[org.bitcoins.core.gcs.FilterHeader],stopHash:org.bitcoins.crypto.DoubleSha256DigestBE):scala.concurrent.Future[org.bitcoins.core.api.chain.ChainApi]" class="anchorToMember"></a><a id="processFilterHeaders(Vector[FilterHeader],DoubleSha256DigestBE):Future[ChainApi]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../org/bitcoins/rpc/client/common/BitcoindRpcClient.html#processFilterHeaders(filterHeaders:Vector[org.bitcoins.core.gcs.FilterHeader],stopHash:org.bitcoins.crypto.DoubleSha256DigestBE):scala.concurrent.Future[org.bitcoins.core.api.chain.ChainApi]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">processFilterHeaders</span><span class="params">(<span name="filterHeaders">filterHeaders: <a href="../../../../../scala/index.html#Vector[+A]=scala.collection.immutable.Vector[A]" name="scala.Vector" id="scala.Vector" class="extmbr">Vector</a>[<a href="../../../core/gcs/FilterHeader.html" name="org.bitcoins.core.gcs.FilterHeader" id="org.bitcoins.core.gcs.FilterHeader" class="extype">FilterHeader</a>]</span>, <span name="stopHash">stopHash: <a href="../../../crypto/DoubleSha256DigestBE.html" name="org.bitcoins.crypto.DoubleSha256DigestBE" id="org.bitcoins.crypto.DoubleSha256DigestBE" class="extype">DoubleSha256DigestBE</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.16/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="../../../core/api/chain/ChainApi.html" name="org.bitcoins.core.api.chain.ChainApi" id="org.bitcoins.core.api.chain.ChainApi" class="extype">ChainApi</a>]</span></span><p class="shortcomment cmt">Process all of the given compact filter headers and returns a new
Deploy website Deploy website version based on afddf73c48d12515d44d11e959ac6d995fdbe61f
2024-04-21 01:15:38 +00:00
<span name="ChainApi" class="extype">chain api</span> that contains these headers.</p><div class="fullcomment"><div class="comment cmt"><p>Process all of the given compact filter headers and returns a new
<span name="ChainApi" class="extype">chain api</span> that contains these headers.
Deploy website Deploy website version based on 0fd33dd4ea0a91c26007191e2cdb2898d325071e
2025-01-16 22:15:49 +00:00
</p></div><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="" name="org.bitcoins.rpc.client.common.BitcoindRpcClient" id="org.bitcoins.rpc.client.common.BitcoindRpcClient" class="extype">BitcoindRpcClient</a> → <a href="../../../core/api/chain/ChainApi.html" name="org.bitcoins.core.api.chain.ChainApi" id="org.bitcoins.core.api.chain.ChainApi" class="extype">ChainApi</a></dd></dl></div></li><li class="indented0 " name="org.bitcoins.rpc.client.common.BitcoindRpcClient#processFilters" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="processFilters(message:Vector[org.bitcoins.core.p2p.CompactFilterMessage]):scala.concurrent.Future[org.bitcoins.core.api.chain.ChainApi]" class="anchorToMember"></a><a id="processFilters(Vector[CompactFilterMessage]):Future[ChainApi]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../org/bitcoins/rpc/client/common/BitcoindRpcClient.html#processFilters(message:Vector[org.bitcoins.core.p2p.CompactFilterMessage]):scala.concurrent.Future[org.bitcoins.core.api.chain.ChainApi]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">processFilters</span><span class="params">(<span name="message">message: <a href="../../../../../scala/index.html#Vector[+A]=scala.collection.immutable.Vector[A]" name="scala.Vector" id="scala.Vector" class="extmbr">Vector</a>[<a href="../../../core/p2p/CompactFilterMessage.html" name="org.bitcoins.core.p2p.CompactFilterMessage" id="org.bitcoins.core.p2p.CompactFilterMessage" class="extype">CompactFilterMessage</a>]</span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.16/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="../../../core/api/chain/ChainApi.html" name="org.bitcoins.core.api.chain.ChainApi" id="org.bitcoins.core.api.chain.ChainApi" class="extype">ChainApi</a>]</span></span><p class="shortcomment cmt">Process all of the given compact filters and returns a new
Deploy website Deploy website version based on afddf73c48d12515d44d11e959ac6d995fdbe61f
2024-04-21 01:15:38 +00:00
<span name="ChainApi" class="extype">chain api</span> that contains these headers.</p><div class="fullcomment"><div class="comment cmt"><p>Process all of the given compact filters and returns a new
<span name="ChainApi" class="extype">chain api</span> that contains these headers.
Deploy website Deploy website version based on 0fd33dd4ea0a91c26007191e2cdb2898d325071e
2025-01-16 22:15:49 +00:00
</p></div><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="" name="org.bitcoins.rpc.client.common.BitcoindRpcClient" id="org.bitcoins.rpc.client.common.BitcoindRpcClient" class="extype">BitcoindRpcClient</a> → <a href="../../../core/api/chain/ChainApi.html" name="org.bitcoins.core.api.chain.ChainApi" id="org.bitcoins.core.api.chain.ChainApi" class="extype">ChainApi</a></dd></dl></div></li><li class="indented0 " name="org.bitcoins.core.api.chain.ChainApi#processHeader" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="processHeader(header:org.bitcoins.core.protocol.blockchain.BlockHeader):scala.concurrent.Future[org.bitcoins.core.api.chain.ChainApi]" class="anchorToMember"></a><a id="processHeader(BlockHeader):Future[ChainApi]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../org/bitcoins/rpc/client/common/BitcoindRpcClient.html#processHeader(header:org.bitcoins.core.protocol.blockchain.BlockHeader):scala.concurrent.Future[org.bitcoins.core.api.chain.ChainApi]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">processHeader</span><span class="params">(<span name="header">header: <a href="../../../core/protocol/blockchain/BlockHeader.html" name="org.bitcoins.core.protocol.blockchain.BlockHeader" id="org.bitcoins.core.protocol.blockchain.BlockHeader" class="extype">BlockHeader</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.16/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="../../../core/api/chain/ChainApi.html" name="org.bitcoins.core.api.chain.ChainApi" id="org.bitcoins.core.api.chain.ChainApi" class="extype">ChainApi</a>]</span></span><p class="shortcomment cmt">Adds a block header to our chain project.</p><div class="fullcomment"><div class="comment cmt"><p>Adds a block header to our chain project. This will return a failed future
Deploy website Deploy website version based on afddf73c48d12515d44d11e959ac6d995fdbe61f
2024-04-21 01:15:38 +00:00
when the given header is invalid.
Deploy website Deploy website version based on 0fd33dd4ea0a91c26007191e2cdb2898d325071e
2025-01-16 22:15:49 +00:00
</p></div><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../../core/api/chain/ChainApi.html" name="org.bitcoins.core.api.chain.ChainApi" id="org.bitcoins.core.api.chain.ChainApi" class="extype">ChainApi</a></dd></dl></div></li><li class="indented0 " name="org.bitcoins.rpc.client.common.BitcoindRpcClient#processHeaders" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="processHeaders(headers:Vector[org.bitcoins.core.protocol.blockchain.BlockHeader]):scala.concurrent.Future[org.bitcoins.core.api.chain.ChainApi]" class="anchorToMember"></a><a id="processHeaders(Vector[BlockHeader]):Future[ChainApi]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../org/bitcoins/rpc/client/common/BitcoindRpcClient.html#processHeaders(headers:Vector[org.bitcoins.core.protocol.blockchain.BlockHeader]):scala.concurrent.Future[org.bitcoins.core.api.chain.ChainApi]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">processHeaders</span><span class="params">(<span name="headers">headers: <a href="../../../../../scala/index.html#Vector[+A]=scala.collection.immutable.Vector[A]" name="scala.Vector" id="scala.Vector" class="extmbr">Vector</a>[<a href="../../../core/protocol/blockchain/BlockHeader.html" name="org.bitcoins.core.protocol.blockchain.BlockHeader" id="org.bitcoins.core.protocol.blockchain.BlockHeader" class="extype">BlockHeader</a>]</span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.16/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="../../../core/api/chain/ChainApi.html" name="org.bitcoins.core.api.chain.ChainApi" id="org.bitcoins.core.api.chain.ChainApi" class="extype">ChainApi</a>]</span></span><p class="shortcomment cmt">Process all of the given headers and returns a new <span name="ChainApi" class="extype">chain api</span>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
that contains these headers.</p><div class="fullcomment"><div class="comment cmt"><p>Process all of the given headers and returns a new <span name="ChainApi" class="extype">chain api</span>
that contains these headers. This method processes headers in the order
Deploy website Deploy website version based on afddf73c48d12515d44d11e959ac6d995fdbe61f
2024-04-21 01:15:38 +00:00
that they are given. If the headers are out of order, this method will
fail.</p><p>This method will also fail when there are zero headers given that are
valid.
Deploy website Deploy website version based on 0fd33dd4ea0a91c26007191e2cdb2898d325071e
2025-01-16 22:15:49 +00:00
</p></div><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="" name="org.bitcoins.rpc.client.common.BitcoindRpcClient" id="org.bitcoins.rpc.client.common.BitcoindRpcClient" class="extype">BitcoindRpcClient</a> → <a href="../../../core/api/chain/ChainApi.html" name="org.bitcoins.core.api.chain.ChainApi" id="org.bitcoins.core.api.chain.ChainApi" class="extype">ChainApi</a></dd></dl></div></li><li class="indented0 " name="org.bitcoins.rpc.client.common.BlockchainRpc#pruneBlockChain" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="pruneBlockChain(height:Int):scala.concurrent.Future[Int]" class="anchorToMember"></a><a id="pruneBlockChain(Int):Future[Int]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../org/bitcoins/rpc/client/common/BitcoindRpcClient.html#pruneBlockChain(height:Int):scala.concurrent.Future[Int]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">pruneBlockChain</span><span class="params">(<span name="height">height: <a href="https://www.scala-lang.org/api/2.13.16/scala/Int.html#scala.Int" name="scala.Int" id="scala.Int" class="extype">Int</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.16/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="https://www.scala-lang.org/api/2.13.16/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><a href="BlockchainRpc.html" name="org.bitcoins.rpc.client.common.BlockchainRpc" id="org.bitcoins.rpc.client.common.BlockchainRpc" class="extype">BlockchainRpc</a></dd></dl></div></li><li class="indented0 " name="org.bitcoins.rpc.client.common.WalletRpc#removePrunedFunds" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="removePrunedFunds(txid:org.bitcoins.crypto.DoubleSha256Digest,walletName:String):scala.concurrent.Future[Unit]" class="anchorToMember"></a><a id="removePrunedFunds(DoubleSha256Digest,String):Future[Unit]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../org/bitcoins/rpc/client/common/BitcoindRpcClient.html#removePrunedFunds(txid:org.bitcoins.crypto.DoubleSha256Digest,walletName:String):scala.concurrent.Future[Unit]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">removePrunedFunds</span><span class="params">(<span name="txid">txid: <a href="../../../crypto/DoubleSha256Digest.html" name="org.bitcoins.crypto.DoubleSha256Digest" id="org.bitcoins.crypto.DoubleSha256Digest" class="extype">DoubleSha256Digest</a></span>, <span name="walletName">walletName: <span name="scala.Predef.String" class="extype">String</span></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.16/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="https://www.scala-lang.org/api/2.13.16/scala/Unit.html#scala.Unit" name="scala.Unit" id="scala.Unit" class="extype">Unit</a>]</span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="WalletRpc.html" name="org.bitcoins.rpc.client.common.WalletRpc" id="org.bitcoins.rpc.client.common.WalletRpc" class="extype">WalletRpc</a></dd></dl></div></li><li class="indented0 " name="org.bitcoins.rpc.client.common.WalletRpc#removePrunedFunds" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="removePrunedFunds(txid:org.bitcoins.crypto.DoubleSha256Digest):scala.concurrent.Future[Unit]" class="anchorToMember"></a><a id="removePrunedFunds(DoubleSha256Digest):Future[Unit]" class="anchorToMember"></a> <span
Set to 0 if you want to enable allowhighfees</p></dd></dl><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="RawTransactionRpc.html" name="org.bitcoins.rpc.client.common.RawTransactionRpc" id="org.bitcoins.rpc.client.common.RawTransactionRpc" class="extype">RawTransactionRpc</a></dd></dl></div></li><li class="indented0 " name="org.bitcoins.rpc.client.common.Client#sendRequest" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="prt"><a id="sendRequest(req:org.apache.pekko.http.scaladsl.model.HttpRequest):scala.concurrent.Future[org.apache.pekko.http.scaladsl.model.HttpResponse]" class="anchorToMember"></a><a id="sendRequest(HttpRequest):Future[HttpResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../org/bitcoins/rpc/client/common/BitcoindRpcClient.html#sendRequest(req:org.apache.pekko.http.scaladsl.model.HttpRequest):scala.concurrent.Future[org.apache.pekko.http.scaladsl.model.HttpResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">sendRequest</span><span class="params">(<span name="req">req: <a href="https://pekko.apache.org/api/pekko-http/1.1.0/org/apache/pekko/http/scaladsl/model/HttpRequest.html#org.apache.pekko.http.scaladsl.model.HttpRequest" name="org.apache.pekko.http.scaladsl.model.HttpRequest" id="org.apache.pekko.http.scaladsl.model.HttpRequest" class="extype">HttpRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.16/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="https://pekko.apache.org/api/pekko-http/1.1.0/org/apache/pekko/http/scaladsl/model/HttpResponse.html#org.apache.pekko.http.scaladsl.model.HttpResponse" name="org.apache.pekko.http.scaladsl.model.HttpResponse" id="org.apache.pekko.http.scaladsl.model.HttpResponse" class="extype">HttpResponse</a>]</span></span><div class="fullcomment"><dl class="attributes block"><dt>Attributes</dt><dd>protected </dd><dt>Definition Classes</dt><dd><a href="Client.html" name="org.bitcoins.rpc.client.common.Client" id="org.bitcoins.rpc.client.common.Client" class="extype">Client</a></dd></dl></div></li><li class="indented0 " name="org.bitcoins.rpc.client.common.WalletRpc#sendToAddress" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="sendToAddress(address:org.bitcoins.core.protocol.BitcoinAddress,amount:org.bitcoins.core.currency.CurrencyUnit,localComment:String,toComment:String,subractFeeFromAmount:Boolean,walletName:String):scala.concurrent.Future[org.bitcoins.crypto.DoubleSha256DigestBE]" class="anchorToMember"></a><a id="sendToAddress(BitcoinAddress,CurrencyUnit,String,String,Boolean,String):Future[DoubleSha256DigestBE]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../org/bitcoins/rpc/client/common/BitcoindRpcClient.html#sendToAddress(address:org.bitcoins.core.protocol.BitcoinAddress,amount:org.bitcoins.core.currency.CurrencyUnit,localComment:String,toComment:String,subractFeeFromAmount:Boolean,walletName:String):scala.concurrent.Future[org.bitcoins.crypto.DoubleSha256DigestBE]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">sendToAddress</span><span class="params">(<span name="address">address: <a href="../../../core/protocol/BitcoinAddress.html" name="org.bitcoins.core.protocol.BitcoinAddress" id="org.bitcoins.core.protocol.BitcoinAddress" class="extype">BitcoinAddress</a></span>, <span name="amount">amount: <a href="../../../core/currency/CurrencyUnit.html" name="org.bitcoins.core.currency.CurrencyUnit" id="org.bitcoins.core.currency.CurrencyUnit" class="extype">CurrencyUnit</a></span>, <span name="localComment">localComment: <span name="scala.Predef.String" class="extype">String</span> = <span class="s
</p></div><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="WalletRpc.html" name="org.bitcoins.rpc.client.common.WalletRpc" id="org.bitcoins.rpc.client.common.WalletRpc" class="extype">WalletRpc</a></dd></dl></div></li><li class="indented0 " name="org.bitcoins.rpc.client.common.MessageRpc#signMessage" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="signMessage(address:org.bitcoins.core.protocol.P2PKHAddress,message:String):scala.concurrent.Future[String]" class="anchorToMember"></a><a id="signMessage(P2PKHAddress,String):Future[String]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../org/bitcoins/rpc/client/common/BitcoindRpcClient.html#signMessage(address:org.bitcoins.core.protocol.P2PKHAddress,message:String):scala.concurrent.Future[String]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">signMessage</span><span class="params">(<span name="address">address: <a href="../../../core/protocol/P2PKHAddress.html" name="org.bitcoins.core.protocol.P2PKHAddress" id="org.bitcoins.core.protocol.P2PKHAddress" class="extype">P2PKHAddress</a></span>, <span name="message">message: <span name="scala.Predef.String" class="extype">String</span></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.16/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<span name="scala.Predef.String" class="extype">String</span>]</span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="MessageRpc.html" name="org.bitcoins.rpc.client.common.MessageRpc" id="org.bitcoins.rpc.client.common.MessageRpc" class="extype">MessageRpc</a></dd></dl></div></li><li class="indented0 " name="org.bitcoins.rpc.client.common.MessageRpc#signMessageWithPrivKey" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="signMessageWithPrivKey(key:org.bitcoins.crypto.ECPrivateKeyBytes,message:String):scala.concurrent.Future[String]" class="anchorToMember"></a><a id="signMessageWithPrivKey(ECPrivateKeyBytes,String):Future[String]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../org/bitcoins/rpc/client/common/BitcoindRpcClient.html#signMessageWithPrivKey(key:org.bitcoins.crypto.ECPrivateKeyBytes,message:String):scala.concurrent.Future[String]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">signMessageWithPrivKey</span><span class="params">(<span name="key">key: <a href="../../../crypto/ECPrivateKeyBytes.html" name="org.bitcoins.crypto.ECPrivateKeyBytes" id="org.bitcoins.crypto.ECPrivateKeyBytes" class="extype">ECPrivateKeyBytes</a></span>, <span name="message">message: <span name="scala.Predef.String" class="extype">String</span></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.16/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<span name="scala.Predef.String" class="extype">String</span>]</span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="MessageRpc.html" name="org.bitcoins.rpc.client.common.MessageRpc" id="org.bitcoins.rpc.client.common.MessageRpc" class="extype">MessageRpc</a></dd></dl></div></li><li class="indented0 " name="org.bitcoins.rpc.client.common.WalletRpc#signRawTransactionWithKey" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="signRawTransactionWithKey(transaction:org.bitcoins.core.protocol.transaction.Transaction,keys:Vector[org.bitcoins.crypto.ECPrivateKey],utxoDeps:Vector[org.bitcoins.commons.jsonmodels.bitcoind.RpcOpts.SignRawTransactionOutputParameter],sigHash:org.bitcoins.crypto.Ha
</p></div><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="WalletRpc.html" name="org.bitcoins.rpc.client.common.WalletRpc" id="org.bitcoins.rpc.client.common.WalletRpc" class="extype">WalletRpc</a></dd></dl></div></li><li class="indented0 " name="org.bitcoins.rpc.client.common.WalletRpc#signRawTransactionWithWallet" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="signRawTransactionWithWallet(transaction:org.bitcoins.core.protocol.transaction.Transaction,utxoDeps:Vector[org.bitcoins.commons.jsonmodels.bitcoind.RpcOpts.SignRawTransactionOutputParameter],sigHash:org.bitcoins.crypto.HashType):scala.concurrent.Future[org.bitcoins.commons.jsonmodels.bitcoind.SignRawTransactionResult]" class="anchorToMember"></a><a id="signRawTransactionWithWallet(Transaction,Vector[SignRawTransactionOutputParameter],HashType):Future[SignRawTransactionResult]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../org/bitcoins/rpc/client/common/BitcoindRpcClient.html#signRawTransactionWithWallet(transaction:org.bitcoins.core.protocol.transaction.Transaction,utxoDeps:Vector[org.bitcoins.commons.jsonmodels.bitcoind.RpcOpts.SignRawTransactionOutputParameter],sigHash:org.bitcoins.crypto.HashType):scala.concurrent.Future[org.bitcoins.commons.jsonmodels.bitcoind.SignRawTransactionResult]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">signRawTransactionWithWallet</span><span class="params">(<span name="transaction">transaction: <a href="../../../core/protocol/transaction/Transaction.html" name="org.bitcoins.core.protocol.transaction.Transaction" id="org.bitcoins.core.protocol.transaction.Transaction" class="extype">Transaction</a></span>, <span name="utxoDeps">utxoDeps: <a href="../../../../../scala/index.html#Vector[+A]=scala.collection.immutable.Vector[A]" name="scala.Vector" id="scala.Vector" class="extmbr">Vector</a>[<a href="../../../commons/jsonmodels/bitcoind/RpcOpts$$SignRawTransactionOutputParameter.html" name="org.bitcoins.commons.jsonmodels.bitcoind.RpcOpts.SignRawTransactionOutputParameter" id="org.bitcoins.commons.jsonmodels.bitcoind.RpcOpts.SignRawTransactionOutputParameter" class="extype">SignRawTransactionOutputParameter</a>]</span>, <span name="sigHash">sigHash: <a href="../../../crypto/HashType.html" name="org.bitcoins.crypto.HashType" id="org.bitcoins.crypto.HashType" class="extype">HashType</a> = <span class="symbol"><span class="name"><a href="../../../../index.html">HashType.sigHashAll</a></span></span></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.16/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="../../../commons/jsonmodels/bitcoind/SignRawTransactionResult.html" name="org.bitcoins.commons.jsonmodels.bitcoind.SignRawTransactionResult" id="org.bitcoins.commons.jsonmodels.bitcoind.SignRawTransactionResult" class="extype">SignRawTransactionResult</a>]</span></span><p class="shortcomment cmt">$signRawTx</p><div class="fullcomment"><div class="comment cmt"><p>$signRawTx</p><p>This RPC call signs the raw transaction with keys found in the Bitcoin
Deploy website Deploy website version based on afddf73c48d12515d44d11e959ac6d995fdbe61f
2024-04-21 01:15:38 +00:00
Core wallet.
Deploy website Deploy website version based on 0fd33dd4ea0a91c26007191e2cdb2898d325071e
2025-01-16 22:15:49 +00:00
</p></div><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="WalletRpc.html" name="org.bitcoins.rpc.client.common.WalletRpc" id="org.bitcoins.rpc.client.common.WalletRpc" class="extype">WalletRpc</a></dd></dl></div></li><li class="indented0 " name="org.bitcoins.rpc.client.common.WalletRpc#signRawTransactionWithWallet" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="signRawTransactionWithWallet(transaction:org.bitcoins.core.protocol.transaction.Transaction):scala.concurrent.Future[org.bitcoins.commons.jsonmodels.bitcoind.SignRawTransactionWithWalletResult]" class="anchorToMember"></a><a id="signRawTransactionWithWallet(Transaction):Future[SignRawTransactionWithWalletResult]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../org/bitcoins/rpc/client/common/BitcoindRpcClient.html#signRawTransactionWithWallet(transaction:org.bitcoins.core.protocol.transaction.Transaction):scala.concurrent.Future[org.bitcoins.commons.jsonmodels.bitcoind.SignRawTransactionWithWalletResult]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">signRawTransactionWithWallet</span><span class="params">(<span name="transaction">transaction: <a href="../../../core/protocol/transaction/Transaction.html" name="org.bitcoins.core.protocol.transaction.Transaction" id="org.bitcoins.core.protocol.transaction.Transaction" class="extype">Transaction</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.16/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="../../../commons/jsonmodels/bitcoind/SignRawTransactionWithWalletResult.html" name="org.bitcoins.commons.jsonmodels.bitcoind.SignRawTransactionWithWalletResult" id="org.bitcoins.commons.jsonmodels.bitcoind.SignRawTransactionWithWalletResult" class="extype">SignRawTransactionWithWalletResult</a>]</span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="WalletRpc.html" name="org.bitcoins.rpc.client.common.WalletRpc" id="org.bitcoins.rpc.client.common.WalletRpc" class="extype">WalletRpc</a></dd></dl></div></li><li class="indented0 " name="org.bitcoins.rpc.client.common.WalletRpc#signRawTransactionWithWallet" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="signRawTransactionWithWallet(transaction:org.bitcoins.core.protocol.transaction.Transaction,walletName:String):scala.concurrent.Future[org.bitcoins.commons.jsonmodels.bitcoind.SignRawTransactionWithWalletResult]" class="anchorToMember"></a><a id="signRawTransactionWithWallet(Transaction,String):Future[SignRawTransactionWithWalletResult]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../org/bitcoins/rpc/client/common/BitcoindRpcClient.html#signRawTransactionWithWallet(transaction:org.bitcoins.core.protocol.transaction.Transaction,walletName:String):scala.concurrent.Future[org.bitcoins.commons.jsonmodels.bitcoind.SignRawTransactionWithWalletResult]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">signRawTransactionWithWallet</span><span class="params">(<span name="transaction">transaction: <a href="../../../core/protocol/transaction/Transaction.html" name="org.bitcoins.core.protocol.transaction.Transaction" id="org.bitcoins.core.protocol.transaction.Transaction" class="extype">Transaction</a></span>, <span name="walletName">walletName: <span name="scala.Predef.String" class="extype">String</span></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.16/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="../../../commons/jsonmodels/bitcoind/SignRawTra
Deploy website Deploy website version based on afddf73c48d12515d44d11e959ac6d995fdbe61f
2024-04-21 01:15:38 +00:00
a future that completes when bitcoind is fully started. This future
Deploy website Deploy website version based on 0fd33dd4ea0a91c26007191e2cdb2898d325071e
2025-01-16 22:15:49 +00:00
times out after 60 seconds if the client cannot be started</p></dd></dl><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="Client.html" name="org.bitcoins.rpc.client.common.Client" id="org.bitcoins.rpc.client.common.Client" class="extype">Client</a> → <a href="../../../core/util/StartStop.html" name="org.bitcoins.core.util.StartStop" id="org.bitcoins.core.util.StartStop" class="extype">StartStop</a></dd></dl></div></li><li class="indented0 " name="org.bitcoins.commons.util.NativeProcessFactory#startBinary" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="startBinary():scala.concurrent.Future[Unit]" class="anchorToMember"></a><a id="startBinary():Future[Unit]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../org/bitcoins/rpc/client/common/BitcoindRpcClient.html#startBinary():scala.concurrent.Future[Unit]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">startBinary</span><span class="params">()</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.16/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="https://www.scala-lang.org/api/2.13.16/scala/Unit.html#scala.Unit" name="scala.Unit" id="scala.Unit" class="extype">Unit</a>]</span></span><p class="shortcomment cmt">Starts the binary by spinning up a new process</p><div class="fullcomment"><div class="comment cmt"><p>Starts the binary by spinning up a new process</p></div><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../../commons/util/NativeProcessFactory.html" name="org.bitcoins.commons.util.NativeProcessFactory" id="org.bitcoins.commons.util.NativeProcessFactory" class="extype">NativeProcessFactory</a></dd></dl></div></li><li class="indented0 " name="org.bitcoins.rpc.client.common.Client#stop" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="stop():scala.concurrent.Future[org.bitcoins.rpc.client.common.BitcoindRpcClient]" class="anchorToMember"></a><a id="stop():Future[BitcoindRpcClient]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../org/bitcoins/rpc/client/common/BitcoindRpcClient.html#stop():scala.concurrent.Future[org.bitcoins.rpc.client.common.BitcoindRpcClient]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">stop</span><span class="params">()</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.16/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="" name="org.bitcoins.rpc.client.common.BitcoindRpcClient" id="org.bitcoins.rpc.client.common.BitcoindRpcClient" class="extype">BitcoindRpcClient</a>]</span></span><p class="shortcomment cmt">Stop method for BitcoindRpcClient that is stopped, inherits from the
Deploy website Deploy website version based on afddf73c48d12515d44d11e959ac6d995fdbe61f
2024-04-21 01:15:38 +00:00
StartStop trait</p><div class="fullcomment"><div class="comment cmt"><p>Stop method for BitcoindRpcClient that is stopped, inherits from the
StartStop trait</p></div><dl class="paramcmts block"><dt>returns</dt><dd class="cmt"><p>
Deploy website Deploy website version based on 0fd33dd4ea0a91c26007191e2cdb2898d325071e
2025-01-16 22:15:49 +00:00
A future stopped bitcoindRPC client</p></dd></dl><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="Client.html" name="org.bitcoins.rpc.client.common.Client" id="org.bitcoins.rpc.client.common.Client" class="extype">Client</a> → <a href="../../../core/util/StartStop.html" name="org.bitcoins.core.util.StartStop" id="org.bitcoins.core.util.StartStop" class="extype">StartStop</a></dd></dl></div></li><li class="indented0 " name="org.bitcoins.commons.util.NativeProcessFactory#stopBinary" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="stopBinary():scala.concurrent.Future[Unit]" class="anchorToMember"></a><a id="stopBinary():Future[Unit]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../org/bitcoins/rpc/client/common/BitcoindRpcClient.html#stopBinary():scala.concurrent.Future[Unit]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">stopBinary</span><span class="params">()</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.16/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="https://www.scala-lang.org/api/2.13.16/scala/Unit.html#scala.Unit" name="scala.Unit" id="scala.Unit" class="extype">Unit</a>]</span></span><p class="shortcomment cmt">Stops the binary by destroying the underlying operating system process</p><div class="fullcomment"><div class="comment cmt"><p>Stops the binary by destroying the underlying operating system process</p><p>If the client is a remote client (not started on the host operating
Deploy website Deploy website version based on afddf73c48d12515d44d11e959ac6d995fdbe61f
2024-04-21 01:15:38 +00:00
system) this method is a no-op
Deploy website Deploy website version based on 0fd33dd4ea0a91c26007191e2cdb2898d325071e
2025-01-16 22:15:49 +00:00
</p></div><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../../commons/util/NativeProcessFactory.html" name="org.bitcoins.commons.util.NativeProcessFactory" id="org.bitcoins.commons.util.NativeProcessFactory" class="extype">NativeProcessFactory</a></dd></dl></div></li><li class="indented0 " name="org.bitcoins.rpc.client.common.P2PRpc#submitBlock" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="submitBlock(block:org.bitcoins.core.protocol.blockchain.Block):scala.concurrent.Future[Unit]" class="anchorToMember"></a><a id="submitBlock(Block):Future[Unit]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../org/bitcoins/rpc/client/common/BitcoindRpcClient.html#submitBlock(block:org.bitcoins.core.protocol.blockchain.Block):scala.concurrent.Future[Unit]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">submitBlock</span><span class="params">(<span name="block">block: <a href="../../../core/protocol/blockchain/Block.html" name="org.bitcoins.core.protocol.blockchain.Block" id="org.bitcoins.core.protocol.blockchain.Block" class="extype">Block</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.16/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="https://www.scala-lang.org/api/2.13.16/scala/Unit.html#scala.Unit" name="scala.Unit" id="scala.Unit" class="extype">Unit</a>]</span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="P2PRpc.html" name="org.bitcoins.rpc.client.common.P2PRpc" id="org.bitcoins.rpc.client.common.P2PRpc" class="extype">P2PRpc</a></dd></dl></div></li><li class="indented0 " name="org.bitcoins.rpc.client.v18.V18AssortedRpc#submitHeader" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="submitHeader(header:org.bitcoins.core.protocol.blockchain.BlockHeader):scala.concurrent.Future[Unit]" class="anchorToMember"></a><a id="submitHeader(BlockHeader):Future[Unit]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../org/bitcoins/rpc/client/common/BitcoindRpcClient.html#submitHeader(header:org.bitcoins.core.protocol.blockchain.BlockHeader):scala.concurrent.Future[Unit]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">submitHeader</span><span class="params">(<span name="header">header: <a href="../../../core/protocol/blockchain/BlockHeader.html" name="org.bitcoins.core.protocol.blockchain.BlockHeader" id="org.bitcoins.core.protocol.blockchain.BlockHeader" class="extype">BlockHeader</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.16/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="https://www.scala-lang.org/api/2.13.16/scala/Unit.html#scala.Unit" name="scala.Unit" id="scala.Unit" class="extype">Unit</a>]</span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../v18/V18AssortedRpc.html" name="org.bitcoins.rpc.client.v18.V18AssortedRpc" id="org.bitcoins.rpc.client.v18.V18AssortedRpc" class="extype">V18AssortedRpc</a></dd></dl></div></li><li class="indented0 " name="org.bitcoins.rpc.client.common.BlockchainRpc#syncWithValidationInterfaceQueue" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="syncWithValidationInterfaceQueue():scala.concurrent.Future[Unit]" class="anchorToMember"></a><a id="syncWithValidationInterfaceQueue():Future[Unit]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../org/bitcoins/rpc/client/common/BitcoindRpcClient.html#syncWithValidationInterfaceQueue():scala.concurrent.Fut
Deploy website Deploy website version based on afddf73c48d12515d44d11e959ac6d995fdbe61f
2024-04-21 01:15:38 +00:00
was there when we entered this function</p><div class="fullcomment"><div class="comment cmt"><p>Waits for the validation interface queue to catch up on everything that
was there when we entered this function</p></div><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="BlockchainRpc.html" name="org.bitcoins.rpc.client.common.BlockchainRpc" id="org.bitcoins.rpc.client.common.BlockchainRpc" class="extype">BlockchainRpc</a></dd><dt>See also</dt><dd><span class="cmt"><p>
Deploy website Deploy website version based on a911d53eaec63caec699ee8098acd153677379ad
2025-01-17 15:39:32 +00:00
<a href="https://github.com/bitcoin/bitcoin/issues/27085" target="_blank">https://github.com/bitcoin/bitcoin/issues/27085</a></p></span></dd></dl></div></li><li class="indented0 " name="scala.AnyRef#synchronized" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="synchronized[T0](x$1:=&gt;T0):T0" class="anchorToMember"></a><a id="synchronized[T0](=&gt;T0):T0" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../org/bitcoins/rpc/client/common/BitcoindRpcClient.html#synchronized[T0](x$1:=&gt;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">synchronized</span><span class="tparams">[<span name="T0">T0</span>]</span><span class="params">(<span name="arg0">arg0: =&gt; <span name="java.lang.AnyRef.synchronized.T0" class="extype">T0</span></span>)</span><span class="result">: <span name="java.lang.AnyRef.synchronized.T0" class="extype">T0</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef</dd></dl></div></li><li class="indented0 " name="org.bitcoins.rpc.client.common.BitcoindRpcClient#system" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="system:org.apache.pekko.actor.ActorSystem" class="anchorToMember"></a><a id="system:ActorSystem" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../org/bitcoins/rpc/client/common/BitcoindRpcClient.html#system:org.apache.pekko.actor.ActorSystem" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">implicit </span> <span class="kind">val</span></span> <span class="symbol"><span class="name">system</span><span class="result">: <a href="https://pekko.apache.org/api/pekko/1.1.3/org/apache/pekko/actor/ActorSystem.html#org.apache.pekko.actor.ActorSystem" name="org.apache.pekko.actor.ActorSystem" id="org.apache.pekko.actor.ActorSystem" class="extype">ActorSystem</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="" name="org.bitcoins.rpc.client.common.BitcoindRpcClient" id="org.bitcoins.rpc.client.common.BitcoindRpcClient" class="extype">BitcoindRpcClient</a> → <a href="Client.html" name="org.bitcoins.rpc.client.common.Client" id="org.bitcoins.rpc.client.common.Client" class="extype">Client</a></dd></dl></div></li><li class="indented0 " name="org.bitcoins.rpc.client.common.MempoolRpc#testMempoolAccept" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="testMempoolAccept(transaction:Vector[org.bitcoins.core.protocol.transaction.Transaction],maxFeeRate:Double):scala.concurrent.Future[Vector[org.bitcoins.commons.jsonmodels.bitcoind.TestMempoolAcceptResultPostV24]]" class="anchorToMember"></a><a id="testMempoolAccept(Vector[Transaction],Double):Future[Vector[TestMempoolAcceptResultPostV24]]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../org/bitcoins/rpc/client/common/BitcoindRpcClient.html#testMempoolAccept(transaction:Vector[org.bitcoins.core.protocol.transaction.Transaction],maxFeeRate:Double):scala.concurrent.Future[Vector[org.bitcoins.commons.jsonmodels.bitcoind.TestMempoolAcceptResultPostV24]]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">testMempoolAccept</span><span class="params">(<span name="transaction">transaction: <a href="../../../../../scala/index.html#Vector[+A]=scala.collection.immutable.Vector[A]" name="scala.Vector" id="scala.Vector" class="extmbr">Vector</a>[<a href="../../../core/protocol/transaction/Transaction.html" name="org.bitcoins.core.protocol.transaction.Transaction" id="org.bitcoins.core.protocol.transaction.Transaction" class="extype">Transaction</a>]</span>, <span name="maxFeeRate">maxFeeRate: <a href="https://www.scala-lang.org/api/
Deploy website Deploy website version based on afddf73c48d12515d44d11e959ac6d995fdbe61f
2024-04-21 01:15:38 +00:00
accessible
</p><div class="fullcomment"><div class="comment cmt"><p>This is here (and not in JsonWrriters) so that the implicit network val is
accessible
</p></div><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="Client.html" name="org.bitcoins.rpc.client.common.Client" id="org.bitcoins.rpc.client.common.Client" class="extype">Client</a></dd></dl></div></li><li class="indented0 " name="org.bitcoins.rpc.client.common.Client.ECPrivateKeyWrites" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ECPrivateKeyWrites" class="anchorToMember"></a><a id="ECPrivateKeyWrites:ECPrivateKeyWrites" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../org/bitcoins/rpc/client/common/Client$ECPrivateKeyWrites$.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">implicit </span> <span class="kind">object</span></span> <span class="symbol"><a href="Client$ECPrivateKeyWrites$.html" title="This is here (and not in JsonWrriters) so that the implicit network val is accessible"><span class="name">ECPrivateKeyWrites</span></a><span class="result"> extends <a href="https://www.playframework.com/documentation/latest/api/scala/play/api/libs/json/Writes.html#play.api.libs.json.Writes" name="play.api.libs.json.Writes" id="play.api.libs.json.Writes" class="extype">Writes</a>[<a href="../../../crypto/ECPrivateKey.html" name="org.bitcoins.crypto.ECPrivateKey" id="org.bitcoins.crypto.ECPrivateKey" class="extype">ECPrivateKey</a>]</span></span><p class="shortcomment cmt">This is here (and not in JsonWrriters) so that the implicit network val is
accessible
</p><div class="fullcomment"><div class="comment cmt"><p>This is here (and not in JsonWrriters) so that the implicit network val is
accessible
Deploy website Deploy website version based on 0fd33dd4ea0a91c26007191e2cdb2898d325071e
2025-01-16 22:15:49 +00:00
</p></div><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="Client.html" name="org.bitcoins.rpc.client.common.Client" id="org.bitcoins.rpc.client.common.Client" class="extype">Client</a></dd></dl></div></li></ol></div></div><div id="inheritedMembers"><div name="org.bitcoins.rpc.client.v20.V20MultisigRpc" class="parent"><h3>Inherited from <a href="../v20/V20MultisigRpc.html" name="org.bitcoins.rpc.client.v20.V20MultisigRpc" id="org.bitcoins.rpc.client.v20.V20MultisigRpc" class="extype">V20MultisigRpc</a></h3></div><div name="org.bitcoins.rpc.client.common.DescriptorRpc" class="parent"><h3>Inherited from <a href="DescriptorRpc.html" name="org.bitcoins.rpc.client.common.DescriptorRpc" id="org.bitcoins.rpc.client.common.DescriptorRpc" class="extype">DescriptorRpc</a></h3></div><div name="org.bitcoins.rpc.client.v18.V18AssortedRpc" class="parent"><h3>Inherited from <a href="../v18/V18AssortedRpc.html" name="org.bitcoins.rpc.client.v18.V18AssortedRpc" id="org.bitcoins.rpc.client.v18.V18AssortedRpc" class="extype">V18AssortedRpc</a></h3></div><div name="org.bitcoins.rpc.client.common.UtilRpc" class="parent"><h3>Inherited from <a href="UtilRpc.html" name="org.bitcoins.rpc.client.common.UtilRpc" id="org.bitcoins.rpc.client.common.UtilRpc" class="extype">UtilRpc</a></h3></div><div name="org.bitcoins.rpc.client.common.PsbtRpc" class="parent"><h3>Inherited from <a href="PsbtRpc.html" name="org.bitcoins.rpc.client.common.PsbtRpc" id="org.bitcoins.rpc.client.common.PsbtRpc" class="extype">PsbtRpc</a></h3></div><div name="org.bitcoins.rpc.client.common.WalletRpc" class="parent"><h3>Inherited from <a href="WalletRpc.html" name="org.bitcoins.rpc.client.common.WalletRpc" id="org.bitcoins.rpc.client.common.WalletRpc" class="extype">WalletRpc</a></h3></div><div name="org.bitcoins.rpc.client.common.UTXORpc" class="parent"><h3>Inherited from <a href="UTXORpc.html" name="org.bitcoins.rpc.client.common.UTXORpc" id="org.bitcoins.rpc.client.common.UTXORpc" class="extype">UTXORpc</a></h3></div><div name="org.bitcoins.rpc.client.common.TransactionRpc" class="parent"><h3>Inherited from <a href="TransactionRpc.html" name="org.bitcoins.rpc.client.common.TransactionRpc" id="org.bitcoins.rpc.client.common.TransactionRpc" class="extype">TransactionRpc</a></h3></div><div name="org.bitcoins.rpc.client.common.RawTransactionRpc" class="parent"><h3>Inherited from <a href="RawTransactionRpc.html" name="org.bitcoins.rpc.client.common.RawTransactionRpc" id="org.bitcoins.rpc.client.common.RawTransactionRpc" class="extype">RawTransactionRpc</a></h3></div><div name="org.bitcoins.rpc.client.common.P2PRpc" class="parent"><h3>Inherited from <a href="P2PRpc.html" name="org.bitcoins.rpc.client.common.P2PRpc" id="org.bitcoins.rpc.client.common.P2PRpc" class="extype">P2PRpc</a></h3></div><div name="org.bitcoins.rpc.client.common.NodeRpc" class="parent"><h3>Inherited from <a href="NodeRpc.html" name="org.bitcoins.rpc.client.common.NodeRpc" id="org.bitcoins.rpc.client.common.NodeRpc" class="extype">NodeRpc</a></h3></div><div name="org.bitcoins.rpc.client.common.MultisigRpc" class="parent"><h3>Inherited from <a href="MultisigRpc.html" name="org.bitcoins.rpc.client.common.MultisigRpc" id="org.bitcoins.rpc.client.common.MultisigRpc" class="extype">MultisigRpc</a></h3></div><div name="org.bitcoins.rpc.client.common.MiningRpc" class="parent"><h3>Inherited from <a href="MiningRpc.html" name="org.bitcoins.rpc.client.common.MiningRpc" id="org.bitcoins.rpc.client.common.MiningRpc" class="extype">MiningRpc</a></h3></div><div name="org.bitcoins.rpc.client.common.MempoolRpc" class="parent"><h3>Inherited from <a href="MempoolRpc.html" name="org.bitcoins.rpc.client.common.MempoolRpc" id="org.bitcoins.rpc.client.common.MempoolRpc" class="extype">MempoolRpc</a></h3></div><div name="org.bitcoins.rpc.client.common.MessageRpc" class="parent"><h3>Inherited from <a href="MessageRpc.html" name="org.bitcoins.rpc.client.common.MessageRpc" id="org.bitcoins.rpc.client.common.MessageRpc" class="extype">MessageRpc</a></h3></div><div name="org.bitcoins.rpc.client.common.BlockchainRp
Reference in a new issue Copy permalink