@lodestar/state-transition 1.35.0-dev.955e9f89ed → 1.35.0-dev.98d359db41

package/src/util/genesis.ts

@@ -0,0 +1,343 @@
+import {CompositeViewDU, ListCompositeType} from "@chainsafe/ssz";
+import {ChainForkConfig} from "@lodestar/config";
+import {
+  EFFECTIVE_BALANCE_INCREMENT,
+  EPOCHS_PER_HISTORICAL_VECTOR,
+  ForkName,
+  ForkSeq,
+  GENESIS_EPOCH,
+  GENESIS_SLOT,
+  MAX_EFFECTIVE_BALANCE,
+  UNSET_DEPOSIT_REQUESTS_START_INDEX,
+} from "@lodestar/params";
+import {Bytes32, Root, TimeSeconds, phase0, ssz} from "@lodestar/types";
+import {processDeposit} from "../block/processDeposit.js";
+import {EpochCacheImmutableData} from "../cache/epochCache.js";
+import {createCachedBeaconState} from "../cache/stateCache.js";
+import {increaseBalance} from "../index.js";
+import {BeaconStateAllForks, CachedBeaconStateAllForks, CachedBeaconStateElectra} from "../types.js";
+import {newFilledArray} from "./array.js";
+import {getTemporaryBlockHeader} from "./blockRoot.js";
+import {computeEpochAtSlot} from "./epoch.js";
+import {getNextSyncCommittee} from "./syncCommittee.js";
+import {getActiveValidatorIndices, getMaxEffectiveBalance} from "./validator.js";
+
+type DepositDataRootListType = ListCompositeType<typeof ssz.Root>;
+type DepositDataRootViewDU = CompositeViewDU<DepositDataRootListType>;
+
+// TODO: Refactor to work with non-phase0 genesis state
+
+/**
+ * Check if it's valid genesis state.
+ * @param config
+ * @param state
+ */
+export function isValidGenesisState(config: ChainForkConfig, state: BeaconStateAllForks): boolean {
+  return state.genesisTime >= config.MIN_GENESIS_TIME && isValidGenesisValidators(config, state);
+}
+
+/**
+ * Check if it's valid genesis validators state.
+ * @param config
+ * @param state
+ */
+export function isValidGenesisValidators(config: ChainForkConfig, state: BeaconStateAllForks): boolean {
+  return (
+    getActiveValidatorIndices(state, computeEpochAtSlot(GENESIS_SLOT)).length >=
+    config.MIN_GENESIS_ACTIVE_VALIDATOR_COUNT
+  );
+}
+
+/**
+ * Generate the initial beacon chain state.
+ *
+ * SLOW CODE - 🐢
+ */
+export function getGenesisBeaconState(
+  config: ChainForkConfig,
+  genesisEth1Data: phase0.Eth1Data,
+  latestBlockHeader: phase0.BeaconBlockHeader
+): BeaconStateAllForks {
+  // Seed RANDAO with Eth1 entropy
+  const randaoMixes = newFilledArray(EPOCHS_PER_HISTORICAL_VECTOR, genesisEth1Data.blockHash);
+
+  const beaconStateType = config.getForkTypes(GENESIS_SLOT).BeaconState;
+  const state = beaconStateType.defaultViewDU();
+
+  // MISC
+  state.slot = GENESIS_SLOT;
+  const version = config.getForkVersion(GENESIS_SLOT);
+  const forkName = config.getForkName(GENESIS_SLOT);
+  const allForkNames = Object.keys(config.forks) as ForkName[];
+  const forkIndex = allForkNames.findIndex((item) => item === forkName);
+  const previousForkIndex = Math.max(0, forkIndex - 1);
+  const previousForkName = allForkNames[previousForkIndex];
+  const previousFork = config.forks[previousForkName];
+
+  // the altair genesis spec test requires previous version to be phase0 although ALTAIR_FORK_EPOCH=0
+  state.fork = ssz.phase0.Fork.toViewDU({
+    previousVersion: previousFork.version,
+    currentVersion: version,
+    epoch: computeEpochAtSlot(GENESIS_SLOT),
+  });
+
+  // Validator registry
+
+  // Randomness and committees
+  state.latestBlockHeader = ssz.phase0.BeaconBlockHeader.toViewDU(latestBlockHeader);
+
+  // Ethereum 1.0 chain data
+  state.eth1Data = ssz.phase0.Eth1Data.toViewDU(genesisEth1Data);
+  state.randaoMixes = ssz.phase0.RandaoMixes.toViewDU(randaoMixes);
+
+  return state;
+}
+
+/**
+ * Apply eth1 block hash to state.
+ * @param config ChainForkConfig
+ * @param state BeaconState
+ * @param eth1BlockHash eth1 block hash
+ */
+export function applyEth1BlockHash(state: CachedBeaconStateAllForks, eth1BlockHash: Bytes32): void {
+  state.eth1Data.blockHash = eth1BlockHash;
+  state.randaoMixes = ssz.phase0.RandaoMixes.toViewDU(newFilledArray(EPOCHS_PER_HISTORICAL_VECTOR, eth1BlockHash));
+}
+
+/**
+ * Apply eth1 block timestamp to state.
+ * @param config IBeaconState
+ * @param state BeaconState
+ * @param eth1Timestamp eth1 block timestamp
+ */
+export function applyTimestamp(config: ChainForkConfig, state: CachedBeaconStateAllForks, eth1Timestamp: number): void {
+  state.genesisTime = eth1Timestamp + config.GENESIS_DELAY;
+}
+
+/**
+ * Apply deposits to state.
+ * For spec test, fullDepositDataRootList is undefined.
+ * For genesis builder, fullDepositDataRootList is full list of deposit data root from index 0.
+ *
+ * SLOW CODE - 🐢
+ *
+ * @param config ChainForkConfig
+ * @param state BeaconState
+ * @param newDeposits new deposits
+ * @param fullDepositDataRootList full list of deposit data root from index 0
+ * @returns active validator indices
+ */
+export function applyDeposits(
+  config: ChainForkConfig,
+  state: CachedBeaconStateAllForks,
+  newDeposits: phase0.Deposit[],
+  fullDepositDataRootList?: DepositDataRootViewDU
+): {activatedValidatorCount: number} {
+  const fork = config.getForkSeq(state.slot);
+  const depositDataRootList: Root[] = [];
+
+  const fullDepositDataRootArr = fullDepositDataRootList ? fullDepositDataRootList.getAllReadonlyValues() : null;
+
+  if (fullDepositDataRootArr) {
+    const depositCount = state.eth1Data.depositCount;
+    for (let index = 0; index < depositCount; index++) {
+      depositDataRootList.push(fullDepositDataRootArr[index]);
+    }
+  }
+
+  const initDepositCount = depositDataRootList.length;
+  const depositDatas = fullDepositDataRootList ? null : newDeposits.map((deposit) => deposit.data);
+  const {DepositData, DepositDataRootList} = ssz.phase0;
+
+  for (const [index, deposit] of newDeposits.entries()) {
+    if (fullDepositDataRootArr) {
+      depositDataRootList.push(fullDepositDataRootArr[index + initDepositCount]);
+      state.eth1Data.depositRoot = DepositDataRootList.hashTreeRoot(depositDataRootList);
+    } else if (depositDatas) {
+      const depositDataList = depositDatas.slice(0, index + 1);
+      state.eth1Data.depositRoot = DepositDataRootList.hashTreeRoot(
+        depositDataList.map((d) => DepositData.hashTreeRoot(d))
+      );
+    }
+
+    state.eth1Data.depositCount += 1;
+
+    const fork = config.getForkSeq(GENESIS_SLOT);
+    processDeposit(fork, state, deposit);
+  }
+
+  // Process deposit balance updates
+  if (fork >= ForkSeq.electra) {
+    const stateElectra = state as CachedBeaconStateElectra;
+    stateElectra.commit();
+    for (const {pubkey, amount} of stateElectra.pendingDeposits.getAllReadonly()) {
+      const validatorIndex = state.epochCtx.getValidatorIndex(pubkey);
+      if (validatorIndex === null) {
+        // Should not happen if the gensis state is correct
+        continue;
+      }
+      increaseBalance(state, validatorIndex, amount);
+    }
+    stateElectra.pendingDeposits = ssz.electra.PendingDeposits.defaultViewDU();
+  }
+
+  // Process activations
+  const {epochCtx} = state;
+  const balancesArr = state.balances.getAll();
+  const validatorCount = state.validators.length;
+  let activatedValidatorCount = 0;
+
+  for (let i = 0; i < validatorCount; i++) {
+    // For the case if effective balance has to be updated, get a mutable view
+    const validator = state.validators.get(i);
+
+    // Already active, ignore
+    if (validator.activationEpoch === GENESIS_EPOCH) {
+      continue;
+    }
+
+    const balance = balancesArr[i];
+    const effectiveBalance = Math.min(
+      balance - (balance % EFFECTIVE_BALANCE_INCREMENT),
+      getMaxEffectiveBalance(validator.withdrawalCredentials)
+    );
+
+    validator.effectiveBalance = effectiveBalance;
+    epochCtx.effectiveBalanceIncrementsSet(i, effectiveBalance);
+
+    if (validator.effectiveBalance >= MAX_EFFECTIVE_BALANCE) {
+      validator.activationEligibilityEpoch = GENESIS_EPOCH;
+      validator.activationEpoch = GENESIS_EPOCH;
+      activatedValidatorCount++;
+    }
+  }
+
+  // Set genesis validators root for domain separation and chain versioning
+  // .hashTreeRoot() automatically commits()
+  state.genesisValidatorsRoot = state.validators.hashTreeRoot();
+
+  return {activatedValidatorCount};
+}
+
+/**
+ * Mainly used for spec test.
+ *
+ * SLOW CODE - 🐢
+ */
+export function initializeBeaconStateFromEth1(
+  config: ChainForkConfig,
+  immutableData: EpochCacheImmutableData,
+  eth1BlockHash: Bytes32,
+  eth1Timestamp: TimeSeconds,
+  deposits: phase0.Deposit[],
+  fullDepositDataRootList?: DepositDataRootViewDU,
+  executionPayloadHeader?: CompositeViewDU<
+    | typeof ssz.bellatrix.ExecutionPayloadHeader
+    | typeof ssz.capella.ExecutionPayloadHeader
+    | typeof ssz.deneb.ExecutionPayloadHeader
+    | typeof ssz.electra.ExecutionPayloadHeader
+  >
+): CachedBeaconStateAllForks {
+  const stateView = getGenesisBeaconState(
+    // CachedBeaconcState is used for convinience only, we return BeaconStateAllForks anyway
+    // so it's safe to do a cast here, we can't use get domain until we have genesisValidatorRoot
+    config,
+    ssz.phase0.Eth1Data.defaultValue(),
+    getTemporaryBlockHeader(config, config.getForkTypes(GENESIS_SLOT).BeaconBlock.defaultValue())
+  );
+
+  const fork = config.getForkSeq(GENESIS_SLOT);
+
+  // We need a CachedBeaconState to run processDeposit() which uses various caches.
+  // However at this point the state's syncCommittees are not known.
+  // This function can be called by:
+  // - 1. genesis spec tests: Don't care about the committee cache
+  // - 2. genesis builder: Only supports starting from genesis at phase0 fork
+  // - 3. interop state: Only supports starting from genesis at phase0 fork
+  // So it's okay to skip syncing the sync committee cache here and expect it to be
+  // populated latter when the altair fork happens for cases 2, 3.
+  const state = createCachedBeaconState(stateView, immutableData, {skipSyncCommitteeCache: true});
+
+  applyTimestamp(config, state, eth1Timestamp);
+  applyEth1BlockHash(state, eth1BlockHash);
+
+  // Process deposits
+  applyDeposits(config, state, deposits, fullDepositDataRootList);
+
+  // Commit before reading all validators in `getActiveValidatorIndices()`
+  state.commit();
+  const activeValidatorIndices = getActiveValidatorIndices(state, computeEpochAtSlot(GENESIS_SLOT));
+
+  if (fork >= ForkSeq.altair) {
+    const {syncCommittee} = getNextSyncCommittee(
+      fork,
+      state,
+      activeValidatorIndices,
+      state.epochCtx.effectiveBalanceIncrements
+    );
+    const stateAltair = state as CompositeViewDU<typeof ssz.altair.BeaconState>;
+    stateAltair.fork.previousVersion = config.ALTAIR_FORK_VERSION;
+    stateAltair.fork.currentVersion = config.ALTAIR_FORK_VERSION;
+    stateAltair.currentSyncCommittee = ssz.altair.SyncCommittee.toViewDU(syncCommittee);
+    stateAltair.nextSyncCommittee = ssz.altair.SyncCommittee.toViewDU(syncCommittee);
+  }
+
+  if (fork >= ForkSeq.bellatrix) {
+    const stateBellatrix = state as CompositeViewDU<typeof ssz.bellatrix.BeaconState>;
+    stateBellatrix.fork.previousVersion = config.BELLATRIX_FORK_VERSION;
+    stateBellatrix.fork.currentVersion = config.BELLATRIX_FORK_VERSION;
+    stateBellatrix.latestExecutionPayloadHeader =
+      (executionPayloadHeader as CompositeViewDU<typeof ssz.bellatrix.ExecutionPayloadHeader>) ??
+      ssz.bellatrix.ExecutionPayloadHeader.defaultViewDU();
+  }
+
+  if (fork >= ForkSeq.capella) {
+    const stateCapella = state as CompositeViewDU<typeof ssz.capella.BeaconState>;
+    stateCapella.fork.previousVersion = config.CAPELLA_FORK_VERSION;
+    stateCapella.fork.currentVersion = config.CAPELLA_FORK_VERSION;
+    stateCapella.latestExecutionPayloadHeader =
+      (executionPayloadHeader as CompositeViewDU<typeof ssz.capella.ExecutionPayloadHeader>) ??
+      ssz.capella.ExecutionPayloadHeader.defaultViewDU();
+  }
+
+  if (fork >= ForkSeq.deneb) {
+    const stateDeneb = state as CompositeViewDU<typeof ssz.deneb.BeaconState>;
+    stateDeneb.fork.previousVersion = config.DENEB_FORK_VERSION;
+    stateDeneb.fork.currentVersion = config.DENEB_FORK_VERSION;
+    stateDeneb.latestExecutionPayloadHeader =
+      (executionPayloadHeader as CompositeViewDU<typeof ssz.deneb.ExecutionPayloadHeader>) ??
+      ssz.deneb.ExecutionPayloadHeader.defaultViewDU();
+  }
+
+  if (fork >= ForkSeq.electra) {
+    const stateElectra = state as CompositeViewDU<typeof ssz.electra.BeaconState>;
+    stateElectra.fork.previousVersion = config.ELECTRA_FORK_VERSION;
+    stateElectra.fork.currentVersion = config.ELECTRA_FORK_VERSION;
+    stateElectra.latestExecutionPayloadHeader =
+      (executionPayloadHeader as CompositeViewDU<typeof ssz.electra.ExecutionPayloadHeader>) ??
+      ssz.electra.ExecutionPayloadHeader.defaultViewDU();
+    stateElectra.depositRequestsStartIndex = UNSET_DEPOSIT_REQUESTS_START_INDEX;
+  }
+
+  if (fork >= ForkSeq.fulu) {
+    const stateFulu = state as CompositeViewDU<typeof ssz.fulu.BeaconState>;
+    stateFulu.fork.previousVersion = config.FULU_FORK_VERSION;
+    stateFulu.fork.currentVersion = config.FULU_FORK_VERSION;
+    stateFulu.latestExecutionPayloadHeader =
+      (executionPayloadHeader as CompositeViewDU<typeof ssz.fulu.ExecutionPayloadHeader>) ??
+      ssz.fulu.ExecutionPayloadHeader.defaultViewDU();
+  }
+
+  if (fork >= ForkSeq.gloas) {
+    const stateGloas = state as CompositeViewDU<typeof ssz.gloas.BeaconState>;
+    stateGloas.fork.previousVersion = config.GLOAS_FORK_VERSION;
+    stateGloas.fork.currentVersion = config.GLOAS_FORK_VERSION;
+    stateGloas.latestExecutionPayloadHeader =
+      (executionPayloadHeader as CompositeViewDU<typeof ssz.gloas.ExecutionPayloadHeader>) ??
+      ssz.gloas.ExecutionPayloadHeader.defaultViewDU();
+  }
+
+  state.commit();
+
+  return state;
+}

package/src/util/index.ts

@@ -0,0 +1,29 @@
+export * from "./aggregator.js";
+export * from "./array.js";
+export * from "./attestation.js";
+export * from "./attesterStatus.js";
+export * from "./balance.js";
+export * from "./blindedBlock.js";
+export * from "./blockRoot.js";
+export * from "./calculateCommitteeAssignments.js";
+export * from "./capella.js";
+export * from "./computeAnchorCheckpoint.js";
+export * from "./deposit.js";
+export * from "./domain.js";
+export * from "./electra.js";
+export * from "./epoch.js";
+export * from "./epochShuffling.js";
+export * from "./execution.js";
+export * from "./finality.js";
+export * from "./genesis.js";
+export * from "./interop.js";
+export * from "./loadState/index.js";
+export * from "./rootCache.js";
+export * from "./seed.js";
+export * from "./shufflingDecisionRoot.js";
+export * from "./signatureSets.js";
+export * from "./signingRoot.js";
+export * from "./slot.js";
+export * from "./syncCommittee.js";
+export * from "./validator.js";
+export * from "./weakSubjectivity.js";

package/src/util/interop.ts

@@ -0,0 +1,22 @@
+import {toBufferBE} from "bigint-buffer";
+import {digest} from "@chainsafe/as-sha256";
+import {SecretKey} from "@chainsafe/blst";
+import {bytesToBigInt, intToBytes} from "@lodestar/utils";
+
+let curveOrder: bigint;
+function getCurveOrder(): bigint {
+  if (!curveOrder) curveOrder = BigInt("52435875175126190479447740508185965837690552500527637822603658699938581184513");
+  return curveOrder;
+}
+
+export function interopSecretKeys(validatorCount: number): SecretKey[] {
+  return Array.from({length: validatorCount}, (_, i) => {
+    return interopSecretKey(i);
+  });
+}
+
+export function interopSecretKey(index: number): SecretKey {
+  const CURVE_ORDER = getCurveOrder();
+  const secretKeyBytes = toBufferBE(bytesToBigInt(digest(intToBytes(index, 32))) % CURVE_ORDER, 32);
+  return SecretKey.fromBytes(secretKeyBytes);
+}

package/src/util/loadState/findModifiedInactivityScores.ts

@@ -0,0 +1,47 @@
+// UintNum64 = 8 bytes
+export const INACTIVITY_SCORE_SIZE = 8;
+
+/**
+ * As monitored on mainnet, inactivityScores are not changed much and they are mostly 0
+ * Using Buffer.compare is the fastest way as noted in `./findModifiedValidators.ts`
+ * @returns output parameter modifiedValidators: validator indices that are modified
+ */
+export function findModifiedInactivityScores(
+  inactivityScoresBytes: Uint8Array,
+  inactivityScoresBytes2: Uint8Array,
+  modifiedValidators: number[],
+  validatorOffset = 0
+): void {
+  if (inactivityScoresBytes.length !== inactivityScoresBytes2.length) {
+    throw new Error(
+      "inactivityScoresBytes.length !== inactivityScoresBytes2.length " +
+        inactivityScoresBytes.length +
+        " vs " +
+        inactivityScoresBytes2.length
+    );
+  }
+
+  if (Buffer.compare(inactivityScoresBytes, inactivityScoresBytes2) === 0) {
+    return;
+  }
+
+  if (inactivityScoresBytes.length === INACTIVITY_SCORE_SIZE) {
+    modifiedValidators.push(validatorOffset);
+    return;
+  }
+
+  const numValidator = Math.floor(inactivityScoresBytes.length / INACTIVITY_SCORE_SIZE);
+  const halfValidator = Math.floor(numValidator / 2);
+  findModifiedInactivityScores(
+    inactivityScoresBytes.subarray(0, halfValidator * INACTIVITY_SCORE_SIZE),
+    inactivityScoresBytes2.subarray(0, halfValidator * INACTIVITY_SCORE_SIZE),
+    modifiedValidators,
+    validatorOffset
+  );
+  findModifiedInactivityScores(
+    inactivityScoresBytes.subarray(halfValidator * INACTIVITY_SCORE_SIZE),
+    inactivityScoresBytes2.subarray(halfValidator * INACTIVITY_SCORE_SIZE),
+    modifiedValidators,
+    validatorOffset + halfValidator
+  );
+}

package/src/util/loadState/findModifiedValidators.ts

@@ -0,0 +1,46 @@
+import {VALIDATOR_BYTES_SIZE} from "../sszBytes.js";
+
+/**
+ * Find modified validators by comparing two validators bytes using Buffer.compare() recursively
+ * - As noted in packages/state-transition/test/perf/util/loadState/findModifiedValidators.test.ts, serializing validators and compare Uint8Array is the fastest way
+ * - The performance is quite stable and can afford a lot of difference in validators (the benchmark tested up to 10k but it's not likely we have that difference in mainnet)
+ * - Also packages/state-transition/test/perf/misc/byteArrayEquals.test.ts shows that Buffer.compare() is very efficient for large Uint8Array
+ *
+ * @returns output parameter modifiedValidators: validator indices that are modified
+ */
+export function findModifiedValidators(
+  validatorsBytes: Uint8Array,
+  validatorsBytes2: Uint8Array,
+  modifiedValidators: number[],
+  validatorOffset = 0
+): void {
+  if (validatorsBytes.length !== validatorsBytes2.length) {
+    throw new Error(
+      "validatorsBytes.length !== validatorsBytes2.length " + validatorsBytes.length + " vs " + validatorsBytes2.length
+    );
+  }
+
+  if (Buffer.compare(validatorsBytes, validatorsBytes2) === 0) {
+    return;
+  }
+
+  if (validatorsBytes.length === VALIDATOR_BYTES_SIZE) {
+    modifiedValidators.push(validatorOffset);
+    return;
+  }
+
+  const numValidator = Math.floor(validatorsBytes.length / VALIDATOR_BYTES_SIZE);
+  const halfValidator = Math.floor(numValidator / 2);
+  findModifiedValidators(
+    validatorsBytes.subarray(0, halfValidator * VALIDATOR_BYTES_SIZE),
+    validatorsBytes2.subarray(0, halfValidator * VALIDATOR_BYTES_SIZE),
+    modifiedValidators,
+    validatorOffset
+  );
+  findModifiedValidators(
+    validatorsBytes.subarray(halfValidator * VALIDATOR_BYTES_SIZE),
+    validatorsBytes2.subarray(halfValidator * VALIDATOR_BYTES_SIZE),
+    modifiedValidators,
+    validatorOffset + halfValidator
+  );
+}

package/src/util/loadState/index.ts

@@ -0,0 +1,2 @@
+export {loadState, loadStateAndValidators} from "./loadState.js";
+export {getEffectiveBalancesFromStateBytes} from "./loadValidator.js";