@across-protocol/sdk 3.1.25 → 3.1.27

package/dist/types/providers/alchemy.d.ts

@@ -0,0 +1,3 @@
+import { RPCTransport } from "./types";
+export declare function getURL(chainId: number, apiKey: string, transport: RPCTransport): string;
+//# sourceMappingURL=alchemy.d.ts.map

package/dist/types/providers/alchemy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"alchemy.d.ts","sourceRoot":"","sources":["../../../src/providers/alchemy.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAcvC,wBAAgB,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,YAAY,GAAG,MAAM,CAYvF"}

package/dist/types/providers/index.d.ts

@@ -2,5 +2,6 @@ export * from "./rateLimitedProvider";
 export * from "./cachedProvider";
 export * from "./retryProvider";
 export * from "./constants";
+export * from "./types";
 export * from "./utils";
 //# sourceMappingURL=index.d.ts.map

package/dist/types/providers/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/providers/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAC;AACtC,cAAc,kBAAkB,CAAC;AACjC,cAAc,iBAAiB,CAAC;AAChC,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/providers/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAC;AACtC,cAAc,kBAAkB,CAAC;AACjC,cAAc,iBAAiB,CAAC;AAChC,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC"}

package/dist/types/providers/infura.d.ts

@@ -0,0 +1,3 @@
+import { RPCTransport } from "./types";
+export declare function getURL(chainId: number, apiKey: string, transport: RPCTransport): string;
+//# sourceMappingURL=infura.d.ts.map

package/dist/types/providers/infura.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"infura.d.ts","sourceRoot":"","sources":["../../../src/providers/infura.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AASvC,wBAAgB,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,YAAY,GAAG,MAAM,CAYvF"}

package/dist/types/providers/types.d.ts

@@ -0,0 +1,3 @@
+export type RPCProvider = "INFURA" | "ALCHEMY";
+export type RPCTransport = "https" | "wss";
+//# sourceMappingURL=types.d.ts.map

package/dist/types/providers/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/providers/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,WAAW,GAAG,QAAQ,GAAG,SAAS,CAAC;AAC/C,MAAM,MAAM,YAAY,GAAG,OAAO,GAAG,KAAK,CAAC"}

package/dist/types/providers/utils.d.ts

@@ -1,4 +1,20 @@
 import { providers } from "ethers";
+import { RPCProvider, RPCTransport } from "./types";
+/**
+ * Type predicate for RPCProvider type.
+ * @param provider Provider string (ALCHEMY, INFURA, ...).
+ * @returns True if the provider string is a supported provider.
+ */
+export declare function isSupportedProvider(provider: string): provider is RPCProvider;
+/**
+ * Produce an RPC for a given RPC provider, chainId API key and transport.
+ * @param provider RPC provider identifier (ALCHEMY, INFURA, ...)
+ * @param chainId Chain ID to obtain a URL for.
+ * @param apiKey API key for provider.
+ * @param transport Optional transport specifier (HTTPS or WSS).
+ * @returns An RPC URL confirming to the specified inputs.
+ */
+export declare function getURL(provider: RPCProvider, chainId: number, apiKey: string, transport?: RPCTransport): string;
 export declare function compareResultsAndFilterIgnoredKeys(ignoredKeys: string[], _objA: Record<string, unknown>, _objB: Record<string, unknown>): boolean;
 export declare function compareArrayResultsWithIgnoredKeys(ignoredKeys: string[], objA: unknown[], objB: unknown[]): boolean;
 /**

package/dist/types/providers/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/providers/utils.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;AAqBnC,wBAAgB,kCAAkC,CAChD,WAAW,EAAE,MAAM,EAAE,EACrB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC9B,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC7B,OAAO,CAOT;AAED,wBAAgB,kCAAkC,CAAC,WAAW,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,OAAO,CAOnH;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAE5B,QAAQ,EAAE,CAAC,MAAM,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;IAInC,OAAO,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,IAAI,CAAC;IACnC,MAAM,EAAE,CAAC,GAAG,EAAE,OAAO,KAAK,IAAI,CAAC;CAChC;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,SAAS,CAAC,qBAAqB,EAAE,YAAY,EAAE,MAAM,UAElG;AAED,wBAAgB,0BAA0B,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;;;;;EAG7F;AAED;;;;;;;;GAQG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,GAAG,OAAO,CA8BnG;AAED,oBAAY,SAAS;IACnB,IAAI,IAAA;IACJ,QAAQ,IAAA;IACR,MAAM,IAAA;CACP"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/providers/utils.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;AAGnC,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAapD;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,MAAM,GAAG,QAAQ,IAAI,WAAW,CAE7E;AAED;;;;;;;GAOG;AACH,wBAAgB,MAAM,CACpB,QAAQ,EAAE,WAAW,EACrB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,EACd,SAAS,GAAE,YAAsB,GAChC,MAAM,CAIR;AAmBD,wBAAgB,kCAAkC,CAChD,WAAW,EAAE,MAAM,EAAE,EACrB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC9B,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC7B,OAAO,CAOT;AAED,wBAAgB,kCAAkC,CAAC,WAAW,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,OAAO,CAOnH;AAuBD;;GAEG;AACH,MAAM,WAAW,aAAa;IAE5B,QAAQ,EAAE,CAAC,MAAM,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;IAInC,OAAO,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,IAAI,CAAC;IACnC,MAAM,EAAE,CAAC,GAAG,EAAE,OAAO,KAAK,IAAI,CAAC;CAChC;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,SAAS,CAAC,qBAAqB,EAAE,YAAY,EAAE,MAAM,UAElG;AAED,wBAAgB,0BAA0B,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;;;;;EAG7F;AAED;;;;;;;;GAQG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,GAAG,OAAO,CAkBnG;AAED,oBAAY,SAAS;IACnB,IAAI,IAAA;IACJ,QAAQ,IAAA;IACR,MAAM,IAAA;CACP"}

package/dist/types/utils/AddressUtils.d.ts

@@ -6,4 +6,5 @@ import { providers } from "ethers";
  * @returns A boolean indicating if a contract is deployed at the given address or not (true = contract, false = no contract)
  */
 export declare function isContractDeployedToAddress(address: string, provider: providers.Provider): Promise<boolean>;
+export declare function compareAddressesSimple(addressA?: string, addressB?: string): boolean;
 //# sourceMappingURL=AddressUtils.d.ts.map

package/dist/types/utils/AddressUtils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AddressUtils.d.ts","sourceRoot":"","sources":["../../../src/utils/AddressUtils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAS,MAAM,QAAQ,CAAC;AAE1C;;;;;GAKG;AACH,wBAAsB,2BAA2B,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,SAAS,CAAC,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC,CASjH"}
+{"version":3,"file":"AddressUtils.d.ts","sourceRoot":"","sources":["../../../src/utils/AddressUtils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAS,MAAM,QAAQ,CAAC;AAE1C;;;;;GAKG;AACH,wBAAsB,2BAA2B,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,SAAS,CAAC,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC,CASjH;AAED,wBAAgB,sBAAsB,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAKpF"}

package/dist/types/utils/TokenUtils.d.ts

@@ -74,6 +74,13 @@ export declare const resolveContractFromSymbol: (symbol: string, chainId: string
         addresses: {
             [x: number]: string;
         };
+        /**
+         * Resolve a token symbol to an L1Token description on a particular chain ID.
+         * @notice Not to be confused with the HubPool's internal view on the supported origin/destination token for a chain.
+         * @param symbol Symbol to query.
+         * @param chainId Chain ID to query on.
+         * @returns Symbol, decimals and contract address on the requested chain.
+         */
         coingeckoId: string;
     };
     ETH: {
@@ -116,13 +123,6 @@ export declare const resolveContractFromSymbol: (symbol: string, chainId: string
         name: string;
         symbol: string;
         decimals: number;
-        /**
-         * Returns the contract address for a given token symbol and chainId.
-         * @param symbol A case-insensitive token symbol.
-         * @param chainId The chainId to resolve the contract address for.
-         * @param tokenMapping A parameter to determine where to source token information. Defaults to the constants variant.
-         * @returns The contract address for the given token symbol and chainId, or undefined if the token symbol is not supported.
-         */
         addresses: {
             [x: number]: string;
         };
@@ -199,7 +199,14 @@ export declare const resolveContractFromSymbol: (symbol: string, chainId: string
             [x: number]: string;
         };
         coingeckoId: string;
-    };
+    }; /**
+     * Retrieves the ERC20 balance for a given address and token address.
+     * @param address The address to retrieve the balance for.
+     * @param tokenAddress The token address
+     * @param signerOrProvider A valid ethers.js Signer or Provider object.
+     * @param blockTag The block tag to retrieve the balance at.
+     * @returns The balance of the given address for the given token address.
+     */
     WBTC: {
         name: string;
         symbol: string;
@@ -281,6 +288,13 @@ export declare function getTokenInformationFromAddress(address: string, tokenMap
         addresses: {
             [x: number]: string;
         };
+        /**
+         * Resolve a token symbol to an L1Token description on a particular chain ID.
+         * @notice Not to be confused with the HubPool's internal view on the supported origin/destination token for a chain.
+         * @param symbol Symbol to query.
+         * @param chainId Chain ID to query on.
+         * @returns Symbol, decimals and contract address on the requested chain.
+         */
         coingeckoId: string;
     };
     ETH: {
@@ -323,13 +337,6 @@ export declare function getTokenInformationFromAddress(address: string, tokenMap
         name: string;
         symbol: string;
         decimals: number;
-        /**
-         * Returns the contract address for a given token symbol and chainId.
-         * @param symbol A case-insensitive token symbol.
-         * @param chainId The chainId to resolve the contract address for.
-         * @param tokenMapping A parameter to determine where to source token information. Defaults to the constants variant.
-         * @returns The contract address for the given token symbol and chainId, or undefined if the token symbol is not supported.
-         */
         addresses: {
             [x: number]: string;
         };
@@ -406,7 +413,14 @@ export declare function getTokenInformationFromAddress(address: string, tokenMap
             [x: number]: string;
         };
         coingeckoId: string;
-    };
+    }; /**
+     * Retrieves the ERC20 balance for a given address and token address.
+     * @param address The address to retrieve the balance for.
+     * @param tokenAddress The token address
+     * @param signerOrProvider A valid ethers.js Signer or Provider object.
+     * @param blockTag The block tag to retrieve the balance at.
+     * @returns The balance of the given address for the given token address.
+     */
     WBTC: {
         name: string;
         symbol: string;
@@ -446,5 +460,14 @@ export declare function getCoingeckoTokenIdByAddress(contractAddress: string): s
  */
 export declare function getTokenBalance(address: string, tokenAddress: string, signerOrProvider: SignerOrProvider, blockTag?: BlockTag): Promise<BigNumber>;
 export declare function isBridgedUsdc(tokenSymbol: string): boolean;
+export declare function getTokenInfo(l2TokenAddress: string, chainId: number): L1Token;
+/**
+ * Get the USDC symbol for the given token address and chain ID.
+ * @param l2Token A Web3 token address (not case sensitive)
+ * @param chainId A chain Id to reference
+ * @returns Either USDC (if native) or USDbC/USDC.e (if bridged) or undefined if the token address is not recognized.
+ */
+export declare function getUsdcSymbol(l2Token: string, chainId: number): string | undefined;
+export declare function getL1TokenInfo(l2TokenAddress: string, chainId: number): L1Token;
 export {};
 //# sourceMappingURL=TokenUtils.d.ts.map

package/dist/types/utils/TokenUtils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TokenUtils.d.ts","sourceRoot":"","sources":["../../../src/utils/TokenUtils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,kCAAkC,CAAC;AAC5D,OAAO,EAAE,SAAS,EAAY,SAAS,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhE,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAMxC,KAAK,gBAAgB,GAAG,SAAS,CAAC,QAAQ,GAAG,MAAM,CAAC;AAEpD,wBAAsB,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,gBAAgB,EAAE,gBAAgB,GAAG,OAAO,CAAC,OAAO,CAAC,CAI1G;AAED,eAAO,MAAM,mBAAmB,mBACd,MAAM;;aAMvB,CAAC;AAEF;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAY7E;AAED;;;;;;GAMG;AACH,eAAO,MAAM,yBAAyB,WAC5B,MAAM,WACL,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QATjB;;;;;;WAMG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAKA,MAAM,GAAG,SAIX,CAAC;AAEF,wBAAgB,8BAA8B,CAAC,OAAO,EAAE,MAAM,EAAE,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAjB5E;;;;;;WAMG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAW6F,GAAG,OAAO,GAAG,SAAS,CAWrH;AAED,wBAAgB,4BAA4B,CAAC,eAAe,EAAE,MAAM,GAAG,MAAM,CAM5E;AAED;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAC7B,OAAO,EAAE,MAAM,EACf,YAAY,EAAE,MAAM,EACpB,gBAAgB,EAAE,gBAAgB,EAClC,QAAQ,GAAE,QAAmB,GAC5B,OAAO,CAAC,SAAS,CAAC,CAGpB;AAED,wBAAgB,aAAa,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAI1D"}
+{"version":3,"file":"TokenUtils.d.ts","sourceRoot":"","sources":["../../../src/utils/TokenUtils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,kCAAkC,CAAC;AAC5D,OAAO,EAAE,SAAS,EAAY,SAAS,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhE,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAOxC,KAAK,gBAAgB,GAAG,SAAS,CAAC,QAAQ,GAAG,MAAM,CAAC;AAEpD,wBAAsB,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,gBAAgB,EAAE,gBAAgB,GAAG,OAAO,CAAC,OAAO,CAAC,CAI1G;AAED,eAAO,MAAM,mBAAmB,mBACd,MAAM;;aAMvB,CAAC;AAEF;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAY7E;AAED;;;;;;GAMG;AACH,eAAO,MAAM,yBAAyB,WAC5B,MAAM,WACL,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QA9BjB;;;;;;WAMG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqDH;;;;;;;OAOG;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAlCA,MAAM,GAAG,SAIX,CAAC;AAEF,wBAAgB,8BAA8B,CAAC,OAAO,EAAE,MAAM,EAAE,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAtC5E;;;;;;WAMG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqDH;;;;;;;OAOG;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA5B6F,GAAG,OAAO,GAAG,SAAS,CAWrH;AAED,wBAAgB,4BAA4B,CAAC,eAAe,EAAE,MAAM,GAAG,MAAM,CAM5E;AAED;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAC7B,OAAO,EAAE,MAAM,EACf,YAAY,EAAE,MAAM,EACpB,gBAAgB,EAAE,gBAAgB,EAClC,QAAQ,GAAE,QAAmB,GAC5B,OAAO,CAAC,SAAS,CAAC,CAGpB;AAED,wBAAgB,aAAa,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAI1D;AAED,wBAAgB,YAAY,CAAC,cAAc,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAc7E;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAOlF;AAED,wBAAgB,cAAc,CAAC,cAAc,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAa/E"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@across-protocol/sdk",
   "author": "UMA Team",
-  "version": "3.1.25",
+  "version": "3.1.27",
   "license": "AGPL-3.0",
   "homepage": "https://docs.across.to/reference/sdk",
   "files": [

package/src/clients/HubPoolClient.ts

@@ -40,6 +40,9 @@ import {
   spreadEvent,
   spreadEventWithBlockNumber,
   toBN,
+  getTokenInfo,
+  getUsdcSymbol,
+  getL1TokenInfo,
 } from "../utils";
 import { AcrossConfigStoreClient as ConfigStoreClient } from "./AcrossConfigStoreClient/AcrossConfigStoreClient";
 import { BaseAbstractClient, isUpdateFailureReason, UpdateFailureReason } from "./BaseAbstractClient";
@@ -260,6 +263,33 @@ export class HubPoolClient extends BaseAbstractClient {
     return this.l1TokensToDestinationTokens?.[l1Token]?.[destinationChainId] != undefined;
   }
 
+  /**
+   * @dev If tokenAddress + chain do not exist in TOKEN_SYMBOLS_MAP then this will throw.
+   * @param tokenAddress Token address on `chain`
+   * @param chain Chain where the `tokenAddress` exists in TOKEN_SYMBOLS_MAP.
+   * @returns Token info for the given token address on the L2 chain including symbol and decimal.
+   */
+  getTokenInfoForAddress(tokenAddress: string, chain: number): L1Token {
+    const tokenInfo = getTokenInfo(tokenAddress, chain);
+    // @dev Temporarily handle case where an L2 token for chain ID can map to more than one TOKEN_SYMBOLS_MAP
+    // entry. For example, L2 Bridged USDC maps to both the USDC and USDC.e/USDbC entries in TOKEN_SYMBOLS_MAP.
+    if (tokenInfo.symbol.toLowerCase() === "usdc" && chain !== this.chainId) {
+      tokenInfo.symbol = getUsdcSymbol(tokenAddress, chain) ?? "UNKNOWN";
+    }
+    return tokenInfo;
+  }
+
+  /**
+   * @dev If tokenAddress + chain do not exist in TOKEN_SYMBOLS_MAP then this will throw.
+   * @dev if the token matched in TOKEN_SYMBOLS_MAP does not have an L1 token address then this will throw.
+   * @param tokenAddress Token address on `chain`
+   * @param chain Chain where the `tokenAddress` exists in TOKEN_SYMBOLS_MAP.
+   * @returns Token info for the given token address on the Hub chain including symbol and decimal and L1 address.
+   */
+  getL1TokenInfoForAddress(tokenAddress: string, chain: number): L1Token {
+    return getL1TokenInfo(tokenAddress, chain);
+  }
+
   getBlockNumber(timestamp: number): Promise<number | undefined> {
     const hints = { lowBlock: this.deploymentBlock };
     return getCachedBlockForTimestamp(this.chainId, timestamp, this.blockFinder, this.cachingMechanism, hints);

package/src/providers/alchemy.ts

@@ -0,0 +1,28 @@
+import { CHAIN_IDs, MAINNET_CHAIN_IDs as _MAINNET_CHAIN_IDs, PUBLIC_NETWORKS } from "../constants";
+import { RPCTransport } from "./types";
+
+const MAINNET_CHAIN_IDs = Object.values(_MAINNET_CHAIN_IDs);
+
+// Chain-specific overrides for when the Alchemy endpoint does not match the canonical chain name.
+const endpoints: { [chainId: string]: string } = {
+  [CHAIN_IDs.ARBITRUM]: "arb",
+  [CHAIN_IDs.ARBITRUM_SEPOLIA]: "arb-sepolia",
+  [CHAIN_IDs.MAINNET]: "eth",
+  [CHAIN_IDs.SEPOLIA]: "eth-sepolia",
+  [CHAIN_IDs.OPTIMISM]: "opt",
+  [CHAIN_IDs.OPTIMISM_SEPOLIA]: "opt-sepolia",
+};
+
+export function getURL(chainId: number, apiKey: string, transport: RPCTransport): string {
+  let host = endpoints[chainId] ?? PUBLIC_NETWORKS[chainId]?.name;
+  if (!host) {
+    throw new Error(`No known Alchemy provider for chainId ${chainId}`);
+  }
+
+  if (MAINNET_CHAIN_IDs.includes(chainId)) {
+    host = `${host}-mainnet`;
+  }
+  host = host.toLowerCase().replace(" ", "-");
+
+  return `${transport}://${host}.g.alchemy.com/v2/${apiKey}`;
+}

package/src/providers/index.ts

@@ -2,4 +2,5 @@ export * from "./rateLimitedProvider";
 export * from "./cachedProvider";
 export * from "./retryProvider";
 export * from "./constants";
+export * from "./types";
 export * from "./utils";

package/src/providers/infura.ts

@@ -0,0 +1,23 @@
+import { CHAIN_IDs, MAINNET_CHAIN_IDs as _MAINNET_CHAIN_IDs, PUBLIC_NETWORKS } from "../constants";
+import { RPCTransport } from "./types";
+
+const MAINNET_CHAIN_IDs = Object.values(_MAINNET_CHAIN_IDs);
+
+// Chain-specific overrides for when the Infura endpoint does not match the canonical chain name.
+const endpoints: { [chainId: string]: string } = {
+  [CHAIN_IDs.ARBITRUM]: "arbitrum",
+};
+
+export function getURL(chainId: number, apiKey: string, transport: RPCTransport): string {
+  let host = endpoints[chainId] ?? PUBLIC_NETWORKS[chainId]?.name;
+  if (!host) {
+    throw new Error(`No known Infura provider for chainId ${chainId}`);
+  }
+
+  if (chainId !== CHAIN_IDs.MAINNET && MAINNET_CHAIN_IDs.includes(chainId)) {
+    host = `${host}-mainnet`;
+  }
+  host = host.toLowerCase().replace(" ", "-");
+
+  return transport === "https" ? `https://${host}.infura.io/v3/${apiKey}` : `wss://${host}.infura.io/ws/v3/${apiKey}`;
+}

package/src/providers/types.ts

@@ -0,0 +1,2 @@
+export type RPCProvider = "INFURA" | "ALCHEMY";
+export type RPCTransport = "https" | "wss";

package/src/providers/utils.ts

@@ -1,8 +1,48 @@
 // The async/queue library has a task-based interface for building a concurrent queue.
-
+import assert from "assert";
 import { providers } from "ethers";
-import { isDefined } from "../utils";
 import { isEqual } from "lodash";
+import { isDefined } from "../utils";
+import { RPCProvider, RPCTransport } from "./types";
+import * as alchemy from "./alchemy";
+import * as infura from "./infura";
+
+/**
+ * Infura DIN is identified separately to allow it to be configured explicitly.
+ */
+const PROVIDERS = {
+  ALCHEMY: alchemy.getURL,
+  INFURA: infura.getURL,
+  INFURA_DIN: infura.getURL,
+};
+
+/**
+ * Type predicate for RPCProvider type.
+ * @param provider Provider string (ALCHEMY, INFURA, ...).
+ * @returns True if the provider string is a supported provider.
+ */
+export function isSupportedProvider(provider: string): provider is RPCProvider {
+  return ["ALCHEMY", "INFURA", "INFURA_DIN"].includes(provider);
+}
+
+/**
+ * Produce an RPC for a given RPC provider, chainId API key and transport.
+ * @param provider RPC provider identifier (ALCHEMY, INFURA, ...)
+ * @param chainId Chain ID to obtain a URL for.
+ * @param apiKey API key for provider.
+ * @param transport Optional transport specifier (HTTPS or WSS).
+ * @returns An RPC URL confirming to the specified inputs.
+ */
+export function getURL(
+  provider: RPCProvider,
+  chainId: number,
+  apiKey: string,
+  transport: RPCTransport = "https"
+): string {
+  const getURL = PROVIDERS[provider];
+  assert(getURL, `Unsupported RPC provider (${provider})`);
+  return getURL(chainId, apiKey, transport);
+}
 
 /**
  * Deletes keys from an object and returns new copy of object without ignored keys
@@ -43,6 +83,27 @@ export function compareArrayResultsWithIgnoredKeys(ignoredKeys: string[], objA:
   return isDefined(filteredA) && isDefined(filteredB) && isEqual(filteredA, filteredB);
 }
 
+/**
+ * A record of error codes that correspond to fields that should be ignored when comparing RPC results.
+ * This is used to compare results from different providers that may have different, but still valid, results.
+ */
+const IGNORED_FIELDS = {
+  // We've seen some RPC's like QuickNode add in transactionLogIndex which isn't in the
+  // JSON RPC spec: https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getfilterchanges
+  // Additional reference: https://github.com/ethers-io/ethers.js/issues/1721
+  // 2023-08-31 Added blockHash because of upstream zkSync provider disagreements. Consider removing later.
+  // 2024-05-07 Added l1BatchNumber and logType due to Alchemy. Consider removing later.
+  // 2024-07-11 Added blockTimestamp after zkSync rolled out a new node release.
+  eth_getBlockByNumber: [
+    "miner", // polygon (sometimes)
+    "l1BatchNumber", // zkSync
+    "l1BatchTimestamp", // zkSync
+    "size", // Alchemy/Arbitrum (temporary)
+    "totalDifficulty", // Quicknode/Alchemy (sometimes)
+  ],
+  eth_getLogs: ["blockTimestamp", "transactionLogIndex", "l1BatchNumber", "logType"],
+};
+
 /**
  * This is the type we pass to define a request "task".
  */
@@ -85,25 +146,13 @@ export function compareRpcResults(method: string, rpcResultA: unknown, rpcResult
     // We've seen RPC's disagree on the miner field, for example when Polygon nodes updated software that
     // led alchemy and quicknode to disagree on the miner field's value.
     return compareResultsAndFilterIgnoredKeys(
-      [
-        "miner", // polygon (sometimes)
-        "l1BatchNumber", // zkSync
-        "l1BatchTimestamp", // zkSync
-        "size", // Alchemy/Arbitrum (temporary)
-        "totalDifficulty", // Quicknode/Alchemy (sometimes)
-      ],
+      IGNORED_FIELDS.eth_getBlockByNumber,
       rpcResultA as Record<string, unknown>,
       rpcResultB as Record<string, unknown>
     );
   } else if (method === "eth_getLogs") {
-    // We've seen some RPC's like QuickNode add in transactionLogIndex which isn't in the
-    // JSON RPC spec: https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getfilterchanges
-    // Additional reference: https://github.com/ethers-io/ethers.js/issues/1721
-    // 2023-08-31 Added blockHash because of upstream zkSync provider disagreements. Consider removing later.
-    // 2024-05-07 Added l1BatchNumber and logType due to Alchemy. Consider removing later.
-    // 2024-07-11 Added blockTimestamp after zkSync rolled out a new node release.
     return compareArrayResultsWithIgnoredKeys(
-      ["blockTimestamp", "transactionLogIndex", "l1BatchNumber", "logType"],
+      IGNORED_FIELDS.eth_getLogs,
       rpcResultA as unknown[],
       rpcResultB as unknown[]
     );

package/src/utils/AddressUtils.ts

@@ -16,3 +16,10 @@ export async function isContractDeployedToAddress(address: string, provider: pro
   // If the code is not empty, then there is a contract at this address
   return code !== "0x";
 }
+
+export function compareAddressesSimple(addressA?: string, addressB?: string): boolean {
+  if (addressA === undefined || addressB === undefined) {
+    return false;
+  }
+  return addressA.toLowerCase() === addressB.toLowerCase();
+}

package/src/utils/TokenUtils.ts

@@ -5,6 +5,7 @@ import { L1Token } from "../interfaces";
 import { ERC20__factory } from "../typechain";
 import { getNetworkName } from "./NetworkUtils";
 import { isDefined } from "./TypeGuards";
+import { compareAddressesSimple } from "./AddressUtils";
 const { TOKEN_SYMBOLS_MAP, CHAIN_IDs } = constants;
 
 type SignerOrProvider = providers.Provider | Signer;
@@ -106,3 +107,49 @@ export function isBridgedUsdc(tokenSymbol: string): boolean {
     (bridgedUsdcSymbol) => bridgedUsdcSymbol.toLowerCase() === tokenSymbol.toLowerCase()
   );
 }
+
+export function getTokenInfo(l2TokenAddress: string, chainId: number): L1Token {
+  // @dev This might give false positives if tokens on different networks have the same address. I'm not sure how
+  // to get around this...
+  const tokenObject = Object.values(TOKEN_SYMBOLS_MAP).find(({ addresses }) => addresses[chainId] === l2TokenAddress);
+  if (!tokenObject) {
+    throw new Error(
+      `TokenUtils#getTokenInfo: Unable to resolve token in TOKEN_SYMBOLS_MAP for ${l2TokenAddress} on chain ${chainId}`
+    );
+  }
+  return {
+    address: l2TokenAddress,
+    symbol: tokenObject.symbol,
+    decimals: tokenObject.decimals,
+  };
+}
+
+/**
+ * Get the USDC symbol for the given token address and chain ID.
+ * @param l2Token A Web3 token address (not case sensitive)
+ * @param chainId A chain Id to reference
+ * @returns Either USDC (if native) or USDbC/USDC.e (if bridged) or undefined if the token address is not recognized.
+ */
+export function getUsdcSymbol(l2Token: string, chainId: number): string | undefined {
+  const compareToken = (token?: string) => isDefined(token) && compareAddressesSimple(l2Token, token);
+  return ["USDC", "USDbC", "USDC.e"].find((token) =>
+    compareToken(
+      (TOKEN_SYMBOLS_MAP as Record<string, { addresses?: Record<number, string> }>)[token]?.addresses?.[chainId]
+    )
+  );
+}
+
+export function getL1TokenInfo(l2TokenAddress: string, chainId: number): L1Token {
+  const tokenObject = Object.values(TOKEN_SYMBOLS_MAP).find(({ addresses }) => addresses[chainId] === l2TokenAddress);
+  const l1TokenAddress = tokenObject?.addresses[CHAIN_IDs.MAINNET];
+  if (!l1TokenAddress) {
+    throw new Error(
+      `TokenUtils#getL1TokenInfo: Unable to resolve l1 token address in TOKEN_SYMBOLS_MAP for L2 token ${l2TokenAddress} on chain ${chainId}`
+    );
+  }
+  return {
+    address: l1TokenAddress,
+    symbol: tokenObject.symbol,
+    decimals: tokenObject.decimals,
+  };
+}