@lodestar/state-transition 1.50.0-dev.033e6b7138 → 1.50.0-dev.040a952dd7

package/src/stateView/beaconStateView.ts

@@ -14,8 +14,6 @@ import {
   ExecutionPayloadHeader,
   Root,
   RootHex,
-  SignedBeaconBlock,
-  SignedBlindedBeaconBlock,
   Slot,
   SyncCommittee,
   ValidatorIndex,
@@ -71,7 +69,7 @@ import {getRandaoMix} from "../util/seed.js";
 import {getLatestWeakSubjectivityCheckpointEpoch} from "../util/weakSubjectivity.js";
 import {computeNewStateRootStateTransitionOpts, getComputeNewStateRootResult} from "./computeNewStateRoot.js";
 import {
-  ComputeNewStateRootInput,
+  BlockSTFInput,
   ComputeNewStateRootResult,
   IBeaconStateView,
   IBeaconStateViewGloas,
@@ -83,34 +81,36 @@ export class BeaconStateView implements IBeaconStateViewLatestFork {
   private readonly config: BeaconConfig;
   // Cached values extracted from the tree
   // phase0
-  private _fork: Fork | null = null;
-  private _latestBlockHeader: phase0.BeaconBlockHeader | null = null;
+  private cachedFork: Fork | null = null;
+  private cachedLatestBlockHeader: phase0.BeaconBlockHeader | null = null;
   // altair
-  private _currentSyncCommittee: SyncCommittee | null = null;
-  private _nextSyncCommittee: SyncCommittee | null = null;
-  private _previousEpochParticipation: Uint8Array | null = null;
-  private _currentEpochParticipation: Uint8Array | null = null;
+  private cachedCurrentSyncCommittee: SyncCommittee | null = null;
+  private cachedNextSyncCommittee: SyncCommittee | null = null;
+  private cachedPreviousEpochParticipation: Uint8Array | null = null;
+  private cachedCurrentEpochParticipation: Uint8Array | null = null;
   // bellatrix
-  private _latestExecutionPayloadHeader: ExecutionPayloadHeader | null = null;
+  private cachedLatestExecutionPayloadHeader: ExecutionPayloadHeader | null = null;
   // capella
-  private _historicalSummaries: capella.HistoricalSummaries | null = null;
+  private cachedHistoricalSummaries: capella.HistoricalSummaries | null = null;
   // electra
-  private _pendingPartialWithdrawals: electra.PendingPartialWithdrawals | null = null;
-  private _pendingConsolidations: electra.PendingConsolidations | null = null;
-  private _pendingDeposits: electra.PendingDeposits | null = null;
+  private cachedPendingPartialWithdrawals: electra.PendingPartialWithdrawals | null = null;
+  private cachedPendingConsolidations: electra.PendingConsolidations | null = null;
+  private cachedPendingDeposits: electra.PendingDeposits | null = null;
   // fulu
-  private _proposerLookahead: fulu.ProposerLookahead | null = null;
+  private cachedProposerLookahead: fulu.ProposerLookahead | null = null;
   // gloas
-  private _executionPayloadAvailability: BitArray | null = null;
-  private _latestExecutionPayloadBid: ExecutionPayloadBid | null = null;
-  private _payloadExpectedWithdrawals: capella.Withdrawal[] | null = null;
-  private _builderPendingPayments: gloas.BuilderPendingPayments | null = null;
-  private _builderPendingWithdrawals: gloas.BuilderPendingWithdrawals | null = null;
+  private cachedExecutionPayloadAvailability: BitArray | null = null;
+  private cachedLatestExecutionPayloadBid: ExecutionPayloadBid | null = null;
+  private cachedPayloadExpectedWithdrawals: capella.Withdrawal[] | null = null;
+  private cachedBuilderPendingPayments: gloas.BuilderPendingPayments | null = null;
+  private cachedBuilderPendingWithdrawals: gloas.BuilderPendingWithdrawals | null = null;
 
   constructor(readonly cachedState: CachedBeaconStateAllForks) {
     this.config = cachedState.config;
   }
 
+  release(): void {}
+
   // phase0
 
   get forkName(): ForkName {
@@ -126,10 +126,10 @@ export class BeaconStateView implements IBeaconStateViewLatestFork {
   }
 
   get fork(): Fork {
-    if (this._fork === null) {
-      this._fork = this.cachedState.fork.toValue();
+    if (this.cachedFork === null) {
+      this.cachedFork = this.cachedState.fork.toValue();
     }
-    return this._fork;
+    return this.cachedFork;
   }
 
   get epoch(): number {
@@ -149,10 +149,10 @@ export class BeaconStateView implements IBeaconStateViewLatestFork {
   }
 
   get latestBlockHeader(): phase0.BeaconBlockHeader {
-    if (this._latestBlockHeader === null) {
-      this._latestBlockHeader = this.cachedState.latestBlockHeader.toValue();
+    if (this.cachedLatestBlockHeader === null) {
+      this.cachedLatestBlockHeader = this.cachedState.latestBlockHeader.toValue();
     }
-    return this._latestBlockHeader;
+    return this.cachedLatestBlockHeader;
   }
 
   get previousJustifiedCheckpoint(): Checkpoint {
@@ -188,13 +188,13 @@ export class BeaconStateView implements IBeaconStateViewLatestFork {
       throw new Error("previousEpochParticipation is not available before Altair");
     }
 
-    if (this._previousEpochParticipation === null) {
-      this._previousEpochParticipation = (
+    if (this.cachedPreviousEpochParticipation === null) {
+      this.cachedPreviousEpochParticipation = (
         this.cachedState as CachedBeaconStateAltair
       ).previousEpochParticipation.serialize();
     }
 
-    return this._previousEpochParticipation;
+    return this.cachedPreviousEpochParticipation;
   }
 
   // altair
@@ -204,13 +204,13 @@ export class BeaconStateView implements IBeaconStateViewLatestFork {
       throw new Error("currentEpochParticipation is not available before Altair");
     }
 
-    if (this._currentEpochParticipation === null) {
-      this._currentEpochParticipation = (
+    if (this.cachedCurrentEpochParticipation === null) {
+      this.cachedCurrentEpochParticipation = (
         this.cachedState as CachedBeaconStateAltair
       ).currentEpochParticipation.serialize();
     }
 
-    return this._currentEpochParticipation;
+    return this.cachedCurrentEpochParticipation;
   }
 
   getPreviousEpochParticipation(validatorIndex: ValidatorIndex): number {
@@ -238,13 +238,13 @@ export class BeaconStateView implements IBeaconStateViewLatestFork {
       throw new Error("latestExecutionPayloadHeader is not available after Gloas");
     }
 
-    if (this._latestExecutionPayloadHeader === null) {
-      this._latestExecutionPayloadHeader = (
+    if (this.cachedLatestExecutionPayloadHeader === null) {
+      this.cachedLatestExecutionPayloadHeader = (
         this.cachedState as CachedBeaconStateExecutions
       ).latestExecutionPayloadHeader.toValue();
     }
 
-    return this._latestExecutionPayloadHeader;
+    return this.cachedLatestExecutionPayloadHeader;
   }
 
   /**
@@ -270,11 +270,11 @@ export class BeaconStateView implements IBeaconStateViewLatestFork {
       throw new Error("Historical summaries are not supported before Capella");
     }
 
-    if (this._historicalSummaries === null) {
-      this._historicalSummaries = (this.cachedState as CachedBeaconStateCapella).historicalSummaries.toValue();
+    if (this.cachedHistoricalSummaries === null) {
+      this.cachedHistoricalSummaries = (this.cachedState as CachedBeaconStateCapella).historicalSummaries.toValue();
     }
 
-    return this._historicalSummaries;
+    return this.cachedHistoricalSummaries;
   }
 
   // electra
@@ -284,11 +284,11 @@ export class BeaconStateView implements IBeaconStateViewLatestFork {
       throw new Error("Pending deposits are not supported before Electra");
     }
 
-    if (this._pendingDeposits === null) {
-      this._pendingDeposits = (this.cachedState as CachedBeaconStateElectra).pendingDeposits.toValue();
+    if (this.cachedPendingDeposits === null) {
+      this.cachedPendingDeposits = (this.cachedState as CachedBeaconStateElectra).pendingDeposits.toValue();
     }
 
-    return this._pendingDeposits;
+    return this.cachedPendingDeposits;
   }
 
   get pendingDepositsCount(): number {
@@ -304,13 +304,13 @@ export class BeaconStateView implements IBeaconStateViewLatestFork {
       throw new Error("Pending partial withdrawals are not supported before Electra");
     }
 
-    if (this._pendingPartialWithdrawals === null) {
-      this._pendingPartialWithdrawals = (
+    if (this.cachedPendingPartialWithdrawals === null) {
+      this.cachedPendingPartialWithdrawals = (
         this.cachedState as CachedBeaconStateElectra
       ).pendingPartialWithdrawals.toValue();
     }
 
-    return this._pendingPartialWithdrawals;
+    return this.cachedPendingPartialWithdrawals;
   }
 
   get pendingPartialWithdrawalsCount(): number {
@@ -326,11 +326,11 @@ export class BeaconStateView implements IBeaconStateViewLatestFork {
       throw new Error("Pending consolidations are not supported before Electra");
     }
 
-    if (this._pendingConsolidations === null) {
-      this._pendingConsolidations = (this.cachedState as CachedBeaconStateElectra).pendingConsolidations.toValue();
+    if (this.cachedPendingConsolidations === null) {
+      this.cachedPendingConsolidations = (this.cachedState as CachedBeaconStateElectra).pendingConsolidations.toValue();
     }
 
-    return this._pendingConsolidations;
+    return this.cachedPendingConsolidations;
   }
 
   get pendingConsolidationsCount(): number {
@@ -348,11 +348,11 @@ export class BeaconStateView implements IBeaconStateViewLatestFork {
       throw new Error("Proposer lookahead is not supported before Fulu");
     }
 
-    if (this._proposerLookahead === null) {
-      this._proposerLookahead = (this.cachedState as CachedBeaconStateFulu).proposerLookahead.toValue();
+    if (this.cachedProposerLookahead === null) {
+      this.cachedProposerLookahead = (this.cachedState as CachedBeaconStateFulu).proposerLookahead.toValue();
     }
 
-    return this._proposerLookahead;
+    return this.cachedProposerLookahead;
   }
 
   preVerifyBuilderDepositsPreGloas(maxBuilderDeposits: number, maxDurationMs: number): PreVerifyBuilderDepositsResult {
@@ -381,13 +381,13 @@ export class BeaconStateView implements IBeaconStateViewLatestFork {
       throw new Error("executionPayloadAvailability is not available before Gloas");
     }
 
-    if (this._executionPayloadAvailability === null) {
-      this._executionPayloadAvailability = (
+    if (this.cachedExecutionPayloadAvailability === null) {
+      this.cachedExecutionPayloadAvailability = (
         this.cachedState as CachedBeaconStateGloas
       ).executionPayloadAvailability.toValue();
     }
 
-    return this._executionPayloadAvailability;
+    return this.cachedExecutionPayloadAvailability;
   }
 
   get latestExecutionPayloadBid(): ExecutionPayloadBid {
@@ -395,12 +395,12 @@ export class BeaconStateView implements IBeaconStateViewLatestFork {
       throw new Error("latestExecutionPayloadBid is not available before Gloas");
     }
 
-    if (this._latestExecutionPayloadBid === null) {
-      this._latestExecutionPayloadBid = (
+    if (this.cachedLatestExecutionPayloadBid === null) {
+      this.cachedLatestExecutionPayloadBid = (
         this.cachedState as CachedBeaconStateGloas
       ).latestExecutionPayloadBid.toValue();
     }
-    return this._latestExecutionPayloadBid;
+    return this.cachedLatestExecutionPayloadBid;
   }
 
   get payloadExpectedWithdrawals(): capella.Withdrawal[] {
@@ -408,12 +408,12 @@ export class BeaconStateView implements IBeaconStateViewLatestFork {
       throw new Error("payloadExpectedWithdrawals is not available before Gloas");
     }
 
-    if (this._payloadExpectedWithdrawals === null) {
-      this._payloadExpectedWithdrawals = (
+    if (this.cachedPayloadExpectedWithdrawals === null) {
+      this.cachedPayloadExpectedWithdrawals = (
         this.cachedState as CachedBeaconStateGloas
       ).payloadExpectedWithdrawals.toValue();
     }
-    return this._payloadExpectedWithdrawals;
+    return this.cachedPayloadExpectedWithdrawals;
   }
 
   get builderPendingPayments(): gloas.BuilderPendingPayments {
@@ -421,10 +421,10 @@ export class BeaconStateView implements IBeaconStateViewLatestFork {
       throw new Error("Pending builder payments are not supported before Gloas");
     }
 
-    if (this._builderPendingPayments === null) {
-      this._builderPendingPayments = (this.cachedState as CachedBeaconStateGloas).builderPendingPayments.toValue();
+    if (this.cachedBuilderPendingPayments === null) {
+      this.cachedBuilderPendingPayments = (this.cachedState as CachedBeaconStateGloas).builderPendingPayments.toValue();
     }
-    return this._builderPendingPayments;
+    return this.cachedBuilderPendingPayments;
   }
 
   get builderPendingWithdrawals(): gloas.BuilderPendingWithdrawals {
@@ -432,12 +432,12 @@ export class BeaconStateView implements IBeaconStateViewLatestFork {
       throw new Error("Pending builder withdrawals are not supported before Gloas");
     }
 
-    if (this._builderPendingWithdrawals === null) {
-      this._builderPendingWithdrawals = (
+    if (this.cachedBuilderPendingWithdrawals === null) {
+      this.cachedBuilderPendingWithdrawals = (
         this.cachedState as CachedBeaconStateGloas
       ).builderPendingWithdrawals.toValue();
     }
-    return this._builderPendingWithdrawals;
+    return this.cachedBuilderPendingWithdrawals;
   }
 
   getBuilder(index: BuilderIndex): gloas.Builder {
@@ -588,11 +588,11 @@ export class BeaconStateView implements IBeaconStateViewLatestFork {
       throw new Error("currentSyncCommittee is not available before Altair");
     }
 
-    if (this._currentSyncCommittee === null) {
-      this._currentSyncCommittee = (this.cachedState as CachedBeaconStateAltair).currentSyncCommittee.toValue();
+    if (this.cachedCurrentSyncCommittee === null) {
+      this.cachedCurrentSyncCommittee = (this.cachedState as CachedBeaconStateAltair).currentSyncCommittee.toValue();
     }
 
-    return this._currentSyncCommittee;
+    return this.cachedCurrentSyncCommittee;
   }
 
   get nextSyncCommittee(): SyncCommittee {
@@ -600,11 +600,11 @@ export class BeaconStateView implements IBeaconStateViewLatestFork {
       throw new Error("nextSyncCommittee is not available before Altair");
     }
 
-    if (this._nextSyncCommittee === null) {
-      this._nextSyncCommittee = (this.cachedState as CachedBeaconStateAltair).nextSyncCommittee.toValue();
+    if (this.cachedNextSyncCommittee === null) {
+      this.cachedNextSyncCommittee = (this.cachedState as CachedBeaconStateAltair).nextSyncCommittee.toValue();
     }
 
-    return this._nextSyncCommittee;
+    return this.cachedNextSyncCommittee;
   }
 
   get currentSyncCommitteeIndexed(): SyncCommitteeCache {
@@ -872,7 +872,7 @@ export class BeaconStateView implements IBeaconStateViewLatestFork {
 
   // State transition
 
-  computeNewStateRoot({block}: ComputeNewStateRootInput, modules: StateTransitionModules): ComputeNewStateRootResult {
+  computeNewStateRoot({block}: BlockSTFInput, modules: StateTransitionModules): ComputeNewStateRootResult {
     const postState = new BeaconStateView(
       stateTransition(this.cachedState, block, computeNewStateRootStateTransitionOpts, modules)
     );
@@ -880,12 +880,11 @@ export class BeaconStateView implements IBeaconStateViewLatestFork {
   }
 
   stateTransition(
-    signedBlock: SignedBeaconBlock | SignedBlindedBeaconBlock,
+    {block}: BlockSTFInput,
     options: StateTransitionOpts,
-    {metrics, validatorMonitor}: StateTransitionModules
+    modules: StateTransitionModules
   ): IBeaconStateView {
-    const newState = stateTransition(this.cachedState, signedBlock, options, {metrics, validatorMonitor});
-    return new BeaconStateView(newState);
+    return new BeaconStateView(stateTransition(this.cachedState, block, options, modules));
   }
 
   processSlots(slot: Slot, opts?: {dontTransferCache?: boolean}, modules?: StateTransitionModules): IBeaconStateView {

package/src/stateView/interface.ts

@@ -55,10 +55,13 @@ import {StateTransitionModules, StateTransitionOpts} from "../stateTransition.js
 import {EpochShuffling} from "../util/epochShuffling.js";
 import {PreVerifyBuilderDepositsResult} from "../util/preVerifyBuilderDeposits.js";
 
-/** Inputs for computing the state root of a locally produced block. */
-export type ComputeNewStateRootInput = {
+/** Signed block to apply in a state transition. */
+export type BlockSTFInput = {
   block: SignedBeaconBlock | SignedBlindedBeaconBlock;
-  /** Pre-serialized block bytes for native implementations. */
+  /**
+   * Fork-specific SSZ serialization of `block`, using the matching full or blinded block type. Native
+   * implementations serialize `block` when omitted.
+   */
   ssz?: Uint8Array;
 };
 
@@ -159,6 +162,13 @@ export interface IBeaconStateView {
   // TODO is there a better name that is less implementation specific but still conveys the meaning?
   isStateValidatorsNodesPopulated(): boolean;
 
+  // Lifecycle
+  /**
+   * Release resources owned by this view.
+   * Do not use the view after calling this method.
+   */
+  release(): void;
+
   // Serialization
   /** Set `preloadValidatorsAndBalances` only when the whole state will be consumed
    *  immediately (e.g. CP reload before block replay). */
@@ -178,9 +188,9 @@ export interface IBeaconStateView {
   hashTreeRoot(): Uint8Array;
 
   // State transition
-  computeNewStateRoot(input: ComputeNewStateRootInput, modules: StateTransitionModules): ComputeNewStateRootResult;
+  computeNewStateRoot(input: BlockSTFInput, modules: StateTransitionModules): ComputeNewStateRootResult;
   stateTransition(
-    signedBlock: SignedBeaconBlock | SignedBlindedBeaconBlock,
+    input: BlockSTFInput,
     options: StateTransitionOpts,
     modules: StateTransitionModules
   ): IBeaconStateView;
@@ -317,33 +327,63 @@ export type IBeaconStateViewLatestFork = Omit<
 /**
  * Contract a BeaconStateView backing implementation must satisfy.
  *
- * Differs from `IBeaconStateViewLatestFork` in two ways:
- * - `executionPayloadAvailability` is a raw `{uint8Array, bitLen}` POJO — a
- *   native (`.node`) binding cannot construct a `BitArray` across FFI.
- *   `NativeBeaconStateView` lifts it back to `BitArray` for beacon-node.
- * - Methods that produce another view (`stateTransition`, `processSlots`,
- *   `loadOtherState`, `withParentPayloadApplied`) return `IBeaconStateViewNative`
- *   so callers can re-wrap without an `as unknown` cast. Param lists are reused
- *   via `Parameters<...>` to avoid duplicating signatures.
- * - `computeNewStateRoot` is implemented by the wrapper because its inputs differ
- *   between the TypeScript and Zig implementations.
- *
- * The TS-side `BeaconStateView` also structurally satisfies this contract since
- * `BitArray` exposes `uint8Array` and `bitLen`.
+ * Differs from `IBeaconStateViewLatestFork` in these ways:
+ * - SSZ-backed lists use serialized bytes or native typed arrays at the FFI boundary.
+ * - Methods that produce another view return `IBeaconStateViewNative` so callers can re-wrap them.
+ * - `stateTransition` accepts the native block inputs and omits JS-only modules.
+ * - `computeNewStateRoot` is implemented by the wrapper because its inputs differ between implementations.
  */
 export type IBeaconStateViewNative = Omit<
   IBeaconStateViewLatestFork,
+  | "builderPendingPayments"
+  | "builderPendingWithdrawals"
+  | "computeAttestationsRewards"
+  | "computeBlockRewards"
   | "computeNewStateRoot"
+  | "computeSyncCommitteeRewards"
+  | "eth1Data"
   | "executionPayloadAvailability"
+  | "getBeaconCommittee"
+  | "getIndicesInPayloadTimelinessCommittee"
+  | "getPayloadTimelinessCommittee"
   | "loadOtherState"
-  | "stateTransition"
+  | "pendingConsolidations"
+  | "pendingDeposits"
+  | "pendingPartialWithdrawals"
+  | "preVerifyBuilderDepositsPreGloas"
+  | "clearPreGloasBuilderDepositCache"
   | "processSlots"
+  | "proposerLookahead"
+  | "stateTransition"
   | "withParentPayloadApplied"
 > & {
+  pendingDeposits: Uint8Array;
+  pendingPartialWithdrawals: Uint8Array;
+  pendingConsolidations: Uint8Array;
+  proposerLookahead: Uint32Array;
+  // UintBn64 lowers to number across the FFI boundary; the wrapper lifts it back to bigint
+  eth1Data: phase0.Eth1Data;
   executionPayloadAvailability: {uint8Array: Uint8Array; bitLen: number};
+  computeBlockRewards(
+    signedBlockBytes: Uint8Array,
+    isBlinded: boolean,
+    proposerRewards?: RewardCache
+  ): rewards.BlockRewards;
+  computeAttestationsRewards(validatorIds?: (ValidatorIndex | string)[]): rewards.AttestationsRewards;
+  computeSyncCommitteeRewards(
+    block: BeaconBlock,
+    validatorIds: (ValidatorIndex | string)[]
+  ): rewards.SyncCommitteeRewards;
+  getBeaconCommittee(slot: Slot, index: CommitteeIndex): Uint32Array;
+  getIndexInPayloadTimelinessCommittee?(validatorIndex: ValidatorIndex, slot: Slot): number;
+  getIndicesInPayloadTimelinessCommittee?(validatorIndex: ValidatorIndex, slot: Slot): number[];
   loadOtherState(...args: Parameters<IBeaconStateViewLatestFork["loadOtherState"]>): IBeaconStateViewNative;
-  stateTransition(...args: Parameters<IBeaconStateViewLatestFork["stateTransition"]>): IBeaconStateViewNative;
-  processSlots(...args: Parameters<IBeaconStateViewLatestFork["processSlots"]>): IBeaconStateViewNative;
+  stateTransition(
+    signedBlockBytes: Uint8Array,
+    isBlinded: boolean,
+    options?: StateTransitionOpts
+  ): IBeaconStateViewNative;
+  processSlots(slot: Slot, opts?: {dontTransferCache?: boolean}): IBeaconStateViewNative;
   withParentPayloadApplied(
     ...args: Parameters<IBeaconStateViewLatestFork["withParentPayloadApplied"]>
   ): IBeaconStateViewNative;