@pear-protocol/types 2.4.0 → 2.6.0

package/dist/position/entities.d.ts

@@ -523,8 +523,14 @@ export declare const VaultOpenPosition: z.ZodObject<{
 }, z.core.$strip>;
 export type VaultOpenPosition = z.output<typeof VaultOpenPosition>;
 /**
- * The public, vault-scoped view of one closed leg: entry, exit and PnL, with fees, funding
- * and committed-cash figures withheld. Same allowlist rule as `VaultOpenPositionLeg`.
+ * The public, vault-scoped view of one closed leg: entry, exit, committed cash and PnL,
+ * with fees and funding withheld. Same allowlist rule as `VaultOpenPositionLeg`.
+ * `entryNotional` is this leg's peak committed cash, not an additive share of the position.
+ * For basket ratios, divide each leg's value by the sum of all leg entry notionals.
+ * "0" means committed cash is unknowable after an unpriced synthetic entry; clients
+ * must leave the basket quote unknown rather than treat that leg as weightless.
+ * Either VWAP is absent on a leg the ledger never priced, and absence binds the same
+ * way: quote the side that priced, and leave the side that did not unknown.
  */
 export declare const VaultClosedPositionLeg: z.ZodObject<{
     side: z.ZodEnum<{
@@ -534,14 +540,15 @@ export declare const VaultClosedPositionLeg: z.ZodObject<{
     asset: z.ZodString;
     grossPnl: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
     netPnl: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
+    entryNotional: z.ZodString;
     entryVwap: z.ZodOptional<z.ZodString>;
     exitVwap: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
 export type VaultClosedPositionLeg = z.output<typeof VaultClosedPositionLeg>;
 /**
- * The public, vault-scoped view of one closed position: lifecycle, position-level PnL and
- * the reduced legs. Funding is withheld for the same reason as on `VaultOpenPosition`;
- * `netPnl` never folds it in, so the published figures stay exact without it.
+ * The public, vault-scoped view of one closed position: lifecycle, position-level PnL,
+ * and reduced legs with the inputs needed to quote the basket. Funding is withheld for
+ * the same reason as on `VaultOpenPosition`; `netPnl` never folds it in.
  */
 export declare const VaultClosedPosition: z.ZodObject<{
     status: z.ZodLiteral<"CLOSED">;
@@ -571,6 +578,7 @@ export declare const VaultClosedPosition: z.ZodObject<{
         asset: z.ZodString;
         grossPnl: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
         netPnl: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
+        entryNotional: z.ZodString;
         entryVwap: z.ZodOptional<z.ZodString>;
         exitVwap: z.ZodOptional<z.ZodString>;
     }, z.core.$strip>>;

package/dist/position/entities.js

@@ -394,6 +394,7 @@ const VaultClosedPositionLeg = ClosedPositionLeg.pick({
   side: true,
   entryVwap: true,
   exitVwap: true,
+  entryNotional: true,
   grossPnl: true,
   netPnl: true
 });

package/dist/position/responses.d.ts

@@ -379,6 +379,7 @@ export declare const VaultClosedPositionListResponse: z.ZodObject<{
             asset: z.ZodString;
             grossPnl: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
             netPnl: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
+            entryNotional: z.ZodString;
             entryVwap: z.ZodOptional<z.ZodString>;
             exitVwap: z.ZodOptional<z.ZodString>;
         }, z.core.$strip>>;

package/dist/trade/payloads.d.ts

@@ -1,4 +1,5 @@
 import { z } from 'zod';
+export declare const BOUNDED_MARKET_MAX_TTL_MS = 10000;
 export declare const CreateMarketOpen: z.ZodObject<{
     type: z.ZodLiteral<"MARKET">;
     legs: z.ZodTuple<[z.ZodObject<{
@@ -100,6 +101,39 @@ export declare const CreateMarketOpen: z.ZodObject<{
     }, z.core.$strip>]>>;
     clientId: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
+/** Explicit price protection: legacy gateways reject this request type instead of stripping limits. */
+export declare const CreateBoundedMarketOpen: z.ZodObject<{
+    type: z.ZodLiteral<"BOUNDED_MARKET">;
+    expiresAt: z.ZodNumber;
+    legs: z.ZodTuple<[z.ZodObject<{
+        symbol: z.ZodString;
+        id: z.ZodOptional<z.ZodString>;
+        side: z.ZodEnum<{
+            BUY: "BUY";
+            SELL: "SELL";
+        }>;
+        mode: z.ZodEnum<{
+            QUANTITY: "QUANTITY";
+            USD: "USD";
+        }>;
+        amount: z.ZodString;
+        limitPrice: z.ZodString;
+    }, z.core.$strip>], z.ZodObject<{
+        symbol: z.ZodString;
+        id: z.ZodOptional<z.ZodString>;
+        side: z.ZodEnum<{
+            BUY: "BUY";
+            SELL: "SELL";
+        }>;
+        mode: z.ZodEnum<{
+            QUANTITY: "QUANTITY";
+            USD: "USD";
+        }>;
+        amount: z.ZodString;
+        limitPrice: z.ZodString;
+    }, z.core.$strip>>;
+    clientId: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
 export declare const CreateMarketAdjust: z.ZodObject<{
     type: z.ZodLiteral<"MARKET">;
     legs: z.ZodTuple<[z.ZodObject<{
@@ -243,6 +277,37 @@ export declare const CreateTradeOpen: z.ZodDiscriminatedUnion<[z.ZodObject<{
         }, z.core.$strip>;
     }, z.core.$strip>]>>;
     clientId: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<"BOUNDED_MARKET">;
+    expiresAt: z.ZodNumber;
+    legs: z.ZodTuple<[z.ZodObject<{
+        symbol: z.ZodString;
+        id: z.ZodOptional<z.ZodString>;
+        side: z.ZodEnum<{
+            BUY: "BUY";
+            SELL: "SELL";
+        }>;
+        mode: z.ZodEnum<{
+            QUANTITY: "QUANTITY";
+            USD: "USD";
+        }>;
+        amount: z.ZodString;
+        limitPrice: z.ZodString;
+    }, z.core.$strip>], z.ZodObject<{
+        symbol: z.ZodString;
+        id: z.ZodOptional<z.ZodString>;
+        side: z.ZodEnum<{
+            BUY: "BUY";
+            SELL: "SELL";
+        }>;
+        mode: z.ZodEnum<{
+            QUANTITY: "QUANTITY";
+            USD: "USD";
+        }>;
+        amount: z.ZodString;
+        limitPrice: z.ZodString;
+    }, z.core.$strip>>;
+    clientId: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>], "type">;
 export declare const CreateTradeAdjust: z.ZodDiscriminatedUnion<[z.ZodObject<{
     type: z.ZodLiteral<"MARKET">;
@@ -288,6 +353,7 @@ export declare const CreateTradeCloseAll: z.ZodDiscriminatedUnion<[z.ZodObject<{
     clientId: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>], "type">;
 export type CreateMarketOpen = z.output<typeof CreateMarketOpen>;
+export type CreateBoundedMarketOpen = z.output<typeof CreateBoundedMarketOpen>;
 export type CreateMarketAdjust = z.output<typeof CreateMarketAdjust>;
 export type CreateMarketClose = z.output<typeof CreateMarketClose>;
 export type CreateMarketReverse = z.output<typeof CreateMarketReverse>;

package/dist/trade/payloads.js

@@ -1,9 +1,14 @@
 import { z } from 'zod';
 import { ClientIdCode } from '../common/client-id';
 import { RefineMinimumOneSymbol, RefineUniqueSymbols } from '../common/refinement';
+import { UnsignedDecimalString } from '../common/schema';
 import { TradeLegPostOnly, TradeLeg } from '../common/trade-legs';
 import { AttachTriggerMarketClose } from '../trigger';
 
+const BOUNDED_MARKET_MAX_TTL_MS = 1e4;
+const BoundedTradeLeg = TradeLegPostOnly.safeExtend({
+  limitPrice: UnsignedDecimalString.refine((value) => Number.isFinite(Number(value)) && Number(value) > 0)
+});
 const CreateMarketOpen = z.object({
   type: z.literal("MARKET"),
   /**
@@ -21,6 +26,14 @@ const CreateMarketOpen = z.object({
   */
   clientId: ClientIdCode
 });
+const CreateBoundedMarketOpen = z.object({
+  type: z.literal("BOUNDED_MARKET"),
+  expiresAt: z.number().int().positive().max(Number.MAX_SAFE_INTEGER),
+  legs: z.tuple([
+    BoundedTradeLeg
+  ]).rest(BoundedTradeLeg).superRefine(RefineMinimumOneSymbol).superRefine(RefineUniqueSymbols),
+  clientId: ClientIdCode
+});
 const CreateMarketAdjust = z.object({
   type: z.literal("MARKET"),
   /**
@@ -56,7 +69,8 @@ const CreateMarketCloseAll = z.object({
   clientId: ClientIdCode
 });
 const CreateTradeOpen = z.discriminatedUnion("type", [
-  CreateMarketOpen
+  CreateMarketOpen,
+  CreateBoundedMarketOpen
 ]);
 const CreateTradeAdjust = z.discriminatedUnion("type", [
   CreateMarketAdjust
@@ -71,4 +85,4 @@ const CreateTradeCloseAll = z.discriminatedUnion("type", [
   CreateMarketCloseAll
 ]);
 
-export { CreateMarketAdjust, CreateMarketClose, CreateMarketCloseAll, CreateMarketOpen, CreateMarketReverse, CreateTradeAdjust, CreateTradeClose, CreateTradeCloseAll, CreateTradeOpen, CreateTradeReverse };
+export { BOUNDED_MARKET_MAX_TTL_MS, CreateBoundedMarketOpen, CreateMarketAdjust, CreateMarketClose, CreateMarketCloseAll, CreateMarketOpen, CreateMarketReverse, CreateTradeAdjust, CreateTradeClose, CreateTradeCloseAll, CreateTradeOpen, CreateTradeReverse };

package/dist/trade/responses.d.ts

@@ -1,4 +1,13 @@
 import { z } from 'zod';
+/** An authenticated admission capability; old workers also reject the new persisted discriminant. */
+export declare const TradeCapabilities: z.ZodObject<{
+    boundedMarketOpen: z.ZodObject<{
+        version: z.ZodLiteral<1>;
+        maxTtlMs: z.ZodLiteral<10000>;
+        connectors: z.ZodArray<z.ZodLiteral<"hyperliquid">>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type TradeCapabilities = z.output<typeof TradeCapabilities>;
 export declare const CreateTradeOpenResponse: z.ZodObject<{
     execution: z.ZodDiscriminatedUnion<[z.ZodDiscriminatedUnion<[z.ZodObject<{
         id: z.ZodUUID;

package/dist/trade/responses.js

@@ -2,7 +2,15 @@ import { z } from 'zod';
 import { CursorResponse } from '../common';
 import { Execution } from '../execution/entities';
 import { TradeGroup } from './entities';
+import { BOUNDED_MARKET_MAX_TTL_MS } from './payloads';
 
+const TradeCapabilities = z.object({
+  boundedMarketOpen: z.object({
+    version: z.literal(1),
+    maxTtlMs: z.literal(BOUNDED_MARKET_MAX_TTL_MS),
+    connectors: z.array(z.literal("hyperliquid"))
+  })
+});
 const CreateTradeOpenResponse = z.object({
   execution: Execution
 });
@@ -22,4 +30,4 @@ const TradeListResponse = CursorResponse.extend({
   groups: z.array(TradeGroup)
 });
 
-export { CreateTradeAdjustResponse, CreateTradeCloseAllResponse, CreateTradeCloseResponse, CreateTradeOpenResponse, CreateTradeReverseResponse, TradeListResponse };
+export { CreateTradeAdjustResponse, CreateTradeCloseAllResponse, CreateTradeCloseResponse, CreateTradeOpenResponse, CreateTradeReverseResponse, TradeCapabilities, TradeListResponse };

package/package.json

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