Merge pull request #2358 from AmbireTech/feature/add-gas-field-to-advanced-form

Feature/add gas field to advanced form

Author: Oxbobby

src/controllers/signAccountOp/signAccountOp.test.ts

@@ -55,6 +55,7 @@ import { ProvidersController } from '../providers/providers'
 import { SafeController } from '../safe/safe'
 import { SelectedAccountController } from '../selectedAccount/selectedAccount'
 import { StorageController } from '../storage/storage'
+import { SurveyController } from '../survey/survey'
 import { UiController } from '../ui/ui'
 import { getFeeSpeedIdentifier } from './helper'
 import { FeeSpeed, SigningStatus } from './signAccountOp'
@@ -426,10 +427,24 @@ const init = async (
     {},
     new InviteController({ relayerUrl, fetch, storage: storageCtrl })
   )
+  const surveyCtrl = new SurveyController({
+    fetch,
+    relayerUrl,
+    storage: storageCtrl,
+    ui: uiCtrl,
+    dismissBanner: () => {}
+  })
+  const bannerCtrl = new BannerController(
+    storageCtrl,
+    () => ({ status: 'no-selected-account' }),
+    surveyCtrl,
+    'test'
+  )
   const selectedAccountCtrl = new SelectedAccountController({
     storage: storageCtrl,
     accounts: accountsCtrl,
-    autoLogin: autoLoginCtrl
+    autoLogin: autoLoginCtrl,
+    banner: bannerCtrl
   })
   const addressBookCtrl = new AddressBookController(storageCtrl, accountsCtrl, selectedAccountCtrl)
   await accountsCtrl.initialLoadPromise
@@ -447,7 +462,7 @@ const init = async (
     keystore,
     'https://staging-relayer.ambire.com',
     velcroUrl,
-    new BannerController(storageCtrl),
+    bannerCtrl,
     featureFlagsCtrl
   )
   const phishing = new PhishingController({
@@ -871,6 +886,7 @@ describe('SignAccountOp Controller ', () => {
       paidBy: eoaAccount.addr,
       broadcastOption: BROADCAST_OPTIONS.bySelf,
       paidByKeyType: 'internal',
+      isCustomGasLimit: false,
       isGasTank: false,
       inToken: '0x0000000000000000000000000000000000000000',
       feeTokenChainId: 1n,

src/controllers/signAccountOp/signAccountOp.ts

@@ -96,6 +96,7 @@ import {
   FeePaymentOption,
   FullEstimationSummary
 } from '../../libs/estimate/interfaces'
+import { calculateFeeAmount } from '../../libs/fees/fees'
 import { humanizeAccountOp } from '../../libs/humanizer'
 import { HumanizerWarning, IrCall } from '../../libs/humanizer/interfaces'
 import { hasRelayerSupport, relayerAdditionalNetworks } from '../../libs/networks/networks'
@@ -201,6 +202,7 @@ export const noStateUpdateStatuses = [
 export type SignAccountOpUpdateProps = {
   gasPrices?: GasSpeeds
   customGasPrices?: GasSpeeds
+  customGasLimit?: bigint
   feeToken?: TokenResult
   paidBy?: string
   paidByKeyType?: Key['type']
@@ -260,6 +262,8 @@ export class SignAccountOpController extends EventEmitter implements ISignAccoun
 
   hasCustomGasPrices: boolean = false
 
+  customGasLimit?: bigint
+
   feeSpeeds: {
     [identifier: string]: SpeedCalc[]
   } = {}
@@ -1234,6 +1238,7 @@ export class SignAccountOpController extends EventEmitter implements ISignAccoun
   update({
     gasPrices,
     customGasPrices,
+    customGasLimit,
     feeToken,
     paidBy,
     speed,
@@ -1390,6 +1395,10 @@ export class SignAccountOpController extends EventEmitter implements ISignAccoun
         this.gasPrices = gasPrices
       }
 
+      if (typeof customGasLimit !== 'undefined') {
+        this.customGasLimit = customGasLimit
+      }
+
       this.#syncSpeedUpFeeSelectionFromEstimation()
 
       if (feeToken && paidBy && !isSpeedUpTransaction) {
@@ -1461,6 +1470,7 @@ export class SignAccountOpController extends EventEmitter implements ISignAccoun
         Array.isArray(accountOpData?.calls) ||
         gasPrices ||
         customGasPrices ||
+        typeof customGasLimit !== 'undefined' ||
         this.#paidBy ||
         this.feeTokenResult ||
         hasNewEstimation
@@ -1754,38 +1764,6 @@ export class SignAccountOpController extends EventEmitter implements ISignAccoun
     return BigInt(toBigInt)
   }
 
-  static getAmountAfterFeeTokenConvert(
-    simulatedGasLimit: bigint,
-    gasPrice: bigint,
-    nativeRatio: bigint,
-    feeTokenDecimals: number,
-    addedNative: bigint
-  ) {
-    const amountInWei = simulatedGasLimit * gasPrice + addedNative
-
-    // Let's break down the process of converting the amount into FeeToken:
-    // 1. Initially, we multiply the amount in wei by the native to fee token ratio.
-    // 2. Next, we address the decimal places:
-    // 2.1. First, we convert wei to native by dividing by 10^18 (representing the decimals).
-    // 2.2. Now, with the amount in the native token, we incorporate nativeRatio decimals into the calculation (18 + 18) to standardize the amount.
-    // 2.3. At this point, we precisely determine the number of fee tokens. For instance, if the amount is 3 USDC, we must convert it to a BigInt value, while also considering feeToken.decimals.
-    const extraDecimals = BigInt(10 ** 18)
-    const feeTokenExtraDecimals = BigInt(10 ** (18 - feeTokenDecimals))
-    const pow = extraDecimals * feeTokenExtraDecimals
-    const result = (amountInWei * nativeRatio) / pow
-
-    // Fixes the edge case where the fee in wei is not zero
-    // but the decimals of the token we are converting to
-    // cannot represent the amount in wei. Example: 0.(6zeros)1 USDC
-    // We are returning 1n which is the smallest possible amount
-    // to be represented in USDC
-    if (result === 0n && amountInWei !== 0n) {
-      return 1n
-    }
-
-    return result
-  }
-
   async #traceCall() {
     // `traceCall` should not be invoked too frequently. However, if there is a pending timeout,
     // it should be cleared to prevent the previous interval from changing the status
@@ -1880,15 +1858,6 @@ export class SignAccountOpController extends EventEmitter implements ISignAccoun
     clearTimeout(timeoutId)
   }
 
-  /**
-   * Increase the paymaster fee by 10%, the relayer by 5%.
-   * This is required because even now, we are broadcasting at a loss
-   */
-  #increaseFee(amount: bigint, broadcaster: string = 'relayer'): bigint {
-    if (broadcaster === 'paymaster') return amount + amount / 10n
-    return amount + amount / 20n
-  }
-
   #addExtra(gasInWei: bigint, percentageIncrease: bigint): Hex {
     const percent = 100n / percentageIncrease
     return toBeHex(gasInWei + gasInWei / percent) as Hex
@@ -2009,23 +1978,18 @@ export class SignAccountOpController extends EventEmitter implements ISignAccoun
         let simulatedGasLimit: bigint
         let gasPrice
         let maxPriorityFeePerGas
+        let amountGasPrice: bigint
+        let usesPaymaster = false
 
         if (broadcastOption === BROADCAST_OPTIONS.byBundler) {
           if (!estimation.bundlerEstimation) return
 
-          const usesPaymaster = estimation.bundlerEstimation?.paymaster.isUsable()
+          usesPaymaster = !!estimation.bundlerEstimation?.paymaster.isUsable()
           simulatedGasLimit =
             BigInt(gasUsed) +
             BigInt(estimation.bundlerEstimation.preVerificationGas) +
             BigInt(option.gasUsed)
-          amount = SignAccountOpController.getAmountAfterFeeTokenConvert(
-            simulatedGasLimit,
-            BigInt(increasedPrices.maxFeePerGas),
-            nativeRatio,
-            option.token.decimals,
-            0n
-          )
-          if (usesPaymaster) amount = this.#increaseFee(amount, 'paymaster')
+          amountGasPrice = BigInt(increasedPrices.maxFeePerGas)
           gasPrice = BigInt(receivedPrices.maxFeePerGas)
           maxPriorityFeePerGas = BigInt(receivedPrices.maxPriorityFeePerGas)
         } else if (
@@ -2036,36 +2000,42 @@ export class SignAccountOpController extends EventEmitter implements ISignAccoun
           simulatedGasLimit = gasUsed
           gasPrice = BigInt(increasedPrices.maxFeePerGas)
           maxPriorityFeePerGas = BigInt(increasedPrices.maxPriorityFeePerGas)
+          amountGasPrice = BigInt(receivedPrices.maxFeePerGas)
 
           this.accountOp.calls.forEach((call) => {
             if (call.to && getAddress(call.to) === SINGLETON) {
               simulatedGasLimit = getGasUsed(simulatedGasLimit)
             }
           })
-
-          amount = simulatedGasLimit * BigInt(receivedPrices.maxFeePerGas) + option.addedNative
         } else if (broadcastOption === BROADCAST_OPTIONS.byOtherEOA) {
           // Smart account, but EOA pays the fee
           // 7702, and it pays for the fee by itself
           simulatedGasLimit = gasUsed
-          amount = simulatedGasLimit * BigInt(receivedPrices.maxFeePerGas) + option.addedNative
           gasPrice = BigInt(increasedPrices.maxFeePerGas)
           maxPriorityFeePerGas = BigInt(increasedPrices.maxPriorityFeePerGas)
+          amountGasPrice = BigInt(receivedPrices.maxFeePerGas)
         } else {
           // Relayer
           simulatedGasLimit = gasUsed + option.gasUsed
-          amount = SignAccountOpController.getAmountAfterFeeTokenConvert(
-            simulatedGasLimit,
-            BigInt(increasedPrices.maxFeePerGas),
-            nativeRatio,
-            option.token.decimals,
-            option.addedNative
-          )
-          amount = this.#increaseFee(amount)
+          amountGasPrice = BigInt(increasedPrices.maxFeePerGas)
           gasPrice = BigInt(increasedPrices.maxFeePerGas)
           maxPriorityFeePerGas = BigInt(increasedPrices.maxPriorityFeePerGas)
         }
 
+        if (typeof this.customGasLimit !== 'undefined') {
+          simulatedGasLimit = this.customGasLimit
+        }
+
+        amount = calculateFeeAmount({
+          broadcastOption,
+          simulatedGasLimit,
+          gasPrice: amountGasPrice,
+          nativeRatio,
+          feeTokenDecimals: option.token.decimals,
+          addedNative: broadcastOption === BROADCAST_OPTIONS.byBundler ? 0n : option.addedNative,
+          usesPaymaster
+        })
+
         const feeSpeed: SpeedCalc = {
           type: speed,
           simulatedGasLimit,
@@ -2184,10 +2154,11 @@ export class SignAccountOpController extends EventEmitter implements ISignAccoun
       inToken: this.feeTokenResult.address,
       feeTokenChainId: this.feeTokenResult.chainId,
       amount: chosenSpeed.amount,
-      simulatedGasLimit: chosenSpeed.simulatedGasLimit,
+      simulatedGasLimit: this.customGasLimit ?? chosenSpeed.simulatedGasLimit,
       gasPrice: chosenSpeed.gasPrice,
       maxPriorityFeePerGas:
         'maxPriorityFeePerGas' in chosenSpeed ? chosenSpeed.maxPriorityFeePerGas : undefined,
+      isCustomGasLimit: typeof this.customGasLimit !== 'undefined',
       broadcastOption: this.baseAccount.getBroadcastOption(this.selectedOption, {
         op: this.accountOp,
         isSponsored: this.isSponsored
@@ -3488,6 +3459,12 @@ export class SignAccountOpController extends EventEmitter implements ISignAccoun
     return this.baseAccount.canSetCustomGasPrices(this.selectedOption)
   }
 
+  get canSetCustomGas(): boolean {
+    if (!this.selectedOption) return false
+
+    return this.baseAccount.canSetCustomGas(this.selectedOption, this.accountOp)
+  }
+
   get threshold(): number {
     const accountState =
       this.#accounts.accountStates[this.account.addr]![this.#network.chainId.toString()]
@@ -3528,6 +3505,7 @@ export class SignAccountOpController extends EventEmitter implements ISignAccoun
       banners: this.banners,
       canAccountBroadcastByItself: this.canAccountBroadcastByItself,
       canSetCustomGasPrices: this.canSetCustomGasPrices,
+      canSetCustomGas: this.canSetCustomGas,
       threshold: this.threshold,
       canBroadcast: this.canBroadcast,
       hasSafeApiFailed: this.hasSafeApiFailed

src/libs/account/BaseAccount.ts

@@ -94,6 +94,8 @@ export abstract class BaseAccount {
 
   abstract canSetCustomGasPrices(feeOption: FeePaymentOption): boolean
 
+  abstract canSetCustomGas(feeOption: FeePaymentOption, accountOp?: AccountOp): boolean
+
   // this is specific for v2 accounts, hardcoding a false for all else
   shouldIncludeActivatorCall(paidBy?: string) {
     return false

src/libs/account/EOA.ts

@@ -135,4 +135,12 @@ export class EOA extends BaseAccount {
   canSetCustomGasPrices(): boolean {
     return true
   }
+
+  canSetCustomGas(_feeOption?: FeePaymentOption, accountOp?: AccountOp): boolean {
+    // we do not allow custom gas for a bundle as we can estimate
+    // the gas for the next transaction after the first one has completed
+    if (accountOp && accountOp.calls.length > 1) return false
+
+    return this.canSetCustomGasPrices()
+  }
 }

src/libs/account/EOA7702.ts

@@ -221,4 +221,8 @@ export class EOA7702 extends BaseAccount {
   canSetCustomGasPrices(feeOption: FeePaymentOption): boolean {
     return feeOption.token.address === ZeroAddress
   }
+
+  canSetCustomGas(feeOption: FeePaymentOption): boolean {
+    return this.canSetCustomGasPrices(feeOption)
+  }
 }

src/libs/account/Safe.ts

@@ -202,4 +202,8 @@ export class Safe extends BaseAccount {
   canSetCustomGasPrices(): boolean {
     return true
   }
+
+  canSetCustomGas(): boolean {
+    return this.canSetCustomGasPrices()
+  }
 }

src/libs/account/V1.ts

@@ -136,4 +136,8 @@ export class V1 extends BaseAccount {
   canSetCustomGasPrices(): boolean {
     return true
   }
+
+  canSetCustomGas(): boolean {
+    return this.canSetCustomGasPrices()
+  }
 }

src/libs/account/V2.ts

@@ -205,4 +205,8 @@ export class V2 extends BaseAccount {
       feeOption.paidBy.toLowerCase() !== this.account.addr.toLowerCase()
     )
   }
+
+  canSetCustomGas(feeOption: FeePaymentOption): boolean {
+    return this.canSetCustomGasPrices(feeOption)
+  }
 }

src/libs/account/customGasPrices.test.ts

@@ -4,6 +4,7 @@ import { describe, expect, test } from '@jest/globals'
 
 import { Account, AccountOnchainState } from '../../interfaces/account'
 import { Network } from '../../interfaces/network'
+import { AccountOp } from '../accountOp/accountOp'
 import { FeePaymentOption } from '../estimate/interfaces'
 import { EOA } from './EOA'
 import { EOA7702 } from './EOA7702'
@@ -66,6 +67,14 @@ const tokenFeeOption = {
   }
 } as FeePaymentOption
 
+const accountOp = {
+  calls: [{}]
+} as AccountOp
+
+const batchAccountOp = {
+  calls: [{}, {}]
+} as AccountOp
+
 describe('custom gas price support', () => {
   test('EOA, V1 and Safe always allow custom gas prices', () => {
     expect(new EOA(account, network, accountState).canSetCustomGasPrices()).toBe(true)
@@ -87,4 +96,18 @@ describe('custom gas price support', () => {
     expect(v2.canSetCustomGasPrices(eoaNativeFeeOption)).toBe(true)
     expect(v2.canSetCustomGasPrices(tokenFeeOption)).toBe(false)
   })
+
+  test('EOA allows custom gas only for single-call account ops', () => {
+    const eoa = new EOA(account, network, accountState)
+
+    expect(eoa.canSetCustomGas(nativeFeeOption, accountOp)).toBe(true)
+    expect(eoa.canSetCustomGas(nativeFeeOption, batchAccountOp)).toBe(false)
+  })
+
+  test('non-EOA custom gas support follows custom gas price support', () => {
+    expect(new V1(account, network, accountState).canSetCustomGas(nativeFeeOption)).toBe(true)
+    expect(new Safe(account, network, accountState).canSetCustomGas(nativeFeeOption)).toBe(true)
+    expect(new EOA7702(account, network, accountState).canSetCustomGas(tokenFeeOption)).toBe(false)
+    expect(new V2(account, network, accountState).canSetCustomGas(eoaNativeFeeOption)).toBe(true)
+  })
 })

src/libs/accountOp/accountOp.ts

@@ -30,6 +30,7 @@ export interface GasFeePayment {
   feeTokenChainId?: bigint
   amount: bigint
   simulatedGasLimit: bigint
+  isCustomGasLimit?: boolean
   gasPrice: bigint
   broadcastOption: string
   maxPriorityFeePerGas?: bigint