@metamask/bridge-status-controller 1.0.0 → 3.0.0

package/dist/utils/validators.cjs

@@ -1,161 +1,42 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validators = exports.validateResponse = exports.validateData = exports.validHex = void 0;
-const controller_utils_1 = require("@metamask/controller-utils");
-const bridge_status_1 = require("./bridge-status.cjs");
+exports.validateBridgeStatusResponse = void 0;
+const superstruct_1 = require("@metamask/superstruct");
 const types_1 = require("../types.cjs");
-const validHex = (value) => typeof value === 'string' && Boolean(value.match(/^0x[a-f0-9]+$/u));
-exports.validHex = validHex;
-const isValidObject = (v) => typeof v === 'object' && v !== null;
-const validateData = (validators, object, urlUsed, logError = true) => {
-    return validators.every(({ property, type, validator }) => {
-        const types = type.split('|');
-        const propertyString = String(property);
-        const valid = isValidObject(object) &&
-            types.some((_type) => typeof object[propertyString] === _type) &&
-            (!validator || validator(object[propertyString]));
-        if (!valid && logError) {
-            const value = isValidObject(object)
-                ? object[propertyString]
-                : undefined;
-            const typeString = isValidObject(object)
-                ? typeof object[propertyString]
-                : 'undefined';
-            console.error(`response to GET ${urlUsed} invalid for property ${String(property)}; value was:`, value, '| type was: ', typeString);
-        }
-        return valid;
+const validateBridgeStatusResponse = (data) => {
+    const ChainIdSchema = (0, superstruct_1.union)([(0, superstruct_1.number)(), (0, superstruct_1.string)()]);
+    const AssetSchema = (0, superstruct_1.type)({
+        chainId: ChainIdSchema,
+        address: (0, superstruct_1.string)(),
+        symbol: (0, superstruct_1.string)(),
+        name: (0, superstruct_1.string)(),
+        decimals: (0, superstruct_1.number)(),
+        icon: (0, superstruct_1.optional)((0, superstruct_1.nullable)((0, superstruct_1.string)())),
     });
+    const EmptyObjectSchema = (0, superstruct_1.object)({});
+    const SrcChainStatusSchema = (0, superstruct_1.type)({
+        chainId: ChainIdSchema,
+        txHash: (0, superstruct_1.optional)((0, superstruct_1.string)()),
+        amount: (0, superstruct_1.optional)((0, superstruct_1.string)()),
+        token: (0, superstruct_1.optional)((0, superstruct_1.union)([EmptyObjectSchema, AssetSchema])),
+    });
+    const DestChainStatusSchema = (0, superstruct_1.type)({
+        chainId: ChainIdSchema,
+        txHash: (0, superstruct_1.optional)((0, superstruct_1.string)()),
+        amount: (0, superstruct_1.optional)((0, superstruct_1.string)()),
+        token: (0, superstruct_1.optional)((0, superstruct_1.union)([EmptyObjectSchema, AssetSchema])),
+    });
+    const RefuelStatusResponseSchema = (0, superstruct_1.object)();
+    const StatusResponseSchema = (0, superstruct_1.type)({
+        status: (0, superstruct_1.enums)(Object.values(types_1.StatusTypes)),
+        srcChain: SrcChainStatusSchema,
+        destChain: (0, superstruct_1.optional)(DestChainStatusSchema),
+        bridge: (0, superstruct_1.optional)((0, superstruct_1.enums)(Object.values(types_1.BridgeId))),
+        isExpectedToken: (0, superstruct_1.optional)((0, superstruct_1.boolean)()),
+        isUnrecognizedRouterAddress: (0, superstruct_1.optional)((0, superstruct_1.boolean)()),
+        refuel: (0, superstruct_1.optional)(RefuelStatusResponseSchema),
+    });
+    (0, superstruct_1.assert)(data, StatusResponseSchema);
 };
-exports.validateData = validateData;
-const validateResponse = (validators, data, urlUsed) => {
-    if (data === null || data === undefined) {
-        return false;
-    }
-    return (0, exports.validateData)(validators, data, urlUsed);
-};
-exports.validateResponse = validateResponse;
-const assetValidators = [
-    {
-        property: 'chainId',
-        type: 'number',
-        validator: (v) => typeof v === 'number',
-    },
-    {
-        property: 'address',
-        type: 'string',
-        validator: (v) => (0, controller_utils_1.isValidHexAddress)(v),
-    },
-    {
-        property: 'symbol',
-        type: 'string',
-        validator: (v) => typeof v === 'string',
-    },
-    {
-        property: 'name',
-        type: 'string',
-        validator: (v) => typeof v === 'string',
-    },
-    {
-        property: 'decimals',
-        type: 'number',
-        validator: (v) => typeof v === 'number',
-    },
-    {
-        property: 'icon',
-        // typeof null === 'object'
-        type: 'string|undefined|object',
-        validator: (v) => v === undefined || v === null || typeof v === 'string',
-    },
-];
-const assetValidator = (v) => (0, exports.validateResponse)(assetValidators, v, bridge_status_1.BRIDGE_STATUS_BASE_URL);
-const srcChainStatusValidators = [
-    {
-        property: 'chainId',
-        // For some reason, API returns destChain.chainId as a string, it's a number everywhere else
-        type: 'number|string',
-        validator: (v) => typeof v === 'number' || typeof v === 'string',
-    },
-    {
-        property: 'txHash',
-        type: 'string',
-        validator: exports.validHex,
-    },
-    {
-        property: 'amount',
-        type: 'string|undefined',
-        validator: (v) => v === undefined || typeof v === 'string',
-    },
-    {
-        property: 'token',
-        type: 'object|undefined',
-        validator: (v) => v === undefined ||
-            (v && typeof v === 'object' && Object.keys(v).length === 0) ||
-            assetValidator(v),
-    },
-];
-const srcChainStatusValidator = (v) => (0, exports.validateResponse)(srcChainStatusValidators, v, bridge_status_1.BRIDGE_STATUS_BASE_URL);
-const destChainStatusValidators = [
-    {
-        property: 'chainId',
-        // For some reason, API returns destChain.chainId as a string, it's a number everywhere else
-        type: 'number|string',
-        validator: (v) => typeof v === 'number' || typeof v === 'string',
-    },
-    {
-        property: 'amount',
-        type: 'string|undefined',
-        validator: (v) => v === undefined || typeof v === 'string',
-    },
-    {
-        property: 'txHash',
-        type: 'string|undefined',
-        validator: (v) => v === undefined || typeof v === 'string',
-    },
-    {
-        property: 'token',
-        type: 'object|undefined',
-        validator: (v) => v === undefined ||
-            (v && typeof v === 'object' && Object.keys(v).length === 0) ||
-            assetValidator(v),
-    },
-];
-const destChainStatusValidator = (v) => (0, exports.validateResponse)(destChainStatusValidators, v, bridge_status_1.BRIDGE_STATUS_BASE_URL);
-exports.validators = [
-    {
-        property: 'status',
-        type: 'string',
-        validator: (v) => Object.values(types_1.StatusTypes).includes(v),
-    },
-    {
-        property: 'srcChain',
-        type: 'object',
-        validator: srcChainStatusValidator,
-    },
-    {
-        property: 'destChain',
-        type: 'object|undefined',
-        validator: (v) => v === undefined || destChainStatusValidator(v),
-    },
-    {
-        property: 'bridge',
-        type: 'string|undefined',
-        validator: (v) => v === undefined || Object.values(types_1.BridgeId).includes(v),
-    },
-    {
-        property: 'isExpectedToken',
-        type: 'boolean|undefined',
-        validator: (v) => v === undefined || typeof v === 'boolean',
-    },
-    {
-        property: 'isUnrecognizedRouterAddress',
-        type: 'boolean|undefined',
-        validator: (v) => v === undefined || typeof v === 'boolean',
-    },
-    // TODO: add refuel validator
-    // {
-    //   property: 'refuel',
-    //   type: 'object',
-    //   validator: (v: unknown) => Object.values(RefuelStatusResponse).includes(v),
-    // },
-];
+exports.validateBridgeStatusResponse = validateBridgeStatusResponse;
 //# sourceMappingURL=validators.cjs.map

package/dist/utils/validators.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"validators.cjs","sourceRoot":"","sources":["../../src/utils/validators.ts"],"names":[],"mappings":";;;AAAA,iEAA+D;AAE/D,uDAAyD;AAEzD,wCAAiD;AAQ1C,MAAM,QAAQ,GAAG,CAAC,KAAc,EAAE,EAAE,CACzC,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAC;AADzD,QAAA,QAAQ,YACiD;AACtE,MAAM,aAAa,GAAG,CAAC,CAAU,EAAe,EAAE,CAChD,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,IAAI,CAAC;AAE/B,MAAM,YAAY,GAAG,CAC1B,UAAyD,EACzD,MAAe,EACf,OAAe,EACf,QAAQ,GAAG,IAAI,EACa,EAAE;IAC9B,OAAO,UAAU,CAAC,KAAK,CAAC,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE;QACxD,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC9B,MAAM,cAAc,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC;QAExC,MAAM,KAAK,GACT,aAAa,CAAC,MAAM,CAAC;YACrB,KAAK,CAAC,IAAI,CACR,CAAC,KAAK,EAAE,EAAE,CACR,OAAO,MAAM,CAAC,cAAqC,CAAC,KAAK,KAAK,CACjE;YACD,CAAC,CAAC,SAAS,IAAI,SAAS,CAAC,MAAM,CAAC,cAAqC,CAAC,CAAC,CAAC,CAAC;QAE3E,IAAI,CAAC,KAAK,IAAI,QAAQ,EAAE;YACtB,MAAM,KAAK,GAAG,aAAa,CAAC,MAAM,CAAC;gBACjC,CAAC,CAAC,MAAM,CAAC,cAAqC,CAAC;gBAC/C,CAAC,CAAC,SAAS,CAAC;YACd,MAAM,UAAU,GAAG,aAAa,CAAC,MAAM,CAAC;gBACtC,CAAC,CAAC,OAAO,MAAM,CAAC,cAAqC,CAAC;gBACtD,CAAC,CAAC,WAAW,CAAC;YAEhB,OAAO,CAAC,KAAK,CACX,mBAAmB,OAAO,yBAAyB,MAAM,CAAC,QAAQ,CAAC,cAAc,EACjF,KAAK,EACL,cAAc,EACd,UAAU,CACX,CAAC;SACH;QACD,OAAO,KAAK,CAAC;IACf,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAnCW,QAAA,YAAY,gBAmCvB;AAEK,MAAM,gBAAgB,GAAG,CAC9B,UAAyD,EACzD,IAAa,EACb,OAAe,EACW,EAAE;IAC5B,IAAI,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,SAAS,EAAE;QACvC,OAAO,KAAK,CAAC;KACd;IACD,OAAO,IAAA,oBAAY,EAAC,UAAU,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;AACjD,CAAC,CAAC;AATW,QAAA,gBAAgB,oBAS3B;AAEF,MAAM,eAAe,GAAG;IACtB;QACE,QAAQ,EAAE,SAAS;QACnB,IAAI,EAAE,QAAQ;QACd,SAAS,EAAE,CAAC,CAAU,EAAe,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ;KAC9D;IACD;QACE,QAAQ,EAAE,SAAS;QACnB,IAAI,EAAE,QAAQ;QACd,SAAS,EAAE,CAAC,CAAU,EAAe,EAAE,CAAC,IAAA,oCAAiB,EAAC,CAAW,CAAC;KACvE;IACD;QACE,QAAQ,EAAE,QAAQ;QAClB,IAAI,EAAE,QAAQ;QACd,SAAS,EAAE,CAAC,CAAU,EAAe,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ;KAC9D;IACD;QACE,QAAQ,EAAE,MAAM;QAChB,IAAI,EAAE,QAAQ;QACd,SAAS,EAAE,CAAC,CAAU,EAAe,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ;KAC9D;IACD;QACE,QAAQ,EAAE,UAAU;QACpB,IAAI,EAAE,QAAQ;QACd,SAAS,EAAE,CAAC,CAAU,EAAe,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ;KAC9D;IACD;QACE,QAAQ,EAAE,MAAM;QAChB,2BAA2B;QAC3B,IAAI,EAAE,yBAAyB;QAC/B,SAAS,EAAE,CAAC,CAAU,EAAoC,EAAE,CAC1D,CAAC,KAAK,SAAS,IAAI,CAAC,KAAK,IAAI,IAAI,OAAO,CAAC,KAAK,QAAQ;KACzD;CACF,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,CAAU,EAAc,EAAE,CAChD,IAAA,wBAAgB,EAAiB,eAAe,EAAE,CAAC,EAAE,sCAAsB,CAAC,CAAC;AAE/E,MAAM,wBAAwB,GAAG;IAC/B;QACE,QAAQ,EAAE,SAAS;QACnB,4FAA4F;QAC5F,IAAI,EAAE,eAAe;QACrB,SAAS,EAAE,CAAC,CAAU,EAAwB,EAAE,CAC9C,OAAO,CAAC,KAAK,QAAQ,IAAI,OAAO,CAAC,KAAK,QAAQ;KACjD;IACD;QACE,QAAQ,EAAE,QAAQ;QAClB,IAAI,EAAE,QAAQ;QACd,SAAS,EAAE,gBAAQ;KACpB;IACD;QACE,QAAQ,EAAE,QAAQ;QAClB,IAAI,EAAE,kBAAkB;QACxB,SAAS,EAAE,CAAC,CAAU,EAA2B,EAAE,CACjD,CAAC,KAAK,SAAS,IAAI,OAAO,CAAC,KAAK,QAAQ;KAC3C;IACD;QACE,QAAQ,EAAE,OAAO;QACjB,IAAI,EAAE,kBAAkB;QACxB,SAAS,EAAE,CAAC,CAAU,EAA2B,EAAE,CACjD,CAAC,KAAK,SAAS;YACf,CAAC,CAAC,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC;YAC3D,cAAc,CAAC,CAAC,CAAC;KACpB;CACF,CAAC;AAEF,MAAM,uBAAuB,GAAG,CAAC,CAAU,EAAuB,EAAE,CAClE,IAAA,wBAAgB,EACd,wBAAwB,EACxB,CAAC,EACD,sCAAsB,CACvB,CAAC;AAEJ,MAAM,yBAAyB,GAAG;IAChC;QACE,QAAQ,EAAE,SAAS;QACnB,4FAA4F;QAC5F,IAAI,EAAE,eAAe;QACrB,SAAS,EAAE,CAAC,CAAU,EAAwB,EAAE,CAC9C,OAAO,CAAC,KAAK,QAAQ,IAAI,OAAO,CAAC,KAAK,QAAQ;KACjD;IACD;QACE,QAAQ,EAAE,QAAQ;QAClB,IAAI,EAAE,kBAAkB;QACxB,SAAS,EAAE,CAAC,CAAU,EAA2B,EAAE,CACjD,CAAC,KAAK,SAAS,IAAI,OAAO,CAAC,KAAK,QAAQ;KAC3C;IACD;QACE,QAAQ,EAAE,QAAQ;QAClB,IAAI,EAAE,kBAAkB;QACxB,SAAS,EAAE,CAAC,CAAU,EAA2B,EAAE,CACjD,CAAC,KAAK,SAAS,IAAI,OAAO,CAAC,KAAK,QAAQ;KAC3C;IACD;QACE,QAAQ,EAAE,OAAO;QACjB,IAAI,EAAE,kBAAkB;QACxB,SAAS,EAAE,CAAC,CAAU,EAA0B,EAAE,CAChD,CAAC,KAAK,SAAS;YACf,CAAC,CAAC,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC;YAC3D,cAAc,CAAC,CAAC,CAAC;KACpB;CACF,CAAC;AAEF,MAAM,wBAAwB,GAAG,CAAC,CAAU,EAAwB,EAAE,CACpE,IAAA,wBAAgB,EACd,yBAAyB,EACzB,CAAC,EACD,sCAAsB,CACvB,CAAC;AAES,QAAA,UAAU,GAAG;IACxB;QACE,QAAQ,EAAE,QAAQ;QAClB,IAAI,EAAE,QAAQ;QACd,SAAS,EAAE,CAAC,CAAU,EAAoB,EAAE,CAC1C,MAAM,CAAC,MAAM,CAAC,mBAAW,CAAC,CAAC,QAAQ,CAAC,CAAgB,CAAC;KACxD;IACD;QACE,QAAQ,EAAE,UAAU;QACpB,IAAI,EAAE,QAAQ;QACd,SAAS,EAAE,uBAAuB;KACnC;IACD;QACE,QAAQ,EAAE,WAAW;QACrB,IAAI,EAAE,kBAAkB;QACxB,SAAS,EAAE,CAAC,CAAU,EAAyB,EAAE,CAC/C,CAAC,KAAK,SAAS,IAAI,wBAAwB,CAAC,CAAC,CAAC;KACjD;IACD;QACE,QAAQ,EAAE,QAAQ;QAClB,IAAI,EAAE,kBAAkB;QACxB,SAAS,EAAE,CAAC,CAAU,EAA6B,EAAE,CACnD,CAAC,KAAK,SAAS,IAAI,MAAM,CAAC,MAAM,CAAC,gBAAQ,CAAC,CAAC,QAAQ,CAAC,CAAa,CAAC;KACrE;IACD;QACE,QAAQ,EAAE,iBAAiB;QAC3B,IAAI,EAAE,mBAAmB;QACzB,SAAS,EAAE,CAAC,CAAU,EAA4B,EAAE,CAClD,CAAC,KAAK,SAAS,IAAI,OAAO,CAAC,KAAK,SAAS;KAC5C;IACD;QACE,QAAQ,EAAE,6BAA6B;QACvC,IAAI,EAAE,mBAAmB;QACzB,SAAS,EAAE,CAAC,CAAU,EAA4B,EAAE,CAClD,CAAC,KAAK,SAAS,IAAI,OAAO,CAAC,KAAK,SAAS;KAC5C;IACD,6BAA6B;IAC7B,IAAI;IACJ,wBAAwB;IACxB,oBAAoB;IACpB,gFAAgF;IAChF,KAAK;CACN,CAAC","sourcesContent":["import { isValidHexAddress } from '@metamask/controller-utils';\n\nimport { BRIDGE_STATUS_BASE_URL } from './bridge-status';\nimport type { DestChainStatus, SrcChainStatus, Asset } from '../types';\nimport { BridgeId, StatusTypes } from '../types';\n\ntype Validator<ExpectedResponse, DataToValidate> = {\n  property: keyof ExpectedResponse | string;\n  type: string;\n  validator: (value: DataToValidate) => boolean;\n};\n\nexport const validHex = (value: unknown) =>\n  typeof value === 'string' && Boolean(value.match(/^0x[a-f0-9]+$/u));\nconst isValidObject = (v: unknown): v is object =>\n  typeof v === 'object' && v !== null;\n\nexport const validateData = <ExpectedResponse, DataToValidate>(\n  validators: Validator<ExpectedResponse, DataToValidate>[],\n  object: unknown,\n  urlUsed: string,\n  logError = true,\n): object is ExpectedResponse => {\n  return validators.every(({ property, type, validator }) => {\n    const types = type.split('|');\n    const propertyString = String(property);\n\n    const valid =\n      isValidObject(object) &&\n      types.some(\n        (_type) =>\n          typeof object[propertyString as keyof typeof object] === _type,\n      ) &&\n      (!validator || validator(object[propertyString as keyof typeof object]));\n\n    if (!valid && logError) {\n      const value = isValidObject(object)\n        ? object[propertyString as keyof typeof object]\n        : undefined;\n      const typeString = isValidObject(object)\n        ? typeof object[propertyString as keyof typeof object]\n        : 'undefined';\n\n      console.error(\n        `response to GET ${urlUsed} invalid for property ${String(property)}; value was:`,\n        value,\n        '| type was: ',\n        typeString,\n      );\n    }\n    return valid;\n  });\n};\n\nexport const validateResponse = <ExpectedResponse, DataToValidate>(\n  validators: Validator<ExpectedResponse, DataToValidate>[],\n  data: unknown,\n  urlUsed: string,\n): data is ExpectedResponse => {\n  if (data === null || data === undefined) {\n    return false;\n  }\n  return validateData(validators, data, urlUsed);\n};\n\nconst assetValidators = [\n  {\n    property: 'chainId',\n    type: 'number',\n    validator: (v: unknown): v is number => typeof v === 'number',\n  },\n  {\n    property: 'address',\n    type: 'string',\n    validator: (v: unknown): v is string => isValidHexAddress(v as string),\n  },\n  {\n    property: 'symbol',\n    type: 'string',\n    validator: (v: unknown): v is string => typeof v === 'string',\n  },\n  {\n    property: 'name',\n    type: 'string',\n    validator: (v: unknown): v is string => typeof v === 'string',\n  },\n  {\n    property: 'decimals',\n    type: 'number',\n    validator: (v: unknown): v is number => typeof v === 'number',\n  },\n  {\n    property: 'icon',\n    // typeof null === 'object'\n    type: 'string|undefined|object',\n    validator: (v: unknown): v is string | undefined | object =>\n      v === undefined || v === null || typeof v === 'string',\n  },\n];\n\nconst assetValidator = (v: unknown): v is Asset =>\n  validateResponse<Asset, unknown>(assetValidators, v, BRIDGE_STATUS_BASE_URL);\n\nconst srcChainStatusValidators = [\n  {\n    property: 'chainId',\n    // For some reason, API returns destChain.chainId as a string, it's a number everywhere else\n    type: 'number|string',\n    validator: (v: unknown): v is number | string =>\n      typeof v === 'number' || typeof v === 'string',\n  },\n  {\n    property: 'txHash',\n    type: 'string',\n    validator: validHex,\n  },\n  {\n    property: 'amount',\n    type: 'string|undefined',\n    validator: (v: unknown): v is string | undefined =>\n      v === undefined || typeof v === 'string',\n  },\n  {\n    property: 'token',\n    type: 'object|undefined',\n    validator: (v: unknown): v is object | undefined =>\n      v === undefined ||\n      (v && typeof v === 'object' && Object.keys(v).length === 0) ||\n      assetValidator(v),\n  },\n];\n\nconst srcChainStatusValidator = (v: unknown): v is SrcChainStatus =>\n  validateResponse<SrcChainStatus, unknown>(\n    srcChainStatusValidators,\n    v,\n    BRIDGE_STATUS_BASE_URL,\n  );\n\nconst destChainStatusValidators = [\n  {\n    property: 'chainId',\n    // For some reason, API returns destChain.chainId as a string, it's a number everywhere else\n    type: 'number|string',\n    validator: (v: unknown): v is number | string =>\n      typeof v === 'number' || typeof v === 'string',\n  },\n  {\n    property: 'amount',\n    type: 'string|undefined',\n    validator: (v: unknown): v is string | undefined =>\n      v === undefined || typeof v === 'string',\n  },\n  {\n    property: 'txHash',\n    type: 'string|undefined',\n    validator: (v: unknown): v is string | undefined =>\n      v === undefined || typeof v === 'string',\n  },\n  {\n    property: 'token',\n    type: 'object|undefined',\n    validator: (v: unknown): v is Asset | undefined =>\n      v === undefined ||\n      (v && typeof v === 'object' && Object.keys(v).length === 0) ||\n      assetValidator(v),\n  },\n];\n\nconst destChainStatusValidator = (v: unknown): v is DestChainStatus =>\n  validateResponse<DestChainStatus, unknown>(\n    destChainStatusValidators,\n    v,\n    BRIDGE_STATUS_BASE_URL,\n  );\n\nexport const validators = [\n  {\n    property: 'status',\n    type: 'string',\n    validator: (v: unknown): v is StatusTypes =>\n      Object.values(StatusTypes).includes(v as StatusTypes),\n  },\n  {\n    property: 'srcChain',\n    type: 'object',\n    validator: srcChainStatusValidator,\n  },\n  {\n    property: 'destChain',\n    type: 'object|undefined',\n    validator: (v: unknown): v is object | unknown =>\n      v === undefined || destChainStatusValidator(v),\n  },\n  {\n    property: 'bridge',\n    type: 'string|undefined',\n    validator: (v: unknown): v is BridgeId | undefined =>\n      v === undefined || Object.values(BridgeId).includes(v as BridgeId),\n  },\n  {\n    property: 'isExpectedToken',\n    type: 'boolean|undefined',\n    validator: (v: unknown): v is boolean | undefined =>\n      v === undefined || typeof v === 'boolean',\n  },\n  {\n    property: 'isUnrecognizedRouterAddress',\n    type: 'boolean|undefined',\n    validator: (v: unknown): v is boolean | undefined =>\n      v === undefined || typeof v === 'boolean',\n  },\n  // TODO: add refuel validator\n  // {\n  //   property: 'refuel',\n  //   type: 'object',\n  //   validator: (v: unknown) => Object.values(RefuelStatusResponse).includes(v),\n  // },\n];\n"]}
+{"version":3,"file":"validators.cjs","sourceRoot":"","sources":["../../src/utils/validators.ts"],"names":[],"mappings":";;;AAAA,uDAW+B;AAE/B,wCAAiD;AAE1C,MAAM,4BAA4B,GAAG,CAAC,IAAa,EAAE,EAAE;IAC5D,MAAM,aAAa,GAAG,IAAA,mBAAK,EAAC,CAAC,IAAA,oBAAM,GAAE,EAAE,IAAA,oBAAM,GAAE,CAAC,CAAC,CAAC;IAElD,MAAM,WAAW,GAAG,IAAA,kBAAI,EAAC;QACvB,OAAO,EAAE,aAAa;QACtB,OAAO,EAAE,IAAA,oBAAM,GAAE;QACjB,MAAM,EAAE,IAAA,oBAAM,GAAE;QAChB,IAAI,EAAE,IAAA,oBAAM,GAAE;QACd,QAAQ,EAAE,IAAA,oBAAM,GAAE;QAClB,IAAI,EAAE,IAAA,sBAAQ,EAAC,IAAA,sBAAQ,EAAC,IAAA,oBAAM,GAAE,CAAC,CAAC;KACnC,CAAC,CAAC;IAEH,MAAM,iBAAiB,GAAG,IAAA,oBAAM,EAAC,EAAE,CAAC,CAAC;IAErC,MAAM,oBAAoB,GAAG,IAAA,kBAAI,EAAC;QAChC,OAAO,EAAE,aAAa;QACtB,MAAM,EAAE,IAAA,sBAAQ,EAAC,IAAA,oBAAM,GAAE,CAAC;QAC1B,MAAM,EAAE,IAAA,sBAAQ,EAAC,IAAA,oBAAM,GAAE,CAAC;QAC1B,KAAK,EAAE,IAAA,sBAAQ,EAAC,IAAA,mBAAK,EAAC,CAAC,iBAAiB,EAAE,WAAW,CAAC,CAAC,CAAC;KACzD,CAAC,CAAC;IAEH,MAAM,qBAAqB,GAAG,IAAA,kBAAI,EAAC;QACjC,OAAO,EAAE,aAAa;QACtB,MAAM,EAAE,IAAA,sBAAQ,EAAC,IAAA,oBAAM,GAAE,CAAC;QAC1B,MAAM,EAAE,IAAA,sBAAQ,EAAC,IAAA,oBAAM,GAAE,CAAC;QAC1B,KAAK,EAAE,IAAA,sBAAQ,EAAC,IAAA,mBAAK,EAAC,CAAC,iBAAiB,EAAE,WAAW,CAAC,CAAC,CAAC;KACzD,CAAC,CAAC;IAEH,MAAM,0BAA0B,GAAG,IAAA,oBAAM,GAAE,CAAC;IAE5C,MAAM,oBAAoB,GAAG,IAAA,kBAAI,EAAC;QAChC,MAAM,EAAE,IAAA,mBAAK,EAAC,MAAM,CAAC,MAAM,CAAC,mBAAW,CAAC,CAAC;QACzC,QAAQ,EAAE,oBAAoB;QAC9B,SAAS,EAAE,IAAA,sBAAQ,EAAC,qBAAqB,CAAC;QAC1C,MAAM,EAAE,IAAA,sBAAQ,EAAC,IAAA,mBAAK,EAAC,MAAM,CAAC,MAAM,CAAC,gBAAQ,CAAC,CAAC,CAAC;QAChD,eAAe,EAAE,IAAA,sBAAQ,EAAC,IAAA,qBAAO,GAAE,CAAC;QACpC,2BAA2B,EAAE,IAAA,sBAAQ,EAAC,IAAA,qBAAO,GAAE,CAAC;QAChD,MAAM,EAAE,IAAA,sBAAQ,EAAC,0BAA0B,CAAC;KAC7C,CAAC,CAAC;IAEH,IAAA,oBAAM,EAAC,IAAI,EAAE,oBAAoB,CAAC,CAAC;AACrC,CAAC,CAAC;AAzCW,QAAA,4BAA4B,gCAyCvC","sourcesContent":["import {\n  object,\n  string,\n  boolean,\n  number,\n  optional,\n  enums,\n  union,\n  type,\n  nullable,\n  assert,\n} from '@metamask/superstruct';\n\nimport { BridgeId, StatusTypes } from '../types';\n\nexport const validateBridgeStatusResponse = (data: unknown) => {\n  const ChainIdSchema = union([number(), string()]);\n\n  const AssetSchema = type({\n    chainId: ChainIdSchema,\n    address: string(),\n    symbol: string(),\n    name: string(),\n    decimals: number(),\n    icon: optional(nullable(string())),\n  });\n\n  const EmptyObjectSchema = object({});\n\n  const SrcChainStatusSchema = type({\n    chainId: ChainIdSchema,\n    txHash: optional(string()),\n    amount: optional(string()),\n    token: optional(union([EmptyObjectSchema, AssetSchema])),\n  });\n\n  const DestChainStatusSchema = type({\n    chainId: ChainIdSchema,\n    txHash: optional(string()),\n    amount: optional(string()),\n    token: optional(union([EmptyObjectSchema, AssetSchema])),\n  });\n\n  const RefuelStatusResponseSchema = object();\n\n  const StatusResponseSchema = type({\n    status: enums(Object.values(StatusTypes)),\n    srcChain: SrcChainStatusSchema,\n    destChain: optional(DestChainStatusSchema),\n    bridge: optional(enums(Object.values(BridgeId))),\n    isExpectedToken: optional(boolean()),\n    isUnrecognizedRouterAddress: optional(boolean()),\n    refuel: optional(RefuelStatusResponseSchema),\n  });\n\n  assert(data, StatusResponseSchema);\n};\n"]}

package/dist/utils/validators.d.cts

@@ -1,15 +1,2 @@
-type Validator<ExpectedResponse, DataToValidate> = {
-    property: keyof ExpectedResponse | string;
-    type: string;
-    validator: (value: DataToValidate) => boolean;
-};
-export declare const validHex: (value: unknown) => boolean;
-export declare const validateData: <ExpectedResponse, DataToValidate>(validators: Validator<ExpectedResponse, DataToValidate>[], object: unknown, urlUsed: string, logError?: boolean) => object is ExpectedResponse;
-export declare const validateResponse: <ExpectedResponse, DataToValidate>(validators: Validator<ExpectedResponse, DataToValidate>[], data: unknown, urlUsed: string) => data is ExpectedResponse;
-export declare const validators: {
-    property: string;
-    type: string;
-    validator: (v: unknown) => v is unknown;
-}[];
-export {};
+export declare const validateBridgeStatusResponse: (data: unknown) => void;
 //# sourceMappingURL=validators.d.cts.map

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

@@ -1 +1 @@
-{"version":3,"file":"validators.d.cts","sourceRoot":"","sources":["../../src/utils/validators.ts"],"names":[],"mappings":"AAMA,KAAK,SAAS,CAAC,gBAAgB,EAAE,cAAc,IAAI;IACjD,QAAQ,EAAE,MAAM,gBAAgB,GAAG,MAAM,CAAC;IAC1C,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,CAAC,KAAK,EAAE,cAAc,KAAK,OAAO,CAAC;CAC/C,CAAC;AAEF,eAAO,MAAM,QAAQ,UAAW,OAAO,YAC8B,CAAC;AAItE,eAAO,MAAM,YAAY,wGAEf,OAAO,WACN,MAAM,mDAgChB,CAAC;AAEF,eAAO,MAAM,gBAAgB,sGAErB,OAAO,WACJ,MAAM,6BAMhB,CAAC;AAiHF,eAAO,MAAM,UAAU;;;mBAeJ,OAAO;GA2BzB,CAAC"}
+{"version":3,"file":"validators.d.cts","sourceRoot":"","sources":["../../src/utils/validators.ts"],"names":[],"mappings":"AAeA,eAAO,MAAM,4BAA4B,SAAU,OAAO,SAyCzD,CAAC"}

package/dist/utils/validators.d.mts

@@ -1,15 +1,2 @@
-type Validator<ExpectedResponse, DataToValidate> = {
-    property: keyof ExpectedResponse | string;
-    type: string;
-    validator: (value: DataToValidate) => boolean;
-};
-export declare const validHex: (value: unknown) => boolean;
-export declare const validateData: <ExpectedResponse, DataToValidate>(validators: Validator<ExpectedResponse, DataToValidate>[], object: unknown, urlUsed: string, logError?: boolean) => object is ExpectedResponse;
-export declare const validateResponse: <ExpectedResponse, DataToValidate>(validators: Validator<ExpectedResponse, DataToValidate>[], data: unknown, urlUsed: string) => data is ExpectedResponse;
-export declare const validators: {
-    property: string;
-    type: string;
-    validator: (v: unknown) => v is unknown;
-}[];
-export {};
+export declare const validateBridgeStatusResponse: (data: unknown) => void;
 //# sourceMappingURL=validators.d.mts.map

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

@@ -1 +1 @@
-{"version":3,"file":"validators.d.mts","sourceRoot":"","sources":["../../src/utils/validators.ts"],"names":[],"mappings":"AAMA,KAAK,SAAS,CAAC,gBAAgB,EAAE,cAAc,IAAI;IACjD,QAAQ,EAAE,MAAM,gBAAgB,GAAG,MAAM,CAAC;IAC1C,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,CAAC,KAAK,EAAE,cAAc,KAAK,OAAO,CAAC;CAC/C,CAAC;AAEF,eAAO,MAAM,QAAQ,UAAW,OAAO,YAC8B,CAAC;AAItE,eAAO,MAAM,YAAY,wGAEf,OAAO,WACN,MAAM,mDAgChB,CAAC;AAEF,eAAO,MAAM,gBAAgB,sGAErB,OAAO,WACJ,MAAM,6BAMhB,CAAC;AAiHF,eAAO,MAAM,UAAU;;;mBAeJ,OAAO;GA2BzB,CAAC"}
+{"version":3,"file":"validators.d.mts","sourceRoot":"","sources":["../../src/utils/validators.ts"],"names":[],"mappings":"AAeA,eAAO,MAAM,4BAA4B,SAAU,OAAO,SAyCzD,CAAC"}

package/dist/utils/validators.mjs

@@ -1,155 +1,38 @@
-import { isValidHexAddress } from "@metamask/controller-utils";
-import { BRIDGE_STATUS_BASE_URL } from "./bridge-status.mjs";
+import { object, string, boolean, number, optional, enums, union, type, nullable, assert } from "@metamask/superstruct";
 import { BridgeId, StatusTypes } from "../types.mjs";
-export const validHex = (value) => typeof value === 'string' && Boolean(value.match(/^0x[a-f0-9]+$/u));
-const isValidObject = (v) => typeof v === 'object' && v !== null;
-export const validateData = (validators, object, urlUsed, logError = true) => {
-    return validators.every(({ property, type, validator }) => {
-        const types = type.split('|');
-        const propertyString = String(property);
-        const valid = isValidObject(object) &&
-            types.some((_type) => typeof object[propertyString] === _type) &&
-            (!validator || validator(object[propertyString]));
-        if (!valid && logError) {
-            const value = isValidObject(object)
-                ? object[propertyString]
-                : undefined;
-            const typeString = isValidObject(object)
-                ? typeof object[propertyString]
-                : 'undefined';
-            console.error(`response to GET ${urlUsed} invalid for property ${String(property)}; value was:`, value, '| type was: ', typeString);
-        }
-        return valid;
+export const validateBridgeStatusResponse = (data) => {
+    const ChainIdSchema = union([number(), string()]);
+    const AssetSchema = type({
+        chainId: ChainIdSchema,
+        address: string(),
+        symbol: string(),
+        name: string(),
+        decimals: number(),
+        icon: optional(nullable(string())),
     });
+    const EmptyObjectSchema = object({});
+    const SrcChainStatusSchema = type({
+        chainId: ChainIdSchema,
+        txHash: optional(string()),
+        amount: optional(string()),
+        token: optional(union([EmptyObjectSchema, AssetSchema])),
+    });
+    const DestChainStatusSchema = type({
+        chainId: ChainIdSchema,
+        txHash: optional(string()),
+        amount: optional(string()),
+        token: optional(union([EmptyObjectSchema, AssetSchema])),
+    });
+    const RefuelStatusResponseSchema = object();
+    const StatusResponseSchema = type({
+        status: enums(Object.values(StatusTypes)),
+        srcChain: SrcChainStatusSchema,
+        destChain: optional(DestChainStatusSchema),
+        bridge: optional(enums(Object.values(BridgeId))),
+        isExpectedToken: optional(boolean()),
+        isUnrecognizedRouterAddress: optional(boolean()),
+        refuel: optional(RefuelStatusResponseSchema),
+    });
+    assert(data, StatusResponseSchema);
 };
-export const validateResponse = (validators, data, urlUsed) => {
-    if (data === null || data === undefined) {
-        return false;
-    }
-    return validateData(validators, data, urlUsed);
-};
-const assetValidators = [
-    {
-        property: 'chainId',
-        type: 'number',
-        validator: (v) => typeof v === 'number',
-    },
-    {
-        property: 'address',
-        type: 'string',
-        validator: (v) => isValidHexAddress(v),
-    },
-    {
-        property: 'symbol',
-        type: 'string',
-        validator: (v) => typeof v === 'string',
-    },
-    {
-        property: 'name',
-        type: 'string',
-        validator: (v) => typeof v === 'string',
-    },
-    {
-        property: 'decimals',
-        type: 'number',
-        validator: (v) => typeof v === 'number',
-    },
-    {
-        property: 'icon',
-        // typeof null === 'object'
-        type: 'string|undefined|object',
-        validator: (v) => v === undefined || v === null || typeof v === 'string',
-    },
-];
-const assetValidator = (v) => validateResponse(assetValidators, v, BRIDGE_STATUS_BASE_URL);
-const srcChainStatusValidators = [
-    {
-        property: 'chainId',
-        // For some reason, API returns destChain.chainId as a string, it's a number everywhere else
-        type: 'number|string',
-        validator: (v) => typeof v === 'number' || typeof v === 'string',
-    },
-    {
-        property: 'txHash',
-        type: 'string',
-        validator: validHex,
-    },
-    {
-        property: 'amount',
-        type: 'string|undefined',
-        validator: (v) => v === undefined || typeof v === 'string',
-    },
-    {
-        property: 'token',
-        type: 'object|undefined',
-        validator: (v) => v === undefined ||
-            (v && typeof v === 'object' && Object.keys(v).length === 0) ||
-            assetValidator(v),
-    },
-];
-const srcChainStatusValidator = (v) => validateResponse(srcChainStatusValidators, v, BRIDGE_STATUS_BASE_URL);
-const destChainStatusValidators = [
-    {
-        property: 'chainId',
-        // For some reason, API returns destChain.chainId as a string, it's a number everywhere else
-        type: 'number|string',
-        validator: (v) => typeof v === 'number' || typeof v === 'string',
-    },
-    {
-        property: 'amount',
-        type: 'string|undefined',
-        validator: (v) => v === undefined || typeof v === 'string',
-    },
-    {
-        property: 'txHash',
-        type: 'string|undefined',
-        validator: (v) => v === undefined || typeof v === 'string',
-    },
-    {
-        property: 'token',
-        type: 'object|undefined',
-        validator: (v) => v === undefined ||
-            (v && typeof v === 'object' && Object.keys(v).length === 0) ||
-            assetValidator(v),
-    },
-];
-const destChainStatusValidator = (v) => validateResponse(destChainStatusValidators, v, BRIDGE_STATUS_BASE_URL);
-export const validators = [
-    {
-        property: 'status',
-        type: 'string',
-        validator: (v) => Object.values(StatusTypes).includes(v),
-    },
-    {
-        property: 'srcChain',
-        type: 'object',
-        validator: srcChainStatusValidator,
-    },
-    {
-        property: 'destChain',
-        type: 'object|undefined',
-        validator: (v) => v === undefined || destChainStatusValidator(v),
-    },
-    {
-        property: 'bridge',
-        type: 'string|undefined',
-        validator: (v) => v === undefined || Object.values(BridgeId).includes(v),
-    },
-    {
-        property: 'isExpectedToken',
-        type: 'boolean|undefined',
-        validator: (v) => v === undefined || typeof v === 'boolean',
-    },
-    {
-        property: 'isUnrecognizedRouterAddress',
-        type: 'boolean|undefined',
-        validator: (v) => v === undefined || typeof v === 'boolean',
-    },
-    // TODO: add refuel validator
-    // {
-    //   property: 'refuel',
-    //   type: 'object',
-    //   validator: (v: unknown) => Object.values(RefuelStatusResponse).includes(v),
-    // },
-];
 //# sourceMappingURL=validators.mjs.map

package/dist/utils/validators.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"validators.mjs","sourceRoot":"","sources":["../../src/utils/validators.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,mCAAmC;AAE/D,OAAO,EAAE,sBAAsB,EAAE,4BAAwB;AAEzD,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,qBAAiB;AAQjD,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,KAAc,EAAE,EAAE,CACzC,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAC;AACtE,MAAM,aAAa,GAAG,CAAC,CAAU,EAAe,EAAE,CAChD,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,IAAI,CAAC;AAEtC,MAAM,CAAC,MAAM,YAAY,GAAG,CAC1B,UAAyD,EACzD,MAAe,EACf,OAAe,EACf,QAAQ,GAAG,IAAI,EACa,EAAE;IAC9B,OAAO,UAAU,CAAC,KAAK,CAAC,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE;QACxD,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC9B,MAAM,cAAc,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC;QAExC,MAAM,KAAK,GACT,aAAa,CAAC,MAAM,CAAC;YACrB,KAAK,CAAC,IAAI,CACR,CAAC,KAAK,EAAE,EAAE,CACR,OAAO,MAAM,CAAC,cAAqC,CAAC,KAAK,KAAK,CACjE;YACD,CAAC,CAAC,SAAS,IAAI,SAAS,CAAC,MAAM,CAAC,cAAqC,CAAC,CAAC,CAAC,CAAC;QAE3E,IAAI,CAAC,KAAK,IAAI,QAAQ,EAAE;YACtB,MAAM,KAAK,GAAG,aAAa,CAAC,MAAM,CAAC;gBACjC,CAAC,CAAC,MAAM,CAAC,cAAqC,CAAC;gBAC/C,CAAC,CAAC,SAAS,CAAC;YACd,MAAM,UAAU,GAAG,aAAa,CAAC,MAAM,CAAC;gBACtC,CAAC,CAAC,OAAO,MAAM,CAAC,cAAqC,CAAC;gBACtD,CAAC,CAAC,WAAW,CAAC;YAEhB,OAAO,CAAC,KAAK,CACX,mBAAmB,OAAO,yBAAyB,MAAM,CAAC,QAAQ,CAAC,cAAc,EACjF,KAAK,EACL,cAAc,EACd,UAAU,CACX,CAAC;SACH;QACD,OAAO,KAAK,CAAC;IACf,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAC9B,UAAyD,EACzD,IAAa,EACb,OAAe,EACW,EAAE;IAC5B,IAAI,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,SAAS,EAAE;QACvC,OAAO,KAAK,CAAC;KACd;IACD,OAAO,YAAY,CAAC,UAAU,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;AACjD,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG;IACtB;QACE,QAAQ,EAAE,SAAS;QACnB,IAAI,EAAE,QAAQ;QACd,SAAS,EAAE,CAAC,CAAU,EAAe,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ;KAC9D;IACD;QACE,QAAQ,EAAE,SAAS;QACnB,IAAI,EAAE,QAAQ;QACd,SAAS,EAAE,CAAC,CAAU,EAAe,EAAE,CAAC,iBAAiB,CAAC,CAAW,CAAC;KACvE;IACD;QACE,QAAQ,EAAE,QAAQ;QAClB,IAAI,EAAE,QAAQ;QACd,SAAS,EAAE,CAAC,CAAU,EAAe,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ;KAC9D;IACD;QACE,QAAQ,EAAE,MAAM;QAChB,IAAI,EAAE,QAAQ;QACd,SAAS,EAAE,CAAC,CAAU,EAAe,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ;KAC9D;IACD;QACE,QAAQ,EAAE,UAAU;QACpB,IAAI,EAAE,QAAQ;QACd,SAAS,EAAE,CAAC,CAAU,EAAe,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ;KAC9D;IACD;QACE,QAAQ,EAAE,MAAM;QAChB,2BAA2B;QAC3B,IAAI,EAAE,yBAAyB;QAC/B,SAAS,EAAE,CAAC,CAAU,EAAoC,EAAE,CAC1D,CAAC,KAAK,SAAS,IAAI,CAAC,KAAK,IAAI,IAAI,OAAO,CAAC,KAAK,QAAQ;KACzD;CACF,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,CAAU,EAAc,EAAE,CAChD,gBAAgB,CAAiB,eAAe,EAAE,CAAC,EAAE,sBAAsB,CAAC,CAAC;AAE/E,MAAM,wBAAwB,GAAG;IAC/B;QACE,QAAQ,EAAE,SAAS;QACnB,4FAA4F;QAC5F,IAAI,EAAE,eAAe;QACrB,SAAS,EAAE,CAAC,CAAU,EAAwB,EAAE,CAC9C,OAAO,CAAC,KAAK,QAAQ,IAAI,OAAO,CAAC,KAAK,QAAQ;KACjD;IACD;QACE,QAAQ,EAAE,QAAQ;QAClB,IAAI,EAAE,QAAQ;QACd,SAAS,EAAE,QAAQ;KACpB;IACD;QACE,QAAQ,EAAE,QAAQ;QAClB,IAAI,EAAE,kBAAkB;QACxB,SAAS,EAAE,CAAC,CAAU,EAA2B,EAAE,CACjD,CAAC,KAAK,SAAS,IAAI,OAAO,CAAC,KAAK,QAAQ;KAC3C;IACD;QACE,QAAQ,EAAE,OAAO;QACjB,IAAI,EAAE,kBAAkB;QACxB,SAAS,EAAE,CAAC,CAAU,EAA2B,EAAE,CACjD,CAAC,KAAK,SAAS;YACf,CAAC,CAAC,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC;YAC3D,cAAc,CAAC,CAAC,CAAC;KACpB;CACF,CAAC;AAEF,MAAM,uBAAuB,GAAG,CAAC,CAAU,EAAuB,EAAE,CAClE,gBAAgB,CACd,wBAAwB,EACxB,CAAC,EACD,sBAAsB,CACvB,CAAC;AAEJ,MAAM,yBAAyB,GAAG;IAChC;QACE,QAAQ,EAAE,SAAS;QACnB,4FAA4F;QAC5F,IAAI,EAAE,eAAe;QACrB,SAAS,EAAE,CAAC,CAAU,EAAwB,EAAE,CAC9C,OAAO,CAAC,KAAK,QAAQ,IAAI,OAAO,CAAC,KAAK,QAAQ;KACjD;IACD;QACE,QAAQ,EAAE,QAAQ;QAClB,IAAI,EAAE,kBAAkB;QACxB,SAAS,EAAE,CAAC,CAAU,EAA2B,EAAE,CACjD,CAAC,KAAK,SAAS,IAAI,OAAO,CAAC,KAAK,QAAQ;KAC3C;IACD;QACE,QAAQ,EAAE,QAAQ;QAClB,IAAI,EAAE,kBAAkB;QACxB,SAAS,EAAE,CAAC,CAAU,EAA2B,EAAE,CACjD,CAAC,KAAK,SAAS,IAAI,OAAO,CAAC,KAAK,QAAQ;KAC3C;IACD;QACE,QAAQ,EAAE,OAAO;QACjB,IAAI,EAAE,kBAAkB;QACxB,SAAS,EAAE,CAAC,CAAU,EAA0B,EAAE,CAChD,CAAC,KAAK,SAAS;YACf,CAAC,CAAC,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC;YAC3D,cAAc,CAAC,CAAC,CAAC;KACpB;CACF,CAAC;AAEF,MAAM,wBAAwB,GAAG,CAAC,CAAU,EAAwB,EAAE,CACpE,gBAAgB,CACd,yBAAyB,EACzB,CAAC,EACD,sBAAsB,CACvB,CAAC;AAEJ,MAAM,CAAC,MAAM,UAAU,GAAG;IACxB;QACE,QAAQ,EAAE,QAAQ;QAClB,IAAI,EAAE,QAAQ;QACd,SAAS,EAAE,CAAC,CAAU,EAAoB,EAAE,CAC1C,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,QAAQ,CAAC,CAAgB,CAAC;KACxD;IACD;QACE,QAAQ,EAAE,UAAU;QACpB,IAAI,EAAE,QAAQ;QACd,SAAS,EAAE,uBAAuB;KACnC;IACD;QACE,QAAQ,EAAE,WAAW;QACrB,IAAI,EAAE,kBAAkB;QACxB,SAAS,EAAE,CAAC,CAAU,EAAyB,EAAE,CAC/C,CAAC,KAAK,SAAS,IAAI,wBAAwB,CAAC,CAAC,CAAC;KACjD;IACD;QACE,QAAQ,EAAE,QAAQ;QAClB,IAAI,EAAE,kBAAkB;QACxB,SAAS,EAAE,CAAC,CAAU,EAA6B,EAAE,CACnD,CAAC,KAAK,SAAS,IAAI,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAa,CAAC;KACrE;IACD;QACE,QAAQ,EAAE,iBAAiB;QAC3B,IAAI,EAAE,mBAAmB;QACzB,SAAS,EAAE,CAAC,CAAU,EAA4B,EAAE,CAClD,CAAC,KAAK,SAAS,IAAI,OAAO,CAAC,KAAK,SAAS;KAC5C;IACD;QACE,QAAQ,EAAE,6BAA6B;QACvC,IAAI,EAAE,mBAAmB;QACzB,SAAS,EAAE,CAAC,CAAU,EAA4B,EAAE,CAClD,CAAC,KAAK,SAAS,IAAI,OAAO,CAAC,KAAK,SAAS;KAC5C;IACD,6BAA6B;IAC7B,IAAI;IACJ,wBAAwB;IACxB,oBAAoB;IACpB,gFAAgF;IAChF,KAAK;CACN,CAAC","sourcesContent":["import { isValidHexAddress } from '@metamask/controller-utils';\n\nimport { BRIDGE_STATUS_BASE_URL } from './bridge-status';\nimport type { DestChainStatus, SrcChainStatus, Asset } from '../types';\nimport { BridgeId, StatusTypes } from '../types';\n\ntype Validator<ExpectedResponse, DataToValidate> = {\n  property: keyof ExpectedResponse | string;\n  type: string;\n  validator: (value: DataToValidate) => boolean;\n};\n\nexport const validHex = (value: unknown) =>\n  typeof value === 'string' && Boolean(value.match(/^0x[a-f0-9]+$/u));\nconst isValidObject = (v: unknown): v is object =>\n  typeof v === 'object' && v !== null;\n\nexport const validateData = <ExpectedResponse, DataToValidate>(\n  validators: Validator<ExpectedResponse, DataToValidate>[],\n  object: unknown,\n  urlUsed: string,\n  logError = true,\n): object is ExpectedResponse => {\n  return validators.every(({ property, type, validator }) => {\n    const types = type.split('|');\n    const propertyString = String(property);\n\n    const valid =\n      isValidObject(object) &&\n      types.some(\n        (_type) =>\n          typeof object[propertyString as keyof typeof object] === _type,\n      ) &&\n      (!validator || validator(object[propertyString as keyof typeof object]));\n\n    if (!valid && logError) {\n      const value = isValidObject(object)\n        ? object[propertyString as keyof typeof object]\n        : undefined;\n      const typeString = isValidObject(object)\n        ? typeof object[propertyString as keyof typeof object]\n        : 'undefined';\n\n      console.error(\n        `response to GET ${urlUsed} invalid for property ${String(property)}; value was:`,\n        value,\n        '| type was: ',\n        typeString,\n      );\n    }\n    return valid;\n  });\n};\n\nexport const validateResponse = <ExpectedResponse, DataToValidate>(\n  validators: Validator<ExpectedResponse, DataToValidate>[],\n  data: unknown,\n  urlUsed: string,\n): data is ExpectedResponse => {\n  if (data === null || data === undefined) {\n    return false;\n  }\n  return validateData(validators, data, urlUsed);\n};\n\nconst assetValidators = [\n  {\n    property: 'chainId',\n    type: 'number',\n    validator: (v: unknown): v is number => typeof v === 'number',\n  },\n  {\n    property: 'address',\n    type: 'string',\n    validator: (v: unknown): v is string => isValidHexAddress(v as string),\n  },\n  {\n    property: 'symbol',\n    type: 'string',\n    validator: (v: unknown): v is string => typeof v === 'string',\n  },\n  {\n    property: 'name',\n    type: 'string',\n    validator: (v: unknown): v is string => typeof v === 'string',\n  },\n  {\n    property: 'decimals',\n    type: 'number',\n    validator: (v: unknown): v is number => typeof v === 'number',\n  },\n  {\n    property: 'icon',\n    // typeof null === 'object'\n    type: 'string|undefined|object',\n    validator: (v: unknown): v is string | undefined | object =>\n      v === undefined || v === null || typeof v === 'string',\n  },\n];\n\nconst assetValidator = (v: unknown): v is Asset =>\n  validateResponse<Asset, unknown>(assetValidators, v, BRIDGE_STATUS_BASE_URL);\n\nconst srcChainStatusValidators = [\n  {\n    property: 'chainId',\n    // For some reason, API returns destChain.chainId as a string, it's a number everywhere else\n    type: 'number|string',\n    validator: (v: unknown): v is number | string =>\n      typeof v === 'number' || typeof v === 'string',\n  },\n  {\n    property: 'txHash',\n    type: 'string',\n    validator: validHex,\n  },\n  {\n    property: 'amount',\n    type: 'string|undefined',\n    validator: (v: unknown): v is string | undefined =>\n      v === undefined || typeof v === 'string',\n  },\n  {\n    property: 'token',\n    type: 'object|undefined',\n    validator: (v: unknown): v is object | undefined =>\n      v === undefined ||\n      (v && typeof v === 'object' && Object.keys(v).length === 0) ||\n      assetValidator(v),\n  },\n];\n\nconst srcChainStatusValidator = (v: unknown): v is SrcChainStatus =>\n  validateResponse<SrcChainStatus, unknown>(\n    srcChainStatusValidators,\n    v,\n    BRIDGE_STATUS_BASE_URL,\n  );\n\nconst destChainStatusValidators = [\n  {\n    property: 'chainId',\n    // For some reason, API returns destChain.chainId as a string, it's a number everywhere else\n    type: 'number|string',\n    validator: (v: unknown): v is number | string =>\n      typeof v === 'number' || typeof v === 'string',\n  },\n  {\n    property: 'amount',\n    type: 'string|undefined',\n    validator: (v: unknown): v is string | undefined =>\n      v === undefined || typeof v === 'string',\n  },\n  {\n    property: 'txHash',\n    type: 'string|undefined',\n    validator: (v: unknown): v is string | undefined =>\n      v === undefined || typeof v === 'string',\n  },\n  {\n    property: 'token',\n    type: 'object|undefined',\n    validator: (v: unknown): v is Asset | undefined =>\n      v === undefined ||\n      (v && typeof v === 'object' && Object.keys(v).length === 0) ||\n      assetValidator(v),\n  },\n];\n\nconst destChainStatusValidator = (v: unknown): v is DestChainStatus =>\n  validateResponse<DestChainStatus, unknown>(\n    destChainStatusValidators,\n    v,\n    BRIDGE_STATUS_BASE_URL,\n  );\n\nexport const validators = [\n  {\n    property: 'status',\n    type: 'string',\n    validator: (v: unknown): v is StatusTypes =>\n      Object.values(StatusTypes).includes(v as StatusTypes),\n  },\n  {\n    property: 'srcChain',\n    type: 'object',\n    validator: srcChainStatusValidator,\n  },\n  {\n    property: 'destChain',\n    type: 'object|undefined',\n    validator: (v: unknown): v is object | unknown =>\n      v === undefined || destChainStatusValidator(v),\n  },\n  {\n    property: 'bridge',\n    type: 'string|undefined',\n    validator: (v: unknown): v is BridgeId | undefined =>\n      v === undefined || Object.values(BridgeId).includes(v as BridgeId),\n  },\n  {\n    property: 'isExpectedToken',\n    type: 'boolean|undefined',\n    validator: (v: unknown): v is boolean | undefined =>\n      v === undefined || typeof v === 'boolean',\n  },\n  {\n    property: 'isUnrecognizedRouterAddress',\n    type: 'boolean|undefined',\n    validator: (v: unknown): v is boolean | undefined =>\n      v === undefined || typeof v === 'boolean',\n  },\n  // TODO: add refuel validator\n  // {\n  //   property: 'refuel',\n  //   type: 'object',\n  //   validator: (v: unknown) => Object.values(RefuelStatusResponse).includes(v),\n  // },\n];\n"]}
+{"version":3,"file":"validators.mjs","sourceRoot":"","sources":["../../src/utils/validators.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,MAAM,EACN,MAAM,EACN,OAAO,EACP,MAAM,EACN,QAAQ,EACR,KAAK,EACL,KAAK,EACL,IAAI,EACJ,QAAQ,EACR,MAAM,EACP,8BAA8B;AAE/B,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,qBAAiB;AAEjD,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,IAAa,EAAE,EAAE;IAC5D,MAAM,aAAa,GAAG,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;IAElD,MAAM,WAAW,GAAG,IAAI,CAAC;QACvB,OAAO,EAAE,aAAa;QACtB,OAAO,EAAE,MAAM,EAAE;QACjB,MAAM,EAAE,MAAM,EAAE;QAChB,IAAI,EAAE,MAAM,EAAE;QACd,QAAQ,EAAE,MAAM,EAAE;QAClB,IAAI,EAAE,QAAQ,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;KACnC,CAAC,CAAC;IAEH,MAAM,iBAAiB,GAAG,MAAM,CAAC,EAAE,CAAC,CAAC;IAErC,MAAM,oBAAoB,GAAG,IAAI,CAAC;QAChC,OAAO,EAAE,aAAa;QACtB,MAAM,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC;QAC1B,MAAM,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC;QAC1B,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC,iBAAiB,EAAE,WAAW,CAAC,CAAC,CAAC;KACzD,CAAC,CAAC;IAEH,MAAM,qBAAqB,GAAG,IAAI,CAAC;QACjC,OAAO,EAAE,aAAa;QACtB,MAAM,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC;QAC1B,MAAM,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC;QAC1B,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC,iBAAiB,EAAE,WAAW,CAAC,CAAC,CAAC;KACzD,CAAC,CAAC;IAEH,MAAM,0BAA0B,GAAG,MAAM,EAAE,CAAC;IAE5C,MAAM,oBAAoB,GAAG,IAAI,CAAC;QAChC,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QACzC,QAAQ,EAAE,oBAAoB;QAC9B,SAAS,EAAE,QAAQ,CAAC,qBAAqB,CAAC;QAC1C,MAAM,EAAE,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC;QAChD,eAAe,EAAE,QAAQ,CAAC,OAAO,EAAE,CAAC;QACpC,2BAA2B,EAAE,QAAQ,CAAC,OAAO,EAAE,CAAC;QAChD,MAAM,EAAE,QAAQ,CAAC,0BAA0B,CAAC;KAC7C,CAAC,CAAC;IAEH,MAAM,CAAC,IAAI,EAAE,oBAAoB,CAAC,CAAC;AACrC,CAAC,CAAC","sourcesContent":["import {\n  object,\n  string,\n  boolean,\n  number,\n  optional,\n  enums,\n  union,\n  type,\n  nullable,\n  assert,\n} from '@metamask/superstruct';\n\nimport { BridgeId, StatusTypes } from '../types';\n\nexport const validateBridgeStatusResponse = (data: unknown) => {\n  const ChainIdSchema = union([number(), string()]);\n\n  const AssetSchema = type({\n    chainId: ChainIdSchema,\n    address: string(),\n    symbol: string(),\n    name: string(),\n    decimals: number(),\n    icon: optional(nullable(string())),\n  });\n\n  const EmptyObjectSchema = object({});\n\n  const SrcChainStatusSchema = type({\n    chainId: ChainIdSchema,\n    txHash: optional(string()),\n    amount: optional(string()),\n    token: optional(union([EmptyObjectSchema, AssetSchema])),\n  });\n\n  const DestChainStatusSchema = type({\n    chainId: ChainIdSchema,\n    txHash: optional(string()),\n    amount: optional(string()),\n    token: optional(union([EmptyObjectSchema, AssetSchema])),\n  });\n\n  const RefuelStatusResponseSchema = object();\n\n  const StatusResponseSchema = type({\n    status: enums(Object.values(StatusTypes)),\n    srcChain: SrcChainStatusSchema,\n    destChain: optional(DestChainStatusSchema),\n    bridge: optional(enums(Object.values(BridgeId))),\n    isExpectedToken: optional(boolean()),\n    isUnrecognizedRouterAddress: optional(boolean()),\n    refuel: optional(RefuelStatusResponseSchema),\n  });\n\n  assert(data, StatusResponseSchema);\n};\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/bridge-status-controller",
-  "version": "1.0.0",
+  "version": "3.0.0",
   "description": "Manages bridge-related status fetching functionality for MetaMask",
   "keywords": [
     "MetaMask",
@@ -48,13 +48,14 @@
   },
   "dependencies": {
     "@metamask/base-controller": "^8.0.0",
-    "@metamask/bridge-controller": "^1.0.0",
+    "@metamask/bridge-controller": "^3.0.0",
     "@metamask/controller-utils": "^11.5.0",
     "@metamask/polling-controller": "^12.0.3",
+    "@metamask/superstruct": "^3.1.0",
     "@metamask/utils": "^11.2.0"
   },
   "devDependencies": {
-    "@metamask/accounts-controller": "^24.0.0",
+    "@metamask/accounts-controller": "^24.1.0",
     "@metamask/auto-changelog": "^3.4.4",
     "@metamask/network-controller": "^22.2.1",
     "@metamask/transaction-controller": "^46.0.0",
@@ -71,7 +72,7 @@
   },
   "peerDependencies": {
     "@metamask/accounts-controller": "^24.0.0",
-    "@metamask/bridge-controller": "^1.0.0",
+    "@metamask/bridge-controller": "^3.0.0",
     "@metamask/network-controller": "^22.0.0",
     "@metamask/transaction-controller": "^46.0.0"
   },