Merge pull request #8292 from BitGo/CECHO-354

feat: add support for L1 fee buffers in gas calculations for multiple coin families

Author: shubham-damkondwar

.gitignore

@@ -1,4 +1,5 @@
 node_modules/
+.worktrees/
 .idea/
 *.iml
 lerna-debug.log

modules/abstract-eth/src/abstractEthLikeNewCoins.ts

@@ -72,6 +72,7 @@ import { AbstractEthLikeCoin } from './abstractEthLikeCoin';
 import { EthLikeToken } from './ethLikeToken';
 import {
   calculateForwarderV1Address,
+  coinFamiliesWithL1Fees,
   decodeTransferData,
   ERC1155TransferBuilder,
   ERC721TransferBuilder,
@@ -1516,10 +1517,9 @@ export abstract class AbstractEthLikeNewCoins extends AbstractEthLikeCoin {
     const backupKeyBalance = await this.queryAddressBalance(backupKeyAddress, params.apiKey);
     let totalGasNeeded = gasPrice.mul(gasLimit);
 
-    // On optimism chain, L1 fees is to be paid as well apart from L2 fees
-    // So we are adding the amount that can be used up as l1 fees
-    if (this.staticsCoin?.family === 'opeth') {
-      totalGasNeeded = totalGasNeeded.add(new optionalDeps.ethUtil.BN(ethGasConfigs.opethGasL1Fees));
+    // On L2 chains with L1 data fees, add buffer for L1 fees
+    if (this.staticsCoin?.family !== undefined && coinFamiliesWithL1Fees.includes(this.staticsCoin.family)) {
+      totalGasNeeded = totalGasNeeded.add(new optionalDeps.ethUtil.BN(ethGasConfigs.l1GasFeeBuffer));
     }
 
     const weiToGwei = 10 ** 9;
@@ -2515,7 +2515,11 @@ export abstract class AbstractEthLikeNewCoins extends AbstractEthLikeCoin {
 
   async validateBalanceAndGetTxAmount(baseAddress: string, gasPrice: BN, gasLimit: BN, apiKey?: string) {
     const baseAddressBalance = await this.queryAddressBalance(baseAddress, apiKey);
-    const totalGasNeeded = gasPrice.mul(gasLimit);
+    let totalGasNeeded = gasPrice.mul(gasLimit);
+    // On L2 chains with L1 data fees, add buffer for L1 fees
+    if (this.staticsCoin?.family !== undefined && coinFamiliesWithL1Fees.includes(this.staticsCoin.family)) {
+      totalGasNeeded = totalGasNeeded.add(new optionalDeps.ethUtil.BN(ethGasConfigs.l1GasFeeBuffer));
+    }
     const weiToGwei = new BN(10 ** 9);
     if (baseAddressBalance.lt(totalGasNeeded)) {
       throw new Error(

modules/abstract-eth/src/ethLikeToken.ts

@@ -8,6 +8,7 @@ import { BigNumber } from 'bignumber.js';
 
 import { BitGoBase, CoinConstructor, NamedCoinConstructor, getIsUnsignedSweep, Util } from '@bitgo/sdk-core';
 import {
+  coinFamiliesWithL1Fees,
   TransactionBuilder as EthLikeTransactionBuilder,
   TransferBuilder as EthLikeTransferBuilder,
   KeyPair as KeyPairLib,
@@ -276,10 +277,9 @@ export class EthLikeToken extends AbstractEthLikeNewCoins {
 
     let totalGasNeeded = gasPrice.mul(gasLimit);
 
-    // On optimism chain, L1 fees is to be paid as well apart from L2 fees
-    // So we are adding the amount that can be used up as l1 fees
-    if (this.staticsCoin?.family === 'opeth') {
-      totalGasNeeded = totalGasNeeded.add(new optionalDeps.ethUtil.BN(ethGasConfigs.opethGasL1Fees));
+    // On L2 chains with L1 data fees, add buffer for L1 fees
+    if (this.staticsCoin?.family !== undefined && coinFamiliesWithL1Fees.includes(this.staticsCoin.family)) {
+      totalGasNeeded = totalGasNeeded.add(new optionalDeps.ethUtil.BN(ethGasConfigs.l1GasFeeBuffer));
     }
 
     const weiToGwei = 10 ** 9;

modules/abstract-eth/src/lib/constants.ts

@@ -0,0 +1,8 @@
+import { CoinFamily } from '@bitgo/statics';
+
+/** L2 coin families that incur L1 data fees during recovery transactions */
+export const coinFamiliesWithL1Fees: ReadonlyArray<CoinFamily> = [
+  CoinFamily.OPETH,
+  CoinFamily.DOGEOS,
+  CoinFamily.MORPHETH,
+];

modules/abstract-eth/src/lib/index.ts

@@ -1,3 +1,4 @@
+export * from './constants';
 export * from './contractCall';
 export * from './iface';
 export * from './keyPair';

modules/statics/src/tokenConfig.ts

@@ -345,7 +345,7 @@ export const ethGasConfigs = {
   minimumGasLimit: 30000, // minimum gas limit a user can set for a send
   maximumGasLimit: 20000000, // Customers cannot set gas limits beyond this amount
   newEthLikeCoinsMinGasLimit: 400000, // minimum gas limit a user can set for a send for eth like coins like arbitrum, optimism, etc
-  opethGasL1Fees: 1000000000000000, // Buffer for opeth L1 gas fees
+  l1GasFeeBuffer: 1000000000000000, // Buffer for L1 data fees
 };
 
 function getStellarTokenConfig(coin: StellarCoin): StellarTokenConfig {