Packages

class BitcoindRpcClient extends Client with FeeRateApi with NodeApi with ChainApi with BlockchainRpc with MessageRpc with MempoolRpc with MiningRpc with MultisigRpc with NodeRpc with P2PRpc with RawTransactionRpc with TransactionRpc with UTXORpc with WalletRpc with PsbtRpc with UtilRpc with V18AssortedRpc with DescriptorRpc with V20MultisigRpc

This class is not guaranteed to be compatible with any particular version of Bitcoin Core. It implements RPC calls that are similar across different versions. If you need RPC calls specific to a version, check out

If a RPC call fails for any reason, a BitcoindException is thrown. This is a sealed abstract class, so you can pattern match easily on the errors, and handle them as you see fit.

Linear Supertypes
V20MultisigRpc, DescriptorRpc, V18AssortedRpc, UtilRpc, PsbtRpc, WalletRpc, UTXORpc, TransactionRpc, RawTransactionRpc, P2PRpc, NodeRpc, MultisigRpc, MiningRpc, MempoolRpc, MessageRpc, BlockchainRpc, ChainApi, ChainQueryApi, NodeApi, FeeRateApi, Client, NativeProcessFactory, StartStopAsync[BitcoindRpcClient], StartStop[Future[BitcoindRpcClient]], BitcoinSLogger, AnyRef, Any
Known Subclasses
BitcoindV29RpcClient, BitcoindV30RpcClient, BitcoindV31RpcClient
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BitcoindRpcClient
  2. V20MultisigRpc
  3. DescriptorRpc
  4. V18AssortedRpc
  5. UtilRpc
  6. PsbtRpc
  7. WalletRpc
  8. UTXORpc
  9. TransactionRpc
  10. RawTransactionRpc
  11. P2PRpc
  12. NodeRpc
  13. MultisigRpc
  14. MiningRpc
  15. MempoolRpc
  16. MessageRpc
  17. BlockchainRpc
  18. ChainApi
  19. ChainQueryApi
  20. NodeApi
  21. FeeRateApi
  22. Client
  23. NativeProcessFactory
  24. StartStopAsync
  25. StartStop
  26. BitcoinSLogger
  27. AnyRef
  28. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new BitcoindRpcClient(instance: BitcoindInstance)(implicit system: ActorSystem)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def abandonTransaction(txid: DoubleSha256Digest): Future[Unit]
    Definition Classes
    TransactionRpc
  5. def abandonTransaction(txid: DoubleSha256DigestBE): Future[Unit]
    Definition Classes
    TransactionRpc
  6. def abortPrivateBroadcast(id: DoubleSha256DigestBE): Future[AbortPrivateBroadcastResult]

    Abort private broadcast attempts for a transaction currently being privately broadcast.

    Abort private broadcast attempts for a transaction currently being privately broadcast. The transaction will be removed from the private broadcast queue.

    New in Bitcoin Core v31.

    id

    A transaction identifier (txid or wtxid) to abort

    Definition Classes
    P2PRpc
  7. def abortRescan(): Future[Unit]
    Definition Classes
    NodeRpc
  8. def addMultiSigAddress(minSignatures: Int, keys: Vector[Either[ECPublicKey, P2PKHAddress]], account: String, addressType: AddressType): Future[MultiSigResultPostV20]
    Definition Classes
    V20MultisigRpc → MultisigRpc
  9. def addMultiSigAddress(minSignatures: Int, keys: Vector[Either[ECPublicKey, P2PKHAddress]], addressType: AddressType): Future[MultiSigResultPostV20]
    Definition Classes
    V20MultisigRpc → MultisigRpc
  10. def addMultiSigAddress(minSignatures: Int, keys: Vector[Either[ECPublicKey, P2PKHAddress]], account: String): Future[MultiSigResultPostV20]
    Definition Classes
    V20MultisigRpc → MultisigRpc
  11. def addMultiSigAddress(minSignatures: Int, keys: Vector[Either[ECPublicKey, P2PKHAddress]]): Future[MultiSigResultPostV20]
    Definition Classes
    V20MultisigRpc → MultisigRpc
  12. def addNode(address: URI, command: AddNodeArgument, v2transport: Boolean = true): Future[Unit]
    Definition Classes
    P2PRpc
  13. def analyzePsbt(psbt: PSBT): Future[AnalyzePsbtResult]
    Definition Classes
    PsbtRpc
  14. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  15. def backupWallet(destination: String, walletName: String = DEFAULT_WALLET): Future[Unit]
    Definition Classes
    WalletRpc
  16. def bitcoindCall[T](command: String, parameters: List[JsValue] = List.empty, printError: Boolean = true, uriExtensionOpt: Option[String] = None)(implicit reader: Reads[T]): Future[T]
    Attributes
    protected
    Definition Classes
    Client
  17. def bitcoindRpcAppConfig: BitcoindRpcAppConfig
  18. def broadcastTransaction(transaction: Transaction): Future[Unit]

    Broadcasts the given transaction over the P2P network

    Broadcasts the given transaction over the P2P network

    Definition Classes
    NodeApi
  19. def broadcastTransactions(transactions: Vector[Transaction]): Future[Unit]

    Broadcasts the given transactions over the P2P network

    Broadcasts the given transactions over the P2P network

    Definition Classes
    BitcoindRpcClient → NodeApi
  20. def buildRequest(instance: BitcoindInstance, methodName: String, params: JsArray, uriExtensionOpt: Option[String] = None): HttpRequest
    Attributes
    protected
    Definition Classes
    Client
  21. def bumpFee(txid: DoubleSha256Digest, confTarget: Int, totalFee: Option[Satoshis], replaceable: Boolean, estimateMode: String): Future[BumpFeeResult]
    Definition Classes
    TransactionRpc
  22. def bumpFee(txid: DoubleSha256DigestBE, confTarget: Int = 6, totalFee: Option[Satoshis] = None, replaceable: Boolean = true, estimateMode: String = "UNSET"): Future[BumpFeeResult]
    Definition Classes
    TransactionRpc
  23. def clearBanned(): Future[Unit]
    Definition Classes
    P2PRpc
  24. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  25. lazy val cmd: Vector[String]

    The command to start the daemon on the underlying OS

    The command to start the daemon on the underlying OS

    Definition Classes
    Client → NativeProcessFactory
  26. def combinePsbt(psbts: Vector[PSBT]): Future[PSBT]
    Definition Classes
    PsbtRpc
  27. def combineRawTransaction(txs: Vector[Transaction]): Future[Transaction]
    Definition Classes
    RawTransactionRpc
  28. lazy val confFileOpt: Option[Path]

    The configuration file of the Bitcoin Core daemon This returns the conf file is the underlying instance is BitcoindInstanceLocal and None if the underlying instance is BitcoindInstanceRemote

    The configuration file of the Bitcoin Core daemon This returns the conf file is the underlying instance is BitcoindInstanceLocal and None if the underlying instance is BitcoindInstanceRemote

    Definition Classes
    Client
  29. def convertToPsbt(rawTx: Transaction, permitSigData: Boolean = false, isWitness: Option[Boolean] = None): Future[PSBT]
    Definition Classes
    PsbtRpc
  30. def createMultiSig(minSignatures: Int, keys: Vector[ECPublicKey], addressType: AddressType, walletName: String = BitcoindRpcClient.DEFAULT_WALLET_NAME): Future[MultiSigResultPostV20]
    Definition Classes
    V20MultisigRpc → MultisigRpc
  31. def createPsbt(inputs: Vector[TransactionInput], outputs: Map[BitcoinAddress, CurrencyUnit], locktime: Int = 0, replacable: Boolean = false): Future[PSBT]
    Definition Classes
    PsbtRpc
  32. def createRawTransaction(inputs: Vector[TransactionInput], outputs: Map[BitcoinAddress, Bitcoins], locktime: Int = 0): Future[Transaction]
    Definition Classes
    RawTransactionRpc
  33. def createWallet(walletName: String, disablePrivateKeys: Boolean = false, blank: Boolean = false, passphrase: String = "", avoidReuse: Boolean = false, descriptors: Boolean = true): Future[CreateWalletResult]

    blank

    Not available to versions before v19

    passphrase

    Not available to versions before v19

    Definition Classes
    WalletRpc
  34. def createWalletDescriptor(addressType: AddressType, options: Option[CreateWalletDescriptorOptions] = None, walletName: String = DEFAULT_WALLET): Future[CreateWalletDescriptorResult]
    Definition Classes
    WalletRpc
  35. def decodePsbt(psbt: PSBT): Future[DecodePsbtResult]
    Definition Classes
    PsbtRpc
  36. def decodeRawTransaction(transaction: Transaction): Future[RpcTransaction]
    Definition Classes
    RawTransactionRpc
  37. def decodeScript(script: ScriptPubKey): Future[DecodeScriptResult]
    Definition Classes
    UtilRpc
  38. def deriveAddresses(descriptor: Descriptor, range: Option[Vector[Double]]): Future[DeriveAddressesResult]
    Definition Classes
    DescriptorRpc
  39. def disconnectNode(address: URI): Future[Unit]
    Definition Classes
    P2PRpc
  40. def downloadBlocks(blockHashes: Vector[DoubleSha256DigestBE]): Future[Unit]

    Request the underlying node to download the given blocks from its peers and feed the blocks to org.bitcoins.node.NodeCallbacks.

    Request the underlying node to download the given blocks from its peers and feed the blocks to org.bitcoins.node.NodeCallbacks.

    Definition Classes
    BitcoindRpcClient → NodeApi
  41. def dumpTxOutSet(path: Path, dumpTxOutSetType: DumpTxOutSetType): Future[DumpTxOutSetResult]
    Definition Classes
    UTXORpc
  42. implicit val eCPrivateKeyBytesWrites: Writes[ECPrivateKeyBytes]
    Definition Classes
    Client
  43. implicit val eCPrivateKeyWrites: Writes[ECPrivateKey]
    Definition Classes
    Client
  44. def encryptWallet(passphrase: String, walletName: String = DEFAULT_WALLET): Future[String]
    Definition Classes
    WalletRpc
  45. def epochSecondToBlockHeight(time: Long): Future[Int]

    Gets the block height of the closest block to the given time

    Gets the block height of the closest block to the given time

    Definition Classes
    BitcoindRpcClient → ChainQueryApi
  46. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  47. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  48. def estimateSmartFee(blocks: Int, mode: FeeEstimationMode = FeeEstimationMode.Ecnomical): Future[EstimateSmartFeeResult]
    Definition Classes
    TransactionRpc
  49. implicit val executionContext: ExecutionContext
    Attributes
    protected
    Definition Classes
    Client → NativeProcessFactory
  50. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  51. def finalizePsbt(psbt: PSBT, extract: Boolean = true): Future[FinalizePsbtResult]
    Definition Classes
    PsbtRpc
  52. def fundRawTransaction(transaction: Transaction, options: FundRawTransactionOptions, walletName: String): Future[FundRawTransactionResult]
    Definition Classes
    RawTransactionRpc
  53. def fundRawTransaction(transaction: Transaction, options: FundRawTransactionOptions): Future[FundRawTransactionResult]
    Definition Classes
    RawTransactionRpc
  54. def fundRawTransaction(transaction: Transaction, walletName: String): Future[FundRawTransactionResult]
    Definition Classes
    RawTransactionRpc
  55. def fundRawTransaction(transaction: Transaction): Future[FundRawTransactionResult]
    Definition Classes
    RawTransactionRpc
  56. def generate(numBlocks: Int): Future[Vector[DoubleSha256DigestBE]]

    Sends funds to an external address to bitcoin core's wallet, this increases bitcoin core performance If you want to send funds somewhere specific use generateToAddress

  57. def generateBlock(address: BitcoinAddress, transactions: Vector[Transaction]): Future[DoubleSha256DigestBE]
    Definition Classes
    MiningRpc
  58. def generateToAddress(blocks: Int, address: BitcoinAddress, maxTries: Int = 1000000): Future[Vector[DoubleSha256DigestBE]]
    Definition Classes
    MiningRpc
  59. def generateToDescriptor(numBlocks: Int, descriptor: String, maxTries: Long = 1000000): Future[Vector[DoubleSha256DigestBE]]
    Definition Classes
    MiningRpc
  60. def getAddedNodeInfo(node: URI): Future[Vector[Node]]
    Definition Classes
    P2PRpc
  61. def getAddedNodeInfo: Future[Vector[Node]]
    Definition Classes
    P2PRpc
  62. def getAddrManInfo(): Future[GetAddrmanInfoResponse]
    Definition Classes
    P2PRpc
  63. def getAddressInfo(address: BitcoinAddress, walletName: String = DEFAULT_WALLET): Future[AddressInfoResult]
    Definition Classes
    WalletRpc
  64. def getBalance(walletName: String): Future[Bitcoins]
    Definition Classes
    WalletRpc
  65. def getBalance: Future[Bitcoins]
    Definition Classes
    WalletRpc
  66. def getBalances(walletName: String): Future[GetBalancesResult]
    Definition Classes
    WalletRpc
  67. def getBalances: Future[GetBalancesResult]
    Definition Classes
    WalletRpc
  68. def getBestBlockHash(): Future[DoubleSha256DigestBE]

    Gets the hash of the block that is what we consider "best"

    Gets the hash of the block that is what we consider "best"

    Definition Classes
    BlockchainRpc → ChainQueryApi
  69. def getBestBlockHeader(): Future[BlockHeaderDb]

    Gets the best block header we have

    Gets the best block header we have

    Definition Classes
    BitcoindRpcClient → ChainApi
  70. def getBestChainTips(): Future[Vector[BlockHeaderDb]]

    Gets all chain tips with the heaviest work

    Gets all chain tips with the heaviest work

    Definition Classes
    BitcoindRpcClient → ChainApi
  71. def getBestFilter(): Future[Option[CompactFilterDb]]
    Definition Classes
    BlockchainRpc → ChainApi
  72. def getBestFilterHeader(): Future[Option[CompactFilterHeaderDb]]

    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.

    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

    Definition Classes
    BlockchainRpc → ChainApi
  73. def getBestHashBlockHeight()(implicit ec: ExecutionContext): Future[Int]
    Definition Classes
    ChainQueryApi
  74. def getBlock(headerHash: DoubleSha256Digest): Future[GetBlockResult]
    Definition Classes
    BlockchainRpc
  75. def getBlock(headerHash: DoubleSha256DigestBE): Future[GetBlockResult]
    Definition Classes
    BlockchainRpc
  76. def getBlockChainInfo: Future[GetBlockChainInfoResult]
    Definition Classes
    BlockchainRpc
  77. def getBlockCount(): Future[Int]

    Gets the number of blocks in the database

    Gets the number of blocks in the database

    Definition Classes
    BlockchainRpc → ChainApi
  78. def getBlockFilter(blockhash: DoubleSha256DigestBE, filtertype: FilterType): Future[GetBlockFilterResult]
    Definition Classes
    BlockchainRpc
  79. def getBlockHash(height: Int): Future[DoubleSha256DigestBE]
    Definition Classes
    BlockchainRpc
  80. def getBlockHeader(headerHash: DoubleSha256Digest): Future[GetBlockHeaderResult]
    Definition Classes
    BlockchainRpc
  81. def getBlockHeader(headerHash: DoubleSha256DigestBE): Future[GetBlockHeaderResult]
    Definition Classes
    BlockchainRpc
  82. def getBlockHeaderRaw(headerHash: DoubleSha256Digest): Future[BlockHeader]
    Definition Classes
    BlockchainRpc
  83. def getBlockHeaderRaw(headerHash: DoubleSha256DigestBE): Future[BlockHeader]
    Definition Classes
    BlockchainRpc
  84. def getBlockHeight(blockHash: DoubleSha256DigestBE): Future[Option[Int]]

    Gets the height of the given block

    Gets the height of the given block

    Definition Classes
    BitcoindRpcClient → ChainQueryApi
  85. def getBlockRaw(headerHash: DoubleSha256Digest): Future[Block]
    Definition Classes
    BlockchainRpc
  86. def getBlockRaw(headerHash: DoubleSha256DigestBE): Future[Block]
    Definition Classes
    BlockchainRpc
  87. def getBlockTemplate(request: Option[BlockTemplateRequest] = None): Future[GetBlockTemplateResult]
    Definition Classes
    MiningRpc
  88. def getBlockWithTransactions(headerHash: DoubleSha256Digest): Future[GetBlockWithTransactionsResult]
    Definition Classes
    BlockchainRpc
  89. def getBlockWithTransactions(headerHash: DoubleSha256DigestBE): Future[GetBlockWithTransactionsResultV22]
    Definition Classes
    BlockchainRpc
  90. def getChainStates(): Future[ChainStateResult]
    Definition Classes
    BlockchainRpc
  91. def getChainTips: Future[Vector[ChainTip]]
    Definition Classes
    BlockchainRpc
  92. def getChainTxStats(blocks: Int, blockHash: DoubleSha256Digest): Future[GetChainTxStatsResult]
    Definition Classes
    BlockchainRpc
  93. def getChainTxStats(blocks: Int, blockHash: DoubleSha256DigestBE): Future[GetChainTxStatsResult]
    Definition Classes
    BlockchainRpc
  94. def getChainTxStats(blocks: Int): Future[GetChainTxStatsResult]
    Definition Classes
    BlockchainRpc
  95. def getChainTxStats: Future[GetChainTxStatsResult]
    Definition Classes
    BlockchainRpc
  96. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  97. def getConnectionCount: Future[Int]
    Definition Classes
    BitcoindRpcClient → P2PRpc → NodeApi
  98. def getDaemon: BitcoindInstance
    Definition Classes
    Client
  99. def getDescriptorActivity(blockHashes: Vector[DoubleSha256DigestBE], scanobjects: Vector[Descriptor], includeMempool: Boolean = true): Future[GetDescriptorActivityResult]
    Definition Classes
    BlockchainRpc
  100. def getDescriptorInfo(descriptor: Descriptor): Future[GetDescriptorInfoResult]
    Definition Classes
    DescriptorRpc
  101. def getDifficulty: Future[BigDecimal]
    Definition Classes
    BlockchainRpc
  102. def getFeeRate(): Future[FeeUnit]
    Definition Classes
    BitcoindRpcClient → FeeRateApi
  103. def getFilter(hash: DoubleSha256DigestBE): Future[Option[CompactFilterDb]]

    Looks up a compact filter by its hash.

    Looks up a compact filter by its hash.

    Definition Classes
    BlockchainRpc → ChainApi
  104. def getFilterCount(): Future[Int]

    Gets the number of compact filters in the database

    Gets the number of compact filters in the database

    Definition Classes
    BlockchainRpc → ChainApi → ChainQueryApi
  105. def getFilterHeader(blockHash: DoubleSha256DigestBE): Future[Option[CompactFilterHeaderDb]]

    Looks up a compact filter header by its hash.

    Looks up a compact filter header by its hash.

    Definition Classes
    BlockchainRpc → ChainApi
  106. def getFilterHeaderCount(): Future[Int]

    Gets the number of compact filter headers in the database

    Gets the number of compact filter headers in the database

    Definition Classes
    BlockchainRpc → ChainApi
  107. def getFilterHeadersAtHeight(height: Int): Future[Vector[CompactFilterHeaderDb]]

    Looks up a compact filter header by its height.

    Looks up a compact filter header by its height.

    Definition Classes
    BlockchainRpc → ChainApi
  108. def getFiltersAtHeight(height: Int): Future[Vector[CompactFilterDb]]

    Looks up a compact filter by its height.

    Looks up a compact filter by its height.

    Definition Classes
    BlockchainRpc → ChainApi
  109. def getFiltersBetweenHeights(startHeight: Int, endHeight: Int): Future[Vector[FilterResponse]]
    Definition Classes
    BlockchainRpc → ChainQueryApi
  110. def getHDKeys(walletName: String = DEFAULT_WALLET): Future[Vector[GetHDKeysResult]]
    Definition Classes
    WalletRpc
  111. def getHeader(hash: DoubleSha256DigestBE): Future[Option[BlockHeaderDb]]

    Gets a org.bitcoins.core.api.chain.db.BlockHeaderDb from the chain's database

    Gets a org.bitcoins.core.api.chain.db.BlockHeaderDb from the chain's database

    Definition Classes
    BitcoindRpcClient → ChainApi
  112. def getHeaders(hashes: Vector[DoubleSha256DigestBE]): Future[Vector[Option[BlockHeaderDb]]]
    Definition Classes
    BitcoindRpcClient → ChainApi
  113. def getHeadersAtHeight(height: Int): Future[Vector[BlockHeaderDb]]

    Gets all org.bitcoins.core.api.chain.db.BlockHeaderDbs at a given height

    Gets all org.bitcoins.core.api.chain.db.BlockHeaderDbs at a given height

    Definition Classes
    BitcoindRpcClient → ChainApi
  114. def getHeadersBetween(from: BlockHeaderDb, to: BlockHeaderDb): Future[Vector[BlockHeaderDb]]

    Fetchs the block headers between from and to (inclusive).

    Fetchs the block headers between from and to (inclusive).

    Definition Classes
    BitcoindRpcClient → ChainApi
  115. def getHeightByBlockStamp(blockStamp: BlockStamp): Future[Int]

    Returns the block height of the given block stamp

    Returns the block height of the given block stamp

    Definition Classes
    BitcoindRpcClient → ChainApi → ChainQueryApi
  116. def getIndexInfo(indexName: String): Future[IndexInfoResult]
    Definition Classes
    UtilRpc
  117. def getIndexInfo: Future[Map[String, IndexInfoResult]]
    Definition Classes
    UtilRpc
  118. def getMedianTimePast(): Future[Long]

    calculates the median time passed

    calculates the median time passed

    Definition Classes
    BitcoindRpcClient → ChainQueryApi
  119. def getMemPoolAncestors(txid: DoubleSha256Digest): Future[Vector[DoubleSha256DigestBE]]
    Definition Classes
    MempoolRpc
  120. def getMemPoolAncestors(txid: DoubleSha256DigestBE): Future[Vector[DoubleSha256DigestBE]]
    Definition Classes
    MempoolRpc
  121. def getMemPoolAncestorsVerbose(txid: DoubleSha256Digest): Future[Map[DoubleSha256DigestBE, GetMemPoolResult]]
    Definition Classes
    MempoolRpc
  122. def getMemPoolAncestorsVerbose(txid: DoubleSha256DigestBE): Future[Map[DoubleSha256DigestBE, GetMemPoolResult]]
    Definition Classes
    MempoolRpc
  123. def getMemPoolDescendants(txid: DoubleSha256Digest): Future[Vector[DoubleSha256DigestBE]]
    Definition Classes
    MempoolRpc
  124. def getMemPoolDescendants(txid: DoubleSha256DigestBE): Future[Vector[DoubleSha256DigestBE]]
    Definition Classes
    MempoolRpc
  125. def getMemPoolDescendantsVerbose(txid: DoubleSha256Digest): Future[Map[DoubleSha256DigestBE, GetMemPoolResult]]
    Definition Classes
    MempoolRpc
  126. def getMemPoolDescendantsVerbose(txid: DoubleSha256DigestBE): Future[Map[DoubleSha256DigestBE, GetMemPoolResult]]
    Definition Classes
    MempoolRpc
  127. def getMemPoolEntry(txid: DoubleSha256Digest): Future[GetMemPoolEntryResult]
    Definition Classes
    MempoolRpc
  128. def getMemPoolEntry(txid: DoubleSha256DigestBE): Future[GetMemPoolEntryResult]
    Definition Classes
    MempoolRpc
  129. def getMemPoolEntryOpt(txid: DoubleSha256DigestBE): Future[Option[GetMemPoolEntryResult]]
    Definition Classes
    MempoolRpc
  130. def getMemPoolEntryOpt(txid: DoubleSha256Digest): Future[Option[GetMemPoolEntryResult]]
    Definition Classes
    MempoolRpc
  131. def getMemPoolInfo: Future[GetMemPoolInfoResult]
    Definition Classes
    MempoolRpc
  132. def getMemoryInfo: Future[GetMemoryInfoResult]
    Definition Classes
    NodeRpc
  133. def getMempoolCluster(txid: DoubleSha256Digest): Future[GetMempoolClusterResult]
    Definition Classes
    MempoolRpc
  134. def getMempoolCluster(txid: DoubleSha256DigestBE): Future[GetMempoolClusterResult]

    Returns cluster information for the given transaction.

    Returns cluster information for the given transaction. The cluster contains all transactions in the same cluster as the given transaction, along with the ordering of those transactions and grouping into chunks.

    New in Bitcoin Core v31.

    txid

    The transaction id

    Definition Classes
    MempoolRpc
  135. def getMempoolFeerateDiagram(): Future[Vector[GetMempoolFeerateDiagramEntry]]

    Returns the feerate diagram for the entire mempool.

    Returns the feerate diagram for the entire mempool. Each entry represents a point in the feerate diagram showing the cumulative fee and weight.

    New in Bitcoin Core v31.

    Definition Classes
    MempoolRpc
  136. def getMiningInfo: Future[GetMiningInfoResult]
    Definition Classes
    MiningRpc
  137. def getNetTotals: Future[GetNetTotalsResult]
    Definition Classes
    P2PRpc
  138. def getNetworkHashPS(blocks: Int = 120, height: Int = -1): Future[BigDecimal]
    Definition Classes
    MiningRpc
  139. def getNetworkInfo: Future[GetNetworkInfoResult]
    Definition Classes
    P2PRpc
  140. def getNewAddress(accountOrLabel: String, addressType: AddressType, walletName: String): Future[BitcoinAddress]
    Definition Classes
    WalletRpc
  141. def getNewAddress(accountOrLabel: String, addressType: AddressType): Future[BitcoinAddress]
    Definition Classes
    WalletRpc
  142. def getNewAddress(addressType: AddressType): Future[BitcoinAddress]
    Definition Classes
    WalletRpc
  143. def getNewAddress(addressType: AddressType, walletName: String): Future[BitcoinAddress]
    Definition Classes
    WalletRpc
  144. def getNewAddress(walletName: String, label: String = ""): Future[BitcoinAddress]
    Definition Classes
    WalletRpc
  145. def getNewAddress: Future[BitcoinAddress]
    Definition Classes
    WalletRpc
  146. def getNodeAddresses(): Future[Vector[GetNodeAddressesResultPostV22]]
    Definition Classes
    NodeRpc
  147. def getNodeAddresses(count: Int): Future[Vector[GetNodeAddressesResultPostV22]]
    Definition Classes
    NodeRpc
  148. def getNodeAddresses(network: String, count: Int): Future[Vector[GetNodeAddressesResultPostV22]]
    Definition Classes
    NodeRpc
  149. def getNumberOfConfirmations(blockHash: DoubleSha256DigestBE): Future[Option[Int]]

    Gets number of confirmations for the given block hash

    Gets number of confirmations for the given block hash

    Definition Classes
    BitcoindRpcClient → ChainQueryApi
  150. def getPayload(response: HttpResponse): Future[JsValue]

    Parses the payload of the given response into JSON.

    Parses the payload of the given response into JSON.

    The command, parameters and request are given as debug parameters, and only used for printing diagnostics if things go belly-up.

    Attributes
    protected
    Definition Classes
    Client
  151. def getPeerInfo: Future[Vector[PeerInfoResponseV25]]
    Definition Classes
    P2PRpc
  152. def getPrioritisedTransactions(): Future[Map[DoubleSha256DigestBE, PrioritisedTransaction]]
    Definition Classes
    MiningRpc
  153. def getPrivateBroadcastInfo(): Future[GetPrivateBroadcastInfoResult]

    Returns information about transactions that are currently being privately broadcast.

    Returns information about transactions that are currently being privately broadcast.

    New in Bitcoin Core v31. Requires -privatebroadcast to be enabled.

    Definition Classes
    P2PRpc
  154. def getRawChangeAddress(addressType: AddressType, walletName: String): Future[BitcoinAddress]
    Definition Classes
    WalletRpc
  155. def getRawChangeAddress(walletName: String): Future[BitcoinAddress]
    Definition Classes
    WalletRpc
  156. def getRawChangeAddress(addressType: AddressType): Future[BitcoinAddress]
    Definition Classes
    WalletRpc
  157. def getRawChangeAddress: Future[BitcoinAddress]
    Definition Classes
    WalletRpc
  158. def getRawMemPool(verbose: Boolean = false): Future[GetRawMempoolResult]
    Definition Classes
    MempoolRpc
  159. def getRawMemPoolWithTransactions: Future[Map[DoubleSha256DigestBE, GetMemPoolResult]]
    Definition Classes
    MempoolRpc
  160. def getRawMempoolTxIds(): Future[GetRawMempoolTxIds]
    Definition Classes
    MempoolRpc
  161. def getRawMempoolVerbose(): Future[GetRawMempoolVerbose]
    Definition Classes
    MempoolRpc
  162. def getRawTransaction(txid: DoubleSha256DigestBE, blockhash: Option[DoubleSha256DigestBE] = None): Future[GetRawTransactionResult]
    Definition Classes
    RawTransactionRpc
  163. def getRawTransactionRaw(txid: DoubleSha256DigestBE, blockhash: Option[DoubleSha256DigestBE] = None): Future[Transaction]
    Definition Classes
    RawTransactionRpc
  164. def getReceivedByAddress(address: BitcoinAddress, minConfirmations: Int = 1, walletName: String = DEFAULT_WALLET): Future[Bitcoins]
    Definition Classes
    WalletRpc
  165. def getRpcInfo(): Future[GetRpcInfoResult]
    Definition Classes
    V18AssortedRpc
  166. def getTransaction(txid: DoubleSha256DigestBE, watchOnly: Boolean = false, walletName: String = BitcoindRpcClient.DEFAULT_WALLET_NAME): Future[GetTransactionResult]
    Definition Classes
    TransactionRpc
  167. def getTxOut(txid: DoubleSha256DigestBE, vout: Long, includeMemPool: Boolean = true): Future[Option[GetTxOutResult]]
    Definition Classes
    TransactionRpc
  168. def getTxOutProof(txids: Vector[DoubleSha256DigestBE], headerHash: DoubleSha256DigestBE): Future[MerkleBlock]
    Definition Classes
    TransactionRpc
  169. def getTxOutProof(txids: Vector[DoubleSha256Digest], headerHash: DoubleSha256Digest): Future[MerkleBlock]
    Definition Classes
    TransactionRpc
  170. def getTxOutProof(txids: Vector[DoubleSha256DigestBE]): Future[MerkleBlock]
    Definition Classes
    TransactionRpc
  171. def getTxOutSetInfo: Future[GetTxOutSetInfoResult]
    Definition Classes
    TransactionRpc
  172. def getTxSpendingPrevOut(prevouts: Vector[TransactionOutPoint], mempoolOnly: Option[Boolean], returnSpendingTx: Option[Boolean]): Future[Vector[GetTxSpendingPrevOutResult]]

    Returns information about in-mempool or confirmed spenders of the given outputs.

    Returns information about in-mempool or confirmed spenders of the given outputs.

    prevouts

    Outpoints to query

    mempoolOnly

    If false and mempool lacks a relevant spend, use txospenderindex (v31+, throws an exception if not available)

    returnSpendingTx

    If true, return the full spending transaction (v31+)

    Definition Classes
    MempoolRpc
  173. def getTxSpendingPrevOut(prevouts: Vector[TransactionOutPoint]): Future[Vector[GetTxSpendingPrevOutResult]]
    Definition Classes
    MempoolRpc
  174. def getTxSpendingPrevOut(prevout: TransactionOutPoint): Future[GetTxSpendingPrevOutResult]
    Definition Classes
    MempoolRpc
  175. def getUnconfirmedBalance(walletName: String): Future[Bitcoins]
    Definition Classes
    WalletRpc
  176. def getUnconfirmedBalance: Future[Bitcoins]
    Definition Classes
    WalletRpc
  177. def getWalletInfo: Future[GetWalletInfoResult]
    Definition Classes
    WalletRpc
  178. def getWalletInfo(walletName: String): Future[GetWalletInfoResult]
    Definition Classes
    WalletRpc
  179. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  180. def help(rpcName: String = ""): Future[String]
    Definition Classes
    NodeRpc
  181. def importDescriptor(imp: DescriptorsResult, walletName: String = BitcoindRpcClient.DEFAULT_WALLET_NAME): Future[ImportDescriptorResult]
    Definition Classes
    DescriptorRpc
  182. def importDescriptors(imports: Vector[DescriptorsResult], walletName: String = BitcoindRpcClient.DEFAULT_WALLET_NAME): Future[Vector[ImportDescriptorResult]]

    https://bitcoincore.org/en/doc/22.0.0/rpc/wallet/importdescriptors/

    https://bitcoincore.org/en/doc/22.0.0/rpc/wallet/importdescriptors/

    Definition Classes
    DescriptorRpc
  183. def importMempool(path: Path): Future[Unit]
    Definition Classes
    MempoolRpc
  184. def importMulti(requests: Vector[ImportMultiRequest], rescan: Boolean = true, walletName: String = DEFAULT_WALLET): Future[Vector[ImportMultiResult]]
    Definition Classes
    WalletRpc
  185. implicit val importMultiAddressWrites: Writes[ImportMultiAddress]
    Definition Classes
    Client
  186. implicit val importMultiRequestWrites: Writes[ImportMultiRequest]
    Definition Classes
    Client
  187. def importPrunedFunds(transaction: Transaction, txOutProof: MerkleBlock, walletName: String = DEFAULT_WALLET): Future[Unit]
    Definition Classes
    WalletRpc
  188. val instance: BitcoindInstance
    Definition Classes
    BitcoindRpcClient → Client
  189. def invalidateBlock(blockHash: DoubleSha256Digest): Future[Unit]
    Definition Classes
    BlockchainRpc
  190. def invalidateBlock(blockHash: DoubleSha256DigestBE): Future[Unit]
    Definition Classes
    BlockchainRpc
  191. def isAlive(): Boolean
    Definition Classes
    NativeProcessFactory
  192. def isIBD(): Future[Boolean]
    Definition Classes
    BitcoindRpcClient → ChainApi
  193. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  194. def isStartedF: Future[Boolean]

    Checks whether the underlying bitcoind daemon is running

    Checks whether the underlying bitcoind daemon is running

    Definition Classes
    Client
  195. def isStoppedF: Future[Boolean]

    Checks whether the underlyind bitcoind daemon is stopped

    Checks whether the underlyind bitcoind daemon is stopped

    returns

    A future boolean which represents isstopped or not

    Definition Classes
    Client
  196. def isSyncing(): Future[Boolean]
    Definition Classes
    BitcoindRpcClient → ChainApi
  197. def isTipStale(): Future[Boolean]

    Checks if our chain tip is stale

    Checks if our chain tip is stale

    Definition Classes
    BitcoindRpcClient → ChainApi
    See also

    https://github.com/bitcoin/bitcoin/blob/664500fc71a32d5066db8cb4a19ddc7005a1c9e9/src/net_processing.cpp#L1235

  198. def joinPsbts(psbts: Seq[PSBT]): Future[PSBT]
    Definition Classes
    PsbtRpc
  199. def keyPoolRefill(keyPoolSize: Int = 100, walletName: String = DEFAULT_WALLET): Future[Unit]

    Definition Classes
    WalletRpc
  200. def listAddressGroupings(walletName: String): Future[Vector[Vector[RpcAddress]]]
    Definition Classes
    WalletRpc
  201. def listAddressGroupings: Future[Vector[Vector[RpcAddress]]]
    Definition Classes
    WalletRpc
  202. def listBanned: Future[Vector[NodeBan]]
    Definition Classes
    P2PRpc
  203. def listDescriptors(walletName: String): Future[ListDescriptorsResult]
    Definition Classes
    DescriptorRpc
  204. def listDescriptors(priv: Option[Boolean]): Future[ListDescriptorsResult]
    Definition Classes
    DescriptorRpc
  205. def listDescriptors(priv: Option[Boolean], walletName: String): Future[ListDescriptorsResult]
    Definition Classes
    DescriptorRpc
  206. def listDescriptors(): Future[ListDescriptorsResult]
    Definition Classes
    DescriptorRpc
  207. def listLockUnspent: Future[Vector[TransactionOutPoint]]
    Definition Classes
    UTXORpc
  208. def listReceivedByAddress(confirmations: Int = 1, includeEmpty: Boolean = false, includeWatchOnly: Boolean = false, walletName: String = DEFAULT_WALLET): Future[Vector[ReceivedAddress]]
    Definition Classes
    WalletRpc
  209. def listSinceBlock(headerHash: DoubleSha256Digest, confirmations: Int, includeWatchOnly: Boolean): Future[ListSinceBlockResult]
    Definition Classes
    BlockchainRpc
  210. def listSinceBlock(headerHash: DoubleSha256Digest, includeWatchOnly: Boolean): Future[ListSinceBlockResult]
    Definition Classes
    BlockchainRpc
  211. def listSinceBlock(headerHash: DoubleSha256Digest, confirmations: Int): Future[ListSinceBlockResult]
    Definition Classes
    BlockchainRpc
  212. def listSinceBlock(headerHash: DoubleSha256Digest): Future[ListSinceBlockResult]
    Definition Classes
    BlockchainRpc
  213. def listSinceBlock(headerHash: DoubleSha256DigestBE, confirmations: Int, includeWatchOnly: Boolean): Future[ListSinceBlockResult]
    Definition Classes
    BlockchainRpc
  214. def listSinceBlock(headerHash: DoubleSha256DigestBE, includeWatchOnly: Boolean): Future[ListSinceBlockResult]
    Definition Classes
    BlockchainRpc
  215. def listSinceBlock(headerHash: DoubleSha256DigestBE, confirmations: Int): Future[ListSinceBlockResult]
    Definition Classes
    BlockchainRpc
  216. def listSinceBlock(headerHash: DoubleSha256DigestBE): Future[ListSinceBlockResult]
    Definition Classes
    BlockchainRpc
  217. def listSinceBlock(headerHash: Option[DoubleSha256DigestBE] = None, confirmations: Int = 1, includeWatchOnly: Boolean = false): Future[ListSinceBlockResult]
    Definition Classes
    BlockchainRpc
  218. def listSinceBlock: Future[ListSinceBlockResult]
    Definition Classes
    BlockchainRpc
  219. def listTransactions(account: String = "*", count: Int = 10, skip: Int = 0, includeWatchOnly: Boolean = false): Future[Vector[ListTransactionsResult]]
    Definition Classes
    BlockchainRpc
  220. def listUnspent(minConfirmations: Int, maxConfirmations: Int, addresses: Vector[BitcoinAddress]): Future[Vector[UnspentOutput]]
    Definition Classes
    UTXORpc
  221. def listUnspent(addresses: Vector[BitcoinAddress]): Future[Vector[UnspentOutput]]
    Definition Classes
    UTXORpc
  222. def listUnspent(minConfirmations: Int, maxConfirmations: Int): Future[Vector[UnspentOutput]]
    Definition Classes
    UTXORpc
  223. def listUnspent(walletName: String): Future[Vector[UnspentOutput]]
    Definition Classes
    UTXORpc
  224. def listUnspent: Future[Vector[UnspentOutput]]
    Definition Classes
    UTXORpc
  225. def listWalletDir(): Future[ListWalletDirResult]
    Definition Classes
    V18AssortedRpc
  226. def listWallets: Future[Vector[String]]
    Definition Classes
    WalletRpc
  227. def loadTxOutSet(path: Path): Future[LoadTxOutSetResult]
    Definition Classes
    UTXORpc
  228. def loadWallet(filePath: String): Future[LoadWalletResult]
    Definition Classes
    WalletRpc
  229. def lockUnspent(unlock: Boolean, outputs: Vector[LockUnspentOutputParameter]): Future[Boolean]
    Definition Classes
    UTXORpc
  230. lazy val logFileOpt: Option[Path]

    The log file of the Bitcoin Core daemon.

    The log file of the Bitcoin Core daemon. This returns the log file if the underlying instance is org.bitcoins.rpc.config.BitcoindInstanceLocal, and None if the underlying instance is BitcoindInstanceRemote

    Definition Classes
    Client
  231. def logger: Logger
    Definition Classes
    BitcoinSLogger
  232. def logging(include: Vector[String] = Vector.empty, exclude: Vector[String] = Vector.empty): Future[Map[String, Boolean]]
    Definition Classes
    NodeRpc
  233. def logging: Future[Map[String, Boolean]]
    Definition Classes
    NodeRpc
  234. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  235. implicit val network: NetworkParameters
    Attributes
    protected
    Definition Classes
    Client
  236. def nextBlockHeaderBatchRange(prevStopHash: DoubleSha256DigestBE, stopHash: DoubleSha256DigestBE, batchSize: Int): Future[Option[FilterSyncMarker]]

    Generates a block range in form of (startHeight, stopHash) by the given stop hash.

    Generates a block range in form of (startHeight, stopHash) by the given stop hash. Returns None if we are synced

    prevStopHash

    our previous block hash where filter header sync stopped

    stopHash

    the block hash we want to sync the new batch of filters to

    batchSize

    the batch size of filter headers

    Definition Classes
    BitcoindRpcClient → ChainApi
  237. def nextFilterHeaderBatchRange(stopBlockHash: DoubleSha256DigestBE, batchSize: Int, startHeightOpt: Option[Int]): Future[Option[FilterSyncMarker]]

    Generates a query for a range of compact filters

    Generates a query for a range of compact filters

    stopBlockHash

    the block hash to stop receiving filters at

    startHeightOpt

    the block height to start syncing filters from. If None, we query our chainstate for the last filter we've seen

    Definition Classes
    BitcoindRpcClient → ChainApi
  238. final def nextFilterHeaderBatchRange(stopBlockHash: DoubleSha256DigestBE, batchSize: Int): Future[Option[FilterSyncMarker]]

    Generates a filter header range in form of (startHeight, stopHash) by the given stop hash.

    Generates a filter header range in form of (startHeight, stopHash) by the given stop hash.

    Definition Classes
    ChainApi
  239. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  240. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  241. def ping(): Future[Unit]
    Definition Classes
    Client
  242. def preciousBlock(headerHash: DoubleSha256Digest): Future[Unit]
    Definition Classes
    BlockchainRpc
  243. def preciousBlock(headerHash: DoubleSha256DigestBE): Future[Unit]
    Definition Classes
    BlockchainRpc
  244. def prioritiseTransaction(txid: DoubleSha256Digest, feeDelta: Satoshis): Future[Boolean]
    Definition Classes
    MiningRpc
  245. def prioritiseTransaction(txid: DoubleSha256DigestBE, feeDelta: Satoshis): Future[Boolean]
    Definition Classes
    MiningRpc
  246. def processCheckpoint(filterHeaderHash: DoubleSha256DigestBE, blockHash: DoubleSha256DigestBE): Future[ChainApi]

    Adds a compact filter header check point into the list of check points.

    Adds a compact filter header check point into the list of check points.

    Definition Classes
    ChainApi
  247. def processCheckpoints(checkpoints: Vector[DoubleSha256DigestBE], blockHash: DoubleSha256DigestBE): Future[ChainApi]

    Process all compact filter header check points.

    Process all compact filter header check points.

    Definition Classes
    BitcoindRpcClient → ChainApi
  248. def processFilter(message: CompactFilterMessage): Future[ChainApi]

    Adds a compact filter into the filter database.

    Adds a compact filter into the filter database.

    Definition Classes
    ChainApi
  249. def processFilterHeader(filterHeader: FilterHeader, blockHash: DoubleSha256DigestBE): Future[ChainApi]

    Adds a compact filter header into the filter header chain and returns a new chain api that contains this header

    Adds a compact filter header into the filter header chain and returns a new chain api that contains this header

    Definition Classes
    ChainApi
  250. def processFilterHeaders(filterHeaders: Vector[FilterHeader], stopHash: DoubleSha256DigestBE): Future[ChainApi]

    Process all of the given compact filter headers and returns a new chain api that contains these headers.

    Process all of the given compact filter headers and returns a new chain api that contains these headers.

    Definition Classes
    BitcoindRpcClient → ChainApi
  251. def processFilters(message: Vector[CompactFilterMessage]): Future[ChainApi]

    Process all of the given compact filters and returns a new chain api that contains these headers.

    Process all of the given compact filters and returns a new chain api that contains these headers.

    Definition Classes
    BitcoindRpcClient → ChainApi
  252. def processHeader(header: BlockHeader): Future[ChainApi]

    Adds a block header to our chain project.

    Adds a block header to our chain project. This will return a failed future when the given header is invalid.

    Definition Classes
    ChainApi
  253. def processHeaders(headers: Vector[BlockHeader]): Future[ChainApi]

    Process all of the given headers and returns a new chain api that contains these headers.

    Process all of the given headers and returns a new chain api that contains these headers. This method processes headers in the order that they are given. If the headers are out of order, this method will fail.

    This method will also fail when there are zero headers given that are valid.

    Definition Classes
    BitcoindRpcClient → ChainApi
  254. def pruneBlockChain(height: Int): Future[Int]
    Definition Classes
    BlockchainRpc
  255. def removePrunedFunds(txid: DoubleSha256Digest, walletName: String): Future[Unit]
    Definition Classes
    WalletRpc
  256. def removePrunedFunds(txid: DoubleSha256Digest): Future[Unit]
    Definition Classes
    WalletRpc
  257. def removePrunedFunds(txid: DoubleSha256DigestBE): Future[Unit]
    Definition Classes
    WalletRpc
  258. def removePrunedFunds(txid: DoubleSha256DigestBE, walletName: String): Future[Unit]
    Definition Classes
    WalletRpc
  259. def rescanBlockChain(start: Int, stop: Int): Future[RescanBlockChainResult]
    Definition Classes
    BlockchainRpc
  260. def rescanBlockChain(start: Int): Future[RescanBlockChainResult]
    Definition Classes
    BlockchainRpc
  261. def rescanBlockChain(): Future[RescanBlockChainResult]
    Definition Classes
    BlockchainRpc
  262. def saveMemPool(): Future[Unit]
    Definition Classes
    MempoolRpc
  263. def scanBlocks(request: ScanBlocksRequest): Future[ScanBlocksResult]
    Definition Classes
    BlockchainRpc
  264. def scanTxoutSet(request: ScanTxoutSetRequest): Future[ScanTxoutSetResult]
    Definition Classes
    UTXORpc
  265. def sendMany(amounts: Map[BitcoinAddress, CurrencyUnit], minconf: Int = 1, comment: String = "", subtractFeeFrom: Vector[BitcoinAddress] = Vector.empty, walletName: String = DEFAULT_WALLET): Future[DoubleSha256DigestBE]
    Definition Classes
    WalletRpc
  266. def sendRawTransaction(transaction: Transaction, maxfeerate: Double = 0.10, maxBurnAmount: Int = 0): Future[DoubleSha256DigestBE]

    maxfeerate

    Set to 0 if you want to enable allowhighfees

    Definition Classes
    RawTransactionRpc
  267. def sendRequest(req: HttpRequest): Future[HttpResponse]
    Attributes
    protected
    Definition Classes
    Client
  268. def sendToAddress(address: BitcoinAddress, amount: CurrencyUnit, localComment: String = "", toComment: String = "", subractFeeFromAmount: Boolean = false, walletName: String = DEFAULT_WALLET): Future[DoubleSha256DigestBE]
    Definition Classes
    WalletRpc
  269. def setBan(address: URI, command: SetBanCommand, banTime: Int = 86400, absolute: Boolean = false): Future[Unit]
    Definition Classes
    P2PRpc
  270. def setIBD(value: Boolean): Future[ChainApi]
    Definition Classes
    BitcoindRpcClient → ChainApi
  271. def setNetworkActive(activate: Boolean): Future[Unit]
    Definition Classes
    P2PRpc
  272. def setSyncing(value: Boolean): Future[ChainApi]
    Definition Classes
    BitcoindRpcClient → ChainApi
  273. def setWalletFlag(flag: WalletFlag, value: Boolean, walletName: String = DEFAULT_WALLET): Future[SetWalletFlagResult]

    Change the state of the given wallet flag for a wallet.

    Change the state of the given wallet flag for a wallet.

    Definition Classes
    WalletRpc
  274. def signMessage(address: P2PKHAddress, message: String): Future[String]
    Definition Classes
    MessageRpc
  275. def signMessageWithPrivKey(key: ECPrivateKeyBytes, message: String): Future[String]
    Definition Classes
    MessageRpc
  276. def signRawTransactionWithKey(transaction: Transaction, keys: Vector[ECPrivateKey], utxoDeps: Vector[SignRawTransactionOutputParameter] = Vector.empty, sigHash: HashType = HashType.sigHashAll): Future[SignRawTransactionResult]

    $signRawTx

    $signRawTx

    This RPC call signs the raw transaction with keys provided manually.

    Definition Classes
    WalletRpc
  277. def signRawTransactionWithWallet(transaction: Transaction, utxoDeps: Vector[SignRawTransactionOutputParameter], sigHash: HashType = HashType.sigHashAll): Future[SignRawTransactionResult]

    $signRawTx

    $signRawTx

    This RPC call signs the raw transaction with keys found in the Bitcoin Core wallet.

    Definition Classes
    WalletRpc
  278. def signRawTransactionWithWallet(transaction: Transaction): Future[SignRawTransactionWithWalletResult]
    Definition Classes
    WalletRpc
  279. def signRawTransactionWithWallet(transaction: Transaction, walletName: String): Future[SignRawTransactionWithWalletResult]
    Definition Classes
    WalletRpc
  280. def simulateRawTransaction(tx: Transaction, includeWatchOnly: Boolean = true, walletName: String = BitcoindRpcClient.DEFAULT_WALLET_NAME): Future[CurrencyUnit]
    Definition Classes
    WalletRpc
  281. def simulateRawTransactions(txs: Vector[Transaction], includeWatchOnly: Boolean = true, walletName: String = BitcoindRpcClient.DEFAULT_WALLET_NAME): Future[CurrencyUnit]
    Definition Classes
    WalletRpc
  282. def start(): Future[BitcoindRpcClient]

    Starts bitcoind on the local system.

    Starts bitcoind on the local system.

    returns

    a future that completes when bitcoind is fully started. This future times out after 60 seconds if the client cannot be started

    Definition Classes
    Client → StartStop
  283. def startBinary(): Future[Unit]

    Starts the binary by spinning up a new process

    Starts the binary by spinning up a new process

    Definition Classes
    NativeProcessFactory
  284. def stop(): Future[BitcoindRpcClient]

    Stop method for BitcoindRpcClient that is stopped, inherits from the StartStop trait

    Stop method for BitcoindRpcClient that is stopped, inherits from the StartStop trait

    returns

    A future stopped bitcoindRPC client

    Definition Classes
    Client → StartStop
  285. def stopBinary(): Future[Unit]

    Stops the binary by destroying the underlying operating system process

    Stops the binary by destroying the underlying operating system process

    If the client is a remote client (not started on the host operating system) this method is a no-op

    Definition Classes
    NativeProcessFactory
  286. def submitBlock(block: Block): Future[Unit]
    Definition Classes
    P2PRpc
  287. def submitHeader(header: BlockHeader): Future[Unit]
    Definition Classes
    V18AssortedRpc
  288. def submitPackage(transactions: Vector[Transaction], maxFeeRate: Double = 0.10, maxBurnAmount: Double = 0.0): Future[SubmitPackageResult]

    Submit a package of raw transactions to the mempool.

    Submit a package of raw transactions to the mempool.

    The package will be validated according to consensus and mempool policy rules. If any transaction passes, it will be accepted to mempool. The package must solely consist of a child transaction and all of its unconfirmed parents, if any. None of the parents may depend on each other.

    This RPC is experimental and the interface may be unstable. Package relay is not currently supported, so successful submission does not mean the transactions will propagate throughout the network.

    transactions

    Vector of transactions to submit as a package (must be topologically sorted with child last)

    maxFeeRate

    Maximum fee rate in BTC/kvB. Transactions with higher fee rates will be rejected. Set to 0 to accept any fee rate. Default is 0.10 BTC/kvB.

    maxBurnAmount

    Maximum amount in BTC that can be burned through provably unspendable outputs (e.g., OP_RETURN). Default is 0.

    returns

    SubmitPackageResult containing package validation results

    Definition Classes
    MempoolRpc
  289. def syncWithValidationInterfaceQueue(): Future[Unit]

    Waits for the validation interface queue to catch up on everything that was there when we entered this function

    Waits for the validation interface queue to catch up on everything that was there when we entered this function

    Definition Classes
    BlockchainRpc
    See also

    https://github.com/bitcoin/bitcoin/issues/27085

  290. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  291. implicit val system: ActorSystem
    Definition Classes
    BitcoindRpcClient → Client
  292. def testMempoolAccept(transaction: Vector[Transaction], maxFeeRate: Double = 0.10): Future[Vector[TestMempoolAcceptResultPostV24]]
    Definition Classes
    MempoolRpc
  293. def toString(): String
    Definition Classes
    AnyRef → Any
  294. def unloadWallet(filePath: String): Future[Unit]
    Definition Classes
    WalletRpc
  295. def uptime: Future[UInt32]
    Definition Classes
    NodeRpc
  296. def utxoUpdatePsbt(psbt: PSBT, descriptors: Seq[String]): Future[PSBT]
    Definition Classes
    PsbtRpc
  297. def utxoUpdatePsbt(psbt: PSBT): Future[PSBT]
    Definition Classes
    PsbtRpc
  298. def validateAddress(address: BitcoinAddress): Future[ValidateAddressResult]
    Definition Classes
    UtilRpc
  299. def verifyChain(level: Int = 3, blocks: Int = 6): Future[Boolean]
    Definition Classes
    BlockchainRpc
  300. def verifyMessage(address: P2PKHAddress, signature: String, message: String): Future[Boolean]
    Definition Classes
    MessageRpc
  301. def verifyTxOutProof(proof: MerkleBlock): Future[Vector[DoubleSha256DigestBE]]
    Definition Classes
    TransactionRpc
  302. lazy val version: Future[BitcoindVersion]
    Definition Classes
    BitcoindRpcClient → Client
  303. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  304. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  305. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  306. def waitForBlock(timeout: FiniteDuration, blockHash: DoubleSha256DigestBE): Future[WaitForBlockResult]
    Definition Classes
    BlockchainRpc
  307. def waitForBlockHeight(timeout: FiniteDuration, height: Int): Future[WaitForBlockResult]
    Definition Classes
    BlockchainRpc
  308. def waitForNewBlock(timeout: FiniteDuration, currentTipOpt: Option[DoubleSha256DigestBE]): Future[WaitForBlockResult]
    Definition Classes
    BlockchainRpc
  309. def walletCreateFundedPsbt(inputs: Vector[TransactionInput], outputs: Map[BitcoinAddress, CurrencyUnit], locktime: Int = 0, options: WalletCreateFundedPsbtOptions = WalletCreateFundedPsbtOptions(), bip32derivs: Boolean = false, walletName: String = DEFAULT_WALLET): Future[WalletCreateFundedPsbtResult]
    Definition Classes
    WalletRpc
  310. def walletExtension(walletName: String): String
    Attributes
    protected
    Definition Classes
    Client
  311. def walletLock(walletName: String): Future[Unit]
    Definition Classes
    WalletRpc
  312. def walletLock(): Future[Unit]
    Definition Classes
    WalletRpc
  313. def walletPassphrase(passphrase: String, seconds: Int, walletName: String = DEFAULT_WALLET): Future[Unit]
    Definition Classes
    WalletRpc
  314. def walletPassphraseChange(currentPassphrase: String, newPassphrase: String, walletName: String = DEFAULT_WALLET): Future[Unit]
    Definition Classes
    WalletRpc
  315. def walletProcessPSBT(psbt: PSBT, sign: Boolean = true, sigHashType: HashType = HashType.sigHashAll, walletName: String = DEFAULT_WALLET): Future[WalletProcessPsbtResult]
    Definition Classes
    WalletRpc
  316. implicit object ECPrivateKeyBytesWrites extends Writes[ECPrivateKeyBytes]

    This is here (and not in JsonWrriters) so that the implicit network val is accessible

    This is here (and not in JsonWrriters) so that the implicit network val is accessible

    Definition Classes
    Client
  317. implicit object ECPrivateKeyWrites extends Writes[ECPrivateKey]

    This is here (and not in JsonWrriters) so that the implicit network val is accessible

    This is here (and not in JsonWrriters) so that the implicit network val is accessible

    Definition Classes
    Client

Inherited from V20MultisigRpc

Inherited from DescriptorRpc

Inherited from V18AssortedRpc

Inherited from UtilRpc

Inherited from PsbtRpc

Inherited from WalletRpc

Inherited from UTXORpc

Inherited from TransactionRpc

Inherited from RawTransactionRpc

Inherited from P2PRpc

Inherited from NodeRpc

Inherited from MultisigRpc

Inherited from MiningRpc

Inherited from MempoolRpc

Inherited from MessageRpc

Inherited from BlockchainRpc

Inherited from ChainApi

Inherited from ChainQueryApi

Inherited from NodeApi

Inherited from FeeRateApi

Inherited from Client

Inherited from NativeProcessFactory

Inherited from StartStopAsync[BitcoindRpcClient]

Inherited from StartStop[Future[BitcoindRpcClient]]

Inherited from BitcoinSLogger

Inherited from AnyRef

Inherited from Any

Ungrouped