Merge pull request #249 from rainlanguage/2024-11-06-node-error-report

report on error being from eth node
rainlanguage · Nov 10, 2024 · 64cce4d · 64cce4d
2 parents d16c425 + 947c75f
commit 64cce4d
Show file tree

Hide file tree

Showing 13 changed files with 208 additions and 35 deletions.
diff --git a/README.md b/README.md
@@ -114,7 +114,7 @@ Other optional arguments are:
 - `-V` or `--version`, output the version number
 - `-h` or `--help`, output usage information
 
-<br>
+<br> 
 
 ### List of available supported dexes (decentralized exchanges)
 - all of the below names are case INSENSITIVE:

diff --git a/src/config.ts b/src/config.ts
@@ -79,7 +79,7 @@ export async function createViemClient(
 ): Promise<ViemClient> {
     const transport =
         !rpcs || rpcs?.length === 0
-            ? fallback(fallbacks[chainId].transport, { rank: false, retryCount: 6 })
+            ? fallback(fallbacks[chainId].transport, { rank: false, retryCount: 3 })
             : useFallbacks
               ? fallback(
                     [
@@ -92,7 +92,7 @@ export async function createViemClient(
                         ),
                         ...fallbacks[chainId].transport,
                     ],
-                    { rank: false, retryCount: 6 },
+                    { rank: false, retryCount: 3 },
                 )
               : fallback(
                     rpcs.map((v) =>
@@ -102,7 +102,7 @@ export async function createViemClient(
                             onFetchResponse: config?.onFetchResponse,
                         }),
                     ),
-                    { rank: false, retryCount: 6 },
+                    { rank: false, retryCount: 3 },
                 );
 
     return testClient

diff --git a/src/error.ts b/src/error.ts
@@ -1,4 +1,10 @@
-import { BaseError } from "viem";
+import {
+    BaseError,
+    RpcRequestError,
+    InvalidInputRpcError,
+    ExecutionRevertedError,
+    TransactionRejectedRpcError,
+} from "viem";
 
 /**
  * Specifies error severity
@@ -32,3 +38,21 @@ export function errorSnapshot(header: string, err: any): string {
     }
     return message.join("\n");
 }
+
+/**
+ * Checks if a viem BaseError is from eth node, copied from
+ * "viem/_types/utils/errors/getNodeError" since not a default export
+ */
+export function containsNodeError(err: BaseError): boolean {
+    try {
+        return (
+            err instanceof TransactionRejectedRpcError ||
+            err instanceof InvalidInputRpcError ||
+            err instanceof ExecutionRevertedError ||
+            (err instanceof RpcRequestError && err.code === ExecutionRevertedError.code) ||
+            ("cause" in err && containsNodeError(err.cause as any))
+        );
+    } catch (error) {
+        return false;
+    }
+}
diff --git a/src/modes/index.ts b/src/modes/index.ts
@@ -98,6 +98,7 @@ export async function findOpp({
             spanAttributes,
             rawtx: undefined,
             oppBlockNumber: undefined,
+            noneNodeError: undefined,
         };
         if ((allResults[0] as any)?.reason?.spanAttributes) {
             spanAttributes["route-processor"] = JSON.stringify(
@@ -114,6 +115,19 @@ export async function findOpp({
                 (allResults[2] as any).reason.spanAttributes,
             );
         }
+        if ((allResults[0] as any)?.reason?.value?.noneNodeError) {
+            result.noneNodeError = (allResults[0] as any).reason.value.noneNodeError;
+        } else if (
+            result.noneNodeError === undefined &&
+            (allResults[1] as any)?.reason?.value?.noneNodeError
+        ) {
+            result.noneNodeError = (allResults[1] as any).reason.value.noneNodeError;
+        } else if (
+            result.noneNodeError === undefined &&
+            (allResults[2] as any)?.reason?.value?.noneNodeError
+        ) {
+            result.noneNodeError = (allResults[2] as any).reason.value.noneNodeError;
+        }
         throw result;
     }
 }
diff --git a/src/modes/interOrderbook.ts b/src/modes/interOrderbook.ts
@@ -1,8 +1,8 @@
-import { PublicClient } from "viem";
 import { orderbookAbi } from "../abis";
-import { errorSnapshot } from "../error";
+import { BaseError, PublicClient } from "viem";
 import { getBountyEnsureBytecode } from "../config";
 import { BigNumber, Contract, ethers } from "ethers";
+import { containsNodeError, errorSnapshot } from "../error";
 import { estimateProfit, withBigintSerializer } from "../utils";
 import { BotConfig, BundledOrders, ViemClient, DryrunResult, SpanAttrs } from "../types";
 
@@ -104,14 +104,23 @@ export async function dryrun({
         spanAttributes["blockNumber"] = blockNumber;
         gasLimit = ethers.BigNumber.from(await signer.estimateGas(rawtx));
     } catch (e) {
-        spanAttributes["error"] = errorSnapshot("", e);
+        const isNodeError = containsNodeError(e as BaseError);
+        const errMsg = errorSnapshot("", e);
+        spanAttributes["isNodeError"] = isNodeError;
+        spanAttributes["error"] = errMsg;
         spanAttributes["rawtx"] = JSON.stringify(
             {
                 ...rawtx,
                 from: signer.account.address,
             },
             withBigintSerializer,
         );
+        if (!isNodeError) {
+            result.value = {
+                noneNodeError: errMsg,
+                estimatedProfit: ethers.constants.Zero,
+            };
+        }
         return Promise.reject(result);
     }
     let gasCost = gasLimit.mul(gasPrice);
@@ -149,14 +158,23 @@ export async function dryrun({
                 task,
             ]);
         } catch (e) {
-            spanAttributes["error"] = errorSnapshot("", e);
+            const isNodeError = containsNodeError(e as BaseError);
+            const errMsg = errorSnapshot("", e);
+            spanAttributes["isNodeError"] = isNodeError;
+            spanAttributes["error"] = errMsg;
             spanAttributes["rawtx"] = JSON.stringify(
                 {
                     ...rawtx,
                     from: signer.account.address,
                 },
                 withBigintSerializer,
             );
+            if (!isNodeError) {
+                result.value = {
+                    noneNodeError: errMsg,
+                    estimatedProfit: ethers.constants.Zero,
+                };
+            }
             return Promise.reject(result);
         }
     }
@@ -213,6 +231,7 @@ export async function findOpp({
         reason: undefined,
         spanAttributes,
     };
+    const allNoneNodeErrors: (string | undefined)[] = [];
 
     const opposingOrderbookOrders = orderbooksOrders
         .map((v) => {
@@ -266,6 +285,9 @@ export async function findOpp({
             }),
         );
     } catch (e: any) {
+        for (const err of (e as AggregateError).errors) {
+            allNoneNodeErrors.push(err?.value?.noneNodeError);
+        }
         maximumInput = maximumInput.div(2);
         try {
             // try to find the first resolving binary search
@@ -303,6 +325,13 @@ export async function findOpp({
                 e.errors[i].spanAttributes;
         }
         spanAttributes["againstOrderbooks"] = JSON.stringify(allOrderbooksAttributes);
+        const noneNodeErrors = allNoneNodeErrors.filter((v) => !!v);
+        if (allNoneNodeErrors.length && noneNodeErrors.length / allNoneNodeErrors.length > 0.5) {
+            result.value = {
+                noneNodeError: noneNodeErrors[0],
+                estimatedProfit: ethers.constants.Zero,
+            };
+        }
         return Promise.reject(result);
     }
 }

diff --git a/src/modes/intraOrderbook.ts b/src/modes/intraOrderbook.ts
@@ -1,8 +1,8 @@
-import { PublicClient } from "viem";
-import { errorSnapshot } from "../error";
 import { BigNumber, ethers } from "ethers";
+import { BaseError, PublicClient } from "viem";
 import { erc20Abi, orderbookAbi } from "../abis";
 import { getWithdrawEnsureBytecode } from "../config";
+import { containsNodeError, errorSnapshot } from "../error";
 import { estimateProfit, withBigintSerializer } from "../utils";
 import {
     BotConfig,
@@ -92,14 +92,23 @@ export async function dryrun({
         gasLimit = ethers.BigNumber.from(await signer.estimateGas(rawtx));
     } catch (e) {
         // reason, code, method, transaction, error, stack, message
-        spanAttributes["error"] = errorSnapshot("", e);
+        const isNodeError = containsNodeError(e as BaseError);
+        const errMsg = errorSnapshot("", e);
+        spanAttributes["isNodeError"] = isNodeError;
+        spanAttributes["error"] = errMsg;
         spanAttributes["rawtx"] = JSON.stringify(
             {
                 ...rawtx,
                 from: signer.account.address,
             },
             withBigintSerializer,
         );
+        if (!isNodeError) {
+            result.value = {
+                noneNodeError: errMsg,
+                estimatedProfit: ethers.constants.Zero,
+            };
+        }
         return Promise.reject(result);
     }
     let gasCost = gasLimit.mul(gasPrice);
@@ -162,14 +171,23 @@ export async function dryrun({
                 [clear2Calldata, withdrawInputCalldata, withdrawOutputCalldata],
             ]);
         } catch (e) {
-            spanAttributes["error"] = errorSnapshot("", e);
+            const isNodeError = containsNodeError(e as BaseError);
+            const errMsg = errorSnapshot("", e);
+            spanAttributes["isNodeError"] = isNodeError;
+            spanAttributes["error"] = errMsg;
             spanAttributes["rawtx"] = JSON.stringify(
                 {
                     ...rawtx,
                     from: signer.account.address,
                 },
                 withBigintSerializer,
             );
+            if (!isNodeError) {
+                result.value = {
+                    noneNodeError: errMsg,
+                    estimatedProfit: ethers.constants.Zero,
+                };
+            }
             return Promise.reject(result);
         }
     }
@@ -248,6 +266,7 @@ export async function findOpp({
     if (!opposingOrders || !opposingOrders.length) throw undefined;
 
     const allErrorAttributes: string[] = [];
+    const allNoneNodeErrors: (string | undefined)[] = [];
     const erc20 = new ethers.utils.Interface(erc20Abi);
     const inputBalance = ethers.BigNumber.from(
         (
@@ -284,9 +303,17 @@ export async function findOpp({
                 outputBalance,
             });
         } catch (e: any) {
+            allNoneNodeErrors.push(e?.value?.noneNodeError);
             allErrorAttributes.push(JSON.stringify(e.spanAttributes));
         }
     }
     spanAttributes["intraOrderbook"] = allErrorAttributes;
+    const noneNodeErrors = allNoneNodeErrors.filter((v) => !!v);
+    if (allNoneNodeErrors.length && noneNodeErrors.length / allNoneNodeErrors.length > 0.5) {
+        result.value = {
+            noneNodeError: noneNodeErrors[0],
+            estimatedProfit: ethers.constants.Zero,
+        };
+    }
     return Promise.reject(result);
 }
diff --git a/src/modes/routeProcessor.ts b/src/modes/routeProcessor.ts
@@ -1,9 +1,9 @@
-import { PublicClient } from "viem";
 import { Token } from "sushi/currency";
-import { errorSnapshot } from "../error";
+import { BaseError, PublicClient } from "viem";
 import { getBountyEnsureBytecode } from "../config";
 import { ChainId, DataFetcher, Router } from "sushi";
 import { BigNumber, Contract, ethers } from "ethers";
+import { containsNodeError, errorSnapshot } from "../error";
 import { BotConfig, BundledOrders, ViemClient, DryrunResult, SpanAttrs } from "../types";
 import { estimateProfit, RPoolFilter, visualizeRoute, withBigintSerializer } from "../utils";
 
@@ -170,7 +170,10 @@ export async function dryrun({
             gasLimit = ethers.BigNumber.from(await signer.estimateGas(rawtx));
         } catch (e) {
             // reason, code, method, transaction, error, stack, message
-            spanAttributes["error"] = errorSnapshot("", e);
+            const isNodeError = containsNodeError(e as BaseError);
+            const errMsg = errorSnapshot("", e);
+            spanAttributes["isNodeError"] = isNodeError;
+            spanAttributes["error"] = errMsg;
             spanAttributes["rawtx"] = JSON.stringify(
                 {
                     ...rawtx,
@@ -179,6 +182,12 @@ export async function dryrun({
                 withBigintSerializer,
             );
             result.reason = RouteProcessorDryrunHaltReason.NoOpportunity;
+            if (!isNodeError) {
+                result.value = {
+                    noneNodeError: errMsg,
+                    estimatedProfit: ethers.constants.Zero,
+                };
+            }
             return Promise.reject(result);
         }
         let gasCost = gasLimit.mul(gasPrice);
@@ -216,7 +225,10 @@ export async function dryrun({
                     task,
                 ]);
             } catch (e) {
-                spanAttributes["error"] = errorSnapshot("", e);
+                const isNodeError = containsNodeError(e as BaseError);
+                const errMsg = errorSnapshot("", e);
+                spanAttributes["isNodeError"] = isNodeError;
+                spanAttributes["error"] = errMsg;
                 spanAttributes["rawtx"] = JSON.stringify(
                     {
                         ...rawtx,
@@ -225,6 +237,12 @@ export async function dryrun({
                     withBigintSerializer,
                 );
                 result.reason = RouteProcessorDryrunHaltReason.NoOpportunity;
+                if (!isNodeError) {
+                    result.value = {
+                        noneNodeError: errMsg,
+                        estimatedProfit: ethers.constants.Zero,
+                    };
+                }
                 return Promise.reject(result);
             }
         }
@@ -300,6 +318,7 @@ export async function findOpp({
 
     const allSuccessHops: DryrunResult[] = [];
     const allHopsAttributes: string[] = [];
+    const allNoneNodeErrors: (string | undefined)[] = [];
     for (let i = 1; i < config.hops + 1; i++) {
         try {
             const dryrunResult = await dryrun({
@@ -337,6 +356,7 @@ export async function findOpp({
                 delete e.spanAttributes["error"];
                 delete e.spanAttributes["rawtx"];
             }
+            allNoneNodeErrors.push(e?.value?.noneNodeError);
             allHopsAttributes.push(JSON.stringify(e.spanAttributes));
 
             // set the maxInput for next hop by decreasing
@@ -351,7 +371,19 @@ export async function findOpp({
         spanAttributes["hops"] = allHopsAttributes;
 
         if (noRoute) result.reason = RouteProcessorDryrunHaltReason.NoRoute;
-        else result.reason = RouteProcessorDryrunHaltReason.NoOpportunity;
+        else {
+            const noneNodeErrors = allNoneNodeErrors.filter((v) => !!v);
+            if (
+                allNoneNodeErrors.length &&
+                noneNodeErrors.length / allNoneNodeErrors.length > 0.5
+            ) {
+                result.value = {
+                    noneNodeError: noneNodeErrors[0],
+                    estimatedProfit: ethers.constants.Zero,
+                };
+            }
+            result.reason = RouteProcessorDryrunHaltReason.NoOpportunity;
+        }
 
         return Promise.reject(result);
     }
@@ -439,6 +471,12 @@ export async function findOppWithRetries({
         for (const attrKey in (allPromises[0] as any).reason.spanAttributes) {
             spanAttributes[attrKey] = (allPromises[0] as any).reason.spanAttributes[attrKey];
         }
+        if ((allPromises[0] as any)?.reason?.value?.noneNodeError) {
+            result.value = {
+                noneNodeError: (allPromises[0] as any).reason.value.noneNodeError,
+                estimatedProfit: ethers.constants.Zero,
+            };
+        }
         result.reason = RouteProcessorDryrunHaltReason.NoOpportunity;
         throw result;
     }