Fix ethers error messages sanitization (#294)

* Sanitize ethers error messages

* Add more context to logs

* Update sanitizeError function

Author: Siegrift

src/update-feeds-loops/pending-transaction-info.ts

@@ -57,7 +57,11 @@ export const updatePendingTransactionsInfo = (
         : 1;
       const firstUpdatableTimestamp = pendingTransactionInfo?.firstUpdatableTimestamp ?? currentTimestamp;
       const newPendingTransactionInfo = { consecutivelyUpdatableCount, firstUpdatableTimestamp };
-      logger.info('Updating pending transaction info.', newPendingTransactionInfo);
+      logger.info('Updating pending transaction info.', {
+        ...newPendingTransactionInfo,
+        dapiName: decodedDapiName,
+        dataFeedId,
+      });
       setPendingTransactionInfo(chainId, providerName, sponsorWalletAddress, newPendingTransactionInfo);
     }
     if (!isFeedUpdatable && pendingTransactionInfo) {

src/update-feeds-loops/submit-transactions.ts

@@ -166,10 +166,13 @@ export const submitTransaction = async (
             return null;
           } else if (ethersError.code === 'INSUFFICIENT_FUNDS') {
             // This should never happen and monitoring should warn even before Airseeker comes to this point.
-            logger.error(`Failed to submit the transaction because of insufficient funds.`, ethersError);
+            logger.error(
+              `Failed to submit the transaction because of insufficient funds.`,
+              sanitizeEthersError(ethersError)
+            );
             return null;
           } else {
-            logger.warn(`Failed to submit the update transaction.`, ethersError);
+            logger.warn(`Failed to submit the update transaction.`, sanitizeEthersError(ethersError));
             return null;
           }
         }

src/utils.ts

@@ -91,7 +91,12 @@ export const sanitizeEthersError = (error: Error) => {
 
   // We don't care about the stack trace, nor error name - just the code and the message. According to the ethers
   // sources, the short message should always be defined.
-  return new SanitizedErrorsError(ethersError.code, ethersError.shortMessage);
+  const sanitizedError = new SanitizedErrorsError(ethersError.code, ethersError.shortMessage);
+  // NOTE: We don't need the stack trace, because the errors are usually easy to find by the developer message and the
+  // stack can be traced manually. This reduces the risk of the stack trace being too large and "exploding" the log
+  // size.
+  delete sanitizedError.stack;
+  return sanitizedError;
 };
 
 export const generateRandomId = () => randomBytes(32).toString('hex');