feat: add category field

.changeset/afraid-cheetahs-sleep.md

@@ -0,0 +1,6 @@
+---
+"@blobscan/api": minor
+"@blobscan/db": minor
+---
+
+Added `category` column to `Transaction` model

packages/api/enums.ts

@@ -1 +1 @@
-export { BlobStorage, Rollup } from "@blobscan/db/prisma/enums";
+export { BlobStorage, Category, Rollup } from "@blobscan/db/prisma/enums";

packages/api/src/middlewares/withExpands.ts

@@ -9,9 +9,11 @@ import { z } from "@blobscan/zod";
 
 import { t } from "../trpc-client";
 import {
+  categorySchema,
   dataStorageReferencesSelect,
   rollupSchema,
   serializeBlobDataStorageReferences,
+  serializeCategory,
   serializeDecimal,
   serializeRollup,
   serializedBlobDataStorageReferenceSchema,
@@ -29,6 +31,7 @@ const expandedTransactionSelect = Prisma.validator<Prisma.TransactionSelect>()({
   toId: true,
   gasPrice: true,
   maxFeePerBlobGas: true,
+  category: true,
   rollup: true,
   index: true,
 });
@@ -118,6 +121,7 @@ export const serializedExpandedTransactionSchema = z
     to: z.string().optional(),
     maxFeePerBlobGas: z.string().optional(),
     blobAsCalldataGasUsed: z.string().optional(),
+    category: categorySchema.optional(),
     rollup: rollupSchema.nullable().optional(),
     index: z.number().nonnegative().optional(),
   })
@@ -228,6 +232,7 @@ export function serializeExpandedTransaction(
     maxFeePerBlobGas,
     fromId,
     toId,
+    category,
     rollup,
     blobAsCalldataGasFee,
     blobGasBaseFee,
@@ -255,6 +260,10 @@ export function serializeExpandedTransaction(
     expandedTransaction.to = toId;
   }
 
+  if (category) {
+    expandedTransaction.category = serializeCategory(category);
+  }
+
   if (rollup) {
     expandedTransaction.rollup = serializeRollup(rollup);
   }

packages/api/src/routers/blob/common/selects.ts

@@ -26,6 +26,7 @@ export function createBlobSelect(expands: Expands) {
         transaction: {
           select: {
             rollup: true,
+            category: true,
             ...(expands.transaction?.select ?? {}),
           },
         },

packages/api/src/routers/blob/common/serializers.ts

@@ -22,6 +22,7 @@ import {
   serializeBlobDataStorageReferences,
   serializeDate,
   isEmptyObject,
+  serializeCategory,
 } from "../../../utils";
 
 type BaseBlob = Pick<

packages/api/src/routers/indexer/indexData.utils.ts

@@ -6,6 +6,7 @@ import type {
   WithoutTimestampFields,
 } from "@blobscan/db";
 import { Prisma } from "@blobscan/db";
+import { Category } from "@blobscan/db/prisma/enums";
 import { env } from "@blobscan/env";
 import { getRollupByAddress } from "@blobscan/rollups";
 
@@ -91,6 +92,7 @@ export function createDBTransactions({
 
       const blobGasPrice = calculateBlobGasPrice(block.excessBlobGas);
       const rollup = getRollupByAddress(from, env.CHAIN_ID);
+      const category = rollup ? Category.ROLLUP : Category.OTHER;
 
       return {
         blockHash: block.hash,
@@ -105,6 +107,7 @@ export function createDBTransactions({
         maxFeePerBlobGas: bigIntToDecimal(maxFeePerBlobGas),
         blobAsCalldataGasUsed: bigIntToDecimal(blobGasAsCalldataUsed),
         rollup,
+        category,
       };
     }
   );

packages/api/src/routers/tx/common/selects.ts

@@ -27,6 +27,7 @@ export const baseTransactionSelect =
     blobAsCalldataGasUsed: true,
     gasPrice: true,
     maxFeePerBlobGas: true,
+    category: true,
     rollup: true,
     blockHash: true,
     blockNumber: true,

packages/api/src/routers/tx/common/serializers.ts

@@ -15,6 +15,8 @@ import {
   serializedDerivedTxBlobGasFieldsSchema,
   calculateDerivedTxBlobGasFields,
   serializeDate,
+  categorySchema,
+  serializeCategory,
 } from "../../../utils";
 import type { FullQueriedTransaction, BaseTransaction } from "./selects";
 
@@ -28,6 +30,7 @@ const baseSerializedTransactionFieldsSchema = z.object({
   to: z.string(),
   maxFeePerBlobGas: z.string(),
   blobAsCalldataGasUsed: z.string(),
+  category: categorySchema,
   rollup: rollupSchema.nullable(),
   blobs: z.array(
     z
@@ -80,6 +83,7 @@ export function serializeBaseTransactionFields(
     index,
     fromId,
     toId,
+    category,
     rollup,
     blobs,
     block,
@@ -96,6 +100,7 @@ export function serializeBaseTransactionFields(
     from: fromId,
     blobAsCalldataGasUsed: serializeDecimal(txQuery.blobAsCalldataGasUsed),
     maxFeePerBlobGas: serializeDecimal(txQuery.maxFeePerBlobGas),
+    category: serializeCategory(category),
     rollup: serializeRollup(rollup),
     blobs: blobs.map(({ blob, blobHash, index }) => {
       return {

packages/api/src/utils/schemas.ts

@@ -1,4 +1,4 @@
-import { BlobStorage, Rollup } from "@blobscan/db/prisma/enums";
+import { BlobStorage, Category, Rollup } from "@blobscan/db/prisma/enums";
 import { z } from "@blobscan/zod";
 
 const zodBlobStorageEnums = [
@@ -29,6 +29,8 @@ const zodRollupEnums = [
   "zora",
 ] as const;
 
+const zodCategoryEnum = ["other", "rollup"] as const;
+
 /**
  * This is a type-safe way to get the enum values as we can't use `Object.values`
  * on zod enums directly
@@ -46,6 +48,13 @@ const missingBlobStorageEnums = Object.values(BlobStorage).filter(
     )
 );
 
+const missingCategoryEnums = Object.values(Category).filter(
+  (r) =>
+    !zodCategoryEnum.includes(
+      r.toLowerCase() as (typeof zodCategoryEnum)[number]
+    )
+);
+
 if (missingRollupEnums.length) {
   throw new Error(
     `Zod rollup enums is not in sync with Prisma rollup enums. Missing zod enums: ${missingRollupEnums.join(
@@ -62,10 +71,20 @@ if (missingBlobStorageEnums.length) {
   );
 }
 
+if (missingCategoryEnums.length) {
+  throw new Error(
+    `Zod category enums is not in sync with Prisma category enums. Missing zod enums: ${missingCategoryEnums.join(
+      ", "
+    )}`
+  );
+}
+
 export type ZodRollupEnum = (typeof zodRollupEnums)[number];
 
 export type ZodBlobStorageEnum = (typeof zodBlobStorageEnums)[number];
 
+export type ZodCategoryEnum = (typeof zodCategoryEnum)[number];
+
 export const blobStorageSchema = z.enum(zodBlobStorageEnums);
 
 // Use string and refine it as TRPC OpenAPI doesn't support enums yet
@@ -76,6 +95,13 @@ export const rollupSchema = z
   })
   .transform((value) => value as ZodRollupEnum);
 
+export const categorySchema = z
+  .string()
+  .refine((value) => {
+    return zodCategoryEnum.includes(value as ZodCategoryEnum);
+  })
+  .transform((value) => value as ZodCategoryEnum);
+
 export const nullableRollupSchema = z
   .string()
   .refine((value) => {

packages/api/src/utils/serializers.ts

@@ -2,12 +2,16 @@ import type {
   Prisma,
   BlobDataStorageReference as DBBlobDataStorageReference,
 } from "@blobscan/db/prisma/client";
-import type { BlobStorage, Rollup } from "@blobscan/db/prisma/enums";
+import type { BlobStorage, Category, Rollup } from "@blobscan/db/prisma/enums";
 import { env } from "@blobscan/env";
 import { z } from "@blobscan/zod";
 
 import { blobStorageSchema } from "./schemas";
-import type { ZodBlobStorageEnum, ZodRollupEnum } from "./schemas";
+import type {
+  ZodBlobStorageEnum,
+  ZodCategoryEnum,
+  ZodRollupEnum,
+} from "./schemas";
 
 export function serializeDecimal(decimal: Prisma.Decimal): string {
   return decimal.toFixed();
@@ -27,6 +31,10 @@ export function serializeBlobStorage(
   return blobStorage.toLowerCase() as ZodBlobStorageEnum;
 }
 
+export function serializeCategory(category: Category): ZodCategoryEnum {
+  return category.toLowerCase() as ZodCategoryEnum;
+}
+
 export function buildBlobDataUrl(
   blobStorage: BlobStorage,
   blobDataUri: string