Merge pull request #6853 from BitGo/WIN-6977-add-a-helper-method-to-create-a-base-coin-from-trimmed-config-details-of-a-single-token

feat(statics): add method to create base coin from trimmed token details

Author: veetragjain

modules/statics/src/coins.ts

@@ -372,3 +372,29 @@ export function createTokenMapUsingTrimmedConfigDetails(
 
   return createTokenMapUsingConfigDetails(amsTokenConfigMap);
 }
+
+export function createTokenUsingTrimmedConfigDetails(
+  tokenConfig: TrimmedAmsTokenConfig
+): Readonly<BaseCoin> | undefined {
+  let fullTokenConfig: AmsTokenConfig | undefined;
+  const networkNameMap = new Map(
+    Object.values(Networks).flatMap((networkType) =>
+      Object.values(networkType).map((network) => [network.name, network])
+    )
+  );
+  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));
+    fullTokenConfig = { ...tokenConfig, features: Array.from(features), network } as AmsTokenConfig;
+    return createToken(fullTokenConfig);
+  }
+}

modules/statics/test/unit/coins.ts

@@ -9,6 +9,7 @@ import {
   createToken,
   createTokenMapUsingConfigDetails,
   createTokenMapUsingTrimmedConfigDetails,
+  createTokenUsingTrimmedConfigDetails,
   EosCoin,
   Erc20Coin,
   EthereumNetwork,
@@ -1165,6 +1166,7 @@ describe('create token map using config details', () => {
       JSON.stringify(tokenNetwork).should.eql(JSON.stringify(staticNetwork));
     });
   });
+
   it('should give precedence to static coin map over ams coin map', () => {
     const tokenMap = createTokenMapUsingConfigDetails(incorrectAmsTokenConfig);
     const tokenName = 'thbar:usdc';
@@ -1174,6 +1176,7 @@ describe('create token map using config details', () => {
     token.decimalPlaces.should.not.eql(incorrectAmsTokenConfig[tokenName][0].decimalPlaces);
     token.baseUnit.should.not.eql(incorrectAmsTokenConfig[tokenName][0].baseUnit);
   });
+
   it('should create a coin map and get formatted tokens from it', () => {
     const coinMap = createTokenMapUsingConfigDetails(amsTokenConfigWithCustomToken);
     const formattedTokens = getFormattedTokens(coinMap);
@@ -1182,10 +1185,12 @@ describe('create token map using config details', () => {
     formattedTokens.testnet.eth.tokens.some((token) => token.type === 'hteth:faketoken').should.eql(true);
     formattedTokens.testnet.ofc.tokens.some((token) => token.type === 'ofcterc2').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');
@@ -1202,6 +1207,7 @@ describe('create token map using config details', () => {
     JSON.stringify(tokenNetwork1).should.eql(JSON.stringify(tokenNetwork2));
     JSON.stringify(tokenNetwork3).should.eql(JSON.stringify(tokenNetwork4));
   });
+
   it('should be able to add single ams token into coin map', () => {
     const coinMap = CoinMap.fromCoins([]);
     const staticsCoin = createToken(amsTokenConfigWithCustomToken['hteth:faketoken'][0]);
@@ -1210,6 +1216,7 @@ describe('create token map using config details', () => {
     }
     coinMap.has('hteth:faketoken').should.be.true();
   });
+
   it('should be able to create token config of a single base coin', () => {
     const tokenName = 'hteth:faketoken';
     const coinMap = createTokenMapUsingTrimmedConfigDetails(reducedAmsTokenConfig);
@@ -1225,14 +1232,27 @@ describe('create token map using config details', () => {
       decimalPlaces: amsTokenConfig.decimalPlaces,
       tokenContractAddress: amsTokenConfig.contractAddress.toLowerCase(),
     });
-    it('should return the base coin present in default coin map', () => {
-      const tokenName = 'thbar:usdc';
-      const token = createToken(incorrectAmsTokenConfig[tokenName][0]);
-      token?.should.not.be.undefined();
-      token?.decimalPlaces.should.eql(coins.get(tokenName).decimalPlaces);
-      token?.baseUnit.should.eql(coins.get(tokenName).baseUnit);
-      token?.decimalPlaces.should.not.eql(incorrectAmsTokenConfig[tokenName][0].decimalPlaces);
-      token?.baseUnit.should.not.eql(incorrectAmsTokenConfig[tokenName][0].baseUnit);
-    });
+  });
+
+  it('should return the base coin present in default coin map', () => {
+    const tokenName = 'thbar:usdc';
+    const token = createToken(incorrectAmsTokenConfig[tokenName][0]);
+    token?.should.not.be.undefined();
+    token?.decimalPlaces.should.eql(coins.get(tokenName).decimalPlaces);
+    token?.baseUnit.should.eql(coins.get(tokenName).baseUnit);
+    token?.decimalPlaces.should.not.eql(incorrectAmsTokenConfig[tokenName][0].decimalPlaces);
+    token?.baseUnit.should.not.eql(incorrectAmsTokenConfig[tokenName][0].baseUnit);
+  });
+
+  it('should be able to create base coin from trimmed token config', () => {
+    const tokenName = 'hteth:faketoken';
+    const reducedTokenConfig = reducedAmsTokenConfig[tokenName][0];
+    const token = createTokenUsingTrimmedConfigDetails(reducedTokenConfig);
+    token?.should.not.be.undefined();
+    token?.name.should.eql(reducedTokenConfig.name);
+    token?.decimalPlaces.should.eql(reducedTokenConfig.decimalPlaces);
+    const bgerchToken = coins.get('bgerch');
+    const bgerchNetwork = bgerchToken?.network;
+    JSON.stringify(bgerchNetwork).should.eql(JSON.stringify(token?.network));
   });
 });