test: rename to "missing-broadcasts"

test: rename to "componentName"

Author: PaulRBerg

tests/utils/generators.ts

@@ -1,10 +1,10 @@
 import { getChain } from "@src/helpers";
+import { isLockupV1Release } from "@src/helpers";
 import type { Sablier } from "@src/types";
-import { isLockupV1Release } from "@src/types";
 import _ from "lodash";
 import { beforeAll, describe, expect, it } from "vitest";
 import { findContract, findZKContract, loadBroadcastJSON, loadZKBroadcastJSONs } from "./helpers";
-import { isKnownMissing } from "./known-missing";
+import { isKnownMissing } from "./missing-broadcasts";
 import type { BroadcastJSON, ZKBroadcastJSON } from "./types";
 
 /**
@@ -41,7 +41,7 @@ export function validateZKContract(contract: Sablier.Contract, zkBroadcast: ZKBr
  */
 interface TestConfig<BD, CD> {
   finder: (data: BD, contractName: string) => CD | null;
-  loader: (release: Sablier.Release, chain: Sablier.Chain, releaseModule?: string) => Promise<BD | null>;
+  loader: (release: Sablier.Release, chain: Sablier.Chain, componentName?: string) => Promise<BD | null>;
   validator: (contract: Sablier.Contract, data: CD) => void;
 }
 
@@ -51,13 +51,13 @@ function createInnerTests<BD, CD>(
   release: Sablier.Release,
   chain: Sablier.Chain,
   contracts: Sablier.Contract[],
-  releaseModule?: string,
+  componentName?: string,
 ): void {
   describe(testDescription, () => {
     let broadcastData: BD | null;
 
     beforeAll(async () => {
-      broadcastData = await testConfig.loader(release, chain, releaseModule);
+      broadcastData = await testConfig.loader(release, chain, componentName);
     });
 
     for (const contract of contracts) {
@@ -73,7 +73,6 @@ function createInnerTests<BD, CD>(
           // As a fallback, we check if this contract has already been validated. Some contracts
           // are shared between releases (e.g., Comptroller in Lockup v1.0 and v1.1).
           const previouslyValidated = _.get(validated, [contract.address, contract.name, chain.id]);
-          // TODO: throw more explanatory error message
           expect(previouslyValidated).toBeTruthy();
           return;
         }

tests/utils/helpers.ts

@@ -76,9 +76,9 @@ export function findInLibraries(data: BroadcastJSON, contractName: string): Sabl
 export async function loadBroadcastJSON(
   release: Sablier.Release,
   chain: Sablier.Chain,
-  releaseModule?: string,
+  componentName?: string,
 ): Promise<BroadcastJSON | null> {
-  const foundPath = await checkBroadcast(release, chain, releaseModule);
+  const foundPath = await checkBroadcast(release, chain, componentName);
   if (!foundPath) {
     return null;
   }
@@ -93,9 +93,9 @@ export async function loadBroadcastJSON(
 export async function loadZKBroadcastJSONs(
   release: Sablier.Release,
   chain: Sablier.Chain,
-  releaseModule?: string,
+  componentName?: string,
 ): Promise<ZKBroadcastJSON[] | null> {
-  const dirs = await checkZKBroadcast(release, chain, releaseModule);
+  const dirs = await checkZKBroadcast(release, chain, componentName);
   if (!dirs) {
     return null;
   }

tests/utils/loaders.ts

@@ -7,9 +7,9 @@ import type { BroadcastJSON, ZKBroadcastJSON } from "./types";
 export async function loadBroadcastJSON(
   release: Sablier.Release,
   chain: Sablier.Chain,
-  releaseModule?: string,
+  componentName?: string,
 ): Promise<BroadcastJSON | null> {
-  const foundPath = await checkBroadcast(release, chain, releaseModule);
+  const foundPath = await checkBroadcast(release, chain, componentName);
   if (!foundPath) {
     return null;
   }
@@ -24,9 +24,9 @@ export async function loadBroadcastJSON(
 export async function loadZKBroadcastJSONs(
   release: Sablier.Release,
   chain: Sablier.Chain,
-  releaseModule?: string,
+  componentName?: string,
 ): Promise<ZKBroadcastJSON[] | null> {
-  const dirs = await checkZKBroadcast(release, chain, releaseModule);
+  const dirs = await checkZKBroadcast(release, chain, componentName);
   if (!dirs) {
     return null;
   }

tests/utils/known-missing.ts renamed to tests/utils/missing-broadcasts.ts

@@ -2,22 +2,22 @@ import { ChainId } from "@src/chains/ids";
 import { names as lockupNamesV1_0 } from "@src/releases/lockup/v1.0/manifest";
 import { names as lockupNamesV1_1 } from "@src/releases/lockup/v1.1/manifest";
 import type { Sablier } from "@src/types";
-import { versions } from "@src/versions";
 import _ from "lodash";
 
 type ContractMap = Record<string, boolean>;
 type ChainMap = Record<number, ContractMap>;
 type VersionMap = Partial<Record<Sablier.Version, ChainMap>>;
 type ProtocolMap = Partial<Record<Sablier.Protocol, VersionMap>>;
 
-export const knownMissing: ProtocolMap = {
+// A map of known missing broadcasts.
+export const missingBroadcasts: ProtocolMap = {
   lockup: {
-    [versions.lockup.v1_0]: {
+    "v1.0": {
       [ChainId.ARBITRUM_SEPOLIA]: {
         [lockupNamesV1_0.core.SABLIER_V2_COMPTROLLER]: true,
       },
     },
-    [versions.lockup.v1_1]: {
+    "v1.1": {
       [ChainId.ARBITRUM_ONE]: {
         [lockupNamesV1_1.core.SABLIER_V2_LOCKUP_LINEAR]: true,
         [lockupNamesV1_1.core.SABLIER_V2_NFT_DESCRIPTOR]: true,
@@ -57,5 +57,5 @@ export const knownMissing: ProtocolMap = {
 };
 
 export function isKnownMissing(release: Sablier.Release, chain: Sablier.Chain, contractName: string): boolean {
-  return _.get(knownMissing, [release.protocol, release.version, chain.id, contractName]) ?? false;
+  return _.get(missingBroadcasts, [release.protocol, release.version, chain.id, contractName]) ?? false;
 }