@metamask-previews/bridge-controller 79.0.1-preview-58a4a8b71 → 79.0.1-preview-4c8a5dfcb

package/dist/utils/quote-metadata/types.cjs

@@ -1,3 +1,19 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.QuoteMetadataMigrationPhase = void 0;
+exports.QuoteMetadataMigrationPhase = {
+    /**
+     * Phase 1: omit API V2 currency metadata; serve legacy calcQuoteMetadata
+     * into V2 nested shape
+     */
+    V1Data: '1',
+    /**
+     * Phase 1.5: prefer API V2 metadata (+ fiat from usd); fall back to legacy.
+     */
+    V2WithV1Fallback: '1.5',
+    /**
+     * Phase 2: API V2 metadata only; legacy metadata utils can be removed.
+     */
+    V2Only: '2',
+};
 //# sourceMappingURL=types.cjs.map

package/dist/utils/quote-metadata/types.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"types.cjs","sourceRoot":"","sources":["../../../src/utils/quote-metadata/types.ts"],"names":[],"mappings":"","sourcesContent":["import type { DeepPartial } from '../../types.js';\n\n/**\n * The types of values for the token amount and its values when converted to the user's selected currency and USD\n */\nexport type TokenAmountValues = {\n  /**\n   * The amount of the token\n   *\n   * @example \"1.005\"\n   */\n  amount: string;\n  /**\n   * The amount of the token in the user's selected currency\n   *\n   * @example \"4.55\"\n   */\n  valueInCurrency: string;\n  /**\n   * The amount of the token in USD\n   *\n   * @example \"1.234\"\n   */\n  usd: string;\n};\n\n/**\n * Values derived from the quote response\n *\n * @deprecated Avoid introducing new usages and use the QuoteResponse V2 type instead\n */\ntype QuoteMetadataV1 = {\n  /**\n   * If gas is included, this is the value of the src or dest token that was used to pay for the gas.\n   * Show this value to indicate transaction fees for gasless quotes.\n   */\n  includedTxFees?: Partial<TokenAmountValues>;\n  /**\n   * The gas fee for the bridge transaction.\n   * effective is the gas fee that is shown to the user. If this value is not\n   * included in the trade, the calculation falls back to the gasLimit (total)\n   * total is the gas fee that is spent by the user, including refunds.\n   * max is the max gas fee that will be used by the transaction.\n   */\n  gasFee: Record<'total', TokenAmountValues>;\n  relayerFee?: Partial<TokenAmountValues>; // relayer/provider fee in native units\n  /**\n   * The total network fee required to submit the trade and any approvals. This includes\n   * the relayer fee or other native fees. Should be used for balance checks and tx submission.\n   * Note: This is only accurate for non-gasless transactions. Use {@link QuoteMetadata.includedTxFees} to\n   * get the total network fee for gasless transactions.\n   */\n  totalNetworkFee: TokenAmountValues; // gasFee.total + relayerFee\n  /**\n   * The amount that the user will receive (destTokenAmount)\n   */\n  toTokenAmount: TokenAmountValues;\n  /**\n   * The minimum amount that the user will receive (minDestTokenAmount)\n   */\n  minToTokenAmount: TokenAmountValues;\n  /**\n   * If gas is included: {@link QuoteMetadata.toTokenAmount} - {@link QuoteMetadata.includedTxFees}.\n   * Otherwise: {@link QuoteMetadata.toTokenAmount} - {@link QuoteMetadata.totalNetworkFee}.\n   */\n  adjustedReturn: Omit<TokenAmountValues, 'amount'>;\n  /**\n   * The amount that the user will send, including fees that are paid in the src token\n   * {@link Quote.srcTokenAmount} + {@link Quote.feeData[FeeType.METABRIDGE].amount} + {@link Quote.feeData[FeeType.TX_FEE].amount}\n   */\n  sentAmount: TokenAmountValues;\n  /**\n   * The swap rate is the amount that the user will receive per amount sent. Accounts for fees paid in the src or dest token.\n   * This is calculated as {@link QuoteMetadata.toTokenAmount} / {@link QuoteMetadata.sentAmount}.\n   */\n  swapRate: string;\n  /**\n   * The cost of the trade, which is the difference between the amount sent and the adjusted return.\n   * This is calculated as {@link QuoteMetadata.sentAmount} - {@link QuoteMetadata.adjustedReturn}.\n   */\n  cost: Omit<TokenAmountValues, 'amount'>; // sentAmount - adjustedReturn\n\n  /**\n   * The price impact for the quote.\n   */\n  priceImpact: Omit<TokenAmountValues, 'amount'>; // abs(sentAmount - toTokenAmount);\n};\n\nexport type QuoteMetadata = DeepPartial<QuoteMetadataV1>;\n"]}
+{"version":3,"file":"types.cjs","sourceRoot":"","sources":["../../../src/utils/quote-metadata/types.ts"],"names":[],"mappings":";;;AA+Fa,QAAA,2BAA2B,GAAG;IACzC;;;OAGG;IACH,MAAM,EAAE,GAAG;IACX;;OAEG;IACH,gBAAgB,EAAE,KAAK;IACvB;;OAEG;IACH,MAAM,EAAE,GAAG;CACH,CAAC","sourcesContent":["import type { DeepPartial } from '../../types.js';\n\n/**\n * The types of values for the token amount and its values when converted to the user's selected currency and USD\n */\nexport type TokenAmountValues = {\n  /**\n   * The amount of the token\n   *\n   * @example \"1.005\"\n   */\n  amount: string;\n  /**\n   * The amount of the token in the user's selected currency\n   *\n   * @example \"4.55\"\n   */\n  valueInCurrency: string;\n  /**\n   * The amount of the token in USD\n   *\n   * @example \"1.234\"\n   */\n  usd: string;\n};\n\n/**\n * Values derived from the quote response\n *\n * @deprecated Avoid introducing new usages and use the QuoteResponse V2 type instead\n */\ntype QuoteMetadataV1 = {\n  /**\n   * If gas is included, this is the value of the src or dest token that was used to pay for the gas.\n   * Show this value to indicate transaction fees for gasless quotes.\n   */\n  includedTxFees?: Partial<TokenAmountValues>;\n  /**\n   * The gas fee for the bridge transaction.\n   * effective is the gas fee that is shown to the user. If this value is not\n   * included in the trade, the calculation falls back to the gasLimit (total)\n   * total is the gas fee that is spent by the user, including refunds.\n   * max is the max gas fee that will be used by the transaction.\n   */\n  gasFee: Record<'total', TokenAmountValues>;\n  relayerFee?: Partial<TokenAmountValues>; // relayer/provider fee in native units\n  /**\n   * The total network fee required to submit the trade and any approvals. This includes\n   * the relayer fee or other native fees. Should be used for balance checks and tx submission.\n   * Note: This is only accurate for non-gasless transactions. Use {@link QuoteMetadata.includedTxFees} to\n   * get the total network fee for gasless transactions.\n   */\n  totalNetworkFee: TokenAmountValues; // gasFee.total + relayerFee\n  /**\n   * The amount that the user will receive (destTokenAmount)\n   */\n  toTokenAmount: TokenAmountValues;\n  /**\n   * The minimum amount that the user will receive (minDestTokenAmount)\n   */\n  minToTokenAmount: TokenAmountValues;\n  /**\n   * If gas is included: {@link QuoteMetadata.toTokenAmount} - {@link QuoteMetadata.includedTxFees}.\n   * Otherwise: {@link QuoteMetadata.toTokenAmount} - {@link QuoteMetadata.totalNetworkFee}.\n   */\n  adjustedReturn: Omit<TokenAmountValues, 'amount'>;\n  /**\n   * The amount that the user will send, including fees that are paid in the src token\n   * {@link Quote.srcTokenAmount} + {@link Quote.feeData[FeeType.METABRIDGE].amount} + {@link Quote.feeData[FeeType.TX_FEE].amount}\n   */\n  sentAmount: TokenAmountValues;\n  /**\n   * The swap rate is the amount that the user will receive per amount sent. Accounts for fees paid in the src or dest token.\n   * This is calculated as {@link QuoteMetadata.toTokenAmount} / {@link QuoteMetadata.sentAmount}.\n   */\n  swapRate: string;\n  /**\n   * The cost of the trade, which is the difference between the amount sent and the adjusted return.\n   * This is calculated as {@link QuoteMetadata.sentAmount} - {@link QuoteMetadata.adjustedReturn}.\n   */\n  cost: Omit<TokenAmountValues, 'amount'>; // sentAmount - adjustedReturn\n\n  /**\n   * The price impact for the quote.\n   */\n  priceImpact: Omit<TokenAmountValues, 'amount'>; // abs(sentAmount - toTokenAmount);\n};\n\n/**\n * The partial legacy quote metadata\n *\n * @deprecated Avoid introducing new usages and use the nested QuoteResponse metadata instead\n */\nexport type QuoteMetadata = DeepPartial<QuoteMetadataV1>;\n\nexport const QuoteMetadataMigrationPhase = {\n  /**\n   * Phase 1: omit API V2 currency metadata; serve legacy calcQuoteMetadata\n   * into V2 nested shape\n   */\n  V1Data: '1',\n  /**\n   * Phase 1.5: prefer API V2 metadata (+ fiat from usd); fall back to legacy.\n   */\n  V2WithV1Fallback: '1.5',\n  /**\n   * Phase 2: API V2 metadata only; legacy metadata utils can be removed.\n   */\n  V2Only: '2',\n} as const;\n\nexport type QuoteMetadataMigrationPhase =\n  (typeof QuoteMetadataMigrationPhase)[keyof typeof QuoteMetadataMigrationPhase];\n"]}

package/dist/utils/quote-metadata/types.d.cts

@@ -82,6 +82,27 @@ type QuoteMetadataV1 = {
      */
     priceImpact: Omit<TokenAmountValues, 'amount'>;
 };
+/**
+ * The partial legacy quote metadata
+ *
+ * @deprecated Avoid introducing new usages and use the nested QuoteResponse metadata instead
+ */
 export type QuoteMetadata = DeepPartial<QuoteMetadataV1>;
+export declare const QuoteMetadataMigrationPhase: {
+    /**
+     * Phase 1: omit API V2 currency metadata; serve legacy calcQuoteMetadata
+     * into V2 nested shape
+     */
+    readonly V1Data: "1";
+    /**
+     * Phase 1.5: prefer API V2 metadata (+ fiat from usd); fall back to legacy.
+     */
+    readonly V2WithV1Fallback: "1.5";
+    /**
+     * Phase 2: API V2 metadata only; legacy metadata utils can be removed.
+     */
+    readonly V2Only: "2";
+};
+export type QuoteMetadataMigrationPhase = (typeof QuoteMetadataMigrationPhase)[keyof typeof QuoteMetadataMigrationPhase];
 export {};
 //# sourceMappingURL=types.d.cts.map

package/dist/utils/quote-metadata/types.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.cts","sourceRoot":"","sources":["../../../src/utils/quote-metadata/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,wBAAuB;AAElD;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,eAAe,EAAE,MAAM,CAAC;IACxB;;;;OAIG;IACH,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF;;;;GAIG;AACH,KAAK,eAAe,GAAG;IACrB;;;OAGG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAC5C;;;;;;OAMG;IACH,MAAM,EAAE,MAAM,CAAC,OAAO,EAAE,iBAAiB,CAAC,CAAC;IAC3C,UAAU,CAAC,EAAE,OAAO,CAAC,iBAAiB,CAAC,CAAC;IACxC;;;;;OAKG;IACH,eAAe,EAAE,iBAAiB,CAAC;IACnC;;OAEG;IACH,aAAa,EAAE,iBAAiB,CAAC;IACjC;;OAEG;IACH,gBAAgB,EAAE,iBAAiB,CAAC;IACpC;;;OAGG;IACH,cAAc,EAAE,IAAI,CAAC,iBAAiB,EAAE,QAAQ,CAAC,CAAC;IAClD;;;OAGG;IACH,UAAU,EAAE,iBAAiB,CAAC;IAC9B;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;;OAGG;IACH,IAAI,EAAE,IAAI,CAAC,iBAAiB,EAAE,QAAQ,CAAC,CAAC;IAExC;;OAEG;IACH,WAAW,EAAE,IAAI,CAAC,iBAAiB,EAAE,QAAQ,CAAC,CAAC;CAChD,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG,WAAW,CAAC,eAAe,CAAC,CAAC"}
+{"version":3,"file":"types.d.cts","sourceRoot":"","sources":["../../../src/utils/quote-metadata/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,wBAAuB;AAElD;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,eAAe,EAAE,MAAM,CAAC;IACxB;;;;OAIG;IACH,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF;;;;GAIG;AACH,KAAK,eAAe,GAAG;IACrB;;;OAGG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAC5C;;;;;;OAMG;IACH,MAAM,EAAE,MAAM,CAAC,OAAO,EAAE,iBAAiB,CAAC,CAAC;IAC3C,UAAU,CAAC,EAAE,OAAO,CAAC,iBAAiB,CAAC,CAAC;IACxC;;;;;OAKG;IACH,eAAe,EAAE,iBAAiB,CAAC;IACnC;;OAEG;IACH,aAAa,EAAE,iBAAiB,CAAC;IACjC;;OAEG;IACH,gBAAgB,EAAE,iBAAiB,CAAC;IACpC;;;OAGG;IACH,cAAc,EAAE,IAAI,CAAC,iBAAiB,EAAE,QAAQ,CAAC,CAAC;IAClD;;;OAGG;IACH,UAAU,EAAE,iBAAiB,CAAC;IAC9B;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;;OAGG;IACH,IAAI,EAAE,IAAI,CAAC,iBAAiB,EAAE,QAAQ,CAAC,CAAC;IAExC;;OAEG;IACH,WAAW,EAAE,IAAI,CAAC,iBAAiB,EAAE,QAAQ,CAAC,CAAC;CAChD,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,aAAa,GAAG,WAAW,CAAC,eAAe,CAAC,CAAC;AAEzD,eAAO,MAAM,2BAA2B;IACtC;;;OAGG;;IAEH;;OAEG;;IAEH;;OAEG;;CAEK,CAAC;AAEX,MAAM,MAAM,2BAA2B,GACrC,CAAC,OAAO,2BAA2B,CAAC,CAAC,MAAM,OAAO,2BAA2B,CAAC,CAAC"}

package/dist/utils/quote-metadata/types.d.mts

@@ -82,6 +82,27 @@ type QuoteMetadataV1 = {
      */
     priceImpact: Omit<TokenAmountValues, 'amount'>;
 };
+/**
+ * The partial legacy quote metadata
+ *
+ * @deprecated Avoid introducing new usages and use the nested QuoteResponse metadata instead
+ */
 export type QuoteMetadata = DeepPartial<QuoteMetadataV1>;
+export declare const QuoteMetadataMigrationPhase: {
+    /**
+     * Phase 1: omit API V2 currency metadata; serve legacy calcQuoteMetadata
+     * into V2 nested shape
+     */
+    readonly V1Data: "1";
+    /**
+     * Phase 1.5: prefer API V2 metadata (+ fiat from usd); fall back to legacy.
+     */
+    readonly V2WithV1Fallback: "1.5";
+    /**
+     * Phase 2: API V2 metadata only; legacy metadata utils can be removed.
+     */
+    readonly V2Only: "2";
+};
+export type QuoteMetadataMigrationPhase = (typeof QuoteMetadataMigrationPhase)[keyof typeof QuoteMetadataMigrationPhase];
 export {};
 //# sourceMappingURL=types.d.mts.map

package/dist/utils/quote-metadata/types.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.mts","sourceRoot":"","sources":["../../../src/utils/quote-metadata/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,wBAAuB;AAElD;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,eAAe,EAAE,MAAM,CAAC;IACxB;;;;OAIG;IACH,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF;;;;GAIG;AACH,KAAK,eAAe,GAAG;IACrB;;;OAGG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAC5C;;;;;;OAMG;IACH,MAAM,EAAE,MAAM,CAAC,OAAO,EAAE,iBAAiB,CAAC,CAAC;IAC3C,UAAU,CAAC,EAAE,OAAO,CAAC,iBAAiB,CAAC,CAAC;IACxC;;;;;OAKG;IACH,eAAe,EAAE,iBAAiB,CAAC;IACnC;;OAEG;IACH,aAAa,EAAE,iBAAiB,CAAC;IACjC;;OAEG;IACH,gBAAgB,EAAE,iBAAiB,CAAC;IACpC;;;OAGG;IACH,cAAc,EAAE,IAAI,CAAC,iBAAiB,EAAE,QAAQ,CAAC,CAAC;IAClD;;;OAGG;IACH,UAAU,EAAE,iBAAiB,CAAC;IAC9B;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;;OAGG;IACH,IAAI,EAAE,IAAI,CAAC,iBAAiB,EAAE,QAAQ,CAAC,CAAC;IAExC;;OAEG;IACH,WAAW,EAAE,IAAI,CAAC,iBAAiB,EAAE,QAAQ,CAAC,CAAC;CAChD,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG,WAAW,CAAC,eAAe,CAAC,CAAC"}
+{"version":3,"file":"types.d.mts","sourceRoot":"","sources":["../../../src/utils/quote-metadata/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,wBAAuB;AAElD;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,eAAe,EAAE,MAAM,CAAC;IACxB;;;;OAIG;IACH,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF;;;;GAIG;AACH,KAAK,eAAe,GAAG;IACrB;;;OAGG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAC5C;;;;;;OAMG;IACH,MAAM,EAAE,MAAM,CAAC,OAAO,EAAE,iBAAiB,CAAC,CAAC;IAC3C,UAAU,CAAC,EAAE,OAAO,CAAC,iBAAiB,CAAC,CAAC;IACxC;;;;;OAKG;IACH,eAAe,EAAE,iBAAiB,CAAC;IACnC;;OAEG;IACH,aAAa,EAAE,iBAAiB,CAAC;IACjC;;OAEG;IACH,gBAAgB,EAAE,iBAAiB,CAAC;IACpC;;;OAGG;IACH,cAAc,EAAE,IAAI,CAAC,iBAAiB,EAAE,QAAQ,CAAC,CAAC;IAClD;;;OAGG;IACH,UAAU,EAAE,iBAAiB,CAAC;IAC9B;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;;OAGG;IACH,IAAI,EAAE,IAAI,CAAC,iBAAiB,EAAE,QAAQ,CAAC,CAAC;IAExC;;OAEG;IACH,WAAW,EAAE,IAAI,CAAC,iBAAiB,EAAE,QAAQ,CAAC,CAAC;CAChD,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,aAAa,GAAG,WAAW,CAAC,eAAe,CAAC,CAAC;AAEzD,eAAO,MAAM,2BAA2B;IACtC;;;OAGG;;IAEH;;OAEG;;IAEH;;OAEG;;CAEK,CAAC;AAEX,MAAM,MAAM,2BAA2B,GACrC,CAAC,OAAO,2BAA2B,CAAC,CAAC,MAAM,OAAO,2BAA2B,CAAC,CAAC"}

package/dist/utils/quote-metadata/types.mjs

@@ -1,2 +1,16 @@
-export {};
+export const QuoteMetadataMigrationPhase = {
+    /**
+     * Phase 1: omit API V2 currency metadata; serve legacy calcQuoteMetadata
+     * into V2 nested shape
+     */
+    V1Data: '1',
+    /**
+     * Phase 1.5: prefer API V2 metadata (+ fiat from usd); fall back to legacy.
+     */
+    V2WithV1Fallback: '1.5',
+    /**
+     * Phase 2: API V2 metadata only; legacy metadata utils can be removed.
+     */
+    V2Only: '2',
+};
 //# sourceMappingURL=types.mjs.map

package/dist/utils/quote-metadata/types.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"types.mjs","sourceRoot":"","sources":["../../../src/utils/quote-metadata/types.ts"],"names":[],"mappings":"","sourcesContent":["import type { DeepPartial } from '../../types.js';\n\n/**\n * The types of values for the token amount and its values when converted to the user's selected currency and USD\n */\nexport type TokenAmountValues = {\n  /**\n   * The amount of the token\n   *\n   * @example \"1.005\"\n   */\n  amount: string;\n  /**\n   * The amount of the token in the user's selected currency\n   *\n   * @example \"4.55\"\n   */\n  valueInCurrency: string;\n  /**\n   * The amount of the token in USD\n   *\n   * @example \"1.234\"\n   */\n  usd: string;\n};\n\n/**\n * Values derived from the quote response\n *\n * @deprecated Avoid introducing new usages and use the QuoteResponse V2 type instead\n */\ntype QuoteMetadataV1 = {\n  /**\n   * If gas is included, this is the value of the src or dest token that was used to pay for the gas.\n   * Show this value to indicate transaction fees for gasless quotes.\n   */\n  includedTxFees?: Partial<TokenAmountValues>;\n  /**\n   * The gas fee for the bridge transaction.\n   * effective is the gas fee that is shown to the user. If this value is not\n   * included in the trade, the calculation falls back to the gasLimit (total)\n   * total is the gas fee that is spent by the user, including refunds.\n   * max is the max gas fee that will be used by the transaction.\n   */\n  gasFee: Record<'total', TokenAmountValues>;\n  relayerFee?: Partial<TokenAmountValues>; // relayer/provider fee in native units\n  /**\n   * The total network fee required to submit the trade and any approvals. This includes\n   * the relayer fee or other native fees. Should be used for balance checks and tx submission.\n   * Note: This is only accurate for non-gasless transactions. Use {@link QuoteMetadata.includedTxFees} to\n   * get the total network fee for gasless transactions.\n   */\n  totalNetworkFee: TokenAmountValues; // gasFee.total + relayerFee\n  /**\n   * The amount that the user will receive (destTokenAmount)\n   */\n  toTokenAmount: TokenAmountValues;\n  /**\n   * The minimum amount that the user will receive (minDestTokenAmount)\n   */\n  minToTokenAmount: TokenAmountValues;\n  /**\n   * If gas is included: {@link QuoteMetadata.toTokenAmount} - {@link QuoteMetadata.includedTxFees}.\n   * Otherwise: {@link QuoteMetadata.toTokenAmount} - {@link QuoteMetadata.totalNetworkFee}.\n   */\n  adjustedReturn: Omit<TokenAmountValues, 'amount'>;\n  /**\n   * The amount that the user will send, including fees that are paid in the src token\n   * {@link Quote.srcTokenAmount} + {@link Quote.feeData[FeeType.METABRIDGE].amount} + {@link Quote.feeData[FeeType.TX_FEE].amount}\n   */\n  sentAmount: TokenAmountValues;\n  /**\n   * The swap rate is the amount that the user will receive per amount sent. Accounts for fees paid in the src or dest token.\n   * This is calculated as {@link QuoteMetadata.toTokenAmount} / {@link QuoteMetadata.sentAmount}.\n   */\n  swapRate: string;\n  /**\n   * The cost of the trade, which is the difference between the amount sent and the adjusted return.\n   * This is calculated as {@link QuoteMetadata.sentAmount} - {@link QuoteMetadata.adjustedReturn}.\n   */\n  cost: Omit<TokenAmountValues, 'amount'>; // sentAmount - adjustedReturn\n\n  /**\n   * The price impact for the quote.\n   */\n  priceImpact: Omit<TokenAmountValues, 'amount'>; // abs(sentAmount - toTokenAmount);\n};\n\nexport type QuoteMetadata = DeepPartial<QuoteMetadataV1>;\n"]}
+{"version":3,"file":"types.mjs","sourceRoot":"","sources":["../../../src/utils/quote-metadata/types.ts"],"names":[],"mappings":"AA+FA,MAAM,CAAC,MAAM,2BAA2B,GAAG;IACzC;;;OAGG;IACH,MAAM,EAAE,GAAG;IACX;;OAEG;IACH,gBAAgB,EAAE,KAAK;IACvB;;OAEG;IACH,MAAM,EAAE,GAAG;CACH,CAAC","sourcesContent":["import type { DeepPartial } from '../../types.js';\n\n/**\n * The types of values for the token amount and its values when converted to the user's selected currency and USD\n */\nexport type TokenAmountValues = {\n  /**\n   * The amount of the token\n   *\n   * @example \"1.005\"\n   */\n  amount: string;\n  /**\n   * The amount of the token in the user's selected currency\n   *\n   * @example \"4.55\"\n   */\n  valueInCurrency: string;\n  /**\n   * The amount of the token in USD\n   *\n   * @example \"1.234\"\n   */\n  usd: string;\n};\n\n/**\n * Values derived from the quote response\n *\n * @deprecated Avoid introducing new usages and use the QuoteResponse V2 type instead\n */\ntype QuoteMetadataV1 = {\n  /**\n   * If gas is included, this is the value of the src or dest token that was used to pay for the gas.\n   * Show this value to indicate transaction fees for gasless quotes.\n   */\n  includedTxFees?: Partial<TokenAmountValues>;\n  /**\n   * The gas fee for the bridge transaction.\n   * effective is the gas fee that is shown to the user. If this value is not\n   * included in the trade, the calculation falls back to the gasLimit (total)\n   * total is the gas fee that is spent by the user, including refunds.\n   * max is the max gas fee that will be used by the transaction.\n   */\n  gasFee: Record<'total', TokenAmountValues>;\n  relayerFee?: Partial<TokenAmountValues>; // relayer/provider fee in native units\n  /**\n   * The total network fee required to submit the trade and any approvals. This includes\n   * the relayer fee or other native fees. Should be used for balance checks and tx submission.\n   * Note: This is only accurate for non-gasless transactions. Use {@link QuoteMetadata.includedTxFees} to\n   * get the total network fee for gasless transactions.\n   */\n  totalNetworkFee: TokenAmountValues; // gasFee.total + relayerFee\n  /**\n   * The amount that the user will receive (destTokenAmount)\n   */\n  toTokenAmount: TokenAmountValues;\n  /**\n   * The minimum amount that the user will receive (minDestTokenAmount)\n   */\n  minToTokenAmount: TokenAmountValues;\n  /**\n   * If gas is included: {@link QuoteMetadata.toTokenAmount} - {@link QuoteMetadata.includedTxFees}.\n   * Otherwise: {@link QuoteMetadata.toTokenAmount} - {@link QuoteMetadata.totalNetworkFee}.\n   */\n  adjustedReturn: Omit<TokenAmountValues, 'amount'>;\n  /**\n   * The amount that the user will send, including fees that are paid in the src token\n   * {@link Quote.srcTokenAmount} + {@link Quote.feeData[FeeType.METABRIDGE].amount} + {@link Quote.feeData[FeeType.TX_FEE].amount}\n   */\n  sentAmount: TokenAmountValues;\n  /**\n   * The swap rate is the amount that the user will receive per amount sent. Accounts for fees paid in the src or dest token.\n   * This is calculated as {@link QuoteMetadata.toTokenAmount} / {@link QuoteMetadata.sentAmount}.\n   */\n  swapRate: string;\n  /**\n   * The cost of the trade, which is the difference between the amount sent and the adjusted return.\n   * This is calculated as {@link QuoteMetadata.sentAmount} - {@link QuoteMetadata.adjustedReturn}.\n   */\n  cost: Omit<TokenAmountValues, 'amount'>; // sentAmount - adjustedReturn\n\n  /**\n   * The price impact for the quote.\n   */\n  priceImpact: Omit<TokenAmountValues, 'amount'>; // abs(sentAmount - toTokenAmount);\n};\n\n/**\n * The partial legacy quote metadata\n *\n * @deprecated Avoid introducing new usages and use the nested QuoteResponse metadata instead\n */\nexport type QuoteMetadata = DeepPartial<QuoteMetadataV1>;\n\nexport const QuoteMetadataMigrationPhase = {\n  /**\n   * Phase 1: omit API V2 currency metadata; serve legacy calcQuoteMetadata\n   * into V2 nested shape\n   */\n  V1Data: '1',\n  /**\n   * Phase 1.5: prefer API V2 metadata (+ fiat from usd); fall back to legacy.\n   */\n  V2WithV1Fallback: '1.5',\n  /**\n   * Phase 2: API V2 metadata only; legacy metadata utils can be removed.\n   */\n  V2Only: '2',\n} as const;\n\nexport type QuoteMetadataMigrationPhase =\n  (typeof QuoteMetadataMigrationPhase)[keyof typeof QuoteMetadataMigrationPhase];\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask-previews/bridge-controller",
-  "version": "79.0.1-preview-58a4a8b71",
+  "version": "79.0.1-preview-4c8a5dfcb",
   "description": "Manages bridge-related quote fetching functionality for MetaMask",
   "keywords": [
     "Ethereum",
@@ -61,7 +61,7 @@
     "@ethersproject/providers": "^5.7.0",
     "@metamask/accounts-controller": "^39.0.7",
     "@metamask/assets-controller": "^13.1.1",
-    "@metamask/assets-controllers": "^111.0.0",
+    "@metamask/assets-controllers": "^111.1.0",
     "@metamask/base-controller": "^9.1.0",
     "@metamask/controller-utils": "^12.3.0",
     "@metamask/gas-fee-controller": "^26.3.1",
@@ -74,7 +74,7 @@
     "@metamask/profile-sync-controller": "^29.0.0",
     "@metamask/remote-feature-flag-controller": "^5.0.0",
     "@metamask/snaps-controllers": "^19.0.0",
-    "@metamask/transaction-controller": "^69.5.0",
+    "@metamask/transaction-controller": "^69.5.1",
     "@metamask/utils": "^11.11.0",
     "bignumber.js": "^9.1.2",
     "reselect": "^5.1.1",