@chainsafe/lodestar 1.35.0-dev.fcf8d024ea → 1.35.0-dev.feed916580

package/src/cmds/lightclient/handler.ts

@@ -1,36 +0,0 @@
-import path from "node:path";
-import {getClient} from "@lodestar/api";
-import {Lightclient} from "@lodestar/light-client";
-import {LightClientRestTransport} from "@lodestar/light-client/transport";
-import {getNodeLogger} from "@lodestar/logger/node";
-import {fromHex} from "@lodestar/utils";
-import {getBeaconConfigFromArgs} from "../../config/beaconParams.js";
-import {GlobalArgs} from "../../options/index.js";
-import {getGlobalPaths} from "../../paths/global.js";
-import {parseLoggerArgs} from "../../util/logger.js";
-import {ILightClientArgs} from "./options.js";
-
-export async function lightclientHandler(args: ILightClientArgs & GlobalArgs): Promise<void> {
-  const {config, network} = getBeaconConfigFromArgs(args);
-  const globalPaths = getGlobalPaths(args, network);
-
-  const logger = getNodeLogger(
-    parseLoggerArgs(args, {defaultLogFilepath: path.join(globalPaths.dataDir, "lightclient.log")}, config)
-  );
-
-  const api = getClient({baseUrl: args.beaconApiUrl}, {config});
-  const {genesisTime, genesisValidatorsRoot} = (await api.beacon.getGenesis()).value();
-
-  const client = await Lightclient.initializeFromCheckpointRoot({
-    config,
-    logger,
-    genesisData: {
-      genesisTime,
-      genesisValidatorsRoot,
-    },
-    checkpointRoot: fromHex(args.checkpointRoot),
-    transport: new LightClientRestTransport(api),
-  });
-
-  void client.start();
-}

package/src/cmds/lightclient/index.ts

@@ -1,18 +0,0 @@
-import {CliCommand} from "@lodestar/utils";
-import {GlobalArgs} from "../../options/index.js";
-import {lightclientHandler} from "./handler.js";
-import {ILightClientArgs, lightclientOptions} from "./options.js";
-
-export const lightclient: CliCommand<ILightClientArgs, GlobalArgs> = {
-  command: "lightclient",
-  describe: "Run lightclient",
-  docsFolder: "libraries/lightclient-prover",
-  examples: [
-    {
-      command: "lightclient --network hoodi",
-      description: "Run lightclient with hoodi network",
-    },
-  ],
-  options: lightclientOptions,
-  handler: lightclientHandler,
-};

package/src/cmds/lightclient/options.ts

@@ -1,21 +0,0 @@
-import {CliCommandOptions} from "@lodestar/utils";
-import {LogArgs, logOptions} from "../../options/logOptions.js";
-
-export type ILightClientArgs = LogArgs & {
-  beaconApiUrl: string;
-  checkpointRoot: string;
-};
-
-export const lightclientOptions: CliCommandOptions<ILightClientArgs> = {
-  ...logOptions,
-  beaconApiUrl: {
-    description: "Url to a beacon node that support lightclient API",
-    type: "string",
-    demandOption: true,
-  },
-  checkpointRoot: {
-    description: "Checkpoint root hex string to sync the lightclient from, start with 0x",
-    type: "string",
-    demandOption: true,
-  },
-};

package/src/cmds/validator/blsToExecutionChange.ts

@@ -1,91 +0,0 @@
-import {SecretKey} from "@chainsafe/blst";
-import {getClient} from "@lodestar/api";
-import {createBeaconConfig} from "@lodestar/config";
-import {DOMAIN_BLS_TO_EXECUTION_CHANGE, ForkName} from "@lodestar/params";
-import {computeSigningRoot} from "@lodestar/state-transition";
-import {capella, ssz} from "@lodestar/types";
-import {CliCommand, fromHex} from "@lodestar/utils";
-import {getBeaconConfigFromArgs} from "../../config/index.js";
-import {GlobalArgs} from "../../options/index.js";
-import {IValidatorCliArgs} from "./options.js";
-
-type BlsToExecutionChangeArgs = {
-  publicKey: string;
-  fromBlsPrivkey: string;
-  toExecutionAddress: string;
-};
-
-export const blsToExecutionChange: CliCommand<BlsToExecutionChangeArgs, IValidatorCliArgs & GlobalArgs> = {
-  command: "bls-to-execution-change",
-
-  describe:
-    "Performs BLS To Execution Change for a given validator (as identified via `publicKey`.  \
-If no `publicKey` is provided, a prompt will ask the user which validator they would \
-like to choose for BLS To Execution Change.",
-
-  examples: [
-    {
-      command: "validator bls-to-execution-change --publicKey 0xF00 --fromBlsPrivkey ... --toExecutionAddress ...",
-      description: "Perform BLS To Execution Change for the validator who has a public key 0xF00",
-    },
-  ],
-
-  options: {
-    publicKey: {
-      description: "Validator public key for which to set withdrawal address hence enabling withdrawals",
-      type: "string",
-      demandOption: true,
-    },
-    fromBlsPrivkey: {
-      description: "Bls withdrawals private key to sign the message",
-      type: "string",
-      demandOption: true,
-    },
-    toExecutionAddress: {
-      description: "Address to which the validator's balances will be set to be withdrawn.",
-      type: "string",
-      demandOption: true,
-    },
-  },
-
-  handler: async (args) => {
-    const {publicKey} = args;
-    // Fetch genesisValidatorsRoot always from beacon node as anyway beacon node is needed for
-    // submitting the signed message
-    const {config: chainForkConfig} = getBeaconConfigFromArgs(args);
-    const client = getClient({urls: args.beaconNodes}, {config: chainForkConfig});
-    const {genesisValidatorsRoot} = (await client.beacon.getGenesis()).value();
-    const config = createBeaconConfig(chainForkConfig, genesisValidatorsRoot);
-
-    const validators = (await client.beacon.postStateValidators({stateId: "head", validatorIds: [publicKey]})).value();
-    const validator = validators[0];
-    if (validator === undefined) {
-      throw new Error(`Validator pubkey ${publicKey} not found in state`);
-    }
-
-    const blsPrivkey = SecretKey.fromBytes(fromHex(args.fromBlsPrivkey));
-    const fromBlsPubkey = blsPrivkey.toPublicKey().toBytes();
-
-    const blsToExecutionChange: capella.BLSToExecutionChange = {
-      validatorIndex: validator.index,
-      fromBlsPubkey,
-      toExecutionAddress: fromHex(args.toExecutionAddress),
-    };
-
-    const signatureFork = ForkName.phase0;
-    const domain = config.getDomainAtFork(signatureFork, DOMAIN_BLS_TO_EXECUTION_CHANGE);
-    const signingRoot = computeSigningRoot(ssz.capella.BLSToExecutionChange, blsToExecutionChange, domain);
-    const signedBLSToExecutionChange = {
-      message: blsToExecutionChange,
-      signature: blsPrivkey.sign(signingRoot).toBytes(),
-    };
-
-    (
-      await client.beacon.submitPoolBLSToExecutionChange({
-        blsToExecutionChanges: [signedBLSToExecutionChange],
-      })
-    ).assertOk();
-
-    console.log(`Submitted bls to execution change for ${publicKey}`);
-  },
-};

package/src/cmds/validator/handler.ts

@@ -1,300 +0,0 @@
-import {setMaxListeners} from "node:events";
-import path from "node:path";
-import {WireFormat, routes} from "@lodestar/api";
-import {
-  MonitoringService,
-  RegistryMetricCreator,
-  collectNodeJSMetrics,
-  getHttpMetricsServer,
-} from "@lodestar/beacon-node";
-import {LevelDbController} from "@lodestar/db/controller/level";
-import {getNodeLogger} from "@lodestar/logger/node";
-import {
-  ProcessShutdownCallback,
-  SlashingProtection,
-  Validator,
-  ValidatorProposerConfig,
-  defaultOptions,
-  getMetrics,
-} from "@lodestar/validator";
-import {getBeaconConfigFromArgs} from "../../config/index.js";
-import {GlobalArgs} from "../../options/index.js";
-import {
-  YargsError,
-  cleanOldLogFiles,
-  mkdir,
-  onGracefulShutdown,
-  parseFeeRecipient,
-  parseLoggerArgs,
-  parseProposerConfig,
-} from "../../util/index.js";
-import {parseBuilderBoostFactor, parseBuilderSelection} from "../../util/proposerConfig.js";
-import {getVersionData} from "../../util/version.js";
-import {KeymanagerApi} from "./keymanager/impl.js";
-import {IPersistedKeysBackend} from "./keymanager/interface.js";
-import {PersistedKeysBackend} from "./keymanager/persistedKeys.js";
-import {KeymanagerRestApiServer} from "./keymanager/server.js";
-import {IValidatorCliArgs, validatorMetricsDefaultOptions, validatorMonitoringDefaultOptions} from "./options.js";
-import {getAccountPaths, getValidatorPaths} from "./paths.js";
-import {getSignersFromArgs} from "./signers/index.js";
-import {logSigners, warnOrExitNoSigners} from "./signers/logSigners.js";
-
-/**
- * Runs a validator client.
- */
-export async function validatorHandler(args: IValidatorCliArgs & GlobalArgs): Promise<void> {
-  const {config, network} = getBeaconConfigFromArgs(args);
-
-  const {doppelgangerProtection} = args;
-
-  const validatorPaths = getValidatorPaths(args, network);
-  const accountPaths = getAccountPaths(args, network);
-
-  const defaultLogFilepath = path.join(validatorPaths.dataDir, "validator.log");
-  const logger = getNodeLogger(parseLoggerArgs(args, {defaultLogFilepath}, config));
-  try {
-    cleanOldLogFiles(args, {defaultLogFilepath});
-  } catch (e) {
-    logger.debug("Not able to delete log files", {}, e as Error);
-  }
-
-  const persistedKeysBackend = new PersistedKeysBackend(accountPaths);
-  const valProposerConfig = getProposerConfigFromArgs(args, {persistedKeysBackend, accountPaths});
-
-  const {version, commit} = getVersionData();
-  logger.info("Lodestar", {network, version, commit});
-  if (args.distributed) logger.info("Client is configured to run as part of a distributed validator cluster");
-  logger.info("Connecting to LevelDB database", {path: validatorPaths.validatorsDbDir});
-
-  const dbPath = validatorPaths.validatorsDbDir;
-  mkdir(dbPath);
-
-  const onGracefulShutdownCbs: (() => Promise<void> | void)[] = [];
-  onGracefulShutdown(async () => {
-    for (const cb of onGracefulShutdownCbs) await cb();
-  }, logger.info.bind(logger));
-
-  // Callback for validator to request forced exit, in case of doppelganger detection
-  const processShutdownCallback: ProcessShutdownCallback = (err) => {
-    logger.error("Process shutdown requested", {}, err);
-    process.kill(process.pid, "SIGINT");
-  };
-
-  // This AbortController interrupts various validators ops: genesis req, clients call, clock etc
-  const abortController = new AbortController();
-
-  // We set infinity for abort controller used for validator operations,
-  // to prevent MaxListenersExceededWarning which get logged when listeners > 10
-  // Since it is perfectly fine to have listeners > 10
-  setMaxListeners(Infinity, abortController.signal);
-
-  onGracefulShutdownCbs.push(async () => abortController.abort());
-
-  /**
-   * For rationale and documentation of how signers are loaded from args and disk,
-   * see {@link PersistedKeysBackend} and {@link getSignersFromArgs}
-   *
-   * Note: local signers are already locked once returned from this function.
-   */
-  const signers = await getSignersFromArgs(args, network, {logger, signal: abortController.signal});
-
-  // Ensure the validator has at least one key
-  if (signers.length === 0) {
-    warnOrExitNoSigners(args, logger);
-  }
-
-  logSigners(logger, signers);
-
-  const db = await LevelDbController.create({name: dbPath}, {metrics: null, logger});
-  onGracefulShutdownCbs.push(() => db.close());
-
-  const slashingProtection = new SlashingProtection(db);
-
-  // Create metrics registry if metrics are enabled or monitoring endpoint is configured
-  // Send version and network data for static registries
-
-  const register = args.metrics || args["monitoring.endpoint"] ? new RegistryMetricCreator() : null;
-  const metrics = register && getMetrics(register, {version, commit, network});
-
-  // Start metrics server if metrics are enabled.
-  // Collect NodeJS metrics defined in the Lodestar repo
-
-  if (metrics) {
-    const closeMetrics = collectNodeJSMetrics(register);
-    onGracefulShutdownCbs.push(() => closeMetrics());
-
-    // only start server if metrics are explicitly enabled
-    if (args.metrics) {
-      const port = args["metrics.port"] ?? validatorMetricsDefaultOptions.port;
-      const address = args["metrics.address"] ?? validatorMetricsDefaultOptions.address;
-      const metricsServer = await getHttpMetricsServer({port, address}, {register, logger});
-
-      onGracefulShutdownCbs.push(() => metricsServer.close());
-    }
-  }
-
-  if (args["monitoring.endpoint"]) {
-    const {interval, initialDelay, requestTimeout, collectSystemStats} = validatorMonitoringDefaultOptions;
-
-    const monitoring = new MonitoringService(
-      "validator",
-      {
-        endpoint: args["monitoring.endpoint"],
-        interval: args["monitoring.interval"] ?? interval,
-        initialDelay: args["monitoring.initialDelay"] ?? initialDelay,
-        requestTimeout: args["monitoring.requestTimeout"] ?? requestTimeout,
-        collectSystemStats: args["monitoring.collectSystemStats"] ?? collectSystemStats,
-      },
-      {register: register as RegistryMetricCreator, logger}
-    );
-
-    onGracefulShutdownCbs.push(() => monitoring.close());
-  }
-
-  // This promise resolves once genesis is available.
-  // It will wait for genesis, so this promise can be potentially very long
-
-  const validator = await Validator.initializeFromBeaconNode(
-    {
-      db,
-      config,
-      slashingProtection,
-      api: {
-        clientOrUrls: args.beaconNodes,
-        globalInit: {
-          requestWireFormat: parseWireFormat(args, "http.requestWireFormat"),
-          responseWireFormat: parseWireFormat(args, "http.responseWireFormat"),
-          headers: {"User-Agent": `Lodestar/${version}`},
-        },
-      },
-      logger,
-      processShutdownCallback,
-      signers,
-      abortController,
-      doppelgangerProtection,
-      afterBlockDelaySlotFraction: args.afterBlockDelaySlotFraction,
-      scAfterBlockDelaySlotFraction: args.scAfterBlockDelaySlotFraction,
-      valProposerConfig,
-      distributed: args.distributed,
-      broadcastValidation: parseBroadcastValidation(args.broadcastValidation),
-      blindedLocal: args.blindedLocal,
-      externalSigner: {
-        url: args["externalSigner.url"],
-        fetch: args["externalSigner.fetch"],
-        fetchInterval: args["externalSigner.fetchInterval"],
-      },
-    },
-    metrics
-  );
-
-  onGracefulShutdownCbs.push(() => validator.close());
-
-  // Start keymanager API backend
-  // Only if keymanagerEnabled flag is set to true
-  if (args.keymanager) {
-    // if proposerSettingsFile provided disable the key proposerConfigWrite in keymanager
-    const proposerConfigWriteDisabled = args.proposerSettingsFile !== undefined;
-    if (proposerConfigWriteDisabled) {
-      logger.warn(
-        "Proposer data updates (feeRecipient/gasLimit etc) will not be available via Keymanager API as proposerSettingsFile has been set"
-      );
-    }
-
-    const keymanagerApi = new KeymanagerApi(
-      validator,
-      persistedKeysBackend,
-      abortController.signal,
-      proposerConfigWriteDisabled
-    );
-    const keymanagerServer = new KeymanagerRestApiServer(
-      {
-        address: args["keymanager.address"],
-        port: args["keymanager.port"],
-        cors: args["keymanager.cors"],
-        isAuthEnabled: args["keymanager.auth"],
-        headerLimit: args["keymanager.headerLimit"],
-        bodyLimit: args["keymanager.bodyLimit"],
-        stacktraces: args["keymanager.stacktraces"],
-        tokenFile: args["keymanager.tokenFile"],
-        tokenDir: dbPath,
-      },
-      {config, logger, api: keymanagerApi, metrics: metrics ? metrics.keymanagerApiRest : null}
-    );
-    onGracefulShutdownCbs.push(() => keymanagerServer.close());
-    await keymanagerServer.listen();
-  }
-}
-
-function getProposerConfigFromArgs(
-  args: IValidatorCliArgs,
-  {
-    persistedKeysBackend,
-    accountPaths,
-  }: {persistedKeysBackend: IPersistedKeysBackend; accountPaths: {proposerDir: string}}
-): ValidatorProposerConfig {
-  const defaultConfig = {
-    graffiti: args.graffiti,
-    strictFeeRecipientCheck: args.strictFeeRecipientCheck,
-    feeRecipient: args.suggestedFeeRecipient ? parseFeeRecipient(args.suggestedFeeRecipient) : undefined,
-    builder: {
-      gasLimit: args.defaultGasLimit,
-      selection: parseBuilderSelection(
-        args["builder.selection"] ?? (args.builder ? defaultOptions.builderAliasSelection : undefined)
-      ),
-      boostFactor: parseBuilderBoostFactor(args["builder.boostFactor"]),
-    },
-  };
-
-  let valProposerConfig: ValidatorProposerConfig;
-  const proposerConfigFromKeymanager = persistedKeysBackend.readProposerConfigs();
-
-  if (Object.keys(proposerConfigFromKeymanager).length > 0) {
-    // from persistedBackend
-    if (args.proposerSettingsFile) {
-      throw new YargsError(
-        `Cannot accept --proposerSettingsFile since it conflicts with proposer configs previously persisted via the keymanager api. Delete directory ${accountPaths.proposerDir} to discard them`
-      );
-    }
-    valProposerConfig = {proposerConfig: proposerConfigFromKeymanager, defaultConfig};
-  } else {
-    // from Proposer Settings File
-    if (args.proposerSettingsFile) {
-      // parseProposerConfig will override the defaults with the arg created defaultConfig
-      valProposerConfig = parseProposerConfig(args.proposerSettingsFile, defaultConfig);
-    } else {
-      valProposerConfig = {defaultConfig} as ValidatorProposerConfig;
-    }
-  }
-  return valProposerConfig;
-}
-
-function parseBroadcastValidation(broadcastValidation?: string): routes.beacon.BroadcastValidation | undefined {
-  if (broadcastValidation) {
-    switch (broadcastValidation) {
-      case "gossip":
-      case "consensus":
-      case "consensus_and_equivocation":
-        break;
-      default:
-        throw new YargsError("Invalid input for broadcastValidation, check help");
-    }
-  }
-
-  return broadcastValidation as routes.beacon.BroadcastValidation;
-}
-
-function parseWireFormat(args: IValidatorCliArgs, key: keyof IValidatorCliArgs): WireFormat | undefined {
-  const wireFormat = args[key];
-
-  if (wireFormat !== undefined) {
-    switch (wireFormat) {
-      case WireFormat.json:
-      case WireFormat.ssz:
-        break;
-      default:
-        throw new YargsError(`Invalid input for ${key}, must be one of "${WireFormat.json}" or "${WireFormat.ssz}"`);
-    }
-  }
-
-  return wireFormat;
-}

package/src/cmds/validator/import.ts

@@ -1,111 +0,0 @@
-import fs from "node:fs";
-import {Keystore} from "@chainsafe/bls-keystore";
-import {CliCommand} from "@lodestar/utils";
-import {getBeaconConfigFromArgs} from "../../config/beaconParams.js";
-import {GlobalArgs} from "../../options/index.js";
-import {YargsError, getPubkeyHexFromKeystore} from "../../util/index.js";
-import {PersistedKeysBackend} from "./keymanager/persistedKeys.js";
-import {IValidatorCliArgs, validatorOptions} from "./options.js";
-import {getAccountPaths} from "./paths.js";
-import {importKeystoreDefinitionsFromExternalDir, readPassphraseOrPrompt} from "./signers/importExternalKeystores.js";
-
-type ValidatorImportArgs = Pick<IValidatorCliArgs, "importKeystores" | "importKeystoresPassword">;
-
-const {importKeystores, importKeystoresPassword} = validatorOptions;
-
-export const importCmd: CliCommand<ValidatorImportArgs, IValidatorCliArgs & GlobalArgs> = {
-  command: "import",
-
-  describe:
-    "Imports one or more EIP-2335 keystores into a Lodestar validator client directory, \
-requesting passwords interactively. The directory flag provides a convenient \
-method for importing a directory of keys generated by the eth2-deposit-cli \
-Ethereum Foundation utility.",
-
-  examples: [
-    {
-      command: "validator import --network hoodi --importKeystores $HOME/staking-deposit-cli/validator_keys",
-      description: "Import validator keystores generated with the Ethereum Foundation Staking Launchpad",
-    },
-  ],
-
-  // Note: re-uses `--importKeystores` and `--importKeystoresPassword` from root validator command options
-
-  options: {
-    importKeystores: {
-      ...importKeystores,
-      requiresArg: true,
-    },
-    importKeystoresPassword,
-  },
-
-  handler: async (args) => {
-    const {network} = getBeaconConfigFromArgs(args);
-
-    // This command takes: importKeystores, importKeystoresPassword
-    //
-    // - recursively finds keystores in importKeystores
-    // - validates keystores can decrypt
-    // - writes them in persisted form - do not lock
-
-    if (!args.importKeystores) {
-      throw new YargsError("Must set importKeystores");
-    }
-
-    // Collect same password for all keystores
-    // If importKeystoresPassword is not provided, interactive prompt for it
-
-    const keystoreDefinitions = importKeystoreDefinitionsFromExternalDir({
-      keystoresPath: args.importKeystores,
-      password: await readPassphraseOrPrompt(args),
-    });
-
-    if (keystoreDefinitions.length === 0) {
-      throw new YargsError("No keystores found");
-    }
-
-    console.log(
-      `Importing ${keystoreDefinitions.length} keystores:\n ${keystoreDefinitions
-        .map((def) => def.keystorePath)
-        .join("\n")}`
-    );
-
-    const accountPaths = getAccountPaths(args, network);
-    const persistedKeystoresBackend = new PersistedKeysBackend(accountPaths);
-    let importedCount = 0;
-
-    for (const {keystorePath, password} of keystoreDefinitions) {
-      const keystoreStr = fs.readFileSync(keystorePath, "utf8");
-      const keystore = Keystore.parse(keystoreStr);
-      const pubkeyHex = getPubkeyHexFromKeystore(keystore);
-
-      // Check if keystore can decrypt
-      if (!(await keystore.verifyPassword(password))) {
-        throw Error(`Invalid password for keystore ${keystorePath}`);
-      }
-
-      const didImportKey = persistedKeystoresBackend.writeKeystore({
-        keystoreStr,
-        password,
-        // Not used immediately
-        lockBeforeWrite: false,
-        // Return duplicate status if already found
-        persistIfDuplicate: false,
-      });
-
-      if (didImportKey) {
-        console.log(`Imported keystore ${pubkeyHex} ${keystorePath}`);
-        importedCount++;
-      } else {
-        console.log(`Duplicate keystore ${pubkeyHex} ${keystorePath}`);
-      }
-    }
-
-    console.log(`\nSuccessfully imported ${importedCount}/${keystoreDefinitions.length} keystores`);
-
-    console.log(`
-  DO NOT USE THE ORIGINAL KEYSTORES TO VALIDATE WITH
-  ANOTHER CLIENT, OR YOU WILL GET SLASHED.
-  `);
-  },
-};

package/src/cmds/validator/index.ts

@@ -1,28 +0,0 @@
-import {CliCommand} from "@lodestar/utils";
-import {GlobalArgs} from "../../options/index.js";
-import {blsToExecutionChange} from "./blsToExecutionChange.js";
-import {validatorHandler} from "./handler.js";
-import {importCmd} from "./import.js";
-import {list} from "./list.js";
-import {IValidatorCliArgs, validatorOptions} from "./options.js";
-import {getAccountPaths} from "./paths.js";
-import {slashingProtection} from "./slashingProtection/index.js";
-import {voluntaryExit} from "./voluntaryExit.js";
-
-export const validator: CliCommand<IValidatorCliArgs, GlobalArgs> = {
-  command: "validator",
-  describe: "Run one or multiple validator clients",
-  docsFolder: "run/validator-management",
-  examples: [
-    {
-      command: "validator --network hoodi",
-      title: "Base `validator` command",
-      description:
-        "Run one validator client with all the keystores available in the directory" +
-        ` ${getAccountPaths({dataDir: ".hoodi"}, "hoodi").keystoresDir}`,
-    },
-  ],
-  options: validatorOptions,
-  handler: validatorHandler,
-  subcommands: [slashingProtection, importCmd, list, voluntaryExit, blsToExecutionChange],
-};