fix: erc20 automation script

packages/automation-scripts/package.json

@@ -16,6 +16,7 @@
     "build:esm": "tsc -p tsconfig.json",
     "build:dirty": "pnpm build:esm",
     "pre-commit": "lint-staged",
+    "test": "jest",
     "erc20-diff": "node dist/cjs/commands/erc20/diff.js",
     "gen-erc20-list": "node dist/cjs/commands/erc20/createNewList.js",
     "download-erc20-images": "node dist/cjs/commands/erc20/downloadImages.js",

packages/automation-scripts/src/__mocks__/coingecko.ts

@@ -0,0 +1,18 @@
+import { jest } from '@jest/globals';
+import { CoingeckoCoinDetails, CoingeckoCoinListItem } from '../tokens';
+
+export const getCoingeckoCoinList =
+  jest.fn<() => Promise<CoingeckoCoinListItem[]>>();
+export const getCoingeckoCoinDetails =
+  jest.fn<() => Promise<CoingeckoCoinDetails>>();
+
+jest.mock('../tokens/coingecko', () => {
+  const originalModule: any = jest.requireActual('../../src/tokens/coingecko');
+
+  return {
+    __esModule: true,
+    ...originalModule,
+    getCoingeckoCoinList,
+    getCoingeckoCoinDetails,
+  };
+});

packages/automation-scripts/src/index.ts

@@ -1 +1,2 @@
 export * from './tokens';
+export * from './translate';

packages/automation-scripts/src/tokens/asserts.ts

@@ -0,0 +1,15 @@
+import { assert } from '@cypherock/cysync-utils';
+import { TokenAutomationParams } from './types';
+
+export const assertTokenAutomationParams = (params: TokenAutomationParams) => {
+  assert(params, 'Token automation params are not provided');
+  assert(params.createTokenAssetId, 'createTokenAssetId is not provided');
+  assert(params.tokenJsonList, 'tokenJsonList is not provided');
+  assert(params.coinList, 'coinList is not provided');
+  assert(params.coinIdMap, 'coinIdMap is not provided');
+  assert(
+    params.coingeckoPlatformMapping,
+    'coingeckoPlatformMapping is not provided',
+  );
+  assert(params.filePrefix, 'filePrefix is not provided');
+};

packages/automation-scripts/src/tokens/diff/helpers.ts

@@ -0,0 +1,108 @@
+import {
+  CoingeckoCoinListItem,
+  TokenAutomationParams,
+  TokenListItem,
+} from '../types';
+
+export const createContractMapFromExistingList = (
+  params: TokenAutomationParams,
+) => {
+  const map: Record<string, TokenListItem | undefined> = {};
+
+  for (const coin of params.tokenJsonList) {
+    if (!coin.platforms) continue;
+
+    for (const platform in coin.platforms) {
+      if (!coin.platforms[platform]) continue;
+
+      // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+      if (!params.coinList[platform]) continue;
+
+      const tokenDetails = coin.platforms[platform];
+      if (!tokenDetails) continue;
+
+      map[`${platform}:${tokenDetails.contract_address.toLowerCase()}`] = {
+        ...coin,
+        platforms: {
+          [platform]: {
+            ...tokenDetails,
+          },
+        },
+      };
+    }
+  }
+
+  return map;
+};
+
+export const createContractMapFromCoingeckoList = (
+  list: CoingeckoCoinListItem[],
+  params: TokenAutomationParams,
+) => {
+  const map: Record<string, TokenListItem | undefined> = {};
+
+  for (const coin of list) {
+    if (!coin.platforms) continue;
+
+    for (const platform in coin.platforms) {
+      if (!coin.platforms[platform]) continue;
+
+      const mappedPlatform = params.coingeckoPlatformMapping[platform];
+      if (!mappedPlatform) continue;
+
+      const contractAddress = coin.platforms[platform];
+      if (!contractAddress) continue;
+
+      map[`${mappedPlatform}:${contractAddress.toLowerCase()}`] = {
+        id: coin.id,
+        name: coin.name,
+        symbol: coin.symbol,
+        platforms: {
+          [mappedPlatform]: {
+            contract_address: contractAddress,
+            decimal_place: 0,
+          },
+        },
+      };
+    }
+  }
+
+  return map;
+};
+
+export const verifyDuplicateIds = (
+  list: TokenListItem[],
+  params: TokenAutomationParams,
+) => {
+  const idSet = new Set();
+  const duplicateIdList: string[] = [];
+
+  for (const coin of list) {
+    if (!coin.platforms) continue;
+
+    for (const platform in coin.platforms) {
+      if (!coin.platforms[platform]) continue;
+
+      const tokenDetails = coin.platforms[platform];
+      if (!tokenDetails) continue;
+
+      const id = params.createTokenAssetId({
+        parentAssetId: platform,
+        assetId: coin.id,
+        version: coin.version,
+      });
+
+      if (idSet.has(id)) {
+        duplicateIdList.push(id);
+      } else {
+        idSet.add(id);
+      }
+    }
+  }
+
+  if (duplicateIdList.length > 0) {
+    throw new Error(
+      `Duplicate ids found in list: ${duplicateIdList.join(',')}`,
+    );
+  }
+};

packages/automation-scripts/src/tokens/diff.ts → packages/automation-scripts/src/tokens/diff/index.ts

@@ -4,78 +4,16 @@ import path from 'path';
 
 import lodash from 'lodash';
 
-import { getCoingeckoCoinList } from './coingecko';
-import {
-  CoingeckoCoinListItem,
-  TokenAutomationParams,
-  TokenListItem,
-} from './types';
-
-import { config } from '../config';
-
-const createContractMapFromExistingList = (params: TokenAutomationParams) => {
-  const map: Record<string, TokenListItem | undefined> = {};
-
-  for (const coin of params.tokenJsonList) {
-    if (!coin.platforms) continue;
-
-    for (const platform in coin.platforms) {
-      if (!coin.platforms[platform]) continue;
-
-      // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-      if (!params.coinList[platform]) continue;
-
-      const tokenDetails = coin.platforms[platform];
-      if (!tokenDetails) continue;
-
-      map[`${platform}:${tokenDetails.contract_address.toLowerCase()}`] = {
-        ...coin,
-        platforms: {
-          [platform]: {
-            ...tokenDetails,
-          },
-        },
-      };
-    }
-  }
+import { getCoingeckoCoinList } from '../coingecko';
+import { TokenAutomationParams, TokenListItem } from '../types';
 
-  return map;
-};
-
-const createContractMapFromCoingeckoList = (
-  list: CoingeckoCoinListItem[],
-  params: TokenAutomationParams,
-) => {
-  const map: Record<string, TokenListItem | undefined> = {};
-
-  for (const coin of list) {
-    if (!coin.platforms) continue;
-
-    for (const platform in coin.platforms) {
-      if (!coin.platforms[platform]) continue;
-
-      const mappedPlatform = params.coingeckoPlatformMapping[platform];
-      if (!mappedPlatform) continue;
-
-      const contractAddress = coin.platforms[platform];
-      if (!contractAddress) continue;
-
-      map[`${mappedPlatform}:${contractAddress.toLowerCase()}`] = {
-        id: coin.id,
-        name: coin.name,
-        symbol: coin.symbol,
-        platforms: {
-          [mappedPlatform]: {
-            contract_address: contractAddress,
-            decimal_place: 0,
-          },
-        },
-      };
-    }
-  }
-
-  return map;
-};
+import { config } from '../../config';
+import {
+  createContractMapFromCoingeckoList,
+  createContractMapFromExistingList,
+  verifyDuplicateIds,
+} from './helpers';
+import { assertTokenAutomationParams } from '../asserts';
 
 const getChangedContracts = (params: {
   sameContracts: string[];
@@ -176,43 +114,6 @@ const getRemovedContracts = (params: {
   return { removedCoinList };
 };
 
-const verifyDuplicateIds = (
-  list: TokenListItem[],
-  params: TokenAutomationParams,
-) => {
-  const idSet = new Set();
-  const duplicateIdList: string[] = [];
-
-  for (const coin of list) {
-    if (!coin.platforms) continue;
-
-    for (const platform in coin.platforms) {
-      if (!coin.platforms[platform]) continue;
-
-      const tokenDetails = coin.platforms[platform];
-      if (!tokenDetails) continue;
-
-      const id = params.createTokenAssetId({
-        parentAssetId: platform,
-        assetId: coin.id,
-        version: coin.version,
-      });
-
-      if (idSet.has(id)) {
-        duplicateIdList.push(id);
-      } else {
-        idSet.add(id);
-      }
-    }
-  }
-
-  if (duplicateIdList.length > 0) {
-    throw new Error(
-      `Duplicate ids found in list: ${duplicateIdList.join(',')}`,
-    );
-  }
-};
-
 const getAddedContracts = (params: {
   addedContracts: string[];
   coingeckoCoinMap: Record<string, TokenListItem | undefined>;
@@ -257,6 +158,8 @@ export const getTokenDifference = async (
   params: TokenAutomationParams,
   dontSaveToFile?: boolean,
 ) => {
+  assertTokenAutomationParams(params);
+
   const coingeckoCoinMap = createContractMapFromCoingeckoList(
     await getCoingeckoCoinList(),
     params,

packages/automation-scripts/src/tokens/index.ts

@@ -2,3 +2,4 @@ export * from './diff';
 export * from './createNewList';
 export * from './downloadImages';
 export * from './types';
+export * from './coingecko';

packages/automation-scripts/tests/01.tokenDiff.ts

@@ -0,0 +1,37 @@
+import { describe, expect, test } from '@jest/globals';
+
+import * as coingeckoMocks from '../src/__mocks__/coingecko';
+
+import { getTokenDifference } from '../src';
+import testCases from './__fixtures__/01.tokenDiff';
+
+describe('getTokenDifference', () => {
+  beforeAll(() => {
+    coingeckoMocks.getCoingeckoCoinList.mockReturnValueOnce(
+      Promise.resolve([]),
+    );
+    coingeckoMocks.getCoingeckoCoinDetails.mockReturnValueOnce(
+      Promise.resolve({} as any),
+    );
+  });
+
+  describe('should throw error with invalid params', () => {
+    testCases.invalid.forEach(testCase => {
+      test(testCase.name, async () => {
+        await expect(getTokenDifference(testCase.params)).rejects.toThrow(
+          'AssertionError',
+        );
+      });
+    });
+  });
+
+  describe('should return correct response', () => {
+    testCases.invalid.forEach(testCase => {
+      test(testCase.name, async () => {
+        await expect(getTokenDifference(testCase.params)).rejects.toThrow(
+          'AssertionError',
+        );
+      });
+    });
+  });
+});

packages/automation-scripts/tests/__fixtures__/01.tokenDiff/index.ts

@@ -0,0 +1,9 @@
+import { invalid } from './invalid';
+import { valid } from './valid';
+
+const testCases = {
+  invalid,
+  valid,
+};
+
+export default testCases;