Merge pull request #6639 from BitGo/WIN-6573

feat: add polyxToken skeleton

Author: akarath

modules/bitgo/src/v2/coinFactory.ts

@@ -35,6 +35,7 @@ import {
   CosmosTokenConfig,
   VetTokenConfig,
   TaoTokenConfig,
+  PolyxTokenConfig,
 } from '@bitgo/statics';
 import {
   Ada,
@@ -107,6 +108,7 @@ import {
   Polygon,
   PolygonToken,
   Polyx,
+  PolyxToken,
   Rune,
   Rbtc,
   Sei,
@@ -496,6 +498,10 @@ export function registerCoinConstructors(coinFactory: CoinFactory, coinMap: Coin
     ({ name, coinConstructor }) => coinFactory.register(name, coinConstructor)
   );
 
+  PolyxToken.createTokenConstructors([...tokens.bitcoin.polyx.tokens, ...tokens.testnet.polyx.tokens]).forEach(
+    ({ name, coinConstructor }) => coinFactory.register(name, coinConstructor)
+  );
+
   XrpToken.createTokenConstructors([...tokens.bitcoin.xrp.tokens, ...tokens.testnet.xrp.tokens]).forEach(
     ({ name, coinConstructor }) => coinFactory.register(name, coinConstructor)
   );
@@ -919,6 +925,9 @@ export function getTokenConstructor(tokenConfig: TokenConfig): CoinConstructor |
     case 'tao':
     case 'ttao':
       return TaoToken.createTokenConstructor(tokenConfig as TaoTokenConfig);
+    case 'polyx':
+    case 'tpolyx':
+      return PolyxToken.createTokenConstructor(tokenConfig as PolyxTokenConfig);
     case 'xrp':
     case 'txrp':
       return XrpToken.createTokenConstructor(tokenConfig as XrpTokenConfig);

modules/bitgo/src/v2/coins/index.ts

@@ -49,7 +49,7 @@ import { Oas, Toas } from '@bitgo/sdk-coin-oas';
 import { Opeth, Topeth, OpethToken } from '@bitgo/sdk-coin-opeth';
 import { Osmo, Tosmo } from '@bitgo/sdk-coin-osmo';
 import { Polygon, PolygonToken, Tpolygon } from '@bitgo/sdk-coin-polygon';
-import { Polyx, Tpolyx } from '@bitgo/sdk-coin-polyx';
+import { Polyx, Tpolyx, PolyxToken } from '@bitgo/sdk-coin-polyx';
 import { Rbtc, Trbtc } from '@bitgo/sdk-coin-rbtc';
 import { Rune, Trune } from '@bitgo/sdk-coin-rune';
 import { Sei, Tsei } from '@bitgo/sdk-coin-sei';
@@ -122,7 +122,7 @@ export { Oas, Toas };
 export { Opeth, Topeth, OpethToken };
 export { Osmo, Tosmo };
 export { Polygon, PolygonToken, Tpolygon };
-export { Polyx, Tpolyx };
+export { Polyx, Tpolyx, PolyxToken };
 export { Rbtc, Trbtc };
 export { Rune, Trune };
 export { Sgb, Tsgb };

modules/bitgo/test/browser/browser.spec.ts

@@ -30,6 +30,7 @@ describe('Coins', () => {
       ZkethToken: 1,
       SuiToken: 1,
       TaoToken: 1,
+      PolyxToken: 1,
       BeraToken: 1,
       XrpToken: 1,
       Rune: 1,

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

@@ -2,3 +2,4 @@ export * from './lib';
 export * from './register';
 export * from './polyx';
 export * from './tpolyx';
+export * from './polyxToken';

modules/sdk-coin-polyx/src/polyxToken.ts

@@ -0,0 +1,68 @@
+import { coins, PolyxTokenConfig, tokens } from '@bitgo/statics';
+import { Polyx } from './polyx';
+import { BitGoBase, CoinConstructor, NamedCoinConstructor } from '@bitgo/sdk-core';
+
+export class PolyxToken extends Polyx {
+  public readonly tokenConfig: PolyxTokenConfig;
+
+  constructor(bitgo: BitGoBase, tokenConfig: PolyxTokenConfig) {
+    const staticsCoin = tokenConfig.network === 'Mainnet' ? coins.get('polyx') : coins.get('tpolyx');
+    super(bitgo, staticsCoin);
+    this.tokenConfig = tokenConfig;
+  }
+
+  static createTokenConstructor(config: PolyxTokenConfig): CoinConstructor {
+    return (bitgo: BitGoBase) => new PolyxToken(bitgo, config);
+  }
+
+  static createTokenConstructors(
+    tokenConfigs: PolyxTokenConfig[] = [...tokens.bitcoin.polyx.tokens, ...tokens.testnet.polyx.tokens]
+  ): NamedCoinConstructor[] {
+    const tokensCtors: NamedCoinConstructor[] = [];
+    for (const token of tokenConfigs) {
+      const tokenConstructor = PolyxToken.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 ticker(): string {
+    return this.tokenConfig.ticker;
+  }
+
+  get assetId(): string {
+    return this.tokenConfig.assetId;
+  }
+
+  get decimalPlaces(): number {
+    return this.tokenConfig.decimalPlaces;
+  }
+
+  getChain(): string {
+    return this.tokenConfig.type;
+  }
+
+  getBaseChain(): string {
+    return this.coin;
+  }
+
+  getFullName(): string {
+    return this._staticsCoin.fullName;
+  }
+
+  getBaseFactor(): number {
+    return Math.pow(10, this.tokenConfig.decimalPlaces);
+  }
+}

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

@@ -1,8 +1,12 @@
 import { BitGoBase } from '@bitgo/sdk-core';
 import { Polyx } from './polyx';
 import { Tpolyx } from './tpolyx';
+import { PolyxToken } from './polyxToken';
 
 export const register = (sdk: BitGoBase): void => {
   sdk.register('polyx', Polyx.createInstance);
   sdk.register('tpolyx', Tpolyx.createInstance);
+  PolyxToken.createTokenConstructors().forEach(({ name, coinConstructor }) => {
+    sdk.register(name, coinConstructor);
+  });
 };