@pear-protocol/types 0.0.1

package/dist/trigger/payloads/index.d.ts

@@ -0,0 +1,470 @@
+import { z } from 'zod';
+export declare const CreateTriggerMarketOpen: z.ZodObject<{
+    intent: z.ZodLiteral<"OPEN">;
+    type: z.ZodLiteral<"MARKET">;
+    condition: z.ZodDiscriminatedUnion<[z.ZodObject<{
+        type: z.ZodLiteral<"ratio_v1">;
+        data: z.ZodObject<{
+            priceSource: z.ZodEnum<{
+                mid: "mid";
+                mark: "mark";
+            }>;
+            symbol_a: z.ZodString;
+            symbol_b: z.ZodString;
+            direction: z.ZodEnum<{
+                ABOVE: "ABOVE";
+                BELOW: "BELOW";
+            }>;
+            threshold: z.ZodNumber;
+        }, z.core.$strip>;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<"price_v1">;
+        data: z.ZodObject<{
+            priceSource: z.ZodEnum<{
+                mid: "mid";
+                mark: "mark";
+            }>;
+            symbol: z.ZodString;
+            direction: z.ZodEnum<{
+                ABOVE: "ABOVE";
+                BELOW: "BELOW";
+            }>;
+            threshold: z.ZodNumber;
+        }, z.core.$strip>;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<"index_v1">;
+        data: z.ZodObject<{
+            priceSource: z.ZodEnum<{
+                mid: "mid";
+                mark: "mark";
+            }>;
+            basket: z.ZodArray<z.ZodObject<{
+                symbol: z.ZodString;
+                weight: z.ZodNumber;
+            }, z.core.$strip>>;
+            direction: z.ZodEnum<{
+                ABOVE: "ABOVE";
+                BELOW: "BELOW";
+            }>;
+            threshold: z.ZodNumber;
+        }, z.core.$strip>;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<"weighted_ratio_v1">;
+        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>>;
+            direction: z.ZodEnum<{
+                ABOVE: "ABOVE";
+                BELOW: "BELOW";
+            }>;
+            threshold: z.ZodNumber;
+        }, z.core.$strip>;
+    }, z.core.$strip>], "type">;
+    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 CreateTriggerMarketClose: z.ZodObject<{
+    intent: z.ZodLiteral<"CLOSE">;
+    type: z.ZodLiteral<"MARKET">;
+    condition: z.ZodDiscriminatedUnion<[z.ZodObject<{
+        type: z.ZodLiteral<"ratio_v1">;
+        data: z.ZodObject<{
+            priceSource: z.ZodEnum<{
+                mid: "mid";
+                mark: "mark";
+            }>;
+            symbol_a: z.ZodString;
+            symbol_b: z.ZodString;
+            direction: z.ZodEnum<{
+                ABOVE: "ABOVE";
+                BELOW: "BELOW";
+            }>;
+            threshold: z.ZodNumber;
+        }, z.core.$strip>;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<"price_v1">;
+        data: z.ZodObject<{
+            priceSource: z.ZodEnum<{
+                mid: "mid";
+                mark: "mark";
+            }>;
+            symbol: z.ZodString;
+            direction: z.ZodEnum<{
+                ABOVE: "ABOVE";
+                BELOW: "BELOW";
+            }>;
+            threshold: z.ZodNumber;
+        }, z.core.$strip>;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<"index_v1">;
+        data: z.ZodObject<{
+            priceSource: z.ZodEnum<{
+                mid: "mid";
+                mark: "mark";
+            }>;
+            basket: z.ZodArray<z.ZodObject<{
+                symbol: z.ZodString;
+                weight: z.ZodNumber;
+            }, z.core.$strip>>;
+            direction: z.ZodEnum<{
+                ABOVE: "ABOVE";
+                BELOW: "BELOW";
+            }>;
+            threshold: z.ZodNumber;
+        }, z.core.$strip>;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<"weighted_ratio_v1">;
+        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>>;
+            direction: z.ZodEnum<{
+                ABOVE: "ABOVE";
+                BELOW: "BELOW";
+            }>;
+            threshold: z.ZodNumber;
+        }, z.core.$strip>;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<"position_value_v1">;
+        data: z.ZodObject<{
+            priceSource: z.ZodEnum<{
+                mid: "mid";
+                mark: "mark";
+            }>;
+            direction: z.ZodEnum<{
+                ABOVE: "ABOVE";
+                BELOW: "BELOW";
+            }>;
+            threshold: z.ZodNumber;
+        }, z.core.$strip>;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<"position_upnl_value_v1">;
+        data: z.ZodObject<{
+            priceSource: z.ZodEnum<{
+                mid: "mid";
+                mark: "mark";
+            }>;
+            direction: z.ZodEnum<{
+                ABOVE: "ABOVE";
+                BELOW: "BELOW";
+            }>;
+            threshold: z.ZodNumber;
+        }, z.core.$strip>;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<"position_upnl_percentage_v1">;
+        data: z.ZodObject<{
+            priceSource: z.ZodEnum<{
+                mid: "mid";
+                mark: "mark";
+            }>;
+            direction: z.ZodEnum<{
+                ABOVE: "ABOVE";
+                BELOW: "BELOW";
+            }>;
+            threshold_bps: z.ZodNumber;
+        }, z.core.$strip>;
+    }, z.core.$strip>], "type">;
+    positionId: z.ZodUUID;
+}, z.core.$strip>;
+export declare const AttachTriggerMarketClose: z.ZodObject<{
+    intent: z.ZodLiteral<"CLOSE">;
+    type: z.ZodLiteral<"MARKET">;
+    condition: z.ZodDiscriminatedUnion<[z.ZodObject<{
+        type: z.ZodLiteral<"position_value_v1">;
+        data: z.ZodObject<{
+            priceSource: z.ZodEnum<{
+                mid: "mid";
+                mark: "mark";
+            }>;
+            direction: z.ZodEnum<{
+                ABOVE: "ABOVE";
+                BELOW: "BELOW";
+            }>;
+            threshold: z.ZodNumber;
+        }, z.core.$strip>;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<"position_upnl_value_v1">;
+        data: z.ZodObject<{
+            priceSource: z.ZodEnum<{
+                mid: "mid";
+                mark: "mark";
+            }>;
+            direction: z.ZodEnum<{
+                ABOVE: "ABOVE";
+                BELOW: "BELOW";
+            }>;
+            threshold: z.ZodNumber;
+        }, z.core.$strip>;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<"position_upnl_percentage_v1">;
+        data: z.ZodObject<{
+            priceSource: z.ZodEnum<{
+                mid: "mid";
+                mark: "mark";
+            }>;
+            direction: z.ZodEnum<{
+                ABOVE: "ABOVE";
+                BELOW: "BELOW";
+            }>;
+            threshold_bps: z.ZodNumber;
+        }, z.core.$strip>;
+    }, z.core.$strip>], "type">;
+}, z.core.$strip>;
+export declare const CreateTriggerOpen: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    intent: z.ZodLiteral<"OPEN">;
+    type: z.ZodLiteral<"MARKET">;
+    condition: z.ZodDiscriminatedUnion<[z.ZodObject<{
+        type: z.ZodLiteral<"ratio_v1">;
+        data: z.ZodObject<{
+            priceSource: z.ZodEnum<{
+                mid: "mid";
+                mark: "mark";
+            }>;
+            symbol_a: z.ZodString;
+            symbol_b: z.ZodString;
+            direction: z.ZodEnum<{
+                ABOVE: "ABOVE";
+                BELOW: "BELOW";
+            }>;
+            threshold: z.ZodNumber;
+        }, z.core.$strip>;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<"price_v1">;
+        data: z.ZodObject<{
+            priceSource: z.ZodEnum<{
+                mid: "mid";
+                mark: "mark";
+            }>;
+            symbol: z.ZodString;
+            direction: z.ZodEnum<{
+                ABOVE: "ABOVE";
+                BELOW: "BELOW";
+            }>;
+            threshold: z.ZodNumber;
+        }, z.core.$strip>;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<"index_v1">;
+        data: z.ZodObject<{
+            priceSource: z.ZodEnum<{
+                mid: "mid";
+                mark: "mark";
+            }>;
+            basket: z.ZodArray<z.ZodObject<{
+                symbol: z.ZodString;
+                weight: z.ZodNumber;
+            }, z.core.$strip>>;
+            direction: z.ZodEnum<{
+                ABOVE: "ABOVE";
+                BELOW: "BELOW";
+            }>;
+            threshold: z.ZodNumber;
+        }, z.core.$strip>;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<"weighted_ratio_v1">;
+        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>>;
+            direction: z.ZodEnum<{
+                ABOVE: "ABOVE";
+                BELOW: "BELOW";
+            }>;
+            threshold: z.ZodNumber;
+        }, z.core.$strip>;
+    }, z.core.$strip>], "type">;
+    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 declare const CreateTriggerClose: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    intent: z.ZodLiteral<"CLOSE">;
+    type: z.ZodLiteral<"MARKET">;
+    condition: z.ZodDiscriminatedUnion<[z.ZodObject<{
+        type: z.ZodLiteral<"ratio_v1">;
+        data: z.ZodObject<{
+            priceSource: z.ZodEnum<{
+                mid: "mid";
+                mark: "mark";
+            }>;
+            symbol_a: z.ZodString;
+            symbol_b: z.ZodString;
+            direction: z.ZodEnum<{
+                ABOVE: "ABOVE";
+                BELOW: "BELOW";
+            }>;
+            threshold: z.ZodNumber;
+        }, z.core.$strip>;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<"price_v1">;
+        data: z.ZodObject<{
+            priceSource: z.ZodEnum<{
+                mid: "mid";
+                mark: "mark";
+            }>;
+            symbol: z.ZodString;
+            direction: z.ZodEnum<{
+                ABOVE: "ABOVE";
+                BELOW: "BELOW";
+            }>;
+            threshold: z.ZodNumber;
+        }, z.core.$strip>;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<"index_v1">;
+        data: z.ZodObject<{
+            priceSource: z.ZodEnum<{
+                mid: "mid";
+                mark: "mark";
+            }>;
+            basket: z.ZodArray<z.ZodObject<{
+                symbol: z.ZodString;
+                weight: z.ZodNumber;
+            }, z.core.$strip>>;
+            direction: z.ZodEnum<{
+                ABOVE: "ABOVE";
+                BELOW: "BELOW";
+            }>;
+            threshold: z.ZodNumber;
+        }, z.core.$strip>;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<"weighted_ratio_v1">;
+        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>>;
+            direction: z.ZodEnum<{
+                ABOVE: "ABOVE";
+                BELOW: "BELOW";
+            }>;
+            threshold: z.ZodNumber;
+        }, z.core.$strip>;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<"position_value_v1">;
+        data: z.ZodObject<{
+            priceSource: z.ZodEnum<{
+                mid: "mid";
+                mark: "mark";
+            }>;
+            direction: z.ZodEnum<{
+                ABOVE: "ABOVE";
+                BELOW: "BELOW";
+            }>;
+            threshold: z.ZodNumber;
+        }, z.core.$strip>;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<"position_upnl_value_v1">;
+        data: z.ZodObject<{
+            priceSource: z.ZodEnum<{
+                mid: "mid";
+                mark: "mark";
+            }>;
+            direction: z.ZodEnum<{
+                ABOVE: "ABOVE";
+                BELOW: "BELOW";
+            }>;
+            threshold: z.ZodNumber;
+        }, z.core.$strip>;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<"position_upnl_percentage_v1">;
+        data: z.ZodObject<{
+            priceSource: z.ZodEnum<{
+                mid: "mid";
+                mark: "mark";
+            }>;
+            direction: z.ZodEnum<{
+                ABOVE: "ABOVE";
+                BELOW: "BELOW";
+            }>;
+            threshold_bps: z.ZodNumber;
+        }, z.core.$strip>;
+    }, z.core.$strip>], "type">;
+    positionId: z.ZodUUID;
+}, z.core.$strip>], "type">;
+export type CreateTriggerMarketOpen = z.output<typeof CreateTriggerMarketOpen>;
+export type CreateTriggerMarketClose = z.output<typeof CreateTriggerMarketClose>;
+export type AttachTriggerMarketClose = z.output<typeof AttachTriggerMarketClose>;
+export type CreateTriggerOpen = z.output<typeof CreateTriggerOpen>;
+export type CreateTriggerClose = z.output<typeof CreateTriggerClose>;

package/dist/trigger/payloads/index.js

@@ -0,0 +1,47 @@
+import { z } from 'zod';
+import { RefineMinimumOneSymbol, RefineUniqueSymbols } from '../../common/refinement';
+import { TradeLegPostOnly } from '../../common/trade-legs';
+import { CreateTriggerConditionOpen, CreateTriggerConditionClose, CreateTriggerConditionAttach } from './conditions';
+
+const CreateTriggerMarketOpen = z.object({
+  intent: z.literal("OPEN"),
+  type: z.literal("MARKET"),
+  /**
+   * Condition to fire the trigger
+   */
+  condition: CreateTriggerConditionOpen,
+  /**
+   * MARKET Execution details to execute when the trigger is fired
+   */
+  payload: z.object({
+    type: z.literal("MARKET"),
+    /**
+     * Requested legs
+     */
+    legs: z.tuple([TradeLegPostOnly]).rest(TradeLegPostOnly).superRefine(RefineMinimumOneSymbol).superRefine(RefineUniqueSymbols).describe("Array of legs to make up the exposure")
+  })
+});
+const CreateTriggerMarketClose = z.object({
+  intent: z.literal("CLOSE"),
+  type: z.literal("MARKET"),
+  /**
+   * Condition to fire the trigger
+   */
+  condition: CreateTriggerConditionClose,
+  /**
+   * Position UUID
+   */
+  positionId: z.uuid()
+});
+const AttachTriggerMarketClose = z.object({
+  intent: z.literal("CLOSE"),
+  type: z.literal("MARKET"),
+  /**
+   * Condition to fire the trigger
+   */
+  condition: CreateTriggerConditionAttach
+});
+const CreateTriggerOpen = z.discriminatedUnion("type", [CreateTriggerMarketOpen]);
+const CreateTriggerClose = z.discriminatedUnion("type", [CreateTriggerMarketClose]);
+
+export { AttachTriggerMarketClose, CreateTriggerClose, CreateTriggerMarketClose, CreateTriggerMarketOpen, CreateTriggerOpen };

package/dist/trigger/queries.d.ts

@@ -0,0 +1,18 @@
+import { z } from 'zod';
+export declare const TriggerListParams: 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";
+    }>>>>;
+}, z.core.$strip>;
+export type TriggerListParamsInput = z.input<typeof TriggerListParams>;
+export type TriggerListParams = z.output<typeof TriggerListParams>;

package/dist/trigger/queries.js

@@ -0,0 +1,12 @@
+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 TriggerListParams = CursorFindParams.extend({
+  connector: Connector.optional(),
+  status: StatusArray.optional()
+});
+
+export { TriggerListParams };