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

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 BitcoindV16RpcClient or BitcoindV17RpcClient.

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
UtilRpc, PsbtRpc, WalletRpc, UTXORpc, TransactionRpc, RawTransactionRpc, P2PRpc, NodeRpc, MultisigRpc, MiningRpc, MempoolRpc, MessageRpc, BlockchainRpc, ChainApi, ChainQueryApi, NodeApi, FeeRateApi, Client, NativeProcessFactory, StartStopAsync[BitcoindRpcClient], StartStop[Future[BitcoindRpcClient]], Logging, AnyRef, Any
Known Subclasses
BitcoindV16RpcClient, BitcoindV17RpcClient, BitcoindV18RpcClient, BitcoindV19RpcClient, BitcoindV20RpcClient, BitcoindV21RpcClient
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BitcoindRpcClient
  2. UtilRpc
  3. PsbtRpc
  4. WalletRpc
  5. UTXORpc
  6. TransactionRpc
  7. RawTransactionRpc
  8. P2PRpc
  9. NodeRpc
  10. MultisigRpc
  11. MiningRpc
  12. MempoolRpc
  13. MessageRpc
  14. BlockchainRpc
  15. ChainApi
  16. ChainQueryApi
  17. NodeApi
  18. FeeRateApi
  19. Client
  20. NativeProcessFactory
  21. StartStopAsync
  22. StartStop
  23. Logging
  24. AnyRef
  25. 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 abortRescan(): Future[Unit]
    Definition Classes
    NodeRpc
  7. def addMultiSigAddress(minSignatures: Int, keys: Vector[Either[ECPublicKey, P2PKHAddress]], account: String, addressType: AddressType): Future[MultiSigResult]
    Definition Classes
    MultisigRpc
  8. def addMultiSigAddress(minSignatures: Int, keys: Vector[Either[ECPublicKey, P2PKHAddress]], addressType: AddressType): Future[MultiSigResult]
    Definition Classes
    MultisigRpc
  9. def addMultiSigAddress(minSignatures: Int, keys: Vector[Either[ECPublicKey, P2PKHAddress]], account: String): Future[MultiSigResult]
    Definition Classes
    MultisigRpc
  10. def addMultiSigAddress(minSignatures: Int, keys: Vector[Either[ECPublicKey, P2PKHAddress]]): Future[MultiSigResult]
    Definition Classes
    MultisigRpc
  11. def addNode(address: URI, command: AddNodeArgument): Future[Unit]
    Definition Classes
    P2PRpc
  12. def analyzePsbt(psbt: PSBT): Future[AnalyzePsbtResult]
    Definition Classes
    PsbtRpc
  13. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  14. def backupWallet(destination: String, walletNameOpt: Option[String] = None): Future[Unit]
    Definition Classes
    WalletRpc
  15. 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
  16. 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
  17. 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
  18. def buildRequest(instance: BitcoindInstance, methodName: String, params: JsArray, uriExtensionOpt: Option[String] = None): HttpRequest
    Attributes
    protected
    Definition Classes
    Client
  19. def bumpFee(txid: DoubleSha256Digest, confTarget: Int, totalFee: Option[Satoshis], replaceable: Boolean, estimateMode: String): Future[BumpFeeResult]
    Definition Classes
    TransactionRpc
  20. def bumpFee(txid: DoubleSha256DigestBE, confTarget: Int = 6, totalFee: Option[Satoshis] = None, replaceable: Boolean = true, estimateMode: String = "UNSET"): Future[BumpFeeResult]
    Definition Classes
    TransactionRpc
  21. def clearBanned(): Future[Unit]
    Definition Classes
    P2PRpc
  22. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  23. lazy val cmd: 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
  24. def combinePsbt(psbts: Vector[PSBT]): Future[PSBT]
    Definition Classes
    PsbtRpc
  25. def combineRawTransaction(txs: Vector[Transaction]): Future[Transaction]
    Definition Classes
    RawTransactionRpc
  26. lazy val confFile: Path

    The configuration file of the Bitcoin Core daemon

    The configuration file of the Bitcoin Core daemon

    Definition Classes
    Client
  27. def convertToPsbt(rawTx: Transaction, permitSigData: Boolean = false, isWitness: Option[Boolean] = None): Future[PSBT]
    Definition Classes
    PsbtRpc
  28. def createMultiSig(minSignatures: Int, keys: Vector[ECPublicKey], walletNameOpt: Option[String] = None): Future[MultiSigResult]
    Definition Classes
    MultisigRpc
  29. def createPsbt(inputs: Vector[TransactionInput], outputs: Map[BitcoinAddress, CurrencyUnit], locktime: Int = 0, replacable: Boolean = false): Future[PSBT]
    Definition Classes
    PsbtRpc
  30. def createRawTransaction(inputs: Vector[TransactionInput], outputs: Map[BitcoinAddress, Bitcoins], locktime: Int = 0): Future[Transaction]
    Definition Classes
    RawTransactionRpc
  31. def createWallet(walletName: String, disablePrivateKeys: Boolean = false, blank: Boolean = false, passphrase: String = ""): Future[CreateWalletResult]

    blank

    Not available to versions before v19

    passphrase

    Not available to versions before v19

    Definition Classes
    WalletRpc
  32. def debug(mkr: Marker, msg: => Any, t: => Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  33. def debug(msg: => Any, t: => Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  34. def debug(msg: => Any): Unit
    Attributes
    protected
    Definition Classes
    Logging
  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 disconnectNode(address: URI): Future[Unit]
    Definition Classes
    P2PRpc
  39. def downloadBlocks(blockHashes: Vector[DoubleSha256Digest]): 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
  40. def dumpPrivKey(address: BitcoinAddress, walletNameOpt: Option[String] = None): Future[ECPrivateKeyBytes]
    Definition Classes
    WalletRpc
  41. def dumpWallet(filePath: String, walletNameOpt: Option[String] = None): Future[DumpWalletResult]
    Definition Classes
    WalletRpc
  42. implicit val eCPrivateKeyBytesWrites: Writes[ECPrivateKeyBytes]
    Definition Classes
    Client
  43. implicit val eCPrivateKeyWrites: Writes[ECPrivateKey]
    Definition Classes
    Client
  44. def encryptWallet(passphrase: String, walletNameOpt: Option[String] = None): 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 error(mkr: Marker, msg: => Any, t: => Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  49. def error(msg: => Any, t: => Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  50. def error(msg: => Any): Unit
    Attributes
    protected
    Definition Classes
    Logging
  51. def estimateSmartFee(blocks: Int, mode: FeeEstimationMode = FeeEstimationMode.Ecnomical): Future[EstimateSmartFeeResult]
    Definition Classes
    TransactionRpc
  52. implicit val executionContext: ExecutionContext
    Attributes
    protected
    Definition Classes
    Client → NativeProcessFactory
  53. def filterHeadersUnsupported: Future[Nothing]
    Attributes
    protected
  54. def filtersUnsupported: Future[Nothing]
    Attributes
    protected
  55. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  56. def finalizePsbt(psbt: PSBT, extract: Boolean = true): Future[FinalizePsbtResult]
    Definition Classes
    PsbtRpc
  57. def fundRawTransaction(transaction: Transaction, options: FundRawTransactionOptions, walletName: String): Future[FundRawTransactionResult]
    Definition Classes
    RawTransactionRpc
  58. def fundRawTransaction(transaction: Transaction, options: FundRawTransactionOptions): Future[FundRawTransactionResult]
    Definition Classes
    RawTransactionRpc
  59. def fundRawTransaction(transaction: Transaction, walletName: String): Future[FundRawTransactionResult]
    Definition Classes
    RawTransactionRpc
  60. def fundRawTransaction(transaction: Transaction): Future[FundRawTransactionResult]
    Definition Classes
    RawTransactionRpc
  61. def generateToAddress(blocks: Int, address: BitcoinAddress, maxTries: Int = 1000000): Future[Vector[DoubleSha256DigestBE]]
    Definition Classes
    MiningRpc
  62. def getAddedNodeInfo(node: URI): Future[Vector[Node]]
    Definition Classes
    P2PRpc
  63. def getAddedNodeInfo: Future[Vector[Node]]
    Definition Classes
    P2PRpc
  64. def getAddressInfo(address: BitcoinAddress, walletNameOpt: Option[String] = None): Future[AddressInfoResult]
    Definition Classes
    WalletRpc
  65. def getBalance(walletName: String): Future[Bitcoins]
    Definition Classes
    WalletRpc
  66. def getBalance: Future[Bitcoins]
    Definition Classes
    WalletRpc
  67. def getBalances(walletName: String): Future[GetBalancesResult]
    Definition Classes
    WalletRpc
  68. def getBalances: Future[GetBalancesResult]
    Definition Classes
    WalletRpc
  69. def getBestBlockHash: Future[DoubleSha256DigestBE]
    Definition Classes
    BlockchainRpc
  70. def getBestBlockHeader(): Future[BlockHeaderDb]

    Gets the best block header we have

    Gets the best block header we have

    Definition Classes
    BitcoindRpcClient → ChainApi
  71. 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
    BitcoindRpcClient → ChainApi
  72. def getBestHashBlockHeight()(implicit ec: ExecutionContext): Future[Int]
    Definition Classes
    ChainQueryApi
  73. def getBlock(headerHash: DoubleSha256Digest): Future[GetBlockResult]
    Definition Classes
    BlockchainRpc
  74. def getBlock(headerHash: DoubleSha256DigestBE): Future[GetBlockResult]
    Definition Classes
    BlockchainRpc
  75. def getBlockChainInfo: Future[GetBlockChainInfoResult]
    Definition Classes
    BlockchainRpc
  76. def getBlockCount: Future[Int]
    Definition Classes
    BlockchainRpc
  77. def getBlockHash(height: Int): Future[DoubleSha256DigestBE]
    Definition Classes
    BlockchainRpc
  78. def getBlockHeader(headerHash: DoubleSha256Digest): Future[GetBlockHeaderResult]
    Definition Classes
    BlockchainRpc
  79. def getBlockHeader(headerHash: DoubleSha256DigestBE): Future[GetBlockHeaderResult]
    Definition Classes
    BlockchainRpc
  80. def getBlockHeaderRaw(headerHash: DoubleSha256Digest): Future[BlockHeader]
    Definition Classes
    BlockchainRpc
  81. def getBlockHeaderRaw(headerHash: DoubleSha256DigestBE): Future[BlockHeader]
    Definition Classes
    BlockchainRpc
  82. 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
  83. def getBlockRaw(headerHash: DoubleSha256Digest): Future[Block]
    Definition Classes
    BlockchainRpc
  84. def getBlockRaw(headerHash: DoubleSha256DigestBE): Future[Block]
    Definition Classes
    BlockchainRpc
  85. def getBlockTemplate(request: Option[BlockTemplateRequest] = None): Future[GetBlockTemplateResult]
    Definition Classes
    MiningRpc
  86. def getBlockWithTransactions(headerHash: DoubleSha256Digest): Future[GetBlockWithTransactionsResult]
    Definition Classes
    BlockchainRpc
  87. def getBlockWithTransactions(headerHash: DoubleSha256DigestBE): Future[GetBlockWithTransactionsResult]
    Definition Classes
    BlockchainRpc
  88. def getChainTips: Future[Vector[ChainTip]]
    Definition Classes
    BlockchainRpc
  89. def getChainTxStats(blocks: Int, blockHash: DoubleSha256Digest): Future[GetChainTxStatsResult]
    Definition Classes
    BlockchainRpc
  90. def getChainTxStats(blocks: Int, blockHash: DoubleSha256DigestBE): Future[GetChainTxStatsResult]
    Definition Classes
    BlockchainRpc
  91. def getChainTxStats(blocks: Int): Future[GetChainTxStatsResult]
    Definition Classes
    BlockchainRpc
  92. def getChainTxStats: Future[GetChainTxStatsResult]
    Definition Classes
    BlockchainRpc
  93. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  94. def getConnectionCount: Future[Int]
    Definition Classes
    P2PRpc
  95. def getDaemon: BitcoindInstance
    Definition Classes
    Client
  96. def getDifficulty: Future[BigDecimal]
    Definition Classes
    BlockchainRpc
  97. def getFeeRate: Future[FeeUnit]
    Definition Classes
    BitcoindRpcClient → FeeRateApi
  98. 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
    BitcoindRpcClient → ChainApi
  99. def getFilterCount(): Future[Int]

    Gets the number of compact filters in the database

    Gets the number of compact filters in the database

    Definition Classes
    BitcoindRpcClient → ChainApi → ChainQueryApi
  100. 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
    BitcoindRpcClient → ChainApi
  101. 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
    BitcoindRpcClient → ChainApi
  102. 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
    BitcoindRpcClient → ChainApi
  103. 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
    BitcoindRpcClient → ChainApi
  104. def getFiltersBetweenHeights(startHeight: Int, endHeight: Int): Future[Vector[FilterResponse]]
    Definition Classes
    BitcoindRpcClient → ChainQueryApi
  105. 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
  106. 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
  107. 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
  108. 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
  109. def getIndexInfo(indexName: String): Future[IndexInfoResult]
    Definition Classes
    UtilRpc
  110. def getIndexInfo: Future[Map[String, IndexInfoResult]]
    Definition Classes
    UtilRpc
  111. def getMemPoolAncestors(txid: DoubleSha256Digest): Future[Vector[DoubleSha256DigestBE]]
    Definition Classes
    MempoolRpc
  112. def getMemPoolAncestors(txid: DoubleSha256DigestBE): Future[Vector[DoubleSha256DigestBE]]
    Definition Classes
    MempoolRpc
  113. def getMemPoolAncestorsVerbose(txid: DoubleSha256Digest): Future[Map[DoubleSha256DigestBE, GetMemPoolResult]]
    Definition Classes
    MempoolRpc
  114. def getMemPoolAncestorsVerbose(txid: DoubleSha256DigestBE): Future[Map[DoubleSha256DigestBE, GetMemPoolResult]]
    Definition Classes
    MempoolRpc
  115. def getMemPoolDescendants(txid: DoubleSha256Digest): Future[Vector[DoubleSha256DigestBE]]
    Definition Classes
    MempoolRpc
  116. def getMemPoolDescendants(txid: DoubleSha256DigestBE): Future[Vector[DoubleSha256DigestBE]]
    Definition Classes
    MempoolRpc
  117. def getMemPoolDescendantsVerbose(txid: DoubleSha256Digest): Future[Map[DoubleSha256DigestBE, GetMemPoolResult]]
    Definition Classes
    MempoolRpc
  118. def getMemPoolDescendantsVerbose(txid: DoubleSha256DigestBE): Future[Map[DoubleSha256DigestBE, GetMemPoolResult]]
    Definition Classes
    MempoolRpc
  119. def getMemPoolEntry(txid: DoubleSha256Digest): Future[GetMemPoolEntryResult]
    Definition Classes
    MempoolRpc
  120. def getMemPoolEntry(txid: DoubleSha256DigestBE): Future[GetMemPoolEntryResult]
    Definition Classes
    MempoolRpc
  121. def getMemPoolEntryOpt(txid: DoubleSha256DigestBE): Future[Option[GetMemPoolEntryResult]]
    Definition Classes
    MempoolRpc
  122. def getMemPoolEntryOpt(txid: DoubleSha256Digest): Future[Option[GetMemPoolEntryResult]]
    Definition Classes
    MempoolRpc
  123. def getMemPoolInfo: Future[GetMemPoolInfoResult]
    Definition Classes
    MempoolRpc
  124. def getMemoryInfo: Future[GetMemoryInfoResult]
    Definition Classes
    NodeRpc
  125. def getMiningInfo: Future[GetMiningInfoResult]
    Definition Classes
    MiningRpc
  126. def getNetTotals: Future[GetNetTotalsResult]
    Definition Classes
    P2PRpc
  127. def getNetworkHashPS(blocks: Int = 120, height: Int = -1): Future[BigDecimal]
    Definition Classes
    MiningRpc
  128. def getNetworkInfo: Future[GetNetworkInfoResult]
    Definition Classes
    P2PRpc
  129. def getNewAddress(accountOrLabel: String, addressType: AddressType, walletName: String): Future[BitcoinAddress]
    Definition Classes
    WalletRpc
  130. def getNewAddress(accountOrLabel: String, addressType: AddressType): Future[BitcoinAddress]
    Definition Classes
    WalletRpc
  131. def getNewAddress(accountOrLabel: String): Future[BitcoinAddress]
    Definition Classes
    WalletRpc
  132. def getNewAddress(addressType: AddressType): Future[BitcoinAddress]
    Definition Classes
    WalletRpc
  133. def getNewAddress(walletNameOpt: Option[String]): Future[BitcoinAddress]
    Definition Classes
    WalletRpc
  134. def getNewAddress: Future[BitcoinAddress]
    Definition Classes
    WalletRpc
  135. 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
  136. 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
  137. def getPeerInfo: Future[Vector[Peer]]
    Definition Classes
    P2PRpc
  138. def getRawChangeAddress(addressType: AddressType, walletName: String): Future[BitcoinAddress]
    Definition Classes
    WalletRpc
  139. def getRawChangeAddress(walletName: String): Future[BitcoinAddress]
    Definition Classes
    WalletRpc
  140. def getRawChangeAddress(addressType: AddressType): Future[BitcoinAddress]
    Definition Classes
    WalletRpc
  141. def getRawChangeAddress: Future[BitcoinAddress]
    Definition Classes
    WalletRpc
  142. def getRawMemPool: Future[Vector[DoubleSha256DigestBE]]
    Definition Classes
    MempoolRpc
  143. def getRawMemPoolWithTransactions: Future[Map[DoubleSha256DigestBE, GetMemPoolResult]]
    Definition Classes
    MempoolRpc
  144. def getRawTransaction(txid: DoubleSha256DigestBE, blockhash: Option[DoubleSha256DigestBE] = None): Future[GetRawTransactionResult]
    Definition Classes
    RawTransactionRpc
  145. def getRawTransactionRaw(txid: DoubleSha256DigestBE, blockhash: Option[DoubleSha256DigestBE] = None): Future[Transaction]
    Definition Classes
    RawTransactionRpc
  146. def getReceivedByAddress(address: BitcoinAddress, minConfirmations: Int = 1, walletNameOpt: Option[String] = None): Future[Bitcoins]
    Definition Classes
    WalletRpc
  147. def getTransaction(txid: DoubleSha256DigestBE, watchOnly: Boolean = false, walletNameOpt: Option[String] = None): Future[GetTransactionResult]
    Definition Classes
    TransactionRpc
  148. def getTxOut(txid: DoubleSha256DigestBE, vout: Int, includeMemPool: Boolean = true): Future[GetTxOutResult]
    Definition Classes
    TransactionRpc
  149. def getTxOutProof(txids: Vector[DoubleSha256DigestBE], headerHash: DoubleSha256DigestBE): Future[MerkleBlock]
    Definition Classes
    TransactionRpc
  150. def getTxOutProof(txids: Vector[DoubleSha256Digest], headerHash: DoubleSha256Digest): Future[MerkleBlock]
    Definition Classes
    TransactionRpc
  151. def getTxOutProof(txids: Vector[DoubleSha256DigestBE]): Future[MerkleBlock]
    Definition Classes
    TransactionRpc
  152. def getTxOutSetInfo: Future[GetTxOutSetInfoResult]
    Definition Classes
    TransactionRpc
  153. def getUnconfirmedBalance(walletName: String): Future[Bitcoins]
    Definition Classes
    WalletRpc
  154. def getUnconfirmedBalance: Future[Bitcoins]
    Definition Classes
    WalletRpc
  155. def getWalletInfo(walletName: String): Future[GetWalletInfoResult]
    Definition Classes
    WalletRpc
  156. def getWalletInfo: Future[GetWalletInfoResult]
    Definition Classes
    WalletRpc
  157. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  158. def help(rpcName: String = ""): Future[String]
    Definition Classes
    NodeRpc
  159. def importAddress(address: BitcoinAddress, account: String = "", rescan: Boolean = true, p2sh: Boolean = false, walletNameOpt: Option[String] = None): Future[Unit]
    Definition Classes
    WalletRpc
  160. def importMulti(requests: Vector[ImportMultiRequest], rescan: Boolean = true, walletNameOpt: Option[String] = None): Future[Vector[ImportMultiResult]]
    Definition Classes
    WalletRpc
  161. implicit val importMultiAddressWrites: Writes[ImportMultiAddress]
    Definition Classes
    Client
  162. implicit val importMultiRequestWrites: Writes[ImportMultiRequest]
    Definition Classes
    Client
  163. def importPrivKey(key: ECPrivateKeyBytes, account: String = "", rescan: Boolean = true, walletNameOpt: Option[String] = None): Future[Unit]
    Definition Classes
    WalletRpc
  164. def importPrunedFunds(transaction: Transaction, txOutProof: MerkleBlock, walletNameOpt: Option[String] = None): Future[Unit]
    Definition Classes
    WalletRpc
  165. def importPubKey(pubKey: ECPublicKey, label: String = "", rescan: Boolean = true, walletNameOpt: Option[String] = None): Future[Unit]
    Definition Classes
    WalletRpc
  166. def importWallet(filePath: String, walletNameOpt: Option[String] = None): Future[Unit]
    Definition Classes
    WalletRpc
  167. def info(mkr: Marker, msg: => Any, t: => Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  168. def info(msg: => Any, t: => Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  169. def info(msg: => Any): Unit
    Attributes
    protected
    Definition Classes
    Logging
  170. val instance: BitcoindInstance
    Definition Classes
    BitcoindRpcClient → Client
  171. def invalidateBlock(blockHash: DoubleSha256Digest): Future[Unit]
    Definition Classes
    BlockchainRpc
  172. def invalidateBlock(blockHash: DoubleSha256DigestBE): Future[Unit]
    Definition Classes
    BlockchainRpc
  173. def isAlive(): Boolean
    Definition Classes
    NativeProcessFactory
  174. def isDebugEnabled: Boolean
    Attributes
    protected
    Definition Classes
    Logging
  175. def isErrorEnabled: Boolean
    Attributes
    protected
    Definition Classes
    Logging
  176. def isInfoEnabled: Boolean
    Attributes
    protected
    Definition Classes
    Logging
  177. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  178. def isStartedF: Future[Boolean]

    Checks whether the underlying bitcoind daemon is running

    Checks whether the underlying bitcoind daemon is running

    Definition Classes
    Client
  179. 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
  180. def isTraceEnabled: Boolean
    Attributes
    protected
    Definition Classes
    Logging
  181. def isWarnEnabled: Boolean
    Attributes
    protected
    Definition Classes
    Logging
  182. def joinPsbts(psbts: Seq[PSBT]): Future[PSBT]
    Definition Classes
    PsbtRpc
  183. def keyPoolRefill(keyPoolSize: Int = 100, walletNameOpt: Option[String] = None): Future[Unit]
    Definition Classes
    WalletRpc
  184. def listAddressGroupings(walletName: String): Future[Vector[Vector[RpcAddress]]]
    Definition Classes
    WalletRpc
  185. def listAddressGroupings: Future[Vector[Vector[RpcAddress]]]
    Definition Classes
    WalletRpc
  186. def listBanned: Future[Vector[NodeBan]]
    Definition Classes
    P2PRpc
  187. def listLockUnspent: Future[Vector[TransactionOutPoint]]
    Definition Classes
    UTXORpc
  188. def listReceivedByAddress(confirmations: Int = 1, includeEmpty: Boolean = false, includeWatchOnly: Boolean = false, walletNameOpt: Option[String] = None): Future[Vector[ReceivedAddress]]
    Definition Classes
    WalletRpc
  189. def listSinceBlock(headerHash: DoubleSha256Digest, confirmations: Int, includeWatchOnly: Boolean): Future[ListSinceBlockResult]
    Definition Classes
    BlockchainRpc
  190. def listSinceBlock(headerHash: DoubleSha256Digest, includeWatchOnly: Boolean): Future[ListSinceBlockResult]
    Definition Classes
    BlockchainRpc
  191. def listSinceBlock(headerHash: DoubleSha256Digest, confirmations: Int): Future[ListSinceBlockResult]
    Definition Classes
    BlockchainRpc
  192. def listSinceBlock(headerHash: DoubleSha256Digest): Future[ListSinceBlockResult]
    Definition Classes
    BlockchainRpc
  193. def listSinceBlock(headerHash: DoubleSha256DigestBE, confirmations: Int, includeWatchOnly: Boolean): Future[ListSinceBlockResult]
    Definition Classes
    BlockchainRpc
  194. def listSinceBlock(headerHash: DoubleSha256DigestBE, includeWatchOnly: Boolean): Future[ListSinceBlockResult]
    Definition Classes
    BlockchainRpc
  195. def listSinceBlock(headerHash: DoubleSha256DigestBE, confirmations: Int): Future[ListSinceBlockResult]
    Definition Classes
    BlockchainRpc
  196. def listSinceBlock(headerHash: DoubleSha256DigestBE): Future[ListSinceBlockResult]
    Definition Classes
    BlockchainRpc
  197. def listSinceBlock(headerHash: Option[DoubleSha256DigestBE] = None, confirmations: Int = 1, includeWatchOnly: Boolean = false): Future[ListSinceBlockResult]
    Definition Classes
    BlockchainRpc
  198. def listSinceBlock: Future[ListSinceBlockResult]
    Definition Classes
    BlockchainRpc
  199. def listTransactions(account: String = "*", count: Int = 10, skip: Int = 0, includeWatchOnly: Boolean = false): Future[Vector[ListTransactionsResult]]
    Definition Classes
    BlockchainRpc
  200. def listUnspent(minConfirmations: Int, maxConfirmations: Int, addresses: Vector[BitcoinAddress]): Future[Vector[UnspentOutput]]
    Definition Classes
    UTXORpc
  201. def listUnspent(addresses: Vector[BitcoinAddress]): Future[Vector[UnspentOutput]]
    Definition Classes
    UTXORpc
  202. def listUnspent(minConfirmations: Int, maxConfirmations: Int): Future[Vector[UnspentOutput]]
    Definition Classes
    UTXORpc
  203. def listUnspent(walletName: String): Future[Vector[UnspentOutput]]
    Definition Classes
    UTXORpc
  204. def listUnspent: Future[Vector[UnspentOutput]]
    Definition Classes
    UTXORpc
  205. def listWallets: Future[Vector[String]]
    Definition Classes
    WalletRpc
  206. def loadWallet(filePath: String): Future[LoadWalletResult]
    Definition Classes
    WalletRpc
  207. def lockUnspent(unlock: Boolean, outputs: Vector[LockUnspentOutputParameter]): Future[Boolean]
    Definition Classes
    UTXORpc
  208. lazy val logFile: Path

    The log file of the Bitcoin Core daemon

    The log file of the Bitcoin Core daemon

    Definition Classes
    Client
  209. def logger: Logger
    Attributes
    protected
    Definition Classes
    Logging
  210. def loggerName: String
    Attributes
    protected
    Definition Classes
    Logging
  211. def logging(include: Vector[String] = Vector.empty, exclude: Vector[String] = Vector.empty): Future[Map[String, Boolean]]
    Definition Classes
    NodeRpc
  212. def logging: Future[Map[String, Boolean]]
    Definition Classes
    NodeRpc
  213. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  214. implicit val network: NetworkParameters
    Attributes
    protected
    Definition Classes
    Client
  215. def nextBlockHeaderBatchRange(prevStopHash: 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.

    Definition Classes
    BitcoindRpcClient → ChainApi
  216. def nextFilterHeaderBatchRange(startHeight: Int, 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
    BitcoindRpcClient → ChainApi
  217. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  218. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  219. def ping(): Future[Unit]
    Definition Classes
    Client
  220. def preciousBlock(headerHash: DoubleSha256Digest): Future[Unit]
    Definition Classes
    BlockchainRpc
  221. def preciousBlock(headerHash: DoubleSha256DigestBE): Future[Unit]
    Definition Classes
    BlockchainRpc
  222. def prioritiseTransaction(txid: DoubleSha256Digest, feeDelta: Satoshis): Future[Boolean]
    Definition Classes
    MiningRpc
  223. def prioritiseTransaction(txid: DoubleSha256DigestBE, feeDelta: Satoshis): Future[Boolean]
    Definition Classes
    MiningRpc
  224. 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
  225. def processCheckpoints(checkpoints: Vector[DoubleSha256DigestBE], blockHash: DoubleSha256DigestBE): Future[ChainApi]

    Process all ompact filter header check points.

    Process all ompact filter header check points.

    Definition Classes
    BitcoindRpcClient → ChainApi
  226. 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
  227. 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
  228. 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
  229. 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
  230. 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
  231. 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
  232. def pruneBlockChain(height: Int): Future[Int]
    Definition Classes
    BlockchainRpc
  233. def removePrunedFunds(txid: DoubleSha256Digest, walletNameOpt: Option[String]): Future[Unit]
    Definition Classes
    WalletRpc
  234. def removePrunedFunds(txid: DoubleSha256Digest): Future[Unit]
    Definition Classes
    WalletRpc
  235. def removePrunedFunds(txid: DoubleSha256DigestBE): Future[Unit]
    Definition Classes
    WalletRpc
  236. def removePrunedFunds(txid: DoubleSha256DigestBE, walletNameOpt: Option[String]): Future[Unit]
    Definition Classes
    WalletRpc
  237. def rescanBlockChain(start: Int, stop: Int): Future[RescanBlockChainResult]
    Definition Classes
    BlockchainRpc
  238. def rescanBlockChain(start: Int): Future[RescanBlockChainResult]
    Definition Classes
    BlockchainRpc
  239. def rescanBlockChain(): Future[RescanBlockChainResult]
    Definition Classes
    BlockchainRpc
  240. def saveMemPool(): Future[Unit]
    Definition Classes
    MempoolRpc
  241. def sendMany(amounts: Map[BitcoinAddress, CurrencyUnit], minconf: Int = 1, comment: String = "", subtractFeeFrom: Vector[BitcoinAddress] = Vector.empty, walletNameOpt: Option[String] = None): Future[DoubleSha256DigestBE]
    Definition Classes
    WalletRpc
  242. def sendRawTransaction(transaction: Transaction, maxfeerate: Double = 0.10): Future[DoubleSha256DigestBE]

    maxfeerate

    Set to 0 if you want to enable allowhighfees

    Definition Classes
    RawTransactionRpc
  243. def sendRequest(req: HttpRequest): Future[HttpResponse]
    Attributes
    protected
    Definition Classes
    Client
  244. def sendToAddress(address: BitcoinAddress, amount: CurrencyUnit, localComment: String = "", toComment: String = "", subractFeeFromAmount: Boolean = false, walletNameOpt: Option[String] = None): Future[DoubleSha256DigestBE]
    Definition Classes
    WalletRpc
  245. def setBan(address: URI, command: SetBanCommand, banTime: Int = 86400, absolute: Boolean = false): Future[Unit]
    Definition Classes
    P2PRpc
  246. def setNetworkActive(activate: Boolean): Future[Unit]
    Definition Classes
    P2PRpc
  247. def setTxFee(feePerKB: Bitcoins, walletNameOpt: Option[String] = None): Future[Boolean]
    Definition Classes
    WalletRpc
  248. def setWalletFlag(flag: WalletFlag, value: Boolean, walletNameOpt: Option[String] = None): 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
  249. def signMessage(address: P2PKHAddress, message: String): Future[String]
    Definition Classes
    MessageRpc
  250. def signMessageWithPrivKey(key: ECPrivateKeyBytes, message: String): Future[String]
    Definition Classes
    MessageRpc
  251. def signRawTransactionWithWallet(transaction: Transaction): Future[SignRawTransactionWithWalletResult]
    Definition Classes
    WalletRpc
  252. def signRawTransactionWithWallet(transaction: Transaction, walletNameOpt: Option[String]): Future[SignRawTransactionWithWalletResult]
    Definition Classes
    WalletRpc
  253. 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
  254. 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
  255. 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
  256. 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
  257. def submitBlock(block: Block): Future[Unit]
    Definition Classes
    P2PRpc
  258. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  259. implicit val system: ActorSystem
    Definition Classes
    BitcoindRpcClient → Client
  260. def toString(): String
    Definition Classes
    AnyRef → Any
  261. def trace(mkr: Marker, msg: => Any, t: => Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  262. def trace(msg: => Any, t: => Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  263. def trace(msg: => Any): Unit
    Attributes
    protected
    Definition Classes
    Logging
  264. def unloadWallet(filePath: String): Future[Unit]
    Definition Classes
    WalletRpc
  265. def uptime: Future[UInt32]
    Definition Classes
    NodeRpc
  266. def utxoUpdatePsbt(psbt: PSBT, descriptors: Seq[String]): Future[PSBT]
    Definition Classes
    PsbtRpc
  267. def utxoUpdatePsbt(psbt: PSBT): Future[PSBT]
    Definition Classes
    PsbtRpc
  268. def validateAddress(address: BitcoinAddress): Future[ValidateAddressResult]
    Definition Classes
    UtilRpc
  269. def verifyChain(level: Int = 3, blocks: Int = 6): Future[Boolean]
    Definition Classes
    BlockchainRpc
  270. def verifyMessage(address: P2PKHAddress, signature: String, message: String): Future[Boolean]
    Definition Classes
    MessageRpc
  271. def verifyTxOutProof(proof: MerkleBlock): Future[Vector[DoubleSha256DigestBE]]
    Definition Classes
    TransactionRpc
  272. def version: BitcoindVersion
    Definition Classes
    BitcoindRpcClient → Client
  273. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  274. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  275. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  276. def walletCreateFundedPsbt(inputs: Vector[TransactionInput], outputs: Map[BitcoinAddress, CurrencyUnit], locktime: Int = 0, options: WalletCreateFundedPsbtOptions = WalletCreateFundedPsbtOptions(), bip32derivs: Boolean = false, walletNameOpt: Option[String] = None): Future[WalletCreateFundedPsbtResult]
    Definition Classes
    WalletRpc
  277. def walletExtension(walletName: String): String
    Attributes
    protected
    Definition Classes
    Client
  278. def walletLock(walletName: String): Future[Unit]
    Definition Classes
    WalletRpc
  279. def walletLock(): Future[Unit]
    Definition Classes
    WalletRpc
  280. def walletPassphrase(passphrase: String, seconds: Int, walletNameOpt: Option[String] = None): Future[Unit]
    Definition Classes
    WalletRpc
  281. def walletPassphraseChange(currentPassphrase: String, newPassphrase: String, walletNameOpt: Option[String] = None): Future[Unit]
    Definition Classes
    WalletRpc
  282. def walletProcessPSBT(psbt: PSBT, sign: Boolean = true, sigHashType: HashType = HashType.sigHashAll, walletNameOpt: Option[String] = None): Future[WalletProcessPsbtResult]
    Definition Classes
    WalletRpc
  283. def warn(mkr: Marker, msg: => Any, t: => Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  284. def warn(msg: => Any, t: => Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  285. def warn(msg: => Any): Unit
    Attributes
    protected
    Definition Classes
    Logging
  286. 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
  287. 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

Deprecated Value Members

  1. def generate(blocks: Int, maxTries: Int = 1000000): Future[Vector[DoubleSha256DigestBE]]
    Definition Classes
    MiningRpc
    Annotations
    @deprecated
    Deprecated

    (Since version 0.18.0) use generateToAddress instead

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 Logging

Inherited from AnyRef

Inherited from Any

Ungrouped