@lodestar/state-transition 1.35.0-dev.0c6f50771f → 1.35.0-dev.248b252a94

package/src/cache/effectiveBalanceIncrements.ts

@@ -0,0 +1,39 @@
+import {EFFECTIVE_BALANCE_INCREMENT} from "@lodestar/params";
+import {BeaconStateAllForks} from "../types.js";
+
+/**
+ * Alias to allow easier refactoring.
+ */
+export type EffectiveBalanceIncrements = Uint16Array;
+
+/** Helper to prevent re-writting tests downstream if we change Uint16Array to number[] */
+export function getEffectiveBalanceIncrementsZeroed(len: number): EffectiveBalanceIncrements {
+  return new Uint16Array(len);
+}
+
+/**
+ * effectiveBalanceIncrements length will always be equal or greater than validatorCount. The
+ * getEffectiveBalanceIncrementsByteLen() modulo is used to reduce the frequency at which its Uint16Array is recreated.
+ * if effectiveBalanceIncrements has length greater than validatorCount it's not a problem since those values would
+ * never be accessed.
+ */
+export function getEffectiveBalanceIncrementsWithLen(validatorCount: number): EffectiveBalanceIncrements {
+  // TODO: Research what's the best number to minimize both memory cost and copy costs
+  const byteLen = 1024 * Math.ceil(validatorCount / 1024);
+
+  return new Uint16Array(byteLen);
+}
+
+/**
+ * Shows how EffectiveBalanceIncrements is meant to be populated.
+ * In practice this function should not be used, since it more efficient to loop the validators array once and do
+ * more tasks than only populating effectiveBalanceIncrements
+ */
+export function getEffectiveBalanceIncrements(state: BeaconStateAllForks): EffectiveBalanceIncrements {
+  const validatorsArr = state.validators.getAllReadonlyValues();
+  const effectiveBalanceIncrements = new Uint16Array(validatorsArr.length);
+  for (let i = 0; i < validatorsArr.length; i++) {
+    effectiveBalanceIncrements[i] = Math.floor(validatorsArr[i].effectiveBalance / EFFECTIVE_BALANCE_INCREMENT);
+  }
+  return effectiveBalanceIncrements;
+}