chore: consolidate chain queries, 4xx if not found (#673)

* chore: consolidate chain queries, 4xx if not found

* fix formatter

* fix lint

* update getters

* type the override getters

* clean up error message

* use StatusCodes helper

Author: arcoraven

src/db/configuration/updateConfiguration.ts

@@ -1,4 +1,4 @@
-import { Prisma } from "@prisma/client";
+import type { Prisma } from "@prisma/client";
 import { encrypt } from "../../utils/crypto";
 import { prisma } from "../client";
 

src/server/middleware/error.ts

@@ -1,4 +1,4 @@
-import { FastifyInstance } from "fastify";
+import type { FastifyInstance } from "fastify";
 import { ReasonPhrases, StatusCodes } from "http-status-codes";
 import { ZodError } from "zod";
 import { env } from "../../utils/env";
@@ -22,21 +22,27 @@ export const createCustomError = (
   code,
 });
 
-export const createCustomDateTimestampError = (key: string): CustomError => {
+export const customDateTimestampError = (date: string): CustomError => {
   return createCustomError(
-    `Invalid ${key} Value. Needs to new Date() / new Date().toISOstring() / new Date().getTime() / Unix Epoch`,
-    404,
+    `Invalid date: ${date}. Needs to new Date() / new Date().toISOstring() / new Date().getTime() / Unix Epoch`,
+    StatusCodes.BAD_REQUEST,
     "INVALID_DATE_TIME",
   );
 };
 
-export const createBadAddressError = (key: string): CustomError => {
-  return createCustomError(
-    `Invalid ${key} Value. Needs to be a valid EVM address`,
-    422,
+export const badAddressError = (address: string): CustomError =>
+  createCustomError(
+    `Invalid address: ${address}. Needs to be a valid EVM address`,
+    StatusCodes.BAD_REQUEST,
     "INVALID_ADDRESS",
   );
-};
+
+export const badChainError = (chain: string | number): CustomError =>
+  createCustomError(
+    `Invalid chain: ${chain}. If this is a custom chain, add it to chain overrides.`,
+    StatusCodes.BAD_REQUEST,
+    "INVALID_CHAIN",
+  );
 
 const flipObject = (data: any) =>
   Object.fromEntries(Object.entries(data).map(([key, value]) => [value, key]));

src/server/routes/auth/access-tokens/create.ts

@@ -91,7 +91,7 @@ export async function createAccessToken(fastify: FastifyInstance) {
 
       accessTokenCache.clear();
 
-      res.status(200).send({
+      res.status(StatusCodes.OK).send({
         result: {
           ...token,
           createdAt: token.createdAt.toISOString(),

src/server/routes/auth/access-tokens/getAll.ts

@@ -36,7 +36,7 @@ export async function getAllAccessTokens(fastify: FastifyInstance) {
     },
     handler: async (req, res) => {
       const accessTokens = await getAccessTokens();
-      res.status(200).send({
+      res.status(StatusCodes.OK).send({
         result: accessTokens.map((token) => ({
           ...token,
           createdAt: token.createdAt.toISOString(),

src/server/routes/auth/access-tokens/revoke.ts

@@ -38,7 +38,7 @@ export async function revokeAccessToken(fastify: FastifyInstance) {
 
       accessTokenCache.clear();
 
-      res.status(200).send({
+      res.status(StatusCodes.OK).send({
         result: {
           success: true,
         },

src/server/routes/auth/access-tokens/update.ts

@@ -40,7 +40,7 @@ export async function updateAccessToken(fastify: FastifyInstance) {
 
       accessTokenCache.clear();
 
-      res.status(200).send({
+      res.status(StatusCodes.OK).send({
         result: {
           success: true,
         },

src/server/routes/auth/keypair/add.ts

@@ -77,7 +77,7 @@ export async function addKeypair(fastify: FastifyInstance) {
         throw e;
       }
 
-      res.status(200).send({
+      res.status(StatusCodes.OK).send({
         result: {
           keypair: toKeypairSchema(keypair),
         },

src/server/routes/auth/keypair/list.ts

@@ -28,7 +28,7 @@ export async function listPublicKeys(fastify: FastifyInstance) {
     handler: async (req, res) => {
       const keypairs = await listKeypairs();
 
-      res.status(200).send({
+      res.status(StatusCodes.OK).send({
         result: keypairs.map(toKeypairSchema),
       });
     },

src/server/routes/auth/keypair/remove.ts

@@ -39,7 +39,7 @@ export async function removePublicKey(fastify: FastifyInstance) {
       await deleteKeypair({ hash });
       keypairCache.clear();
 
-      res.status(200).send({
+      res.status(StatusCodes.OK).send({
         result: { success: true },
       });
     },

src/server/routes/auth/permissions/getAll.ts

@@ -33,7 +33,7 @@ export async function getAllPermissions(fastify: FastifyInstance) {
     },
     handler: async (req, res) => {
       const permissions = await prisma.permissions.findMany();
-      res.status(200).send({
+      res.status(StatusCodes.OK).send({
         result: permissions,
       });
     },

src/server/routes/auth/permissions/grant.ts

@@ -43,7 +43,7 @@ export async function grantPermissions(fastify: FastifyInstance) {
         permissions,
         label,
       });
-      res.status(200).send({
+      res.status(StatusCodes.OK).send({
         result: {
           success: true,
         },

src/server/routes/auth/permissions/revoke.ts

@@ -38,7 +38,7 @@ export async function revokePermissions(fastify: FastifyInstance) {
       await deletePermissions({
         walletAddress,
       });
-      res.status(200).send({
+      res.status(StatusCodes.OK).send({
         result: {
           success: true,
         },

src/server/routes/backend-wallet/signMessage.ts

@@ -55,7 +55,7 @@ export async function signMessage(fastify: FastifyInstance) {
         signedMessage = await signer.signMessage(message);
       }
 
-      reply.status(200).send({
+      reply.status(StatusCodes.OK).send({
         result: signedMessage,
       });
     },

src/server/routes/backend-wallet/signTransaction.ts

@@ -60,7 +60,7 @@ export async function signTransaction(fastify: FastifyInstance) {
       const signer = await wallet.getSigner();
       const signedMessage = await signer.signTransaction(transaction);
 
-      reply.status(200).send({
+      reply.status(StatusCodes.OK).send({
         result: signedMessage,
       });
     },

src/server/routes/backend-wallet/signTypedData.ts

@@ -45,7 +45,7 @@ export async function signTypedData(fastify: FastifyInstance) {
       const signer = (await wallet.getSigner()) as unknown as TypedDataSigner;
       const result = await signer._signTypedData(domain, types, value);
 
-      reply.status(200).send({
+      reply.status(StatusCodes.OK).send({
         result: result,
       });
     },

src/server/routes/chain/get.ts

@@ -1,19 +1,14 @@
-import { Static, Type } from "@sinclair/typebox";
-import {
-  Chain,
-  getChainByChainIdAsync,
-  getChainBySlugAsync,
-  minimizeChain,
-} from "@thirdweb-dev/chains";
-import { FastifyInstance } from "fastify";
+import { Type, type Static } from "@sinclair/typebox";
+import type { FastifyInstance } from "fastify";
 import { StatusCodes } from "http-status-codes";
-import { getConfig } from "../../../utils/cache/getConfig";
-import { createCustomError } from "../../middleware/error";
+import { getChainMetadata } from "thirdweb/chains";
+import { getChain } from "../../../utils/chain";
 import {
   chainRequestQuerystringSchema,
   chainResponseSchema,
 } from "../../schemas/chain";
 import { standardResponseSchema } from "../../schemas/sharedApiSchemas";
+import { getChainIdFromChain } from "../../utils/chain";
 
 // OUTPUT
 const responseSchema = Type.Object({
@@ -31,7 +26,7 @@ responseSchema.examples = [
         symbol: "MATIC",
         decimals: 18,
       },
-      shortName: "polygonamoy",
+      shortName: "amoy",
       chainId: 80002,
       testnet: true,
       slug: "polygon-amoy-testnet",
@@ -60,37 +55,15 @@ export async function getChainData(fastify: FastifyInstance) {
     },
     handler: async (request, reply) => {
       const { chain } = request.query;
-      const config = await getConfig();
-
-      let chainData: Chain | null = null;
-      if (config.chainOverrides) {
-        chainData = JSON.parse(config.chainOverrides).find(
-          (dt: Chain) => dt.slug === chain || dt.chainId === parseInt(chain),
-        );
-      }
-
-      if (!chainData) {
-        chainData = await getChainBySlugAsync(chain);
-        if (!chainData) {
-          chainData = await getChainByChainIdAsync(parseInt(chain));
-        }
-      }
-
-      if (!chainData) {
-        const error = createCustomError(
-          "Chain not found",
-          StatusCodes.NOT_FOUND,
-          "ChainNotFound",
-        );
-        throw error;
-      }
 
-      const minimizeChainData = minimizeChain(chainData);
+      const chainId = await getChainIdFromChain(chain);
+      const chainV5 = await getChain(chainId);
+      const chainMetadata = await getChainMetadata(chainV5);
 
       reply.status(StatusCodes.OK).send({
         result: {
-          ...minimizeChainData,
-          rpc: [chainData.rpc.length === 0 ? "" : minimizeChainData.rpc[0]],
+          ...chainMetadata,
+          rpc: [...chainMetadata.rpc],
         },
       });
     },

src/server/routes/chain/getAll.ts

@@ -1,6 +1,6 @@
-import { Static, Type } from "@sinclair/typebox";
-import { Chain, fetchChains, minimizeChain } from "@thirdweb-dev/chains";
-import { FastifyInstance } from "fastify";
+import { Type, type Static } from "@sinclair/typebox";
+import { fetchChains } from "@thirdweb-dev/chains";
+import type { FastifyInstance } from "fastify";
 import { StatusCodes } from "http-status-codes";
 import { getConfig } from "../../../utils/cache/getConfig";
 import { chainResponseSchema } from "../../schemas/chain";
@@ -64,37 +64,31 @@ export async function getAllChainData(fastify: FastifyInstance) {
       },
     },
     handler: async (request, reply) => {
-      const allChainsData = await fetchChains();
+      const allChains = (await fetchChains()) ?? [];
       const config = await getConfig();
 
-      let chain = (allChainsData ?? ([] as Chain[])).map((chain) => {
-        const minimizeChainData = minimizeChain(chain);
-        if (chain.rpc.length === 0) {
-          return { ...minimizeChainData, rpc: [""] };
-        }
-        return { ...minimizeChainData, rpc: [minimizeChainData.rpc[0]] };
-      });
-
-      let chainOverrides: typeof chain = [];
-
-      if (config.chainOverrides) {
-        chainOverrides = (JSON.parse(config.chainOverrides) as Chain[]).map(
-          (overrideChain) => {
-            const shortName = overrideChain.shortName
-              ? overrideChain.shortName
-              : "";
-            const rpc =
-              overrideChain.rpc.length === 0 ? [""] : [overrideChain.rpc[0]];
-            return { ...overrideChain, shortName, rpc };
+      for (const chain of config.chainOverridesParsed) {
+        allChains.push({
+          chainId: chain.id,
+          name: chain.name ?? "",
+          rpc: [...chain.rpc],
+          nativeCurrency: {
+            name: chain.nativeCurrency?.name ?? "Ether",
+            symbol: chain.nativeCurrency?.symbol ?? "ETH",
+            decimals: chain.nativeCurrency?.decimals ?? 18,
           },
-        );
+          testnet: chain.testnet ?? false,
+          chain: "",
+          shortName: "",
+          slug: "",
+        });
       }
 
-      // Concatenate chain and chainOverrides
-      chain = chain.concat(chainOverrides);
-
       reply.status(StatusCodes.OK).send({
-        result: chain,
+        result: allChains.map((chain) => ({
+          ...chain,
+          rpc: [...chain.rpc],
+        })),
       });
     },
   });

src/server/routes/configuration/auth/get.ts

@@ -28,7 +28,7 @@ export async function getAuthConfiguration(fastify: FastifyInstance) {
     },
     handler: async (req, res) => {
       const config = await getConfig();
-      res.status(200).send({
+      res.status(StatusCodes.OK).send({
         result: {
           domain: config.authDomain,
         },

src/server/routes/configuration/auth/update.ts

@@ -35,7 +35,7 @@ export async function updateAuthConfiguration(fastify: FastifyInstance) {
 
       const config = await getConfig(false);
 
-      res.status(200).send({
+      res.status(StatusCodes.OK).send({
         result: {
           domain: config.authDomain,
         },

src/server/routes/configuration/backend-wallet-balance/get.ts

@@ -32,7 +32,7 @@ export async function getBackendWalletBalanceConfiguration(
     },
     handler: async (req, res) => {
       const config = await getConfig();
-      res.status(200).send({
+      res.status(StatusCodes.OK).send({
         result: {
           minWalletBalance: config.minWalletBalance,
         },

src/server/routes/configuration/backend-wallet-balance/update.ts

@@ -37,7 +37,7 @@ export async function updateBackendWalletBalanceConfiguration(
       await updateConfiguration({ ...req.body });
       const config = await getConfig(false);
 
-      res.status(200).send({
+      res.status(StatusCodes.OK).send({
         result: {
           minWalletBalance: config.minWalletBalance,
         },

src/server/routes/configuration/cache/get.ts

@@ -28,7 +28,7 @@ export async function getCacheConfiguration(fastify: FastifyInstance) {
     },
     handler: async (req, res) => {
       const config = await getConfig();
-      res.status(200).send({
+      res.status(StatusCodes.OK).send({
         result: {
           clearCacheCronSchedule: config.clearCacheCronSchedule,
         },

src/server/routes/configuration/cache/update.ts

@@ -49,7 +49,7 @@ export async function updateCacheConfiguration(fastify: FastifyInstance) {
       const config = await getConfig(false);
       // restarting cache cron with updated cron schedule
       await clearCacheCron("server");
-      res.status(200).send({
+      res.status(StatusCodes.OK).send({
         result: {
           clearCacheCronSchedule: config.clearCacheCronSchedule,
         },

src/server/routes/configuration/chains/get.ts

@@ -1,11 +1,12 @@
-import { Static, Type } from "@sinclair/typebox";
-import { FastifyInstance } from "fastify";
+import { Type, type Static } from "@sinclair/typebox";
+import type { FastifyInstance } from "fastify";
 import { StatusCodes } from "http-status-codes";
 import { getConfig } from "../../../../utils/cache/getConfig";
+import { chainResponseSchema } from "../../../schemas/chain";
 import { standardResponseSchema } from "../../../schemas/sharedApiSchemas";
 
 export const responseBodySchema = Type.Object({
-  result: Type.Union([Type.String(), Type.Null()]),
+  result: Type.Array(chainResponseSchema),
 });
 
 export async function getChainsConfiguration(fastify: FastifyInstance) {
@@ -26,9 +27,11 @@ export async function getChainsConfiguration(fastify: FastifyInstance) {
     },
     handler: async (req, res) => {
       const config = await getConfig();
-      res.status(200).send({
-        result: config.chainOverrides,
-      });
+      const result: Static<typeof chainResponseSchema>[] = config.chainOverrides
+        ? JSON.parse(config.chainOverrides)
+        : [];
+
+      res.status(StatusCodes.OK).send({ result });
     },
   });
 }