@metamask/transaction-pay-controller 5.0.0 → 7.0.0

package/dist/types.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"types.mjs","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"","sourcesContent":["import type {\n  CurrencyRateControllerActions,\n  TokenBalancesControllerGetStateAction,\n} from '@metamask/assets-controllers';\nimport type { TokenListControllerActions } from '@metamask/assets-controllers';\nimport type { TokenRatesControllerGetStateAction } from '@metamask/assets-controllers';\nimport type { TokensControllerGetStateAction } from '@metamask/assets-controllers';\nimport type { AccountTrackerControllerGetStateAction } from '@metamask/assets-controllers';\nimport type { ControllerStateChangeEvent } from '@metamask/base-controller';\nimport type { ControllerGetStateAction } from '@metamask/base-controller';\nimport type { BridgeControllerActions } from '@metamask/bridge-controller';\nimport type { BridgeStatusControllerStateChangeEvent } from '@metamask/bridge-status-controller';\nimport type { BridgeStatusControllerActions } from '@metamask/bridge-status-controller';\nimport type { GasFeeControllerActions } from '@metamask/gas-fee-controller';\nimport type { Messenger } from '@metamask/messenger';\nimport type { NetworkControllerFindNetworkClientIdByChainIdAction } from '@metamask/network-controller';\nimport type { NetworkControllerGetNetworkClientByIdAction } from '@metamask/network-controller';\nimport type { RemoteFeatureFlagControllerGetStateAction } from '@metamask/remote-feature-flag-controller';\nimport type {\n  AuthorizationList,\n  TransactionControllerAddTransactionBatchAction,\n  TransactionControllerUnapprovedTransactionAddedEvent,\n} from '@metamask/transaction-controller';\nimport type { TransactionControllerGetStateAction } from '@metamask/transaction-controller';\nimport type { TransactionControllerStateChangeEvent } from '@metamask/transaction-controller';\nimport type { TransactionMeta } from '@metamask/transaction-controller';\nimport type { TransactionControllerAddTransactionAction } from '@metamask/transaction-controller';\nimport type { TransactionControllerUpdateTransactionAction } from '@metamask/transaction-controller';\nimport type { BatchTransaction } from '@metamask/transaction-controller';\nimport type { Hex, Json } from '@metamask/utils';\nimport type { Draft } from 'immer';\n\nimport type { CONTROLLER_NAME, TransactionPayStrategy } from './constants';\n\nexport type AllowedActions =\n  | AccountTrackerControllerGetStateAction\n  | BridgeControllerActions\n  | BridgeStatusControllerActions\n  | CurrencyRateControllerActions\n  | GasFeeControllerActions\n  | NetworkControllerFindNetworkClientIdByChainIdAction\n  | NetworkControllerGetNetworkClientByIdAction\n  | RemoteFeatureFlagControllerGetStateAction\n  | TokenBalancesControllerGetStateAction\n  | TokenListControllerActions\n  | TokenRatesControllerGetStateAction\n  | TokensControllerGetStateAction\n  | TransactionControllerAddTransactionAction\n  | TransactionControllerAddTransactionBatchAction\n  | TransactionControllerGetStateAction\n  | TransactionControllerUpdateTransactionAction;\n\nexport type AllowedEvents =\n  | BridgeStatusControllerStateChangeEvent\n  | TransactionControllerStateChangeEvent\n  | TransactionControllerUnapprovedTransactionAddedEvent;\n\nexport type TransactionPayControllerGetStateAction = ControllerGetStateAction<\n  typeof CONTROLLER_NAME,\n  TransactionPayControllerState\n>;\n\nexport type TransactionPayControllerGetDelegationTransactionAction = {\n  type: `${typeof CONTROLLER_NAME}:getDelegationTransaction`;\n  handler: GetDelegationTransactionCallback;\n};\n\n/** Action to get the pay strategy type used for a transaction. */\nexport type TransactionPayControllerGetStrategyAction = {\n  type: `${typeof CONTROLLER_NAME}:getStrategy`;\n  handler: (transaction: TransactionMeta) => Promise<TransactionPayStrategy>;\n};\n\n/** Action to update the payment token for a transaction. */\nexport type TransactionPayControllerUpdatePaymentTokenAction = {\n  type: `${typeof CONTROLLER_NAME}:updatePaymentToken`;\n  handler: (request: UpdatePaymentTokenRequest) => void;\n};\n\nexport type TransactionPayControllerStateChangeEvent =\n  ControllerStateChangeEvent<\n    typeof CONTROLLER_NAME,\n    TransactionPayControllerState\n  >;\n\nexport type TransactionPayControllerActions =\n  | TransactionPayControllerGetDelegationTransactionAction\n  | TransactionPayControllerGetStateAction\n  | TransactionPayControllerGetStrategyAction\n  | TransactionPayControllerUpdatePaymentTokenAction;\n\nexport type TransactionPayControllerEvents =\n  TransactionPayControllerStateChangeEvent;\n\nexport type TransactionPayControllerMessenger = Messenger<\n  typeof CONTROLLER_NAME,\n  TransactionPayControllerActions | AllowedActions,\n  TransactionPayControllerEvents | AllowedEvents\n>;\n\n/** Options for the TransactionPayController. */\nexport type TransactionPayControllerOptions = {\n  /** Callback to convert a transaction into a redeem delegation. */\n  getDelegationTransaction: GetDelegationTransactionCallback;\n\n  /** Callback to select the PayStrategy for a transaction. */\n  getStrategy?: (\n    transaction: TransactionMeta,\n  ) => Promise<TransactionPayStrategy>;\n\n  /** Controller messenger. */\n  messenger: TransactionPayControllerMessenger;\n\n  /** Initial state of the controller. */\n  state?: Partial<TransactionPayControllerState>;\n};\n\n/** State of the TransactionPayController. */\nexport type TransactionPayControllerState = {\n  /** State relating to each transaction, keyed by transaction ID. */\n  transactionData: Record<string, TransactionData>;\n};\n\n/** State relating to a single transaction. */\nexport type TransactionData = {\n  /** Whether quotes are currently being retrieved. */\n  isLoading: boolean;\n\n  /** Source token selected for the transaction. */\n  paymentToken?: TransactionPaymentToken;\n\n  /** Quotes retrieved for the transaction. */\n  quotes?: TransactionPayQuote<Json>[];\n\n  /** Timestamp of when quotes were last updated. */\n  quotesLastUpdated?: number;\n\n  /** Amounts of payment token required for each required token. */\n  sourceAmounts?: TransactionPaySourceAmount[];\n\n  /** Tokens required by the transaction. */\n  tokens: TransactionPayRequiredToken[];\n\n  /** Calculated totals for the transaction. */\n  totals?: TransactionPayTotals;\n};\n\n/** A token required by a transaction. */\nexport type TransactionPayRequiredToken = {\n  /** Address of the required token. */\n  address: Hex;\n\n  /** Whether to allow quotes that return less than the minimum amount requested. */\n  allowUnderMinimum: boolean;\n\n  /** Amount required in the selected currency. */\n  amountFiat: string;\n\n  /** Amount required in a human-readable format factoring token decimals. */\n  amountHuman: string;\n\n  /** Amount required in atomic format without factoring token decimals. */\n  amountRaw: string;\n\n  /** Amount required in USD. */\n  amountUsd: string;\n\n  /** Balance of the required token in the selected currency. */\n  balanceFiat: string;\n\n  /** Balance of the required token in a human-readable format factoring token decimals. */\n  balanceHuman: string;\n\n  /** Balance of the required token in atomic format without factoring token decimals. */\n  balanceRaw: string;\n\n  /** Balance of the required token in USD. */\n  balanceUsd: string;\n\n  /** Chain ID of the required token. */\n  chainId: Hex;\n\n  /** Decimals of the required token. */\n  decimals: number;\n\n  /** Whether to skip transfer of this token if balance is already sufficient. */\n  skipIfBalance: boolean;\n\n  /** Symbol of the required token. */\n  symbol: string;\n};\n\n/** Amount of payment token required by a required token. */\nexport type TransactionPaySourceAmount = {\n  /** Amount of payment token required in the selected currency. */\n  sourceAmountHuman: string;\n\n  /** Amount of payment token required in atomic format without factoring token decimals. */\n  sourceAmountRaw: string;\n\n  /** Address of the required token. */\n  targetTokenAddress: Hex;\n};\n\n/** Source token used to pay for required tokens. */\nexport type TransactionPaymentToken = {\n  /** Address of the payment token. */\n  address: Hex;\n\n  /** Balance of the payment token in the selected currency. */\n  balanceFiat: string;\n\n  /** Balance of the payment token in a human-readable format factoring token decimals. */\n  balanceHuman: string;\n\n  /** Balance of the payment token in atomic format without factoring token decimals. */\n  balanceRaw: string;\n\n  /** Balance of the payment token in USD. */\n  balanceUsd: string;\n\n  /** Chain ID of the payment token. */\n  chainId: Hex;\n\n  /** Decimals of the payment token. */\n  decimals: number;\n\n  /** Symbol of the payment token. */\n  symbol: string;\n};\n\n/** Callback to update state for a single transaction. */\nexport type UpdateTransactionDataCallback = (\n  /** ID of the transaction to update. */\n  transactionId: string,\n  /** Function that receives a draft of the transaction data to update. */\n  fn: (data: Draft<TransactionData>) => void,\n) => void;\n\n/** Conversion rates from the native currency to other currencies. */\nexport type FiatRates = {\n  /** Conversion rate for the native currency to the selected fiat currency. */\n  fiatRate: string;\n\n  /** Conversion rate for the native currency to USD. */\n  usdRate: string;\n};\n\n/** Request for a quote to retrieve a required token. */\nexport type QuoteRequest = {\n  /** Address of the user's account. */\n  from: Hex;\n\n  /** Balance of the source token in atomic format without factoring token decimals. */\n  sourceBalanceRaw: string;\n\n  /** Chain ID of the source token. */\n  sourceChainId: Hex;\n\n  /** Address of the source token. */\n  sourceTokenAddress: Hex;\n\n  /** Amount of the required token in atomic format without factoring token decimals. */\n  sourceTokenAmount: string;\n\n  /** Minimum amount required of the target token in atomic format without factoring token decimals. */\n  targetAmountMinimum: string;\n\n  /** Chain ID of the target token. */\n  targetChainId: Hex;\n\n  /** Address of the target token. */\n  targetTokenAddress: Hex;\n};\n\n/** Fees associated with a transaction pay quote. */\nexport type TransactionPayFees = {\n  /** Fee charged by the quote provider. */\n  provider: FiatValue;\n\n  /** Network fee for transactions on the source network. */\n  sourceNetwork: FiatValue;\n\n  /** Network fee for transactions on the target network. */\n  targetNetwork: FiatValue;\n};\n\n/** Quote returned to retrieve a required token using the payment token. */\nexport type TransactionPayQuote<OriginalQuote> = {\n  /** Additional amount provided by the quote beyond the minimum requested. */\n  dust: FiatValue;\n\n  /** Duration estimated for the transaction to complete in seconds. */\n  estimatedDuration: number;\n\n  /** Fees associated with the transaction pay quote. */\n  fees: TransactionPayFees;\n\n  /** Raw quote data returned by the provider. */\n  original: OriginalQuote;\n\n  /** Associated quote request. */\n  request: QuoteRequest;\n\n  /** Name of the strategy used to retrieve the quote. */\n  strategy: TransactionPayStrategy;\n};\n\n/** Request to get quotes for a transaction. */\nexport type PayStrategyGetQuotesRequest = {\n  /** Controller messenger. */\n  messenger: TransactionPayControllerMessenger;\n\n  /** Quote requests for required tokens. */\n  requests: QuoteRequest[];\n\n  /** Metadata of the original target transaction. */\n  transaction: TransactionMeta;\n};\n\n/** Request to submit quotes for a transaction. */\nexport type PayStrategyExecuteRequest<OriginalRequest> = {\n  /** Callback to determine if the transaction is a smart transaction. */\n  isSmartTransaction: (chainId: Hex) => boolean;\n\n  /** Controller messenger. */\n  messenger: TransactionPayControllerMessenger;\n\n  /** Quotes to be submitted. */\n  quotes: TransactionPayQuote<OriginalRequest>[];\n\n  /** Metadata of the original target transaction. */\n  transaction: TransactionMeta;\n};\n\n/** Request to get batch transactions for quotes. */\nexport type PayStrategyGetBatchRequest<OriginalQuote> = {\n  /** Controller messenger. */\n  messenger: TransactionPayControllerMessenger;\n\n  /** Quotes for required tokens. */\n  quotes: TransactionPayQuote<OriginalQuote>[];\n};\n\n/** Request to get refresh interval for a specific strategy. */\nexport type PayStrategyGetRefreshIntervalRequest = {\n  /** Chain ID of the source or payment token. */\n  chainId: Hex;\n\n  /** Controller messenger. */\n  messenger: TransactionPayControllerMessenger;\n};\n\n/** Strategy used to obtain required tokens for a transaction. */\nexport type PayStrategy<OriginalQuote> = {\n  /** Retrieve quotes for required tokens. */\n  getQuotes: (\n    request: PayStrategyGetQuotesRequest,\n  ) => Promise<TransactionPayQuote<OriginalQuote>[]>;\n\n  /** Retrieve batch transactions for quotes, if supported by the strategy. */\n  getBatchTransactions?: (\n    request: PayStrategyGetBatchRequest<OriginalQuote>,\n  ) => Promise<BatchTransaction[]>;\n\n  /**\n   * Retrieve refresh interval for the strategy, if applicable.\n   * Defaults to 30 seconds.\n   */\n  getRefreshInterval?: (\n    request: PayStrategyGetRefreshIntervalRequest,\n  ) => Promise<number | undefined>;\n\n  /** Execute or submit the quotes to obtain required tokens. */\n  execute: (request: PayStrategyExecuteRequest<OriginalQuote>) => Promise<{\n    transactionHash?: Hex;\n  }>;\n};\n\n/** Single fiat value in alternate currencies. */\nexport type FiatValue = {\n  /** Value in the selected fiat currency. */\n  fiat: string;\n\n  /** Value in USD. */\n  usd: string;\n};\n\n/** Calculated totals for a target transaction and all quotes. */\nexport type TransactionPayTotals = {\n  /** Total estimated duration for the target transaction and all quotes. */\n  estimatedDuration: number;\n\n  /** Total fees for the target transaction and all quotes. */\n  fees: TransactionPayFees;\n\n  /** Overall total cost for the target transaction and all quotes. */\n  total: FiatValue;\n};\n\n/** Request to update the payment token for a transaction. */\nexport type UpdatePaymentTokenRequest = {\n  /** ID of the transaction to update. */\n  transactionId: string;\n\n  /** Address of the new payment token. */\n  tokenAddress: Hex;\n\n  /** Chain ID of the new payment token. */\n  chainId: Hex;\n};\n\n/** Callback to convert a transaction to a redeem delegation. */\nexport type GetDelegationTransactionCallback = ({\n  transaction,\n}: {\n  transaction: TransactionMeta;\n}) => Promise<{\n  authorizationList?: AuthorizationList;\n  data: Hex;\n  to: Hex;\n  value: Hex;\n}>;\n"]}
+{"version":3,"file":"types.mjs","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"","sourcesContent":["import type {\n  CurrencyRateControllerActions,\n  TokenBalancesControllerGetStateAction,\n} from '@metamask/assets-controllers';\nimport type { TokenListControllerActions } from '@metamask/assets-controllers';\nimport type { TokenRatesControllerGetStateAction } from '@metamask/assets-controllers';\nimport type { TokensControllerGetStateAction } from '@metamask/assets-controllers';\nimport type { AccountTrackerControllerGetStateAction } from '@metamask/assets-controllers';\nimport type { ControllerStateChangeEvent } from '@metamask/base-controller';\nimport type { ControllerGetStateAction } from '@metamask/base-controller';\nimport type { BridgeControllerActions } from '@metamask/bridge-controller';\nimport type { BridgeStatusControllerStateChangeEvent } from '@metamask/bridge-status-controller';\nimport type { BridgeStatusControllerActions } from '@metamask/bridge-status-controller';\nimport type { GasFeeControllerActions } from '@metamask/gas-fee-controller';\nimport type { Messenger } from '@metamask/messenger';\nimport type { NetworkControllerFindNetworkClientIdByChainIdAction } from '@metamask/network-controller';\nimport type { NetworkControllerGetNetworkClientByIdAction } from '@metamask/network-controller';\nimport type { RemoteFeatureFlagControllerGetStateAction } from '@metamask/remote-feature-flag-controller';\nimport type {\n  AuthorizationList,\n  TransactionControllerAddTransactionBatchAction,\n  TransactionControllerUnapprovedTransactionAddedEvent,\n} from '@metamask/transaction-controller';\nimport type { TransactionControllerGetStateAction } from '@metamask/transaction-controller';\nimport type { TransactionControllerStateChangeEvent } from '@metamask/transaction-controller';\nimport type { TransactionMeta } from '@metamask/transaction-controller';\nimport type { TransactionControllerAddTransactionAction } from '@metamask/transaction-controller';\nimport type { TransactionControllerUpdateTransactionAction } from '@metamask/transaction-controller';\nimport type { BatchTransaction } from '@metamask/transaction-controller';\nimport type { Hex, Json } from '@metamask/utils';\nimport type { Draft } from 'immer';\n\nimport type { CONTROLLER_NAME, TransactionPayStrategy } from './constants';\n\nexport type AllowedActions =\n  | AccountTrackerControllerGetStateAction\n  | BridgeControllerActions\n  | BridgeStatusControllerActions\n  | CurrencyRateControllerActions\n  | GasFeeControllerActions\n  | NetworkControllerFindNetworkClientIdByChainIdAction\n  | NetworkControllerGetNetworkClientByIdAction\n  | RemoteFeatureFlagControllerGetStateAction\n  | TokenBalancesControllerGetStateAction\n  | TokenListControllerActions\n  | TokenRatesControllerGetStateAction\n  | TokensControllerGetStateAction\n  | TransactionControllerAddTransactionAction\n  | TransactionControllerAddTransactionBatchAction\n  | TransactionControllerGetStateAction\n  | TransactionControllerUpdateTransactionAction;\n\nexport type AllowedEvents =\n  | BridgeStatusControllerStateChangeEvent\n  | TransactionControllerStateChangeEvent\n  | TransactionControllerUnapprovedTransactionAddedEvent;\n\nexport type TransactionPayControllerGetStateAction = ControllerGetStateAction<\n  typeof CONTROLLER_NAME,\n  TransactionPayControllerState\n>;\n\nexport type TransactionPayControllerGetDelegationTransactionAction = {\n  type: `${typeof CONTROLLER_NAME}:getDelegationTransaction`;\n  handler: GetDelegationTransactionCallback;\n};\n\n/** Action to get the pay strategy type used for a transaction. */\nexport type TransactionPayControllerGetStrategyAction = {\n  type: `${typeof CONTROLLER_NAME}:getStrategy`;\n  handler: (transaction: TransactionMeta) => TransactionPayStrategy;\n};\n\n/** Action to update the payment token for a transaction. */\nexport type TransactionPayControllerUpdatePaymentTokenAction = {\n  type: `${typeof CONTROLLER_NAME}:updatePaymentToken`;\n  handler: (request: UpdatePaymentTokenRequest) => void;\n};\n\nexport type TransactionPayControllerStateChangeEvent =\n  ControllerStateChangeEvent<\n    typeof CONTROLLER_NAME,\n    TransactionPayControllerState\n  >;\n\nexport type TransactionPayControllerActions =\n  | TransactionPayControllerGetDelegationTransactionAction\n  | TransactionPayControllerGetStateAction\n  | TransactionPayControllerGetStrategyAction\n  | TransactionPayControllerUpdatePaymentTokenAction;\n\nexport type TransactionPayControllerEvents =\n  TransactionPayControllerStateChangeEvent;\n\nexport type TransactionPayControllerMessenger = Messenger<\n  typeof CONTROLLER_NAME,\n  TransactionPayControllerActions | AllowedActions,\n  TransactionPayControllerEvents | AllowedEvents\n>;\n\n/** Options for the TransactionPayController. */\nexport type TransactionPayControllerOptions = {\n  /** Callback to convert a transaction into a redeem delegation. */\n  getDelegationTransaction: GetDelegationTransactionCallback;\n\n  /** Callback to select the PayStrategy for a transaction. */\n  getStrategy?: (transaction: TransactionMeta) => TransactionPayStrategy;\n\n  /** Controller messenger. */\n  messenger: TransactionPayControllerMessenger;\n\n  /** Initial state of the controller. */\n  state?: Partial<TransactionPayControllerState>;\n};\n\n/** State of the TransactionPayController. */\nexport type TransactionPayControllerState = {\n  /** State relating to each transaction, keyed by transaction ID. */\n  transactionData: Record<string, TransactionData>;\n};\n\n/** State relating to a single transaction. */\nexport type TransactionData = {\n  /** Whether quotes are currently being retrieved. */\n  isLoading: boolean;\n\n  /** Source token selected for the transaction. */\n  paymentToken?: TransactionPaymentToken;\n\n  /** Quotes retrieved for the transaction. */\n  quotes?: TransactionPayQuote<Json>[];\n\n  /** Timestamp of when quotes were last updated. */\n  quotesLastUpdated?: number;\n\n  /** Amounts of payment token required for each required token. */\n  sourceAmounts?: TransactionPaySourceAmount[];\n\n  /** Tokens required by the transaction. */\n  tokens: TransactionPayRequiredToken[];\n\n  /** Calculated totals for the transaction. */\n  totals?: TransactionPayTotals;\n};\n\n/** A token required by a transaction. */\nexport type TransactionPayRequiredToken = {\n  /** Address of the required token. */\n  address: Hex;\n\n  /** Whether to allow quotes that return less than the minimum amount requested. */\n  allowUnderMinimum: boolean;\n\n  /** Amount required in the selected currency. */\n  amountFiat: string;\n\n  /** Amount required in a human-readable format factoring token decimals. */\n  amountHuman: string;\n\n  /** Amount required in atomic format without factoring token decimals. */\n  amountRaw: string;\n\n  /** Amount required in USD. */\n  amountUsd: string;\n\n  /** Balance of the required token in the selected currency. */\n  balanceFiat: string;\n\n  /** Balance of the required token in a human-readable format factoring token decimals. */\n  balanceHuman: string;\n\n  /** Balance of the required token in atomic format without factoring token decimals. */\n  balanceRaw: string;\n\n  /** Balance of the required token in USD. */\n  balanceUsd: string;\n\n  /** Chain ID of the required token. */\n  chainId: Hex;\n\n  /** Decimals of the required token. */\n  decimals: number;\n\n  /** Whether to skip transfer of this token if balance is already sufficient. */\n  skipIfBalance: boolean;\n\n  /** Symbol of the required token. */\n  symbol: string;\n};\n\n/** Amount of payment token required by a required token. */\nexport type TransactionPaySourceAmount = {\n  /** Amount of payment token required in the selected currency. */\n  sourceAmountHuman: string;\n\n  /** Amount of payment token required in atomic format without factoring token decimals. */\n  sourceAmountRaw: string;\n\n  /** Address of the required token. */\n  targetTokenAddress: Hex;\n};\n\n/** Source token used to pay for required tokens. */\nexport type TransactionPaymentToken = {\n  /** Address of the payment token. */\n  address: Hex;\n\n  /** Balance of the payment token in the selected currency. */\n  balanceFiat: string;\n\n  /** Balance of the payment token in a human-readable format factoring token decimals. */\n  balanceHuman: string;\n\n  /** Balance of the payment token in atomic format without factoring token decimals. */\n  balanceRaw: string;\n\n  /** Balance of the payment token in USD. */\n  balanceUsd: string;\n\n  /** Chain ID of the payment token. */\n  chainId: Hex;\n\n  /** Decimals of the payment token. */\n  decimals: number;\n\n  /** Symbol of the payment token. */\n  symbol: string;\n};\n\n/** Callback to update state for a single transaction. */\nexport type UpdateTransactionDataCallback = (\n  /** ID of the transaction to update. */\n  transactionId: string,\n  /** Function that receives a draft of the transaction data to update. */\n  fn: (data: Draft<TransactionData>) => void,\n) => void;\n\n/** Conversion rates from the native currency to other currencies. */\nexport type FiatRates = {\n  /** Conversion rate for the native currency to the selected fiat currency. */\n  fiatRate: string;\n\n  /** Conversion rate for the native currency to USD. */\n  usdRate: string;\n};\n\n/** Request for a quote to retrieve a required token. */\nexport type QuoteRequest = {\n  /** Address of the user's account. */\n  from: Hex;\n\n  /** Balance of the source token in atomic format without factoring token decimals. */\n  sourceBalanceRaw: string;\n\n  /** Chain ID of the source token. */\n  sourceChainId: Hex;\n\n  /** Address of the source token. */\n  sourceTokenAddress: Hex;\n\n  /** Amount of the required token in atomic format without factoring token decimals. */\n  sourceTokenAmount: string;\n\n  /** Minimum amount required of the target token in atomic format without factoring token decimals. */\n  targetAmountMinimum: string;\n\n  /** Chain ID of the target token. */\n  targetChainId: Hex;\n\n  /** Address of the target token. */\n  targetTokenAddress: Hex;\n};\n\n/** Fees associated with a transaction pay quote. */\nexport type TransactionPayFees = {\n  /** Whether a gas fee token is used to pay target network fees. */\n  isTargetGasFeeToken?: boolean;\n\n  /** Fee charged by the quote provider. */\n  provider: FiatValue;\n\n  /** Network fee for transactions on the source network. */\n  sourceNetwork: {\n    estimate: Amount;\n    max: Amount;\n  };\n\n  /** Network fee for transactions on the target network. */\n  targetNetwork: FiatValue;\n};\n\n/** Quote returned to retrieve a required token using the payment token. */\nexport type TransactionPayQuote<OriginalQuote> = {\n  /** Additional amount provided by the quote beyond the minimum requested. */\n  dust: FiatValue;\n\n  /** Duration estimated for the transaction to complete in seconds. */\n  estimatedDuration: number;\n\n  /** Fees associated with the transaction pay quote. */\n  fees: TransactionPayFees;\n\n  /** Raw quote data returned by the provider. */\n  original: OriginalQuote;\n\n  /** Associated quote request. */\n  request: QuoteRequest;\n\n  /** Amount of source token required. */\n  sourceAmount: Amount;\n\n  /** Name of the strategy used to retrieve the quote. */\n  strategy: TransactionPayStrategy;\n};\n\n/** Request to get quotes for a transaction. */\nexport type PayStrategyGetQuotesRequest = {\n  /** Controller messenger. */\n  messenger: TransactionPayControllerMessenger;\n\n  /** Quote requests for required tokens. */\n  requests: QuoteRequest[];\n\n  /** Metadata of the original target transaction. */\n  transaction: TransactionMeta;\n};\n\n/** Request to submit quotes for a transaction. */\nexport type PayStrategyExecuteRequest<OriginalRequest> = {\n  /** Callback to determine if the transaction is a smart transaction. */\n  isSmartTransaction: (chainId: Hex) => boolean;\n\n  /** Controller messenger. */\n  messenger: TransactionPayControllerMessenger;\n\n  /** Quotes to be submitted. */\n  quotes: TransactionPayQuote<OriginalRequest>[];\n\n  /** Metadata of the original target transaction. */\n  transaction: TransactionMeta;\n};\n\n/** Request to get batch transactions for quotes. */\nexport type PayStrategyGetBatchRequest<OriginalQuote> = {\n  /** Controller messenger. */\n  messenger: TransactionPayControllerMessenger;\n\n  /** Quotes for required tokens. */\n  quotes: TransactionPayQuote<OriginalQuote>[];\n};\n\n/** Request to get refresh interval for a specific strategy. */\nexport type PayStrategyGetRefreshIntervalRequest = {\n  /** Chain ID of the source or payment token. */\n  chainId: Hex;\n\n  /** Controller messenger. */\n  messenger: TransactionPayControllerMessenger;\n};\n\n/** Strategy used to obtain required tokens for a transaction. */\nexport type PayStrategy<OriginalQuote> = {\n  /** Retrieve quotes for required tokens. */\n  getQuotes: (\n    request: PayStrategyGetQuotesRequest,\n  ) => Promise<TransactionPayQuote<OriginalQuote>[]>;\n\n  /** Retrieve batch transactions for quotes, if supported by the strategy. */\n  getBatchTransactions?: (\n    request: PayStrategyGetBatchRequest<OriginalQuote>,\n  ) => Promise<BatchTransaction[]>;\n\n  /**\n   * Retrieve refresh interval for the strategy, if applicable.\n   * Defaults to 30 seconds.\n   */\n  getRefreshInterval?: (\n    request: PayStrategyGetRefreshIntervalRequest,\n  ) => Promise<number | undefined>;\n\n  /** Execute or submit the quotes to obtain required tokens. */\n  execute: (request: PayStrategyExecuteRequest<OriginalQuote>) => Promise<{\n    transactionHash?: Hex;\n  }>;\n};\n\n/** Single fiat value in alternate currencies. */\nexport type FiatValue = {\n  /** Value in the selected fiat currency. */\n  fiat: string;\n\n  /** Value in USD. */\n  usd: string;\n};\n\n/** Calculated totals for a target transaction and all quotes. */\nexport type TransactionPayTotals = {\n  /** Total estimated duration for the target transaction and all quotes. */\n  estimatedDuration: number;\n\n  /** Total fees for the target transaction and all quotes. */\n  fees: TransactionPayFees;\n\n  /** Total amount of source token required. */\n  sourceAmount: Amount;\n\n  /** Overall total cost for the target transaction and all quotes. */\n  total: FiatValue;\n};\n\n/** Request to update the payment token for a transaction. */\nexport type UpdatePaymentTokenRequest = {\n  /** ID of the transaction to update. */\n  transactionId: string;\n\n  /** Address of the new payment token. */\n  tokenAddress: Hex;\n\n  /** Chain ID of the new payment token. */\n  chainId: Hex;\n};\n\n/** Callback to convert a transaction to a redeem delegation. */\nexport type GetDelegationTransactionCallback = ({\n  transaction,\n}: {\n  transaction: TransactionMeta;\n}) => Promise<{\n  authorizationList?: AuthorizationList;\n  data: Hex;\n  to: Hex;\n  value: Hex;\n}>;\n\n/** Single amount in alternate formats. */\nexport type Amount = FiatValue & {\n  /** Amount in human-readable format factoring token decimals. */\n  human: string;\n\n  /** Amount in atomic format without factoring token decimals. */\n  raw: string;\n};\n"]}

package/dist/utils/gas.cjs

@@ -4,25 +4,48 @@ exports.calculateGasCost = exports.calculateTransactionGasCost = void 0;
 const controller_utils_1 = require("@metamask/controller-utils");
 const bignumber_js_1 = require("bignumber.js");
 const token_1 = require("./token.cjs");
+const logger_1 = require("../logger.cjs");
+const log = (0, logger_1.createModuleLogger)(logger_1.projectLogger, 'gas');
 /**
  *
  * Calculate the estimated gas cost for a given transaction in fiat.
  *
  * @param transaction - Transaction to calculate gas cost for
  * @param messenger - Controller messenger.
+ * @param options - Calculation options.
+ * @param options.isMax - Whether to calculate the maximum fee.
  * @returns Estimated gas cost for the transaction.
  */
-function calculateTransactionGasCost(transaction, messenger) {
-    const { chainId, gasUsed, gasLimitNoBuffer, txParams } = transaction;
-    const { gas, maxFeePerGas, maxPriorityFeePerGas } = txParams;
+function calculateTransactionGasCost(transaction, messenger, { isMax } = {}) {
+    const { chainId, gasUsed: gasUsedOriginal, gasLimitNoBuffer, txParams, } = transaction;
+    const { from, gas, maxFeePerGas, maxPriorityFeePerGas } = txParams;
+    const gasUsed = isMax ? undefined : gasUsedOriginal;
     const finalGas = gasUsed || gasLimitNoBuffer || gas || '0x0';
-    return calculateGasCost({
+    const result = calculateGasCost({
         chainId,
         gas: finalGas,
+        isMax,
         maxFeePerGas,
         maxPriorityFeePerGas,
         messenger,
     });
+    const max = calculateGasCost({
+        chainId,
+        gas: finalGas,
+        isMax: true,
+        messenger,
+    });
+    const nativeBalance = (0, token_1.getTokenBalance)(messenger, from, chainId, (0, token_1.getNativeToken)(chainId));
+    const hasBalance = new bignumber_js_1.BigNumber(nativeBalance).gte(max.raw);
+    const gasFeeTokenCost = calculateGasFeeTokenCost({
+        hasBalance,
+        messenger,
+        transaction,
+    });
+    if (gasFeeTokenCost) {
+        return gasFeeTokenCost;
+    }
+    return result;
 }
 exports.calculateTransactionGasCost = calculateTransactionGasCost;
 /**
@@ -31,32 +54,37 @@ exports.calculateTransactionGasCost = calculateTransactionGasCost;
  * @param request - Gas cost calculation parameters.
  * @param request.chainId - ID of the chain.
  * @param request.gas - Amount of gas the transaction will use.
+ * @param request.isMax - Whether to calculate the maximum fee.
  * @param request.maxFeePerGas - Max fee to pay per gas.
  * @param request.maxPriorityFeePerGas - Max priority fee to pay per gas.
  * @param request.messenger - Controller messenger.
+ 
  * @returns Estimated gas cost for the transaction.
  */
 function calculateGasCost(request) {
-    const { chainId: chainIdInput, gas, maxFeePerGas: maxFeePerGasInput, maxPriorityFeePerGas: maxPriorityFeePerGasInput, messenger, } = request;
+    const { chainId: chainIdInput, gas, isMax, maxFeePerGas: maxFeePerGasInput, maxPriorityFeePerGas: maxPriorityFeePerGasInput, messenger, } = request;
     const chainId = (0, controller_utils_1.toHex)(chainIdInput);
     const { estimatedBaseFee, maxFeePerGas: maxFeePerGasEstimate, maxPriorityFeePerGas: maxPriorityFeePerGasEstimate, } = getGasFee(chainId, messenger);
     const maxFeePerGas = maxFeePerGasInput || maxFeePerGasEstimate;
     const maxPriorityFeePerGas = maxPriorityFeePerGasInput || maxPriorityFeePerGasEstimate;
-    const feePerGas = estimatedBaseFee && maxPriorityFeePerGas
+    const feePerGas = estimatedBaseFee && maxPriorityFeePerGas && !isMax
         ? new bignumber_js_1.BigNumber(estimatedBaseFee).plus(maxPriorityFeePerGas)
         : new bignumber_js_1.BigNumber(maxFeePerGas || '0x0');
-    const gasCostNative = new bignumber_js_1.BigNumber(gas)
-        .multipliedBy(feePerGas)
-        .shiftedBy(-18);
+    const rawValue = new bignumber_js_1.BigNumber(gas).multipliedBy(feePerGas);
+    const raw = rawValue.toString(10);
+    const humanValue = rawValue.shiftedBy(-18);
+    const human = humanValue.toString(10);
     const fiatRate = (0, token_1.getTokenFiatRate)(messenger, (0, token_1.getNativeToken)(chainId), chainId);
     if (!fiatRate) {
         throw new Error('Could not fetch fiat rate for native token');
     }
-    const usd = gasCostNative.multipliedBy(fiatRate.usdRate).toString(10);
-    const fiat = gasCostNative.multipliedBy(fiatRate.fiatRate).toString(10);
+    const usd = humanValue.multipliedBy(fiatRate.usdRate).toString(10);
+    const fiat = humanValue.multipliedBy(fiatRate.fiatRate).toString(10);
     return {
-        usd,
         fiat,
+        human,
+        raw,
+        usd,
     };
 }
 exports.calculateGasCost = calculateGasCost;
@@ -84,4 +112,49 @@ function getGasFee(chainId, messenger) {
         : undefined;
     return { estimatedBaseFee, maxFeePerGas, maxPriorityFeePerGas };
 }
+/**
+ * Calculate the cost of a gas fee token on a transaction.
+ *
+ * @param request - Request parameters.
+ * @param request.hasBalance - Whether the user has enough balance to cover the gas fee.
+ * @param request.messenger - Controller messenger.
+ * @param request.transaction - Transaction to calculate gas fee token cost for.
+ * @returns Cost of the gas fee token.
+ */
+function calculateGasFeeTokenCost({ hasBalance, messenger, transaction, }) {
+    const { chainId, gasFeeTokens, isGasFeeTokenIgnoredIfBalance, selectedGasFeeToken, } = transaction;
+    if (!gasFeeTokens ||
+        !selectedGasFeeToken ||
+        (isGasFeeTokenIgnoredIfBalance && hasBalance)) {
+        return undefined;
+    }
+    log('Calculating gas fee token cost', { selectedGasFeeToken, chainId });
+    const gasFeeToken = gasFeeTokens?.find((t) => t.tokenAddress.toLowerCase() === selectedGasFeeToken.toLowerCase());
+    if (!gasFeeToken) {
+        log('Gas fee token not found', {
+            gasFeeTokens,
+            selectedGasFeeToken,
+        });
+        return undefined;
+    }
+    const tokenInfo = (0, token_1.getTokenInfo)(messenger, selectedGasFeeToken, chainId);
+    const tokenFiatRate = (0, token_1.getTokenFiatRate)(messenger, selectedGasFeeToken, chainId);
+    if (!tokenFiatRate || !tokenInfo) {
+        log('Cannot get gas fee token info');
+        return undefined;
+    }
+    const rawValue = new bignumber_js_1.BigNumber(gasFeeToken.amount);
+    const raw = rawValue.toString(10);
+    const humanValue = rawValue.shiftedBy(-tokenInfo.decimals);
+    const human = humanValue.toString(10);
+    const fiat = humanValue.multipliedBy(tokenFiatRate.fiatRate).toString(10);
+    const usd = humanValue.multipliedBy(tokenFiatRate.usdRate).toString(10);
+    return {
+        isGasFeeToken: true,
+        fiat,
+        human,
+        raw,
+        usd,
+    };
+}
 //# sourceMappingURL=gas.cjs.map

package/dist/utils/gas.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"gas.cjs","sourceRoot":"","sources":["../../src/utils/gas.ts"],"names":[],"mappings":";;;AAAA,iEAAmD;AAInD,+CAAyC;AAEzC,uCAA2D;AAI3D;;;;;;;GAOG;AACH,SAAgB,2BAA2B,CACzC,WAA4B,EAC5B,SAA4C;IAE5C,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,gBAAgB,EAAE,QAAQ,EAAE,GAAG,WAAW,CAAC;IACrE,MAAM,EAAE,GAAG,EAAE,YAAY,EAAE,oBAAoB,EAAE,GAAG,QAAQ,CAAC;IAC7D,MAAM,QAAQ,GAAG,OAAO,IAAI,gBAAgB,IAAI,GAAG,IAAI,KAAK,CAAC;IAE7D,OAAO,gBAAgB,CAAC;QACtB,OAAO;QACP,GAAG,EAAE,QAAQ;QACb,YAAY;QACZ,oBAAoB;QACpB,SAAS;KACV,CAAC,CAAC;AACL,CAAC;AAfD,kEAeC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,gBAAgB,CAAC,OAMhC;IACC,MAAM,EACJ,OAAO,EAAE,YAAY,EACrB,GAAG,EACH,YAAY,EAAE,iBAAiB,EAC/B,oBAAoB,EAAE,yBAAyB,EAC/C,SAAS,GACV,GAAG,OAAO,CAAC;IAEZ,MAAM,OAAO,GAAG,IAAA,wBAAK,EAAC,YAAY,CAAC,CAAC;IAEpC,MAAM,EACJ,gBAAgB,EAChB,YAAY,EAAE,oBAAoB,EAClC,oBAAoB,EAAE,4BAA4B,GACnD,GAAG,SAAS,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;IAElC,MAAM,YAAY,GAAG,iBAAiB,IAAI,oBAAoB,CAAC;IAE/D,MAAM,oBAAoB,GACxB,yBAAyB,IAAI,4BAA4B,CAAC;IAE5D,MAAM,SAAS,GACb,gBAAgB,IAAI,oBAAoB;QACtC,CAAC,CAAC,IAAI,wBAAS,CAAC,gBAAgB,CAAC,CAAC,IAAI,CAAC,oBAAoB,CAAC;QAC5D,CAAC,CAAC,IAAI,wBAAS,CAAC,YAAY,IAAI,KAAK,CAAC,CAAC;IAE3C,MAAM,aAAa,GAAG,IAAI,wBAAS,CAAC,GAAG,CAAC;SACrC,YAAY,CAAC,SAAS,CAAC;SACvB,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC;IAElB,MAAM,QAAQ,GAAG,IAAA,wBAAgB,EAC/B,SAAS,EACT,IAAA,sBAAc,EAAC,OAAO,CAAC,EACvB,OAAO,CACR,CAAC;IAEF,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;IAChE,CAAC;IAED,MAAM,GAAG,GAAG,aAAa,CAAC,YAAY,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IACtE,MAAM,IAAI,GAAG,aAAa,CAAC,YAAY,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAExE,OAAO;QACL,GAAG;QACH,IAAI;KACL,CAAC;AACJ,CAAC;AAtDD,4CAsDC;AAED;;;;;;GAMG;AACH,SAAS,SAAS,CAAC,OAAY,EAAE,SAA4C;IAC3E,MAAM,qBAAqB,GAAG,SAAS,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC;IAE1E,MAAM,UAAU,GAAG,qBAAqB,EAAE,wBAAwB,EAAE,CAAC,OAAO,CAAC,CAAC;IAE9E,MAAM,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,MAAM,EAAE,GACrD,UAAU,EAAE,eAA+C,IAAI,EAAE,CAAC;IAErE,MAAM,gBAAgB,GAAG,MAAM,EAAE,qBAAqB,CAAC;IACvD,MAAM,wBAAwB,GAAG,MAAM,EAAE,6BAA6B,CAAC;IAEvE,MAAM,gBAAgB,GAAG,oBAAoB;QAC3C,CAAC,CAAC,IAAI,wBAAS,CAAC,oBAAoB,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC/D,CAAC,CAAC,SAAS,CAAC;IAEd,MAAM,YAAY,GAAG,gBAAgB;QACnC,CAAC,CAAC,IAAI,wBAAS,CAAC,gBAAgB,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC3D,CAAC,CAAC,SAAS,CAAC;IAEd,MAAM,oBAAoB,GAAG,wBAAwB;QACnD,CAAC,CAAC,IAAI,wBAAS,CAAC,wBAAwB,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC;QACnE,CAAC,CAAC,SAAS,CAAC;IAEd,OAAO,EAAE,gBAAgB,EAAE,YAAY,EAAE,oBAAoB,EAAE,CAAC;AAClE,CAAC","sourcesContent":["import { toHex } from '@metamask/controller-utils';\nimport type { GasFeeEstimates } from '@metamask/gas-fee-controller';\nimport type { TransactionMeta } from '@metamask/transaction-controller';\nimport type { Hex } from '@metamask/utils';\nimport { BigNumber } from 'bignumber.js';\n\nimport { getNativeToken, getTokenFiatRate } from './token';\nimport type { TransactionPayControllerMessenger } from '..';\nimport type { FiatValue } from '../types';\n\n/**\n *\n * Calculate the estimated gas cost for a given transaction in fiat.\n *\n * @param transaction - Transaction to calculate gas cost for\n * @param messenger - Controller messenger.\n * @returns Estimated gas cost for the transaction.\n */\nexport function calculateTransactionGasCost(\n  transaction: TransactionMeta,\n  messenger: TransactionPayControllerMessenger,\n): FiatValue {\n  const { chainId, gasUsed, gasLimitNoBuffer, txParams } = transaction;\n  const { gas, maxFeePerGas, maxPriorityFeePerGas } = txParams;\n  const finalGas = gasUsed || gasLimitNoBuffer || gas || '0x0';\n\n  return calculateGasCost({\n    chainId,\n    gas: finalGas,\n    maxFeePerGas,\n    maxPriorityFeePerGas,\n    messenger,\n  });\n}\n\n/**\n * Calculate the gas cost for the specified parameters.\n *\n * @param request - Gas cost calculation parameters.\n * @param request.chainId - ID of the chain.\n * @param request.gas - Amount of gas the transaction will use.\n * @param request.maxFeePerGas - Max fee to pay per gas.\n * @param request.maxPriorityFeePerGas - Max priority fee to pay per gas.\n * @param request.messenger - Controller messenger.\n * @returns Estimated gas cost for the transaction.\n */\nexport function calculateGasCost(request: {\n  chainId: number | Hex;\n  gas: BigNumber.Value;\n  maxFeePerGas?: BigNumber.Value;\n  maxPriorityFeePerGas?: BigNumber.Value;\n  messenger: TransactionPayControllerMessenger;\n}): FiatValue {\n  const {\n    chainId: chainIdInput,\n    gas,\n    maxFeePerGas: maxFeePerGasInput,\n    maxPriorityFeePerGas: maxPriorityFeePerGasInput,\n    messenger,\n  } = request;\n\n  const chainId = toHex(chainIdInput);\n\n  const {\n    estimatedBaseFee,\n    maxFeePerGas: maxFeePerGasEstimate,\n    maxPriorityFeePerGas: maxPriorityFeePerGasEstimate,\n  } = getGasFee(chainId, messenger);\n\n  const maxFeePerGas = maxFeePerGasInput || maxFeePerGasEstimate;\n\n  const maxPriorityFeePerGas =\n    maxPriorityFeePerGasInput || maxPriorityFeePerGasEstimate;\n\n  const feePerGas =\n    estimatedBaseFee && maxPriorityFeePerGas\n      ? new BigNumber(estimatedBaseFee).plus(maxPriorityFeePerGas)\n      : new BigNumber(maxFeePerGas || '0x0');\n\n  const gasCostNative = new BigNumber(gas)\n    .multipliedBy(feePerGas)\n    .shiftedBy(-18);\n\n  const fiatRate = getTokenFiatRate(\n    messenger,\n    getNativeToken(chainId),\n    chainId,\n  );\n\n  if (!fiatRate) {\n    throw new Error('Could not fetch fiat rate for native token');\n  }\n\n  const usd = gasCostNative.multipliedBy(fiatRate.usdRate).toString(10);\n  const fiat = gasCostNative.multipliedBy(fiatRate.fiatRate).toString(10);\n\n  return {\n    usd,\n    fiat,\n  };\n}\n\n/**\n * Get gas fee estimates for a given chain.\n *\n * @param chainId - Chain ID.\n * @param messenger - Controller messenger.\n * @returns Gas fee estimates for the chain.\n */\nfunction getGasFee(chainId: Hex, messenger: TransactionPayControllerMessenger) {\n  const gasFeeControllerState = messenger.call('GasFeeController:getState');\n\n  const chainState = gasFeeControllerState?.gasFeeEstimatesByChainId?.[chainId];\n\n  const { estimatedBaseFee: estimatedBaseFeeGwei, medium } =\n    (chainState?.gasFeeEstimates as GasFeeEstimates | undefined) ?? {};\n\n  const maxFeePerGasGwei = medium?.suggestedMaxFeePerGas;\n  const maxPriorityFeePerGasGwei = medium?.suggestedMaxPriorityFeePerGas;\n\n  const estimatedBaseFee = estimatedBaseFeeGwei\n    ? new BigNumber(estimatedBaseFeeGwei).shiftedBy(9).toString(10)\n    : undefined;\n\n  const maxFeePerGas = maxFeePerGasGwei\n    ? new BigNumber(maxFeePerGasGwei).shiftedBy(9).toString(10)\n    : undefined;\n\n  const maxPriorityFeePerGas = maxPriorityFeePerGasGwei\n    ? new BigNumber(maxPriorityFeePerGasGwei).shiftedBy(9).toString(10)\n    : undefined;\n\n  return { estimatedBaseFee, maxFeePerGas, maxPriorityFeePerGas };\n}\n"]}
+{"version":3,"file":"gas.cjs","sourceRoot":"","sources":["../../src/utils/gas.ts"],"names":[],"mappings":";;;AAAA,iEAAmD;AAInD,+CAAyC;AAEzC,uCAKiB;AAEjB,0CAA8D;AAG9D,MAAM,GAAG,GAAG,IAAA,2BAAkB,EAAC,sBAAa,EAAE,KAAK,CAAC,CAAC;AAErD;;;;;;;;;GASG;AACH,SAAgB,2BAA2B,CACzC,WAA4B,EAC5B,SAA4C,EAC5C,EAAE,KAAK,KAA0B,EAAE;IAEnC,MAAM,EACJ,OAAO,EACP,OAAO,EAAE,eAAe,EACxB,gBAAgB,EAChB,QAAQ,GACT,GAAG,WAAW,CAAC;IAEhB,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,YAAY,EAAE,oBAAoB,EAAE,GAAG,QAAQ,CAAC;IACnE,MAAM,OAAO,GAAG,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,eAAe,CAAC;IACpD,MAAM,QAAQ,GAAG,OAAO,IAAI,gBAAgB,IAAI,GAAG,IAAI,KAAK,CAAC;IAE7D,MAAM,MAAM,GAAG,gBAAgB,CAAC;QAC9B,OAAO;QACP,GAAG,EAAE,QAAQ;QACb,KAAK;QACL,YAAY;QACZ,oBAAoB;QACpB,SAAS;KACV,CAAC,CAAC;IAEH,MAAM,GAAG,GAAG,gBAAgB,CAAC;QAC3B,OAAO;QACP,GAAG,EAAE,QAAQ;QACb,KAAK,EAAE,IAAI;QACX,SAAS;KACV,CAAC,CAAC;IAEH,MAAM,aAAa,GAAG,IAAA,uBAAe,EACnC,SAAS,EACT,IAAW,EACX,OAAO,EACP,IAAA,sBAAc,EAAC,OAAO,CAAC,CACxB,CAAC;IAEF,MAAM,UAAU,GAAG,IAAI,wBAAS,CAAC,aAAa,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAE7D,MAAM,eAAe,GAAG,wBAAwB,CAAC;QAC/C,UAAU;QACV,SAAS;QACT,WAAW;KACZ,CAAC,CAAC;IAEH,IAAI,eAAe,EAAE,CAAC;QACpB,OAAO,eAAe,CAAC;IACzB,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AApDD,kEAoDC;AAED;;;;;;;;;;;;GAYG;AACH,SAAgB,gBAAgB,CAAC,OAOhC;IACC,MAAM,EACJ,OAAO,EAAE,YAAY,EACrB,GAAG,EACH,KAAK,EACL,YAAY,EAAE,iBAAiB,EAC/B,oBAAoB,EAAE,yBAAyB,EAC/C,SAAS,GACV,GAAG,OAAO,CAAC;IAEZ,MAAM,OAAO,GAAG,IAAA,wBAAK,EAAC,YAAY,CAAC,CAAC;IAEpC,MAAM,EACJ,gBAAgB,EAChB,YAAY,EAAE,oBAAoB,EAClC,oBAAoB,EAAE,4BAA4B,GACnD,GAAG,SAAS,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;IAElC,MAAM,YAAY,GAAG,iBAAiB,IAAI,oBAAoB,CAAC;IAE/D,MAAM,oBAAoB,GACxB,yBAAyB,IAAI,4BAA4B,CAAC;IAE5D,MAAM,SAAS,GACb,gBAAgB,IAAI,oBAAoB,IAAI,CAAC,KAAK;QAChD,CAAC,CAAC,IAAI,wBAAS,CAAC,gBAAgB,CAAC,CAAC,IAAI,CAAC,oBAAoB,CAAC;QAC5D,CAAC,CAAC,IAAI,wBAAS,CAAC,YAAY,IAAI,KAAK,CAAC,CAAC;IAE3C,MAAM,QAAQ,GAAG,IAAI,wBAAS,CAAC,GAAG,CAAC,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;IAC5D,MAAM,GAAG,GAAG,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAElC,MAAM,UAAU,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC;IAC3C,MAAM,KAAK,GAAG,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAEtC,MAAM,QAAQ,GAAG,IAAA,wBAAgB,EAC/B,SAAS,EACT,IAAA,sBAAc,EAAC,OAAO,CAAC,EACvB,OAAO,CACR,CAAC;IAEF,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;IAChE,CAAC;IAED,MAAM,GAAG,GAAG,UAAU,CAAC,YAAY,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IACnE,MAAM,IAAI,GAAG,UAAU,CAAC,YAAY,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAErE,OAAO;QACL,IAAI;QACJ,KAAK;QACL,GAAG;QACH,GAAG;KACJ,CAAC;AACJ,CAAC;AA5DD,4CA4DC;AAED;;;;;;GAMG;AACH,SAAS,SAAS,CAAC,OAAY,EAAE,SAA4C;IAC3E,MAAM,qBAAqB,GAAG,SAAS,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC;IAE1E,MAAM,UAAU,GAAG,qBAAqB,EAAE,wBAAwB,EAAE,CAAC,OAAO,CAAC,CAAC;IAE9E,MAAM,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,MAAM,EAAE,GACrD,UAAU,EAAE,eAA+C,IAAI,EAAE,CAAC;IAErE,MAAM,gBAAgB,GAAG,MAAM,EAAE,qBAAqB,CAAC;IACvD,MAAM,wBAAwB,GAAG,MAAM,EAAE,6BAA6B,CAAC;IAEvE,MAAM,gBAAgB,GAAG,oBAAoB;QAC3C,CAAC,CAAC,IAAI,wBAAS,CAAC,oBAAoB,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC/D,CAAC,CAAC,SAAS,CAAC;IAEd,MAAM,YAAY,GAAG,gBAAgB;QACnC,CAAC,CAAC,IAAI,wBAAS,CAAC,gBAAgB,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC3D,CAAC,CAAC,SAAS,CAAC;IAEd,MAAM,oBAAoB,GAAG,wBAAwB;QACnD,CAAC,CAAC,IAAI,wBAAS,CAAC,wBAAwB,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC;QACnE,CAAC,CAAC,SAAS,CAAC;IAEd,OAAO,EAAE,gBAAgB,EAAE,YAAY,EAAE,oBAAoB,EAAE,CAAC;AAClE,CAAC;AAED;;;;;;;;GAQG;AACH,SAAS,wBAAwB,CAAC,EAChC,UAAU,EACV,SAAS,EACT,WAAW,GAKZ;IACC,MAAM,EACJ,OAAO,EACP,YAAY,EACZ,6BAA6B,EAC7B,mBAAmB,GACpB,GAAG,WAAW,CAAC;IAEhB,IACE,CAAC,YAAY;QACb,CAAC,mBAAmB;QACpB,CAAC,6BAA6B,IAAI,UAAU,CAAC,EAC7C,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,GAAG,CAAC,gCAAgC,EAAE,EAAE,mBAAmB,EAAE,OAAO,EAAE,CAAC,CAAC;IAExE,MAAM,WAAW,GAAG,YAAY,EAAE,IAAI,CACpC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,WAAW,EAAE,KAAK,mBAAmB,CAAC,WAAW,EAAE,CAC1E,CAAC;IAEF,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,GAAG,CAAC,yBAAyB,EAAE;YAC7B,YAAY;YACZ,mBAAmB;SACpB,CAAC,CAAC;QAEH,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,SAAS,GAAG,IAAA,oBAAY,EAAC,SAAS,EAAE,mBAAmB,EAAE,OAAO,CAAC,CAAC;IAExE,MAAM,aAAa,GAAG,IAAA,wBAAgB,EACpC,SAAS,EACT,mBAAmB,EACnB,OAAO,CACR,CAAC;IAEF,IAAI,CAAC,aAAa,IAAI,CAAC,SAAS,EAAE,CAAC;QACjC,GAAG,CAAC,+BAA+B,CAAC,CAAC;QACrC,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,QAAQ,GAAG,IAAI,wBAAS,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;IACnD,MAAM,GAAG,GAAG,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAElC,MAAM,UAAU,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;IAC3D,MAAM,KAAK,GAAG,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAEtC,MAAM,IAAI,GAAG,UAAU,CAAC,YAAY,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAC1E,MAAM,GAAG,GAAG,UAAU,CAAC,YAAY,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAExE,OAAO;QACL,aAAa,EAAE,IAAI;QACnB,IAAI;QACJ,KAAK;QACL,GAAG;QACH,GAAG;KACJ,CAAC;AACJ,CAAC","sourcesContent":["import { toHex } from '@metamask/controller-utils';\nimport type { GasFeeEstimates } from '@metamask/gas-fee-controller';\nimport type { TransactionMeta } from '@metamask/transaction-controller';\nimport type { Hex } from '@metamask/utils';\nimport { BigNumber } from 'bignumber.js';\n\nimport {\n  getNativeToken,\n  getTokenBalance,\n  getTokenFiatRate,\n  getTokenInfo,\n} from './token';\nimport type { TransactionPayControllerMessenger } from '..';\nimport { createModuleLogger, projectLogger } from '../logger';\nimport type { Amount } from '../types';\n\nconst log = createModuleLogger(projectLogger, 'gas');\n\n/**\n *\n * Calculate the estimated gas cost for a given transaction in fiat.\n *\n * @param transaction - Transaction to calculate gas cost for\n * @param messenger - Controller messenger.\n * @param options - Calculation options.\n * @param options.isMax - Whether to calculate the maximum fee.\n * @returns Estimated gas cost for the transaction.\n */\nexport function calculateTransactionGasCost(\n  transaction: TransactionMeta,\n  messenger: TransactionPayControllerMessenger,\n  { isMax }: { isMax?: boolean } = {},\n): Amount & { isGasFeeToken?: boolean } {\n  const {\n    chainId,\n    gasUsed: gasUsedOriginal,\n    gasLimitNoBuffer,\n    txParams,\n  } = transaction;\n\n  const { from, gas, maxFeePerGas, maxPriorityFeePerGas } = txParams;\n  const gasUsed = isMax ? undefined : gasUsedOriginal;\n  const finalGas = gasUsed || gasLimitNoBuffer || gas || '0x0';\n\n  const result = calculateGasCost({\n    chainId,\n    gas: finalGas,\n    isMax,\n    maxFeePerGas,\n    maxPriorityFeePerGas,\n    messenger,\n  });\n\n  const max = calculateGasCost({\n    chainId,\n    gas: finalGas,\n    isMax: true,\n    messenger,\n  });\n\n  const nativeBalance = getTokenBalance(\n    messenger,\n    from as Hex,\n    chainId,\n    getNativeToken(chainId),\n  );\n\n  const hasBalance = new BigNumber(nativeBalance).gte(max.raw);\n\n  const gasFeeTokenCost = calculateGasFeeTokenCost({\n    hasBalance,\n    messenger,\n    transaction,\n  });\n\n  if (gasFeeTokenCost) {\n    return gasFeeTokenCost;\n  }\n\n  return result;\n}\n\n/**\n * Calculate the gas cost for the specified parameters.\n *\n * @param request - Gas cost calculation parameters.\n * @param request.chainId - ID of the chain.\n * @param request.gas - Amount of gas the transaction will use.\n * @param request.isMax - Whether to calculate the maximum fee.\n * @param request.maxFeePerGas - Max fee to pay per gas.\n * @param request.maxPriorityFeePerGas - Max priority fee to pay per gas.\n * @param request.messenger - Controller messenger.\n \n * @returns Estimated gas cost for the transaction.\n */\nexport function calculateGasCost(request: {\n  chainId: number | Hex;\n  gas: BigNumber.Value;\n  isMax?: boolean;\n  maxFeePerGas?: BigNumber.Value;\n  maxPriorityFeePerGas?: BigNumber.Value;\n  messenger: TransactionPayControllerMessenger;\n}): Amount {\n  const {\n    chainId: chainIdInput,\n    gas,\n    isMax,\n    maxFeePerGas: maxFeePerGasInput,\n    maxPriorityFeePerGas: maxPriorityFeePerGasInput,\n    messenger,\n  } = request;\n\n  const chainId = toHex(chainIdInput);\n\n  const {\n    estimatedBaseFee,\n    maxFeePerGas: maxFeePerGasEstimate,\n    maxPriorityFeePerGas: maxPriorityFeePerGasEstimate,\n  } = getGasFee(chainId, messenger);\n\n  const maxFeePerGas = maxFeePerGasInput || maxFeePerGasEstimate;\n\n  const maxPriorityFeePerGas =\n    maxPriorityFeePerGasInput || maxPriorityFeePerGasEstimate;\n\n  const feePerGas =\n    estimatedBaseFee && maxPriorityFeePerGas && !isMax\n      ? new BigNumber(estimatedBaseFee).plus(maxPriorityFeePerGas)\n      : new BigNumber(maxFeePerGas || '0x0');\n\n  const rawValue = new BigNumber(gas).multipliedBy(feePerGas);\n  const raw = rawValue.toString(10);\n\n  const humanValue = rawValue.shiftedBy(-18);\n  const human = humanValue.toString(10);\n\n  const fiatRate = getTokenFiatRate(\n    messenger,\n    getNativeToken(chainId),\n    chainId,\n  );\n\n  if (!fiatRate) {\n    throw new Error('Could not fetch fiat rate for native token');\n  }\n\n  const usd = humanValue.multipliedBy(fiatRate.usdRate).toString(10);\n  const fiat = humanValue.multipliedBy(fiatRate.fiatRate).toString(10);\n\n  return {\n    fiat,\n    human,\n    raw,\n    usd,\n  };\n}\n\n/**\n * Get gas fee estimates for a given chain.\n *\n * @param chainId - Chain ID.\n * @param messenger - Controller messenger.\n * @returns Gas fee estimates for the chain.\n */\nfunction getGasFee(chainId: Hex, messenger: TransactionPayControllerMessenger) {\n  const gasFeeControllerState = messenger.call('GasFeeController:getState');\n\n  const chainState = gasFeeControllerState?.gasFeeEstimatesByChainId?.[chainId];\n\n  const { estimatedBaseFee: estimatedBaseFeeGwei, medium } =\n    (chainState?.gasFeeEstimates as GasFeeEstimates | undefined) ?? {};\n\n  const maxFeePerGasGwei = medium?.suggestedMaxFeePerGas;\n  const maxPriorityFeePerGasGwei = medium?.suggestedMaxPriorityFeePerGas;\n\n  const estimatedBaseFee = estimatedBaseFeeGwei\n    ? new BigNumber(estimatedBaseFeeGwei).shiftedBy(9).toString(10)\n    : undefined;\n\n  const maxFeePerGas = maxFeePerGasGwei\n    ? new BigNumber(maxFeePerGasGwei).shiftedBy(9).toString(10)\n    : undefined;\n\n  const maxPriorityFeePerGas = maxPriorityFeePerGasGwei\n    ? new BigNumber(maxPriorityFeePerGasGwei).shiftedBy(9).toString(10)\n    : undefined;\n\n  return { estimatedBaseFee, maxFeePerGas, maxPriorityFeePerGas };\n}\n\n/**\n * Calculate the cost of a gas fee token on a transaction.\n *\n * @param request - Request parameters.\n * @param request.hasBalance - Whether the user has enough balance to cover the gas fee.\n * @param request.messenger - Controller messenger.\n * @param request.transaction - Transaction to calculate gas fee token cost for.\n * @returns Cost of the gas fee token.\n */\nfunction calculateGasFeeTokenCost({\n  hasBalance,\n  messenger,\n  transaction,\n}: {\n  hasBalance: boolean;\n  messenger: TransactionPayControllerMessenger;\n  transaction: TransactionMeta;\n}): (Amount & { isGasFeeToken?: boolean }) | undefined {\n  const {\n    chainId,\n    gasFeeTokens,\n    isGasFeeTokenIgnoredIfBalance,\n    selectedGasFeeToken,\n  } = transaction;\n\n  if (\n    !gasFeeTokens ||\n    !selectedGasFeeToken ||\n    (isGasFeeTokenIgnoredIfBalance && hasBalance)\n  ) {\n    return undefined;\n  }\n\n  log('Calculating gas fee token cost', { selectedGasFeeToken, chainId });\n\n  const gasFeeToken = gasFeeTokens?.find(\n    (t) => t.tokenAddress.toLowerCase() === selectedGasFeeToken.toLowerCase(),\n  );\n\n  if (!gasFeeToken) {\n    log('Gas fee token not found', {\n      gasFeeTokens,\n      selectedGasFeeToken,\n    });\n\n    return undefined;\n  }\n\n  const tokenInfo = getTokenInfo(messenger, selectedGasFeeToken, chainId);\n\n  const tokenFiatRate = getTokenFiatRate(\n    messenger,\n    selectedGasFeeToken,\n    chainId,\n  );\n\n  if (!tokenFiatRate || !tokenInfo) {\n    log('Cannot get gas fee token info');\n    return undefined;\n  }\n\n  const rawValue = new BigNumber(gasFeeToken.amount);\n  const raw = rawValue.toString(10);\n\n  const humanValue = rawValue.shiftedBy(-tokenInfo.decimals);\n  const human = humanValue.toString(10);\n\n  const fiat = humanValue.multipliedBy(tokenFiatRate.fiatRate).toString(10);\n  const usd = humanValue.multipliedBy(tokenFiatRate.usdRate).toString(10);\n\n  return {\n    isGasFeeToken: true,\n    fiat,\n    human,\n    raw,\n    usd,\n  };\n}\n"]}

package/dist/utils/gas.d.cts

@@ -2,32 +2,41 @@ import type { TransactionMeta } from "@metamask/transaction-controller";
 import type { Hex } from "@metamask/utils";
 import { BigNumber } from "bignumber.js";
 import type { TransactionPayControllerMessenger } from "../index.cjs";
-import type { FiatValue } from "../types.cjs";
+import type { Amount } from "../types.cjs";
 /**
  *
  * Calculate the estimated gas cost for a given transaction in fiat.
  *
  * @param transaction - Transaction to calculate gas cost for
  * @param messenger - Controller messenger.
+ * @param options - Calculation options.
+ * @param options.isMax - Whether to calculate the maximum fee.
  * @returns Estimated gas cost for the transaction.
  */
-export declare function calculateTransactionGasCost(transaction: TransactionMeta, messenger: TransactionPayControllerMessenger): FiatValue;
+export declare function calculateTransactionGasCost(transaction: TransactionMeta, messenger: TransactionPayControllerMessenger, { isMax }?: {
+    isMax?: boolean;
+}): Amount & {
+    isGasFeeToken?: boolean;
+};
 /**
  * Calculate the gas cost for the specified parameters.
  *
  * @param request - Gas cost calculation parameters.
  * @param request.chainId - ID of the chain.
  * @param request.gas - Amount of gas the transaction will use.
+ * @param request.isMax - Whether to calculate the maximum fee.
  * @param request.maxFeePerGas - Max fee to pay per gas.
  * @param request.maxPriorityFeePerGas - Max priority fee to pay per gas.
  * @param request.messenger - Controller messenger.
+ 
  * @returns Estimated gas cost for the transaction.
  */
 export declare function calculateGasCost(request: {
     chainId: number | Hex;
     gas: BigNumber.Value;
+    isMax?: boolean;
     maxFeePerGas?: BigNumber.Value;
     maxPriorityFeePerGas?: BigNumber.Value;
     messenger: TransactionPayControllerMessenger;
-}): FiatValue;
+}): Amount;
 //# sourceMappingURL=gas.d.cts.map

package/dist/utils/gas.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"gas.d.cts","sourceRoot":"","sources":["../../src/utils/gas.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,yCAAyC;AACxE,OAAO,KAAK,EAAE,GAAG,EAAE,wBAAwB;AAC3C,OAAO,EAAE,SAAS,EAAE,qBAAqB;AAGzC,OAAO,KAAK,EAAE,iCAAiC,EAAE,qBAAW;AAC5D,OAAO,KAAK,EAAE,SAAS,EAAE,qBAAiB;AAE1C;;;;;;;GAOG;AACH,wBAAgB,2BAA2B,CACzC,WAAW,EAAE,eAAe,EAC5B,SAAS,EAAE,iCAAiC,GAC3C,SAAS,CAYX;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE;IACxC,OAAO,EAAE,MAAM,GAAG,GAAG,CAAC;IACtB,GAAG,EAAE,SAAS,CAAC,KAAK,CAAC;IACrB,YAAY,CAAC,EAAE,SAAS,CAAC,KAAK,CAAC;IAC/B,oBAAoB,CAAC,EAAE,SAAS,CAAC,KAAK,CAAC;IACvC,SAAS,EAAE,iCAAiC,CAAC;CAC9C,GAAG,SAAS,CAgDZ"}
+{"version":3,"file":"gas.d.cts","sourceRoot":"","sources":["../../src/utils/gas.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,yCAAyC;AACxE,OAAO,KAAK,EAAE,GAAG,EAAE,wBAAwB;AAC3C,OAAO,EAAE,SAAS,EAAE,qBAAqB;AAQzC,OAAO,KAAK,EAAE,iCAAiC,EAAE,qBAAW;AAE5D,OAAO,KAAK,EAAE,MAAM,EAAE,qBAAiB;AAIvC;;;;;;;;;GASG;AACH,wBAAgB,2BAA2B,CACzC,WAAW,EAAE,eAAe,EAC5B,SAAS,EAAE,iCAAiC,EAC5C,EAAE,KAAK,EAAE,GAAE;IAAE,KAAK,CAAC,EAAE,OAAO,CAAA;CAAO,GAClC,MAAM,GAAG;IAAE,aAAa,CAAC,EAAE,OAAO,CAAA;CAAE,CAgDtC;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE;IACxC,OAAO,EAAE,MAAM,GAAG,GAAG,CAAC;IACtB,GAAG,EAAE,SAAS,CAAC,KAAK,CAAC;IACrB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,YAAY,CAAC,EAAE,SAAS,CAAC,KAAK,CAAC;IAC/B,oBAAoB,CAAC,EAAE,SAAS,CAAC,KAAK,CAAC;IACvC,SAAS,EAAE,iCAAiC,CAAC;CAC9C,GAAG,MAAM,CAqDT"}

package/dist/utils/gas.d.mts

@@ -2,32 +2,41 @@ import type { TransactionMeta } from "@metamask/transaction-controller";
 import type { Hex } from "@metamask/utils";
 import { BigNumber } from "bignumber.js";
 import type { TransactionPayControllerMessenger } from "../index.mjs";
-import type { FiatValue } from "../types.mjs";
+import type { Amount } from "../types.mjs";
 /**
  *
  * Calculate the estimated gas cost for a given transaction in fiat.
  *
  * @param transaction - Transaction to calculate gas cost for
  * @param messenger - Controller messenger.
+ * @param options - Calculation options.
+ * @param options.isMax - Whether to calculate the maximum fee.
  * @returns Estimated gas cost for the transaction.
  */
-export declare function calculateTransactionGasCost(transaction: TransactionMeta, messenger: TransactionPayControllerMessenger): FiatValue;
+export declare function calculateTransactionGasCost(transaction: TransactionMeta, messenger: TransactionPayControllerMessenger, { isMax }?: {
+    isMax?: boolean;
+}): Amount & {
+    isGasFeeToken?: boolean;
+};
 /**
  * Calculate the gas cost for the specified parameters.
  *
  * @param request - Gas cost calculation parameters.
  * @param request.chainId - ID of the chain.
  * @param request.gas - Amount of gas the transaction will use.
+ * @param request.isMax - Whether to calculate the maximum fee.
  * @param request.maxFeePerGas - Max fee to pay per gas.
  * @param request.maxPriorityFeePerGas - Max priority fee to pay per gas.
  * @param request.messenger - Controller messenger.
+ 
  * @returns Estimated gas cost for the transaction.
  */
 export declare function calculateGasCost(request: {
     chainId: number | Hex;
     gas: BigNumber.Value;
+    isMax?: boolean;
     maxFeePerGas?: BigNumber.Value;
     maxPriorityFeePerGas?: BigNumber.Value;
     messenger: TransactionPayControllerMessenger;
-}): FiatValue;
+}): Amount;
 //# sourceMappingURL=gas.d.mts.map

package/dist/utils/gas.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"gas.d.mts","sourceRoot":"","sources":["../../src/utils/gas.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,yCAAyC;AACxE,OAAO,KAAK,EAAE,GAAG,EAAE,wBAAwB;AAC3C,OAAO,EAAE,SAAS,EAAE,qBAAqB;AAGzC,OAAO,KAAK,EAAE,iCAAiC,EAAE,qBAAW;AAC5D,OAAO,KAAK,EAAE,SAAS,EAAE,qBAAiB;AAE1C;;;;;;;GAOG;AACH,wBAAgB,2BAA2B,CACzC,WAAW,EAAE,eAAe,EAC5B,SAAS,EAAE,iCAAiC,GAC3C,SAAS,CAYX;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE;IACxC,OAAO,EAAE,MAAM,GAAG,GAAG,CAAC;IACtB,GAAG,EAAE,SAAS,CAAC,KAAK,CAAC;IACrB,YAAY,CAAC,EAAE,SAAS,CAAC,KAAK,CAAC;IAC/B,oBAAoB,CAAC,EAAE,SAAS,CAAC,KAAK,CAAC;IACvC,SAAS,EAAE,iCAAiC,CAAC;CAC9C,GAAG,SAAS,CAgDZ"}
+{"version":3,"file":"gas.d.mts","sourceRoot":"","sources":["../../src/utils/gas.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,yCAAyC;AACxE,OAAO,KAAK,EAAE,GAAG,EAAE,wBAAwB;AAC3C,OAAO,EAAE,SAAS,EAAE,qBAAqB;AAQzC,OAAO,KAAK,EAAE,iCAAiC,EAAE,qBAAW;AAE5D,OAAO,KAAK,EAAE,MAAM,EAAE,qBAAiB;AAIvC;;;;;;;;;GASG;AACH,wBAAgB,2BAA2B,CACzC,WAAW,EAAE,eAAe,EAC5B,SAAS,EAAE,iCAAiC,EAC5C,EAAE,KAAK,EAAE,GAAE;IAAE,KAAK,CAAC,EAAE,OAAO,CAAA;CAAO,GAClC,MAAM,GAAG;IAAE,aAAa,CAAC,EAAE,OAAO,CAAA;CAAE,CAgDtC;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE;IACxC,OAAO,EAAE,MAAM,GAAG,GAAG,CAAC;IACtB,GAAG,EAAE,SAAS,CAAC,KAAK,CAAC;IACrB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,YAAY,CAAC,EAAE,SAAS,CAAC,KAAK,CAAC;IAC/B,oBAAoB,CAAC,EAAE,SAAS,CAAC,KAAK,CAAC;IACvC,SAAS,EAAE,iCAAiC,CAAC;CAC9C,GAAG,MAAM,CAqDT"}

package/dist/utils/gas.mjs

@@ -1,25 +1,48 @@
 import { toHex } from "@metamask/controller-utils";
 import { BigNumber } from "bignumber.js";
-import { getNativeToken, getTokenFiatRate } from "./token.mjs";
+import { getNativeToken, getTokenBalance, getTokenFiatRate, getTokenInfo } from "./token.mjs";
+import { createModuleLogger, projectLogger } from "../logger.mjs";
+const log = createModuleLogger(projectLogger, 'gas');
 /**
  *
  * Calculate the estimated gas cost for a given transaction in fiat.
  *
  * @param transaction - Transaction to calculate gas cost for
  * @param messenger - Controller messenger.
+ * @param options - Calculation options.
+ * @param options.isMax - Whether to calculate the maximum fee.
  * @returns Estimated gas cost for the transaction.
  */
-export function calculateTransactionGasCost(transaction, messenger) {
-    const { chainId, gasUsed, gasLimitNoBuffer, txParams } = transaction;
-    const { gas, maxFeePerGas, maxPriorityFeePerGas } = txParams;
+export function calculateTransactionGasCost(transaction, messenger, { isMax } = {}) {
+    const { chainId, gasUsed: gasUsedOriginal, gasLimitNoBuffer, txParams, } = transaction;
+    const { from, gas, maxFeePerGas, maxPriorityFeePerGas } = txParams;
+    const gasUsed = isMax ? undefined : gasUsedOriginal;
     const finalGas = gasUsed || gasLimitNoBuffer || gas || '0x0';
-    return calculateGasCost({
+    const result = calculateGasCost({
         chainId,
         gas: finalGas,
+        isMax,
         maxFeePerGas,
         maxPriorityFeePerGas,
         messenger,
     });
+    const max = calculateGasCost({
+        chainId,
+        gas: finalGas,
+        isMax: true,
+        messenger,
+    });
+    const nativeBalance = getTokenBalance(messenger, from, chainId, getNativeToken(chainId));
+    const hasBalance = new BigNumber(nativeBalance).gte(max.raw);
+    const gasFeeTokenCost = calculateGasFeeTokenCost({
+        hasBalance,
+        messenger,
+        transaction,
+    });
+    if (gasFeeTokenCost) {
+        return gasFeeTokenCost;
+    }
+    return result;
 }
 /**
  * Calculate the gas cost for the specified parameters.
@@ -27,32 +50,37 @@ export function calculateTransactionGasCost(transaction, messenger) {
  * @param request - Gas cost calculation parameters.
  * @param request.chainId - ID of the chain.
  * @param request.gas - Amount of gas the transaction will use.
+ * @param request.isMax - Whether to calculate the maximum fee.
  * @param request.maxFeePerGas - Max fee to pay per gas.
  * @param request.maxPriorityFeePerGas - Max priority fee to pay per gas.
  * @param request.messenger - Controller messenger.
+ 
  * @returns Estimated gas cost for the transaction.
  */
 export function calculateGasCost(request) {
-    const { chainId: chainIdInput, gas, maxFeePerGas: maxFeePerGasInput, maxPriorityFeePerGas: maxPriorityFeePerGasInput, messenger, } = request;
+    const { chainId: chainIdInput, gas, isMax, maxFeePerGas: maxFeePerGasInput, maxPriorityFeePerGas: maxPriorityFeePerGasInput, messenger, } = request;
     const chainId = toHex(chainIdInput);
     const { estimatedBaseFee, maxFeePerGas: maxFeePerGasEstimate, maxPriorityFeePerGas: maxPriorityFeePerGasEstimate, } = getGasFee(chainId, messenger);
     const maxFeePerGas = maxFeePerGasInput || maxFeePerGasEstimate;
     const maxPriorityFeePerGas = maxPriorityFeePerGasInput || maxPriorityFeePerGasEstimate;
-    const feePerGas = estimatedBaseFee && maxPriorityFeePerGas
+    const feePerGas = estimatedBaseFee && maxPriorityFeePerGas && !isMax
         ? new BigNumber(estimatedBaseFee).plus(maxPriorityFeePerGas)
         : new BigNumber(maxFeePerGas || '0x0');
-    const gasCostNative = new BigNumber(gas)
-        .multipliedBy(feePerGas)
-        .shiftedBy(-18);
+    const rawValue = new BigNumber(gas).multipliedBy(feePerGas);
+    const raw = rawValue.toString(10);
+    const humanValue = rawValue.shiftedBy(-18);
+    const human = humanValue.toString(10);
     const fiatRate = getTokenFiatRate(messenger, getNativeToken(chainId), chainId);
     if (!fiatRate) {
         throw new Error('Could not fetch fiat rate for native token');
     }
-    const usd = gasCostNative.multipliedBy(fiatRate.usdRate).toString(10);
-    const fiat = gasCostNative.multipliedBy(fiatRate.fiatRate).toString(10);
+    const usd = humanValue.multipliedBy(fiatRate.usdRate).toString(10);
+    const fiat = humanValue.multipliedBy(fiatRate.fiatRate).toString(10);
     return {
-        usd,
         fiat,
+        human,
+        raw,
+        usd,
     };
 }
 /**
@@ -79,4 +107,49 @@ function getGasFee(chainId, messenger) {
         : undefined;
     return { estimatedBaseFee, maxFeePerGas, maxPriorityFeePerGas };
 }
+/**
+ * Calculate the cost of a gas fee token on a transaction.
+ *
+ * @param request - Request parameters.
+ * @param request.hasBalance - Whether the user has enough balance to cover the gas fee.
+ * @param request.messenger - Controller messenger.
+ * @param request.transaction - Transaction to calculate gas fee token cost for.
+ * @returns Cost of the gas fee token.
+ */
+function calculateGasFeeTokenCost({ hasBalance, messenger, transaction, }) {
+    const { chainId, gasFeeTokens, isGasFeeTokenIgnoredIfBalance, selectedGasFeeToken, } = transaction;
+    if (!gasFeeTokens ||
+        !selectedGasFeeToken ||
+        (isGasFeeTokenIgnoredIfBalance && hasBalance)) {
+        return undefined;
+    }
+    log('Calculating gas fee token cost', { selectedGasFeeToken, chainId });
+    const gasFeeToken = gasFeeTokens?.find((t) => t.tokenAddress.toLowerCase() === selectedGasFeeToken.toLowerCase());
+    if (!gasFeeToken) {
+        log('Gas fee token not found', {
+            gasFeeTokens,
+            selectedGasFeeToken,
+        });
+        return undefined;
+    }
+    const tokenInfo = getTokenInfo(messenger, selectedGasFeeToken, chainId);
+    const tokenFiatRate = getTokenFiatRate(messenger, selectedGasFeeToken, chainId);
+    if (!tokenFiatRate || !tokenInfo) {
+        log('Cannot get gas fee token info');
+        return undefined;
+    }
+    const rawValue = new BigNumber(gasFeeToken.amount);
+    const raw = rawValue.toString(10);
+    const humanValue = rawValue.shiftedBy(-tokenInfo.decimals);
+    const human = humanValue.toString(10);
+    const fiat = humanValue.multipliedBy(tokenFiatRate.fiatRate).toString(10);
+    const usd = humanValue.multipliedBy(tokenFiatRate.usdRate).toString(10);
+    return {
+        isGasFeeToken: true,
+        fiat,
+        human,
+        raw,
+        usd,
+    };
+}
 //# sourceMappingURL=gas.mjs.map

package/dist/utils/gas.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"gas.mjs","sourceRoot":"","sources":["../../src/utils/gas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,mCAAmC;AAInD,OAAO,EAAE,SAAS,EAAE,qBAAqB;AAEzC,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,oBAAgB;AAI3D;;;;;;;GAOG;AACH,MAAM,UAAU,2BAA2B,CACzC,WAA4B,EAC5B,SAA4C;IAE5C,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,gBAAgB,EAAE,QAAQ,EAAE,GAAG,WAAW,CAAC;IACrE,MAAM,EAAE,GAAG,EAAE,YAAY,EAAE,oBAAoB,EAAE,GAAG,QAAQ,CAAC;IAC7D,MAAM,QAAQ,GAAG,OAAO,IAAI,gBAAgB,IAAI,GAAG,IAAI,KAAK,CAAC;IAE7D,OAAO,gBAAgB,CAAC;QACtB,OAAO;QACP,GAAG,EAAE,QAAQ;QACb,YAAY;QACZ,oBAAoB;QACpB,SAAS;KACV,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,gBAAgB,CAAC,OAMhC;IACC,MAAM,EACJ,OAAO,EAAE,YAAY,EACrB,GAAG,EACH,YAAY,EAAE,iBAAiB,EAC/B,oBAAoB,EAAE,yBAAyB,EAC/C,SAAS,GACV,GAAG,OAAO,CAAC;IAEZ,MAAM,OAAO,GAAG,KAAK,CAAC,YAAY,CAAC,CAAC;IAEpC,MAAM,EACJ,gBAAgB,EAChB,YAAY,EAAE,oBAAoB,EAClC,oBAAoB,EAAE,4BAA4B,GACnD,GAAG,SAAS,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;IAElC,MAAM,YAAY,GAAG,iBAAiB,IAAI,oBAAoB,CAAC;IAE/D,MAAM,oBAAoB,GACxB,yBAAyB,IAAI,4BAA4B,CAAC;IAE5D,MAAM,SAAS,GACb,gBAAgB,IAAI,oBAAoB;QACtC,CAAC,CAAC,IAAI,SAAS,CAAC,gBAAgB,CAAC,CAAC,IAAI,CAAC,oBAAoB,CAAC;QAC5D,CAAC,CAAC,IAAI,SAAS,CAAC,YAAY,IAAI,KAAK,CAAC,CAAC;IAE3C,MAAM,aAAa,GAAG,IAAI,SAAS,CAAC,GAAG,CAAC;SACrC,YAAY,CAAC,SAAS,CAAC;SACvB,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC;IAElB,MAAM,QAAQ,GAAG,gBAAgB,CAC/B,SAAS,EACT,cAAc,CAAC,OAAO,CAAC,EACvB,OAAO,CACR,CAAC;IAEF,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;IAChE,CAAC;IAED,MAAM,GAAG,GAAG,aAAa,CAAC,YAAY,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IACtE,MAAM,IAAI,GAAG,aAAa,CAAC,YAAY,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAExE,OAAO;QACL,GAAG;QACH,IAAI;KACL,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,SAAS,SAAS,CAAC,OAAY,EAAE,SAA4C;IAC3E,MAAM,qBAAqB,GAAG,SAAS,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC;IAE1E,MAAM,UAAU,GAAG,qBAAqB,EAAE,wBAAwB,EAAE,CAAC,OAAO,CAAC,CAAC;IAE9E,MAAM,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,MAAM,EAAE,GACrD,UAAU,EAAE,eAA+C,IAAI,EAAE,CAAC;IAErE,MAAM,gBAAgB,GAAG,MAAM,EAAE,qBAAqB,CAAC;IACvD,MAAM,wBAAwB,GAAG,MAAM,EAAE,6BAA6B,CAAC;IAEvE,MAAM,gBAAgB,GAAG,oBAAoB;QAC3C,CAAC,CAAC,IAAI,SAAS,CAAC,oBAAoB,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC/D,CAAC,CAAC,SAAS,CAAC;IAEd,MAAM,YAAY,GAAG,gBAAgB;QACnC,CAAC,CAAC,IAAI,SAAS,CAAC,gBAAgB,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC3D,CAAC,CAAC,SAAS,CAAC;IAEd,MAAM,oBAAoB,GAAG,wBAAwB;QACnD,CAAC,CAAC,IAAI,SAAS,CAAC,wBAAwB,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC;QACnE,CAAC,CAAC,SAAS,CAAC;IAEd,OAAO,EAAE,gBAAgB,EAAE,YAAY,EAAE,oBAAoB,EAAE,CAAC;AAClE,CAAC","sourcesContent":["import { toHex } from '@metamask/controller-utils';\nimport type { GasFeeEstimates } from '@metamask/gas-fee-controller';\nimport type { TransactionMeta } from '@metamask/transaction-controller';\nimport type { Hex } from '@metamask/utils';\nimport { BigNumber } from 'bignumber.js';\n\nimport { getNativeToken, getTokenFiatRate } from './token';\nimport type { TransactionPayControllerMessenger } from '..';\nimport type { FiatValue } from '../types';\n\n/**\n *\n * Calculate the estimated gas cost for a given transaction in fiat.\n *\n * @param transaction - Transaction to calculate gas cost for\n * @param messenger - Controller messenger.\n * @returns Estimated gas cost for the transaction.\n */\nexport function calculateTransactionGasCost(\n  transaction: TransactionMeta,\n  messenger: TransactionPayControllerMessenger,\n): FiatValue {\n  const { chainId, gasUsed, gasLimitNoBuffer, txParams } = transaction;\n  const { gas, maxFeePerGas, maxPriorityFeePerGas } = txParams;\n  const finalGas = gasUsed || gasLimitNoBuffer || gas || '0x0';\n\n  return calculateGasCost({\n    chainId,\n    gas: finalGas,\n    maxFeePerGas,\n    maxPriorityFeePerGas,\n    messenger,\n  });\n}\n\n/**\n * Calculate the gas cost for the specified parameters.\n *\n * @param request - Gas cost calculation parameters.\n * @param request.chainId - ID of the chain.\n * @param request.gas - Amount of gas the transaction will use.\n * @param request.maxFeePerGas - Max fee to pay per gas.\n * @param request.maxPriorityFeePerGas - Max priority fee to pay per gas.\n * @param request.messenger - Controller messenger.\n * @returns Estimated gas cost for the transaction.\n */\nexport function calculateGasCost(request: {\n  chainId: number | Hex;\n  gas: BigNumber.Value;\n  maxFeePerGas?: BigNumber.Value;\n  maxPriorityFeePerGas?: BigNumber.Value;\n  messenger: TransactionPayControllerMessenger;\n}): FiatValue {\n  const {\n    chainId: chainIdInput,\n    gas,\n    maxFeePerGas: maxFeePerGasInput,\n    maxPriorityFeePerGas: maxPriorityFeePerGasInput,\n    messenger,\n  } = request;\n\n  const chainId = toHex(chainIdInput);\n\n  const {\n    estimatedBaseFee,\n    maxFeePerGas: maxFeePerGasEstimate,\n    maxPriorityFeePerGas: maxPriorityFeePerGasEstimate,\n  } = getGasFee(chainId, messenger);\n\n  const maxFeePerGas = maxFeePerGasInput || maxFeePerGasEstimate;\n\n  const maxPriorityFeePerGas =\n    maxPriorityFeePerGasInput || maxPriorityFeePerGasEstimate;\n\n  const feePerGas =\n    estimatedBaseFee && maxPriorityFeePerGas\n      ? new BigNumber(estimatedBaseFee).plus(maxPriorityFeePerGas)\n      : new BigNumber(maxFeePerGas || '0x0');\n\n  const gasCostNative = new BigNumber(gas)\n    .multipliedBy(feePerGas)\n    .shiftedBy(-18);\n\n  const fiatRate = getTokenFiatRate(\n    messenger,\n    getNativeToken(chainId),\n    chainId,\n  );\n\n  if (!fiatRate) {\n    throw new Error('Could not fetch fiat rate for native token');\n  }\n\n  const usd = gasCostNative.multipliedBy(fiatRate.usdRate).toString(10);\n  const fiat = gasCostNative.multipliedBy(fiatRate.fiatRate).toString(10);\n\n  return {\n    usd,\n    fiat,\n  };\n}\n\n/**\n * Get gas fee estimates for a given chain.\n *\n * @param chainId - Chain ID.\n * @param messenger - Controller messenger.\n * @returns Gas fee estimates for the chain.\n */\nfunction getGasFee(chainId: Hex, messenger: TransactionPayControllerMessenger) {\n  const gasFeeControllerState = messenger.call('GasFeeController:getState');\n\n  const chainState = gasFeeControllerState?.gasFeeEstimatesByChainId?.[chainId];\n\n  const { estimatedBaseFee: estimatedBaseFeeGwei, medium } =\n    (chainState?.gasFeeEstimates as GasFeeEstimates | undefined) ?? {};\n\n  const maxFeePerGasGwei = medium?.suggestedMaxFeePerGas;\n  const maxPriorityFeePerGasGwei = medium?.suggestedMaxPriorityFeePerGas;\n\n  const estimatedBaseFee = estimatedBaseFeeGwei\n    ? new BigNumber(estimatedBaseFeeGwei).shiftedBy(9).toString(10)\n    : undefined;\n\n  const maxFeePerGas = maxFeePerGasGwei\n    ? new BigNumber(maxFeePerGasGwei).shiftedBy(9).toString(10)\n    : undefined;\n\n  const maxPriorityFeePerGas = maxPriorityFeePerGasGwei\n    ? new BigNumber(maxPriorityFeePerGasGwei).shiftedBy(9).toString(10)\n    : undefined;\n\n  return { estimatedBaseFee, maxFeePerGas, maxPriorityFeePerGas };\n}\n"]}
+{"version":3,"file":"gas.mjs","sourceRoot":"","sources":["../../src/utils/gas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,mCAAmC;AAInD,OAAO,EAAE,SAAS,EAAE,qBAAqB;AAEzC,OAAO,EACL,cAAc,EACd,eAAe,EACf,gBAAgB,EAChB,YAAY,EACb,oBAAgB;AAEjB,OAAO,EAAE,kBAAkB,EAAE,aAAa,EAAE,sBAAkB;AAG9D,MAAM,GAAG,GAAG,kBAAkB,CAAC,aAAa,EAAE,KAAK,CAAC,CAAC;AAErD;;;;;;;;;GASG;AACH,MAAM,UAAU,2BAA2B,CACzC,WAA4B,EAC5B,SAA4C,EAC5C,EAAE,KAAK,KAA0B,EAAE;IAEnC,MAAM,EACJ,OAAO,EACP,OAAO,EAAE,eAAe,EACxB,gBAAgB,EAChB,QAAQ,GACT,GAAG,WAAW,CAAC;IAEhB,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,YAAY,EAAE,oBAAoB,EAAE,GAAG,QAAQ,CAAC;IACnE,MAAM,OAAO,GAAG,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,eAAe,CAAC;IACpD,MAAM,QAAQ,GAAG,OAAO,IAAI,gBAAgB,IAAI,GAAG,IAAI,KAAK,CAAC;IAE7D,MAAM,MAAM,GAAG,gBAAgB,CAAC;QAC9B,OAAO;QACP,GAAG,EAAE,QAAQ;QACb,KAAK;QACL,YAAY;QACZ,oBAAoB;QACpB,SAAS;KACV,CAAC,CAAC;IAEH,MAAM,GAAG,GAAG,gBAAgB,CAAC;QAC3B,OAAO;QACP,GAAG,EAAE,QAAQ;QACb,KAAK,EAAE,IAAI;QACX,SAAS;KACV,CAAC,CAAC;IAEH,MAAM,aAAa,GAAG,eAAe,CACnC,SAAS,EACT,IAAW,EACX,OAAO,EACP,cAAc,CAAC,OAAO,CAAC,CACxB,CAAC;IAEF,MAAM,UAAU,GAAG,IAAI,SAAS,CAAC,aAAa,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAE7D,MAAM,eAAe,GAAG,wBAAwB,CAAC;QAC/C,UAAU;QACV,SAAS;QACT,WAAW;KACZ,CAAC,CAAC;IAEH,IAAI,eAAe,EAAE,CAAC;QACpB,OAAO,eAAe,CAAC;IACzB,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,gBAAgB,CAAC,OAOhC;IACC,MAAM,EACJ,OAAO,EAAE,YAAY,EACrB,GAAG,EACH,KAAK,EACL,YAAY,EAAE,iBAAiB,EAC/B,oBAAoB,EAAE,yBAAyB,EAC/C,SAAS,GACV,GAAG,OAAO,CAAC;IAEZ,MAAM,OAAO,GAAG,KAAK,CAAC,YAAY,CAAC,CAAC;IAEpC,MAAM,EACJ,gBAAgB,EAChB,YAAY,EAAE,oBAAoB,EAClC,oBAAoB,EAAE,4BAA4B,GACnD,GAAG,SAAS,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;IAElC,MAAM,YAAY,GAAG,iBAAiB,IAAI,oBAAoB,CAAC;IAE/D,MAAM,oBAAoB,GACxB,yBAAyB,IAAI,4BAA4B,CAAC;IAE5D,MAAM,SAAS,GACb,gBAAgB,IAAI,oBAAoB,IAAI,CAAC,KAAK;QAChD,CAAC,CAAC,IAAI,SAAS,CAAC,gBAAgB,CAAC,CAAC,IAAI,CAAC,oBAAoB,CAAC;QAC5D,CAAC,CAAC,IAAI,SAAS,CAAC,YAAY,IAAI,KAAK,CAAC,CAAC;IAE3C,MAAM,QAAQ,GAAG,IAAI,SAAS,CAAC,GAAG,CAAC,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;IAC5D,MAAM,GAAG,GAAG,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAElC,MAAM,UAAU,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC;IAC3C,MAAM,KAAK,GAAG,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAEtC,MAAM,QAAQ,GAAG,gBAAgB,CAC/B,SAAS,EACT,cAAc,CAAC,OAAO,CAAC,EACvB,OAAO,CACR,CAAC;IAEF,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;IAChE,CAAC;IAED,MAAM,GAAG,GAAG,UAAU,CAAC,YAAY,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IACnE,MAAM,IAAI,GAAG,UAAU,CAAC,YAAY,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAErE,OAAO;QACL,IAAI;QACJ,KAAK;QACL,GAAG;QACH,GAAG;KACJ,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,SAAS,SAAS,CAAC,OAAY,EAAE,SAA4C;IAC3E,MAAM,qBAAqB,GAAG,SAAS,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC;IAE1E,MAAM,UAAU,GAAG,qBAAqB,EAAE,wBAAwB,EAAE,CAAC,OAAO,CAAC,CAAC;IAE9E,MAAM,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,MAAM,EAAE,GACrD,UAAU,EAAE,eAA+C,IAAI,EAAE,CAAC;IAErE,MAAM,gBAAgB,GAAG,MAAM,EAAE,qBAAqB,CAAC;IACvD,MAAM,wBAAwB,GAAG,MAAM,EAAE,6BAA6B,CAAC;IAEvE,MAAM,gBAAgB,GAAG,oBAAoB;QAC3C,CAAC,CAAC,IAAI,SAAS,CAAC,oBAAoB,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC/D,CAAC,CAAC,SAAS,CAAC;IAEd,MAAM,YAAY,GAAG,gBAAgB;QACnC,CAAC,CAAC,IAAI,SAAS,CAAC,gBAAgB,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC3D,CAAC,CAAC,SAAS,CAAC;IAEd,MAAM,oBAAoB,GAAG,wBAAwB;QACnD,CAAC,CAAC,IAAI,SAAS,CAAC,wBAAwB,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC;QACnE,CAAC,CAAC,SAAS,CAAC;IAEd,OAAO,EAAE,gBAAgB,EAAE,YAAY,EAAE,oBAAoB,EAAE,CAAC;AAClE,CAAC;AAED;;;;;;;;GAQG;AACH,SAAS,wBAAwB,CAAC,EAChC,UAAU,EACV,SAAS,EACT,WAAW,GAKZ;IACC,MAAM,EACJ,OAAO,EACP,YAAY,EACZ,6BAA6B,EAC7B,mBAAmB,GACpB,GAAG,WAAW,CAAC;IAEhB,IACE,CAAC,YAAY;QACb,CAAC,mBAAmB;QACpB,CAAC,6BAA6B,IAAI,UAAU,CAAC,EAC7C,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,GAAG,CAAC,gCAAgC,EAAE,EAAE,mBAAmB,EAAE,OAAO,EAAE,CAAC,CAAC;IAExE,MAAM,WAAW,GAAG,YAAY,EAAE,IAAI,CACpC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,WAAW,EAAE,KAAK,mBAAmB,CAAC,WAAW,EAAE,CAC1E,CAAC;IAEF,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,GAAG,CAAC,yBAAyB,EAAE;YAC7B,YAAY;YACZ,mBAAmB;SACpB,CAAC,CAAC;QAEH,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,SAAS,GAAG,YAAY,CAAC,SAAS,EAAE,mBAAmB,EAAE,OAAO,CAAC,CAAC;IAExE,MAAM,aAAa,GAAG,gBAAgB,CACpC,SAAS,EACT,mBAAmB,EACnB,OAAO,CACR,CAAC;IAEF,IAAI,CAAC,aAAa,IAAI,CAAC,SAAS,EAAE,CAAC;QACjC,GAAG,CAAC,+BAA+B,CAAC,CAAC;QACrC,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,QAAQ,GAAG,IAAI,SAAS,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;IACnD,MAAM,GAAG,GAAG,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAElC,MAAM,UAAU,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;IAC3D,MAAM,KAAK,GAAG,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAEtC,MAAM,IAAI,GAAG,UAAU,CAAC,YAAY,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAC1E,MAAM,GAAG,GAAG,UAAU,CAAC,YAAY,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAExE,OAAO;QACL,aAAa,EAAE,IAAI;QACnB,IAAI;QACJ,KAAK;QACL,GAAG;QACH,GAAG;KACJ,CAAC;AACJ,CAAC","sourcesContent":["import { toHex } from '@metamask/controller-utils';\nimport type { GasFeeEstimates } from '@metamask/gas-fee-controller';\nimport type { TransactionMeta } from '@metamask/transaction-controller';\nimport type { Hex } from '@metamask/utils';\nimport { BigNumber } from 'bignumber.js';\n\nimport {\n  getNativeToken,\n  getTokenBalance,\n  getTokenFiatRate,\n  getTokenInfo,\n} from './token';\nimport type { TransactionPayControllerMessenger } from '..';\nimport { createModuleLogger, projectLogger } from '../logger';\nimport type { Amount } from '../types';\n\nconst log = createModuleLogger(projectLogger, 'gas');\n\n/**\n *\n * Calculate the estimated gas cost for a given transaction in fiat.\n *\n * @param transaction - Transaction to calculate gas cost for\n * @param messenger - Controller messenger.\n * @param options - Calculation options.\n * @param options.isMax - Whether to calculate the maximum fee.\n * @returns Estimated gas cost for the transaction.\n */\nexport function calculateTransactionGasCost(\n  transaction: TransactionMeta,\n  messenger: TransactionPayControllerMessenger,\n  { isMax }: { isMax?: boolean } = {},\n): Amount & { isGasFeeToken?: boolean } {\n  const {\n    chainId,\n    gasUsed: gasUsedOriginal,\n    gasLimitNoBuffer,\n    txParams,\n  } = transaction;\n\n  const { from, gas, maxFeePerGas, maxPriorityFeePerGas } = txParams;\n  const gasUsed = isMax ? undefined : gasUsedOriginal;\n  const finalGas = gasUsed || gasLimitNoBuffer || gas || '0x0';\n\n  const result = calculateGasCost({\n    chainId,\n    gas: finalGas,\n    isMax,\n    maxFeePerGas,\n    maxPriorityFeePerGas,\n    messenger,\n  });\n\n  const max = calculateGasCost({\n    chainId,\n    gas: finalGas,\n    isMax: true,\n    messenger,\n  });\n\n  const nativeBalance = getTokenBalance(\n    messenger,\n    from as Hex,\n    chainId,\n    getNativeToken(chainId),\n  );\n\n  const hasBalance = new BigNumber(nativeBalance).gte(max.raw);\n\n  const gasFeeTokenCost = calculateGasFeeTokenCost({\n    hasBalance,\n    messenger,\n    transaction,\n  });\n\n  if (gasFeeTokenCost) {\n    return gasFeeTokenCost;\n  }\n\n  return result;\n}\n\n/**\n * Calculate the gas cost for the specified parameters.\n *\n * @param request - Gas cost calculation parameters.\n * @param request.chainId - ID of the chain.\n * @param request.gas - Amount of gas the transaction will use.\n * @param request.isMax - Whether to calculate the maximum fee.\n * @param request.maxFeePerGas - Max fee to pay per gas.\n * @param request.maxPriorityFeePerGas - Max priority fee to pay per gas.\n * @param request.messenger - Controller messenger.\n \n * @returns Estimated gas cost for the transaction.\n */\nexport function calculateGasCost(request: {\n  chainId: number | Hex;\n  gas: BigNumber.Value;\n  isMax?: boolean;\n  maxFeePerGas?: BigNumber.Value;\n  maxPriorityFeePerGas?: BigNumber.Value;\n  messenger: TransactionPayControllerMessenger;\n}): Amount {\n  const {\n    chainId: chainIdInput,\n    gas,\n    isMax,\n    maxFeePerGas: maxFeePerGasInput,\n    maxPriorityFeePerGas: maxPriorityFeePerGasInput,\n    messenger,\n  } = request;\n\n  const chainId = toHex(chainIdInput);\n\n  const {\n    estimatedBaseFee,\n    maxFeePerGas: maxFeePerGasEstimate,\n    maxPriorityFeePerGas: maxPriorityFeePerGasEstimate,\n  } = getGasFee(chainId, messenger);\n\n  const maxFeePerGas = maxFeePerGasInput || maxFeePerGasEstimate;\n\n  const maxPriorityFeePerGas =\n    maxPriorityFeePerGasInput || maxPriorityFeePerGasEstimate;\n\n  const feePerGas =\n    estimatedBaseFee && maxPriorityFeePerGas && !isMax\n      ? new BigNumber(estimatedBaseFee).plus(maxPriorityFeePerGas)\n      : new BigNumber(maxFeePerGas || '0x0');\n\n  const rawValue = new BigNumber(gas).multipliedBy(feePerGas);\n  const raw = rawValue.toString(10);\n\n  const humanValue = rawValue.shiftedBy(-18);\n  const human = humanValue.toString(10);\n\n  const fiatRate = getTokenFiatRate(\n    messenger,\n    getNativeToken(chainId),\n    chainId,\n  );\n\n  if (!fiatRate) {\n    throw new Error('Could not fetch fiat rate for native token');\n  }\n\n  const usd = humanValue.multipliedBy(fiatRate.usdRate).toString(10);\n  const fiat = humanValue.multipliedBy(fiatRate.fiatRate).toString(10);\n\n  return {\n    fiat,\n    human,\n    raw,\n    usd,\n  };\n}\n\n/**\n * Get gas fee estimates for a given chain.\n *\n * @param chainId - Chain ID.\n * @param messenger - Controller messenger.\n * @returns Gas fee estimates for the chain.\n */\nfunction getGasFee(chainId: Hex, messenger: TransactionPayControllerMessenger) {\n  const gasFeeControllerState = messenger.call('GasFeeController:getState');\n\n  const chainState = gasFeeControllerState?.gasFeeEstimatesByChainId?.[chainId];\n\n  const { estimatedBaseFee: estimatedBaseFeeGwei, medium } =\n    (chainState?.gasFeeEstimates as GasFeeEstimates | undefined) ?? {};\n\n  const maxFeePerGasGwei = medium?.suggestedMaxFeePerGas;\n  const maxPriorityFeePerGasGwei = medium?.suggestedMaxPriorityFeePerGas;\n\n  const estimatedBaseFee = estimatedBaseFeeGwei\n    ? new BigNumber(estimatedBaseFeeGwei).shiftedBy(9).toString(10)\n    : undefined;\n\n  const maxFeePerGas = maxFeePerGasGwei\n    ? new BigNumber(maxFeePerGasGwei).shiftedBy(9).toString(10)\n    : undefined;\n\n  const maxPriorityFeePerGas = maxPriorityFeePerGasGwei\n    ? new BigNumber(maxPriorityFeePerGasGwei).shiftedBy(9).toString(10)\n    : undefined;\n\n  return { estimatedBaseFee, maxFeePerGas, maxPriorityFeePerGas };\n}\n\n/**\n * Calculate the cost of a gas fee token on a transaction.\n *\n * @param request - Request parameters.\n * @param request.hasBalance - Whether the user has enough balance to cover the gas fee.\n * @param request.messenger - Controller messenger.\n * @param request.transaction - Transaction to calculate gas fee token cost for.\n * @returns Cost of the gas fee token.\n */\nfunction calculateGasFeeTokenCost({\n  hasBalance,\n  messenger,\n  transaction,\n}: {\n  hasBalance: boolean;\n  messenger: TransactionPayControllerMessenger;\n  transaction: TransactionMeta;\n}): (Amount & { isGasFeeToken?: boolean }) | undefined {\n  const {\n    chainId,\n    gasFeeTokens,\n    isGasFeeTokenIgnoredIfBalance,\n    selectedGasFeeToken,\n  } = transaction;\n\n  if (\n    !gasFeeTokens ||\n    !selectedGasFeeToken ||\n    (isGasFeeTokenIgnoredIfBalance && hasBalance)\n  ) {\n    return undefined;\n  }\n\n  log('Calculating gas fee token cost', { selectedGasFeeToken, chainId });\n\n  const gasFeeToken = gasFeeTokens?.find(\n    (t) => t.tokenAddress.toLowerCase() === selectedGasFeeToken.toLowerCase(),\n  );\n\n  if (!gasFeeToken) {\n    log('Gas fee token not found', {\n      gasFeeTokens,\n      selectedGasFeeToken,\n    });\n\n    return undefined;\n  }\n\n  const tokenInfo = getTokenInfo(messenger, selectedGasFeeToken, chainId);\n\n  const tokenFiatRate = getTokenFiatRate(\n    messenger,\n    selectedGasFeeToken,\n    chainId,\n  );\n\n  if (!tokenFiatRate || !tokenInfo) {\n    log('Cannot get gas fee token info');\n    return undefined;\n  }\n\n  const rawValue = new BigNumber(gasFeeToken.amount);\n  const raw = rawValue.toString(10);\n\n  const humanValue = rawValue.shiftedBy(-tokenInfo.decimals);\n  const human = humanValue.toString(10);\n\n  const fiat = humanValue.multipliedBy(tokenFiatRate.fiatRate).toString(10);\n  const usd = humanValue.multipliedBy(tokenFiatRate.usdRate).toString(10);\n\n  return {\n    isGasFeeToken: true,\n    fiat,\n    human,\n    raw,\n    usd,\n  };\n}\n"]}

package/dist/utils/quotes.cjs

@@ -90,7 +90,7 @@ function syncTransaction({ batchTransactions, messenger, paymentToken, totals, t
         tx.metamaskPay = {
             bridgeFeeFiat: totals.fees.provider.usd,
             chainId: paymentToken.chainId,
-            networkFeeFiat: totals.fees.sourceNetwork.usd,
+            networkFeeFiat: totals.fees.sourceNetwork.estimate.usd,
             tokenAddress: paymentToken.address,
             totalFiat: totals.total.usd,
         };
@@ -176,7 +176,7 @@ function buildQuoteRequests({ from, paymentToken, sourceAmounts, tokens, transac
  */
 async function getQuotes(transaction, requests, messenger) {
     const { id: transactionId } = transaction;
-    const strategy = await (0, strategy_1.getStrategy)(messenger, transaction);
+    const strategy = (0, strategy_1.getStrategy)(messenger, transaction);
     let quotes = [];
     try {
         quotes = requests?.length