@lodestar/params/src/setPreset.ts

Chain parameters required for lodestar

import {presetFromJson} from "./json.js";
import {PresetName} from "./presetName.js";
import {presetStatus} from "./presetStatus.js";
import {BeaconPreset} from "./types.js";

export {PresetName, presetFromJson};

/**
 * The preset name currently exported by this library
 *
 * The `LODESTAR_PRESET` environment variable is used to select the active preset
 * If `LODESTAR_PRESET` is not set, the default is `mainnet`.
 *
 * The active preset can be manually overridden with `setActivePreset`
 */
export let userSelectedPreset: PresetName | null = null;

export let userOverrides: Partial<BeaconPreset> | undefined = undefined;

/**
 * Override the active preset
 *
 * WARNING: Lodestar libraries rely on preset values being _constant_, so the active preset must be set _before_ loading any other lodestar libraries.
 *
 * Only call this function if you _really_ know what you are doing.
 *
 * @param presetName - the preset to use as a base
 * @param overrides - customized fields
 */
export function setActivePreset(presetName: PresetName | null, overrides?: Partial<BeaconPreset>): void {
  if (presetStatus.frozen) {
    throw Error(`Lodestar preset is already frozen. You must call setActivePreset() at the top of your
application entry point, before importing @lodestar/params, or any library that may import it.

\`\`\`
// index.ts
import {setActivePreset, PresetName} from "@lodestar/params/setPreset"
setActivePreset(PresetName.minimal)
// Now you can safely import from other paths and consume params
import {SLOTS_PER_EPOCH} from "@lodestar/params"
console.log({SLOTS_PER_EPOCH})
\`\`\`
`);
  }

  userSelectedPreset = presetName;
  userOverrides = overrides;
}