feat: improve error handling, refactor folders

Author: dglowinski

src/api-docs/openAPIDocumentGenerator.ts

@@ -3,8 +3,8 @@ import {
   OpenApiGeneratorV3,
 } from "@asteasolutions/zod-to-openapi"
 
-import { healthCheckRegistry } from "@/api/healthCheck/healthCheckRouter"
-import { swapRegistry } from "@/api/swap/swapRouter"
+import { healthCheckRegistry } from "@/api/routes/healthCheck/healthCheckRouter"
+import { swapRegistry } from "@/api/routes/swap/swapRouter"
 
 export function generateOpenAPIDocument() {
   const registry = new OpenAPIRegistry([healthCheckRegistry, swapRegistry])

src/api/healthCheck/healthCheckRouter.ts renamed to src/api/routes/healthCheck/healthCheckRouter.ts

@@ -1,4 +1,4 @@
-import { SwapVerificationType, SwapperMode } from "@/swap/interface"
+import { SwapVerificationType, SwapperMode } from "@/swapService/interface"
 import { extendZodWithOpenApi } from "@asteasolutions/zod-to-openapi"
 import { InvalidAddressError, getAddress, isHex } from "viem"
 import { z } from "zod"
@@ -150,7 +150,7 @@ const getSwapSchema = z.object({
       .string()
       .transform((s) => JSON.parse(s))
       .pipe(chainRoutingConfigSchema)
-      .optional(), // TODO handle routing config
+      .optional(),
   }),
 })
 

src/api/swap/swapModel.ts renamed to src/api/routes/swap/swapModel.ts

@@ -0,0 +1,124 @@
+import { OpenAPIRegistry } from "@asteasolutions/zod-to-openapi"
+import express, { type Router, type Request, type Response } from "express"
+
+import { createApiResponse } from "@/api-docs/openAPIResponseBuilders"
+
+import { ServiceResponse } from "@/common/models/serviceResponse"
+import {
+  handleServiceResponse,
+  validateRequest,
+} from "@/common/utils/httpHandlers"
+import { runPipeline } from "@/swapService/runner"
+import type { SwapParams } from "@/swapService/types"
+import {
+  ApiError,
+  addInOutDeposits,
+  findToken,
+  getSwapper,
+} from "@/swapService/utils"
+import { StatusCodes } from "http-status-codes"
+import { InvalidAddressError, isHex } from "viem"
+import { z } from "zod"
+import {
+  type SwapResponse,
+  getSwapSchema,
+  swapResponseSchema,
+} from "./swapModel"
+
+export const swapRegistry = new OpenAPIRegistry()
+export const swapRouter: Router = express.Router()
+
+swapRegistry.register("Swap", swapResponseSchema)
+swapRegistry.registerPath({
+  method: "get",
+  path: "/swap",
+  tags: ["Swap"],
+  request: { query: getSwapSchema.shape.query },
+  responses: createApiResponse(swapResponseSchema, "Success"),
+})
+
+swapRouter.get(
+  "/",
+  validateRequest(getSwapSchema),
+  async (req: Request, res: Response) => {
+    const serviceResponse = await findSwap(req)
+    return handleServiceResponse(serviceResponse, res)
+  },
+)
+
+async function findSwap(
+  req: Request,
+): Promise<ServiceResponse<SwapResponse | null>> {
+  try {
+    const swapParams = parseRequest(req)
+
+    let data = await runPipeline(swapParams)
+
+    // GLOBAL CHECKS
+    data = addInOutDeposits(swapParams, data)
+
+    // make sure verify item includes at least a function selector
+    if (
+      !isHex(data.verify.verifierData) ||
+      data.verify.verifierData.length < 10
+    )
+      throw new ApiError(
+        StatusCodes.INTERNAL_SERVER_ERROR,
+        "Verifier transaction is empty",
+      )
+
+    return ServiceResponse.success<SwapResponse>(data)
+  } catch (error) {
+    if (error instanceof ApiError) {
+      return ServiceResponse.failure(
+        error.message,
+        error.statusCode,
+        error.data,
+      )
+    }
+    return ServiceResponse.failure(
+      `${error}`,
+      StatusCodes.INTERNAL_SERVER_ERROR,
+    )
+  }
+}
+
+function parseRequest(request: Request): SwapParams {
+  try {
+    const { query: validatedParams } = getSwapSchema.parse(request)
+
+    // TODO
+    // if (!isSupportedChainId(validatedParams.chainId)) {
+    //   throw new Error("Unsupported chainId")
+    // }
+
+    const chainId = validatedParams.chainId
+    const tokenIn = findToken(chainId, validatedParams.tokenIn)
+    if (!tokenIn)
+      throw new ApiError(StatusCodes.NOT_FOUND, "Token in not supported")
+
+    const tokenOut = findToken(chainId, validatedParams.tokenOut)
+    if (!tokenOut)
+      throw new ApiError(StatusCodes.NOT_FOUND, "Token out not supported")
+
+    return {
+      ...validatedParams,
+      from: getSwapper(chainId),
+      chainId,
+      tokenIn,
+      tokenOut,
+    }
+  } catch (error) {
+    if (error instanceof ApiError) throw error
+    if (error instanceof z.ZodError) {
+      throw new ApiError(
+        StatusCodes.BAD_REQUEST,
+        `Invalid parameters: ${error.errors.map((e) => e.message).join(", ")}`,
+      )
+    }
+    if (error instanceof InvalidAddressError)
+      throw new ApiError(400, "Invalid Address")
+
+    throw new ApiError(500, `${error}`)
+  }
+}

src/api/routes/swap/swapRouter.ts

@@ -23,10 +23,10 @@ export class ServiceResponse<T = null> {
     return new ServiceResponse(true, data, statusCode)
   }
 
-  static failure<T>(
+  static failure(
     message: string,
-    data: T,
     statusCode: number = StatusCodes.BAD_REQUEST,
+    data?: any,
   ) {
     return new ServiceResponse(false, data, statusCode, message)
   }

src/api/swap/swapRouter.ts

@@ -1,5 +1,5 @@
 import * as chains from "viem/chains"
-// TODO
+
 const contractBook: any = {
   swapper: {
     abi: require("./abi/Swapper.json"),

src/common/models/serviceResponse.ts

@@ -13,5 +13,4 @@ export const env = cleanEnv(process.env, {
   CORS_ORIGIN: str({ devDefault: testOnly("http://localhost:3001") }),
   COMMON_RATE_LIMIT_MAX_REQUESTS: num({ devDefault: testOnly(1000) }),
   COMMON_RATE_LIMIT_WINDOW_MS: num({ devDefault: testOnly(1000) }),
-  // TODO
 })

src/common/utils/contractBook.ts

@@ -146,7 +146,7 @@
     "name": "Renzo Restaked ETH",
     "symbol": "EZETH",
     "decimals": 18,
-    "logoURI": "https://coin-images.coingecko.com/coins/images/34753/large/Ezeth_logo_circle.png?1713496404",
+    "logoURI": "https://coin-images.coingecko.com/coins/images/34753/large/Ezeth_logo_circle.png?1713496StatusCodes.NOT_FOUND",
     "meta": {}
   },
   {
@@ -948,7 +948,7 @@
     "meta": {}
   },
   {
-    "addressInfo": "0x64047dd3288276d70a4f8b5df54668c8403f877f",
+    "addressInfo": "0x6StatusCodes.NOT_FOUND7dd3288276d70a4f8b5df54668c8403f877f",
     "chainId": 1,
     "name": "Amphor Restaked BTC",
     "symbol": "amphrBTC",

src/common/utils/envConfig.ts

@@ -4,8 +4,8 @@ import helmet from "helmet"
 import { pino } from "pino"
 
 import { openAPIRouter } from "@/api-docs/openAPIRouter"
-import { healthCheckRouter } from "@/api/healthCheck/healthCheckRouter"
-import { swapRouter } from "@/api/swap/swapRouter"
+import { healthCheckRouter } from "@/api/routes/healthCheck/healthCheckRouter"
+import { swapRouter } from "@/api/routes/swap/swapRouter"
 import errorHandler from "@/common/middleware/errorHandler"
 import rateLimiter from "@/common/middleware/rateLimiter"
 import requestLogger from "@/common/middleware/requestLogger"