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 V19BlockFilterRpc with V20MultisigRpc with V20AssortedRpc

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.

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BitcoindRpcClient
  2. V20AssortedRpc
  3. V20MultisigRpc
  4. V19BlockFilterRpc
  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 abortRescan(): Future[Unit]
    Definition Classes
    NodeRpc
  7. def addMultiSigAddress(minSignatures: Int, keys: Vector[Either[ECPublicKey, P2PKHAddress]], account: String, addressType: AddressType): Future[MultiSigResultPostV20]
    Definition Classes
    V20MultisigRpc → MultisigRpc
  8. def addMultiSigAddress(minSignatures: Int, keys: Vector[Either[ECPublicKey, P2PKHAddress]], addressType: AddressType): Future[MultiSigResultPostV20]
    Definition Classes
    V20MultisigRpc → MultisigRpc
  9. def addMultiSigAddress(minSignatures: Int, keys: Vector[Either[ECPublicKey, P2PKHAddress]], account: String): Future[MultiSigResultPostV20]
    Definition Classes
    V20MultisigRpc → MultisigRpc
  10. def addMultiSigAddress(minSignatures: Int, keys: Vector[Either[ECPublicKey, P2PKHAddress]]): Future[MultiSigResultPostV20]
    Definition Classes
    V20MultisigRpc → 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]
    Definition Classes
    NodeApi
  17. def broadcastTransactions(transactions: Vector[Transaction]): Future[Unit]
    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
    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 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
  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], addressType: AddressType, walletNameOpt: Option[String] = None): Future[MultiSigResultPostV20]
    Definition Classes
    V20MultisigRpc → 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 = "", avoidReuse: Boolean = false, descriptors: Boolean = false): Future[CreateWalletResult]

    blank

    Not available to versions before v19

    passphrase

    Not available to versions before v19

    Definition Classes
    WalletRpc
  32. def decodePsbt(psbt: PSBT): Future[DecodePsbtResult]
    Definition Classes
    PsbtRpc
  33. def decodeRawTransaction(transaction: Transaction): Future[RpcTransaction]
    Definition Classes
    RawTransactionRpc
  34. def decodeScript(script: ScriptPubKey): Future[DecodeScriptResult]
    Definition Classes
    UtilRpc
  35. def disconnectNode(address: URI): Future[Unit]
    Definition Classes
    P2PRpc
  36. def downloadBlocks(blockHashes: Vector[DoubleSha256DigestBE]): Future[Unit]
    Definition Classes
    BitcoindRpcClient → NodeApi
  37. def dumpPrivKey(address: BitcoinAddress, walletNameOpt: Option[String] = None): Future[ECPrivateKeyBytes]
    Definition Classes
    WalletRpc
  38. def dumpTxOutSet(path: Path): Future[DumpTxOutSetResult]
    Definition Classes
    V20AssortedRpc
  39. def dumpWallet(filePath: String, walletNameOpt: Option[String] = None): Future[DumpWalletResult]
    Definition Classes
    WalletRpc
  40. implicit val eCPrivateKeyBytesWrites: Writes[ECPrivateKeyBytes]
    Definition Classes
    Client
  41. implicit val eCPrivateKeyWrites: Writes[ECPrivateKey]
    Definition Classes
    Client
  42. def encryptWallet(passphrase: String, walletNameOpt: Option[String] = None): Future[String]
    Definition Classes
    WalletRpc
  43. 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
  44. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  45. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  46. def estimateSmartFee(blocks: Int, mode: FeeEstimationMode = FeeEstimationMode.Ecnomical): Future[EstimateSmartFeeResult]
    Definition Classes
    TransactionRpc
  47. implicit val executionContext: ExecutionContext
    Attributes
    protected
    Definition Classes
    Client → NativeProcessFactory
  48. def filterHeadersUnsupported: Future[Nothing]
    Attributes
    protected
  49. def filtersUnsupported: Future[Nothing]
    Attributes
    protected
  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]]
  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
    V20AssortedRpc
  60. def getAddedNodeInfo(node: URI): Future[Vector[Node]]
    Definition Classes
    P2PRpc
  61. def getAddedNodeInfo: Future[Vector[Node]]
    Definition Classes
    P2PRpc
  62. def getAddressInfo(address: BitcoinAddress, walletNameOpt: Option[String] = None): Future[AddressInfoResult]
    Definition Classes
    WalletRpc
  63. def getBalance(walletName: String): Future[Bitcoins]
    Definition Classes
    WalletRpc
  64. def getBalance: Future[Bitcoins]
    Definition Classes
    WalletRpc
  65. def getBalances(walletName: String): Future[GetBalancesResult]
    Definition Classes
    WalletRpc
  66. def getBalances: Future[GetBalancesResult]
    Definition Classes
    WalletRpc
  67. def getBestBlockHash(): Future[DoubleSha256DigestBE]
    Definition Classes
    BlockchainRpc
  68. def getBestBlockHeader(): Future[BlockHeaderDb]
    Definition Classes
    BitcoindRpcClient → ChainApi
  69. def getBestChainTips(): Future[Vector[BlockHeaderDb]]
    Definition Classes
    BitcoindRpcClient → ChainApi
  70. def getBestFilter(): Future[Option[CompactFilterDb]]
    Definition Classes
    BitcoindRpcClient → ChainApi
  71. def getBestFilterHeader(): Future[Option[CompactFilterHeaderDb]]
    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 getBlockFilter(blockhash: DoubleSha256DigestBE, filtertype: FilterType): Future[GetBlockFilterResult]
    Definition Classes
    V19BlockFilterRpc
  78. def getBlockHash(height: Int): Future[DoubleSha256DigestBE]
    Definition Classes
    BlockchainRpc
  79. def getBlockHeader(headerHash: DoubleSha256Digest): Future[GetBlockHeaderResult]
    Definition Classes
    BlockchainRpc
  80. def getBlockHeader(headerHash: DoubleSha256DigestBE): Future[GetBlockHeaderResult]
    Definition Classes
    BlockchainRpc
  81. def getBlockHeaderRaw(headerHash: DoubleSha256Digest): Future[BlockHeader]
    Definition Classes
    BlockchainRpc
  82. def getBlockHeaderRaw(headerHash: DoubleSha256DigestBE): Future[BlockHeader]
    Definition Classes
    BlockchainRpc
  83. 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
  84. def getBlockRaw(headerHash: DoubleSha256Digest): Future[Block]
    Definition Classes
    BlockchainRpc
  85. def getBlockRaw(headerHash: DoubleSha256DigestBE): Future[Block]
    Definition Classes
    BlockchainRpc
  86. def getBlockTemplate(request: Option[BlockTemplateRequest] = None): Future[GetBlockTemplateResult]
    Definition Classes
    MiningRpc
  87. def getBlockWithTransactions(headerHash: DoubleSha256Digest): Future[GetBlockWithTransactionsResult]
    Definition Classes
    BlockchainRpc
  88. def getBlockWithTransactions(headerHash: DoubleSha256DigestBE): Future[GetBlockWithTransactionsResult]
    Definition Classes
    BlockchainRpc
  89. def getChainTips: Future[Vector[ChainTip]]
    Definition Classes
    BlockchainRpc
  90. def getChainTxStats(blocks: Int, blockHash: DoubleSha256Digest): Future[GetChainTxStatsResult]
    Definition Classes
    BlockchainRpc
  91. def getChainTxStats(blocks: Int, blockHash: DoubleSha256DigestBE): Future[GetChainTxStatsResult]
    Definition Classes
    BlockchainRpc
  92. def getChainTxStats(blocks: Int): Future[GetChainTxStatsResult]
    Definition Classes
    BlockchainRpc
  93. def getChainTxStats: Future[GetChainTxStatsResult]
    Definition Classes
    BlockchainRpc
  94. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  95. def getConnectionCount: Future[Int]
    Definition Classes
    BitcoindRpcClient → P2PRpc → NodeApi
  96. def getDaemon: BitcoindInstance
    Definition Classes
    Client
  97. def getDifficulty: Future[BigDecimal]
    Definition Classes
    BlockchainRpc
  98. def getFeeRate(): Future[FeeUnit]
    Definition Classes
    BitcoindRpcClient → FeeRateApi
  99. def getFilter(hash: DoubleSha256DigestBE): Future[Option[CompactFilterDb]]
    Definition Classes
    BitcoindRpcClient → ChainApi
  100. 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
  101. def getFilterHeader(blockHash: DoubleSha256DigestBE): Future[Option[CompactFilterHeaderDb]]
    Definition Classes
    BitcoindRpcClient → ChainApi
  102. def getFilterHeaderCount(): Future[Int]
    Definition Classes
    BitcoindRpcClient → ChainApi
  103. def getFilterHeadersAtHeight(height: Int): Future[Vector[CompactFilterHeaderDb]]
    Definition Classes
    BitcoindRpcClient → ChainApi
  104. def getFiltersAtHeight(height: Int): Future[Vector[CompactFilterDb]]
    Definition Classes
    BitcoindRpcClient → ChainApi
  105. def getFiltersBetweenHeights(startHeight: Int, endHeight: Int): Future[Vector[FilterResponse]]
    Definition Classes
    BitcoindRpcClient → ChainQueryApi
  106. def getHeader(hash: DoubleSha256DigestBE): Future[Option[BlockHeaderDb]]
    Definition Classes
    BitcoindRpcClient → ChainApi
  107. def getHeaders(hashes: Vector[DoubleSha256DigestBE]): Future[Vector[Option[BlockHeaderDb]]]
    Definition Classes
    BitcoindRpcClient → ChainApi
  108. def getHeadersAtHeight(height: Int): Future[Vector[BlockHeaderDb]]
    Definition Classes
    BitcoindRpcClient → ChainApi
  109. def getHeadersBetween(from: BlockHeaderDb, to: BlockHeaderDb): Future[Vector[BlockHeaderDb]]
    Definition Classes
    BitcoindRpcClient → ChainApi
  110. 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
  111. def getIndexInfo(indexName: String): Future[IndexInfoResult]
    Definition Classes
    UtilRpc
  112. def getIndexInfo: Future[Map[String, IndexInfoResult]]
    Definition Classes
    UtilRpc
  113. def getMedianTimePast(): Future[Long]
    Definition Classes
    BitcoindRpcClient → ChainQueryApi
  114. def getMemPoolAncestors(txid: DoubleSha256Digest): Future[Vector[DoubleSha256DigestBE]]
    Definition Classes
    MempoolRpc
  115. def getMemPoolAncestors(txid: DoubleSha256DigestBE): Future[Vector[DoubleSha256DigestBE]]
    Definition Classes
    MempoolRpc
  116. def getMemPoolAncestorsVerbose(txid: DoubleSha256Digest): Future[Map[DoubleSha256DigestBE, GetMemPoolResult]]
    Definition Classes
    MempoolRpc
  117. def getMemPoolAncestorsVerbose(txid: DoubleSha256DigestBE): Future[Map[DoubleSha256DigestBE, GetMemPoolResult]]
    Definition Classes
    MempoolRpc
  118. def getMemPoolDescendants(txid: DoubleSha256Digest): Future[Vector[DoubleSha256DigestBE]]
    Definition Classes
    MempoolRpc
  119. def getMemPoolDescendants(txid: DoubleSha256DigestBE): Future[Vector[DoubleSha256DigestBE]]
    Definition Classes
    MempoolRpc
  120. def getMemPoolDescendantsVerbose(txid: DoubleSha256Digest): Future[Map[DoubleSha256DigestBE, GetMemPoolResult]]
    Definition Classes
    MempoolRpc
  121. def getMemPoolDescendantsVerbose(txid: DoubleSha256DigestBE): Future[Map[DoubleSha256DigestBE, GetMemPoolResult]]
    Definition Classes
    MempoolRpc
  122. def getMemPoolEntry(txid: DoubleSha256Digest): Future[GetMemPoolEntryResult]
    Definition Classes
    MempoolRpc
  123. def getMemPoolEntry(txid: DoubleSha256DigestBE): Future[GetMemPoolEntryResult]
    Definition Classes
    MempoolRpc
  124. def getMemPoolEntryOpt(txid: DoubleSha256DigestBE): Future[Option[GetMemPoolEntryResult]]
    Definition Classes
    MempoolRpc
  125. def getMemPoolEntryOpt(txid: DoubleSha256Digest): Future[Option[GetMemPoolEntryResult]]
    Definition Classes
    MempoolRpc
  126. def getMemPoolInfo: Future[GetMemPoolInfoResult]
    Definition Classes
    MempoolRpc
  127. def getMemoryInfo: Future[GetMemoryInfoResult]
    Definition Classes
    NodeRpc
  128. def getMiningInfo: Future[GetMiningInfoResult]
    Definition Classes
    MiningRpc
  129. def getNetTotals: Future[GetNetTotalsResult]
    Definition Classes
    P2PRpc
  130. def getNetworkHashPS(blocks: Int = 120, height: Int = -1): Future[BigDecimal]
    Definition Classes
    MiningRpc
  131. def getNetworkInfo: Future[GetNetworkInfoResult]
    Definition Classes
    P2PRpc
  132. def getNewAddress(accountOrLabel: String, addressType: AddressType, walletName: String): Future[BitcoinAddress]
    Definition Classes
    WalletRpc
  133. def getNewAddress(accountOrLabel: String, addressType: AddressType): Future[BitcoinAddress]
    Definition Classes
    WalletRpc
  134. def getNewAddress(accountOrLabel: String): Future[BitcoinAddress]
    Definition Classes
    WalletRpc
  135. def getNewAddress(addressType: AddressType): Future[BitcoinAddress]
    Definition Classes
    WalletRpc
  136. def getNewAddress(walletNameOpt: Option[String]): Future[BitcoinAddress]
    Definition Classes
    WalletRpc
  137. def getNewAddress: Future[BitcoinAddress]
    Definition Classes
    WalletRpc
  138. 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
  139. 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
  140. def getPeerInfo: Future[Vector[Peer]]
    Definition Classes
    P2PRpc
  141. def getRawChangeAddress(addressType: AddressType, walletName: String): Future[BitcoinAddress]
    Definition Classes
    WalletRpc
  142. def getRawChangeAddress(walletName: String): Future[BitcoinAddress]
    Definition Classes
    WalletRpc
  143. def getRawChangeAddress(addressType: AddressType): Future[BitcoinAddress]
    Definition Classes
    WalletRpc
  144. def getRawChangeAddress: Future[BitcoinAddress]
    Definition Classes
    WalletRpc
  145. def getRawMemPool: Future[Vector[DoubleSha256DigestBE]]
    Definition Classes
    MempoolRpc
  146. def getRawMemPoolWithTransactions: Future[Map[DoubleSha256DigestBE, GetMemPoolResult]]
    Definition Classes
    MempoolRpc
  147. def getRawTransaction(txid: DoubleSha256DigestBE, blockhash: Option[DoubleSha256DigestBE] = None): Future[GetRawTransactionResult]
    Definition Classes
    RawTransactionRpc
  148. def getRawTransactionRaw(txid: DoubleSha256DigestBE, blockhash: Option[DoubleSha256DigestBE] = None): Future[Transaction]
    Definition Classes
    RawTransactionRpc
  149. def getReceivedByAddress(address: BitcoinAddress, minConfirmations: Int = 1, walletNameOpt: Option[String] = None): Future[Bitcoins]
    Definition Classes
    WalletRpc
  150. def getTransaction(txid: DoubleSha256DigestBE, watchOnly: Boolean = false, walletNameOpt: Option[String] = None): Future[GetTransactionResult]
    Definition Classes
    TransactionRpc
  151. def getTxOut(txid: DoubleSha256DigestBE, vout: Long, includeMemPool: Boolean = true): Future[GetTxOutResult]
    Definition Classes
    TransactionRpc
  152. def getTxOutOpt(txid: DoubleSha256DigestBE, vout: Long, includeMemPool: Boolean = true): Future[Option[GetTxOutResult]]
    Definition Classes
    TransactionRpc
  153. def getTxOutProof(txids: Vector[DoubleSha256DigestBE], headerHash: DoubleSha256DigestBE): Future[MerkleBlock]
    Definition Classes
    TransactionRpc
  154. def getTxOutProof(txids: Vector[DoubleSha256Digest], headerHash: DoubleSha256Digest): Future[MerkleBlock]
    Definition Classes
    TransactionRpc
  155. def getTxOutProof(txids: Vector[DoubleSha256DigestBE]): Future[MerkleBlock]
    Definition Classes
    TransactionRpc
  156. def getTxOutSetInfo: Future[GetTxOutSetInfoResult]
    Definition Classes
    TransactionRpc
  157. def getUnconfirmedBalance(walletName: String): Future[Bitcoins]
    Definition Classes
    WalletRpc
  158. def getUnconfirmedBalance: Future[Bitcoins]
    Definition Classes
    WalletRpc
  159. def getWalletInfo(walletName: String): Future[GetWalletInfoResult]
    Definition Classes
    WalletRpc
  160. def getWalletInfo: Future[GetWalletInfoResult]
    Definition Classes
    WalletRpc
  161. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  162. def help(rpcName: String = ""): Future[String]
    Definition Classes
    NodeRpc
  163. def importAddress(address: BitcoinAddress, account: String = "", rescan: Boolean = true, p2sh: Boolean = false, walletNameOpt: Option[String] = None): Future[Unit]
    Definition Classes
    WalletRpc
  164. def importMulti(requests: Vector[ImportMultiRequest], rescan: Boolean = true, walletNameOpt: Option[String] = None): Future[Vector[ImportMultiResult]]
    Definition Classes
    WalletRpc
  165. implicit val importMultiAddressWrites: Writes[ImportMultiAddress]
    Definition Classes
    Client
  166. implicit val importMultiRequestWrites: Writes[ImportMultiRequest]
    Definition Classes
    Client
  167. def importPrivKey(key: ECPrivateKeyBytes, account: String = "", rescan: Boolean = true, walletNameOpt: Option[String] = None): Future[Unit]
    Definition Classes
    WalletRpc
  168. def importPrunedFunds(transaction: Transaction, txOutProof: MerkleBlock, walletNameOpt: Option[String] = None): Future[Unit]
    Definition Classes
    WalletRpc
  169. def importPubKey(pubKey: ECPublicKey, label: String = "", rescan: Boolean = true, walletNameOpt: Option[String] = None): Future[Unit]
    Definition Classes
    WalletRpc
  170. def importWallet(filePath: String, walletNameOpt: Option[String] = None): Future[Unit]
    Definition Classes
    WalletRpc
  171. val instance: BitcoindInstance
    Definition Classes
    BitcoindRpcClient → Client
  172. def invalidateBlock(blockHash: DoubleSha256Digest): Future[Unit]
    Definition Classes
    BlockchainRpc
  173. def invalidateBlock(blockHash: DoubleSha256DigestBE): Future[Unit]
    Definition Classes
    BlockchainRpc
  174. def isAlive(): Boolean
    Definition Classes
    NativeProcessFactory
  175. def isIBD(): Future[Boolean]
    Definition Classes
    BitcoindRpcClient → ChainApi
  176. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  177. def isStartedF: Future[Boolean]

    Checks whether the underlying bitcoind daemon is running

    Checks whether the underlying bitcoind daemon is running

    Definition Classes
    Client
  178. 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
  179. def isSyncing(): Future[Boolean]
    Definition Classes
    BitcoindRpcClient → ChainApi
  180. def isTipStale(): Future[Boolean]
    Definition Classes
    BitcoindRpcClient → ChainApi
  181. def joinPsbts(psbts: Seq[PSBT]): Future[PSBT]
    Definition Classes
    PsbtRpc
  182. def keyPoolRefill(keyPoolSize: Int = 100, walletNameOpt: Option[String] = None): Future[Unit]

    Definition Classes
    WalletRpc
  183. def listAddressGroupings(walletName: String): Future[Vector[Vector[RpcAddress]]]
    Definition Classes
    WalletRpc
  184. def listAddressGroupings: Future[Vector[Vector[RpcAddress]]]
    Definition Classes
    WalletRpc
  185. def listBanned: Future[Vector[NodeBan]]
    Definition Classes
    P2PRpc
  186. def listLockUnspent: Future[Vector[TransactionOutPoint]]
    Definition Classes
    UTXORpc
  187. def listReceivedByAddress(confirmations: Int = 1, includeEmpty: Boolean = false, includeWatchOnly: Boolean = false, walletNameOpt: Option[String] = None): Future[Vector[ReceivedAddress]]
    Definition Classes
    WalletRpc
  188. def listSinceBlock(headerHash: DoubleSha256Digest, confirmations: Int, includeWatchOnly: Boolean): Future[ListSinceBlockResult]
    Definition Classes
    BlockchainRpc
  189. def listSinceBlock(headerHash: DoubleSha256Digest, includeWatchOnly: Boolean): Future[ListSinceBlockResult]
    Definition Classes
    BlockchainRpc
  190. def listSinceBlock(headerHash: DoubleSha256Digest, confirmations: Int): Future[ListSinceBlockResult]
    Definition Classes
    BlockchainRpc
  191. def listSinceBlock(headerHash: DoubleSha256Digest): Future[ListSinceBlockResult]
    Definition Classes
    BlockchainRpc
  192. def listSinceBlock(headerHash: DoubleSha256DigestBE, confirmations: Int, includeWatchOnly: Boolean): Future[ListSinceBlockResult]
    Definition Classes
    BlockchainRpc
  193. def listSinceBlock(headerHash: DoubleSha256DigestBE, includeWatchOnly: Boolean): Future[ListSinceBlockResult]
    Definition Classes
    BlockchainRpc
  194. def listSinceBlock(headerHash: DoubleSha256DigestBE, confirmations: Int): Future[ListSinceBlockResult]
    Definition Classes
    BlockchainRpc
  195. def listSinceBlock(headerHash: DoubleSha256DigestBE): Future[ListSinceBlockResult]
    Definition Classes
    BlockchainRpc
  196. def listSinceBlock(headerHash: Option[DoubleSha256DigestBE] = None, confirmations: Int = 1, includeWatchOnly: Boolean = false): Future[ListSinceBlockResult]
    Definition Classes
    BlockchainRpc
  197. def listSinceBlock: Future[ListSinceBlockResult]
    Definition Classes
    BlockchainRpc
  198. def listTransactions(account: String = "*", count: Int = 10, skip: Int = 0, includeWatchOnly: Boolean = false): Future[Vector[ListTransactionsResult]]
    Definition Classes
    BlockchainRpc
  199. def listUnspent(minConfirmations: Int, maxConfirmations: Int, addresses: Vector[BitcoinAddress]): Future[Vector[UnspentOutput]]
    Definition Classes
    UTXORpc
  200. def listUnspent(addresses: Vector[BitcoinAddress]): Future[Vector[UnspentOutput]]
    Definition Classes
    UTXORpc
  201. def listUnspent(minConfirmations: Int, maxConfirmations: Int): Future[Vector[UnspentOutput]]
    Definition Classes
    UTXORpc
  202. def listUnspent(walletName: String): Future[Vector[UnspentOutput]]
    Definition Classes
    UTXORpc
  203. def listUnspent: Future[Vector[UnspentOutput]]
    Definition Classes
    UTXORpc
  204. def listWallets: Future[Vector[String]]
    Definition Classes
    WalletRpc
  205. def loadWallet(filePath: String): Future[LoadWalletResult]
    Definition Classes
    WalletRpc
  206. def lockUnspent(unlock: Boolean, outputs: Vector[LockUnspentOutputParameter]): Future[Boolean]
    Definition Classes
    UTXORpc
  207. 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
  208. def logger: Logger
    Definition Classes
    BitcoinSLogger
  209. def logging(include: Vector[String] = Vector.empty, exclude: Vector[String] = Vector.empty): Future[Map[String, Boolean]]
    Definition Classes
    NodeRpc
  210. def logging: Future[Map[String, Boolean]]
    Definition Classes
    NodeRpc
  211. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  212. implicit val network: NetworkParameters
    Attributes
    protected
    Definition Classes
    Client
  213. def nextBlockHeaderBatchRange(prevStopHash: DoubleSha256DigestBE, stopHash: DoubleSha256DigestBE, batchSize: Int): Future[Option[FilterSyncMarker]]
    Definition Classes
    BitcoindRpcClient → ChainApi
  214. def nextFilterHeaderBatchRange(stopBlockHash: DoubleSha256DigestBE, batchSize: Int, startHeightOpt: Option[Int]): Future[Option[FilterSyncMarker]]
    Definition Classes
    BitcoindRpcClient → ChainApi
  215. final def nextFilterHeaderBatchRange(stopBlockHash: DoubleSha256DigestBE, batchSize: Int): Future[Option[FilterSyncMarker]]
    Definition Classes
    ChainApi
  216. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  217. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  218. def ping(): Future[Unit]
    Definition Classes
    Client
  219. def preciousBlock(headerHash: DoubleSha256Digest): Future[Unit]
    Definition Classes
    BlockchainRpc
  220. def preciousBlock(headerHash: DoubleSha256DigestBE): Future[Unit]
    Definition Classes
    BlockchainRpc
  221. def prioritiseTransaction(txid: DoubleSha256Digest, feeDelta: Satoshis): Future[Boolean]
    Definition Classes
    MiningRpc
  222. def prioritiseTransaction(txid: DoubleSha256DigestBE, feeDelta: Satoshis): Future[Boolean]
    Definition Classes
    MiningRpc
  223. def processCheckpoint(filterHeaderHash: DoubleSha256DigestBE, blockHash: DoubleSha256DigestBE): Future[ChainApi]
    Definition Classes
    ChainApi
  224. def processCheckpoints(checkpoints: Vector[DoubleSha256DigestBE], blockHash: DoubleSha256DigestBE): Future[ChainApi]
    Definition Classes
    BitcoindRpcClient → ChainApi
  225. def processFilter(message: CompactFilterMessage): Future[ChainApi]
    Definition Classes
    ChainApi
  226. def processFilterHeader(filterHeader: FilterHeader, blockHash: DoubleSha256DigestBE): Future[ChainApi]
    Definition Classes
    ChainApi
  227. def processFilterHeaders(filterHeaders: Vector[FilterHeader], stopHash: DoubleSha256DigestBE): Future[ChainApi]
    Definition Classes
    BitcoindRpcClient → ChainApi
  228. def processFilters(message: Vector[CompactFilterMessage]): Future[ChainApi]
    Definition Classes
    BitcoindRpcClient → ChainApi
  229. def processHeader(header: BlockHeader): Future[ChainApi]
    Definition Classes
    ChainApi
  230. def processHeaders(headers: Vector[BlockHeader]): Future[ChainApi]
    Definition Classes
    BitcoindRpcClient → ChainApi
  231. def pruneBlockChain(height: Int): Future[Int]
    Definition Classes
    BlockchainRpc
  232. def removePrunedFunds(txid: DoubleSha256Digest, walletNameOpt: Option[String]): Future[Unit]
    Definition Classes
    WalletRpc
  233. def removePrunedFunds(txid: DoubleSha256Digest): Future[Unit]
    Definition Classes
    WalletRpc
  234. def removePrunedFunds(txid: DoubleSha256DigestBE): Future[Unit]
    Definition Classes
    WalletRpc
  235. def removePrunedFunds(txid: DoubleSha256DigestBE, walletNameOpt: Option[String]): Future[Unit]
    Definition Classes
    WalletRpc
  236. def rescanBlockChain(start: Int, stop: Int): Future[RescanBlockChainResult]
    Definition Classes
    BlockchainRpc
  237. def rescanBlockChain(start: Int): Future[RescanBlockChainResult]
    Definition Classes
    BlockchainRpc
  238. def rescanBlockChain(): Future[RescanBlockChainResult]
    Definition Classes
    BlockchainRpc
  239. def saveMemPool(): Future[Unit]
    Definition Classes
    MempoolRpc
  240. 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
  241. def sendRawTransaction(transaction: Transaction, maxfeerate: Double = 0.10): Future[DoubleSha256DigestBE]

    maxfeerate

    Set to 0 if you want to enable allowhighfees

    Definition Classes
    RawTransactionRpc
  242. def sendRequest(req: HttpRequest): Future[HttpResponse]
    Attributes
    protected
    Definition Classes
    Client
  243. def sendToAddress(address: BitcoinAddress, amount: CurrencyUnit, localComment: String = "", toComment: String = "", subractFeeFromAmount: Boolean = false, walletNameOpt: Option[String] = None): Future[DoubleSha256DigestBE]
    Definition Classes
    WalletRpc
  244. def setBan(address: URI, command: SetBanCommand, banTime: Int = 86400, absolute: Boolean = false): Future[Unit]
    Definition Classes
    P2PRpc
  245. def setIBD(value: Boolean): Future[ChainApi]
    Definition Classes
    BitcoindRpcClient → ChainApi
  246. def setNetworkActive(activate: Boolean): Future[Unit]
    Definition Classes
    P2PRpc
  247. def setSyncing(value: Boolean): Future[ChainApi]
    Definition Classes
    BitcoindRpcClient → ChainApi
  248. def setTxFee(feePerKB: Bitcoins, walletNameOpt: Option[String] = None): Future[Boolean]
    Definition Classes
    WalletRpc
  249. 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
  250. def signMessage(address: P2PKHAddress, message: String): Future[String]
    Definition Classes
    MessageRpc
  251. def signMessageWithPrivKey(key: ECPrivateKeyBytes, message: String): Future[String]
    Definition Classes
    MessageRpc
  252. def signRawTransactionWithWallet(transaction: Transaction): Future[SignRawTransactionWithWalletResult]
    Definition Classes
    WalletRpc
  253. def signRawTransactionWithWallet(transaction: Transaction, walletNameOpt: Option[String]): Future[SignRawTransactionWithWalletResult]
    Definition Classes
    WalletRpc
  254. 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
  255. def startBinary(): Future[Unit]
    Definition Classes
    NativeProcessFactory
  256. 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
  257. def stopBinary(): Future[Unit]
    Definition Classes
    NativeProcessFactory
  258. def submitBlock(block: Block): Future[Unit]
    Definition Classes
    P2PRpc
  259. 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

  260. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  261. implicit val system: ActorSystem
    Definition Classes
    BitcoindRpcClient → Client
  262. def toString(): String
    Definition Classes
    AnyRef → Any
  263. def unloadWallet(filePath: String): Future[Unit]
    Definition Classes
    WalletRpc
  264. def uptime: Future[UInt32]
    Definition Classes
    NodeRpc
  265. def utxoUpdatePsbt(psbt: PSBT, descriptors: Seq[String]): Future[PSBT]
    Definition Classes
    PsbtRpc
  266. def utxoUpdatePsbt(psbt: PSBT): Future[PSBT]
    Definition Classes
    PsbtRpc
  267. def validateAddress(address: BitcoinAddress): Future[ValidateAddressResult]
    Definition Classes
    UtilRpc
  268. def verifyChain(level: Int = 3, blocks: Int = 6): Future[Boolean]
    Definition Classes
    BlockchainRpc
  269. def verifyMessage(address: P2PKHAddress, signature: String, message: String): Future[Boolean]
    Definition Classes
    MessageRpc
  270. def verifyTxOutProof(proof: MerkleBlock): Future[Vector[DoubleSha256DigestBE]]
    Definition Classes
    TransactionRpc
  271. def version: Future[BitcoindVersion]
    Definition Classes
    BitcoindRpcClient → Client
  272. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  273. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  274. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  275. 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
  276. def walletExtension(walletName: String): String
    Attributes
    protected
    Definition Classes
    Client
  277. def walletLock(walletName: String): Future[Unit]
    Definition Classes
    WalletRpc
  278. def walletLock(): Future[Unit]
    Definition Classes
    WalletRpc
  279. def walletPassphrase(passphrase: String, seconds: Int, walletNameOpt: Option[String] = None): Future[Unit]
    Definition Classes
    WalletRpc
  280. def walletPassphraseChange(currentPassphrase: String, newPassphrase: String, walletNameOpt: Option[String] = None): Future[Unit]
    Definition Classes
    WalletRpc
  281. def walletProcessPSBT(psbt: PSBT, sign: Boolean = true, sigHashType: HashType = HashType.sigHashAll, walletNameOpt: Option[String] = None): Future[WalletProcessPsbtResult]
    Definition Classes
    WalletRpc
  282. 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
  283. 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 V20AssortedRpc

Inherited from V20MultisigRpc

Inherited from V19BlockFilterRpc

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 BitcoinSLogger

Inherited from AnyRef

Inherited from Any

Ungrouped