Documentation

A relative slot within a chunk

Chunk number

Size of a chunk

The total number of slots available in a chunk is equal to numRegularBlocks if not chunkCanContainEBB, and numRegularBlocks + 1 otherwise.

Size of the chunks of the immutable DB

This is the key data structure that drives all layout functions.

TODO: Add support for non-uniform ChunkInfo https://github.com/input-output-hk/ouroboros-network/issues/1754

Simple chunk config with a single chunk size

This intentionally takes EpochSize (number of slots) rather than ChunkSize: the translation from EpochSize to ChunkSize (number of available entries in a chunk) should not be done by client code.

ChunkInfo for a single ChunkSize

See also simpleChunkInfo.

Can we store EBBs in the chunks described by this ChunkInfo?

This is only used for tests. This API will need to change (and the tests will become more complicated) once we support non-uniform ChunkInfo.

First chunk

Count number of chunks between two indices

countChunks x              x  == 0
countChunks x (nextChunkNo x) == 1

Enumerate all chunks

chunksBetween x              x  == [x]
chunksBetween x (nextChunkNo x) == [x, nextChunkNo x]

Smart constructor for RelativeSlot

RelativeSlot is partially ordered, not totally ordered

It makes no sense to compare RelativeSlots from different chunks. Doing so will result in an assertion failure.

Uniquely identify a block within the immutable DB

Constructor marked as Unsafe; construction should normally happen inside this module only (though see the ChunkSlot pattern synonym).

Result of nextRelativeSlot

The last relative slot within a chunk of the given size

Is this relative slot reserved for an EBB?

The n'th relative slot for an arbitrary block

NOTE: Offset 0 refers to an EBB only if the ChunkSize supports it.

The first relative slot

NOTE: This refers to an EBB only if the ChunkSize supports it.

Next relative slot

Variation on nextRelativeSlot where the caller knows that there must be a next slot

Throws an assertion failure (if assertions are enabled) if there is no next slot.

Chunk slot for an unknown block

This returns two ChunkSlots: one in case the block could be an EBB, and one in case the block is a regular block. In addition, it also returns the ChunkNo that both of these ChunkSlots must necessarily share.

Chunk slot for a regular block (i.e., not an EBB)

Chunk slot for EBB

Chunk slot for BlockOrEBB

Chunk slot for Tip

From relative to absolute slot

This can be used for EBBs and regular blocks, since they don't share a relative slot.