Fix tx overrides (#130)

* Add util to remove invalid values

* Add test

* lint files

* Fix linting

Author: WyattMufson

.gitignore

@@ -232,8 +232,8 @@ crash.log
 crash.*.log
 
 # Exclude all .tfvars files, which are likely to contain sensitive data, such as
-# password, private keys, and other secrets. These should not be part of version 
-# control as they are data points which are potentially sensitive and subject 
+# password, private keys, and other secrets. These should not be part of version
+# control as they are data points which are potentially sensitive and subject
 # to change depending on the environment.
 *.tfvars
 *.tfvars.json
@@ -257,4 +257,7 @@ terraform.rc
 
 # Ignore CLI configuration files
 .vscode
-*storybook.log
+*storybook.log
+
+# IntelliJ
+.idea

apps/api/src/routes/transactions.ts

@@ -27,6 +27,7 @@ import {
   normalizeEngineErrorMessage,
   parseEngineErrorMessage,
 } from "../utils/error";
+import { parseTxOverrides } from "../utils/transaction";
 
 export const transactionsRoutes =
   ({ db, engine, env }: TdkApiContext): FastifyPluginAsync =>
@@ -106,6 +107,8 @@ export const transactionsRoutes =
             ),
           );
 
+          const parsedTxOverrides = parseTxOverrides(txOverrides);
+
           const { result } = await engine.contract.write(
             chain.id.toString(),
             address,
@@ -114,7 +117,7 @@ export const transactionsRoutes =
               abi: transactionAbi,
               functionName,
               args,
-              txOverrides,
+              txOverrides: parsedTxOverrides,
             },
             simulateTransaction,
             undefined,
@@ -174,6 +177,8 @@ export const transactionsRoutes =
           });
         }
 
+        const parsedTxOverrides = parseTxOverrides(txOverrides);
+
         try {
           Sentry.setExtra("transaction", { to, value, data });
           const { result } = await engine.backendWallet.sendTransaction(
@@ -183,7 +188,7 @@ export const transactionsRoutes =
               toAddress: to,
               value: value,
               data,
-              txOverrides,
+              txOverrides: parsedTxOverrides,
             },
             simulateTransaction,
             undefined,

apps/api/src/utils/transaction.test.ts

@@ -0,0 +1,82 @@
+import { describe, expect, it } from "vitest";
+import { parseTxOverrides } from "./transaction";
+
+describe("transaction utils", () => {
+  it("should parse tx overrides", () => {
+    expect(parseTxOverrides()).toBeUndefined();
+
+    expect(parseTxOverrides({})).toBeUndefined();
+
+    expect(parseTxOverrides({ gas: "10000000000" })).toStrictEqual({
+      gas: "10000000000",
+      maxFeePerGas: undefined,
+      maxPriorityFeePerGas: undefined,
+      value: undefined,
+    });
+
+    expect(parseTxOverrides({ maxFeePerGas: "10000000000" })).toStrictEqual({
+      gas: undefined,
+      maxFeePerGas: "10000000000",
+      maxPriorityFeePerGas: undefined,
+      value: undefined,
+    });
+
+    expect(
+      parseTxOverrides({ maxPriorityFeePerGas: "10000000000" }),
+    ).toStrictEqual({
+      gas: undefined,
+      maxFeePerGas: undefined,
+      maxPriorityFeePerGas: "10000000000",
+      value: undefined,
+    });
+
+    expect(parseTxOverrides({ value: "10000000000" })).toStrictEqual({
+      gas: undefined,
+      maxFeePerGas: undefined,
+      maxPriorityFeePerGas: undefined,
+      value: "10000000000",
+    });
+
+    expect(
+      parseTxOverrides({
+        gas: "10000000000",
+        maxFeePerGas: "10000000000",
+        maxPriorityFeePerGas: "10000000000",
+        value: "10000000000",
+      }),
+    ).toStrictEqual({
+      gas: "10000000000",
+      maxFeePerGas: "10000000000",
+      maxPriorityFeePerGas: "10000000000",
+      value: "10000000000",
+    });
+
+    expect(
+      parseTxOverrides({
+        gas: "",
+        maxFeePerGas: "10000000000",
+        maxPriorityFeePerGas: "10000000000",
+        value: "10000000000",
+      }),
+    ).toStrictEqual({
+      gas: undefined,
+      maxFeePerGas: "10000000000",
+      maxPriorityFeePerGas: "10000000000",
+      value: "10000000000",
+    });
+
+    expect(
+      parseTxOverrides({
+        gas: null as unknown as string,
+        maxFeePerGas: "10000000000",
+        maxPriorityFeePerGas: null as unknown as string,
+        value: "10000000000",
+      }),
+    ).toStrictEqual({
+      gas: undefined,
+      maxFeePerGas: "10000000000",
+      maxPriorityFeePerGas: undefined,
+      value: "10000000000",
+    });
+  });
+});

apps/api/src/utils/transaction.ts

@@ -9,6 +9,28 @@ import type {
 
 import type { TransactionArguments, TransactionOverrides } from "../schema";
 
+export const parseTxOverrides = (
+  txOverrides?: TransactionOverrides,
+): TransactionOverrides | undefined => {
+  const gas = txOverrides?.gas ? txOverrides.gas : undefined;
+  const maxFeePerGas = txOverrides?.maxFeePerGas
+    ? txOverrides.maxFeePerGas
+    : undefined;
+  const maxPriorityFeePerGas = txOverrides?.maxPriorityFeePerGas
+    ? txOverrides.maxPriorityFeePerGas
+    : undefined;
+  const value = txOverrides?.value ? txOverrides.value : undefined;
+  if (gas || maxFeePerGas || maxPriorityFeePerGas || value) {
+    return {
+      gas,
+      maxFeePerGas,
+      maxPriorityFeePerGas,
+      value,
+    };
+  }
+  return undefined;
+};
+
 export const writeTransaction = async <
   TAbi extends Abi,
   TFunctionName extends ExtractAbiFunctionNames<
@@ -64,6 +86,9 @@ export const writeTransaction = async <
       2,
     ),
   );
+
+  const parsedTxOverrides = parseTxOverrides(txOverrides);
+
   const { result } = await engine.contract.write(
     chainId.toString(),
     contractAddress,
@@ -74,7 +99,7 @@ export const writeTransaction = async <
       functionName,
       // @ts-ignore: stronger type-checking than Engine
       args,
-      txOverrides,
+      txOverrides: parsedTxOverrides,
     },
     simulateTransaction,
     idempotencyKey,