@pear-protocol/exchanges-sdk 0.1.6 → 0.1.8

package/dist/sdk.js

@@ -1,52 +1,65 @@
 import { createExchangeWs } from './client';
 import './helper';
 import { createExchangeHelper } from './helper/factory';
+import { checkAccountStatus } from './status';
 import { createAccountSyncer } from './syncer';
 import { createAccountTracker } from './tracker';
 
 class ExchangesSDK {
   sdk;
   demo;
+  options;
   constructor(config) {
     this.sdk = config.sdk;
     this.demo = config.demo ?? false;
+    this.options = config.options;
   }
-  async connect(tradeAccountId, exchange) {
-    const credentials = await this.fetchCredentials(tradeAccountId, exchange);
-    const ws = await createExchangeWs(exchange, { demo: this.demo, credentials });
-    return { exchange, credentials, ws };
+  async connect(tradeAccountId) {
+    const connection = await this.fetchCredentials(tradeAccountId);
+    const ws = await createExchangeWs(connection.connector, {
+      demo: this.demo,
+      credentials: connection.credentials
+    });
+    return { ...connection, ws };
+  }
+  async status(connection) {
+    return checkAccountStatus(connection.connector, {
+      sdk: this.sdk,
+      connector: connection.connector,
+      account: connection.account,
+      credentials: connection.credentials,
+      statusOptions: this.options,
+      demo: this.demo
+    });
   }
   createTracker(connection) {
-    return createAccountTracker(connection.exchange, {
+    return createAccountTracker(connection.connector, {
       demo: this.demo,
+      account: connection.account,
       credentials: connection.credentials,
       ws: connection.ws
     });
   }
   createHelper(exchange) {
-    return createExchangeHelper(exchange, this.sdk);
+    switch (exchange) {
+      case "hyperliquid":
+        return createExchangeHelper({ exchange: "hyperliquid" });
+      case "lighter":
+        return createExchangeHelper({ exchange: "lighter", sdk: this.sdk });
+    }
   }
   createSyncer(connection) {
-    return createAccountSyncer(connection.exchange, {
+    return createAccountSyncer(connection.connector, {
       sdk: this.sdk,
-      connector: connection.exchange,
+      connector: connection.connector,
+      account: connection.account,
       credentials: connection.credentials,
       ws: connection.ws,
       demo: this.demo
     });
   }
-  async fetchCredentials(tradeAccountId, exchange) {
-    const response = await this.sdk.core.accounts.credentials(tradeAccountId);
-    const baseCreds = response.credentials;
-    if (exchange === "hyperliquid" || exchange === "lighter") {
-      const { accounts } = await this.sdk.core.accounts.list();
-      const account = accounts.find((a) => a.id === tradeAccountId);
-      if (!account) {
-        throw new Error(`Trade account ${tradeAccountId} not found`);
-      }
-      return { ...baseCreds, accountIdentifier: account.exchangeIdentifier };
-    }
-    return baseCreds;
+  async fetchCredentials(tradeAccountId) {
+    return await this.sdk.core.accounts.credentials(tradeAccountId);
   }
 }
 

package/dist/status/base.js

@@ -0,0 +1,10 @@
+const ACTIVE_STATUS = { status: "active", reasons: [] };
+function activeStatus() {
+  return { ...ACTIVE_STATUS, reasons: [] };
+}
+function warningStatus(reasons) {
+  if (reasons.length === 0) return activeStatus();
+  return { status: "warning", reasons };
+}
+
+export { activeStatus, warningStatus };

package/dist/status/binance/status.js

@@ -0,0 +1,14 @@
+import { fetchAccountStatus } from '../../client/binance/rest';
+import { warningStatus } from '../base';
+
+async function checkBinanceAccountStatus(config) {
+  const reasons = [];
+  try {
+    await fetchAccountStatus(config.credentials, config.demo);
+  } catch {
+    reasons.push("api_key_invalid");
+  }
+  return warningStatus(reasons);
+}
+
+export { checkBinanceAccountStatus };

package/dist/status/bybit/status.js

@@ -0,0 +1,14 @@
+import { fetchAccountInfo } from '../../client/bybit/rest';
+import { warningStatus } from '../base';
+
+async function checkBybitAccountStatus(config) {
+  const reasons = [];
+  try {
+    await fetchAccountInfo(config.credentials, config.demo);
+  } catch {
+    reasons.push("api_key_invalid");
+  }
+  return warningStatus(reasons);
+}
+
+export { checkBybitAccountStatus };

package/dist/status/factory.js

@@ -0,0 +1,26 @@
+import { checkBinanceAccountStatus } from './binance/status';
+import { checkBybitAccountStatus } from './bybit/status';
+import { checkHyperliquidAccountStatus } from './hyperliquid/status';
+import { checkLighterAccountStatus } from './lighter/status';
+import { checkOkxAccountStatus } from './okx/status';
+
+function checkAccountStatus(exchange, config) {
+  switch (exchange) {
+    case "binance":
+      return checkBinanceAccountStatus(config);
+    case "bybit":
+      return checkBybitAccountStatus(config);
+    case "okx":
+      return checkOkxAccountStatus(config);
+    case "hyperliquid":
+      return checkHyperliquidAccountStatus(config);
+    case "lighter":
+      return checkLighterAccountStatus(config);
+    default: {
+      const _exhaustive = exchange;
+      throw new Error(`Unsupported exchange: ${String(_exhaustive)}`);
+    }
+  }
+}
+
+export { checkAccountStatus };

package/dist/status/hyperliquid/status.js

@@ -0,0 +1,37 @@
+import { createExchangeHelper } from '../../helper/factory';
+import { warningStatus } from '../base';
+
+async function checkHyperliquidAccountStatus(config) {
+  const reasons = [];
+  const options = config.statusOptions;
+  if (!options?.builderAddress) {
+    throw new Error("Missing required hyperliquid connect options");
+  }
+  const helper = createExchangeHelper({ exchange: "hyperliquid" });
+  const metadata = config.account.metadata;
+  if (!metadata || !("agentWalletAddress" in metadata)) {
+    reasons.push("hyperliquid_api_wallet_invalid");
+  } else {
+    try {
+      const apiWalletValid = await helper.checkApiWallet({
+        userAddress: config.account.exchangeIdentifier,
+        agentWalletAddress: metadata.agentWalletAddress
+      });
+      if (!apiWalletValid) reasons.push("hyperliquid_api_wallet_invalid");
+    } catch {
+      reasons.push("hyperliquid_api_wallet_invalid");
+    }
+  }
+  try {
+    const approved = await helper.checkBuilderFeeApproval(
+      config.account.exchangeIdentifier,
+      options.builderAddress
+    );
+    if (!approved) reasons.push("hyperliquid_builder_fee_not_approved");
+  } catch {
+    reasons.push("hyperliquid_builder_fee_not_approved");
+  }
+  return warningStatus(reasons);
+}
+
+export { checkHyperliquidAccountStatus };

package/dist/status/index.js

@@ -0,0 +1,7 @@
+export * from './base';
+export * from './binance/status';
+export * from './bybit/status';
+export * from './factory';
+export * from './hyperliquid/status';
+export * from './lighter/status';
+export * from './okx/status';

package/dist/status/lighter/status.js

@@ -0,0 +1,33 @@
+import { fetchAccountMetadata } from '../../client/lighter/rest';
+import { createExchangeHelper } from '../../helper/factory';
+import { warningStatus } from '../base';
+
+async function checkLighterAccountStatus(config) {
+  const reasons = [];
+  const options = config.statusOptions;
+  if (options?.integratorAccountIndex === void 0) {
+    throw new Error("Missing required lighter connect options");
+  }
+  const credentials = config.credentials;
+  const accountIndex = Number(config.account.exchangeIdentifier);
+  try {
+    const { token } = await config.sdk.core.misc.lighter.createAuthToken({
+      accountIndex,
+      apiKeyIndex: credentials.api_key_index,
+      apiPrivateKey: credentials.api_private_key
+    });
+    await fetchAccountMetadata(accountIndex, token);
+  } catch {
+    reasons.push("lighter_api_key_invalid");
+  }
+  try {
+    const helper = createExchangeHelper({ exchange: "lighter", sdk: config.sdk });
+    const approved = await helper.checkIntegratorApproval(accountIndex, options.integratorAccountIndex);
+    if (!approved) reasons.push("lighter_integrator_not_approved");
+  } catch {
+    reasons.push("lighter_integrator_not_approved");
+  }
+  return warningStatus(reasons);
+}
+
+export { checkLighterAccountStatus };

package/dist/status/okx/status.js

@@ -0,0 +1,14 @@
+import { fetchAccountConfig } from '../../client/okx/rest';
+import { warningStatus } from '../base';
+
+async function checkOkxAccountStatus(config) {
+  const reasons = [];
+  try {
+    await fetchAccountConfig(config.credentials, config.demo);
+  } catch {
+    reasons.push("api_key_invalid");
+  }
+  return warningStatus(reasons);
+}
+
+export { checkOkxAccountStatus };

package/dist/syncer/base.js

@@ -3,12 +3,14 @@ import { computeSyncPayload } from '@pear-protocol/utils';
 class BaseAccountSyncer {
   sdk;
   connector;
+  account;
   credentials;
   ws;
   demo;
   constructor(config) {
     this.sdk = config.sdk;
     this.connector = config.connector;
+    this.account = config.account;
     this.credentials = config.credentials;
     this.ws = config.ws;
     this.demo = config.demo;

package/dist/syncer/hyperliquid/syncer.js

@@ -5,8 +5,7 @@ class HyperliquidAccountSyncer extends BaseAccountSyncer {
   address;
   constructor(config) {
     super(config);
-    const creds = config.credentials;
-    this.address = creds.accountIdentifier;
+    this.address = config.account.exchangeIdentifier;
   }
   async listExternalFills({
     since,

package/dist/syncer/lighter/syncer.js

@@ -10,7 +10,7 @@ class LighterAccountSyncer extends BaseAccountSyncer {
   constructor(config) {
     super(config);
     const creds = config.credentials;
-    this.accountIndex = Number(creds.accountIdentifier);
+    this.accountIndex = Number(config.account.exchangeIdentifier);
     this.apiKeyIndex = creds.api_key_index;
     this.apiPrivateKey = creds.api_private_key;
   }

package/dist/tracker/hyperliquid/tracker.js

@@ -26,9 +26,8 @@ class HyperliquidAccountTracker extends BaseAccountTracker {
   trackedAssetData = /* @__PURE__ */ new Map();
   constructor(config) {
     super(config);
-    const creds = config.credentials;
     this.credentials = config.credentials;
-    this.address = creds.accountIdentifier;
+    this.address = config.account.exchangeIdentifier;
     this.ws = config.ws;
   }
   async start() {

package/dist/tracker/index.js

@@ -55,6 +55,7 @@ function createAccountTracker(exchange, config) {
       tracker = new HyperliquidAccountTracker({
         demo: config.demo,
         onError: config.onError,
+        account: config.account,
         credentials: config.credentials,
         ws: ws.main
       });
@@ -65,6 +66,7 @@ function createAccountTracker(exchange, config) {
       tracker = new LighterAccountTracker({
         demo: config.demo,
         onError: config.onError,
+        account: config.account,
         credentials: config.credentials,
         ws: ws.main
       });

package/dist/tracker/lighter/tracker.js

@@ -14,9 +14,8 @@ class LighterAccountTracker extends BaseAccountTracker {
   hasAssets = false;
   constructor(config) {
     super(config);
-    const creds = config.credentials;
     this.credentials = config.credentials;
-    this.accountIdentifier = creds.accountIdentifier;
+    this.accountIdentifier = config.account.exchangeIdentifier;
     this.ws = config.ws;
   }
   async start() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pear-protocol/exchanges-sdk",
-  "version": "0.1.6",
+  "version": "0.1.8",
   "description": "Pear Protocol Exchanges SDK",
   "private": false,
   "type": "module",
@@ -25,9 +25,9 @@
     "typecheck": "tsc --noEmit"
   },
   "dependencies": {
-    "@pear-protocol/core-sdk": "^0.0.21",
-    "@pear-protocol/types": "^0.0.18",
-    "@pear-protocol/utils": "^0.0.18",
+    "@pear-protocol/core-sdk": "^0.0.23",
+    "@pear-protocol/types": "^0.0.20",
+    "@pear-protocol/utils": "^0.0.20",
     "bignumber.js": "^11.1.1",
     "partysocket": "^1.0.3",
     "viem": "^2.48.8"

package/dist/client/base-ws.d.ts

@@ -1,30 +0,0 @@
-import { WebSocket } from 'partysocket';
-
-interface WsMessage {
-    [key: string]: unknown;
-}
-type MessageListener = (data: string) => void;
-type OpenListener = () => void;
-declare abstract class BaseWs {
-    protected ws: WebSocket | null;
-    protected pingTimer: ReturnType<typeof setInterval> | null;
-    private messageListeners;
-    private openListeners;
-    private nextListenerId;
-    protected abstract getWsUrl(): string;
-    protected abstract getPingIntervalMs(): number;
-    protected abstract buildPingMessage(): WsMessage | string | null;
-    connect(): Promise<void>;
-    disconnect(): void;
-    get connected(): boolean;
-    send(msg: WsMessage | string): void;
-    addMessageListener(listener: MessageListener): string;
-    removeMessageListener(id: string): void;
-    addOpenListener(listener: OpenListener): string;
-    removeOpenListener(id: string): void;
-    destroy(): void;
-    private startPing;
-    private stopPing;
-}
-
-export { BaseWs, type MessageListener, type OpenListener, type WsMessage };

package/dist/client/binance/exchange-ws.d.ts

@@ -1,19 +0,0 @@
-import { BinanceCredentialsDTO } from '@pear-protocol/types';
-import { BaseWs } from '../base-ws.js';
-import { ExchangeWs } from '../exchange-ws.js';
-import { BinanceUserDataWs, BinanceWsApi } from './ws.js';
-import 'partysocket';
-
-declare class BinanceExchangeWs extends ExchangeWs {
-    userData: BinanceUserDataWs;
-    wsApi: BinanceWsApi;
-    readonly exchange: "binance";
-    constructor(userData: BinanceUserDataWs, wsApi: BinanceWsApi);
-    protected connections(): BaseWs[];
-    static create(config: {
-        demo: boolean;
-        credentials: BinanceCredentialsDTO;
-    }): Promise<BinanceExchangeWs>;
-}
-
-export { BinanceExchangeWs };

package/dist/client/binance/rest.d.ts

@@ -1,13 +0,0 @@
-import { BinanceCredentialsDTO } from '@pear-protocol/types';
-import { BinanceRawAccountStatus, BinanceRawOrder, BinanceRawPositionRisk, BinanceRawUserTrade } from './types.js';
-
-declare function createListenKey(apiKey: string, demo?: boolean): Promise<string>;
-declare function keepAliveListenKey(apiKey: string, demo?: boolean): Promise<void>;
-declare function fetchAccountStatus(creds: BinanceCredentialsDTO, demo: boolean): Promise<BinanceRawAccountStatus>;
-declare function fetchPositionRisk(creds: BinanceCredentialsDTO, symbol: string, demo: boolean): Promise<BinanceRawPositionRisk | undefined>;
-declare function fetchAllPositionRisk(creds: BinanceCredentialsDTO, demo: boolean): Promise<BinanceRawPositionRisk[]>;
-declare function fetchMultiAssetsMargin(creds: BinanceCredentialsDTO, demo: boolean): Promise<boolean>;
-declare function fetchUserTradesSince(creds: BinanceCredentialsDTO, symbols: string[], since: Date, demo: boolean): Promise<BinanceRawUserTrade[]>;
-declare function fetchAllOrdersSince(creds: BinanceCredentialsDTO, symbols: string[], since: Date, demo: boolean): Promise<BinanceRawOrder[]>;
-
-export { createListenKey, fetchAccountStatus, fetchAllOrdersSince, fetchAllPositionRisk, fetchMultiAssetsMargin, fetchPositionRisk, fetchUserTradesSince, keepAliveListenKey };

package/dist/client/binance/types.d.ts

@@ -1,103 +0,0 @@
-import { MarginMode } from '@pear-protocol/types';
-
-interface BinanceRawPositionRisk {
-    symbol: string;
-    leverage: string;
-    marginType: MarginMode;
-    isAutoAddMargin: string;
-    isolatedMargin: string;
-    positionAmt: string;
-    entryPrice: string;
-    breakEvenPrice: string;
-    unRealizedProfit: string;
-    liquidationPrice: string;
-    markPrice: string;
-    maxNotionalValue: string;
-    positionSide: string;
-    notional: string;
-    isolatedWallet: string;
-    updateTime: number;
-}
-interface BinanceRawAsset {
-    asset: string;
-    walletBalance: string;
-    availableBalance: string;
-    unrealizedProfit: string;
-    marginBalance: string;
-    initialMargin: string;
-    maintMargin: string;
-    marginAvailable: boolean;
-}
-interface BinanceRawAccountStatus {
-    totalWalletBalance: string;
-    totalMarginBalance: string;
-    availableBalance: string;
-    totalUnrealizedProfit: string;
-    totalInitialMargin: string;
-    totalMaintMargin: string;
-    assets?: BinanceRawAsset[];
-}
-interface BinanceMultiAssetsMarginResponse {
-    multiAssetsMargin: boolean;
-}
-interface BinanceRawUserTrade {
-    buyer: boolean;
-    commission: string;
-    commissionAsset: string;
-    id: number;
-    maker: boolean;
-    orderId: number;
-    price: string;
-    qty: string;
-    quoteQty: string;
-    realizedPnl: string;
-    side: 'BUY' | 'SELL';
-    positionSide: string;
-    symbol: string;
-    time: number;
-}
-interface BinanceRawOrder {
-    avgPrice: string;
-    clientOrderId: string;
-    cumQuote: string;
-    executedQty: string;
-    orderId: number;
-    origQty: string;
-    origType: string;
-    price: string;
-    reduceOnly: boolean;
-    side: 'BUY' | 'SELL';
-    positionSide: string;
-    status: string;
-    symbol: string;
-    time: number;
-    timeInForce: string;
-    type: string;
-    updateTime: number;
-}
-interface BinanceAssetIndex {
-    symbol: string;
-    time: number;
-    index: string;
-    bidBuffer: string;
-    askBuffer: string;
-    bidRate: string;
-    askRate: string;
-    autoExchangeBidBuffer: string;
-    autoExchangeAskBuffer: string;
-    autoExchangeBidRate: string;
-    autoExchangeAskRate: string;
-}
-interface BinanceRawUserDataEvent {
-    e?: string;
-    ac?: {
-        s: string;
-        l: string;
-    };
-    a?: {
-        B?: unknown[];
-        P?: unknown[];
-    };
-}
-
-export type { BinanceAssetIndex, BinanceMultiAssetsMarginResponse, BinanceRawAccountStatus, BinanceRawAsset, BinanceRawOrder, BinanceRawPositionRisk, BinanceRawUserDataEvent, BinanceRawUserTrade };

package/dist/client/binance/ws.d.ts

@@ -1,30 +0,0 @@
-import { BinanceCredentialsDTO } from '@pear-protocol/types';
-import { BaseWs } from '../base-ws.js';
-import 'partysocket';
-
-type BinanceUserDataWsConfig = {
-    listenKey: string;
-    demo: boolean;
-};
-declare class BinanceUserDataWs extends BaseWs {
-    private readonly listenKey;
-    private readonly demo;
-    constructor(config: BinanceUserDataWsConfig);
-    protected getWsUrl(): string;
-    protected getPingIntervalMs(): number;
-    protected buildPingMessage(): null;
-}
-type BinanceWsApiConfig = {
-    demo: boolean;
-};
-declare class BinanceWsApi extends BaseWs {
-    private readonly demo;
-    private requestId;
-    constructor(config: BinanceWsApiConfig);
-    protected getWsUrl(): string;
-    protected getPingIntervalMs(): number;
-    protected buildPingMessage(): null;
-    sendSignedRequest(creds: BinanceCredentialsDTO, method: string, params?: Record<string, unknown>): Promise<number>;
-}
-
-export { BinanceUserDataWs, type BinanceUserDataWsConfig, BinanceWsApi, type BinanceWsApiConfig };

package/dist/client/bybit/exchange-ws.d.ts

@@ -1,20 +0,0 @@
-import { BybitCredentialsDTO } from '@pear-protocol/types';
-import { BaseWs } from '../base-ws.js';
-import { ExchangeWs } from '../exchange-ws.js';
-import { BybitWs } from './ws.js';
-import 'partysocket';
-
-declare class BybitExchangeWs extends ExchangeWs {
-    main: BybitWs;
-    private readonly creds;
-    readonly exchange: "bybit";
-    constructor(main: BybitWs, creds: BybitCredentialsDTO);
-    protected connections(): BaseWs[];
-    authenticate(): Promise<void>;
-    static create(config: {
-        demo: boolean;
-        credentials: BybitCredentialsDTO;
-    }): Promise<BybitExchangeWs>;
-}
-
-export { BybitExchangeWs };

package/dist/client/bybit/rest.d.ts

@@ -1,11 +0,0 @@
-import { BybitCredentialsDTO } from '@pear-protocol/types';
-import { BybitRawAccountInfo, BybitRawExecution, BybitRawPosition, BybitRawWallet } from './types.js';
-
-declare function fetchWalletBalance(creds: BybitCredentialsDTO, demo: boolean): Promise<BybitRawWallet | undefined>;
-declare function fetchPositions(creds: BybitCredentialsDTO, settleCoin: string, demo: boolean): Promise<BybitRawPosition[]>;
-declare function fetchPositionLeverage(creds: BybitCredentialsDTO, symbol: string, demo: boolean): Promise<BybitRawPosition | undefined>;
-declare function fetchAccountInfo(creds: BybitCredentialsDTO, demo: boolean): Promise<BybitRawAccountInfo>;
-declare function fetchCollateralRatios(creds: BybitCredentialsDTO, demo: boolean): Promise<Map<string, string>>;
-declare function fetchExecutionsSince(creds: BybitCredentialsDTO, since: Date, demo: boolean): Promise<BybitRawExecution[]>;
-
-export { fetchAccountInfo, fetchCollateralRatios, fetchExecutionsSince, fetchPositionLeverage, fetchPositions, fetchWalletBalance };

package/dist/client/bybit/types.d.ts

@@ -1,75 +0,0 @@
-interface BybitRawCoin {
-    coin: string;
-    equity: string;
-    usdValue: string;
-    walletBalance: string;
-    unrealisedPnl: string;
-    totalPositionIM: string;
-    totalPositionMM: string;
-    totalOrderIM: string;
-    locked: string;
-    borrowAmount: string;
-    marginCollateral: boolean;
-    collateralSwitch: boolean;
-}
-interface BybitRawWallet {
-    totalEquity: string;
-    totalWalletBalance: string;
-    totalMarginBalance: string;
-    totalAvailableBalance: string;
-    totalPerpUPL: string;
-    totalInitialMargin: string;
-    totalMaintenanceMargin: string;
-    accountMMRate: string;
-    coin: BybitRawCoin[];
-}
-interface BybitRawAccountInfo {
-    marginMode: string;
-    updatedTime: string;
-}
-interface BybitRawCollateralTier {
-    collateralCoin: string;
-    rate: string;
-    collateralAmount: string;
-}
-interface BybitRawCollateralRatioEntry {
-    currency: string;
-    tiers: BybitRawCollateralTier[];
-}
-interface BybitRawPosition {
-    symbol: string;
-    side: string;
-    size: string;
-    avgPrice: string;
-    unrealisedPnl: string;
-    leverage: string;
-    tradeMode: string;
-    liqPrice: string;
-}
-interface BybitRawExecution {
-    symbol: string;
-    orderId: string;
-    orderLinkId: string;
-    side: 'Buy' | 'Sell';
-    execFee: string;
-    execId: string;
-    execPrice: string;
-    execQty: string;
-    execTime: string;
-    execType: string;
-    closedSize: string;
-}
-interface BybitResponse<T> {
-    retCode: number;
-    retMsg: string;
-    result: T;
-}
-type BybitWsMessage = {
-    topic: 'wallet';
-    data: BybitRawWallet[];
-} | {
-    topic: 'position';
-    data: BybitRawPosition[];
-};
-
-export type { BybitRawAccountInfo, BybitRawCoin, BybitRawCollateralRatioEntry, BybitRawCollateralTier, BybitRawExecution, BybitRawPosition, BybitRawWallet, BybitResponse, BybitWsMessage };