test: deployment blocks for indexed contracts

Author: PaulRBerg

TODOs.md

@@ -1,12 +1,10 @@
 # Priority 1
 
 - [ ] Add instructions in the README
-- [ ] Consider what to do with `admin` and `fee`
 - [ ] Refactor `data` broadcasts to get rid of `mainnets` and `testnets` dichotomy
 
 # Priority 2
 
-- [ ] Test to ensure that all indexed contracts have a deployment block
 - [ ] Check why Sophon tests don't work
 - [ ] Add just script for printing available chain names
 - [ ] Add `@unimplemented` tag for `compilerSettings`

biome.jsonc

@@ -6,11 +6,11 @@
   },
   "overrides": [
     {
-      "includes": ["**/{scripts,tests}/**/*.ts"],
+      "includes": ["**/tests/**/*.ts"],
       "linter": {
         "rules": {
-          "suspicious": {
-            "noFocusedTests": "off"
+          "style": {
+            "noNonNullAssertion": "off"
           }
         }
       }

tests/contracts.test.ts renamed to tests/contracts/catalog.test.ts

@@ -3,30 +3,8 @@ import queries from "@src/queries";
 import { releases, releasesByVersion } from "@src/releases";
 import axios from "axios";
 import _ from "lodash";
-import { isAddress } from "viem";
 import { describe, expect, it } from "vitest";
-import etherscanChainIds from "./setup/etherscan";
-
-/**
- * @note Use https://ethsum.netlify.app to fix failing tests
- */
-describe("Address checksums", () => {
-  for (const release of releases) {
-    describe(`${release.protocol} ${release.version}`, () => {
-      const contracts = queries.contracts.getAll({ release });
-      if (!contracts) {
-        logAndThrow({ msg: "No contracts found", release });
-      }
-
-      for (const contract of contracts) {
-        it(`${contract.name} should have a checksummed address`, () => {
-          const message = `Found non-checksummed address: ${contract.address}`;
-          expect(isAddress(contract.address), message).toBe(true);
-        });
-      }
-    });
-  }
-});
+import etherscanChainIds from "../setup/etherscan";
 
 describe("Contract catalog", () => {
   const releasesToTest = [

tests/contracts/checksums.test.ts

@@ -0,0 +1,22 @@
+import queries from "@src/queries";
+import { releases } from "@src/releases";
+import { isAddress } from "viem";
+import { describe, expect, it } from "vitest";
+
+/**
+ * @note Use https://ethsum.netlify.app to fix failing tests
+ */
+describe("Address checksums", () => {
+  for (const release of releases) {
+    describe(`${release.protocol} ${release.version}`, () => {
+      const contracts = queries.contracts.getAll({ release })!;
+
+      for (const contract of contracts) {
+        it(`${contract.name} should have a checksummed address`, () => {
+          const errorMsg = `Found non-checksummed address: ${contract.address}`;
+          expect(isAddress(contract.address), errorMsg).toBe(true);
+        });
+      }
+    });
+  }
+});

tests/contracts/deployment-blocks.test.ts

@@ -0,0 +1,45 @@
+
+import { names } from "@src/contracts";
+import { Protocol } from "@src/enums";
+import queries from "@src/queries";
+import { releases } from "@src/releases";
+import type { Sablier } from "@src/types";
+import { describe, expect, it } from "vitest";
+
+// These contracts are indexed by the Sablier Indexers, so they require a deployment block number.
+// See https://github.com/sablier-labs/indexers
+const INDEXED: Record<Sablier.Protocol, string[]> = {
+  [Protocol.Airdrops]: [
+    names.SABLIER_MERKLE_FACTORY,
+    names.SABLIER_V2_MERKLE_LOCKUP_FACTORY,
+    names.SABLIER_V2_MERKLE_STREAMER_FACTORY,
+  ],
+  [Protocol.Flow]: [names.SABLIER_FLOW],
+  [Protocol.Legacy]: [],
+  [Protocol.Lockup]: [
+    names.SABLIER_V2_LOCKUP_LINEAR,
+    names.SABLIER_V2_LOCKUP_DYNAMIC,
+    names.SABLIER_V2_LOCKUP_TRANCHED,
+    names.SABLIER_LOCKUP,
+  ],
+};
+
+describe("Deployment blocks", () => {
+  for (const release of releases) {
+    describe(`${release.protocol} ${release.version}`, () => {
+      const contracts = queries.contracts.getAll({ release })!;
+
+      for (const contract of contracts) {
+        if (!INDEXED[release.protocol].includes(contract.name)) {
+          it.skip(`Skipped ${contract.name} because it's not an indexed contract.`, () => {});
+          continue;
+        }
+
+        it(`${contract.name} should have a deployment block number`, () => {
+          const errorMsg = `No block number found for ${contract.name}`;
+          expect(contract.block, errorMsg).toBeDefined();
+        });
+      }
+    });
+  }
+});

vitest.config.ts

@@ -8,7 +8,7 @@ function getInclude() {
   const paths: string[] = [];
 
   if (TEST_ONLY_CONTRACTS) {
-    paths.push("tests/contracts.test.ts");
+    paths.push("tests/contracts/**/*.test.ts");
   }
   if (TEST_ONLY_CHAINS) {
     paths.push("tests/chains.test.ts");