npm - @pear-protocol/core-sdk - Versions diffs - 0.0.24 → 0.1.0 - Mend

@pear-protocol/core-sdk 0.0.24 → 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (8) hide show

package/dist/admin/index.d.ts ADDED Viewed

@@ -0,0 +1,57 @@
+import { HttpTypes } from '@pear-protocol/types';
+import { HttpClient } from '../http.js';
+import { ClientHeaders } from '../types.js';
+declare class Admin {
+    private client;
+    constructor(client: HttpClient);
+    clientIds: {
+        list: (query?: HttpTypes.ListClientIdsParamsInput, headers?: ClientHeaders) => Promise<{
+            id: string;
+            code: string;
+            label: string;
+            isActive: boolean;
+            createdAt: string;
+            updatedAt: string;
+            description?: string | undefined;
+        }[]>;
+        create: (body: HttpTypes.CreateClientIdPayloadInput, headers?: ClientHeaders) => Promise<{
+            id: string;
+            code: string;
+            label: string;
+            isActive: boolean;
+            createdAt: string;
+            updatedAt: string;
+            description?: string | undefined;
+        }>;
+        update: (id: string, body: HttpTypes.UpdateClientIdPayloadInput, headers?: ClientHeaders) => Promise<{
+            id: string;
+            code: string;
+            label: string;
+            isActive: boolean;
+            createdAt: string;
+            updatedAt: string;
+            description?: string | undefined;
+        }>;
+        activate: (id: string, headers?: ClientHeaders) => Promise<{
+            id: string;
+            code: string;
+            label: string;
+            isActive: boolean;
+            createdAt: string;
+            updatedAt: string;
+            description?: string | undefined;
+        }>;
+        deactivate: (id: string, headers?: ClientHeaders) => Promise<{
+            id: string;
+            code: string;
+            label: string;
+            isActive: boolean;
+            createdAt: string;
+            updatedAt: string;
+            description?: string | undefined;
+        }>;
+    };
+}
+export { Admin };

package/dist/admin/index.js ADDED Viewed

@@ -0,0 +1,43 @@
+class Admin {
+  client;
+  constructor(client) {
+    this.client = client;
+  }
+  clientIds = {
+    list: async (query, headers) => {
+      return await this.client.fetch(`/admin/client-ids`, {
+        method: "GET",
+        headers,
+        query
+      });
+    },
+    create: async (body, headers) => {
+      return await this.client.fetch(`/admin/client-ids`, {
+        method: "POST",
+        headers,
+        body
+      });
+    },
+    update: async (id, body, headers) => {
+      return await this.client.fetch(`/admin/client-ids/${id}`, {
+        method: "PATCH",
+        headers,
+        body
+      });
+    },
+    activate: async (id, headers) => {
+      return await this.client.fetch(`/admin/client-ids/${id}/activate`, {
+        method: "POST",
+        headers
+      });
+    },
+    deactivate: async (id, headers) => {
+      return await this.client.fetch(`/admin/client-ids/${id}/deactivate`, {
+        method: "POST",
+        headers
+      });
+    }
+  };
+}
+export { Admin };

package/dist/auth/index.d.ts CHANGED Viewed

@@ -12,7 +12,7 @@ declare class Auth {
         refreshToken: string;
         user: {
             id: string;
-            role: "basic" | "pro";
+            role: "basic" | "pro" | "admin";
             providerId: string | null;
             loginMethod: "email" | "evm_wallet";
         };
@@ -26,7 +26,7 @@ declare class Auth {
     logout(headers?: ClientHeaders): Promise<void>;
     me(headers?: ClientHeaders): Promise<{
         id: string;
-        role: "basic" | "pro";
+        role: "basic" | "pro" | "admin";
         providerId: string | null;
         loginMethod: "email" | "evm_wallet";
     }>;

package/dist/core/index.d.ts CHANGED Viewed

@@ -405,6 +405,57 @@ declare class Core {
             data: Record<string, string>;
         }>;
     };
+    markets: {
+        list: (query: HttpTypes.MarketsQueryParamsInput, headers?: ClientHeaders) => Promise<{
+            markets: {
+                connector: "hyperliquid" | "binance" | "bybit" | "okx" | "lighter";
+                instrumentId: string;
+                displaySymbol: string;
+                base: string;
+                quote: string;
+                price: string;
+                volume24h: string;
+                change24h: string;
+                openInterest: string;
+                fundingRate: string;
+                tradeability: {
+                    status: "tradable" | "reduce_only" | "not_tradable";
+                    reason: string | null;
+                };
+                updatedAt: number;
+            }[];
+            totals: {
+                markets: number;
+                volume24h: string;
+                openInterest: string;
+            };
+        }>;
+        baskets: (query: HttpTypes.MarketBasketsQueryParamsInput, headers?: ClientHeaders) => Promise<{
+            limit: number;
+            offset: number;
+            count: number;
+            markets: {
+                connector: "hyperliquid" | "binance" | "bybit" | "okx" | "lighter";
+                basketKey: string;
+                displaySymbol: string;
+                longInstrumentIds: string[];
+                shortInstrumentIds: string[];
+                price: string;
+                priceChange24h: string;
+                weightRatio: string;
+                weightRatioChange24h: string;
+                netFunding: string;
+                volume24h: string;
+                openInterest: string;
+                tradeability: {
+                    status: "tradable" | "reduce_only" | "not_tradable";
+                    reason: string | null;
+                };
+                updatedAt: number;
+                hasMaterializedStats: boolean;
+            }[];
+        }>;
+    };
     positions: {
         list: (query: HttpTypes.PositionListParamsInput, headers?: ClientHeaders) => Promise<{
             positions: {
@@ -430,6 +481,177 @@ declare class Core {
             }[];
         }>;
     };
+    portfolio: {
+        overview: (query?: HttpTypes.PortfolioQueryInput, headers?: ClientHeaders) => Promise<{
+            intervals: {
+                oneDay: {
+                    periodStart: string;
+                    periodEnd: string;
+                    volume: number;
+                    openInterest: number;
+                    winningTradesCount: number;
+                    winningTradesUsd: number;
+                    losingTradesCount: number;
+                    losingTradesUsd: number;
+                }[];
+                oneWeek: {
+                    periodStart: string;
+                    periodEnd: string;
+                    volume: number;
+                    openInterest: number;
+                    winningTradesCount: number;
+                    winningTradesUsd: number;
+                    losingTradesCount: number;
+                    losingTradesUsd: number;
+                }[];
+                oneMonth: {
+                    periodStart: string;
+                    periodEnd: string;
+                    volume: number;
+                    openInterest: number;
+                    winningTradesCount: number;
+                    winningTradesUsd: number;
+                    losingTradesCount: number;
+                    losingTradesUsd: number;
+                }[];
+                oneYear: {
+                    periodStart: string;
+                    periodEnd: string;
+                    volume: number;
+                    openInterest: number;
+                    winningTradesCount: number;
+                    winningTradesUsd: number;
+                    losingTradesCount: number;
+                    losingTradesUsd: number;
+                }[];
+                all: {
+                    periodStart: string;
+                    periodEnd: string;
+                    volume: number;
+                    openInterest: number;
+                    winningTradesCount: number;
+                    winningTradesUsd: number;
+                    losingTradesCount: number;
+                    losingTradesUsd: number;
+                }[];
+            } | null;
+            overall: {
+                totalWinningTradesCount: number;
+                totalLosingTradesCount: number;
+                totalWinningUsd: number;
+                totalLosingUsd: number;
+                currentOpenInterest: number;
+                currentTotalVolume: number;
+                unrealizedPnl: number;
+                realizedPnl: number;
+                totalFees: number;
+                totalTrades: number;
+            };
+        }>;
+        analytics: (query?: HttpTypes.PortfolioAnalyticsQueryInput, headers?: ClientHeaders) => Promise<{
+            config: {
+                rollingWindowDays: number;
+                startDate: string;
+                endDate: string;
+            };
+            portfolio: {
+                realizedOnly: {
+                    pnlAbsolute: number;
+                    pnlPercent: number | null;
+                    hitRate: number | null;
+                    profitFactor: number | null;
+                    avgWinSize: number | null;
+                    avgLossSize: number | null;
+                    avgReturnPerWin: number | null;
+                    avgReturnPerLoss: number | null;
+                    maxDrawdown: number | null;
+                    sharpeRatio: number | null;
+                    sortinoRatio: number | null;
+                };
+                realizedPlusUnrealized: {
+                    pnlAbsolute: number;
+                    pnlPercent: number | null;
+                    hitRate: number | null;
+                    profitFactor: number | null;
+                    avgWinSize: number | null;
+                    avgLossSize: number | null;
+                    avgReturnPerWin: number | null;
+                    avgReturnPerLoss: number | null;
+                    maxDrawdown: number | null;
+                    sharpeRatio: number | null;
+                    sortinoRatio: number | null;
+                };
+                realizedHitRate: number | null;
+                profitFactor: number | null;
+                avgWinSize: number | null;
+                avgLossSize: number | null;
+                breakevenHitRate: number | null;
+                cushion: number | null;
+            };
+            assets: {
+                asset: string;
+                realizedOnly: {
+                    pnlAbsolute: number;
+                    pnlPercent: number | null;
+                    hitRate: number | null;
+                    profitFactor: number | null;
+                    avgWinSize: number | null;
+                    avgLossSize: number | null;
+                    avgReturnPerWin: number | null;
+                    avgReturnPerLoss: number | null;
+                    maxDrawdown: number | null;
+                    sharpeRatio: number | null;
+                    sortinoRatio: number | null;
+                };
+                realizedPlusUnrealized: {
+                    pnlAbsolute: number;
+                    pnlPercent: number | null;
+                    hitRate: number | null;
+                    profitFactor: number | null;
+                    avgWinSize: number | null;
+                    avgLossSize: number | null;
+                    avgReturnPerWin: number | null;
+                    avgReturnPerLoss: number | null;
+                    maxDrawdown: number | null;
+                    sharpeRatio: number | null;
+                    sortinoRatio: number | null;
+                };
+                unrealizedReturnPerDay: number | null;
+            }[];
+            pairs: {
+                key: string;
+                longAssets: string[];
+                shortAssets: string[];
+                trades: number;
+                wins: number;
+                losses: number;
+                hitRate: number | null;
+                avgWinSize: number | null;
+                avgLossSize: number | null;
+                expectancy: number | null;
+                totalPnl: number;
+                bookPercent: number | null;
+            }[];
+            series?: {
+                date: string;
+                trades: number;
+                wins: number;
+                losses: number;
+                dayPnl: number;
+                hitRate: number | null;
+                winLossRatio: number | null;
+                rollingHitRate: number | null;
+                rollingWinLossRatio: number | null;
+                dailyReturn: number | null;
+                cumulativeReturn: number;
+                equity: number;
+                drawdown: number;
+                rollingSharpe: number | null;
+                rollingSortino: number | null;
+                rollingVolatility: number | null;
+            }[] | undefined;
+        }>;
+    };
     prices: {
         list: (query: HttpTypes.PricesQueryParams, headers?: ClientHeaders) => Promise<{
             mid: Record<string, string>;
@@ -2149,7 +2371,7 @@ declare class Core {
             profile: {
                 id: string;
                 displayName: string;
-                role: "basic" | "pro";
+                role: "basic" | "pro" | "admin";
                 address: string | null;
                 email: string | null;
                 emailVerified: boolean;
@@ -2210,6 +2432,170 @@ declare class Core {
             }[];
         }>;
     };
+    tca: {
+        execution: (executionId: string, headers?: ClientHeaders) => Promise<{
+            fillMetrics: {
+                id: string;
+                fillId: string;
+                tradeAccountId: string;
+                connector: "hyperliquid" | "binance" | "bybit" | "okx" | "lighter";
+                symbol: string;
+                status: "FINAL";
+                createdAt: string;
+                updatedAt: string;
+                benchmarkId?: string | undefined;
+                executionId?: string | undefined;
+                positionId?: string | undefined;
+                cloid?: string | undefined;
+                exchangeFillId?: string | undefined;
+                slippageBps?: string | undefined;
+                slippageQuote?: string | undefined;
+                slippageUsd?: string | undefined;
+                implementationShortfallBps?: string | undefined;
+                spreadCostQuote?: string | undefined;
+                spreadCostUsd?: string | undefined;
+                tradeFee?: string | undefined;
+                pearFee?: string | undefined;
+                totalCostUsd?: string | undefined;
+                gatewayLatencyMs?: number | undefined;
+                timeToFillMs?: number | undefined;
+                quoteAsset?: string | undefined;
+                notionalQuote?: string | undefined;
+                notionalUsd?: string | undefined;
+                submittedAt?: string | undefined;
+                acknowledgedAt?: string | undefined;
+                exchangeExecutedAt?: string | undefined;
+                timingGranularity?: "BATCH" | "LEG" | undefined;
+                benchmark?: {
+                    id: string;
+                    executionId: string;
+                    legIndex: number;
+                    connector: "hyperliquid" | "binance" | "bybit" | "okx" | "lighter";
+                    symbol: string;
+                    side: "BUY" | "SELL";
+                    source: string;
+                    timestamp: string;
+                    createdAt: string;
+                    orderId?: string | undefined;
+                    cloid?: string | undefined;
+                    decisionPrice?: string | undefined;
+                    arrivalMid?: string | undefined;
+                    arrivalBid?: string | undefined;
+                    arrivalAsk?: string | undefined;
+                    markPrice?: string | undefined;
+                    indexPrice?: string | undefined;
+                    quoteAsset?: string | undefined;
+                    usdConversionPrice?: string | undefined;
+                } | undefined;
+            }[];
+            summary?: {
+                id: string;
+                executionId: string;
+                tradeAccountId: string;
+                connector: "hyperliquid" | "binance" | "bybit" | "okx" | "lighter";
+                fillCount: number;
+                status: "FINAL";
+                createdAt: string;
+                updatedAt: string;
+                notionalQuote?: string | undefined;
+                notionalUsd?: string | undefined;
+                weightedSlippageBps?: string | undefined;
+                totalSlippageUsd?: string | undefined;
+                totalTradeFee?: string | undefined;
+                totalPearFee?: string | undefined;
+                totalCostUsd?: string | undefined;
+            } | undefined;
+        }>;
+        position: (positionId: string, query?: HttpTypes.TcaPositionQueryParamsInput, headers?: ClientHeaders) => Promise<{
+            limit: number;
+            fillMetrics: {
+                id: string;
+                fillId: string;
+                tradeAccountId: string;
+                connector: "hyperliquid" | "binance" | "bybit" | "okx" | "lighter";
+                symbol: string;
+                status: "FINAL";
+                createdAt: string;
+                updatedAt: string;
+                benchmarkId?: string | undefined;
+                executionId?: string | undefined;
+                positionId?: string | undefined;
+                cloid?: string | undefined;
+                exchangeFillId?: string | undefined;
+                slippageBps?: string | undefined;
+                slippageQuote?: string | undefined;
+                slippageUsd?: string | undefined;
+                implementationShortfallBps?: string | undefined;
+                spreadCostQuote?: string | undefined;
+                spreadCostUsd?: string | undefined;
+                tradeFee?: string | undefined;
+                pearFee?: string | undefined;
+                totalCostUsd?: string | undefined;
+                gatewayLatencyMs?: number | undefined;
+                timeToFillMs?: number | undefined;
+                quoteAsset?: string | undefined;
+                notionalQuote?: string | undefined;
+                notionalUsd?: string | undefined;
+                submittedAt?: string | undefined;
+                acknowledgedAt?: string | undefined;
+                exchangeExecutedAt?: string | undefined;
+                timingGranularity?: "BATCH" | "LEG" | undefined;
+                benchmark?: {
+                    id: string;
+                    executionId: string;
+                    legIndex: number;
+                    connector: "hyperliquid" | "binance" | "bybit" | "okx" | "lighter";
+                    symbol: string;
+                    side: "BUY" | "SELL";
+                    source: string;
+                    timestamp: string;
+                    createdAt: string;
+                    orderId?: string | undefined;
+                    cloid?: string | undefined;
+                    decisionPrice?: string | undefined;
+                    arrivalMid?: string | undefined;
+                    arrivalBid?: string | undefined;
+                    arrivalAsk?: string | undefined;
+                    markPrice?: string | undefined;
+                    indexPrice?: string | undefined;
+                    quoteAsset?: string | undefined;
+                    usdConversionPrice?: string | undefined;
+                } | undefined;
+            }[];
+            nextCursor?: string | undefined;
+        }>;
+        summary: (query?: HttpTypes.TcaSummaryQueryParamsInput, headers?: ClientHeaders) => Promise<{
+            limit: number;
+            summaries: {
+                id: string;
+                executionId: string;
+                tradeAccountId: string;
+                connector: "hyperliquid" | "binance" | "bybit" | "okx" | "lighter";
+                fillCount: number;
+                status: "FINAL";
+                createdAt: string;
+                updatedAt: string;
+                notionalQuote?: string | undefined;
+                notionalUsd?: string | undefined;
+                weightedSlippageBps?: string | undefined;
+                totalSlippageUsd?: string | undefined;
+                totalTradeFee?: string | undefined;
+                totalPearFee?: string | undefined;
+                totalCostUsd?: string | undefined;
+            }[];
+            totals: {
+                executionCount: number;
+                fillCount: number;
+                notionalQuote?: string | undefined;
+                notionalUsd?: string | undefined;
+                totalSlippageUsd?: string | undefined;
+                totalTradeFee?: string | undefined;
+                totalPearFee?: string | undefined;
+                totalCostUsd?: string | undefined;
+            };
+            nextCursor?: string | undefined;
+        }>;
+    };
 }
 export { Core };

package/dist/core/index.js CHANGED Viewed

@@ -99,6 +99,22 @@ class Core {
       });
     }
   };
+  markets = {
+    list: async (query, headers) => {
+      return await this.client.fetch(`/markets`, {
+        method: "GET",
+        headers,
+        query
+      });
+    },
+    baskets: async (query, headers) => {
+      return await this.client.fetch(`/markets/baskets`, {
+        method: "GET",
+        headers,
+        query
+      });
+    }
+  };
   positions = {
     list: async (query, headers) => {
       return await this.client.fetch(`/positions`, {
@@ -114,6 +130,22 @@ class Core {
       });
     }
   };
+  portfolio = {
+    overview: async (query, headers) => {
+      return await this.client.fetch(`/portfolio`, {
+        method: "GET",
+        headers,
+        query
+      });
+    },
+    analytics: async (query, headers) => {
+      return await this.client.fetch(`/portfolio/analytics`, {
+        method: "GET",
+        headers,
+        query
+      });
+    }
+  };
   prices = {
     list: async (query, headers) => {
       return await this.client.fetch(`/prices`, {
@@ -345,6 +377,28 @@ class Core {
       });
     }
   };
+  tca = {
+    execution: async (executionId, headers) => {
+      return await this.client.fetch(`/tca/executions/${executionId}`, {
+        method: "GET",
+        headers
+      });
+    },
+    position: async (positionId, query, headers) => {
+      return await this.client.fetch(`/tca/positions/${positionId}`, {
+        method: "GET",
+        headers,
+        query
+      });
+    },
+    summary: async (query, headers) => {
+      return await this.client.fetch(`/tca/summary`, {
+        method: "GET",
+        headers,
+        query
+      });
+    }
+  };
 }
 export { Core };

package/dist/index.d.ts CHANGED Viewed

@@ -1,3 +1,4 @@
+import { Admin } from './admin/index.js';
 import { Auth } from './auth/index.js';
 import { Core } from './core/index.js';
 import { SDKConfig } from './types.js';
@@ -6,6 +7,7 @@ export * from '@pear-protocol/utils';
 import './http.js';
 declare class PearSDK {
+    admin: Admin;
     auth: Auth;
     core: Core;
     constructor(config: SDKConfig);

package/dist/index.js CHANGED Viewed

@@ -1,3 +1,4 @@
+import { Admin } from './admin';
 import { Auth } from './auth';
 import { Core } from './core';
 import { HttpClient } from './http';
@@ -5,6 +6,7 @@ import { FetchError } from './utils';
 export * from '@pear-protocol/utils';
 class PearSDK {
+  admin;
   auth;
   core;
   constructor(config) {
@@ -17,6 +19,7 @@ class PearSDK {
       }
     };
     const client = new HttpClient(config.url, authMode, config.logger, config.debug);
+    this.admin = new Admin(client);
     this.auth = new Auth(client);
     this.core = new Core(client);
     if (authMode === "session") {

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@pear-protocol/core-sdk",
-  "version": "0.0.24",
+  "version": "0.1.0",
   "description": "Pear Protocol Core SDK",
   "private": false,
   "type": "module",
@@ -25,8 +25,8 @@
     "typecheck": "tsc --noEmit"
   },
   "dependencies": {
-    "@pear-protocol/types": "^0.0.21",
-    "@pear-protocol/utils": "^0.0.21",
+    "@pear-protocol/types": "^0.1.0",
+    "@pear-protocol/utils": "^0.0.22",
     "qs": "^6.14.0"
   },
   "devDependencies": {