class BitcoindV31RpcClient extends BitcoindRpcClient
- Alphabetic
- By Inheritance
- BitcoindV31RpcClient
- BitcoindRpcClient
- V20MultisigRpc
- DescriptorRpc
- V18AssortedRpc
- UtilRpc
- PsbtRpc
- WalletRpc
- UTXORpc
- TransactionRpc
- RawTransactionRpc
- P2PRpc
- NodeRpc
- MultisigRpc
- MiningRpc
- MempoolRpc
- MessageRpc
- BlockchainRpc
- ChainApi
- ChainQueryApi
- NodeApi
- FeeRateApi
- Client
- NativeProcessFactory
- StartStopAsync
- StartStop
- BitcoinSLogger
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new BitcoindV31RpcClient(instance: BitcoindInstance)(implicit actorSystem: ActorSystem)
Value Members
- 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
- 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
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def abandonTransaction(txid: DoubleSha256Digest): Future[Unit]
- Definition Classes
- TransactionRpc
- def abandonTransaction(txid: DoubleSha256DigestBE): Future[Unit]
- Definition Classes
- TransactionRpc
- def abortPrivateBroadcast(id: DoubleSha256DigestBE): Future[AbortPrivateBroadcastResult]
Abort private broadcast attempts for a transaction currently being privately broadcast.
Abort private broadcast attempts for a transaction currently being privately broadcast. The transaction will be removed from the private broadcast queue.
New in Bitcoin Core v31.
- id
A transaction identifier (txid or wtxid) to abort
- Definition Classes
- P2PRpc
- def abortRescan(): Future[Unit]
- Definition Classes
- NodeRpc
- def addMultiSigAddress(minSignatures: Int, keys: Vector[Either[ECPublicKey, P2PKHAddress]], account: String, addressType: AddressType): Future[MultiSigResultPostV20]
- Definition Classes
- V20MultisigRpc → MultisigRpc
- def addMultiSigAddress(minSignatures: Int, keys: Vector[Either[ECPublicKey, P2PKHAddress]], addressType: AddressType): Future[MultiSigResultPostV20]
- Definition Classes
- V20MultisigRpc → MultisigRpc
- def addMultiSigAddress(minSignatures: Int, keys: Vector[Either[ECPublicKey, P2PKHAddress]], account: String): Future[MultiSigResultPostV20]
- Definition Classes
- V20MultisigRpc → MultisigRpc
- def addMultiSigAddress(minSignatures: Int, keys: Vector[Either[ECPublicKey, P2PKHAddress]]): Future[MultiSigResultPostV20]
- Definition Classes
- V20MultisigRpc → MultisigRpc
- def addNode(address: URI, command: AddNodeArgument, v2transport: Boolean = true): Future[Unit]
- Definition Classes
- P2PRpc
- def analyzePsbt(psbt: PSBT): Future[AnalyzePsbtResult]
- Definition Classes
- PsbtRpc
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def backupWallet(destination: String, walletName: String = DEFAULT_WALLET): Future[Unit]
- Definition Classes
- WalletRpc
- 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
- def bitcoindRpcAppConfig: BitcoindRpcAppConfig
- Definition Classes
- BitcoindRpcClient
- 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
- 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
- def buildRequest(instance: BitcoindInstance, methodName: String, params: JsArray, uriExtensionOpt: Option[String] = None): HttpRequest
- Attributes
- protected
- Definition Classes
- Client
- def bumpFee(txid: DoubleSha256Digest, confTarget: Int, totalFee: Option[Satoshis], replaceable: Boolean, estimateMode: String): Future[BumpFeeResult]
- Definition Classes
- TransactionRpc
- def bumpFee(txid: DoubleSha256DigestBE, confTarget: Int = 6, totalFee: Option[Satoshis] = None, replaceable: Boolean = true, estimateMode: String = "UNSET"): Future[BumpFeeResult]
- Definition Classes
- TransactionRpc
- def clearBanned(): Future[Unit]
- Definition Classes
- P2PRpc
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- lazy val cmd: Vector[String]
The command to start the daemon on the underlying OS
The command to start the daemon on the underlying OS
- Definition Classes
- Client → NativeProcessFactory
- def combinePsbt(psbts: Vector[PSBT]): Future[PSBT]
- Definition Classes
- PsbtRpc
- def combineRawTransaction(txs: Vector[Transaction]): Future[Transaction]
- Definition Classes
- RawTransactionRpc
- 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
- def convertToPsbt(rawTx: Transaction, permitSigData: Boolean = false, isWitness: Option[Boolean] = None): Future[PSBT]
- Definition Classes
- PsbtRpc
- def createMultiSig(minSignatures: Int, keys: Vector[ECPublicKey], addressType: AddressType, walletName: String = BitcoindRpcClient.DEFAULT_WALLET_NAME): Future[MultiSigResultPostV20]
- Definition Classes
- V20MultisigRpc → MultisigRpc
- def createPsbt(inputs: Vector[TransactionInput], outputs: Map[BitcoinAddress, CurrencyUnit], locktime: Int = 0, replacable: Boolean = false): Future[PSBT]
- Definition Classes
- PsbtRpc
- def createRawTransaction(inputs: Vector[TransactionInput], outputs: Map[BitcoinAddress, Bitcoins], locktime: Int = 0): Future[Transaction]
- Definition Classes
- RawTransactionRpc
- def createWallet(walletName: String, disablePrivateKeys: Boolean = false, blank: Boolean = false, passphrase: String = "", avoidReuse: Boolean = false, descriptors: Boolean = true): Future[CreateWalletResult]
- blank
Not available to versions before v19
- passphrase
Not available to versions before v19
- Definition Classes
- WalletRpc
- def createWalletDescriptor(addressType: AddressType, options: Option[CreateWalletDescriptorOptions] = None, walletName: String = DEFAULT_WALLET): Future[CreateWalletDescriptorResult]
- Definition Classes
- WalletRpc
- def decodePsbt(psbt: PSBT): Future[DecodePsbtResult]
- Definition Classes
- PsbtRpc
- def decodeRawTransaction(transaction: Transaction): Future[RpcTransaction]
- Definition Classes
- RawTransactionRpc
- def decodeScript(script: ScriptPubKey): Future[DecodeScriptResult]
- Definition Classes
- UtilRpc
- def deriveAddresses(descriptor: Descriptor, range: Option[Vector[Double]]): Future[DeriveAddressesResult]
- Definition Classes
- DescriptorRpc
- def disconnectNode(address: URI): Future[Unit]
- Definition Classes
- P2PRpc
- def downloadBlocks(blockHashes: Vector[DoubleSha256DigestBE]): Future[Unit]
Request the underlying node to download the given blocks from its peers and feed the blocks to org.bitcoins.node.NodeCallbacks.
Request the underlying node to download the given blocks from its peers and feed the blocks to org.bitcoins.node.NodeCallbacks.
- Definition Classes
- BitcoindRpcClient → NodeApi
- def dumpTxOutSet(path: Path, dumpTxOutSetType: DumpTxOutSetType): Future[DumpTxOutSetResult]
- Definition Classes
- UTXORpc
- implicit val eCPrivateKeyBytesWrites: Writes[ECPrivateKeyBytes]
- Definition Classes
- Client
- implicit val eCPrivateKeyWrites: Writes[ECPrivateKey]
- Definition Classes
- Client
- def encryptWallet(passphrase: String, walletName: String = DEFAULT_WALLET): Future[String]
- Definition Classes
- WalletRpc
- 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
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def estimateSmartFee(blocks: Int, mode: FeeEstimationMode = FeeEstimationMode.Ecnomical): Future[EstimateSmartFeeResult]
- Definition Classes
- TransactionRpc
- implicit val executionContext: ExecutionContext
- Attributes
- protected
- Definition Classes
- Client → NativeProcessFactory
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- def finalizePsbt(psbt: PSBT, extract: Boolean = true): Future[FinalizePsbtResult]
- Definition Classes
- PsbtRpc
- def fundRawTransaction(transaction: Transaction, options: FundRawTransactionOptions, walletName: String): Future[FundRawTransactionResult]
- Definition Classes
- RawTransactionRpc
- def fundRawTransaction(transaction: Transaction, options: FundRawTransactionOptions): Future[FundRawTransactionResult]
- Definition Classes
- RawTransactionRpc
- def fundRawTransaction(transaction: Transaction, walletName: String): Future[FundRawTransactionResult]
- Definition Classes
- RawTransactionRpc
- def fundRawTransaction(transaction: Transaction): Future[FundRawTransactionResult]
- Definition Classes
- RawTransactionRpc
- def generate(numBlocks: Int): Future[Vector[DoubleSha256DigestBE]]
Sends funds to an external address to bitcoin core's wallet, this increases bitcoin core performance If you want to send funds somewhere specific use generateToAddress
Sends funds to an external address to bitcoin core's wallet, this increases bitcoin core performance If you want to send funds somewhere specific use generateToAddress
- Definition Classes
- BitcoindRpcClient
- def generateBlock(address: BitcoinAddress, transactions: Vector[Transaction]): Future[DoubleSha256DigestBE]
- Definition Classes
- MiningRpc
- def generateToAddress(blocks: Int, address: BitcoinAddress, maxTries: Int = 1000000): Future[Vector[DoubleSha256DigestBE]]
- Definition Classes
- MiningRpc
- def generateToDescriptor(numBlocks: Int, descriptor: String, maxTries: Long = 1000000): Future[Vector[DoubleSha256DigestBE]]
- Definition Classes
- MiningRpc
- def getAddedNodeInfo(node: URI): Future[Vector[Node]]
- Definition Classes
- P2PRpc
- def getAddedNodeInfo: Future[Vector[Node]]
- Definition Classes
- P2PRpc
- def getAddrManInfo(): Future[GetAddrmanInfoResponse]
- Definition Classes
- P2PRpc
- def getAddressInfo(address: BitcoinAddress, walletName: String = DEFAULT_WALLET): Future[AddressInfoResult]
- Definition Classes
- WalletRpc
- def getBalance(walletName: String): Future[Bitcoins]
- Definition Classes
- WalletRpc
- def getBalance: Future[Bitcoins]
- Definition Classes
- WalletRpc
- def getBalances(walletName: String): Future[GetBalancesResult]
- Definition Classes
- WalletRpc
- def getBalances: Future[GetBalancesResult]
- Definition Classes
- WalletRpc
- def getBestBlockHash(): Future[DoubleSha256DigestBE]
Gets the hash of the block that is what we consider "best"
Gets the hash of the block that is what we consider "best"
- Definition Classes
- BlockchainRpc → ChainQueryApi
- def getBestBlockHeader(): Future[BlockHeaderDb]
Gets the best block header we have
Gets the best block header we have
- Definition Classes
- BitcoindRpcClient → ChainApi
- def getBestChainTips(): Future[Vector[BlockHeaderDb]]
Gets all chain tips with the heaviest work
Gets all chain tips with the heaviest work
- Definition Classes
- BitcoindRpcClient → ChainApi
- def getBestFilter(): Future[Option[CompactFilterDb]]
- Definition Classes
- BlockchainRpc → ChainApi
- def getBestFilterHeader(): Future[Option[CompactFilterHeaderDb]]
Finds the "best" filter header we have stored in our database What this means in practice is the latest filter header we have received from our peer.
Finds the "best" filter header we have stored in our database What this means in practice is the latest filter header we have received from our peer. Returns none if we have no filters in the database
- Definition Classes
- BlockchainRpc → ChainApi
- def getBestHashBlockHeight()(implicit ec: ExecutionContext): Future[Int]
- Definition Classes
- ChainQueryApi
- def getBlock(headerHash: DoubleSha256Digest): Future[GetBlockResult]
- Definition Classes
- BlockchainRpc
- def getBlock(headerHash: DoubleSha256DigestBE): Future[GetBlockResult]
- Definition Classes
- BlockchainRpc
- def getBlockChainInfo: Future[GetBlockChainInfoResult]
- Definition Classes
- BlockchainRpc
- def getBlockCount(): Future[Int]
Gets the number of blocks in the database
Gets the number of blocks in the database
- Definition Classes
- BlockchainRpc → ChainApi
- def getBlockFilter(blockhash: DoubleSha256DigestBE, filtertype: FilterType): Future[GetBlockFilterResult]
- Definition Classes
- BlockchainRpc
- def getBlockHash(height: Int): Future[DoubleSha256DigestBE]
- Definition Classes
- BlockchainRpc
- def getBlockHeader(headerHash: DoubleSha256Digest): Future[GetBlockHeaderResult]
- Definition Classes
- BlockchainRpc
- def getBlockHeader(headerHash: DoubleSha256DigestBE): Future[GetBlockHeaderResult]
- Definition Classes
- BlockchainRpc
- def getBlockHeaderRaw(headerHash: DoubleSha256Digest): Future[BlockHeader]
- Definition Classes
- BlockchainRpc
- def getBlockHeaderRaw(headerHash: DoubleSha256DigestBE): Future[BlockHeader]
- Definition Classes
- BlockchainRpc
- 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
- def getBlockRaw(headerHash: DoubleSha256Digest): Future[Block]
- Definition Classes
- BlockchainRpc
- def getBlockRaw(headerHash: DoubleSha256DigestBE): Future[Block]
- Definition Classes
- BlockchainRpc
- def getBlockTemplate(request: Option[BlockTemplateRequest] = None): Future[GetBlockTemplateResult]
- Definition Classes
- MiningRpc
- def getBlockWithTransactions(headerHash: DoubleSha256Digest): Future[GetBlockWithTransactionsResult]
- Definition Classes
- BlockchainRpc
- def getBlockWithTransactions(headerHash: DoubleSha256DigestBE): Future[GetBlockWithTransactionsResultV22]
- Definition Classes
- BlockchainRpc
- def getChainStates(): Future[ChainStateResult]
- Definition Classes
- BlockchainRpc
- def getChainTips: Future[Vector[ChainTip]]
- Definition Classes
- BlockchainRpc
- def getChainTxStats(blocks: Int, blockHash: DoubleSha256Digest): Future[GetChainTxStatsResult]
- Definition Classes
- BlockchainRpc
- def getChainTxStats(blocks: Int, blockHash: DoubleSha256DigestBE): Future[GetChainTxStatsResult]
- Definition Classes
- BlockchainRpc
- def getChainTxStats(blocks: Int): Future[GetChainTxStatsResult]
- Definition Classes
- BlockchainRpc
- def getChainTxStats: Future[GetChainTxStatsResult]
- Definition Classes
- BlockchainRpc
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def getConnectionCount: Future[Int]
- Definition Classes
- BitcoindRpcClient → P2PRpc → NodeApi
- def getDaemon: BitcoindInstance
- Definition Classes
- Client
- def getDescriptorActivity(blockHashes: Vector[DoubleSha256DigestBE], scanobjects: Vector[Descriptor], includeMempool: Boolean = true): Future[GetDescriptorActivityResult]
- Definition Classes
- BlockchainRpc
- def getDescriptorInfo(descriptor: Descriptor): Future[GetDescriptorInfoResult]
- Definition Classes
- DescriptorRpc
- def getDifficulty: Future[BigDecimal]
- Definition Classes
- BlockchainRpc
- def getFeeRate(): Future[FeeUnit]
- Definition Classes
- BitcoindRpcClient → FeeRateApi
- def getFilter(hash: DoubleSha256DigestBE): Future[Option[CompactFilterDb]]
Looks up a compact filter by its hash.
Looks up a compact filter by its hash.
- Definition Classes
- BlockchainRpc → ChainApi
- def getFilterCount(): Future[Int]
Gets the number of compact filters in the database
Gets the number of compact filters in the database
- Definition Classes
- BlockchainRpc → ChainApi → ChainQueryApi
- def getFilterHeader(blockHash: DoubleSha256DigestBE): Future[Option[CompactFilterHeaderDb]]
Looks up a compact filter header by its hash.
Looks up a compact filter header by its hash.
- Definition Classes
- BlockchainRpc → ChainApi
- def getFilterHeaderCount(): Future[Int]
Gets the number of compact filter headers in the database
Gets the number of compact filter headers in the database
- Definition Classes
- BlockchainRpc → ChainApi
- def getFilterHeadersAtHeight(height: Int): Future[Vector[CompactFilterHeaderDb]]
Looks up a compact filter header by its height.
Looks up a compact filter header by its height.
- Definition Classes
- BlockchainRpc → ChainApi
- def getFiltersAtHeight(height: Int): Future[Vector[CompactFilterDb]]
Looks up a compact filter by its height.
Looks up a compact filter by its height.
- Definition Classes
- BlockchainRpc → ChainApi
- def getFiltersBetweenHeights(startHeight: Int, endHeight: Int): Future[Vector[FilterResponse]]
- Definition Classes
- BlockchainRpc → ChainQueryApi
- def getHDKeys(walletName: String = DEFAULT_WALLET): Future[Vector[GetHDKeysResult]]
- Definition Classes
- WalletRpc
- 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
- def getHeaders(hashes: Vector[DoubleSha256DigestBE]): Future[Vector[Option[BlockHeaderDb]]]
- Definition Classes
- BitcoindRpcClient → ChainApi
- 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
- 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
- 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
- def getIndexInfo(indexName: String): Future[IndexInfoResult]
- Definition Classes
- UtilRpc
- def getIndexInfo: Future[Map[String, IndexInfoResult]]
- Definition Classes
- UtilRpc
- def getMedianTimePast(): Future[Long]
calculates the median time passed
calculates the median time passed
- Definition Classes
- BitcoindRpcClient → ChainQueryApi
- def getMemPoolAncestors(txid: DoubleSha256Digest): Future[Vector[DoubleSha256DigestBE]]
- Definition Classes
- MempoolRpc
- def getMemPoolAncestors(txid: DoubleSha256DigestBE): Future[Vector[DoubleSha256DigestBE]]
- Definition Classes
- MempoolRpc
- def getMemPoolAncestorsVerbose(txid: DoubleSha256Digest): Future[Map[DoubleSha256DigestBE, GetMemPoolResult]]
- Definition Classes
- MempoolRpc
- def getMemPoolAncestorsVerbose(txid: DoubleSha256DigestBE): Future[Map[DoubleSha256DigestBE, GetMemPoolResult]]
- Definition Classes
- MempoolRpc
- def getMemPoolDescendants(txid: DoubleSha256Digest): Future[Vector[DoubleSha256DigestBE]]
- Definition Classes
- MempoolRpc
- def getMemPoolDescendants(txid: DoubleSha256DigestBE): Future[Vector[DoubleSha256DigestBE]]
- Definition Classes
- MempoolRpc
- def getMemPoolDescendantsVerbose(txid: DoubleSha256Digest): Future[Map[DoubleSha256DigestBE, GetMemPoolResult]]
- Definition Classes
- MempoolRpc
- def getMemPoolDescendantsVerbose(txid: DoubleSha256DigestBE): Future[Map[DoubleSha256DigestBE, GetMemPoolResult]]
- Definition Classes
- MempoolRpc
- def getMemPoolEntry(txid: DoubleSha256Digest): Future[GetMemPoolEntryResult]
- Definition Classes
- MempoolRpc
- def getMemPoolEntry(txid: DoubleSha256DigestBE): Future[GetMemPoolEntryResult]
- Definition Classes
- MempoolRpc
- def getMemPoolEntryOpt(txid: DoubleSha256DigestBE): Future[Option[GetMemPoolEntryResult]]
- Definition Classes
- MempoolRpc
- def getMemPoolEntryOpt(txid: DoubleSha256Digest): Future[Option[GetMemPoolEntryResult]]
- Definition Classes
- MempoolRpc
- def getMemPoolInfo: Future[GetMemPoolInfoResult]
- Definition Classes
- MempoolRpc
- def getMemoryInfo: Future[GetMemoryInfoResult]
- Definition Classes
- NodeRpc
- def getMempoolCluster(txid: DoubleSha256Digest): Future[GetMempoolClusterResult]
- Definition Classes
- MempoolRpc
- def getMempoolCluster(txid: DoubleSha256DigestBE): Future[GetMempoolClusterResult]
Returns cluster information for the given transaction.
Returns cluster information for the given transaction. The cluster contains all transactions in the same cluster as the given transaction, along with the ordering of those transactions and grouping into chunks.
New in Bitcoin Core v31.
- txid
The transaction id
- Definition Classes
- MempoolRpc
- def getMempoolFeerateDiagram(): Future[Vector[GetMempoolFeerateDiagramEntry]]
Returns the feerate diagram for the entire mempool.
Returns the feerate diagram for the entire mempool. Each entry represents a point in the feerate diagram showing the cumulative fee and weight.
New in Bitcoin Core v31.
- Definition Classes
- MempoolRpc
- def getMiningInfo: Future[GetMiningInfoResult]
- Definition Classes
- MiningRpc
- def getNetTotals: Future[GetNetTotalsResult]
- Definition Classes
- P2PRpc
- def getNetworkHashPS(blocks: Int = 120, height: Int = -1): Future[BigDecimal]
- Definition Classes
- MiningRpc
- def getNetworkInfo: Future[GetNetworkInfoResult]
- Definition Classes
- P2PRpc
- def getNewAddress(accountOrLabel: String, addressType: AddressType, walletName: String): Future[BitcoinAddress]
- Definition Classes
- WalletRpc
- def getNewAddress(accountOrLabel: String, addressType: AddressType): Future[BitcoinAddress]
- Definition Classes
- WalletRpc
- def getNewAddress(addressType: AddressType): Future[BitcoinAddress]
- Definition Classes
- WalletRpc
- def getNewAddress(addressType: AddressType, walletName: String): Future[BitcoinAddress]
- Definition Classes
- WalletRpc
- def getNewAddress(walletName: String, label: String = ""): Future[BitcoinAddress]
- Definition Classes
- WalletRpc
- def getNewAddress: Future[BitcoinAddress]
- Definition Classes
- WalletRpc
- def getNodeAddresses(): Future[Vector[GetNodeAddressesResultPostV22]]
- Definition Classes
- NodeRpc
- def getNodeAddresses(count: Int): Future[Vector[GetNodeAddressesResultPostV22]]
- Definition Classes
- NodeRpc
- def getNodeAddresses(network: String, count: Int): Future[Vector[GetNodeAddressesResultPostV22]]
- Definition Classes
- NodeRpc
- 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
- 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
- def getPeerInfo: Future[Vector[PeerInfoResponseV25]]
- Definition Classes
- P2PRpc
- def getPrioritisedTransactions(): Future[Map[DoubleSha256DigestBE, PrioritisedTransaction]]
- Definition Classes
- MiningRpc
- def getPrivateBroadcastInfo(): Future[GetPrivateBroadcastInfoResult]
Returns information about transactions that are currently being privately broadcast.
Returns information about transactions that are currently being privately broadcast.
New in Bitcoin Core v31. Requires
-privatebroadcastto be enabled.- Definition Classes
- P2PRpc
- def getRawChangeAddress(addressType: AddressType, walletName: String): Future[BitcoinAddress]
- Definition Classes
- WalletRpc
- def getRawChangeAddress(walletName: String): Future[BitcoinAddress]
- Definition Classes
- WalletRpc
- def getRawChangeAddress(addressType: AddressType): Future[BitcoinAddress]
- Definition Classes
- WalletRpc
- def getRawChangeAddress: Future[BitcoinAddress]
- Definition Classes
- WalletRpc
- def getRawMemPool(verbose: Boolean = false): Future[GetRawMempoolResult]
- Definition Classes
- MempoolRpc
- def getRawMemPoolWithTransactions: Future[Map[DoubleSha256DigestBE, GetMemPoolResult]]
- Definition Classes
- MempoolRpc
- def getRawMempoolTxIds(): Future[GetRawMempoolTxIds]
- Definition Classes
- MempoolRpc
- def getRawMempoolVerbose(): Future[GetRawMempoolVerbose]
- Definition Classes
- MempoolRpc
- def getRawTransaction(txid: DoubleSha256DigestBE, blockhash: Option[DoubleSha256DigestBE] = None): Future[GetRawTransactionResult]
- Definition Classes
- RawTransactionRpc
- def getRawTransactionRaw(txid: DoubleSha256DigestBE, blockhash: Option[DoubleSha256DigestBE] = None): Future[Transaction]
- Definition Classes
- RawTransactionRpc
- def getReceivedByAddress(address: BitcoinAddress, minConfirmations: Int = 1, walletName: String = DEFAULT_WALLET): Future[Bitcoins]
- Definition Classes
- WalletRpc
- def getRpcInfo(): Future[GetRpcInfoResult]
- Definition Classes
- V18AssortedRpc
- def getTransaction(txid: DoubleSha256DigestBE, watchOnly: Boolean = false, walletName: String = BitcoindRpcClient.DEFAULT_WALLET_NAME): Future[GetTransactionResult]
- Definition Classes
- TransactionRpc
- def getTxOut(txid: DoubleSha256DigestBE, vout: Long, includeMemPool: Boolean = true): Future[Option[GetTxOutResult]]
- Definition Classes
- TransactionRpc
- def getTxOutProof(txids: Vector[DoubleSha256DigestBE], headerHash: DoubleSha256DigestBE): Future[MerkleBlock]
- Definition Classes
- TransactionRpc
- def getTxOutProof(txids: Vector[DoubleSha256Digest], headerHash: DoubleSha256Digest): Future[MerkleBlock]
- Definition Classes
- TransactionRpc
- def getTxOutProof(txids: Vector[DoubleSha256DigestBE]): Future[MerkleBlock]
- Definition Classes
- TransactionRpc
- def getTxOutSetInfo: Future[GetTxOutSetInfoResult]
- Definition Classes
- TransactionRpc
- def getTxSpendingPrevOut(prevouts: Vector[TransactionOutPoint], mempoolOnly: Option[Boolean], returnSpendingTx: Option[Boolean]): Future[Vector[GetTxSpendingPrevOutResult]]
Returns information about in-mempool or confirmed spenders of the given outputs.
Returns information about in-mempool or confirmed spenders of the given outputs.
- prevouts
Outpoints to query
- mempoolOnly
If false and mempool lacks a relevant spend, use txospenderindex (v31+, throws an exception if not available)
- returnSpendingTx
If true, return the full spending transaction (v31+)
- Definition Classes
- MempoolRpc
- def getTxSpendingPrevOut(prevouts: Vector[TransactionOutPoint]): Future[Vector[GetTxSpendingPrevOutResult]]
- Definition Classes
- MempoolRpc
- def getTxSpendingPrevOut(prevout: TransactionOutPoint): Future[GetTxSpendingPrevOutResult]
- Definition Classes
- MempoolRpc
- def getUnconfirmedBalance(walletName: String): Future[Bitcoins]
- Definition Classes
- WalletRpc
- def getUnconfirmedBalance: Future[Bitcoins]
- Definition Classes
- WalletRpc
- def getWalletInfo: Future[GetWalletInfoResult]
- Definition Classes
- WalletRpc
- def getWalletInfo(walletName: String): Future[GetWalletInfoResult]
- Definition Classes
- WalletRpc
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def help(rpcName: String = ""): Future[String]
- Definition Classes
- NodeRpc
- def importDescriptor(imp: DescriptorsResult, walletName: String = BitcoindRpcClient.DEFAULT_WALLET_NAME): Future[ImportDescriptorResult]
- Definition Classes
- DescriptorRpc
- def importDescriptors(imports: Vector[DescriptorsResult], walletName: String = BitcoindRpcClient.DEFAULT_WALLET_NAME): Future[Vector[ImportDescriptorResult]]
https://bitcoincore.org/en/doc/22.0.0/rpc/wallet/importdescriptors/
https://bitcoincore.org/en/doc/22.0.0/rpc/wallet/importdescriptors/
- Definition Classes
- DescriptorRpc
- def importMempool(path: Path): Future[Unit]
- Definition Classes
- MempoolRpc
- def importMulti(requests: Vector[ImportMultiRequest], rescan: Boolean = true, walletName: String = DEFAULT_WALLET): Future[Vector[ImportMultiResult]]
- Definition Classes
- WalletRpc
- implicit val importMultiAddressWrites: Writes[ImportMultiAddress]
- Definition Classes
- Client
- implicit val importMultiRequestWrites: Writes[ImportMultiRequest]
- Definition Classes
- Client
- def importPrunedFunds(transaction: Transaction, txOutProof: MerkleBlock, walletName: String = DEFAULT_WALLET): Future[Unit]
- Definition Classes
- WalletRpc
- val instance: BitcoindInstance
- Definition Classes
- BitcoindV31RpcClient → BitcoindRpcClient → Client
- def invalidateBlock(blockHash: DoubleSha256Digest): Future[Unit]
- Definition Classes
- BlockchainRpc
- def invalidateBlock(blockHash: DoubleSha256DigestBE): Future[Unit]
- Definition Classes
- BlockchainRpc
- def isAlive(): Boolean
- Definition Classes
- NativeProcessFactory
- def isIBD(): Future[Boolean]
- Definition Classes
- BitcoindRpcClient → ChainApi
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isStartedF: Future[Boolean]
Checks whether the underlying bitcoind daemon is running
Checks whether the underlying bitcoind daemon is running
- Definition Classes
- Client
- 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
- def isSyncing(): Future[Boolean]
- Definition Classes
- BitcoindRpcClient → ChainApi
- def isTipStale(): Future[Boolean]
Checks if our chain tip is stale
Checks if our chain tip is stale
- def joinPsbts(psbts: Seq[PSBT]): Future[PSBT]
- Definition Classes
- PsbtRpc
- def keyPoolRefill(keyPoolSize: Int = 100, walletName: String = DEFAULT_WALLET): Future[Unit]
- Definition Classes
- WalletRpc
- def listAddressGroupings(walletName: String): Future[Vector[Vector[RpcAddress]]]
- Definition Classes
- WalletRpc
- def listAddressGroupings: Future[Vector[Vector[RpcAddress]]]
- Definition Classes
- WalletRpc
- def listBanned: Future[Vector[NodeBan]]
- Definition Classes
- P2PRpc
- def listDescriptors(walletName: String): Future[ListDescriptorsResult]
- Definition Classes
- DescriptorRpc
- def listDescriptors(priv: Option[Boolean]): Future[ListDescriptorsResult]
- Definition Classes
- DescriptorRpc
- def listDescriptors(priv: Option[Boolean], walletName: String): Future[ListDescriptorsResult]
- Definition Classes
- DescriptorRpc
- def listDescriptors(): Future[ListDescriptorsResult]
- Definition Classes
- DescriptorRpc
- def listLockUnspent: Future[Vector[TransactionOutPoint]]
- Definition Classes
- UTXORpc
- def listReceivedByAddress(confirmations: Int = 1, includeEmpty: Boolean = false, includeWatchOnly: Boolean = false, walletName: String = DEFAULT_WALLET): Future[Vector[ReceivedAddress]]
- Definition Classes
- WalletRpc
- def listSinceBlock(headerHash: DoubleSha256Digest, confirmations: Int, includeWatchOnly: Boolean): Future[ListSinceBlockResult]
- Definition Classes
- BlockchainRpc
- def listSinceBlock(headerHash: DoubleSha256Digest, includeWatchOnly: Boolean): Future[ListSinceBlockResult]
- Definition Classes
- BlockchainRpc
- def listSinceBlock(headerHash: DoubleSha256Digest, confirmations: Int): Future[ListSinceBlockResult]
- Definition Classes
- BlockchainRpc
- def listSinceBlock(headerHash: DoubleSha256Digest): Future[ListSinceBlockResult]
- Definition Classes
- BlockchainRpc
- def listSinceBlock(headerHash: DoubleSha256DigestBE, confirmations: Int, includeWatchOnly: Boolean): Future[ListSinceBlockResult]
- Definition Classes
- BlockchainRpc
- def listSinceBlock(headerHash: DoubleSha256DigestBE, includeWatchOnly: Boolean): Future[ListSinceBlockResult]
- Definition Classes
- BlockchainRpc
- def listSinceBlock(headerHash: DoubleSha256DigestBE, confirmations: Int): Future[ListSinceBlockResult]
- Definition Classes
- BlockchainRpc
- def listSinceBlock(headerHash: DoubleSha256DigestBE): Future[ListSinceBlockResult]
- Definition Classes
- BlockchainRpc
- def listSinceBlock(headerHash: Option[DoubleSha256DigestBE] = None, confirmations: Int = 1, includeWatchOnly: Boolean = false): Future[ListSinceBlockResult]
- Definition Classes
- BlockchainRpc
- def listSinceBlock: Future[ListSinceBlockResult]
- Definition Classes
- BlockchainRpc
- def listTransactions(account: String = "*", count: Int = 10, skip: Int = 0, includeWatchOnly: Boolean = false): Future[Vector[ListTransactionsResult]]
- Definition Classes
- BlockchainRpc
- def listUnspent(minConfirmations: Int, maxConfirmations: Int, addresses: Vector[BitcoinAddress]): Future[Vector[UnspentOutput]]
- Definition Classes
- UTXORpc
- def listUnspent(addresses: Vector[BitcoinAddress]): Future[Vector[UnspentOutput]]
- Definition Classes
- UTXORpc
- def listUnspent(minConfirmations: Int, maxConfirmations: Int): Future[Vector[UnspentOutput]]
- Definition Classes
- UTXORpc
- def listUnspent(walletName: String): Future[Vector[UnspentOutput]]
- Definition Classes
- UTXORpc
- def listUnspent: Future[Vector[UnspentOutput]]
- Definition Classes
- UTXORpc
- def listWalletDir(): Future[ListWalletDirResult]
- Definition Classes
- V18AssortedRpc
- def listWallets: Future[Vector[String]]
- Definition Classes
- WalletRpc
- def loadTxOutSet(path: Path): Future[LoadTxOutSetResult]
- Definition Classes
- UTXORpc
- def loadWallet(filePath: String): Future[LoadWalletResult]
- Definition Classes
- WalletRpc
- def lockUnspent(unlock: Boolean, outputs: Vector[LockUnspentOutputParameter]): Future[Boolean]
- Definition Classes
- UTXORpc
- 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
- def logger: Logger
- Definition Classes
- BitcoinSLogger
- def logging(include: Vector[String] = Vector.empty, exclude: Vector[String] = Vector.empty): Future[Map[String, Boolean]]
- Definition Classes
- NodeRpc
- def logging: Future[Map[String, Boolean]]
- Definition Classes
- NodeRpc
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- implicit val network: NetworkParameters
- Attributes
- protected
- Definition Classes
- Client
- def nextBlockHeaderBatchRange(prevStopHash: DoubleSha256DigestBE, stopHash: DoubleSha256DigestBE, batchSize: Int): Future[Option[FilterSyncMarker]]
Generates a block range in form of (startHeight, stopHash) by the given stop hash.
Generates a block range in form of (startHeight, stopHash) by the given stop hash. Returns None if we are synced
- prevStopHash
our previous block hash where filter header sync stopped
- stopHash
the block hash we want to sync the new batch of filters to
- batchSize
the batch size of filter headers
- Definition Classes
- BitcoindRpcClient → ChainApi
- def nextFilterHeaderBatchRange(stopBlockHash: DoubleSha256DigestBE, batchSize: Int, startHeightOpt: Option[Int]): Future[Option[FilterSyncMarker]]
Generates a query for a range of compact filters
Generates a query for a range of compact filters
- stopBlockHash
the block hash to stop receiving filters at
- startHeightOpt
the block height to start syncing filters from. If None, we query our chainstate for the last filter we've seen
- Definition Classes
- BitcoindRpcClient → ChainApi
- final def nextFilterHeaderBatchRange(stopBlockHash: DoubleSha256DigestBE, batchSize: Int): Future[Option[FilterSyncMarker]]
Generates a filter header range in form of (startHeight, stopHash) by the given stop hash.
Generates a filter header range in form of (startHeight, stopHash) by the given stop hash.
- Definition Classes
- ChainApi
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def ping(): Future[Unit]
- Definition Classes
- Client
- def preciousBlock(headerHash: DoubleSha256Digest): Future[Unit]
- Definition Classes
- BlockchainRpc
- def preciousBlock(headerHash: DoubleSha256DigestBE): Future[Unit]
- Definition Classes
- BlockchainRpc
- def prioritiseTransaction(txid: DoubleSha256Digest, feeDelta: Satoshis): Future[Boolean]
- Definition Classes
- MiningRpc
- def prioritiseTransaction(txid: DoubleSha256DigestBE, feeDelta: Satoshis): Future[Boolean]
- Definition Classes
- MiningRpc
- 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
- def processCheckpoints(checkpoints: Vector[DoubleSha256DigestBE], blockHash: DoubleSha256DigestBE): Future[ChainApi]
Process all compact filter header check points.
Process all compact filter header check points.
- Definition Classes
- BitcoindRpcClient → ChainApi
- 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
- 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
- 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
- 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
- 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
- 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
- def pruneBlockChain(height: Int): Future[Int]
- Definition Classes
- BlockchainRpc
- def removePrunedFunds(txid: DoubleSha256Digest, walletName: String): Future[Unit]
- Definition Classes
- WalletRpc
- def removePrunedFunds(txid: DoubleSha256Digest): Future[Unit]
- Definition Classes
- WalletRpc
- def removePrunedFunds(txid: DoubleSha256DigestBE): Future[Unit]
- Definition Classes
- WalletRpc
- def removePrunedFunds(txid: DoubleSha256DigestBE, walletName: String): Future[Unit]
- Definition Classes
- WalletRpc
- def rescanBlockChain(start: Int, stop: Int): Future[RescanBlockChainResult]
- Definition Classes
- BlockchainRpc
- def rescanBlockChain(start: Int): Future[RescanBlockChainResult]
- Definition Classes
- BlockchainRpc
- def rescanBlockChain(): Future[RescanBlockChainResult]
- Definition Classes
- BlockchainRpc
- def saveMemPool(): Future[Unit]
- Definition Classes
- MempoolRpc
- def scanBlocks(request: ScanBlocksRequest): Future[ScanBlocksResult]
- Definition Classes
- BlockchainRpc
- def scanTxoutSet(request: ScanTxoutSetRequest): Future[ScanTxoutSetResult]
- Definition Classes
- UTXORpc
- def sendMany(amounts: Map[BitcoinAddress, CurrencyUnit], minconf: Int = 1, comment: String = "", subtractFeeFrom: Vector[BitcoinAddress] = Vector.empty, walletName: String = DEFAULT_WALLET): Future[DoubleSha256DigestBE]
- Definition Classes
- WalletRpc
- def sendRawTransaction(transaction: Transaction, maxfeerate: Double = 0.10, maxBurnAmount: Int = 0): Future[DoubleSha256DigestBE]
- maxfeerate
Set to 0 if you want to enable allowhighfees
- Definition Classes
- RawTransactionRpc
- def sendRequest(req: HttpRequest): Future[HttpResponse]
- Attributes
- protected
- Definition Classes
- Client
- def sendToAddress(address: BitcoinAddress, amount: CurrencyUnit, localComment: String = "", toComment: String = "", subractFeeFromAmount: Boolean = false, walletName: String = DEFAULT_WALLET): Future[DoubleSha256DigestBE]
- Definition Classes
- WalletRpc
- def setBan(address: URI, command: SetBanCommand, banTime: Int = 86400, absolute: Boolean = false): Future[Unit]
- Definition Classes
- P2PRpc
- def setIBD(value: Boolean): Future[ChainApi]
- Definition Classes
- BitcoindRpcClient → ChainApi
- def setNetworkActive(activate: Boolean): Future[Unit]
- Definition Classes
- P2PRpc
- def setSyncing(value: Boolean): Future[ChainApi]
- Definition Classes
- BitcoindRpcClient → ChainApi
- def setWalletFlag(flag: WalletFlag, value: Boolean, walletName: String = DEFAULT_WALLET): Future[SetWalletFlagResult]
Change the state of the given wallet flag for a wallet.
Change the state of the given wallet flag for a wallet.
- Definition Classes
- WalletRpc
- def signMessage(address: P2PKHAddress, message: String): Future[String]
- Definition Classes
- MessageRpc
- def signMessageWithPrivKey(key: ECPrivateKeyBytes, message: String): Future[String]
- Definition Classes
- MessageRpc
- def signRawTransactionWithKey(transaction: Transaction, keys: Vector[ECPrivateKey], utxoDeps: Vector[SignRawTransactionOutputParameter] = Vector.empty, sigHash: HashType = HashType.sigHashAll): Future[SignRawTransactionResult]
$signRawTx
$signRawTx
This RPC call signs the raw transaction with keys provided manually.
- Definition Classes
- WalletRpc
- def signRawTransactionWithWallet(transaction: Transaction, utxoDeps: Vector[SignRawTransactionOutputParameter], sigHash: HashType = HashType.sigHashAll): Future[SignRawTransactionResult]
$signRawTx
$signRawTx
This RPC call signs the raw transaction with keys found in the Bitcoin Core wallet.
- Definition Classes
- WalletRpc
- def signRawTransactionWithWallet(transaction: Transaction): Future[SignRawTransactionWithWalletResult]
- Definition Classes
- WalletRpc
- def signRawTransactionWithWallet(transaction: Transaction, walletName: String): Future[SignRawTransactionWithWalletResult]
- Definition Classes
- WalletRpc
- def simulateRawTransaction(tx: Transaction, includeWatchOnly: Boolean = true, walletName: String = BitcoindRpcClient.DEFAULT_WALLET_NAME): Future[CurrencyUnit]
- Definition Classes
- WalletRpc
- def simulateRawTransactions(txs: Vector[Transaction], includeWatchOnly: Boolean = true, walletName: String = BitcoindRpcClient.DEFAULT_WALLET_NAME): Future[CurrencyUnit]
- Definition Classes
- WalletRpc
- def start(): Future[BitcoindRpcClient]
Starts bitcoind on the local system.
- 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
- def stop(): Future[BitcoindRpcClient]
Stop method for BitcoindRpcClient that is stopped, inherits from the StartStop trait
- 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
- def submitBlock(block: Block): Future[Unit]
- Definition Classes
- P2PRpc
- def submitHeader(header: BlockHeader): Future[Unit]
- Definition Classes
- V18AssortedRpc
- def submitPackage(transactions: Vector[Transaction], maxFeeRate: Double = 0.10, maxBurnAmount: Double = 0.0): Future[SubmitPackageResult]
Submit a package of raw transactions to the mempool.
Submit a package of raw transactions to the mempool.
The package will be validated according to consensus and mempool policy rules. If any transaction passes, it will be accepted to mempool. The package must solely consist of a child transaction and all of its unconfirmed parents, if any. None of the parents may depend on each other.
This RPC is experimental and the interface may be unstable. Package relay is not currently supported, so successful submission does not mean the transactions will propagate throughout the network.
- transactions
Vector of transactions to submit as a package (must be topologically sorted with child last)
- maxFeeRate
Maximum fee rate in BTC/kvB. Transactions with higher fee rates will be rejected. Set to 0 to accept any fee rate. Default is 0.10 BTC/kvB.
- maxBurnAmount
Maximum amount in BTC that can be burned through provably unspendable outputs (e.g., OP_RETURN). Default is 0.
- returns
SubmitPackageResult containing package validation results
- Definition Classes
- MempoolRpc
- 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
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- implicit val system: ActorSystem
- Definition Classes
- BitcoindRpcClient → Client
- def testMempoolAccept(transaction: Vector[Transaction], maxFeeRate: Double = 0.10): Future[Vector[TestMempoolAcceptResultPostV24]]
- Definition Classes
- MempoolRpc
- def toString(): String
- Definition Classes
- AnyRef → Any
- def unloadWallet(filePath: String): Future[Unit]
- Definition Classes
- WalletRpc
- def uptime: Future[UInt32]
- Definition Classes
- NodeRpc
- def utxoUpdatePsbt(psbt: PSBT, descriptors: Seq[String]): Future[PSBT]
- Definition Classes
- PsbtRpc
- def utxoUpdatePsbt(psbt: PSBT): Future[PSBT]
- Definition Classes
- PsbtRpc
- def validateAddress(address: BitcoinAddress): Future[ValidateAddressResult]
- Definition Classes
- UtilRpc
- def verifyChain(level: Int = 3, blocks: Int = 6): Future[Boolean]
- Definition Classes
- BlockchainRpc
- def verifyMessage(address: P2PKHAddress, signature: String, message: String): Future[Boolean]
- Definition Classes
- MessageRpc
- def verifyTxOutProof(proof: MerkleBlock): Future[Vector[DoubleSha256DigestBE]]
- Definition Classes
- TransactionRpc
- lazy val version: Future[BitcoindVersion]
- Definition Classes
- BitcoindV31RpcClient → BitcoindRpcClient → Client
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- def waitForBlock(timeout: FiniteDuration, blockHash: DoubleSha256DigestBE): Future[WaitForBlockResult]
- Definition Classes
- BlockchainRpc
- def waitForBlockHeight(timeout: FiniteDuration, height: Int): Future[WaitForBlockResult]
- Definition Classes
- BlockchainRpc
- def waitForNewBlock(timeout: FiniteDuration, currentTipOpt: Option[DoubleSha256DigestBE]): Future[WaitForBlockResult]
- Definition Classes
- BlockchainRpc
- def walletCreateFundedPsbt(inputs: Vector[TransactionInput], outputs: Map[BitcoinAddress, CurrencyUnit], locktime: Int = 0, options: WalletCreateFundedPsbtOptions = WalletCreateFundedPsbtOptions(), bip32derivs: Boolean = false, walletName: String = DEFAULT_WALLET): Future[WalletCreateFundedPsbtResult]
- Definition Classes
- WalletRpc
- def walletExtension(walletName: String): String
- Attributes
- protected
- Definition Classes
- Client
- def walletLock(walletName: String): Future[Unit]
- Definition Classes
- WalletRpc
- def walletLock(): Future[Unit]
- Definition Classes
- WalletRpc
- def walletPassphrase(passphrase: String, seconds: Int, walletName: String = DEFAULT_WALLET): Future[Unit]
- Definition Classes
- WalletRpc
- def walletPassphraseChange(currentPassphrase: String, newPassphrase: String, walletName: String = DEFAULT_WALLET): Future[Unit]
- Definition Classes
- WalletRpc
- def walletProcessPSBT(psbt: PSBT, sign: Boolean = true, sigHashType: HashType = HashType.sigHashAll, walletName: String = DEFAULT_WALLET): Future[WalletProcessPsbtResult]
- Definition Classes
- WalletRpc