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

• batch_tx 🔒
  Transaction Types
• block 🔒
  Block Types for Optimism.
• block_info
  This module contains the L1BlockInfoTx type, and various encoding / decoding methods for it.
• channel 🔒
  Channel Types
• deposits
  Contains deposit transaction types and helper methods.
• fee
  This module contains the L1 block fee calculation function.
• frame 🔒
  Frame Types
• iter 🔒
  An iterator over encoded frames.
• utils 🔒
  Utility methods used by protocol types.

Structs

• BatchTransaction
  BatchTransaction is a set of Frames that can be Into::into [Bytes]. if the size exceeds the desired threshold.
• 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

Enums

• 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.

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.

Functions

• 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.