feat: contract catalog

docs: remove @description tag
refactor: delete "version.ts"
refactor: rename some types
refactor: use string literals instead of Protocol enum
refactor: rename resolvers

Author: PaulRBerg

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sablier/deployments",
   "description": "Keeping track of Sablier deployments",
-  "version": "1.0.0-alpha.36",
+  "version": "1.0.0-alpha.37",
   "author": {
     "name": "Sablier Labs Ltd",
     "url": "https://sablier.com"

src/contracts/catalog.ts

@@ -0,0 +1,32 @@
+import { Protocol } from "@src/enums";
+import { releases } from "@src/releases";
+import type { Sablier } from "@src/types";
+import _ from "lodash";
+
+const catalog: Sablier.ContractCatalog = {
+  [Protocol.Airdrops]: {},
+  [Protocol.Flow]: {},
+  [Protocol.Legacy]: {},
+  [Protocol.Lockup]: {},
+};
+
+for (const release of releases) {
+  const { protocol, version, deployments } = release;
+
+  for (const deployment of deployments) {
+    const { chainId, contracts } = deployment;
+
+    for (const contract of contracts) {
+      const address = contract.address.toLowerCase(); // lowercase needed for deterministic lookup
+      const info = {
+        alias: contract.alias,
+        name: contract.name,
+        protocol,
+        version,
+      };
+      _.set(catalog, [protocol, chainId, address], info);
+    }
+  }
+}
+
+export default catalog;

src/contracts/index.ts

@@ -1 +1,2 @@
+export { default as catalog } from "./catalog";
 export { default as names } from "./names";

src/contracts/names.ts

@@ -12,18 +12,6 @@ import lockupV2_0 from "@src/releases/lockup/v2.0/manifest";
 import type { Sablier } from "@src/types";
 import _ from "lodash";
 
-/**
- * At runtime: for v1.x, merge `core` + `periphery`; for v2.0, use the top-level record directly.
- */
-function flattenNames(manifest: Sablier.Manifest): Record<string, string> {
-  if ("core" in manifest && "periphery" in manifest) {
-    const lockupManifest = manifest as Sablier.Manifest.LockupV1;
-    return { ...lockupManifest.core, ...lockupManifest.periphery };
-  }
-  // v2.0 has no core/periphery nesting
-  return { ...manifest } as Record<string, string>;
-}
-
 /**
  * Works at compile-time!
  */
@@ -66,8 +54,16 @@ const manifests = [
   lockupV1_2,
   lockupV2_0,
 ];
-const flattened = manifests.map(flattenNames);
 
+function flattenNames(manifest: Sablier.Manifest): Record<string, string> {
+  if ("core" in manifest && "periphery" in manifest) {
+    const lockupManifest = manifest as Sablier.Manifest.LockupV1;
+    return { ...lockupManifest.core, ...lockupManifest.periphery };
+  }
+  return { ...manifest } as Record<string, string>;
+}
+
+const flattened = manifests.map(flattenNames);
 const names: ContractNames = _.merge({}, ...flattened) as ContractNames;
 
 export default names;

src/version.ts renamed to src/enums.ts

@@ -1,3 +1,13 @@
+/**
+ * @file The types in {@link file://./types.ts} are generated from these enums.
+ */
+export const Protocol = {
+  Airdrops: "airdrops",
+  Flow: "flow",
+  Legacy: "legacy",
+  Lockup: "lockup",
+} as const;
+
 export const Version = {
   Airdrops: {
     V1_1: "v1.1",
@@ -19,5 +29,3 @@ export const Version = {
     V2_0: "v2.0",
   },
 } as const;
-
-export default Version;

src/index.ts

@@ -1,8 +1,8 @@
 export * from "./chains";
+export * from "./enums";
 export * from "./helpers";
 export * from "./indexers";
 export * from "./releases";
 export * from "./types";
 export * as contracts from "./contracts";
 export * as nativeTokens from "./native-tokens";
-export { default as Version } from "./version";

src/indexers/airdrops/envio.ts

@@ -1,8 +1,8 @@
+import { Protocol } from "@src/enums";
 import config from "../config";
 import { resolveEnvio } from "../helpers";
-
 function get(chainId: number) {
-  return resolveEnvio("airdrops", chainId);
+  return resolveEnvio(Protocol.Airdrops, chainId);
 }
 
 const envio = config.envio.supportedChains.map(get);

src/indexers/airdrops/graph.ts

@@ -1,14 +1,15 @@
 import { ChainId } from "@src/chains/ids";
+import { Protocol } from "@src/enums";
 import type { Sablier } from "@src/types";
 import type { TheGraphCustomChainId } from "../config";
 import { resolveCustomSubgraph, resolveOfficialSubgraph } from "../helpers";
 
 function resolveCustom(chainId: TheGraphCustomChainId, name: string): Sablier.Indexer.TheGraph {
-  return resolveCustomSubgraph("airdrops", chainId, name);
+  return resolveCustomSubgraph(Protocol.Airdrops, chainId, name);
 }
 
 function resolveOfficial(chainId: number, name: string, id: string): Sablier.Indexer.TheGraph {
-  return resolveOfficialSubgraph("airdrops", chainId, name, id);
+  return resolveOfficialSubgraph(Protocol.Airdrops, chainId, name, id);
 }
 
 const graph = [

src/indexers/flow/envio.ts

@@ -1,8 +1,9 @@
+import { Protocol } from "@src/enums";
 import config from "../config";
 import { resolveEnvio } from "../helpers";
 
 function get(chainId: number) {
-  return resolveEnvio("flow", chainId);
+  return resolveEnvio(Protocol.Flow, chainId);
 }
 
 const envio = config.envio.supportedChains.map(get);

src/indexers/flow/graph.ts

@@ -1,14 +1,15 @@
 import { ChainId } from "@src/chains/ids";
+import { Protocol } from "@src/enums";
 import type { Sablier } from "@src/types";
 import type { TheGraphCustomChainId } from "../config";
 import { resolveCustomSubgraph, resolveOfficialSubgraph } from "../helpers";
 
 function resolveCustom(chainId: TheGraphCustomChainId, name: string): Sablier.Indexer.TheGraph {
-  return resolveCustomSubgraph("flow", chainId, name);
+  return resolveCustomSubgraph(Protocol.Flow, chainId, name);
 }
 
 function resolveOfficial(chainId: number, name: string, id: string): Sablier.Indexer.TheGraph {
-  return resolveOfficialSubgraph("flow", chainId, name, id);
+  return resolveOfficialSubgraph(Protocol.Flow, chainId, name, id);
 }
 
 const graph = [