@pear-protocol/types 2.21.0 → 2.22.1

package/dist/common/request.js

@@ -1,24 +0,0 @@
-import { z } from 'zod';
-
-const CursorFindParams = z.object({
-  /**
-  * The maximum number of items to retrieve.
-  */
-  limit: z.coerce.number().int().positive().max(2e3).optional().default(20),
-  /**
-  * Opaque pagination cursor returned by the API.
-  */
-  cursor: z.string().optional()
-});
-const PaginationFindParams = z.object({
-  /**
-  * The maximum number of items to retrieve.
-  */
-  limit: z.coerce.number().int().positive().max(100).optional().default(20),
-  /**
-  * The number of items to skip before retrieving the returned items.
-  */
-  offset: z.coerce.number().int().min(0).optional().default(0)
-});
-
-export { CursorFindParams, PaginationFindParams };

package/dist/common/response.js

@@ -1,28 +0,0 @@
-import { z } from 'zod';
-
-const PaginatedResponse = z.object({
-  /**
-  * The maximum number of items retrieved.
-  */
-  limit: z.number(),
-  /**
-  * The number of items to skip before retrieving the returned items.
-  */
-  offset: z.number(),
-  /**
-  * The total number of items.
-  */
-  count: z.number()
-});
-const CursorResponse = z.object({
-  /**
-  * The maximum number of items retrieved.
-  */
-  limit: z.number(),
-  /**
-  * The cursor to use for pagination.
-  */
-  nextCursor: z.string().optional()
-});
-
-export { CursorResponse, PaginatedResponse };

package/dist/common/schema.js

@@ -1,18 +0,0 @@
-import z from 'zod';
-
-const UnsignedDecimalString = z.string().regex(/^\d+(\.\d+)?$/, "Must be a valid decimal string");
-const DecimalString = z.string().regex(/^[+-]?\d+(\.\d+)?$/, "Must be a valid decimal string");
-const SignedDecimalString = z.string().regex(/^[+-]\d+(\.\d+)?$/, "Must be a valid signed decimal string").transform((val) => val);
-const Side = z.enum([
-  "BUY",
-  "SELL"
-], {
-  message: "Side must be either BUY or SELL"
-});
-const AssetWeight = z.number().positive({
-  message: "Weight must be greater than 0"
-}).max(1, {
-  message: "Weight must be less than 1"
-});
-
-export { AssetWeight, DecimalString, Side, SignedDecimalString, UnsignedDecimalString };

package/dist/common/trade-legs.js

@@ -1,50 +0,0 @@
-import { z } from 'zod';
-import { InstrumentId } from '../instrument';
-import { RefineLegIdMatchesSymbol } from './refinement';
-import { UnsignedDecimalString, Side } from './schema';
-
-const TradeLegMode = z.enum([
-  "QUANTITY",
-  "USD"
-]);
-const TradeLegShape = z.object({
-  /** SYMBOL-MIGRATION switch-to-id: mirrors `symbol` today; becomes required once requests always carry `id`. */
-  id: InstrumentId.optional(),
-  /**
-  * Instrument ID
-  */
-  symbol: InstrumentId,
-  /**
-  * Side
-  */
-  side: Side,
-  /**
-  * Mode to interpret the amount
-  */
-  mode: TradeLegMode,
-  /**
-  * Quantity or USD amount
-  */
-  amount: UnsignedDecimalString,
-  /**
-  * Reduce only flag
-  */
-  reduceOnly: z.boolean()
-});
-const TradeLegMaxImpactPrice = {
-  /** Reject the former wire field instead of silently stripping a caller's price constraint. */
-  limitPrice: z.never({
-    error: "limitPrice is no longer supported; use maxImpactPrice instead."
-  }).optional(),
-  maxImpactPrice: UnsignedDecimalString.refine((value) => Number(value) > 0, "Max impact price must be positive").optional()
-};
-const TradeLeg = TradeLegShape.superRefine(RefineLegIdMatchesSymbol);
-const TradeLegPostOnly = TradeLegShape.omit({
-  reduceOnly: true
-}).superRefine(RefineLegIdMatchesSymbol);
-const TradeLegWithMaxImpactPrice = TradeLegShape.extend(TradeLegMaxImpactPrice).strict().superRefine(RefineLegIdMatchesSymbol);
-const TradeLegPostOnlyWithMaxImpactPrice = TradeLegShape.omit({
-  reduceOnly: true
-}).extend(TradeLegMaxImpactPrice).strict().superRefine(RefineLegIdMatchesSymbol);
-
-export { TradeLeg, TradeLegPostOnly, TradeLegPostOnlyWithMaxImpactPrice, TradeLegWithMaxImpactPrice };

package/dist/connector/index.js

@@ -1,12 +0,0 @@
-import { z } from 'zod';
-
-const Connector = z.enum([
-  "hyperliquid",
-  "binance",
-  "bybit",
-  "okx",
-  "lighter",
-  "lighter_rhc"
-]);
-
-export { Connector };

package/dist/copy/entities.js

@@ -1,151 +0,0 @@
-import { z } from 'zod';
-import { SignedDecimalString, UnsignedDecimalString } from '../common/schema';
-import { Connector } from '../connector';
-import { InstrumentId } from '../instrument';
-import { CopyPerformance, CopyEndCaptureStatus, CopyStartSnapshot } from './performance';
-
-const CopySubscriptionStatus = z.enum([
-  "ACTIVE",
-  "ENDED"
-]);
-const CopySizing = z.discriminatedUnion("mode", [
-  z.object({
-    /**
-    * Entry is the leader's own notional-over-equity fraction applied to the follower's equity, taken
-    * at the moment of entry. There is nothing for the follower to size.
-    */
-    mode: z.literal("LEADER_EQUITY_FRACTION")
-  })
-]);
-const CopySubscriptionMetrics = z.object({
-  volume: UnsignedDecimalString.describe("Lifetime executed USD turnover across opens and closes; excludes fees and funding"),
-  grossRealizedPnl: SignedDecimalString.describe("Gross realized USD PnL over attributed positions during the copy period, including partial reductions; excludes fees and funding"),
-  grossUpnl: SignedDecimalString.describe("Gross unrealized USD PnL observed for the subscription; fixed at the actual asynchronous end capture for ended subscriptions; excludes fees and funding"),
-  fundingPayment: SignedDecimalString.describe("Signed USD funding attributed to exposure during the copy period; positive values are received funding"),
-  tradeFee: SignedDecimalString.describe("Signed USD trade fees on attributed position fills; negative values are rebates"),
-  pearFee: SignedDecimalString.describe("Signed USD Pear fees on attributed position fills; negative values are rebates"),
-  totalNetPnl: SignedDecimalString.describe("Gross realized plus gross unrealized plus fundingPayment minus tradeFee and pearFee in USD")
-});
-const CopySubscription = z.object({
-  id: z.uuid(),
-  leaderTradeAccountId: z.uuid().describe("The account being copied"),
-  followerTradeAccountId: z.uuid().describe("The account copies land in"),
-  connector: Connector,
-  status: CopySubscriptionStatus,
-  sizing: CopySizing,
-  startSnapshot: CopyStartSnapshot.optional(),
-  endCapture: CopyEndCaptureStatus.optional(),
-  endReason: z.enum([
-    "UNSUBSCRIBED",
-    "MANUAL_TRADE",
-    "EXTERNAL_POSITION_DETECTED",
-    "LEADER_EXTERNAL_ACTIVITY",
-    "FAILURE_THRESHOLD"
-  ]).optional(),
-  performance: CopyPerformance.optional(),
-  ...CopySubscriptionMetrics.omit({
-    volume: true
-  }).partial().shape,
-  roi: SignedDecimalString.optional().describe("Whole-subscription net PnL divided by positive starting account equity, times 100; included with complete period performance"),
-  provisional: z.literal(true).optional(),
-  latestFillAt: z.string().datetime().optional().describe("Latest confirmed fill included in period accounting"),
-  createdAt: z.string().describe("ISO 8601"),
-  endedAt: z.string().optional().describe("ISO 8601; set once the follower unsubscribed")
-});
-const CopySubscriptionWithMetrics = CopySubscription.extend({
-  ...CopySubscriptionMetrics.shape,
-  status: z.literal("ACTIVE")
-});
-const CopyEndedSubscriptionWithVolume = CopySubscription.extend({
-  status: z.literal("ENDED"),
-  volume: CopySubscriptionMetrics.shape.volume
-});
-const CopySubscriptionRead = z.discriminatedUnion("status", [
-  CopySubscriptionWithMetrics,
-  CopyEndedSubscriptionWithVolume
-]);
-const CopyActivityOutcome = z.enum([
-  "COPIED",
-  "PARTIAL",
-  "SKIPPED",
-  "FAILED"
-]);
-const CopyActivityState = z.enum([
-  "RECORDED",
-  "DISPATCHED",
-  "SETTLED"
-]);
-const CopyActivityLeg = z.object({
-  symbol: InstrumentId,
-  targetQuantity: SignedDecimalString,
-  deltaQuantity: SignedDecimalString
-});
-const CopySkipReason = z.enum([
-  "SUBSCRIPTION_NOT_ACTIVE",
-  "POSITION_EXCLUDED",
-  "INCLUDED_IN_JOIN",
-  "VENUE_MISMATCH",
-  "BELOW_VENUE_MINIMUM",
-  "PAIR_ALREADY_ENTERED",
-  "ENTRY_EXPIRED",
-  "FOLLOWER_LEG_ABSENT",
-  "LEADER_LEG_REOPENED",
-  "NO_FOLLOWER_DELTA",
-  "LEADER_EQUITY_UNREADABLE",
-  "FOLLOWER_EQUITY_UNREADABLE",
-  "PRICE_UNAVAILABLE",
-  "LEVERAGE_NOT_APPLIED"
-]);
-const CopyLeaderAction = z.enum([
-  "OPEN",
-  "ADJUST",
-  "CLOSE",
-  "REVERSE"
-]);
-const CopyExecutionSource = z.discriminatedUnion("origin", [
-  z.object({
-    origin: z.literal("DIRECT")
-  }),
-  z.object({
-    origin: z.literal("SCHEDULE"),
-    scheduleId: z.string()
-  }),
-  z.object({
-    origin: z.literal("TRIGGER"),
-    triggerId: z.string(),
-    triggerIntent: z.enum([
-      "OPEN",
-      "ADJUST",
-      "CLOSE"
-    ]),
-    bracketType: z.string().optional(),
-    ladderId: z.string().optional()
-  }),
-  z.object({
-    origin: z.literal("AUTO_REBALANCE"),
-    configId: z.string()
-  })
-]);
-const CopyActivity = z.object({
-  id: z.uuid(),
-  leaderAction: CopyLeaderAction.describe("What the leader did"),
-  executionSource: CopyExecutionSource.optional().describe("Leader source; absent for admission position joins"),
-  state: CopyActivityState,
-  outcome: CopyActivityOutcome.optional().describe("Absent until dispatch work settles"),
-  skipReason: CopySkipReason.optional().describe("Why nothing was placed; set when the outcome is SKIPPED"),
-  failureReason: z.string().optional().describe("Why execution stopped; set when the outcome is FAILED or PARTIAL"),
-  followerLegs: z.array(CopyActivityLeg).describe("Actual fills received by the follower"),
-  leaderEquityFraction: z.string().optional().describe("The leader position notional over their equity at that moment; absent when unvaluable"),
-  createdAt: z.string().describe("ISO 8601")
-});
-const CopyFollower = z.object({
-  tradeAccountId: z.uuid(),
-  status: z.literal("ACTIVE"),
-  followedAt: z.string().describe("ISO 8601 subscription creation time"),
-  xUserId: z.string().optional(),
-  xHandle: z.string().optional(),
-  xName: z.string().optional(),
-  xAvatarUrl: z.string().optional()
-});
-
-export { CopyActivity, CopyActivityLeg, CopyActivityOutcome, CopyActivityState, CopyEndedSubscriptionWithVolume, CopyExecutionSource, CopyFollower, CopyLeaderAction, CopySizing, CopySkipReason, CopySubscription, CopySubscriptionMetrics, CopySubscriptionRead, CopySubscriptionStatus, CopySubscriptionWithMetrics };

package/dist/copy/index.js

@@ -1,5 +0,0 @@
-export * from './entities';
-export * from './payloads';
-export * from './performance';
-export * from './queries';
-export * from './responses';

package/dist/copy/payloads.js

@@ -1,8 +0,0 @@
-import { z } from 'zod';
-
-const CreateCopySubscription = z.object({
-  leaderTradeAccountId: z.uuid().describe("The account to copy"),
-  syncExistingPositions: z.boolean().default(true).describe("Copy existing leader positions when subscribing")
-});
-
-export { CreateCopySubscription };

package/dist/copy/performance.js

@@ -1,63 +0,0 @@
-import { z } from 'zod';
-import { SignedDecimalString } from '../common/schema';
-
-const Decimal = z.string().regex(/^[+-]?\d+(?:\.\d+)?$/);
-const CopyPnlBreakdown = z.object({
-  grossRealizedPnl: SignedDecimalString,
-  unrealizedPnl: SignedDecimalString,
-  funding: SignedDecimalString,
-  tradingFees: SignedDecimalString,
-  platformFees: SignedDecimalString,
-  netPnl: SignedDecimalString
-});
-const CopyStartingAccount = z.object({
-  tradeAccountId: z.string(),
-  capturedAt: z.string().datetime(),
-  initialEquityUsd: Decimal,
-  pnl: CopyPnlBreakdown
-});
-const CopyStartSnapshot = z.object({
-  leader: CopyStartingAccount,
-  follower: CopyStartingAccount
-});
-const CopyAccountPerformance = z.object({
-  tradeAccountId: z.string(),
-  capturedAt: z.string().datetime(),
-  provisional: z.literal(true),
-  latestFillAt: z.string().datetime().optional(),
-  pnl: CopyPnlBreakdown,
-  returnOnStartingEquityPercent: SignedDecimalString.optional()
-});
-const CopyCaptureTiming = z.literal("DELAYED");
-const CopyPerformance = z.object({
-  kind: z.literal("OBSERVED"),
-  boundaryAt: z.string().datetime(),
-  timing: z.union([
-    z.literal("LIVE"),
-    CopyCaptureTiming
-  ]),
-  accountTimings: z.object({
-    leader: CopyCaptureTiming,
-    follower: CopyCaptureTiming
-  }).optional(),
-  leader: CopyAccountPerformance,
-  follower: CopyAccountPerformance
-});
-const CopyEndCapture = z.object({
-  leader: CopyAccountPerformance,
-  follower: CopyAccountPerformance
-});
-const CopyEndCaptureStatus = z.discriminatedUnion("status", [
-  z.object({
-    status: z.literal("PENDING")
-  }),
-  z.object({
-    status: z.literal("FAILED")
-  }),
-  z.object({
-    status: z.literal("COMPLETE"),
-    snapshot: CopyEndCapture
-  })
-]);
-
-export { CopyAccountPerformance, CopyCaptureTiming, CopyEndCapture, CopyEndCaptureStatus, CopyPerformance, CopyPnlBreakdown, CopyStartSnapshot, CopyStartingAccount };

package/dist/copy/queries.js

@@ -1,20 +0,0 @@
-import { z } from 'zod';
-import { CopySubscriptionStatus } from './entities';
-
-const CopySubscriptionListQuery = z.object({
-  status: CopySubscriptionStatus.optional()
-});
-const CopyActivityListParams = z.object({
-  limit: z.coerce.number().int().min(1).max(200).default(50)
-});
-const CopyStatsParams = z.object({
-  startDate: z.coerce.date().optional(),
-  endDate: z.coerce.date().optional()
-}).refine((params) => !params.startDate || !params.endDate || params.startDate < params.endDate, {
-  message: "startDate must be before endDate",
-  path: [
-    "startDate"
-  ]
-});
-
-export { CopyActivityListParams, CopyStatsParams, CopySubscriptionListQuery };

package/dist/copy/responses.js

@@ -1,89 +0,0 @@
-import { z } from 'zod';
-import { UnsignedDecimalString } from '../common/schema';
-import { CopySubscriptionWithMetrics, CopyFollower, CopySubscription, CopySkipReason, CopySubscriptionRead, CopyActivity, CopySubscriptionStatus } from './entities';
-
-const CopyStateResponse = z.discriminatedUnion("state", [
-  z.object({
-    state: z.literal("NONE")
-  }),
-  z.object({
-    state: z.literal("ACTIVE"),
-    subscription: CopySubscriptionWithMetrics
-  })
-]);
-const CopyFollowersResponse = z.object({
-  followers: z.array(CopyFollower),
-  followerCount: z.number().int().nonnegative()
-});
-const CopySubscriptionResponse = z.object({
-  subscription: CopySubscription
-});
-const EndCopySubscriptionResponse = CopySubscriptionResponse;
-const CopyJoinResult = z.discriminatedUnion("outcome", [
-  z.object({
-    leaderPositionId: z.uuid(),
-    outcome: z.literal("COPIED"),
-    positionId: z.uuid()
-  }),
-  z.object({
-    leaderPositionId: z.uuid(),
-    outcome: z.literal("PARTIAL"),
-    positionId: z.uuid(),
-    reason: z.string()
-  }),
-  z.object({
-    leaderPositionId: z.uuid(),
-    outcome: z.literal("SKIPPED"),
-    reason: CopySkipReason
-  }),
-  z.object({
-    leaderPositionId: z.uuid(),
-    outcome: z.literal("FAILED"),
-    reason: z.string()
-  }),
-  z.object({
-    leaderPositionId: z.uuid(),
-    outcome: z.literal("UNCONFIRMED")
-  })
-]);
-const CreateCopySubscriptionResponse = CopySubscriptionResponse.extend({
-  joinResults: z.array(CopyJoinResult)
-});
-const CopySubscriptionListResponse = z.object({
-  subscriptions: z.array(CopySubscriptionRead)
-});
-const CopyActivityListResponse = z.object({
-  activities: z.array(CopyActivity)
-});
-const CopyHealthResponse = z.object({
-  status: z.enum([
-    "ok",
-    "degraded"
-  ]),
-  consumerRunning: z.boolean(),
-  acceptanceBlocked: z.boolean().optional(),
-  outbox: z.object({
-    pending: z.number().int().nonnegative(),
-    failed: z.number().int().nonnegative()
-  }).optional()
-});
-const CopyFollowerStats = CopyFollower.pick({
-  tradeAccountId: true,
-  xUserId: true,
-  xHandle: true,
-  xName: true,
-  xAvatarUrl: true
-}).extend({
-  status: CopySubscriptionStatus,
-  copiedTrades: z.number().int().nonnegative(),
-  copiedVolumeUsd: UnsignedDecimalString
-});
-const CopyStatsResponse = z.object({
-  currentFollowerCount: z.number().int().nonnegative(),
-  lifetimeFollowerCount: z.number().int().nonnegative(),
-  copiedTrades: z.number().int().nonnegative(),
-  copiedVolumeUsd: UnsignedDecimalString,
-  followers: z.array(CopyFollowerStats)
-});
-
-export { CopyActivityListResponse, CopyFollowerStats, CopyFollowersResponse, CopyHealthResponse, CopyJoinResult, CopyStateResponse, CopyStatsResponse, CopySubscriptionListResponse, CopySubscriptionResponse, CreateCopySubscriptionResponse, EndCopySubscriptionResponse };

package/dist/execution/entities.js

@@ -1,196 +0,0 @@
-import { z } from 'zod';
-import { UnsignedDecimalString, Side } from '../common/schema';
-import { Connector } from '../connector';
-import { InstrumentId } from '../instrument';
-import { Order } from '../order';
-import { Position } from '../position';
-
-const ExecutionIntent = z.enum([
-  "OPEN",
-  "CLOSE",
-  "ADJUST",
-  "REVERSE"
-]);
-const ExecutionOrderType = z.enum([
-  "MARKET"
-]);
-const ExecutionStatus = z.enum([
-  "IDLE",
-  "ACTIVE",
-  "COMPLETED",
-  "FAILED",
-  "CANCELLED"
-]);
-const ExecutionFulfillment = z.enum([
-  "COMPLETE",
-  "PARTIAL",
-  "NONE",
-  "PENDING"
-]);
-const ExecutionLegMode = z.enum([
-  "QUANTITY",
-  "USD"
-]);
-const ExecutionLeg = z.object({
-  /** SYMBOL-MIGRATION switch-to-id: mirrors `symbol` today; becomes required once requests always carry `id`. */
-  id: InstrumentId.optional(),
-  /**
-  * Instrument ID
-  */
-  symbol: InstrumentId,
-  /**
-  * Side
-  */
-  side: Side,
-  /**
-  * Mode to interpret the amount
-  */
-  mode: ExecutionLegMode,
-  /**
-  * Quantity or USD amount
-  */
-  amount: UnsignedDecimalString,
-  /**
-  * Optional worst acceptable execution price; replaces the slippage-derived price when present
-  */
-  maxImpactPrice: UnsignedDecimalString.optional(),
-  /**
-  * Reduce only flag
-  */
-  reduceOnly: z.boolean()
-});
-const BaseExecution = z.object({
-  /**
-  * Execution UUID
-  */
-  id: z.uuid(),
-  /**
-  * Connector
-  */
-  connector: Connector,
-  /**
-  * Intent
-  */
-  intent: ExecutionIntent,
-  /**
-  * Order type
-  */
-  orderType: ExecutionOrderType,
-  /**
-  * Status
-  */
-  status: ExecutionStatus,
-  /**
-  * Error message
-  */
-  error: z.string().optional(),
-  /**
-  * Created at timestamp
-  */
-  createdAt: z.string(),
-  /**
-  * Updated at timestamp
-  */
-  updatedAt: z.string(),
-  /**
-  * Orders
-  */
-  orders: z.array(Order).optional(),
-  /**
-  * Filled-quantity outcome across this execution's orders; absent when the server does not
-  * publish it. It never claims venue-side certainty, only what the order rows report filled.
-  */
-  fulfillment: ExecutionFulfillment.optional()
-});
-const MarketOpenExecution = BaseExecution.extend({
-  /**
-  * Intent
-  */
-  intent: z.literal("OPEN"),
-  /**
-  * Order type
-  */
-  orderType: z.literal("MARKET"),
-  /**
-  * Position opened by this execution; absent when the position link was severed (a FAILED
-  * execution unlinks its position). Id only: an open carries no exposure snapshot, so read
-  * the position itself for its exposure.
-  */
-  position: Position.pick({
-    id: true
-  }).optional(),
-  /**
-  * Requested legs
-  */
-  legs: z.tuple([
-    ExecutionLeg
-  ]).rest(ExecutionLeg)
-});
-const MarketAdjustExecution = BaseExecution.extend({
-  /**
-  * Intent
-  */
-  intent: z.literal("ADJUST"),
-  /**
-  * Order type
-  */
-  orderType: z.literal("MARKET"),
-  /**
-  * Position; absent when the position link was severed (a FAILED execution unlinks its position)
-  */
-  position: Position.pick({
-    id: true,
-    exposure: true
-  }).optional(),
-  /**
-  * Requested legs
-  */
-  legs: z.tuple([
-    ExecutionLeg
-  ]).rest(ExecutionLeg)
-});
-const MarketCloseExecution = BaseExecution.extend({
-  /**
-  * Intent
-  */
-  intent: z.literal("CLOSE"),
-  /**
-  * Order type
-  */
-  orderType: z.literal("MARKET"),
-  /**
-  * Position; absent when the position link was severed (a FAILED execution unlinks its position)
-  */
-  position: Position.pick({
-    id: true,
-    exposure: true
-  }).optional()
-});
-const MarketReverseExecution = BaseExecution.extend({
-  /**
-  * Intent
-  */
-  intent: z.literal("REVERSE"),
-  /**
-  * Order type
-  */
-  orderType: z.literal("MARKET"),
-  /**
-  * Position; absent when the position link was severed (a FAILED execution unlinks its position)
-  */
-  position: Position.pick({
-    id: true,
-    exposure: true
-  }).optional()
-});
-const MarketExecution = z.discriminatedUnion("intent", [
-  MarketOpenExecution,
-  MarketAdjustExecution,
-  MarketCloseExecution,
-  MarketReverseExecution
-]);
-const Execution = z.discriminatedUnion("orderType", [
-  MarketExecution
-]);
-
-export { BaseExecution, Execution, ExecutionFulfillment, ExecutionIntent, ExecutionLegMode, ExecutionOrderType, ExecutionStatus, MarketAdjustExecution, MarketCloseExecution, MarketExecution, MarketOpenExecution, MarketReverseExecution };

package/dist/execution/index.js

@@ -1,3 +0,0 @@
-export * from './entities';
-export * from './queries';
-export * from './responses';