refactor: delete indexers

build: move build-only settings to "tsconfig.build.json"
refactor: export mainnets before testnets
refactor: get rid of "logAndThrow"
refactor: move release-specific helpers
refactor: move "logger" and "check-broadcast" to "src/internal"
refactor: non-default exports
refactor: rename "scripts" to "cli"
refactor: simplify logic in "resolvers.ts"

Author: PaulRBerg

README.md

@@ -65,8 +65,8 @@ const arbitrum = chains.queries.get({ chainId: 42161 });
 const polygon = chains.queries.get({ slug: "polygon" });
 
 // Check if chain supports Sablier UI
-if (ethereum.isSupportedByUI) {
-  console.log("Available on app.sablier.com");
+if (arbitrum.isSupportedByUI) {
+  console.log("Arbitrum available on app.sablier.com");
 }
 ```
 

scripts/print-aliases.ts renamed to cli/print/aliases.ts

@@ -1,6 +1,6 @@
+import { logger } from "@src/internal/logger";
 import { sablier } from "@src/sablier";
 import _ from "lodash";
-import logger from "./logger";
 
 type AliasRow = {
   alias: string;

scripts/print-chains.ts renamed to cli/print/chains.ts

@@ -4,15 +4,17 @@
  * for all chains, only the ones listed in the releases.
  *
  * Usage:
- *   bun run scripts/print-missing.ts airdrops
- *   bun run scripts/print-missing.ts flow
- *   bun run scripts/print-missing.ts lockup
+ *   bun run cli/print/missing-broadcasts.ts airdrops
+ *   bun run cli/print/missing-broadcasts.ts flow
+ *   bun run cli/print/missing-broadcasts.ts lockup
  */
+
+import { checkBroadcast } from "@src/check-broadcast";
+import { Protocol } from "@src/enums";
+import { logger } from "@src/internal/logger";
 import { sablier } from "@src/sablier";
 import type { Sablier } from "@src/types";
 import _ from "lodash";
-import { checkBroadcast } from "./check-broadcast";
-import logger from "./logger";
 
 const EMOJIS = {
   check: "✅",
@@ -30,31 +32,30 @@ const EMOJIS = {
 
 async function main(): Promise<void> {
   const missing: Record<string, Sablier.Chain[]> = {};
-  const protocol = parseArgs();
+  const protocolArg = parseArgs();
 
-  logger.info(`\n${EMOJIS.folder} Checking ${protocol} broadcasts...\n`);
+  console.log(`${EMOJIS.folder} Checking ${protocolArg} broadcasts...\n`);
 
-  const allReleases = sablier.releases.getAll({ protocol });
-  for (const release of allReleases) {
-    for (const deployment of release.deployments) {
-      const chain = sablier.chains.getOrThrow(deployment.chainId);
+  const releases = sablier.releases.getAll({ protocol: protocolArg });
+  for (const r of releases) {
+    for (const d of r.deployments) {
+      const chain = sablier.chains.getOrThrow(d.chainId);
 
       let hasValidBroadcasts = false;
 
-      if (release.kind === "lockupV1") {
+      if (r.kind === "lockupV1") {
         const components = ["core", "periphery"];
-        hasValidBroadcasts = await Promise.all(
-          components.map((component) => checkBroadcast(release, chain, component)),
-        ).then((results) => results.every(Boolean));
+        const results = await Promise.all(components.map((component) => checkBroadcast(r, chain, component)));
+        hasValidBroadcasts = results.every(Boolean);
       } else {
-        const paths = await checkBroadcast(release, chain);
+        const paths = await checkBroadcast(r, chain);
         hasValidBroadcasts = !_.isEmpty(paths);
       }
 
       // Add to missing list if broadcasts aren't valid
       if (!hasValidBroadcasts) {
-        _.defaults(missing, { [release.version]: [] });
-        missing[release.version].push(chain);
+        _.defaults(missing, { [r.version]: [] });
+        missing[r.version].push(chain);
       }
     }
   }
@@ -124,15 +125,15 @@ main();
 /* -------------------------------------------------------------------------- */
 
 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(", ")}`;
+  const protocolArg = process.argv[2] as Sablier.Protocol;
+  const available = _.values(Protocol);
+  if (!protocolArg || !available.includes(protocolArg)) {
+    const msg = `Error: Please provide one of these protocols: ${available.join(", ")}`;
     logger.error(msg);
     throw new Error(msg);
   }
 
-  return protocol;
+  return protocolArg;
 }
 
 function printSectionHeader(text: string): void {

scripts/print-missing.ts renamed to cli/print/missing-broadcasts.ts

@@ -1,3 +1,7 @@
+<!---
+TODO: update
+-->
+
 # v1.0.0
 
 ## Contract Deployed

data/flow/v1.0/README.md

@@ -1,3 +1,7 @@
+<!---
+TODO: update
+-->
+
 # v1.2.0
 
 ## Contract Deployed

data/lockup/v1.2/core/README.md

@@ -1,3 +1,5 @@
+set shell := ["bash", "-euo", "pipefail", "-c"]
+
 # ---------------------------------------------------------------------------- #
 #                                    RECIPES                                   #
 # ---------------------------------------------------------------------------- #
@@ -42,9 +44,9 @@ prettier-check:
 prettier-write:
     bun prettier --cache --write "**/*.{md,yml}"
 
-# Print available chain arguments
-@print thing:
-    bun run scripts/print-{{ thing }}.ts
+# Run print CLI script. See the files under ./cli/print for available scripts
+@print script *args:
+    bun run cli/print/{{ script }}.ts {{ args }}
 
 # Setup Husky
 setup:

justfile

@@ -2,4 +2,4 @@ import * as mainnets from "./mainnets";
 import * as testnets from "./testnets";
 
 export { mainnets, testnets };
-export const chains = { ...testnets, ...mainnets };
+export const chains = { ...mainnets, ...testnets };

src/chains/data.ts

@@ -1,7 +1,7 @@
 import * as path from "node:path";
 import type { Sablier } from "@src/types";
 import * as fs from "fs-extra";
-import { logInfo } from "./logger";
+import { logVerbose } from "./internal/logger";
 
 const ROOT_DIR = path.join(__dirname, "..");
 const DATA_DIR = path.join(ROOT_DIR, "data");
@@ -12,12 +12,12 @@ const DATA_DIR = path.join(ROOT_DIR, "data");
  * ├── lockup/
  * │ └── v2.0/
  * │   └── broadcasts/
- * │     └── ethereum.json
+ * │     └── mainnet.json
  * └── lockup/
  *   └── v1.2/
  *     └── core/
  *       └── broadcasts/
- *         └── ethereum.json
+ *         └── mainnet.json
  */
 export function checkBroadcast(release: Sablier.Release, chain: Sablier.Chain, innerPath?: string): string | null {
   let chainType = "";
@@ -35,7 +35,7 @@ export function checkBroadcast(release: Sablier.Release, chain: Sablier.Chain, i
 
   if (!fs.existsSync(pathToCheck)) {
     const relativePath = path.relative(ROOT_DIR, pathToCheck);
-    logInfo({
+    logVerbose({
       msg: `No broadcasts for ${chain.slug} at ${relativePath}`,
       release,
     });

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

@@ -1,2 +1,7 @@
-export * from "./catalog";
-export * from "./names";
+import { catalog } from "./catalog";
+import { names } from "./names";
+
+export const contracts = {
+  catalog,
+  names,
+};