@lodestar/params 1.35.0-dev.feed916580 → 1.35.0-rc.1

package/src/setPreset.ts

@@ -0,0 +1,48 @@
+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;
+}

package/src/types.ts

@@ -0,0 +1,228 @@
+/**
+ * Compile-time chain configuration
+ */
+export type BeaconPreset = {
+  // Misc
+  MAX_COMMITTEES_PER_SLOT: number;
+  TARGET_COMMITTEE_SIZE: number;
+  MAX_VALIDATORS_PER_COMMITTEE: number;
+
+  SHUFFLE_ROUND_COUNT: number;
+
+  HYSTERESIS_QUOTIENT: number;
+  HYSTERESIS_DOWNWARD_MULTIPLIER: number;
+  HYSTERESIS_UPWARD_MULTIPLIER: number;
+
+  // Gwei Values
+  MIN_DEPOSIT_AMOUNT: number;
+  MAX_EFFECTIVE_BALANCE: number;
+  EFFECTIVE_BALANCE_INCREMENT: number;
+
+  // Time parameters
+  MIN_ATTESTATION_INCLUSION_DELAY: number;
+  SLOTS_PER_EPOCH: number;
+  MIN_SEED_LOOKAHEAD: number;
+  MAX_SEED_LOOKAHEAD: number;
+  EPOCHS_PER_ETH1_VOTING_PERIOD: number;
+  SLOTS_PER_HISTORICAL_ROOT: number;
+  MIN_EPOCHS_TO_INACTIVITY_PENALTY: number;
+
+  // State vector lengths
+  EPOCHS_PER_HISTORICAL_VECTOR: number;
+  EPOCHS_PER_SLASHINGS_VECTOR: number;
+  HISTORICAL_ROOTS_LIMIT: number;
+  VALIDATOR_REGISTRY_LIMIT: number;
+
+  // Reward and penalty quotients
+  BASE_REWARD_FACTOR: number;
+  WHISTLEBLOWER_REWARD_QUOTIENT: number;
+  PROPOSER_REWARD_QUOTIENT: number;
+  INACTIVITY_PENALTY_QUOTIENT: number;
+  MIN_SLASHING_PENALTY_QUOTIENT: number;
+  PROPORTIONAL_SLASHING_MULTIPLIER: number;
+
+  // Max operations per block
+  MAX_PROPOSER_SLASHINGS: number;
+  MAX_ATTESTER_SLASHINGS: number;
+  MAX_ATTESTATIONS: number;
+  MAX_DEPOSITS: number;
+  MAX_VOLUNTARY_EXITS: number;
+
+  // ALTAIR
+  /////////
+  SYNC_COMMITTEE_SIZE: number;
+  EPOCHS_PER_SYNC_COMMITTEE_PERIOD: number;
+  INACTIVITY_PENALTY_QUOTIENT_ALTAIR: number;
+  MIN_SLASHING_PENALTY_QUOTIENT_ALTAIR: number;
+  PROPORTIONAL_SLASHING_MULTIPLIER_ALTAIR: number;
+  MIN_SYNC_COMMITTEE_PARTICIPANTS: number;
+  UPDATE_TIMEOUT: number;
+
+  // BELLATRIX
+  ////////////
+  INACTIVITY_PENALTY_QUOTIENT_BELLATRIX: number;
+  MIN_SLASHING_PENALTY_QUOTIENT_BELLATRIX: number;
+  PROPORTIONAL_SLASHING_MULTIPLIER_BELLATRIX: number;
+  MAX_BYTES_PER_TRANSACTION: number;
+  MAX_TRANSACTIONS_PER_PAYLOAD: number;
+  BYTES_PER_LOGS_BLOOM: number;
+  MAX_EXTRA_DATA_BYTES: number;
+
+  // CAPELLA
+  //////////
+  MAX_BLS_TO_EXECUTION_CHANGES: number;
+  MAX_WITHDRAWALS_PER_PAYLOAD: number;
+  MAX_VALIDATORS_PER_WITHDRAWALS_SWEEP: number;
+
+  // DENEB
+  ///////////
+  FIELD_ELEMENTS_PER_BLOB: number;
+  MAX_BLOB_COMMITMENTS_PER_BLOCK: number;
+  KZG_COMMITMENT_INCLUSION_PROOF_DEPTH: number;
+
+  // ELECTRA
+  MAX_DEPOSIT_REQUESTS_PER_PAYLOAD: number;
+  MAX_WITHDRAWAL_REQUESTS_PER_PAYLOAD: number;
+  MAX_ATTESTER_SLASHINGS_ELECTRA: number;
+  MAX_ATTESTATIONS_ELECTRA: number;
+  MAX_PENDING_PARTIALS_PER_WITHDRAWALS_SWEEP: number;
+  MAX_PENDING_DEPOSITS_PER_EPOCH: number;
+  MAX_EFFECTIVE_BALANCE_ELECTRA: number;
+  MIN_SLASHING_PENALTY_QUOTIENT_ELECTRA: number;
+  MIN_ACTIVATION_BALANCE: number;
+  PENDING_DEPOSITS_LIMIT: number;
+  PENDING_PARTIAL_WITHDRAWALS_LIMIT: number;
+  PENDING_CONSOLIDATIONS_LIMIT: number;
+  MAX_CONSOLIDATION_REQUESTS_PER_PAYLOAD: number;
+  WHISTLEBLOWER_REWARD_QUOTIENT_ELECTRA: number;
+
+  // FULU
+  ///////////
+  NUMBER_OF_COLUMNS: number;
+  CELLS_PER_EXT_BLOB: number;
+  FIELD_ELEMENTS_PER_CELL: number;
+  FIELD_ELEMENTS_PER_EXT_BLOB: number;
+  KZG_COMMITMENTS_INCLUSION_PROOF_DEPTH: number;
+
+  // GLOAS
+  PTC_SIZE: number;
+  MAX_PAYLOAD_ATTESTATIONS: number;
+  BUILDER_PENDING_WITHDRAWALS_LIMIT: number;
+};
+
+/**
+ * Presets only contain numbers, just used to filter out extraneous keys
+ * when overriding the active preset with custom values from file
+ */
+export const beaconPresetTypes: BeaconPresetTypes = {
+  // Misc
+  MAX_COMMITTEES_PER_SLOT: "number",
+  TARGET_COMMITTEE_SIZE: "number",
+  MAX_VALIDATORS_PER_COMMITTEE: "number",
+
+  SHUFFLE_ROUND_COUNT: "number",
+
+  HYSTERESIS_QUOTIENT: "number",
+  HYSTERESIS_DOWNWARD_MULTIPLIER: "number",
+  HYSTERESIS_UPWARD_MULTIPLIER: "number",
+
+  // Gwei Values
+  MIN_DEPOSIT_AMOUNT: "number",
+  MAX_EFFECTIVE_BALANCE: "number",
+  EFFECTIVE_BALANCE_INCREMENT: "number",
+
+  // Time parameters
+  MIN_ATTESTATION_INCLUSION_DELAY: "number",
+  SLOTS_PER_EPOCH: "number",
+  MIN_SEED_LOOKAHEAD: "number",
+  MAX_SEED_LOOKAHEAD: "number",
+  EPOCHS_PER_ETH1_VOTING_PERIOD: "number",
+  SLOTS_PER_HISTORICAL_ROOT: "number",
+  MIN_EPOCHS_TO_INACTIVITY_PENALTY: "number",
+
+  // State vector lengths
+  EPOCHS_PER_HISTORICAL_VECTOR: "number",
+  EPOCHS_PER_SLASHINGS_VECTOR: "number",
+  HISTORICAL_ROOTS_LIMIT: "number",
+  VALIDATOR_REGISTRY_LIMIT: "number",
+
+  // Reward and penalty quotients
+  BASE_REWARD_FACTOR: "number",
+  WHISTLEBLOWER_REWARD_QUOTIENT: "number",
+  PROPOSER_REWARD_QUOTIENT: "number",
+  INACTIVITY_PENALTY_QUOTIENT: "number",
+  MIN_SLASHING_PENALTY_QUOTIENT: "number",
+  PROPORTIONAL_SLASHING_MULTIPLIER: "number",
+
+  // Max operations per block
+  MAX_PROPOSER_SLASHINGS: "number",
+  MAX_ATTESTER_SLASHINGS: "number",
+  MAX_ATTESTATIONS: "number",
+  MAX_DEPOSITS: "number",
+  MAX_VOLUNTARY_EXITS: "number",
+
+  // ALTAIR
+  /////////
+  SYNC_COMMITTEE_SIZE: "number",
+  EPOCHS_PER_SYNC_COMMITTEE_PERIOD: "number",
+  INACTIVITY_PENALTY_QUOTIENT_ALTAIR: "number",
+  MIN_SLASHING_PENALTY_QUOTIENT_ALTAIR: "number",
+  PROPORTIONAL_SLASHING_MULTIPLIER_ALTAIR: "number",
+  MIN_SYNC_COMMITTEE_PARTICIPANTS: "number",
+  UPDATE_TIMEOUT: "number",
+
+  // BELLATRIX
+  ////////////
+  INACTIVITY_PENALTY_QUOTIENT_BELLATRIX: "number",
+  MIN_SLASHING_PENALTY_QUOTIENT_BELLATRIX: "number",
+  PROPORTIONAL_SLASHING_MULTIPLIER_BELLATRIX: "number",
+  MAX_BYTES_PER_TRANSACTION: "number",
+  MAX_TRANSACTIONS_PER_PAYLOAD: "number",
+  BYTES_PER_LOGS_BLOOM: "number",
+  MAX_EXTRA_DATA_BYTES: "number",
+
+  // CAPELLA
+  //////////
+  MAX_BLS_TO_EXECUTION_CHANGES: "number",
+  MAX_WITHDRAWALS_PER_PAYLOAD: "number",
+  MAX_VALIDATORS_PER_WITHDRAWALS_SWEEP: "number",
+
+  // DENEB
+  ///////////
+  FIELD_ELEMENTS_PER_BLOB: "number",
+  MAX_BLOB_COMMITMENTS_PER_BLOCK: "number",
+  KZG_COMMITMENT_INCLUSION_PROOF_DEPTH: "number",
+
+  // ELECTRA
+  MAX_DEPOSIT_REQUESTS_PER_PAYLOAD: "number",
+  MAX_WITHDRAWAL_REQUESTS_PER_PAYLOAD: "number",
+  MAX_ATTESTER_SLASHINGS_ELECTRA: "number",
+  MAX_ATTESTATIONS_ELECTRA: "number",
+  MAX_PENDING_PARTIALS_PER_WITHDRAWALS_SWEEP: "number",
+  MAX_PENDING_DEPOSITS_PER_EPOCH: "number",
+  MAX_EFFECTIVE_BALANCE_ELECTRA: "number",
+  MIN_SLASHING_PENALTY_QUOTIENT_ELECTRA: "number",
+  MIN_ACTIVATION_BALANCE: "number",
+  PENDING_DEPOSITS_LIMIT: "number",
+  PENDING_PARTIAL_WITHDRAWALS_LIMIT: "number",
+  PENDING_CONSOLIDATIONS_LIMIT: "number",
+  MAX_CONSOLIDATION_REQUESTS_PER_PAYLOAD: "number",
+  WHISTLEBLOWER_REWARD_QUOTIENT_ELECTRA: "number",
+
+  // FULU
+  ///////////
+  NUMBER_OF_COLUMNS: "number",
+  CELLS_PER_EXT_BLOB: "number",
+  FIELD_ELEMENTS_PER_CELL: "number",
+  FIELD_ELEMENTS_PER_EXT_BLOB: "number",
+  KZG_COMMITMENTS_INCLUSION_PROOF_DEPTH: "number",
+
+  // GLOAS
+  PTC_SIZE: "number",
+  MAX_PAYLOAD_ATTESTATIONS: "number",
+  BUILDER_PENDING_WITHDRAWALS_LIMIT: "number",
+};
+
+type BeaconPresetTypes = {
+  [K in keyof BeaconPreset]: "number";
+};