@pear-protocol/types 2.19.0 → 2.21.0

package/dist/statistics/queries.d.ts

@@ -84,3 +84,28 @@ export declare const LeaderboardQueryParams: z.ZodObject<{
 }, z.core.$strip>;
 export type LeaderboardQueryParamsInput = z.input<typeof LeaderboardQueryParams>;
 export type LeaderboardQueryParams = z.output<typeof LeaderboardQueryParams>;
+export declare const LeaderboardSnapshotParams: z.ZodObject<{
+    slug: z.ZodString;
+}, z.core.$strip>;
+export type LeaderboardSnapshotParams = z.output<typeof LeaderboardSnapshotParams>;
+export declare const LeaderboardSnapshotQueryParams: z.ZodObject<{
+    sortBy: z.ZodOptional<z.ZodEnum<{
+        volume: "volume";
+        totalNetPnl: "totalNetPnl";
+        roi: "roi";
+        trades: "trades";
+    }>>;
+    limit: z.ZodDefault<z.ZodCoercedNumber<number>>;
+}, z.core.$strip>;
+export type LeaderboardSnapshotQueryParamsInput = z.input<typeof LeaderboardSnapshotQueryParams>;
+export type LeaderboardSnapshotQueryParams = z.output<typeof LeaderboardSnapshotQueryParams>;
+export declare const LeaderboardArchiveParams: z.ZodObject<{
+    slug: z.ZodString;
+}, z.core.$strip>;
+export type LeaderboardArchiveParams = z.output<typeof LeaderboardArchiveParams>;
+export declare const LeaderboardArchivePeriodParams: z.ZodObject<{
+    slug: z.ZodString;
+    startDate: z.ZodPipe<z.ZodCoercedNumber<number>, z.ZodTransform<Date, number>>;
+}, z.core.$strip>;
+export type LeaderboardArchivePeriodParamsInput = z.input<typeof LeaderboardArchivePeriodParams>;
+export type LeaderboardArchivePeriodParams = z.output<typeof LeaderboardArchivePeriodParams>;

package/dist/statistics/queries.js

@@ -89,5 +89,23 @@ const LeaderboardQueryParams = z.object({
 }).refine((data) => !data.startDate || !data.endDate || data.startDate < data.endDate, {
   message: "startDate must be before endDate"
 });
+const LeaderboardSnapshotParams = z.object({
+  slug: z.string()
+});
+const LeaderboardSnapshotQueryParams = z.object({
+  // Absent means the default the board was published with, never the registry's current one.
+  sortBy: LeaderboardSortBy.optional(),
+  // Defaults to the free-form board's 200, so a migrating client sees no change. Deliberately
+  // uncapped, unlike LEADERBOARD_MAX_LIMIT there: the snapshot already holds every qualifying
+  // row, so a larger limit costs response size, not a ranking.
+  limit: z.coerce.number().int().positive().default(200)
+});
+const LeaderboardArchiveParams = z.object({
+  slug: z.string()
+});
+const LeaderboardArchivePeriodParams = z.object({
+  slug: z.string(),
+  startDate: UnixSeconds
+});
 
-export { LEADERBOARD_MAX_LIMIT, LeaderboardQueryParams, LeaderboardSortBy, OiStatisticsQueryParams, StatisticsTotalsQueryParams, VolumeStatisticsQueryParams };
+export { LEADERBOARD_MAX_LIMIT, LeaderboardArchiveParams, LeaderboardArchivePeriodParams, LeaderboardQueryParams, LeaderboardSnapshotParams, LeaderboardSnapshotQueryParams, LeaderboardSortBy, OiStatisticsQueryParams, StatisticsTotalsQueryParams, VolumeStatisticsQueryParams };

package/dist/statistics/responses.d.ts

@@ -37,6 +37,126 @@ export declare const LeaderboardResponse: z.ZodObject<{
     }, z.core.$strip>>;
 }, z.core.$strip>;
 export type LeaderboardResponse = z.output<typeof LeaderboardResponse>;
+export declare const LeaderboardStatus: z.ZodEnum<{
+    upcoming: "upcoming";
+    live: "live";
+    final: "final";
+}>;
+export type LeaderboardStatus = z.output<typeof LeaderboardStatus>;
+export declare const LeaderboardSnapshotResponse: z.ZodObject<{
+    slug: z.ZodString;
+    status: z.ZodEnum<{
+        upcoming: "upcoming";
+        live: "live";
+        final: "final";
+    }>;
+    sortBy: z.ZodEnum<{
+        volume: "volume";
+        totalNetPnl: "totalNetPnl";
+        roi: "roi";
+        trades: "trades";
+    }>;
+    updatedAt: z.ZodISODateTime;
+    window: z.ZodObject<{
+        startDate: z.ZodOptional<z.ZodNumber>;
+        endDate: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>;
+    data: z.ZodArray<z.ZodObject<{
+        tradeAccountId: z.ZodString;
+        userId: z.ZodString;
+        connector: z.ZodEnum<{
+            hyperliquid: "hyperliquid";
+            binance: "binance";
+            bybit: "bybit";
+            okx: "okx";
+            lighter: "lighter";
+            lighter_rhc: "lighter_rhc";
+        }>;
+        followers: z.ZodArray<z.ZodObject<{
+            tradeAccountId: z.ZodUUID;
+            status: z.ZodLiteral<"ACTIVE">;
+            followedAt: z.ZodString;
+            xUserId: z.ZodOptional<z.ZodString>;
+            xHandle: z.ZodOptional<z.ZodString>;
+            xName: z.ZodOptional<z.ZodString>;
+            xAvatarUrl: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>;
+        followerCount: z.ZodNumber;
+        volume: z.ZodString;
+        grossRealizedPnl: z.ZodString;
+        grossUpnl: z.ZodString;
+        fundingPayment: z.ZodString;
+        totalNetPnl: z.ZodString;
+        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>;
+        xUserId: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type LeaderboardSnapshotResponse = z.output<typeof LeaderboardSnapshotResponse>;
+export declare const LeaderboardArchiveListResponse: z.ZodObject<{
+    slug: z.ZodString;
+    periods: z.ZodArray<z.ZodObject<{
+        startDate: z.ZodNumber;
+        endDate: z.ZodNumber;
+        archivedAt: z.ZodISODateTime;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type LeaderboardArchiveListResponse = z.output<typeof LeaderboardArchiveListResponse>;
+export declare const LeaderboardArchiveResponse: z.ZodObject<{
+    slug: z.ZodString;
+    sortBy: z.ZodEnum<{
+        volume: "volume";
+        totalNetPnl: "totalNetPnl";
+        roi: "roi";
+        trades: "trades";
+    }>;
+    window: z.ZodObject<{
+        startDate: z.ZodNumber;
+        endDate: z.ZodNumber;
+    }, z.core.$strip>;
+    archivedAt: z.ZodISODateTime;
+    data: z.ZodArray<z.ZodObject<{
+        tradeAccountId: z.ZodString;
+        userId: z.ZodString;
+        connector: z.ZodEnum<{
+            hyperliquid: "hyperliquid";
+            binance: "binance";
+            bybit: "bybit";
+            okx: "okx";
+            lighter: "lighter";
+            lighter_rhc: "lighter_rhc";
+        }>;
+        followers: z.ZodArray<z.ZodObject<{
+            tradeAccountId: z.ZodUUID;
+            status: z.ZodLiteral<"ACTIVE">;
+            followedAt: z.ZodString;
+            xUserId: z.ZodOptional<z.ZodString>;
+            xHandle: z.ZodOptional<z.ZodString>;
+            xName: z.ZodOptional<z.ZodString>;
+            xAvatarUrl: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>;
+        followerCount: z.ZodNumber;
+        volume: z.ZodString;
+        grossRealizedPnl: z.ZodString;
+        grossUpnl: z.ZodString;
+        fundingPayment: z.ZodString;
+        totalNetPnl: z.ZodString;
+        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>;
+        xUserId: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type LeaderboardArchiveResponse = z.output<typeof LeaderboardArchiveResponse>;
 export declare const VolumeStatisticsResponse: z.ZodObject<{
     data: z.ZodArray<z.ZodObject<{
         timestamp: z.ZodNumber;

package/dist/statistics/responses.js

@@ -1,9 +1,59 @@
 import { z } from 'zod';
 import { LeaderboardRow, VolumeStatistics, OiStatistics, StatisticsTotals } from './entities';
+import { LeaderboardSortBy } from './queries';
 
 const LeaderboardResponse = z.object({
   data: z.array(LeaderboardRow)
 });
+const UnixSeconds = z.number().int().nonnegative();
+const LeaderboardStatus = z.enum([
+  "upcoming",
+  "live",
+  "final"
+]);
+const LeaderboardSnapshotResponse = z.object({
+  // Echoes the path parameter.
+  slug: z.string(),
+  // Lifecycle of the requested competition; final rows come from its frozen archive.
+  status: LeaderboardStatus,
+  // The order the rows are in, including when the board's published default was applied.
+  sortBy: LeaderboardSortBy,
+  // Live: computed at; final: archived at; upcoming: lifecycle evaluated at.
+  updatedAt: z.iso.datetime(),
+  // The period the rows cover, in the free-form board's query units, so a consumer can feed
+  // these back as its startDate/endDate to reproduce the board. An absent bound is open.
+  window: z.object({
+    startDate: UnixSeconds.optional(),
+    endDate: UnixSeconds.optional()
+  }),
+  data: z.array(LeaderboardRow)
+});
+const LeaderboardArchiveListResponse = z.object({
+  // Echoes the path parameter.
+  slug: z.string(),
+  periods: z.array(z.object({
+    // The period's bounds in the free-form board's query units; startDate addresses the period.
+    startDate: UnixSeconds,
+    endDate: UnixSeconds,
+    // When the period was ranked — not a freshness signal, the board never changes after it.
+    archivedAt: z.iso.datetime()
+  }))
+});
+const LeaderboardArchiveResponse = z.object({
+  // Echoes the path parameter.
+  slug: z.string(),
+  // The order the rows are in, including when the archived query's default was applied.
+  sortBy: LeaderboardSortBy,
+  // A finished period always has both bounds, in the free-form board's query units, so a
+  // consumer can feed them back as its startDate/endDate to re-query the period.
+  window: z.object({
+    startDate: UnixSeconds,
+    endDate: UnixSeconds
+  }),
+  // When the period was ranked; distinct from a live board's updatedAt, it says nothing of freshness.
+  archivedAt: z.iso.datetime(),
+  data: z.array(LeaderboardRow)
+});
 const VolumeStatisticsResponse = z.object({
   data: z.array(VolumeStatistics)
 });
@@ -14,4 +64,4 @@ const StatisticsTotalsResponse = z.object({
   data: StatisticsTotals
 });
 
-export { LeaderboardResponse, OiStatisticsResponse, StatisticsTotalsResponse, VolumeStatisticsResponse };
+export { LeaderboardArchiveListResponse, LeaderboardArchiveResponse, LeaderboardResponse, LeaderboardSnapshotResponse, LeaderboardStatus, OiStatisticsResponse, StatisticsTotalsResponse, VolumeStatisticsResponse };

package/dist/sync/responses.d.ts

@@ -5,6 +5,7 @@ export declare const SyncFillsSinceResponse: z.ZodObject<{
     neverSynced: z.ZodBoolean;
     firstSyncStartedAt: z.ZodOptional<z.ZodNumber>;
     confirmedExchangeFillIds: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    hasPendingSynthetics: z.ZodOptional<z.ZodBoolean>;
     executionsUpdatedAtEpochMs: z.ZodNumber;
 }, z.core.$strip>;
 export declare const SyncFundingSinceResponse: z.ZodObject<{

package/dist/sync/responses.js

@@ -11,6 +11,8 @@ const SyncFillsSinceResponse = z.object({
   // through when an empty exchange fetch provides no fill-derived checkpoint.
   firstSyncStartedAt: z.number().int().nonnegative().optional(),
   confirmedExchangeFillIds: z.array(z.string()).optional(),
+  // A pending correction needs the next full snapshot even when there are no fills to apply.
+  hasPendingSynthetics: z.boolean().optional(),
   // Newest executions.updatedAt this response can have observed, as epoch ms ceiled to the next
   // whole millisecond (the column keeps microseconds); 0 when the account has no executions. The
   // client echoes it verbatim in the create meta — core defers the create when any execution

package/dist/users/entities.js

@@ -30,8 +30,8 @@ const BoundReferralReferee = z.object({
   status: z.literal("BOUND").describe("The referee resolves to a V3 user with a permanent binding"),
   address: EthereumAddress.optional().describe("Linked EVM wallet address when the referee has one"),
   referredAt: z.number().int().nonnegative().optional().describe("V3 attribution time in epoch milliseconds; not the original legacy on-chain referral time, and absent on a historical binding without a recoverable date"),
-  tradeCount: z.number().int().nonnegative().describe("Distinct Pear executions with at least one real confirmed fill"),
-  volumeUsd: UnsignedDecimalString.describe("Post-binding V3 volume from real confirmed Pear fills, in USD")
+  tradeCount: z.number().int().nonnegative().describe("Distinct Pear executions with at least one real confirmed Hyperliquid or Lighter fill"),
+  volumeUsd: UnsignedDecimalString.describe("Post-binding V3 volume from real confirmed Pear fills on Hyperliquid and Lighter, in USD")
 });
 const PendingReferralReferee = z.object({
   status: z.literal("PENDING").describe("A verified legacy referee that has no V3 identity yet"),

package/dist/users/response.d.ts

@@ -42,6 +42,7 @@ export declare const ReferralRefereeListResponse: z.ZodObject<{
     count: z.ZodNumber;
     pendingCount: z.ZodNumber;
     totalVolumeUsd: z.ZodString;
+    totalEarnedUsd: z.ZodString;
     referees: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
         status: z.ZodLiteral<"BOUND">;
         address: z.ZodOptional<z.ZodPipe<z.ZodString, z.ZodTransform<import("..").EthereumAddress, string>>>;

package/dist/users/response.js

@@ -20,7 +20,8 @@ const ReferralStatusResponse = z.object({
 const ReferralRefereeListResponse = CursorResponse.extend({
   count: z.number().int().nonnegative().describe("Total referees this list yields, counting bound V3 users and pending legacy wallets together"),
   pendingCount: z.number().int().nonnegative().describe("Subset of count whose verified legacy wallet has no V3 identity yet, so no binding exists"),
-  totalVolumeUsd: UnsignedDecimalString.describe("Post-binding V3 volume from real confirmed Pear fills across the complete bound referee set, independent of pagination"),
+  totalVolumeUsd: UnsignedDecimalString.describe("Post-binding V3 volume from real confirmed Pear fills on Hyperliquid and Lighter across the complete bound referee set, independent of pagination"),
+  totalEarnedUsd: UnsignedDecimalString.describe("The referrer's share of the Pear fees on the same fills totalVolumeUsd counts, independent of pagination"),
   referees: z.array(ReferralReferee)
 });
 

package/dist/vaults/responses.d.ts

@@ -355,15 +355,6 @@ export declare const ActivityItemResponse: z.ZodObject<{
     }, z.core.$strip>;
 }, z.core.$strip>;
 export type ActivityItemResponse = z.output<typeof ActivityItemResponse>;
-export declare const AgentBalancesResponse: z.ZodObject<{
-    agentAddress: z.ZodString;
-    spot: z.ZodRecord<z.ZodString, z.ZodString>;
-    perp: z.ZodObject<{
-        accountValue: z.ZodString;
-        withdrawable: z.ZodString;
-    }, z.core.$strip>;
-}, z.core.$strip>;
-export type AgentBalancesResponse = z.infer<typeof AgentBalancesResponse>;
 /** Bare agent-approve outcome: the service returns exactly this union. */
 export declare const AgentApproveResult: z.ZodDiscriminatedUnion<[z.ZodObject<{
     success: z.ZodLiteral<true>;

package/dist/vaults/responses.js

@@ -159,14 +159,6 @@ const ActivityResponse = z.object({
 const ActivityItemResponse = z.object({
   activity: Activity
 });
-const AgentBalancesResponse = z.object({
-  agentAddress: z.string(),
-  spot: z.record(z.string(), z.string()),
-  perp: z.object({
-    accountValue: z.string(),
-    withdrawable: z.string()
-  })
-});
 const AgentApproveSent = z.object({
   success: z.literal(true),
   transactionHash: z.string(),
@@ -373,4 +365,4 @@ const VaultServiceError = z.discriminatedUnion("error", [
   })
 ]);
 
-export { ActivityItemResponse, ActivityResponse, AgentApproveResponse, AgentApproveResult, AgentBalancesResponse, BulkSnapshotsResponse, CreatedVaultResponse, CreatedVaultResult, NavRangeResponse, NavSnapshotResponse, NavStatsResponse, SetTraderResponse, SetTraderResult, UnifiedAccountResponse, UpdateVaultMetadataResponse, UpdateVaultMetadataResult, VaultEventListResponse, VaultInvestmentsResponse, VaultListResponse, VaultOverviewResponse, VaultRequestIssue, VaultResponse, VaultServiceError, VaultStatsResponse, WithdrawToEvmResponse, WithdrawToEvmResult };
+export { ActivityItemResponse, ActivityResponse, AgentApproveResponse, AgentApproveResult, BulkSnapshotsResponse, CreatedVaultResponse, CreatedVaultResult, NavRangeResponse, NavSnapshotResponse, NavStatsResponse, SetTraderResponse, SetTraderResult, UnifiedAccountResponse, UpdateVaultMetadataResponse, UpdateVaultMetadataResult, VaultEventListResponse, VaultInvestmentsResponse, VaultListResponse, VaultOverviewResponse, VaultRequestIssue, VaultResponse, VaultServiceError, VaultStatsResponse, WithdrawToEvmResponse, WithdrawToEvmResult };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pear-protocol/types",
-  "version": "2.19.0",
+  "version": "2.21.0",
   "description": "Pear Protocol Types definitions",
   "private": false,
   "type": "module",
@@ -23,7 +23,7 @@
     "test": "vitest run --typecheck",
     "build": "tsup && tsc -p tsconfig.build.json",
     "clean": "rm -rf dist .turbo",
-    "typecheck": "tsc --noEmit"
+    "typecheck": "bunx --package bun@1.4.3 bun --check --threads=2"
   },
   "dependencies": {
     "zod": "4.1.12"