Merge pull request #6830 from BitGo/WIN-6446-ada-token-support

feat(sdk-coin-ada): add support for tokens

Author: Ranjna-G

modules/statics/src/account.ts

@@ -1864,17 +1864,18 @@ export function tsolToken(
 }
 
 /**
- * Factory function for ada token instances.
+ * Factory function for prod cardano token instances.
  *
  * @param id uuid v4
- * @param name unique identifier of the token
+ * @param name Name of the token
  * @param fullName Complete human-readable name of the token
  * @param decimalPlaces Number of decimal places this token supports (divisibility exponent)
- * @param tokenSymbol Token symbol of this token
+ * @param policyId Policy Id
+ * @param assetName Asset name -> Policy ID + Asset name is the unique identifier
  * @param asset Asset which this coin represents. This is the same for both mainnet and testnet variants of a coin.
  * @param prefix? Optional token prefix. Defaults to empty string
  * @param suffix? Optional token suffix. Defaults to token name.
- * @param network? Optional token network. Defaults to Cardano main network.
+ * @param network? Optional token network. Defaults to the testnet Cardano network.
  * @param features? Features of this coin. Defaults to the DEFAULT_FEATURES and REQUIRES_RESERVE defined in `AccountCoin`
  * @param primaryKeyCurve The elliptic curve for this chain/token
  */
@@ -1916,10 +1917,11 @@ export function adaToken(
  * Factory function for testnet cardano token instances.
  *
  * @param id uuid v4
- * @param name unique identifier of the token
+ * @param name Name of the token
  * @param fullName Complete human-readable name of the token
  * @param decimalPlaces Number of decimal places this token supports (divisibility exponent)
- * @param tokenSymbol Token symbol of this token i.e: AUSD
+ * @param policyId Policy Id
+ * @param assetName Asset name -> Policy ID + Asset name is the unique identifier
  * @param asset Asset which this coin represents. This is the same for both mainnet and testnet variants of a coin.
  * @param prefix? Optional token prefix. Defaults to empty string
  * @param suffix? Optional token suffix. Defaults to token name.
@@ -1935,9 +1937,9 @@ export function tadaToken(
   assetName: string,
   asset: UnderlyingAsset,
   features: CoinFeature[] = [...AccountCoin.DEFAULT_FEATURES, CoinFeature.REQUIRES_RESERVE],
+  network: AccountNetwork = Networks.test.ada,
   prefix = '',
-  suffix: string = name.toUpperCase(),
-  network: AccountNetwork = Networks.test.ada
+  suffix: string = name.toUpperCase()
 ) {
   return adaToken(id, name, fullName, decimalPlaces, policyId, assetName, asset, features, prefix, suffix, network);
 }

modules/statics/src/allCoinsAndTokens.ts

@@ -126,6 +126,7 @@ import {
 } from './coinFeatures';
 import { botTokens } from './coins/botTokens';
 import { botOfcTokens } from './coins/botOfcTokens';
+import { adaTokens } from './coins/adaTokens';
 
 export const allCoinsAndTokens = [
   ...lightningCoins,
@@ -141,6 +142,7 @@ export const allCoinsAndTokens = [
   ...cosmosTokens,
   ...botTokens,
   ...botOfcTokens,
+  ...adaTokens,
   avaxp(
     '5436386e-9e4d-4d82-92df-59d9720d1738',
     'avaxp',

modules/statics/src/base.ts

@@ -3022,6 +3022,9 @@ export enum UnderlyingAsset {
   'eth:neiro2' = 'eth:neiro2',
   'eth:sign' = 'eth:sign',
 
+  // ADA testnet tokens
+  'tada:water' = 'tada:water',
+
   // fiats
   AED = 'aed',
   EUR = 'eur',

modules/statics/src/coinFeatures.ts

@@ -168,7 +168,7 @@ export const HTETH_TOKEN_FEATURES = [
   CoinFeature.EIP1559,
   CoinFeature.WALLET_CONNECT_DEFI,
 ];
-export const ADA_FEATURES = [...Ada.DEFAULT_FEATURES, CoinFeature.BULK_TRANSACTION];
+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 DOT_FEATURES = [
   ...ACCOUNT_COIN_DEFAULT_FEATURES,

modules/statics/src/coins.ts

@@ -24,6 +24,7 @@ import {
   vetNFTCollection,
   vetToken,
   xrpToken,
+  adaToken,
 } from './account';
 import { ofcToken } from './ofc';
 import { BaseCoin } from './base';
@@ -63,6 +64,7 @@ export function createToken(token: AmsTokenConfig): Readonly<BaseCoin> | undefin
     xlm: stellarToken,
     xrp: xrpToken,
     ofc: ofcToken,
+    ada: adaToken,
   };
 
   //return the BaseCoin from default coin map if present

modules/statics/src/coins/adaTokens.ts

@@ -0,0 +1,17 @@
+import { tadaToken, AccountCoin } from '../account';
+import { UnderlyingAsset } from '../base';
+import { Networks } from '../networks';
+
+export const adaTokens = [
+  tadaToken(
+    'a7678172-84b3-4c7e-ac46-9875d23a1cb7',
+    'tada:water',
+    'Test ADA Token',
+    6,
+    '2533cca6eb42076e144e9f2772c390dece9fce173bc38c72294b3924',
+    'WATER',
+    UnderlyingAsset['tada:water'],
+    AccountCoin.DEFAULT_FEATURES,
+    Networks.test.ada
+  ),
+];