@pear-protocol/types 0.0.20 → 0.1.0

package/dist/tca/responses.d.ts

@@ -0,0 +1,353 @@
+import { z } from 'zod';
+export declare const TcaBenchmarkResponse: z.ZodObject<{
+    id: z.ZodUUID;
+    executionId: z.ZodUUID;
+    orderId: z.ZodOptional<z.ZodUUID>;
+    cloid: z.ZodOptional<z.ZodString>;
+    legIndex: z.ZodNumber;
+    connector: z.ZodEnum<{
+        hyperliquid: "hyperliquid";
+        binance: "binance";
+        bybit: "bybit";
+        okx: "okx";
+        lighter: "lighter";
+    }>;
+    symbol: z.ZodString;
+    side: z.ZodEnum<{
+        BUY: "BUY";
+        SELL: "SELL";
+    }>;
+    decisionPrice: z.ZodOptional<z.ZodString>;
+    arrivalMid: z.ZodOptional<z.ZodString>;
+    arrivalBid: z.ZodOptional<z.ZodString>;
+    arrivalAsk: z.ZodOptional<z.ZodString>;
+    markPrice: z.ZodOptional<z.ZodString>;
+    indexPrice: z.ZodOptional<z.ZodString>;
+    source: z.ZodString;
+    timestamp: z.ZodISODateTime;
+    quoteAsset: z.ZodOptional<z.ZodString>;
+    usdConversionPrice: z.ZodOptional<z.ZodString>;
+    createdAt: z.ZodISODateTime;
+}, z.core.$strip>;
+export type TcaBenchmarkResponse = z.output<typeof TcaBenchmarkResponse>;
+export declare const TcaFillMetricResponse: z.ZodObject<{
+    id: z.ZodUUID;
+    fillId: z.ZodUUID;
+    benchmarkId: z.ZodOptional<z.ZodUUID>;
+    executionId: z.ZodOptional<z.ZodUUID>;
+    positionId: z.ZodOptional<z.ZodUUID>;
+    tradeAccountId: z.ZodUUID;
+    connector: z.ZodEnum<{
+        hyperliquid: "hyperliquid";
+        binance: "binance";
+        bybit: "bybit";
+        okx: "okx";
+        lighter: "lighter";
+    }>;
+    symbol: z.ZodString;
+    cloid: z.ZodOptional<z.ZodString>;
+    exchangeFillId: z.ZodOptional<z.ZodString>;
+    slippageBps: z.ZodOptional<z.ZodString>;
+    slippageQuote: z.ZodOptional<z.ZodString>;
+    slippageUsd: z.ZodOptional<z.ZodString>;
+    implementationShortfallBps: z.ZodOptional<z.ZodString>;
+    spreadCostQuote: z.ZodOptional<z.ZodString>;
+    spreadCostUsd: z.ZodOptional<z.ZodString>;
+    tradeFee: z.ZodOptional<z.ZodString>;
+    pearFee: z.ZodOptional<z.ZodString>;
+    totalCostUsd: z.ZodOptional<z.ZodString>;
+    gatewayLatencyMs: z.ZodOptional<z.ZodNumber>;
+    timeToFillMs: z.ZodOptional<z.ZodNumber>;
+    quoteAsset: z.ZodOptional<z.ZodString>;
+    notionalQuote: z.ZodOptional<z.ZodString>;
+    notionalUsd: z.ZodOptional<z.ZodString>;
+    submittedAt: z.ZodOptional<z.ZodISODateTime>;
+    acknowledgedAt: z.ZodOptional<z.ZodISODateTime>;
+    exchangeExecutedAt: z.ZodOptional<z.ZodISODateTime>;
+    timingGranularity: z.ZodOptional<z.ZodEnum<{
+        BATCH: "BATCH";
+        LEG: "LEG";
+    }>>;
+    status: z.ZodLiteral<"FINAL">;
+    createdAt: z.ZodISODateTime;
+    updatedAt: z.ZodISODateTime;
+    benchmark: z.ZodOptional<z.ZodObject<{
+        id: z.ZodUUID;
+        executionId: z.ZodUUID;
+        orderId: z.ZodOptional<z.ZodUUID>;
+        cloid: z.ZodOptional<z.ZodString>;
+        legIndex: z.ZodNumber;
+        connector: z.ZodEnum<{
+            hyperliquid: "hyperliquid";
+            binance: "binance";
+            bybit: "bybit";
+            okx: "okx";
+            lighter: "lighter";
+        }>;
+        symbol: z.ZodString;
+        side: z.ZodEnum<{
+            BUY: "BUY";
+            SELL: "SELL";
+        }>;
+        decisionPrice: z.ZodOptional<z.ZodString>;
+        arrivalMid: z.ZodOptional<z.ZodString>;
+        arrivalBid: z.ZodOptional<z.ZodString>;
+        arrivalAsk: z.ZodOptional<z.ZodString>;
+        markPrice: z.ZodOptional<z.ZodString>;
+        indexPrice: z.ZodOptional<z.ZodString>;
+        source: z.ZodString;
+        timestamp: z.ZodISODateTime;
+        quoteAsset: z.ZodOptional<z.ZodString>;
+        usdConversionPrice: z.ZodOptional<z.ZodString>;
+        createdAt: z.ZodISODateTime;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type TcaFillMetricResponse = z.output<typeof TcaFillMetricResponse>;
+export declare const TcaExecutionSummaryResponse: z.ZodObject<{
+    id: z.ZodUUID;
+    executionId: z.ZodUUID;
+    tradeAccountId: z.ZodUUID;
+    connector: z.ZodEnum<{
+        hyperliquid: "hyperliquid";
+        binance: "binance";
+        bybit: "bybit";
+        okx: "okx";
+        lighter: "lighter";
+    }>;
+    notionalQuote: z.ZodOptional<z.ZodString>;
+    notionalUsd: z.ZodOptional<z.ZodString>;
+    weightedSlippageBps: z.ZodOptional<z.ZodString>;
+    totalSlippageUsd: z.ZodOptional<z.ZodString>;
+    totalTradeFee: z.ZodOptional<z.ZodString>;
+    totalPearFee: z.ZodOptional<z.ZodString>;
+    totalCostUsd: z.ZodOptional<z.ZodString>;
+    fillCount: z.ZodNumber;
+    status: z.ZodLiteral<"FINAL">;
+    createdAt: z.ZodISODateTime;
+    updatedAt: z.ZodISODateTime;
+}, z.core.$strip>;
+export type TcaExecutionSummaryResponse = z.output<typeof TcaExecutionSummaryResponse>;
+export declare const TcaExecutionResponse: z.ZodObject<{
+    summary: z.ZodOptional<z.ZodObject<{
+        id: z.ZodUUID;
+        executionId: z.ZodUUID;
+        tradeAccountId: z.ZodUUID;
+        connector: z.ZodEnum<{
+            hyperliquid: "hyperliquid";
+            binance: "binance";
+            bybit: "bybit";
+            okx: "okx";
+            lighter: "lighter";
+        }>;
+        notionalQuote: z.ZodOptional<z.ZodString>;
+        notionalUsd: z.ZodOptional<z.ZodString>;
+        weightedSlippageBps: z.ZodOptional<z.ZodString>;
+        totalSlippageUsd: z.ZodOptional<z.ZodString>;
+        totalTradeFee: z.ZodOptional<z.ZodString>;
+        totalPearFee: z.ZodOptional<z.ZodString>;
+        totalCostUsd: z.ZodOptional<z.ZodString>;
+        fillCount: z.ZodNumber;
+        status: z.ZodLiteral<"FINAL">;
+        createdAt: z.ZodISODateTime;
+        updatedAt: z.ZodISODateTime;
+    }, z.core.$strip>>;
+    fillMetrics: z.ZodArray<z.ZodObject<{
+        id: z.ZodUUID;
+        fillId: z.ZodUUID;
+        benchmarkId: z.ZodOptional<z.ZodUUID>;
+        executionId: z.ZodOptional<z.ZodUUID>;
+        positionId: z.ZodOptional<z.ZodUUID>;
+        tradeAccountId: z.ZodUUID;
+        connector: z.ZodEnum<{
+            hyperliquid: "hyperliquid";
+            binance: "binance";
+            bybit: "bybit";
+            okx: "okx";
+            lighter: "lighter";
+        }>;
+        symbol: z.ZodString;
+        cloid: z.ZodOptional<z.ZodString>;
+        exchangeFillId: z.ZodOptional<z.ZodString>;
+        slippageBps: z.ZodOptional<z.ZodString>;
+        slippageQuote: z.ZodOptional<z.ZodString>;
+        slippageUsd: z.ZodOptional<z.ZodString>;
+        implementationShortfallBps: z.ZodOptional<z.ZodString>;
+        spreadCostQuote: z.ZodOptional<z.ZodString>;
+        spreadCostUsd: z.ZodOptional<z.ZodString>;
+        tradeFee: z.ZodOptional<z.ZodString>;
+        pearFee: z.ZodOptional<z.ZodString>;
+        totalCostUsd: z.ZodOptional<z.ZodString>;
+        gatewayLatencyMs: z.ZodOptional<z.ZodNumber>;
+        timeToFillMs: z.ZodOptional<z.ZodNumber>;
+        quoteAsset: z.ZodOptional<z.ZodString>;
+        notionalQuote: z.ZodOptional<z.ZodString>;
+        notionalUsd: z.ZodOptional<z.ZodString>;
+        submittedAt: z.ZodOptional<z.ZodISODateTime>;
+        acknowledgedAt: z.ZodOptional<z.ZodISODateTime>;
+        exchangeExecutedAt: z.ZodOptional<z.ZodISODateTime>;
+        timingGranularity: z.ZodOptional<z.ZodEnum<{
+            BATCH: "BATCH";
+            LEG: "LEG";
+        }>>;
+        status: z.ZodLiteral<"FINAL">;
+        createdAt: z.ZodISODateTime;
+        updatedAt: z.ZodISODateTime;
+        benchmark: z.ZodOptional<z.ZodObject<{
+            id: z.ZodUUID;
+            executionId: z.ZodUUID;
+            orderId: z.ZodOptional<z.ZodUUID>;
+            cloid: z.ZodOptional<z.ZodString>;
+            legIndex: z.ZodNumber;
+            connector: z.ZodEnum<{
+                hyperliquid: "hyperliquid";
+                binance: "binance";
+                bybit: "bybit";
+                okx: "okx";
+                lighter: "lighter";
+            }>;
+            symbol: z.ZodString;
+            side: z.ZodEnum<{
+                BUY: "BUY";
+                SELL: "SELL";
+            }>;
+            decisionPrice: z.ZodOptional<z.ZodString>;
+            arrivalMid: z.ZodOptional<z.ZodString>;
+            arrivalBid: z.ZodOptional<z.ZodString>;
+            arrivalAsk: z.ZodOptional<z.ZodString>;
+            markPrice: z.ZodOptional<z.ZodString>;
+            indexPrice: z.ZodOptional<z.ZodString>;
+            source: z.ZodString;
+            timestamp: z.ZodISODateTime;
+            quoteAsset: z.ZodOptional<z.ZodString>;
+            usdConversionPrice: z.ZodOptional<z.ZodString>;
+            createdAt: z.ZodISODateTime;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type TcaExecutionResponse = z.output<typeof TcaExecutionResponse>;
+export declare const TcaPositionResponse: z.ZodObject<{
+    limit: z.ZodNumber;
+    nextCursor: z.ZodOptional<z.ZodISODateTime>;
+    fillMetrics: z.ZodArray<z.ZodObject<{
+        id: z.ZodUUID;
+        fillId: z.ZodUUID;
+        benchmarkId: z.ZodOptional<z.ZodUUID>;
+        executionId: z.ZodOptional<z.ZodUUID>;
+        positionId: z.ZodOptional<z.ZodUUID>;
+        tradeAccountId: z.ZodUUID;
+        connector: z.ZodEnum<{
+            hyperliquid: "hyperliquid";
+            binance: "binance";
+            bybit: "bybit";
+            okx: "okx";
+            lighter: "lighter";
+        }>;
+        symbol: z.ZodString;
+        cloid: z.ZodOptional<z.ZodString>;
+        exchangeFillId: z.ZodOptional<z.ZodString>;
+        slippageBps: z.ZodOptional<z.ZodString>;
+        slippageQuote: z.ZodOptional<z.ZodString>;
+        slippageUsd: z.ZodOptional<z.ZodString>;
+        implementationShortfallBps: z.ZodOptional<z.ZodString>;
+        spreadCostQuote: z.ZodOptional<z.ZodString>;
+        spreadCostUsd: z.ZodOptional<z.ZodString>;
+        tradeFee: z.ZodOptional<z.ZodString>;
+        pearFee: z.ZodOptional<z.ZodString>;
+        totalCostUsd: z.ZodOptional<z.ZodString>;
+        gatewayLatencyMs: z.ZodOptional<z.ZodNumber>;
+        timeToFillMs: z.ZodOptional<z.ZodNumber>;
+        quoteAsset: z.ZodOptional<z.ZodString>;
+        notionalQuote: z.ZodOptional<z.ZodString>;
+        notionalUsd: z.ZodOptional<z.ZodString>;
+        submittedAt: z.ZodOptional<z.ZodISODateTime>;
+        acknowledgedAt: z.ZodOptional<z.ZodISODateTime>;
+        exchangeExecutedAt: z.ZodOptional<z.ZodISODateTime>;
+        timingGranularity: z.ZodOptional<z.ZodEnum<{
+            BATCH: "BATCH";
+            LEG: "LEG";
+        }>>;
+        status: z.ZodLiteral<"FINAL">;
+        createdAt: z.ZodISODateTime;
+        updatedAt: z.ZodISODateTime;
+        benchmark: z.ZodOptional<z.ZodObject<{
+            id: z.ZodUUID;
+            executionId: z.ZodUUID;
+            orderId: z.ZodOptional<z.ZodUUID>;
+            cloid: z.ZodOptional<z.ZodString>;
+            legIndex: z.ZodNumber;
+            connector: z.ZodEnum<{
+                hyperliquid: "hyperliquid";
+                binance: "binance";
+                bybit: "bybit";
+                okx: "okx";
+                lighter: "lighter";
+            }>;
+            symbol: z.ZodString;
+            side: z.ZodEnum<{
+                BUY: "BUY";
+                SELL: "SELL";
+            }>;
+            decisionPrice: z.ZodOptional<z.ZodString>;
+            arrivalMid: z.ZodOptional<z.ZodString>;
+            arrivalBid: z.ZodOptional<z.ZodString>;
+            arrivalAsk: z.ZodOptional<z.ZodString>;
+            markPrice: z.ZodOptional<z.ZodString>;
+            indexPrice: z.ZodOptional<z.ZodString>;
+            source: z.ZodString;
+            timestamp: z.ZodISODateTime;
+            quoteAsset: z.ZodOptional<z.ZodString>;
+            usdConversionPrice: z.ZodOptional<z.ZodString>;
+            createdAt: z.ZodISODateTime;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type TcaPositionResponse = z.output<typeof TcaPositionResponse>;
+export declare const TcaSummaryTotalsResponse: z.ZodObject<{
+    executionCount: z.ZodNumber;
+    fillCount: z.ZodNumber;
+    notionalQuote: z.ZodOptional<z.ZodString>;
+    notionalUsd: z.ZodOptional<z.ZodString>;
+    totalSlippageUsd: z.ZodOptional<z.ZodString>;
+    totalTradeFee: z.ZodOptional<z.ZodString>;
+    totalPearFee: z.ZodOptional<z.ZodString>;
+    totalCostUsd: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type TcaSummaryTotalsResponse = z.output<typeof TcaSummaryTotalsResponse>;
+export declare const TcaSummaryResponse: z.ZodObject<{
+    limit: z.ZodNumber;
+    nextCursor: z.ZodOptional<z.ZodISODateTime>;
+    summaries: z.ZodArray<z.ZodObject<{
+        id: z.ZodUUID;
+        executionId: z.ZodUUID;
+        tradeAccountId: z.ZodUUID;
+        connector: z.ZodEnum<{
+            hyperliquid: "hyperliquid";
+            binance: "binance";
+            bybit: "bybit";
+            okx: "okx";
+            lighter: "lighter";
+        }>;
+        notionalQuote: z.ZodOptional<z.ZodString>;
+        notionalUsd: z.ZodOptional<z.ZodString>;
+        weightedSlippageBps: z.ZodOptional<z.ZodString>;
+        totalSlippageUsd: z.ZodOptional<z.ZodString>;
+        totalTradeFee: z.ZodOptional<z.ZodString>;
+        totalPearFee: z.ZodOptional<z.ZodString>;
+        totalCostUsd: z.ZodOptional<z.ZodString>;
+        fillCount: z.ZodNumber;
+        status: z.ZodLiteral<"FINAL">;
+        createdAt: z.ZodISODateTime;
+        updatedAt: z.ZodISODateTime;
+    }, z.core.$strip>>;
+    totals: z.ZodObject<{
+        executionCount: z.ZodNumber;
+        fillCount: z.ZodNumber;
+        notionalQuote: z.ZodOptional<z.ZodString>;
+        notionalUsd: z.ZodOptional<z.ZodString>;
+        totalSlippageUsd: z.ZodOptional<z.ZodString>;
+        totalTradeFee: z.ZodOptional<z.ZodString>;
+        totalPearFee: z.ZodOptional<z.ZodString>;
+        totalCostUsd: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type TcaSummaryResponse = z.output<typeof TcaSummaryResponse>;

package/dist/tca/responses.js

@@ -0,0 +1,105 @@
+import { z } from 'zod';
+import { Connector } from '../connector';
+import { TcaMetricStatus, TcaTimingGranularity } from './entities';
+
+const optionalNumeric = z.string().optional();
+const optionalTimestamp = z.iso.datetime().optional();
+const TcaBenchmarkResponse = z.object({
+  id: z.uuid(),
+  executionId: z.uuid(),
+  orderId: z.uuid().optional(),
+  cloid: z.string().optional(),
+  legIndex: z.number(),
+  connector: Connector,
+  symbol: z.string(),
+  side: z.enum(["BUY", "SELL"]),
+  decisionPrice: optionalNumeric,
+  arrivalMid: optionalNumeric,
+  arrivalBid: optionalNumeric,
+  arrivalAsk: optionalNumeric,
+  markPrice: optionalNumeric,
+  indexPrice: optionalNumeric,
+  source: z.string(),
+  timestamp: z.iso.datetime(),
+  quoteAsset: z.string().optional(),
+  usdConversionPrice: optionalNumeric,
+  createdAt: z.iso.datetime()
+});
+const TcaFillMetricResponse = z.object({
+  id: z.uuid(),
+  fillId: z.uuid(),
+  benchmarkId: z.uuid().optional(),
+  executionId: z.uuid().optional(),
+  positionId: z.uuid().optional(),
+  tradeAccountId: z.uuid(),
+  connector: Connector,
+  symbol: z.string(),
+  cloid: z.string().optional(),
+  exchangeFillId: z.string().optional(),
+  slippageBps: optionalNumeric,
+  slippageQuote: optionalNumeric,
+  slippageUsd: optionalNumeric,
+  implementationShortfallBps: optionalNumeric,
+  spreadCostQuote: optionalNumeric,
+  spreadCostUsd: optionalNumeric,
+  tradeFee: optionalNumeric,
+  pearFee: optionalNumeric,
+  totalCostUsd: optionalNumeric,
+  gatewayLatencyMs: z.number().optional(),
+  timeToFillMs: z.number().optional(),
+  quoteAsset: z.string().optional(),
+  notionalQuote: optionalNumeric,
+  notionalUsd: optionalNumeric,
+  submittedAt: optionalTimestamp,
+  acknowledgedAt: optionalTimestamp,
+  exchangeExecutedAt: optionalTimestamp,
+  timingGranularity: TcaTimingGranularity.optional(),
+  status: TcaMetricStatus,
+  createdAt: z.iso.datetime(),
+  updatedAt: z.iso.datetime(),
+  benchmark: TcaBenchmarkResponse.optional()
+});
+const TcaExecutionSummaryResponse = z.object({
+  id: z.uuid(),
+  executionId: z.uuid(),
+  tradeAccountId: z.uuid(),
+  connector: Connector,
+  notionalQuote: optionalNumeric,
+  notionalUsd: optionalNumeric,
+  weightedSlippageBps: optionalNumeric,
+  totalSlippageUsd: optionalNumeric,
+  totalTradeFee: optionalNumeric,
+  totalPearFee: optionalNumeric,
+  totalCostUsd: optionalNumeric,
+  fillCount: z.number(),
+  status: TcaMetricStatus,
+  createdAt: z.iso.datetime(),
+  updatedAt: z.iso.datetime()
+});
+const TcaExecutionResponse = z.object({
+  summary: TcaExecutionSummaryResponse.optional(),
+  fillMetrics: z.array(TcaFillMetricResponse)
+});
+const TcaPositionResponse = z.object({
+  limit: z.number(),
+  nextCursor: z.iso.datetime().optional(),
+  fillMetrics: z.array(TcaFillMetricResponse)
+});
+const TcaSummaryTotalsResponse = z.object({
+  executionCount: z.number(),
+  fillCount: z.number(),
+  notionalQuote: optionalNumeric,
+  notionalUsd: optionalNumeric,
+  totalSlippageUsd: optionalNumeric,
+  totalTradeFee: optionalNumeric,
+  totalPearFee: optionalNumeric,
+  totalCostUsd: optionalNumeric
+});
+const TcaSummaryResponse = z.object({
+  limit: z.number(),
+  nextCursor: z.iso.datetime().optional(),
+  summaries: z.array(TcaExecutionSummaryResponse),
+  totals: TcaSummaryTotalsResponse
+});
+
+export { TcaBenchmarkResponse, TcaExecutionResponse, TcaExecutionSummaryResponse, TcaFillMetricResponse, TcaPositionResponse, TcaSummaryResponse, TcaSummaryTotalsResponse };

package/dist/users/entities.d.ts

@@ -8,6 +8,7 @@ export declare const UserProfile: z.ZodObject<{
     role: z.ZodEnum<{
         basic: "basic";
         pro: "pro";
+        admin: "admin";
     }>;
     address: z.ZodNullable<z.ZodString>;
     email: z.ZodNullable<z.ZodString>;

package/dist/users/entities.js

@@ -6,7 +6,7 @@ const UserPreferences = z.object({
 const UserProfile = z.object({
   id: z.uuid().describe("User UUID"),
   displayName: z.string().describe("Public display name"),
-  role: z.enum(["basic", "pro"]).describe("User role"),
+  role: z.enum(["basic", "pro", "admin"]).describe("User role"),
   address: z.string().nullable().describe("Linked wallet address (for evm_wallet provider)"),
   email: z.string().nullable().describe("Linked email address (for email provider)"),
   emailVerified: z.boolean().describe("Whether the email is verified")

package/dist/users/response.d.ts

@@ -6,6 +6,7 @@ export declare const ProfileResponse: z.ZodObject<{
         role: z.ZodEnum<{
             basic: "basic";
             pro: "pro";
+            admin: "admin";
         }>;
         address: z.ZodNullable<z.ZodString>;
         email: z.ZodNullable<z.ZodString>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pear-protocol/types",
-  "version": "0.0.20",
+  "version": "0.1.0",
   "description": "Pear Protocol Types definitions",
   "private": false,
   "type": "module",