kona-engine 0.1.2

An implementation of the OP Stack engine client
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

//! Contains the different kinds of execution engine clients that can be used.

use derive_more::{Display, FromStr};

/// Identifies the type of execution layer client for behavior customization.
///
/// Different execution clients may have slight variations in API behavior
/// or supported features. This enum allows the engine to adapt its behavior
/// accordingly, though as of v0.1.0, behavior is equivalent across all types.
///
/// # Examples
///
/// ```rust
/// use kona_engine::EngineKind;
/// use std::str::FromStr;
///
/// // Parse from string
/// let kind = EngineKind::from_str("geth").unwrap();
/// assert_eq!(kind, EngineKind::Geth);
///
/// // Display as string
/// assert_eq!(EngineKind::Reth.to_string(), "reth");
/// ```
#[derive(Debug, Display, FromStr, Clone, Copy, PartialEq, Eq)]
pub enum EngineKind {
    /// Geth execution client.
    #[display("geth")]
    Geth,
    /// Reth execution client.
    #[display("reth")]
    Reth,
    /// Erigon execution client.
    #[display("erigon")]
    Erigon,
}

impl EngineKind {
    /// Contains all valid engine client kinds.
    pub const KINDS: [Self; 3] = [Self::Geth, Self::Reth, Self::Erigon];

    /// Returns whether the engine client kind supports post finalization EL sync.
    #[deprecated(
        since = "0.1.0",
        note = "Node behavior is now equivalent across all engine client types."
    )]
    pub const fn supports_post_finalization_elsync(self) -> bool {
        match self {
            Self::Geth => false,
            Self::Erigon | Self::Reth => true,
        }
    }
}