Merge pull request #6588 from BitGo/COIN-4748-add-gastank-token-name

feat: add gasTankTokenName coin property for vet

Author: gianchandania

modules/statics/src/account.ts

@@ -149,6 +149,7 @@ export interface Nep141TokenConstructorOptions extends AccountConstructorOptions
 
 export interface VetTokenConstructorOptions extends AccountConstructorOptions {
   contractAddress: string;
+  gasTankToken?: string;
 }
 export interface CosmosTokenConstructorOptions extends AccountConstructorOptions {
   denom: string;
@@ -623,11 +624,13 @@ export class Nep141Token extends AccountCoinToken {
 
 export class VetToken extends AccountCoinToken {
   public contractAddress: string;
+  public gasTankToken?: string;
   constructor(options: VetTokenConstructorOptions) {
     super({
       ...options,
     });
     this.contractAddress = options.contractAddress;
+    this.gasTankToken = options.gasTankToken;
   }
 }
 
@@ -3176,7 +3179,8 @@ export function vetToken(
   prefix = '',
   suffix: string = name.toUpperCase(),
   network: AccountNetwork = Networks.main.vet,
-  primaryKeyCurve: KeyCurve = KeyCurve.Secp256k1
+  primaryKeyCurve: KeyCurve = KeyCurve.Secp256k1,
+  gasTankToken = 'VET:VTHO'
 ) {
   return Object.freeze(
     new VetToken({
@@ -3193,6 +3197,7 @@ export function vetToken(
       isToken: true,
       primaryKeyCurve,
       baseUnit: BaseUnit.VET,
+      gasTankToken,
     })
   );
 }
@@ -3221,9 +3226,23 @@ export function tvetToken(
   features: CoinFeature[] = AccountCoin.DEFAULT_FEATURES,
   prefix = '',
   suffix: string = name.toUpperCase(),
-  network: AccountNetwork = Networks.test.vet
+  network: AccountNetwork = Networks.test.vet,
+  gasTankToken = 'TVET:VTHO' // For test environment
 ) {
-  return vetToken(id, name, fullName, decimalPlaces, contractAddress, asset, features, prefix, suffix, network);
+  return vetToken(
+    id,
+    name,
+    fullName,
+    decimalPlaces,
+    contractAddress,
+    asset,
+    features,
+    prefix,
+    suffix,
+    network,
+    KeyCurve.Secp256k1,
+    gasTankToken
+  );
 }
 
 /**

modules/statics/test/unit/account.ts

@@ -1,6 +1,6 @@
 const should = require('should');
 import { AccountCoin, Networks, UnderlyingAsset } from '../../src';
-import { txrpToken, xrpToken } from '../../src/account';
+import { txrpToken, xrpToken, vetToken, tvetToken } from '../../src/account';
 
 describe('XRP', () => {
   it('should create a new XRP token with the correct properties', () => {
@@ -62,3 +62,31 @@ describe('XRP', () => {
     should(token.baseUnit).equal('drop');
   });
 });
+
+describe('VET', () => {
+  it('should create a new VET token with the correct gastankTokenName for production', () => {
+    const token = vetToken(
+      'cebb0ba8-6736-46bb-a006-5db7b5b3c376',
+      'token-name',
+      'Token fullname',
+      15,
+      'contract-address',
+      UnderlyingAsset.VET
+    );
+    should(token.id).equal('cebb0ba8-6736-46bb-a006-5db7b5b3c376');
+    should(token.gasTankToken).equal('VET:VTHO');
+  });
+
+  it('should create a new TVET token with the correct gasTankToken for testnet', () => {
+    const token = tvetToken(
+      'cebb0ba8-6736-46bb-a006-5db7b5b3c376',
+      'token-name',
+      'Token fullname',
+      15,
+      'contract-address',
+      UnderlyingAsset.VET
+    );
+    should(token.id).equal('cebb0ba8-6736-46bb-a006-5db7b5b3c376');
+    should(token.gasTankToken).equal('TVET:VTHO');
+  });
+});