@pear-protocol/types 1.24.1 → 1.25.1

package/dist/common/refinement.d.ts

@@ -15,7 +15,4 @@ export declare const RefineUniqueSymbols: <T extends {
 export declare const RefineWeightingSum: <T extends {
     weight: number;
 }[]>(basket: T, ctx: z.RefinementCtx) => void;
-export declare const RefineMinimumOneBuyOneSell: <T extends {
-    side: "BUY" | "SELL";
-}[]>(basket: T, ctx: z.RefinementCtx) => void;
 export declare const RefineMinimumOneKeyValuePair: <T extends Record<string, unknown>>(data: T, ctx: z.RefinementCtx) => void;

package/dist/common/refinement.js

@@ -52,16 +52,6 @@ const RefineWeightingSum = /* @__PURE__ */ __name((basket, ctx) => {
     });
   }
 }, "RefineWeightingSum");
-const RefineMinimumOneBuyOneSell = /* @__PURE__ */ __name((basket, ctx) => {
-  const buyCount = basket.filter((item) => item.side === "BUY").length;
-  const sellCount = basket.filter((item) => item.side === "SELL").length;
-  if (buyCount < 1 || sellCount < 1) {
-    ctx.addIssue({
-      code: "custom",
-      message: "At least one BUY and one SELL are required."
-    });
-  }
-}, "RefineMinimumOneBuyOneSell");
 const RefineMinimumOneKeyValuePair = /* @__PURE__ */ __name((data, ctx) => {
   if (Object.keys(data).length < 1) {
     ctx.addIssue({
@@ -71,4 +61,4 @@ const RefineMinimumOneKeyValuePair = /* @__PURE__ */ __name((data, ctx) => {
   }
 }, "RefineMinimumOneKeyValuePair");
 
-export { RefineMinimumOneBuyOneSell, RefineMinimumOneKeyValuePair, RefineMinimumOneSymbol, RefineMinimumTwoSymbols, RefineTwoUniqueSymbols, RefineUniqueSymbols, RefineWeightingSum };
+export { RefineMinimumOneKeyValuePair, RefineMinimumOneSymbol, RefineMinimumTwoSymbols, RefineTwoUniqueSymbols, RefineUniqueSymbols, RefineWeightingSum };

package/dist/ladder/payloads.js

@@ -1,6 +1,6 @@
 import { z } from 'zod';
 import { ClientIdCode } from '../common/client-id';
-import { RefineMinimumTwoSymbols, RefineUniqueSymbols, RefineWeightingSum, RefineMinimumOneBuyOneSell, RefineTwoUniqueSymbols, RefineMinimumOneSymbol } from '../common/refinement';
+import { RefineMinimumTwoSymbols, RefineUniqueSymbols, RefineWeightingSum, RefineTwoUniqueSymbols, RefineMinimumOneSymbol } from '../common/refinement';
 import { AssetWeight, Side } from '../common/schema';
 import { TradeLegPostOnly } from '../common/trade-legs';
 import { InstrumentId } from '../instrument';
@@ -29,7 +29,7 @@ const WeightedRatioBasketItem = z.object({
   side: Side,
   weight: AssetWeight
 });
-const WeightedRatioBasket = z.array(WeightedRatioBasketItem).superRefine(RefineMinimumTwoSymbols).superRefine(RefineUniqueSymbols).superRefine(RefineWeightingSum).superRefine(RefineMinimumOneBuyOneSell);
+const WeightedRatioBasket = z.array(WeightedRatioBasketItem).superRefine(RefineMinimumTwoSymbols).superRefine(RefineUniqueSymbols).superRefine(RefineWeightingSum);
 const LadderRatioOpen = z.object({
   type: z.literal("ratio"),
   data: z.object({

package/dist/statistics/entities.d.ts

@@ -17,6 +17,7 @@ export declare const LeaderboardRow: z.ZodObject<{
     pearFee: z.ZodString;
     tradeFee: z.ZodString;
     totalTrades: z.ZodNumber;
+    roi: z.ZodOptional<z.ZodString>;
     xHandle: z.ZodOptional<z.ZodString>;
     xName: z.ZodOptional<z.ZodString>;
     xAvatarUrl: z.ZodOptional<z.ZodString>;

package/dist/statistics/entities.js

@@ -21,6 +21,18 @@ const LeaderboardRow = z.object({
   pearFee: z.string(),
   tradeFee: z.string(),
   totalTrades: z.number(),
+  // The plain average of this account's per-position returns, as a ratio: "0.25" is +25%.
+  // Every position is weighted equally, so a small winner counts as much as a large one —
+  // this is a measure of the trader's decisions, not of the dollars those decisions moved.
+  //
+  // Each position is measured against the size it opened with. An open position contributes
+  // its unrealized PnL, a closed one what it realized after fees.
+  //
+  // Absent when the board could measure none of the account's positions — never "0", which
+  // would claim a break-even trader. An account reaches the board with nothing measurable
+  // when its only activity in scope is a fill on a position opened before startDate, or when
+  // none of its positions recorded an opening size.
+  roi: z.string().optional(),
   // The trader's linked X account. Absent for an account whose owner has connected no X
   // account, and absent for an anonymous caller: the board itself is public, but pairing a
   // real name with a wallet address and a PnL for the open internet is a wider promise than

package/dist/statistics/queries.d.ts

@@ -53,6 +53,7 @@ export declare const LeaderboardSortBy: z.ZodEnum<{
     trades: "trades";
     volume: "volume";
     totalNetPnl: "totalNetPnl";
+    roi: "roi";
 }>;
 export type LeaderboardSortBy = z.infer<typeof LeaderboardSortBy>;
 export declare const LEADERBOARD_MAX_LIMIT = 200;
@@ -70,6 +71,7 @@ export declare const LeaderboardQueryParams: z.ZodObject<{
         trades: "trades";
         volume: "volume";
         totalNetPnl: "totalNetPnl";
+        roi: "roi";
     }>>;
     startDate: z.ZodOptional<z.ZodPipe<z.ZodCoercedNumber<number>, z.ZodTransform<Date, number>>>;
     endDate: z.ZodOptional<z.ZodPipe<z.ZodCoercedNumber<number>, z.ZodTransform<Date, number>>>;

package/dist/statistics/queries.js

@@ -41,7 +41,8 @@ const StatisticsTotalsQueryParams = z.object({
 const LeaderboardSortBy = z.enum([
   "trades",
   "totalNetPnl",
-  "volume"
+  "volume",
+  "roi"
 ]);
 const LEADERBOARD_MAX_LIMIT = 200;
 const UnixSeconds = z.coerce.number().int().min(0).transform((seconds) => new Date(seconds * 1e3));

package/dist/statistics/responses.d.ts

@@ -18,6 +18,7 @@ export declare const LeaderboardResponse: z.ZodObject<{
         pearFee: z.ZodString;
         tradeFee: z.ZodString;
         totalTrades: z.ZodNumber;
+        roi: z.ZodOptional<z.ZodString>;
         xHandle: z.ZodOptional<z.ZodString>;
         xName: z.ZodOptional<z.ZodString>;
         xAvatarUrl: z.ZodOptional<z.ZodString>;

package/dist/trigger/payloads/conditions.js

@@ -1,5 +1,5 @@
 import { z } from 'zod';
-import { RefineMinimumTwoSymbols, RefineUniqueSymbols, RefineWeightingSum, RefineMinimumOneBuyOneSell, RefineTwoUniqueSymbols } from '../../common/refinement';
+import { RefineMinimumTwoSymbols, RefineUniqueSymbols, RefineWeightingSum, RefineTwoUniqueSymbols } from '../../common/refinement';
 import { AssetWeight, Side } from '../../common/schema';
 import { Connector } from '../../connector';
 import { InstrumentId } from '../../instrument';
@@ -19,7 +19,7 @@ const WeightedRatioBasketItem = z.object({
   side: Side,
   weight: AssetWeight
 });
-const WeightedRatioBasket = z.array(WeightedRatioBasketItem).superRefine(RefineMinimumTwoSymbols).superRefine(RefineUniqueSymbols).superRefine(RefineWeightingSum).superRefine(RefineMinimumOneBuyOneSell);
+const WeightedRatioBasket = z.array(WeightedRatioBasketItem).superRefine(RefineMinimumTwoSymbols).superRefine(RefineUniqueSymbols).superRefine(RefineWeightingSum);
 const RatioOpen = z.object({
   type: z.literal("ratio"),
   data: z.object({

package/package.json

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