Merge pull request #2317 from AmbireTech/feature/smooth-max-transfer

Smooth max transfer

Author: Oxbobby

src/controllers/signAccountOp/signAccountOp.ts

@@ -150,6 +150,7 @@ import {
   getUnknownTokenWarning,
   SignAccountOpType
 } from './helper'
+import { canFeeOptionCoverAmount, isTransferredTokenFeeOption } from '../../libs/account/feeOptions'
 
 export enum SigningStatus {
   EstimationError = 'estimation-error',
@@ -906,7 +907,10 @@ export class SignAccountOpController extends EventEmitter implements ISignAccoun
       this.canBroadcast
     ) {
       const identifier = getFeeSpeedIdentifier(this.selectedOption, this.accountOp.accountAddr)
-      if (this.hasSpeeds(identifier))
+      if (
+        this.hasSpeeds(identifier) &&
+        !this.#shouldSuppressTransferFeeSelectionError(this.selectedOption)
+      )
         errors.push({
           title: 'Please select a token and an account for paying the gas fee.'
         })
@@ -917,6 +921,7 @@ export class SignAccountOpController extends EventEmitter implements ISignAccoun
       this.selectedOption &&
       this.accountOp.gasFeePayment &&
       this.selectedOption.availableAmount < this.accountOp.gasFeePayment.amount &&
+      !this.#shouldSuppressTransferFeeSelectionError(this.selectedOption) &&
       this.canBroadcast
     ) {
       const speedCoverage = []
@@ -1650,12 +1655,12 @@ export class SignAccountOpController extends EventEmitter implements ISignAccoun
     const aId = getFeeSpeedIdentifier(a, this.accountOp.accountAddr)
     const aSlow = this.feeSpeeds[aId]?.find((speed) => speed.type === 'slow')
     if (!aSlow) return 1
-    const aCanCoverFee = a.availableAmount >= aSlow.amount
+    const aCanCoverFee = canFeeOptionCoverAmount(a, this.accountOp, aSlow.amount)
 
     const bId = getFeeSpeedIdentifier(b, this.accountOp.accountAddr)
     const bSlow = this.feeSpeeds[bId]?.find((speed) => speed.type === 'slow')
     if (!bSlow) return -1
-    const bCanCoverFee = b.availableAmount >= bSlow.amount
+    const bCanCoverFee = canFeeOptionCoverAmount(b, this.accountOp, bSlow.amount)
 
     if (aCanCoverFee && !bCanCoverFee) return -1
     if (!aCanCoverFee && bCanCoverFee) return 1
@@ -1681,13 +1686,14 @@ export class SignAccountOpController extends EventEmitter implements ISignAccoun
   #getIsFeeOptionDisabled(feeOption: FeePaymentOption): boolean {
     const id = getFeeSpeedIdentifier(feeOption, this.accountOp.accountAddr)
     const speeds = this.feeSpeeds[id] ?? []
+    const isTransferredTokenOption = isTransferredTokenFeeOption(feeOption, this.accountOp)
 
     const coversSlow = speeds.some(
       (speed: SpeedCalc) =>
         speed.type === FeeSpeed.Slow && feeOption.availableAmount >= speed.amount
     )
 
-    if (!coversSlow) return true
+    if (!coversSlow && !isTransferredTokenOption) return true
 
     const isExternal = this.accountKeyStoreKeys.some(
       (keyStoreKey) => keyStoreKey.addr === feeOption.paidBy && keyStoreKey.isExternallyStored
@@ -1700,6 +1706,14 @@ export class SignAccountOpController extends EventEmitter implements ISignAccoun
     return false
   }
 
+  #shouldSuppressTransferFeeSelectionError(feeOption?: FeePaymentOption): boolean {
+    return (
+      this.#type === 'one-click-transfer' &&
+      !!feeOption &&
+      isTransferredTokenFeeOption(feeOption, this.accountOp)
+    )
+  }
+
   /**
    * Obtain the native token ratio in relation to a fee token.
    *

src/controllers/transfer/transfer.test.ts

@@ -1,7 +1,7 @@
 /* eslint-disable @typescript-eslint/no-use-before-define */
 /* eslint-disable @typescript-eslint/no-floating-promises */
 
-import { ZeroAddress } from 'ethers'
+import { ZeroAddress, formatUnits } from 'ethers'
 
 import { expect } from '@jest/globals'
 
@@ -117,6 +117,43 @@ describe('Transfer Controller', () => {
     })
     expect(transferController.amount).toBe('1')
   })
+  test('should set max amount minus fee when the selected fee token matches the transfer token', async () => {
+    const { transferController, tokens } = await prepareTest()
+
+    const nativeToken = tokens.find((t) => t.address === ZeroAddress && t.chainId === 1n)!
+    const feeAmount = 1_000_000_000_000_000n
+
+    await transferController.update({
+      selectedToken: nativeToken
+    })
+    ;(transferController as any).signAccountOpController = {
+      accountOp: {
+        gasFeePayment: {
+          amount: feeAmount,
+          inToken: nativeToken.address,
+          feeTokenChainId: nativeToken.chainId
+        }
+      },
+      selectedOption: {
+        paidBy: account.addr,
+        token: {
+          ...nativeToken,
+          flags: {
+            ...nativeToken.flags,
+            onGasTank: false
+          }
+        }
+      }
+    }
+
+    await transferController.update({
+      shouldSetMaxAmount: true
+    })
+
+    expect(transferController.amount).toBe(
+      formatUnits(nativeToken.amount - feeAmount, nativeToken.decimals)
+    )
+  })
   test('should set validation form messages', async () => {
     const { transferController, tokens } = await prepareTest()
 

src/controllers/transfer/transfer.ts

@@ -24,7 +24,11 @@ import { HumanizerMeta } from '../../libs/humanizer/interfaces'
 import { randomId } from '../../libs/humanizer/utils'
 import { TokenResult } from '../../libs/portfolio'
 import { getTokenAmount, getTokenBalanceInUSD } from '../../libs/portfolio/helpers'
-import { getSanitizedAmount } from '../../libs/transfer/amount'
+import {
+  getAmountAfterFeeReserve,
+  getAmountAfterFeeSync,
+  getSanitizedAmount
+} from '../../libs/transfer/amount'
 import { getTransferRequestParams } from '../../libs/transfer/userRequest'
 import {
   validateSendTransferAddress,
@@ -126,6 +130,8 @@ export class TransferController extends EventEmitter implements ITransferControl
 
   #shouldSkipTransactionQueuedModal: boolean = false
 
+  #isMaxAmountSelected: boolean = false
+
   #accounts: IAccountsController
 
   #keystore: IKeystoreController
@@ -402,6 +408,7 @@ export class TransferController extends EventEmitter implements ITransferControl
 
     if (!token || Number(getTokenAmount(token)) === 0) {
       this.#selectedToken = null
+      this.#isMaxAmountSelected = false
       this.#setAmountAndNotifyUI('')
       this.#setAmountInFiatAndNotifyUI('')
       this.amountFieldMode = 'token'
@@ -416,6 +423,7 @@ export class TransferController extends EventEmitter implements ITransferControl
       prevSelectedToken?.address !== token?.address ||
       prevSelectedToken?.chainId !== token?.chainId
     ) {
+      this.#isMaxAmountSelected = false
       if (!token.priceIn.length) this.amountFieldMode = 'token'
       this.#setAmountAndNotifyUI('')
       this.#setAmountInFiatAndNotifyUI('')
@@ -431,12 +439,7 @@ export class TransferController extends EventEmitter implements ITransferControl
   }
 
   get maxAmount(): string {
-    if (
-      !this.selectedToken ||
-      getTokenAmount(this.selectedToken) === 0n ||
-      typeof this.selectedToken.decimals !== 'number'
-    )
-      return '0'
+    if (!this.selectedToken || getTokenAmount(this.selectedToken) === 0n) return '0'
 
     return formatUnits(getTokenAmount(this.selectedToken), this.selectedToken.decimals)
   }
@@ -461,6 +464,7 @@ export class TransferController extends EventEmitter implements ITransferControl
   }
 
   resetForm(shouldDestroyAccountOp = true) {
+    this.#isMaxAmountSelected = false
     this.amount = ''
     this.amountInFiat = ''
     this.amountFieldMode = 'token'
@@ -587,12 +591,14 @@ export class TransferController extends EventEmitter implements ITransferControl
     }
     // If we do a regular check the value won't update if it's '' or '0'
     if (typeof amount === 'string') {
+      this.#isMaxAmountSelected = false
       this.#setAmount(amount)
     }
 
     if (shouldSetMaxAmount) {
+      this.#isMaxAmountSelected = true
       this.amountFieldMode = 'token'
-      this.#setAmount(this.maxAmount, true)
+      this.#setTokenAmount(this.#getMaxAmountAfterFeeReservation(), true)
     }
 
     if (addressState) {
@@ -760,6 +766,119 @@ export class TransferController extends EventEmitter implements ITransferControl
     }
   }
 
+  #setTokenAmount(amount: string, isProgrammaticUpdate = false) {
+    const amountFieldMode = this.amountFieldMode
+
+    this.amountFieldMode = 'token'
+    this.#setAmount(amount, isProgrammaticUpdate)
+    this.amountFieldMode = amountFieldMode
+  }
+
+  #getMaxAmountAfterFeeReservation() {
+    if (!this.selectedToken) return this.maxAmount
+
+    const totalTokenAmount = getTokenAmount(this.selectedToken)
+    const gasFeePayment = this.signAccountOpController?.accountOp.gasFeePayment
+
+    if (!this.#shouldReserveFeeFromTransferredToken() || !gasFeePayment) {
+      return formatUnits(totalTokenAmount, this.selectedToken.decimals)
+    }
+
+    return formatUnits(
+      getAmountAfterFeeReserve(totalTokenAmount, gasFeePayment.amount),
+      this.selectedToken.decimals
+    )
+  }
+
+  #shouldReserveFeeFromTransferredToken() {
+    const gasFeePayment = this.signAccountOpController?.accountOp.gasFeePayment
+    const selectedFeeOption = this.signAccountOpController?.selectedOption
+    const selectedToken = this.selectedToken
+    const accountAddr = this.#selectedAccount.account?.addr.toLowerCase()
+
+    if (!accountAddr || !gasFeePayment || !selectedFeeOption || !selectedToken) return false
+    if (selectedFeeOption.token.flags.onGasTank) return false
+    if (selectedFeeOption.paidBy.toLowerCase() !== accountAddr) return false
+
+    const selectedTokenAddress = selectedToken.address.toLowerCase()
+
+    return (
+      !!accountAddr &&
+      !!gasFeePayment &&
+      !!selectedFeeOption &&
+      selectedFeeOption.paidBy.toLowerCase() === accountAddr &&
+      selectedFeeOption.token.chainId === selectedToken.chainId &&
+      selectedFeeOption.token.address.toLowerCase() === selectedTokenAddress &&
+      gasFeePayment.inToken.toLowerCase() === selectedTokenAddress &&
+      (!gasFeePayment.feeTokenChainId || gasFeePayment.feeTokenChainId === selectedToken.chainId)
+    )
+  }
+
+  #syncAmountWithFeeReservation(forceEmit?: boolean) {
+    if (!this.amount || !this.selectedToken || typeof this.selectedToken.decimals !== 'number')
+      return false
+
+    const totalTokenAmount = getTokenAmount(this.selectedToken)
+    const shouldReserveFee = this.#shouldReserveFeeFromTransferredToken()
+    const gasFeePayment = this.signAccountOpController?.accountOp.gasFeePayment
+    const currentAmount = this.amount
+      ? parseUnits(
+          getSafeAmountFromFieldValue(this.amount, this.selectedToken.decimals),
+          this.selectedToken.decimals
+        )
+      : 0n
+    const desiredAmount = getAmountAfterFeeSync({
+      currentAmount,
+      totalAmount: totalTokenAmount,
+      fee: shouldReserveFee ? gasFeePayment?.amount || 0n : 0n,
+      shouldReserveFee,
+      isMaxAmountSelected: this.#isMaxAmountSelected
+    })
+
+    if (currentAmount === desiredAmount) return false
+
+    this.#setTokenAmount(
+      desiredAmount === 0n ? '0' : formatUnits(desiredAmount, this.selectedToken.decimals),
+      true
+    )
+    // eslint-disable-next-line @typescript-eslint/no-floating-promises
+    this.syncSignAccountOp()
+    this.propagateUpdate(forceEmit)
+
+    return true
+  }
+
+  /**
+   * When doing a MAX transfer or a close to MAX transfer out,
+   * if the selected fee token is the same as the transfer token,
+   * we automatically adjust the transfer amount so the user
+   * can successfully broadcast. For that, we put an additional
+   * warning telling him why this is happening
+   */
+  get amountAdjustmentWarning(): Validation | null {
+    if (!this.amount || !this.selectedToken || !this.#shouldReserveFeeFromTransferredToken()) {
+      return null
+    }
+
+    const gasFeePayment = this.signAccountOpController?.accountOp.gasFeePayment
+    if (!gasFeePayment) return null
+
+    const currentAmount = parseUnits(
+      getSafeAmountFromFieldValue(this.amount, this.selectedToken.decimals),
+      this.selectedToken.decimals
+    )
+    const totalTokenAmount = getTokenAmount(this.selectedToken)
+
+    if (currentAmount > 0n && currentAmount + gasFeePayment.amount >= totalTokenAmount) {
+      return {
+        severity: 'warning',
+        message: 'Amount adjusted to cover blockchain fees'
+      }
+    }
+
+    return null
+  }
+
   get hasPersistedState() {
     return !!(this.amount || this.amountInFiat || this.addressState.fieldValue)
   }
@@ -860,7 +979,8 @@ export class TransferController extends EventEmitter implements ITransferControl
       calls,
       meta: {
         paymasterService: getAmbirePaymasterService(baseAcc, this.#relayerUrl),
-        topUpAmount
+        topUpAmount,
+        allowTransferFeeTokenSelfReserve: true
       }
     }
 
@@ -899,7 +1019,7 @@ export class TransferController extends EventEmitter implements ITransferControl
       shouldSimulate: false,
       onBroadcastSuccess: async (props) => {
         const { submittedAccountOp } = props
-        this.#portfolio.simulateAccountOp(props.accountOp).then(() => {
+        void this.#portfolio.simulateAccountOp(props.accountOp).then(() => {
           this.#portfolio.markSimulationAsBroadcasted(accountOp.accountAddr, accountOp.chainId)
         })
 
@@ -918,6 +1038,8 @@ export class TransferController extends EventEmitter implements ITransferControl
     })
 
     this.signAccountOpController.onUpdate((forceEmit) => {
+      this.#syncAmountWithFeeReservation(forceEmit)
+
       this.propagateUpdate(forceEmit)
 
       if (this.signAccountOpController?.broadcastStatus === 'SUCCESS') {
@@ -1015,7 +1137,8 @@ export class TransferController extends EventEmitter implements ITransferControl
       maxAmountInFiat: this.maxAmountInFiat,
       shouldSkipTransactionQueuedModal: this.shouldSkipTransactionQueuedModal,
       hasPersistedState: this.hasPersistedState,
-      isRecipientAddressViewOnly: this.isRecipientAddressViewOnly
+      isRecipientAddressViewOnly: this.isRecipientAddressViewOnly,
+      amountAdjustmentWarning: this.amountAdjustmentWarning
     }
   }
 }

src/libs/account/EOA7702.ts

@@ -17,6 +17,7 @@ import { TokenResult } from '../portfolio'
 import { isNative } from '../portfolio/helpers'
 import { UserOperation } from '../userOperation/types'
 import { BaseAccount } from './BaseAccount'
+import { isTransferredTokenFeeOption } from './feeOptions'
 
 // this class describes an EOA that CAN transition to 7702
 // even if it is YET to transition to 7702
@@ -78,7 +79,7 @@ export class EOA7702 extends BaseAccount {
         opt.paidBy === this.account.addr &&
         (isNative(opt.token) ||
           (!isDelegating &&
-            opt.availableAmount > 0n &&
+            (opt.availableAmount > 0n || isTransferredTokenFeeOption(opt, op)) &&
             estimation.bundlerEstimation &&
             estimation.bundlerEstimation.paymaster.isUsable()))
     )