feat: protocol and version field in Contract

PaulRBerg · PaulRBerg · commit 9f5df98864d1 · 2025-05-16T19:34:05.000+03:00
refactor: merge Contract and ContractCatalogEntry
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@sablier/deployments",
   "description": "Keeping track of Sablier deployments",
-  "version": "1.0.0-alpha.39",
+  "version": "1.0.0-alpha.40",
   "author": {
     "name": "Sablier Labs Ltd",
     "url": "https://sablier.com"
diff --git a/src/contracts/catalog.ts b/src/contracts/catalog.ts
@@ -18,12 +18,10 @@ for (const release of releases) {
 
     for (const contract of contracts) {
       const address = contract.address.toLowerCase(); // lowercase needed for deterministic lookup
-      const entry = {
-        alias: contract.alias,
-        name: contract.name,
+      const entry = _.merge(contract, {
         protocol,
         version,
-      };
+      });
       _.set(catalog, [protocol, chainId, address], entry);
     }
   }
diff --git a/src/releases/airdrops/v1.3/deployments.ts b/src/releases/airdrops/v1.3/deployments.ts
@@ -1,11 +1,12 @@
 import { ChainId } from "@src/chains/ids";
+import { Protocol } from "@src/enums";
 import { resolveDeployment } from "@src/releases/resolvers";
 import type { Sablier } from "@src/types";
 import aliases from "./aliases";
 import manifest from "./manifest";
 
 function get(chainId: number, contractMap: Sablier.ContractMap): Sablier.Deployment {
-  return resolveDeployment(chainId, contractMap, aliases);
+  return resolveDeployment(Protocol.Airdrops, "v1.3", chainId, aliases, contractMap);
 }
 
 /**
diff --git a/src/releases/flow/v1.0/deployments.ts b/src/releases/flow/v1.0/deployments.ts
@@ -1,11 +1,12 @@
 import { ChainId } from "@src/chains/ids";
+import { Protocol } from "@src/enums";
 import { resolveDeployment } from "@src/releases/resolvers";
 import type { Sablier } from "@src/types";
 import aliases from "./aliases";
 import manifest from "./manifest";
 
 function get(chainId: number, contractMap: Sablier.ContractMap): Sablier.Deployment {
-  return resolveDeployment(chainId, contractMap, aliases);
+  return resolveDeployment(Protocol.Flow, "v1.0", chainId, aliases, contractMap);
 }
 
 /**
diff --git a/src/releases/flow/v1.1/deployments.ts b/src/releases/flow/v1.1/deployments.ts
@@ -1,11 +1,12 @@
 import { ChainId } from "@src/chains/ids";
+import { Protocol } from "@src/enums";
 import { resolveDeployment } from "@src/releases/resolvers";
 import type { Sablier } from "@src/types";
 import aliases from "./aliases";
 import manifest from "./manifest";
 
 function get(chainId: number, contractMap: Sablier.ContractMap): Sablier.Deployment {
-  return resolveDeployment(chainId, contractMap, aliases);
+  return resolveDeployment(Protocol.Flow, "v1.1", chainId, aliases, contractMap);
 }
 
 /**
diff --git a/src/releases/legacy/v1.0/deployments.ts b/src/releases/legacy/v1.0/deployments.ts
@@ -1,20 +1,18 @@
 import { ChainId } from "@src/chains/ids";
+import { Protocol } from "@src/enums";
 import { resolveDeployment } from "@src/releases/resolvers";
 import type { Sablier } from "@src/types";
 import manifest from "./manifest";
 
-const aliases = {};
+const aliasMap = {};
+const contractMap: Sablier.ContractMap = {
+  [manifest.PAYROLL]: "0xbd6a40Bb904aEa5a49c59050B5395f7484A4203d",
+  [manifest.SABLIER]: "0xA4fc358455Febe425536fd1878bE67FfDBDEC59a",
+};
 
 /**
  * @description Mainnet deployments for Legacy v1.0
  */
 export const mainnets: Sablier.Deployment[] = [
-  resolveDeployment(
-    ChainId.ETHEREUM,
-    {
-      [manifest.PAYROLL]: "0xbd6a40Bb904aEa5a49c59050B5395f7484A4203d",
-      [manifest.SABLIER]: "0xA4fc358455Febe425536fd1878bE67FfDBDEC59a",
-    },
-    aliases,
-  ),
+  resolveDeployment(Protocol.Legacy, "v1.0", ChainId.ETHEREUM, aliasMap, contractMap),
 ];
diff --git a/src/releases/legacy/v1.1/deployments.ts b/src/releases/legacy/v1.1/deployments.ts
@@ -1,10 +1,13 @@
 import { ChainId } from "@src/chains/ids";
+import { Protocol } from "@src/enums";
 import { resolveDeployment } from "@src/releases/resolvers";
 import type { Sablier } from "@src/types";
 import manifest from "./manifest";
 
+const aliasMap = {};
+
 function get(chainId: number, contractMap: Sablier.ContractMap): Sablier.Deployment {
-  return resolveDeployment(chainId, contractMap, {});
+  return resolveDeployment(Protocol.Legacy, "v1.1", chainId, aliasMap, contractMap);
 }
 
 /**
diff --git a/src/releases/lockup/v1.0/deployments.ts b/src/releases/lockup/v1.0/deployments.ts
@@ -1,4 +1,5 @@
 import { ChainId } from "@src/chains/ids";
+import { Protocol } from "@src/enums";
 import { resolveDeploymentLockupV1 } from "@src/releases/resolvers";
 import type { Sablier } from "@src/types";
 import aliases from "./aliases";
@@ -11,7 +12,7 @@ function get(
     periphery: Sablier.ContractMap;
   },
 ): Sablier.Deployment.LockupV1 {
-  return resolveDeploymentLockupV1(chainId, contractMap, aliases);
+  return resolveDeploymentLockupV1(Protocol.Lockup, "v1.0", chainId, aliases, contractMap);
 }
 
 /**
diff --git a/src/releases/lockup/v1.1/deployments.ts b/src/releases/lockup/v1.1/deployments.ts
@@ -1,4 +1,5 @@
 import { ChainId } from "@src/chains/ids";
+import { Protocol } from "@src/enums";
 import { resolveDeploymentLockupV1 } from "@src/releases/resolvers";
 import type { Sablier } from "@src/types";
 import aliases from "./aliases";
@@ -11,7 +12,7 @@ function get(
     periphery: Sablier.ContractMap;
   },
 ): Sablier.Deployment.LockupV1 {
-  return resolveDeploymentLockupV1(chainId, contractMap, aliases);
+  return resolveDeploymentLockupV1(Protocol.Lockup, "v1.1", chainId, aliases, contractMap);
 }
 
 /**
diff --git a/src/releases/lockup/v1.2/deployments.ts b/src/releases/lockup/v1.2/deployments.ts
@@ -1,4 +1,5 @@
 import { ChainId } from "@src/chains/ids";
+import { Protocol } from "@src/enums";
 import { resolveDeploymentLockupV1 } from "@src/releases/resolvers";
 import type { Sablier } from "@src/types";
 import aliases from "./aliases";
@@ -11,7 +12,7 @@ function get(
     periphery: Sablier.ContractMap;
   },
 ): Sablier.Deployment.LockupV1 {
-  return resolveDeploymentLockupV1(chainId, contractMap, aliases);
+  return resolveDeploymentLockupV1(Protocol.Lockup, "v1.2", chainId, aliases, contractMap);
 }
 
 /**
diff --git a/src/releases/lockup/v2.0/deployments.ts b/src/releases/lockup/v2.0/deployments.ts
@@ -1,11 +1,12 @@
 import { ChainId } from "@src/chains/ids";
+import { Protocol } from "@src/enums";
 import { resolveDeployment } from "@src/releases/resolvers";
 import type { Sablier } from "@src/types";
 import aliases from "./aliases";
 import manifest from "./manifest";
 
 function get(chainId: number, contractMap: Sablier.ContractMap): Sablier.Deployment {
-  return resolveDeployment(chainId, contractMap, aliases);
+  return resolveDeployment(Protocol.Lockup, "v2.0", chainId, aliases, contractMap);
 }
 
 /**
diff --git a/src/releases/resolvers.ts b/src/releases/resolvers.ts
@@ -5,18 +5,28 @@ import _ from "lodash";
 
 /** @internal */
 export function resolveDeployment(
+  protocol: Sablier.Protocol,
+  version: Sablier.Version,
   chainId: number,
+  aliasMap: Sablier.AliasMap,
   contractMap: Sablier.ContractMap,
-  aliases: Sablier.AliasMap,
 ): Sablier.Deployment {
   const chain = getChain(chainId);
   const contracts: Sablier.Contract[] = [];
+
   for (const [contractName, addressOrTuple] of _.entries(contractMap)) {
     // A contract can be declared either as a static address or as a tuple of [address, blockNumber]
     const [address, blockNumber] = Array.isArray(addressOrTuple) ? addressOrTuple : [addressOrTuple, 0];
-    const alias = aliases[contractName];
-    const explorerURL = getContractExplorerURL(chain.explorerURL, address);
-    contracts.push({ address, alias, block: blockNumber, explorerURL, name: contractName });
+    const contract = {
+      address,
+      alias: aliasMap[contractName],
+      block: blockNumber,
+      explorerURL: getContractExplorerURL(chain.explorerURL, address),
+      name: contractName,
+      protocol,
+      version,
+    };
+    contracts.push(contract);
   }
 
   return {
@@ -27,35 +37,46 @@ export function resolveDeployment(
 
 /** @internal */
 export function resolveDeploymentLockupV1(
+  protocol: Sablier.Protocol,
+  version: Sablier.Version,
   chainId: number,
+  aliasMap: Sablier.AliasMap,
   contractMap: {
     core: Sablier.ContractMap;
     periphery: Sablier.ContractMap;
   },
-  aliases: Sablier.AliasMap,
 ): Sablier.Deployment.LockupV1 {
-  const mapContractsToDeployment = (
+  // Function to convert the contract map to deployment contracts
+  function mapContracts(
     contracts: Sablier.ContractMap,
-    aliases: Sablier.AliasMap,
     chain: Sablier.Chain,
-  ): Sablier.Contract[] => {
+    aliasMap: Sablier.AliasMap,
+  ): Sablier.Contract[] {
     return _.entries(contracts).map(([name, addressOrTuple]) => {
       const [address, blockNumber] = Array.isArray(addressOrTuple) ? addressOrTuple : [addressOrTuple, 0];
       return {
-        alias: aliases[name],
+        alias: aliasMap[name],
         address,
         explorerURL: getContractExplorerURL(chain.explorerURL, address),
         block: blockNumber,
         name,
+        protocol,
+        version,
       };
     });
-  };
+  }
 
   const mergedContracts = { ...contractMap.core, ...contractMap.periphery };
   const chain = getChain(chainId);
-  const deployment = resolveDeployment(chainId, mergedContracts, aliases) as Sablier.Deployment.LockupV1;
-  deployment.core = mapContractsToDeployment(contractMap.core, aliases, chain);
-  deployment.periphery = mapContractsToDeployment(contractMap.periphery, aliases, chain);
+  const deployment = resolveDeployment(
+    protocol,
+    version,
+    chainId,
+    aliasMap,
+    mergedContracts,
+  ) as Sablier.Deployment.LockupV1;
+  deployment.core = mapContracts(contractMap.core, chain, aliasMap);
+  deployment.periphery = mapContracts(contractMap.periphery, chain, aliasMap);
   return deployment;
 }
 
diff --git a/src/types.ts b/src/types.ts
@@ -50,10 +50,10 @@ export namespace Sablier {
    * The base contract type.
    */
   export type Contract = {
-    /** Optional alias for the contract, used in the Sablier Interface and the indexers. */
-    alias?: string;
     /** The address of the contract. */
     address: Address;
+    /** Optional alias for the contract, used in the Sablier Interface and the indexers. */
+    alias?: string;
     /** The block number at which the contract was deployed. */
     block?: number;
     /** Compiler settings for the contract. */
@@ -62,22 +62,19 @@ export namespace Sablier {
     explorerURL?: string;
     /** The name of the contract. */
     name: string;
-  };
-
-  export type ContractCatalogEntry = {
-    alias?: string;
-    name: string;
+    /** The protocol the contract is part of. */
     protocol: Sablier.Protocol;
+    /** The release version the contract is part of. */
     version: Sablier.Version;
   };
 
   /**
-   * Look up contract information by address.
+   * Reverse mapping of contracts so that we can look up contracts by address.
    */
   export type ContractCatalog = {
     [protocol in Protocol]: {
       [chainId: number]: {
-        [address: Address]: ContractCatalogEntry;
+        [address: Address]: Contract;
       };
     };
   };
diff --git a/tests/contracts.test.ts b/tests/contracts.test.ts
@@ -44,12 +44,7 @@ describe("Contract catalog", () => {
       const contract = deployment.contracts[0];
       const lowercaseAddress = contract.address.toLowerCase();
       const entry = _.get(catalog, [release.protocol, deployment.chainId, lowercaseAddress]);
-
-      expect(entry).toBeDefined();
-      expect(entry.alias).toBe(contract.alias);
-      expect(entry.name).toBe(contract.name);
-      expect(entry.protocol).toBe(release.protocol);
-      expect(entry.version).toBe(release.version);
+      expect(entry).toStrictEqual(contract);
     });
   }
 });
diff --git a/tests/utils/finders.ts b/tests/utils/finders.ts
@@ -1,13 +1,12 @@
-import type { Sablier } from "@src/types";
 import _ from "lodash";
-import type { BroadcastJSON, ZKBroadcastJSON } from "./types";
+import type { BasicContract, BroadcastJSON, ZKBroadcastJSON } from "./types";
 
 const CONTRACT_PREFIX = "contract ";
 
 /**
  * Finds a contract in the broadcast data.
  */
-export function findContract(data: BroadcastJSON, contractName: string): Sablier.Contract | null {
+export function findContract(data: BroadcastJSON, contractName: string): BasicContract | null {
   const contractFromReturns = findInReturns(data, contractName);
   if (contractFromReturns) return contractFromReturns;
 
@@ -32,7 +31,7 @@ export function findZKContract(zkData: ZKBroadcastJSON[], contractName: string):
  *  }
  * }
  */
-export function findInReturns(data: BroadcastJSON, contractName: string): Sablier.Contract | null {
+export function findInReturns(data: BroadcastJSON, contractName: string): BasicContract | null {
   if (!data.returns) return null;
   for (const contractReturn of _.values(data.returns)) {
     const sanitizedName = contractReturn.internal_type.replace(CONTRACT_PREFIX, "");
@@ -51,7 +50,7 @@ export function findInReturns(data: BroadcastJSON, contractName: string): Sablie
  *   "src/libraries/Helpers.sol:Helpers:0xf8076E4Fb5cfE8be1C26E61222DC51828Db8C1dc"
  * ]
  */
-export function findInLibraries(data: BroadcastJSON, contractName: string): Sablier.Contract | null {
+export function findInLibraries(data: BroadcastJSON, contractName: string): BasicContract | null {
   if (!data.libraries) return null;
 
   for (const library of data.libraries) {
diff --git a/tests/utils/generators.ts b/tests/utils/generators.ts
diff --git a/tests/utils/helpers.ts b/tests/utils/helpers.ts
diff --git a/tests/utils/types.ts b/tests/utils/types.ts

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@sablier/deployments",`
`3`	`3`	`"description": "Keeping track of Sablier deployments",`
`4`		`- "version": "1.0.0-alpha.39",`
	`4`	`+ "version": "1.0.0-alpha.40",`
`5`	`5`	`"author": {`
`6`	`6`	`"name": "Sablier Labs Ltd",`
`7`	`7`	`"url": "https://sablier.com"`
Original file line number	Diff line number	Diff line change
`@@ -18,12 +18,10 @@ for (const release of releases) {`
`18`	`18`
`19`	`19`	`for (const contract of contracts) {`
`20`	`20`	`const address = contract.address.toLowerCase(); // lowercase needed for deterministic lookup`
`21`		`- const entry = {`
`22`		`- alias: contract.alias,`
`23`		`- name: contract.name,`
	`21`	`+ const entry = _.merge(contract, {`
`24`	`22`	`protocol,`
`25`	`23`	`version,`
`26`		`- };`
	`24`	`+ });`
`27`	`25`	`_.set(catalog, [protocol, chainId, address], entry);`
`28`	`26`	`}`
`29`	`27`	`}`