@metamask-previews/bridge-status-controller 1.0.0-preview-dbdf1da

package/dist/utils/bridge-status.d.mts

@@ -0,0 +1,10 @@
+import type { Quote } from "@metamask/bridge-controller";
+import type { StatusResponse, StatusRequestWithSrcTxHash, StatusRequestDto, FetchFunction } from "../types.mjs";
+export declare const getClientIdHeader: (clientId: string) => {
+    'X-Client-Id': string;
+};
+export declare const BRIDGE_STATUS_BASE_URL: string;
+export declare const getStatusRequestDto: (statusRequest: StatusRequestWithSrcTxHash) => StatusRequestDto;
+export declare const fetchBridgeTxStatus: (statusRequest: StatusRequestWithSrcTxHash, clientId: string, fetchFn: FetchFunction) => Promise<StatusResponse>;
+export declare const getStatusRequestWithSrcTxHash: (quote: Quote, srcTxHash: string) => StatusRequestWithSrcTxHash;
+//# sourceMappingURL=bridge-status.d.mts.map

package/dist/utils/bridge-status.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bridge-status.d.mts","sourceRoot":"","sources":["../../src/utils/bridge-status.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,oCAAoC;AAIzD,OAAO,KAAK,EACV,cAAc,EACd,0BAA0B,EAC1B,gBAAgB,EAChB,aAAa,EACd,qBAAiB;AAElB,eAAO,MAAM,iBAAiB,aAAc,MAAM;;CAEhD,CAAC;AAEH,eAAO,MAAM,sBAAsB,QAAyC,CAAC;AAE7E,eAAO,MAAM,mBAAmB,kBACf,0BAA0B,KACxC,gBAiBF,CAAC;AAEF,eAAO,MAAM,mBAAmB,kBACf,0BAA0B,YAC/B,MAAM,WACP,aAAa,4BAwBvB,CAAC;AAEF,eAAO,MAAM,6BAA6B,UACjC,KAAK,aACD,MAAM,KAChB,0BAUF,CAAC"}

package/dist/utils/bridge-status.mjs

@@ -0,0 +1,46 @@
+import { getBridgeApiBaseUrl } from "@metamask/bridge-controller";
+import { validateResponse, validators } from "./validators.mjs";
+export const getClientIdHeader = (clientId) => ({
+    'X-Client-Id': clientId,
+});
+export const BRIDGE_STATUS_BASE_URL = `${getBridgeApiBaseUrl()}/getTxStatus`;
+export const getStatusRequestDto = (statusRequest) => {
+    const { quote, ...statusRequestNoQuote } = statusRequest;
+    const statusRequestNoQuoteFormatted = Object.fromEntries(Object.entries(statusRequestNoQuote).map(([key, value]) => [
+        key,
+        value.toString(),
+    ]));
+    const requestId = quote?.requestId ? { requestId: quote.requestId } : {};
+    return {
+        ...statusRequestNoQuoteFormatted,
+        ...requestId,
+    };
+};
+export const fetchBridgeTxStatus = async (statusRequest, clientId, fetchFn) => {
+    const statusRequestDto = getStatusRequestDto(statusRequest);
+    const params = new URLSearchParams(statusRequestDto);
+    // Fetch
+    const url = `${BRIDGE_STATUS_BASE_URL}?${params.toString()}`;
+    const rawTxStatus = await fetchFn(url, {
+        headers: getClientIdHeader(clientId),
+    });
+    // Validate
+    const isValid = validateResponse(validators, rawTxStatus, BRIDGE_STATUS_BASE_URL);
+    if (!isValid) {
+        throw new Error('Invalid response from bridge');
+    }
+    // Return
+    return rawTxStatus;
+};
+export const getStatusRequestWithSrcTxHash = (quote, srcTxHash) => {
+    return {
+        bridgeId: quote.bridgeId,
+        srcTxHash,
+        bridge: quote.bridges[0],
+        srcChainId: quote.srcChainId,
+        destChainId: quote.destChainId,
+        quote,
+        refuel: Boolean(quote.refuel),
+    };
+};
+//# sourceMappingURL=bridge-status.mjs.map

package/dist/utils/bridge-status.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"bridge-status.mjs","sourceRoot":"","sources":["../../src/utils/bridge-status.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,mBAAmB,EAAE,oCAAoC;AAElE,OAAO,EAAE,gBAAgB,EAAE,UAAU,EAAE,yBAAqB;AAQ5D,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,QAAgB,EAAE,EAAE,CAAC,CAAC;IACtD,aAAa,EAAE,QAAQ;CACxB,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,sBAAsB,GAAG,GAAG,mBAAmB,EAAE,cAAc,CAAC;AAE7E,MAAM,CAAC,MAAM,mBAAmB,GAAG,CACjC,aAAyC,EACvB,EAAE;IACpB,MAAM,EAAE,KAAK,EAAE,GAAG,oBAAoB,EAAE,GAAG,aAAa,CAAC;IAEzD,MAAM,6BAA6B,GAAG,MAAM,CAAC,WAAW,CACtD,MAAM,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC;QACzD,GAAG;QACH,KAAK,CAAC,QAAQ,EAAE;KACjB,CAAC,CAC+C,CAAC;IAEpD,MAAM,SAAS,GACb,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,KAAK,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IAEzD,OAAO;QACL,GAAG,6BAA6B;QAChC,GAAG,SAAS;KACb,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,mBAAmB,GAAG,KAAK,EACtC,aAAyC,EACzC,QAAgB,EAChB,OAAsB,EACtB,EAAE;IACF,MAAM,gBAAgB,GAAG,mBAAmB,CAAC,aAAa,CAAC,CAAC;IAC5D,MAAM,MAAM,GAAG,IAAI,eAAe,CAAC,gBAAgB,CAAC,CAAC;IAErD,QAAQ;IACR,MAAM,GAAG,GAAG,GAAG,sBAAsB,IAAI,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAC;IAE7D,MAAM,WAAW,GAAG,MAAM,OAAO,CAAC,GAAG,EAAE;QACrC,OAAO,EAAE,iBAAiB,CAAC,QAAQ,CAAC;KACrC,CAAC,CAAC;IAEH,WAAW;IACX,MAAM,OAAO,GAAG,gBAAgB,CAC9B,UAAU,EACV,WAAW,EACX,sBAAsB,CACvB,CAAC;IACF,IAAI,CAAC,OAAO,EAAE;QACZ,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;KACjD;IAED,SAAS;IACT,OAAO,WAAW,CAAC;AACrB,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAC3C,KAAY,EACZ,SAAiB,EACW,EAAE;IAC9B,OAAO;QACL,QAAQ,EAAE,KAAK,CAAC,QAAQ;QACxB,SAAS;QACT,MAAM,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;QACxB,UAAU,EAAE,KAAK,CAAC,UAAU;QAC5B,WAAW,EAAE,KAAK,CAAC,WAAW;QAC9B,KAAK;QACL,MAAM,EAAE,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC;KAC9B,CAAC;AACJ,CAAC,CAAC","sourcesContent":["import type { Quote } from '@metamask/bridge-controller';\nimport { getBridgeApiBaseUrl } from '@metamask/bridge-controller';\n\nimport { validateResponse, validators } from './validators';\nimport type {\n  StatusResponse,\n  StatusRequestWithSrcTxHash,\n  StatusRequestDto,\n  FetchFunction,\n} from '../types';\n\nexport const getClientIdHeader = (clientId: string) => ({\n  'X-Client-Id': clientId,\n});\n\nexport const BRIDGE_STATUS_BASE_URL = `${getBridgeApiBaseUrl()}/getTxStatus`;\n\nexport const getStatusRequestDto = (\n  statusRequest: StatusRequestWithSrcTxHash,\n): StatusRequestDto => {\n  const { quote, ...statusRequestNoQuote } = statusRequest;\n\n  const statusRequestNoQuoteFormatted = Object.fromEntries(\n    Object.entries(statusRequestNoQuote).map(([key, value]) => [\n      key,\n      value.toString(),\n    ]),\n  ) as unknown as Omit<StatusRequestDto, 'requestId'>;\n\n  const requestId: { requestId: string } | Record<string, never> =\n    quote?.requestId ? { requestId: quote.requestId } : {};\n\n  return {\n    ...statusRequestNoQuoteFormatted,\n    ...requestId,\n  };\n};\n\nexport const fetchBridgeTxStatus = async (\n  statusRequest: StatusRequestWithSrcTxHash,\n  clientId: string,\n  fetchFn: FetchFunction,\n) => {\n  const statusRequestDto = getStatusRequestDto(statusRequest);\n  const params = new URLSearchParams(statusRequestDto);\n\n  // Fetch\n  const url = `${BRIDGE_STATUS_BASE_URL}?${params.toString()}`;\n\n  const rawTxStatus = await fetchFn(url, {\n    headers: getClientIdHeader(clientId),\n  });\n\n  // Validate\n  const isValid = validateResponse<StatusResponse, unknown>(\n    validators,\n    rawTxStatus,\n    BRIDGE_STATUS_BASE_URL,\n  );\n  if (!isValid) {\n    throw new Error('Invalid response from bridge');\n  }\n\n  // Return\n  return rawTxStatus;\n};\n\nexport const getStatusRequestWithSrcTxHash = (\n  quote: Quote,\n  srcTxHash: string,\n): StatusRequestWithSrcTxHash => {\n  return {\n    bridgeId: quote.bridgeId,\n    srcTxHash,\n    bridge: quote.bridges[0],\n    srcChainId: quote.srcChainId,\n    destChainId: quote.destChainId,\n    quote,\n    refuel: Boolean(quote.refuel),\n  };\n};\n"]}

package/dist/utils/validators.cjs

@@ -0,0 +1,161 @@
+"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");
+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;
+    });
+};
+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),
+    // },
+];
+//# sourceMappingURL=validators.cjs.map

package/dist/utils/validators.cjs.map

@@ -0,0 +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"]}

package/dist/utils/validators.d.cts

@@ -0,0 +1,15 @@
+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 {};
+//# sourceMappingURL=validators.d.cts.map

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

@@ -0,0 +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"}

package/dist/utils/validators.d.mts

@@ -0,0 +1,15 @@
+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 {};
+//# sourceMappingURL=validators.d.mts.map

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

@@ -0,0 +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"}

package/dist/utils/validators.mjs

@@ -0,0 +1,155 @@
+import { isValidHexAddress } from "@metamask/controller-utils";
+import { BRIDGE_STATUS_BASE_URL } from "./bridge-status.mjs";
+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 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

@@ -0,0 +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"]}

package/package.json

@@ -0,0 +1,85 @@
+{
+  "name": "@metamask-previews/bridge-status-controller",
+  "version": "1.0.0-preview-dbdf1da",
+  "description": "Manages bridge-related status fetching functionality for MetaMask",
+  "keywords": [
+    "MetaMask",
+    "Ethereum"
+  ],
+  "homepage": "https://github.com/MetaMask/core/tree/main/packages/bridge-status-controller#readme",
+  "bugs": {
+    "url": "https://github.com/MetaMask/core/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/MetaMask/core.git"
+  },
+  "license": "MIT",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/index.cjs",
+  "types": "./dist/index.d.cts",
+  "files": [
+    "dist/"
+  ],
+  "scripts": {
+    "build": "ts-bridge --project tsconfig.build.json --verbose --clean --no-references",
+    "build:docs": "typedoc",
+    "changelog:update": "../../scripts/update-changelog.sh @metamask/bridge-status-controller",
+    "changelog:validate": "../../scripts/validate-changelog.sh @metamask/bridge-status-controller",
+    "publish:preview": "yarn npm publish --tag preview",
+    "since-latest-release": "../../scripts/since-latest-release.sh",
+    "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter",
+    "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache",
+    "test:verbose": "NODE_OPTIONS=--experimental-vm-modules jest --verbose",
+    "test:watch": "NODE_OPTIONS=--experimental-vm-modules jest --watch"
+  },
+  "dependencies": {
+    "@metamask/base-controller": "^8.0.0",
+    "@metamask/bridge-controller": "^1.0.0",
+    "@metamask/controller-utils": "^11.5.0",
+    "@metamask/polling-controller": "^12.0.3",
+    "@metamask/utils": "^11.2.0"
+  },
+  "devDependencies": {
+    "@metamask/accounts-controller": "^24.0.0",
+    "@metamask/auto-changelog": "^3.4.4",
+    "@metamask/network-controller": "^22.2.1",
+    "@metamask/transaction-controller": "^46.0.0",
+    "@types/jest": "^27.4.1",
+    "deepmerge": "^4.2.2",
+    "jest": "^27.5.1",
+    "jest-environment-jsdom": "^27.5.1",
+    "lodash": "^4.17.21",
+    "nock": "^13.3.1",
+    "ts-jest": "^27.1.4",
+    "typedoc": "^0.24.8",
+    "typedoc-plugin-missing-exports": "^2.0.0",
+    "typescript": "~5.2.2"
+  },
+  "peerDependencies": {
+    "@metamask/accounts-controller": "^24.0.0",
+    "@metamask/bridge-controller": "^1.0.0",
+    "@metamask/network-controller": "^22.0.0",
+    "@metamask/transaction-controller": "^46.0.0"
+  },
+  "engines": {
+    "node": "^18.18 || >=20"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  }
+}