@metamask-previews/perps-controller 0.0.0-preview-685dbf46b → 1.0.0-preview-bc00f2c

package/dist/services/MarketDataService.d.mts

@@ -0,0 +1,291 @@
+import type { ServiceContext } from "./ServiceContext.mjs";
+import type { CandlePeriod } from "../constants/chartConfig.mjs";
+import type { PerpsProvider, Position, GetPositionsParams, AccountState, GetAccountStateParams, HistoricalPortfolioResult, GetHistoricalPortfolioParams, OrderFill, GetOrderFillsParams, Funding, GetFundingParams, Order, GetOrdersParams, MarketInfo, GetMarketsParams, GetAvailableDexsParams, LiquidationPriceParams, MaintenanceMarginParams, FeeCalculationParams, FeeCalculationResult, OrderParams, ClosePositionParams, AssetRoute, PerpsPlatformDependencies } from "../types/index.mjs";
+import type { CandleData } from "../types/perps-types.mjs";
+/**
+ * MarketDataService
+ *
+ * Handles all read-only data-fetching operations for the Perps controller.
+ * This service is stateless and delegates to the provider.
+ * The controller is responsible for tracing and state management.
+ *
+ * Instance-based service with constructor injection of platform dependencies.
+ */
+export declare class MarketDataService {
+    #private;
+    /**
+     * Create a new MarketDataService instance
+     *
+     * @param deps - Platform dependencies for logging, metrics, etc.
+     */
+    constructor(deps: PerpsPlatformDependencies);
+    /**
+     * Get current positions
+     * Handles full orchestration: tracing, error logging, state management, and provider delegation
+     *
+     * @param options - The configuration options.
+     * @param options.provider - The perps provider instance.
+     * @param options.params - The operation parameters.
+     * @param options.context - The service context for dependencies.
+     * @returns The result of the operation.
+     */
+    getPositions(options: {
+        provider: PerpsProvider;
+        params?: GetPositionsParams;
+        context: ServiceContext;
+    }): Promise<Position[]>;
+    /**
+     * Get order fills for a specific user or order
+     * Handles full orchestration: tracing, error logging, and provider delegation
+     *
+     * @param options - The configuration options.
+     * @param options.provider - The perps provider instance.
+     * @param options.params - The operation parameters.
+     * @param options.context - The service context for dependencies.
+     * @returns The result of the operation.
+     */
+    getOrderFills(options: {
+        provider: PerpsProvider;
+        params?: GetOrderFillsParams;
+        context: ServiceContext;
+    }): Promise<OrderFill[]>;
+    /**
+     * Get historical user orders (order lifecycle)
+     * Handles full orchestration: tracing, error logging, and provider delegation
+     *
+     * @param options - The configuration options.
+     * @param options.provider - The perps provider instance.
+     * @param options.params - The operation parameters.
+     * @param options.context - The service context for dependencies.
+     * @returns The result of the operation.
+     */
+    getOrders(options: {
+        provider: PerpsProvider;
+        params?: GetOrdersParams;
+        context: ServiceContext;
+    }): Promise<Order[]>;
+    /**
+     * Get current open orders
+     * Handles full orchestration: tracing, error logging, performance measurement, and provider delegation
+     *
+     * @param options - The configuration options.
+     * @param options.provider - The perps provider instance.
+     * @param options.params - The operation parameters.
+     * @param options.context - The service context for dependencies.
+     * @returns The result of the operation.
+     */
+    getOpenOrders(options: {
+        provider: PerpsProvider;
+        params?: GetOrdersParams;
+        context: ServiceContext;
+    }): Promise<Order[]>;
+    /**
+     * Get funding rates
+     * Handles full orchestration: tracing, error logging, and provider delegation
+     *
+     * @param options - The configuration options.
+     * @param options.provider - The perps provider instance.
+     * @param options.params - The operation parameters.
+     * @param options.context - The service context for dependencies.
+     * @returns The result of the operation.
+     */
+    getFunding(options: {
+        provider: PerpsProvider;
+        params?: GetFundingParams;
+        context: ServiceContext;
+    }): Promise<Funding[]>;
+    /**
+     * Get account state
+     * Handles full orchestration: tracing, error logging, state management, and provider delegation
+     *
+     * @param options - The configuration options.
+     * @param options.provider - The perps provider instance.
+     * @param options.params - The operation parameters.
+     * @param options.context - The service context for dependencies.
+     * @returns The result of the operation.
+     */
+    getAccountState(options: {
+        provider: PerpsProvider;
+        params?: GetAccountStateParams;
+        context: ServiceContext;
+    }): Promise<AccountState>;
+    /**
+     * Get historical portfolio data
+     * Handles full orchestration: tracing, error logging, state management, and provider delegation
+     *
+     * @param options - The configuration options.
+     * @param options.provider - The perps provider instance.
+     * @param options.params - The operation parameters.
+     * @param options.context - The service context for dependencies.
+     * @returns The result of the operation.
+     */
+    getHistoricalPortfolio(options: {
+        provider: PerpsProvider;
+        params?: GetHistoricalPortfolioParams;
+        context: ServiceContext;
+    }): Promise<HistoricalPortfolioResult>;
+    /**
+     * Get available markets
+     * Handles full orchestration: tracing, error logging, state management, and provider delegation
+     *
+     * @param options - The configuration options.
+     * @param options.provider - The perps provider instance.
+     * @param options.params - The operation parameters.
+     * @param options.context - The service context for dependencies.
+     * @returns The result of the operation.
+     */
+    getMarkets(options: {
+        provider: PerpsProvider;
+        params?: GetMarketsParams;
+        context: ServiceContext;
+    }): Promise<MarketInfo[]>;
+    /**
+     * Get available DEXs (HIP-3 support required)
+     *
+     * @param options - The configuration options.
+     * @param options.provider - The perps provider instance.
+     * @param options.params - The operation parameters.
+     * @param options.context - The service context for dependencies.
+     * @returns The result of the operation.
+     */
+    getAvailableDexs(options: {
+        provider: PerpsProvider;
+        params?: GetAvailableDexsParams;
+        context: ServiceContext;
+    }): Promise<string[]>;
+    /**
+     * Fetch historical candle data for charting
+     * Handles full orchestration: tracing, error logging, state management, and provider delegation
+     *
+     * @param options - The configuration options.
+     * @param options.provider - The perps provider instance.
+     * @param options.symbol - The trading pair symbol.
+     * @param options.interval - The candle interval period.
+     * @param options.limit - Maximum number of items to fetch.
+     * @param options.endTime - End timestamp in milliseconds.
+     * @param options.context - The service context for dependencies.
+     * @returns The result of the operation.
+     */
+    fetchHistoricalCandles(options: {
+        provider: PerpsProvider;
+        symbol: string;
+        interval: CandlePeriod;
+        limit?: number;
+        endTime?: number;
+        context: ServiceContext;
+    }): Promise<CandleData>;
+    /**
+     * Calculate liquidation price for a position
+     *
+     * @param options - The configuration options.
+     * @param options.provider - The perps provider instance.
+     * @param options.params - The operation parameters.
+     * @param options.context - The service context for dependencies.
+     * @returns The result of the operation.
+     */
+    calculateLiquidationPrice(options: {
+        provider: PerpsProvider;
+        params: LiquidationPriceParams;
+        context: ServiceContext;
+    }): Promise<string>;
+    /**
+     * Calculate maintenance margin for a position
+     *
+     * @param options - The configuration options.
+     * @param options.provider - The perps provider instance.
+     * @param options.params - The operation parameters.
+     * @param options.context - The service context for dependencies.
+     * @returns The result of the operation.
+     */
+    calculateMaintenanceMargin(options: {
+        provider: PerpsProvider;
+        params: MaintenanceMarginParams;
+        context: ServiceContext;
+    }): Promise<number>;
+    /**
+     * Get maximum leverage for an asset
+     *
+     * @param options - The configuration options.
+     * @param options.provider - The perps provider instance.
+     * @param options.asset - The asset identifier.
+     * @param options.context - The service context for dependencies.
+     * @returns The result of the operation.
+     */
+    getMaxLeverage(options: {
+        provider: PerpsProvider;
+        asset: string;
+        context: ServiceContext;
+    }): Promise<number>;
+    /**
+     * Calculate fees for an order
+     *
+     * @param options - The configuration options.
+     * @param options.provider - The perps provider instance.
+     * @param options.params - The operation parameters.
+     * @param options.context - The service context for dependencies.
+     * @returns The result of the operation.
+     */
+    calculateFees(options: {
+        provider: PerpsProvider;
+        params: FeeCalculationParams;
+        context: ServiceContext;
+    }): Promise<FeeCalculationResult>;
+    /**
+     * Validate an order before placement
+     *
+     * @param options - The configuration options.
+     * @param options.provider - The perps provider instance.
+     * @param options.params - The operation parameters.
+     * @param options.context - The service context for dependencies.
+     * @returns The result of the operation.
+     */
+    validateOrder(options: {
+        provider: PerpsProvider;
+        params: OrderParams;
+        context: ServiceContext;
+    }): Promise<{
+        isValid: boolean;
+        error?: string;
+    }>;
+    /**
+     * Validate a position close request
+     *
+     * @param options - The configuration options.
+     * @param options.provider - The perps provider instance.
+     * @param options.params - The operation parameters.
+     * @param options.context - The service context for dependencies.
+     * @returns The result of the operation.
+     */
+    validateClosePosition(options: {
+        provider: PerpsProvider;
+        params: ClosePositionParams;
+        context: ServiceContext;
+    }): Promise<{
+        isValid: boolean;
+        error?: string;
+    }>;
+    /**
+     * Get supported withdrawal routes (synchronous)
+     * Note: This method doesn't log errors to avoid needing context for a synchronous getter
+     *
+     * @param options - The configuration options.
+     * @param options.provider - The perps provider instance.
+     * @returns The result of the operation.
+     */
+    getWithdrawalRoutes(options: {
+        provider: PerpsProvider;
+    }): AssetRoute[];
+    /**
+     * Get block explorer URL (synchronous)
+     *
+     * @param options - The configuration options.
+     * @param options.provider - The perps provider instance.
+     * @param options.address - The wallet address.
+     * @returns The result of the operation.
+     */
+    getBlockExplorerUrl(options: {
+        provider: PerpsProvider;
+        address?: string;
+    }): string;
+}
+//# sourceMappingURL=MarketDataService.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"MarketDataService.d.mts","sourceRoot":"","sources":["../../src/services/MarketDataService.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,cAAc,EAAE,6BAAyB;AACvD,OAAO,KAAK,EAAE,YAAY,EAAE,qCAAiC;AAK7D,OAAO,KAAK,EACV,aAAa,EACb,QAAQ,EACR,kBAAkB,EAClB,YAAY,EACZ,qBAAqB,EACrB,yBAAyB,EACzB,4BAA4B,EAC5B,SAAS,EACT,mBAAmB,EACnB,OAAO,EACP,gBAAgB,EAChB,KAAK,EACL,eAAe,EACf,UAAU,EACV,gBAAgB,EAChB,sBAAsB,EACtB,sBAAsB,EACtB,uBAAuB,EACvB,oBAAoB,EACpB,oBAAoB,EACpB,WAAW,EACX,mBAAmB,EACnB,UAAU,EACV,yBAAyB,EAC1B,2BAAiB;AAClB,OAAO,KAAK,EAAE,UAAU,EAAE,iCAA6B;AAGvD;;;;;;;;GAQG;AACH,qBAAa,iBAAiB;;IAG5B;;;;OAIG;gBACS,IAAI,EAAE,yBAAyB;IAI3C;;;;;;;;;OASG;IACG,YAAY,CAAC,OAAO,EAAE;QAC1B,QAAQ,EAAE,aAAa,CAAC;QACxB,MAAM,CAAC,EAAE,kBAAkB,CAAC;QAC5B,OAAO,EAAE,cAAc,CAAC;KACzB,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IAyDvB;;;;;;;;;OASG;IACG,aAAa,CAAC,OAAO,EAAE;QAC3B,QAAQ,EAAE,aAAa,CAAC;QACxB,MAAM,CAAC,EAAE,mBAAmB,CAAC;QAC7B,OAAO,EAAE,cAAc,CAAC;KACzB,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IAqDxB;;;;;;;;;OASG;IACG,SAAS,CAAC,OAAO,EAAE;QACvB,QAAQ,EAAE,aAAa,CAAC;QACxB,MAAM,CAAC,EAAE,eAAe,CAAC;QACzB,OAAO,EAAE,cAAc,CAAC;KACzB,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;IAqDpB;;;;;;;;;OASG;IACG,aAAa,CAAC,OAAO,EAAE;QAC3B,QAAQ,EAAE,aAAa,CAAC;QACxB,MAAM,CAAC,EAAE,eAAe,CAAC;QACzB,OAAO,EAAE,cAAc,CAAC;KACzB,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;IA6DpB;;;;;;;;;OASG;IACG,UAAU,CAAC,OAAO,EAAE;QACxB,QAAQ,EAAE,aAAa,CAAC;QACxB,MAAM,CAAC,EAAE,gBAAgB,CAAC;QAC1B,OAAO,EAAE,cAAc,CAAC;KACzB,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAqDtB;;;;;;;;;OASG;IACG,eAAe,CAAC,OAAO,EAAE;QAC7B,QAAQ,EAAE,aAAa,CAAC;QACxB,MAAM,CAAC,EAAE,qBAAqB,CAAC;QAC/B,OAAO,EAAE,cAAc,CAAC;KACzB,GAAG,OAAO,CAAC,YAAY,CAAC;IAoFzB;;;;;;;;;OASG;IACG,sBAAsB,CAAC,OAAO,EAAE;QACpC,QAAQ,EAAE,aAAa,CAAC;QACxB,MAAM,CAAC,EAAE,4BAA4B,CAAC;QACtC,OAAO,EAAE,cAAc,CAAC;KACzB,GAAG,OAAO,CAAC,yBAAyB,CAAC;IAuEtC;;;;;;;;;OASG;IACG,UAAU,CAAC,OAAO,EAAE;QACxB,QAAQ,EAAE,aAAa,CAAC;QACxB,MAAM,CAAC,EAAE,gBAAgB,CAAC;QAC1B,OAAO,EAAE,cAAc,CAAC;KACzB,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;IA+EzB;;;;;;;;OAQG;IACG,gBAAgB,CAAC,OAAO,EAAE;QAC9B,QAAQ,EAAE,aAAa,CAAC;QACxB,MAAM,CAAC,EAAE,sBAAsB,CAAC;QAChC,OAAO,EAAE,cAAc,CAAC;KACzB,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAuBrB;;;;;;;;;;;;OAYG;IACG,sBAAsB,CAAC,OAAO,EAAE;QACpC,QAAQ,EAAE,aAAa,CAAC;QACxB,MAAM,EAAE,MAAM,CAAC;QACf,QAAQ,EAAE,YAAY,CAAC;QACvB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,OAAO,EAAE,cAAc,CAAC;KACzB,GAAG,OAAO,CAAC,UAAU,CAAC;IAoGvB;;;;;;;;OAQG;IACG,yBAAyB,CAAC,OAAO,EAAE;QACvC,QAAQ,EAAE,aAAa,CAAC;QACxB,MAAM,EAAE,sBAAsB,CAAC;QAC/B,OAAO,EAAE,cAAc,CAAC;KACzB,GAAG,OAAO,CAAC,MAAM,CAAC;IAmBnB;;;;;;;;OAQG;IACG,0BAA0B,CAAC,OAAO,EAAE;QACxC,QAAQ,EAAE,aAAa,CAAC;QACxB,MAAM,EAAE,uBAAuB,CAAC;QAChC,OAAO,EAAE,cAAc,CAAC;KACzB,GAAG,OAAO,CAAC,MAAM,CAAC;IAmBnB;;;;;;;;OAQG;IACG,cAAc,CAAC,OAAO,EAAE;QAC5B,QAAQ,EAAE,aAAa,CAAC;QACxB,KAAK,EAAE,MAAM,CAAC;QACd,OAAO,EAAE,cAAc,CAAC;KACzB,GAAG,OAAO,CAAC,MAAM,CAAC;IAmBnB;;;;;;;;OAQG;IACG,aAAa,CAAC,OAAO,EAAE;QAC3B,QAAQ,EAAE,aAAa,CAAC;QACxB,MAAM,EAAE,oBAAoB,CAAC;QAC7B,OAAO,EAAE,cAAc,CAAC;KACzB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAmBjC;;;;;;;;OAQG;IACG,aAAa,CAAC,OAAO,EAAE;QAC3B,QAAQ,EAAE,aAAa,CAAC;QACxB,MAAM,EAAE,WAAW,CAAC;QACpB,OAAO,EAAE,cAAc,CAAC;KACzB,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAmBjD;;;;;;;;OAQG;IACG,qBAAqB,CAAC,OAAO,EAAE;QACnC,QAAQ,EAAE,aAAa,CAAC;QACxB,MAAM,EAAE,mBAAmB,CAAC;QAC5B,OAAO,EAAE,cAAc,CAAC;KACzB,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAmBjD;;;;;;;OAOG;IACH,mBAAmB,CAAC,OAAO,EAAE;QAAE,QAAQ,EAAE,aAAa,CAAA;KAAE,GAAG,UAAU,EAAE;IAWvE;;;;;;;OAOG;IACH,mBAAmB,CAAC,OAAO,EAAE;QAC3B,QAAQ,EAAE,aAAa,CAAC;QACxB,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,GAAG,MAAM;CAIX"}