feat(sdk-coin-bsc): support tokens for bsc

Ticket: BG-55766

Author: kxl4126

modules/bitgo/src/v2/coinFactory.ts

@@ -13,6 +13,7 @@ import {
   AvaxP,
   Bch,
   Bsc,
+  BscToken,
   Bsv,
   Btc,
   Btg,
@@ -181,6 +182,10 @@ function registerCoinConstructors(globalCoinFactory: CoinFactory): void {
     globalCoinFactory.register(name, coinConstructor);
   });
 
+  BscToken.createTokenConstructors().forEach(({ name, coinConstructor }) => {
+    globalCoinFactory.register(name, coinConstructor);
+  });
+
   EosToken.createTokenConstructors().forEach(({ name, coinConstructor }) => {
     globalCoinFactory.register(name, coinConstructor);
   });

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

@@ -12,8 +12,8 @@ import { AvaxP, TavaxP } from '@bitgo/sdk-coin-avaxp';
 export { AvaxP, TavaxP };
 import { Bch, Tbch } from '@bitgo/sdk-coin-bch';
 export { Bch, Tbch };
-import { Bsc, Tbsc } from '@bitgo/sdk-coin-bsc';
-export { Bsc, Tbsc };
+import { Bsc, Tbsc, BscToken } from '@bitgo/sdk-coin-bsc';
+export { Bsc, Tbsc, BscToken };
 import { Bsv, Tbsv } from '@bitgo/sdk-coin-bsv';
 export { Bsv, Tbsv };
 import { Btc, Tbtc } from '@bitgo/sdk-coin-btc';

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

@@ -20,6 +20,7 @@ describe('Coins', () => {
             'AlgoToken': 1,
             'AvaxCToken': 1,
             'PolygonToken': 1,
+            'BscToken': 1,
         };
         Object.keys(BitGoJS.Coin)
         .filter((coinName) => !excludedKeys[coinName])

modules/sdk-coin-bsc/src/bscToken.ts

@@ -0,0 +1,97 @@
+/**
+ * @prettier
+ */
+
+import { Bsc } from './bsc';
+import { TransactionPrebuild } from '@bitgo/sdk-coin-eth';
+import { EthLikeTokenConfig, tokens, coins } from '@bitgo/statics';
+import { BitGoBase, CoinConstructor, NamedCoinConstructor } from '@bitgo/sdk-core';
+
+export { EthLikeTokenConfig };
+
+export class BscToken extends Bsc {
+  public readonly tokenConfig: EthLikeTokenConfig;
+  constructor(bitgo: BitGoBase, tokenConfig: EthLikeTokenConfig) {
+    const staticsCoin = tokenConfig.network === 'Mainnet' ? coins.get('bsc') : coins.get('tbsc');
+    super(bitgo, staticsCoin);
+    this.tokenConfig = tokenConfig;
+  }
+
+  static createTokenConstructor(config: EthLikeTokenConfig): CoinConstructor {
+    return (bitgo: BitGoBase) => new BscToken(bitgo, config);
+  }
+
+  static createTokenConstructors(): NamedCoinConstructor[] {
+    const tokensCtors: NamedCoinConstructor[] = [];
+    for (const token of [...tokens.bitcoin.bsc.tokens, ...tokens.testnet.bsc.tokens]) {
+      const tokenConstructor = BscToken.createTokenConstructor(token);
+      tokensCtors.push({ name: token.type, coinConstructor: tokenConstructor });
+      tokensCtors.push({ name: token.tokenContractAddress, coinConstructor: tokenConstructor });
+    }
+    return tokensCtors;
+  }
+
+  get type() {
+    return this.tokenConfig.type;
+  }
+
+  get name() {
+    return this.tokenConfig.name;
+  }
+
+  get coin() {
+    return this.tokenConfig.coin;
+  }
+
+  get network() {
+    return this.tokenConfig.network;
+  }
+
+  get tokenContractAddress() {
+    return this.tokenConfig.tokenContractAddress;
+  }
+
+  get decimalPlaces() {
+    return this.tokenConfig.decimalPlaces;
+  }
+
+  getChain(): string {
+    return this.tokenConfig.type;
+  }
+
+  getBaseChain() {
+    return this.coin;
+  }
+
+  getFullName(): string {
+    return 'Bsc Token';
+  }
+
+  getBaseFactor() {
+    return Math.pow(10, this.tokenConfig.decimalPlaces);
+  }
+
+  /**
+   * Flag for sending value of 0
+   * @returns {boolean} True if okay to send 0 value, false otherwise
+   */
+  valuelessTransferAllowed() {
+    return false;
+  }
+
+  /**
+   * Flag for sending data along with transactions
+   * @returns {boolean} True if okay to send tx data (ETH), false otherwise
+   */
+  transactionDataAllowed() {
+    return false;
+  }
+
+  isToken(): boolean {
+    return true;
+  }
+
+  verifyCoin(txPrebuild: TransactionPrebuild): boolean {
+    return txPrebuild.coin === this.tokenConfig.coin && txPrebuild.token === this.tokenConfig.type;
+  }
+}

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

@@ -1,3 +1,4 @@
 export * from './lib';
 export * from './bsc';
 export * from './tbsc';
+export * from './bscToken';

modules/sdk-coin-bsc/test/unit/bscToken.ts

@@ -0,0 +1,32 @@
+import 'should';
+
+import { TestBitGo, TestBitGoAPI } from '@bitgo/sdk-test';
+import { BscToken } from '../../src';
+import { BitGoAPI } from '@bitgo/sdk-api';
+
+describe('Bsc Token:', function () {
+  let bitgo: TestBitGoAPI;
+  let bscTokenCoin;
+  const tokenName = 'tbsc:busd';
+
+  before(function () {
+    bitgo = TestBitGo.decorate(BitGoAPI, { env: 'test' });
+    BscToken.createTokenConstructors().forEach(({ name, coinConstructor }) => {
+      bitgo.safeRegister(name, coinConstructor);
+    });
+    bitgo.initializeTestVars();
+    bscTokenCoin = bitgo.coin(tokenName);
+  });
+
+  it('should return constants', function () {
+    bscTokenCoin.getChain().should.equal('tbsc:busd');
+    bscTokenCoin.getBaseChain().should.equal('tbsc');
+    bscTokenCoin.getFullName().should.equal('Bsc Token');
+    bscTokenCoin.getBaseFactor().should.equal(1e18);
+    bscTokenCoin.type.should.equal(tokenName);
+    bscTokenCoin.name.should.equal('Test Binance USD Token');
+    bscTokenCoin.coin.should.equal('tbsc');
+    bscTokenCoin.network.should.equal('Testnet');
+    bscTokenCoin.decimalPlaces.should.equal(18);
+  });
+});

modules/statics/src/account.ts

@@ -181,6 +181,11 @@ export class Erc20CompatibleAccountCoin extends ContractAddressDefinedToken {
  */
 export class CeloCoin extends ContractAddressDefinedToken {}
 
+/**
+ * The BSC blockchain supports tokens of the ERC20 standard similar to ETH ERC20 tokens.
+ */
+export class BscCoin extends ContractAddressDefinedToken {}
+
 /**
  * The Stellar network supports tokens (non-native assets)
  * XLM is also known as the native asset.
@@ -699,6 +704,76 @@ export function tceloToken(
   return celoToken(name, fullName, decimalPlaces, contractAddress, asset, features, prefix, suffix, network);
 }
 
+/**
+ * Factory function for celo token instances.
+ *
+ * @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 prefix? Optional token prefix. Defaults to empty string
+ * @param suffix? Optional token suffix. Defaults to token name.
+ * @param network? Optional token network. Defaults to BSC main network.
+ * @param features? Features of this coin. Defaults to the DEFAULT_FEATURES defined in `AccountCoin`
+ * @param primaryKeyCurve The elliptic curve for this chain/token
+ */
+export function bscToken(
+  name: string,
+  fullName: string,
+  decimalPlaces: number,
+  contractAddress: string,
+  asset: UnderlyingAsset,
+  features: CoinFeature[] = AccountCoin.DEFAULT_FEATURES,
+  prefix = '',
+  suffix: string = name.toUpperCase(),
+  network: EthereumNetwork = Networks.main.bsc,
+  primaryKeyCurve: KeyCurve = KeyCurve.Secp256k1
+) {
+  return Object.freeze(
+    new BscCoin({
+      name,
+      fullName,
+      network,
+      contractAddress,
+      prefix,
+      suffix,
+      features,
+      decimalPlaces,
+      asset,
+      isToken: true,
+      primaryKeyCurve,
+    })
+  );
+}
+
+/**
+ * Factory function for testnet bsc token instances.
+ *
+ * @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 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 BSC network.
+ * @param features? Features of this coin. Defaults to the DEFAULT_FEATURES defined in `AccountCoin`
+ */
+export function tbscToken(
+  name: string,
+  fullName: string,
+  decimalPlaces: number,
+  contractAddress: string,
+  asset: UnderlyingAsset,
+  features: CoinFeature[] = AccountCoin.DEFAULT_FEATURES,
+  prefix = '',
+  suffix: string = name.toUpperCase(),
+  network: EthereumNetwork = Networks.test.bsc
+) {
+  return bscToken(name, fullName, decimalPlaces, contractAddress, asset, features, prefix, suffix, network);
+}
+
 /**
  * Factory function for Stellar token instances.
  *

modules/statics/src/base.ts

@@ -859,6 +859,10 @@ export enum UnderlyingAsset {
   'avaxc:usdc' = 'avaxc:usdc',
   'avaxc:link' = 'avaxc:link',
 
+  // BSC Token BEP-20
+  'bsc:busd' = 'bsc:busd',
+  'tbsc:busd' = 'tbsc:busd',
+
   // Polygon testnet tokens
   'tpolygon:derc20' = 'tpolygon:derc20',
   'tpolygon:link' = 'tpolygon:link',

modules/statics/src/coins.ts

@@ -3,6 +3,7 @@ import {
   AccountCoin,
   algoToken,
   avaxErc20,
+  bscToken,
   celoToken,
   eosToken,
   erc20,
@@ -15,6 +16,7 @@ import {
   stellarToken,
   talgoToken,
   tavaxErc20,
+  tbscToken,
   tceloToken,
   teosToken,
   terc20,
@@ -845,6 +847,13 @@ export const coins = CoinMap.fromCoins([
   erc20('zrx', '0x Token', 18, '0xe41d2489571d322189246dafa5ebde1f4699f498', UnderlyingAsset.ZRX),
   erc20('zusd', 'Z.com Usd', 6, '0xc56c2b7e71b54d38aab6d52e94a04cbfa8f604fa', UnderlyingAsset.ZUSD),
   celoToken('cusd', 'Celo USD', 18, '0x765de816845861e75a25fca122bb6898b8b1282a', UnderlyingAsset.CUSD),
+  bscToken(
+    'bsc:busd',
+    'Binance USD Token',
+    18,
+    '0xe9e7cea3dedca5984780bafc599bd69add087d56',
+    UnderlyingAsset['bsc:busd']
+  ),
   ofcerc20('ofc1inch', '1Inch Token', 18, UnderlyingAsset['1INCH']),
   ofcerc20('ofcusdc', 'USD Coin', 6, UnderlyingAsset.USDC),
   ofcerc20('ofcaave', 'Aave', 18, UnderlyingAsset.AAVE),
@@ -1648,6 +1657,13 @@ export const coins = CoinMap.fromCoins([
   terc20('tdai', 'Test DAI', 18, '0x4f96fe3b7a6cf9725f59d353f723c1bdb64ca6aa', UnderlyingAsset.TERC20),
   terc20('trif', 'Test RIF Token', 18, '0x19f64674d8a5b4e652319f5e239efd3bc969a1fe', UnderlyingAsset.RIF),
   tceloToken('tcusd', 'Test Celo USD Token', 18, '0x874069fa1eb16d44d622f2e0ca25eea172369bc1', UnderlyingAsset.CUSD),
+  tbscToken(
+    'tbsc:busd',
+    'Test Binance USD Token',
+    18,
+    '0x78867bbeef44f2326bf8ddd1941a4439382ef2a7',
+    UnderlyingAsset['tbsc:busd']
+  ),
   erc721('erc721:witch', 'Crypto Coven', '0x5180db8f5c931aae63c74266b211f580155ecac8'),
   terc721('terc721:bitgoerc721', 'Test BITGO ERC 721 Token', '0x8397b091514c1f7bebb9dea6ac267ea23b570605'),
   terc721('terc1155:bitgoerc1155', 'Test BITGO ERC 1155 Token', '0x87cd6a40640befdd96e563b788a6b1fb3e07a186'),

modules/statics/src/tokenConfig.ts

@@ -8,6 +8,7 @@ import {
   SolCoin,
   HederaToken,
   PolygonERC20Token,
+  BscCoin,
 } from './account';
 import { CoinKind } from './base';
 import { coins } from './coins';
@@ -77,6 +78,9 @@ export interface Tokens {
     polygon: {
       tokens: EthLikeTokenConfig[];
     };
+    bsc: {
+      tokens: EthLikeTokenConfig[];
+    };
     sol: {
       tokens: SolTokenConfig[];
     };
@@ -100,6 +104,9 @@ export interface Tokens {
     celo: {
       tokens: CeloTokenConfig[];
     };
+    bsc: {
+      tokens: EthLikeTokenConfig[];
+    };
     eos: {
       tokens: EosTokenConfig[];
     };
@@ -200,6 +207,20 @@ const formattedCeloTokens = coins.reduce((acc: CeloTokenConfig[], coin) => {
   return acc;
 }, []);
 
+const formattedBscTokens = coins.reduce((acc: EthLikeTokenConfig[], coin) => {
+  if (coin instanceof BscCoin) {
+    acc.push({
+      type: coin.name,
+      coin: coin.network.type === NetworkType.MAINNET ? 'bsc' : 'tbsc',
+      network: coin.network.type === NetworkType.MAINNET ? 'Mainnet' : 'Testnet',
+      name: coin.fullName,
+      tokenContractAddress: coin.contractAddress.toString().toLowerCase(),
+      decimalPlaces: coin.decimalPlaces,
+    });
+  }
+  return acc;
+}, []);
+
 const formattedEosTokens = coins.reduce((acc: EosTokenConfig[], coin) => {
   if (coin instanceof EosCoin) {
     acc.push({
@@ -301,6 +322,9 @@ export const tokens: Tokens = {
     celo: {
       tokens: formattedCeloTokens.filter((token) => token.network === 'Mainnet'),
     },
+    bsc: {
+      tokens: formattedBscTokens.filter((token) => token.network === 'Mainnet'),
+    },
     eos: {
       tokens: formattedEosTokens.filter((token) => token.network === 'Mainnet'),
     },
@@ -334,6 +358,9 @@ export const tokens: Tokens = {
     celo: {
       tokens: formattedCeloTokens.filter((token) => token.network === 'Testnet'),
     },
+    bsc: {
+      tokens: formattedBscTokens.filter((token) => token.network === 'Testnet'),
+    },
     eos: {
       tokens: formattedEosTokens.filter((token) => token.network === 'Testnet'),
     },