@metamask/bridge-status-controller 71.2.0 → 72.0.0

package/dist/utils/transaction.d.mts

@@ -1,49 +1,29 @@
-import type { QuoteMetadata, QuoteResponse, TxData } from "@metamask/bridge-controller";
+import type { BatchSellTradesResponse, QuoteMetadata, QuoteResponse, SimulatedGasFeeLimits, Trade, TxData, TxFeeGasLimits } from "@metamask/bridge-controller";
 import { TransactionType } from "@metamask/transaction-controller";
-import type { BatchTransactionParams, TransactionController, TransactionMeta, TransactionParams } from "@metamask/transaction-controller";
-import { Hex } from "@metamask/utils";
-import { BigNumber } from "bignumber.js";
+import type { TransactionController, TransactionMeta, BatchTransactionParams } from "@metamask/transaction-controller";
+import type { Hex } from "@metamask/utils";
 import type { BridgeStatusControllerMessenger } from "../types.mjs";
+import type { QuoteAndTxMetadata } from "../types.mjs";
+export declare const isApprovalTx: (type: TransactionType) => boolean;
+export declare const isTradeTx: (type: TransactionType) => boolean;
 export declare const isCrossChainTx: (type: TransactionType) => boolean;
-export declare const getGasFeeEstimates: (messenger: BridgeStatusControllerMessenger, args: Parameters<TransactionController['estimateGasFee']>[0]) => Promise<{
-    maxFeePerGas?: string;
-    maxPriorityFeePerGas?: string;
-}>;
 /**
- * Get the gas fee estimates for a transaction
+ * For 7702 delegated transactions, check for delegation-specific fields
+ * These transactions might have authorizationList or delegationAddress
  *
- * @param messenger - The messenger for the gas fee estimates
- * @param estimateGasFeeParams - The parameters for the {@link TransactionController.estimateGasFee} method
- 
- * @returns The gas fee estimates for the transaction
+ * @param tx - The transaction meta
+ * @returns Whether the transaction is a 7702 transaction
  */
-export declare const getTxGasEstimates: (messenger: BridgeStatusControllerMessenger, estimateGasFeeParams: Parameters<TransactionController['estimateGasFee']>[0]) => Promise<{
-    baseAndPriorityFeePerGas: BigNumber | undefined;
-    maxFeePerGas: string | undefined;
-    maxPriorityFeePerGas: string | undefined;
-}>;
-export declare const calculateGasFees: (skipGasFields: boolean, messenger: BridgeStatusControllerMessenger, { chainId: _, gasLimit, ...trade }: TxData, networkClientId: string, chainId: Hex, txFee?: {
-    maxFeePerGas: string;
-    maxPriorityFeePerGas: string;
-}) => Promise<{
-    maxFeePerGas?: undefined;
-    maxPriorityFeePerGas?: undefined;
-    gas?: undefined;
-} | {
-    gas: string | undefined;
-    maxFeePerGas: string;
-    maxPriorityFeePerGas: string;
-} | {
-    maxFeePerGas: string | undefined;
-    maxPriorityFeePerGas: string | undefined;
-    gas: `0x${string}`;
-}>;
+export declare const is7702Tx: (tx: TransactionMeta) => boolean;
+export declare const shouldDisable7702: (gasIncluded7702?: boolean, gasIncluded?: boolean, isDelegatedAccount?: boolean) => boolean;
+export declare const hasNestedSwapTransactions: (txMeta: TransactionMeta) => boolean;
+export declare const getGasFeeEstimates: (messenger: BridgeStatusControllerMessenger, args: Parameters<TransactionController['estimateGasFee']>[0]) => Promise<import("@metamask/transaction-controller").FeeMarketGasFeeEstimateForLevel | undefined>;
 export declare const getTransactions: (messenger: BridgeStatusControllerMessenger) => TransactionMeta[];
 export declare const getTransactionMetaById: (messenger: BridgeStatusControllerMessenger, txId?: string) => TransactionMeta | undefined;
 export declare const getTransactionMetaByHash: (messenger: BridgeStatusControllerMessenger, txHash?: string) => TransactionMeta | undefined;
 export declare const updateTransaction: (messenger: BridgeStatusControllerMessenger, txMeta: TransactionMeta, txMetaUpdates: Partial<TransactionMeta>, note: string) => void;
 export declare const checkIsDelegatedAccount: (messenger: BridgeStatusControllerMessenger, fromAddress: Hex, chainIds: Hex[]) => Promise<boolean>;
-export declare const addTransaction: (messenger: BridgeStatusControllerMessenger, txParams: TransactionParams, options: import("@metamask/transaction-controller").AddTransactionOptions) => Promise<TransactionMeta>;
+export declare const addTransaction: (messenger: BridgeStatusControllerMessenger, txParams: import("@metamask/transaction-controller").TransactionParams, options: import("@metamask/transaction-controller").AddTransactionOptions) => Promise<TransactionMeta>;
 export declare const generateActionId: () => string;
 /**
  * Adds a synthetic transaction to the TransactionController to display pending intent orders in the UI
@@ -52,7 +32,7 @@ export declare const generateActionId: () => string;
  * @param args - The arguments for the transaction
  * @returns The transaction meta
  */
-export declare const addSyntheticTransaction: (messenger: BridgeStatusControllerMessenger, txParams: TransactionParams, options: import("@metamask/transaction-controller").AddTransactionOptions) => Promise<TransactionMeta>;
+export declare const addSyntheticTransaction: (messenger: BridgeStatusControllerMessenger, txParams: import("@metamask/transaction-controller").TransactionParams, options: import("@metamask/transaction-controller").AddTransactionOptions) => Promise<TransactionMeta>;
 export declare const handleApprovalDelay: (srcChainId: QuoteResponse['quote']['srcChainId']) => Promise<void>;
 /**
  * Adds a delay for hardware wallet transactions on mobile to fix an issue
@@ -77,125 +57,66 @@ export declare const waitForTxConfirmation: (messenger: BridgeStatusControllerMe
     timeoutMs?: number | undefined;
     pollMs?: number | undefined;
 }) => Promise<TransactionMeta>;
-export declare const toBatchTxParams: (skipGasFields: boolean, { chainId, gasLimit, ...trade }: TxData, { maxFeePerGas, maxPriorityFeePerGas, gas, }: {
-    maxFeePerGas?: string | undefined;
-    maxPriorityFeePerGas?: string | undefined;
-    gas?: string | undefined;
-}) => BatchTransactionParams;
-export declare const getAddTransactionBatchParams: ({ messenger, isBridgeTx, approval, resetApproval, trade, quoteResponse: { quote: { feeData: { txFee }, gasIncluded, gasIncluded7702, gasSponsored, }, sentAmount, toTokenAmount, }, requireApproval, isDelegatedAccount, }: {
-    messenger: BridgeStatusControllerMessenger;
+export declare const toQuoteAndTxMetadata: ({ quoteResponse, isBridgeTx, }: {
+    quoteResponse: QuoteResponse<Trade, Trade> & QuoteMetadata;
     isBridgeTx: boolean;
-    trade: TxData;
-    quoteResponse: Omit<QuoteResponse, 'approval' | 'trade'> & Partial<QuoteMetadata>;
-    approval?: {
-        chainId: number;
-        from: string;
-        to: string;
-        value: string;
-        data: string;
-        gasLimit: number | null;
-        effectiveGas?: number | undefined;
-    } | undefined;
-    resetApproval?: {
-        chainId: number;
-        from: string;
-        to: string;
-        value: string;
-        data: string;
-        gasLimit: number | null;
-        effectiveGas?: number | undefined;
-    } | undefined;
+}) => Omit<QuoteAndTxMetadata, 'txMeta'>[];
+/**
+ * Build the trade+quote metadata array for the batch sell transaction
+ * This ties together the quote, the tx params and the txMeta after submission
+ *
+ * @param options - The options for the batch sell transaction
+ * @param options.quoteResponses - The quote responses for the batch sell transaction
+ * @param options.batchSellTrades - The batch sell trades for the batch sell transaction
+ * @returns The trade+quote metadata array for the batch sell transaction
+ */
+export declare const toQuoteAndTxMetadataBatch: ({ quoteResponses, batchSellTrades, }: {
+    quoteResponses: (QuoteResponse<TxData, TxData> & QuoteMetadata)[];
+    batchSellTrades: BatchSellTradesResponse;
+}) => Omit<QuoteAndTxMetadata, 'txMeta'>[];
+/**
+ * Appends the gas fee estimates for a transaction and normalizes the trade data
+ *
+ * @param messenger - The messenger for the gas fee estimates
+ * @param trade - the trade data to append gas fees to
+ * @param trade.chainId - ignored, use chainId instead
+ * @param trade.gasLimit - the gas limit to use for the gas fee estimates
+ * @param networkClientId - the network client ID to use for the gas fee estimates
+ * @param chainId - the chain ID to use for the gas fee estimates
+ * @param simulatedGasFeeLimits - either the txFee from the quote or the simulated gas fee limits for the batch sell
+ * @returns The gas fee estimates for the transaction
+ */
+export declare const toTransactionParams: (messenger: BridgeStatusControllerMessenger, { chainId: tradeChainId, gasLimit, ...trade }: TxData, networkClientId: string, chainId: Hex, simulatedGasFeeLimits?: SimulatedGasFeeLimits | TxFeeGasLimits) => Promise<BatchTransactionParams>;
+export declare const getAddTransactionBatchParams: ({ messenger, tradeData, requireApproval, isDelegatedAccount, ...addTransactionBatchParams }: Partial<import("@metamask/transaction-controller").TransactionBatchRequest> & {
+    messenger: BridgeStatusControllerMessenger;
+    tradeData: QuoteAndTxMetadata[];
     requireApproval?: boolean | undefined;
     isDelegatedAccount?: boolean | undefined;
-}) => Promise<import("@metamask/transaction-controller").TransactionBatchRequest>;
-export declare const findAndUpdateTransactionsInBatch: ({ messenger, batchId, txDataByType, }: {
+}) => Promise<Parameters<TransactionController['addTransactionBatch']>[0]>;
+export declare const findAllTransactionsInBatch: ({ messenger, batchId, tradeData, }: {
     messenger: BridgeStatusControllerMessenger;
     batchId: string;
-    txDataByType: {
-        batch?: string | undefined;
-        bridge?: string | undefined;
-        bridgeApproval?: string | undefined;
-        cancel?: string | undefined;
-        contractInteraction?: string | undefined;
-        contractDeployment?: string | undefined;
-        eth_decrypt?: string | undefined;
-        eth_getEncryptionPublicKey?: string | undefined;
-        gas_payment?: string | undefined;
-        incoming?: string | undefined;
-        lendingDeposit?: string | undefined;
-        lendingWithdraw?: string | undefined;
-        moneyAccountDeposit?: string | undefined;
-        moneyAccountWithdraw?: string | undefined;
-        musdClaim?: string | undefined;
-        musdConversion?: string | undefined;
-        musdRelayDeposit?: string | undefined;
-        perpsAcrossDeposit?: string | undefined;
-        perpsDeposit?: string | undefined;
-        perpsDepositAndOrder?: string | undefined;
-        perpsRelayDeposit?: string | undefined;
-        perpsWithdraw?: string | undefined;
-        personal_sign?: string | undefined;
-        predictAcrossDeposit?: string | undefined;
-        predictAcrossWithdraw?: string | undefined;
-        predictBuy?: string | undefined;
-        predictClaim?: string | undefined;
-        predictDeposit?: string | undefined;
-        predictDepositAndOrder?: string | undefined;
-        predictSell?: string | undefined;
-        predictWithdraw?: string | undefined;
-        predictRelayDeposit?: string | undefined;
-        relayDeposit?: string | undefined;
-        retry?: string | undefined;
-        revokeDelegation?: string | undefined;
-        simpleSend?: string | undefined;
-        eth_signTypedData?: string | undefined;
-        smart?: string | undefined;
-        stakingClaim?: string | undefined;
-        stakingDeposit?: string | undefined;
-        stakingUnstake?: string | undefined;
-        swap?: string | undefined;
-        swapAndSend?: string | undefined;
-        swapApproval?: string | undefined;
-        approve?: string | undefined;
-        safetransferfrom?: string | undefined;
-        transfer?: string | undefined;
-        transferfrom?: string | undefined;
-        setapprovalforall?: string | undefined;
-        increaseAllowance?: string | undefined;
-        shieldSubscriptionApprove?: string | undefined;
-        cardDelegation?: string | undefined;
-    };
-}) => {
-    approvalMeta?: TransactionMeta | undefined;
-    tradeMeta?: TransactionMeta | undefined;
-};
-export declare const addTransactionBatch: (messenger: BridgeStatusControllerMessenger, addTransactionBatchFn: TransactionController['addTransactionBatch'], request: import("@metamask/transaction-controller").TransactionBatchRequest) => Promise<{
-    approvalMeta: TransactionMeta | undefined;
-    tradeMeta: TransactionMeta;
-}>;
+    tradeData: QuoteAndTxMetadata[];
+}) => QuoteAndTxMetadata[];
 /**
- * Submits an EVM transaction to the TransactionController
+ * This is a workaround to update the tx type after submission. Batch txs are submitted with
+ * the "batch" type, but we need to update to swap/bridge for display purposes.
  *
- * @param params - The parameters for the transaction
- * @param params.transactionType - The type of transaction to submit
- * @param params.trade - The trade data to confirm
- * @param params.requireApproval - Whether to require approval for the transaction
- * @param params.txFee - Optional gas fee parameters from the quote (used when gasIncluded is true)
- * @param params.txFee.maxFeePerGas - The maximum fee per gas from the quote
- * @param params.txFee.maxPriorityFeePerGas - The maximum priority fee per gas from the quote
- * @param params.actionId - Optional actionId for pre-submission history (if not provided, one is generated)
+ * @param params - The parameters for the transaction search
  * @param params.messenger - The messenger to use for the transaction
- * @returns The transaction meta
+ * @param params.allTradesWithMetadata - The quote, tx data and type for each transaction in the batch
+ * @returns A list of transaction metas for each trade in the batch]
+ *
+ * @example
+ * [
+ *   {...tradeData[0], tradeMeta: TransactionMeta}
+ *   {...tradeData[1], tradeMeta: TransactionMeta}
+ *   {...tradeData[2], tradeMeta: TransactionMeta}
+ *   {...tradeData[3], tradeMeta: TransactionMeta}
+ * ]
  */
-export declare const submitEvmTransaction: ({ messenger, trade, transactionType, requireApproval, txFee, actionId, }: {
+export declare const updateTransactionsInBatch: ({ messenger, allTradesWithMetadata, }: {
     messenger: BridgeStatusControllerMessenger;
-    transactionType: TransactionType;
-    trade: TxData;
-    requireApproval?: boolean | undefined;
-    txFee?: {
-        maxFeePerGas: string;
-        maxPriorityFeePerGas: string;
-    } | undefined;
-    actionId?: string | undefined;
-}) => Promise<TransactionMeta>;
+    allTradesWithMetadata: QuoteAndTxMetadata[];
+}) => QuoteAndTxMetadata[];
 //# sourceMappingURL=transaction.d.mts.map

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

@@ -1 +1 @@
-{"version":3,"file":"transaction.d.mts","sourceRoot":"","sources":["../../src/utils/transaction.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EACV,aAAa,EACb,aAAa,EACb,MAAM,EACP,oCAAoC;AAErC,OAAO,EAEL,eAAe,EAChB,yCAAyC;AAC1C,OAAO,KAAK,EACV,sBAAsB,EAEtB,qBAAqB,EACrB,eAAe,EAEf,iBAAiB,EAClB,yCAAyC;AAC1C,OAAO,EAAuB,GAAG,EAAE,wBAAwB;AAC3D,OAAO,EAAE,SAAS,EAAE,qBAAqB;AAGzC,OAAO,KAAK,EAAE,+BAA+B,EAAE,qBAAiB;AAShE,eAAO,MAAM,cAAc,SAAU,eAAe,YACb,CAAC;AAExC,eAAO,MAAM,kBAAkB,qDAEvB,WAAW,qBAAqB,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC,KAC3D,QAAQ;IAAE,YAAY,CAAC,EAAE,MAAM,CAAC;IAAC,oBAAoB,CAAC,EAAE,MAAM,CAAA;CAAE,CAclE,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,iBAAiB,qEAEN,WAAW,qBAAqB,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC;;;;EA4B7E,CAAC;AAEF,eAAO,MAAM,gBAAgB,kBACZ,OAAO,kFAEc,MAAM,mBACzB,MAAM,WACd,GAAG,UACJ;IAAE,YAAY,EAAE,MAAM,CAAC;IAAC,oBAAoB,EAAE,MAAM,CAAA;CAAE;;;;;;kBAAtC,MAAM;0BAAwB,MAAM;;;;;EA8B7D,CAAC;AAEF,eAAO,MAAM,eAAe,mEAE3B,CAAC;AAEF,eAAO,MAAM,sBAAsB,sDAE1B,MAAM,gCAKd,CAAC;AAEF,eAAO,MAAM,wBAAwB,wDAE1B,MAAM,gCAKhB,CAAC;AAEF,eAAO,MAAM,iBAAiB,uDAEpB,eAAe,iBACR,QAAQ,eAAe,CAAC,QACjC,MAAM,SAOb,CAAC;AAEF,eAAO,MAAM,uBAAuB,4DAErB,GAAG,YACN,GAAG,EAAE,KACd,QAAQ,OAAO,CAgBjB,CAAC;AAkBF,eAAO,MAAM,cAAc,kLAS1B,CAAC;AAEF,eAAO,MAAM,gBAAgB,cAAgD,CAAC;AAE9E;;;;;;GAMG;AACH,eAAO,MAAM,uBAAuB,kLAgBnC,CAAC;AAEF,eAAO,MAAM,mBAAmB,eAClB,aAAa,CAAC,OAAO,CAAC,CAAC,YAAY,CAAC,kBAYjD,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,+BAA+B,oBACzB,OAAO,kBAQzB,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,qBAAqB,qDAE1B,MAAM;;;MAKX,QAAQ,eAAe,CAwBzB,CAAC;AAEF,eAAO,MAAM,eAAe,kBACX,OAAO,mCACW,MAAM;;;;MAMtC,sBAiBF,CAAC;AAEF,eAAO,MAAM,4BAA4B;;gBAoB3B,OAAO;WACZ,MAAM;mBACE,KAAK,aAAa,EAAE,UAAU,GAAG,OAAO,CAAC,GACtD,QAAQ,aAAa,CAAC;;;;;;;;;;;;;;;;;;;;;iFA6FzB,CAAC;AAEF,eAAO,MAAM,gCAAgC;;aAMlC,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAoEhB,CAAC;AAEF,eAAO,MAAM,mBAAmB,sEAEP,qBAAqB,CAAC,qBAAqB,CAAC;;;EAiCpE,CAAC;AAyCF;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,oBAAoB;;qBAUd,eAAe;WACzB,MAAM;;;sBAEW,MAAM;8BAAwB,MAAM;;;MAE1D,QAAQ,eAAe,CAiD1B,CAAC"}
+{"version":3,"file":"transaction.d.mts","sourceRoot":"","sources":["../../src/utils/transaction.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EACV,uBAAuB,EACvB,aAAa,EACb,aAAa,EACb,qBAAqB,EACrB,KAAK,EACL,MAAM,EACN,cAAc,EACf,oCAAoC;AAErC,OAAO,EAGL,eAAe,EAChB,yCAAyC;AAC1C,OAAO,KAAK,EAEV,qBAAqB,EACrB,eAAe,EAEf,sBAAsB,EACvB,yCAAyC;AAE1C,OAAO,KAAK,EAAE,GAAG,EAAE,wBAAwB;AAG3C,OAAO,KAAK,EAAE,+BAA+B,EAAE,qBAAiB;AAChE,OAAO,KAAK,EAAE,kBAAkB,EAAE,qBAAiB;AAInD,eAAO,MAAM,YAAY,SAAU,eAAe,YAEX,CAAC;AACxC,eAAO,MAAM,SAAS,SAAU,eAAe,YACmB,CAAC;AACnE,eAAO,MAAM,cAAc,SAAU,eAAe,YACb,CAAC;AAExC;;;;;;GAMG;AACH,eAAO,MAAM,QAAQ,OAAQ,eAAe,YAM3C,CAAC;AAEF,eAAO,MAAM,iBAAiB,qBACX,OAAO,gBACX,OAAO,uBACA,OAAO,KAC1B,OAiBF,CAAC;AAEF,eAAO,MAAM,yBAAyB,WAAY,eAAe,YAIhE,CAAC;AAEF,eAAO,MAAM,kBAAkB,qDAEvB,WAAW,qBAAqB,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC,oGAY7D,CAAC;AAEF,eAAO,MAAM,eAAe,mEAE3B,CAAC;AAEF,eAAO,MAAM,sBAAsB,sDAE1B,MAAM,gCAKd,CAAC;AAEF,eAAO,MAAM,wBAAwB,wDAE1B,MAAM,gCAKhB,CAAC;AAEF,eAAO,MAAM,iBAAiB,uDAEpB,eAAe,iBACR,QAAQ,eAAe,CAAC,QACjC,MAAM,SAOb,CAAC;AAEF,eAAO,MAAM,uBAAuB,4DAErB,GAAG,YACN,GAAG,EAAE,KACd,QAAQ,OAAO,CAgBjB,CAAC;AAkBF,eAAO,MAAM,cAAc,6NAS1B,CAAC;AAEF,eAAO,MAAM,gBAAgB,cAAgD,CAAC;AAE9E;;;;;;GAMG;AACH,eAAO,MAAM,uBAAuB,6NAgBnC,CAAC;AAEF,eAAO,MAAM,mBAAmB,eAClB,aAAa,CAAC,OAAO,CAAC,CAAC,YAAY,CAAC,kBAYjD,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,+BAA+B,oBACzB,OAAO,kBAQzB,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,qBAAqB,qDAE1B,MAAM;;;MAKX,QAAQ,eAAe,CAwBzB,CAAC;AAEF,eAAO,MAAM,oBAAoB;mBAIhB,cAAc,KAAK,EAAE,KAAK,CAAC,GAAG,aAAa;gBAC9C,OAAO;MACjB,KAAK,kBAAkB,EAAE,QAAQ,CAAC,EAmCrC,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,yBAAyB;oBAIpB,CAAC,cAAc,MAAM,EAAE,MAAM,CAAC,GAAG,aAAa,CAAC,EAAE;qBAChD,uBAAuB;MACtC,KAAK,kBAAkB,EAAE,QAAQ,CAAC,EA4DrC,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,mBAAmB,8FAEiB,MAAM,mBACpC,MAAM,WACd,GAAG,0BACY,qBAAqB,GAAG,cAAc,KAC7D,QAAQ,sBAAsB,CAmChC,CAAC;AAEF,eAAO,MAAM,4BAA4B;;eAQ5B,kBAAkB,EAAE;;;MAG7B,QAAQ,WAAW,qBAAqB,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC,CAAC,CAkCtE,CAAC;AAEF,eAAO,MAAM,0BAA0B;;aAM5B,MAAM;eACJ,kBAAkB,EAAE;MAC7B,kBAAkB,EA8BrB,CAAC;AAEF;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,yBAAyB;;2BAKb,kBAAkB,EAAE;0BAmB5C,CAAC"}