@lodestar/prover 1.35.0-dev.8ea34e52ba → 1.35.0-dev.91dadf81de

package/src/proof_provider/proof_provider.ts

@@ -0,0 +1,210 @@
+import {ApiClient, getClient} from "@lodestar/api/beacon";
+import {ChainForkConfig, createChainForkConfig} from "@lodestar/config";
+import {NetworkName, networksChainConfig} from "@lodestar/config/networks";
+import {Lightclient, LightclientEvent, RunStatusCode} from "@lodestar/light-client";
+import {LightClientRestTransport} from "@lodestar/light-client/transport";
+import {ForkName, isForkPostCapella} from "@lodestar/params";
+import {ExecutionPayload, LightClientHeader} from "@lodestar/types";
+import {Logger} from "@lodestar/utils";
+import {LCTransport, RootProviderInitOptions} from "../interfaces.js";
+import {assertLightClient} from "../utils/assertion.js";
+import {
+  fetchBlock,
+  getExecutionPayloads,
+  getGenesisData,
+  getSyncCheckpoint,
+  getUnFinalizedRangeForPayloads,
+} from "../utils/consensus.js";
+import {bufferToHex} from "../utils/conversion.js";
+import {PayloadStore} from "./payload_store.js";
+
+type RootProviderOptions = Omit<RootProviderInitOptions, "transport"> & {
+  transport: LightClientRestTransport;
+  api: ApiClient;
+  config: ChainForkConfig;
+};
+
+export class ProofProvider {
+  private store: PayloadStore;
+  private logger: Logger;
+  // Make sure readyPromise doesn't throw unhandled exceptions
+  private readyPromise?: Promise<void>;
+
+  readonly config: ChainForkConfig;
+  readonly network: NetworkName;
+  readonly api: ApiClient;
+
+  lightClient?: Lightclient;
+
+  constructor(readonly opts: RootProviderOptions) {
+    this.store = new PayloadStore({api: opts.api, logger: opts.logger});
+    this.logger = opts.logger;
+    this.config = opts.config;
+    this.api = opts.api;
+    this.network = opts.config.PRESET_BASE as NetworkName;
+  }
+
+  async waitToBeReady(): Promise<void> {
+    return this.readyPromise;
+  }
+
+  static init(opts: RootProviderInitOptions): ProofProvider {
+    if (opts.transport === LCTransport.P2P) {
+      throw new Error("P2P mode not supported yet");
+    }
+    opts.logger.info("Creating ProofProvider instance with REST APIs", {
+      network: opts.network,
+      urls: opts.urls.join(","),
+    });
+
+    const config = opts.network
+      ? createChainForkConfig(networksChainConfig[opts.network])
+      : createChainForkConfig(opts.config);
+
+    const api = getClient({urls: opts.urls}, {config});
+    const transport = new LightClientRestTransport(api);
+
+    const provider = new ProofProvider({
+      ...opts,
+      config,
+      api,
+      transport,
+    });
+
+    provider.readyPromise = provider.sync(opts.wsCheckpoint).catch((e) => {
+      opts.logger.error("Error while syncing", e);
+      return Promise.reject(e);
+    });
+
+    return provider;
+  }
+
+  private async sync(wsCheckpoint?: string): Promise<void> {
+    if (this.lightClient !== undefined) {
+      throw Error("Light client already initialized and syncing.");
+    }
+    this.logger.info("Starting sync for proof provider");
+    const {api, config, transport} = this.opts;
+    const checkpointRoot = await getSyncCheckpoint(api, wsCheckpoint);
+    const genesisData = await getGenesisData(api);
+
+    this.logger.info("Initializing lightclient", {checkpointRoot: bufferToHex(checkpointRoot)});
+    this.lightClient = await Lightclient.initializeFromCheckpointRoot({
+      checkpointRoot,
+      config,
+      transport,
+      genesisData,
+    });
+
+    assertLightClient(this.lightClient);
+
+    this.logger.info("Initiating lightclient");
+    // Wait for the lightclient to start
+    await this.lightClient?.start();
+    this.logger.info("Lightclient synced", this.getStatus());
+    this.registerEvents();
+
+    // Load the payloads from the CL
+    this.logger.info("Building EL payload history");
+    const {start, end} = await getUnFinalizedRangeForPayloads(this.lightClient);
+    const payloads = await getExecutionPayloads({
+      api: this.opts.api,
+      startSlot: start,
+      endSlot: end,
+      logger: this.logger,
+    });
+    for (const [slot, payload] of payloads.entries()) {
+      this.store.set(payload, slot, false);
+    }
+
+    // Load the finalized payload from the CL
+    const finalizedSlot = this.lightClient.getFinalized().beacon.slot;
+    this.logger.debug("Getting finalized slot from lightclient", {finalizedSlot});
+    const block = await fetchBlock(this.opts.api, finalizedSlot);
+    if (block) {
+      this.store.set(block.message.body.executionPayload, finalizedSlot, true);
+    } else {
+      this.logger.error("Failed to fetch finalized block", finalizedSlot);
+    }
+
+    this.logger.info("Proof provider ready");
+  }
+
+  getStatus(): {latest: number; finalized: number; status: RunStatusCode} {
+    if (!this.lightClient) {
+      return {
+        latest: 0,
+        finalized: 0,
+        status: RunStatusCode.uninitialized,
+      };
+    }
+
+    return {
+      latest: this.lightClient.getHead().beacon.slot,
+      finalized: this.lightClient.getFinalized().beacon.slot,
+      status: this.lightClient.status,
+    };
+  }
+
+  async getExecutionPayload(blockNumber: number | string | "finalized" | "latest"): Promise<ExecutionPayload> {
+    assertLightClient(this.lightClient);
+
+    if (typeof blockNumber === "string" && blockNumber === "finalized") {
+      const payload = this.store.finalized;
+      if (!payload) throw new Error("No finalized payload");
+      return payload;
+    }
+
+    if (typeof blockNumber === "string" && blockNumber === "latest") {
+      const payload = this.store.latest;
+      if (!payload) throw new Error("No latest payload");
+      return payload;
+    }
+
+    if ((typeof blockNumber === "string" && blockNumber.startsWith("0x")) || typeof blockNumber === "number") {
+      const payload = await this.store.get(blockNumber);
+      if (!payload) throw new Error(`No payload for blockNumber ${blockNumber}`);
+      return payload;
+    }
+
+    throw new Error(`Invalid blockNumber "${blockNumber}"`);
+  }
+
+  async processLCHeader(lcHeader: LightClientHeader, finalized = false): Promise<void> {
+    const fork = this.opts.config.getForkName(lcHeader.beacon.slot);
+
+    if (!isForkPostCapella(fork)) {
+      return;
+    }
+
+    const sszType = this.opts.config.getPostBellatrixForkTypes(lcHeader.beacon.slot).ExecutionPayloadHeader;
+    if (
+      isForkPostCapella(fork) &&
+      (!("execution" in lcHeader) || sszType.equals(lcHeader.execution, sszType.defaultValue()))
+    ) {
+      throw new Error("Execution payload is required for execution fork");
+    }
+
+    await this.store.processLCHeader(lcHeader as LightClientHeader<ForkName.capella>, finalized);
+  }
+
+  private registerEvents(): void {
+    assertLightClient(this.lightClient);
+
+    this.opts.signal.addEventListener("abort", () => {
+      this.lightClient?.stop();
+    });
+
+    this.lightClient.emitter.on(LightclientEvent.lightClientFinalityHeader, async (data) => {
+      await this.processLCHeader(data, true).catch((e) => {
+        this.logger.error("Error processing finality update", null, e);
+      });
+    });
+
+    this.lightClient.emitter.on(LightclientEvent.lightClientOptimisticHeader, async (data) => {
+      await this.processLCHeader(data).catch((e) => {
+        this.logger.error("Error processing optimistic update", null, e);
+      });
+    });
+  }
+}

package/src/provider_types/eip1193_provider_type.ts

@@ -0,0 +1,32 @@
+import {Web3ProviderType} from "../interfaces.js";
+import {JsonRpcRequestOrBatch, JsonRpcResponseOrBatch} from "../types.js";
+
+// Modern providers uses this structure e.g. Web3 4.x
+export interface EIP1193Provider {
+  request: (payload: JsonRpcRequestOrBatch) => Promise<JsonRpcResponseOrBatch>;
+}
+export default {
+  name: "eip1193",
+  matched(provider): provider is EIP1193Provider {
+    return (
+      "request" in provider &&
+      typeof provider.request === "function" &&
+      provider.request.constructor.name === "AsyncFunction"
+    );
+  },
+  handler(provider) {
+    const request = provider.request.bind(provider);
+
+    return async (payload: JsonRpcRequestOrBatch): Promise<JsonRpcResponseOrBatch | undefined> => {
+      const response = await request(payload);
+      return response;
+    };
+  },
+  mutateProvider(provider, newHandler) {
+    Object.assign(provider, {
+      request: async function newRequest(payload: JsonRpcRequestOrBatch): Promise<JsonRpcResponseOrBatch | undefined> {
+        return newHandler(payload);
+      },
+    });
+  },
+} as Web3ProviderType<EIP1193Provider>;

package/src/provider_types/ethers_provider_type.ts

@@ -0,0 +1,44 @@
+import {Web3ProviderType} from "../interfaces.js";
+import {JsonRpcRequestOrBatch, JsonRpcResponse, JsonRpcResponseOrBatch} from "../types.js";
+import {isBatchRequest} from "../utils/json_rpc.js";
+import web3JsProviderType from "./web3_js_provider_type.js";
+
+export interface EthersProvider {
+  // Ethers provider does not have a public interface for batch requests
+  send(method: string, params: Array<unknown>): Promise<JsonRpcResponse>;
+}
+export default {
+  name: "ethers",
+  matched(provider): provider is EthersProvider {
+    return (
+      !web3JsProviderType.matched(provider) &&
+      "send" in provider &&
+      typeof provider.send === "function" &&
+      provider.send.length > 1 &&
+      provider.send.constructor.name === "AsyncFunction"
+    );
+  },
+  handler(provider) {
+    const send = provider.send.bind(provider);
+
+    return async (payload: JsonRpcRequestOrBatch): Promise<JsonRpcResponseOrBatch | undefined> => {
+      // Because ethers provider public interface does not support batch requests
+      // so we need to handle it manually
+      if (isBatchRequest(payload)) {
+        const responses = [];
+        for (const request of payload) {
+          responses.push(await send(request.method, request.params));
+        }
+        return responses;
+      }
+      return send(payload.method, payload.params);
+    };
+  },
+  mutateProvider(provider, newHandler) {
+    Object.assign(provider, {
+      send: function newSend(method: string, params: Array<unknown>): Promise<JsonRpcResponseOrBatch | undefined> {
+        return newHandler({jsonrpc: "2.0", id: 0, method, params});
+      },
+    });
+  },
+} as Web3ProviderType<EthersProvider>;

package/src/provider_types/legacy_provider_type.ts

@@ -0,0 +1,123 @@
+import {AnyWeb3Provider, Web3ProviderType} from "../interfaces.js";
+import {JsonRpcRequest, JsonRpcRequestOrBatch, JsonRpcResponse, JsonRpcResponseOrBatch} from "../types.js";
+import web3JsProviderType from "./web3_js_provider_type.js";
+
+// Some providers uses `request` instead of the `send`. e.g. Ganache
+interface RequestProvider {
+  request(
+    payload: JsonRpcRequestOrBatch,
+    callback: (err: Error | undefined, response: JsonRpcResponseOrBatch) => void
+  ): void;
+}
+// The legacy Web3 1.x use this structure
+interface SendProvider {
+  send(payload: JsonRpcRequest, callback: (err?: Error | null, response?: JsonRpcResponse) => void): void;
+}
+// Some legacy providers use this very old structure
+interface SendAsyncProvider {
+  sendAsync(payload: JsonRpcRequestOrBatch): Promise<JsonRpcResponseOrBatch>;
+}
+
+type LegacyProvider = RequestProvider | SendProvider | SendAsyncProvider;
+
+export default {
+  name: "legacy",
+  matched(provider): provider is LegacyProvider {
+    return isRequestProvider(provider) || isSendProvider(provider) || isSendAsyncProvider(provider);
+  },
+  handler(provider) {
+    if (isRequestProvider(provider)) {
+      const request = provider.request.bind(provider);
+      return function newHandler(payload: JsonRpcRequestOrBatch): Promise<JsonRpcResponseOrBatch | undefined> {
+        return new Promise((resolve, reject) => {
+          request(payload, (err, response) => {
+            if (err) {
+              reject(err);
+            } else {
+              resolve(response);
+            }
+          });
+        });
+      };
+    }
+    if (isSendProvider(provider)) {
+      const send = provider.send.bind(provider);
+      return function newHandler(payload: JsonRpcRequestOrBatch): Promise<JsonRpcResponseOrBatch | undefined> {
+        return new Promise((resolve, reject) => {
+          // web3 providers supports batch requests but don't have valid types
+          send(payload as JsonRpcRequest, (err, response) => {
+            if (err) {
+              reject(err);
+            } else {
+              resolve(response);
+            }
+          });
+        });
+      };
+    }
+
+    // sendAsync provider
+    const sendAsync = provider.sendAsync.bind(provider);
+    return async function newHandler(payload: JsonRpcRequestOrBatch): Promise<JsonRpcResponseOrBatch | undefined> {
+      const response = await sendAsync(payload);
+      return response;
+    };
+  },
+  mutateProvider(provider, newHandler) {
+    if (isRequestProvider(provider)) {
+      const newRequest = function newRequest(
+        payload: JsonRpcRequestOrBatch,
+        callback: (err?: Error | null, response?: JsonRpcResponseOrBatch) => void
+      ): void {
+        newHandler(payload)
+          .then((response) => callback(undefined, response))
+          .catch((err) => callback(err, undefined));
+      };
+
+      Object.assign(provider, {request: newRequest});
+    }
+
+    if (isSendProvider(provider)) {
+      const newSend = function newSend(
+        payload: JsonRpcRequestOrBatch,
+        callback: (err?: Error | null, response?: JsonRpcResponseOrBatch) => void
+      ): void {
+        newHandler(payload)
+          .then((response) => callback(undefined, response))
+          .catch((err) => callback(err, undefined));
+      };
+
+      Object.assign(provider, {send: newSend});
+    }
+
+    // sendAsync provider
+    Object.assign(provider, {sendAsync: newHandler});
+  },
+} as Web3ProviderType<LegacyProvider>;
+
+function isSendProvider(provider: AnyWeb3Provider): provider is SendProvider {
+  return (
+    !web3JsProviderType.matched(provider) &&
+    "send" in provider &&
+    typeof provider.send === "function" &&
+    provider.send.length > 1 &&
+    provider.send.constructor.name !== "AsyncFunction"
+  );
+}
+
+function isRequestProvider(provider: AnyWeb3Provider): provider is RequestProvider {
+  return (
+    !web3JsProviderType.matched(provider) &&
+    "request" in provider &&
+    typeof provider.request === "function" &&
+    provider.request.length > 1
+  );
+}
+
+function isSendAsyncProvider(provider: AnyWeb3Provider): provider is SendAsyncProvider {
+  return (
+    "sendAsync" in provider &&
+    typeof provider.sendAsync === "function" &&
+    provider.sendAsync.constructor.name === "AsyncFunction"
+  );
+}

package/src/provider_types/web3_js_provider_type.ts

@@ -0,0 +1,35 @@
+import {AnyWeb3Provider, Web3ProviderType} from "../interfaces.js";
+import {JsonRpcRequest, JsonRpcRequestOrBatch, JsonRpcResponse, JsonRpcResponseOrBatch} from "../types.js";
+import {isBatchRequest} from "../utils/json_rpc.js";
+
+export interface Web3jsProvider {
+  request: (payload: JsonRpcRequest) => Promise<JsonRpcResponse>;
+}
+
+export default {
+  name: "web3js",
+  matched(provider): provider is Web3jsProvider {
+    return (
+      "isWeb3Provider" in provider.constructor &&
+      (provider.constructor as {isWeb3Provider: (provider: AnyWeb3Provider) => boolean}).isWeb3Provider(provider)
+    );
+  },
+  handler(provider) {
+    const request = provider.request.bind(provider);
+
+    return async (payload: JsonRpcRequestOrBatch): Promise<JsonRpcResponseOrBatch | undefined> => {
+      if (isBatchRequest(payload)) {
+        return Promise.all(payload.map((p) => request(p)));
+      }
+
+      return request(payload);
+    };
+  },
+  mutateProvider(provider, newHandler) {
+    Object.assign(provider, {
+      request: async function newRequest(payload: JsonRpcRequestOrBatch): Promise<JsonRpcResponseOrBatch | undefined> {
+        return newHandler(payload);
+      },
+    });
+  },
+} as Web3ProviderType<Web3jsProvider>;

package/src/types.ts

@@ -0,0 +1,163 @@
+export type JsonRpcId = number | string;
+export type JsonRpcVersion = string & ("2.0" | "1.0");
+
+export interface JsonRpcRequestPayload<T = unknown[]> {
+  readonly jsonrpc: JsonRpcVersion;
+  readonly id: JsonRpcId;
+  readonly method: string;
+  readonly params: T;
+  readonly requestOptions?: unknown;
+}
+
+export interface JsonRpcNotificationPayload<T = unknown[]> {
+  readonly jsonrpc: JsonRpcVersion;
+  readonly method: string;
+  readonly params: T;
+  readonly requestOptions?: unknown;
+}
+
+export type JsonRpcRequest<T = unknown[]> = JsonRpcRequestPayload<T> | JsonRpcNotificationPayload<T>;
+export type JsonRpcBatchRequest<T = unknown[]> = JsonRpcRequest<T>[];
+
+// The request can be a single request, a notification
+// or an array of requests and notifications as batch request
+export type JsonRpcRequestOrBatch<T = unknown[]> = JsonRpcRequest<T> | JsonRpcBatchRequest<T>;
+
+// Make the response compatible with different libraries, we don't use the readonly modifier
+export interface JsonRpcResponseWithResultPayload<T> {
+  readonly id?: JsonRpcId;
+  jsonrpc: JsonRpcVersion;
+  result: T;
+  error?: never;
+}
+
+export interface JsonRpcErrorPayload<T> {
+  readonly code?: number;
+  readonly data?: T;
+  readonly message: string;
+}
+
+export interface JsonRpcResponseWithErrorPayload<T> {
+  readonly id?: JsonRpcId;
+  jsonrpc: JsonRpcVersion;
+  result?: never;
+  error: JsonRpcErrorPayload<T>;
+}
+
+// Make the very flexible el response type to match different libraries easily
+// biome-ignore lint/suspicious/noExplicitAny: We need to use `any` type here
+export type JsonRpcResponse<T = any, E = any> =
+  | JsonRpcResponseWithResultPayload<T>
+  | JsonRpcResponseWithErrorPayload<E>;
+
+// biome-ignore lint/suspicious/noExplicitAny: We need to use `any` type here
+export type JsonRpcBatchResponse<T = any, E = any> = JsonRpcResponse<T, E>[];
+
+// Response can be a single response or an array of responses in case of batch request
+// Make the very flexible el response type to match different libraries easily
+// biome-ignore lint/suspicious/noExplicitAny: We need to use `any` type here
+export type JsonRpcResponseOrBatch<T = any, E = any> = JsonRpcResponse<T, E> | JsonRpcBatchResponse<T, E>;
+
+export type HexString = string;
+
+export type ELBlockNumberOrTag = number | string | "latest" | "earliest" | "pending";
+
+export interface ELProof {
+  readonly address: string;
+  readonly balance: string;
+  readonly codeHash: string;
+  readonly nonce: string;
+  readonly storageHash: string;
+  readonly accountProof: string[];
+  readonly storageProof: {
+    readonly key: string;
+    readonly value: string;
+    readonly proof: string[];
+  }[];
+}
+
+export interface ELTransaction {
+  readonly type: string;
+  readonly nonce: string;
+  readonly to: string | null;
+  readonly chainId?: string;
+  readonly input: string;
+  readonly value: string;
+  readonly gasPrice?: string;
+  readonly gas: string;
+  readonly maxFeePerGas?: string;
+  readonly maxPriorityFeePerGas?: string;
+  readonly blockHash: string;
+  readonly blockNumber: string;
+  readonly from: string;
+  readonly hash: string;
+  readonly r: string;
+  readonly s: string;
+  readonly v: string;
+  readonly transactionIndex: string;
+  readonly accessList?: {address: string; storageKeys: string[]}[];
+  readonly data?: string;
+}
+
+export interface ELWithdrawal {
+  readonly index: string;
+  readonly validatorIndex: string;
+  readonly address: string;
+  readonly amount: string;
+}
+
+export interface ELBlock {
+  readonly parentHash: string;
+  readonly stateRoot: string;
+  readonly receiptsRoot: string;
+  readonly logsBloom: string;
+  readonly nonce: string;
+  readonly difficulty: string;
+  readonly totalDifficulty: string;
+  readonly number: string;
+  readonly gasLimit: string;
+  readonly gasUsed: string;
+  readonly timestamp: string;
+  readonly extraData?: Buffer | string;
+  readonly mixHash: string;
+  readonly hash: string;
+  readonly baseFeePerGas: string;
+  readonly miner: string;
+  readonly sha3Uncles: string;
+  readonly size: string;
+  readonly uncles: ELBlock[];
+  readonly transactions: ELTransaction[];
+  readonly transactionsRoot: string;
+  readonly withdrawals?: ELWithdrawal[];
+  readonly withdrawalsRoot?: string;
+}
+
+export interface ELAccessList {
+  readonly address: HexString;
+  readonly storageKeys: HexString[];
+}
+
+export interface ELAccessListResponse {
+  readonly error: string;
+  readonly gasUsed: HexString;
+  readonly accessList: ELAccessList[];
+}
+
+export type ELStorageProof = Pick<ELProof, "storageHash" | "storageProof">;
+
+export type ELApi = {
+  eth_getBalance: (address: string, block?: number | string) => string;
+  eth_createAccessList: (transaction: ELTransaction, block?: ELBlockNumberOrTag) => ELAccessListResponse;
+  eth_call: (transaction: ELTransaction, block?: ELBlockNumberOrTag) => HexString;
+  eth_estimateGas: (transaction: ELTransaction, block?: ELBlockNumberOrTag) => HexString;
+  eth_getCode: (address: string, block?: ELBlockNumberOrTag) => HexString;
+  eth_getProof: (address: string, storageKeys: string[], block?: ELBlockNumberOrTag) => ELProof;
+  eth_getBlockByNumber: (block: ELBlockNumberOrTag, hydrated?: boolean) => ELBlock | undefined;
+  eth_getBlockByHash: (block: string, hydrated?: boolean) => ELBlock | undefined;
+};
+export type ELApiParams = {
+  [K in keyof ELApi]: Parameters<ELApi[K]>;
+};
+export type ELApiReturn = {
+  [K in keyof ELApi]: ReturnType<ELApi[K]>;
+};

package/src/utils/assertion.ts

@@ -0,0 +1,11 @@
+import {Lightclient} from "@lodestar/light-client";
+
+export function assertLightClient(client?: Lightclient): asserts client is Lightclient {
+  if (!client) {
+    throw new Error("Light client is not initialized yet.");
+  }
+}
+
+export function isTruthy<T = unknown>(value: T): value is Exclude<T, undefined | null> {
+  return value !== undefined && value !== null && value !== false;
+}