improve: simulate relay gas fees for messages

api/_types/utility.types.ts

@@ -3,3 +3,9 @@ export type PoolStateResult = {
   exchangeRateCurrent: string;
   totalPoolSize: string;
 };
+
+export type MessagePayload = {
+  message: string;
+  recipientAddress: string;
+  relayerAddress?: string;
+};

api/_utils.ts

@@ -33,7 +33,7 @@ import {
   maxRelayFeePct,
   relayerFeeCapitalCostConfig,
 } from "./_constants";
-import { PoolStateResult } from "./_types";
+import { MessagePayload, PoolStateResult } from "./_types";
 
 type LoggingUtility = sdk.relayFeeCalculator.Logger;
 
@@ -333,7 +333,6 @@ export const queries: Record<
       undefined,
       undefined,
       undefined,
-      undefined,
       REACT_APP_COINGECKO_PRO_API_KEY,
       getLogger(),
       getGasMarkup(CHAIN_IDs.MAINNET)
@@ -344,7 +343,6 @@ export const queries: Record<
       undefined,
       undefined,
       undefined,
-      undefined,
       REACT_APP_COINGECKO_PRO_API_KEY,
       getLogger(),
       getGasMarkup(CHAIN_IDs.OPTIMISM)
@@ -355,7 +353,6 @@ export const queries: Record<
       undefined,
       undefined,
       undefined,
-      undefined,
       REACT_APP_COINGECKO_PRO_API_KEY,
       getLogger(),
       getGasMarkup(CHAIN_IDs.POLYGON)
@@ -366,7 +363,6 @@ export const queries: Record<
       undefined,
       undefined,
       undefined,
-      undefined,
       REACT_APP_COINGECKO_PRO_API_KEY,
       getLogger(),
       getGasMarkup(CHAIN_IDs.ARBITRUM)
@@ -377,7 +373,6 @@ export const queries: Record<
       undefined,
       undefined,
       undefined,
-      undefined,
       REACT_APP_COINGECKO_PRO_API_KEY,
       getLogger(),
       getGasMarkup(CHAIN_IDs.ZK_SYNC)
@@ -388,7 +383,6 @@ export const queries: Record<
       undefined,
       undefined,
       undefined,
-      undefined,
       REACT_APP_COINGECKO_PRO_API_KEY,
       getLogger(),
       getGasMarkup(CHAIN_IDs.BASE)
@@ -400,7 +394,6 @@ export const queries: Record<
       undefined,
       undefined,
       undefined,
-      undefined,
       REACT_APP_COINGECKO_PRO_API_KEY,
       getLogger(),
       getGasMarkup(CHAIN_IDs.GOERLI)
@@ -411,7 +404,6 @@ export const queries: Record<
       undefined,
       undefined,
       undefined,
-      undefined,
       REACT_APP_COINGECKO_PRO_API_KEY,
       getLogger(),
       getGasMarkup(CHAIN_IDs.ARBITRUM_GOERLI)
@@ -422,7 +414,6 @@ export const queries: Record<
       undefined,
       undefined,
       undefined,
-      undefined,
       REACT_APP_COINGECKO_PRO_API_KEY,
       getLogger(),
       getGasMarkup(CHAIN_IDs.ZK_SYNC_GOERLI)
@@ -433,7 +424,6 @@ export const queries: Record<
       undefined,
       undefined,
       undefined,
-      undefined,
       REACT_APP_COINGECKO_PRO_API_KEY,
       getLogger(),
       getGasMarkup(CHAIN_IDs.BASE_GOERLI)
@@ -492,22 +482,43 @@ export const getTokenSymbol = (tokenAddress: string): string => {
  * @param tokenPrice An optional overred price to prevent the SDK from creating its own call
  * @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
+  tokenPrice?: number,
+  messagePayload?: MessagePayload
 ): Promise<sdk.relayFeeCalculator.RelayerFeeDetails> => {
   const tokenSymbol = getTokenSymbol(l1Token);
   const relayFeeCalculator = getRelayerFeeCalculator(destinationChainId);
-  return relayFeeCalculator.relayerFeeDetails(
-    amount,
-    tokenSymbol,
-    tokenPrice,
-    originChainId.toString(),
-    destinationChainId.toString()
-  );
+  try {
+    return await relayFeeCalculator.relayerFeeDetails(
+      amount,
+      tokenSymbol,
+      String(originChainId),
+      String(destinationChainId),
+      messagePayload,
+      tokenPrice
+    );
+  } catch (_e: unknown) {
+    const e = _e as Error;
+    // If the error is due to a specific number of erroneous inputs,
+    // we can propagate the error to the user as a 4xx.
+    if (e.message.includes("Could not simulate message fill.")) {
+      throw new InputError(e.message);
+    } else {
+      // Otherwise, we throw a 500.
+      throw new Error(
+        `Could not process relayer fee details.
+      ${
+        sdk.utils.isDefined(messagePayload)
+          ? " The likely cause is related to message payload."
+          : ""
+      }`
+      );
+    }
+  }
 };
 
 /**

api/suggested-fees.ts

@@ -5,7 +5,7 @@ import * as sdk from "@across-protocol/sdk-v2";
 import { BlockFinder } from "@uma/sdk";
 import { VercelResponse } from "@vercel/node";
 import { ethers } from "ethers";
-import { type, assert, Infer, optional } from "superstruct";
+import { type, assert, Infer, optional, string } from "superstruct";
 import { disabledL1Tokens, DEFAULT_QUOTE_TIMESTAMP_BUFFER } from "./_constants";
 import { TypedVercelRequest } from "./_types";
 import {
@@ -33,6 +33,9 @@ const SuggestedFeesQueryParamsSchema = type({
   originChainId: optional(positiveIntStr()),
   timestamp: optional(positiveIntStr()),
   skipAmountLimit: optional(boolStr()),
+  message: optional(string()),
+  recipientAddress: optional(validAddress()),
+  relayerAddress: optional(validAddress()),
 });
 
 type SuggestedFeesQueryParams = Infer<typeof SuggestedFeesQueryParamsSchema>;
@@ -64,6 +67,9 @@ const handler = async (
       originChainId,
       timestamp,
       skipAmountLimit,
+      recipientAddress,
+      relayerAddress,
+      message,
     } = query;
 
     if (originChainId === destinationChainId) {
@@ -78,6 +84,31 @@ const handler = async (
     ]);
     const { l1Token, hubPool, chainId: computedOriginChainId } = tokenDetails;
 
+    if (
+      sdk.utils.isDefined(message) &&
+      !sdk.utils.isDefined(recipientAddress)
+    ) {
+      throw new InputError(
+        "Recipient address is required when message is provided"
+      );
+    }
+    if (
+      sdk.utils.isDefined(message) &&
+      // Our message encoding is a hex string, so we need to check that the length is even.
+      message.length % 2 !== 0
+    ) {
+      throw new InputError("Message must be an even hex string");
+    }
+
+    const messagePayload =
+      sdk.utils.isDefined(message) && sdk.utils.isDefined(recipientAddress)
+        ? {
+            message,
+            recipientAddress,
+            relayerAddress,
+          }
+        : undefined;
+
     // Note: Add a buffer to "latest" timestamp so that it corresponds to a block older than HEAD.
     // This is to improve relayer UX who have heightened risk of sending inadvertent invalid fills
     // for quote times right at HEAD (or worst, in the future of HEAD). If timestamp is supplied as
@@ -151,7 +182,8 @@ const handler = async (
       amount,
       computedOriginChainId,
       Number(destinationChainId),
-      tokenPrice
+      tokenPrice,
+      messagePayload
     );
 
     const skipAmountLimitEnabled = skipAmountLimit === "true";