refactor: sort keys and imports

build: use biome v2
refactor: use type instead of interface
refactor: use spaces instead of tabs for indents

Author: PaulRBerg

.vscode/settings.json

@@ -1,8 +1,8 @@
 {
   "biome.enabled": true,
   "editor.codeActionsOnSave": {
-    "quickfix.biome": "always",
-    "source.organizeImports.biome": "always"
+    "source.fixAll.biome": "always",
+    "source.organizeImports.biome": "explicit"
   },
   "[javascript][json][jsonc][typescript]": {
     "editor.defaultFormatter": "biomejs.biome"

biome.jsonc

@@ -2,12 +2,11 @@
   "$schema": "./node_modules/@biomejs/biome/configuration_schema.json",
   "extends": ["@sablier/configs/biome"],
   "files": {
-    "ignore": ["/dist/"],
-    "include": ["*.js", "*.json", "*.jsonc", "*.ts"]
+    "includes": ["**/*.js", "**/*.json", "**/*.jsonc", "**/*.ts"]
   },
   "overrides": [
     {
-      "include": ["tests/*"],
+      "includes": ["**/tests/*"],
       "linter": {
         "rules": {
           "suspicious": {

bun.lock

@@ -4,11 +4,11 @@
     "": {
       "name": "@sablier/deployments",
       "dependencies": {
-        "@sablier/configs": "github:sablier-labs/configs",
         "lodash": "^4.17",
       },
       "devDependencies": {
-        "@biomejs/biome": "1.9.4",
+        "@biomejs/biome": "2.0.0-beta.4",
+        "@sablier/configs": "github:sablier-labs/configs",
         "@types/fs-extra": "^11.0",
         "@types/lodash": "^4.17",
         "@types/node": "^22.14",
@@ -31,23 +31,23 @@
   "packages": {
     "@adraffy/ens-normalize": ["@adraffy/[email protected]", "", {}, "sha512-/3DDPKHqqIqxUULp8yP4zODUY1i+2xvVWsv8A79xGWdCAG+8sb0hRh0Rk2QyOJUnnbyPUAZYcpBuRe3nS2OIUg=="],
 
-    "@biomejs/biome": ["@biomejs/biome@1.9.4", "", { "optionalDependencies": { "@biomejs/cli-darwin-arm64": "1.9.4", "@biomejs/cli-darwin-x64": "1.9.4", "@biomejs/cli-linux-arm64": "1.9.4", "@biomejs/cli-linux-arm64-musl": "1.9.4", "@biomejs/cli-linux-x64": "1.9.4", "@biomejs/cli-linux-x64-musl": "1.9.4", "@biomejs/cli-win32-arm64": "1.9.4", "@biomejs/cli-win32-x64": "1.9.4" }, "bin": { "biome": "bin/biome" } }, "sha512-1rkd7G70+o9KkTn5KLmDYXihGoTaIGO9PIIN2ZB7UJxFrWw04CZHPYiMRjYsaDvVV7hP1dYNRLxSANLaBFGpog=="],
+    "@biomejs/biome": ["@biomejs/biome@2.0.0-beta.4", "", { "optionalDependencies": { "@biomejs/cli-darwin-arm64": "2.0.0-beta.4", "@biomejs/cli-darwin-x64": "2.0.0-beta.4", "@biomejs/cli-linux-arm64": "2.0.0-beta.4", "@biomejs/cli-linux-arm64-musl": "2.0.0-beta.4", "@biomejs/cli-linux-x64": "2.0.0-beta.4", "@biomejs/cli-linux-x64-musl": "2.0.0-beta.4", "@biomejs/cli-win32-arm64": "2.0.0-beta.4", "@biomejs/cli-win32-x64": "2.0.0-beta.4" }, "bin": { "biome": "bin/biome" } }, "sha512-xKdyKTTveVfNthvoyNPEsp+PXU3Iz1n4wgTQKWBEdqxgw4JpQ/W7gBBiLqjVtegEBCc4+sAp+MOA2UH9Tqfxpg=="],
 
-    "@biomejs/cli-darwin-arm64": ["@biomejs/cli-darwin-arm64@1.9.4", "", { "os": "darwin", "cpu": "arm64" }, "sha512-bFBsPWrNvkdKrNCYeAp+xo2HecOGPAy9WyNyB/jKnnedgzl4W4Hb9ZMzYNbf8dMCGmUdSavlYHiR01QaYR58cw=="],
+    "@biomejs/cli-darwin-arm64": ["@biomejs/cli-darwin-arm64@2.0.0-beta.4", "", { "os": "darwin", "cpu": "arm64" }, "sha512-gELCMhP72d2ADWBev3Fc11YO9j7LdfMBGrPetwWtsYSNMiqP/ww5rXxHkodqu/J63PSw0M8oGJ1slZbF4QsuRA=="],
 
-    "@biomejs/cli-darwin-x64": ["@biomejs/cli-darwin-x64@1.9.4", "", { "os": "darwin", "cpu": "x64" }, "sha512-ngYBh/+bEedqkSevPVhLP4QfVPCpb+4BBe2p7Xs32dBgs7rh9nY2AIYUL6BgLw1JVXV8GlpKmb/hNiuIxfPfZg=="],
+    "@biomejs/cli-darwin-x64": ["@biomejs/cli-darwin-x64@2.0.0-beta.4", "", { "os": "darwin", "cpu": "x64" }, "sha512-OnbNtCoG+Vhh3xuQcxnbeg1e54eBlyH6bhNc+7i2HS+diC3ntOtBttkV5menBzabktEGrE0d0L9ftwzuCL0zwQ=="],
 
-    "@biomejs/cli-linux-arm64": ["@biomejs/cli-linux-arm64@1.9.4", "", { "os": "linux", "cpu": "arm64" }, "sha512-fJIW0+LYujdjUgJJuwesP4EjIBl/N/TcOX3IvIHJQNsAqvV2CHIogsmA94BPG6jZATS4Hi+xv4SkBBQSt1N4/g=="],
+    "@biomejs/cli-linux-arm64": ["@biomejs/cli-linux-arm64@2.0.0-beta.4", "", { "os": "linux", "cpu": "arm64" }, "sha512-IzSohzD68di/uoGzXMK9B8gJrhU7v2czPCJOLuZH1WgRmK4ejUzaGyi1JpNpFlP1mRtfAWfbJkYP57BUD+4mSA=="],
 
-    "@biomejs/cli-linux-arm64-musl": ["@biomejs/cli-linux-arm64-musl@1.9.4", "", { "os": "linux", "cpu": "arm64" }, "sha512-v665Ct9WCRjGa8+kTr0CzApU0+XXtRgwmzIf1SeKSGAv+2scAlW6JR5PMFo6FzqqZ64Po79cKODKf3/AAmECqA=="],
+    "@biomejs/cli-linux-arm64-musl": ["@biomejs/cli-linux-arm64-musl@2.0.0-beta.4", "", { "os": "linux", "cpu": "arm64" }, "sha512-wZWLwJu/rwG5Z791lyhJI3Cu5JdkzIddU0wrIygFbYOIu4KyGPYIzAWX33HgtlmNfH0hVxByUke3J1Szzx9CjQ=="],
 
-    "@biomejs/cli-linux-x64": ["@biomejs/cli-linux-x64@1.9.4", "", { "os": "linux", "cpu": "x64" }, "sha512-lRCJv/Vi3Vlwmbd6K+oQ0KhLHMAysN8lXoCI7XeHlxaajk06u7G+UsFSO01NAs5iYuWKmVZjmiOzJ0OJmGsMwg=="],
+    "@biomejs/cli-linux-x64": ["@biomejs/cli-linux-x64@2.0.0-beta.4", "", { "os": "linux", "cpu": "x64" }, "sha512-71NQPwTg9T/p/cE/k6P7tCBJmeg8vR1+bP4w6ADBT55SVL4pSEyaOsZ3LDIUrV5jkISh8UQsuwxy9F29pHpeqg=="],
 
-    "@biomejs/cli-linux-x64-musl": ["@biomejs/cli-linux-x64-musl@1.9.4", "", { "os": "linux", "cpu": "x64" }, "sha512-gEhi/jSBhZ2m6wjV530Yy8+fNqG8PAinM3oV7CyO+6c3CEh16Eizm21uHVsyVBEB6RIM8JHIl6AGYCv6Q6Q9Tg=="],
+    "@biomejs/cli-linux-x64-musl": ["@biomejs/cli-linux-x64-musl@2.0.0-beta.4", "", { "os": "linux", "cpu": "x64" }, "sha512-OX6qS1jUYmk6+VtV1XWyDj2z5RS13JFv6ujEXLq1a3Cn86nzN5v/Dw/MuZYko3zAJ4BDNwlbNztvFVxmL1uWiA=="],
 
-    "@biomejs/cli-win32-arm64": ["@biomejs/cli-win32-arm64@1.9.4", "", { "os": "win32", "cpu": "arm64" }, "sha512-tlbhLk+WXZmgwoIKwHIHEBZUwxml7bRJgk0X2sPyNR3S93cdRq6XulAZRQJ17FYGGzWne0fgrXBKpl7l4M87Hg=="],
+    "@biomejs/cli-win32-arm64": ["@biomejs/cli-win32-arm64@2.0.0-beta.4", "", { "os": "win32", "cpu": "arm64" }, "sha512-SBYQqhJ19EcPbGshEd8k98du9gbfBFUqbmgqnTT/METPn+WyqIEnYcWLudjd+ujYHuMHYpXqSYxh+NYfL331eg=="],
 
-    "@biomejs/cli-win32-x64": ["@biomejs/cli-win32-x64@1.9.4", "", { "os": "win32", "cpu": "x64" }, "sha512-8Y5wMhVIPaWe6jw2H+KlEm4wP/f7EW3810ZLmDlrEEy5KvBsb9ECEfu/kMWD484ijfQ8+nIi0giMgu9g1UAuuA=="],
+    "@biomejs/cli-win32-x64": ["@biomejs/cli-win32-x64@2.0.0-beta.4", "", { "os": "win32", "cpu": "x64" }, "sha512-2eGsMOwtm8mvicKMkegV2DW2EH0vQPF0Skt9n4enoFk8ABFtoxherTG8Us1fwlBrk9tA7gcshrdUilu35BmZdA=="],
 
     "@colors/colors": ["@colors/[email protected]", "", {}, "sha512-Ir+AOibqzrIsL6ajt3Rz3LskB7OiMVHqltZmspbW/TJuTVuyOMirVqAkjfY6JISiLHgyNqicAC8AyHHGzNd/dA=="],
 
@@ -157,7 +157,7 @@
 
     "@rollup/rollup-win32-x64-msvc": ["@rollup/[email protected]", "", { "os": "win32", "cpu": "x64" }, "sha512-lpPE1cLfP5oPzVjKMx10pgBmKELQnFJXHgvtHCtuJWOv8MxqdEIMNtgHgBFf7Ea2/7EuVwa9fodWUfXAlXZLZQ=="],
 
-    "@sablier/configs": ["@sablier/configs@github:sablier-labs/configs#d25b72b", {}, "sablier-labs-configs-d25b72b"],
+    "@sablier/configs": ["@sablier/configs@github:sablier-labs/configs#e086b68", {}, "sablier-labs-configs-e086b68"],
 
     "@scure/base": ["@scure/[email protected]", "", {}, "sha512-5Yy9czTO47mqz+/J8GM6GIId4umdCk1wc1q8rKERQulIoc8VP9pzDcghv10Tl2E7R96ZUx/PhND3ESYUQX8NuQ=="],
 

package.json

@@ -1,16 +1,14 @@
 {
-  "name": "@sablier/deployments",
-  "description": "Keeping track of Sablier deployments",
-  "version": "1.0.0-alpha.40",
   "author": {
     "name": "Sablier Labs Ltd",
     "url": "https://sablier.com"
   },
   "dependencies": {
     "lodash": "^4.17"
   },
+  "description": "Keeping track of Sablier deployments",
   "devDependencies": {
-    "@biomejs/biome": "1.9.4",
+    "@biomejs/biome": "2.0.0-beta.4",
     "@sablier/configs": "github:sablier-labs/configs",
     "@types/fs-extra": "^11.0",
     "@types/lodash": "^4.17",
@@ -29,7 +27,9 @@
     "vitest": "^3.1",
     "winston": "^3.17"
   },
-  "files": ["dist"],
+  "files": [
+    "dist"
+  ],
   "keywords": [
     "airdrops",
     "blockchain",
@@ -45,17 +45,18 @@
   ],
   "license": "GPL-3.0-or-later",
   "main": "dist/index.js",
+  "name": "@sablier/deployments",
   "publishConfig": {
     "access": "public"
   },
   "repository": "github.com:sablier-labs/deployments",
   "scripts": {
     "biome:check": "biome check .",
-    "biome:write": "biome check --write .",
+    "biome:write": "biome check --write . && bun run biome:write:imports",
     "biome:write:imports": "biome lint --write --only correctness/noUnusedImports .",
     "build": "bun run clean && bun run tsc:build",
-    "clean": "rm -rf dist",
     "check": "bun run biome:check && bun run prettier:check && bun run tsc:check",
+    "clean": "rm -rf dist",
     "fix": "bun run biome:write && bun run prettier:write",
     "prepack": "bun run build",
     "prepare": "husky",
@@ -67,5 +68,6 @@
     "tsc:build": "tsc -p tsconfig.build.json && bun tsc-alias -p tsconfig.build.json",
     "tsc:check": "tsc -p tsconfig.json --noEmit"
   },
-  "types": "./dist/index.d.ts"
+  "types": "./dist/index.d.ts",
+  "version": "1.0.0-alpha.40"
 }

scripts/check-broadcast.ts renamed to scripts/check-broadcasts.ts

@@ -1,11 +1,43 @@
 import path from "node:path";
 import type { Sablier } from "@src/types";
-import { globby } from "globby";
+import { foo } from "@src/types";
 import type { Options as GlobbyOptions } from "globby";
+import { globby } from "globby";
 import { logInfo } from "./logger";
 
+const _bar = foo + 5;
 const ROOT_DIR = path.join(__dirname, "..");
 
+/**
+ * Checks that the broadcast file exists for the specified release and chain.
+ * @param release - The release to check
+ * @param chain - The chain to check
+ * @param contractPath - The inner directory path to the contract to check, e.g. "core" or "periphery"
+ * @returns The path to the broadcast file if it exists, otherwise null
+ */
+export async function checkBroadcast(
+  release: Sablier.Release,
+  chain: Sablier.Chain,
+  contractPath?: string,
+): Promise<string | null> {
+  return checkPath(release, chain, { onlyFiles: true }, contractPath, ".json");
+}
+
+/**
+ * Checks that the ZK broadcast directory exists for the specified release and chain.
+ * @param release - The release to check
+ * @param chain - The chain to check
+ * @param contractPath - The inner directory path to the contract to check, e.g. "core" or "periphery"
+ * @returns The path to the broadcast directory if it exists, otherwise null
+ */
+export async function checkZKBroadcast(
+  release: Sablier.Release,
+  chain: Sablier.Chain,
+  contractPath?: string,
+): Promise<string | null> {
+  return checkPath(release, chain, { onlyDirectories: true }, contractPath, "");
+}
+
 /**
  * @example
  * data/
@@ -37,39 +69,12 @@ async function checkPath(
 
   if (!pathExists) {
     const relativePath = path.relative(ROOT_DIR, pathToCheck);
-    logInfo({ msg: `No broadcasts for ${chain.name} at ${relativePath}`, release });
+    logInfo({
+      msg: `No broadcasts for ${chain.name} at ${relativePath}`,
+      release,
+    });
     return null;
   }
 
   return found;
 }
-
-/**
- * Checks that the broadcast file exists for the specified release and chain.
- * @param release - The release to check
- * @param chain - The chain to check
- * @param contractPath - The inner directory path to the contract to check, e.g. "core" or "periphery"
- * @returns The path to the broadcast file if it exists, otherwise null
- */
-export async function checkBroadcast(
-  release: Sablier.Release,
-  chain: Sablier.Chain,
-  contractPath?: string,
-): Promise<string | null> {
-  return checkPath(release, chain, { onlyFiles: true }, contractPath, ".json");
-}
-
-/**
- * Checks that the ZK broadcast directory exists for the specified release and chain.
- * @param release - The release to check
- * @param chain - The chain to check
- * @param contractPath - The inner directory path to the contract to check, e.g. "core" or "periphery"
- * @returns The path to the broadcast directory if it exists, otherwise null
- */
-export async function checkZKBroadcast(
-  release: Sablier.Release,
-  chain: Sablier.Chain,
-  contractPath?: string,
-): Promise<string | null> {
-  return checkPath(release, chain, { onlyDirectories: true }, contractPath, "");
-}

scripts/logger.ts

@@ -61,8 +61,8 @@ if (LOG_FILE_PATH) {
  * LOG_LEVEL=silly bun run scripts/your-script.ts
  */
 const logger = winston.createLogger({
-  level: LOG_LEVEL,
   format: format.combine(format.timestamp(), format.errors({ stack: true })),
+  level: LOG_LEVEL,
   transports,
 });
 

scripts/print-aliases.ts

@@ -1,13 +1,14 @@
 import { releases } from "@src/releases";
 import _ from "lodash";
-import logger from "./logger";
-interface AliasRow {
+import logger, { logAndThrow } from "./logger";
+
+type AliasRow = {
   alias: string;
   contractName: string;
   releaseName: string;
-}
+};
 
-async function main() {
+async function main(): Promise<void> {
   const rows: AliasRow[] = [];
 
   for (const release of releases) {
@@ -40,7 +41,7 @@ async function main() {
   rows.sort((a, b) => a.alias.localeCompare(b.alias));
 
   const headers = ["Alias", "Contract Name", "Release"];
-  const colWidths = headers.map((h, i) => Math.max(h.length, ...rows.map((row) => Object.values(row)[i].length)));
+  const colWidths = headers.map((h, i) => Math.max(h.length, ...rows.map((row) => _.values(row)[i].length)));
 
   const headerRow = headers.map((h, i) => h.padEnd(colWidths[i])).join(" | ");
   const sep = colWidths.map((w) => "-".repeat(w)).join("-|-");
@@ -55,9 +56,5 @@ async function main() {
 }
 
 main().catch((error) => {
-  logger.error(`Error checking missing broadcasts: ${error.message}`);
-  if (error.stack) {
-    logger.error(error.stack);
-  }
-  throw error;
+  logAndThrow({ msg: `Error printing aliases: ${error.message}` });
 });

scripts/print-missing-broadcasts.ts

@@ -12,8 +12,8 @@ import { getChain } from "@src/chains";
 import { releasesByProtocol } from "@src/releases";
 import type { Sablier } from "@src/types";
 import _ from "lodash";
-import { checkBroadcast, checkZKBroadcast } from "./check-broadcast";
-import logger from "./logger";
+import { checkBroadcast, checkZKBroadcast } from "./check-broadcasts";
+import logger, { logAndThrow } from "./logger";
 
 const EMOJIS = {
   check: "✅",
@@ -25,24 +25,9 @@ const EMOJIS = {
   warning: "⚠️",
 } as const;
 
-function parseArgs(): Sablier.Protocol {
-  const protocol = process.argv[2] as Sablier.Protocol;
-  const validProtocols: Sablier.Protocol[] = ["airdrops", "flow", "legacy", "lockup"];
-  if (!protocol || !validProtocols.includes(protocol)) {
-    const msg = `Error: Please provide one of these protocols: ${validProtocols.join(", ")}`;
-    logger.error(msg);
-    throw new Error(msg);
-  }
-
-  return protocol;
-}
-
-function printSectionHeader(text: string): void {
-  const separator = "═".repeat(50);
-  console.log(`\n${separator}`);
-  console.log(text);
-  console.log(`${separator}\n`);
-}
+/* -------------------------------------------------------------------------- */
+/*                                    MAIN                                    */
+/* -------------------------------------------------------------------------- */
 
 async function main(): Promise<void> {
   const missing: Record<string, Sablier.Chain[]> = {};
@@ -67,7 +52,7 @@ async function main(): Promise<void> {
         const paths = chain.isZK
           ? await checkZKBroadcast(release, chain, "")
           : await checkBroadcast(release, chain, "");
-        hasValidBroadcasts = !!paths;
+        hasValidBroadcasts = !_.isEmpty(paths);
       }
 
       // Add to missing list if broadcasts aren't valid
@@ -139,9 +124,28 @@ async function main(): Promise<void> {
 }
 
 main().catch((error) => {
-  logger.error(`Error checking missing broadcasts: ${error.message}`);
-  if (error.stack) {
-    logger.error(error.stack);
-  }
-  throw error;
+  logAndThrow({ msg: `Error checking missing broadcasts: ${error.message}` });
 });
+
+/* -------------------------------------------------------------------------- */
+/*                                   HELPERS                                  */
+/* -------------------------------------------------------------------------- */
+
+function parseArgs(): Sablier.Protocol {
+  const protocol = process.argv[2] as Sablier.Protocol;
+  const validProtocols: Sablier.Protocol[] = ["airdrops", "flow", "legacy", "lockup"];
+  if (!protocol || !validProtocols.includes(protocol)) {
+    const msg = `Error: Please provide one of these protocols: ${validProtocols.join(", ")}`;
+    logger.error(msg);
+    throw new Error(msg);
+  }
+
+  return protocol;
+}
+
+function printSectionHeader(text: string): void {
+  const separator = "═".repeat(50);
+  console.log(`\n${separator}`);
+  console.log(text);
+  console.log(`${separator}\n`);
+}

src/chains/ids.ts

@@ -1,5 +1,4 @@
-export const ChainId = {
-  // Mainnets
+const mainnets = {
   ABSTRACT: 2741,
   ARBITRUM_ONE: 42161,
   AVALANCHE: 43114,
@@ -30,8 +29,9 @@ export const ChainId = {
   UNICHAIN: 130,
   XDC: 50,
   ZK_SYNC_ERA: 324,
+} as const;
 
-  // Testnets
+const testnets = {
   ARBITRUM_SEPOLIA: 421614,
   BASE_SEPOLIA: 84532,
   BLAST_SEPOLIA: 168587773,
@@ -45,3 +45,8 @@ export const ChainId = {
   TAIKO_HEKLA: 167009,
   ZK_SYNC_SEPOLIA: 300,
 } as const;
+
+export const ChainId = {
+  ...mainnets,
+  ...testnets,
+} as const;

src/chains/mainnets.ts

@@ -1,6 +1,6 @@
 import _ from "lodash";
 import { sortChains } from "../helpers";
-import { AVAX, BERA, BNB, CHZ, CORE, ETH, IOTX, POL, SEI, TNT, UOS, XDC, gMELD, xDAI } from "../native-tokens";
+import { AVAX, BERA, BNB, CHZ, CORE, ETH, gMELD, IOTX, POL, SEI, TNT, UOS, XDC, xDAI } from "../native-tokens";
 import type { Sablier } from "../types";
 import { ChainId } from "./ids";
 import { getAlchemyRPC, getInfuraRPC } from "./rpc";