Merge pull request #6039 from BitGo/WIN-5303-write-a-function-to-convert-trimmed-ams-response-to-coin-map

feat(statics): add method to create coin map from trimmed ams response

Author: veetragjain

modules/statics/src/coins.ts

@@ -47,14 +47,15 @@ import {
 import { ada } from './ada';
 import { avaxp } from './avaxp';
 import { BaseCoin, BaseUnit, CoinFeature, KeyCurve, UnderlyingAsset } from './base';
-import { AmsTokenConfig } from './tokenConfig';
+import { AmsTokenConfig, TrimmedAmsTokenConfig } from './tokenConfig';
 import { erc20Coins } from './coins/erc20Coins';
 import { avaxTokens } from './coins/avaxTokens';
 import { bscTokens } from './coins/bscTokens';
 import { polygonTokens } from './coins/polygonTokens';
 import { solTokens } from './coins/solTokens';
 import { CoinMap } from './map';
 import { Networks } from './networks';
+import { networkFeatureMapForTokens } from './networkFeatureMapForTokens';
 import { utxoCoins } from './utxo';
 import { lightningCoins } from './lightning';
 import { ofcErc20Coins, tOfcErc20Coins } from './coins/ofcErc20Coins';
@@ -3289,6 +3290,25 @@ function getAptTokenInitializer(token: AmsTokenConfig) {
   };
 }
 
+export function isCoinPresentInCoinMap({
+  name,
+  id,
+  contractAddress,
+  alias,
+}: {
+  name: string;
+  id?: string;
+  contractAddress?: string;
+  alias?: string;
+}): boolean {
+  return Boolean(
+    coins.has(name) ||
+      (id && coins.has(id)) ||
+      (contractAddress && coins.has(contractAddress)) ||
+      (alias && coins.has(alias))
+  );
+}
+
 export function createTokenMapUsingConfigDetails(tokenConfigMap: Record<string, AmsTokenConfig[]>): CoinMap {
   const BaseCoins: Map<string, Readonly<BaseCoin>> = new Map();
   const initializerMap: Record<string, unknown> = {
@@ -3341,9 +3361,12 @@ export function createTokenMapUsingConfigDetails(tokenConfigMap: Record<string,
   for (const tokenConfigs of Object.values(tokenConfigMap)) {
     const tokenConfig = tokenConfigs[0];
     const family = tokenConfig.family;
-    const name = tokenConfig.name;
 
-    if (!coins.has(name) && tokenConfig.isToken && !nftAndOtherTokens.has(tokenConfig.name)) {
+    if (
+      !isCoinPresentInCoinMap({ ...tokenConfig }) &&
+      tokenConfig.isToken &&
+      !nftAndOtherTokens.has(tokenConfig.name)
+    ) {
       const token = createToken(family, tokenConfig, initializerMap);
       if (token) {
         BaseCoins.set(token.name, token);
@@ -3353,3 +3376,34 @@ export function createTokenMapUsingConfigDetails(tokenConfigMap: Record<string,
 
   return CoinMap.fromCoins(Array.from(BaseCoins.values()));
 }
+
+export function createTokenMapUsingTrimmedConfigDetails(
+  reducedTokenConfigMap: Record<string, TrimmedAmsTokenConfig[]>
+): CoinMap {
+  const amsTokenConfigMap: Record<string, AmsTokenConfig[]> = {};
+  const networkNameMap = new Map(
+    Object.values(Networks).flatMap((networkType) =>
+      Object.values(networkType).map((network) => [network.name, network])
+    )
+  );
+
+  for (const tokenConfigs of Object.values(reducedTokenConfigMap)) {
+    const tokenConfig = tokenConfigs[0];
+    const network = networkNameMap.get(tokenConfig.network.name);
+    if (
+      !isCoinPresentInCoinMap({ ...tokenConfig }) &&
+      network &&
+      tokenConfig.isToken &&
+      networkFeatureMapForTokens[network.family]
+    ) {
+      const features = new Set([
+        ...(networkFeatureMapForTokens[network.family] || []),
+        ...(tokenConfig.additionalFeatures || []),
+      ]);
+      tokenConfig.excludedFeatures?.forEach((feature) => features.delete(feature));
+      amsTokenConfigMap[tokenConfig.name] = [{ ...tokenConfig, features: Array.from(features), network }];
+    }
+  }
+
+  return createTokenMapUsingConfigDetails(amsTokenConfigMap);
+}

modules/statics/src/tokenConfig.ts

@@ -261,6 +261,15 @@ export interface AmsTokenConfig {
   isToken: boolean;
 }
 
+export interface TrimmedAmsNetworkConfig {
+  name: string;
+}
+export interface TrimmedAmsTokenConfig extends Omit<AmsTokenConfig, 'features' | 'network'> {
+  network: TrimmedAmsNetworkConfig;
+  excludedFeatures?: string[];
+  additionalFeatures?: string[];
+}
+
 // Get the list of ERC-20 tokens from statics and format it properly
 const getFormattedErc20Tokens = (customCoinMap = coins) =>
   customCoinMap.reduce((acc: Erc20TokenConfig[], coin) => {

modules/statics/test/unit/coins.ts

@@ -20,10 +20,17 @@ import {
   tokens,
   getFormattedTokens,
   createTokenMapUsingConfigDetails,
+  createTokenMapUsingTrimmedConfigDetails,
 } from '../../src';
 import { utxo } from '../../src/utxo';
 import { expectedColdFeatures } from './fixtures/expectedColdFeatures';
-import { amsTokenConfig, amsTokenConfigWithCustomToken, incorrectAmsTokenConfig } from './resources/amsTokenConfig';
+import {
+  amsTokenConfig,
+  amsTokenConfigWithCustomToken,
+  incorrectAmsTokenConfig,
+  reducedAmsTokenConfig,
+  amsTokenWithUnsupportedNetwork,
+} from './resources/amsTokenConfig';
 
 interface DuplicateCoinObject {
   name: string;
@@ -958,4 +965,18 @@ describe('create token map using config details', () => {
     formattedTokens.testnet.eth.should.not.deepEqual(tokens.testnet.eth);
     formattedTokens.testnet.eth.tokens.some((token) => token.type === 'hteth:faketoken').should.eql(true);
   });
+  it('should not create an base coin object in coin map for token with unsupported network', () => {
+    const tokenMap = createTokenMapUsingTrimmedConfigDetails(amsTokenWithUnsupportedNetwork);
+    tokenMap.has('hteth:faketoken').should.eql(false);
+  });
+  it('should create a coin map using reduced token config details', () => {
+    const coinMap1 = createTokenMapUsingTrimmedConfigDetails(reducedAmsTokenConfig);
+    const amsToken1 = coinMap1.get('hteth:faketoken');
+    const coinMap2 = createTokenMapUsingConfigDetails(amsTokenConfigWithCustomToken);
+    const amsToken2 = coinMap2.get('hteth:faketoken');
+    const { network: tokenNetwork1, ...tokenRest1 } = amsToken1;
+    const { network: tokenNetwork2, ...tokenRest2 } = amsToken2;
+    tokenRest1.should.deepEqual(tokenRest2);
+    JSON.stringify(tokenNetwork1).should.eql(JSON.stringify(tokenNetwork2));
+  });
 });

modules/statics/test/unit/resources/amsTokenConfig.ts

@@ -629,9 +629,9 @@ export const amsTokenConfigWithCustomToken = {
         'custody-bitgo-mena-fze',
         'custody-bitgo-custody-mena-fze',
         'custody-bitgo-singapore',
-        'custody-bitgo-korea',
         'custody-bitgo-europe-aps',
         'custody-bitgo-frankfurt',
+        'bulk-transaction',
       ],
       decimalPlaces: 6,
       asset: 'hteth:faketoken',
@@ -643,7 +643,7 @@ export const amsTokenConfigWithCustomToken = {
         accountExplorerUrl: 'https://holesky.etherscan.io/address/',
         blockExplorerUrl: 'https://holesky.etherscan.io/block/',
         chainId: 17000,
-        batcherContractAddress: '0xb1b7e7cc1ecafbfd0771a5eb5454ab5b0356980d',
+        batcherContractAddress: '0x3e1e5d78e44f15593b3b61ed278f12c27f0ff33e',
         forwarderFactoryAddress: '0xffa397285ce46fb78c588a9e993286aac68c37cd',
         forwarderImplementationAddress: '0x059ffafdc6ef594230de44f824e2bd0a51ca5ded',
         nativeCoinOperationHashPrefix: 'ETHER',
@@ -697,3 +697,53 @@ export const incorrectAmsTokenConfig = {
     },
   ],
 };
+
+export const reducedAmsTokenConfig = {
+  'hteth:faketoken': [
+    {
+      id: '49ff49ea-3355-4717-bbb0-5e8f5cae2201',
+      fullName: 'Holesky Testnet fake token',
+      name: 'hteth:faketoken',
+      prefix: '',
+      suffix: 'HTETH:FAKETOKEN',
+      baseUnit: 'wei',
+      kind: 'crypto',
+      family: 'eth',
+      isToken: true,
+      additionalFeatures: ['bulk-transaction'],
+      excludedFeatures: ['custody-bitgo-korea'],
+      decimalPlaces: 6,
+      asset: 'hteth:faketoken',
+      network: {
+        name: 'Holesky',
+      },
+      primaryKeyCurve: 'secp256k1',
+      contractAddress: '0x89a959b9184b4f8c8633646d5dfd049d2ebc983a',
+    },
+  ],
+};
+
+export const amsTokenWithUnsupportedNetwork = {
+  'hteth:faketoken': [
+    {
+      id: '49ff49ea-3355-4717-bbb0-5e8f5cae2201',
+      fullName: 'Holesky Testnet fake token',
+      name: 'hteth:faketoken',
+      prefix: '',
+      suffix: 'HTETH:FAKETOKEN',
+      baseUnit: 'wei',
+      kind: 'crypto',
+      family: 'eth',
+      isToken: true,
+      additionalFeatures: ['bulk-transaction'],
+      excludedFeatures: ['custody-bitgo-korea'],
+      decimalPlaces: 6,
+      asset: 'hteth:faketoken',
+      network: {
+        name: 'FakeNetwork',
+      },
+      primaryKeyCurve: 'secp256k1',
+      contractAddress: '0x89a959b9184b4f8c8633646d5dfd049d2ebc983a',
+    },
+  ],
+};