From 85c862142067491527493f3045180f335fcf1253 Mon Sep 17 00:00:00 2001
From: Paul <108695806+pxrl@users.noreply.github.com>
Date: Mon, 30 Oct 2023 17:32:44 +0100
Subject: [PATCH] refactor: Align /suggested-fees inputs w/ SpokePool names
 (#890)

To reduce misalignment between the SpokePool deposit() input parameters
and the parameter names supplied to /suggested-fees, rename the
following:

 recipientAddress -> recipient
 relayerAddress -> relayer

This leaves only `token` as the variable name that differs.
---
 api/suggested-fees.ts | 23 ++++++++++++-----------
 1 file changed, 12 insertions(+), 11 deletions(-)

diff --git a/api/suggested-fees.ts b/api/suggested-fees.ts
index f4737bbf2..2fc0b823d 100644
--- a/api/suggested-fees.ts
+++ b/api/suggested-fees.ts
@@ -39,8 +39,8 @@ const SuggestedFeesQueryParamsSchema = type({
   timestamp: optional(positiveIntStr()),
   skipAmountLimit: optional(boolStr()),
   message: optional(string()),
-  recipientAddress: optional(validAddress()),
-  relayerAddress: optional(validAddress()),
+  recipient: optional(validAddress()),
+  relayer: optional(validAddress()),
 });
 
 type SuggestedFeesQueryParams = Infer<typeof SuggestedFeesQueryParamsSchema>;
@@ -72,8 +72,8 @@ const handler = async (
       originChainId,
       timestamp,
       skipAmountLimit,
-      recipientAddress,
-      relayerAddress,
+      recipient,
+      relayer,
       message,
     } = query;
 
@@ -82,8 +82,8 @@ const handler = async (
     }
     const destinationChainId = Number(_destinationChainId);
 
-    relayerAddress ??= sdk.constants.DEFAULT_SIMULATED_RELAYER_ADDRESS;
-    recipientAddress ??= DEFAULT_SIMULATED_RECIPIENT_ADDRESS;
+    relayer ??= sdk.constants.DEFAULT_SIMULATED_RELAYER_ADDRESS;
+    recipient ??= DEFAULT_SIMULATED_RECIPIENT_ADDRESS;
     token = ethers.utils.getAddress(token);
 
     const [latestBlock, tokenDetails] = await Promise.all([
@@ -101,7 +101,7 @@ const handler = async (
         throw new InputError("Message must be an even hex string");
       }
       const isRecipientAContract = await sdk.utils.isContractDeployedToAddress(
-        recipientAddress,
+        recipient,
         getProvider(destinationChainId)
       );
       if (!isRecipientAContract) {
@@ -124,12 +124,13 @@ const handler = async (
         }
         const balanceOfToken = await getCachedTokenBalance(
           destinationChainId,
-          relayerAddress,
+          relayer,
           destinationToken
         );
         if (balanceOfToken.lt(amountInput)) {
           throw new InputError(
-            `Relayer Address (${relayerAddress}) doesn't have enough funds to support this deposit. For help, please reach out to https://discord.across.to`
+            `Relayer Address (${relayer}) doesn't have enough funds to support this deposit;` +
+              ` for help, please reach out to https://discord.across.to`
           );
         }
       }
@@ -208,10 +209,10 @@ const handler = async (
       amount,
       computedOriginChainId,
       destinationChainId,
-      recipientAddress,
+      recipient,
       tokenPrice,
       message,
-      relayerAddress
+      relayer
     );
 
     const skipAmountLimitEnabled = skipAmountLimit === "true";