Packages

trait MempoolRpc extends AnyRef

This trait defines RPC calls related to the mempool of a Bitcoin Core node. The mempool contains all unconfirmed transactions.

Self Type
MempoolRpc with Client
Linear Supertypes
AnyRef, Any
Known Subclasses
BitcoindRpcClient, BitcoindV29RpcClient, BitcoindV30RpcClient, BitcoindV31RpcClient
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MempoolRpc
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def getMemPoolAncestors(txid: DoubleSha256Digest): Future[Vector[DoubleSha256DigestBE]]
  11. def getMemPoolAncestors(txid: DoubleSha256DigestBE): Future[Vector[DoubleSha256DigestBE]]
  12. def getMemPoolAncestorsVerbose(txid: DoubleSha256Digest): Future[Map[DoubleSha256DigestBE, GetMemPoolResult]]
  13. def getMemPoolAncestorsVerbose(txid: DoubleSha256DigestBE): Future[Map[DoubleSha256DigestBE, GetMemPoolResult]]
  14. def getMemPoolDescendants(txid: DoubleSha256Digest): Future[Vector[DoubleSha256DigestBE]]
  15. def getMemPoolDescendants(txid: DoubleSha256DigestBE): Future[Vector[DoubleSha256DigestBE]]
  16. def getMemPoolDescendantsVerbose(txid: DoubleSha256Digest): Future[Map[DoubleSha256DigestBE, GetMemPoolResult]]
  17. def getMemPoolDescendantsVerbose(txid: DoubleSha256DigestBE): Future[Map[DoubleSha256DigestBE, GetMemPoolResult]]
  18. def getMemPoolEntry(txid: DoubleSha256Digest): Future[GetMemPoolEntryResult]
  19. def getMemPoolEntry(txid: DoubleSha256DigestBE): Future[GetMemPoolEntryResult]
  20. def getMemPoolEntryOpt(txid: DoubleSha256DigestBE): Future[Option[GetMemPoolEntryResult]]
  21. def getMemPoolEntryOpt(txid: DoubleSha256Digest): Future[Option[GetMemPoolEntryResult]]
  22. def getMemPoolInfo: Future[GetMemPoolInfoResult]
  23. def getMempoolCluster(txid: DoubleSha256Digest): Future[GetMempoolClusterResult]
  24. 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

  25. 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.

  26. def getRawMemPool(verbose: Boolean = false): Future[GetRawMempoolResult]
  27. def getRawMemPoolWithTransactions: Future[Map[DoubleSha256DigestBE, GetMemPoolResult]]
  28. def getRawMempoolTxIds(): Future[GetRawMempoolTxIds]
  29. def getRawMempoolVerbose(): Future[GetRawMempoolVerbose]
  30. 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+)

  31. def getTxSpendingPrevOut(prevouts: Vector[TransactionOutPoint]): Future[Vector[GetTxSpendingPrevOutResult]]
  32. def getTxSpendingPrevOut(prevout: TransactionOutPoint): Future[GetTxSpendingPrevOutResult]
  33. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  34. def importMempool(path: Path): Future[Unit]
  35. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  36. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  37. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  38. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  39. def saveMemPool(): Future[Unit]
  40. 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

  41. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  42. def testMempoolAccept(transaction: Vector[Transaction], maxFeeRate: Double = 0.10): Future[Vector[TestMempoolAcceptResultPostV24]]
  43. def toString(): String
    Definition Classes
    AnyRef → Any
  44. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  45. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  46. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped