feat: production release 🚀 (#445)

Co-authored-by: Ashwin <[email protected]>
Co-authored-by: Nikolas Haimerl <[email protected]>
Co-authored-by: Melisa Guevara <[email protected]>

Author: 4 people

.github/workflows/ci.yml

@@ -26,6 +26,19 @@ jobs:
           cache: 'pnpm'
       - name: Install dependencies
         run: pnpm install
+      - name: Validate and inject secret into .env.test
+        env:
+          RPC_PROVIDER_URLS_421614: ${{ secrets.RPC_PROVIDER_URLS_421614 }}
+          RPC_PROVIDER_URLS_998: ${{ secrets.RPC_PROVIDER_URLS_998 }}
+          RPC_PROVIDER_URLS_42161: ${{ secrets.RPC_PROVIDER_URLS_42161 }}
+          RPC_PROVIDER_URLS_999: ${{ secrets.RPC_PROVIDER_URLS_999 }}
+        run: |
+          # Safely append the secret, prefixed with a newline.
+          # This prevents file corruption.
+          printf '\n%s\n' "RPC_PROVIDER_URLS_421614=$RPC_PROVIDER_URLS_421614" >> .env.test
+          printf '\n%s\n' "RPC_PROVIDER_URLS_998=$RPC_PROVIDER_URLS_998" >> .env.test
+          printf '\n%s\n' "RPC_PROVIDER_URLS_42161=$RPC_PROVIDER_URLS_42161" >> .env.test
+          printf '\n%s\n' "RPC_PROVIDER_URLS_999=$RPC_PROVIDER_URLS_999" >> .env.test
       - name: Run tests using docker
         run: pnpm test:e2e:docker
   build:

.gitignore

@@ -9,6 +9,7 @@ node_modules
 # Local env files
 .env
 .env.local
+.env.test
 .env.development.local
 .env.test.local
 .env.production.local

package.json

@@ -6,7 +6,7 @@
     "dev": "turbo dev",
     "fix": "turbo fix",
     "check": "turbo check",
-    "test": "turbo test",
+    "test": "turbo test --concurrency=1",
     "test:e2e:docker": "docker compose --env-file .env.test -f docker-compose.e2e.yml up --abort-on-container-exit --exit-code-from indexer-scraper-e2e",
     "test:e2e:docker:prune": "docker compose --env-file .env.test -f docker-compose.e2e.yml down -v",
     "start:indexer": "APP=indexer pnpm --filter @repo/node-app start",

packages/indexer-api/package.json

@@ -22,7 +22,8 @@
   "author": "",
   "license": "ISC",
   "dependencies": {
-    "@across-protocol/sdk": "^4.3.75",
+    "@across-protocol/constants": "^3.1.89",
+    "@across-protocol/sdk": "^4.3.97",
     "@repo/error-handling": "workspace:*",
     "@repo/indexer": "workspace:*",
     "@repo/indexer-database": "workspace:*",
@@ -48,15 +49,19 @@
     "@types/body-parser": "^1.19.5",
     "@types/chai": "^4.3.17",
     "@types/cors": "^2.8.17",
+    "@types/ioredis-mock": "^8.2.6",
     "@types/mocha": "^10.0.7",
     "chai": "^4.5.0",
     "eslint": "^8.57.0",
+    "ioredis-mock": "^8.13.1",
     "mocha": "^10.7.0",
     "nyc": "^17.0.0",
+    "pg-mem": "^3.0.5",
     "prettier": "^3.3.3",
     "source-map-support": "^0.5.21",
     "supertest": "^7.0.0",
     "ts-node": "^10.9.2",
+    "typeorm": "^0.3.20",
     "typescript": "^5.5.4"
   }
 }

packages/indexer-api/src/controllers/deposits.ts

@@ -5,6 +5,7 @@ import {
   DepositsParams,
   DepositParams,
   FilterDepositsParams,
+  DepositStatusParams,
 } from "../dtos/deposits.dto";
 
 export class DepositsController {
@@ -30,7 +31,7 @@ export class DepositsController {
     next: NextFunction,
   ) => {
     try {
-      const params = s.create(req.query, DepositParams);
+      const params = s.create(req.query, DepositStatusParams);
       const result = await this.service.getDepositStatus(params);
       return res.json(result);
     } catch (err) {

packages/indexer-api/src/dtos/deposits.dto.ts

@@ -68,6 +68,33 @@ export const DepositParams = s.object({
 
 export type DepositParams = s.Infer<typeof DepositParams>;
 
+export const DepositStatusParams = s.object({
+  depositId: s.optional(s.string()),
+  originChainId: s.optional(stringToInt),
+  /**
+   * @deprecated Use depositTxnRef instead.
+   * Once with supporting SVM chains, all references
+   * to EVM terminology is being deprecated for more general terms.
+   *
+   */
+  depositTxHash: s.optional(s.string()),
+  depositTxnRef: s.optional(s.string()),
+  relayDataHash: s.optional(s.string()),
+  index: s.refine(
+    s.defaulted(stringToInt, 0),
+    "positiveIndex",
+    (value) => value >= 0,
+  ),
+
+  /**
+   * Hyperliquid Withdrawals
+   */
+  from: s.optional(parseAddressField),
+  hypercoreWithdrawalNonce: s.optional(s.string()),
+});
+
+export type DepositStatusParams = s.Infer<typeof DepositStatusParams>;
+
 export const FilterDepositsParams = s.object({
   originChainId: s.optional(stringToInt),
   destinationChainId: s.optional(stringToInt),
@@ -163,10 +190,10 @@ export type DepositStatusResponse = {
   status: string | entities.RelayStatus;
   originChainId: number;
   depositId: string;
-  depositTxHash: string | null;
-  fillTx: string | undefined;
+  depositTxHash?: string | null;
+  fillTx?: string | undefined;
   destinationChainId: number;
-  depositRefundTxHash: string | undefined;
+  depositRefundTxHash?: string | undefined;
   actionsSucceeded: boolean | null;
   pagination: PaginationInfo;
 };

packages/indexer-api/src/services/deposits.ts

@@ -1,4 +1,5 @@
 import { Redis } from "ioredis";
+import { CHAIN_IDs } from "@across-protocol/constants";
 import { DataSource, entities } from "@repo/indexer-database";
 import type {
   DepositParams,
@@ -7,9 +8,11 @@ import type {
   DepositReturnType,
   ParsedDepositReturnType,
   DepositStatusResponse,
+  DepositStatusParams,
 } from "../dtos/deposits.dto";
 import {
   DepositNotFoundException,
+  HyperliquidWithdrawalNotFoundException,
   IncorrectQueryParamsException,
   IndexParamOutOfRangeException,
 } from "./exceptions";
@@ -222,7 +225,7 @@ export class DepositsService {
   }
 
   public async getDepositStatus(
-    params: DepositParams,
+    params: DepositStatusParams,
   ): Promise<DepositStatusResponse> {
     // in the validation rules each of these params are marked as optional
     // but we need to check that at least one of them is present
@@ -231,7 +234,8 @@ export class DepositsService {
         (params.depositId && params.originChainId) ||
         params.depositTxHash ||
         params.depositTxnRef ||
-        params.relayDataHash
+        params.relayDataHash ||
+        (params.from && params.hypercoreWithdrawalNonce)
       )
     ) {
       throw new IncorrectQueryParamsException();
@@ -245,6 +249,11 @@ export class DepositsService {
       return JSON.parse(cachedData);
     }
 
+    if (params.from && params.hypercoreWithdrawalNonce) {
+      // Hyperliquid Withdrawal status check
+      return this.getHyperliquidWithdrawalStatus(params);
+    }
+
     // no cached data, so we need to query the database
     const repo = this.db.getRepository(entities.RelayHashInfo);
     const queryBuilder = repo.createQueryBuilder("rhi");
@@ -323,6 +332,46 @@ export class DepositsService {
     return result;
   }
 
+  private async getHyperliquidWithdrawalStatus(params: DepositStatusParams) {
+    const cacheKey = this.getDepositStatusCacheKey(params);
+    const repo = this.db.getRepository(entities.HypercoreCctpWithdraw);
+    const withdrawal = await repo.findOne({
+      where: {
+        fromAddress: params.from,
+        hypercoreNonce: params.hypercoreWithdrawalNonce,
+      },
+    });
+
+    if (!withdrawal) {
+      throw new HyperliquidWithdrawalNotFoundException();
+    }
+
+    const result = {
+      status: "filled",
+      originChainId: CHAIN_IDs.HYPERCORE,
+      depositId: params.hypercoreWithdrawalNonce as string, // it cannot be undefined because of the query validation rules
+      depositTxnRef: null,
+      fillTxnRef: withdrawal.mintTxnHash,
+      destinationChainId: parseInt(withdrawal.destinationChainId),
+      depositRefundTxnRef: null,
+      actionsSucceeded: null,
+      pagination: {
+        currentIndex: 0,
+        maxIndex: 0,
+      },
+    };
+
+    const cacheTtlSeconds = 60 * 5; // 5 minutes
+    await this.redis.set(
+      cacheKey,
+      JSON.stringify(result),
+      "EX",
+      cacheTtlSeconds,
+    );
+
+    return result;
+  }
+
   public async getDeposit(params: DepositParams) {
     // in the validation rules each of these params are marked as optional
     // but we need to check that at least one of them is present
@@ -703,7 +752,7 @@ export class DepositsService {
     return false;
   }
 
-  private getDepositStatusCacheKey(params: DepositParams) {
+  private getDepositStatusCacheKey(params: DepositStatusParams) {
     if (params.depositId && params.originChainId) {
       return `depositStatus-${params.depositId}-${params.originChainId}-${params.index}`;
     }
@@ -716,6 +765,10 @@ export class DepositsService {
       return `depositStatus-${params.relayDataHash}-${params.index}`;
     }
 
+    if (params.from && params.hypercoreWithdrawalNonce) {
+      return `depositStatus-${params.from}-${params.hypercoreWithdrawalNonce}`;
+    }
+
     // in theory this should never happen because we have already checked
     // that at least one of the params is present
     throw new Error(

packages/indexer-api/src/services/exceptions.ts

@@ -10,6 +10,16 @@ export class DepositNotFoundException extends IndexerHTTPError {
   }
 }
 
+export class HyperliquidWithdrawalNotFoundException extends IndexerHTTPError {
+  constructor() {
+    super(
+      StatusCodes.NOT_FOUND,
+      HyperliquidWithdrawalNotFoundException.name,
+      "Hyperliquid withdrawal not found given the provided constraints",
+    );
+  }
+}
+
 export class IndexParamOutOfRangeException extends IndexerHTTPError {
   constructor(message: string) {
     super(StatusCodes.BAD_REQUEST, IndexParamOutOfRangeException.name, message);

packages/indexer-api/src/tests/deposit.test.ts

@@ -2,31 +2,21 @@ import { expect } from "chai";
 import request from "supertest";
 import { ExpressApp } from "../express-app";
 import express from "express";
-import {
-  createDataSource,
-  DataSource,
-  entities,
-  fixtures,
-} from "@repo/indexer-database";
+import { DataSource, entities, fixtures } from "@repo/indexer-database";
 import Redis from "ioredis";
-import * as Indexer from "@repo/indexer";
-import * as utils from "../utils";
+import { getTestDataSource, getTestRedisInstance } from "./setup";
 import * as routers from "../routers";
 
 describe("/deposit", () => {
   let app: express.Express;
   let dataSource: DataSource;
-  let redis: Redis;
+  let redisClient: Redis;
   let depositsFixture: fixtures.FundsDepositedFixture;
   let relayHashInfoFixture: fixtures.RelayHashInfoFixture;
 
-  before(async () => {
-    // Set up database and Redis
-    const databaseConfig = utils.getPostgresConfig(process.env);
-    dataSource = await createDataSource(databaseConfig).initialize();
-
-    const redisConfig = Indexer.parseRedisConfig(process.env);
-    redis = new Redis(redisConfig);
+  beforeEach(async () => {
+    dataSource = await getTestDataSource();
+    redisClient = getTestRedisInstance();
 
     // Initialize fixtures
     depositsFixture = new fixtures.FundsDepositedFixture(dataSource);
@@ -35,15 +25,14 @@ describe("/deposit", () => {
     await relayHashInfoFixture.deleteAllRelayHashInfoRows();
 
     // Initialize the Express app with the deposits router
-    const depositsRouter = routers.deposits.getRouter(dataSource, redis);
+    const depositsRouter = routers.deposits.getRouter(dataSource, redisClient);
     app = ExpressApp({ deposits: depositsRouter });
   });
 
-  after(async () => {
+  afterEach(async () => {
     // Clean up resources
-    await depositsFixture.deleteAllDeposits();
     await dataSource.destroy();
-    await redis.quit();
+    await redisClient.quit();
   });
 
   it("should return 200 and one deposit by depositId and originChainId", async () => {