Merge pull request #6312 from BitGo/coin-4567

feat: add vechain token standard support

Author: baltiyal

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

@@ -2,3 +2,4 @@ export * from './lib';
 export * from './vet';
 export * from './tvet';
 export * from './register';
+export * from './vetToken';

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

@@ -1,8 +1,12 @@
 import { BitGoBase } from '@bitgo/sdk-core';
 import { Vet } from './vet';
 import { Tvet } from './tvet';
+import { VetToken } from './vetToken';
 
 export const register = (sdk: BitGoBase): void => {
   sdk.register('vet', Vet.createInstance);
   sdk.register('tvet', Tvet.createInstance);
+  VetToken.createTokenConstructors().forEach(({ name, coinConstructor }) => {
+    sdk.register(name, coinConstructor);
+  });
 };

modules/sdk-coin-vet/src/vetToken.ts

@@ -0,0 +1,62 @@
+import { Vet } from './vet';
+import { BitGoBase, CoinConstructor, NamedCoinConstructor } from '@bitgo/sdk-core';
+import { VetTokenConfig, coins, tokens } from '@bitgo/statics';
+
+export class VetToken extends Vet {
+  public readonly tokenConfig: VetTokenConfig;
+
+  constructor(bitgo: BitGoBase, tokenConfig: VetTokenConfig) {
+    const staticsCoin = tokenConfig.network === 'Mainnet' ? coins.get('vet') : coins.get('tvet');
+    super(bitgo, staticsCoin);
+    this.tokenConfig = tokenConfig;
+  }
+
+  static createTokenConstructor(config: VetTokenConfig): CoinConstructor {
+    return (bitgo: BitGoBase) => new VetToken(bitgo, config);
+  }
+
+  static createTokenConstructors(): NamedCoinConstructor[] {
+    const tokensCtors: NamedCoinConstructor[] = [];
+    for (const token of [...tokens.bitcoin.vet.tokens, ...tokens.testnet.vet.tokens]) {
+      const tokenConstructor = VetToken.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 'Vet Token';
+  }
+
+  getBaseFactor(): number {
+    return Math.pow(10, this.tokenConfig.decimalPlaces);
+  }
+}

modules/statics/src/account.ts

@@ -146,6 +146,10 @@ export interface Nep141TokenConstructorOptions extends AccountConstructorOptions
   storageDepositAmount: string;
 }
 
+export interface VetTokenConstructorOptions extends AccountConstructorOptions {
+  contractAddress: string;
+}
+
 export interface ContractAddress extends String {
   __contractaddress_phantom__: never;
 }
@@ -603,6 +607,16 @@ export class Nep141Token extends AccountCoinToken {
   }
 }
 
+export class VetToken extends AccountCoinToken {
+  public contractAddress: string;
+  constructor(options: VetTokenConstructorOptions) {
+    super({
+      ...options,
+    });
+    this.contractAddress = options.contractAddress;
+  }
+}
+
 /**
  * Factory function for account coin instances.
  *
@@ -3015,3 +3029,79 @@ export function tnep141Token(
     network
   );
 }
+
+/**
+ * Factory function for vet 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 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 Near main network.
+ * @param primaryKeyCurve The elliptic curve for this chain/token
+ */
+export function vetToken(
+  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.vet,
+  primaryKeyCurve: KeyCurve = KeyCurve.Secp256k1
+) {
+  return Object.freeze(
+    new VetToken({
+      id,
+      name,
+      fullName,
+      network,
+      contractAddress,
+      prefix,
+      suffix,
+      features,
+      decimalPlaces,
+      asset,
+      isToken: true,
+      primaryKeyCurve,
+      baseUnit: BaseUnit.VET,
+    })
+  );
+}
+
+/**
+ * Factory function for testnet vet 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 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 Near network.
+ */
+export function tvetToken(
+  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.vet
+) {
+  return vetToken(id, name, fullName, decimalPlaces, contractAddress, asset, features, prefix, suffix, network);
+}

modules/statics/src/base.ts

@@ -2809,6 +2809,7 @@ export enum BaseUnit {
   FETCHAI = 'afet',
   INITIA = 'uinit',
   ASI = 'afet',
+  VET = 'wei',
 }
 
 export interface BaseCoinConstructorOptions {

modules/statics/src/index.ts

@@ -26,6 +26,7 @@ export {
   AptNFTCollection,
   Sip10Token,
   Nep141Token,
+  VetToken,
 } from './account';
 export { CoinMap } from './map';
 export { networkFeatureMapForTokens } from './networkFeatureMapForTokens';

modules/statics/src/tokenConfig.ts

@@ -22,6 +22,7 @@ import {
   StellarCoin,
   SuiCoin,
   TronErc20Coin,
+  VetToken,
   XrpCoin,
   ZkethERC20Token,
 } from './account';
@@ -112,6 +113,10 @@ export type Nep141TokenConfig = BaseNetworkConfig & {
   storageDepositAmount: string;
 };
 
+export type VetTokenConfig = BaseNetworkConfig & {
+  contractAddress: string;
+};
+
 export type TokenConfig =
   | Erc20TokenConfig
   | StellarTokenConfig
@@ -207,6 +212,9 @@ export interface Tokens {
     near: {
       tokens: Nep141TokenConfig[];
     };
+    vet: {
+      tokens: VetTokenConfig[];
+    };
   };
   testnet: {
     eth: {
@@ -282,6 +290,9 @@ export interface Tokens {
     near: {
       tokens: Nep141TokenConfig[];
     };
+    vet: {
+      tokens: VetTokenConfig[];
+    };
   };
 }
 
@@ -822,6 +833,25 @@ const getFormattedNep141Tokens = (customCoinMap = coins) =>
     return acc;
   }, []);
 
+function getVetTokenConfig(coin: VetToken): VetTokenConfig {
+  return {
+    type: coin.name,
+    coin: coin.network.type === NetworkType.MAINNET ? 'vet' : 'tvet',
+    network: coin.network.type === NetworkType.MAINNET ? 'Mainnet' : 'Testnet',
+    name: coin.fullName,
+    contractAddress: coin.contractAddress,
+    decimalPlaces: coin.decimalPlaces,
+  };
+}
+
+const getFormattedVetTokens = (customCoinMap = coins) =>
+  customCoinMap.reduce((acc: VetTokenConfig[], coin) => {
+    if (coin instanceof VetToken) {
+      acc.push(getVetTokenConfig(coin));
+    }
+    return acc;
+  }, []);
+
 export const getFormattedTokens = (coinMap = coins): Tokens => {
   const formattedAptNFTCollections = getFormattedAptNFTCollections(coinMap);
   return {
@@ -903,6 +933,9 @@ export const getFormattedTokens = (coinMap = coins): Tokens => {
       near: {
         tokens: getFormattedNep141Tokens(coinMap).filter((token) => token.network === 'Mainnet'),
       },
+      vet: {
+        tokens: getFormattedVetTokens(coinMap).filter((token) => token.network === 'Mainnet'),
+      },
     },
     testnet: {
       eth: {
@@ -982,6 +1015,9 @@ export const getFormattedTokens = (coinMap = coins): Tokens => {
       near: {
         tokens: getFormattedNep141Tokens(coinMap).filter((token) => token.network === 'Testnet'),
       },
+      vet: {
+        tokens: getFormattedVetTokens(coinMap).filter((token) => token.network === 'Testnet'),
+      },
     },
   };
 };