@pear-protocol/types 0.0.1

package/dist/execution/entities.js

@@ -0,0 +1,125 @@
+import { z } from 'zod';
+import { UnsignedDecimalString, Side } from '../common/schema';
+import { Connector } from '../connector';
+import { InstrumentId } from '../instrument';
+import { Order } from '../order';
+import { Position } from '../position';
+
+const ExecutionIntent = z.enum(["OPEN", "CLOSE", "ADJUST"]);
+const ExecutionOrderType = z.enum(["MARKET"]);
+const ExecutionStatus = z.enum(["IDLE", "ACTIVE", "COMPLETED", "FAILED", "CANCELLED"]);
+const ExecutionLegMode = z.enum(["QUANTITY", "USD"]);
+const ExecutionLeg = z.object({
+  /**
+   * Instrument ID
+   */
+  symbol: InstrumentId,
+  /**
+   * Side
+   */
+  side: Side,
+  /**
+   * Mode to interpret the amount
+   */
+  mode: ExecutionLegMode,
+  /**
+   * Quantity or USD amount
+   */
+  amount: UnsignedDecimalString,
+  /**
+   * Reduce only flag
+   */
+  reduceOnly: z.boolean()
+});
+const BaseExecution = z.object({
+  /**
+   * Execution UUID
+   */
+  id: z.uuid(),
+  /**
+   * Connector
+   */
+  connector: Connector,
+  /**
+   * Intent
+   */
+  intent: ExecutionIntent,
+  /**
+   * Order type
+   */
+  orderType: ExecutionOrderType,
+  /**
+   * Status
+   */
+  status: ExecutionStatus,
+  /**
+   * Error message
+   */
+  error: z.string().optional(),
+  /**
+   * Created at timestamp
+   */
+  createdAt: z.string(),
+  /**
+   * Updated at timestamp
+   */
+  updatedAt: z.string(),
+  /**
+   * Orders
+   */
+  orders: z.array(Order).optional()
+});
+const MarketOpenExecution = BaseExecution.extend({
+  /**
+   * Intent
+   */
+  intent: z.literal("OPEN"),
+  /**
+   * Order type
+   */
+  orderType: z.literal("MARKET"),
+  /**
+   * Requested legs
+   */
+  legs: z.tuple([ExecutionLeg]).rest(ExecutionLeg)
+});
+const MarketAdjustExecution = BaseExecution.extend({
+  /**
+   * Intent
+   */
+  intent: z.literal("ADJUST"),
+  /**
+   * Order type
+   */
+  orderType: z.literal("MARKET"),
+  /**
+   * Position
+   */
+  position: Position.pick({ id: true, exposure: true }),
+  /**
+   * Requested legs
+   */
+  legs: z.tuple([ExecutionLeg]).rest(ExecutionLeg)
+});
+const MarketCloseExecution = BaseExecution.extend({
+  /**
+   * Intent
+   */
+  intent: z.literal("CLOSE"),
+  /**
+   * Order type
+   */
+  orderType: z.literal("MARKET"),
+  /**
+   * Position
+   */
+  position: Position.pick({ id: true, exposure: true })
+});
+const MarketExecution = z.discriminatedUnion("intent", [
+  MarketOpenExecution,
+  MarketAdjustExecution,
+  MarketCloseExecution
+]);
+const Execution = z.discriminatedUnion("orderType", [MarketExecution]);
+
+export { BaseExecution, Execution, ExecutionIntent, ExecutionLegMode, ExecutionOrderType, ExecutionStatus, MarketAdjustExecution, MarketCloseExecution, MarketExecution, MarketOpenExecution };

package/dist/execution/index.d.ts

@@ -0,0 +1,3 @@
+export * from './entities';
+export * from './queries';
+export * from './responses';

package/dist/execution/index.js

@@ -0,0 +1,3 @@
+export * from './entities';
+export * from './queries';
+export * from './responses';

package/dist/execution/queries.d.ts

@@ -0,0 +1,20 @@
+import { z } from 'zod';
+export declare const ExecutionListParams: z.ZodObject<{
+    limit: z.ZodDefault<z.ZodOptional<z.ZodCoercedNumber<number>>>;
+    cursor: z.ZodOptional<z.ZodString>;
+    connector: z.ZodOptional<z.ZodEnum<{
+        hyperliquid: "hyperliquid";
+        binanceusdm: "binanceusdm";
+        bybit: "bybit";
+        okx: "okx";
+    }>>;
+    status: z.ZodOptional<z.ZodPipe<z.ZodTransform<string[] | (("CANCELLED" | "ACTIVE" | "COMPLETED")[] & any[]) | undefined, ("CANCELLED" | "ACTIVE" | "COMPLETED")[]>, z.ZodArray<z.ZodEnum<{
+        CANCELLED: "CANCELLED";
+        ACTIVE: "ACTIVE";
+        COMPLETED: "COMPLETED";
+    }>>>>;
+    includeSchedule: z.ZodDefault<z.ZodOptional<z.ZodCoercedBoolean<boolean>>>;
+    includeTriggers: z.ZodDefault<z.ZodOptional<z.ZodCoercedBoolean<boolean>>>;
+}, z.core.$strip>;
+export type ExecutionListParamsInput = z.input<typeof ExecutionListParams>;
+export type ExecutionListParams = z.output<typeof ExecutionListParams>;

package/dist/execution/queries.js

@@ -0,0 +1,14 @@
+import { z } from 'zod';
+import { normalizeArray, CursorFindParams } from '../common';
+import { Connector } from '../connector';
+
+const StatusEnum = z.enum(["ACTIVE", "COMPLETED", "CANCELLED"]);
+const StatusArray = z.preprocess((arg) => normalizeArray(arg), z.array(StatusEnum));
+const ExecutionListParams = CursorFindParams.extend({
+  connector: Connector.optional(),
+  status: StatusArray.optional(),
+  includeSchedule: z.coerce.boolean().optional().default(false),
+  includeTriggers: z.coerce.boolean().optional().default(false)
+});
+
+export { ExecutionListParams };

package/dist/execution/responses.d.ts

@@ -0,0 +1,218 @@
+import { z } from 'zod';
+export declare const ExecutionListResponse: z.ZodObject<{
+    limit: z.ZodNumber;
+    nextCursor: z.ZodUnion<[z.ZodString, z.ZodUndefined]>;
+    executions: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodDiscriminatedUnion<[z.ZodObject<{
+        id: z.ZodUUID;
+        connector: z.ZodEnum<{
+            hyperliquid: "hyperliquid";
+            binanceusdm: "binanceusdm";
+            bybit: "bybit";
+            okx: "okx";
+        }>;
+        status: z.ZodEnum<{
+            CANCELLED: "CANCELLED";
+            IDLE: "IDLE";
+            ACTIVE: "ACTIVE";
+            COMPLETED: "COMPLETED";
+            FAILED: "FAILED";
+        }>;
+        error: z.ZodOptional<z.ZodString>;
+        createdAt: z.ZodString;
+        updatedAt: z.ZodString;
+        orders: z.ZodOptional<z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
+            id: z.ZodUUID;
+            connector: z.ZodEnum<{
+                hyperliquid: "hyperliquid";
+                binanceusdm: "binanceusdm";
+                bybit: "bybit";
+                okx: "okx";
+            }>;
+            status: z.ZodEnum<{
+                PENDING: "PENDING";
+                PARTIAL: "PARTIAL";
+                FILLED: "FILLED";
+                CANCELLED: "CANCELLED";
+                REJECTED: "REJECTED";
+            }>;
+            error: z.ZodOptional<z.ZodString>;
+            createdAt: z.ZodString;
+            updatedAt: z.ZodString;
+            type: z.ZodLiteral<"MARKET">;
+            symbol: z.ZodString;
+            side: z.ZodEnum<{
+                BUY: "BUY";
+                SELL: "SELL";
+            }>;
+            reduceOnly: z.ZodBoolean;
+            leverage: z.ZodInt;
+            quantity: z.ZodString;
+            price: z.ZodString;
+            filledQuantity: z.ZodString;
+            filledPrice: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>], "type">>>;
+        intent: z.ZodLiteral<"OPEN">;
+        orderType: z.ZodLiteral<"MARKET">;
+        legs: z.ZodTuple<[z.ZodObject<{
+            symbol: z.ZodString;
+            side: z.ZodEnum<{
+                BUY: "BUY";
+                SELL: "SELL";
+            }>;
+            mode: z.ZodEnum<{
+                QUANTITY: "QUANTITY";
+                USD: "USD";
+            }>;
+            amount: z.ZodString;
+            reduceOnly: z.ZodBoolean;
+        }, z.core.$strip>], z.ZodObject<{
+            symbol: z.ZodString;
+            side: z.ZodEnum<{
+                BUY: "BUY";
+                SELL: "SELL";
+            }>;
+            mode: z.ZodEnum<{
+                QUANTITY: "QUANTITY";
+                USD: "USD";
+            }>;
+            amount: z.ZodString;
+            reduceOnly: z.ZodBoolean;
+        }, z.core.$strip>>;
+    }, z.core.$strip>, z.ZodObject<{
+        id: z.ZodUUID;
+        connector: z.ZodEnum<{
+            hyperliquid: "hyperliquid";
+            binanceusdm: "binanceusdm";
+            bybit: "bybit";
+            okx: "okx";
+        }>;
+        status: z.ZodEnum<{
+            CANCELLED: "CANCELLED";
+            IDLE: "IDLE";
+            ACTIVE: "ACTIVE";
+            COMPLETED: "COMPLETED";
+            FAILED: "FAILED";
+        }>;
+        error: z.ZodOptional<z.ZodString>;
+        createdAt: z.ZodString;
+        updatedAt: z.ZodString;
+        orders: z.ZodOptional<z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
+            id: z.ZodUUID;
+            connector: z.ZodEnum<{
+                hyperliquid: "hyperliquid";
+                binanceusdm: "binanceusdm";
+                bybit: "bybit";
+                okx: "okx";
+            }>;
+            status: z.ZodEnum<{
+                PENDING: "PENDING";
+                PARTIAL: "PARTIAL";
+                FILLED: "FILLED";
+                CANCELLED: "CANCELLED";
+                REJECTED: "REJECTED";
+            }>;
+            error: z.ZodOptional<z.ZodString>;
+            createdAt: z.ZodString;
+            updatedAt: z.ZodString;
+            type: z.ZodLiteral<"MARKET">;
+            symbol: z.ZodString;
+            side: z.ZodEnum<{
+                BUY: "BUY";
+                SELL: "SELL";
+            }>;
+            reduceOnly: z.ZodBoolean;
+            leverage: z.ZodInt;
+            quantity: z.ZodString;
+            price: z.ZodString;
+            filledQuantity: z.ZodString;
+            filledPrice: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>], "type">>>;
+        intent: z.ZodLiteral<"ADJUST">;
+        orderType: z.ZodLiteral<"MARKET">;
+        position: z.ZodObject<{
+            id: z.ZodUUID;
+            exposure: z.ZodRecord<z.ZodString, z.ZodString>;
+        }, z.core.$strip>;
+        legs: z.ZodTuple<[z.ZodObject<{
+            symbol: z.ZodString;
+            side: z.ZodEnum<{
+                BUY: "BUY";
+                SELL: "SELL";
+            }>;
+            mode: z.ZodEnum<{
+                QUANTITY: "QUANTITY";
+                USD: "USD";
+            }>;
+            amount: z.ZodString;
+            reduceOnly: z.ZodBoolean;
+        }, z.core.$strip>], z.ZodObject<{
+            symbol: z.ZodString;
+            side: z.ZodEnum<{
+                BUY: "BUY";
+                SELL: "SELL";
+            }>;
+            mode: z.ZodEnum<{
+                QUANTITY: "QUANTITY";
+                USD: "USD";
+            }>;
+            amount: z.ZodString;
+            reduceOnly: z.ZodBoolean;
+        }, z.core.$strip>>;
+    }, z.core.$strip>, z.ZodObject<{
+        id: z.ZodUUID;
+        connector: z.ZodEnum<{
+            hyperliquid: "hyperliquid";
+            binanceusdm: "binanceusdm";
+            bybit: "bybit";
+            okx: "okx";
+        }>;
+        status: z.ZodEnum<{
+            CANCELLED: "CANCELLED";
+            IDLE: "IDLE";
+            ACTIVE: "ACTIVE";
+            COMPLETED: "COMPLETED";
+            FAILED: "FAILED";
+        }>;
+        error: z.ZodOptional<z.ZodString>;
+        createdAt: z.ZodString;
+        updatedAt: z.ZodString;
+        orders: z.ZodOptional<z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
+            id: z.ZodUUID;
+            connector: z.ZodEnum<{
+                hyperliquid: "hyperliquid";
+                binanceusdm: "binanceusdm";
+                bybit: "bybit";
+                okx: "okx";
+            }>;
+            status: z.ZodEnum<{
+                PENDING: "PENDING";
+                PARTIAL: "PARTIAL";
+                FILLED: "FILLED";
+                CANCELLED: "CANCELLED";
+                REJECTED: "REJECTED";
+            }>;
+            error: z.ZodOptional<z.ZodString>;
+            createdAt: z.ZodString;
+            updatedAt: z.ZodString;
+            type: z.ZodLiteral<"MARKET">;
+            symbol: z.ZodString;
+            side: z.ZodEnum<{
+                BUY: "BUY";
+                SELL: "SELL";
+            }>;
+            reduceOnly: z.ZodBoolean;
+            leverage: z.ZodInt;
+            quantity: z.ZodString;
+            price: z.ZodString;
+            filledQuantity: z.ZodString;
+            filledPrice: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>], "type">>>;
+        intent: z.ZodLiteral<"CLOSE">;
+        orderType: z.ZodLiteral<"MARKET">;
+        position: z.ZodObject<{
+            id: z.ZodUUID;
+            exposure: z.ZodRecord<z.ZodString, z.ZodString>;
+        }, z.core.$strip>;
+    }, z.core.$strip>], "intent">], "orderType">>;
+}, z.core.$strip>;
+export type ExecutionListResponse = z.output<typeof ExecutionListResponse>;

package/dist/execution/responses.js

@@ -0,0 +1,9 @@
+import { z } from 'zod';
+import { CursorResponse } from '../common';
+import { Execution } from './entities';
+
+const ExecutionListResponse = CursorResponse.extend({
+  executions: z.array(Execution)
+});
+
+export { ExecutionListResponse };

package/dist/fill/entities.d.ts

@@ -0,0 +1,25 @@
+import { z } from 'zod';
+export declare const Fill: z.ZodObject<{
+    id: z.ZodUUID;
+    cloid: z.ZodOptional<z.ZodUUID>;
+    tradeAccountId: z.ZodUUID;
+    symbol: z.ZodString;
+    positionId: z.ZodUUID;
+    connector: z.ZodEnum<{
+        hyperliquid: "hyperliquid";
+        binanceusdm: "binanceusdm";
+        bybit: "bybit";
+        okx: "okx";
+    }>;
+    side: z.ZodEnum<{
+        BUY: "BUY";
+        SELL: "SELL";
+    }>;
+    reduceOnly: z.ZodBoolean;
+    quantity: z.ZodString;
+    price: z.ZodString;
+    usd: z.ZodString;
+    fee: z.ZodOptional<z.ZodString>;
+    timestamp: z.ZodString;
+}, z.core.$strip>;
+export type Fill = z.output<typeof Fill>;

package/dist/fill/entities.js

@@ -0,0 +1,61 @@
+import { z } from 'zod';
+import { Side } from '../common/schema';
+import { Connector } from '../connector';
+import { InstrumentId } from '../instrument';
+
+const Fill = z.object({
+  /**
+   * Fill UUID
+   */
+  id: z.uuid(),
+  /**
+   * Client order ID
+   */
+  cloid: z.uuid().optional(),
+  /**
+   * Trade account UUID
+   */
+  tradeAccountId: z.uuid(),
+  /**
+   * Instrument ID
+   */
+  symbol: InstrumentId,
+  /**
+   * Position UUID
+   */
+  positionId: z.uuid(),
+  /**
+   * Connector
+   */
+  connector: Connector,
+  /**
+   * Side
+   */
+  side: Side,
+  /**
+   * Reduce only flag
+   */
+  reduceOnly: z.boolean(),
+  /**
+   * Filled quantity
+   */
+  quantity: z.string(),
+  /**
+   * Filled price
+   */
+  price: z.string(),
+  /**
+   * USD value
+   */
+  usd: z.string(),
+  /**
+   * Fee paid
+   */
+  fee: z.string().optional(),
+  /**
+   * Timestamp
+   */
+  timestamp: z.string()
+});
+
+export { Fill };

package/dist/fill/index.d.ts

@@ -0,0 +1,3 @@
+export * from './entities';
+export * from './queries';
+export * from './responses';

package/dist/fill/index.js

@@ -0,0 +1,3 @@
+export * from './entities';
+export * from './queries';
+export * from './responses';

package/dist/fill/queries.d.ts

@@ -0,0 +1,13 @@
+import { z } from 'zod';
+export declare const FillListParams: z.ZodObject<{
+    limit: z.ZodDefault<z.ZodOptional<z.ZodCoercedNumber<number>>>;
+    cursor: z.ZodOptional<z.ZodString>;
+    connector: z.ZodOptional<z.ZodEnum<{
+        hyperliquid: "hyperliquid";
+        binanceusdm: "binanceusdm";
+        bybit: "bybit";
+        okx: "okx";
+    }>>;
+    orderBy: z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<"timestamp">, z.ZodLiteral<"-timestamp">]>>;
+}, z.core.$strip>;
+export type FillListParams = z.output<typeof FillListParams>;

package/dist/fill/queries.js

@@ -0,0 +1,11 @@
+import { z } from 'zod';
+import { CursorFindParams } from '../common';
+import { Connector } from '../connector';
+
+const OrderBy = z.union([z.literal("timestamp"), z.literal("-timestamp")]);
+const FillListParams = CursorFindParams.extend({
+  connector: Connector.optional(),
+  orderBy: OrderBy.default("-timestamp")
+});
+
+export { FillListParams };

package/dist/fill/responses.d.ts

@@ -0,0 +1,55 @@
+import { z } from 'zod';
+export declare const FillListResponse: z.ZodObject<{
+    limit: z.ZodNumber;
+    nextCursor: z.ZodUnion<[z.ZodString, z.ZodUndefined]>;
+    fills: z.ZodArray<z.ZodObject<{
+        id: z.ZodUUID;
+        cloid: z.ZodOptional<z.ZodUUID>;
+        tradeAccountId: z.ZodUUID;
+        symbol: z.ZodString;
+        positionId: z.ZodUUID;
+        connector: z.ZodEnum<{
+            hyperliquid: "hyperliquid";
+            binanceusdm: "binanceusdm";
+            bybit: "bybit";
+            okx: "okx";
+        }>;
+        side: z.ZodEnum<{
+            BUY: "BUY";
+            SELL: "SELL";
+        }>;
+        reduceOnly: z.ZodBoolean;
+        quantity: z.ZodString;
+        price: z.ZodString;
+        usd: z.ZodString;
+        fee: z.ZodOptional<z.ZodString>;
+        timestamp: z.ZodString;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type FillListResponse = z.output<typeof FillListResponse>;
+export declare const PositionFillListResponse: z.ZodObject<{
+    fills: z.ZodArray<z.ZodObject<{
+        id: z.ZodUUID;
+        cloid: z.ZodOptional<z.ZodUUID>;
+        tradeAccountId: z.ZodUUID;
+        symbol: z.ZodString;
+        positionId: z.ZodUUID;
+        connector: z.ZodEnum<{
+            hyperliquid: "hyperliquid";
+            binanceusdm: "binanceusdm";
+            bybit: "bybit";
+            okx: "okx";
+        }>;
+        side: z.ZodEnum<{
+            BUY: "BUY";
+            SELL: "SELL";
+        }>;
+        reduceOnly: z.ZodBoolean;
+        quantity: z.ZodString;
+        price: z.ZodString;
+        usd: z.ZodString;
+        fee: z.ZodOptional<z.ZodString>;
+        timestamp: z.ZodString;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type PositionFillListResponse = z.output<typeof PositionFillListResponse>;

package/dist/fill/responses.js

@@ -0,0 +1,12 @@
+import { z } from 'zod';
+import { CursorResponse } from '../common';
+import { Fill } from './entities';
+
+const FillListResponse = CursorResponse.extend({
+  fills: z.array(Fill)
+});
+const PositionFillListResponse = z.object({
+  fills: z.array(Fill)
+});
+
+export { FillListResponse, PositionFillListResponse };

package/dist/funding/entities.d.ts

@@ -0,0 +1,11 @@
+import { z } from 'zod';
+export declare const FundingInfo: z.ZodObject<{
+    r: z.ZodString;
+    nft: z.ZodNumber;
+}, z.core.$strip>;
+export type FundingInfo = z.output<typeof FundingInfo>;
+export declare const InstrumentFundingMap: z.ZodRecord<z.ZodString, z.ZodObject<{
+    r: z.ZodString;
+    nft: z.ZodNumber;
+}, z.core.$strip>>;
+export type InstrumentFundingMap = z.output<typeof InstrumentFundingMap>;

package/dist/funding/entities.js

@@ -0,0 +1,16 @@
+import { z } from 'zod';
+import { InstrumentId } from '../instrument';
+
+const FundingInfo = z.object({
+  /**
+   * Funding rate
+   */
+  r: z.string(),
+  /**
+   * Next funding time in milliseconds
+   */
+  nft: z.number()
+});
+const InstrumentFundingMap = z.record(InstrumentId, FundingInfo);
+
+export { FundingInfo, InstrumentFundingMap };

package/dist/funding/index.d.ts

@@ -0,0 +1,3 @@
+export * from './entities';
+export * from './queries';
+export * from './responses';

package/dist/funding/index.js

@@ -0,0 +1,3 @@
+export * from './entities';
+export * from './queries';
+export * from './responses';

package/dist/funding/queries.d.ts

@@ -0,0 +1,10 @@
+import { z } from 'zod';
+export declare const FundingQueryParams: z.ZodObject<{
+    connector: z.ZodEnum<{
+        hyperliquid: "hyperliquid";
+        binanceusdm: "binanceusdm";
+        bybit: "bybit";
+        okx: "okx";
+    }>;
+}, z.core.$strip>;
+export type FundingQueryParams = z.output<typeof FundingQueryParams>;

package/dist/funding/queries.js

@@ -0,0 +1,8 @@
+import { z } from 'zod';
+import { Connector } from '../connector';
+
+const FundingQueryParams = z.object({
+  connector: Connector
+});
+
+export { FundingQueryParams };

package/dist/funding/responses.d.ts

@@ -0,0 +1,8 @@
+import { z } from 'zod';
+export declare const FundingResponse: z.ZodObject<{
+    funding: z.ZodRecord<z.ZodString, z.ZodObject<{
+        r: z.ZodString;
+        nft: z.ZodNumber;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type FundingResponse = z.output<typeof FundingResponse>;

package/dist/funding/responses.js

@@ -0,0 +1,11 @@
+import { z } from 'zod';
+import { InstrumentFundingMap } from './entities';
+
+const FundingResponse = z.object({
+  /**
+   * Funding rates and next funding times for instruments
+   */
+  funding: InstrumentFundingMap
+});
+
+export { FundingResponse };

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from './bundle';
+export * as HttpTypes from './bundle';