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

package/dist/services/MarketDataService.d.mts

@@ -0,0 +1,289 @@
+import type { ServiceContext } from "./ServiceContext.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, CandleData, CandlePeriod } from "../types/index.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 readonly deps;
+    /**
+     * 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 - Options for getting positions
+     * @param options.provider - The perps provider
+     * @param options.params - Optional parameters for the request
+     * @param options.context - Service context for tracing and state management
+     * @returns Array of positions
+     */
+    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 - Options for getting order fills
+     * @param options.provider - The perps provider
+     * @param options.params - Optional parameters for the request
+     * @param options.context - Service context for tracing
+     * @returns Array of order fills
+     */
+    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 - Options for getting orders
+     * @param options.provider - The perps provider
+     * @param options.params - Optional parameters for the request
+     * @param options.context - Service context for tracing
+     * @returns Array of orders
+     */
+    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 - Options for getting open orders
+     * @param options.provider - The perps provider
+     * @param options.params - Optional parameters for the request
+     * @param options.context - Service context for tracing
+     * @returns Array of open orders
+     */
+    getOpenOrders(options: {
+        provider: PerpsProvider;
+        params?: GetOrdersParams;
+        context: ServiceContext;
+    }): Promise<Order[]>;
+    /**
+     * Get funding rates.
+     * Handles full orchestration: tracing, error logging, and provider delegation.
+     *
+     * @param options - Options for getting funding
+     * @param options.provider - The perps provider
+     * @param options.params - Optional parameters for the request
+     * @param options.context - Service context for tracing
+     * @returns Array of funding entries
+     */
+    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 - Options for getting account state
+     * @param options.provider - The perps provider
+     * @param options.params - Optional parameters for the request
+     * @param options.context - Service context for tracing and state management
+     * @returns Account state
+     */
+    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 - Options for getting historical portfolio
+     * @param options.provider - The perps provider
+     * @param options.params - Optional parameters for the request
+     * @param options.context - Service context for tracing and state management
+     * @returns Historical portfolio result
+     */
+    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 - Options for getting markets
+     * @param options.provider - The perps provider
+     * @param options.params - Optional parameters for the request
+     * @param options.context - Service context for tracing and state management
+     * @returns Array of market info
+     */
+    getMarkets(options: {
+        provider: PerpsProvider;
+        params?: GetMarketsParams;
+        context: ServiceContext;
+    }): Promise<MarketInfo[]>;
+    /**
+     * Get available DEXs (HIP-3 support required).
+     *
+     * @param options - Options for getting available DEXs
+     * @param options.provider - The perps provider
+     * @param options.params - Optional parameters for the request
+     * @param options.context - Service context for error logging
+     * @returns Array of DEX names
+     */
+    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 - Options for fetching historical candles
+     * @param options.provider - The perps provider
+     * @param options.symbol - The asset symbol
+     * @param options.interval - The candle period
+     * @param options.limit - Maximum number of candles to fetch
+     * @param options.endTime - End time for the candle range
+     * @param options.context - Service context for tracing and state management
+     * @returns Candle data
+     */
+    fetchHistoricalCandles(options: {
+        provider: PerpsProvider;
+        symbol: string;
+        interval: CandlePeriod;
+        limit?: number;
+        endTime?: number;
+        context: ServiceContext;
+    }): Promise<CandleData>;
+    /**
+     * Calculate liquidation price for a position.
+     *
+     * @param options - Options for calculating liquidation price
+     * @param options.provider - The perps provider
+     * @param options.params - Liquidation price parameters
+     * @param options.context - Service context for error logging
+     * @returns Liquidation price as string
+     */
+    calculateLiquidationPrice(options: {
+        provider: PerpsProvider;
+        params: LiquidationPriceParams;
+        context: ServiceContext;
+    }): Promise<string>;
+    /**
+     * Calculate maintenance margin for a position.
+     *
+     * @param options - Options for calculating maintenance margin
+     * @param options.provider - The perps provider
+     * @param options.params - Maintenance margin parameters
+     * @param options.context - Service context for error logging
+     * @returns Maintenance margin as number
+     */
+    calculateMaintenanceMargin(options: {
+        provider: PerpsProvider;
+        params: MaintenanceMarginParams;
+        context: ServiceContext;
+    }): Promise<number>;
+    /**
+     * Get maximum leverage for an asset.
+     *
+     * @param options - Options for getting max leverage
+     * @param options.provider - The perps provider
+     * @param options.asset - The asset symbol
+     * @param options.context - Service context for error logging
+     * @returns Maximum leverage as number
+     */
+    getMaxLeverage(options: {
+        provider: PerpsProvider;
+        asset: string;
+        context: ServiceContext;
+    }): Promise<number>;
+    /**
+     * Calculate fees for an order.
+     *
+     * @param options - Options for calculating fees
+     * @param options.provider - The perps provider
+     * @param options.params - Fee calculation parameters
+     * @param options.context - Service context for error logging
+     * @returns Fee calculation result
+     */
+    calculateFees(options: {
+        provider: PerpsProvider;
+        params: FeeCalculationParams;
+        context: ServiceContext;
+    }): Promise<FeeCalculationResult>;
+    /**
+     * Validate an order before placement.
+     *
+     * @param options - Options for validating order
+     * @param options.provider - The perps provider
+     * @param options.params - Order parameters
+     * @param options.context - Service context for error logging
+     * @returns Validation result
+     */
+    validateOrder(options: {
+        provider: PerpsProvider;
+        params: OrderParams;
+        context: ServiceContext;
+    }): Promise<{
+        isValid: boolean;
+        error?: string;
+    }>;
+    /**
+     * Validate a position close request.
+     *
+     * @param options - Options for validating close position
+     * @param options.provider - The perps provider
+     * @param options.params - Close position parameters
+     * @param options.context - Service context for error logging
+     * @returns Validation result
+     */
+    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 - Options for getting withdrawal routes
+     * @param options.provider - The perps provider
+     * @returns Array of asset routes
+     */
+    getWithdrawalRoutes(options: {
+        provider: PerpsProvider;
+    }): AssetRoute[];
+    /**
+     * Get block explorer URL (synchronous).
+     *
+     * @param options - Options for getting block explorer URL
+     * @param options.provider - The perps provider
+     * @param options.address - Optional address to include in URL
+     * @returns Block explorer URL
+     */
+    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":"AAIA,OAAO,KAAK,EAAE,cAAc,EAAE,6BAAyB;AAGvD,OAAO,KAAK,EAGV,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,EACzB,UAAU,EACV,YAAY,EACb,2BAAiB;AAuClB;;;;;;;;GAQG;AACH,qBAAa,iBAAiB;IAC5B,OAAO,CAAC,QAAQ,CAAC,IAAI,CAA4B;IAEjD;;;;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;IAmDxB;;;;;;;;;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;IAmDpB;;;;;;;;;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;IA2DpB;;;;;;;;;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;IAmDtB;;;;;;;;;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;IAiFzB;;;;;;;;;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;IAqEtC;;;;;;;;;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;IA2EzB;;;;;;;;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;IAqBrB;;;;;;;;;;;;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;IAkGvB;;;;;;;;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;IAiBnB;;;;;;;;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;IAiBnB;;;;;;;;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;IAiBnB;;;;;;;;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;IAiBjC;;;;;;;;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;IAiBjD;;;;;;;;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;IAiBjD;;;;;;;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"}