Merge pull request #6299 from BitGo/COIN-4511

fix: fixed the common handling for ethlike coin

Author: HimanshuS2212

modules/sdk-coin-ethlike/src/ethlikeCoin.ts

@@ -4,6 +4,12 @@ import { BaseCoin, BitGoBase, common } from '@bitgo/sdk-core';
 import { BaseCoin as StaticsBaseCoin, coins } from '@bitgo/statics';
 import { EthLikeTransactionBuilder } from './lib';
 
+interface CommonConfig {
+  chain?: number;
+  chainId?: number;
+  hardfork?: string;
+}
+
 export class EthLikeCoin extends AbstractEthLikeNewCoins {
   protected constructor(bitgo: BitGoBase, staticsCoin?: Readonly<StaticsBaseCoin>) {
     super(bitgo, staticsCoin);
@@ -13,8 +19,31 @@ export class EthLikeCoin extends AbstractEthLikeNewCoins {
     return new EthLikeCoin(bitgo, staticsCoin);
   }
 
-  protected getTransactionBuilder(common?: EthereumCommon): EthLikeTransactionBuilder {
-    return new EthLikeTransactionBuilder(coins.get(this.getBaseChain()), common);
+  protected getTransactionBuilder(common?: EthereumCommon | CommonConfig): EthLikeTransactionBuilder {
+    let ethereumCommon: EthereumCommon | undefined;
+
+    // If common is an EthereumCommon instance, use it directly
+    if (common instanceof EthereumCommon) {
+      ethereumCommon = common;
+    }
+    // If common is provided as a plain object, convert it to EthereumCommon instance
+    else if (common && typeof common === 'object') {
+      try {
+        const chainId = common.chain || common.chainId;
+        const hardfork = common.hardfork || 'london';
+
+        if (chainId) {
+          ethereumCommon = EthereumCommon.custom({
+            name: this.getFullName(),
+            chainId: chainId,
+            defaultHardfork: hardfork,
+          });
+        }
+      } catch (error) {
+        ethereumCommon = undefined;
+      }
+    }
+    return new EthLikeTransactionBuilder(coins.get(this.getBaseChain()), ethereumCommon);
   }
 
   async recoveryBlockchainExplorerQuery(query: Record<string, string>): Promise<Record<string, unknown>> {

modules/sdk-coin-ethlike/test/unit/ethlikeCoin.ts

@@ -672,4 +672,58 @@ describe('EthLikeCoin', function () {
       transaction.halfSigned?.should.have.property('recipients');
     });
   });
+
+  describe('Common parameter handling', function () {
+    it('should handle plain object common parameter for BASE chain', function () {
+      const baseCoin = bitgo.coin('baseeth') as EthLikeCoin;
+
+      const plainCommon = { chain: 8453, hardfork: 'london' };
+
+      const txBuilder = (baseCoin as any).getTransactionBuilder(plainCommon);
+      txBuilder.should.be.an.instanceof(EthLikeTransactionBuilder);
+    });
+
+    it('should handle plain object common parameter with chainId property', function () {
+      const baseCoin = bitgo.coin('baseeth') as EthLikeCoin;
+
+      const plainCommon = { chainId: 8453, hardfork: 'london' };
+
+      const txBuilder = (baseCoin as any).getTransactionBuilder(plainCommon);
+      txBuilder.should.be.an.instanceof(EthLikeTransactionBuilder);
+    });
+
+    it('should handle EthereumCommon instance', function () {
+      const baseCoin = bitgo.coin('baseeth') as EthLikeCoin;
+
+      const txBuilder = (baseCoin as any).getTransactionBuilder(baseChainCommon);
+      txBuilder.should.be.an.instanceof(EthLikeTransactionBuilder);
+    });
+
+    it('should require common parameter and throw error when undefined', function () {
+      const baseCoin = bitgo.coin('baseeth') as EthLikeCoin;
+
+      (() => {
+        (baseCoin as any).getTransactionBuilder(undefined);
+      }).should.throw('Common must be provided for EthLikeTransactionBuilder');
+    });
+
+    it('should convert plain object common to EthereumCommon with working gteHardfork method', function () {
+      const baseCoin = bitgo.coin('baseeth') as EthLikeCoin;
+
+      const plainCommon = { chain: 8453, hardfork: 'london' };
+
+      const txBuilder = (baseCoin as any).getTransactionBuilder(plainCommon);
+      txBuilder.should.be.an.instanceof(EthLikeTransactionBuilder);
+
+      const common = (txBuilder as any)._common;
+      common.should.not.be.undefined;
+
+      common.should.have.property('gteHardfork');
+      (typeof common.gteHardfork).should.equal('function');
+
+      const result = common.gteHardfork('homestead');
+      (typeof result).should.equal('boolean');
+      result.should.equal(true);
+    });
+  });
 });