Merge pull request #6977 from BitGo/COIN-5624-sdk-add-token-support-to-statics

feat(statics): add jetton token standard

Author: MohammedRyaan786

modules/statics/src/account.ts

@@ -168,6 +168,10 @@ export interface CosmosTokenConstructorOptions extends AccountConstructorOptions
   denom: string;
 }
 
+export interface JettonTokenConstructorOptions extends AccountConstructorOptions {
+  contractAddress: string;
+}
+
 export interface AdaTokenConstructorOptions extends AccountConstructorOptions {
   policyId: string;
   assetName: string;
@@ -680,6 +684,19 @@ export class CosmosChainToken extends AccountCoinToken {
     this.denom = options.denom;
   }
 }
+/**
+ * TON supports tokens and Jetton is a token standard on TON
+ * Jetton tokens work similar to native TON coin
+ */
+export class JettonToken extends AccountCoinToken {
+  public contractAddress: string;
+  constructor(options: JettonTokenConstructorOptions) {
+    super({
+      ...options,
+    });
+    this.contractAddress = options.contractAddress;
+  }
+}
 
 /**
  * The Bittensor network supports tokens
@@ -3809,3 +3826,94 @@ export function tpolyxToken(
     primaryKeyCurve
   );
 }
+
+/**
+ * Factory function for Jetton token instances.
+ * Jetton is the token standard on TON blockchain.
+ *
+ * @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 contractAddress Contract address of this token
+ * @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 defined in `AccountCoin`
+ * @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 TON main network.
+ * @param primaryKeyCurve The elliptic curve for this chain/token
+ */
+export function jettonToken(
+  id: string,
+  name: string,
+  fullName: string,
+  decimalPlaces: number,
+  contractAddress: string,
+  asset: UnderlyingAsset,
+  features: CoinFeature[] = AccountCoin.DEFAULT_FEATURES,
+  prefix = '',
+  suffix: string = name.toUpperCase(),
+  network: AccountNetwork = Networks.main.ton,
+  primaryKeyCurve: KeyCurve = KeyCurve.Ed25519
+) {
+  return Object.freeze(
+    new JettonToken({
+      id,
+      name,
+      fullName,
+      network,
+      contractAddress,
+      prefix,
+      suffix,
+      features,
+      decimalPlaces,
+      asset,
+      isToken: true,
+      primaryKeyCurve,
+      baseUnit: BaseUnit.TON,
+    })
+  );
+}
+
+/**
+ * Factory function for testnet jetton token instances.
+ * Jetton is the token standard on TON blockchain.
+ *
+ * @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 contractAddress Contract address of this token
+ * @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 defined in `AccountCoin`
+ * @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 the testnet TON network.
+ */
+export function tjettonToken(
+  id: string,
+  name: string,
+  fullName: string,
+  decimalPlaces: number,
+  contractAddress: string,
+  asset: UnderlyingAsset,
+  features: CoinFeature[] = AccountCoin.DEFAULT_FEATURES,
+  prefix = '',
+  suffix: string = name.toUpperCase(),
+  network: AccountNetwork = Networks.test.ton,
+  primaryKeyCurve: KeyCurve = KeyCurve.Ed25519
+) {
+  return jettonToken(
+    id,
+    name,
+    fullName,
+    decimalPlaces,
+    contractAddress,
+    asset,
+    features,
+    prefix,
+    suffix,
+    network,
+    primaryKeyCurve
+  );
+}