feat(statics): add tao token support

TICKET: WIN-6424

Author: hitansh-madan

modules/statics/src/account.ts

@@ -135,6 +135,10 @@ export interface AptCoinConstructorOptions extends AccountConstructorOptions {
   assetId: string;
 }
 
+export interface TaoCoinConstructorOptions extends AccountConstructorOptions {
+  subnetId: string;
+}
+
 type FiatCoinName = `fiat${string}` | `tfiat${string}`;
 export interface FiatCoinConstructorOptions extends AccountConstructorOptions {
   name: FiatCoinName;
@@ -654,6 +658,20 @@ export class CosmosChainToken extends AccountCoinToken {
   }
 }
 
+/**
+ * The Bittensor network supports tokens
+ * The token name is determined by the subnetId on chain.
+ */
+export class TaoCoin extends AccountCoinToken {
+  public subnetId: string;
+  constructor(options: TaoCoinConstructorOptions) {
+    super({
+      ...options,
+    });
+    this.subnetId = options.subnetId;
+  }
+}
+
 /**
  * Factory function for account coin instances.
  *
@@ -3299,3 +3317,94 @@ export function cosmosToken(
     })
   );
 }
+
+/**
+ * Factory function for tao token instances.
+ *
+ * @param id uuid v4
+ * @param name unique identifier of the token
+ * @param fullName Complete human-readable name of the token
+ * @param decimalPlaces Number of decimal places this token supports (divisibility exponent)
+ * @param subnetId Contract address of this token formed with `packageId::module::symbol`
+ * @param asset Asset which this coin represents. This is the same for both mainnet and testnet variants of a coin.
+ * @param features? Features of this coin. Defaults to the DEFAULT_FEATURES
+ * @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 TAO main network.
+ * @param primaryKeyCurve The elliptic curve for this chain/token
+ */
+export function taoToken(
+  id: string,
+  name: string,
+  fullName: string,
+  decimalPlaces: number,
+  subnetId: string,
+  asset: UnderlyingAsset,
+  features: CoinFeature[] = AccountCoin.DEFAULT_FEATURES,
+  prefix = '',
+  suffix: string = name.toUpperCase(),
+  network: AccountNetwork = Networks.main.tao,
+  primaryKeyCurve: KeyCurve = KeyCurve.Ed25519
+): Readonly<TaoCoin> {
+  return Object.freeze(
+    new TaoCoin({
+      id,
+      name,
+      fullName,
+      network,
+      subnetId,
+      prefix,
+      suffix,
+      features,
+      decimalPlaces,
+      asset,
+      isToken: true,
+      primaryKeyCurve,
+      baseUnit: BaseUnit.TAO,
+    })
+  );
+}
+
+/**
+ * Factory function for testnet tao token instances.
+ *
+ * @param id uuid v4
+ * @param name unique identifier of the token
+ * @param fullName Complete human-readable name of the token
+ * @param decimalPlaces Number of decimal places this token supports (divisibility exponent)
+ * @param subnetId Contract address of this token formed with `packageId::module::symbol`
+ * @param asset Asset which this coin represents. This is the same for both mainnet and testnet variants of a coin.
+ * @param features? Features of this coin. Defaults to the DEFAULT_FEATURES
+ * @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 TAO test network.
+ * @param primaryKeyCurve The elliptic curve for this chain/token
+ */
+
+export function ttaoToken(
+  id: string,
+  name: string,
+  fullName: string,
+  decimalPlaces: number,
+  subnetId: string,
+  asset: UnderlyingAsset,
+  features: CoinFeature[] = AccountCoin.DEFAULT_FEATURES,
+  prefix = '',
+  suffix: string = name.toUpperCase(),
+  network: AccountNetwork = Networks.test.tao,
+  primaryKeyCurve: KeyCurve = KeyCurve.Ed25519
+): Readonly<TaoCoin> {
+  return taoToken(
+    id,
+    name,
+    fullName,
+    decimalPlaces,
+    subnetId,
+    asset,
+    features,
+    prefix,
+    suffix,
+    network,
+    primaryKeyCurve
+  );
+}

modules/statics/src/base.ts

@@ -2873,6 +2873,9 @@ export enum UnderlyingAsset {
   'tstx:tsip6dp' = 'tstx:tsip6dp',
   'tstx:tsip8dp' = 'tstx:tsip8dp',
 
+  // TAO testnet tokens
+  'ttao:apex' = 'ttao:apex',
+
   // Hbar tokens
   'hbar:karate' = 'hbar:karate',
   'hbar:sauce' = 'hbar:sauce',

modules/statics/src/coinFeatures.ts

@@ -526,8 +526,11 @@ export const TAO_FEATURES = [
   CoinFeature.TSS,
   CoinFeature.TSS_COLD,
   CoinFeature.STAKING,
+  CoinFeature.SUPPORTS_TOKENS,
 ];
 
+export const TAO_TOKEN_FEATURES = [...ACCOUNT_COIN_DEFAULT_FEATURES, CoinFeature.TSS, CoinFeature.TSS_COLD];
+
 export const SONEIUM_FEATURES = [
   ...ETH_FEATURES,
   CoinFeature.TSS,

modules/statics/src/coins.ts

@@ -31,6 +31,7 @@ import {
   vetToken,
   cosmosToken,
   talgoToken,
+  taoToken,
   taptNFTCollection,
   taptToken,
   tarbethErc20,
@@ -44,6 +45,7 @@ import {
   tronToken,
   tstellarToken,
   tsuiToken,
+  ttaoToken,
   ttronToken,
   txrpToken,
   tworldErc20,
@@ -112,6 +114,7 @@ import {
   SUI_TOKEN_FEATURES,
   SUI_TOKEN_FEATURES_STAKING,
   TAO_FEATURES,
+  TAO_TOKEN_FEATURES,
   TIA_FEATURES,
   TOKEN_FEATURES_WITH_FRANKFURT,
   TON_FEATURES,
@@ -3957,6 +3960,15 @@ export const coins = CoinMap.fromCoins([
     UnderlyingAsset['tsui:wal'],
     SUI_TOKEN_FEATURES_STAKING
   ),
+  ttaoToken(
+    'b8b5fded-65f8-49eb-8f83-ad97d08d07f2',
+    'ttao:apex',
+    'Apex',
+    9,
+    '1',
+    UnderlyingAsset['ttao:apex'],
+    TAO_TOKEN_FEATURES
+  ),
   aptToken(
     'e8bfdab3-4ef6-4b39-9450-d9cb59593f7a',
     'apt:usdt',
@@ -4129,6 +4141,7 @@ export function createToken(token: AmsTokenConfig): Readonly<BaseCoin> | undefin
     sol: solToken,
     stx: sip10Token,
     sui: suiToken,
+    tao: taoToken,
     trx: tronToken,
     vet: vetToken,
     xlm: stellarToken,
@@ -4244,6 +4257,13 @@ export function createToken(token: AmsTokenConfig): Readonly<BaseCoin> | undefin
         ...commonArgs.slice(4) // asset, features, prefix, suffix, network, primaryKeyCurve
       );
 
+    case 'tao':
+      return initializer(
+        ...commonArgs.slice(0, 4), // id, name, fullName, decimalPlaces
+        token.subnetId, // subnetId
+        ...commonArgs.slice(4) // asset, features, prefix, suffix, network, primaryKeyCurve
+      );
+
     case 'xlm':
       return initializer(
         ...commonArgs.slice(0, 5), // id, name, fullName, decimalPlaces, asset

modules/statics/src/index.ts

@@ -21,6 +21,7 @@ export {
   HederaToken,
   TronErc20Coin,
   SuiCoin,
+  TaoCoin,
   XrpCoin,
   AptCoin,
   AptNFTCollection,

modules/statics/src/networkFeatureMapForTokens.ts

@@ -7,6 +7,7 @@ import {
   SOL_TOKEN_FEATURES,
   STX_TOKEN_FEATURES,
   SUI_TOKEN_FEATURES,
+  TAO_TOKEN_FEATURES,
 } from './coinFeatures';
 import { OfcCoin } from './ofc';
 
@@ -26,6 +27,7 @@ export const networkFeatureMapForTokens: Partial<Record<CoinFamily, CoinFeature[
   sol: SOL_TOKEN_FEATURES,
   stx: STX_TOKEN_FEATURES,
   sui: SUI_TOKEN_FEATURES,
+  tao: TAO_TOKEN_FEATURES,
   trx: AccountCoin.DEFAULT_FEATURES,
   xlm: AccountCoin.DEFAULT_FEATURES,
   xrp: AccountCoin.DEFAULT_FEATURES,

modules/statics/src/tokenConfig.ts

@@ -22,6 +22,7 @@ import {
   SolCoin,
   StellarCoin,
   SuiCoin,
+  TaoCoin,
   TronErc20Coin,
   VetToken,
   WorldERC20Token,
@@ -110,6 +111,10 @@ export type Sip10TokenConfig = BaseNetworkConfig & {
   assetId: string;
 };
 
+export type TaoTokenConfig = BaseNetworkConfig & {
+  subnetId: string;
+};
+
 export type Nep141TokenConfig = BaseNetworkConfig & {
   contractAddress: string;
   storageDepositAmount: string;
@@ -143,7 +148,8 @@ export type TokenConfig =
   | Sip10TokenConfig
   | Nep141TokenConfig
   | CosmosTokenConfig
-  | VetTokenConfig;
+  | VetTokenConfig
+  | TaoTokenConfig;
 
 export interface Tokens {
   bitcoin: {
@@ -210,6 +216,9 @@ export interface Tokens {
     sui: {
       tokens: SuiTokenConfig[];
     };
+    tao: {
+      tokens: TaoTokenConfig[];
+    };
     bera: {
       tokens: EthLikeTokenConfig[];
     };
@@ -288,6 +297,9 @@ export interface Tokens {
     sui: {
       tokens: SuiTokenConfig[];
     };
+    tao: {
+      tokens: TaoTokenConfig[];
+    };
     bera: {
       tokens: EthLikeTokenConfig[];
     };
@@ -345,6 +357,7 @@ export interface AmsTokenConfig {
   isToken: boolean;
   baseUnit?: string;
   kind?: string;
+  subnetId?: string;
 }
 
 export interface TrimmedAmsNetworkConfig {
@@ -800,6 +813,24 @@ const getFormattedSuiTokens = (customCoinMap = coins) =>
     return acc;
   }, []);
 
+function getTaoTokenConfig(coin: TaoCoin): TaoTokenConfig {
+  return {
+    type: coin.name,
+    coin: coin.network.type === NetworkType.MAINNET ? 'tao' : 'ttao',
+    network: coin.network.type === NetworkType.MAINNET ? 'Mainnet' : 'Testnet',
+    name: coin.fullName,
+    decimalPlaces: coin.decimalPlaces,
+    subnetId: coin.subnetId,
+  };
+}
+const getFormattedTaoTokens = (customCoinMap = coins) =>
+  customCoinMap.reduce((acc: TaoTokenConfig[], coin) => {
+    if (coin instanceof TaoCoin) {
+      acc.push(getTaoTokenConfig(coin));
+    }
+    return acc;
+  }, []);
+
 function getAptTokenConfig(coin: AptCoin): AptTokenConfig {
   return {
     type: coin.name,
@@ -974,6 +1005,9 @@ export const getFormattedTokens = (coinMap = coins): Tokens => {
       sui: {
         tokens: getFormattedSuiTokens(coinMap).filter((token) => token.network === 'Mainnet'),
       },
+      tao: {
+        tokens: getFormattedTaoTokens(coinMap).filter((token) => token.network === 'Mainnet'),
+      },
       bera: {
         tokens: getFormattedBeraTokens(coinMap).filter((token) => token.network === 'Mainnet'),
       },
@@ -1062,6 +1096,9 @@ export const getFormattedTokens = (coinMap = coins): Tokens => {
       sui: {
         tokens: getFormattedSuiTokens(coinMap).filter((token) => token.network === 'Testnet'),
       },
+      tao: {
+        tokens: getFormattedTaoTokens(coinMap).filter((token) => token.network === 'Testnet'),
+      },
       bera: {
         tokens: getFormattedBeraTokens(coinMap).filter((token) => token.network === 'Testnet'),
       },
@@ -1176,6 +1213,8 @@ export function getFormattedTokenConfigForCoin(coin: Readonly<BaseCoin>): TokenC
     return getXrpTokenConfig(coin);
   } else if (coin instanceof SuiCoin) {
     return getSuiTokenConfig(coin);
+  } else if (coin instanceof TaoCoin) {
+    return getTaoTokenConfig(coin);
   } else if (coin instanceof AptCoin) {
     return getAptTokenConfig(coin);
   } else if (coin instanceof AptNFTCollection) {