feat: add sdk-coin-evm

CODEOWNERS

@@ -62,6 +62,7 @@
 /modules/sdk-coin-cspr/ @BitGo/ethalt-team
 /modules/sdk-coin-dot/ @BitGo/ethalt-team
 /modules/sdk-coin-eos/ @BitGo/ethalt-team
+/modules/sdk-coin-evm/ @BitGo/ethalt-team
 /modules/sdk-coin-fetchai/ @BitGo/ethalt-team
 /modules/sdk-coin-flr/ @BitGo/ethalt-team
 /modules/sdk-coin-ethlike/ @BitGo/ethalt-team

Dockerfile

@@ -66,6 +66,7 @@ COPY --from=builder /tmp/bitgo/modules/abstract-cosmos /var/modules/abstract-cos
 COPY --from=builder /tmp/bitgo/modules/sdk-coin-avaxc /var/modules/sdk-coin-avaxc/
 COPY --from=builder /tmp/bitgo/modules/sdk-coin-avaxp /var/modules/sdk-coin-avaxp/
 COPY --from=builder /tmp/bitgo/modules/sdk-coin-eth /var/modules/sdk-coin-eth/
+COPY --from=builder /tmp/bitgo/modules/sdk-coin-evm /var/modules/sdk-coin-evm/
 COPY --from=builder /tmp/bitgo/modules/sdk-coin-baby /var/modules/sdk-coin-baby/
 COPY --from=builder /tmp/bitgo/modules/sdk-coin-bera /var/modules/sdk-coin-bera/
 COPY --from=builder /tmp/bitgo/modules/sdk-coin-bld /var/modules/sdk-coin-bld/
@@ -159,6 +160,7 @@ cd /var/modules/abstract-cosmos && yarn link && \
 cd /var/modules/sdk-coin-avaxc && yarn link && \
 cd /var/modules/sdk-coin-avaxp && yarn link && \
 cd /var/modules/sdk-coin-eth && yarn link && \
+cd /var/modules/sdk-coin-evm && yarn link && \
 cd /var/modules/sdk-coin-baby && yarn link && \
 cd /var/modules/sdk-coin-bera && yarn link && \
 cd /var/modules/sdk-coin-bld && yarn link && \
@@ -255,6 +257,7 @@ RUN cd /var/bitgo-express && \
     yarn link @bitgo/sdk-coin-avaxc && \
     yarn link @bitgo/sdk-coin-avaxp && \
     yarn link @bitgo/sdk-coin-eth && \
+    yarn link @bitgo/sdk-coin-evm && \
     yarn link @bitgo/sdk-coin-baby && \
     yarn link @bitgo/sdk-coin-bera && \
     yarn link @bitgo/sdk-coin-bld && \

modules/account-lib/package.json

@@ -46,6 +46,7 @@
     "@bitgo/sdk-coin-dot": "^4.2.0",
     "@bitgo/sdk-coin-etc": "^2.2.50",
     "@bitgo/sdk-coin-eth": "^24.5.0",
+    "@bitgo/sdk-coin-evm": "^1.0.0",
     "@bitgo/sdk-coin-fetchai": "^2.0.2",
     "@bitgo/sdk-coin-flr": "^1.2.7",
     "@bitgo/sdk-coin-hash": "^3.0.52",

modules/account-lib/src/index.ts

@@ -8,7 +8,7 @@ import {
   accountLibBaseCoin,
   acountLibCrypto,
 } from '@bitgo/sdk-core';
-import { BaseCoin as CoinConfig, coins } from '@bitgo/statics';
+import { BaseCoin as CoinConfig, coins, CoinFeature } from '@bitgo/statics';
 export { Ed25519BIP32, Eddsa };
 
 /**
@@ -191,6 +191,9 @@ export { Stt };
 import * as Soneium from '@bitgo/sdk-coin-soneium';
 export { Soneium };
 
+import * as EvmCoin from '@bitgo/sdk-coin-evm';
+export { EvmCoin };
+
 const coinBuilderMap = {
   trx: Trx.WrappedBuilder,
   ttrx: Trx.WrappedBuilder,
@@ -303,6 +306,16 @@ const coinBuilderMap = {
   tpolyx: Polyx.TransactionBuilderFactory,
 };
 
+/**
+ * coins.filter(coin => coin.coinFeature.has(EVM_SHARED_SDK)).forEach(coin => coinBuilderMap[coin.name] = EvmCoin.TransactionBuilder);
+ */
+
+coins
+  .filter((coin) => coin.features.includes(CoinFeature.SHARED_EVM_SDK))
+  .forEach((coin) => {
+    coinBuilderMap[coin.name] = EvmCoin.TransactionBuilder;
+  });
+
 /**
  * Get the list of coin tickers supported by this library.
  */

modules/account-lib/test/unit/keyPair/index.ts

@@ -12,7 +12,7 @@ describe('Key Pair Factory', () => {
   describe('coinToKey map initialization', function () {
     const supportedCoinsExceptTestnet = Object.keys(coinModules)
       // TODO(BG-40990): temporarily disable eth2 from the test for bls not initialized error
-      .filter((k) => coinModules[k].KeyPair && k.trim().toLowerCase() !== 'eth2');
+      .filter((k) => coinModules[k].KeyPair && !['eth2', 'evmcoin'].includes(k.trim().toLowerCase()));
 
     supportedCoinsExceptTestnet.forEach((coinName) => {
       it(`should initialize a ${coinName} keyPair map`, () => {

modules/account-lib/tsconfig.json

@@ -49,6 +49,9 @@
     {
       "path": "../sdk-coin-eth"
     },
+    {
+      "path": "../sdk-coin-evm"
+    },
     {
       "path": "../sdk-coin-flr"
     },

modules/bitgo/package.json

@@ -79,6 +79,7 @@
     "@bitgo/sdk-coin-eth": "^24.5.0",
     "@bitgo/sdk-coin-ethlike": "^1.2.18",
     "@bitgo/sdk-coin-ethw": "^20.0.83",
+    "@bitgo/sdk-coin-evm": "^1.0.0",
     "@bitgo/sdk-coin-fetchai": "^2.0.2",
     "@bitgo/sdk-coin-flr": "^1.2.7",
     "@bitgo/sdk-coin-hash": "^3.0.52",

modules/bitgo/src/v2/coinFactory.ts

@@ -9,7 +9,7 @@ import { Near, TNear } from '@bitgo/sdk-coin-near';
 import { SolToken } from '@bitgo/sdk-coin-sol';
 import { TrxToken } from '@bitgo/sdk-coin-trx';
 import { CoinFactory } from '@bitgo/sdk-core';
-import { CoinMap, coins, getFormattedTokens } from '@bitgo/statics';
+import { CoinFeature, CoinMap, coins, getFormattedTokens } from '@bitgo/statics';
 import {
   Ada,
   Algo,
@@ -49,6 +49,7 @@ import {
   Eth,
   Ethw,
   EthLikeCoin,
+  EvmCoin,
   FetchAi,
   Flr,
   TethLikeCoin,
@@ -345,6 +346,12 @@ export function registerCoinConstructors(coinFactory: CoinFactory, coinMap: Coin
   coinFactory.register('zeta', Zeta.createInstance);
   coinFactory.register('zketh', Zketh.createInstance);
 
+  coins
+    .filter((coin) => coin.features.includes(CoinFeature.SHARED_EVM_SDK))
+    .forEach((coin) => {
+      coinFactory.register(coin.name, EvmCoin.createInstance);
+    });
+
   const tokens = getFormattedTokens(coinMap);
 
   Erc20Token.createTokenConstructors([...tokens.bitcoin.eth.tokens, ...tokens.testnet.eth.tokens]).forEach(

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

@@ -31,6 +31,7 @@ import { Erc20Token, Eth, Gteth, Hteth, Teth } from '@bitgo/sdk-coin-eth';
 import { FetchAi, TfetchAi } from '@bitgo/sdk-coin-fetchai';
 import { Flr, Tflr } from '@bitgo/sdk-coin-flr';
 import { Ethw } from '@bitgo/sdk-coin-ethw';
+import { EvmCoin } from '@bitgo/sdk-coin-evm';
 import { EthLikeCoin, TethLikeCoin } from '@bitgo/sdk-coin-ethlike';
 import { Hash, Thash } from '@bitgo/sdk-coin-hash';
 import { Hbar, Thbar } from '@bitgo/sdk-coin-hbar';
@@ -102,6 +103,7 @@ export { Erc20Token, Eth, Gteth, Hteth, Teth };
 export { Ethw };
 export { EthLikeCoin, TethLikeCoin };
 export { Etc, Tetc };
+export { EvmCoin };
 export { FetchAi, TfetchAi };
 export { Flr, Tflr };
 export { Hash, Thash };

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

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

modules/bitgo/tsconfig.json

@@ -149,6 +149,9 @@
     {
       "path": "../sdk-coin-ethw"
     },
+    {
+      "path": "../sdk-coin-evm"
+    },
     {
       "path": "../sdk-coin-fetchai"
     },

modules/sdk-coin-evm/.eslintignore

@@ -0,0 +1 @@
+dist/

modules/sdk-coin-evm/.gitignore

@@ -0,0 +1,3 @@
+node_modules/
+.idea/
+dist/

modules/sdk-coin-evm/.mocharc.yml

@@ -0,0 +1,8 @@
+require: 'ts-node/register'
+timeout: '60000'
+reporter: 'min'
+reporter-option:
+  - 'cdn=true'
+  - 'json=false'
+exit: true
+spec: ['test/**/*.ts']

modules/sdk-coin-evm/.npmignore

@@ -0,0 +1,12 @@
+!dist/
+.idea/
+.prettierrc.yml
+tsconfig.json
+src/
+test/
+scripts/
+.nyc_output
+CODEOWNERS
+node_modules/
+.prettierignore
+.mocharc.js

modules/sdk-coin-evm/.prettierignore

@@ -0,0 +1,2 @@
+.nyc_output/
+dist/

modules/sdk-coin-evm/.prettierrc.yml

@@ -0,0 +1,3 @@
+printWidth: 120
+singleQuote: true
+trailingComma: 'es5'

modules/sdk-coin-evm/CHANGELOG.md

@@ -0,0 +1,4 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.

modules/sdk-coin-evm/README.md

@@ -0,0 +1,3 @@
+# @bitgo/sdk-coin-evm
+
+Configurable common module for EVM assets, using @bitgo/abstract-eth for reduced coin integration boilerplate

modules/sdk-coin-evm/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@bitgo/sdk-coin-evm",
+  "version": "1.0.0",
+  "description": "Configurable common module for EVM assets, using @bitgo/abstract-eth for reduced coin integration boilerplate.",
+  "main": "./dist/src/index.js",
+  "types": "./dist/src/index.d.ts",
+  "scripts": {
+    "build": "yarn tsc --build --incremental --verbose .",
+    "fmt": "prettier --write .",
+    "check-fmt": "prettier --check .",
+    "clean": "rm -r ./dist",
+    "lint": "eslint --quiet .",
+    "test": "npm run coverage",
+    "coverage": "nyc -- npm run unit-test",
+    "unit-test": "mocha",
+    "prepare": "npm run build"
+  },
+  "dependencies": {
+    "@bitgo/abstract-eth": "^24.4.0",
+    "@bitgo/sdk-core": "^35.1.0",
+    "@bitgo/statics": "^54.1.0",
+    "@ethereumjs/common": "^2.6.5"
+  },
+  "devDependencies": {},
+  "author": "BitGo SDK Team <[email protected]>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/BitGo/BitGoJS.git",
+    "directory": "modules/sdk-coin-evm"
+  },
+  "files": [
+    "dist/src"
+  ],
+  "lint-staged": {
+    "*.{js,ts}": [
+      "yarn prettier --write",
+      "yarn eslint --fix"
+    ]
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "nyc": {
+    "extension": [
+      ".ts"
+    ]
+  }
+}

modules/sdk-coin-evm/src/evm.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 './evm';
+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';