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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107

//! Optimism Payload attributes that reference the parent L2 block.

use crate::{BlockInfo, L2BlockInfo};
use alloc::vec;
use op_alloy_consensus::OpTxType;
use op_alloy_rpc_types_engine::OpPayloadAttributes;

/// Optimism Payload Attributes with parent block reference and the L1 origin block.
#[derive(Debug, Clone, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct OpAttributesWithParent {
    /// The payload attributes.
    pub inner: OpPayloadAttributes,
    /// The parent block reference.
    pub parent: L2BlockInfo,
    /// The L1 block that the attributes were derived from.
    pub derived_from: Option<BlockInfo>,
    /// Whether the current batch is the last in its span.
    pub is_last_in_span: bool,
}

impl OpAttributesWithParent {
    /// Create a new [`OpAttributesWithParent`] instance.
    pub const fn new(
        inner: OpPayloadAttributes,
        parent: L2BlockInfo,
        derived_from: Option<BlockInfo>,
        is_last_in_span: bool,
    ) -> Self {
        Self { inner, parent, derived_from, is_last_in_span }
    }

    /// Returns the L2 block number for the payload attributes if made canonical.
    /// Derived as the parent block height plus one.
    pub const fn block_number(&self) -> u64 {
        self.parent.block_info.number.saturating_add(1)
    }

    /// Consumes `self` and returns the inner [`OpPayloadAttributes`].
    pub fn take_inner(self) -> OpPayloadAttributes {
        self.inner
    }

    /// Returns the payload attributes.
    pub const fn inner(&self) -> &OpPayloadAttributes {
        &self.inner
    }

    /// Returns the parent block reference.
    pub const fn parent(&self) -> &L2BlockInfo {
        &self.parent
    }

    /// Returns the L1 origin block reference.
    pub const fn derived_from(&self) -> Option<&BlockInfo> {
        self.derived_from.as_ref()
    }

    /// Returns whether the current batch is the last in its span.
    pub const fn is_last_in_span(&self) -> bool {
        self.is_last_in_span
    }

    /// Returns `true` if all transactions in the payload are deposits.
    pub fn is_deposits_only(&self) -> bool {
        self.inner
            .transactions
            .iter()
            .all(|tx| tx.first().is_some_and(|tx| tx[0] == OpTxType::Deposit as u8))
    }

    /// Converts the [`OpAttributesWithParent`] into a deposits-only payload.
    pub fn as_deposits_only(&self) -> Self {
        Self {
            inner: OpPayloadAttributes {
                transactions: self.inner.transactions.as_ref().map(|txs| {
                    txs.iter()
                        .map(|_| alloy_primitives::Bytes::from(vec![OpTxType::Deposit as u8]))
                        .collect()
                }),
                ..self.inner.clone()
            },
            parent: self.parent,
            derived_from: self.derived_from,
            is_last_in_span: self.is_last_in_span,
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_op_attributes_with_parent() {
        let attributes = OpPayloadAttributes::default();
        let parent = L2BlockInfo::default();
        let is_last_in_span = true;
        let op_attributes_with_parent =
            OpAttributesWithParent::new(attributes.clone(), parent, None, is_last_in_span);

        assert_eq!(op_attributes_with_parent.inner(), &attributes);
        assert_eq!(op_attributes_with_parent.parent(), &parent);
        assert_eq!(op_attributes_with_parent.is_last_in_span(), is_last_in_span);
        assert_eq!(op_attributes_with_parent.derived_from(), None);
    }
}