@pear-protocol/types 2.4.0 → 2.5.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/package.json

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