refactor: use SubnetID type from CL spec instead of number

Author: nflaig

packages/beacon-node/src/api/impl/validator/utils.ts

@@ -1,15 +1,15 @@
 import {routes} from "@lodestar/api";
 import {ATTESTATION_SUBNET_COUNT} from "@lodestar/params";
 import {BeaconStateAllForks, computeSlotsSinceEpochStart} from "@lodestar/state-transition";
-import {BLSPubkey, CommitteeIndex, ProducedBlockSource, Slot, ValidatorIndex} from "@lodestar/types";
+import {BLSPubkey, CommitteeIndex, ProducedBlockSource, Slot, SubnetID, ValidatorIndex} from "@lodestar/types";
 import {MAX_BUILDER_BOOST_FACTOR} from "@lodestar/validator";
 import {BlockSelectionResult, BuilderBlockSelectionReason, EngineBlockSelectionReason} from "./index.js";
 
 export function computeSubnetForCommitteesAtSlot(
   slot: Slot,
   committeesAtSlot: number,
   committeeIndex: CommitteeIndex
-): number {
+): SubnetID {
   const slotsSinceEpochStart = computeSlotsSinceEpochStart(slot);
   const committeesSinceEpochStart = committeesAtSlot * slotsSinceEpochStart;
   return (committeesSinceEpochStart + committeeIndex) % ATTESTATION_SUBNET_COUNT;

packages/beacon-node/src/chain/errors/blobSidecarError.ts

@@ -1,4 +1,4 @@
-import {RootHex, Slot, ValidatorIndex} from "@lodestar/types";
+import {RootHex, Slot, SubnetID, ValidatorIndex} from "@lodestar/types";
 import {GossipActionError} from "./gossipValidation.js";
 
 export enum BlobSidecarErrorCode {
@@ -26,7 +26,7 @@ export enum BlobSidecarErrorCode {
 }
 
 export type BlobSidecarErrorType =
-  | {code: BlobSidecarErrorCode.INVALID_INDEX; blobIdx: number; subnet: number}
+  | {code: BlobSidecarErrorCode.INVALID_INDEX; blobIdx: number; subnet: SubnetID}
   | {code: BlobSidecarErrorCode.INVALID_KZG; blobIdx: number}
   | {code: BlobSidecarErrorCode.INVALID_KZG_TXS}
   | {code: BlobSidecarErrorCode.INCORRECT_SLOT; blockSlot: Slot; blobSlot: Slot; blobIdx: number}

packages/beacon-node/src/chain/opPools/syncCommitteeMessagePool.ts

@@ -146,7 +146,7 @@ function aggregateSignatureInto(
  * Format `signature` into an efficient `contribution` to add more signatures in with aggregateSignatureInto()
  */
 function signatureToAggregate(
-  subnet: number,
+  subnet: Subnet,
   signature: altair.SyncCommitteeMessage,
   indexInSubcommittee: number
 ): ContributionFast {

packages/beacon-node/src/chain/seenCache/seenAttestationData.ts

@@ -1,5 +1,5 @@
 import {BitArray} from "@chainsafe/ssz";
-import {CommitteeIndex, RootHex, Slot, phase0} from "@lodestar/types";
+import {CommitteeIndex, RootHex, Slot, SubnetID, phase0} from "@lodestar/types";
 import {MapDef} from "@lodestar/utils";
 import {Metrics} from "../../metrics/metrics.js";
 import {InsertOutcome} from "../opPools/types.js";
@@ -23,7 +23,7 @@ export type AttestationDataCacheEntry = {
   // caching this for 3 slots take 600 instances max, this is nothing compared to attestations processed per slot
   // for example in a mainnet node subscribing to all subnets, attestations are processed up to 20k per slot
   attestationData: phase0.AttestationData;
-  subnet: number;
+  subnet: SubnetID;
 };
 
 export enum RejectReason {

packages/beacon-node/src/chain/seenCache/seenCommittee.ts

@@ -38,6 +38,6 @@ export class SeenSyncCommitteeMessages {
   }
 }
 
-function seenCacheKey(subnet: number, validatorIndex: ValidatorIndex): ValidatorSubnetKey {
+function seenCacheKey(subnet: SubcommitteeIndex, validatorIndex: ValidatorIndex): ValidatorSubnetKey {
   return `${subnet}-${validatorIndex}`;
 }

packages/beacon-node/src/chain/validation/attestation.ts

@@ -27,6 +27,7 @@ import {
   Root,
   RootHex,
   Slot,
+  SubnetID,
   electra,
   isElectraAttestation,
   phase0,
@@ -58,7 +59,7 @@ export type BatchResult = {
 export type AttestationValidationResult = {
   attestation: Attestation;
   indexedAttestation: IndexedAttestation;
-  subnet: number;
+  subnet: SubnetID;
   attDataRootHex: RootHex;
   committeeIndex: CommitteeIndex;
 };
@@ -93,7 +94,7 @@ export async function validateGossipAttestationsSameAttData(
   fork: ForkName,
   chain: IBeaconChain,
   attestationOrBytesArr: GossipAttestation[],
-  subnet: number,
+  subnet: SubnetID,
   // for unit test, consumers do not need to pass this
   step0ValidationFn = validateAttestationNoSignatureCheck
 ): Promise<BatchResult> {
@@ -232,7 +233,7 @@ async function validateAttestationNoSignatureCheck(
   chain: IBeaconChain,
   attestationOrBytes: AttestationOrBytes,
   /** Optional, to allow verifying attestations through API with unknown subnet */
-  subnet: number | null
+  subnet: SubnetID | null
 ): Promise<Step0Result> {
   // Do checks in this order:
   // - do early checks (w/o indexed attestation)
@@ -342,7 +343,7 @@ async function validateAttestationNoSignatureCheck(
 
   let committeeValidatorIndices: Uint32Array;
   let getSigningRoot: () => Uint8Array;
-  let expectedSubnet: number;
+  let expectedSubnet: SubnetID;
   if (attestationOrCache.cache) {
     committeeValidatorIndices = attestationOrCache.cache.committeeValidatorIndices;
     const signingRoot = attestationOrCache.cache.signingRoot;
@@ -762,7 +763,7 @@ export function getCommitteeIndices(
 /**
  * Compute the correct subnet for a slot/committee index
  */
-export function computeSubnetForSlot(shuffling: EpochShuffling, slot: number, committeeIndex: number): number {
+export function computeSubnetForSlot(shuffling: EpochShuffling, slot: number, committeeIndex: number): SubnetID {
   const slotsSinceEpochStart = slot % SLOTS_PER_EPOCH;
   const committeesSinceEpochStart = shuffling.committeesPerSlot * slotsSinceEpochStart;
   return (committeesSinceEpochStart + committeeIndex) % ATTESTATION_SUBNET_COUNT;

packages/beacon-node/src/chain/validation/blobSidecar.ts

@@ -1,7 +1,7 @@
 import {ChainConfig} from "@lodestar/config";
 import {KZG_COMMITMENT_INCLUSION_PROOF_DEPTH, KZG_COMMITMENT_SUBTREE_INDEX0} from "@lodestar/params";
 import {computeStartSlotAtEpoch, getBlockHeaderProposerSignatureSet} from "@lodestar/state-transition";
-import {BlobIndex, Root, Slot, deneb, ssz} from "@lodestar/types";
+import {BlobIndex, Root, Slot, SubnetID, deneb, ssz} from "@lodestar/types";
 import {toRootHex, verifyMerkleBranch} from "@lodestar/utils";
 
 import {byteArrayEquals} from "../../util/bytes.js";
@@ -14,7 +14,7 @@ import {RegenCaller} from "../regen/index.js";
 export async function validateGossipBlobSidecar(
   chain: IBeaconChain,
   blobSidecar: deneb.BlobSidecar,
-  subnet: number
+  subnet: SubnetID
 ): Promise<void> {
   const blobSlot = blobSidecar.signedBlockHeader.message.slot;
 
@@ -227,6 +227,6 @@ function validateInclusionProof(blobSidecar: deneb.BlobSidecar): boolean {
   );
 }
 
-function computeSubnetForBlobSidecar(blobIndex: BlobIndex, config: ChainConfig): number {
+function computeSubnetForBlobSidecar(blobIndex: BlobIndex, config: ChainConfig): SubnetID {
   return blobIndex % config.BLOB_SIDECAR_SUBNET_COUNT;
 }

packages/beacon-node/src/chain/validation/syncCommittee.ts

@@ -1,6 +1,6 @@
 import {SYNC_COMMITTEE_SUBNET_COUNT, SYNC_COMMITTEE_SUBNET_SIZE} from "@lodestar/params";
 import {CachedBeaconStateAllForks} from "@lodestar/state-transition";
-import {altair} from "@lodestar/types";
+import {SubnetID, altair} from "@lodestar/types";
 import {toRootHex} from "@lodestar/utils";
 import {GossipAction, SyncCommitteeError, SyncCommitteeErrorCode} from "../errors/index.js";
 import {IBeaconChain} from "../interface.js";
@@ -14,7 +14,7 @@ type IndexInSubcommittee = number;
 export async function validateGossipSyncCommittee(
   chain: IBeaconChain,
   syncCommittee: altair.SyncCommitteeMessage,
-  subnet: number
+  subnet: SubnetID
 ): Promise<{indexInSubcommittee: IndexInSubcommittee}> {
   const {slot, validatorIndex, beaconBlockRoot} = syncCommittee;
   const messageRoot = toRootHex(beaconBlockRoot);
@@ -103,7 +103,7 @@ async function validateSyncCommitteeSigOnly(
 export function validateGossipSyncCommitteeExceptSig(
   chain: IBeaconChain,
   headState: CachedBeaconStateAllForks,
-  subnet: number,
+  subnet: SubnetID,
   data: Pick<altair.SyncCommitteeMessage, "slot" | "validatorIndex">
 ): IndexInSubcommittee {
   const {slot, validatorIndex} = data;
@@ -144,7 +144,7 @@ export function validateGossipSyncCommitteeExceptSig(
  */
 function getIndexInSubcommittee(
   headState: CachedBeaconStateAllForks,
-  subnet: number,
+  subnet: SubnetID,
   data: Pick<altair.SyncCommitteeMessage, "slot" | "validatorIndex">
 ): IndexInSubcommittee | null {
   const syncCommittee = headState.epochCtx.getIndexedSyncCommittee(data.slot);

packages/beacon-node/src/metrics/validatorMonitor.ts

@@ -10,7 +10,7 @@ import {
   parseAttesterFlags,
   parseParticipationFlags,
 } from "@lodestar/state-transition";
-import {BeaconBlock, RootHex, altair, deneb} from "@lodestar/types";
+import {BeaconBlock, RootHex, SubnetID, altair, deneb} from "@lodestar/types";
 import {Epoch, Slot, ValidatorIndex} from "@lodestar/types";
 import {IndexedAttestation, SignedAggregateAndProof} from "@lodestar/types";
 import {LogData, LogHandler, LogLevel, Logger, MapDef, MapDefMax, toRootHex} from "@lodestar/utils";
@@ -52,7 +52,7 @@ export type ValidatorMonitor = {
   onPoolSubmitUnaggregatedAttestation(
     seenTimestampSec: number,
     indexedAttestation: IndexedAttestation,
-    subnet: number,
+    subnet: SubnetID,
     sentPeers: number
   ): void;
   onPoolSubmitAggregatedAttestation(

packages/beacon-node/src/network/core/metrics.ts

@@ -1,3 +1,4 @@
+import {SubnetID} from "@lodestar/types";
 import {RegistryMetricCreator} from "../../metrics/utils/registryMetricCreator.js";
 import {SubnetType} from "../metadata.js";
 import {DiscoveredPeerStatus} from "../peers/discover.js";
@@ -194,14 +195,14 @@ export function createNetworkCoreMetrics(register: RegistryMetricCreator) {
         name: "lodestar_attnets_service_committee_subscriptions_total",
         help: "Count of committee subscriptions",
       }),
-      subscriptionsCommitteeMeshPeers: register.histogram<{subnet: number}>({
+      subscriptionsCommitteeMeshPeers: register.histogram<{subnet: SubnetID}>({
         name: "lodestar_attnets_service_committee_subscriptions_mesh_peers",
         help: "Histogram of mesh peers per committee subscription",
         labelNames: ["subnet"],
         // Dlow = 6, D = 8, DHi = 12 plus 2 more buckets
         buckets: [0, 4, 6, 8, 12],
       }),
-      subscriptionsCommitteeTimeToStableMesh: register.histogram<{subnet: number}>({
+      subscriptionsCommitteeTimeToStableMesh: register.histogram<{subnet: SubnetID}>({
         name: "lodestar_attnets_service_committee_subscriptions_time_to_stable_mesh_seconds",
         help: "Histogram of time until committee subscription is considered healthy (>= 6 mesh peers)",
         labelNames: ["subnet"],
@@ -216,12 +217,12 @@ export function createNetworkCoreMetrics(register: RegistryMetricCreator) {
         name: "lodestar_attnets_service_long_lived_subscriptions_total",
         help: "Count of long lived subscriptions",
       }),
-      subscribeSubnets: register.gauge<{subnet: number; src: SubnetSource}>({
+      subscribeSubnets: register.gauge<{subnet: SubnetID; src: SubnetSource}>({
         name: "lodestar_attnets_service_subscribe_subnets_total",
         help: "Count of subscribe_subnets calls",
         labelNames: ["subnet", "src"],
       }),
-      unsubscribeSubnets: register.gauge<{subnet: number; src: SubnetSource}>({
+      unsubscribeSubnets: register.gauge<{subnet: SubnetID; src: SubnetSource}>({
         name: "lodestar_attnets_service_unsubscribe_subnets_total",
         help: "Count of unsubscribe_subnets calls",
         labelNames: ["subnet", "src"],
@@ -237,12 +238,12 @@ export function createNetworkCoreMetrics(register: RegistryMetricCreator) {
         name: "lodestar_syncnets_service_committee_subscriptions_total",
         help: "Count of syncnet committee subscriptions",
       }),
-      subscribeSubnets: register.gauge<{subnet: number}>({
+      subscribeSubnets: register.gauge<{subnet: SubnetID}>({
         name: "lodestar_syncnets_service_subscribe_subnets_total",
         help: "Count of syncnet subscribe_subnets calls",
         labelNames: ["subnet"],
       }),
-      unsubscribeSubnets: register.gauge<{subnet: number}>({
+      unsubscribeSubnets: register.gauge<{subnet: SubnetID}>({
         name: "lodestar_syncnets_service_unsubscribe_subnets_total",
         help: "Count of syncnet unsubscribe_subnets calls",
         labelNames: ["subnet"],