root
API
Generated with
root/org.sigilaris/org.sigilaris.node/org.sigilaris.node.jvm/org.sigilaris.node.jvm.runtime/org.sigilaris.node.jvm.runtime.block

org.sigilaris.node.jvm.runtime.block

package org.sigilaris.node.jvm.runtime.block

Members list

Type members

Classlikes

final case class BlockBody[TxRef, ResultRef, Event](records: Set[BlockRecord[TxRef, ResultRef, Event]])

The body of a block, containing the set of records included in it.

The body of a block, containing the set of records included in it.

Duplicate BlockRecordHash rejection is owned by the canonical validation/root-computation helpers so callers can assemble generic bodies before the consensus boundary validates them.

Type parameters

Event

event type

ResultRef

result reference type

TxRef

transaction reference type

Value parameters

records

the set of block records comprising this body

Attributes

Companion
object
Source
Model.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object BlockBody

Companion for BlockBody providing canonical ordering, root computation, and verification.

Companion for BlockBody providing canonical ordering, root computation, and verification.

Attributes

Companion
class
Source
Model.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
BlockBody.type
final case class BlockHeader(parent: Option[BlockId], height: BlockHeight, stateRoot: StateRoot, bodyRoot: BodyRoot, timestamp: BlockTimestamp, version: BlockHeaderVersion, executionPlanRoot: Option[ExecutionPlanRoot])

Immutable header of a block containing linkage and commitment data.

Immutable header of a block containing linkage and commitment data.

Value parameters

bodyRoot

cryptographic commitment to the block body contents

height

zero-based height of this block in the chain

parent

identifier of the parent block, or None for the genesis block

stateRoot

cryptographic commitment to the post-execution state

timestamp

UTC timestamp in epoch milliseconds when the block was produced

Attributes

Companion
object
Source
Model.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object BlockHeader

Companion for BlockHeader.

Companion for BlockHeader.

Attributes

Companion
class
Source
Model.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
enum BlockHeaderVersion(val tag: Byte)

Attributes

Companion
object
Source
Model.scala
Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object BlockHeaderVersion

Attributes

Companion
enum
Source
Model.scala
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
object BlockHeight

Companion for BlockHeight.

Companion for BlockHeight.

Attributes

Source
Model.scala
Supertypes
class Object
trait Matchable
class Any
Self type
object BlockId

Companion for BlockId.

Companion for BlockId.

Attributes

Source
Model.scala
Supertypes
class Object
trait Matchable
class Any
Self type
BlockId.type
final case class BlockProtocolActivation(activationHeight: BlockHeight, requiredVersion: BlockHeaderVersion)

Attributes

Companion
object
Source
Model.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object BlockProtocolActivation

Attributes

Companion
class
Source
Model.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
trait BlockQuery[F[_], TxRef, ResultRef, Event]

Read-only query interface for retrieving block headers, bodies, and views.

Read-only query interface for retrieving block headers, bodies, and views.

Type parameters

Event

event type

F

effect type

ResultRef

result reference type

TxRef

transaction reference type

Attributes

Source
Store.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait BlockStore[F, TxRef, ResultRef, Event]
final case class BlockRecord[TxRef, ResultRef, Event](tx: TxRef, result: Option[ResultRef], events: Vector[Event])

A single record within a block body, linking a transaction to its result and emitted events.

A single record within a block body, linking a transaction to its result and emitted events.

Type parameters

Event

event type

ResultRef

result reference type

TxRef

transaction reference type

Value parameters

events

events emitted during execution

result

optional reference to the execution result

tx

reference to the originating transaction

Attributes

Source
Model.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object BlockRecordHash

Companion for BlockRecordHash.

Companion for BlockRecordHash.

Attributes

Source
Model.scala
Supertypes
class Object
trait Matchable
class Any
Self type
trait BlockStore[F[_], TxRef, ResultRef, Event] extends BlockQuery[F, TxRef, ResultRef, Event]

Mutable store for persisting and retrieving blocks, extending BlockQuery with write operations.

Mutable store for persisting and retrieving blocks, extending BlockQuery with write operations.

Type parameters

Event

event type

F

effect type

ResultRef

result reference type

TxRef

transaction reference type

Attributes

Companion
object
Source
Store.scala
Supertypes
trait BlockQuery[F, TxRef, ResultRef, Event]
class Object
trait Matchable
class Any
object BlockStore

Companion for BlockStore providing factory methods.

Companion for BlockStore providing factory methods.

Attributes

Companion
trait
Source
Store.scala
Supertypes
class Object
trait Matchable
class Any
Self type
BlockStore.type
object BlockTimestamp

Companion for BlockTimestamp.

Companion for BlockTimestamp.

Attributes

Source
Model.scala
Supertypes
class Object
trait Matchable
class Any
Self type
final case class BlockValidationFailure(reason: String, detail: Option[String])

Represents a failure encountered during block validation.

Represents a failure encountered during block validation.

Value parameters

detail

optional human-readable detail message

reason

short machine-readable failure reason

Attributes

Companion
object
Source
Model.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object BlockValidationFailure

Companion for BlockValidationFailure.

Companion for BlockValidationFailure.

Attributes

Companion
class
Source
Model.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class BlockView[TxRef, ResultRef, Event](header: BlockHeader, body: BlockBody[TxRef, ResultRef, Event])

Combined view of a block header and its body.

Combined view of a block header and its body.

Type parameters

Event

event type

ResultRef

result reference type

TxRef

transaction reference type

Value parameters

body

the block body

header

the block header

Attributes

Companion
object
Source
Model.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object BlockView

Companion for BlockView.

Companion for BlockView.

Attributes

Companion
class
Source
Model.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
BlockView.type
object BodyRoot

Companion for BodyRoot.

Companion for BodyRoot.

Attributes

Source
Model.scala
Supertypes
class Object
trait Matchable
class Any
Self type
BodyRoot.type
object StateRoot

Companion for StateRoot.

Companion for StateRoot.

Attributes

Source
Model.scala
Supertypes
class Object
trait Matchable
class Any
Self type
StateRoot.type

Types

opaque type BlockHeight

Zero-based height of a block within the chain.

Zero-based height of a block within the chain.

Attributes

Source
Model.scala
opaque type BlockId

Unique identifier for a block, derived from the block header hash.

Unique identifier for a block, derived from the block header hash.

Attributes

Source
Model.scala
opaque type BlockRecordHash

Content-addressable hash of a single block record.

Content-addressable hash of a single block record.

Attributes

Source
Model.scala
opaque type BlockTimestamp

Millisecond-precision UTC timestamp associated with a block.

Millisecond-precision UTC timestamp associated with a block.

Attributes

Source
Model.scala
opaque type BodyRoot

Cryptographic commitment to the contents of a block body.

Cryptographic commitment to the contents of a block body.

Attributes

Source
Model.scala
opaque type StateRoot

Cryptographic commitment to the global state at a given block.

Cryptographic commitment to the global state at a given block.

Attributes

Source
Model.scala
Generated with