feat: include new relayer address override (#886)

* feat: include new relayer address override

* improve: embed new relayer defaults into routes

* fix: bug

* chore: include checksummed address

api/_constants.ts

@@ -95,6 +95,16 @@ const defaultRelayerFeeCapitalCostConfig: {
   },
 };
 
+export const defaultRelayerAddressOverride: Record<
+  string,
+  { relayer: string; destinationChains: number[] }
+> = {
+  SNX: {
+    relayer: "0x19cDc2b23AF0cC791ca64dda5BFc094Cddda31Cd",
+    destinationChains: [1, 10],
+  },
+};
+
 const relayerFeeCapitalCostOverrides: Record<
   string,
   Record<string, Record<string, relayFeeCalculator.CapitalCostConfig>>

api/_utils.ts

@@ -33,6 +33,7 @@ import {
   maxRelayFeePct,
   relayerFeeCapitalCostConfig,
   BLOCK_TAG_LAG,
+  defaultRelayerAddressOverride,
 } from "./_constants";
 import { PoolStateResult } from "./_types";
 
@@ -1226,3 +1227,22 @@ export async function getBalancerV2TokenPrice(
 
   return Number((totalValue / floatTotalSupply).toFixed(18));
 }
+
+/**
+ * Returns the EOA that will serve as the default relayer address
+ * @param symbol A valid token symbol
+ * @param destinationChainId The destination chain that a bridge operation will transfer to
+ * @returns A valid EOA address
+ */
+export function getDefaultRelayerAddress(
+  symbol: string,
+  destinationChainId: number
+) {
+  // All symbols are uppercase in this record.
+  const result = defaultRelayerAddressOverride[symbol.toUpperCase()];
+  if (result?.destinationChains.includes(destinationChainId)) {
+    return result.relayer;
+  } else {
+    return sdk.constants.DEFAULT_SIMULATED_RELAYER_ADDRESS;
+  }
+}

api/limits.ts

@@ -30,6 +30,7 @@ import {
   getProvider,
   HUB_POOL_CHAIN_ID,
   ENABLED_ROUTES,
+  getDefaultRelayerAddress,
 } from "./_utils";
 
 const LimitsQueryParamsSchema = object({
@@ -99,8 +100,10 @@ const handler = async (
     const tokenDetails = Object.values(TOKEN_SYMBOLS_MAP).find(
       (details) => details.addresses[HUB_POOL_CHAIN_ID] === l1Token
     );
-    if (tokenDetails === undefined)
+
+    if (tokenDetails === undefined) {
       throw new InputError("Unsupported token address");
+    }
     const symbol = tokenDetails.symbol;
 
     const [tokenDetailsResult, routeEnabledResult] = await Promise.allSettled([
@@ -154,7 +157,9 @@ const handler = async (
         computedOriginChainId,
         Number(destinationChainId),
         DEFAULT_SIMULATED_RECIPIENT_ADDRESS,
-        tokenPriceNative
+        tokenPriceNative,
+        undefined,
+        getDefaultRelayerAddress(symbol, Number(destinationChainId))
       ),
       hubPool.callStatic.multicall(multicallInput, { blockTag: BLOCK_TAG_LAG }),
       Promise.all(

api/suggested-fees.ts

@@ -9,6 +9,7 @@ import { type, assert, Infer, optional, string } from "superstruct";
 import {
   disabledL1Tokens,
   DEFAULT_QUOTE_TIMESTAMP_BUFFER,
+  TOKEN_SYMBOLS_MAP,
   DEFAULT_SIMULATED_RECIPIENT_ADDRESS,
 } from "./_constants";
 import { TypedVercelRequest } from "./_types";
@@ -29,6 +30,7 @@ import {
   ENABLED_ROUTES,
   getSpokePoolAddress,
   getCachedTokenBalance,
+  getDefaultRelayerAddress,
 } from "./_utils";
 
 const SuggestedFeesQueryParamsSchema = type({
@@ -92,6 +94,19 @@ const handler = async (
     ]);
     const { l1Token, hubPool, chainId: computedOriginChainId } = tokenDetails;
 
+    const tokenInformation = Object.values(TOKEN_SYMBOLS_MAP).find(
+      (details) => details.addresses[HUB_POOL_CHAIN_ID] === l1Token
+    );
+
+    if (!sdk.utils.isDefined(tokenInformation)) {
+      throw new InputError("Unsupported token address");
+    }
+
+    relayer ??= getDefaultRelayerAddress(
+      tokenInformation.symbol,
+      Number(destinationChainId)
+    );
+
     if (sdk.utils.isDefined(message) && !sdk.utils.isMessageEmpty(message)) {
       if (!ethers.utils.isHexString(message)) {
         throw new InputError("Message must be a hex string");