@lodestar/builder 1.50.0-dev.f2fb26d453 → 1.50.0-dev.fd4f342a40

package/lib/services/payloadOrchestrator.d.ts

@@ -0,0 +1,42 @@
+import { LodestarError } from "@lodestar/utils";
+import { type BuildRequest, type BuiltPayload, type PayloadSource } from "./payloadSource.js";
+export type PayloadBuildJob = {
+    /** Jobs with the same ID share one build and its result. */
+    id: string;
+    request: BuildRequest;
+    /** Unix timestamp in milliseconds at which the prepared payload should be retrieved. */
+    getPayloadAt: number;
+};
+export type PayloadOrchestratorOptions = {
+    /** Maximum time in milliseconds to wait for payload retrieval. */
+    getPayloadTimeout: number;
+};
+export declare enum PayloadOrchestratorErrorCode {
+    PREPARE_DEADLINE_REACHED = "PAYLOAD_ORCHESTRATOR_ERROR_PREPARE_DEADLINE_REACHED",
+    PREPARE_TIMEOUT = "PAYLOAD_ORCHESTRATOR_ERROR_PREPARE_TIMEOUT",
+    GET_PAYLOAD_TIMEOUT = "PAYLOAD_ORCHESTRATOR_ERROR_GET_PAYLOAD_TIMEOUT"
+}
+export type PayloadOrchestratorErrorType = {
+    code: PayloadOrchestratorErrorCode.PREPARE_DEADLINE_REACHED;
+    jobId: string;
+    getPayloadAt: number;
+} | {
+    code: PayloadOrchestratorErrorCode.PREPARE_TIMEOUT | PayloadOrchestratorErrorCode.GET_PAYLOAD_TIMEOUT;
+    jobId: string;
+};
+export declare class PayloadOrchestratorError extends LodestarError<PayloadOrchestratorErrorType> {
+}
+/**
+ * Prepares a payload and retrieves it at the requested time. Preparation retries missing payload IDs until the
+ * retrieval time. Transport-level retries remain owned by the source.
+ */
+export declare class PayloadOrchestrator {
+    private readonly source;
+    private readonly options;
+    private readonly signal;
+    private readonly jobs;
+    constructor(source: PayloadSource, options: PayloadOrchestratorOptions, signal: AbortSignal);
+    run(job: PayloadBuildJob): Promise<BuiltPayload>;
+    private runJob;
+}
+//# sourceMappingURL=payloadOrchestrator.d.ts.map

package/lib/services/payloadOrchestrator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"payloadOrchestrator.d.ts","sourceRoot":"","sources":["../../src/services/payloadOrchestrator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,aAAa,EAA0C,MAAM,iBAAiB,CAAC;AACvF,OAAO,EACL,KAAK,YAAY,EACjB,KAAK,YAAY,EACjB,KAAK,aAAa,EAGnB,MAAM,oBAAoB,CAAC;AAI5B,MAAM,MAAM,eAAe,GAAG;IAC5B,4DAA4D;IAC5D,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,YAAY,CAAC;IACtB,wFAAwF;IACxF,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG;IACvC,kEAAkE;IAClE,iBAAiB,EAAE,MAAM,CAAC;CAC3B,CAAC;AAEF,oBAAY,4BAA4B;IACtC,wBAAwB,wDAAwD;IAChF,eAAe,+CAA+C;IAC9D,mBAAmB,mDAAmD;CACvE;AAED,MAAM,MAAM,4BAA4B,GACpC;IACE,IAAI,EAAE,4BAA4B,CAAC,wBAAwB,CAAC;IAC5D,KAAK,EAAE,MAAM,CAAC;IACd,YAAY,EAAE,MAAM,CAAC;CACtB,GACD;IACE,IAAI,EAAE,4BAA4B,CAAC,eAAe,GAAG,4BAA4B,CAAC,mBAAmB,CAAC;IACtG,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEN,qBAAa,wBAAyB,SAAQ,aAAa,CAAC,4BAA4B,CAAC;CAAG;AAE5F;;;GAGG;AACH,qBAAa,mBAAmB;IAI5B,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,OAAO,CAAC,QAAQ,CAAC,MAAM;IALzB,OAAO,CAAC,QAAQ,CAAC,IAAI,CAA4C;IAEjE,YACmB,MAAM,EAAE,aAAa,EACrB,OAAO,EAAE,0BAA0B,EACnC,MAAM,EAAE,WAAW,EAClC;IAEJ,GAAG,CAAC,GAAG,EAAE,eAAe,GAAG,OAAO,CAAC,YAAY,CAAC,CAQ/C;YAEa,MAAM;CAwCrB"}

package/lib/services/payloadOrchestrator.js

@@ -0,0 +1,60 @@
+import { LodestarError, TimeoutError, retry, sleep, withTimeout } from "@lodestar/utils";
+import { PayloadSourceError, PayloadSourceErrorCode, } from "./payloadSource.js";
+const PREPARE_RETRY_DELAY = 100;
+export var PayloadOrchestratorErrorCode;
+(function (PayloadOrchestratorErrorCode) {
+    PayloadOrchestratorErrorCode["PREPARE_DEADLINE_REACHED"] = "PAYLOAD_ORCHESTRATOR_ERROR_PREPARE_DEADLINE_REACHED";
+    PayloadOrchestratorErrorCode["PREPARE_TIMEOUT"] = "PAYLOAD_ORCHESTRATOR_ERROR_PREPARE_TIMEOUT";
+    PayloadOrchestratorErrorCode["GET_PAYLOAD_TIMEOUT"] = "PAYLOAD_ORCHESTRATOR_ERROR_GET_PAYLOAD_TIMEOUT";
+})(PayloadOrchestratorErrorCode || (PayloadOrchestratorErrorCode = {}));
+export class PayloadOrchestratorError extends LodestarError {
+}
+/**
+ * Prepares a payload and retrieves it at the requested time. Preparation retries missing payload IDs until the
+ * retrieval time. Transport-level retries remain owned by the source.
+ */
+export class PayloadOrchestrator {
+    source;
+    options;
+    signal;
+    jobs = new Map();
+    constructor(source, options, signal) {
+        this.source = source;
+        this.options = options;
+        this.signal = signal;
+    }
+    run(job) {
+        const { id } = job;
+        let promise = this.jobs.get(id);
+        if (promise === undefined) {
+            promise = this.runJob(job).finally(() => this.jobs.delete(id));
+            this.jobs.set(id, promise);
+        }
+        return promise;
+    }
+    async runJob({ id, request, getPayloadAt }) {
+        const prepareTimeout = getPayloadAt - Date.now();
+        if (!(prepareTimeout > 0)) {
+            throw new PayloadOrchestratorError({ code: PayloadOrchestratorErrorCode.PREPARE_DEADLINE_REACHED, jobId: id, getPayloadAt }, `Payload preparation deadline reached jobId=${id} getPayloadAt=${getPayloadAt}`);
+        }
+        const handle = await withTimeout((signal = this.signal) => retry(() => this.source.prepare(request, signal), {
+            retries: Infinity,
+            retryDelay: PREPARE_RETRY_DELAY,
+            shouldRetry: (error) => error instanceof PayloadSourceError && error.type.code === PayloadSourceErrorCode.NO_PAYLOAD_ID,
+            signal,
+        }), prepareTimeout, this.signal).catch((error) => {
+            if (error instanceof TimeoutError) {
+                throw new PayloadOrchestratorError({ code: PayloadOrchestratorErrorCode.PREPARE_TIMEOUT, jobId: id });
+            }
+            throw error;
+        });
+        await sleep(getPayloadAt - Date.now(), this.signal);
+        return withTimeout((signal = this.signal) => this.source.getPayload(handle, signal), this.options.getPayloadTimeout, this.signal).catch((error) => {
+            if (error instanceof TimeoutError) {
+                throw new PayloadOrchestratorError({ code: PayloadOrchestratorErrorCode.GET_PAYLOAD_TIMEOUT, jobId: id });
+            }
+            throw error;
+        });
+    }
+}
+//# sourceMappingURL=payloadOrchestrator.js.map

package/lib/services/payloadOrchestrator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"payloadOrchestrator.js","sourceRoot":"","sources":["../../src/services/payloadOrchestrator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,aAAa,EAAE,YAAY,EAAE,KAAK,EAAE,KAAK,EAAE,WAAW,EAAC,MAAM,iBAAiB,CAAC;AACvF,OAAO,EAIL,kBAAkB,EAClB,sBAAsB,GACvB,MAAM,oBAAoB,CAAC;AAE5B,MAAM,mBAAmB,GAAG,GAAG,CAAC;AAehC,MAAM,CAAN,IAAY,4BAIX;AAJD,WAAY,4BAA4B;IACtC,gHAAgF,CAAA;IAChF,8FAA8D,CAAA;IAC9D,sGAAsE,CAAA;AACxE,CAAC,EAJW,4BAA4B,KAA5B,4BAA4B,QAIvC;AAaD,MAAM,OAAO,wBAAyB,SAAQ,aAA2C;CAAG;AAE5F;;;GAGG;AACH,MAAM,OAAO,mBAAmB;IAIX,MAAM;IACN,OAAO;IACP,MAAM;IALR,IAAI,GAAG,IAAI,GAAG,EAAiC,CAAC;IAEjE,YACmB,MAAqB,EACrB,OAAmC,EACnC,MAAmB;sBAFnB,MAAM;uBACN,OAAO;sBACP,MAAM;IACtB,CAAC;IAEJ,GAAG,CAAC,GAAoB;QACtB,MAAM,EAAC,EAAE,EAAC,GAAG,GAAG,CAAC;QACjB,IAAI,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAChC,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YAC1B,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC;YAC/D,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;QAC7B,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAEO,KAAK,CAAC,MAAM,CAAC,EAAC,EAAE,EAAE,OAAO,EAAE,YAAY,EAAkB;QAC/D,MAAM,cAAc,GAAG,YAAY,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACjD,IAAI,CAAC,CAAC,cAAc,GAAG,CAAC,CAAC,EAAE,CAAC;YAC1B,MAAM,IAAI,wBAAwB,CAChC,EAAC,IAAI,EAAE,4BAA4B,CAAC,wBAAwB,EAAE,KAAK,EAAE,EAAE,EAAE,YAAY,EAAC,EACtF,8CAA8C,EAAE,iBAAiB,YAAY,EAAE,CAChF,CAAC;QACJ,CAAC;QAED,MAAM,MAAM,GAAG,MAAM,WAAW,CAC9B,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,EAAE,EAAE,CACvB,KAAK,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE;YAChD,OAAO,EAAE,QAAQ;YACjB,UAAU,EAAE,mBAAmB;YAC/B,WAAW,EAAE,CAAC,KAAK,EAAE,EAAE,CACrB,KAAK,YAAY,kBAAkB,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,KAAK,sBAAsB,CAAC,aAAa;YACjG,MAAM;SACP,CAAC,EACJ,cAAc,EACd,IAAI,CAAC,MAAM,CACZ,CAAC,KAAK,CAAC,CAAC,KAAc,EAAE,EAAE;YACzB,IAAI,KAAK,YAAY,YAAY,EAAE,CAAC;gBAClC,MAAM,IAAI,wBAAwB,CAAC,EAAC,IAAI,EAAE,4BAA4B,CAAC,eAAe,EAAE,KAAK,EAAE,EAAE,EAAC,CAAC,CAAC;YACtG,CAAC;YACD,MAAM,KAAK,CAAC;QACd,CAAC,CAAC,CAAC;QAEH,MAAM,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC,GAAG,EAAE,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;QAEpD,OAAO,WAAW,CAChB,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE,MAAM,CAAC,EAChE,IAAI,CAAC,OAAO,CAAC,iBAAiB,EAC9B,IAAI,CAAC,MAAM,CACZ,CAAC,KAAK,CAAC,CAAC,KAAc,EAAE,EAAE;YACzB,IAAI,KAAK,YAAY,YAAY,EAAE,CAAC;gBAClC,MAAM,IAAI,wBAAwB,CAAC,EAAC,IAAI,EAAE,4BAA4B,CAAC,mBAAmB,EAAE,KAAK,EAAE,EAAE,EAAC,CAAC,CAAC;YAC1G,CAAC;YACD,MAAM,KAAK,CAAC;QACd,CAAC,CAAC,CAAC;IACL,CAAC;CACF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lodestar/builder",
-  "version": "1.50.0-dev.f2fb26d453",
+  "version": "1.50.0-dev.fd4f342a40",
   "description": "A Typescript implementation of the builder client",
   "author": "ChainSafe Systems",
   "license": "Apache-2.0",
@@ -48,16 +48,16 @@
   "dependencies": {
     "@chainsafe/lodestar-z": "catalog:",
     "@chainsafe/ssz": "^1.8.0",
-    "@lodestar/api": "^1.50.0-dev.f2fb26d453",
-    "@lodestar/config": "^1.50.0-dev.f2fb26d453",
-    "@lodestar/params": "^1.50.0-dev.f2fb26d453",
-    "@lodestar/state-transition": "^1.50.0-dev.f2fb26d453",
-    "@lodestar/types": "^1.50.0-dev.f2fb26d453",
-    "@lodestar/utils": "^1.50.0-dev.f2fb26d453"
+    "@lodestar/api": "^1.50.0-dev.fd4f342a40",
+    "@lodestar/config": "^1.50.0-dev.fd4f342a40",
+    "@lodestar/params": "^1.50.0-dev.fd4f342a40",
+    "@lodestar/state-transition": "^1.50.0-dev.fd4f342a40",
+    "@lodestar/types": "^1.50.0-dev.fd4f342a40",
+    "@lodestar/utils": "^1.50.0-dev.fd4f342a40"
   },
   "devDependencies": {
-    "@lodestar/logger": "^1.50.0-dev.f2fb26d453",
-    "@lodestar/test-utils": "^1.50.0-dev.f2fb26d453"
+    "@lodestar/logger": "^1.50.0-dev.fd4f342a40",
+    "@lodestar/test-utils": "^1.50.0-dev.fd4f342a40"
   },
-  "gitHead": "639434e12d5aa481d4e1334c8cd43561f0d1da33"
+  "gitHead": "d6b5b265be7298e02833b90a83b8cab3b4decc9c"
 }

package/src/services/payloadOrchestrator.ts

@@ -0,0 +1,107 @@
+import {LodestarError, TimeoutError, retry, sleep, withTimeout} from "@lodestar/utils";
+import {
+  type BuildRequest,
+  type BuiltPayload,
+  type PayloadSource,
+  PayloadSourceError,
+  PayloadSourceErrorCode,
+} from "./payloadSource.js";
+
+const PREPARE_RETRY_DELAY = 100;
+
+export type PayloadBuildJob = {
+  /** Jobs with the same ID share one build and its result. */
+  id: string;
+  request: BuildRequest;
+  /** Unix timestamp in milliseconds at which the prepared payload should be retrieved. */
+  getPayloadAt: number;
+};
+
+export type PayloadOrchestratorOptions = {
+  /** Maximum time in milliseconds to wait for payload retrieval. */
+  getPayloadTimeout: number;
+};
+
+export enum PayloadOrchestratorErrorCode {
+  PREPARE_DEADLINE_REACHED = "PAYLOAD_ORCHESTRATOR_ERROR_PREPARE_DEADLINE_REACHED",
+  PREPARE_TIMEOUT = "PAYLOAD_ORCHESTRATOR_ERROR_PREPARE_TIMEOUT",
+  GET_PAYLOAD_TIMEOUT = "PAYLOAD_ORCHESTRATOR_ERROR_GET_PAYLOAD_TIMEOUT",
+}
+
+export type PayloadOrchestratorErrorType =
+  | {
+      code: PayloadOrchestratorErrorCode.PREPARE_DEADLINE_REACHED;
+      jobId: string;
+      getPayloadAt: number;
+    }
+  | {
+      code: PayloadOrchestratorErrorCode.PREPARE_TIMEOUT | PayloadOrchestratorErrorCode.GET_PAYLOAD_TIMEOUT;
+      jobId: string;
+    };
+
+export class PayloadOrchestratorError extends LodestarError<PayloadOrchestratorErrorType> {}
+
+/**
+ * Prepares a payload and retrieves it at the requested time. Preparation retries missing payload IDs until the
+ * retrieval time. Transport-level retries remain owned by the source.
+ */
+export class PayloadOrchestrator {
+  private readonly jobs = new Map<string, Promise<BuiltPayload>>();
+
+  constructor(
+    private readonly source: PayloadSource,
+    private readonly options: PayloadOrchestratorOptions,
+    private readonly signal: AbortSignal
+  ) {}
+
+  run(job: PayloadBuildJob): Promise<BuiltPayload> {
+    const {id} = job;
+    let promise = this.jobs.get(id);
+    if (promise === undefined) {
+      promise = this.runJob(job).finally(() => this.jobs.delete(id));
+      this.jobs.set(id, promise);
+    }
+    return promise;
+  }
+
+  private async runJob({id, request, getPayloadAt}: PayloadBuildJob): Promise<BuiltPayload> {
+    const prepareTimeout = getPayloadAt - Date.now();
+    if (!(prepareTimeout > 0)) {
+      throw new PayloadOrchestratorError(
+        {code: PayloadOrchestratorErrorCode.PREPARE_DEADLINE_REACHED, jobId: id, getPayloadAt},
+        `Payload preparation deadline reached jobId=${id} getPayloadAt=${getPayloadAt}`
+      );
+    }
+
+    const handle = await withTimeout(
+      (signal = this.signal) =>
+        retry(() => this.source.prepare(request, signal), {
+          retries: Infinity,
+          retryDelay: PREPARE_RETRY_DELAY,
+          shouldRetry: (error) =>
+            error instanceof PayloadSourceError && error.type.code === PayloadSourceErrorCode.NO_PAYLOAD_ID,
+          signal,
+        }),
+      prepareTimeout,
+      this.signal
+    ).catch((error: unknown) => {
+      if (error instanceof TimeoutError) {
+        throw new PayloadOrchestratorError({code: PayloadOrchestratorErrorCode.PREPARE_TIMEOUT, jobId: id});
+      }
+      throw error;
+    });
+
+    await sleep(getPayloadAt - Date.now(), this.signal);
+
+    return withTimeout(
+      (signal = this.signal) => this.source.getPayload(handle, signal),
+      this.options.getPayloadTimeout,
+      this.signal
+    ).catch((error: unknown) => {
+      if (error instanceof TimeoutError) {
+        throw new PayloadOrchestratorError({code: PayloadOrchestratorErrorCode.GET_PAYLOAD_TIMEOUT, jobId: id});
+      }
+      throw error;
+    });
+  }
+}