@pear-protocol/types 1.3.0 → 1.5.0

package/dist/ladder/entities.js

@@ -0,0 +1,18 @@
+import { z } from 'zod';
+import { Connector } from '../connector';
+import { Trigger } from '../trigger';
+import { LadderConfig } from './payloads';
+
+const LadderStatus = z.enum(["ACTIVE", "COMPLETED", "CANCELLED"]);
+const Ladder = z.object({
+  id: z.uuid(),
+  connector: Connector,
+  positionKey: z.string(),
+  config: LadderConfig,
+  status: LadderStatus,
+  triggers: z.array(Trigger),
+  createdAt: z.string(),
+  updatedAt: z.string()
+});
+
+export { Ladder, LadderStatus };

package/dist/ladder/index.d.ts

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

package/dist/ladder/index.js

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

package/dist/ladder/payloads.d.ts

@@ -0,0 +1,229 @@
+import { z } from 'zod';
+export declare const LadderConfig: z.ZodObject<{
+    thresholdStart: z.ZodNumber;
+    thresholdEnd: z.ZodNumber;
+    levels: z.ZodInt;
+    weighting: z.ZodDefault<z.ZodLiteral<"EQUAL">>;
+}, z.core.$strip>;
+export declare const LadderConditionOpen: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    type: z.ZodLiteral<"ratio">;
+    data: z.ZodObject<{
+        priceSource: z.ZodEnum<{
+            mid: "mid";
+            mark: "mark";
+        }>;
+        symbol_a: z.ZodString;
+        symbol_b: z.ZodString;
+        track: z.ZodEnum<{
+            PEAK: "PEAK";
+            TROUGH: "TROUGH";
+        }>;
+    }, z.core.$strip>;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<"price">;
+    data: z.ZodObject<{
+        priceSource: z.ZodEnum<{
+            mid: "mid";
+            mark: "mark";
+        }>;
+        symbol: z.ZodString;
+        track: z.ZodEnum<{
+            PEAK: "PEAK";
+            TROUGH: "TROUGH";
+        }>;
+    }, z.core.$strip>;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<"weighted_ratio">;
+    data: z.ZodObject<{
+        priceSource: z.ZodEnum<{
+            mid: "mid";
+            mark: "mark";
+        }>;
+        basket: z.ZodArray<z.ZodObject<{
+            symbol: z.ZodString;
+            side: z.ZodEnum<{
+                BUY: "BUY";
+                SELL: "SELL";
+            }>;
+            weight: z.ZodNumber;
+        }, z.core.$strip>>;
+        track: z.ZodEnum<{
+            PEAK: "PEAK";
+            TROUGH: "TROUGH";
+        }>;
+    }, z.core.$strip>;
+}, z.core.$strip>], "type">;
+export declare const CreateLadderMarketOpen: z.ZodObject<{
+    type: z.ZodLiteral<"MARKET">;
+    intent: z.ZodLiteral<"OPEN">;
+    clientId: z.ZodOptional<z.ZodString>;
+    condition: z.ZodDiscriminatedUnion<[z.ZodObject<{
+        type: z.ZodLiteral<"ratio">;
+        data: z.ZodObject<{
+            priceSource: z.ZodEnum<{
+                mid: "mid";
+                mark: "mark";
+            }>;
+            symbol_a: z.ZodString;
+            symbol_b: z.ZodString;
+            track: z.ZodEnum<{
+                PEAK: "PEAK";
+                TROUGH: "TROUGH";
+            }>;
+        }, z.core.$strip>;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<"price">;
+        data: z.ZodObject<{
+            priceSource: z.ZodEnum<{
+                mid: "mid";
+                mark: "mark";
+            }>;
+            symbol: z.ZodString;
+            track: z.ZodEnum<{
+                PEAK: "PEAK";
+                TROUGH: "TROUGH";
+            }>;
+        }, z.core.$strip>;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<"weighted_ratio">;
+        data: z.ZodObject<{
+            priceSource: z.ZodEnum<{
+                mid: "mid";
+                mark: "mark";
+            }>;
+            basket: z.ZodArray<z.ZodObject<{
+                symbol: z.ZodString;
+                side: z.ZodEnum<{
+                    BUY: "BUY";
+                    SELL: "SELL";
+                }>;
+                weight: z.ZodNumber;
+            }, z.core.$strip>>;
+            track: z.ZodEnum<{
+                PEAK: "PEAK";
+                TROUGH: "TROUGH";
+            }>;
+        }, z.core.$strip>;
+    }, z.core.$strip>], "type">;
+    config: z.ZodObject<{
+        thresholdStart: z.ZodNumber;
+        thresholdEnd: z.ZodNumber;
+        levels: z.ZodInt;
+        weighting: z.ZodDefault<z.ZodLiteral<"EQUAL">>;
+    }, z.core.$strip>;
+    payload: z.ZodObject<{
+        type: 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;
+        }, 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;
+        }, z.core.$strip>>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export declare const CreateLadder: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    type: z.ZodLiteral<"MARKET">;
+    intent: z.ZodLiteral<"OPEN">;
+    clientId: z.ZodOptional<z.ZodString>;
+    condition: z.ZodDiscriminatedUnion<[z.ZodObject<{
+        type: z.ZodLiteral<"ratio">;
+        data: z.ZodObject<{
+            priceSource: z.ZodEnum<{
+                mid: "mid";
+                mark: "mark";
+            }>;
+            symbol_a: z.ZodString;
+            symbol_b: z.ZodString;
+            track: z.ZodEnum<{
+                PEAK: "PEAK";
+                TROUGH: "TROUGH";
+            }>;
+        }, z.core.$strip>;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<"price">;
+        data: z.ZodObject<{
+            priceSource: z.ZodEnum<{
+                mid: "mid";
+                mark: "mark";
+            }>;
+            symbol: z.ZodString;
+            track: z.ZodEnum<{
+                PEAK: "PEAK";
+                TROUGH: "TROUGH";
+            }>;
+        }, z.core.$strip>;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<"weighted_ratio">;
+        data: z.ZodObject<{
+            priceSource: z.ZodEnum<{
+                mid: "mid";
+                mark: "mark";
+            }>;
+            basket: z.ZodArray<z.ZodObject<{
+                symbol: z.ZodString;
+                side: z.ZodEnum<{
+                    BUY: "BUY";
+                    SELL: "SELL";
+                }>;
+                weight: z.ZodNumber;
+            }, z.core.$strip>>;
+            track: z.ZodEnum<{
+                PEAK: "PEAK";
+                TROUGH: "TROUGH";
+            }>;
+        }, z.core.$strip>;
+    }, z.core.$strip>], "type">;
+    config: z.ZodObject<{
+        thresholdStart: z.ZodNumber;
+        thresholdEnd: z.ZodNumber;
+        levels: z.ZodInt;
+        weighting: z.ZodDefault<z.ZodLiteral<"EQUAL">>;
+    }, z.core.$strip>;
+    payload: z.ZodObject<{
+        type: 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;
+        }, 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;
+        }, z.core.$strip>>;
+    }, z.core.$strip>;
+}, z.core.$strip>], "type">;
+export type LadderConfig = z.output<typeof LadderConfig>;
+export type LadderConditionOpen = z.output<typeof LadderConditionOpen>;
+export type CreateLadderMarketOpen = z.output<typeof CreateLadderMarketOpen>;
+export type CreateLadder = z.output<typeof CreateLadder>;

package/dist/ladder/payloads.js

@@ -0,0 +1,73 @@
+import { z } from 'zod';
+import { ClientIdCode } from '../common/client-id';
+import { RefineMinimumTwoSymbols, RefineUniqueSymbols, RefineWeightingSum, RefineMinimumOneBuyOneSell, RefineTwoUniqueSymbols, RefineMinimumOneSymbol } from '../common/refinement';
+import { Side } from '../common/schema';
+import { TradeLegPostOnly } from '../common/trade-legs';
+import { InstrumentId } from '../instrument';
+import { MetricTrack } from '../trigger/common';
+
+const LadderThreshold = z.number().positive({
+  message: "Threshold must be greater than 0"
+});
+const LadderConfig = z.object({
+  thresholdStart: LadderThreshold,
+  thresholdEnd: LadderThreshold,
+  levels: z.int().min(2).max(50),
+  weighting: z.literal("EQUAL").default("EQUAL")
+}).refine((config) => config.thresholdStart !== config.thresholdEnd, {
+  message: "thresholds must differ"
+});
+const PriceSource = z.enum(["mid", "mark"], {
+  message: "Price source must be mid or mark"
+});
+const AssetWeight = z.number().positive({ message: "Weight must be greater than 0" }).max(1, { message: "Weight must be less than 1" });
+const WeightedRatioBasketItem = z.object({
+  symbol: InstrumentId,
+  side: Side,
+  weight: AssetWeight
+});
+const WeightedRatioBasket = z.array(WeightedRatioBasketItem).superRefine(RefineMinimumTwoSymbols).superRefine(RefineUniqueSymbols).superRefine(RefineWeightingSum).superRefine(RefineMinimumOneBuyOneSell);
+const LadderRatioOpen = z.object({
+  type: z.literal("ratio"),
+  data: z.object({
+    priceSource: PriceSource,
+    symbol_a: InstrumentId,
+    symbol_b: InstrumentId,
+    track: MetricTrack
+  }).superRefine(RefineTwoUniqueSymbols)
+});
+const LadderPriceOpen = z.object({
+  type: z.literal("price"),
+  data: z.object({
+    priceSource: PriceSource,
+    symbol: InstrumentId,
+    track: MetricTrack
+  })
+});
+const LadderWeightedRatioOpen = z.object({
+  type: z.literal("weighted_ratio"),
+  data: z.object({
+    priceSource: PriceSource,
+    basket: WeightedRatioBasket,
+    track: MetricTrack
+  })
+});
+const LadderConditionOpen = z.discriminatedUnion("type", [
+  LadderRatioOpen,
+  LadderPriceOpen,
+  LadderWeightedRatioOpen
+]);
+const CreateLadderMarketOpen = z.object({
+  type: z.literal("MARKET"),
+  intent: z.literal("OPEN"),
+  clientId: ClientIdCode,
+  condition: LadderConditionOpen,
+  config: LadderConfig,
+  payload: z.object({
+    type: z.literal("MARKET"),
+    legs: z.tuple([TradeLegPostOnly]).rest(TradeLegPostOnly).superRefine(RefineMinimumOneSymbol).superRefine(RefineUniqueSymbols)
+  })
+});
+const CreateLadder = z.discriminatedUnion("type", [CreateLadderMarketOpen]);
+
+export { CreateLadder, CreateLadderMarketOpen, LadderConditionOpen, LadderConfig };

package/dist/ladder/queries.d.ts

@@ -0,0 +1,14 @@
+import { z } from 'zod';
+export declare const LadderListParams: z.ZodObject<{
+    limit: z.ZodDefault<z.ZodOptional<z.ZodCoercedNumber<number>>>;
+    cursor: z.ZodOptional<z.ZodString>;
+    connector: z.ZodOptional<z.ZodEnum<{
+        hyperliquid: "hyperliquid";
+        binance: "binance";
+        bybit: "bybit";
+        okx: "okx";
+        lighter: "lighter";
+    }>>;
+}, z.core.$strip>;
+export type LadderListParamsInput = z.input<typeof LadderListParams>;
+export type LadderListParams = z.output<typeof LadderListParams>;

package/dist/ladder/queries.js

@@ -0,0 +1,9 @@
+import 'zod';
+import { CursorFindParams } from '../common';
+import { Connector } from '../connector';
+
+const LadderListParams = CursorFindParams.extend({
+  connector: Connector.optional()
+});
+
+export { LadderListParams };