@metamask-previews/bridge-controller 80.0.0-preview-3e34650c2 → 80.1.0-preview-4f4c98e

package/dist/validators/quote-response.cjs

@@ -1,129 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isQuoteResponseV2 = exports.validateQuoteResponse = exports.QuoteResponseSchemaV2 = void 0;
-const superstruct_1 = require("@metamask/superstruct");
-const utils_1 = require("@metamask/utils");
-const feature_flags_js_1 = require("./feature-flags.cjs");
-const number_js_1 = require("./number.cjs");
-const quote_js_1 = require("./quote.cjs");
-const trade_js_1 = require("./trade.cjs");
-const CommonQuoteResponseSchema = (0, superstruct_1.type)({
-    quoteId: (0, superstruct_1.optional)((0, superstruct_1.string)()),
-    quote: quote_js_1.QuoteSchemaV2,
-    estimatedProcessingTimeInSeconds: (0, superstruct_1.number)(),
-    /**
-     * Appended to the quote if there are multiple quote requests in a batch. This
-     * indicates which quoteRequest the quote is for
-     */
-    quoteRequestIndex: (0, superstruct_1.optional)((0, superstruct_1.number)()),
-    /**
-     * Appended to the quote response based on the quote requested featureId
-     */
-    featureId: (0, superstruct_1.optional)((0, superstruct_1.enums)(Object.values(feature_flags_js_1.FeatureId))),
-    /**
-     * Appended to the quote response based on the quote request nonEvmFeesInNative flag
-     *
-     * @deprecated Use network feeData
-     */
-    nonEvmFeesInNative: (0, superstruct_1.optional)(number_js_1.FloatStringSchema),
-    /**
-     * Appended to the quote response based on the quote request l1GasFeesInHexWei flag
-     *
-     * @deprecated Use network feeData
-     */
-    l1GasFeesInHexWei: (0, superstruct_1.optional)(utils_1.StrictHexStruct),
-});
-const EvmQuoteResponseSchema = (0, superstruct_1.intersection)([
-    CommonQuoteResponseSchema,
-    (0, superstruct_1.type)({
-        namespace: (0, superstruct_1.literal)(utils_1.KnownCaipNamespace.Eip155),
-        chainId: utils_1.CaipChainIdStruct,
-        trade: trade_js_1.TxDataSchema,
-        approval: (0, superstruct_1.optional)(trade_js_1.TxDataSchema),
-        resetApproval: (0, superstruct_1.optional)(trade_js_1.TxDataSchema),
-    }),
-]);
-const TronQuoteResponseSchema = (0, superstruct_1.intersection)([
-    CommonQuoteResponseSchema,
-    (0, superstruct_1.type)({
-        namespace: (0, superstruct_1.literal)(utils_1.KnownCaipNamespace.Tron),
-        chainId: utils_1.CaipChainIdStruct,
-        trade: trade_js_1.TronTradeDataSchema,
-        approval: (0, superstruct_1.optional)(trade_js_1.TronTradeDataSchema),
-    }),
-]);
-const SolanaQuoteResponseSchema = (0, superstruct_1.intersection)([
-    CommonQuoteResponseSchema,
-    (0, superstruct_1.type)({
-        namespace: (0, superstruct_1.literal)(utils_1.KnownCaipNamespace.Solana),
-        chainId: utils_1.CaipChainIdStruct,
-        trade: (0, superstruct_1.string)(),
-        approval: (0, superstruct_1.optional)(trade_js_1.TxDataSchema),
-    }),
-]);
-const BitcoinQuoteResponseSchema = (0, superstruct_1.intersection)([
-    CommonQuoteResponseSchema,
-    (0, superstruct_1.type)({
-        namespace: (0, superstruct_1.literal)(utils_1.KnownCaipNamespace.Bip122),
-        chainId: utils_1.CaipChainIdStruct,
-        trade: trade_js_1.BitcoinTradeDataSchema,
-        approval: (0, superstruct_1.optional)(trade_js_1.TxDataSchema),
-    }),
-]);
-const StellarQuoteResponseSchema = (0, superstruct_1.intersection)([
-    CommonQuoteResponseSchema,
-    (0, superstruct_1.type)({
-        namespace: (0, superstruct_1.literal)(utils_1.KnownCaipNamespace.Stellar),
-        chainId: utils_1.CaipChainIdStruct,
-        trade: trade_js_1.StellarTradeDataSchema,
-        approval: (0, superstruct_1.optional)(trade_js_1.TxDataSchema),
-    }),
-]);
-exports.QuoteResponseSchemaV2 = (0, superstruct_1.nullable)((0, superstruct_1.union)([
-    EvmQuoteResponseSchema,
-    SolanaQuoteResponseSchema,
-    TronQuoteResponseSchema,
-    BitcoinQuoteResponseSchema,
-    StellarQuoteResponseSchema,
-]));
-// This ensures the QuoteResponse type is in sync with the QuoteResponseSchemaV2
-const QuoteResponse = exports.QuoteResponseSchemaV2;
-const NAMESPACE_TO_TRADE_SCHEMA = {
-    [utils_1.KnownCaipNamespace.Eip155]: EvmQuoteResponseSchema,
-    [utils_1.KnownCaipNamespace.Tron]: TronQuoteResponseSchema,
-    [utils_1.KnownCaipNamespace.Solana]: SolanaQuoteResponseSchema,
-    [utils_1.KnownCaipNamespace.Bip122]: BitcoinQuoteResponseSchema,
-    [utils_1.KnownCaipNamespace.Stellar]: StellarQuoteResponseSchema,
-};
-const validateQuoteResponse = (quoteResponse) => {
-    // Validate common fields first
-    (0, superstruct_1.assert)(quoteResponse, CommonQuoteResponseSchema);
-    // Extract the namespace and chainId from the src asset
-    const { chain: { namespace: namespaceString }, chainId, } = (0, utils_1.parseCaipAssetType)(quoteResponse.quote.src.asset.assetId);
-    const namespace = namespaceString;
-    if (!NAMESPACE_TO_TRADE_SCHEMA[namespace]) {
-        return false;
-    }
-    // Validate the trade and approval fields based on the src chain's namespace
-    (0, superstruct_1.assert)({
-        ...quoteResponse,
-        namespace,
-        chainId,
-    }, NAMESPACE_TO_TRADE_SCHEMA[namespace]);
-    return true;
-};
-exports.validateQuoteResponse = validateQuoteResponse;
-/**
- * Shallow check for the presence of the `src` property
- *
- * @param quote - The quote to check
- * @returns True if the quote is a V2 quote, false otherwise
- */
-const isQuoteResponseV2 = (quote) => {
-    if (!quote?.quote) {
-        return false;
-    }
-    return Object.prototype.hasOwnProperty.call(quote.quote, 'src');
-};
-exports.isQuoteResponseV2 = isQuoteResponseV2;
-//# sourceMappingURL=quote-response.cjs.map

package/dist/validators/quote-response.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"quote-response.cjs","sourceRoot":"","sources":["../../src/validators/quote-response.ts"],"names":[],"mappings":";;;AAAA,uDAc+B;AAC/B,2CAMyB;AAEzB,0DAA+C;AAC/C,4CAAgD;AAChD,0CAA2C;AAC3C,0CASoB;AAEpB,MAAM,yBAAyB,GAAG,IAAA,kBAAI,EAAC;IACrC,OAAO,EAAE,IAAA,sBAAQ,EAAC,IAAA,oBAAM,GAAE,CAAC;IAC3B,KAAK,EAAE,wBAAa;IACpB,gCAAgC,EAAE,IAAA,oBAAM,GAAE;IAC1C;;;OAGG;IACH,iBAAiB,EAAE,IAAA,sBAAQ,EAAC,IAAA,oBAAM,GAAE,CAAC;IACrC;;OAEG;IACH,SAAS,EAAE,IAAA,sBAAQ,EAAC,IAAA,mBAAK,EAAC,MAAM,CAAC,MAAM,CAAC,4BAAS,CAAC,CAAC,CAAC;IACpD;;;;OAIG;IACH,kBAAkB,EAAE,IAAA,sBAAQ,EAAC,6BAAiB,CAAC;IAC/C;;;;OAIG;IACH,iBAAiB,EAAE,IAAA,sBAAQ,EAAC,uBAAe,CAAC;CAC7C,CAAC,CAAC;AAEH,MAAM,sBAAsB,GAAG,IAAA,0BAAY,EAAC;IAC1C,yBAAyB;IACzB,IAAA,kBAAI,EAAC;QACH,SAAS,EAAE,IAAA,qBAAO,EAAC,0BAAkB,CAAC,MAAM,CAAC;QAC7C,OAAO,EAAE,yBAAiB;QAC1B,KAAK,EAAE,uBAAY;QACnB,QAAQ,EAAE,IAAA,sBAAQ,EAAC,uBAAY,CAAC;QAChC,aAAa,EAAE,IAAA,sBAAQ,EAAC,uBAAY,CAAC;KACtC,CAAC;CACH,CAAC,CAAC;AAEH,MAAM,uBAAuB,GAAG,IAAA,0BAAY,EAAC;IAC3C,yBAAyB;IACzB,IAAA,kBAAI,EAAC;QACH,SAAS,EAAE,IAAA,qBAAO,EAAC,0BAAkB,CAAC,IAAI,CAAC;QAC3C,OAAO,EAAE,yBAAiB;QAC1B,KAAK,EAAE,8BAAmB;QAC1B,QAAQ,EAAE,IAAA,sBAAQ,EAAC,8BAAmB,CAAC;KACxC,CAAC;CACH,CAAC,CAAC;AAEH,MAAM,yBAAyB,GAAG,IAAA,0BAAY,EAAC;IAC7C,yBAAyB;IACzB,IAAA,kBAAI,EAAC;QACH,SAAS,EAAE,IAAA,qBAAO,EAAC,0BAAkB,CAAC,MAAM,CAAC;QAC7C,OAAO,EAAE,yBAAiB;QAC1B,KAAK,EAAE,IAAA,oBAAM,GAAE;QACf,QAAQ,EAAE,IAAA,sBAAQ,EAAC,uBAAY,CAAC;KACjC,CAAC;CACH,CAAC,CAAC;AAEH,MAAM,0BAA0B,GAAG,IAAA,0BAAY,EAAC;IAC9C,yBAAyB;IACzB,IAAA,kBAAI,EAAC;QACH,SAAS,EAAE,IAAA,qBAAO,EAAC,0BAAkB,CAAC,MAAM,CAAC;QAC7C,OAAO,EAAE,yBAAiB;QAC1B,KAAK,EAAE,iCAAsB;QAC7B,QAAQ,EAAE,IAAA,sBAAQ,EAAC,uBAAY,CAAC;KACjC,CAAC;CACH,CAAC,CAAC;AAEH,MAAM,0BAA0B,GAAG,IAAA,0BAAY,EAAC;IAC9C,yBAAyB;IACzB,IAAA,kBAAI,EAAC;QACH,SAAS,EAAE,IAAA,qBAAO,EAAC,0BAAkB,CAAC,OAAO,CAAC;QAC9C,OAAO,EAAE,yBAAiB;QAC1B,KAAK,EAAE,iCAAsB;QAC7B,QAAQ,EAAE,IAAA,sBAAQ,EAAC,uBAAY,CAAC;KACjC,CAAC;CACH,CAAC,CAAC;AAEU,QAAA,qBAAqB,GAAG,IAAA,sBAAQ,EAC3C,IAAA,mBAAK,EAAC;IACJ,sBAAsB;IACtB,yBAAyB;IACzB,uBAAuB;IACvB,0BAA0B;IAC1B,0BAA0B;CAC3B,CAAC,CACH,CAAC;AAmDF,gFAAgF;AAChF,MAAM,aAAa,GAAmC,6BAAqB,CAAC;AAE5E,MAAM,yBAAyB,GAC7B;IACE,CAAC,0BAAkB,CAAC,MAAM,CAAC,EAAE,sBAAsB;IACnD,CAAC,0BAAkB,CAAC,IAAI,CAAC,EAAE,uBAAuB;IAClD,CAAC,0BAAkB,CAAC,MAAM,CAAC,EAAE,yBAAyB;IACtD,CAAC,0BAAkB,CAAC,MAAM,CAAC,EAAE,0BAA0B;IACvD,CAAC,0BAAkB,CAAC,OAAO,CAAC,EAAE,0BAA0B;CACzD,CAAC;AAEG,MAAM,qBAAqB,GAAG,CACnC,aAAsB,EACU,EAAE;IAClC,+BAA+B;IAC/B,IAAA,oBAAM,EAAC,aAAa,EAAE,yBAAyB,CAAC,CAAC;IAEjD,uDAAuD;IACvD,MAAM,EACJ,KAAK,EAAE,EAAE,SAAS,EAAE,eAAe,EAAE,EACrC,OAAO,GACR,GAAG,IAAA,0BAAkB,EAAC,aAAa,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC9D,MAAM,SAAS,GAAG,eAA6C,CAAC;IAEhE,IAAI,CAAC,yBAAyB,CAAC,SAAS,CAAC,EAAE,CAAC;QAC1C,OAAO,KAAK,CAAC;IACf,CAAC;IAED,4EAA4E;IAC5E,IAAA,oBAAM,EACJ;QACE,GAAG,aAAa;QAChB,SAAS;QACT,OAAO;KACR,EACD,yBAAyB,CAAC,SAAS,CAAC,CACrC,CAAC;IACF,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AA3BW,QAAA,qBAAqB,yBA2BhC;AAEF;;;;;GAKG;AACI,MAAM,iBAAiB,GAAG,CAC/B,KAA4C,EACpB,EAAE;IAC1B,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,CAAC;QAClB,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;AAClE,CAAC,CAAC;AAPW,QAAA,iBAAiB,qBAO5B","sourcesContent":["import {\n  assert,\n  Infer,\n  number,\n  optional,\n  string,\n  type,\n  union,\n  intersection,\n  Describe,\n  nullable,\n  enums,\n  literal,\n  AnyStruct,\n} from '@metamask/superstruct';\nimport {\n  CaipChainId,\n  CaipChainIdStruct,\n  KnownCaipNamespace,\n  parseCaipAssetType,\n  StrictHexStruct,\n} from '@metamask/utils';\n\nimport { FeatureId } from './feature-flags.js';\nimport { FloatStringSchema } from './number.js';\nimport { QuoteSchemaV2 } from './quote.js';\nimport {\n  BitcoinTradeData,\n  BitcoinTradeDataSchema,\n  StellarTradeData,\n  StellarTradeDataSchema,\n  TronTradeData,\n  TronTradeDataSchema,\n  TxData,\n  TxDataSchema,\n} from './trade.js';\n\nconst CommonQuoteResponseSchema = type({\n  quoteId: optional(string()),\n  quote: QuoteSchemaV2,\n  estimatedProcessingTimeInSeconds: number(),\n  /**\n   * Appended to the quote if there are multiple quote requests in a batch. This\n   * indicates which quoteRequest the quote is for\n   */\n  quoteRequestIndex: optional(number()),\n  /**\n   * Appended to the quote response based on the quote requested featureId\n   */\n  featureId: optional(enums(Object.values(FeatureId))),\n  /**\n   * Appended to the quote response based on the quote request nonEvmFeesInNative flag\n   *\n   * @deprecated Use network feeData\n   */\n  nonEvmFeesInNative: optional(FloatStringSchema),\n  /**\n   * Appended to the quote response based on the quote request l1GasFeesInHexWei flag\n   *\n   * @deprecated Use network feeData\n   */\n  l1GasFeesInHexWei: optional(StrictHexStruct),\n});\n\nconst EvmQuoteResponseSchema = intersection([\n  CommonQuoteResponseSchema,\n  type({\n    namespace: literal(KnownCaipNamespace.Eip155),\n    chainId: CaipChainIdStruct,\n    trade: TxDataSchema,\n    approval: optional(TxDataSchema),\n    resetApproval: optional(TxDataSchema),\n  }),\n]);\n\nconst TronQuoteResponseSchema = intersection([\n  CommonQuoteResponseSchema,\n  type({\n    namespace: literal(KnownCaipNamespace.Tron),\n    chainId: CaipChainIdStruct,\n    trade: TronTradeDataSchema,\n    approval: optional(TronTradeDataSchema),\n  }),\n]);\n\nconst SolanaQuoteResponseSchema = intersection([\n  CommonQuoteResponseSchema,\n  type({\n    namespace: literal(KnownCaipNamespace.Solana),\n    chainId: CaipChainIdStruct,\n    trade: string(),\n    approval: optional(TxDataSchema),\n  }),\n]);\n\nconst BitcoinQuoteResponseSchema = intersection([\n  CommonQuoteResponseSchema,\n  type({\n    namespace: literal(KnownCaipNamespace.Bip122),\n    chainId: CaipChainIdStruct,\n    trade: BitcoinTradeDataSchema,\n    approval: optional(TxDataSchema),\n  }),\n]);\n\nconst StellarQuoteResponseSchema = intersection([\n  CommonQuoteResponseSchema,\n  type({\n    namespace: literal(KnownCaipNamespace.Stellar),\n    chainId: CaipChainIdStruct,\n    trade: StellarTradeDataSchema,\n    approval: optional(TxDataSchema),\n  }),\n]);\n\nexport const QuoteResponseSchemaV2 = nullable(\n  union([\n    EvmQuoteResponseSchema,\n    SolanaQuoteResponseSchema,\n    TronQuoteResponseSchema,\n    BitcoinQuoteResponseSchema,\n    StellarQuoteResponseSchema,\n  ]),\n);\n\n/**\n * This is the V2 QuoteResponse type, including metadata calculated after quote fetch\n */\nexport type QuoteResponse = Omit<\n  NonNullable<Infer<typeof QuoteResponseSchemaV2>>,\n  'trade' | 'approval' | 'resetApproval'\n> &\n  (\n    | {\n        namespace: KnownCaipNamespace.Eip155;\n        chainId: CaipChainId;\n        trade: TxData & {\n          data: string;\n        };\n        approval?: TxData;\n        /**\n         * Appended to the quote response based on the quote request resetApproval flag\n         * If defined, the quote's total network fee will include the reset approval's gas limit.\n         */\n        resetApproval?: TxData;\n      }\n    | {\n        namespace: KnownCaipNamespace.Solana;\n        chainId: CaipChainId;\n        trade: string;\n        approval?: TxData;\n      }\n    | {\n        namespace: KnownCaipNamespace.Tron;\n        chainId: CaipChainId;\n        trade: TronTradeData & {\n          // eslint-disable-next-line @typescript-eslint/naming-convention\n          raw_data_hex: string;\n        };\n        approval?: TronTradeData;\n      }\n    | {\n        namespace: KnownCaipNamespace.Bip122;\n        chainId: CaipChainId;\n        trade: BitcoinTradeData;\n        approval?: TxData;\n      }\n    | {\n        namespace: KnownCaipNamespace.Stellar;\n        chainId: CaipChainId;\n        trade: StellarTradeData;\n        approval?: TxData;\n      }\n  );\n// This ensures the QuoteResponse type is in sync with the QuoteResponseSchemaV2\nconst QuoteResponse: Describe<QuoteResponse | null> = QuoteResponseSchemaV2;\n\nconst NAMESPACE_TO_TRADE_SCHEMA: Record<QuoteResponse['namespace'], AnyStruct> =\n  {\n    [KnownCaipNamespace.Eip155]: EvmQuoteResponseSchema,\n    [KnownCaipNamespace.Tron]: TronQuoteResponseSchema,\n    [KnownCaipNamespace.Solana]: SolanaQuoteResponseSchema,\n    [KnownCaipNamespace.Bip122]: BitcoinQuoteResponseSchema,\n    [KnownCaipNamespace.Stellar]: StellarQuoteResponseSchema,\n  };\n\nexport const validateQuoteResponse = (\n  quoteResponse: unknown,\n): quoteResponse is QuoteResponse => {\n  // Validate common fields first\n  assert(quoteResponse, CommonQuoteResponseSchema);\n\n  // Extract the namespace and chainId from the src asset\n  const {\n    chain: { namespace: namespaceString },\n    chainId,\n  } = parseCaipAssetType(quoteResponse.quote.src.asset.assetId);\n  const namespace = namespaceString as QuoteResponse['namespace'];\n\n  if (!NAMESPACE_TO_TRADE_SCHEMA[namespace]) {\n    return false;\n  }\n\n  // Validate the trade and approval fields based on the src chain's namespace\n  assert(\n    {\n      ...quoteResponse,\n      namespace,\n      chainId,\n    },\n    NAMESPACE_TO_TRADE_SCHEMA[namespace],\n  );\n  return true;\n};\n\n/**\n * Shallow check for the presence of the `src` property\n *\n * @param quote - The quote to check\n * @returns True if the quote is a V2 quote, false otherwise\n */\nexport const isQuoteResponseV2 = (\n  quote: { quote?: object } | null | undefined,\n): quote is QuoteResponse => {\n  if (!quote?.quote) {\n    return false;\n  }\n  return Object.prototype.hasOwnProperty.call(quote.quote, 'src');\n};\n"]}