@lodestar/beacon-node 1.35.0-dev.fcf8d024ea → 1.35.0-dev.feed916580

package/src/execution/engine/index.ts

@@ -1,63 +0,0 @@
-import {fromHex, toPrintableUrl} from "@lodestar/utils";
-import {JsonRpcHttpClient} from "../../eth1/provider/jsonRpcHttpClient.js";
-import {ExecutionEngineDisabled} from "./disabled.js";
-import {
-  ExecutionEngineHttp,
-  ExecutionEngineHttpOpts,
-  ExecutionEngineModules,
-  defaultExecutionEngineHttpOpts,
-} from "./http.js";
-import {IExecutionEngine} from "./interface.js";
-import {ExecutionEngineMockBackend, ExecutionEngineMockOpts} from "./mock.js";
-import {ExecutionEngineMockJsonRpcClient, JsonRpcBackend} from "./utils.js";
-
-export {ExecutionEngineHttp, ExecutionEngineDisabled, defaultExecutionEngineHttpOpts};
-
-export type ExecutionEngineOpts =
-  | ({mode?: "http"} & ExecutionEngineHttpOpts)
-  | ({mode: "mock"} & ExecutionEngineMockOpts)
-  | {mode: "disabled"};
-export const defaultExecutionEngineOpts: ExecutionEngineOpts = defaultExecutionEngineHttpOpts;
-
-export function getExecutionEngineFromBackend(
-  backend: JsonRpcBackend,
-  modules: ExecutionEngineModules
-): IExecutionEngine {
-  const rpc = new ExecutionEngineMockJsonRpcClient(backend);
-  return new ExecutionEngineHttp(rpc, modules);
-}
-
-export function getExecutionEngineHttp(
-  opts: ExecutionEngineHttpOpts,
-  modules: ExecutionEngineModules
-): IExecutionEngine {
-  const rpc = new JsonRpcHttpClient(opts.urls, {
-    ...opts,
-    signal: modules.signal,
-    metrics: modules.metrics?.executionEnginerHttpClient,
-    jwtSecret: opts.jwtSecretHex ? fromHex(opts.jwtSecretHex) : undefined,
-    jwtId: opts.jwtId,
-    jwtVersion: opts.jwtVersion,
-  });
-  modules.logger.info("Execution client", {urls: opts.urls.map(toPrintableUrl).toString()});
-  return new ExecutionEngineHttp(rpc, modules, opts);
-}
-
-export function initializeExecutionEngine(
-  opts: ExecutionEngineOpts,
-  modules: ExecutionEngineModules
-): IExecutionEngine {
-  switch (opts.mode) {
-    case "disabled":
-      return new ExecutionEngineDisabled();
-
-    case "mock":
-      return getExecutionEngineFromBackend(new ExecutionEngineMockBackend(opts), modules);
-
-    case "http":
-      return getExecutionEngineHttp(opts, modules);
-
-    default:
-      return getExecutionEngineHttp(opts, modules);
-  }
-}

package/src/execution/engine/interface.ts

@@ -1,199 +0,0 @@
-import {
-  CONSOLIDATION_REQUEST_TYPE,
-  DEPOSIT_REQUEST_TYPE,
-  ForkName,
-  ForkPostFulu,
-  ForkPreFulu,
-  WITHDRAWAL_REQUEST_TYPE,
-} from "@lodestar/params";
-import {BlobsBundle, ExecutionPayload, ExecutionRequests, Root, RootHex, Wei, capella} from "@lodestar/types";
-import {BlobAndProof} from "@lodestar/types/deneb";
-import {BlobAndProofV2} from "@lodestar/types/fulu";
-import {DATA} from "../../eth1/provider/utils.js";
-import {PayloadId, PayloadIdCache, WithdrawalV1} from "./payloadIdCache.js";
-import {ExecutionPayloadBody} from "./types.js";
-
-export {PayloadIdCache, type PayloadId, type WithdrawalV1};
-
-export enum ExecutionPayloadStatus {
-  /** given payload is valid */
-  VALID = "VALID",
-  /** given payload is invalid */
-  INVALID = "INVALID",
-  /** sync process is in progress */
-  SYNCING = "SYNCING",
-  /**
-   * blockHash is valid, but payload is not part of canonical chain and hasn't been fully
-   * validated
-   */
-  ACCEPTED = "ACCEPTED",
-  /** blockHash is invalid */
-  INVALID_BLOCK_HASH = "INVALID_BLOCK_HASH",
-  /** EL error */
-  ELERROR = "ELERROR",
-  /** EL unavailable */
-  UNAVAILABLE = "UNAVAILABLE",
-  /** EL replied with SYNCING or ACCEPTED when its not safe to import optimistic blocks */
-  UNSAFE_OPTIMISTIC_STATUS = "UNSAFE_OPTIMISTIC_STATUS",
-}
-
-export enum ExecutionEngineState {
-  ONLINE = "ONLINE",
-  OFFLINE = "OFFLINE",
-  SYNCING = "SYNCING",
-  SYNCED = "SYNCED",
-  AUTH_FAILED = "AUTH_FAILED",
-}
-
-/**
- * Client code as defined in https://github.com/ethereum/execution-apis/blob/v1.0.0-beta.4/src/engine/identification.md#clientcode
- * ClientCode.XX is dedicated to other clients which do not have their own code
- */
-export enum ClientCode {
-  BU = "BU", // besu
-  EJ = "EJ", // ethereumJS
-  EG = "EG", // erigon
-  GE = "GE", // go-ethereum
-  GR = "GR", // grandine
-  LH = "LH", // lighthouse
-  LS = "LS", // lodestar
-  NM = "NM", // nethermind
-  NB = "NB", // nimbus
-  TK = "TK", // teku
-  PM = "PM", // prysm
-  RH = "RH", // reth
-  XX = "XX", // unknown
-}
-
-export type ExecutionRequestType =
-  | typeof DEPOSIT_REQUEST_TYPE
-  | typeof WITHDRAWAL_REQUEST_TYPE
-  | typeof CONSOLIDATION_REQUEST_TYPE;
-
-export function isExecutionRequestType(type: number): type is ExecutionRequestType {
-  return type === DEPOSIT_REQUEST_TYPE || type === WITHDRAWAL_REQUEST_TYPE || type === CONSOLIDATION_REQUEST_TYPE;
-}
-
-export type ExecutePayloadResponse =
-  | {
-      status: ExecutionPayloadStatus.SYNCING | ExecutionPayloadStatus.ACCEPTED;
-      latestValidHash: null;
-      validationError: null;
-    }
-  | {status: ExecutionPayloadStatus.VALID; latestValidHash: RootHex; validationError: null}
-  | {status: ExecutionPayloadStatus.INVALID; latestValidHash: RootHex | null; validationError: string | null}
-  | {
-      status:
-        | ExecutionPayloadStatus.INVALID_BLOCK_HASH
-        | ExecutionPayloadStatus.ELERROR
-        | ExecutionPayloadStatus.UNAVAILABLE;
-      latestValidHash: null;
-      validationError: string;
-    };
-
-export type ForkChoiceUpdateStatus =
-  | ExecutionPayloadStatus.VALID
-  | ExecutionPayloadStatus.INVALID
-  | ExecutionPayloadStatus.SYNCING;
-
-export type PayloadAttributes = {
-  timestamp: number;
-  prevRandao: Uint8Array;
-  // DATA is anyway a hex string, so we can just track it as a hex string to
-  // avoid any conversions
-  suggestedFeeRecipient: string;
-  withdrawals?: capella.Withdrawal[];
-  parentBeaconBlockRoot?: Uint8Array;
-};
-
-export type ClientVersion = {
-  code: ClientCode;
-  name: string;
-  version: string;
-  commit: string;
-};
-
-export type VersionedHashes = Uint8Array[];
-
-/**
- * Execution engine represents an abstract protocol to interact with execution clients. Potential transports include:
- * - JSON RPC over network
- * - IPC
- * - Integrated code into the same binary
- */
-export interface IExecutionEngine {
-  readonly state: ExecutionEngineState;
-
-  readonly clientVersion?: ClientVersion | null;
-
-  payloadIdCache: PayloadIdCache;
-  /**
-   * A state transition function which applies changes to the self.execution_state.
-   * Returns ``True`` iff ``execution_payload`` is valid with respect to ``self.execution_state``.
-   *
-   * Required for block processing in the beacon state transition function.
-   * https://github.com/ethereum/consensus-specs/blob/0eb0a934a3/specs/merge/beacon-chain.md#on_payload
-   *
-   * Should be called in advance before, after or in parallel to block processing
-   */
-  notifyNewPayload(
-    fork: ForkName,
-    executionPayload: ExecutionPayload,
-    versionedHashes?: VersionedHashes,
-    parentBeaconBlockRoot?: Root,
-    executionRequests?: ExecutionRequests
-  ): Promise<ExecutePayloadResponse>;
-
-  /**
-   * Signal fork choice updates
-   * This function performs two actions atomically:
-   * - Re-organizes the execution payload chain and corresponding state to make head_block_hash the head.
-   * - Applies finality to the execution state: it irreversibly persists the chain of all execution payloads and
-   *   corresponding state, up to and including finalized_block_hash.
-   *
-   * The call of the notify_forkchoice_updated function maps on the POS_FORKCHOICE_UPDATED event defined in the EIP-3675.
-   * https://github.com/ethereum/consensus-specs/blob/dev/specs/merge/fork-choice.md#notify_forkchoice_updated
-   *
-   * Should be called in response to fork-choice head and finalized events
-   */
-  notifyForkchoiceUpdate(
-    fork: ForkName,
-    headBlockHash: RootHex,
-    safeBlockHash: RootHex,
-    finalizedBlockHash: RootHex,
-    payloadAttributes?: PayloadAttributes
-  ): Promise<PayloadId | null>;
-
-  /**
-   * Given the payload_id, get_payload returns the most recent version of the execution payload that has been built
-   * since the corresponding call to prepare_payload method.
-   *
-   * Required for block producing
-   * https://github.com/ethereum/consensus-specs/blob/dev/specs/merge/validator.md#get_payload
-   */
-  getPayload(
-    fork: ForkName,
-    payloadId: PayloadId
-  ): Promise<{
-    executionPayload: ExecutionPayload;
-    executionPayloadValue: Wei;
-    blobsBundle?: BlobsBundle;
-    executionRequests?: ExecutionRequests;
-    shouldOverrideBuilder?: boolean;
-  }>;
-
-  getPayloadBodiesByHash(fork: ForkName, blockHash: DATA[]): Promise<(ExecutionPayloadBody | null)[]>;
-
-  getPayloadBodiesByRange(fork: ForkName, start: number, count: number): Promise<(ExecutionPayloadBody | null)[]>;
-
-  getBlobs(
-    fork: ForkPostFulu,
-    versionedHashes: VersionedHashes,
-    buffers?: Uint8Array[]
-  ): Promise<BlobAndProofV2[] | null>;
-  getBlobs(
-    fork: ForkPreFulu,
-    versionedHashes: VersionedHashes,
-    buffers?: Uint8Array[]
-  ): Promise<(BlobAndProof | null)[]>;
-}