Crate kona_protocol

Source

Expand description

§`kona-protocol`

Core protocol types for Optimism.

These include types, constants, and methods for derivation as well as batch-submission.

§Provenance

This code was initially ported from kona-primitives to op-alloy as part of maili migrations.

Structs§

BatchReader: Batch Reader provides a function that iteratively consumes batches from the reader. The L1Inclusion block is also provided at creation time. Warning: the batch reader can read every batch-type. The caller of the batch-reader should filter the results.
BatchTransaction: BatchTransaction is a set of Frames that can be Into::into Bytes. if the size exceeds the desired threshold.
BatchWithInclusionBlock: A batch with its inclusion block.
BlockInfo: Block Header Info
Channel: A Channel is a set of batches that are split into at least one, but possibly multiple frames.
Frame: A channel frame representing a segment of channel data for transmission.
L1BlockInfoBedrock: Represents the fields within a Bedrock L1 block info transaction.
L1BlockInfoEcotone: Represents the fields within an Ecotone L1 block info transaction.
L1BlockInfoIsthmus: Represents the fields within an Isthnus L1 block info transaction.
L2BlockInfo: L2 Block Header Info
OpAttributesWithParent: Optimism Payload Attributes with parent block reference and the L1 origin block.
OutputRoot: The OutputRoot is a high-level commitment to an L2 block. It lifts the state root from the block header as well as the storage root of the Predeploys::L2_TO_L1_MESSAGE_PASSER account into the top-level commitment construction.
Predeploys: Container for all predeploy contract addresses
RawSpanBatch: Raw Span Batch
SingleBatch: Represents a single batch: a single encoded L2 block
SpanBatch: Container for the inputs required to build a span of L2 blocks in derived form.
SpanBatchBits: Type for span batch bits.
SpanBatchEip1559TransactionData: The transaction data for an EIP-1559 transaction within a span batch.
SpanBatchEip2930TransactionData: The transaction data for an EIP-2930 transaction within a span batch.
SpanBatchEip7702TransactionData: The transaction data for an EIP-7702 transaction within a span batch.
SpanBatchElement: A single batch element is similar to the SingleBatch type but does not contain the parent hash and epoch hash since spans do not contain this data for every block in the span.
SpanBatchLegacyTransactionData: The transaction data for a legacy transaction within a span batch.
SpanBatchPayload: Span Batch Payload
SpanBatchPrefix: Span Batch Prefix
SpanBatchTransactions: This struct contains the decoded information for transactions in a span batch.
SyncStatus: The SyncStatus of an Optimism Rollup Node.

Enums§

Batch: A Batch.
BatchDecodingError: An error decoding a batch.
BatchEncodingError: An error encoding a batch.
BatchType: The Batch Type.
BatchValidity: Batch Validity
BlockInfoError: An error type for parsing L1 block info transactions.
BrotliDecompressionError: A frame decompression error.
ChannelError: An error returned when adding a frame to a channel.
DecodeError: An error decoding an L1 block info transaction.
DecompressionError: Error type for decompression failures.
DepositError: An TxDeposit validation error.
FrameDecodingError: A frame decoding error.
FrameParseError: Frame parsing error.
FromBlockError: An error that can occur when converting an OP Block to L2BlockInfo.
L1BlockInfoTx: The L1BlockInfoTx enum contains variants for the different versions of the L1 block info transaction on OP Stack chains.
OpBlockConversionError: An error encountered during OP Block conversion.
SpanBatchError: Span Batch Errors
SpanBatchTransactionData: The typed transaction data for a transaction within a span batch.
SpanDecodingError: Decoding Error

Constants§

CHANNEL_ID_LENGTH: CHANNEL_ID_LENGTH is the length of the channel ID.
DEPOSIT_EVENT_ABI: Deposit log event abi signature.
DEPOSIT_EVENT_ABI_HASH: Deposit event abi hash.
DEPOSIT_EVENT_VERSION_0: The initial version of the deposit event log.
DERIVATION_VERSION_0: Version identifier for the current derivation pipeline format.
FJORD_MAX_RLP_BYTES_PER_CHANNEL: FJORD_MAX_RLP_BYTES_PER_CHANNEL is the maximum amount of bytes that will be read from a channel when the Fjord Hardfork is activated. This limit is set when decoding the RLP.
FRAME_OVERHEAD: Overhead estimation for frame metadata and tagging information.
MAX_FRAME_LEN: Maximum allowed size for a single frame in bytes.
MAX_RLP_BYTES_PER_CHANNEL: MAX_RLP_BYTES_PER_CHANNEL is the maximum amount of bytes that will be read from a channel. This limit is set when decoding the RLP.
MAX_SPAN_BATCH_ELEMENTS: MAX_SPAN_BATCH_ELEMENTS is the maximum number of blocks, transactions in total, or transaction per block allowed in a span batch.
SINGLE_BATCH_TYPE: The single batch type identifier.
SPAN_BATCH_TYPE: The span batch type identifier.

Traits§

BatchValidationProvider: Describes the functionality of a data source that fetches safe blocks.

Functions§

decode_deposit: Derives a deposit transaction from an EVM log event emitted by the deposit contract.
decompress_brotli: Decompresses the given bytes data using the Brotli decompressor implemented in the brotli crate.
read_tx_data: Reads transaction data from a reader.
to_system_config: Converts the OpBlock to a partial SystemConfig.

Type Aliases§

ChannelId: ChannelId is an opaque identifier for a channel.

Crate kona_protocolCopy item path

§kona-protocol