@pear-protocol/types 2.20.0 → 2.22.0

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';

package/dist/execution/queries.js

@@ -1,18 +0,0 @@
-import { z } from 'zod';
-import { normalizeArray, CursorFindParams } from '../common';
-import { Connector } from '../connector';
-
-const StatusEnum = z.enum([
-  "ACTIVE",
-  "COMPLETED",
-  "CANCELLED"
-]);
-const StatusArray = z.preprocess((arg) => normalizeArray(arg), z.array(StatusEnum));
-const ExecutionListParams = CursorFindParams.extend({
-  connector: Connector.optional(),
-  status: StatusArray.optional(),
-  includeSchedule: z.coerce.boolean().optional().default(false),
-  includeTriggers: z.coerce.boolean().optional().default(false)
-});
-
-export { ExecutionListParams };

package/dist/execution/responses.js

@@ -1,12 +0,0 @@
-import { z } from 'zod';
-import { CursorResponse } from '../common';
-import { Execution } from './entities';
-
-const ExecutionListResponse = CursorResponse.extend({
-  executions: z.array(Execution)
-});
-const GetExecutionResponse = z.object({
-  execution: Execution
-});
-
-export { ExecutionListResponse, GetExecutionResponse };

package/dist/fee/entities.js

@@ -1,34 +0,0 @@
-import { z } from 'zod';
-import { Connector } from '../connector';
-
-var __defProp = Object.defineProperty;
-var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
-const MAX_FEE_BPS = 10;
-const FeeOverrideScope = z.enum([
-  "user",
-  "client_id"
-]);
-const FeeDiscountScope = z.enum([
-  "user",
-  "client_id",
-  "connector",
-  "all"
-]);
-const FeeConnector = z.enum(Connector.options);
-const FeeRole = z.enum([
-  "basic",
-  "pro",
-  "vault"
-]);
-const FeeBps = z.string().regex(/^\d{1,2}(\.\d)?$/, "Fee bps must be a decimal with at most one decimal place").refine((value) => Number(value) <= MAX_FEE_BPS, `Fee bps must not exceed ${MAX_FEE_BPS}`);
-const DiscountRate = z.string().regex(/^(0(\.\d{1,4})?|1(\.0{1,4})?)$/, 'Discount rate must be a fraction from 0 to 1, e.g. "0.2" for 20% off');
-const ORDERED_VALIDITY_WINDOW_MESSAGE = "endsAt must be later than startsAt";
-function hasOrderedValidityWindow(window) {
-  if (!window.startsAt || !window.endsAt) {
-    return true;
-  }
-  return new Date(window.startsAt).getTime() < new Date(window.endsAt).getTime();
-}
-__name(hasOrderedValidityWindow, "hasOrderedValidityWindow");
-
-export { DiscountRate, FeeBps, FeeConnector, FeeDiscountScope, FeeOverrideScope, FeeRole, MAX_FEE_BPS, ORDERED_VALIDITY_WINDOW_MESSAGE, hasOrderedValidityWindow };

package/dist/fee/index.js

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

package/dist/fee/queries.js

@@ -1,12 +0,0 @@
-import { z } from 'zod';
-import { ClientIdCode } from '../common/client-id';
-import { FeeConnector } from './entities';
-
-const QuoteFeeParams = z.object({
-  clientId: ClientIdCode
-});
-const GetFeeRecipientParams = z.object({
-  connector: FeeConnector
-});
-
-export { GetFeeRecipientParams, QuoteFeeParams };

package/dist/fee/responses.js

@@ -1,29 +0,0 @@
-import { z } from 'zod';
-import { DiscountRate, FeeDiscountScope, FeeBps, FeeOverrideScope } from './entities';
-
-const AppliedFeeDiscount = z.object({
-  scope: FeeDiscountScope,
-  rate: DiscountRate
-}).describe("A discount applied to the quoted fee");
-const FeeResponse = z.object({
-  // Connector-native fee recipient; absent means the order names none, so it carries no fee
-  feeRecipient: z.string().optional(),
-  // The (role, connector) rate the quote started from
-  baseBps: FeeBps,
-  // The rate that replaced the base; absent when no override matched
-  overrideBps: FeeBps.optional(),
-  // Which scope that override came from
-  overrideScope: FeeOverrideScope.optional(),
-  // Every discount taken off the amount. Rates add up rather than compound, and the total is
-  // capped at 100%, so a deep stack floors the fee at zero.
-  discounts: z.array(AppliedFeeDiscount),
-  // What the trade actually pays. Always a multiple of 0.1 bps: resolution rounds up to that step
-  // so a discounted fee cannot shrink to nothing.
-  finalBps: FeeBps
-}).describe("Resolved trading fee and connector fee recipient for the caller's trade account");
-const FeeRecipientResponse = z.object({
-  // Connector-native recipient identifier (Hyperliquid builder address, Lighter integrator account index)
-  recipient: z.string().optional()
-}).describe("Connector-native fee recipient to approve for the caller's role");
-
-export { AppliedFeeDiscount, FeeRecipientResponse, FeeResponse };

package/dist/fill/entities.js

@@ -1,82 +0,0 @@
-import { z } from 'zod';
-import { Side } from '../common/schema';
-import { Connector } from '../connector';
-import { InstrumentId } from '../instrument';
-
-const FillStatus = z.enum([
-  "PROVISIONAL",
-  "CONFIRMED",
-  "RECONCILED"
-]);
-const Fill = z.object({
-  /**
-  * Fill UUID
-  */
-  id: z.uuid(),
-  /** Client order ID (abbreviated as cloid) */
-  cloid: z.string().optional(),
-  /** Exchange-native fill ID (tradeId / tid / etc) */
-  exchangeFillId: z.string().optional(),
-  /**
-  * Fill lifecycle status
-  */
-  status: FillStatus,
-  /**
-  * Trade account UUID
-  */
-  tradeAccountId: z.uuid(),
-  /**
-  * Instrument ID
-  */
-  symbol: InstrumentId,
-  /**
-  * Position UUID
-  */
-  positionId: z.uuid(),
-  /**
-  * Connector
-  */
-  connector: Connector,
-  /**
-  * Side
-  */
-  side: Side,
-  /**
-  * Reduce only flag
-  */
-  reduceOnly: z.boolean(),
-  /** True when the fill was created from external sync. */
-  isExternal: z.boolean(),
-  /**
-  * True when the fill is a synthetic bridge fill (gap/gone reconstruction).
-  * Unpriceable gone-close synthetics carry "0" price/usd and should be displayed distinctly.
-  */
-  synthetic: z.boolean(),
-  quantity: z.string(),
-  /** Filled price — "0" on an unpriceable gone-close synthetic (no price guessing). */
-  price: z.string(),
-  /** USD value — "0" on an unpriceable gone-close synthetic (cannot compute without price). */
-  usd: z.string(),
-  /**
-  * Trade fee paid
-  */
-  tradeFee: z.string().optional(),
-  /**
-  * Pear fee paid
-  */
-  pearFee: z.string().optional(),
-  /**
-  * Timestamp
-  */
-  timestamp: z.string(),
-  /**
-  * A fill spanning multiple positions gets a synthetic exchange fill id.
-  * This `original` field contains the root exchange fill id and quantity.
-  */
-  original: z.object({
-    exchangeFillId: z.string(),
-    quantity: z.string()
-  }).optional()
-});
-
-export { Fill, FillStatus };

package/dist/fill/index.js

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

package/dist/fill/queries.js

@@ -1,14 +0,0 @@
-import { z } from 'zod';
-import { CursorFindParams } from '../common';
-import { Connector } from '../connector';
-
-const FillOrderBy = z.union([
-  z.literal("timestamp"),
-  z.literal("-timestamp")
-]);
-const FillListParams = CursorFindParams.extend({
-  connector: Connector.optional(),
-  orderBy: FillOrderBy.default("-timestamp")
-});
-
-export { FillListParams, FillOrderBy };

package/dist/fill/responses.js

@@ -1,23 +0,0 @@
-import { z } from 'zod';
-import { CursorResponse } from '../common';
-import { InstrumentId } from '../instrument';
-import { Fill } from './entities';
-
-const FillListResponse = CursorResponse.extend({
-  fills: z.array(Fill)
-});
-const PositionFillListResponse = z.object({
-  fills: z.array(Fill)
-});
-const ProvisionalFill = z.object({
-  id: z.uuid(),
-  positionId: z.uuid(),
-  symbol: InstrumentId,
-  cloid: z.string().optional(),
-  status: z.literal("PROVISIONAL")
-});
-const ProvisionalFillListResponse = z.object({
-  fills: z.array(ProvisionalFill)
-});
-
-export { FillListResponse, PositionFillListResponse, ProvisionalFill, ProvisionalFillListResponse };

package/dist/funding/entities.js

@@ -1,16 +0,0 @@
-import { z } from 'zod';
-import { InstrumentId } from '../instrument';
-
-const FundingInfo = z.object({
-  /**
-  * Funding rate
-  */
-  r: z.string(),
-  /**
-  * Next funding time in milliseconds
-  */
-  nft: z.number()
-});
-const InstrumentFundingMap = z.record(InstrumentId, FundingInfo);
-
-export { FundingInfo, InstrumentFundingMap };

package/dist/funding/index.js

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

package/dist/funding/queries.js

@@ -1,8 +0,0 @@
-import { z } from 'zod';
-import { Connector } from '../connector';
-
-const FundingQueryParams = z.object({
-  connector: Connector
-});
-
-export { FundingQueryParams };

package/dist/funding/responses.js

@@ -1,11 +0,0 @@
-import { z } from 'zod';
-import { InstrumentFundingMap } from './entities';
-
-const FundingResponse = z.object({
-  /**
-  * Funding rates and next funding times for instruments
-  */
-  funding: InstrumentFundingMap
-});
-
-export { FundingResponse };

package/dist/instrument/entities.js

@@ -1,102 +0,0 @@
-import { z } from 'zod';
-import { Connector } from '../connector';
-import { InstrumentPrecision } from '../instrument-precision';
-
-const InstrumentId = z.string().trim().min(1, "Instrument ID is required").max(64, "Instrument ID must be at most 64 characters").regex(/^[^\s][^\s]*$/, "Instrument ID contains invalid characters");
-const InstrumentType = z.enum([
-  "spot",
-  "perp",
-  "hip3"
-]);
-const InstrumentMarginMode = z.enum([
-  "isolated",
-  "cross",
-  "any"
-]);
-const InstrumentTradeabilityStatus = z.enum([
-  "tradable",
-  "reduce_only",
-  "not_tradable"
-]);
-const InstrumentTradeabilityReason = z.string().nullable();
-const InstrumentTradeability = z.object({
-  status: InstrumentTradeabilityStatus,
-  reason: InstrumentTradeabilityReason
-});
-const Instrument = z.object({
-  /**
-  * Exchange specific instrument identifier
-  * @example (dexIndex + assetIndex) on Hyperliquid
-  * @example "BTCUSDT" on Binance
-  */
-  id: InstrumentId,
-  /**
-  * The base asset of the instrument.
-  * @example "BTC"
-  */
-  base: z.string(),
-  /**
-  * The quote asset of the instrument.
-  * @example "USDT"
-  */
-  quote: z.string(),
-  /**
-  * The connector of the instrument.
-  * @example "hyperliquid"
-  * @example "binance"
-  */
-  connector: Connector,
-  /**
-  * The type of the instrument.
-  * @example "spot"
-  * @example "perp"
-  * @example "hip3"
-  */
-  type: InstrumentType,
-  /**
-  * The maximum leverage of the instrument.
-  * @example 1
-  */
-  leverage: z.int().min(1),
-  /**
-  * The margin modes this market offers, not the mode selected for an account.
-  * `isolated` and `cross` mean the venue permits only that mode; `any` means the user chooses.
-  */
-  marginMode: InstrumentMarginMode,
-  /**
-  * The precision of the instrument.
-  */
-  precision: InstrumentPrecision,
-  /**
-  * Whether this instrument can be traded normally.
-  */
-  tradeability: InstrumentTradeability
-});
-const InstrumentLite = z.object({
-  /**
-  * Exchange specific instrument identifier
-  * @example (dexIndex + assetIndex) on Hyperliquid
-  * @example "BTCUSDT" on Binance
-  */
-  id: InstrumentId,
-  /**
-  * The base asset of the instrument.
-  * @example "BTC"
-  */
-  base: z.string(),
-  /**
-  * The margin modes this market offers, not the mode selected for an account.
-  * `isolated` and `cross` mean the venue permits only that mode; `any` means the user chooses.
-  */
-  marginMode: InstrumentMarginMode,
-  /**
-  * Minimal precision — only the contract size the syncer needs for BASE-unit normalization.
-  */
-  precision: z.object({
-    quantity: z.object({
-      contractSize: z.number()
-    })
-  })
-});
-
-export { Instrument, InstrumentId, InstrumentLite, InstrumentMarginMode, InstrumentTradeability, InstrumentTradeabilityReason, InstrumentTradeabilityStatus, InstrumentType };

package/dist/instrument/index.js

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

package/dist/instrument/queries.js

@@ -1,15 +0,0 @@
-import { z } from 'zod';
-import { Connector } from '../connector';
-
-const InstrumentScope = z.enum([
-  "tradable",
-  "reduce_only",
-  "not_tradable",
-  "all"
-]);
-const InstrumentListParams = z.object({
-  connector: Connector,
-  scope: InstrumentScope.default("all")
-});
-
-export { InstrumentListParams, InstrumentScope };

package/dist/instrument/responses.js

@@ -1,20 +0,0 @@
-import { z } from 'zod';
-import { Instrument, InstrumentId, InstrumentLite } from './entities';
-
-const InstrumentListResponse = z.object({
-  /**
-  * The list of instruments.
-  */
-  instruments: z.array(Instrument)
-});
-const InstrumentSymbolToIdMapResponse = z.object({
-  data: z.record(z.string(), InstrumentId)
-});
-const InstrumentListLiteResponse = z.object({
-  /**
-  * The list of instruments, trimmed to the lightweight consumer fields.
-  */
-  instruments: z.array(InstrumentLite)
-});
-
-export { InstrumentListLiteResponse, InstrumentListResponse, InstrumentSymbolToIdMapResponse };

package/dist/instrument-precision/index.js

@@ -1,56 +0,0 @@
-import { z } from 'zod';
-
-const InstrumentPrecision = z.object({
-  quantity: z.object({
-    /**
-    * The maximum number of decimals accepted.
-    * @example 4 for a 0.0001 step size.
-    */
-    decimals: z.int(),
-    /**
-    * The smallest step size.
-    * @example 0.01 for a 2 decimal precision.
-    */
-    step: z.number(),
-    /**
-    * Size of one contract in base asset units.
-    * For exchanges where 1 contract != 1 base unit (e.g., OKX: 1 contract = 0.01 BTC).
-    * 1 means 1:1 mapping (most exchanges).
-    */
-    contractSize: z.number(),
-    /**
-    * The venue's minimum order quantity for market (IOC) orders, in contracts, when it has one.
-    * @example 10 on Binance ALLUSDT, where one step is 1.
-    */
-    min: z.number().transform((val) => val === null ? void 0 : val).optional().nullable()
-  }),
-  price: z.object({
-    /**
-    * The maximum number of decimals.
-    * @example 4 for a 0.0001 tick size.
-    */
-    decimals: z.int(),
-    /**
-    * The smallest increment.
-    * @example 0.01 for a 2 decimal precision.
-    */
-    tick: z.number().transform((val) => val === null ? void 0 : val).optional().nullable(),
-    /**
-    * The number of significant figures.
-    * @example 5 on Hyperliquid V2.
-    */
-    sigFigs: z.int().transform((val) => val === null ? void 0 : val).optional().nullable()
-  }),
-  notional: z.object({
-    /**
-    * The minimum notional amount in USD.
-    */
-    min: z.number().transform((val) => val === null ? void 0 : val).optional().nullable(),
-    /**
-    * The maximum notional amount in USD.
-    */
-    max: z.number().transform((val) => val === null ? void 0 : val).optional().nullable()
-  }).optional()
-});
-
-export { InstrumentPrecision };