Merge pull request #6594 from BitGo/COIN-4748-add-gas-tank-token

feat: add gasTankToken property for vet in statics

Author: hrishikeshjain

modules/statics/src/account.ts

@@ -75,6 +75,8 @@ export interface GasTankAccountConstructorOptions extends AccountConstructorOpti
   gasTankLowBalanceAlertFactor: number;
   // min gas tank balance recommendation is calculated as (feeEstimate x gasTankMinBalanceRecommendationFactor)
   gasTankMinBalanceRecommendationFactor: number;
+  // gas tank token is the token used to pay for gas
+  gasTankToken?: string;
 }
 
 export interface Erc20ConstructorOptions extends AccountConstructorOptions {
@@ -170,12 +172,14 @@ export class AccountCoinToken extends AccountCoin {
 export class GasTankAccountCoin extends AccountCoin {
   public gasTankLowBalanceAlertFactor: number;
   public gasTankMinBalanceRecommendationFactor: number;
+  public gasTankToken?: string;
   constructor(options: GasTankAccountConstructorOptions) {
     super({
       ...options,
     });
     this.gasTankLowBalanceAlertFactor = options.gasTankLowBalanceAlertFactor;
     this.gasTankMinBalanceRecommendationFactor = options.gasTankMinBalanceRecommendationFactor;
+    this.gasTankToken = options?.gasTankToken;
   }
 }
 
@@ -729,7 +733,8 @@ export function gasTankAccount(
   gasTankMinBalanceRecommendationFactor = 10,
   prefix = '',
   suffix: string = name.toUpperCase(),
-  isToken = false
+  isToken = false,
+  gasTankToken?: string
 ) {
   return Object.freeze(
     new GasTankAccountCoin({
@@ -747,6 +752,7 @@ export function gasTankAccount(
       primaryKeyCurve,
       gasTankLowBalanceAlertFactor,
       gasTankMinBalanceRecommendationFactor,
+      gasTankToken,
     })
   );
 }

modules/statics/src/coins.ts

@@ -1708,7 +1708,11 @@ export const coins = CoinMap.fromCoins([
     VET_FEATURES,
     KeyCurve.Secp256k1,
     80,
-    200
+    200,
+    '',
+    'VET',
+    false,
+    'VET:VTHO'
   ),
   gasTankAccount(
     'b3158e80-f6ea-4922-98ab-d773a680ce76',
@@ -1721,7 +1725,11 @@ export const coins = CoinMap.fromCoins([
     VET_FEATURES,
     KeyCurve.Secp256k1,
     80,
-    200
+    200,
+    '',
+    'TVET',
+    false,
+    'TVET:VTHO'
   ),
   erc20CompatibleAccountCoin(
     'bfae821b-cf3a-4190-b1a8-a54af51d730e',

modules/statics/test/unit/account.ts

@@ -1,6 +1,6 @@
 const should = require('should');
-import { AccountCoin, Networks, UnderlyingAsset } from '../../src';
-import { txrpToken, xrpToken, vetToken, tvetToken } from '../../src/account';
+import { AccountCoin, coins, Networks, UnderlyingAsset } from '../../src';
+import { txrpToken, xrpToken, vetToken, tvetToken, GasTankAccountCoin } from '../../src/account';
 
 describe('XRP', () => {
   it('should create a new XRP token with the correct properties', () => {
@@ -89,4 +89,15 @@ describe('VET', () => {
     should(token.id).equal('cebb0ba8-6736-46bb-a006-5db7b5b3c376');
     should(token.gasTankToken).equal('TVET:VTHO');
   });
+
+  it('should create a base VET coin with the correct gasTankToken property', () => {
+    // Get the base VET coin
+    const vetCoin = coins.get('vet') as GasTankAccountCoin;
+    should(vetCoin).not.be.undefined();
+    should(vetCoin.gasTankToken).equal('VET:VTHO');
+    // Get the testnet VET coin
+    const tvetCoin = coins.get('tvet') as GasTankAccountCoin;
+    should(tvetCoin).not.be.undefined();
+    should(tvetCoin.gasTankToken).equal('TVET:VTHO');
+  });
 });