Merge remote-tracking branch 'origin/main' into ph/txWorkerRedis

Author: arcoraven

.env.example

@@ -6,8 +6,12 @@ THIRDWEB_API_SECRET_KEY="<your-thirdweb-api-secret-key>"
 POSTGRES_CONNECTION_URL="postgresql://postgres:postgres@localhost:5432/postgres?sslmode=disable"
 # The admin wallet that will be able to connect to Engine from the dashboard
 ADMIN_WALLET_ADDRESS="<your-admin-wallet-address>"
+# Encryption password for the wallet keys
+ENCRYPTION_PASSWORD="<your-encryption-password>"
+# The connection url for your running redis instance, defaults to localhost redis
+REDIS_URL="redis://localhost:6379/0"
 
-# =====[ Optional Configuration ]===== 
+# =====[ Optional Configuration ]=====
 
 # Optional configuration to override server host and port
 # PORT="3005"

src/server/middleware/error.ts

@@ -21,7 +21,9 @@ export const createCustomError = (
   code,
 });
 
-const ETHERS_ERROR_CODES = [
+// https://github.com/ethers-io/ethers.js/blob/main/src.ts/utils/errors.ts
+const ETHERS_ERROR_CODES = new Set([
+  // Generic Errors
   "UNKNOWN_ERROR",
   "NOT_IMPLEMENTED",
   "UNSUPPORTED_OPERATION",
@@ -30,21 +32,40 @@ const ETHERS_ERROR_CODES = [
   "TIMEOUT",
   "BAD_DATA",
   "CANCELLED",
+
+  // Operational Errors
   "BUFFER_OVERRUN",
   "NUMERIC_FAULT",
+
+  // Argument Errors
   "INVALID_ARGUMENT",
   "MISSING_ARGUMENT",
   "UNEXPECTED_ARGUMENT",
   "VALUE_MISMATCH",
+
+  // Blockchain Errors
   "CALL_EXCEPTION",
   "INSUFFICIENT_FUNDS",
   "NONCE_EXPIRED",
   "REPLACEMENT_UNDERPRICED",
   "TRANSACTION_REPLACED",
   "UNCONFIGURED_NAME",
   "OFFCHAIN_FAULT",
+
+  // User Interaction
   "ACTION_REJECTED",
-];
+]);
+
+export const createCustomDateTimestampError = (key: string): CustomError => {
+  return createCustomError(
+    `Invalid ${key} Value. Needs to new Date() / new Date().toISOstring() / new Date().getTime() / Unix Epoch`,
+    404,
+    "INVALID_DATE_TIME",
+  );
+};
+
+const flipObject = (data: any) =>
+  Object.fromEntries(Object.entries(data).map(([key, value]) => [value, key]));
 
 const isZodError = (err: unknown): boolean => {
   return Boolean(
@@ -57,21 +78,10 @@ const isEthersError = (error: any): boolean => {
     error &&
     typeof error === "object" &&
     "code" in error &&
-    ETHERS_ERROR_CODES.includes(error.code)
-  );
-};
-
-export const createCustomDateTimestampError = (key: string): CustomError => {
-  return createCustomError(
-    `Invalid ${key} Value. Needs to new Date() / new Date().toISOstring() / new Date().getTime() / Unix Epoch`,
-    404,
-    "INVALID_DATE_TIME",
+    ETHERS_ERROR_CODES.has(error.code)
   );
 };
 
-const flipObject = (data: any) =>
-  Object.fromEntries(Object.entries(data).map(([key, value]) => [value, key]));
-
 export const withErrorHandler = async (server: FastifyInstance) => {
   server.setErrorHandler(
     (error: Error | CustomError | ZodError, request, reply) => {
@@ -87,7 +97,7 @@ export const withErrorHandler = async (server: FastifyInstance) => {
         return reply.status(StatusCodes.BAD_REQUEST).send({
           error: {
             code: "BAD_REQUEST",
-            message: (error as any).code,
+            message: "code" in error ? error.code : error.message,
             reason: error.message,
             statusCode: 400,
             stack: env.NODE_ENV !== "production" ? error.stack : undefined,
@@ -121,7 +131,6 @@ export const withErrorHandler = async (server: FastifyInstance) => {
         });
       }
 
-      // Handle Custom Errors
       if ("statusCode" in error && "code" in error) {
         // Transform unexpected errors into a standard payload
         const statusCode =
@@ -132,25 +141,25 @@ export const withErrorHandler = async (server: FastifyInstance) => {
           StatusCodes.INTERNAL_SERVER_ERROR;
 
         const message = error.message ?? ReasonPhrases.INTERNAL_SERVER_ERROR;
-        return reply.status(statusCode).send({
+        reply.status(statusCode).send({
           error: {
             code,
             message,
             statusCode,
             stack: env.NODE_ENV !== "production" ? error.stack : undefined,
           },
         });
+      } else {
+        // Handle non-custom errors
+        reply.status(StatusCodes.INTERNAL_SERVER_ERROR).send({
+          error: {
+            statusCode: 500,
+            code: "INTERNAL_SERVER_ERROR",
+            message: error.message || ReasonPhrases.INTERNAL_SERVER_ERROR,
+            stack: env.NODE_ENV !== "production" ? error.stack : undefined,
+          },
+        });
       }
-
-      // Handle non-custom errors
-      return reply.status(StatusCodes.INTERNAL_SERVER_ERROR).send({
-        error: {
-          statusCode: 500,
-          code: "INTERNAL_SERVER_ERROR",
-          message: error.message || ReasonPhrases.INTERNAL_SERVER_ERROR,
-          stack: env.NODE_ENV !== "production" ? error.stack : undefined,
-        },
-      });
     },
   );
 };

src/server/routes/contract/extensions/erc721/read/signaturePrepare.ts

@@ -35,7 +35,7 @@ import { checkAndReturnNFTSignaturePayload } from "../../../../../utils/validato
 
 // INPUTS
 const requestSchema = erc721ContractParamSchema;
-const requestBodySchema = Type.Omit(signature721InputSchema, ["uid"]);
+const requestBodySchema = signature721InputSchema;
 
 // OUTPUT
 const responseSchema = Type.Object({
@@ -213,6 +213,7 @@ export async function erc721SignaturePrepare(fastify: FastifyInstance) {
         quantity,
         royaltyBps,
         royaltyRecipient,
+        uid,
       } = request.body;
 
       const chainId = await getChainIdFromChain(chain);
@@ -245,7 +246,7 @@ export async function erc721SignaturePrepare(fastify: FastifyInstance) {
       const parsed = await Signature721WithQuantityInput.parseAsync(payload);
       const mintPayload = {
         ...parsed,
-        uid: generateUid(),
+        uid: uid ?? generateUid(),
         uri,
         royaltyBps: BigNumber.from(parsed.royaltyBps),
       };

src/server/schemas/nft/index.ts

@@ -4,25 +4,63 @@ import { BigNumber } from "ethers";
 // NFTInput format compatible with v5 SDK
 export const nftInputSchema = Type.Partial(
   Type.Object({
-    name: Type.String(),
-    description: Type.String(),
-    image: Type.String(),
-    animation_url: Type.String(),
-    external_url: Type.String(),
-    background_color: Type.String(),
-    properties: Type.Any(),
+    name: Type.String({
+      description: "The name of the NFT",
+    }),
+    description: Type.String({
+      description: "The description of the NFT",
+    }),
+    image: Type.String({
+      description: "The image of the NFT",
+    }),
+    animation_url: Type.String({
+      description: "The animation url of the NFT",
+    }),
+    external_url: Type.String({
+      description: "The external url of the NFT",
+    }),
+    background_color: Type.String({
+      description: "The background color of the NFT",
+    }),
+    properties: Type.Any({
+      description: "The properties of the NFT",
+    }),
   }),
 );
 
 export const nftMetadataInputSchema = Type.Object({
-  name: Type.Optional(Type.Union([Type.String(), Type.Number(), Type.Null()])),
-  description: Type.Optional(Type.Union([Type.String(), Type.Null()])),
-  image: Type.Optional(Type.Union([Type.String(), Type.Null()])),
-  external_url: Type.Optional(Type.Union([Type.String(), Type.Null()])),
-  animation_url: Type.Optional(Type.Union([Type.String(), Type.Null()])),
-  properties: Type.Optional(Type.Any()),
-  attributes: Type.Optional(Type.Any()),
-  background_color: Type.Optional(Type.Union([Type.String(), Type.Null()])),
+  name: Type.Optional({
+    description: "The name of the NFT",
+    ...Type.Union([Type.String(), Type.Number(), Type.Null()]),
+  }),
+  description: Type.Optional({
+    description: "The description of the NFT",
+    ...Type.Union([Type.String(), Type.Null()]),
+  }),
+  image: Type.Optional({
+    ...Type.Union([Type.String(), Type.Null()]),
+    description: "The image of the NFT",
+  }),
+  external_url: Type.Optional({
+    ...Type.Union([Type.String(), Type.Null()]),
+    description: "The external url of the NFT",
+  }),
+  animation_url: Type.Optional({
+    ...Type.Union([Type.String(), Type.Null()]),
+    description: "The animation url of the NFT",
+  }),
+  properties: Type.Optional({
+    ...Type.Any(),
+    description: "The properties of the NFT",
+  }),
+  attributes: Type.Optional({
+    ...Type.Any(),
+    description: "The attributes of the NFT",
+  }),
+  background_color: Type.Optional({
+    ...Type.Union([Type.String(), Type.Null()]),
+    description: "The background color of the NFT",
+  }),
 });
 
 export const nftMetadataSchema = Type.Object(

src/utils/env.ts

@@ -61,7 +61,13 @@ export const env = createEnv({
     ENABLE_HTTPS: boolSchema("false"),
     HTTPS_PASSPHRASE: z.string().default("thirdweb-engine"),
     TRUST_PROXY: z.boolean().default(false),
-    PRUNE_TRANSACTIONS: boolSchema("true"),
+    PRUNE_TRANSACTIONS: z
+      .union([
+        z.literal("true").transform(() => 7),
+        z.literal("false").transform(() => 0),
+        z.coerce.number().int(),
+      ])
+      .default(7),
     CLIENT_ANALYTICS_URL: z
       .union([UrlSchema, z.literal("")])
       .default("https://c.thirdweb.com/event"),