Interface EngineClient

types/src/engine_client.rs:33–55

use alloy_transport_ipc::IpcConnect;
use std::future::Future;

/// The number of times the engine client will try to reconnect
/// after failing to connect to the IPC socket.
const IPC_CONNECT_MAX_RETRIES: u32 = 200;

/// Typed error returned by `EngineClient` methods so callers can decide
/// whether to retry, drop a round, or shut down — instead of the wrapper
/// panicking on every non-transport JSON-RPC failure.
///
/// Transport-level retry already happens inside each engine-client method
/// via `wait_until_reconnect_available`, so by the time an
/// `EngineClientError` reaches a caller the call has already been retried
/// once after reconnect (or the error is JSON-RPC level, which is not
/// retryable). Callers typically treat any `Err` as a graceful shutdown
/// signal.
#[derive(Debug)]
pub struct EngineClientError(pub TransportError);

impl EngineClientError {
    /// Construct a custom, non-retryable engine-client error from a message.
    /// Primarily for tests that simulate an execution-client failure (e.g. a
    /// failed forkchoice commit at an epoch boundary).
    pub fn custom(msg: &str) -> Self {
        EngineClientError(TransportErrorKind::custom_str(msg))
    }
}