Merge pull request #6980 from BitGo/COIN-5624

feat: add jetton token standard

Author: MohammedRyaan786

modules/sdk-coin-ton/src/index.ts

@@ -2,3 +2,4 @@ export * from './lib';
 export * from './register';
 export * from './ton';
 export * from './tton';
+export * from './jettonToken';

modules/sdk-coin-ton/src/jettonToken.ts

@@ -0,0 +1,64 @@
+import { BitGoBase, CoinConstructor, NamedCoinConstructor } from '@bitgo/sdk-core';
+import { JettonTokenConfig, coins, tokens } from '@bitgo/statics';
+import { Ton } from './ton';
+
+export class JettonToken extends Ton {
+  public readonly tokenConfig: JettonTokenConfig;
+
+  constructor(bitgo: BitGoBase, tokenConfig: JettonTokenConfig) {
+    const staticsCoin = tokenConfig.network === 'Mainnet' ? coins.get('ton') : coins.get('tton');
+    super(bitgo, staticsCoin);
+    this.tokenConfig = tokenConfig;
+  }
+
+  static createTokenConstructor(config: JettonTokenConfig): CoinConstructor {
+    return (bitgo: BitGoBase) => new JettonToken(bitgo, config);
+  }
+
+  static createTokenConstructors(
+    tokenConfig: JettonTokenConfig[] = [...tokens.bitcoin.ton.tokens, ...tokens.testnet.ton.tokens]
+  ): NamedCoinConstructor[] {
+    const tokensCtors: NamedCoinConstructor[] = [];
+    for (const token of tokenConfig) {
+      const tokenConstructor = JettonToken.createTokenConstructor(token);
+      tokensCtors.push({ name: token.type, coinConstructor: tokenConstructor });
+    }
+    return tokensCtors;
+  }
+
+  get name(): string {
+    return this.tokenConfig.name;
+  }
+
+  get coin(): string {
+    return this.tokenConfig.coin;
+  }
+
+  get network(): string {
+    return this.tokenConfig.network;
+  }
+
+  get contractAddress(): string {
+    return this.tokenConfig.contractAddress;
+  }
+
+  get decimalPlaces(): number {
+    return this.tokenConfig.decimalPlaces;
+  }
+
+  getChain(): string {
+    return this.tokenConfig.type;
+  }
+
+  getBaseChain(): string {
+    return this.coin;
+  }
+
+  getFullName(): string {
+    return 'Ton Token';
+  }
+
+  getBaseFactor(): number {
+    return Math.pow(10, this.tokenConfig.decimalPlaces);
+  }
+}

modules/sdk-coin-ton/src/register.ts

@@ -1,8 +1,12 @@
 import { BitGoBase } from '@bitgo/sdk-core';
 import { Ton } from './ton';
 import { Tton } from './tton';
+import { JettonToken } from './jettonToken';
 
 export const register = (sdk: BitGoBase): void => {
   sdk.register('ton', Ton.createInstance);
   sdk.register('tton', Tton.createInstance);
+  JettonToken.createTokenConstructors().forEach(({ name, coinConstructor }) => {
+    sdk.register(name, coinConstructor);
+  });
 };

modules/statics/src/index.ts

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

modules/statics/src/tokenConfig.ts

@@ -31,6 +31,7 @@ import {
   ZkethERC20Token,
   VetNFTCollection,
   AdaToken,
+  JettonToken,
 } from './account';
 import { CoinFamily, CoinKind, BaseCoin } from './base';
 import { coins } from './coins';
@@ -141,6 +142,10 @@ export type CosmosTokenConfig = BaseNetworkConfig & {
   denom: string;
 };
 
+export type JettonTokenConfig = BaseNetworkConfig & {
+  contractAddress: string;
+};
+
 export type TokenConfig =
   | Erc20TokenConfig
   | StellarTokenConfig
@@ -164,7 +169,8 @@ export type TokenConfig =
   | VetTokenConfig
   | VetNFTCollectionConfig
   | TaoTokenConfig
-  | PolyxTokenConfig;
+  | PolyxTokenConfig
+  | JettonTokenConfig;
 
 export interface Tokens {
   bitcoin: {
@@ -261,6 +267,9 @@ export interface Tokens {
     cosmos: {
       tokens: CosmosTokenConfig[];
     };
+    ton: {
+      tokens: JettonTokenConfig[];
+    };
   };
   testnet: {
     eth: {
@@ -356,6 +365,9 @@ export interface Tokens {
     cosmos: {
       tokens: CosmosTokenConfig[];
     };
+    ton: {
+      tokens: JettonTokenConfig[];
+    };
   };
 }
 
@@ -1053,6 +1065,25 @@ function getCosmosTokenConfig(coin: CosmosChainToken): CosmosTokenConfig {
   };
 }
 
+function getJettonTokenConfig(coin: JettonToken): JettonTokenConfig {
+  return {
+    type: coin.name,
+    coin: coin.network.type === NetworkType.MAINNET ? 'ton' : 'tton',
+    network: coin.network.type === NetworkType.MAINNET ? 'Mainnet' : 'Testnet',
+    name: coin.fullName,
+    contractAddress: coin.contractAddress,
+    decimalPlaces: coin.decimalPlaces,
+  };
+}
+
+const getFormattedJettonTokens = (customCoinMap = coins) =>
+  customCoinMap.reduce((acc: JettonTokenConfig[], coin) => {
+    if (coin instanceof JettonToken) {
+      acc.push(getJettonTokenConfig(coin));
+    }
+    return acc;
+  }, []);
+
 export const getFormattedTokens = (coinMap = coins): Tokens => {
   const formattedAptNFTCollections = getFormattedAptNFTCollections(coinMap);
   const formattedVetNFTCollections = getFormattedVetNFTCollections(coinMap);
@@ -1157,6 +1188,9 @@ export const getFormattedTokens = (coinMap = coins): Tokens => {
       cosmos: {
         tokens: getFormattedCosmosChainTokens(coinMap).filter((token) => token.network === 'Mainnet'),
       },
+      ton: {
+        tokens: getFormattedJettonTokens(coinMap).filter((token) => token.network === 'Mainnet'),
+      },
     },
     testnet: {
       eth: {
@@ -1258,6 +1292,9 @@ export const getFormattedTokens = (coinMap = coins): Tokens => {
       cosmos: {
         tokens: getFormattedCosmosChainTokens(coinMap).filter((token) => token.network === 'Testnet'),
       },
+      ton: {
+        tokens: getFormattedJettonTokens(coinMap).filter((token) => token.network === 'Testnet'),
+      },
     },
   };
 };
@@ -1369,6 +1406,8 @@ export function getFormattedTokenConfigForCoin(coin: Readonly<BaseCoin>): TokenC
     return getVetNFTCollectionConfig(coin);
   } else if (coin instanceof CoredaoERC20Token) {
     return getCoredaoTokenConfig(coin);
+  } else if (coin instanceof JettonToken) {
+    return getJettonTokenConfig(coin);
   }
   return undefined;
 }