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.

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]
    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], 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 = "", 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 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]
    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]
    Definition Classes
    BitcoindRpcClient → ChainApi
  71. def getBestFilter(): Future[Option[CompactFilterDb]]
    Definition Classes
    BitcoindRpcClient → ChainApi
  72. def getBestFilterHeader(): Future[Option[CompactFilterHeaderDb]]
    Definition Classes
    BitcoindRpcClient → 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]
    Definition Classes
    BlockchainRpc
  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
    P2PRpc
  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: Int, includeMemPool: Boolean = true): Future[GetTxOutResult]
    Definition Classes
    TransactionRpc
  152. def getTxOutProof(txids: Vector[DoubleSha256DigestBE], headerHash: DoubleSha256DigestBE): Future[MerkleBlock]
    Definition Classes
    TransactionRpc
  153. def getTxOutProof(txids: Vector[DoubleSha256Digest], headerHash: DoubleSha256Digest): Future[MerkleBlock]
    Definition Classes
    TransactionRpc
  154. def getTxOutProof(txids: Vector[DoubleSha256DigestBE]): Future[MerkleBlock]
    Definition Classes
    TransactionRpc
  155. def getTxOutSetInfo: Future[GetTxOutSetInfoResult]
    Definition Classes
    TransactionRpc
  156. def getUnconfirmedBalance(walletName: String): Future[Bitcoins]
    Definition Classes
    WalletRpc
  157. def getUnconfirmedBalance: Future[Bitcoins]
    Definition Classes
    WalletRpc
  158. def getWalletInfo(walletName: String): Future[GetWalletInfoResult]
    Definition Classes
    WalletRpc
  159. def getWalletInfo: Future[GetWalletInfoResult]
    Definition Classes
    WalletRpc
  160. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  161. def help(rpcName: String = ""): Future[String]
    Definition Classes
    NodeRpc
  162. def importAddress(address: BitcoinAddress, account: String = "", rescan: Boolean = true, p2sh: Boolean = false, walletNameOpt: Option[String] = None): Future[Unit]
    Definition Classes
    WalletRpc
  163. def importMulti(requests: Vector[ImportMultiRequest], rescan: Boolean = true, walletNameOpt: Option[String] = None): Future[Vector[ImportMultiResult]]
    Definition Classes
    WalletRpc
  164. implicit val importMultiAddressWrites: Writes[ImportMultiAddress]
    Definition Classes
    Client
  165. implicit val importMultiRequestWrites: Writes[ImportMultiRequest]
    Definition Classes
    Client
  166. def importPrivKey(key: ECPrivateKeyBytes, account: String = "", rescan: Boolean = true, walletNameOpt: Option[String] = None): Future[Unit]
    Definition Classes
    WalletRpc
  167. def importPrunedFunds(transaction: Transaction, txOutProof: MerkleBlock, walletNameOpt: Option[String] = None): Future[Unit]
    Definition Classes
    WalletRpc
  168. def importPubKey(pubKey: ECPublicKey, label: String = "", rescan: Boolean = true, walletNameOpt: Option[String] = None): Future[Unit]
    Definition Classes
    WalletRpc
  169. def importWallet(filePath: String, walletNameOpt: Option[String] = None): Future[Unit]
    Definition Classes
    WalletRpc
  170. def info(mkr: Marker, msg: => Any, t: => Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  171. def info(msg: => Any, t: => Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  172. def info(msg: => Any): Unit
    Attributes
    protected
    Definition Classes
    Logging
  173. val instance: BitcoindInstance
    Definition Classes
    BitcoindRpcClient → Client
  174. def invalidateBlock(blockHash: DoubleSha256Digest): Future[Unit]
    Definition Classes
    BlockchainRpc
  175. def invalidateBlock(blockHash: DoubleSha256DigestBE): Future[Unit]
    Definition Classes
    BlockchainRpc
  176. def isAlive(): Boolean
    Definition Classes
    NativeProcessFactory
  177. def isDebugEnabled: Boolean
    Attributes
    protected
    Definition Classes
    Logging
  178. def isErrorEnabled: Boolean
    Attributes
    protected
    Definition Classes
    Logging
  179. def isIBD(): Future[Boolean]
    Definition Classes
    BitcoindRpcClient → ChainApi
  180. def isInfoEnabled: Boolean
    Attributes
    protected
    Definition Classes
    Logging
  181. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  182. def isStartedF: Future[Boolean]

    Checks whether the underlying bitcoind daemon is running

    Checks whether the underlying bitcoind daemon is running

    Definition Classes
    Client
  183. 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
  184. def isSyncing(): Future[Boolean]
    Definition Classes
    BitcoindRpcClient → ChainApi
  185. def isTraceEnabled: Boolean
    Attributes
    protected
    Definition Classes
    Logging
  186. def isWarnEnabled: Boolean
    Attributes
    protected
    Definition Classes
    Logging
  187. def joinPsbts(psbts: Seq[PSBT]): Future[PSBT]
    Definition Classes
    PsbtRpc
  188. def keyPoolRefill(keyPoolSize: Int = 100, walletNameOpt: Option[String] = None): Future[Unit]

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

    maxfeerate

    Set to 0 if you want to enable allowhighfees

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

Inherited from AnyRef

Inherited from Any

Ungrouped