Struct ChainOf 

pub struct ChainOf<F: HeaderFamily> { /* private fields */ }

The chain with its block file, for header family F.

Implementations

impl<F: HeaderFamily> ChainOf<F>

pub fn open( doc: ChainDocument, dir: impl AsRef<Path>, key: Option<&SecretKey>, ) -> Result<Self>

Replay dir/blocks.dat, creating it with the genesis when absent — which needs the signer’s key. open() refuses a block file whose block 0 does not hash to the document’s genesisHash, and any later block the rules refuse.

pub fn open_sealed( doc: ChainDocument, dir: impl AsRef<Path>, seal: impl FnOnce(&F::Block) -> Result<F::Block>, ) -> Result<Self>

ChainOf::open for a federated chain (siding/lib/chain.mjs open(null, { seal })): when no chain is on disk, seal receives the unsigned genesis (StateOf::build_genesis_for) and returns it sealed by k signatures — crate::federation::seal_federated with the partials the signers made. With a chain on disk, seal is not called.

pub fn state(&self) -> &StateOf<F>

The chain in memory.

pub fn index(&self) -> &Index

The block file’s index.

pub fn dat_path(&self) -> PathBuf

dir/blocks.dat.

pub fn index_path(&self) -> PathBuf

dir/blocks.json.

pub fn add_block( &mut self, bytes: &[u8], expect: Option<BlockHash>, ) -> Result<Applied>

Accept a block from elsewhere (a mirror): validated, applied, written.

pub fn submit(&mut self, tx_bytes: &[u8]) -> Result<Submitted>

A transaction for the mempool (SPEC 11), consensus bytes.

pub fn produce( &mut self, key: &SecretKey, claims: Vec<ClaimRequest>, ) -> Result<Applied>

One signer: build the next block from the mempool and these claims, sign, apply, write.

Trait Implementations

impl<F: Debug + HeaderFamily> Debug for ChainOf<F>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.