feat: restore api search

.github/workflows/docker.yml

@@ -18,6 +18,7 @@ jobs:
           - apps/twap
           - apps/notification-producer
           - apps/telegram
+          - apps/token-list-updater
     steps:
       - name: Checkout
         uses: actions/checkout@v3

apps/api/src/app/inversify.config.ts

@@ -4,6 +4,7 @@ import {
   getPushNotificationsRepository,
   getPushSubscriptionsRepository,
   getSimulationRepository,
+  getTokenCacheRepository,
   getTokenHolderRepository,
   getUsdRepository,
 } from '@cowprotocol/services';
@@ -14,13 +15,15 @@ import {
   PushNotificationsRepository,
   PushSubscriptionsRepository,
   SimulationRepository,
+  TokenCacheRepository,
   TokenHolderRepository,
   UsdRepository,
   cacheRepositorySymbol,
   erc20RepositorySymbol,
   pushNotificationsRepositorySymbol,
   pushSubscriptionsRepositorySymbol,
   tenderlyRepositorySymbol,
+  tokenCacheRepositorySymbol,
   tokenHolderRepositorySymbol,
   usdRepositorySymbol,
 } from '@cowprotocol/repositories';
@@ -52,6 +55,7 @@ function getApiContainer(): Container {
   const cacheRepository = getCacheRepository();
   const erc20Repository = getErc20Repository(cacheRepository);
   const simulationRepository = getSimulationRepository();
+  const tokenCacheRepository = getTokenCacheRepository();
   const tokenHolderRepository = getTokenHolderRepository(cacheRepository);
   const usdRepository = getUsdRepository(cacheRepository, erc20Repository);
   const pushNotificationsRepository = getPushNotificationsRepository();
@@ -85,6 +89,10 @@ function getApiContainer(): Container {
     .bind<TokenHolderRepository>(tokenHolderRepositorySymbol)
     .toConstantValue(tokenHolderRepository);
 
+  apiContainer
+    .bind<TokenCacheRepository>(tokenCacheRepositorySymbol)
+    .toConstantValue(tokenCacheRepository);
+
   // Services
   apiContainer
     .bind<SlippageService>(slippageServiceSymbol)

apps/api/src/app/routes/__chainId/tokens/search/__searchParam/index.ts

@@ -0,0 +1,49 @@
+import { getTokenListBySearchParam } from '@cowprotocol/repositories';
+import { FastifyPluginAsync } from 'fastify';
+import {
+  errorSchema,
+  ErrorSchema,
+  paramsSchema,
+  RouteSchema,
+  successSchema,
+  SuccessSchema,
+} from './schemas';
+
+const root: FastifyPluginAsync = async (fastify): Promise<void> => {
+  // example: http://localhost:3010/1/tokens/search/USDC
+  fastify.get<{
+    Params: RouteSchema;
+    Reply: SuccessSchema | ErrorSchema;
+  }>(
+    '/',
+    {
+      schema: {
+        params: paramsSchema,
+        response: {
+          '2XX': successSchema,
+          '500': errorSchema,
+        },
+      },
+    },
+    async function (request, reply) {
+      const { chainId, searchParam } = request.params;
+
+      try {
+        const tokens = await getTokenListBySearchParam(chainId, searchParam);
+
+        fastify.log.info(
+          `Token search for "${searchParam}" on chain ${chainId}: ${tokens.length} tokens found`
+        );
+
+        reply.send(tokens);
+      } catch (error) {
+        fastify.log.error('Error searching tokens:', error);
+        reply.code(500).send({
+          message: 'Internal server error while searching tokens',
+        });
+      }
+    }
+  );
+};
+
+export default root;

apps/api/src/app/routes/__chainId/tokens/search/__searchParam/schemas.ts

@@ -0,0 +1,81 @@
+import { FromSchema, JSONSchema } from 'json-schema-to-ts';
+import { SupportedChainIdSchema } from '../../../../../schemas';
+import { AllChainIds } from '@cowprotocol/shared';
+
+export const paramsSchema = {
+  type: 'object',
+  required: ['chainId', 'searchParam'],
+  additionalProperties: false,
+  properties: {
+    chainId: SupportedChainIdSchema,
+    searchParam: {
+      title: 'Search Parameter',
+      description: 'Token search parameter (name, symbol, or address)',
+      type: 'string',
+      minLength: 3,
+      maxLength: 100,
+    },
+  },
+} as const satisfies JSONSchema;
+
+export const successSchema = {
+  type: 'array',
+  items: {
+    type: 'object',
+    required: ['chainId', 'address', 'name', 'symbol', 'decimals', 'logoURI'],
+    additionalProperties: false,
+    properties: {
+      chainId: {
+        title: 'Chain ID',
+        description: 'Blockchain network identifier.',
+        type: 'integer',
+        enum: AllChainIds,
+      },
+      address: {
+        title: 'Token Address',
+        description: 'Contract address of the token.',
+        type: 'string',
+        pattern: '^0x[a-fA-F0-9]{40}$',
+      },
+      name: {
+        title: 'Name',
+        description: 'Full name of the token.',
+        type: 'string',
+      },
+      symbol: {
+        title: 'Symbol',
+        description: 'Token symbol/ticker.',
+        type: 'string',
+      },
+      decimals: {
+        title: 'Decimals',
+        description: 'Number of decimal places for the token.',
+        type: 'integer',
+        minimum: 0,
+        maximum: 18,
+      },
+      logoURI: {
+        title: 'Logo URI',
+        description: 'URI to the token logo.',
+        type: 'string',
+      },
+    },
+  },
+} as const satisfies JSONSchema;
+
+export const errorSchema = {
+  type: 'object',
+  required: ['message'],
+  additionalProperties: false,
+  properties: {
+    message: {
+      title: 'Message',
+      description: 'Message describing the error.',
+      type: 'string',
+    },
+  },
+} as const satisfies JSONSchema;
+
+export type RouteSchema = FromSchema<typeof paramsSchema>;
+export type SuccessSchema = FromSchema<typeof successSchema>;
+export type ErrorSchema = FromSchema<typeof errorSchema>;

apps/api/src/main.ts

@@ -1,6 +1,8 @@
 import Fastify from 'fastify';
 import { app } from './app/app';
 import { logger } from '@cowprotocol/shared';
+import { getTokenCacheRepository } from '@cowprotocol/services';
+import { setTokenCacheRepository } from '@cowprotocol/repositories';
 
 const host = process.env.HOST ?? 'localhost';
 const port = process.env.PORT ? Number(process.env.PORT) : 3001;
@@ -10,6 +12,9 @@ export const server = Fastify({
   logger,
 });
 
+const tokenCacheRepository = getTokenCacheRepository();
+setTokenCacheRepository(tokenCacheRepository);
+
 // Register your application as a normal plugin.
 server.register(app);
 

apps/notification-producer/jest.config.ts

@@ -6,6 +6,9 @@ export default {
   transform: {
     '^.+\\.[tj]s$': ['ts-jest', { tsconfig: '<rootDir>/tsconfig.spec.json' }],
   },
+  transformIgnorePatterns: [
+    'node_modules/(?!(node-fetch|data-uri-to-buffer|fetch-blob|formdata-polyfill|@cowprotocol|@uniswap)/)',
+  ],
   moduleFileExtensions: ['ts', 'js', 'html'],
   coverageDirectory: '../../coverage/apps/notification-producer',
   setupFilesAfterEnv: ['../../jest.setup.ts'],

apps/token-list-updater-e2e/.eslintrc.json

@@ -0,0 +1,10 @@
+{
+  "extends": ["../../.eslintrc.json"],
+  "ignorePatterns": ["!**/*"],
+  "overrides": [
+    {
+      "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
+      "rules": {}
+    }
+  ]
+}

apps/token-list-updater-e2e/jest.config.ts

@@ -0,0 +1,17 @@
+/* eslint-disable */
+export default {
+  displayName: 'token-list-updater-e2e',
+  preset: '../..//jest.preset.js',
+  setupFiles: ['<rootDir>/src/test-setup.ts'],
+  testEnvironment: 'node',
+  transform: {
+    '^.+\\.[tj]s$': [
+      'ts-jest',
+      {
+        tsconfig: '<rootDir>/tsconfig.spec.json',
+      },
+    ],
+  },
+  moduleFileExtensions: ['ts', 'js', 'html'],
+  coverageDirectory: '../..//coverage/token-list-updater-e2e',
+};

apps/token-list-updater-e2e/project.json

@@ -0,0 +1,22 @@
+{
+  "name": "token-list-updater-e2e",
+  "$schema": "../../node_modules/nx/schemas/project-schema.json",
+  "implicitDependencies": ["token-list-updater"],
+  "targets": {
+    "e2e": {
+      "executor": "@nx/jest:jest",
+      "outputs": ["{workspaceRoot}/coverage/{e2eProjectRoot}"],
+      "options": {
+        "jestConfig": "apps/token-list-updater-e2e/jest.config.ts",
+        "passWithNoTests": true
+      }
+    },
+    "lint": {
+      "executor": "@nx/linter:eslint",
+      "outputs": ["{options.outputFile}"],
+      "options": {
+        "lintFilePatterns": ["apps/token-list-updater-e2e/**/*.{js,ts}"]
+      }
+    }
+  }
+}

apps/token-list-updater-e2e/src/test-setup.ts

@@ -0,0 +1 @@
+//

apps/token-list-updater-e2e/src/token-list-updater/token-list-updater.spec.ts

@@ -0,0 +1,13 @@
+import { execSync } from 'child_process';
+import { join } from 'path';
+
+describe('CLI tests', () => {
+  // TODO: implement properly this test
+  it.skip('should print a message', () => {
+    const cliPath = join(process.cwd(), 'dist/apps/token-list-updater');
+
+    const output = execSync(`node ${cliPath}`).toString();
+
+    expect(output).toMatch(/Hello World/);
+  });
+});

apps/token-list-updater-e2e/tsconfig.json

@@ -0,0 +1,13 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "files": [],
+  "include": [],
+  "references": [
+    {
+      "path": "./tsconfig.spec.json"
+    }
+  ],
+  "compilerOptions": {
+    "esModuleInterop": true
+  }
+}

apps/token-list-updater-e2e/tsconfig.spec.json

@@ -0,0 +1,9 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../..//dist/out-tsc",
+    "module": "commonjs",
+    "types": ["jest", "node"]
+  },
+  "include": ["jest.config.ts", "src/**/*.ts"]
+}

apps/token-list-updater/.eslintrc.json

@@ -0,0 +1,18 @@
+{
+  "extends": ["../../.eslintrc.json"],
+  "ignorePatterns": ["!**/*"],
+  "overrides": [
+    {
+      "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.ts", "*.tsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.js", "*.jsx"],
+      "rules": {}
+    }
+  ]
+}

apps/token-list-updater/Dockerfile

@@ -0,0 +1,24 @@
+# This file is generated by Nx.
+#
+# Build the docker image with `npx nx docker-build token-list-updater`.
+# Tip: Modify "docker-build" options in project.json to change docker build args.
+#
+# Run the container with `docker run -p 3000:3000 -t token-list-updater`.
+FROM docker.io/node:lts-alpine
+
+ENV HOST=0.0.0.0
+ENV PORT=3000
+
+WORKDIR /app
+
+RUN addgroup --system token-list-updater && \
+          adduser --system -G token-list-updater token-list-updater
+
+COPY dist/apps/token-list-updater token-list-updater
+RUN chown -R token-list-updater:token-list-updater .
+
+# You can remove this install step if you build with `--bundle` option.
+# The bundled output will include external dependencies.
+RUN npm --prefix token-list-updater --omit=dev -f install
+
+CMD [ "node", "token-list-updater/main.js" ]

apps/token-list-updater/jest.config.ts

@@ -0,0 +1,11 @@
+/* eslint-disable */
+export default {
+  displayName: 'token-list-updater',
+  preset: '../../jest.preset.js',
+  testEnvironment: 'node',
+  transform: {
+    '^.+\\.[tj]s$': ['ts-jest', { tsconfig: '<rootDir>/tsconfig.spec.json' }],
+  },
+  moduleFileExtensions: ['ts', 'js', 'html'],
+  coverageDirectory: '../../coverage/apps/token-list-updater',
+};