kona-protocol 0.4.5

Optimism protocol-specific types
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84

//! Batch types and processing for OP Stack L2 derivation.
//!
//! This module contains comprehensive batch handling functionality for the OP Stack
//! derivation pipeline. Batches are the fundamental unit of L2 transaction data
//! that are derived from L1 data and used to construct L2 blocks.
//!
//! # Batch Types
//!
//! ## Single Batches
//! Traditional batch format containing transactions for a single L2 block.
//! Simple, straightforward format used before span batch optimization.
//!
//! ## Span Batches  
//! Advanced batch format that can contain transactions for multiple L2 blocks,
//! providing significant compression and efficiency improvements. Introduced
//! to reduce L1 data costs for high-throughput L2 chains.
//!
//! # Processing Pipeline
//!
//! ```text
//! L1 Data → Frame → Channel → Batch → L2 Block Attributes
//! ```
//!
//! # Key Components
//!
//! - **Batch Types**: [`SingleBatch`], [`SpanBatch`] for different batch formats
//! - **Batch Reading**: [`BatchReader`] for decoding batch data from channels
//! - **Validation**: [`BatchValidationProvider`] for batch validity checking
//! - **Transaction Data**: Specialized transaction formats for span batches
//! - **Error Handling**: Comprehensive error types for batch processing failures

mod r#type;
pub use r#type::*;

mod reader;
pub use reader::{BatchReader, DecompressionError};

mod tx;
pub use tx::BatchTransaction;

mod core;
pub use core::Batch;

mod raw;
pub use raw::RawSpanBatch;

mod payload;
pub use payload::SpanBatchPayload;

mod prefix;
pub use prefix::SpanBatchPrefix;

mod inclusion;
pub use inclusion::BatchWithInclusionBlock;

mod errors;
pub use errors::{BatchDecodingError, BatchEncodingError, SpanBatchError, SpanDecodingError};

mod bits;
pub use bits::SpanBatchBits;

mod span;
pub use span::SpanBatch;

mod transactions;
pub use transactions::SpanBatchTransactions;

mod element;
pub use element::{MAX_SPAN_BATCH_ELEMENTS, SpanBatchElement};

mod validity;
pub use validity::BatchValidity;

mod single;
pub use single::SingleBatch;

mod tx_data;
pub use tx_data::{
    SpanBatchEip1559TransactionData, SpanBatchEip2930TransactionData,
    SpanBatchEip7702TransactionData, SpanBatchLegacyTransactionData, SpanBatchTransactionData,
};

mod traits;
pub use traits::BatchValidationProvider;