chore: Clean up TransactionStatus enum (#454)

* chore: Clean up TransactionStatus enum * fix: dont rely on processedAt * remove debug line * cr feedback * fix build
thirdweb-dev · Mar 29, 2024 · 86305f3 · 86305f3
1 parent caf6a46
commit 86305f3
Show file tree

Hide file tree

Showing 24 changed files with 94 additions and 146 deletions.
diff --git a/src/db/transactions/cleanTxs.ts b/src/db/transactions/cleanTxs.ts
@@ -13,7 +13,6 @@ export const cleanTxs = (
       id: undefined,
       queuedAt: tx.queuedAt.toISOString(),
       sentAt: tx.sentAt?.toISOString() || null,
-      processedAt: tx.processedAt?.toISOString() || null,
       minedAt: tx.minedAt?.toISOString() || null,
       cancelledAt: tx.cancelledAt?.toISOString() || null,
       status: !!tx.errorMessage
@@ -26,8 +25,6 @@ export const cleanTxs = (
         ? "sent"
         : !!tx.sentAt && tx.retryCount > 0
         ? "retried"
-        : !!tx.processedAt
-        ? "processed"
         : "queued",
     };
   });

diff --git a/src/db/transactions/getAllTxs.ts b/src/db/transactions/getAllTxs.ts
@@ -3,7 +3,7 @@ import { Static } from "@sinclair/typebox";
 import { ContractExtension } from "../../schema/extension";
 import { PrismaTransaction } from "../../schema/prisma";
 import {
-  TransactionStatusEnum,
+  TransactionStatus,
   transactionResponseSchema,
 } from "../../server/schemas/transaction";
 import { getPrismaWithPostgresTx } from "../client";
@@ -13,7 +13,7 @@ interface GetAllTxsParams {
   pgtx?: PrismaTransaction;
   page: number;
   limit: number;
-  filter?: TransactionStatusEnum;
+  filter?: TransactionStatus;
   extensions?: ContractExtension[];
 }
 
@@ -40,15 +40,15 @@ export const getAllTxs = async ({
   //   | "errorMessage"
   //   | undefined;
 
-  // if (filter === TransactionStatusEnum.Queued) {
+  // if (filter === TransactionStatus.Queued) {
   //   filterBy = "queuedAt";
-  // } else if (filter === TransactionStatusEnum.Submitted) {
+  // } else if (filter === TransactionStatus.Sent) {
   //   filterBy = "sentAt";
-  // } else if (filter === TransactionStatusEnum.Processed) {
+  // } else if (filter === TransactionStatus.Processed) {
   //   filterBy = "processedAt";
-  // } else if (filter === TransactionStatusEnum.Mined) {
+  // } else if (filter === TransactionStatus.Mined) {
   //   filterBy = "minedAt";
-  // } else if (filter === TransactionStatusEnum.Errored) {
+  // } else if (filter === TransactionStatus.Errored) {
   //   filterBy = "errorMessage";
   // }
 

diff --git a/src/db/transactions/getQueueStatus.ts b/src/db/transactions/getQueueStatus.ts
@@ -10,19 +10,19 @@ export const getQueueStatus = async ({
   const queued = await prisma.transactions.count({
     where: {
       fromAddress: walletAddress?.toLowerCase(),
-      processedAt: null,
+      sentAt: null,
       errorMessage: null,
+      cancelledAt: null,
     },
   });
 
   const pending = await prisma.transactions.count({
     where: {
       fromAddress: walletAddress?.toLowerCase(),
-      sentAt: {
-        not: null,
-      },
+      sentAt: { not: null },
       minedAt: null,
       errorMessage: null,
+      cancelledAt: null,
     },
   });
 

diff --git a/src/db/transactions/getQueuedTxs.ts b/src/db/transactions/getQueuedTxs.ts
@@ -20,8 +20,7 @@ export const getQueuedTxs = async ({ pgtx }: GetQueuedTxsParams = {}): Promise<
   FROM
     "transactions"
   WHERE
-    "processedAt" IS NULL
-    AND "sentAt" IS NULL
+    "sentAt" IS NULL
     AND "minedAt" IS NULL
     AND "cancelledAt" IS NULL
   ORDER BY

diff --git a/src/db/transactions/getSentTxs.ts b/src/db/transactions/getSentTxs.ts
@@ -15,8 +15,7 @@ export const getSentTxs = async ({ pgtx }: GetSentTxsParams = {}): Promise<
 
   return prisma.$queryRaw<Transactions[]>`
     SELECT * FROM "transactions"
-    WHERE "processedAt" IS NOT NULL
-    AND "sentAt" IS NOT NULL
+    WHERE "sentAt" IS NOT NULL
     AND "transactionHash" IS NOT NULL
     AND "accountAddress" IS NULL
     AND "minedAt" IS NULL

diff --git a/src/db/transactions/getSentUserOps.ts b/src/db/transactions/getSentUserOps.ts
@@ -15,8 +15,7 @@ export const getSentUserOps = async ({
 
   return prisma.$queryRaw<Transactions[]>`
     SELECT * FROM "transactions"
-    WHERE "processedAt" IS NOT NULL
-    AND "sentAt" IS NOT NULL
+    WHERE "sentAt" IS NOT NULL
     AND "accountAddress" IS NOT NULL
     AND "userOpHash" IS NOT NULL
     AND "minedAt" IS NULL

diff --git a/src/db/transactions/getTxToRetry.ts b/src/db/transactions/getTxToRetry.ts
@@ -21,8 +21,7 @@ SELECT
 FROM
   "transactions"
 WHERE
-  "processedAt" IS NOT NULL
-  AND "sentAt" IS NOT NULL
+  "sentAt" IS NOT NULL
   AND "accountAddress" IS NULL
   AND "minedAt" IS NULL
   AND "errorMessage" IS NULL

diff --git a/src/db/transactions/queueTxRaw.ts b/src/db/transactions/queueTxRaw.ts
@@ -1,7 +1,7 @@
 import type { Prisma, Transactions } from "@prisma/client";
 import { v4 as uuid } from "uuid";
 import { PrismaTransaction } from "../../schema/prisma";
-import { TransactionStatusEnum } from "../../server/schemas/transaction";
+import { TransactionStatus } from "../../server/schemas/transaction";
 import { simulateTx } from "../../server/utils/simulateTx";
 import { UsageEventTxActionEnum, reportUsage } from "../../utils/usage";
 import { sendWebhooks } from "../../utils/webhook";
@@ -88,7 +88,7 @@ export const queueTxRaw = async ({
   sendWebhooks([
     {
       queueId: txRow.id,
-      status: TransactionStatusEnum.Queued,
+      status: TransactionStatus.Queued,
     },
   ]).catch((err) => {});
 

diff --git a/src/db/transactions/updateTx.ts b/src/db/transactions/updateTx.ts
@@ -1,6 +1,6 @@
 import { BigNumber, ethers } from "ethers";
 import { PrismaTransaction } from "../../schema/prisma";
-import { TransactionStatusEnum } from "../../server/schemas/transaction";
+import { TransactionStatus } from "../../server/schemas/transaction";
 import { getPrismaWithPostgresTx } from "../client";
 
 interface UpdateTxParams {
@@ -11,30 +11,27 @@ interface UpdateTxParams {
 
 type UpdateTxData =
   | {
-      status: TransactionStatusEnum.Cancelled;
+      status: TransactionStatus.Cancelled;
     }
   | {
-      status: TransactionStatusEnum.Processed;
-    }
-  | {
-      status: TransactionStatusEnum.Errored;
+      status: TransactionStatus.Errored;
       errorMessage: string;
     }
   | {
-      status: TransactionStatusEnum.Submitted;
+      status: TransactionStatus.Sent;
       sentAt: Date;
       transactionHash: string;
       res: ethers.providers.TransactionRequest;
       sentAtBlockNumber: number;
       retryCount?: number;
     }
   | {
-      status: TransactionStatusEnum.UserOpSent;
+      status: TransactionStatus.UserOpSent;
       sentAt: Date;
       userOpHash: string;
     }
   | {
-      status: TransactionStatusEnum.Mined;
+      status: TransactionStatus.Mined;
       gasPrice?: string;
       blockNumber?: number;
       minedAt: Date;
@@ -50,7 +47,7 @@ type UpdateTxData =
 export const updateTx = async ({ pgtx, queueId, data }: UpdateTxParams) => {
   const prisma = getPrismaWithPostgresTx(pgtx);
   switch (data.status) {
-    case TransactionStatusEnum.Cancelled:
+    case TransactionStatus.Cancelled:
       await prisma.transactions.update({
         where: {
           id: queueId,
@@ -60,17 +57,7 @@ export const updateTx = async ({ pgtx, queueId, data }: UpdateTxParams) => {
         },
       });
       break;
-    case TransactionStatusEnum.Processed:
-      await prisma.transactions.update({
-        where: {
-          id: queueId,
-        },
-        data: {
-          processedAt: new Date(),
-        },
-      });
-      break;
-    case TransactionStatusEnum.Errored:
+    case TransactionStatus.Errored:
       await prisma.transactions.update({
         where: {
           id: queueId,
@@ -80,7 +67,7 @@ export const updateTx = async ({ pgtx, queueId, data }: UpdateTxParams) => {
         },
       });
       break;
-    case TransactionStatusEnum.Submitted:
+    case TransactionStatus.Sent:
       await prisma.transactions.update({
         where: {
           id: queueId,
@@ -100,7 +87,7 @@ export const updateTx = async ({ pgtx, queueId, data }: UpdateTxParams) => {
         },
       });
       break;
-    case TransactionStatusEnum.UserOpSent:
+    case TransactionStatus.UserOpSent:
       await prisma.transactions.update({
         where: {
           id: queueId,
@@ -111,7 +98,7 @@ export const updateTx = async ({ pgtx, queueId, data }: UpdateTxParams) => {
         },
       });
       break;
-    case TransactionStatusEnum.Mined:
+    case TransactionStatus.Mined:
       await prisma.transactions.update({
         where: {
           id: queueId,

diff --git a/src/prisma/schema.prisma b/src/prisma/schema.prisma
@@ -142,6 +142,7 @@ model Transactions {
   deployedContractType      String?   @map("deployedContractType")
   // Timestamps
   queuedAt                  DateTime  @default(now()) @map("queuedAt")
+  // @deprecated
   processedAt               DateTime? @map("processedAt")
   sentAt                    DateTime? @map("sentAt")
   minedAt                   DateTime? @map("minedAt")

diff --git a/src/schema/webhooks.ts b/src/schema/webhooks.ts
@@ -3,7 +3,6 @@ export enum WebhooksEventTypes {
   SENT_TX = "sent_transaction",
   MINED_TX = "mined_transaction",
   ERRORED_TX = "errored_transaction",
-  RETRIED_TX = "retried_transaction",
   CANCELLED_TX = "cancelled_transaction",
   ALL_TX = "all_transactions",
   BACKEND_WALLET_BALANCE = "backend_wallet_balance",

diff --git a/src/server/routes/transaction/getAll.ts b/src/server/routes/transaction/getAll.ts
@@ -21,7 +21,7 @@ const requestQuerySchema = Type.Object({
     default: "10",
   }),
   // filter: Type.Optional(
-  //   Type.Union([Type.Enum(TransactionStatusEnum), Type.Literal("all")], {
+  //   Type.Union([Type.Enum(TransactionStatus), Type.Literal("all")], {
   //     description:
   //       "This parameter allows to define specific criteria to filter the data by. For example, filtering by processed, submitted or error",
   //     examples: ["all", "submitted", "processed", "errored", "mined", "queued"],
@@ -58,7 +58,6 @@ responseBodySchema.example = {
         transactionHash:
           "0xf11ca950299c9e72b8d6cac8a03623c6e5a43af1d1b0d45b3fd804c129b573f8",
         queuedAt: "2023-09-29T18:17:36.929Z",
-        processedAt: "2023-09-29T18:17:37.011Z",
         sentAt: "2023-09-29T18:17:40.832Z",
         minedAt: "2023-09-29T18:17:44.000Z",
         cancelledAt: null,

diff --git a/src/server/routes/transaction/getAllDeployedContracts.ts b/src/server/routes/transaction/getAllDeployedContracts.ts
@@ -21,7 +21,7 @@ const requestQuerySchema = Type.Object({
     default: "10",
   }),
   // filter: Type.Optional(
-  //   Type.Union([Type.Enum(TransactionStatusEnum), Type.Literal("all")], {
+  //   Type.Union([Type.Enum(TransactionStatus), Type.Literal("all")], {
   //     description:
   //       "This parameter allows to define specific criteria to filter the data by. For example, filtering by processed, submitted or error",
   //     examples: ["all", "submitted", "processed", "errored", "mined", "queued"],

diff --git a/src/server/routes/transaction/syncRetry.ts b/src/server/routes/transaction/syncRetry.ts
@@ -10,7 +10,7 @@ import { parseTxError } from "../../../utils/errors";
 import { UsageEventTxActionEnum, reportUsage } from "../../../utils/usage";
 import { createCustomError } from "../../middleware/error";
 import { standardResponseSchema } from "../../schemas/sharedApiSchemas";
-import { TransactionStatusEnum } from "../../schemas/transaction";
+import { TransactionStatus } from "../../schemas/transaction";
 
 // INPUT
 const requestBodySchema = Type.Object({
@@ -141,7 +141,7 @@ export async function syncRetryTransaction(fastify: FastifyInstance) {
       await updateTx({
         queueId: tx.id,
         data: {
-          status: TransactionStatusEnum.Submitted,
+          status: TransactionStatus.Sent,
           transactionHash,
           res: txRequest,
           sentAt: new Date(),

diff --git a/src/server/routes/webhooks/create.ts b/src/server/routes/webhooks/create.ts
@@ -43,11 +43,6 @@ BodySchema.examples = [
     name: "QueuedTx",
     eventType: WebhooksEventTypes.QUEUED_TX,
   },
-  {
-    url: "https://example.com/retiredTx",
-    name: "RetriedTx",
-    eventType: WebhooksEventTypes.RETRIED_TX,
-  },
   {
     url: "https://example.com/sentTx",
     name: "Sent Transaction Event",

diff --git a/src/server/schemas/transaction/index.ts b/src/server/schemas/transaction/index.ts
@@ -91,12 +91,6 @@ export const transactionResponseSchema = Type.Object({
     }),
     Type.Null(),
   ]),
-  processedAt: Type.Union([
-    Type.String({
-      description: "When the transaction is handled by a worker",
-    }),
-    Type.Null(),
-  ]),
   sentAt: Type.Union([
     Type.String({
       description: "When the transaction is submitted to mempool",
@@ -190,16 +184,19 @@ export const transactionResponseSchema = Type.Object({
   onChainTxStatus: Type.Union([Type.Number(), Type.Null()]),
 });
 
-export enum TransactionStatusEnum {
-  Processed = "processed",
+export enum TransactionStatus {
+  // Tx was received and waiting to be processed.
   Queued = "queued",
-  // TODO: Switch to sent
-  Submitted = "sent",
+  // Tx was submitted to mempool.
+  Sent = "sent",
+  // Tx (userOp for smart account) was submitted to mempool.
   UserOpSent = "user-op-sent",
+  // Tx failed before submitting to mempool.
   Errored = "errored",
+  // Tx was successfully mined onchain. Note: The tx may have "reverted" onchain.
   Mined = "mined",
+  // Tx was cancelled and will not be re-attempted.
   Cancelled = "cancelled",
-  Retried = "retried",
 }
 
 export interface TransactionSchema {