improve: export deployments (#1076)

* export deployments mapping for consumer projects

Signed-off-by: Ihor Farion <[email protected]>

* change to DEPLOYMENTS

Signed-off-by: Ihor Farion <[email protected]>

---------

Signed-off-by: Ihor Farion <[email protected]>

Author: grasphoper

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@across-protocol/contracts",
-  "version": "4.1.2",
+  "version": "4.1.3",
   "author": "UMA Team",
   "license": "AGPL-3.0-only",
   "repository": {

src/DeploymentUtils.ts

@@ -1,40 +1,63 @@
 import * as deployments_ from "../deployments/deployments.json";
 
-interface DeploymentExport {
-  [chainId: string]: { [contractName: string]: { address: string; blockNumber: number } };
-}
-const deployments: DeploymentExport = deployments_ as any;
+/** Mapping: chainId -> contractName -> { address, blockNumber }. */
+export type Deployments = Record<string, Record<string, { address: string; blockNumber: number }>>;
+
+export const DEPLOYMENTS: Readonly<Deployments> = deployments_ as Deployments;
 
-// Returns the deployed address of any contract on any network.
+/**
+ * Returns the deployed address of any contract on any network.
+ */
 export function getDeployedAddress(
   contractName: string,
   networkId: number | string,
   throwOnError = true
 ): string | undefined {
-  const address = deployments[networkId.toString()]?.[contractName]?.address;
+  const address = DEPLOYMENTS[networkId.toString()]?.[contractName]?.address;
   if (!address && throwOnError) {
     throw new Error(`Contract ${contractName} not found on ${networkId} in deployments.json`);
   }
 
   return address;
 }
 
-// Returns the deployment block number of any contract on any network.
+/**
+ * Returns all active deployments for a given contract name across all chains.
+ * Each result contains chainId, address, and blockNumber.
+ */
+export function getAllDeployedAddresses(
+  contractName: string
+): Array<{ chainId: number; address: string; blockNumber: number }> {
+  const results: Array<{ chainId: number; address: string; blockNumber: number }> = [];
+  Object.keys(DEPLOYMENTS).forEach((_chainId) => {
+    const info = DEPLOYMENTS[_chainId]?.[contractName];
+    if (info?.address) {
+      results.push({ chainId: Number(_chainId), address: info.address, blockNumber: info.blockNumber });
+    }
+  });
+  return results;
+}
+
+/**
+ * Returns the deployment block number of any contract on any network.
+ */
 export function getDeployedBlockNumber(contractName: string, networkId: number): number {
   try {
-    return deployments[networkId.toString()][contractName].blockNumber;
+    return DEPLOYMENTS[networkId.toString()][contractName].blockNumber;
   } catch (_) {
     throw new Error(`Contract ${contractName} not found on ${networkId} in deployments.json`);
   }
 }
 
-// Returns the chainId and contract name for a given contract address.
+/**
+ * Returns the chainId and contract name for a given contract address.
+ */
 export function getContractInfoFromAddress(contractAddress: string): { chainId: Number; contractName: string } {
   const returnValue: { chainId: number; contractName: string }[] = [];
 
-  Object.keys(deployments).forEach((_chainId) =>
-    Object.keys(deployments[_chainId]).forEach((_contractName) => {
-      if (deployments[_chainId][_contractName].address === contractAddress)
+  Object.keys(DEPLOYMENTS).forEach((_chainId) =>
+    Object.keys(DEPLOYMENTS[_chainId]).forEach((_contractName) => {
+      if (DEPLOYMENTS[_chainId][_contractName].address === contractAddress)
         returnValue.push({ chainId: Number(_chainId), contractName: _contractName });
     })
   );