feat: add WORLDCHAIN token support

Ticket: WIN-5948

TICKET: WIN-5948

Author: prithvishet2503

modules/bitgo/src/v2/coinFactory.ts

@@ -195,6 +195,7 @@ import {
   Vet,
   Wemix,
   World,
+  WorldToken,
   Xdc,
   Xlm,
   Xrp,
@@ -439,6 +440,10 @@ export function registerCoinConstructors(coinFactory: CoinFactory, coinMap: Coin
     coinFactory.register(name, coinConstructor);
   });
 
+  WorldToken.createTokenConstructors().forEach(({ name, coinConstructor }) => {
+    coinFactory.register(name, coinConstructor);
+  });
+
   SolToken.createTokenConstructors([...tokens.bitcoin.sol.tokens, ...tokens.testnet.sol.tokens]).forEach(
     ({ name, coinConstructor }) => {
       coinFactory.register(name, coinConstructor);

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

@@ -63,7 +63,7 @@ import { Trx, Ttrx } from '@bitgo/sdk-coin-trx';
 import { StellarToken, Txlm, Xlm } from '@bitgo/sdk-coin-xlm';
 import { Vet, Tvet } from '@bitgo/sdk-coin-vet';
 import { Wemix, Twemix } from '@bitgo/sdk-coin-wemix';
-import { World, Tworld } from '@bitgo/sdk-coin-world';
+import { World, Tworld, WorldToken } from '@bitgo/sdk-coin-world';
 import { Xdc, Txdc } from '@bitgo/sdk-coin-xdc';
 import { Txrp, Xrp, XrpToken } from '@bitgo/sdk-coin-xrp';
 import { Txtz, Xtz } from '@bitgo/sdk-coin-xtz';
@@ -141,7 +141,7 @@ export { Txtz, Xtz };
 export { Tzec, Zec };
 export { Tzeta, Zeta };
 export { Wemix, Twemix };
-export { World, Tworld };
+export { World, Tworld, WorldToken };
 export { Zketh, Tzketh, ZkethToken };
 
 import { coins } from '@bitgo/sdk-core';

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

@@ -44,6 +44,7 @@ describe('Coins', () => {
       Tpolyx: 1,
       CoredaoToken: 1,
       Nep141Token: 1,
+      WorldToken: 1,
     };
     Object.keys(BitGoJS.Coin)
       .filter((coinName) => !excludedKeys[coinName])

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

@@ -2,3 +2,5 @@ export * from './lib';
 export * from './world';
 export * from './tworld';
 export * from './register';
+export * from './tworld';
+export * from './worldToken';

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

@@ -1,8 +1,12 @@
 import { BitGoBase } from '@bitgo/sdk-core';
 import { World } from './world';
 import { Tworld } from './tworld';
+import { WorldToken } from './worldToken';
 
 export const register = (sdk: BitGoBase): void => {
   sdk.register('world', World.createInstance);
   sdk.register('tworld', Tworld.createInstance);
+  WorldToken.createTokenConstructors().forEach(({ name, coinConstructor }) => {
+    sdk.register(name, coinConstructor);
+  });
 };

modules/sdk-coin-world/src/worldToken.ts

@@ -0,0 +1,57 @@
+/**
+ * @prettier
+ */
+import { coins, EthLikeTokenConfig } from '@bitgo/statics';
+import { BitGoBase, CoinConstructor, common, MPCAlgorithm, NamedCoinConstructor } from '@bitgo/sdk-core';
+import { CoinNames, EthLikeToken, recoveryBlockchainExplorerQuery } from '@bitgo/abstract-eth';
+
+import { TransactionBuilder } from './lib';
+
+export { EthLikeTokenConfig };
+
+export class WorldToken extends EthLikeToken {
+  public readonly tokenConfig: EthLikeTokenConfig;
+  static coinNames: CoinNames = {
+    Mainnet: 'world',
+    Testnet: 'tworld',
+  };
+  constructor(bitgo: BitGoBase, tokenConfig: EthLikeTokenConfig) {
+    super(bitgo, tokenConfig, WorldToken.coinNames);
+  }
+  static createTokenConstructor(config: EthLikeTokenConfig): CoinConstructor {
+    return super.createTokenConstructor(config, WorldToken.coinNames);
+  }
+
+  static createTokenConstructors(): NamedCoinConstructor[] {
+    return super.createTokenConstructors(WorldToken.coinNames);
+  }
+
+  protected getTransactionBuilder(): TransactionBuilder {
+    return new TransactionBuilder(coins.get(this.getBaseChain()));
+  }
+
+  /** @inheritDoc **/
+  getMPCAlgorithm(): MPCAlgorithm {
+    return 'ecdsa';
+  }
+
+  /** @inheritDoc */
+  supportsTss(): boolean {
+    return true;
+  }
+
+  /**
+   * Make a query to World Chain explorer for information such as balance, token balance, solidity calls
+   * @param {Object} query key-value pairs of parameters to append after /api
+   * @returns {Promise<Object>} response World Chain explorer
+   */
+  async recoveryBlockchainExplorerQuery(query: Record<string, string>): Promise<Record<string, unknown>> {
+    const apiToken = common.Environments[this.bitgo.getEnv()].worldExplorerApiToken;
+    const explorerUrl = common.Environments[this.bitgo.getEnv()].worldExplorerBaseUrl;
+    return await recoveryBlockchainExplorerQuery(query, explorerUrl as string, apiToken);
+  }
+
+  getFullName(): string {
+    return 'World Token';
+  }
+}

modules/sdk-coin-world/test/unit/worldToken.ts

@@ -0,0 +1,31 @@
+import { TestBitGo, TestBitGoAPI } from '@bitgo/sdk-test';
+import { BitGoAPI } from '@bitgo/sdk-api';
+
+import { WorldToken } from '../../src/worldToken';
+
+describe('World Token:', function () {
+  let bitgo: TestBitGoAPI;
+  let worldTokenCoin;
+  const tokenName = 'tworld:wld';
+
+  before(function () {
+    bitgo = TestBitGo.decorate(BitGoAPI, { env: 'test' });
+    WorldToken.createTokenConstructors().forEach(({ name, coinConstructor }) => {
+      bitgo.safeRegister(name, coinConstructor);
+    });
+    bitgo.initializeTestVars();
+    worldTokenCoin = bitgo.coin(tokenName);
+  });
+
+  it('should return constants', function () {
+    worldTokenCoin.getChain().should.equal('tworld:wld');
+    worldTokenCoin.getBaseChain().should.equal('tworld');
+    worldTokenCoin.getFullName().should.equal('World Token');
+    worldTokenCoin.getBaseFactor().should.equal(1e18);
+    worldTokenCoin.type.should.equal(tokenName);
+    worldTokenCoin.name.should.equal('Worldcoin Testnet');
+    worldTokenCoin.coin.should.equal('tworld');
+    worldTokenCoin.network.should.equal('Testnet');
+    worldTokenCoin.decimalPlaces.should.equal(18);
+  });
+});

modules/statics/src/account.ts

@@ -483,6 +483,16 @@ export class CoredaoERC20Token extends ContractAddressDefinedToken {
   }
 }
 
+/**
+ * The World Chain network supports tokens
+ * World Chain Tokens are ERC20 tokens
+ */
+export class WorldERC20Token extends ContractAddressDefinedToken {
+  constructor(options: Erc20ConstructorOptions) {
+    super(options);
+  }
+}
+
 /**
  * The Xrp network supports tokens
  * Xrp tokens are identified by their issuer address
@@ -2426,6 +2436,96 @@ export function tcoredaoErc20(
   );
 }
 
+/**
+ * Factory function for WorldErc20 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 prefix? Optional token prefix. Defaults to empty string
+ * @param suffix? Optional token suffix. Defaults to token name.
+ * @param network? Optional token network. Defaults to World Chain mainnet 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 worldErc20(
+  id: string,
+  name: string,
+  fullName: string,
+  decimalPlaces: number,
+  contractAddress: string,
+  asset: UnderlyingAsset,
+  features: CoinFeature[] = [...AccountCoin.DEFAULT_FEATURES, CoinFeature.EIP1559],
+  prefix = '',
+  suffix: string = name.toUpperCase(),
+  network: AccountNetwork = Networks.main.world,
+  primaryKeyCurve: KeyCurve = KeyCurve.Secp256k1
+) {
+  return Object.freeze(
+    new WorldERC20Token({
+      id,
+      name,
+      fullName,
+      network,
+      contractAddress,
+      prefix,
+      suffix,
+      features,
+      decimalPlaces,
+      asset,
+      isToken: true,
+      primaryKeyCurve,
+      baseUnit: BaseUnit.ETH,
+    })
+  );
+}
+
+/**
+ * Factory function for world testnet worldErc20 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 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 World Chain test 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 tworldErc20(
+  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.coredao,
+  primaryKeyCurve: KeyCurve = KeyCurve.Secp256k1
+) {
+  return worldErc20(
+    id,
+    name,
+    fullName,
+    decimalPlaces,
+    contractAddress,
+    asset,
+    features,
+    prefix,
+    suffix,
+    network,
+    primaryKeyCurve
+  );
+}
+
 /**
  * Factory function for xrp token instances.
  *

modules/statics/src/base.ts

@@ -2523,6 +2523,14 @@ export enum UnderlyingAsset {
   // coredao testnet tokens
   'tcoredao:stcore' = 'tcoredao:stcore',
 
+  //world chain mainnet tokens
+  'world:wld' = 'world:wld',
+  'world:usdc' = 'world:usdc',
+
+  //world chain testnet tokens
+  'tworld:wld' = 'tworld:wld',
+  'tworld:usdc' = 'tworld:usdc',
+
   ERC721 = 'erc721',
   ERC1155 = 'erc1155',
   NONSTANDARD = 'nonstandard',

modules/statics/src/coins.ts

@@ -10,6 +10,7 @@ import {
   bscToken,
   celoToken,
   coredaoErc20,
+  worldErc20,
   eosToken,
   erc1155,
   erc20,
@@ -44,6 +45,7 @@ import {
   tsuiToken,
   ttronToken,
   txrpToken,
+  tworldErc20,
   tzkethErc20,
   xrpToken,
   zkethErc20,
@@ -3216,6 +3218,38 @@ export const coins = CoinMap.fromCoins([
     '0x6401f24ef7c54032f4f54e67492928973ab87650',
     UnderlyingAsset['tcoredao:stcore']
   ),
+  worldErc20(
+    '35cadba6-2324-4ad0-b809-fbdbb59e6ce3',
+    'world:wld',
+    'Worldcoin',
+    18,
+    '0x2cfc85d8e48f8eab294be644d9e25c3030863003',
+    UnderlyingAsset['world:wld']
+  ),
+  worldErc20(
+    '78aaa845-2c36-4f16-bc0f-6a4c65b43dab',
+    'world:usdc',
+    'USDC',
+    18,
+    '0x79a02482a880bce3f13e09da970dc34db4cd24d1',
+    UnderlyingAsset['world:usdc']
+  ),
+  tworldErc20(
+    'c5acdc9b-d0d4-4e0c-88fe-2cc68504cf86',
+    'tworld:wld',
+    'Worldcoin Testnet',
+    18,
+    '0x8803e47fd253915f9c860837f391aa71b3e03c5a',
+    UnderlyingAsset['tworld:wld']
+  ),
+  tworldErc20(
+    'd347b3ba-73ac-4f3d-bd3a-e68b7c1e4669',
+    'tworld:usdc',
+    'USDC',
+    18,
+    '0x66145f38cbac35ca6f1dfb4914df98f1614aea88',
+    UnderlyingAsset['tworld:usdc']
+  ),
   txrpToken(
     '8ef16158-1015-4a67-b6fe-db669c18ab2b',
     'txrp:tst-rP9jPyP5kyvFRb6ZiRghAGw5u8SGAmU4bd',