@metamask-previews/perps-controller 0.0.0-preview-ae46ab603 → 0.0.0-preview-e4aa1532

package/dist/services/ServiceContext.d.mts

@@ -0,0 +1,110 @@
+import type { PerpsControllerMessenger } from "../PerpsController.mjs";
+import type { Order, Position } from "../types/index.mjs";
+import type { TransactionRecord, LastTransactionResult } from "../types/transactionTypes.mjs";
+/**
+ * State interface for service state management.
+ * Uses generic state shape to decouple from specific PerpsControllerState definition.
+ */
+type ServiceState = {
+    lastUpdateTimestamp?: number;
+    lastError?: string | null;
+    accountState?: unknown;
+    withdrawInProgress?: boolean;
+    depositInProgress?: boolean;
+    lastWithdrawResult?: LastTransactionResult | null;
+    lastDepositResult?: LastTransactionResult | null;
+    withdrawalRequests: TransactionRecord[];
+    depositRequests: TransactionRecord[];
+    [key: string]: unknown;
+};
+/**
+ * ServiceContext
+ *
+ * Lightweight per-call context for Perps services.
+ * Contains ONLY data that varies per operation:
+ * - Tracing context (provider, network)
+ * - Error context (controller, method)
+ * - State management callbacks
+ * - Query/action callbacks specific to the operation
+ *
+ * Platform dependencies (logging, metrics, tracing) are injected into service
+ * instances via constructor, not passed per-call.
+ *
+ * Controller-level singletons (RewardsController, NetworkController, messenger)
+ * are also injected into services that need them, not passed per-call.
+ *
+ * This enables:
+ * - Clean method signatures (no verbose dependency passing)
+ * - Fat services with complete orchestration
+ * - Thin controller with pure delegation
+ * - Easy testing through mock contexts and constructor injection
+ */
+export type ServiceContext = {
+    /**
+     * Tracing context for performance monitoring
+     * Used in trace() calls to tag operations
+     */
+    tracingContext: {
+        provider: string;
+        isTestnet: boolean;
+    };
+    /**
+     * Error logging context
+     * Provides consistent error logging across services
+     */
+    errorContext: {
+        controller: string;
+        method: string;
+        extra?: Record<string, unknown>;
+    };
+    /**
+     * State management functions (optional)
+     * Only provided for operations that need to mutate controller state
+     * Example: Trading operations that update lastTransaction
+     */
+    stateManager?: {
+        update: (updater: (state: ServiceState) => void) => void;
+        getState: () => ServiceState;
+    };
+    /**
+     * Messenger for controller communication (optional)
+     * Required by: DataLakeService (getBearerToken)
+     * Note: TradingService now receives this via setControllerDependencies()
+     */
+    messenger?: PerpsControllerMessenger;
+    /**
+     * Query functions for dependent data
+     * Required by: Operations that need to fetch related data
+     */
+    getOpenOrders?: () => Promise<Order[]>;
+    getPositions?: () => Promise<Position[]>;
+    /**
+     * Callback functions for controller-specific operations
+     */
+    saveTradeConfiguration?: (symbol: string, leverage: number) => void;
+    /**
+     * Feature flag configuration callbacks
+     * Required by: FeatureFlagConfigurationService
+     */
+    getBlockedRegionList?: () => {
+        list: string[];
+        source: 'remote' | 'fallback';
+    };
+    setBlockedRegionList?: (list: string[], source: 'remote' | 'fallback') => void;
+    getHip3Config?: () => {
+        enabled: boolean;
+        allowlistMarkets: string[];
+        blocklistMarkets: string[];
+        source: 'remote' | 'fallback';
+    };
+    setHip3Config?: (config: {
+        enabled?: boolean;
+        allowlistMarkets?: string[];
+        blocklistMarkets?: string[];
+        source: 'remote' | 'fallback';
+    }) => void;
+    incrementHip3ConfigVersion?: () => number;
+    refreshEligibility?: () => Promise<void>;
+};
+export {};
+//# sourceMappingURL=ServiceContext.d.mts.map

package/dist/services/ServiceContext.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ServiceContext.d.mts","sourceRoot":"","sources":["../../src/services/ServiceContext.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,+BAA2B;AACnE,OAAO,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,2BAAiB;AAChD,OAAO,KAAK,EACV,iBAAiB,EACjB,qBAAqB,EACtB,sCAAkC;AAEnC;;;GAGG;AACH,KAAK,YAAY,GAAG;IAClB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,kBAAkB,CAAC,EAAE,qBAAqB,GAAG,IAAI,CAAC;IAClD,iBAAiB,CAAC,EAAE,qBAAqB,GAAG,IAAI,CAAC;IACjD,kBAAkB,EAAE,iBAAiB,EAAE,CAAC;IACxC,eAAe,EAAE,iBAAiB,EAAE,CAAC;IACrC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;;OAGG;IACH,cAAc,EAAE;QACd,QAAQ,EAAE,MAAM,CAAC;QACjB,SAAS,EAAE,OAAO,CAAC;KACpB,CAAC;IAEF;;;OAGG;IACH,YAAY,EAAE;QACZ,UAAU,EAAE,MAAM,CAAC;QACnB,MAAM,EAAE,MAAM,CAAC;QACf,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACjC,CAAC;IAEF;;;;OAIG;IACH,YAAY,CAAC,EAAE;QACb,MAAM,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,YAAY,KAAK,IAAI,KAAK,IAAI,CAAC;QACzD,QAAQ,EAAE,MAAM,YAAY,CAAC;KAC9B,CAAC;IAEF;;;;OAIG;IACH,SAAS,CAAC,EAAE,wBAAwB,CAAC;IAErC;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC;IACvC,YAAY,CAAC,EAAE,MAAM,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;IAEzC;;OAEG;IACH,sBAAsB,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAC;IAEpE;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM;QAC3B,IAAI,EAAE,MAAM,EAAE,CAAC;QACf,MAAM,EAAE,QAAQ,GAAG,UAAU,CAAC;KAC/B,CAAC;IACF,oBAAoB,CAAC,EAAE,CACrB,IAAI,EAAE,MAAM,EAAE,EACd,MAAM,EAAE,QAAQ,GAAG,UAAU,KAC1B,IAAI,CAAC;IACV,aAAa,CAAC,EAAE,MAAM;QACpB,OAAO,EAAE,OAAO,CAAC;QACjB,gBAAgB,EAAE,MAAM,EAAE,CAAC;QAC3B,gBAAgB,EAAE,MAAM,EAAE,CAAC;QAC3B,MAAM,EAAE,QAAQ,GAAG,UAAU,CAAC;KAC/B,CAAC;IACF,aAAa,CAAC,EAAE,CAAC,MAAM,EAAE;QACvB,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;QAC5B,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;QAC5B,MAAM,EAAE,QAAQ,GAAG,UAAU,CAAC;KAC/B,KAAK,IAAI,CAAC;IACX,0BAA0B,CAAC,EAAE,MAAM,MAAM,CAAC;IAC1C,kBAAkB,CAAC,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CAC1C,CAAC"}

package/dist/services/ServiceContext.mjs

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ServiceContext.mjs.map

package/dist/services/ServiceContext.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"ServiceContext.mjs","sourceRoot":"","sources":["../../src/services/ServiceContext.ts"],"names":[],"mappings":"","sourcesContent":["import type { PerpsControllerMessenger } from '../PerpsController';\nimport type { Order, Position } from '../types';\nimport type {\n  TransactionRecord,\n  LastTransactionResult,\n} from '../types/transactionTypes';\n\n/**\n * State interface for service state management.\n * Uses generic state shape to decouple from specific PerpsControllerState definition.\n */\ntype ServiceState = {\n  lastUpdateTimestamp?: number;\n  lastError?: string | null;\n  accountState?: unknown;\n  withdrawInProgress?: boolean;\n  depositInProgress?: boolean;\n  lastWithdrawResult?: LastTransactionResult | null;\n  lastDepositResult?: LastTransactionResult | null;\n  withdrawalRequests: TransactionRecord[];\n  depositRequests: TransactionRecord[];\n  [key: string]: unknown;\n};\n\n/**\n * ServiceContext\n *\n * Lightweight per-call context for Perps services.\n * Contains ONLY data that varies per operation:\n * - Tracing context (provider, network)\n * - Error context (controller, method)\n * - State management callbacks\n * - Query/action callbacks specific to the operation\n *\n * Platform dependencies (logging, metrics, tracing) are injected into service\n * instances via constructor, not passed per-call.\n *\n * Controller-level singletons (RewardsController, NetworkController, messenger)\n * are also injected into services that need them, not passed per-call.\n *\n * This enables:\n * - Clean method signatures (no verbose dependency passing)\n * - Fat services with complete orchestration\n * - Thin controller with pure delegation\n * - Easy testing through mock contexts and constructor injection\n */\nexport type ServiceContext = {\n  /**\n   * Tracing context for performance monitoring\n   * Used in trace() calls to tag operations\n   */\n  tracingContext: {\n    provider: string;\n    isTestnet: boolean;\n  };\n\n  /**\n   * Error logging context\n   * Provides consistent error logging across services\n   */\n  errorContext: {\n    controller: string;\n    method: string;\n    extra?: Record<string, unknown>;\n  };\n\n  /**\n   * State management functions (optional)\n   * Only provided for operations that need to mutate controller state\n   * Example: Trading operations that update lastTransaction\n   */\n  stateManager?: {\n    update: (updater: (state: ServiceState) => void) => void;\n    getState: () => ServiceState;\n  };\n\n  /**\n   * Messenger for controller communication (optional)\n   * Required by: DataLakeService (getBearerToken)\n   * Note: TradingService now receives this via setControllerDependencies()\n   */\n  messenger?: PerpsControllerMessenger;\n\n  /**\n   * Query functions for dependent data\n   * Required by: Operations that need to fetch related data\n   */\n  getOpenOrders?: () => Promise<Order[]>;\n  getPositions?: () => Promise<Position[]>;\n\n  /**\n   * Callback functions for controller-specific operations\n   */\n  saveTradeConfiguration?: (symbol: string, leverage: number) => void;\n\n  /**\n   * Feature flag configuration callbacks\n   * Required by: FeatureFlagConfigurationService\n   */\n  getBlockedRegionList?: () => {\n    list: string[];\n    source: 'remote' | 'fallback';\n  };\n  setBlockedRegionList?: (\n    list: string[],\n    source: 'remote' | 'fallback',\n  ) => void;\n  getHip3Config?: () => {\n    enabled: boolean;\n    allowlistMarkets: string[];\n    blocklistMarkets: string[];\n    source: 'remote' | 'fallback';\n  };\n  setHip3Config?: (config: {\n    enabled?: boolean;\n    allowlistMarkets?: string[];\n    blocklistMarkets?: string[];\n    source: 'remote' | 'fallback';\n  }) => void;\n  incrementHip3ConfigVersion?: () => number;\n  refreshEligibility?: () => Promise<void>;\n};\n"]}