chore: allow querying status by query param

Author: arcoraven

src/server/routes/index.ts

@@ -104,7 +104,10 @@ import { getAllTransactions } from "./transaction/get-all";
 import { getAllDeployedContracts } from "./transaction/get-all-deployed-contracts";
 import { retryTransaction } from "./transaction/retry";
 import { retryFailedTransactionRoute } from "./transaction/retry-failed";
-import { checkTxStatus } from "./transaction/status";
+import {
+  getTransactionStatusQueryParamRoute,
+  getTransactionStatusRoute,
+} from "./transaction/status";
 import { syncRetryTransactionRoute } from "./transaction/sync-retry";
 import { createWebhookRoute } from "./webhooks/create";
 import { getWebhooksEventTypes } from "./webhooks/events";
@@ -239,7 +242,8 @@ export async function withRoutes(fastify: FastifyInstance) {
 
   // Transactions
   await fastify.register(getAllTransactions);
-  await fastify.register(checkTxStatus);
+  await fastify.register(getTransactionStatusRoute);
+  await fastify.register(getTransactionStatusQueryParamRoute);
   await fastify.register(getAllDeployedContracts);
   await fastify.register(retryTransaction);
   await fastify.register(syncRetryTransactionRoute);

src/server/routes/transaction/status.ts

@@ -62,7 +62,7 @@ responseBodySchema.example = {
   },
 };
 
-export async function checkTxStatus(fastify: FastifyInstance) {
+export async function getTransactionStatusRoute(fastify: FastifyInstance) {
   fastify.route<{
     Params: Static<typeof requestSchema>;
     Reply: Static<typeof responseBodySchema>;
@@ -135,3 +135,50 @@ export async function checkTxStatus(fastify: FastifyInstance) {
     },
   });
 }
+
+// An alterate route that accepts the queueId as a query param.
+export async function getTransactionStatusQueryParamRoute(
+  fastify: FastifyInstance,
+) {
+  fastify.route<{
+    Querystring: Static<typeof requestSchema>;
+    Reply: Static<typeof responseBodySchema>;
+  }>({
+    method: "GET",
+    url: "/transaction/status",
+    schema: {
+      summary: "Get transaction status",
+      description: "Get the status for a transaction request.",
+      tags: ["Transaction"],
+      operationId: "status",
+      querystring: requestSchema,
+      response: {
+        ...standardResponseSchema,
+        [StatusCodes.OK]: responseBodySchema,
+      },
+    },
+    handler: async (request, reply) => {
+      const { queueId } = request.query;
+      if (!queueId) {
+        throw createCustomError(
+          "Queue ID is required.",
+          StatusCodes.BAD_REQUEST,
+          "QUEUE_ID_REQUIRED",
+        );
+      }
+
+      const transaction = await TransactionDB.get(queueId);
+      if (!transaction) {
+        throw createCustomError(
+          "Transaction not found.",
+          StatusCodes.BAD_REQUEST,
+          "TRANSACTION_NOT_FOUND",
+        );
+      }
+
+      reply.status(StatusCodes.OK).send({
+        result: toTransactionSchema(transaction),
+      });
+    },
+  });
+}