From 6374a95191c940aa024a4a0e59ff998a941feb79 Mon Sep 17 00:00:00 2001
From: Matthew Walsh <matthew.walsh@consensys.net>
Date: Tue, 1 Oct 2024 08:57:09 +0100
Subject: [PATCH] Add JSDoc

---
 .../transaction-controller/src/TransactionController.ts     | 1 +
 packages/transaction-controller/src/utils/etherscan.ts      | 6 +++---
 2 files changed, 4 insertions(+), 3 deletions(-)

diff --git a/packages/transaction-controller/src/TransactionController.ts b/packages/transaction-controller/src/TransactionController.ts
index 654bb6bd38..0d25caa74d 100644
--- a/packages/transaction-controller/src/TransactionController.ts
+++ b/packages/transaction-controller/src/TransactionController.ts
@@ -291,6 +291,7 @@ export type TransactionControllerOptions = {
   getPermittedAccounts?: (origin?: string) => Promise<string[]>;
   getSavedGasFees?: (chainId: Hex) => SavedGasFees | undefined;
   incomingTransactions?: IncomingTransactionOptions & {
+    /** API keys to be used for Etherscan requests to prevent rate limiting. */
     etherscanApiKeysByChainId?: Record<Hex, string>;
   };
   isMultichainEnabled: boolean;
diff --git a/packages/transaction-controller/src/utils/etherscan.ts b/packages/transaction-controller/src/utils/etherscan.ts
index c34edccf16..703871f499 100644
--- a/packages/transaction-controller/src/utils/etherscan.ts
+++ b/packages/transaction-controller/src/utils/etherscan.ts
@@ -77,7 +77,7 @@ export interface EtherscanTransactionRequest {
  *
  * @param request - Configuration required to fetch transactions.
  * @param request.address - Address to retrieve transactions for.
- * @param request.apiKey - Etherscan API key to prevent throttling.
+ * @param request.apiKey - Etherscan API key to prevent rate limiting.
  * @param request.chainId - Current chain ID used to determine subdomain and domain.
  * @param request.fromBlock - Block number to start fetching transactions from.
  * @param request.limit - Number of transactions to retrieve.
@@ -106,7 +106,7 @@ export async function fetchEtherscanTransactions({
  *
  * @param request - Configuration required to fetch token transactions.
  * @param request.address - Address to retrieve token transactions for.
- * @param request.apiKey - Etherscan API key to prevent throttling.
+ * @param request.apiKey - Etherscan API key to prevent rate limiting.
  * @param request.chainId - Current chain ID used to determine subdomain and domain.
  * @param request.fromBlock - Block number to start fetching token transactions from.
  * @param request.limit - Number of token transactions to retrieve.
@@ -136,7 +136,7 @@ export async function fetchEtherscanTokenTransactions({
  * @param action - The Etherscan endpoint to use.
  * @param options - Options bag.
  * @param options.address - Address to retrieve transactions for.
- * @param options.apiKey - Etherscan API key to prevent throttling.
+ * @param options.apiKey - Etherscan API key to prevent rate limiting.
  * @param options.chainId - Current chain ID used to determine subdomain and domain.
  * @param options.fromBlock - Block number to start fetching transactions from.
  * @param options.limit - Number of transactions to retrieve.