@chainsafe/lodestar 1.47.0-dev.ec596194e2 → 1.47.0-dev.f0f26cd2b6

package/src/cmds/validator/options.ts

@@ -48,6 +48,10 @@ export type IValidatorCliArgs = AccountValidatorArgs &
     builder?: boolean;
     "builder.selection"?: string;
     "builder.boostFactor"?: string;
+    "builder.minBid"?: string;
+    "builder.urls"?: string[];
+    "builder.maxExecutionPayment"?: string;
+    allowDangerousTrustedPayments?: boolean;
 
     /** @deprecated */
     useProduceBlockV3?: boolean;
@@ -276,6 +280,38 @@ export const validatorOptions: CliCommandOptions<IValidatorCliArgs> = {
     group: "builder",
   },
 
+  "builder.minBid": {
+    type: "string",
+    description:
+      "Minimum counted total payment in Gwei accepted from a builder bid. The total is the bid value plus its execution payment up to the configured cap. Only used post-Gloas",
+    defaultDescription: `${defaultOptions.builderMinBid}`,
+    group: "builder",
+  },
+
+  "builder.urls": {
+    description:
+      "URL(s) of external builders to request execution payload bids from. Auth data agreed with a builder may be appended as a hex fragment, e.g. https://builder.example.com#0x0123, otherwise the UTF-8 bytes of the URL are used. Only used post-Gloas",
+    type: "array",
+    string: true,
+    coerce: (urls: string[]): string[] => urls.flatMap((url) => url.split(",")),
+    group: "builder",
+  },
+
+  "builder.maxExecutionPayment": {
+    type: "string",
+    description:
+      "Maximum execution layer payment in Gwei counted toward a builder bid. A value of 0 means only trustless payments via the builder's staked collateral count toward the bid. Values above 0 require `--allowDangerousTrustedPayments`. Only used post-Gloas",
+    defaultDescription: `${defaultOptions.builderMaxExecutionPayment}`,
+    group: "builder",
+  },
+
+  allowDangerousTrustedPayments: {
+    type: "boolean",
+    description:
+      "Allow configuring a builder max execution payment above 0. Trusted execution layer payments are only backed by the builder's promise to pay, not by its staked collateral, a builder that fails to pay cannot be penalized in protocol",
+    group: "builder",
+  },
+
   useProduceBlockV3: {
     hidden: true,
     deprecated: true,

package/src/cmds/validator/signers/index.ts

@@ -1,6 +1,6 @@
 import path from "node:path";
 import {deriveEth2ValidatorKeys, deriveKeyFromMnemonic} from "@chainsafe/bls-keygen";
-import {SecretKey} from "@chainsafe/blst";
+import {SecretKey} from "@chainsafe/lodestar-z/blst";
 import {interopSecretKey} from "@lodestar/state-transition";
 import {LogLevel, Logger, isValidHttpUrl} from "@lodestar/utils";
 import {Signer, SignerType, externalSignerGetKeys} from "@lodestar/validator";

package/src/cmds/validator/voluntaryExit.ts

@@ -1,7 +1,7 @@
 import fs from "node:fs";
 import path from "node:path";
 import inquirer from "inquirer";
-import {Signature} from "@chainsafe/blst";
+import {Signature} from "@chainsafe/lodestar-z/blst";
 import {ApiClient, getClient} from "@lodestar/api";
 import {BeaconConfig, createBeaconConfig} from "@lodestar/config";
 import {

package/src/networks/chiado.ts

@@ -5,14 +5,8 @@ export const genesisStateRoot = "0xa48419160f8f146ecaa53d12a5d6e1e6af414a328afdc
 export const bootnodesFileUrl = "https://raw.githubusercontent.com/gnosischain/configs/main/chiado/bootnodes.yaml";
 
 export const bootEnrs = [
-  "enr:-L64QOijsdi9aVIawMb5h5PWueaPM9Ai6P17GNPFlHzz7MGJQ8tFMdYrEx8WQitNKLG924g2Q9cCdzg54M0UtKa3QIKCMxaHYXR0bmV0c4j__________4RldGgykDE2cEMCAABv__________-CaWSCdjSCaXCEi5AaWYlzZWNwMjU2azGhA8CjTkD4m1s8FbKCN18LgqlYcE65jrT148vFtwd9U62SiHN5bmNuZXRzD4N0Y3CCIyiDdWRwgiMo",
-  "enr:-L64QKYKGQj5ybkfBxyFU5IEVzP7oJkGHJlie4W8BCGAYEi4P0mmMksaasiYF789mVW_AxYVNVFUjg9CyzmdvpyWQ1KCMlmHYXR0bmV0c4j__________4RldGgykDE2cEMCAABv__________-CaWSCdjSCaXCEi5CtNolzZWNwMjU2azGhAuA7BAwIijy1z81AO9nz_MOukA1ER68rGA67PYQ5pF1qiHN5bmNuZXRzD4N0Y3CCIyiDdWRwgiMo",
-  "enr:-Ly4QJJUnV9BxP_rw2Bv7E9iyw4sYS2b4OQZIf4Mu_cA6FljJvOeSTQiCUpbZhZjR4R0VseBhdTzrLrlHrAuu_OeZqgJh2F0dG5ldHOI__________-EZXRoMpAxNnBDAgAAb___________gmlkgnY0gmlwhIuQGnOJc2VjcDI1NmsxoQPT_u3IjDtB2r-nveH5DhUmlM8F2IgLyxhmwmqW4L5k3ohzeW5jbmV0cw-DdGNwgiMog3VkcIIjKA",
-  "enr:-MK4QCkOyqOTPX1_-F-5XVFjPclDUc0fj3EeR8FJ5-hZjv6ARuGlFspM0DtioHn1r6YPUXkOg2g3x6EbeeKdsrvVBYmGAYQKrixeh2F0dG5ldHOIAAAAAAAAAACEZXRoMpAxNnBDAgAAb___________gmlkgnY0gmlwhIuQGlWJc2VjcDI1NmsxoQKdW3-DgLExBkpLGMRtuM88wW_gZkC7Yeg0stYDTrlynYhzeW5jbmV0cwCDdGNwgiMog3VkcIIjKA",
-  "enr:-Ly4QLYLNqrjvSxD3lpAPBUNlxa6cIbe79JqLZLFcZZjWoCjZcw-85agLUErHiygG2weRSCLnd5V460qTbLbwJQsfZkoh2F0dG5ldHOI__________-EZXRoMpAxNnBDAgAAb___________gmlkgnY0gmlwhKq7mu-Jc2VjcDI1NmsxoQP900YAYa9kdvzlSKGjVo-F3XVzATjOYp3BsjLjSophO4hzeW5jbmV0cw-DdGNwgiMog3VkcIIjKA",
-  "enr:-Ly4QCGeYvTCNOGKi0mKRUd45rLj96b4pH98qG7B9TCUGXGpHZALtaL2-XfjASQyhbCqENccI4PGXVqYTIehNT9KJMQgh2F0dG5ldHOI__________-EZXRoMpAxNnBDAgAAb___________gmlkgnY0gmlwhIuQrVSJc2VjcDI1NmsxoQP9iDchx2PGl3JyJ29B9fhLCvVMN6n23pPAIIeFV-sHOIhzeW5jbmV0cw-DdGNwgiMog3VkcIIjKA",
-  "enr:-Ly4QAtr21x5Ps7HYhdZkIBRBgcBkvlIfEel1YNjtFWf4cV3au2LgBGICz9PtEs9-p2HUl_eME8m1WImxTxSB3AkCMwBh2F0dG5ldHOIAAAAAAAAAACEZXRoMpAxNnBDAgAAb___________gmlkgnY0gmlwhANHhOeJc2VjcDI1NmsxoQNLp1QPV8-pyMCohOtj6xGtSBM_GtVTqzlbvNsCF4ezkYhzeW5jbmV0cwCDdGNwgiMog3VkcIIjKA",
-  "enr:-Ly4QLgn8Bx6faigkKUGZQvd1HDToV2FAxZIiENK-lczruzQb90qJK-4E65ADly0s4__dQOW7IkLMW7ZAyJy2vtiLy8Bh2F0dG5ldHOIAAAAAAAAAACEZXRoMpAxNnBDAgAAb___________gmlkgnY0gmlwhANFIw2Jc2VjcDI1NmsxoQMa-fWEy9UJHfOl_lix3wdY5qust78sHAqZnWwEiyqKgYhzeW5jbmV0cwCDdGNwgiMog3VkcIIjKA",
-  "enr:-KG4QF7z4LUdMfgwvh-fS-MDv_1hPSUCqGfyOWGLNJuoBHKFAMSHz8geQn8v3qDDbuSQKud3WIAjKqR4gqJoLBUEJ08ZhGV0aDKQDc1ElgAAAG___________4JpZIJ2NIJpcIQjzq5ciXNlY3AyNTZrMaECt7YO363pV54d3QdgnluL5kxzhCR_k0yM9C-G6bqMGoKDdGNwgiMog3VkcIIjKA",
-  "enr:-LK4QCUTEmZrT1AgCKdyVgwnHL5J0VSoxsyjruAtwo-owBTBVEOyAnQRVNXlcW5aL-ycntk5oHDrKCR-DXZAlUAKpjEBh2F0dG5ldHOIAAAAAAAAAACEZXRoMpCdM7Z1BAAAb___________gmlkgnY0gmlwhCPSfheJc2VjcDI1NmsxoQNpdf8U9pzsU9m6Hzgd1rmTI-On-QImJnkZBGqDp4org4N0Y3CCIyiDdWRwgiMo",
+  "enr:-IS4QC9xcSNOKeUBrjOX1-qwcPDGOvRK-Aql_YnRfuYsuXElQawANMLTOz1YfrZTMI07B7DAl9hmk3ic5G7ZHQbq4HsUgmlkgnY0gmlwhDNL9gKJc2VjcDI1NmsxoQOzB8HdKe07eQBOxu5nexAWECV47zxlau23oEYqoToy9YN1ZHCCIyg",
+  "enr:-IS4QMpCWNqXmqbtXg7vQyYBwV2xTDpgTNpgAz060TY5cpJ3JdjuwAkLG01Vf9Vlfb0jtRhJEpj0CfteG-3K_V36bmECgmlkgnY0gmlwhDmBRt6Jc2VjcDI1NmsxoQNkoifSsk1ijP3-OR9pcL2VWCSfD5_syapyrXA83GcAvYN1ZHCCIyg",
+  "enr:-IS4QBa3hl_BcjrY4z_OvhRBx7qUMBFGkjkoedGNMXgC_fzLRBsg161SipeHWAkUnSuvBg_7529-Qfxcc7CAbokn4fMCgmlkgnY0gmlwhDmA_HuJc2VjcDI1NmsxoQL8xX-V_pyU_l3AIfVokHKMN1OMUG02vcy4AMOxdyi5jIN1ZHCCIyg",
+  "enr:-IS4QEuUku9zL0V3hFHt41fqmEdvphEvrOg0D4K_TgiiaePCDH2IPzt6B3O6NLHtgJNXk3UW68DL6KVBD4rjoW-nW9ACgmlkgnY0gmlwhDYnlGKJc2VjcDI1NmsxoQP3W66lisn2YOJF4B0QDEnURZ6tqzpi5gBy9rbMfpC70YN1ZHCCIyg",
 ];

package/src/options/beaconNodeOptions/builder.ts

@@ -31,7 +31,8 @@ export function parseArgs(args: ExecutionBuilderArgs): IBeaconNodeOptions["execu
 
 export const options: CliCommandOptions<ExecutionBuilderArgs> = {
   builder: {
-    description: "Enable external builder",
+    description:
+      "Enable external builder. Pre-Gloas only, deprecated post-Gloas where builders are configured on the validator client",
     type: "boolean",
     default: defaultExecutionBuilderHttpOpts.enabled,
     group: "builder",
@@ -39,7 +40,8 @@ export const options: CliCommandOptions<ExecutionBuilderArgs> = {
 
   "builder.url": {
     alias: ["builder.urls"],
-    description: "Url hosting the builder API",
+    description:
+      "Url hosting the builder API. Pre-Gloas only, deprecated post-Gloas where builders are configured on the validator client",
     defaultDescription: defaultExecutionBuilderHttpOpts.url,
     type: "string",
     group: "builder",

package/src/options/beaconNodeOptions/chain.ts

@@ -343,7 +343,8 @@ Will double processing times. Use only for debugging purposes.",
 
   "chain.maxCPStateEpochsOnDisk": {
     hidden: true,
-    description: "Max epochs to cache checkpoint states on disk, used for PersistentCheckpointStateCache",
+    description:
+      "Max number of checkpoint state epochs to keep on disk. Default (Infinity) uses tiered pruning to bound disk usage during long non-finality; set a finite N to keep only the last N epochs instead (previous behavior)",
     type: "number",
     default: defaultOptions.chain.maxCPStateEpochsOnDisk,
     group: "chain",

package/src/util/format.ts

@@ -1,4 +1,4 @@
-import {PublicKey} from "@chainsafe/blst";
+import {PublicKey} from "@chainsafe/lodestar-z/blst";
 import {fromHex} from "@lodestar/utils";
 
 /**

package/src/util/proposerConfig.ts

@@ -1,10 +1,16 @@
 import fs from "node:fs";
 import path from "node:path";
 import {routes} from "@lodestar/api";
+import {BuilderEntryConfig, builderConfigDataFromJson} from "@lodestar/api/keymanager";
+import {MAX_BUILDER_AUTH_DATA_SIZE, MAX_BUILDER_ENTRIES, MAX_BUILDER_URL_SIZE} from "@lodestar/params";
+import {fromHex, isValidAsciiHttpUrl, toHex} from "@lodestar/utils";
 import {ValidatorProposerConfig} from "@lodestar/validator";
 import {parseFeeRecipient} from "./feeRecipient.js";
 import {readFile} from "./file.js";
 
+const UINT64_MAX = 2n ** 64n - 1n;
+const BUILDER_AUTH_DATA_PATTERN = new RegExp(`^0x(?:[a-fA-F0-9]{2}){1,${MAX_BUILDER_AUTH_DATA_SIZE}}$`);
+
 type ProposerConfig = ValidatorProposerConfig["defaultConfig"];
 
 type ProposerConfigFileSection = {
@@ -17,6 +23,9 @@ type ProposerConfigFileSection = {
     gas_limit?: number;
     selection?: routes.validator.BuilderSelection;
     boost_factor?: bigint;
+    min_bid?: bigint;
+    max_execution_payment?: bigint;
+    builders?: unknown;
   };
 };
 
@@ -54,7 +63,14 @@ function parseProposerConfigSection(
   overrideConfig?: ProposerConfig
 ): ProposerConfig {
   const {graffiti, strict_fee_recipient_check, fee_recipient, builder} = proposerFileSection;
-  const {gas_limit, selection: builderSelection, boost_factor} = builder || {};
+  const {
+    gas_limit,
+    selection: builderSelection,
+    boost_factor,
+    min_bid,
+    max_execution_payment,
+    builders,
+  } = builder || {};
 
   if (graffiti !== undefined && typeof graffiti !== "string") {
     throw Error("graffiti is not 'string");
@@ -79,6 +95,29 @@ function parseProposerConfigSection(
   if (boost_factor !== undefined && typeof boost_factor !== "string") {
     throw Error("boost_factor is not 'string");
   }
+  if (min_bid !== undefined && typeof min_bid !== "string") {
+    throw Error("min_bid is not 'string");
+  }
+  if (max_execution_payment !== undefined && typeof max_execution_payment !== "string") {
+    throw Error("max_execution_payment is not 'string");
+  }
+
+  const parsedBuilder =
+    overrideConfig?.builder || builder
+      ? {
+          gasLimit: overrideConfig?.builder?.gasLimit ?? (gas_limit !== undefined ? Number(gas_limit) : undefined),
+          selection: overrideConfig?.builder?.selection ?? parseBuilderSelection(builderSelection),
+          boostFactor: overrideConfig?.builder?.boostFactor ?? parseBuilderBoostFactor(boost_factor),
+          minBid: overrideConfig?.builder?.minBid ?? parseBuilderMinBid(min_bid),
+          maxExecutionPayment:
+            overrideConfig?.builder?.maxExecutionPayment ?? parseBuilderGweiAmount(max_execution_payment),
+          builders: overrideConfig?.builder?.builders ?? parseBuilderEntries(builders),
+        }
+      : undefined;
+
+  if (overrideConfig?.builder?.builders !== undefined && builders !== undefined) {
+    throw Error("Cannot configure both --builder.urls and builders in the proposer settings file");
+  }
 
   return {
     graffiti: overrideConfig?.graffiti ?? graffiti,
@@ -86,21 +125,27 @@ function parseProposerConfigSection(
       overrideConfig?.strictFeeRecipientCheck ??
       (strict_fee_recipient_check ? stringtoBool(strict_fee_recipient_check) : undefined),
     feeRecipient: overrideConfig?.feeRecipient ?? (fee_recipient ? parseFeeRecipient(fee_recipient) : undefined),
-    builder:
-      overrideConfig?.builder || builder
-        ? {
-            gasLimit: overrideConfig?.builder?.gasLimit ?? (gas_limit !== undefined ? Number(gas_limit) : undefined),
-            selection: overrideConfig?.builder?.selection ?? parseBuilderSelection(builderSelection),
-            boostFactor: overrideConfig?.builder?.boostFactor ?? parseBuilderBoostFactor(boost_factor),
-          }
-        : undefined,
+    builder: parsedBuilder,
   };
 }
 
-export function readProposerConfigDir(filepath: string, filename: string): ProposerConfigFileSection {
+export function readProposerConfigDir(filepath: string, filename: string): ProposerConfig {
   const proposerConfigStr = fs.readFileSync(path.join(filepath, filename), "utf8");
-  const proposerConfigJSON = JSON.parse(proposerConfigStr) as ProposerConfigFileSection;
-  return proposerConfigJSON;
+  // Persisted via `writeProposerConfig` with BigInt values serialized as strings
+  const persisted = JSON.parse(proposerConfigStr) as ProposerConfig;
+  if (persisted.builder) {
+    const {boostFactor, minBid, maxExecutionPayment, builders} = persisted.builder;
+    persisted.builder.boostFactor = boostFactor !== undefined ? BigInt(boostFactor) : undefined;
+    persisted.builder.minBid = minBid !== undefined ? BigInt(minBid) : undefined;
+    persisted.builder.maxExecutionPayment = maxExecutionPayment !== undefined ? BigInt(maxExecutionPayment) : undefined;
+    persisted.builder.builders = builders?.map((entry) => ({
+      ...entry,
+      maxExecutionPayment: entry.maxExecutionPayment !== undefined ? BigInt(entry.maxExecutionPayment) : undefined,
+      minBid: entry.minBid !== undefined ? BigInt(entry.minBid) : undefined,
+      builderBoostFactor: entry.builderBoostFactor !== undefined ? BigInt(entry.builderBoostFactor) : undefined,
+    }));
+  }
+  return persisted;
 }
 
 export function parseBuilderSelection(builderSelection?: string): routes.validator.BuilderSelection | undefined {
@@ -131,6 +176,100 @@ export function parseBuilderBoostFactor(boostFactor?: string): bigint | undefine
   if (!/^\d+$/.test(boostFactor)) {
     throw Error("Invalid input for builder boost factor, must be a valid number without decimals");
   }
+  const parsed = BigInt(boostFactor);
+  if (parsed > UINT64_MAX) {
+    throw Error("Invalid input for builder boost factor, must not exceed 2**64 - 1");
+  }
+
+  return parsed;
+}
+
+export function parseBuilderMinBid(minBid?: string | bigint): bigint | undefined {
+  if (minBid === undefined) return;
+
+  if (!/^\d+$/.test(minBid.toString())) {
+    throw Error("Invalid input for builder min bid, must be a valid number without decimals");
+  }
+  const parsed = BigInt(minBid);
+  if (parsed > UINT64_MAX) {
+    throw Error("Invalid input for builder min bid, must not exceed 2**64 - 1");
+  }
 
-  return BigInt(boostFactor);
+  return parsed;
+}
+
+export function parseBuilderGweiAmount(amount?: string | bigint): bigint | undefined {
+  if (amount === undefined) return;
+
+  if (!/^\d+$/.test(amount.toString())) {
+    throw Error("Invalid input for builder Gwei amount, must be a valid number without decimals");
+  }
+  const parsed = BigInt(amount);
+  if (parsed > UINT64_MAX) {
+    throw Error("Invalid input for builder Gwei amount, must not exceed 2**64 - 1");
+  }
+
+  return parsed;
+}
+
+/**
+ * Parse per-builder entries from the proposer settings file, same shape and validation as the
+ * keymanager builders api. No two entries may share both their url and their auth data, an
+ * omitted auth data is compared as the value derived from the entry url.
+ */
+export function parseBuilderEntries(builders?: unknown): BuilderEntryConfig[] | undefined {
+  if (builders === undefined) return undefined;
+
+  const {builders: entries} = builderConfigDataFromJson({builders});
+  const seenEntries = new Set<string>();
+  for (const entry of entries ?? []) {
+    if (!isValidAsciiHttpUrl(entry.url)) {
+      throw Error(`Invalid builder url: ${entry.url}`);
+    }
+    const authData = entry.authData !== undefined ? toHex(fromHex(entry.authData)) : toHex(Buffer.from(entry.url));
+    const entryKey = `${entry.url}|${authData}`;
+    if (seenEntries.has(entryKey)) {
+      throw Error(`Duplicate builder entry url=${entry.url}`);
+    }
+    seenEntries.add(entryKey);
+  }
+  return entries;
+}
+
+/**
+ * Parse builder urls into builder entries. Auth data agreed with a builder out of band may be
+ * appended as a hex fragment (`https://builder.example.com#0x0123`), it is stripped from the url
+ * and never sent on the wire. Without a fragment the auth data derives from the url.
+ */
+export function parseBuilderUrls(urls?: string[]): BuilderEntryConfig[] | undefined {
+  if (urls === undefined) return undefined;
+
+  const entries: BuilderEntryConfig[] = [];
+  const seenEntries = new Set<string>();
+  for (const value of urls) {
+    const fragmentIndex = value.indexOf("#");
+    const url = fragmentIndex === -1 ? value : value.slice(0, fragmentIndex);
+    const authData = fragmentIndex === -1 ? undefined : value.slice(fragmentIndex + 1);
+    if (!isValidAsciiHttpUrl(url)) {
+      throw Error(`Invalid builder url: ${url}`);
+    }
+    if (Buffer.byteLength(url, "utf8") > MAX_BUILDER_URL_SIZE) {
+      throw Error(`Invalid builder url, must not exceed ${MAX_BUILDER_URL_SIZE} bytes: ${url}`);
+    }
+    if (authData !== undefined && !BUILDER_AUTH_DATA_PATTERN.test(authData)) {
+      throw Error(
+        `Invalid builder url auth data, must be a 0x-prefixed hex string of 1 to ${MAX_BUILDER_AUTH_DATA_SIZE} bytes: ${url}`
+      );
+    }
+    const entryKey = `${url}|${authData !== undefined ? toHex(fromHex(authData)) : toHex(Buffer.from(url))}`;
+    if (seenEntries.has(entryKey)) {
+      throw Error(`Duplicate builder url: ${url}`);
+    }
+    seenEntries.add(entryKey);
+    entries.push({url, authData});
+  }
+  if (entries.length > MAX_BUILDER_ENTRIES) {
+    throw Error(`Number of builder urls must not exceed ${MAX_BUILDER_ENTRIES}, got ${entries.length}`);
+  }
+  return entries;
 }