Merge pull request #6856 from BitGo/WIN-6446-ada-token-configs

feat(sdk-coin-ada): Add token support config

Author: Ranjna-G

modules/bitgo/test/browser/browser.spec.ts

@@ -14,6 +14,7 @@ describe('Coins', () => {
     const excludedKeys = {
       AbstractUtxoCoin: 1,
       AbstractLightningCoin: 1,
+      AdaToken: 1,
       Erc20Token: 1,
       Erc721Token: 1,
       EthLikeCoin: 1,

modules/sdk-coin-ada/src/adaToken.ts

@@ -1,16 +1,6 @@
 import { Ada } from './ada';
 import { BitGoBase, CoinConstructor, NamedCoinConstructor } from '@bitgo/sdk-core';
-import { coins, tokens } from '@bitgo/statics';
-
-export interface AdaTokenConfig {
-  name: string;
-  type: string;
-  coin: string;
-  network: string;
-  policyId: string;
-  assetName: string;
-  decimalPlaces: number;
-}
+import { coins, tokens, AdaTokenConfig } from '@bitgo/statics';
 
 export class AdaToken extends Ada {
   public readonly tokenConfig: AdaTokenConfig;
@@ -60,6 +50,10 @@ export class AdaToken extends Ada {
     return this.tokenConfig.decimalPlaces;
   }
 
+  get uniqueAssetId() {
+    return this.tokenConfig.uniqueAssetId;
+  }
+
   getChain() {
     return this.tokenConfig.type;
   }

modules/statics/src/account.ts

@@ -112,11 +112,6 @@ export interface SolCoinConstructorOptions extends AccountConstructorOptions {
   programId: string;
 }
 
-export interface AdaCoinConstructorOptions extends AccountConstructorOptions {
-  policyId: string;
-  assetName: string;
-}
-
 export interface XrpCoinConstructorOptions extends AccountConstructorOptions {
   issuerAddress: string;
   currencyCode: string;
@@ -166,6 +161,11 @@ export interface CosmosTokenConstructorOptions extends AccountConstructorOptions
   denom: string;
 }
 
+export interface AdaTokenConstructorOptions extends AccountConstructorOptions {
+  uniqueAssetId: string;
+  policyId: string;
+  assetName: string;
+}
 export interface ContractAddress extends String {
   __contractaddress_phantom__: never;
 }
@@ -413,24 +413,6 @@ export class SolCoin extends AccountCoinToken {
   }
 }
 
-/**
- * The Ada network supports tokens
- * Ada tokens are identified by their policy ID and asset name
- *
- */
-export class AdaCoin extends AccountCoinToken {
-  public policyId: string;
-  public assetName: string;
-  constructor(options: AdaCoinConstructorOptions) {
-    super({
-      ...options,
-    });
-
-    this.policyId = options.policyId;
-    this.assetName = options.assetName;
-  }
-}
-
 export class EthLikeERC20Token extends ContractAddressDefinedToken {
   constructor(options: Erc20ConstructorOptions) {
     super(options);
@@ -713,6 +695,21 @@ export class PolyxCoin extends AccountCoinToken {
   }
 }
 
+export class AdaToken extends AccountCoinToken {
+  public uniqueAssetId: string;
+  public policyId: string;
+  public assetName: string;
+  constructor(options: AdaTokenConstructorOptions) {
+    super({
+      ...options,
+    });
+
+    this.uniqueAssetId = options.uniqueAssetId;
+    this.policyId = options.policyId;
+    this.assetName = options.assetName;
+  }
+}
+
 /**
  * Factory function for account coin instances.
  *
@@ -1886,15 +1883,17 @@ export function adaToken(
   decimalPlaces: number,
   policyId: string,
   assetName: string,
+  encodedAssetName: string,
   asset: UnderlyingAsset,
   features: CoinFeature[] = [...AccountCoin.DEFAULT_FEATURES, CoinFeature.REQUIRES_RESERVE],
   prefix = '',
   suffix: string = name.toUpperCase(),
   network: AccountNetwork = Networks.main.ada,
   primaryKeyCurve: KeyCurve = KeyCurve.Ed25519
 ) {
+  const uniqueAssetId = `${policyId}${encodedAssetName}`;
   return Object.freeze(
-    new AdaCoin({
+    new AdaToken({
       id,
       name,
       fullName,
@@ -1909,6 +1908,7 @@ export function adaToken(
       isToken: true,
       primaryKeyCurve,
       baseUnit: BaseUnit.ADA,
+      uniqueAssetId,
     })
   );
 }
@@ -1935,13 +1935,27 @@ export function tadaToken(
   decimalPlaces: number,
   policyId: string,
   assetName: string,
+  encodedAssetName: string,
   asset: UnderlyingAsset,
   features: CoinFeature[] = [...AccountCoin.DEFAULT_FEATURES, CoinFeature.REQUIRES_RESERVE],
   network: AccountNetwork = Networks.test.ada,
   prefix = '',
   suffix: string = name.toUpperCase()
 ) {
-  return adaToken(id, name, fullName, decimalPlaces, policyId, assetName, asset, features, prefix, suffix, network);
+  return adaToken(
+    id,
+    name,
+    fullName,
+    decimalPlaces,
+    policyId,
+    assetName,
+    encodedAssetName,
+    asset,
+    features,
+    prefix,
+    suffix,
+    network
+  );
 }
 
 /**

modules/statics/src/coinFeatures.ts

@@ -170,6 +170,13 @@ export const HTETH_TOKEN_FEATURES = [
 ];
 export const ADA_FEATURES = [...Ada.DEFAULT_FEATURES, CoinFeature.BULK_TRANSACTION, CoinFeature.SUPPORTS_TOKENS];
 export const ADA_FEATURES_WITH_FRANKFURT = [...ADA_FEATURES, CoinFeature.CUSTODY_BITGO_FRANKFURT];
+export const ADA_TOKEN_FEATURES = [
+  ...ACCOUNT_COIN_DEFAULT_FEATURES,
+  CoinFeature.BULK_TRANSACTION,
+  CoinFeature.TSS,
+  CoinFeature.TSS_COLD,
+  CoinFeature.STAKING,
+];
 export const DOT_FEATURES = [
   ...ACCOUNT_COIN_DEFAULT_FEATURES,
   CoinFeature.TSS,

modules/statics/src/coins.ts

@@ -255,6 +255,14 @@ export function createToken(token: AmsTokenConfig): Readonly<BaseCoin> | undefin
         ...commonArgs.slice(4, 8), // asset, features, prefix, suffix
         token.primaryKeyCurve // primaryKeyCurve
       );
+    case 'ada':
+      return initializer(
+        ...commonArgs.slice(0, 4), // id, name, fullName, decimalPlaces
+        token.uniqueAssetId,
+        token.assetName,
+        token.policyId,
+        ...commonArgs.slice(4) // asset, features, prefix, suffix, network, primaryKeyCurve
+      );
     default:
       return undefined;
   }

modules/statics/src/coins/adaTokens.ts

@@ -1,5 +1,6 @@
-import { tadaToken, AccountCoin } from '../account';
+import { tadaToken } from '../account';
 import { UnderlyingAsset } from '../base';
+import { ADA_TOKEN_FEATURES } from '../coinFeatures';
 import { Networks } from '../networks';
 
 export const adaTokens = [
@@ -10,8 +11,9 @@ export const adaTokens = [
     6,
     '2533cca6eb42076e144e9f2772c390dece9fce173bc38c72294b3924',
     'WATER',
+    '5741544552',
     UnderlyingAsset['tada:water'],
-    AccountCoin.DEFAULT_FEATURES,
+    ADA_TOKEN_FEATURES,
     Networks.test.ada
   ),
 ];

modules/statics/src/index.ts

@@ -31,6 +31,7 @@ export {
   VetToken,
   VetNFTCollection,
   CosmosChainToken,
+  AdaToken,
 } from './account';
 export { CoinMap } from './map';
 export { networkFeatureMapForTokens } from './networkFeatureMapForTokens';

modules/statics/src/networkFeatureMapForTokens.ts

@@ -1,6 +1,7 @@
 import { AccountCoin } from './account';
 import { CoinFamily, CoinFeature } from './base';
 import {
+  ADA_TOKEN_FEATURES,
   APT_FEATURES,
   BSC_TOKEN_FEATURES,
   POLYGON_TOKEN_FEATURES,
@@ -33,4 +34,5 @@ export const networkFeatureMapForTokens: Partial<Record<CoinFamily, CoinFeature[
   xlm: AccountCoin.DEFAULT_FEATURES,
   xrp: AccountCoin.DEFAULT_FEATURES,
   ofc: [],
+  ada: ADA_TOKEN_FEATURES,
 };

modules/statics/src/tokenConfig.ts

@@ -1,5 +1,4 @@
 import {
-  AdaCoin,
   AlgoCoin,
   AptCoin,
   AptNFTCollection,
@@ -30,6 +29,7 @@ import {
   XrpCoin,
   ZkethERC20Token,
   VetNFTCollection,
+  AdaToken,
 } from './account';
 import { CoinFamily, CoinKind, BaseCoin } from './base';
 import { coins } from './coins';
@@ -70,6 +70,7 @@ export type SolTokenConfig = BaseNetworkConfig & {
 export type AdaTokenConfig = BaseNetworkConfig & {
   policyId: string;
   assetName: string;
+  uniqueAssetId: string;
 };
 
 export type AlgoTokenConfig = BaseNetworkConfig & {
@@ -384,6 +385,9 @@ export interface AmsTokenConfig {
   ticker?: string;
   programId?: string;
   addressCoin?: string;
+  assetName?: string;
+  uniqueAssetId?: string;
+  policyId?: string;
 }
 
 export interface TrimmedAmsNetworkConfig {
@@ -778,7 +782,7 @@ const getFormattedHbarTokens = (customCoinMap = coins) =>
     return acc;
   }, []);
 
-function getAdaTokenConfig(coin: AdaCoin): AdaTokenConfig {
+function getAdaTokenConfig(coin: AdaToken): AdaTokenConfig {
   return {
     type: coin.name,
     coin: coin.network.type === NetworkType.MAINNET ? 'ada' : 'tada',
@@ -787,11 +791,12 @@ function getAdaTokenConfig(coin: AdaCoin): AdaTokenConfig {
     policyId: coin.policyId,
     assetName: coin.assetName,
     decimalPlaces: coin.decimalPlaces,
+    uniqueAssetId: coin.uniqueAssetId,
   };
 }
 const getFormattedAdaTokens = (customCoinMap = coins) =>
   customCoinMap.reduce((acc: AdaTokenConfig[], coin) => {
-    if (coin instanceof AdaCoin) {
+    if (coin instanceof AdaToken) {
       acc.push(getAdaTokenConfig(coin));
     }
     return acc;
@@ -1306,7 +1311,7 @@ export function getFormattedTokenConfigForCoin(coin: Readonly<BaseCoin>): TokenC
     return getSolTokenConfig(coin);
   } else if (coin instanceof HederaToken) {
     return getHbarTokenConfig(coin);
-  } else if (coin instanceof AdaCoin) {
+  } else if (coin instanceof AdaToken) {
     return getAdaTokenConfig(coin);
   } else if (coin instanceof TronErc20Coin) {
     return getTrxTokenConfig(coin);