Addressed review comments

d4mr · d4mr · commit b60a8bb3877c · 2025-02-07T19:50:49.000+05:30
diff --git a/src/prisma/migrations/20250207135644_nullable_is_default/migration.sql b/src/prisma/migrations/20250207135644_nullable_is_default/migration.sql
@@ -0,0 +1,2 @@
+-- AlterTable
+ALTER TABLE "wallet_credentials" ALTER COLUMN "isDefault" DROP NOT NULL;
diff --git a/src/prisma/schema.prisma b/src/prisma/schema.prisma
@@ -120,15 +120,15 @@ model WalletDetails {
 }
 
 model WalletCredentials {
-  id        String  @id @default(uuid()) @map("id")
-  type      String  @map("type")
-  label     String  @map("label")
-  data      Json    @map("data")
-  isDefault Boolean @default(false) @map("isDefault")
-
-  createdAt DateTime  @default(now()) @map("createdAt")
-  updatedAt DateTime  @updatedAt @map("updatedAt")
-  deletedAt DateTime? @map("deletedAt")
+  id        String   @id @default(uuid())
+  type      String
+  label     String
+  data      Json
+  isDefault Boolean? @default(false)
+
+  createdAt DateTime  @default(now())
+  updatedAt DateTime  @updatedAt
+  deletedAt DateTime?
 
   wallets WalletDetails[]
 
diff --git a/src/server/routes/backend-wallet/create.ts b/src/server/routes/backend-wallet/create.ts
@@ -33,6 +33,7 @@ import {
   CircleWalletError,
   createCircleWalletDetails,
 } from "../../utils/wallets/circle";
+import assert from "node:assert";
 
 const requestBodySchema = Type.Union([
   // Base schema for non-circle wallet types
@@ -87,7 +88,7 @@ export const createBackendWallet = async (fastify: FastifyInstance) => {
     handler: async (req, reply) => {
       const { label } = req.body;
 
-      let walletAddress: string | undefined = undefined;
+      let walletAddress: string;
       const config = await getConfig();
 
       const walletType =
@@ -129,9 +130,7 @@ export const createBackendWallet = async (fastify: FastifyInstance) => {
         case CircleWalletType.circle:
           {
             // we need this if here for typescript to statically type the credentialId and walletSetId
-            if (req.body.type !== "circle")
-              throw new Error("Invalid Circle wallet type"); // invariant
-
+            assert(req.body.type === "circle", "Expected circle wallet type");
             const { credentialId, walletSetId } = req.body;
 
             try {
@@ -159,9 +158,7 @@ export const createBackendWallet = async (fastify: FastifyInstance) => {
         case CircleWalletType.smartCircle:
           {
             // we need this if here for typescript to statically type the credentialId and walletSetId
-            if (req.body.type !== "smart:circle")
-              throw new Error("Invalid Circle wallet type"); // invariant
-
+            assert(req.body.type === "circle", "Expected circle wallet type");
             const { credentialId, walletSetId } = req.body;
 
             try {
@@ -235,10 +232,12 @@ export const createBackendWallet = async (fastify: FastifyInstance) => {
             walletAddress = getAddress(smartLocalWallet.address);
           }
           break;
-      }
-
-      if (!walletAddress) {
-        throw new Error("Invalid state"); // invariant, typescript cannot exhaustive check because enums
+        default:
+          throw createCustomError(
+            "Unkown wallet type",
+            StatusCodes.BAD_REQUEST,
+            "CREATE_WALLET_ERROR",
+          );
       }
 
       reply.status(StatusCodes.OK).send({
diff --git a/src/server/routes/configuration/wallets/update.ts b/src/server/routes/configuration/wallets/update.ts
@@ -21,11 +21,6 @@ const requestBodySchema = Type.Union([
     gcpApplicationCredentialEmail: Type.String(),
     gcpApplicationCredentialPrivateKey: Type.String(),
   }),
-  Type.Object({
-    awsAccessKeyId: Type.String(),
-    awsSecretAccessKey: Type.String(),
-    awsRegion: Type.String(),
-  }),
   Type.Object({
     circleApiKey: Type.String(),
   }),
diff --git a/src/server/routes/wallet-credentials/create.ts b/src/server/routes/wallet-credentials/create.ts
@@ -30,7 +30,7 @@ const responseSchema = Type.Object({
     id: Type.String(),
     type: Type.String(),
     label: Type.String(),
-    isDefault: Type.Boolean(),
+    isDefault: Type.Union([Type.Boolean(), Type.Null()]),
     createdAt: Type.String(),
     updatedAt: Type.String(),
   }),
@@ -47,9 +47,7 @@ responseSchema.example = {
   },
 };
 
-export const createWalletCredentialRoute = async (
-  fastify: FastifyInstance,
-) => {
+export const createWalletCredentialRoute = async (fastify: FastifyInstance) => {
   fastify.withTypeProvider().route<{
     Body: Static<typeof requestBodySchema>;
     Reply: Static<typeof responseSchema>;
diff --git a/src/server/routes/wallet-credentials/get-all.ts b/src/server/routes/wallet-credentials/get-all.ts
@@ -3,32 +3,19 @@ import type { FastifyInstance } from "fastify";
 import { StatusCodes } from "http-status-codes";
 import { getAllWalletCredentials } from "../../../shared/db/wallet-credentials/get-all-wallet-credentials";
 import { standardResponseSchema } from "../../schemas/shared-api-schemas";
+import { PaginationSchema } from "../../schemas/pagination";
 
-const QuerySchema = Type.Object({
-  page: Type.Integer({
-    description: "The page of credentials to get.",
-    examples: ["1"],
-    default: "1",
-    minimum: 1,
-  }),
-  limit: Type.Integer({
-    description: "The number of credentials to get per page.",
-    examples: ["10"],
-    default: "10",
-    minimum: 1,
-  }),
-});
+const QuerySchema = PaginationSchema;
 
 const responseSchema = Type.Object({
   result: Type.Array(
     Type.Object({
       id: Type.String(),
       type: Type.String(),
       label: Type.Union([Type.String(), Type.Null()]),
-      isDefault: Type.Boolean(),
+      isDefault: Type.Union([Type.Boolean(), Type.Null()]),
       createdAt: Type.String(),
       updatedAt: Type.String(),
-      deletedAt: Type.Union([Type.String(), Type.Null()]),
     }),
   ),
 });
@@ -76,9 +63,8 @@ export async function getAllWalletCredentialsRoute(fastify: FastifyInstance) {
           ...cred,
           createdAt: cred.createdAt.toISOString(),
           updatedAt: cred.updatedAt.toISOString(),
-          deletedAt: cred.deletedAt?.toISOString() || null,
         })),
       });
     },
   });
-} 
+}
diff --git a/src/server/utils/wallets/circle/index.ts b/src/server/utils/wallets/circle/index.ts
@@ -26,6 +26,7 @@ import {
   DEFAULT_ACCOUNT_FACTORY_V0_7,
   ENTRYPOINT_ADDRESS_v0_7,
 } from "thirdweb/wallets/smart";
+import { stringify } from "thirdweb/utils";
 
 export class CircleWalletError extends Error {
   constructor(message: string) {
@@ -64,13 +65,12 @@ export async function provisionCircleWallet({
       });
 
     walletSetId = walletSet.data?.walletSet.id;
+    if (!walletSetId)
+      throw new CircleWalletError(
+        "Did not receive walletSetId, and failed to create one automatically",
+      );
   }
 
-  if (!walletSetId)
-    throw new CircleWalletError(
-      "Did not receive walletSetId, and failed to create one automatically",
-    );
-
   const provisionWalletResponse = await circleDeveloperSdk
     .createWallets({
       accountType: "EOA",
@@ -153,15 +153,6 @@ export async function getCircleAccount({
   const wallet = walletResponse.data?.wallet;
   const address = wallet?.address as Address;
 
-  function stringify(data: unknown) {
-    return JSON.stringify(data, (_, value) => {
-      if (typeof value === "bigint") {
-        return value.toString();
-      }
-      return value;
-    });
-  }
-
   async function signTransaction(tx: SerializableTransaction) {
     const signature = await circleDeveloperSdk
       .signTransaction({
diff --git a/src/shared/db/wallet-credentials/create-wallet-credential.ts b/src/shared/db/wallet-credentials/create-wallet-credential.ts
@@ -1,14 +1,10 @@
-import { z } from "zod";
 import { encrypt } from "../../utils/crypto";
 import { registerEntitySecretCiphertext } from "@circle-fin/developer-controlled-wallets";
 import { prisma } from "../client";
 import { getConfig } from "../../utils/cache/get-config";
 import { WalletCredentialsError } from "./get-wallet-credential";
 import { randomBytes } from "node:crypto";
-
-export const entitySecretSchema = z.string().regex(/^[0-9a-fA-F]{64}$/, {
-  message: "entitySecret must be a 32-byte hex string",
-});
+import { cirlceEntitySecretZodSchema } from "../../schemas/wallet";
 
 // will be expanded to be a discriminated union of all supported wallet types
 export type CreateWalletCredentialsParams = {
@@ -24,55 +20,60 @@ export const createWalletCredential = async ({
   entitySecret,
   isDefault,
 }: CreateWalletCredentialsParams) => {
-  // not handling other wallet types because we only support circle for now
   const { walletConfiguration } = await getConfig();
-  const circleApiKey = walletConfiguration.circle?.apiKey;
 
-  if (!circleApiKey) {
-    throw new WalletCredentialsError("No Circle API Key Configured");
-  }
+  switch (type) {
+    case "circle": {
+      const circleApiKey = walletConfiguration.circle?.apiKey;
 
-  if (entitySecret) {
-    const { error } = entitySecretSchema.safeParse(entitySecret);
-    if (error) {
-      throw new WalletCredentialsError(
-        "Invalid provided entity secret for Circle",
-      );
-    }
-  }
+      if (!circleApiKey) {
+        throw new WalletCredentialsError("No Circle API Key Configured");
+      }
 
-  // If entitySecret is not provided, generate a random one
-  const finalEntitySecret = entitySecret ?? randomBytes(32).toString("hex");
-  // Create the wallet credentials
-  const walletCredentials = await prisma.walletCredentials.create({
-    data: {
-      type,
-      label,
-      isDefault: isDefault ?? false,
-      data: {
-        entitySecret: encrypt(finalEntitySecret),
-      },
-    },
-  });
+      if (entitySecret) {
+        const { error } = cirlceEntitySecretZodSchema.safeParse(entitySecret);
+        if (error) {
+          throw new WalletCredentialsError(
+            "Invalid provided entity secret for Circle",
+          );
+        }
+      }
 
-  // try registering the entity secret. See: https://developers.circle.com/w3s/developer-controlled-create-your-first-wallet
-  try {
-    await registerEntitySecretCiphertext({
-      apiKey: circleApiKey,
-      entitySecret: finalEntitySecret,
-    });
-  } catch (e: unknown) {
-    // If failed to registeer, permanently delete erroneously created credential
-    await prisma.walletCredentials.delete({
-      where: {
-        id: walletCredentials.id,
-      },
-    });
+      // If entitySecret is not provided, generate a random one
+      const finalEntitySecret = entitySecret ?? randomBytes(32).toString("hex");
+      // Create the wallet credentials
+      const walletCredentials = await prisma.walletCredentials.create({
+        data: {
+          type,
+          label,
+          isDefault: isDefault ?? false,
+          data: {
+            entitySecret: encrypt(finalEntitySecret),
+          },
+        },
+      });
 
-    throw new WalletCredentialsError(
-      `Could not register Entity Secret with Circle\n${JSON.stringify(e)}`,
-    );
-  }
+      // try registering the entity secret. See: https://developers.circle.com/w3s/developer-controlled-create-your-first-wallet
+      try {
+        await registerEntitySecretCiphertext({
+          apiKey: circleApiKey,
+          entitySecret: finalEntitySecret,
+          recoveryFileDownloadPath: "/dev/null",
+        });
+      } catch (e: unknown) {
+        // If failed to registeer, permanently delete erroneously created credential
+        await prisma.walletCredentials.delete({
+          where: {
+            id: walletCredentials.id,
+          },
+        });
+
+        throw new WalletCredentialsError(
+          `Could not register Entity Secret with Circle\n${JSON.stringify(e)}`,
+        );
+      }
 
-  return walletCredentials;
+      return walletCredentials;
+    }
+  }
 };
diff --git a/src/shared/db/wallet-credentials/get-all-wallet-credentials.ts b/src/shared/db/wallet-credentials/get-all-wallet-credentials.ts
@@ -8,7 +8,6 @@ interface GetAllWalletCredentialsParams {
 }
 
 export const getAllWalletCredentials = async ({
-  pgtx,
   page = 1,
   limit = 10,
 }: GetAllWalletCredentialsParams) => {
@@ -27,7 +26,6 @@ export const getAllWalletCredentials = async ({
       isDefault: true,
       createdAt: true,
       updatedAt: true,
-      deletedAt: true,
     },
     orderBy: {
       createdAt: "desc",
diff --git a/src/shared/db/wallets/get-wallet-details.ts b/src/shared/db/wallets/get-wallet-details.ts
@@ -58,7 +58,6 @@ const smartLocalWalletSchema = localWalletSchema
     type: z.literal("smart:local"),
   })
   .merge(smartWalletPartialSchema)
-  .merge(baseWalletPartialSchema);
 
 const awsKmsWalletSchema = z
   .object({
@@ -74,7 +73,6 @@ const smartAwsKmsWalletSchema = awsKmsWalletSchema
     type: z.literal("smart:aws-kms"),
   })
   .merge(smartWalletPartialSchema)
-  .merge(baseWalletPartialSchema);
 
 const gcpKmsWalletSchema = z
   .object({
@@ -90,7 +88,6 @@ const smartGcpKmsWalletSchema = gcpKmsWalletSchema
     type: z.literal("smart:gcp-kms"),
   })
   .merge(smartWalletPartialSchema)
-  .merge(baseWalletPartialSchema);
 
 const circleWalletSchema = z
   .object({
@@ -108,7 +105,6 @@ const smartCircleWalletSchema = circleWalletSchema
     type: z.literal("smart:circle"),
   })
   .merge(smartWalletPartialSchema)
-  .merge(baseWalletPartialSchema);
 
 const walletDetailsSchema = z.discriminatedUnion("type", [
   localWalletSchema,
@@ -124,7 +120,8 @@ const walletDetailsSchema = z.discriminatedUnion("type", [
 export type SmartBackendWalletDetails =
   | z.infer<typeof smartLocalWalletSchema>
   | z.infer<typeof smartAwsKmsWalletSchema>
-  | z.infer<typeof smartGcpKmsWalletSchema>;
+  | z.infer<typeof smartGcpKmsWalletSchema>
+  | z.infer<typeof smartCircleWalletSchema>;
 
 export function isSmartBackendWallet(
   wallet: ParsedWalletDetails,
diff --git a/src/shared/schemas/wallet.ts b/src/shared/schemas/wallet.ts

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+-- AlterTable`
	`2`	`+ALTER TABLE "wallet_credentials" ALTER COLUMN "isDefault" DROP NOT NULL;`