@pear-protocol/symmio-client 0.1.1 → 0.1.3

package/dist/react/index.d.mts

@@ -1,4 +1,5 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
+import * as viem from 'viem';
 import { Address, Hex, PublicClient, WalletClient } from 'viem';
 import * as _pear_protocol_symm_core from '@pear-protocol/symm-core';
 import { SymmSDK, OpenBasketPositionRequest, ClosePositionRequest, CancelOpenRequest, UpdatePositionRequest, SetTpslRequest, CancelTpslRequest } from '@pear-protocol/symm-core';
@@ -17,8 +18,6 @@ type SymmioSDKConfig = {
     signatureStoreAddress?: Address;
     muonBaseUrls?: string[];
     muonAppName?: string;
-    /** Base URL for the hedger API (required for instant trading). */
-    hedgerBaseUrl?: string;
 };
 declare enum PositionType {
     LONG = 0,
@@ -287,7 +286,6 @@ declare class SymmioSDK {
     private _collateral;
     private _clearingHouse?;
     private _signatureStore?;
-    private _hedgerBaseUrl?;
     constructor(options: {
         chainId: number;
         publicClient: PublicClient;
@@ -375,7 +373,6 @@ declare class SymmioSDK {
         grantRole: (role: Hex, grantee: Address) => Promise<`0x${string}`>;
         revokeRole: (role: Hex, revokee: Address) => Promise<`0x${string}`>;
     };
-    private _requireHedgerUrl;
     get instant(): {
         /** Creates a SIWE message for instant trading authentication. */
         createSiweMessage: (params: CreateSiweMessageParams) => SiweMessageResult;
@@ -401,9 +398,10 @@ type SymmContextValue = {
     symmCoreClient: SymmSDK | null;
     chainId: number;
     address?: `0x${string}`;
+    accessToken: string | null;
     authToken: string | null;
     isReady: boolean;
-    refreshAuth: () => Promise<string | null>;
+    refreshAuth: (accountAddress?: Address) => Promise<string | null>;
 };
 declare function useSymmContext(): SymmContextValue;
 
@@ -412,9 +410,10 @@ declare function useSymmioClient(): SymmioSDK | null;
 declare function useSymmCoreClient(): SymmSDK | null;
 
 declare function useSymmAuth(): {
+    accessToken: string | null;
     authToken: string | null;
     isAuthenticated: boolean;
-    refresh: () => Promise<string | null>;
+    refresh: (accountAddress?: viem.Address) => Promise<string | null>;
 };
 
 declare function useSymmAccounts(userAddress?: Address): {
@@ -599,6 +598,125 @@ declare function useSymmWs(params: {
     isConnected: boolean;
 };
 
+interface SymmChartSelectionInput {
+    longSymbol: string | null;
+    shortSymbol: string | null;
+    longWeight?: number;
+    shortWeight?: number;
+    longTokens?: SymmChartTokenSelection[];
+    shortTokens?: SymmChartTokenSelection[];
+}
+interface SymmChartTokenSelection {
+    symbol: string;
+    weight: number;
+}
+interface SymmChartSelection {
+    longTokens: SymmChartTokenSelection[];
+    shortTokens: SymmChartTokenSelection[];
+    isSingleSided: boolean;
+    activeSide: 'long' | 'short' | null;
+    activeTokenSymbol?: string;
+    pairLabel: string;
+    selectedSymbols: string[];
+}
+/**
+ * SYMM chart selection hook. Accepts selection input as parameters
+ * rather than importing app store state, keeping the SDK app-agnostic.
+ */
+declare function useSymmChartSelection(input: SymmChartSelectionInput): SymmChartSelection;
+
+interface SymmTokenMetadata {
+    currentPrice: number;
+    prevDayPrice: number;
+    priceChange24h: number;
+    priceChange24hPercent: number;
+    netFunding: number;
+    markPrice: number;
+}
+interface UseSymmTokenSelectionMetadataReturn {
+    isLoading: boolean;
+    isPriceDataReady: boolean;
+    isUnsupported: boolean;
+    unsupportedSymbols: string[];
+    unavailableReason: string | null;
+    longTokensMetadata: Record<string, SymmTokenMetadata | null>;
+    shortTokensMetadata: Record<string, SymmTokenMetadata | null>;
+    weightedRatio: number;
+    weightedRatio24h: number;
+    priceRatio: number;
+    priceRatio24h: number;
+    sumNetFunding: number;
+}
+/**
+ * Fetches Binance market data for selected SYMM chart tokens and derives
+ * chart header metrics (price ratio, weighted ratio, etc.).
+ */
+declare function useSymmTokenSelectionMetadata(selection: SymmChartSelection): UseSymmTokenSelectionMetadataReturn;
+
+/**
+ * Candle interval type matching the chart system.
+ * Binance USD-M Futures uses the same string format.
+ */
+type CandleInterval = '1m' | '3m' | '5m' | '15m' | '30m' | '1h' | '2h' | '4h' | '8h' | '12h' | '1d' | '3d' | '1w' | '1M';
+
+interface ChartCandleData {
+    s?: string;
+    t: number;
+    T: number;
+    o: number;
+    c: number;
+    h: number;
+    l: number;
+}
+type RealtimeBar = {
+    time: number;
+    open: number;
+    high: number;
+    low: number;
+    close: number;
+    volume?: number;
+};
+type RealtimeBarsCallback = (bar: RealtimeBar) => void;
+interface UseSymmChartCandlesReturn {
+    fetchBasketCandles: (start: number, end: number, interval: CandleInterval) => Promise<ChartCandleData[]>;
+    fetchPerformanceCandles: (start: number, end: number, interval: CandleInterval, symbol: string) => Promise<ChartCandleData[]>;
+    fetchOverallPerformanceCandles: (start: number, end: number, interval: CandleInterval) => Promise<ChartCandleData[]>;
+    addRealtimeListener: (cb: RealtimeBarsCallback) => string;
+    removeRealtimeListener: (id: string) => void;
+    getEffectiveDataBoundary: (interval: CandleInterval) => number | null;
+    isLoading: boolean;
+    isUnsupported: boolean;
+    unsupportedSymbols: string[];
+    unavailableReason: string | null;
+}
+/**
+ * SYMM chart candles hook backed by Binance mark-price klines.
+ * Returns the same interface as the Hyperliquid useBasketCandles hook.
+ *
+ * Realtime updates are provided via Binance kline WebSocket streams.
+ * When listeners are registered, the hook subscribes to kline streams
+ * for all selected symbols and emits computed basket bars.
+ */
+declare function useSymmChartCandles(selection: SymmChartSelection): UseSymmChartCandlesReturn;
+
+interface SymmPerformanceOverlay {
+    id: string;
+    symbol: string;
+    label: string;
+    color: string;
+    enabled: boolean;
+    type: 'asset' | 'portfolio';
+    weight?: number;
+}
+/**
+ * SYMM performance overlay hook. Generates overlay definitions
+ * for each selected SYMM leg, matching the Hyperliquid overlay contract.
+ */
+declare function useSymmPerformanceOverlays(selection: SymmChartSelection): {
+    overlays: SymmPerformanceOverlay[];
+    generateOverlaySymbols: () => string[];
+};
+
 declare const symmKeys: {
     all: readonly ["symm"];
     accounts: (address?: Address) => readonly ["symm", "accounts", `0x${string}` | undefined];
@@ -620,4 +738,4 @@ declare const symmKeys: {
 
 declare function getSymmErrorMessage(error: unknown): string;
 
-export { type SymmContextValue, SymmProvider, type SymmProviderProps, getSymmErrorMessage, symmKeys, useSymmAccounts, useSymmApproval, useSymmAuth, useSymmBalances, useSymmCollateral, useSymmContext, useSymmCoreClient, useSymmDeposit, useSymmFunding, useSymmMarkets, useSymmNotifications, useSymmOpenOrders, useSymmPortfolio, useSymmPositions, useSymmSignature, useSymmTpsl, useSymmTrade, useSymmTradeHistory, useSymmTwap, useSymmWithdraw, useSymmWs, useSymmioClient };
+export { type SymmChartSelection, type SymmChartSelectionInput, type SymmChartTokenSelection, type SymmContextValue, type SymmPerformanceOverlay, SymmProvider, type SymmProviderProps, type SymmTokenMetadata, type UseSymmChartCandlesReturn, type UseSymmTokenSelectionMetadataReturn, getSymmErrorMessage, symmKeys, useSymmAccounts, useSymmApproval, useSymmAuth, useSymmBalances, useSymmChartCandles, useSymmChartSelection, useSymmCollateral, useSymmContext, useSymmCoreClient, useSymmDeposit, useSymmFunding, useSymmMarkets, useSymmNotifications, useSymmOpenOrders, useSymmPerformanceOverlays, useSymmPortfolio, useSymmPositions, useSymmSignature, useSymmTokenSelectionMetadata, useSymmTpsl, useSymmTrade, useSymmTradeHistory, useSymmTwap, useSymmWithdraw, useSymmWs, useSymmioClient };

package/dist/react/index.d.ts

@@ -1,4 +1,5 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
+import * as viem from 'viem';
 import { Address, Hex, PublicClient, WalletClient } from 'viem';
 import * as _pear_protocol_symm_core from '@pear-protocol/symm-core';
 import { SymmSDK, OpenBasketPositionRequest, ClosePositionRequest, CancelOpenRequest, UpdatePositionRequest, SetTpslRequest, CancelTpslRequest } from '@pear-protocol/symm-core';
@@ -17,8 +18,6 @@ type SymmioSDKConfig = {
     signatureStoreAddress?: Address;
     muonBaseUrls?: string[];
     muonAppName?: string;
-    /** Base URL for the hedger API (required for instant trading). */
-    hedgerBaseUrl?: string;
 };
 declare enum PositionType {
     LONG = 0,
@@ -287,7 +286,6 @@ declare class SymmioSDK {
     private _collateral;
     private _clearingHouse?;
     private _signatureStore?;
-    private _hedgerBaseUrl?;
     constructor(options: {
         chainId: number;
         publicClient: PublicClient;
@@ -375,7 +373,6 @@ declare class SymmioSDK {
         grantRole: (role: Hex, grantee: Address) => Promise<`0x${string}`>;
         revokeRole: (role: Hex, revokee: Address) => Promise<`0x${string}`>;
     };
-    private _requireHedgerUrl;
     get instant(): {
         /** Creates a SIWE message for instant trading authentication. */
         createSiweMessage: (params: CreateSiweMessageParams) => SiweMessageResult;
@@ -401,9 +398,10 @@ type SymmContextValue = {
     symmCoreClient: SymmSDK | null;
     chainId: number;
     address?: `0x${string}`;
+    accessToken: string | null;
     authToken: string | null;
     isReady: boolean;
-    refreshAuth: () => Promise<string | null>;
+    refreshAuth: (accountAddress?: Address) => Promise<string | null>;
 };
 declare function useSymmContext(): SymmContextValue;
 
@@ -412,9 +410,10 @@ declare function useSymmioClient(): SymmioSDK | null;
 declare function useSymmCoreClient(): SymmSDK | null;
 
 declare function useSymmAuth(): {
+    accessToken: string | null;
     authToken: string | null;
     isAuthenticated: boolean;
-    refresh: () => Promise<string | null>;
+    refresh: (accountAddress?: viem.Address) => Promise<string | null>;
 };
 
 declare function useSymmAccounts(userAddress?: Address): {
@@ -599,6 +598,125 @@ declare function useSymmWs(params: {
     isConnected: boolean;
 };
 
+interface SymmChartSelectionInput {
+    longSymbol: string | null;
+    shortSymbol: string | null;
+    longWeight?: number;
+    shortWeight?: number;
+    longTokens?: SymmChartTokenSelection[];
+    shortTokens?: SymmChartTokenSelection[];
+}
+interface SymmChartTokenSelection {
+    symbol: string;
+    weight: number;
+}
+interface SymmChartSelection {
+    longTokens: SymmChartTokenSelection[];
+    shortTokens: SymmChartTokenSelection[];
+    isSingleSided: boolean;
+    activeSide: 'long' | 'short' | null;
+    activeTokenSymbol?: string;
+    pairLabel: string;
+    selectedSymbols: string[];
+}
+/**
+ * SYMM chart selection hook. Accepts selection input as parameters
+ * rather than importing app store state, keeping the SDK app-agnostic.
+ */
+declare function useSymmChartSelection(input: SymmChartSelectionInput): SymmChartSelection;
+
+interface SymmTokenMetadata {
+    currentPrice: number;
+    prevDayPrice: number;
+    priceChange24h: number;
+    priceChange24hPercent: number;
+    netFunding: number;
+    markPrice: number;
+}
+interface UseSymmTokenSelectionMetadataReturn {
+    isLoading: boolean;
+    isPriceDataReady: boolean;
+    isUnsupported: boolean;
+    unsupportedSymbols: string[];
+    unavailableReason: string | null;
+    longTokensMetadata: Record<string, SymmTokenMetadata | null>;
+    shortTokensMetadata: Record<string, SymmTokenMetadata | null>;
+    weightedRatio: number;
+    weightedRatio24h: number;
+    priceRatio: number;
+    priceRatio24h: number;
+    sumNetFunding: number;
+}
+/**
+ * Fetches Binance market data for selected SYMM chart tokens and derives
+ * chart header metrics (price ratio, weighted ratio, etc.).
+ */
+declare function useSymmTokenSelectionMetadata(selection: SymmChartSelection): UseSymmTokenSelectionMetadataReturn;
+
+/**
+ * Candle interval type matching the chart system.
+ * Binance USD-M Futures uses the same string format.
+ */
+type CandleInterval = '1m' | '3m' | '5m' | '15m' | '30m' | '1h' | '2h' | '4h' | '8h' | '12h' | '1d' | '3d' | '1w' | '1M';
+
+interface ChartCandleData {
+    s?: string;
+    t: number;
+    T: number;
+    o: number;
+    c: number;
+    h: number;
+    l: number;
+}
+type RealtimeBar = {
+    time: number;
+    open: number;
+    high: number;
+    low: number;
+    close: number;
+    volume?: number;
+};
+type RealtimeBarsCallback = (bar: RealtimeBar) => void;
+interface UseSymmChartCandlesReturn {
+    fetchBasketCandles: (start: number, end: number, interval: CandleInterval) => Promise<ChartCandleData[]>;
+    fetchPerformanceCandles: (start: number, end: number, interval: CandleInterval, symbol: string) => Promise<ChartCandleData[]>;
+    fetchOverallPerformanceCandles: (start: number, end: number, interval: CandleInterval) => Promise<ChartCandleData[]>;
+    addRealtimeListener: (cb: RealtimeBarsCallback) => string;
+    removeRealtimeListener: (id: string) => void;
+    getEffectiveDataBoundary: (interval: CandleInterval) => number | null;
+    isLoading: boolean;
+    isUnsupported: boolean;
+    unsupportedSymbols: string[];
+    unavailableReason: string | null;
+}
+/**
+ * SYMM chart candles hook backed by Binance mark-price klines.
+ * Returns the same interface as the Hyperliquid useBasketCandles hook.
+ *
+ * Realtime updates are provided via Binance kline WebSocket streams.
+ * When listeners are registered, the hook subscribes to kline streams
+ * for all selected symbols and emits computed basket bars.
+ */
+declare function useSymmChartCandles(selection: SymmChartSelection): UseSymmChartCandlesReturn;
+
+interface SymmPerformanceOverlay {
+    id: string;
+    symbol: string;
+    label: string;
+    color: string;
+    enabled: boolean;
+    type: 'asset' | 'portfolio';
+    weight?: number;
+}
+/**
+ * SYMM performance overlay hook. Generates overlay definitions
+ * for each selected SYMM leg, matching the Hyperliquid overlay contract.
+ */
+declare function useSymmPerformanceOverlays(selection: SymmChartSelection): {
+    overlays: SymmPerformanceOverlay[];
+    generateOverlaySymbols: () => string[];
+};
+
 declare const symmKeys: {
     all: readonly ["symm"];
     accounts: (address?: Address) => readonly ["symm", "accounts", `0x${string}` | undefined];
@@ -620,4 +738,4 @@ declare const symmKeys: {
 
 declare function getSymmErrorMessage(error: unknown): string;
 
-export { type SymmContextValue, SymmProvider, type SymmProviderProps, getSymmErrorMessage, symmKeys, useSymmAccounts, useSymmApproval, useSymmAuth, useSymmBalances, useSymmCollateral, useSymmContext, useSymmCoreClient, useSymmDeposit, useSymmFunding, useSymmMarkets, useSymmNotifications, useSymmOpenOrders, useSymmPortfolio, useSymmPositions, useSymmSignature, useSymmTpsl, useSymmTrade, useSymmTradeHistory, useSymmTwap, useSymmWithdraw, useSymmWs, useSymmioClient };
+export { type SymmChartSelection, type SymmChartSelectionInput, type SymmChartTokenSelection, type SymmContextValue, type SymmPerformanceOverlay, SymmProvider, type SymmProviderProps, type SymmTokenMetadata, type UseSymmChartCandlesReturn, type UseSymmTokenSelectionMetadataReturn, getSymmErrorMessage, symmKeys, useSymmAccounts, useSymmApproval, useSymmAuth, useSymmBalances, useSymmChartCandles, useSymmChartSelection, useSymmCollateral, useSymmContext, useSymmCoreClient, useSymmDeposit, useSymmFunding, useSymmMarkets, useSymmNotifications, useSymmOpenOrders, useSymmPerformanceOverlays, useSymmPortfolio, useSymmPositions, useSymmSignature, useSymmTokenSelectionMetadata, useSymmTpsl, useSymmTrade, useSymmTradeHistory, useSymmTwap, useSymmWithdraw, useSymmWs, useSymmioClient };