trait BifrostQueryAlgebra[F[_]] extends AnyRef
Defines a Bifrost Query API for interacting with a Bifrost node.
- Alphabetic
- By Inheritance
- BifrostQueryAlgebra
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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
- 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
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- 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()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)