@lodestar/builder 1.50.0-dev.033e6b7138 → 1.50.0-dev.1f129c79a1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (45) hide show
  1. package/lib/builder.d.ts +2 -0
  2. package/lib/builder.d.ts.map +1 -1
  3. package/lib/builder.js +56 -4
  4. package/lib/builder.js.map +1 -1
  5. package/lib/services/bidLedger.d.ts +7 -0
  6. package/lib/services/bidLedger.d.ts.map +1 -1
  7. package/lib/services/bidLedger.js +15 -10
  8. package/lib/services/bidLedger.js.map +1 -1
  9. package/lib/services/bidPublisher.d.ts +43 -0
  10. package/lib/services/bidPublisher.d.ts.map +1 -0
  11. package/lib/services/bidPublisher.js +50 -0
  12. package/lib/services/bidPublisher.js.map +1 -0
  13. package/lib/services/bidSelector.d.ts +67 -0
  14. package/lib/services/bidSelector.d.ts.map +1 -0
  15. package/lib/services/bidSelector.js +59 -0
  16. package/lib/services/bidSelector.js.map +1 -0
  17. package/lib/services/blockObserver.d.ts +1 -2
  18. package/lib/services/blockObserver.d.ts.map +1 -1
  19. package/lib/services/blockObserver.js +3 -35
  20. package/lib/services/blockObserver.js.map +1 -1
  21. package/lib/services/builderSigner.d.ts +2 -1
  22. package/lib/services/builderSigner.d.ts.map +1 -1
  23. package/lib/services/builderSigner.js.map +1 -1
  24. package/lib/services/executionPayloadBid.d.ts +57 -0
  25. package/lib/services/executionPayloadBid.d.ts.map +1 -0
  26. package/lib/services/executionPayloadBid.js +69 -0
  27. package/lib/services/executionPayloadBid.js.map +1 -0
  28. package/lib/services/executionPayloadEnvelope.d.ts +55 -0
  29. package/lib/services/executionPayloadEnvelope.d.ts.map +1 -0
  30. package/lib/services/executionPayloadEnvelope.js +79 -0
  31. package/lib/services/executionPayloadEnvelope.js.map +1 -0
  32. package/lib/services/proposerPreferencesTracker.d.ts +0 -6
  33. package/lib/services/proposerPreferencesTracker.d.ts.map +1 -1
  34. package/lib/services/proposerPreferencesTracker.js +0 -38
  35. package/lib/services/proposerPreferencesTracker.js.map +1 -1
  36. package/package.json +10 -10
  37. package/src/builder.ts +63 -5
  38. package/src/services/bidLedger.ts +28 -14
  39. package/src/services/bidPublisher.ts +95 -0
  40. package/src/services/bidSelector.ts +138 -0
  41. package/src/services/blockObserver.ts +3 -41
  42. package/src/services/builderSigner.ts +3 -1
  43. package/src/services/executionPayloadBid.ts +125 -0
  44. package/src/services/executionPayloadEnvelope.ts +156 -0
  45. package/src/services/proposerPreferencesTracker.ts +1 -36
@@ -32,6 +32,7 @@ type MutableBidLedgerRecord = SubmittedBid & {
32
32
  export enum BidLedgerErrorCode {
33
33
  INVALID_BID_VALUE = "BID_LEDGER_ERROR_INVALID_BID_VALUE",
34
34
  DUPLICATE_BID = "BID_LEDGER_ERROR_DUPLICATE_BID",
35
+ BID_TOO_OLD = "BID_LEDGER_ERROR_BID_TOO_OLD",
35
36
  REVEAL_CONFLICT = "BID_LEDGER_ERROR_REVEAL_CONFLICT",
36
37
  UNSETTLED_VALUE_OVERFLOW = "BID_LEDGER_ERROR_UNSETTLED_VALUE_OVERFLOW",
37
38
  }
@@ -47,6 +48,11 @@ export type BidLedgerErrorType =
47
48
  parentBlockHash: RootHex;
48
49
  parentBlockRoot: RootHex;
49
50
  }
51
+ | {
52
+ code: BidLedgerErrorCode.BID_TOO_OLD;
53
+ slot: Slot;
54
+ pruneCutoffSlot: Slot;
55
+ }
50
56
  | {
51
57
  code: BidLedgerErrorCode.REVEAL_CONFLICT;
52
58
  blockRoot: RootHex;
@@ -69,11 +75,28 @@ const KEEP_SLOTS = RECORD_RETENTION_EPOCHS * SLOTS_PER_EPOCH;
69
75
  export class BidLedger {
70
76
  private readonly bidsBySlot = new Map<Slot, Map<string, MutableBidLedgerRecord>>();
71
77
  private readonly revealedPayloadByBlockRoot = new Map<RootHex, RevealedPayload>();
78
+ private pruneCutoffSlot = 0;
72
79
 
73
80
  hasSubmitted(slot: Slot, parentBlockHash: RootHex, parentBlockRoot: RootHex): boolean {
74
81
  return this.bidsBySlot.get(slot)?.has(tupleKey(parentBlockHash, parentBlockRoot)) ?? false;
75
82
  }
76
83
 
84
+ assertCanRecordBid({
85
+ slot,
86
+ parentBlockHash,
87
+ parentBlockRoot,
88
+ }: Pick<SubmittedBid, "slot" | "parentBlockHash" | "parentBlockRoot">): void {
89
+ if (slot < this.pruneCutoffSlot) {
90
+ throw new BidLedgerError({code: BidLedgerErrorCode.BID_TOO_OLD, slot, pruneCutoffSlot: this.pruneCutoffSlot});
91
+ }
92
+ if (this.hasSubmitted(slot, parentBlockHash, parentBlockRoot)) {
93
+ throw new BidLedgerError(
94
+ {code: BidLedgerErrorCode.DUPLICATE_BID, slot, parentBlockHash, parentBlockRoot},
95
+ `Bid already recorded slot=${slot} parentBlockHash=${parentBlockHash} parentBlockRoot=${parentBlockRoot}`
96
+ );
97
+ }
98
+ }
99
+
77
100
  recordBid(bid: SubmittedBid): BidLedgerRecord {
78
101
  if (!Number.isSafeInteger(bid.valueGwei) || bid.valueGwei < 0) {
79
102
  throw new BidLedgerError(
@@ -82,6 +105,7 @@ export class BidLedger {
82
105
  );
83
106
  }
84
107
 
108
+ this.assertCanRecordBid(bid);
85
109
  let bidsForSlot = this.bidsBySlot.get(bid.slot);
86
110
  if (bidsForSlot === undefined) {
87
111
  bidsForSlot = new Map();
@@ -89,18 +113,6 @@ export class BidLedger {
89
113
  }
90
114
 
91
115
  const key = tupleKey(bid.parentBlockHash, bid.parentBlockRoot);
92
- if (bidsForSlot.has(key)) {
93
- throw new BidLedgerError(
94
- {
95
- code: BidLedgerErrorCode.DUPLICATE_BID,
96
- slot: bid.slot,
97
- parentBlockHash: bid.parentBlockHash,
98
- parentBlockRoot: bid.parentBlockRoot,
99
- },
100
- `Bid already recorded slot=${bid.slot} parentBlockHash=${bid.parentBlockHash} parentBlockRoot=${bid.parentBlockRoot}`
101
- );
102
- }
103
-
104
116
  const record = {...bid, wonBlockRoots: new Set<RootHex>(), paymentSettled: false};
105
117
  bidsForSlot.set(key, record);
106
118
  return toRecord(record);
@@ -198,9 +210,11 @@ export class BidLedger {
198
210
  }
199
211
 
200
212
  prune(currentSlot: Slot): number {
213
+ // Pruning must not make an expired slot eligible for another submission.
214
+ this.pruneCutoffSlot = Math.max(this.pruneCutoffSlot, currentSlot - KEEP_SLOTS);
201
215
  let removed = 0;
202
216
  for (const [slot, bidsForSlot] of this.bidsBySlot) {
203
- if (slot >= currentSlot - KEEP_SLOTS) {
217
+ if (slot >= this.pruneCutoffSlot) {
204
218
  continue;
205
219
  }
206
220
 
@@ -216,7 +230,7 @@ export class BidLedger {
216
230
  }
217
231
 
218
232
  for (const [blockRoot, revealedPayload] of this.revealedPayloadByBlockRoot) {
219
- if (revealedPayload.slot < currentSlot - KEEP_SLOTS) {
233
+ if (revealedPayload.slot < this.pruneCutoffSlot) {
220
234
  this.revealedPayloadByBlockRoot.delete(blockRoot);
221
235
  }
222
236
  }
@@ -0,0 +1,95 @@
1
+ import type {ApiClient} from "@lodestar/api";
2
+ import type {ChainForkConfig} from "@lodestar/config";
3
+ import {isForkPostGloas} from "@lodestar/params";
4
+ import type {BuilderIndex, RootHex, Slot, gloas, heze} from "@lodestar/types";
5
+ import {sszTypesFor} from "@lodestar/types";
6
+ import {LodestarError, toRootHex} from "@lodestar/utils";
7
+ import type {BidIdentity, BidLedger} from "./bidLedger.js";
8
+ import type {BuilderSigner} from "./builderSigner.js";
9
+
10
+ export type BidPublisherModules = {
11
+ api: ApiClient;
12
+ config: ChainForkConfig;
13
+ signer: BuilderSigner;
14
+ ledger: BidLedger;
15
+ builderIndex: BuilderIndex;
16
+ hasPayload: (identity: BidIdentity) => boolean;
17
+ };
18
+
19
+ export enum BidPublisherErrorCode {
20
+ BUILDER_INDEX_MISMATCH = "BID_PUBLISHER_ERROR_BUILDER_INDEX_MISMATCH",
21
+ PAYLOAD_NOT_RETAINED = "BID_PUBLISHER_ERROR_PAYLOAD_NOT_RETAINED",
22
+ PRE_GLOAS_BID = "BID_PUBLISHER_ERROR_PRE_GLOAS_BID",
23
+ }
24
+
25
+ export type BidPublisherErrorType =
26
+ | {
27
+ code: BidPublisherErrorCode.PRE_GLOAS_BID;
28
+ slot: Slot;
29
+ }
30
+ | {
31
+ code: BidPublisherErrorCode.BUILDER_INDEX_MISMATCH;
32
+ builderIndex: BuilderIndex;
33
+ bidBuilderIndex: BuilderIndex;
34
+ }
35
+ | {
36
+ code: BidPublisherErrorCode.PAYLOAD_NOT_RETAINED;
37
+ slot: Slot;
38
+ parentBlockHash: RootHex;
39
+ parentBlockRoot: RootHex;
40
+ blockHash: RootHex;
41
+ };
42
+
43
+ export class BidPublisherError extends LodestarError<BidPublisherErrorType> {}
44
+
45
+ /** Signs and submits a bid only if its payload is retained locally. */
46
+ export class BidPublisher {
47
+ constructor(private readonly modules: BidPublisherModules) {}
48
+
49
+ publish(bid: heze.ExecutionPayloadBid, signal: AbortSignal): Promise<heze.SignedExecutionPayloadBid>;
50
+ publish(bid: gloas.ExecutionPayloadBid, signal: AbortSignal): Promise<gloas.SignedExecutionPayloadBid>;
51
+ async publish(bid: gloas.ExecutionPayloadBid, signal: AbortSignal): Promise<gloas.SignedExecutionPayloadBid> {
52
+ signal.throwIfAborted();
53
+
54
+ const {api, config, builderIndex, hasPayload, ledger, signer} = this.modules;
55
+ const fork = config.getForkName(bid.slot);
56
+ if (!isForkPostGloas(fork)) {
57
+ throw new BidPublisherError({code: BidPublisherErrorCode.PRE_GLOAS_BID, slot: bid.slot});
58
+ }
59
+ if (bid.builderIndex !== builderIndex) {
60
+ throw new BidPublisherError(
61
+ {
62
+ code: BidPublisherErrorCode.BUILDER_INDEX_MISMATCH,
63
+ builderIndex,
64
+ bidBuilderIndex: bid.builderIndex,
65
+ },
66
+ `Bid builder index does not match local builder index builderIndex=${builderIndex} bidBuilderIndex=${bid.builderIndex}`
67
+ );
68
+ }
69
+
70
+ const identity: BidIdentity = {
71
+ slot: bid.slot,
72
+ parentBlockHash: toRootHex(bid.parentBlockHash),
73
+ parentBlockRoot: toRootHex(bid.parentBlockRoot),
74
+ blockHash: toRootHex(bid.blockHash),
75
+ };
76
+ if (!hasPayload(identity)) {
77
+ throw new BidPublisherError(
78
+ {code: BidPublisherErrorCode.PAYLOAD_NOT_RETAINED, ...identity},
79
+ `Bid payload is not retained slot=${identity.slot} parentBlockHash=${identity.parentBlockHash} parentBlockRoot=${identity.parentBlockRoot} blockHash=${identity.blockHash}`
80
+ );
81
+ }
82
+
83
+ ledger.assertCanRecordBid(identity);
84
+
85
+ const signedExecutionPayloadBid = signer.signExecutionPayloadBid(bid);
86
+ const signedBidRoot = toRootHex(
87
+ sszTypesFor(fork, "SignedExecutionPayloadBid").hashTreeRoot(signedExecutionPayloadBid)
88
+ );
89
+ ledger.recordBid({...identity, valueGwei: bid.value, signedBidRoot});
90
+
91
+ const response = await api.beacon.publishExecutionPayloadBid({signedExecutionPayloadBid}, {signal});
92
+ response.assertOk();
93
+ return signedExecutionPayloadBid;
94
+ }
95
+ }
@@ -0,0 +1,138 @@
1
+ import type {ChainForkConfig} from "@lodestar/config";
2
+ import type {ForkPostGloas} from "@lodestar/params";
3
+ import type {BuilderIndex, RootHex, SignedBeaconBlock, Slot} from "@lodestar/types";
4
+ import {sszTypesFor} from "@lodestar/types";
5
+ import {LodestarError, toRootHex} from "@lodestar/utils";
6
+ import type {BidIdentity, BidLedger, BidLedgerRecord} from "./bidLedger.js";
7
+
8
+ export type ObservedPostGloasBlock = {
9
+ blockRoot: RootHex;
10
+ slot: Slot;
11
+ version: ForkPostGloas;
12
+ block: SignedBeaconBlock<ForkPostGloas>;
13
+ };
14
+
15
+ export type BidSelectorModules = {
16
+ config: ChainForkConfig;
17
+ ledger: BidLedger;
18
+ builderIndex: BuilderIndex;
19
+ };
20
+
21
+ export enum BidSelectionIgnoreReason {
22
+ FOREIGN_BUILDER = "foreign_builder",
23
+ }
24
+
25
+ export type BidSelectionResult =
26
+ | {
27
+ status: "selected";
28
+ blockRoot: RootHex;
29
+ bid: BidLedgerRecord;
30
+ }
31
+ | {
32
+ status: "ignored";
33
+ reason: BidSelectionIgnoreReason;
34
+ };
35
+
36
+ export enum BidSelectorErrorCode {
37
+ BLOCK_ROOT_MISMATCH = "BID_SELECTOR_ERROR_BLOCK_ROOT_MISMATCH",
38
+ BLOCK_SLOT_MISMATCH = "BID_SELECTOR_ERROR_BLOCK_SLOT_MISMATCH",
39
+ BLOCK_FORK_MISMATCH = "BID_SELECTOR_ERROR_BLOCK_FORK_MISMATCH",
40
+ BID_SLOT_MISMATCH = "BID_SELECTOR_ERROR_BID_SLOT_MISMATCH",
41
+ UNKNOWN_BID = "BID_SELECTOR_ERROR_UNKNOWN_BID",
42
+ }
43
+
44
+ export type BidSelectorErrorType =
45
+ | {
46
+ code: BidSelectorErrorCode.BLOCK_ROOT_MISMATCH;
47
+ blockRoot: RootHex;
48
+ computedBlockRoot: RootHex;
49
+ }
50
+ | {
51
+ code: BidSelectorErrorCode.BLOCK_SLOT_MISMATCH;
52
+ slot: Slot;
53
+ blockSlot: Slot;
54
+ }
55
+ | {
56
+ code: BidSelectorErrorCode.BLOCK_FORK_MISMATCH;
57
+ version: ForkPostGloas;
58
+ blockFork: string;
59
+ }
60
+ | {
61
+ code: BidSelectorErrorCode.BID_SLOT_MISMATCH;
62
+ slot: Slot;
63
+ bidSlot: Slot;
64
+ }
65
+ | {
66
+ code: BidSelectorErrorCode.UNKNOWN_BID;
67
+ slot: Slot;
68
+ parentBlockHash: RootHex;
69
+ parentBlockRoot: RootHex;
70
+ blockHash: RootHex;
71
+ signedBidRoot: RootHex;
72
+ };
73
+
74
+ export class BidSelectorError extends LodestarError<BidSelectorErrorType> {}
75
+
76
+ /** Matches an imported post-Gloas block to an exact local bid and records the win. */
77
+ export class BidSelector {
78
+ constructor(private readonly modules: BidSelectorModules) {}
79
+
80
+ match(observed: ObservedPostGloasBlock): BidSelectionResult {
81
+ const {block, blockRoot, slot, version} = observed;
82
+ const {builderIndex, config, ledger} = this.modules;
83
+ const blockSlot = block.message.slot;
84
+
85
+ if (blockSlot !== slot) {
86
+ throw new BidSelectorError(
87
+ {code: BidSelectorErrorCode.BLOCK_SLOT_MISMATCH, slot, blockSlot},
88
+ `Observed block slot does not match fetched block slot=${slot} blockSlot=${blockSlot}`
89
+ );
90
+ }
91
+
92
+ const blockFork = config.getForkName(slot);
93
+ if (blockFork !== version) {
94
+ throw new BidSelectorError(
95
+ {code: BidSelectorErrorCode.BLOCK_FORK_MISMATCH, version, blockFork},
96
+ `Observed block fork does not match configured fork version=${version} blockFork=${blockFork}`
97
+ );
98
+ }
99
+
100
+ const computedBlockRoot = toRootHex(config.getForkTypes(slot).BeaconBlock.hashTreeRoot(block.message));
101
+ if (computedBlockRoot !== blockRoot) {
102
+ throw new BidSelectorError(
103
+ {code: BidSelectorErrorCode.BLOCK_ROOT_MISMATCH, blockRoot, computedBlockRoot},
104
+ `Observed block root does not match fetched block blockRoot=${blockRoot} computedBlockRoot=${computedBlockRoot}`
105
+ );
106
+ }
107
+
108
+ const bid = block.message.body.signedExecutionPayloadBid.message;
109
+ if (bid.slot !== slot) {
110
+ throw new BidSelectorError(
111
+ {code: BidSelectorErrorCode.BID_SLOT_MISMATCH, slot, bidSlot: bid.slot},
112
+ `Selected bid slot does not match block slot=${slot} bidSlot=${bid.slot}`
113
+ );
114
+ }
115
+ if (bid.builderIndex !== builderIndex) {
116
+ return {status: "ignored", reason: BidSelectionIgnoreReason.FOREIGN_BUILDER};
117
+ }
118
+
119
+ const identity: BidIdentity = {
120
+ slot,
121
+ parentBlockHash: toRootHex(bid.parentBlockHash),
122
+ parentBlockRoot: toRootHex(bid.parentBlockRoot),
123
+ blockHash: toRootHex(bid.blockHash),
124
+ };
125
+ const signedBidRoot = toRootHex(
126
+ sszTypesFor(version, "SignedExecutionPayloadBid").hashTreeRoot(block.message.body.signedExecutionPayloadBid)
127
+ );
128
+ const localBid = ledger.recordWin({...identity, signedBidRoot}, blockRoot);
129
+ if (localBid === null) {
130
+ throw new BidSelectorError(
131
+ {code: BidSelectorErrorCode.UNKNOWN_BID, ...identity, signedBidRoot},
132
+ `Selected bid is not in the local ledger slot=${slot} blockHash=${identity.blockHash} signedBidRoot=${signedBidRoot}`
133
+ );
134
+ }
135
+
136
+ return {status: "selected", blockRoot, bid: localBid};
137
+ }
138
+ }
@@ -47,55 +47,17 @@ export class BlockObserver {
47
47
  this.retries = retries;
48
48
  this.retryDelay = retryDelay;
49
49
  this.maxSeenBlockRoots = maxSeenBlockRoots;
50
+ this.logger.info("Block observer initialized", {retries, retryDelay, maxSeenBlockRoots});
50
51
  }
51
52
 
52
53
  /**
53
- * Register a block consumer. Consumers that require complete observation must register before {@link start}, because
54
+ * Register a block consumer. Consumers that require complete observation must register before event delivery, because
54
55
  * roots observed before registration remain consumed until normal FIFO eviction.
55
56
  */
56
57
  runOnBlock(fn: RunOnBlockFn): void {
57
58
  this.fns.push(fn);
58
59
  }
59
60
 
60
- start(signal: AbortSignal): void {
61
- this.logger.info("Subscribing to block events", {
62
- retries: this.retries,
63
- retryDelay: this.retryDelay,
64
- maxSeenBlockRoots: this.maxSeenBlockRoots,
65
- });
66
-
67
- this.api.events
68
- .eventstream({
69
- topics: [EventType.block],
70
- signal,
71
- onEvent: (event) => {
72
- if (event.type !== EventType.block) {
73
- this.logger.debug("Ignoring unexpected beacon event", {eventType: event.type});
74
- return;
75
- }
76
-
77
- void this.processBlockEvent(event.message, signal);
78
- },
79
- onError: (error) => {
80
- this.logger.error("Failed to receive block event", {}, error);
81
- },
82
- onClose: () => {
83
- if (signal.aborted) {
84
- this.logger.debug("Closed stream for block events");
85
- } else {
86
- this.logger.error("Block event stream closed unexpectedly", {});
87
- }
88
- },
89
- })
90
- .catch((error: unknown) => {
91
- this.logger.error(
92
- "Failed to subscribe to block events",
93
- {},
94
- error instanceof Error ? error : Error(String(error))
95
- );
96
- });
97
- }
98
-
99
61
  async processBlockEvent(event: BlockEvent, signal: AbortSignal): Promise<void> {
100
62
  try {
101
63
  const {slot, block: blockRoot, executionOptimistic} = event;
@@ -145,7 +107,7 @@ export class BlockObserver {
145
107
  return null;
146
108
  });
147
109
 
148
- if (response === null) {
110
+ if (response === null || signal.aborted) {
149
111
  return;
150
112
  }
151
113
 
@@ -1,7 +1,7 @@
1
1
  import {PublicKey, SecretKey} from "@chainsafe/lodestar-z/blst";
2
2
  import {BeaconConfig} from "@lodestar/config";
3
3
  import {getExecutionPayloadBidSigningRoot, getExecutionPayloadEnvelopeSigningRoot} from "@lodestar/state-transition";
4
- import {gloas} from "@lodestar/types";
4
+ import {gloas, heze} from "@lodestar/types";
5
5
 
6
6
  export type Keypair = {publicKey: PublicKey; secretKey: SecretKey};
7
7
 
@@ -23,6 +23,8 @@ export class BuilderSigner {
23
23
  };
24
24
  }
25
25
 
26
+ signExecutionPayloadBid(bid: heze.ExecutionPayloadBid): heze.SignedExecutionPayloadBid;
27
+ signExecutionPayloadBid(bid: gloas.ExecutionPayloadBid): gloas.SignedExecutionPayloadBid;
26
28
  signExecutionPayloadBid(bid: gloas.ExecutionPayloadBid): gloas.SignedExecutionPayloadBid {
27
29
  const signingRoot = getExecutionPayloadBidSigningRoot(this.config, bid);
28
30
 
@@ -0,0 +1,125 @@
1
+ import {ForkName, type ForkPostGloas, INCLUSION_LIST_COMMITTEE_SIZE, isForkPostHeze} from "@lodestar/params";
2
+ import type {
3
+ BuilderIndex,
4
+ Bytes32,
5
+ ExecutionAddress,
6
+ ExecutionPayloadBid,
7
+ Root,
8
+ RootHex,
9
+ Slot,
10
+ gloas,
11
+ heze,
12
+ } from "@lodestar/types";
13
+ import {sszTypesFor} from "@lodestar/types";
14
+ import {LodestarError, byteArrayEquals, toRootHex} from "@lodestar/utils";
15
+ import type {BuiltPayload} from "./payloadSource.js";
16
+
17
+ type CommonBidInput<F extends ForkPostGloas> = {
18
+ slot: Slot;
19
+ parentBlockRoot: Root;
20
+ /** Expected value from the BN payload attributes used for this build. */
21
+ prevRandao: Bytes32;
22
+ builderIndex: BuilderIndex;
23
+ feeRecipient: ExecutionAddress;
24
+ /** Bid value in gwei */
25
+ value: number;
26
+ payload: BuiltPayload & {fork: F};
27
+ };
28
+
29
+ export type GloasBidInput = CommonBidInput<ForkName.gloas>;
30
+
31
+ export type HezeBidInput = CommonBidInput<ForkName.heze> & {
32
+ inclusionListBits: heze.ExecutionPayloadBid["inclusionListBits"];
33
+ };
34
+
35
+ export type ExecutionPayloadBidInput = GloasBidInput | HezeBidInput;
36
+
37
+ export enum ExecutionPayloadBidErrorCode {
38
+ INVALID_VALUE = "EXECUTION_PAYLOAD_BID_ERROR_INVALID_VALUE",
39
+ INVALID_GAS_LIMIT = "EXECUTION_PAYLOAD_BID_ERROR_INVALID_GAS_LIMIT",
40
+ SLOT_MISMATCH = "EXECUTION_PAYLOAD_BID_ERROR_SLOT_MISMATCH",
41
+ BLOCK_HASH_EQUALS_PARENT = "EXECUTION_PAYLOAD_BID_ERROR_BLOCK_HASH_EQUALS_PARENT",
42
+ INVALID_INCLUSION_LIST_BITS = "EXECUTION_PAYLOAD_BID_ERROR_INVALID_INCLUSION_LIST_BITS",
43
+ PREV_RANDAO_MISMATCH = "EXECUTION_PAYLOAD_BID_ERROR_PREV_RANDAO_MISMATCH",
44
+ }
45
+
46
+ export type ExecutionPayloadBidErrorType =
47
+ | {code: ExecutionPayloadBidErrorCode.INVALID_GAS_LIMIT; gasLimit: number}
48
+ | {code: ExecutionPayloadBidErrorCode.SLOT_MISMATCH; slot: Slot; payloadSlot: Slot}
49
+ | {code: ExecutionPayloadBidErrorCode.BLOCK_HASH_EQUALS_PARENT}
50
+ | {code: ExecutionPayloadBidErrorCode.INVALID_INCLUSION_LIST_BITS; bitLen: number | undefined}
51
+ | {
52
+ code: ExecutionPayloadBidErrorCode.PREV_RANDAO_MISMATCH;
53
+ expectedPrevRandao: RootHex;
54
+ payloadPrevRandao: RootHex;
55
+ }
56
+ | {
57
+ code: ExecutionPayloadBidErrorCode.INVALID_VALUE;
58
+ value: number;
59
+ };
60
+
61
+ export class ExecutionPayloadBidError extends LodestarError<ExecutionPayloadBidErrorType> {}
62
+
63
+ export function createExecutionPayloadBid(input: GloasBidInput): gloas.ExecutionPayloadBid;
64
+ export function createExecutionPayloadBid(input: HezeBidInput): heze.ExecutionPayloadBid;
65
+ export function createExecutionPayloadBid(input: ExecutionPayloadBidInput): ExecutionPayloadBid;
66
+ export function createExecutionPayloadBid(input: ExecutionPayloadBidInput): ExecutionPayloadBid {
67
+ if (!Number.isSafeInteger(input.value) || input.value < 0) {
68
+ throw new ExecutionPayloadBidError(
69
+ {code: ExecutionPayloadBidErrorCode.INVALID_VALUE, value: input.value},
70
+ `Invalid bid value value=${input.value}`
71
+ );
72
+ }
73
+
74
+ const {fork, executionPayload, executionRequests, blobsBundle} = input.payload;
75
+ if (executionPayload.gasLimit > Number.MAX_SAFE_INTEGER) {
76
+ throw new ExecutionPayloadBidError({
77
+ code: ExecutionPayloadBidErrorCode.INVALID_GAS_LIMIT,
78
+ gasLimit: executionPayload.gasLimit,
79
+ });
80
+ }
81
+ if (executionPayload.slotNumber !== input.slot) {
82
+ throw new ExecutionPayloadBidError({
83
+ code: ExecutionPayloadBidErrorCode.SLOT_MISMATCH,
84
+ slot: input.slot,
85
+ payloadSlot: executionPayload.slotNumber,
86
+ });
87
+ }
88
+ if (byteArrayEquals(executionPayload.blockHash, executionPayload.parentHash)) {
89
+ throw new ExecutionPayloadBidError({code: ExecutionPayloadBidErrorCode.BLOCK_HASH_EQUALS_PARENT});
90
+ }
91
+ if (!byteArrayEquals(executionPayload.prevRandao, input.prevRandao)) {
92
+ throw new ExecutionPayloadBidError({
93
+ code: ExecutionPayloadBidErrorCode.PREV_RANDAO_MISMATCH,
94
+ expectedPrevRandao: toRootHex(input.prevRandao),
95
+ payloadPrevRandao: toRootHex(executionPayload.prevRandao),
96
+ });
97
+ }
98
+ const bid: gloas.ExecutionPayloadBid = {
99
+ parentBlockHash: executionPayload.parentHash,
100
+ parentBlockRoot: input.parentBlockRoot,
101
+ blockHash: executionPayload.blockHash,
102
+ prevRandao: input.prevRandao,
103
+ feeRecipient: input.feeRecipient,
104
+ gasLimit: BigInt(executionPayload.gasLimit),
105
+ builderIndex: input.builderIndex,
106
+ slot: input.slot,
107
+ value: input.value,
108
+ executionPayment: 0n,
109
+ blobKzgCommitments: blobsBundle.commitments,
110
+ executionRequestsRoot: sszTypesFor(fork).ExecutionRequests.hashTreeRoot(executionRequests),
111
+ };
112
+
113
+ if (isForkPostHeze(fork)) {
114
+ const inclusionListBits = "inclusionListBits" in input ? input.inclusionListBits : undefined;
115
+ if (inclusionListBits?.bitLen !== INCLUSION_LIST_COMMITTEE_SIZE) {
116
+ throw new ExecutionPayloadBidError({
117
+ code: ExecutionPayloadBidErrorCode.INVALID_INCLUSION_LIST_BITS,
118
+ bitLen: inclusionListBits?.bitLen,
119
+ });
120
+ }
121
+ return {...bid, inclusionListBits};
122
+ }
123
+
124
+ return bid;
125
+ }
@@ -0,0 +1,156 @@
1
+ import type {BuilderIndex, RootHex, Slot, deneb, gloas} from "@lodestar/types";
2
+ import {ssz} from "@lodestar/types";
3
+ import {LodestarError, byteArrayEquals, fromHex, toRootHex} from "@lodestar/utils";
4
+ import type {StoredPayload} from "./payloadStore.js";
5
+
6
+ export type ExecutionPayloadEnvelopeInput = {
7
+ blockRoot: RootHex;
8
+ builderIndex: BuilderIndex;
9
+ selectedBid: gloas.ExecutionPayloadBid;
10
+ storedPayload: StoredPayload;
11
+ };
12
+
13
+ export type ExecutionPayloadEnvelopeContents = {
14
+ envelope: gloas.ExecutionPayloadEnvelope;
15
+ kzgProofs: deneb.KZGProofs;
16
+ blobs: deneb.Blobs;
17
+ };
18
+
19
+ export enum ExecutionPayloadEnvelopeErrorCode {
20
+ SLOT_MISMATCH = "EXECUTION_PAYLOAD_ENVELOPE_ERROR_SLOT_MISMATCH",
21
+ PARENT_BLOCK_ROOT_MISMATCH = "EXECUTION_PAYLOAD_ENVELOPE_ERROR_PARENT_BLOCK_ROOT_MISMATCH",
22
+ PARENT_BLOCK_HASH_MISMATCH = "EXECUTION_PAYLOAD_ENVELOPE_ERROR_PARENT_BLOCK_HASH_MISMATCH",
23
+ BLOCK_HASH_MISMATCH = "EXECUTION_PAYLOAD_ENVELOPE_ERROR_BLOCK_HASH_MISMATCH",
24
+ BUILDER_INDEX_MISMATCH = "EXECUTION_PAYLOAD_ENVELOPE_ERROR_BUILDER_INDEX_MISMATCH",
25
+ BLOB_KZG_COMMITMENTS_MISMATCH = "EXECUTION_PAYLOAD_ENVELOPE_ERROR_BLOB_KZG_COMMITMENTS_MISMATCH",
26
+ EXECUTION_REQUESTS_ROOT_MISMATCH = "EXECUTION_PAYLOAD_ENVELOPE_ERROR_EXECUTION_REQUESTS_ROOT_MISMATCH",
27
+ }
28
+
29
+ export type ExecutionPayloadEnvelopeErrorType =
30
+ | {
31
+ code: ExecutionPayloadEnvelopeErrorCode.BUILDER_INDEX_MISMATCH;
32
+ builderIndex: BuilderIndex;
33
+ bidBuilderIndex: BuilderIndex;
34
+ }
35
+ | {code: ExecutionPayloadEnvelopeErrorCode.BLOB_KZG_COMMITMENTS_MISMATCH}
36
+ | {
37
+ code: ExecutionPayloadEnvelopeErrorCode.EXECUTION_REQUESTS_ROOT_MISMATCH;
38
+ bidExecutionRequestsRoot: RootHex;
39
+ payloadExecutionRequestsRoot: RootHex;
40
+ }
41
+ | {
42
+ code: ExecutionPayloadEnvelopeErrorCode.PARENT_BLOCK_ROOT_MISMATCH;
43
+ bidParentBlockRoot: RootHex;
44
+ storedParentBlockRoot: RootHex;
45
+ }
46
+ | {
47
+ code: ExecutionPayloadEnvelopeErrorCode.SLOT_MISMATCH;
48
+ bidSlot: Slot;
49
+ payloadSlot: Slot;
50
+ }
51
+ | {
52
+ code: ExecutionPayloadEnvelopeErrorCode.PARENT_BLOCK_HASH_MISMATCH;
53
+ bidParentBlockHash: RootHex;
54
+ payloadParentBlockHash: RootHex;
55
+ }
56
+ | {
57
+ code: ExecutionPayloadEnvelopeErrorCode.BLOCK_HASH_MISMATCH;
58
+ bidBlockHash: RootHex;
59
+ payloadBlockHash: RootHex;
60
+ };
61
+
62
+ export class ExecutionPayloadEnvelopeError extends LodestarError<ExecutionPayloadEnvelopeErrorType> {}
63
+
64
+ /** The caller must have matched the selected bid to its local ledger record. */
65
+ export function createExecutionPayloadEnvelopeContents({
66
+ blockRoot,
67
+ builderIndex,
68
+ selectedBid,
69
+ storedPayload,
70
+ }: ExecutionPayloadEnvelopeInput): ExecutionPayloadEnvelopeContents {
71
+ if (builderIndex !== selectedBid.builderIndex) {
72
+ throw new ExecutionPayloadEnvelopeError({
73
+ code: ExecutionPayloadEnvelopeErrorCode.BUILDER_INDEX_MISMATCH,
74
+ builderIndex,
75
+ bidBuilderIndex: selectedBid.builderIndex,
76
+ });
77
+ }
78
+
79
+ const bidParentBlockRoot = toRootHex(selectedBid.parentBlockRoot);
80
+ const storedParentBlockRoot = toRootHex(storedPayload.parentBlockRoot);
81
+ if (storedParentBlockRoot !== bidParentBlockRoot) {
82
+ throw new ExecutionPayloadEnvelopeError(
83
+ {
84
+ code: ExecutionPayloadEnvelopeErrorCode.PARENT_BLOCK_ROOT_MISMATCH,
85
+ bidParentBlockRoot,
86
+ storedParentBlockRoot,
87
+ },
88
+ `Selected bid beacon parent does not match retained payload bidParentBlockRoot=${bidParentBlockRoot} storedParentBlockRoot=${storedParentBlockRoot}`
89
+ );
90
+ }
91
+
92
+ const {payload} = storedPayload;
93
+ const payloadSlot = payload.executionPayload.slotNumber;
94
+ if (payloadSlot !== selectedBid.slot) {
95
+ throw new ExecutionPayloadEnvelopeError(
96
+ {code: ExecutionPayloadEnvelopeErrorCode.SLOT_MISMATCH, bidSlot: selectedBid.slot, payloadSlot},
97
+ `Selected bid slot does not match payload slot bidSlot=${selectedBid.slot} payloadSlot=${payloadSlot}`
98
+ );
99
+ }
100
+
101
+ const payloadParentBlockHash = toRootHex(payload.executionPayload.parentHash);
102
+ const bidParentBlockHash = toRootHex(selectedBid.parentBlockHash);
103
+ if (payloadParentBlockHash !== bidParentBlockHash) {
104
+ throw new ExecutionPayloadEnvelopeError(
105
+ {
106
+ code: ExecutionPayloadEnvelopeErrorCode.PARENT_BLOCK_HASH_MISMATCH,
107
+ bidParentBlockHash,
108
+ payloadParentBlockHash,
109
+ },
110
+ `Selected bid parent does not match payload parent bidParentBlockHash=${bidParentBlockHash} payloadParentBlockHash=${payloadParentBlockHash}`
111
+ );
112
+ }
113
+
114
+ const payloadBlockHash = toRootHex(payload.executionPayload.blockHash);
115
+ const bidBlockHash = toRootHex(selectedBid.blockHash);
116
+ if (payloadBlockHash !== bidBlockHash) {
117
+ throw new ExecutionPayloadEnvelopeError(
118
+ {
119
+ code: ExecutionPayloadEnvelopeErrorCode.BLOCK_HASH_MISMATCH,
120
+ bidBlockHash,
121
+ payloadBlockHash,
122
+ },
123
+ `Selected bid block hash does not match payload bidBlockHash=${bidBlockHash} payloadBlockHash=${payloadBlockHash}`
124
+ );
125
+ }
126
+
127
+ if (
128
+ !ssz.gloas.ExecutionPayloadBid.fields.blobKzgCommitments.equals(
129
+ selectedBid.blobKzgCommitments,
130
+ payload.blobsBundle.commitments
131
+ )
132
+ ) {
133
+ throw new ExecutionPayloadEnvelopeError({code: ExecutionPayloadEnvelopeErrorCode.BLOB_KZG_COMMITMENTS_MISMATCH});
134
+ }
135
+
136
+ const executionRequestsRoot = ssz.gloas.ExecutionRequests.hashTreeRoot(payload.executionRequests);
137
+ if (!byteArrayEquals(executionRequestsRoot, selectedBid.executionRequestsRoot)) {
138
+ throw new ExecutionPayloadEnvelopeError({
139
+ code: ExecutionPayloadEnvelopeErrorCode.EXECUTION_REQUESTS_ROOT_MISMATCH,
140
+ bidExecutionRequestsRoot: toRootHex(selectedBid.executionRequestsRoot),
141
+ payloadExecutionRequestsRoot: toRootHex(executionRequestsRoot),
142
+ });
143
+ }
144
+
145
+ return {
146
+ envelope: {
147
+ payload: payload.executionPayload,
148
+ executionRequests: payload.executionRequests,
149
+ builderIndex,
150
+ beaconBlockRoot: fromHex(blockRoot),
151
+ parentBeaconBlockRoot: selectedBid.parentBlockRoot,
152
+ },
153
+ kzgProofs: payload.blobsBundle.proofs,
154
+ blobs: payload.blobsBundle.blobs,
155
+ };
156
+ }