@metamask-previews/bridge-controller 77.3.2-preview-bbd2df29f → 77.3.2-preview-34f2bcbf7

package/dist/validators/feature-flags.d.mts

@@ -0,0 +1,264 @@
+export declare enum FeatureId {
+    UNKNOWN = "unknown",
+    PERPS = "perps",
+    QUICK_BUY_FOLLOW_TRADING = "quick_buy_follow_trading",
+    QUICK_BUY_TOKEN_DETAILS = "quick_buy_token_details",
+    QUICK_BUY_EXPLORE = "quick_buy_explore",
+    DAPP_SWAP = "dapp_swap",
+    BATCH_SELL = "batch_sell",
+    UNIFIED_SWAP_BRIDGE = "unified_swap_bridge"
+}
+export declare const VersionStringSchema: import("@metamask/superstruct").Struct<string, null>;
+export declare const ChainRankingItemSchema: import("@metamask/superstruct").Struct<{
+    chainId: `${string}:${string}`;
+    name: string;
+}, {
+    /**
+     * The CAIP-2 chain identifier (e.g., "eip155:1" for Ethereum mainnet)
+     */
+    chainId: import("@metamask/superstruct").Struct<`${string}:${string}`, null>;
+    /**
+     * The display name of the chain (e.g., "Ethereum")
+     */
+    name: import("@metamask/superstruct").Struct<string, null>;
+}>;
+export declare const ChainRankingSchema: import("@metamask/superstruct").Struct<{
+    chainId: `${string}:${string}`;
+    name: string;
+}[] | undefined, import("@metamask/superstruct").Struct<{
+    chainId: `${string}:${string}`;
+    name: string;
+}, {
+    /**
+     * The CAIP-2 chain identifier (e.g., "eip155:1" for Ethereum mainnet)
+     */
+    chainId: import("@metamask/superstruct").Struct<`${string}:${string}`, null>;
+    /**
+     * The display name of the chain (e.g., "Ethereum")
+     */
+    name: import("@metamask/superstruct").Struct<string, null>;
+}>>;
+export declare const ChainConfigurationSchema: import("@metamask/superstruct").Struct<{
+    isActiveSrc: boolean;
+    isActiveDest: boolean;
+    refreshRate?: number | undefined;
+    topAssets?: string[] | undefined;
+    stablecoins?: string[] | undefined;
+    batchSellDestStablecoins?: `${string}:${string}/${string}:${string}`[] | undefined;
+    isUnifiedUIEnabled?: boolean | undefined;
+    isSingleSwapBridgeButtonEnabled?: boolean | undefined;
+    isGaslessSwapEnabled?: boolean | undefined;
+    noFeeAssets?: string[] | undefined;
+    defaultPairs?: {
+        standard: Record<string, string>;
+        other: Record<string, string>;
+    } | undefined;
+}, {
+    isActiveSrc: import("@metamask/superstruct").Struct<boolean, null>;
+    isActiveDest: import("@metamask/superstruct").Struct<boolean, null>;
+    refreshRate: import("@metamask/superstruct").Struct<number | undefined, null>;
+    topAssets: import("@metamask/superstruct").Struct<string[] | undefined, import("@metamask/superstruct").Struct<string, null>>;
+    stablecoins: import("@metamask/superstruct").Struct<string[] | undefined, import("@metamask/superstruct").Struct<string, null>>;
+    batchSellDestStablecoins: import("@metamask/superstruct").Struct<`${string}:${string}/${string}:${string}`[] | undefined, import("@metamask/superstruct").Struct<`${string}:${string}/${string}:${string}`, null>>;
+    isUnifiedUIEnabled: import("@metamask/superstruct").Struct<boolean | undefined, null>;
+    isSingleSwapBridgeButtonEnabled: import("@metamask/superstruct").Struct<boolean | undefined, null>;
+    isGaslessSwapEnabled: import("@metamask/superstruct").Struct<boolean | undefined, null>;
+    noFeeAssets: import("@metamask/superstruct").Struct<string[] | undefined, import("@metamask/superstruct").Struct<string, null>>;
+    defaultPairs: import("@metamask/superstruct").Struct<{
+        standard: Record<string, string>;
+        other: Record<string, string>;
+    } | undefined, {
+        /**
+         * The standard default pairs. Use this if the pair is only set once.
+         * The key is the CAIP asset type of the src token and the value is the CAIP asset type of the dest token.
+         */
+        standard: import("@metamask/superstruct").Struct<Record<string, string>, null>;
+        /**
+         * The other default pairs. Use this if the dest token depends on the src token and can be set multiple times.
+         * The key is the CAIP asset type of the src token and the value is the CAIP asset type of the dest token.
+         */
+        other: import("@metamask/superstruct").Struct<Record<string, string>, null>;
+    }>;
+}>;
+export declare const PriceImpactThresholdSchema: import("@metamask/superstruct").Struct<{
+    gasless: number;
+    normal: number;
+    warning?: number | undefined;
+    error?: number | undefined;
+}, {
+    gasless: import("@metamask/superstruct").Struct<number, null>;
+    normal: import("@metamask/superstruct").Struct<number, null>;
+    warning: import("@metamask/superstruct").Struct<number | undefined, null>;
+    error: import("@metamask/superstruct").Struct<number | undefined, null>;
+}>;
+/**
+ * This is the schema for the feature flags response from the RemoteFeatureFlagController
+ */
+export declare const PlatformConfigSchema: import("@metamask/superstruct").Struct<{
+    refreshRate: number;
+    minimumVersion: string;
+    maxRefreshCount: number;
+    support: boolean;
+    chains: Record<string, {
+        isActiveSrc: boolean;
+        isActiveDest: boolean;
+        refreshRate?: number | undefined;
+        topAssets?: string[] | undefined;
+        stablecoins?: string[] | undefined;
+        batchSellDestStablecoins?: `${string}:${string}/${string}:${string}`[] | undefined;
+        isUnifiedUIEnabled?: boolean | undefined;
+        isSingleSwapBridgeButtonEnabled?: boolean | undefined;
+        isGaslessSwapEnabled?: boolean | undefined;
+        noFeeAssets?: string[] | undefined;
+        defaultPairs?: {
+            standard: Record<string, string>;
+            other: Record<string, string>;
+        } | undefined;
+    }>;
+    priceImpactThreshold?: {
+        gasless: number;
+        normal: number;
+        warning?: number | undefined;
+        error?: number | undefined;
+    } | undefined;
+    quoteRequestOverrides?: Record<string, {
+        fee?: number | undefined;
+        aggIds?: string[] | undefined;
+        bridgeIds?: string[] | undefined;
+    } | undefined> | undefined;
+    bip44DefaultPairs?: Record<string, {
+        standard: Record<string, string>;
+        other: Record<string, string>;
+    } | undefined> | undefined;
+    sse?: {
+        minimumVersion: string;
+        enabled: boolean;
+    } | undefined;
+    chainRanking?: {
+        chainId: `${string}:${string}`;
+        name: string;
+    }[] | undefined;
+    maxPendingHistoryItemAgeMs?: number | undefined;
+}, {
+    priceImpactThreshold: import("@metamask/superstruct").Struct<{
+        gasless: number;
+        normal: number;
+        warning?: number | undefined;
+        error?: number | undefined;
+    } | undefined, {
+        gasless: import("@metamask/superstruct").Struct<number, null>;
+        normal: import("@metamask/superstruct").Struct<number, null>;
+        warning: import("@metamask/superstruct").Struct<number | undefined, null>;
+        error: import("@metamask/superstruct").Struct<number | undefined, null>;
+    }>;
+    quoteRequestOverrides: import("@metamask/superstruct").Struct<Record<string, {
+        fee?: number | undefined;
+        aggIds?: string[] | undefined;
+        bridgeIds?: string[] | undefined;
+    } | undefined> | undefined, null>;
+    minimumVersion: import("@metamask/superstruct").Struct<string, null>;
+    refreshRate: import("@metamask/superstruct").Struct<number, null>;
+    maxRefreshCount: import("@metamask/superstruct").Struct<number, null>;
+    support: import("@metamask/superstruct").Struct<boolean, null>;
+    chains: import("@metamask/superstruct").Struct<Record<string, {
+        isActiveSrc: boolean;
+        isActiveDest: boolean;
+        refreshRate?: number | undefined;
+        topAssets?: string[] | undefined;
+        stablecoins?: string[] | undefined;
+        batchSellDestStablecoins?: `${string}:${string}/${string}:${string}`[] | undefined;
+        isUnifiedUIEnabled?: boolean | undefined;
+        isSingleSwapBridgeButtonEnabled?: boolean | undefined;
+        isGaslessSwapEnabled?: boolean | undefined;
+        noFeeAssets?: string[] | undefined;
+        defaultPairs?: {
+            standard: Record<string, string>;
+            other: Record<string, string>;
+        } | undefined;
+    }>, null>;
+    /**
+     * The bip44 default pairs for the chains
+     * Key is the CAIP chainId namespace
+     */
+    bip44DefaultPairs: import("@metamask/superstruct").Struct<Record<string, {
+        standard: Record<string, string>;
+        other: Record<string, string>;
+    } | undefined> | undefined, null>;
+    sse: import("@metamask/superstruct").Struct<{
+        minimumVersion: string;
+        enabled: boolean;
+    } | undefined, {
+        enabled: import("@metamask/superstruct").Struct<boolean, null>;
+        /**
+         * The minimum version of the client required to enable SSE, for example 13.8.0
+         */
+        minimumVersion: import("@metamask/superstruct").Struct<string, null>;
+    }>;
+    /**
+     * Array of chain objects ordered by preference/ranking
+     */
+    chainRanking: import("@metamask/superstruct").Struct<{
+        chainId: `${string}:${string}`;
+        name: string;
+    }[] | undefined, import("@metamask/superstruct").Struct<{
+        chainId: `${string}:${string}`;
+        name: string;
+    }, {
+        /**
+         * The CAIP-2 chain identifier (e.g., "eip155:1" for Ethereum mainnet)
+         */
+        chainId: import("@metamask/superstruct").Struct<`${string}:${string}`, null>;
+        /**
+         * The display name of the chain (e.g., "Ethereum")
+         */
+        name: import("@metamask/superstruct").Struct<string, null>;
+    }>>;
+    maxPendingHistoryItemAgeMs: import("@metamask/superstruct").Struct<number | undefined, null>;
+}>;
+export declare const validateFeatureFlagsResponse: (data: unknown) => data is {
+    refreshRate: number;
+    minimumVersion: string;
+    maxRefreshCount: number;
+    support: boolean;
+    chains: Record<string, {
+        isActiveSrc: boolean;
+        isActiveDest: boolean;
+        refreshRate?: number | undefined;
+        topAssets?: string[] | undefined;
+        stablecoins?: string[] | undefined;
+        batchSellDestStablecoins?: `${string}:${string}/${string}:${string}`[] | undefined;
+        isUnifiedUIEnabled?: boolean | undefined;
+        isSingleSwapBridgeButtonEnabled?: boolean | undefined;
+        isGaslessSwapEnabled?: boolean | undefined;
+        noFeeAssets?: string[] | undefined;
+        defaultPairs?: {
+            standard: Record<string, string>;
+            other: Record<string, string>;
+        } | undefined;
+    }>;
+    priceImpactThreshold?: {
+        gasless: number;
+        normal: number;
+        warning?: number | undefined;
+        error?: number | undefined;
+    } | undefined;
+    quoteRequestOverrides?: Record<string, {
+        fee?: number | undefined;
+        aggIds?: string[] | undefined;
+        bridgeIds?: string[] | undefined;
+    } | undefined> | undefined;
+    bip44DefaultPairs?: Record<string, {
+        standard: Record<string, string>;
+        other: Record<string, string>;
+    } | undefined> | undefined;
+    sse?: {
+        minimumVersion: string;
+        enabled: boolean;
+    } | undefined;
+    chainRanking?: {
+        chainId: `${string}:${string}`;
+        name: string;
+    }[] | undefined;
+    maxPendingHistoryItemAgeMs?: number | undefined;
+};
+//# sourceMappingURL=feature-flags.d.mts.map

package/dist/validators/feature-flags.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"feature-flags.d.mts","sourceRoot":"","sources":["../../src/validators/feature-flags.ts"],"names":[],"mappings":"AAeA,oBAAY,SAAS;IACnB,OAAO,YAAY;IACnB,KAAK,UAAU;IACf,wBAAwB,6BAA6B;IACrD,uBAAuB,4BAA4B;IACnD,iBAAiB,sBAAsB;IACvC,SAAS,cAAc;IACvB,UAAU,eAAe;IACzB,mBAAmB,wBAAwB;CAC5C;AAED,eAAO,MAAM,mBAAmB,sDAM/B,CAAC;AAeF,eAAO,MAAM,sBAAsB;;;;IACjC;;OAEG;;IAEH;;OAEG;;EAEH,CAAC;AAEH,eAAO,MAAM,kBAAkB;;;;;;;IAV7B;;OAEG;;IAEH;;OAEG;;GAIoE,CAAC;AAE1E,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAzBnC;;;WAGG;;QAEH;;;WAGG;;;EA6BH,CAAC;AAEH,eAAO,MAAM,0BAA0B;;;;;;;;;;EAcrC,CAAC;AAQH;;GAEG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAU/B;;;OAGG;;;;;;;;;;QAKC;;WAEG;;;IAIP;;OAEG;;;;;;;;QA7EH;;WAEG;;QAEH;;WAEG;;;;EA0EH,CAAC;AAEH,eAAO,MAAM,4BAA4B,SACjC,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAGd,CAAC"}

package/dist/validators/feature-flags.mjs

@@ -0,0 +1,106 @@
+/* eslint-disable @typescript-eslint/naming-convention */
+import { type, record, string, optional, array, boolean, number, is, define } from "@metamask/superstruct";
+import { CaipChainIdStruct, CaipAssetTypeStruct } from "@metamask/utils";
+export var FeatureId;
+(function (FeatureId) {
+    FeatureId["UNKNOWN"] = "unknown";
+    FeatureId["PERPS"] = "perps";
+    FeatureId["QUICK_BUY_FOLLOW_TRADING"] = "quick_buy_follow_trading";
+    FeatureId["QUICK_BUY_TOKEN_DETAILS"] = "quick_buy_token_details";
+    FeatureId["QUICK_BUY_EXPLORE"] = "quick_buy_explore";
+    FeatureId["DAPP_SWAP"] = "dapp_swap";
+    FeatureId["BATCH_SELL"] = "batch_sell";
+    FeatureId["UNIFIED_SWAP_BRIDGE"] = "unified_swap_bridge";
+})(FeatureId || (FeatureId = {}));
+export const VersionStringSchema = define('VersionString', (value) => typeof value === 'string' &&
+    /^(\d+\.*){2}\d+$/u.test(value) &&
+    value.split('.').length === 3);
+const DefaultPairSchema = type({
+    /**
+     * The standard default pairs. Use this if the pair is only set once.
+     * The key is the CAIP asset type of the src token and the value is the CAIP asset type of the dest token.
+     */
+    standard: record(string(), string()),
+    /**
+     * The other default pairs. Use this if the dest token depends on the src token and can be set multiple times.
+     * The key is the CAIP asset type of the src token and the value is the CAIP asset type of the dest token.
+     */
+    other: record(string(), string()),
+});
+export const ChainRankingItemSchema = type({
+    /**
+     * The CAIP-2 chain identifier (e.g., "eip155:1" for Ethereum mainnet)
+     */
+    chainId: CaipChainIdStruct,
+    /**
+     * The display name of the chain (e.g., "Ethereum")
+     */
+    name: string(),
+});
+export const ChainRankingSchema = optional(array(ChainRankingItemSchema));
+export const ChainConfigurationSchema = type({
+    isActiveSrc: boolean(),
+    isActiveDest: boolean(),
+    refreshRate: optional(number()),
+    topAssets: optional(array(string())),
+    stablecoins: optional(array(string())),
+    batchSellDestStablecoins: optional(array(CaipAssetTypeStruct)),
+    isUnifiedUIEnabled: optional(boolean()),
+    isSingleSwapBridgeButtonEnabled: optional(boolean()),
+    isGaslessSwapEnabled: optional(boolean()),
+    noFeeAssets: optional(array(string())),
+    defaultPairs: optional(DefaultPairSchema),
+});
+export const PriceImpactThresholdSchema = type({
+    // We are moving into a unified approach where
+    // price impact thresholds will be segmented by
+    // importance rather than transaction type.
+    // The introduction of warning/danger will first be handled
+    // by mobile, followed by extension and then removal of gasless/normal
+    // from LD configs.
+    // To make the migration easier, we define all fields as optional for now.
+    // After the migration takes place, gasless/normal will be removed
+    // and warning/danger will be set as required fields.
+    gasless: number(), // Percentage value in decimal format (eg 0.02 is 2%)
+    normal: number(), // Percentage value in decimal format
+    warning: optional(number()), // Percentage value in decimal format
+    error: optional(number()), // Percentage value in decimal format
+});
+const GenericQuoteRequestSchema = type({
+    aggIds: optional(array(string())),
+    bridgeIds: optional(array(string())),
+    fee: optional(number()),
+});
+/**
+ * This is the schema for the feature flags response from the RemoteFeatureFlagController
+ */
+export const PlatformConfigSchema = type({
+    priceImpactThreshold: optional(PriceImpactThresholdSchema),
+    quoteRequestOverrides: optional(record(string(), optional(GenericQuoteRequestSchema))),
+    minimumVersion: string(),
+    refreshRate: number(),
+    maxRefreshCount: number(),
+    support: boolean(),
+    chains: record(string(), ChainConfigurationSchema),
+    /**
+     * The bip44 default pairs for the chains
+     * Key is the CAIP chainId namespace
+     */
+    bip44DefaultPairs: optional(record(string(), optional(DefaultPairSchema))),
+    sse: optional(type({
+        enabled: boolean(),
+        /**
+         * The minimum version of the client required to enable SSE, for example 13.8.0
+         */
+        minimumVersion: VersionStringSchema,
+    })),
+    /**
+     * Array of chain objects ordered by preference/ranking
+     */
+    chainRanking: ChainRankingSchema,
+    maxPendingHistoryItemAgeMs: optional(number()),
+});
+export const validateFeatureFlagsResponse = (data) => {
+    return is(data, PlatformConfigSchema);
+};
+//# sourceMappingURL=feature-flags.mjs.map

package/dist/validators/feature-flags.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"feature-flags.mjs","sourceRoot":"","sources":["../../src/validators/feature-flags.ts"],"names":[],"mappings":"AAAA,yDAAyD;AACzD,OAAO,EACL,IAAI,EACJ,MAAM,EACN,MAAM,EACN,QAAQ,EACR,KAAK,EACL,OAAO,EACP,MAAM,EACN,EAAE,EACF,MAAM,EACP,8BAA8B;AAE/B,OAAO,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,wBAAwB;AAEzE,MAAM,CAAN,IAAY,SASX;AATD,WAAY,SAAS;IACnB,gCAAmB,CAAA;IACnB,4BAAe,CAAA;IACf,kEAAqD,CAAA;IACrD,gEAAmD,CAAA;IACnD,oDAAuC,CAAA;IACvC,oCAAuB,CAAA;IACvB,sCAAyB,CAAA;IACzB,wDAA2C,CAAA;AAC7C,CAAC,EATW,SAAS,KAAT,SAAS,QASpB;AAED,MAAM,CAAC,MAAM,mBAAmB,GAAG,MAAM,CACvC,eAAe,EACf,CAAC,KAAc,EAAE,EAAE,CACjB,OAAO,KAAK,KAAK,QAAQ;IACzB,mBAAmB,CAAC,IAAI,CAAC,KAAK,CAAC;IAC/B,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,KAAK,CAAC,CAChC,CAAC;AAEF,MAAM,iBAAiB,GAAG,IAAI,CAAC;IAC7B;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,CAAC;IACpC;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,CAAC;CAClC,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,sBAAsB,GAAG,IAAI,CAAC;IACzC;;OAEG;IACH,OAAO,EAAE,iBAAiB;IAC1B;;OAEG;IACH,IAAI,EAAE,MAAM,EAAE;CACf,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,kBAAkB,GAAG,QAAQ,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAC,CAAC;AAE1E,MAAM,CAAC,MAAM,wBAAwB,GAAG,IAAI,CAAC;IAC3C,WAAW,EAAE,OAAO,EAAE;IACtB,YAAY,EAAE,OAAO,EAAE;IACvB,WAAW,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC;IAC/B,SAAS,EAAE,QAAQ,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC;IACpC,WAAW,EAAE,QAAQ,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC;IACtC,wBAAwB,EAAE,QAAQ,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC;IAC9D,kBAAkB,EAAE,QAAQ,CAAC,OAAO,EAAE,CAAC;IACvC,+BAA+B,EAAE,QAAQ,CAAC,OAAO,EAAE,CAAC;IACpD,oBAAoB,EAAE,QAAQ,CAAC,OAAO,EAAE,CAAC;IACzC,WAAW,EAAE,QAAQ,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC;IACtC,YAAY,EAAE,QAAQ,CAAC,iBAAiB,CAAC;CAC1C,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,0BAA0B,GAAG,IAAI,CAAC;IAC7C,8CAA8C;IAC9C,+CAA+C;IAC/C,2CAA2C;IAC3C,2DAA2D;IAC3D,sEAAsE;IACtE,mBAAmB;IACnB,0EAA0E;IAC1E,kEAAkE;IAClE,qDAAqD;IACrD,OAAO,EAAE,MAAM,EAAE,EAAE,qDAAqD;IACxE,MAAM,EAAE,MAAM,EAAE,EAAE,qCAAqC;IACvD,OAAO,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC,EAAE,qCAAqC;IAClE,KAAK,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC,EAAE,qCAAqC;CACjE,CAAC,CAAC;AAEH,MAAM,yBAAyB,GAAG,IAAI,CAAC;IACrC,MAAM,EAAE,QAAQ,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC;IACjC,SAAS,EAAE,QAAQ,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC;IACpC,GAAG,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC;CACxB,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,IAAI,CAAC;IACvC,oBAAoB,EAAE,QAAQ,CAAC,0BAA0B,CAAC;IAC1D,qBAAqB,EAAE,QAAQ,CAC7B,MAAM,CAAC,MAAM,EAAE,EAAE,QAAQ,CAAC,yBAAyB,CAAC,CAAC,CACtD;IACD,cAAc,EAAE,MAAM,EAAE;IACxB,WAAW,EAAE,MAAM,EAAE;IACrB,eAAe,EAAE,MAAM,EAAE;IACzB,OAAO,EAAE,OAAO,EAAE;IAClB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,EAAE,wBAAwB,CAAC;IAClD;;;OAGG;IACH,iBAAiB,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,QAAQ,CAAC,iBAAiB,CAAC,CAAC,CAAC;IAC1E,GAAG,EAAE,QAAQ,CACX,IAAI,CAAC;QACH,OAAO,EAAE,OAAO,EAAE;QAClB;;WAEG;QACH,cAAc,EAAE,mBAAmB;KACpC,CAAC,CACH;IACD;;OAEG;IACH,YAAY,EAAE,kBAAkB;IAChC,0BAA0B,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC;CAC/C,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAC1C,IAAa,EAC+B,EAAE;IAC9C,OAAO,EAAE,CAAC,IAAI,EAAE,oBAAoB,CAAC,CAAC;AACxC,CAAC,CAAC","sourcesContent":["/* eslint-disable @typescript-eslint/naming-convention */\nimport {\n  type,\n  record,\n  string,\n  optional,\n  array,\n  boolean,\n  number,\n  is,\n  define,\n} from '@metamask/superstruct';\nimport type { Infer } from '@metamask/superstruct';\nimport { CaipChainIdStruct, CaipAssetTypeStruct } from '@metamask/utils';\n\nexport enum FeatureId {\n  UNKNOWN = 'unknown',\n  PERPS = 'perps',\n  QUICK_BUY_FOLLOW_TRADING = 'quick_buy_follow_trading',\n  QUICK_BUY_TOKEN_DETAILS = 'quick_buy_token_details',\n  QUICK_BUY_EXPLORE = 'quick_buy_explore',\n  DAPP_SWAP = 'dapp_swap',\n  BATCH_SELL = 'batch_sell',\n  UNIFIED_SWAP_BRIDGE = 'unified_swap_bridge',\n}\n\nexport const VersionStringSchema = define<string>(\n  'VersionString',\n  (value: unknown) =>\n    typeof value === 'string' &&\n    /^(\\d+\\.*){2}\\d+$/u.test(value) &&\n    value.split('.').length === 3,\n);\n\nconst DefaultPairSchema = type({\n  /**\n   * The standard default pairs. Use this if the pair is only set once.\n   * The key is the CAIP asset type of the src token and the value is the CAIP asset type of the dest token.\n   */\n  standard: record(string(), string()),\n  /**\n   * The other default pairs. Use this if the dest token depends on the src token and can be set multiple times.\n   * The key is the CAIP asset type of the src token and the value is the CAIP asset type of the dest token.\n   */\n  other: record(string(), string()),\n});\n\nexport const ChainRankingItemSchema = type({\n  /**\n   * The CAIP-2 chain identifier (e.g., \"eip155:1\" for Ethereum mainnet)\n   */\n  chainId: CaipChainIdStruct,\n  /**\n   * The display name of the chain (e.g., \"Ethereum\")\n   */\n  name: string(),\n});\n\nexport const ChainRankingSchema = optional(array(ChainRankingItemSchema));\n\nexport const ChainConfigurationSchema = type({\n  isActiveSrc: boolean(),\n  isActiveDest: boolean(),\n  refreshRate: optional(number()),\n  topAssets: optional(array(string())),\n  stablecoins: optional(array(string())),\n  batchSellDestStablecoins: optional(array(CaipAssetTypeStruct)),\n  isUnifiedUIEnabled: optional(boolean()),\n  isSingleSwapBridgeButtonEnabled: optional(boolean()),\n  isGaslessSwapEnabled: optional(boolean()),\n  noFeeAssets: optional(array(string())),\n  defaultPairs: optional(DefaultPairSchema),\n});\n\nexport const PriceImpactThresholdSchema = type({\n  // We are moving into a unified approach where\n  // price impact thresholds will be segmented by\n  // importance rather than transaction type.\n  // The introduction of warning/danger will first be handled\n  // by mobile, followed by extension and then removal of gasless/normal\n  // from LD configs.\n  // To make the migration easier, we define all fields as optional for now.\n  // After the migration takes place, gasless/normal will be removed\n  // and warning/danger will be set as required fields.\n  gasless: number(), // Percentage value in decimal format (eg 0.02 is 2%)\n  normal: number(), // Percentage value in decimal format\n  warning: optional(number()), // Percentage value in decimal format\n  error: optional(number()), // Percentage value in decimal format\n});\n\nconst GenericQuoteRequestSchema = type({\n  aggIds: optional(array(string())),\n  bridgeIds: optional(array(string())),\n  fee: optional(number()),\n});\n\n/**\n * This is the schema for the feature flags response from the RemoteFeatureFlagController\n */\nexport const PlatformConfigSchema = type({\n  priceImpactThreshold: optional(PriceImpactThresholdSchema),\n  quoteRequestOverrides: optional(\n    record(string(), optional(GenericQuoteRequestSchema)),\n  ),\n  minimumVersion: string(),\n  refreshRate: number(),\n  maxRefreshCount: number(),\n  support: boolean(),\n  chains: record(string(), ChainConfigurationSchema),\n  /**\n   * The bip44 default pairs for the chains\n   * Key is the CAIP chainId namespace\n   */\n  bip44DefaultPairs: optional(record(string(), optional(DefaultPairSchema))),\n  sse: optional(\n    type({\n      enabled: boolean(),\n      /**\n       * The minimum version of the client required to enable SSE, for example 13.8.0\n       */\n      minimumVersion: VersionStringSchema,\n    }),\n  ),\n  /**\n   * Array of chain objects ordered by preference/ranking\n   */\n  chainRanking: ChainRankingSchema,\n  maxPendingHistoryItemAgeMs: optional(number()),\n});\n\nexport const validateFeatureFlagsResponse = (\n  data: unknown,\n): data is Infer<typeof PlatformConfigSchema> => {\n  return is(data, PlatformConfigSchema);\n};\n"]}

package/dist/validators/intent.cjs

@@ -0,0 +1,122 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IntentSchema = exports.IntentOrderSchema = void 0;
+const superstruct_1 = require("@metamask/superstruct");
+const number_1 = require("./number.cjs");
+const trade_1 = require("./trade.cjs");
+// Allow digit strings for amounts/validTo for flexibility across providers
+const DigitStringOrNumberSchema = (0, superstruct_1.union)([number_1.TruthyDigitStringSchema, (0, superstruct_1.number)()]);
+/**
+ * Identifier of the intent protocol used for order creation and submission.
+ *
+ * Examples:
+ * - CoW Swap
+ * - Other EIP-712–based intent protocols
+ */
+const IntentProtocolSchema = (0, superstruct_1.string)();
+/**
+ * Schema for an intent-based order used for EIP-712 signing and submission.
+ *
+ * This represents the minimal subset of fields required by intent-based
+ * protocols (e.g. CoW Swap) to build, sign, and submit an order.
+ */
+exports.IntentOrderSchema = (0, superstruct_1.type)({
+    /**
+     * Address of the token being sold.
+     */
+    sellToken: trade_1.HexString,
+    /**
+     * Address of the token being bought.
+     */
+    buyToken: trade_1.HexString,
+    /**
+     * Optional receiver of the bought tokens.
+     * If omitted, defaults to the signer / order owner.
+     */
+    receiver: (0, superstruct_1.optional)(trade_1.HexString),
+    /**
+     * Order expiration time.
+     *
+     * Can be provided as a UNIX timestamp in seconds, either as a number
+     * or as a digit string, depending on provider requirements.
+     */
+    validTo: DigitStringOrNumberSchema,
+    /**
+     * Arbitrary application-specific data attached to the order.
+     */
+    appData: (0, superstruct_1.string)(),
+    /**
+     * Hash of the `appData` field, used for EIP-712 signing.
+     */
+    appDataHash: trade_1.HexString,
+    /**
+     * Fee amount paid for order execution, expressed as a digit string.
+     */
+    feeAmount: number_1.TruthyDigitStringSchema,
+    /**
+     * Order kind.
+     *
+     * - `sell`: exact sell amount, variable buy amount
+     * - `buy`: exact buy amount, variable sell amount
+     */
+    kind: (0, superstruct_1.enums)(['sell', 'buy']),
+    /**
+     * Whether the order can be partially filled.
+     */
+    partiallyFillable: (0, superstruct_1.boolean)(),
+    /**
+     * Exact amount of the sell token.
+     *
+     * Required for `sell` orders.
+     */
+    sellAmount: (0, superstruct_1.optional)(number_1.TruthyDigitStringSchema),
+    /**
+     * Exact amount of the buy token.
+     *
+     * Required for `buy` orders.
+     */
+    buyAmount: (0, superstruct_1.optional)(number_1.TruthyDigitStringSchema),
+    /**
+     * Optional order owner / sender address.
+     *
+     * Provided for convenience when building the EIP-712 domain and message.
+     */
+    from: (0, superstruct_1.optional)(trade_1.HexString),
+});
+/**
+ * Schema representing an intent submission payload.
+ *
+ * Wraps the intent order along with protocol and optional routing metadata
+ * required by the backend or relayer infrastructure.
+ */
+exports.IntentSchema = (0, superstruct_1.type)({
+    /**
+     * Identifier of the intent protocol used to interpret the order.
+     */
+    protocol: IntentProtocolSchema,
+    /**
+     * The intent order to be signed and submitted.
+     */
+    order: exports.IntentOrderSchema,
+    /**
+     * Optional settlement contract address used for execution.
+     */
+    settlementContract: (0, superstruct_1.optional)(trade_1.HexString),
+    /**
+     * Optional EIP-712 typed data payload for signing.
+     * Must be JSON-serializable and include required EIP-712 fields.
+     */
+    typedData: (0, superstruct_1.type)({
+        // Keep values as `any()` here. Using `unknown()` in this record causes
+        // TS2321/TS2589 (excessive type instantiation depth) in bridge state
+        // inference during build.
+        types: (0, superstruct_1.record)((0, superstruct_1.string)(), (0, superstruct_1.array)((0, superstruct_1.type)({
+            name: (0, superstruct_1.string)(),
+            type: (0, superstruct_1.string)(),
+        }))),
+        primaryType: (0, superstruct_1.string)(),
+        domain: (0, superstruct_1.record)((0, superstruct_1.string)(), (0, superstruct_1.any)()),
+        message: (0, superstruct_1.record)((0, superstruct_1.string)(), (0, superstruct_1.any)()),
+    }),
+});
+//# sourceMappingURL=intent.cjs.map

package/dist/validators/intent.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"intent.cjs","sourceRoot":"","sources":["../../src/validators/intent.ts"],"names":[],"mappings":";;;AAAA,uDAW+B;AAE/B,yCAAmD;AACnD,uCAAoC;AAEpC,2EAA2E;AAC3E,MAAM,yBAAyB,GAAG,IAAA,mBAAK,EAAC,CAAC,gCAAuB,EAAE,IAAA,oBAAM,GAAE,CAAC,CAAC,CAAC;AAC7E;;;;;;GAMG;AACH,MAAM,oBAAoB,GAAG,IAAA,oBAAM,GAAE,CAAC;AACtC;;;;;GAKG;AAEU,QAAA,iBAAiB,GAAG,IAAA,kBAAI,EAAC;IACpC;;OAEG;IACH,SAAS,EAAE,iBAAS;IAEpB;;OAEG;IACH,QAAQ,EAAE,iBAAS;IAEnB;;;OAGG;IACH,QAAQ,EAAE,IAAA,sBAAQ,EAAC,iBAAS,CAAC;IAE7B;;;;;OAKG;IACH,OAAO,EAAE,yBAAyB;IAElC;;OAEG;IACH,OAAO,EAAE,IAAA,oBAAM,GAAE;IAEjB;;OAEG;IACH,WAAW,EAAE,iBAAS;IAEtB;;OAEG;IACH,SAAS,EAAE,gCAAuB;IAElC;;;;;OAKG;IACH,IAAI,EAAE,IAAA,mBAAK,EAAC,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IAE5B;;OAEG;IACH,iBAAiB,EAAE,IAAA,qBAAO,GAAE;IAE5B;;;;OAIG;IACH,UAAU,EAAE,IAAA,sBAAQ,EAAC,gCAAuB,CAAC;IAE7C;;;;OAIG;IACH,SAAS,EAAE,IAAA,sBAAQ,EAAC,gCAAuB,CAAC;IAE5C;;;;OAIG;IACH,IAAI,EAAE,IAAA,sBAAQ,EAAC,iBAAS,CAAC;CAC1B,CAAC,CAAC;AACH;;;;;GAKG;AAEU,QAAA,YAAY,GAAG,IAAA,kBAAI,EAAC;IAC/B;;OAEG;IACH,QAAQ,EAAE,oBAAoB;IAE9B;;OAEG;IACH,KAAK,EAAE,yBAAiB;IAExB;;OAEG;IACH,kBAAkB,EAAE,IAAA,sBAAQ,EAAC,iBAAS,CAAC;IAEvC;;;OAGG;IACH,SAAS,EAAE,IAAA,kBAAI,EAAC;QACd,uEAAuE;QACvE,qEAAqE;QACrE,0BAA0B;QAC1B,KAAK,EAAE,IAAA,oBAAM,EACX,IAAA,oBAAM,GAAE,EACR,IAAA,mBAAK,EACH,IAAA,kBAAI,EAAC;YACH,IAAI,EAAE,IAAA,oBAAM,GAAE;YACd,IAAI,EAAE,IAAA,oBAAM,GAAE;SACf,CAAC,CACH,CACF;QACD,WAAW,EAAE,IAAA,oBAAM,GAAE;QACrB,MAAM,EAAE,IAAA,oBAAM,EAAC,IAAA,oBAAM,GAAE,EAAE,IAAA,iBAAG,GAAE,CAAC;QAC/B,OAAO,EAAE,IAAA,oBAAM,EAAC,IAAA,oBAAM,GAAE,EAAE,IAAA,iBAAG,GAAE,CAAC;KACjC,CAAC;CACH,CAAC,CAAC","sourcesContent":["import {\n  union,\n  number,\n  string,\n  type,\n  optional,\n  enums,\n  boolean,\n  record,\n  array,\n  any,\n} from '@metamask/superstruct';\n\nimport { TruthyDigitStringSchema } from './number';\nimport { HexString } from './trade';\n\n// Allow digit strings for amounts/validTo for flexibility across providers\nconst DigitStringOrNumberSchema = union([TruthyDigitStringSchema, number()]);\n/**\n * Identifier of the intent protocol used for order creation and submission.\n *\n * Examples:\n * - CoW Swap\n * - Other EIP-712–based intent protocols\n */\nconst IntentProtocolSchema = string();\n/**\n * Schema for an intent-based order used for EIP-712 signing and submission.\n *\n * This represents the minimal subset of fields required by intent-based\n * protocols (e.g. CoW Swap) to build, sign, and submit an order.\n */\n\nexport const IntentOrderSchema = type({\n  /**\n   * Address of the token being sold.\n   */\n  sellToken: HexString,\n\n  /**\n   * Address of the token being bought.\n   */\n  buyToken: HexString,\n\n  /**\n   * Optional receiver of the bought tokens.\n   * If omitted, defaults to the signer / order owner.\n   */\n  receiver: optional(HexString),\n\n  /**\n   * Order expiration time.\n   *\n   * Can be provided as a UNIX timestamp in seconds, either as a number\n   * or as a digit string, depending on provider requirements.\n   */\n  validTo: DigitStringOrNumberSchema,\n\n  /**\n   * Arbitrary application-specific data attached to the order.\n   */\n  appData: string(),\n\n  /**\n   * Hash of the `appData` field, used for EIP-712 signing.\n   */\n  appDataHash: HexString,\n\n  /**\n   * Fee amount paid for order execution, expressed as a digit string.\n   */\n  feeAmount: TruthyDigitStringSchema,\n\n  /**\n   * Order kind.\n   *\n   * - `sell`: exact sell amount, variable buy amount\n   * - `buy`: exact buy amount, variable sell amount\n   */\n  kind: enums(['sell', 'buy']),\n\n  /**\n   * Whether the order can be partially filled.\n   */\n  partiallyFillable: boolean(),\n\n  /**\n   * Exact amount of the sell token.\n   *\n   * Required for `sell` orders.\n   */\n  sellAmount: optional(TruthyDigitStringSchema),\n\n  /**\n   * Exact amount of the buy token.\n   *\n   * Required for `buy` orders.\n   */\n  buyAmount: optional(TruthyDigitStringSchema),\n\n  /**\n   * Optional order owner / sender address.\n   *\n   * Provided for convenience when building the EIP-712 domain and message.\n   */\n  from: optional(HexString),\n});\n/**\n * Schema representing an intent submission payload.\n *\n * Wraps the intent order along with protocol and optional routing metadata\n * required by the backend or relayer infrastructure.\n */\n\nexport const IntentSchema = type({\n  /**\n   * Identifier of the intent protocol used to interpret the order.\n   */\n  protocol: IntentProtocolSchema,\n\n  /**\n   * The intent order to be signed and submitted.\n   */\n  order: IntentOrderSchema,\n\n  /**\n   * Optional settlement contract address used for execution.\n   */\n  settlementContract: optional(HexString),\n\n  /**\n   * Optional EIP-712 typed data payload for signing.\n   * Must be JSON-serializable and include required EIP-712 fields.\n   */\n  typedData: type({\n    // Keep values as `any()` here. Using `unknown()` in this record causes\n    // TS2321/TS2589 (excessive type instantiation depth) in bridge state\n    // inference during build.\n    types: record(\n      string(),\n      array(\n        type({\n          name: string(),\n          type: string(),\n        }),\n      ),\n    ),\n    primaryType: string(),\n    domain: record(string(), any()),\n    message: record(string(), any()),\n  }),\n});\n"]}