Merge pull request #6124 from BitGo/WIN-5490_soneium

feat(sdk-coin-soneium): add soneium token support

Author: adarsh312

modules/bitgo/src/v2/coinFactory.ts

@@ -83,6 +83,7 @@ import {
   Sip10Token,
   Sol,
   Soneium,
+  SoneiumToken,
   StellarToken,
   Stx,
   Stt,
@@ -384,6 +385,10 @@ export function registerCoinConstructors(coinFactory: CoinFactory, coinMap: Coin
     coinFactory.register(name, coinConstructor);
   });
 
+  SoneiumToken.createTokenConstructors().forEach(({ name, coinConstructor }) => {
+    coinFactory.register(name, coinConstructor);
+  });
+
   ArbethToken.createTokenConstructors().forEach(({ name, coinConstructor }) => {
     coinFactory.register(name, coinConstructor);
   });

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

@@ -49,7 +49,7 @@ import { Polyx, Tpolyx } 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';
-import { Soneium, Tsoneium } from '@bitgo/sdk-coin-soneium';
+import { Soneium, Tsoneium, SoneiumToken } from '@bitgo/sdk-coin-soneium';
 import { Stt, Tstt } from '@bitgo/sdk-coin-stt';
 import { Sgb, Tsgb } from '@bitgo/sdk-coin-sgb';
 import { Sol, Tsol } from '@bitgo/sdk-coin-sol';
@@ -118,7 +118,7 @@ export { Rbtc, Trbtc };
 export { Rune, Trune };
 export { Sgb, Tsgb };
 export { Sol, Tsol };
-export { Soneium, Tsoneium };
+export { Soneium, Tsoneium, SoneiumToken };
 export { Stt, Tstt };
 export { Stx, Tstx, Sip10Token };
 export { Sui, Tsui, SuiToken };

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

@@ -39,6 +39,7 @@ describe('Coins', () => {
       Icp: 1,
       Ticp: 1,
       Sip10Token: 1,
+      SoneiumToken: 1,
       Polyx: 1,
       Tpolyx: 1,
     };

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

@@ -1,4 +1,5 @@
 export * from './lib';
 export * from './soneium';
 export * from './tsoneium';
+export * from './soneiumToken';
 export * from './register';

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

@@ -1,8 +1,12 @@
 import { BitGoBase } from '@bitgo/sdk-core';
 import { Soneium } from './soneium';
 import { Tsoneium } from './tsoneium';
+import { SoneiumToken } from './soneiumToken';
 
 export const register = (sdk: BitGoBase): void => {
   sdk.register('soneium', Soneium.createInstance);
   sdk.register('tsoneium', Tsoneium.createInstance);
+  SoneiumToken.createTokenConstructors().forEach(({ name, coinConstructor }) => {
+    sdk.register(name, coinConstructor);
+  });
 };

modules/sdk-coin-soneium/src/soneiumToken.ts

@@ -0,0 +1,56 @@
+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 SoneiumToken extends EthLikeToken {
+  public readonly tokenConfig: EthLikeTokenConfig;
+  static coinNames: CoinNames = {
+    Mainnet: 'soneium',
+    Testnet: 'tsoneium',
+  };
+
+  constructor(bitgo: BitGoBase, tokenConfig: EthLikeTokenConfig) {
+    super(bitgo, tokenConfig, SoneiumToken.coinNames);
+  }
+
+  static createTokenConstructor(config: EthLikeTokenConfig): CoinConstructor {
+    return super.createTokenConstructor(config, SoneiumToken.coinNames);
+  }
+
+  static createTokenConstructors(): NamedCoinConstructor[] {
+    return super.createTokenConstructors(SoneiumToken.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 Soneium blockchain 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 Soneium explorer
+   */
+  async recoveryBlockchainExplorerQuery(query: Record<string, string>): Promise<Record<string, unknown>> {
+    const apiToken = common.Environments[this.bitgo.getEnv()].soneiumExplorerApiToken;
+    const explorerUrl = common.Environments[this.bitgo.getEnv()].soneiumExplorerBaseUrl;
+    return await recoveryBlockchainExplorerQuery(query, explorerUrl as string, apiToken);
+  }
+
+  getFullName(): string {
+    return 'Soneium Token';
+  }
+}

modules/statics/src/base.ts

@@ -2433,6 +2433,11 @@ export enum UnderlyingAsset {
   'tbera:usdc' = 'tbera:usdc',
   'tbera:ibera' = 'tbera:ibera',
 
+  // Soneium NFTs
+  // generic NFTs
+  'erc721:soneiumtoken' = 'erc721:soneiumtoken',
+  'erc1155:soneiumtoken' = 'erc1155:soneiumtoken',
+
   ERC721 = 'erc721',
   ERC1155 = 'erc1155',
   NONSTANDARD = 'nonstandard',

modules/statics/src/coins.ts

@@ -2347,6 +2347,50 @@ export const coins = CoinMap.fromCoins([
     Networks.test.polygon,
     KeyCurve.Secp256k1
   ),
+  erc721(
+    '7c8a60a0-8ced-4429-b868-02106b3a478d',
+    'erc721:soneiumtoken',
+    'Generic Soneium ERC721',
+    '0xerc721:soneiumtoken',
+    GENERIC_TOKEN_FEATURES,
+    '',
+    '',
+    Networks.main.soneium,
+    KeyCurve.Secp256k1
+  ),
+  erc1155(
+    '64b57b9f-3aaf-4518-95fb-4458abc828fd',
+    'erc1155:soneiumtoken',
+    'Generic Soneium ERC1155',
+    '0xerc1155:soneiumtoken',
+    GENERIC_TOKEN_FEATURES,
+    '',
+    '',
+    Networks.main.polygon,
+    KeyCurve.Secp256k1
+  ),
+  terc721(
+    'c3fd9b27-b7df-4287-8991-58c15d004e83',
+    'terc721:soneiumtoken',
+    'Generic Soneium ERC721',
+    '0xterc721:soneiumtoken',
+    GENERIC_TOKEN_FEATURES,
+    '',
+    '',
+    Networks.test.soneium,
+    KeyCurve.Secp256k1
+  ),
+  terc1155(
+    '8c27076a-c84b-4735-a263-8c47f604df69',
+    'terc1155:soneiumtoken',
+    'Generic Soneium ERC1155',
+    '0xterc1155:soneiumtoken',
+    GENERIC_TOKEN_FEATURES,
+    '',
+    '',
+    Networks.test.soneium,
+    KeyCurve.Secp256k1
+  ),
   arbethErc20(
     '14a21e93-b123-4437-b99f-0489947d0379',
     'arbeth:link',
@@ -3532,6 +3576,10 @@ export function createTokenMapUsingConfigDetails(tokenConfigMap: Record<string,
     'erc1155:polygontoken',
     'terc721:polygontoken',
     'terc1155:polygontoken',
+    'erc721:soneiumtoken',
+    'erc1155:soneiumtoken',
+    'terc721:soneiumtoken',
+    'terc1155:soneiumtoken',
   ]);
 
   // Add all the coins from statics coin map first

modules/statics/src/tokenConfig.ts

@@ -126,6 +126,9 @@ export interface Tokens {
     polygon: {
       tokens: EthLikeTokenConfig[];
     };
+    soneium: {
+      tokens: EthLikeTokenConfig[];
+    };
     bsc: {
       tokens: EthLikeTokenConfig[];
     };
@@ -194,6 +197,9 @@ export interface Tokens {
     polygon: {
       tokens: EthLikeTokenConfig[];
     };
+    soneium: {
+      tokens: EthLikeTokenConfig[];
+    };
     arbeth: {
       tokens: EthLikeTokenConfig[];
     };
@@ -428,6 +434,21 @@ const getFormattedPolygonTokens = (customCoinMap = coins) =>
     return acc;
   }, []);
 
+const getFormattedSoneiumTokens = (customCoinMap = coins) =>
+  customCoinMap.reduce((acc: EthLikeTokenConfig[], coin) => {
+    if ((coin instanceof Erc721Coin || coin instanceof Erc1155Coin) && coin.family === CoinFamily.SONEIUM) {
+      acc.push({
+        type: coin.name,
+        coin: coin.network.type === NetworkType.MAINNET ? 'soneium' : 'tsoneium',
+        network: coin.network.type === NetworkType.MAINNET ? 'Mainnet' : 'Testnet',
+        name: coin.fullName,
+        tokenContractAddress: coin.contractAddress.toString().toLowerCase(),
+        decimalPlaces: coin.decimalPlaces,
+      });
+    }
+    return acc;
+  }, []);
+
 const getFormattedArbethTokens = (customCoinMap = coins) =>
   customCoinMap.reduce((acc: EthLikeTokenConfig[], coin) => {
     if (coin instanceof ArbethERC20Token) {
@@ -665,6 +686,9 @@ export const getFormattedTokens = (coinMap = coins): Tokens => {
       polygon: {
         tokens: getFormattedPolygonTokens(coinMap).filter((token) => token.network === 'Mainnet'),
       },
+      soneium: {
+        tokens: getFormattedSoneiumTokens(coinMap).filter((token) => token.network === 'Mainnet'),
+      },
       arbeth: {
         tokens: getFormattedArbethTokens(coinMap).filter((token) => token.network === 'Mainnet'),
       },
@@ -732,6 +756,9 @@ export const getFormattedTokens = (coinMap = coins): Tokens => {
       polygon: {
         tokens: getFormattedPolygonTokens(coinMap).filter((token) => token.network === 'Testnet'),
       },
+      soneium: {
+        tokens: getFormattedSoneiumTokens(coinMap).filter((token) => token.network === 'Testnet'),
+      },
       arbeth: {
         tokens: getFormattedArbethTokens(coinMap).filter((token) => token.network === 'Testnet'),
       },