Merge pull request #6306 from BitGo/WIN-5910

feat(sdk-coin-evm): add EvmCoin & transaction builder

Author: hitansh-madan

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

@@ -43,6 +43,7 @@ describe('Coins', () => {
       Polyx: 1,
       Tpolyx: 1,
       CoredaoToken: 1,
+      EvmCoin: 1,
       Nep141Token: 1,
     };
     Object.keys(BitGoJS.Coin)

modules/sdk-coin-evm/package.json

@@ -15,6 +15,13 @@
     "unit-test": "mocha",
     "prepare": "npm run build"
   },
+  "dependencies": {
+    "@bitgo/abstract-eth": "^24.5.2",
+    "@bitgo/sdk-core": "^35.3.0",
+    "@bitgo/statics": "^54.4.0",
+    "@ethereumjs/common": "^2.6.5"
+  },
+  "devDependencies": {},
   "author": "BitGo SDK Team <[email protected]>",
   "license": "MIT",
   "repository": {

modules/sdk-coin-evm/src/evmCoin.ts

@@ -0,0 +1,68 @@
+/**
+ * @prettier
+ */
+import { BaseCoin, BitGoBase, common, MPCAlgorithm, MultisigType, multisigTypes } from '@bitgo/sdk-core';
+import { BaseCoin as StaticsBaseCoin, CoinFeature, coins } from '@bitgo/statics';
+import {
+  AbstractEthLikeNewCoins,
+  OfflineVaultTxInfo,
+  RecoverOptions,
+  recoveryBlockchainExplorerQuery,
+  TransactionBuilder as EthLikeTransactionBuilder,
+  UnsignedSweepTxMPCv2,
+} from '@bitgo/abstract-eth';
+import { TransactionBuilder } from './lib';
+import assert from 'assert';
+
+export class EvmCoin extends AbstractEthLikeNewCoins {
+  protected constructor(bitgo: BitGoBase, staticsCoin?: Readonly<StaticsBaseCoin>) {
+    super(bitgo, staticsCoin);
+  }
+
+  static createInstance(bitgo: BitGoBase, staticsCoin?: Readonly<StaticsBaseCoin>): BaseCoin {
+    return new EvmCoin(bitgo, staticsCoin);
+  }
+
+  protected getTransactionBuilder(): EthLikeTransactionBuilder {
+    return new TransactionBuilder(coins.get(this.getBaseChain()));
+  }
+
+  /** @inheritDoc */
+  supportsTss(): boolean {
+    return this.staticsCoin?.features.includes(CoinFeature.TSS) ?? false;
+  }
+
+  /** inherited doc */
+  getDefaultMultisigType(): MultisigType {
+    return this.staticsCoin?.features.includes(CoinFeature.TSS) ? multisigTypes.tss : multisigTypes.onchain;
+  }
+
+  /** @inheritDoc */
+  getMPCAlgorithm(): MPCAlgorithm {
+    return 'ecdsa';
+  }
+
+  protected async buildUnsignedSweepTxnTSS(params: RecoverOptions): Promise<OfflineVaultTxInfo | UnsignedSweepTxMPCv2> {
+    if (this.staticsCoin?.features.includes(CoinFeature.MPCV2)) {
+      return this.buildUnsignedSweepTxnMPCv2(params);
+    }
+    return super.buildUnsignedSweepTxnTSS(params);
+  }
+
+  /**
+   * Make a query to 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 from chain explorer
+   */
+  async recoveryBlockchainExplorerQuery(query: Record<string, string>): Promise<Record<string, unknown>> {
+    const evmConfig = common.Environments[this.bitgo.getEnv()].evm;
+    assert(
+      evmConfig && this.getFamily() in evmConfig,
+      `env config is missing for ${this.getFamily()} in ${this.bitgo.getEnv()}`
+    );
+
+    const apiToken = evmConfig[this.getFamily()].apiToken;
+    const explorerUrl = evmConfig[this.getFamily()].baseUrl;
+    return await recoveryBlockchainExplorerQuery(query, explorerUrl as string, apiToken as string);
+  }
+}

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

@@ -0,0 +1,3 @@
+export * from './evmCoin';
+export * from './lib';
+export * from './register';

modules/sdk-coin-evm/src/lib/index.ts

@@ -0,0 +1,6 @@
+import * as Utils from './utils';
+
+export { TransactionBuilder } from './transactionBuilder';
+export { TransferBuilder } from './transferBuilder';
+export { Transaction, KeyPair } from '@bitgo/abstract-eth';
+export { Utils };

modules/sdk-coin-evm/src/lib/transactionBuilder.ts

@@ -0,0 +1,36 @@
+import { BaseCoin as CoinConfig } from '@bitgo/statics';
+import { BuildTransactionError, TransactionType } from '@bitgo/sdk-core';
+import { TransactionBuilder as AbstractTransactionBuilder, Transaction } from '@bitgo/abstract-eth';
+import { getCommon } from './utils';
+import { TransferBuilder } from './transferBuilder';
+
+export class TransactionBuilder extends AbstractTransactionBuilder {
+  protected _transfer: TransferBuilder;
+  private _signatures: any;
+
+  constructor(_coinConfig: Readonly<CoinConfig>) {
+    super(_coinConfig);
+    this._common = getCommon(this._coinConfig);
+    this.transaction = new Transaction(this._coinConfig, this._common);
+  }
+
+  /** @inheritdoc */
+  transfer(data?: string): TransferBuilder {
+    if (this._type !== TransactionType.Send) {
+      throw new BuildTransactionError('Transfers can only be set for send transactions');
+    }
+    if (!this._transfer) {
+      this._transfer = new TransferBuilder(data);
+    }
+    return this._transfer;
+  }
+
+  addSignature(publicKey, signature) {
+    this._signatures = [];
+    this._signatures.push({ publicKey, signature });
+  }
+
+  protected getContractData(addresses: string[]): string {
+    throw new Error('Method not implemented.');
+  }
+}

modules/sdk-coin-evm/src/lib/transferBuilder.ts

@@ -0,0 +1 @@
+export { TransferBuilder } from '@bitgo/abstract-eth';

modules/sdk-coin-evm/src/lib/utils.ts

@@ -0,0 +1,25 @@
+import { CoinFeature, NetworkType, BaseCoin, EthereumNetwork } from '@bitgo/statics';
+import EthereumCommon from '@ethereumjs/common';
+import { InvalidTransactionError } from '@bitgo/sdk-core';
+
+/**
+ * @param {NetworkType} network either mainnet or testnet
+ * @returns {EthereumCommon} Ethereum common configuration object
+ */
+export function getCommon(coin: Readonly<BaseCoin>): EthereumCommon {
+  if (!coin.features.includes(CoinFeature.SHARED_EVM_SDK)) {
+    throw new InvalidTransactionError(`Cannot use common sdk module for the coin ${coin.name}`);
+  }
+  return EthereumCommon.custom(
+    {
+      name: coin.network.name,
+      networkId: (coin.network as EthereumNetwork).chainId,
+      chainId: (coin.network as EthereumNetwork).chainId,
+    },
+    {
+      baseChain: coin.network.type === NetworkType.MAINNET ? 'mainnet' : 'sepolia',
+      hardfork: coin.features.includes(CoinFeature.EIP1559) ? 'london' : undefined,
+      eips: coin.features.includes(CoinFeature.EIP1559) ? [1559] : undefined,
+    }
+  );
+}

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

@@ -0,0 +1,11 @@
+import { BitGoBase } from '@bitgo/sdk-core';
+import { CoinFeature, coins } from '@bitgo/statics';
+import { EvmCoin } from './evmCoin';
+
+export const register = (sdk: BitGoBase): void => {
+  coins
+    .filter((coin) => coin.features.includes(CoinFeature.SHARED_EVM_SDK))
+    .forEach((coin) => {
+      sdk.register(coin.name, EvmCoin.createInstance);
+    });
+};

modules/sdk-core/src/bitgo/environments.ts

@@ -86,6 +86,12 @@ interface EnvironmentTemplate {
   soneiumExplorerApiToken?: string;
   stxNodeUrl: string;
   vetNodeUrl: string;
+  evm?: {
+    [key: string]: {
+      baseUrl: string;
+      apiToken?: string;
+    };
+  };
 }
 
 export interface Environment extends EnvironmentTemplate {