fix: Add validation on chain ID + slug (#739)

* fix: Add validation on chain ID + slug

* undo

* merge chain files

Author: arcoraven

src/server/routes/contract/subscriptions/addContractSubscription.ts

@@ -13,6 +13,7 @@ import { getChain } from "../../../../utils/chain";
 import { thirdwebClient } from "../../../../utils/sdk";
 import { createCustomError } from "../../../middleware/error";
 import { AddressSchema } from "../../../schemas/address";
+import { chainIdOrSlugSchema } from "../../../schemas/chain";
 import {
   contractSubscriptionSchema,
   toContractSubscriptionSchema,
@@ -22,9 +23,7 @@ import { getChainIdFromChain } from "../../../utils/chain";
 import { isValidHttpUrl } from "../../../utils/validator";
 
 const bodySchema = Type.Object({
-  chain: Type.String({
-    description: "The chain for the contract.",
-  }),
+  chain: chainIdOrSlugSchema,
   contractAddress: {
     ...AddressSchema,
     description: "The address for the contract.",

src/server/routes/contract/subscriptions/getContractIndexedBlockRange.ts

@@ -1,9 +1,10 @@
-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 { getContractEventLogsIndexedBlockRange } from "../../../../db/contractEventLogs/getContractEventLogs";
 import { createCustomError } from "../../../middleware/error";
 import { AddressSchema } from "../../../schemas/address";
+import { chainIdOrSlugSchema } from "../../../schemas/chain";
 import {
   contractParamSchema,
   standardResponseSchema,
@@ -12,7 +13,7 @@ import { getChainIdFromChain } from "../../../utils/chain";
 
 const responseSchema = Type.Object({
   result: Type.Object({
-    chain: Type.String(),
+    chain: chainIdOrSlugSchema,
     contractAddress: AddressSchema,
     fromBlock: Type.Number(),
     toBlock: Type.Number(),

src/server/routes/relayer/create.ts

@@ -3,12 +3,13 @@ import type { FastifyInstance } from "fastify";
 import { StatusCodes } from "http-status-codes";
 import { prisma } from "../../../db/client";
 import { AddressSchema } from "../../schemas/address";
+import { chainIdOrSlugSchema } from "../../schemas/chain";
 import { standardResponseSchema } from "../../schemas/sharedApiSchemas";
 import { getChainIdFromChain } from "../../utils/chain";
 
 const requestBodySchema = Type.Object({
   name: Type.Optional(Type.String()),
-  chain: Type.String(),
+  chain: chainIdOrSlugSchema,
   backendWalletAddress: {
     ...AddressSchema,
     description:

src/server/routes/relayer/update.ts

@@ -3,13 +3,14 @@ import type { FastifyInstance } from "fastify";
 import { StatusCodes } from "http-status-codes";
 import { prisma } from "../../../db/client";
 import { AddressSchema } from "../../schemas/address";
+import { chainIdOrSlugSchema } from "../../schemas/chain";
 import { standardResponseSchema } from "../../schemas/sharedApiSchemas";
 import { getChainIdFromChain } from "../../utils/chain";
 
 const requestBodySchema = Type.Object({
   id: Type.String(),
   name: Type.Optional(Type.String()),
-  chain: Type.Optional(Type.String()),
+  chain: Type.Optional(chainIdOrSlugSchema),
   backendWalletAddress: Type.Optional(AddressSchema),
   allowedContracts: Type.Optional(Type.Array(Type.String())),
   allowedForwarders: Type.Optional(Type.Array(Type.String())),

src/server/routes/transaction/blockchain/getLogs.ts

@@ -17,15 +17,13 @@ import { getChain } from "../../../../utils/chain";
 import { thirdwebClient } from "../../../../utils/sdk";
 import { createCustomError } from "../../../middleware/error";
 import { AddressSchema, TransactionHashSchema } from "../../../schemas/address";
+import { chainIdOrSlugSchema } from "../../../schemas/chain";
 import { standardResponseSchema } from "../../../schemas/sharedApiSchemas";
 import { getChainIdFromChain } from "../../../utils/chain";
 
 // INPUT
 const requestQuerystringSchema = Type.Object({
-  chain: Type.String({
-    examples: ["80002"],
-    description: "Chain ID or name",
-  }),
+  chain: chainIdOrSlugSchema,
   queueId: Type.Optional(
     Type.String({
       description: "The queue ID for a mined transaction.",

src/server/routes/transaction/blockchain/getReceipt.ts

@@ -17,19 +17,17 @@ import {
 } from "../../../../utils/sdk";
 import { createCustomError } from "../../../middleware/error";
 import { AddressSchema, TransactionHashSchema } from "../../../schemas/address";
+import { chainIdOrSlugSchema } from "../../../schemas/chain";
 import { standardResponseSchema } from "../../../schemas/sharedApiSchemas";
 import { getChainIdFromChain } from "../../../utils/chain";
 
 // INPUT
 const requestSchema = Type.Object({
+  chain: chainIdOrSlugSchema,
   transactionHash: {
     ...TransactionHashSchema,
     description: "Transaction hash",
   },
-  chain: Type.String({
-    examples: ["80002"],
-    description: "Chain ID or name",
-  }),
 });
 
 // OUTPUT

src/server/routes/transaction/blockchain/getUserOpReceipt.ts

@@ -4,19 +4,17 @@ import { StatusCodes } from "http-status-codes";
 import { env } from "../../../../utils/env";
 import { createCustomError } from "../../../middleware/error";
 import { TransactionHashSchema } from "../../../schemas/address";
+import { chainIdOrSlugSchema } from "../../../schemas/chain";
 import { standardResponseSchema } from "../../../schemas/sharedApiSchemas";
 import { getChainIdFromChain } from "../../../utils/chain";
 
 // INPUT
 const requestSchema = Type.Object({
+  chain: chainIdOrSlugSchema,
   userOpHash: {
     ...TransactionHashSchema,
     description: "User operation hash",
   },
-  chain: Type.String({
-    examples: ["80002"],
-    description: "Chain ID or name",
-  }),
 });
 
 // OUTPUT

src/server/schemas/chain/index.ts

@@ -1,10 +1,12 @@
 import { Type } from "@sinclair/typebox";
 
+export const chainIdOrSlugSchema = Type.RegExp(/^[\w-]{1,50}$/, {
+  description: `A chain ID ("137") or slug ("polygon-amoy-testnet"). Chain ID is preferred.`,
+  examples: ["80002"],
+});
+
 export const chainRequestQuerystringSchema = Type.Object({
-  chain: Type.String({
-    description: "Chain name or ID",
-    examples: ["1", "ethereum"],
-  }),
+  chain: chainIdOrSlugSchema,
 });
 
 export const chainResponseSchema = Type.Partial(

src/server/schemas/prebuilts/index.ts

@@ -1,6 +1,7 @@
 import { Type } from "@sinclair/typebox";
 import { constants } from "ethers";
 import { AddressSchema } from "../address";
+import { chainIdOrSlugSchema } from "../chain";
 
 const MAX_BPS = 10000;
 
@@ -87,10 +88,7 @@ export const commonTrustedForwarderSchema = Type.Object({
 });
 
 export const prebuiltDeployContractParamSchema = Type.Object({
-  chain: Type.String({
-    examples: ["80002"],
-    description: "Chain ID or name",
-  }),
+  chain: chainIdOrSlugSchema,
 });
 
 export const prebuiltDeployResponseSchema = Type.Object({

src/server/schemas/sharedApiSchemas.ts

@@ -4,6 +4,7 @@ import type { RouteGenericInterface } from "fastify";
 import type { FastifySchema } from "fastify/types/schema";
 import { StatusCodes } from "http-status-codes";
 import { AddressSchema } from "./address";
+import { chainIdOrSlugSchema } from "./chain";
 
 export const baseReplyErrorSchema = Type.Object({
   message: Type.Optional(Type.String()),
@@ -17,10 +18,7 @@ export const baseReplyErrorSchema = Type.Object({
  * Basic schema for Request Parameters
  */
 export const contractParamSchema = Type.Object({
-  chain: Type.String({
-    examples: ["80002"],
-    description: "Chain ID or name",
-  }),
+  chain: chainIdOrSlugSchema,
   contractAddress: {
     ...AddressSchema,
     description: "Contract address",
@@ -37,21 +35,15 @@ export const requestQuerystringSchema = Type.Object({
 });
 
 export const prebuiltDeployParamSchema = Type.Object({
-  chain: Type.String({
-    examples: ["80002"],
-    description: "Chain ID or name",
-  }),
+  chain: chainIdOrSlugSchema,
   contractType: Type.String({
     examples: Object.keys(PREBUILT_CONTRACTS_MAP),
     description: "Contract type to deploy",
   }),
 });
 
 export const publishedDeployParamSchema = Type.Object({
-  chain: Type.String({
-    examples: ["80002"],
-    description: "Chain ID or name",
-  }),
+  chain: chainIdOrSlugSchema,
   publisher: Type.String({
     examples: ["deployer.thirdweb.eth"],
     description: "Address or ENS of the publisher of the contract",
@@ -176,10 +168,7 @@ transactionWritesResponseSchema.example = {
  * Basic schema for ERC721 Contract Request Parameters
  */
 export const erc20ContractParamSchema = Type.Object({
-  chain: Type.String({
-    examples: ["80002"],
-    description: "Chain ID or name",
-  }),
+  chain: chainIdOrSlugSchema,
   contractAddress: {
     ...AddressSchema,
     description: "ERC20 contract address",
@@ -190,10 +179,7 @@ export const erc20ContractParamSchema = Type.Object({
  * Basic schema for ERC721 Contract Request Parameters
  */
 export const erc1155ContractParamSchema = Type.Object({
-  chain: Type.String({
-    examples: ["80002"],
-    description: "Chain ID or name",
-  }),
+  chain: chainIdOrSlugSchema,
   contractAddress: {
     ...AddressSchema,
     description: "ERC1155 contract address",
@@ -204,10 +190,7 @@ export const erc1155ContractParamSchema = Type.Object({
  * Basic schema for ERC721 Contract Request Parameters
  */
 export const erc721ContractParamSchema = Type.Object({
-  chain: Type.String({
-    examples: ["80002"],
-    description: "Chain ID or name",
-  }),
+  chain: chainIdOrSlugSchema,
   contractAddress: {
     ...AddressSchema,
     description: "ERC721 contract address",
@@ -234,10 +217,7 @@ export enum Status {
 }
 
 export const marketplaceV3ContractParamSchema = Type.Object({
-  chain: Type.String({
-    examples: ["80002"],
-    description: "Chain ID or name",
-  }),
+  chain: chainIdOrSlugSchema,
   contractAddress: {
     ...AddressSchema,
     description: "Contract address",

src/server/schemas/wallet/index.ts

@@ -1,8 +1,9 @@
 import { Type } from "@sinclair/typebox";
-import { type Address, getAddress } from "thirdweb";
+import { getAddress, type Address } from "thirdweb";
 import { env } from "../../../utils/env";
 import { badAddressError } from "../../middleware/error";
 import { AddressSchema } from "../address";
+import { chainIdOrSlugSchema } from "../chain";
 
 export const walletHeaderSchema = Type.Object({
   "x-backend-wallet-address": {
@@ -66,10 +67,7 @@ export function requiredAddress(
 }
 
 export const walletChainParamSchema = Type.Object({
-  chain: Type.String({
-    examples: ["80002"],
-    description: "Chain ID",
-  }),
+  chain: chainIdOrSlugSchema,
 });
 
 export const walletWithAddressParamSchema = Type.Object({