Merge pull request #257 from rainlanguage/2024-11-15-gas-price-multip…

…lier-option

gas price ultiplier option

README.md

@@ -111,6 +111,7 @@ Other optional arguments are:
 - `--route`, Specifies the routing mode 'multi' or 'single' or 'full', default is 'single'. Will override the 'ROUTE' in env variables
 - `-w` or `--wallet-count`, Number of wallet to submit transactions with, requirs `--mnemonic`. Will override the 'WALLET_COUNT' in env variables
 - `-t` or `--topup-amount`, The initial topup amount of excess wallets, requirs `--mnemonic`. Will override the 'TOPUP_AMOUNT' in env variables
+- `--gas-price-multiplier`, Option to multiply the gas price fetched from the rpc as percentage, default is 107, ie +7%. Will override the 'GAS_PRICE_MULTIPLIER' in env variables
 - `-V` or `--version`, output the version number
 - `-h` or `--help`, output usage information
 
@@ -252,6 +253,9 @@ SELF_FUND_ORDERS=
 
 # Specifies the routing mode 'multi' or 'single' or 'full', default is 'single'
 ROUTE="single"
+
+# Option to multiply the gas price fetched from the rpc as percentage, default is 107, ie +7%
+GAS_PRICE_MULTIPLIER=
 ```
 If both env variables and CLI argument are set, the CLI arguments will be prioritized and override the env variables.
 

example.env

@@ -82,6 +82,9 @@ SELF_FUND_ORDERS=
 # Specifies the routing mode 'multi' or 'single' or 'full', default is 'single'
 ROUTE="single"
 
+# Option to multiply the gas price fetched from the rpc as percentage, default is 107, ie +7%
+GAS_PRICE_MULTIPLIER=
+
 
 # test rpcs vars
 TEST_POLYGON_RPC=

src/cli.ts

@@ -56,6 +56,7 @@ const ENV_OPTIONS = {
     topupAmount: process?.env?.TOPUP_AMOUNT,
     botMinBalance: process?.env?.BOT_MIN_BALANCE,
     selfFundOrders: process?.env?.SELF_FUND_ORDERS,
+    gasPriceMultiplier: process?.env?.GAS_PRICE_MULTIPLIER,
     route: process?.env?.ROUTE,
     rpc: process?.env?.RPC_URL
         ? Array.from(process?.env?.RPC_URL.matchAll(/[^,\s]+/g)).map((v) => v[0])
@@ -163,6 +164,10 @@ const getOptions = async (argv: any, version?: string) => {
             "--route <string>",
             "Specifies the routing mode 'multi' or 'single' or 'full', default is 'single'. Will override the 'ROUTE' in env variables",
         )
+        .option(
+            "--gas-price-multiplier <integer>",
+            "Option to multiply the gas price fetched from the rpc as percentage, default is 107, ie +7%. Will override the 'GAS_PRICE_MULTIPLIER' in env variables",
+        )
         .description(
             [
                 "A NodeJS app to find and take arbitrage trades for Rain Orderbook orders against some DeFi liquidity providers, requires NodeJS v18 or higher.",
@@ -197,6 +202,7 @@ const getOptions = async (argv: any, version?: string) => {
     cmdOptions.walletCount = cmdOptions.walletCount || ENV_OPTIONS.walletCount;
     cmdOptions.topupAmount = cmdOptions.topupAmount || ENV_OPTIONS.topupAmount;
     cmdOptions.selfFundOrders = cmdOptions.selfFundOrders || ENV_OPTIONS.selfFundOrders;
+    cmdOptions.gasPriceMultiplier = cmdOptions.gasPriceMultiplier || ENV_OPTIONS.gasPriceMultiplier;
     cmdOptions.botMinBalance = cmdOptions.botMinBalance || ENV_OPTIONS.botMinBalance;
     cmdOptions.route = cmdOptions.route || ENV_OPTIONS.route;
     cmdOptions.bundle = cmdOptions.bundle ? ENV_OPTIONS.bundle : false;
@@ -368,6 +374,21 @@ export async function startup(argv: any, version?: string, tracer?: Tracer, ctx?
     if (!options.botMinBalance || !/^[0-9]+(.[0-9]+)?$/.test(options.botMinBalance)) {
         throw "expected a valid value for --bot-min-balance, it should be an number greater than 0";
     }
+    if (options.gasPriceMultiplier) {
+        if (typeof options.gasPriceMultiplier === "number") {
+            if (options.gasPriceMultiplier <= 0 || !Number.isInteger(options.gasPriceMultiplier))
+                throw "invalid gasPriceMultiplier value, must be an integer greater than zero";
+        } else if (
+            typeof options.gasPriceMultiplier === "string" &&
+            /^[0-9]+$/.test(options.gasPriceMultiplier)
+        ) {
+            options.gasPriceMultiplier = Number(options.gasPriceMultiplier);
+            if (options.gasPriceMultiplier <= 0)
+                throw "invalid gasPriceMultiplier value, must be an integer greater than zero";
+        } else throw "invalid gasPriceMultiplier value, must be an integer greater than zero";
+    } else {
+        options.gasPriceMultiplier = 107;
+    }
     const poolUpdateInterval = _poolUpdateInterval * 60 * 1000;
     let ordersDetails: any[] = [];
     if (!process?.env?.TEST)

src/error.ts

@@ -2,6 +2,7 @@ import {
     BaseError,
     RpcRequestError,
     ExecutionRevertedError,
+    InsufficientFundsError,
     // InvalidInputRpcError,
     // TransactionRejectedRpcError,
 } from "viem";
@@ -49,6 +50,7 @@ export function containsNodeError(err: BaseError): boolean {
             // err instanceof TransactionRejectedRpcError ||
             // err instanceof InvalidInputRpcError ||
             err instanceof ExecutionRevertedError ||
+            err instanceof InsufficientFundsError ||
             (err instanceof RpcRequestError && err.code === ExecutionRevertedError.code) ||
             ("cause" in err && containsNodeError(err.cause as any))
         );

src/index.ts

@@ -210,6 +210,7 @@ export async function getConfig(
     config.walletKey = walletKey;
     config.route = route;
     config.rpcRecords = rpcRecords;
+    config.gasPriceMultiplier = options.gasPriceMultiplier;
 
     // init accounts
     const { mainAccount, accounts } = await initAccounts(walletKey, config, options, tracer, ctx);

src/processOrders.ts

@@ -445,7 +445,7 @@ export async function processPair(args: {
     let gasPrice;
     try {
         const gasPriceBigInt = await viemClient.getGasPrice();
-        gasPrice = ethers.BigNumber.from(gasPriceBigInt).mul("107").div("100");
+        gasPrice = ethers.BigNumber.from(gasPriceBigInt).mul(config.gasPriceMultiplier).div("100");
         spanAttributes["details.gasPrice"] = gasPrice.toString();
     } catch (e) {
         result.reason = ProcessPairHaltReason.FailedToGetGasPrice;
@@ -585,6 +585,8 @@ export async function processPair(args: {
         if (e.noneNodeError) {
             spanAttributes["details.noneNodeError"] = true;
             result.error = e.noneNodeError;
+        } else {
+            spanAttributes["details.noneNodeError"] = false;
         }
         result.report = {
             status: ProcessPairReportStatus.NoOpportunity,

src/types.ts

@@ -45,6 +45,7 @@ export type CliOptions = {
     selfFundOrders?: SelfFundOrder[];
     tokens?: TokenDetails[];
     route?: string;
+    gasPriceMultiplier: number;
 };
 
 export type TokenDetails = {
@@ -143,6 +144,7 @@ export type BotConfig = {
     walletKey: string;
     route?: "multi" | "single";
     rpcRecords: Record<string, RpcRecord>;
+    gasPriceMultiplier: number;
     onFetchRequest?: (request: Request) => void;
     onFetchResponse?: (request: Response) => void;
 };

test/cli.test.js

@@ -183,6 +183,8 @@ describe("Test cli", async function () {
             `0x${"2".repeat(40)}`,
             "--bot-min-balance",
             "0.123",
+            "--gas-price-multiplier",
+            "120",
         ]);
         const expected = {
             roundGap: 10000,
@@ -201,9 +203,11 @@ describe("Test cli", async function () {
                         cache: {},
                     },
                 },
+                gasPriceMultiplier: 120,
             },
             options: {
                 botMinBalance: "0.123",
+                gasPriceMultiplier: 120,
             },
         };
         await sleep(1000);
@@ -215,5 +219,7 @@ describe("Test cli", async function () {
         assert.equal(result.config.route, expected.config.route);
         assert.deepEqual(result.config.rpcRecords, expected.config.rpcRecords);
         assert.equal(result.options.botMinBalance, expected.options.botMinBalance);
+        assert.equal(result.options.gasPriceMultiplier, expected.options.gasPriceMultiplier);
+        assert.equal(result.config.gasPriceMultiplier, expected.config.gasPriceMultiplier);
     });
 });

test/data.js

@@ -66,6 +66,7 @@ const config = {
         decimals: token2.decimals,
         symbol: token2.symbol,
     },
+    gasPriceMultiplier: 107,
 };
 
 const vaultBalance1 = BigNumber.from("10000000000000000000");

test/e2e/e2e.test.js

@@ -249,6 +249,7 @@ for (let i = 0; i < testData.length; i++) {
                 config.accounts = [];
                 config.mainAccount = bot;
                 config.quoteRpc = [mockServer.url + "/rpc"];
+                config.gasPriceMultiplier = 107;
                 const { reports } = await clear(config, orders, tracer, ctx);
 
                 // should have cleared correct number of orders
@@ -579,6 +580,7 @@ for (let i = 0; i < testData.length; i++) {
                 config.accounts = [];
                 config.mainAccount = bot;
                 config.quoteRpc = [mockServer.url + "/rpc"];
+                config.gasPriceMultiplier = 107;
                 const { reports } = await clear(config, orders, tracer, ctx);
 
                 // should have cleared correct number of orders
@@ -930,6 +932,7 @@ for (let i = 0; i < testData.length; i++) {
                 config.accounts = [];
                 config.mainAccount = bot;
                 config.quoteRpc = [mockServer.url + "/rpc"];
+                config.gasPriceMultiplier = 107;
                 const { reports } = await clear(config, orders, tracer, ctx);
 
                 // should have cleared correct number of orders