@lodestar/builder 1.50.0-dev.abf1d462fa → 1.50.0-dev.be50566b7e

package/src/services/bidSelector.ts

@@ -0,0 +1,138 @@
+import type {ChainForkConfig} from "@lodestar/config";
+import type {ForkPostGloas} from "@lodestar/params";
+import type {BuilderIndex, RootHex, SignedBeaconBlock, Slot} from "@lodestar/types";
+import {sszTypesFor} from "@lodestar/types";
+import {LodestarError, toRootHex} from "@lodestar/utils";
+import type {BidIdentity, BidLedger, BidLedgerRecord} from "./bidLedger.js";
+
+export type ObservedPostGloasBlock = {
+  blockRoot: RootHex;
+  slot: Slot;
+  version: ForkPostGloas;
+  block: SignedBeaconBlock<ForkPostGloas>;
+};
+
+export type BidSelectorModules = {
+  config: ChainForkConfig;
+  ledger: BidLedger;
+  builderIndex: BuilderIndex;
+};
+
+export enum BidSelectionIgnoreReason {
+  FOREIGN_BUILDER = "foreign_builder",
+}
+
+export type BidSelectionResult =
+  | {
+      status: "selected";
+      blockRoot: RootHex;
+      bid: BidLedgerRecord;
+    }
+  | {
+      status: "ignored";
+      reason: BidSelectionIgnoreReason;
+    };
+
+export enum BidSelectorErrorCode {
+  BLOCK_ROOT_MISMATCH = "BID_SELECTOR_ERROR_BLOCK_ROOT_MISMATCH",
+  BLOCK_SLOT_MISMATCH = "BID_SELECTOR_ERROR_BLOCK_SLOT_MISMATCH",
+  BLOCK_FORK_MISMATCH = "BID_SELECTOR_ERROR_BLOCK_FORK_MISMATCH",
+  BID_SLOT_MISMATCH = "BID_SELECTOR_ERROR_BID_SLOT_MISMATCH",
+  UNKNOWN_BID = "BID_SELECTOR_ERROR_UNKNOWN_BID",
+}
+
+export type BidSelectorErrorType =
+  | {
+      code: BidSelectorErrorCode.BLOCK_ROOT_MISMATCH;
+      blockRoot: RootHex;
+      computedBlockRoot: RootHex;
+    }
+  | {
+      code: BidSelectorErrorCode.BLOCK_SLOT_MISMATCH;
+      slot: Slot;
+      blockSlot: Slot;
+    }
+  | {
+      code: BidSelectorErrorCode.BLOCK_FORK_MISMATCH;
+      version: ForkPostGloas;
+      blockFork: string;
+    }
+  | {
+      code: BidSelectorErrorCode.BID_SLOT_MISMATCH;
+      slot: Slot;
+      bidSlot: Slot;
+    }
+  | {
+      code: BidSelectorErrorCode.UNKNOWN_BID;
+      slot: Slot;
+      parentBlockHash: RootHex;
+      parentBlockRoot: RootHex;
+      blockHash: RootHex;
+      signedBidRoot: RootHex;
+    };
+
+export class BidSelectorError extends LodestarError<BidSelectorErrorType> {}
+
+/** Matches an imported post-Gloas block to an exact local bid and records the win. */
+export class BidSelector {
+  constructor(private readonly modules: BidSelectorModules) {}
+
+  match(observed: ObservedPostGloasBlock): BidSelectionResult {
+    const {block, blockRoot, slot, version} = observed;
+    const {builderIndex, config, ledger} = this.modules;
+    const blockSlot = block.message.slot;
+
+    if (blockSlot !== slot) {
+      throw new BidSelectorError(
+        {code: BidSelectorErrorCode.BLOCK_SLOT_MISMATCH, slot, blockSlot},
+        `Observed block slot does not match fetched block slot=${slot} blockSlot=${blockSlot}`
+      );
+    }
+
+    const blockFork = config.getForkName(slot);
+    if (blockFork !== version) {
+      throw new BidSelectorError(
+        {code: BidSelectorErrorCode.BLOCK_FORK_MISMATCH, version, blockFork},
+        `Observed block fork does not match configured fork version=${version} blockFork=${blockFork}`
+      );
+    }
+
+    const computedBlockRoot = toRootHex(config.getForkTypes(slot).BeaconBlock.hashTreeRoot(block.message));
+    if (computedBlockRoot !== blockRoot) {
+      throw new BidSelectorError(
+        {code: BidSelectorErrorCode.BLOCK_ROOT_MISMATCH, blockRoot, computedBlockRoot},
+        `Observed block root does not match fetched block blockRoot=${blockRoot} computedBlockRoot=${computedBlockRoot}`
+      );
+    }
+
+    const bid = block.message.body.signedExecutionPayloadBid.message;
+    if (bid.slot !== slot) {
+      throw new BidSelectorError(
+        {code: BidSelectorErrorCode.BID_SLOT_MISMATCH, slot, bidSlot: bid.slot},
+        `Selected bid slot does not match block slot=${slot} bidSlot=${bid.slot}`
+      );
+    }
+    if (bid.builderIndex !== builderIndex) {
+      return {status: "ignored", reason: BidSelectionIgnoreReason.FOREIGN_BUILDER};
+    }
+
+    const identity: BidIdentity = {
+      slot,
+      parentBlockHash: toRootHex(bid.parentBlockHash),
+      parentBlockRoot: toRootHex(bid.parentBlockRoot),
+      blockHash: toRootHex(bid.blockHash),
+    };
+    const signedBidRoot = toRootHex(
+      sszTypesFor(version, "SignedExecutionPayloadBid").hashTreeRoot(block.message.body.signedExecutionPayloadBid)
+    );
+    const localBid = ledger.recordWin({...identity, signedBidRoot}, blockRoot);
+    if (localBid === null) {
+      throw new BidSelectorError(
+        {code: BidSelectorErrorCode.UNKNOWN_BID, ...identity, signedBidRoot},
+        `Selected bid is not in the local ledger slot=${slot} blockHash=${identity.blockHash} signedBidRoot=${signedBidRoot}`
+      );
+    }
+
+    return {status: "selected", blockRoot, bid: localBid};
+  }
+}

package/src/services/blockObserver.ts

@@ -47,55 +47,17 @@ export class BlockObserver {
     this.retries = retries;
     this.retryDelay = retryDelay;
     this.maxSeenBlockRoots = maxSeenBlockRoots;
+    this.logger.info("Block observer initialized", {retries, retryDelay, maxSeenBlockRoots});
   }
 
   /**
-   * Register a block consumer. Consumers that require complete observation must register before {@link start}, because
+   * Register a block consumer. Consumers that require complete observation must register before event delivery, because
    * roots observed before registration remain consumed until normal FIFO eviction.
    */
   runOnBlock(fn: RunOnBlockFn): void {
     this.fns.push(fn);
   }
 
-  start(signal: AbortSignal): void {
-    this.logger.info("Subscribing to block events", {
-      retries: this.retries,
-      retryDelay: this.retryDelay,
-      maxSeenBlockRoots: this.maxSeenBlockRoots,
-    });
-
-    this.api.events
-      .eventstream({
-        topics: [EventType.block],
-        signal,
-        onEvent: (event) => {
-          if (event.type !== EventType.block) {
-            this.logger.debug("Ignoring unexpected beacon event", {eventType: event.type});
-            return;
-          }
-
-          void this.processBlockEvent(event.message, signal);
-        },
-        onError: (error) => {
-          this.logger.error("Failed to receive block event", {}, error);
-        },
-        onClose: () => {
-          if (signal.aborted) {
-            this.logger.debug("Closed stream for block events");
-          } else {
-            this.logger.error("Block event stream closed unexpectedly", {});
-          }
-        },
-      })
-      .catch((error: unknown) => {
-        this.logger.error(
-          "Failed to subscribe to block events",
-          {},
-          error instanceof Error ? error : Error(String(error))
-        );
-      });
-  }
-
   async processBlockEvent(event: BlockEvent, signal: AbortSignal): Promise<void> {
     try {
       const {slot, block: blockRoot, executionOptimistic} = event;
@@ -145,7 +107,7 @@ export class BlockObserver {
         return null;
       });
 
-      if (response === null) {
+      if (response === null || signal.aborted) {
         return;
       }
 

package/src/services/builderSigner.ts

@@ -1,7 +1,7 @@
 import {PublicKey, SecretKey} from "@chainsafe/lodestar-z/blst";
 import {BeaconConfig} from "@lodestar/config";
 import {getExecutionPayloadBidSigningRoot, getExecutionPayloadEnvelopeSigningRoot} from "@lodestar/state-transition";
-import {gloas} from "@lodestar/types";
+import {gloas, heze} from "@lodestar/types";
 
 export type Keypair = {publicKey: PublicKey; secretKey: SecretKey};
 
@@ -23,6 +23,8 @@ export class BuilderSigner {
     };
   }
 
+  signExecutionPayloadBid(bid: heze.ExecutionPayloadBid): heze.SignedExecutionPayloadBid;
+  signExecutionPayloadBid(bid: gloas.ExecutionPayloadBid): gloas.SignedExecutionPayloadBid;
   signExecutionPayloadBid(bid: gloas.ExecutionPayloadBid): gloas.SignedExecutionPayloadBid {
     const signingRoot = getExecutionPayloadBidSigningRoot(this.config, bid);
 

package/src/services/executionPayloadBid.ts

@@ -0,0 +1,125 @@
+import {ForkName, type ForkPostGloas, INCLUSION_LIST_COMMITTEE_SIZE, isForkPostHeze} from "@lodestar/params";
+import type {
+  BuilderIndex,
+  Bytes32,
+  ExecutionAddress,
+  ExecutionPayloadBid,
+  Root,
+  RootHex,
+  Slot,
+  gloas,
+  heze,
+} from "@lodestar/types";
+import {sszTypesFor} from "@lodestar/types";
+import {LodestarError, byteArrayEquals, toRootHex} from "@lodestar/utils";
+import type {BuiltPayload} from "./payloadSource.js";
+
+type CommonBidInput<F extends ForkPostGloas> = {
+  slot: Slot;
+  parentBlockRoot: Root;
+  /** Expected value from the BN payload attributes used for this build. */
+  prevRandao: Bytes32;
+  builderIndex: BuilderIndex;
+  feeRecipient: ExecutionAddress;
+  /** Bid value in gwei */
+  value: number;
+  payload: BuiltPayload & {fork: F};
+};
+
+export type GloasBidInput = CommonBidInput<ForkName.gloas>;
+
+export type HezeBidInput = CommonBidInput<ForkName.heze> & {
+  inclusionListBits: heze.ExecutionPayloadBid["inclusionListBits"];
+};
+
+export type ExecutionPayloadBidInput = GloasBidInput | HezeBidInput;
+
+export enum ExecutionPayloadBidErrorCode {
+  INVALID_VALUE = "EXECUTION_PAYLOAD_BID_ERROR_INVALID_VALUE",
+  INVALID_GAS_LIMIT = "EXECUTION_PAYLOAD_BID_ERROR_INVALID_GAS_LIMIT",
+  SLOT_MISMATCH = "EXECUTION_PAYLOAD_BID_ERROR_SLOT_MISMATCH",
+  BLOCK_HASH_EQUALS_PARENT = "EXECUTION_PAYLOAD_BID_ERROR_BLOCK_HASH_EQUALS_PARENT",
+  INVALID_INCLUSION_LIST_BITS = "EXECUTION_PAYLOAD_BID_ERROR_INVALID_INCLUSION_LIST_BITS",
+  PREV_RANDAO_MISMATCH = "EXECUTION_PAYLOAD_BID_ERROR_PREV_RANDAO_MISMATCH",
+}
+
+export type ExecutionPayloadBidErrorType =
+  | {code: ExecutionPayloadBidErrorCode.INVALID_GAS_LIMIT; gasLimit: number}
+  | {code: ExecutionPayloadBidErrorCode.SLOT_MISMATCH; slot: Slot; payloadSlot: Slot}
+  | {code: ExecutionPayloadBidErrorCode.BLOCK_HASH_EQUALS_PARENT}
+  | {code: ExecutionPayloadBidErrorCode.INVALID_INCLUSION_LIST_BITS; bitLen: number | undefined}
+  | {
+      code: ExecutionPayloadBidErrorCode.PREV_RANDAO_MISMATCH;
+      expectedPrevRandao: RootHex;
+      payloadPrevRandao: RootHex;
+    }
+  | {
+      code: ExecutionPayloadBidErrorCode.INVALID_VALUE;
+      value: number;
+    };
+
+export class ExecutionPayloadBidError extends LodestarError<ExecutionPayloadBidErrorType> {}
+
+export function createExecutionPayloadBid(input: GloasBidInput): gloas.ExecutionPayloadBid;
+export function createExecutionPayloadBid(input: HezeBidInput): heze.ExecutionPayloadBid;
+export function createExecutionPayloadBid(input: ExecutionPayloadBidInput): ExecutionPayloadBid;
+export function createExecutionPayloadBid(input: ExecutionPayloadBidInput): ExecutionPayloadBid {
+  if (!Number.isSafeInteger(input.value) || input.value < 0) {
+    throw new ExecutionPayloadBidError(
+      {code: ExecutionPayloadBidErrorCode.INVALID_VALUE, value: input.value},
+      `Invalid bid value value=${input.value}`
+    );
+  }
+
+  const {fork, executionPayload, executionRequests, blobsBundle} = input.payload;
+  if (executionPayload.gasLimit > Number.MAX_SAFE_INTEGER) {
+    throw new ExecutionPayloadBidError({
+      code: ExecutionPayloadBidErrorCode.INVALID_GAS_LIMIT,
+      gasLimit: executionPayload.gasLimit,
+    });
+  }
+  if (executionPayload.slotNumber !== input.slot) {
+    throw new ExecutionPayloadBidError({
+      code: ExecutionPayloadBidErrorCode.SLOT_MISMATCH,
+      slot: input.slot,
+      payloadSlot: executionPayload.slotNumber,
+    });
+  }
+  if (byteArrayEquals(executionPayload.blockHash, executionPayload.parentHash)) {
+    throw new ExecutionPayloadBidError({code: ExecutionPayloadBidErrorCode.BLOCK_HASH_EQUALS_PARENT});
+  }
+  if (!byteArrayEquals(executionPayload.prevRandao, input.prevRandao)) {
+    throw new ExecutionPayloadBidError({
+      code: ExecutionPayloadBidErrorCode.PREV_RANDAO_MISMATCH,
+      expectedPrevRandao: toRootHex(input.prevRandao),
+      payloadPrevRandao: toRootHex(executionPayload.prevRandao),
+    });
+  }
+  const bid: gloas.ExecutionPayloadBid = {
+    parentBlockHash: executionPayload.parentHash,
+    parentBlockRoot: input.parentBlockRoot,
+    blockHash: executionPayload.blockHash,
+    prevRandao: input.prevRandao,
+    feeRecipient: input.feeRecipient,
+    gasLimit: BigInt(executionPayload.gasLimit),
+    builderIndex: input.builderIndex,
+    slot: input.slot,
+    value: input.value,
+    executionPayment: 0n,
+    blobKzgCommitments: blobsBundle.commitments,
+    executionRequestsRoot: sszTypesFor(fork).ExecutionRequests.hashTreeRoot(executionRequests),
+  };
+
+  if (isForkPostHeze(fork)) {
+    const inclusionListBits = "inclusionListBits" in input ? input.inclusionListBits : undefined;
+    if (inclusionListBits?.bitLen !== INCLUSION_LIST_COMMITTEE_SIZE) {
+      throw new ExecutionPayloadBidError({
+        code: ExecutionPayloadBidErrorCode.INVALID_INCLUSION_LIST_BITS,
+        bitLen: inclusionListBits?.bitLen,
+      });
+    }
+    return {...bid, inclusionListBits};
+  }
+
+  return bid;
+}

package/src/services/proposerPreferencesTracker.ts

@@ -1,6 +1,5 @@
-import {ApiClient, routes} from "@lodestar/api";
 import type {RootHex, Slot, gloas} from "@lodestar/types";
-import {Logger, MapDef, toRootHex} from "@lodestar/utils";
+import {MapDef, toRootHex} from "@lodestar/utils";
 
 /** Retains validated proposer preferences by the branch-specific identity used for bid validation. */
 export class ProposerPreferencesTracker {
@@ -8,40 +7,6 @@ export class ProposerPreferencesTracker {
     () => new Map()
   );
 
-  constructor(
-    private readonly api: ApiClient,
-    private readonly logger: Logger
-  ) {}
-
-  start(signal: AbortSignal): void {
-    if (signal.aborted) return;
-
-    this.logger.verbose("Subscribing to proposer preferences");
-    this.api.events
-      .eventstream({
-        topics: [routes.events.EventType.proposerPreferences],
-        signal,
-        onEvent: (event) => {
-          if (!signal.aborted && event.type === routes.events.EventType.proposerPreferences) {
-            this.onProposerPreferences(event.message.data);
-          }
-        },
-        onError: (error) => {
-          if (!signal.aborted) this.logger.error("Failed to receive proposer preferences", {}, error);
-        },
-        onClose: () => {
-          if (signal.aborted) {
-            this.logger.verbose("Closed proposer preferences stream");
-          } else {
-            this.logger.error("Proposer preferences stream closed unexpectedly", {});
-          }
-        },
-      })
-      .catch((error: Error) => {
-        if (!signal.aborted) this.logger.error("Failed to subscribe to proposer preferences", {}, error);
-      });
-  }
-
   onProposerPreferences(signedProposerPreferences: gloas.SignedProposerPreferences): boolean {
     const {proposalSlot, dependentRoot} = signedProposerPreferences.message;
     const dependentRootHex = toRootHex(dependentRoot);