@metamask-previews/perps-controller 20.0.0-preview-44b7ded21 → 20.0.0-preview-2750df1dc

package/dist/utils/errorContext.d.ts

@@ -0,0 +1,78 @@
+import type { PerpsLogger } from '../types/index.js';
+export declare const PERPS_ERROR_OPERATION: {
+    readonly ConnectionManagement: 'connection_management';
+    readonly OrderManagement: 'order_management';
+    readonly PositionManagement: 'position_management';
+    readonly FinancialOperations: 'financial_operations';
+};
+export type PerpsErrorOperation = (typeof PERPS_ERROR_OPERATION)[keyof typeof PERPS_ERROR_OPERATION];
+export declare const PERPS_ERROR_ACTION: {
+    readonly ConnectionConnection: 'connection_connection';
+    readonly FinancialDeposit: 'financial_deposit';
+    readonly FinancialWithdrawal: 'financial_withdrawal';
+    readonly PlaceOrder: 'place_order';
+    readonly EditOrder: 'edit_order';
+    readonly CancelOrder: 'cancel_order';
+    readonly ClosePosition: 'close_position';
+    readonly PositionTpslUpdate: 'position_tpsl_update';
+    readonly UpdateMargin: 'update_margin';
+    readonly FlipPosition: 'flip_position';
+};
+export type PerpsErrorAction = (typeof PERPS_ERROR_ACTION)[keyof typeof PERPS_ERROR_ACTION];
+export declare const PERPS_ERROR_COMPONENT: {
+    readonly ConnectionManager: 'PerpsConnectionManager';
+};
+export type PerpsErrorComponent = (typeof PERPS_ERROR_COMPONENT)[keyof typeof PERPS_ERROR_COMPONENT];
+export type PerpsErrorTags = {
+    operation: PerpsErrorOperation;
+    action?: PerpsErrorAction;
+    component?: PerpsErrorComponent;
+};
+export type PerpsLoggerOptions = NonNullable<Parameters<PerpsLogger['error']>[1]>;
+declare const PROVIDER_ERROR_REPORTED: unique symbol;
+type ProviderErrorReported = {
+    [PROVIDER_ERROR_REPORTED]?: true;
+};
+/**
+ * Mark a failed provider result whose underlying error was already reported.
+ *
+ * The symbol remains internal to Core and survives object spreads used by the
+ * aggregated provider without adding a consumer-facing result field.
+ *
+ * @param result - Provider result to mark.
+ * @returns The same result with internal reporting metadata.
+ */
+export declare function markProviderErrorReported<Result extends object>(result: Result): Result & ProviderErrorReported;
+/**
+ * Check whether a provider already reported the error represented by a result.
+ *
+ * @param result - Provider result returned to a service.
+ * @returns Whether the provider owns reporting for the failure.
+ */
+export declare function wasProviderErrorReported(result: object): boolean;
+/**
+ * Build a Perps logger payload with bounded, searchable Sentry tags.
+ *
+ * Diagnostic data is deliberately kept separate from tags so identifiers,
+ * symbols, messages, and method names cannot accidentally create unbounded
+ * tag cardinality.
+ *
+ * @param options - Error context options.
+ * @param options.contextName - Stable name for the diagnostic context.
+ * @param options.method - Method or boundary where the error occurred.
+ * @param options.provider - Optional provider identifier.
+ * @param options.network - Optional network environment.
+ * @param options.errorTags - Optional bounded dashboard tags.
+ * @param options.data - Optional diagnostic data retained in context.
+ * @returns Logger options accepted by the platform-provided Perps logger.
+ */
+export declare function createPerpsErrorContext(options: {
+    contextName: string;
+    method: string;
+    provider?: string;
+    network?: 'mainnet' | 'testnet';
+    errorTags?: PerpsErrorTags;
+    data?: Record<string, unknown>;
+}): PerpsLoggerOptions;
+export {};
+//# sourceMappingURL=errorContext.d.ts.map

package/dist/utils/errorContext.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errorContext.d.ts","sourceRoot":"","sources":["../../src/utils/errorContext.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAErD,eAAO,MAAM,qBAAqB;aAChC,oBAAoB,EAAE,uBAAuB;aAC7C,eAAe,EAAE,kBAAkB;aACnC,kBAAkB,EAAE,qBAAqB;aACzC,mBAAmB,EAAE,sBAAsB;CACnC,CAAC;AAEX,MAAM,MAAM,mBAAmB,GAC7B,CAAC,OAAO,qBAAqB,CAAC,CAAC,MAAM,OAAO,qBAAqB,CAAC,CAAC;AAErE,eAAO,MAAM,kBAAkB;aAC7B,oBAAoB,EAAE,uBAAuB;aAC7C,gBAAgB,EAAE,mBAAmB;aACrC,mBAAmB,EAAE,sBAAsB;aAC3C,UAAU,EAAE,aAAa;aACzB,SAAS,EAAE,YAAY;aACvB,WAAW,EAAE,cAAc;aAC3B,aAAa,EAAE,gBAAgB;aAC/B,kBAAkB,EAAE,sBAAsB;aAC1C,YAAY,EAAE,eAAe;aAC7B,YAAY,EAAE,eAAe;CACrB,CAAC;AAEX,MAAM,MAAM,gBAAgB,GAC1B,CAAC,OAAO,kBAAkB,CAAC,CAAC,MAAM,OAAO,kBAAkB,CAAC,CAAC;AAE/D,eAAO,MAAM,qBAAqB;aAChC,iBAAiB,EAAE,wBAAwB;CACnC,CAAC;AAEX,MAAM,MAAM,mBAAmB,GAC7B,CAAC,OAAO,qBAAqB,CAAC,CAAC,MAAM,OAAO,qBAAqB,CAAC,CAAC;AAErE,MAAM,MAAM,cAAc,GAAG;IAC3B,SAAS,EAAE,mBAAmB,CAAC;IAC/B,MAAM,CAAC,EAAE,gBAAgB,CAAC;IAC1B,SAAS,CAAC,EAAE,mBAAmB,CAAC;CACjC,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG,WAAW,CAC1C,UAAU,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CACpC,CAAC;AAEF,QAAA,MAAM,uBAAuB,eAAkC,CAAC;AAEhE,KAAK,qBAAqB,GAAG;IAC3B,CAAC,uBAAuB,CAAC,CAAC,EAAE,IAAI,CAAC;CAClC,CAAC;AAEF;;;;;;;;GAQG;AACH,wBAAgB,yBAAyB,CAAC,MAAM,SAAS,MAAM,EAC7D,MAAM,EAAE,MAAM,GACb,MAAM,GAAG,qBAAqB,CAEhC;AAED;;;;;GAKG;AACH,wBAAgB,wBAAwB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAEhE;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,uBAAuB,CAAC,OAAO,EAAE;IAC/C,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC;IAChC,SAAS,CAAC,EAAE,cAAc,CAAC;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAChC,GAAG,kBAAkB,CAgCrB"}

package/dist/utils/errorContext.js

@@ -0,0 +1,92 @@
+import { PERPS_CONSTANTS } from '../constants/perpsConfig.js';
+export const PERPS_ERROR_OPERATION = {
+    ConnectionManagement: 'connection_management',
+    OrderManagement: 'order_management',
+    PositionManagement: 'position_management',
+    FinancialOperations: 'financial_operations',
+};
+export const PERPS_ERROR_ACTION = {
+    ConnectionConnection: 'connection_connection',
+    FinancialDeposit: 'financial_deposit',
+    FinancialWithdrawal: 'financial_withdrawal',
+    PlaceOrder: 'place_order',
+    EditOrder: 'edit_order',
+    CancelOrder: 'cancel_order',
+    ClosePosition: 'close_position',
+    PositionTpslUpdate: 'position_tpsl_update',
+    UpdateMargin: 'update_margin',
+    FlipPosition: 'flip_position',
+};
+export const PERPS_ERROR_COMPONENT = {
+    ConnectionManager: 'PerpsConnectionManager',
+};
+const PROVIDER_ERROR_REPORTED = Symbol('providerErrorReported');
+/**
+ * Mark a failed provider result whose underlying error was already reported.
+ *
+ * The symbol remains internal to Core and survives object spreads used by the
+ * aggregated provider without adding a consumer-facing result field.
+ *
+ * @param result - Provider result to mark.
+ * @returns The same result with internal reporting metadata.
+ */
+export function markProviderErrorReported(result) {
+    return Object.assign(result, { [PROVIDER_ERROR_REPORTED]: true });
+}
+/**
+ * Check whether a provider already reported the error represented by a result.
+ *
+ * @param result - Provider result returned to a service.
+ * @returns Whether the provider owns reporting for the failure.
+ */
+export function wasProviderErrorReported(result) {
+    return result[PROVIDER_ERROR_REPORTED] === true;
+}
+/**
+ * Build a Perps logger payload with bounded, searchable Sentry tags.
+ *
+ * Diagnostic data is deliberately kept separate from tags so identifiers,
+ * symbols, messages, and method names cannot accidentally create unbounded
+ * tag cardinality.
+ *
+ * @param options - Error context options.
+ * @param options.contextName - Stable name for the diagnostic context.
+ * @param options.method - Method or boundary where the error occurred.
+ * @param options.provider - Optional provider identifier.
+ * @param options.network - Optional network environment.
+ * @param options.errorTags - Optional bounded dashboard tags.
+ * @param options.data - Optional diagnostic data retained in context.
+ * @returns Logger options accepted by the platform-provided Perps logger.
+ */
+export function createPerpsErrorContext(options) {
+    const { contextName, method, provider, network, errorTags, data } = options;
+    const tags = {
+        feature: PERPS_CONSTANTS.FeatureName,
+    };
+    if (provider !== undefined) {
+        tags.provider = provider;
+    }
+    if (network !== undefined) {
+        tags.network = network;
+    }
+    if (errorTags !== undefined) {
+        tags.operation = errorTags.operation;
+        if (errorTags.action !== undefined) {
+            tags.action = errorTags.action;
+        }
+        if (errorTags.component !== undefined) {
+            tags.component = errorTags.component;
+        }
+    }
+    return {
+        tags,
+        context: {
+            name: contextName,
+            data: {
+                method,
+                ...data,
+            },
+        },
+    };
+}
+//# sourceMappingURL=errorContext.js.map

package/dist/utils/errorContext.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errorContext.js","sourceRoot":"","sources":["../../src/utils/errorContext.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAG9D,MAAM,CAAC,MAAM,qBAAqB,GAAG;IACnC,oBAAoB,EAAE,uBAAuB;IAC7C,eAAe,EAAE,kBAAkB;IACnC,kBAAkB,EAAE,qBAAqB;IACzC,mBAAmB,EAAE,sBAAsB;CACnC,CAAC;AAKX,MAAM,CAAC,MAAM,kBAAkB,GAAG;IAChC,oBAAoB,EAAE,uBAAuB;IAC7C,gBAAgB,EAAE,mBAAmB;IACrC,mBAAmB,EAAE,sBAAsB;IAC3C,UAAU,EAAE,aAAa;IACzB,SAAS,EAAE,YAAY;IACvB,WAAW,EAAE,cAAc;IAC3B,aAAa,EAAE,gBAAgB;IAC/B,kBAAkB,EAAE,sBAAsB;IAC1C,YAAY,EAAE,eAAe;IAC7B,YAAY,EAAE,eAAe;CACrB,CAAC;AAKX,MAAM,CAAC,MAAM,qBAAqB,GAAG;IACnC,iBAAiB,EAAE,wBAAwB;CACnC,CAAC;AAeX,MAAM,uBAAuB,GAAG,MAAM,CAAC,uBAAuB,CAAC,CAAC;AAMhE;;;;;;;;GAQG;AACH,MAAM,UAAU,yBAAyB,CACvC,MAAc;IAEd,OAAO,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC,uBAAuB,CAAC,EAAE,IAAa,EAAE,CAAC,CAAC;AAC7E,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,wBAAwB,CAAC,MAAc;IACrD,OAAQ,MAAgC,CAAC,uBAAuB,CAAC,KAAK,IAAI,CAAC;AAC7E,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,uBAAuB,CAAC,OAOvC;IACC,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;IAC5E,MAAM,IAAI,GAAoC;QAC5C,OAAO,EAAE,eAAe,CAAC,WAAW;KACrC,CAAC;IAEF,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QAC3B,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IACD,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;QAC1B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IACD,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;QAC5B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC,SAAS,CAAC;QACrC,IAAI,SAAS,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YACnC,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC,MAAM,CAAC;QACjC,CAAC;QACD,IAAI,SAAS,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;YACtC,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC,SAAS,CAAC;QACvC,CAAC;IACH,CAAC;IAED,OAAO;QACL,IAAI;QACJ,OAAO,EAAE;YACP,IAAI,EAAE,WAAW;YACjB,IAAI,EAAE;gBACJ,MAAM;gBACN,GAAG,IAAI;aACR;SACF;KACF,CAAC;AACJ,CAAC","sourcesContent":["import { PERPS_CONSTANTS } from '../constants/perpsConfig.js';\nimport type { PerpsLogger } from '../types/index.js';\n\nexport const PERPS_ERROR_OPERATION = {\n  ConnectionManagement: 'connection_management',\n  OrderManagement: 'order_management',\n  PositionManagement: 'position_management',\n  FinancialOperations: 'financial_operations',\n} as const;\n\nexport type PerpsErrorOperation =\n  (typeof PERPS_ERROR_OPERATION)[keyof typeof PERPS_ERROR_OPERATION];\n\nexport const PERPS_ERROR_ACTION = {\n  ConnectionConnection: 'connection_connection',\n  FinancialDeposit: 'financial_deposit',\n  FinancialWithdrawal: 'financial_withdrawal',\n  PlaceOrder: 'place_order',\n  EditOrder: 'edit_order',\n  CancelOrder: 'cancel_order',\n  ClosePosition: 'close_position',\n  PositionTpslUpdate: 'position_tpsl_update',\n  UpdateMargin: 'update_margin',\n  FlipPosition: 'flip_position',\n} as const;\n\nexport type PerpsErrorAction =\n  (typeof PERPS_ERROR_ACTION)[keyof typeof PERPS_ERROR_ACTION];\n\nexport const PERPS_ERROR_COMPONENT = {\n  ConnectionManager: 'PerpsConnectionManager',\n} as const;\n\nexport type PerpsErrorComponent =\n  (typeof PERPS_ERROR_COMPONENT)[keyof typeof PERPS_ERROR_COMPONENT];\n\nexport type PerpsErrorTags = {\n  operation: PerpsErrorOperation;\n  action?: PerpsErrorAction;\n  component?: PerpsErrorComponent;\n};\n\nexport type PerpsLoggerOptions = NonNullable<\n  Parameters<PerpsLogger['error']>[1]\n>;\n\nconst PROVIDER_ERROR_REPORTED = Symbol('providerErrorReported');\n\ntype ProviderErrorReported = {\n  [PROVIDER_ERROR_REPORTED]?: true;\n};\n\n/**\n * Mark a failed provider result whose underlying error was already reported.\n *\n * The symbol remains internal to Core and survives object spreads used by the\n * aggregated provider without adding a consumer-facing result field.\n *\n * @param result - Provider result to mark.\n * @returns The same result with internal reporting metadata.\n */\nexport function markProviderErrorReported<Result extends object>(\n  result: Result,\n): Result & ProviderErrorReported {\n  return Object.assign(result, { [PROVIDER_ERROR_REPORTED]: true as const });\n}\n\n/**\n * Check whether a provider already reported the error represented by a result.\n *\n * @param result - Provider result returned to a service.\n * @returns Whether the provider owns reporting for the failure.\n */\nexport function wasProviderErrorReported(result: object): boolean {\n  return (result as ProviderErrorReported)[PROVIDER_ERROR_REPORTED] === true;\n}\n\n/**\n * Build a Perps logger payload with bounded, searchable Sentry tags.\n *\n * Diagnostic data is deliberately kept separate from tags so identifiers,\n * symbols, messages, and method names cannot accidentally create unbounded\n * tag cardinality.\n *\n * @param options - Error context options.\n * @param options.contextName - Stable name for the diagnostic context.\n * @param options.method - Method or boundary where the error occurred.\n * @param options.provider - Optional provider identifier.\n * @param options.network - Optional network environment.\n * @param options.errorTags - Optional bounded dashboard tags.\n * @param options.data - Optional diagnostic data retained in context.\n * @returns Logger options accepted by the platform-provided Perps logger.\n */\nexport function createPerpsErrorContext(options: {\n  contextName: string;\n  method: string;\n  provider?: string;\n  network?: 'mainnet' | 'testnet';\n  errorTags?: PerpsErrorTags;\n  data?: Record<string, unknown>;\n}): PerpsLoggerOptions {\n  const { contextName, method, provider, network, errorTags, data } = options;\n  const tags: Record<string, string | number> = {\n    feature: PERPS_CONSTANTS.FeatureName,\n  };\n\n  if (provider !== undefined) {\n    tags.provider = provider;\n  }\n  if (network !== undefined) {\n    tags.network = network;\n  }\n  if (errorTags !== undefined) {\n    tags.operation = errorTags.operation;\n    if (errorTags.action !== undefined) {\n      tags.action = errorTags.action;\n    }\n    if (errorTags.component !== undefined) {\n      tags.component = errorTags.component;\n    }\n  }\n\n  return {\n    tags,\n    context: {\n      name: contextName,\n      data: {\n        method,\n        ...data,\n      },\n    },\n  };\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask-previews/perps-controller",
-  "version": "20.0.0-preview-44b7ded21",
+  "version": "20.0.0-preview-2750df1dc",
   "description": "Controller for perpetual trading functionality in MetaMask",
   "keywords": [
     "Ethereum",