trait BifrostQueryAlgebra[F[_]] extends AnyRef

Defines a Bifrost Query API for interacting with a Bifrost node.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BifrostQueryAlgebra
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def blockByDepth(depth: Long): F[Option[(BlockId, BlockHeader, BlockBody, Seq[IoTransaction])]]

    Fetches a block by its depth.

    Fetches a block by its depth.

    returns

    The BlockId, BlockHeader, BlockBody, and contained transactions of the fetched block, if it exists.

  2. abstract def blockByHeight(height: Long): F[Option[(BlockId, BlockHeader, BlockBody, Seq[IoTransaction])]]

    Fetches a block by its height.

    Fetches a block by its height.

    height

    The height of the block to fetch.

    returns

    The BlockId, BlockHeader, BlockBody, and contained transactions of the fetched block, if it exists.

  3. abstract def blockById(blockId: BlockId): F[Option[(BlockId, BlockHeader, BlockBody, Seq[IoTransaction])]]

    Fetches a block by its Id.

    Fetches a block by its Id.

    blockId

    The Id of the block to fetch.

    returns

    The BlockId, BlockHeader, BlockBody, and contained transactions of the fetched block, if it exists.

  4. abstract def broadcastTransaction(tx: IoTransaction): F[TransactionId]

    Broadcasts a transaction to the network.

    Broadcasts a transaction to the network.

    tx

    The transaction to broadcast.

    returns

    The Id of the transaction that was broadcasted.

  5. abstract def fetchTransaction(txId: TransactionId): F[Option[IoTransaction]]

    Fetches a transaction by its Id.

    Fetches a transaction by its Id.

    txId

    The Id of the transaction to fetch.

    returns

    The fetched transaction, if it exists.

  6. abstract def makeBlock(nbOfBlocks: Int): F[Unit]

    Make a block in regtest mode.

    Make a block in regtest mode.

    nbOfBlocks

    the number of blocks to mint.

  7. abstract def synchronizationTraversal(): F[Iterator[SynchronizationTraversalRes]]

    Retrieve an iterator of changes to the canonical head of the chain.

    Retrieve an iterator of changes to the canonical head of the chain.

    returns

    an iterator of changes to the chain tip

Concrete 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]) @HotSpotIntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped