Crate op_alloy_protocol

op-alloy-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 as part of ongoing op-alloy migrations.

Re-exports

• pub use deposits::decode_deposit;
• pub use deposits::DepositError;
• pub use deposits::DepositSourceDomain;
• pub use deposits::DepositSourceDomainIdentifier;
• pub use deposits::L1InfoDepositSource;
• pub use deposits::UpgradeDepositSource;
• pub use deposits::UserDepositSource;
• pub use deposits::DEPOSIT_EVENT_ABI_HASH;
• pub use block_info::L1BlockInfoBedrock;
• pub use block_info::L1BlockInfoEcotone;
• pub use block_info::L1BlockInfoTx;
• pub use fee::calculate_tx_l1_cost_bedrock;
• pub use fee::calculate_tx_l1_cost_ecotone;
• pub use fee::calculate_tx_l1_cost_fjord;
• pub use fee::calculate_tx_l1_cost_regolith;
• pub use fee::data_gas_bedrock;
• pub use fee::data_gas_fjord;
• pub use fee::data_gas_regolith;

Modules

• block_info
  This module contains the L1BlockInfoTx type, and various encoding / decoding methods for it.
• deposits
  Contains deposit transaction types and helper methods.
• fee
  This module contains the L1 block fee calculation function.

Structs

• 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 is a segment of a channel’s data.
• FrameIter
  An iterator over encoded frames.
• L2BlockInfo
  L2 Block Header Info
• RawSpanBatch
  Raw Span Batch
• SingleBatch
  Represents a single batch: a single encoded L2 block
• SpanBatch
  The span batch contains the input 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.
• 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.

Enums

• Batch
  A Batch.
• BatchDecodingError
  An error decoding a batch.
• BatchType
  The Batch Type.
• BatchValidity
  Batch Validity
• ChannelError
  An error returned when adding a frame to a channel.
• FrameDecodingError
  A frame decoding error.
• FrameParseError
  Frame parsing error.
• FromBlockError
  An error that can occur when converting an OpBlock to an L2BlockInfo.
• OpBlockConversionError
  An error encountered during OpBlock 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.
• DERIVATION_VERSION_0
  The version of the derivation pipeline.
• 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
  Count the tagging info as 200 in terms of buffer size.
• MAX_FRAME_LEN
  Frames cannot be larger than 1MB.
• 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

• read_tx_data
  Reads transaction data from a reader.
• starts_with_2718_deposit
  Returns if the given value is a deposit transaction.
• to_system_config
  Converts the OpBlock to a partial SystemConfig.

Type Aliases

• ChannelId
  ChannelId is an opaque identifier for a channel.