@pear-protocol/types 2.21.0 → 2.22.0

package/dist/traders/public.js

@@ -1,192 +0,0 @@
-import { z } from 'zod';
-import { CursorResponse } from '../common';
-import { Connector } from '../connector';
-import { CopyFollower } from '../copy/entities';
-import { Ladder } from '../ladder/entities';
-import { OpenPosition, OpenPositionLeg, ClosedPosition, ClosedPositionLeg } from '../position/entities';
-import { ClosedPositionListParams } from '../position/queries';
-import { TWAPOpen, TWAPClose } from '../schedule/entities';
-import { TriggerMarketOpen, TriggerMarketAdjust, TriggerMarketClose, TriggerTWAPAdjust, TriggerTWAPClose } from '../trigger/entities';
-
-const PublicTraderParams = z.object({
-  tradeAccountId: z.uuid()
-});
-const PublicTraderQuery = z.object({
-  /** Accept exact HTTP boolean strings without treating the string "false" as true. */
-  includeCopyState: z.union([
-    z.boolean(),
-    z.stringbool({
-      truthy: [
-        "true"
-      ],
-      falsy: [
-        "false"
-      ],
-      case: "sensitive"
-    })
-  ]).optional().default(false)
-});
-const PublicTraderClosedPositionsParams = z.object({
-  limit: ClosedPositionListParams.shape.limit,
-  cursor: ClosedPositionListParams.shape.cursor,
-  startDate: ClosedPositionListParams.shape.startDate,
-  endDate: ClosedPositionListParams.shape.endDate,
-  positionId: ClosedPositionListParams.shape.positionId
-}).strict();
-const ViewerCopyStatus = z.enum([
-  "COPIED",
-  "PARTIAL",
-  "NOT_COPIED",
-  "PENDING",
-  "UNKNOWN"
-]);
-const PublicOpenPosition = OpenPosition.pick({
-  positionId: true,
-  status: true,
-  connector: true,
-  openedAt: true,
-  updatedAt: true,
-  copySubscriptionId: true,
-  realizedGrossPnl: true,
-  netCashflow: true
-}).extend({
-  /** The selected follower's result for this leader position; absent without viewer context. */
-  copyStatus: ViewerCopyStatus.optional(),
-  /** The recorded attempt, exclusion, or lifecycle reason for this follower's result. */
-  copyReason: z.string().optional(),
-  legs: z.array(OpenPositionLeg.pick({
-    asset: true,
-    side: true,
-    realized: true,
-    remaining: true
-  }))
-});
-const PublicClosedPosition = ClosedPosition.pick({
-  positionId: true,
-  status: true,
-  connector: true,
-  openedAt: true,
-  closedAt: true,
-  closedReason: true,
-  grossPnl: true,
-  netPnl: true,
-  hasProvisionalFills: true
-}).extend({
-  legs: z.array(ClosedPositionLeg.pick({
-    asset: true,
-    side: true,
-    entryVwap: true,
-    exitVwap: true,
-    entryNotional: true,
-    grossPnl: true,
-    netPnl: true
-  }))
-});
-const PublicTraderClosedPositionsResponse = CursorResponse.extend({
-  positions: z.array(PublicClosedPosition)
-});
-const triggerFields = {
-  id: true,
-  connector: true,
-  status: true,
-  intent: true,
-  type: true,
-  bracketType: true,
-  semanticBracketType: true,
-  condition: true,
-  context: true,
-  ladderId: true,
-  ladderIndex: true,
-  parentTriggerId: true,
-  triggeredAt: true,
-  cancelledAt: true,
-  cancelledReason: true,
-  createdAt: true,
-  updatedAt: true
-};
-const PublicTrigger = z.discriminatedUnion("type", [
-  z.discriminatedUnion("intent", [
-    TriggerMarketOpen.pick(triggerFields),
-    TriggerMarketAdjust.pick({
-      ...triggerFields,
-      trailing: true
-    }),
-    TriggerMarketClose.pick({
-      ...triggerFields,
-      trailing: true
-    })
-  ]),
-  z.discriminatedUnion("intent", [
-    TriggerTWAPAdjust.pick({
-      ...triggerFields,
-      trailing: true,
-      scheduleId: true
-    }),
-    TriggerTWAPClose.pick({
-      ...triggerFields,
-      trailing: true,
-      scheduleId: true
-    })
-  ])
-]);
-const scheduleFields = {
-  id: true,
-  connector: true,
-  status: true,
-  strategy: true,
-  intent: true,
-  executionType: true,
-  positionKey: true,
-  startAt: true,
-  endAt: true,
-  lastSliceAt: true,
-  sliceIntervalSec: true,
-  sliceCount: true,
-  randomization: true,
-  cancelledAt: true,
-  cancelledReason: true,
-  createdAt: true,
-  updatedAt: true
-};
-const PublicSchedule = z.discriminatedUnion("intent", [
-  TWAPOpen.pick({
-    ...scheduleFields,
-    legs: true,
-    targetNotional: true,
-    remainingNotional: true
-  }),
-  TWAPClose.pick({
-    ...scheduleFields,
-    positionId: true,
-    initialExposure: true
-  })
-]);
-const PublicLadder = Ladder.pick({
-  id: true,
-  connector: true,
-  status: true,
-  positionKey: true,
-  config: true,
-  attachTriggers: true,
-  createdAt: true,
-  updatedAt: true
-}).extend({
-  triggers: z.array(PublicTrigger)
-});
-const PublicTraderResponse = z.object({
-  connector: Connector.describe("Exchange connector type"),
-  // Omit X identity when the owner hides it or has not linked an account.
-  xHandle: z.string().optional().describe("Public X handle at the last authorization; absent when hidden or unlinked"),
-  xName: z.string().optional().describe("Public X display name; absent when hidden or unlinked"),
-  xAvatarUrl: z.string().optional().describe("Public X avatar URL; absent when hidden or unlinked"),
-  xUserId: z.string().optional().describe("Immutable X numeric user ID; absent when hidden or unlinked"),
-  // Followers are complete; the latest-20 limit applies only to trading records.
-  followers: z.array(CopyFollower),
-  followerCount: z.number().int().nonnegative(),
-  positions: z.array(PublicOpenPosition),
-  triggers: z.array(PublicTrigger),
-  schedules: z.array(PublicSchedule),
-  ladders: z.array(PublicLadder)
-});
-
-export { PublicClosedPosition, PublicLadder, PublicOpenPosition, PublicSchedule, PublicTraderClosedPositionsParams, PublicTraderClosedPositionsResponse, PublicTraderParams, PublicTraderQuery, PublicTraderResponse, PublicTrigger, ViewerCopyStatus };

package/dist/trigger/common/index.js

@@ -1,39 +0,0 @@
-import { z } from 'zod';
-
-const TriggerIntent = z.enum([
-  "OPEN",
-  "ADJUST",
-  "CLOSE"
-]);
-const TriggerStatus = z.enum([
-  "ACTIVE",
-  "TRIGGERED",
-  "CANCELLED"
-]);
-const TriggerCancelledReason = z.enum([
-  "POSITION_CLOSED",
-  "USER",
-  "SYSTEM",
-  "POSITION_NETTED",
-  "POSITION_LIQUIDATED",
-  "POSITION_REVERSED"
-]);
-const BracketType = z.enum([
-  "STOP_LOSS",
-  "TAKE_PROFIT",
-  "NONE"
-]);
-const MetricTrack = z.enum([
-  "PEAK",
-  "TROUGH"
-]);
-const TpSlBracketType = z.enum([
-  "TAKE_PROFIT",
-  "STOP_LOSS"
-]);
-const TrailingMode = z.enum([
-  "RELATIVE_BPS",
-  "ABSOLUTE_POINTS"
-]);
-
-export { BracketType, MetricTrack, TpSlBracketType, TrailingMode, TriggerCancelledReason, TriggerIntent, TriggerStatus };

package/dist/trigger/entities/conditions.js

@@ -1,174 +0,0 @@
-import { z } from 'zod';
-import { Side } from '../../common/schema';
-import { Connector } from '../../connector';
-import { InstrumentId } from '../../instrument';
-import { PriceSource } from '../../price';
-import { MetricTrack } from '../common';
-
-const Ratio = z.object({
-  type: z.literal("ratio"),
-  data: z.object({
-    priceSource: PriceSource,
-    symbol_a: InstrumentId,
-    symbol_b: InstrumentId,
-    track: MetricTrack,
-    threshold: z.number()
-  })
-});
-const Price = z.object({
-  type: z.literal("price"),
-  data: z.object({
-    priceSource: PriceSource,
-    symbol: InstrumentId,
-    track: MetricTrack,
-    threshold: z.number()
-  })
-});
-const WeightedRatio = z.object({
-  type: z.literal("weighted_ratio"),
-  data: z.object({
-    priceSource: PriceSource,
-    basket: z.array(z.object({
-      symbol: InstrumentId,
-      side: Side,
-      weight: z.number()
-    })),
-    track: MetricTrack,
-    threshold: z.number()
-  })
-});
-const Notional = z.object({
-  type: z.literal("notional"),
-  data: z.object({
-    priceSource: PriceSource,
-    track: MetricTrack,
-    threshold: z.number()
-  })
-});
-const Upnl = z.object({
-  type: z.literal("upnl"),
-  data: z.object({
-    priceSource: PriceSource,
-    track: MetricTrack,
-    threshold: z.number()
-  })
-});
-const UpnlBps = z.object({
-  type: z.literal("upnl_bps"),
-  data: z.object({
-    priceSource: PriceSource,
-    track: MetricTrack,
-    threshold: z.number()
-  })
-});
-const FundingRate = z.object({
-  type: z.literal("funding_rate"),
-  data: z.object({
-    connector: Connector,
-    symbol: InstrumentId,
-    track: MetricTrack,
-    threshold: z.number()
-  })
-});
-const PredictionMarket = z.object({
-  type: z.literal("prediction_market"),
-  data: z.object({
-    source: z.enum([
-      "kalshi",
-      "polymarket"
-    ]),
-    marketKey: z.string().min(1),
-    track: MetricTrack,
-    threshold: z.number()
-  })
-});
-const BtcDominance = z.object({
-  type: z.literal("btc_dominance"),
-  data: z.object({
-    source: z.literal("coingecko"),
-    track: MetricTrack,
-    threshold: z.number()
-  })
-});
-const RatioTrailing = z.object({
-  type: z.literal("ratio_trailing"),
-  data: z.object({
-    priceSource: PriceSource,
-    symbol_a: InstrumentId,
-    symbol_b: InstrumentId
-  })
-});
-const PriceTrailing = z.object({
-  type: z.literal("price_trailing"),
-  data: z.object({
-    priceSource: PriceSource,
-    symbol: InstrumentId
-  })
-});
-const WeightedRatioTrailing = z.object({
-  type: z.literal("weighted_ratio_trailing"),
-  data: z.object({
-    priceSource: PriceSource,
-    basket: z.array(z.object({
-      symbol: InstrumentId,
-      side: Side,
-      weight: z.number()
-    }))
-  })
-});
-const NotionalTrailing = z.object({
-  type: z.literal("notional_trailing"),
-  data: z.object({
-    priceSource: PriceSource
-  })
-});
-const UpnlTrailing = z.object({
-  type: z.literal("upnl_trailing"),
-  data: z.object({
-    priceSource: PriceSource
-  })
-});
-const UpnlBpsTrailing = z.object({
-  type: z.literal("upnl_bps_trailing"),
-  data: z.object({
-    priceSource: PriceSource
-  })
-});
-const TriggerConditionOpen = z.discriminatedUnion("type", [
-  Ratio,
-  Price,
-  WeightedRatio,
-  FundingRate,
-  PredictionMarket,
-  BtcDominance
-]);
-const TriggerConditionAdjust = z.discriminatedUnion("type", [
-  Ratio,
-  Price,
-  WeightedRatio,
-  Notional,
-  Upnl,
-  UpnlBps,
-  FundingRate,
-  PredictionMarket,
-  BtcDominance
-]);
-const TriggerConditionClose = z.discriminatedUnion("type", [
-  Ratio,
-  Price,
-  WeightedRatio,
-  Notional,
-  Upnl,
-  UpnlBps,
-  RatioTrailing,
-  PriceTrailing,
-  WeightedRatioTrailing,
-  NotionalTrailing,
-  UpnlTrailing,
-  UpnlBpsTrailing,
-  FundingRate,
-  PredictionMarket,
-  BtcDominance
-]);
-
-export { TriggerConditionAdjust, TriggerConditionClose, TriggerConditionOpen };

package/dist/trigger/entities/index.js

@@ -1,257 +0,0 @@
-import { z } from 'zod';
-import { SignedDecimalString } from '../../common/schema';
-import { TradeLegPostOnly, TradeLeg } from '../../common/trade-legs';
-import { Connector } from '../../connector';
-import { Fill } from '../../fill';
-import { InstrumentId } from '../../instrument';
-import { TWAPRandomization } from '../../schedule/randomization';
-import { TWAPSliceIntervalSec, MIN_TWAP_SLICE_INTERVAL_SEC, FINAL_TWAP_SLICE_START_HEADROOM_SEC, MAX_TWAP_DURATION_SEC, TWAPTargetNotional, TriggerTWAPOpenLegs } from '../../schedule/twap-config';
-import { TrailingMode, BracketType, TriggerStatus, TriggerCancelledReason, TpSlBracketType } from '../common';
-import { TriggerConditionOpen, TriggerConditionAdjust, TriggerConditionClose } from './conditions';
-
-const Trailing = z.object({
-  /**
-  * Trailing mode to track the metric.
-  */
-  mode: TrailingMode,
-  /**
-  * Delta value to track the metric in the given mode.
-  */
-  deltaValue: z.number(),
-  /**
-  * Activation value to start tracking the metric.
-  * When omitted, trailing starts immediately from the current metric.
-  */
-  activationValue: z.number().optional(),
-  /**
-  * Best metric seen
-  */
-  bestMetricSeen: z.number().optional(),
-  /**
-  * Current stop value
-  */
-  currentStopValue: z.number().optional(),
-  /**
-  * Timestamp (ms) when a stop/activation breach was detected.
-  */
-  stopBreachedAt: z.number().optional()
-});
-const BaseTrigger = z.object({
-  /**
-  * Trigger UUID
-  */
-  id: z.uuid(),
-  /**
-  * Trade account UUID
-  */
-  tradeAccountId: z.uuid(),
-  /**
-  * Connector
-  */
-  connector: Connector,
-  /**
-  * Status of the trigger
-  */
-  status: TriggerStatus,
-  /**
-  * Parent ladder ID when this trigger is a ladder rung
-  */
-  ladderId: z.uuid().optional(),
-  /**
-  * Zero-based rung index within the parent ladder
-  */
-  ladderIndex: z.number().int().optional(),
-  /**
-  * Source open trigger that spawned this attached close trigger, when it originated from a conditional open
-  */
-  parentTriggerId: z.uuid().optional(),
-  /**
-  * When the trigger was triggered
-  */
-  triggeredAt: z.string().optional(),
-  /**
-  * When the trigger was cancelled
-  */
-  cancelledAt: z.string().optional(),
-  /**
-  * Reason for the trigger being cancelled
-  */
-  cancelledReason: TriggerCancelledReason.optional(),
-  /**
-  * Fills for the trigger
-  */
-  fills: z.array(Fill).optional(),
-  /**
-  * Bracket type for trigger behavior
-  */
-  bracketType: BracketType,
-  /**
-  * User-facing bracket semantics. `bracketType` is the crossing encoding the gateway
-  * fires on (wire-flipped for a price bracket on a short watched leg); this field is
-  * what the user asked for, so present this one as intent. Always stated: where a
-  * legacy client's encoding was unknowable, it carries `bracketType` as a best guess.
-  */
-  semanticBracketType: BracketType,
-  /**
-  * Created at timestamp
-  */
-  createdAt: z.string(),
-  /**
-  * Updated at timestamp
-  */
-  updatedAt: z.string()
-});
-const TriggerMarketOpenAttachedTrigger = z.object({
-  kind: z.enum([
-    "STATIC",
-    "TRAILING"
-  ]),
-  bracketType: TpSlBracketType
-});
-const TriggerMarketOpen = BaseTrigger.extend({
-  /**
-  * Intent
-  */
-  intent: z.literal("OPEN"),
-  /**
-  * Order type
-  */
-  type: z.literal("MARKET"),
-  /**
-  * Condition (only open conditions allowed)
-  */
-  condition: TriggerConditionOpen,
-  /**
-  * Context
-  */
-  context: z.object({
-    type: z.literal("MARKET"),
-    legs: z.tuple([
-      TradeLegPostOnly
-    ]).rest(TradeLegPostOnly),
-    /**
-    * Close triggers configured to attach after this open trigger fires.
-    */
-    attachedTriggers: z.array(TriggerMarketOpenAttachedTrigger)
-  })
-});
-const TriggerMarketAdjust = BaseTrigger.extend({
-  /**
-  * Intent
-  */
-  intent: z.literal("ADJUST"),
-  /**
-  * Order type
-  */
-  type: z.literal("MARKET"),
-  /**
-  * Condition (only adjust conditions allowed)
-  */
-  condition: TriggerConditionAdjust,
-  /**
-  * Context
-  */
-  context: z.object({
-    type: z.literal("MARKET"),
-    position: z.object({
-      id: z.uuid(),
-      initialExposure: z.record(InstrumentId, SignedDecimalString)
-    }),
-    legs: z.tuple([
-      TradeLeg
-    ]).rest(TradeLeg)
-  }),
-  /**
-  * Optional: trailing configuration
-  */
-  trailing: Trailing.optional()
-});
-const TriggerMarketClose = BaseTrigger.extend({
-  /**
-  * Intent
-  */
-  intent: z.literal("CLOSE"),
-  /**
-  * Order type
-  */
-  type: z.literal("MARKET"),
-  /**
-  * Condition (only close conditions allowed)
-  */
-  condition: TriggerConditionClose,
-  /**
-  * Context
-  */
-  context: z.object({
-    type: z.literal("MARKET"),
-    position: z.object({
-      id: z.uuid(),
-      initialExposure: z.record(InstrumentId, SignedDecimalString)
-    })
-  }),
-  /**
-  * Optional: trailing configuration
-  */
-  trailing: Trailing.optional()
-});
-const TriggerMarket = z.discriminatedUnion("intent", [
-  TriggerMarketOpen,
-  TriggerMarketAdjust,
-  TriggerMarketClose
-]);
-const TriggerTWAPContext = z.object({
-  type: z.literal("TWAP"),
-  durationSec: z.int().min(MIN_TWAP_SLICE_INTERVAL_SEC + FINAL_TWAP_SLICE_START_HEADROOM_SEC).max(MAX_TWAP_DURATION_SEC),
-  sliceIntervalSec: TWAPSliceIntervalSec,
-  randomization: TWAPRandomization,
-  position: z.object({
-    id: z.uuid(),
-    initialExposure: z.record(InstrumentId, SignedDecimalString)
-  })
-}).refine((context) => context.durationSec >= context.sliceIntervalSec + FINAL_TWAP_SLICE_START_HEADROOM_SEC, {
-  message: `TWAP duration must leave ${FINAL_TWAP_SLICE_START_HEADROOM_SEC} seconds after the first slice`,
-  path: [
-    "durationSec"
-  ]
-});
-const TriggerTWAPAdjust = BaseTrigger.extend({
-  /** Intent. */
-  intent: z.literal("ADJUST"),
-  /** Order type. */
-  type: z.literal("TWAP"),
-  /** Schedule created when the trigger fired, absent before firing or after a skipped fire. */
-  scheduleId: z.uuid().optional(),
-  /** Condition. */
-  condition: TriggerConditionAdjust,
-  /** Persisted TWAP execution context. */
-  context: TriggerTWAPContext.safeExtend({
-    legs: TriggerTWAPOpenLegs,
-    targetNotional: TWAPTargetNotional
-  }),
-  /** Optional trailing configuration. */
-  trailing: Trailing.optional()
-});
-const TriggerTWAPClose = BaseTrigger.extend({
-  /** Intent. */
-  intent: z.literal("CLOSE"),
-  /** Order type. */
-  type: z.literal("TWAP"),
-  /** Schedule created when the trigger fired, absent before firing or after a skipped fire. */
-  scheduleId: z.uuid().optional(),
-  /** Condition. */
-  condition: TriggerConditionClose,
-  /** Persisted TWAP execution context. */
-  context: TriggerTWAPContext,
-  /** Optional trailing configuration. */
-  trailing: Trailing.optional()
-});
-const TriggerTWAP = z.discriminatedUnion("intent", [
-  TriggerTWAPAdjust,
-  TriggerTWAPClose
-]);
-const Trigger = z.discriminatedUnion("type", [
-  TriggerMarket,
-  TriggerTWAP
-]);
-
-export { Trailing, Trigger, TriggerMarket, TriggerMarketAdjust, TriggerMarketClose, TriggerMarketOpen, TriggerMarketOpenAttachedTrigger, TriggerTWAP, TriggerTWAPAdjust, TriggerTWAPClose };

package/dist/trigger/index.js

@@ -1,9 +0,0 @@
-export * from './common';
-export * from './entities';
-export * from './entities/conditions';
-export * from './oracle';
-export * from './payloads';
-export * from './payloads/conditions';
-export * from './queries';
-export * from './refinement';
-export * from './responses';

package/dist/trigger/oracle.js

@@ -1,22 +0,0 @@
-import { z } from 'zod';
-
-const OracleUnit = z.enum([
-  "cent",
-  "percent"
-]);
-const OracleValue = z.object({
-  value: z.number(),
-  unit: OracleUnit
-});
-const OracleTrigger = z.object({
-  id: z.string(),
-  category: z.enum([
-    "btcdom"
-  ]),
-  source: z.enum([
-    "coingecko"
-  ]),
-  oracle: OracleValue.nullable()
-});
-
-export { OracleTrigger, OracleUnit, OracleValue };