Lodestar prover for execution api

packages/light-client/src/events.ts

@@ -1,13 +1,16 @@
 import {allForks} from "@lodestar/types";
+import {RunStatusCode} from "./index.js";
 
 export enum LightclientEvent {
-  lightClientOptimisticUpdate = "light_client_optimistic_update",
-  lightClientFinalityUpdate = "light_client_finality_update",
+  lightClientOptimisticHeader = "light_client_optimistic_header",
+  lightClientFinalityHeader = "light_client_finality_header",
+  statusChange = "light_client_status_change",
 }
 
 export type LightclientEmitterEvents = {
-  [LightclientEvent.lightClientOptimisticUpdate]: (newHeader: allForks.LightClientHeader) => void;
-  [LightclientEvent.lightClientFinalityUpdate]: (newHeader: allForks.LightClientHeader) => void;
+  [LightclientEvent.lightClientOptimisticHeader]: (newHeader: allForks.LightClientHeader) => void;
+  [LightclientEvent.lightClientFinalityHeader]: (newHeader: allForks.LightClientHeader) => void;
+  [LightclientEvent.statusChange]: (code: RunStatusCode) => void;
 };
 
 export type LightclientEmitter = MittEmitter<LightclientEmitterEvents>;

packages/light-client/src/index.ts

@@ -49,12 +49,14 @@ const ON_ERROR_RETRY_MS = 1000;
 // TODO: Customize with option
 const ALLOW_FORCED_UPDATES = true;
 
-enum RunStatusCode {
+export enum RunStatusCode {
+  uninitialized,
   started,
   syncing,
   stopped,
 }
 type RunStatus =
+  | {code: RunStatusCode.uninitialized}
   | {code: RunStatusCode.started; controller: AbortController}
   | {code: RunStatusCode.syncing}
   | {code: RunStatusCode.stopped};
@@ -104,7 +106,7 @@ export class Lightclient {
 
   private readonly lightclientSpec: LightclientSpec;
 
-  private status: RunStatus = {code: RunStatusCode.stopped};
+  private runStatus: RunStatus = {code: RunStatusCode.stopped};
 
   constructor({config, logger, genesisData, bootstrap, transport}: LightclientInitArgs) {
     this.genesisTime = genesisData.genesisTime;
@@ -116,24 +118,29 @@ export class Lightclient {
     this.config = createBeaconConfig(config, this.genesisValidatorsRoot);
     this.logger = logger ?? getLcLoggerConsole();
     this.transport = transport;
+    this.runStatus = {code: RunStatusCode.uninitialized};
 
     this.lightclientSpec = new LightclientSpec(
       this.config,
       {
         allowForcedUpdates: ALLOW_FORCED_UPDATES,
         onSetFinalizedHeader: (header) => {
-          this.emitter.emit(LightclientEvent.lightClientFinalityUpdate, header);
+          this.emitter.emit(LightclientEvent.lightClientFinalityHeader, header);
           this.logger.debug("Updated state.finalizedHeader", {slot: header.beacon.slot});
         },
         onSetOptimisticHeader: (header) => {
-          this.emitter.emit(LightclientEvent.lightClientOptimisticUpdate, header);
+          this.emitter.emit(LightclientEvent.lightClientOptimisticHeader, header);
           this.logger.debug("Updated state.optimisticHeader", {slot: header.beacon.slot});
         },
       },
       bootstrap
     );
   }
 
+  get status(): RunStatusCode {
+    return this.runStatus.code;
+  }
+
   // Embed lightweight clock. The epoch cycles are handled with `this.runLoop()`
   get currentSlot(): number {
     return getCurrentSlot(this.config, this.genesisTime);
@@ -167,16 +174,20 @@ export class Lightclient {
   }
 
   stop(): void {
-    if (this.status.code !== RunStatusCode.started) return;
+    if (this.runStatus.code !== RunStatusCode.started) return;
 
-    this.status.controller.abort();
-    this.status = {code: RunStatusCode.stopped};
+    this.runStatus.controller.abort();
+    this.updateRunStatus({code: RunStatusCode.stopped});
   }
 
   getHead(): allForks.LightClientHeader {
     return this.lightclientSpec.store.optimisticHeader;
   }
 
+  getFinalized(): allForks.LightClientHeader {
+    return this.lightclientSpec.store.finalizedHeader;
+  }
+
   async sync(fromPeriod: SyncPeriod, toPeriod: SyncPeriod): Promise<void> {
     // Initialize the BLS implementation. This may requires initializing the WebAssembly instance
     // so why it's a an async process. This should be initialized once before any bls operations.
@@ -212,12 +223,12 @@ export class Lightclient {
       // Check if we have a sync committee for the current clock period
       if (!this.lightclientSpec.store.syncCommittees.has(currentPeriod)) {
         // Stop head tracking
-        if (this.status.code === RunStatusCode.started) {
-          this.status.controller.abort();
+        if (this.runStatus.code === RunStatusCode.started) {
+          this.runStatus.controller.abort();
         }
 
         // Go into sync mode
-        this.status = {code: RunStatusCode.syncing};
+        this.updateRunStatus({code: RunStatusCode.syncing});
         const headPeriod = computeSyncPeriodAtSlot(this.getHead().beacon.slot);
         this.logger.debug("Syncing", {lastPeriod: headPeriod, currentPeriod});
 
@@ -243,9 +254,9 @@ export class Lightclient {
       }
 
       // After successfully syncing, track head if not already
-      if (this.status.code !== RunStatusCode.started) {
+      if (this.runStatus.code !== RunStatusCode.started) {
         const controller = new AbortController();
-        this.status = {code: RunStatusCode.started, controller};
+        this.updateRunStatus({code: RunStatusCode.started, controller});
         this.logger.debug("Started tracking the head");
 
         this.transport.onOptimisticUpdate(this.processOptimisticUpdate.bind(this));
@@ -268,11 +279,11 @@ export class Lightclient {
       }
 
       // Wait for the next epoch
-      if (this.status.code !== RunStatusCode.started) {
+      if (this.runStatus.code !== RunStatusCode.started) {
         return;
       } else {
         try {
-          await sleep(timeUntilNextEpoch(this.config, this.genesisTime), this.status.controller.signal);
+          await sleep(timeUntilNextEpoch(this.config, this.genesisTime), this.runStatus.controller.signal);
         } catch (e) {
           if (isErrorAborted(e)) {
             return;
@@ -306,4 +317,9 @@ export class Lightclient {
   private currentSlotWithTolerance(): Slot {
     return slotWithFutureTolerance(this.config, this.genesisTime, MAX_CLOCK_DISPARITY_SEC);
   }
+
+  private updateRunStatus(runStatus: RunStatus): void {
+    this.runStatus = runStatus;
+    this.emitter.emit(LightclientEvent.statusChange, this.runStatus.code);
+  }
 }

packages/light-client/test/unit/sync.node.test.ts

@@ -106,7 +106,7 @@ describe("sync", () => {
 
     // Sync periods to current
     await new Promise<void>((resolve) => {
-      lightclient.emitter.on(LightclientEvent.lightClientFinalityUpdate, (header) => {
+      lightclient.emitter.on(LightclientEvent.lightClientFinalityHeader, (header) => {
         if (computeSyncPeriodAtSlot(header.beacon.slot) >= targetPeriod) {
           resolve();
         }
@@ -128,7 +128,7 @@ describe("sync", () => {
     // Track head + reference states with some known data
     const syncCommittee = getInteropSyncCommittee(targetPeriod);
     await new Promise<void>((resolve) => {
-      lightclient.emitter.on(LightclientEvent.lightClientOptimisticUpdate, (header) => {
+      lightclient.emitter.on(LightclientEvent.lightClientOptimisticHeader, (header) => {
         if (header.beacon.slot === targetSlot) {
           resolve();
         }

packages/params/src/index.ts

@@ -13,6 +13,7 @@ export {
   ForkExecution,
   ForkBlobs,
   isForkExecution,
+  isForkWithdrawals,
   isForkBlobs,
   isForkLightClient,
 } from "./forkName.js";

packages/prover/.gitignore

@@ -0,0 +1,10 @@
+node_modules/
+lib
+.nyc_output/
+coverage/**
+.DS_Store
+*.swp
+.idea
+yarn-error.log
+package-lock.json
+dist*

packages/prover/.mocharc.yaml

@@ -0,0 +1,8 @@
+colors: true
+timeout: 2000
+exit: true
+extension: ["ts"]
+require:
+  - ./test/setup.ts
+node-option:
+  - "loader=ts-node/esm"

packages/prover/.nycrc.json

@@ -0,0 +1,3 @@
+{
+  "extends": "../../.nycrc.json"
+}