improve: simulate relay gas fees for messages

api/_utils.ts

@@ -332,7 +332,6 @@ export const queries: Record<
       undefined,
       undefined,
       undefined,
-      undefined,
       REACT_APP_COINGECKO_PRO_API_KEY,
       getLogger(),
       getGasMarkup(CHAIN_IDs.MAINNET)
@@ -343,7 +342,6 @@ export const queries: Record<
       undefined,
       undefined,
       undefined,
-      undefined,
       REACT_APP_COINGECKO_PRO_API_KEY,
       getLogger(),
       getGasMarkup(CHAIN_IDs.OPTIMISM)
@@ -354,7 +352,6 @@ export const queries: Record<
       undefined,
       undefined,
       undefined,
-      undefined,
       REACT_APP_COINGECKO_PRO_API_KEY,
       getLogger(),
       getGasMarkup(CHAIN_IDs.POLYGON)
@@ -365,7 +362,6 @@ export const queries: Record<
       undefined,
       undefined,
       undefined,
-      undefined,
       REACT_APP_COINGECKO_PRO_API_KEY,
       getLogger(),
       getGasMarkup(CHAIN_IDs.ARBITRUM)
@@ -376,7 +372,6 @@ export const queries: Record<
       undefined,
       undefined,
       undefined,
-      undefined,
       REACT_APP_COINGECKO_PRO_API_KEY,
       getLogger(),
       getGasMarkup(CHAIN_IDs.ZK_SYNC)
@@ -387,7 +382,6 @@ export const queries: Record<
       undefined,
       undefined,
       undefined,
-      undefined,
       REACT_APP_COINGECKO_PRO_API_KEY,
       getLogger(),
       getGasMarkup(CHAIN_IDs.BASE)
@@ -399,7 +393,6 @@ export const queries: Record<
       undefined,
       undefined,
       undefined,
-      undefined,
       REACT_APP_COINGECKO_PRO_API_KEY,
       getLogger(),
       getGasMarkup(CHAIN_IDs.GOERLI)
@@ -410,7 +403,6 @@ export const queries: Record<
       undefined,
       undefined,
       undefined,
-      undefined,
       REACT_APP_COINGECKO_PRO_API_KEY,
       getLogger(),
       getGasMarkup(CHAIN_IDs.ARBITRUM_GOERLI)
@@ -421,7 +413,6 @@ export const queries: Record<
       undefined,
       undefined,
       undefined,
-      undefined,
       REACT_APP_COINGECKO_PRO_API_KEY,
       getLogger(),
       getGasMarkup(CHAIN_IDs.ZK_SYNC_GOERLI)
@@ -432,7 +423,6 @@ export const queries: Record<
       undefined,
       undefined,
       undefined,
-      undefined,
       REACT_APP_COINGECKO_PRO_API_KEY,
       getLogger(),
       getGasMarkup(CHAIN_IDs.BASE_GOERLI)
@@ -487,25 +477,58 @@ export const getTokenSymbol = (tokenAddress: string): string => {
  * @param amount  The amount of funds that are requesting to be transferred
  * @param originChainId The origin chain that this token will be transferred from
  * @param destinationChainId The destination chain that this token will be transferred to
+ * @param recipientAddress The address that will receive the transferred funds
  * @param tokenPrice An optional overred price to prevent the SDK from creating its own call
+ * @param message An optional message to include in the transfer
+ * @param relayerAddress An optional relayer address to use for the transfer
  * @returns The a promise to the relayer fee for the given `amount` of transferring `l1Token` to `destinationChainId`
  */
-export const getRelayerFeeDetails = (
+export const getRelayerFeeDetails = async (
   l1Token: string,
   amount: sdk.utils.BigNumberish,
   originChainId: number,
   destinationChainId: number,
-  tokenPrice?: number
+  recipientAddress = "0x893d0d70ad97717052e3aa8903d9615804167759", // A known dummy address
+  tokenPrice?: number,
+  message?: string,
+  relayerAddress?: string
 ): Promise<sdk.relayFeeCalculator.RelayerFeeDetails> => {
-  const tokenSymbol = getTokenSymbol(l1Token);
+  const tokenAddresses = sdk.utils.getL2TokenAddresses(l1Token);
+  if (!tokenAddresses) {
+    throw new InputError(
+      `Could not resolve token address for token ${l1Token}`
+    );
+  }
+  const originToken = tokenAddresses[originChainId];
+  const destinationToken = tokenAddresses[destinationChainId];
+
   const relayFeeCalculator = getRelayerFeeCalculator(destinationChainId);
-  return relayFeeCalculator.relayerFeeDetails(
-    amount,
-    tokenSymbol,
-    tokenPrice,
-    originChainId.toString(),
-    destinationChainId.toString()
-  );
+  try {
+    return await relayFeeCalculator.relayerFeeDetails(
+      {
+        amount: sdk.utils.toBN(amount),
+        depositId: sdk.utils.bnUint32Max.toNumber(),
+        depositor: recipientAddress,
+        destinationChainId,
+        originChainId,
+        relayerFeePct: sdk.utils.bnZero,
+        realizedLpFeePct: sdk.utils.bnZero,
+        recipient: recipientAddress,
+        message: message ?? sdk.constants.EMPTY_MESSAGE,
+        quoteTimestamp: sdk.utils.getCurrentTime(),
+        originToken,
+        destinationToken,
+      },
+      amount,
+      relayerAddress,
+      tokenPrice
+    );
+  } catch (_e: unknown) {
+    // Resolve and transform the error
+    const e = _e as Error;
+    // We want to mask this error as an Input error.
+    throw new InputError(e?.message);
+  }
 };
 
 /**
@@ -589,23 +612,51 @@ export const isRouteEnabled = (
 };
 
 /**
- * Resolves the balance of a given ERC20 token at a provided address
+ * Resolves the balance of a given ERC20 token at a provided address. If no token is provided, the balance of the
+ * native currency will be returned.
  * @param chainId The blockchain Id to query against
- * @param token The valid ERC20 token address on the given `chainId`
  * @param account A valid Web3 wallet address
- * @param blockTag A blockTag to specify a historical balance date
+ * @param token The valid ERC20 token address on the given `chainId`.
  * @returns A promise that resolves to the BigNumber of the balance
  */
 export const getBalance = (
   chainId: string | number,
-  token: string,
   account: string,
-  blockTag: number | "latest" = "latest"
+  token: string
 ): Promise<BigNumber> => {
-  return ERC20__factory.connect(token, getProvider(Number(chainId))).balanceOf(
+  return sdk.utils.getTokenBalance(
     account,
-    { blockTag }
+    token,
+    getProvider(Number(chainId))
+  );
+};
+
+/**
+ * Resolves the cached balance of a given ERC20 token at a provided address. If no token is provided, the balance of the
+ * native currency will be returned.
+ * @param chainId The blockchain Id to query against
+ * @param account A valid Web3 wallet address
+ * @param token The valid ERC20 token address on the given `chainId`.
+ * @returns A promise that resolves to the BigNumber of the balance
+ */
+export const getCachedTokenBalance = async (
+  chainId: string | number,
+  account: string,
+  token: string
+): Promise<BigNumber> => {
+  // Make the request to the vercel API.
+  const response = await axios.get<{ balance: string }>(
+    `${resolveVercelEndpoint()}/api/account-balance`,
+    {
+      params: {
+        chainId,
+        account,
+        token,
+      },
+    }
   );
+  // Return the balance
+  return BigNumber.from(response.data.balance);
 };
 
 /**

api/account-balance.ts

@@ -0,0 +1,61 @@
+import { VercelResponse } from "@vercel/node";
+import { assert, Infer, type, string } from "superstruct";
+import { TypedVercelRequest } from "./_types";
+import {
+  getBalance,
+  getLogger,
+  handleErrorCondition,
+  validAddress,
+} from "./_utils";
+
+const AccountBalanceQueryParamsSchema = type({
+  token: validAddress(),
+  account: validAddress(),
+  chainId: string(),
+});
+
+type AccountBalanceQueryParams = Infer<typeof AccountBalanceQueryParamsSchema>;
+
+const handler = async (
+  { query }: TypedVercelRequest<AccountBalanceQueryParams>,
+  response: VercelResponse
+) => {
+  const logger = getLogger();
+  logger.debug({
+    at: "AccountBalance",
+    message: "Query data",
+    query,
+  });
+  try {
+    // Validate the query parameters
+    assert(query, AccountBalanceQueryParamsSchema);
+    // Deconstruct the query parameters
+    let { token, account, chainId } = query;
+    // Rely on the utils to query the balance of either the native
+    // token or an ERC20 token.
+    const balance = await getBalance(chainId, account, token);
+    // Package the response
+    const result = {
+      balance: balance.toString(),
+      account: account,
+      token: token,
+    };
+    // Log the response
+    logger.debug({
+      at: "AccountBalance",
+      message: "Response data",
+      responseJson: result,
+    });
+    // Set the caching headers that will be used by the CDN.
+    response.setHeader(
+      "Cache-Control",
+      "s-maxage=150, stale-while-revalidate=150"
+    );
+    // Return the response
+    response.status(200).json(result);
+  } catch (error: unknown) {
+    return handleErrorCondition("account-balance", response, logger, error);
+  }
+};
+
+export default handler;

api/limits.ts

@@ -18,7 +18,7 @@ import {
   getRelayerFeeDetails,
   getCachedTokenPrice,
   getTokenDetails,
-  getBalance,
+  getCachedTokenBalance,
   maxBN,
   minBN,
   isRouteEnabled,
@@ -149,34 +149,25 @@ const handler = async (
         ethers.BigNumber.from("10").pow(18),
         computedOriginChainId,
         Number(destinationChainId),
+        undefined,
         tokenPriceNative
       ),
       hubPool.callStatic.multicall(multicallInput, { blockTag: BLOCK_TAG_LAG }),
       Promise.all(
         fullRelayers.map((relayer) =>
-          getBalance(
-            destinationChainId!,
-            destinationToken,
-            relayer,
-            BLOCK_TAG_LAG
-          )
+          getCachedTokenBalance(destinationChainId!, destinationToken, relayer)
         )
       ),
       Promise.all(
         transferRestrictedRelayers.map((relayer) =>
-          getBalance(
-            destinationChainId!,
-            destinationToken,
-            relayer,
-            BLOCK_TAG_LAG
-          )
+          getCachedTokenBalance(destinationChainId!, destinationToken, relayer)
         )
       ),
       Promise.all(
         fullRelayers.map((relayer) =>
           destinationChainId === "1"
             ? ethers.BigNumber.from("0")
-            : getBalance("1", l1Token, relayer, BLOCK_TAG_LAG)
+            : getCachedTokenBalance("1", l1Token, relayer)
         )
       ),
     ]);