@pear-protocol/types 2.18.0 → 2.20.0

package/dist/realtime/frames.js

@@ -0,0 +1,140 @@
+import { z } from 'zod';
+import { EthereumAddress } from '../common/address';
+import { WebsocketChannel } from './channels';
+import { PriceUpdatedData, FundingUpdatedData, TradeExecutedData, TriggerTriggeredPublicData } from './public-events';
+import { UserEventData, UserEventTopic } from './user-events';
+import { PublicVaultInvalidatedData, ManagementVaultInvalidatedData } from './vault-events';
+
+const FrameRequestId = z.string().optional();
+const WebsocketWelcomeFrame = z.object({
+  type: z.literal("welcome"),
+  connectionId: z.string(),
+  heartbeatIntervalMs: z.number(),
+  resubscribeRequired: z.literal(true)
+});
+const AuthAckFrame = z.object({
+  id: FrameRequestId,
+  type: z.literal("ack"),
+  method: z.literal("auth"),
+  ok: z.literal(true)
+});
+const SubscriptionAckFrame = z.object({
+  id: FrameRequestId,
+  type: z.literal("ack"),
+  method: z.enum([
+    "subscribe",
+    "unsubscribe"
+  ]),
+  channel: WebsocketChannel,
+  ok: z.literal(true)
+});
+const WebsocketAckFrame = z.discriminatedUnion("method", [
+  AuthAckFrame,
+  SubscriptionAckFrame
+]);
+const WebsocketVaultErrorCode = z.enum([
+  "FORBIDDEN",
+  "SUBSCRIPTION_REVOKED"
+]);
+const WebsocketRequestErrorCode = z.enum([
+  "AUTH_EXPIRED",
+  "CAPACITY_UNAVAILABLE",
+  "INTERNAL_ERROR",
+  "INVALID_FRAME",
+  "INVALID_JSON",
+  "INVALID_MESSAGE",
+  "INVALID_SUBSCRIPTION",
+  "RATE_LIMITED",
+  "TOO_MANY_SUBSCRIPTIONS",
+  "UNAUTHENTICATED"
+]);
+const WebsocketErrorCode = z.enum([
+  ...WebsocketRequestErrorCode.options,
+  ...WebsocketVaultErrorCode.options
+]);
+const RequestErrorFrame = z.object({
+  id: FrameRequestId,
+  type: z.literal("error"),
+  code: WebsocketRequestErrorCode,
+  message: z.string()
+});
+const VaultErrorFrame = z.object({
+  id: FrameRequestId,
+  type: z.literal("error"),
+  code: WebsocketVaultErrorCode,
+  message: z.string(),
+  // Vaults a FORBIDDEN refusal or SUBSCRIPTION_REVOKED notice applies to.
+  vaults: z.array(EthereumAddress)
+});
+const WebsocketErrorFrame = z.discriminatedUnion("code", [
+  RequestErrorFrame,
+  VaultErrorFrame
+]);
+const PriceUpdatedFrame = z.object({
+  type: z.literal("event"),
+  channel: z.literal("prices"),
+  topic: z.literal("price.updated"),
+  data: PriceUpdatedData
+});
+const FundingUpdatedFrame = z.object({
+  type: z.literal("event"),
+  channel: z.literal("funding"),
+  topic: z.literal("funding.updated"),
+  data: FundingUpdatedData
+});
+const TradeExecutedFrame = z.object({
+  type: z.literal("event"),
+  channel: z.literal("trades"),
+  topic: z.literal("trade.executed"),
+  data: TradeExecutedData
+});
+const TriggerTriggeredPublicFrame = z.object({
+  type: z.literal("event"),
+  channel: z.literal("trigger_events"),
+  topic: z.literal("trigger.triggered.public"),
+  data: TriggerTriggeredPublicData
+});
+const UserEventFrame = z.object({
+  type: z.literal("event"),
+  channel: z.literal("user_events"),
+  topic: UserEventTopic,
+  data: UserEventData
+});
+const VaultEventsInvalidatedFrame = z.object({
+  type: z.literal("event"),
+  channel: z.literal("vault_events"),
+  topic: z.literal("vault.invalidated"),
+  data: PublicVaultInvalidatedData
+});
+const VaultManagementInvalidatedFrame = z.object({
+  type: z.literal("event"),
+  channel: z.literal("vault_management"),
+  topic: z.literal("vault.invalidated"),
+  data: ManagementVaultInvalidatedData
+});
+const VaultInvalidatedFrame = z.discriminatedUnion("channel", [
+  VaultEventsInvalidatedFrame,
+  VaultManagementInvalidatedFrame
+]);
+const WebsocketEventFrame = z.discriminatedUnion("topic", [
+  PriceUpdatedFrame,
+  FundingUpdatedFrame,
+  TradeExecutedFrame,
+  TriggerTriggeredPublicFrame,
+  UserEventFrame,
+  VaultInvalidatedFrame
+]);
+const WebsocketPongFrame = z.object({
+  id: FrameRequestId,
+  type: z.literal("pong"),
+  timestamp: z.iso.datetime()
+});
+const WebsocketFrame = z.discriminatedUnion("type", [
+  WebsocketWelcomeFrame,
+  WebsocketAckFrame,
+  WebsocketErrorFrame,
+  WebsocketEventFrame,
+  WebsocketPongFrame
+]);
+
+export { WebsocketAckFrame, WebsocketErrorCode, WebsocketErrorFrame, WebsocketEventFrame, WebsocketFrame, WebsocketPongFrame, WebsocketRequestErrorCode, WebsocketVaultErrorCode, WebsocketWelcomeFrame };

package/dist/realtime/index.d.ts

@@ -0,0 +1,6 @@
+export * from './channels';
+export * from './frames';
+export * from './messages';
+export * from './public-events';
+export * from './user-events';
+export * from './vault-events';

package/dist/realtime/index.js

@@ -0,0 +1,6 @@
+export * from './channels';
+export * from './frames';
+export * from './messages';
+export * from './public-events';
+export * from './user-events';
+export * from './vault-events';

package/dist/realtime/messages.d.ts

@@ -0,0 +1,243 @@
+import { z } from 'zod';
+import { EthereumAddress } from '../common/address';
+/** Most vaults one socket may watch per vault channel (vault_events, vault_management). */
+export declare const MAX_VAULTS_PER_CONNECTION = 20;
+/** Client correlation id: a string or number, echoed back as a string on the matching ack or error. */
+export declare const WebsocketRequestId: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string, string | number>>>;
+export declare const WebsocketPublicParams: z.ZodObject<{
+    connectors: z.ZodOptional<z.ZodArray<z.ZodEnum<{
+        hyperliquid: "hyperliquid";
+        binance: "binance";
+        bybit: "bybit";
+        okx: "okx";
+        lighter: "lighter";
+        lighter_rhc: "lighter_rhc";
+    }>>>;
+    instrumentIds: z.ZodOptional<z.ZodArray<z.ZodString>>;
+}, z.core.$strict>;
+export type WebsocketPublicParams = z.output<typeof WebsocketPublicParams>;
+export declare const WebsocketUserEventsParams: z.ZodObject<{
+    topics: z.ZodOptional<z.ZodArray<z.ZodEnum<{
+        "execution.failed": "execution.failed";
+        "execution.completed": "execution.completed";
+        "position.created": "position.created";
+        "position.updated": "position.updated";
+        "position.closed": "position.closed";
+        "schedule.created": "schedule.created";
+        "schedule.completed": "schedule.completed";
+        "schedule.failed": "schedule.failed";
+        "schedule.cancelled": "schedule.cancelled";
+        "ladder.created": "ladder.created";
+        "ladder.updated": "ladder.updated";
+        "ladder.cancelled": "ladder.cancelled";
+        "trigger.created": "trigger.created";
+        "trigger.triggered": "trigger.triggered";
+        "trigger.cancelled": "trigger.cancelled";
+        "trigger.converted": "trigger.converted";
+        "rebalance.created": "rebalance.created";
+        "rebalance.updated": "rebalance.updated";
+        "rebalance.executed": "rebalance.executed";
+        "rebalance.paused": "rebalance.paused";
+        "rebalance.cancelled": "rebalance.cancelled";
+        "notification.created": "notification.created";
+    }>>>;
+}, z.core.$strict>;
+export type WebsocketUserEventsParams = z.output<typeof WebsocketUserEventsParams>;
+export declare const WebsocketTriggerEventsParams: z.ZodObject<{
+    connectors: z.ZodOptional<z.ZodArray<z.ZodEnum<{
+        hyperliquid: "hyperliquid";
+        binance: "binance";
+        bybit: "bybit";
+        okx: "okx";
+        lighter: "lighter";
+        lighter_rhc: "lighter_rhc";
+    }>>>;
+    accountIds: z.ZodOptional<z.ZodArray<z.ZodString>>;
+}, z.core.$strict>;
+export type WebsocketTriggerEventsParams = z.output<typeof WebsocketTriggerEventsParams>;
+/** Public vault invalidations are addressed by lowercased vault contract address. */
+export declare const WebsocketVaultEventsParams: z.ZodObject<{
+    vaults: z.ZodArray<z.ZodPipe<z.ZodString, z.ZodTransform<EthereumAddress, string>>>;
+}, z.core.$strict>;
+export type WebsocketVaultEventsParams = z.output<typeof WebsocketVaultEventsParams>;
+/** Every frame a client may send to the realtime websocket. */
+export declare const WebsocketControlMessage: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    id: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string, string | number>>>;
+    method: z.ZodLiteral<"auth">;
+    params: z.ZodObject<{
+        accessToken: z.ZodString;
+    }, z.core.$strict>;
+}, z.core.$strip>, z.ZodObject<{
+    id: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string, string | number>>>;
+    method: z.ZodLiteral<"ping">;
+}, z.core.$strip>, z.ZodDiscriminatedUnion<[z.ZodObject<{
+    id: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string, string | number>>>;
+    method: z.ZodLiteral<"subscribe">;
+    channel: z.ZodEnum<{
+        funding: "funding";
+        prices: "prices";
+        trades: "trades";
+    }>;
+    params: z.ZodOptional<z.ZodObject<{
+        connectors: z.ZodOptional<z.ZodArray<z.ZodEnum<{
+            hyperliquid: "hyperliquid";
+            binance: "binance";
+            bybit: "bybit";
+            okx: "okx";
+            lighter: "lighter";
+            lighter_rhc: "lighter_rhc";
+        }>>>;
+        instrumentIds: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    }, z.core.$strict>>;
+}, z.core.$strip>, z.ZodObject<{
+    id: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string, string | number>>>;
+    method: z.ZodLiteral<"subscribe">;
+    channel: z.ZodLiteral<"user_events">;
+    params: z.ZodOptional<z.ZodObject<{
+        topics: z.ZodOptional<z.ZodArray<z.ZodEnum<{
+            "execution.failed": "execution.failed";
+            "execution.completed": "execution.completed";
+            "position.created": "position.created";
+            "position.updated": "position.updated";
+            "position.closed": "position.closed";
+            "schedule.created": "schedule.created";
+            "schedule.completed": "schedule.completed";
+            "schedule.failed": "schedule.failed";
+            "schedule.cancelled": "schedule.cancelled";
+            "ladder.created": "ladder.created";
+            "ladder.updated": "ladder.updated";
+            "ladder.cancelled": "ladder.cancelled";
+            "trigger.created": "trigger.created";
+            "trigger.triggered": "trigger.triggered";
+            "trigger.cancelled": "trigger.cancelled";
+            "trigger.converted": "trigger.converted";
+            "rebalance.created": "rebalance.created";
+            "rebalance.updated": "rebalance.updated";
+            "rebalance.executed": "rebalance.executed";
+            "rebalance.paused": "rebalance.paused";
+            "rebalance.cancelled": "rebalance.cancelled";
+            "notification.created": "notification.created";
+        }>>>;
+    }, z.core.$strict>>;
+}, z.core.$strip>, z.ZodObject<{
+    id: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string, string | number>>>;
+    method: z.ZodLiteral<"subscribe">;
+    channel: z.ZodLiteral<"trigger_events">;
+    params: z.ZodOptional<z.ZodObject<{
+        connectors: z.ZodOptional<z.ZodArray<z.ZodEnum<{
+            hyperliquid: "hyperliquid";
+            binance: "binance";
+            bybit: "bybit";
+            okx: "okx";
+            lighter: "lighter";
+            lighter_rhc: "lighter_rhc";
+        }>>>;
+        accountIds: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    }, z.core.$strict>>;
+}, z.core.$strip>, z.ZodObject<{
+    id: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string, string | number>>>;
+    method: z.ZodLiteral<"subscribe">;
+    channel: z.ZodLiteral<"vault_events">;
+    params: z.ZodObject<{
+        vaults: z.ZodArray<z.ZodPipe<z.ZodString, z.ZodTransform<EthereumAddress, string>>>;
+    }, z.core.$strict>;
+}, z.core.$strip>, z.ZodObject<{
+    id: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string, string | number>>>;
+    method: z.ZodLiteral<"subscribe">;
+    channel: z.ZodLiteral<"vault_management">;
+    params: z.ZodObject<{
+        vaults: z.ZodArray<z.ZodPipe<z.ZodString, z.ZodTransform<EthereumAddress, string>>>;
+    }, z.core.$strict>;
+}, z.core.$strip>], "channel">, z.ZodDiscriminatedUnion<[z.ZodObject<{
+    id: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string, string | number>>>;
+    method: z.ZodLiteral<"unsubscribe">;
+    channel: z.ZodEnum<{
+        funding: "funding";
+        prices: "prices";
+        trades: "trades";
+    }>;
+    params: z.ZodOptional<z.ZodObject<{
+        connectors: z.ZodOptional<z.ZodArray<z.ZodEnum<{
+            hyperliquid: "hyperliquid";
+            binance: "binance";
+            bybit: "bybit";
+            okx: "okx";
+            lighter: "lighter";
+            lighter_rhc: "lighter_rhc";
+        }>>>;
+        instrumentIds: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    }, z.core.$strict>>;
+}, z.core.$strip>, z.ZodObject<{
+    id: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string, string | number>>>;
+    method: z.ZodLiteral<"unsubscribe">;
+    channel: z.ZodLiteral<"user_events">;
+    params: z.ZodOptional<z.ZodObject<{
+        topics: z.ZodOptional<z.ZodArray<z.ZodEnum<{
+            "execution.failed": "execution.failed";
+            "execution.completed": "execution.completed";
+            "position.created": "position.created";
+            "position.updated": "position.updated";
+            "position.closed": "position.closed";
+            "schedule.created": "schedule.created";
+            "schedule.completed": "schedule.completed";
+            "schedule.failed": "schedule.failed";
+            "schedule.cancelled": "schedule.cancelled";
+            "ladder.created": "ladder.created";
+            "ladder.updated": "ladder.updated";
+            "ladder.cancelled": "ladder.cancelled";
+            "trigger.created": "trigger.created";
+            "trigger.triggered": "trigger.triggered";
+            "trigger.cancelled": "trigger.cancelled";
+            "trigger.converted": "trigger.converted";
+            "rebalance.created": "rebalance.created";
+            "rebalance.updated": "rebalance.updated";
+            "rebalance.executed": "rebalance.executed";
+            "rebalance.paused": "rebalance.paused";
+            "rebalance.cancelled": "rebalance.cancelled";
+            "notification.created": "notification.created";
+        }>>>;
+    }, z.core.$strict>>;
+}, z.core.$strip>, z.ZodObject<{
+    id: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string, string | number>>>;
+    method: z.ZodLiteral<"unsubscribe">;
+    channel: z.ZodLiteral<"trigger_events">;
+    params: z.ZodOptional<z.ZodObject<{
+        connectors: z.ZodOptional<z.ZodArray<z.ZodEnum<{
+            hyperliquid: "hyperliquid";
+            binance: "binance";
+            bybit: "bybit";
+            okx: "okx";
+            lighter: "lighter";
+            lighter_rhc: "lighter_rhc";
+        }>>>;
+        accountIds: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    }, z.core.$strict>>;
+}, z.core.$strip>, z.ZodObject<{
+    id: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string, string | number>>>;
+    method: z.ZodLiteral<"unsubscribe">;
+    channel: z.ZodLiteral<"vault_events">;
+    params: z.ZodOptional<z.ZodObject<{
+        vaults: z.ZodArray<z.ZodPipe<z.ZodString, z.ZodTransform<EthereumAddress, string>>>;
+    }, z.core.$strict>>;
+}, z.core.$strip>, z.ZodObject<{
+    id: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string, string | number>>>;
+    method: z.ZodLiteral<"unsubscribe">;
+    channel: z.ZodLiteral<"vault_management">;
+    params: z.ZodOptional<z.ZodObject<{
+        vaults: z.ZodArray<z.ZodPipe<z.ZodString, z.ZodTransform<EthereumAddress, string>>>;
+    }, z.core.$strict>>;
+}, z.core.$strip>], "channel">], "method">;
+export type WebsocketControlMessage = z.output<typeof WebsocketControlMessage>;
+export type WebsocketControlMessageInput = z.input<typeof WebsocketControlMessage>;
+export type WebsocketAuthMessage = Extract<WebsocketControlMessage, {
+    method: 'auth';
+}>;
+export type WebsocketPingMessage = Extract<WebsocketControlMessage, {
+    method: 'ping';
+}>;
+export type WebsocketSubscribeMessage = Extract<WebsocketControlMessage, {
+    method: 'subscribe';
+}>;
+export type WebsocketUnsubscribeMessage = Extract<WebsocketControlMessage, {
+    method: 'unsubscribe';
+}>;

package/dist/realtime/messages.js

@@ -0,0 +1,118 @@
+import { z } from 'zod';
+import { EthereumAddress } from '../common/address';
+import { Connector } from '../connector';
+import { WebsocketPublicChannel } from './channels';
+import { UserEventTopic } from './user-events';
+
+const MAX_VAULTS_PER_CONNECTION = 20;
+const WebsocketRequestId = z.union([
+  z.string(),
+  z.number()
+]).transform(String).optional();
+const WebsocketPublicParams = z.object({
+  connectors: z.array(Connector).optional(),
+  instrumentIds: z.array(z.string()).optional()
+}).strict();
+const WebsocketUserEventsParams = z.object({
+  topics: z.array(UserEventTopic).optional()
+}).strict();
+const WebsocketTriggerEventsParams = z.object({
+  connectors: z.array(Connector).optional(),
+  accountIds: z.array(z.string()).optional()
+}).strict();
+const WebsocketVaultEventsParams = z.object({
+  vaults: z.array(EthereumAddress).min(1)
+}).strict();
+const PingMessage = z.object({
+  id: WebsocketRequestId,
+  method: z.literal("ping")
+});
+const AuthMessage = z.object({
+  id: WebsocketRequestId,
+  method: z.literal("auth"),
+  params: z.object({
+    accessToken: z.string().min(1)
+  }).strict()
+});
+const SubscribePublicMessage = z.object({
+  id: WebsocketRequestId,
+  method: z.literal("subscribe"),
+  channel: WebsocketPublicChannel,
+  params: WebsocketPublicParams.optional()
+});
+const SubscribeUserEventsMessage = z.object({
+  id: WebsocketRequestId,
+  method: z.literal("subscribe"),
+  channel: z.literal("user_events"),
+  params: WebsocketUserEventsParams.optional()
+});
+const SubscribeTriggerEventsMessage = z.object({
+  id: WebsocketRequestId,
+  method: z.literal("subscribe"),
+  channel: z.literal("trigger_events"),
+  params: WebsocketTriggerEventsParams.optional()
+});
+const SubscribeVaultEventsMessage = z.object({
+  id: WebsocketRequestId,
+  method: z.literal("subscribe"),
+  channel: z.literal("vault_events"),
+  params: WebsocketVaultEventsParams
+});
+const SubscribeVaultManagementMessage = z.object({
+  id: WebsocketRequestId,
+  method: z.literal("subscribe"),
+  channel: z.literal("vault_management"),
+  params: WebsocketVaultEventsParams
+});
+const UnsubscribePublicMessage = z.object({
+  id: WebsocketRequestId,
+  method: z.literal("unsubscribe"),
+  channel: WebsocketPublicChannel,
+  params: WebsocketPublicParams.optional()
+});
+const UnsubscribeUserEventsMessage = z.object({
+  id: WebsocketRequestId,
+  method: z.literal("unsubscribe"),
+  channel: z.literal("user_events"),
+  params: WebsocketUserEventsParams.optional()
+});
+const UnsubscribeTriggerEventsMessage = z.object({
+  id: WebsocketRequestId,
+  method: z.literal("unsubscribe"),
+  channel: z.literal("trigger_events"),
+  params: WebsocketTriggerEventsParams.optional()
+});
+const UnsubscribeVaultEventsMessage = z.object({
+  id: WebsocketRequestId,
+  method: z.literal("unsubscribe"),
+  channel: z.literal("vault_events"),
+  params: WebsocketVaultEventsParams.optional()
+});
+const UnsubscribeVaultManagementMessage = z.object({
+  id: WebsocketRequestId,
+  method: z.literal("unsubscribe"),
+  channel: z.literal("vault_management"),
+  params: WebsocketVaultEventsParams.optional()
+});
+const SubscribeMessage = z.discriminatedUnion("channel", [
+  SubscribePublicMessage,
+  SubscribeUserEventsMessage,
+  SubscribeTriggerEventsMessage,
+  SubscribeVaultEventsMessage,
+  SubscribeVaultManagementMessage
+]);
+const UnsubscribeMessage = z.discriminatedUnion("channel", [
+  UnsubscribePublicMessage,
+  UnsubscribeUserEventsMessage,
+  UnsubscribeTriggerEventsMessage,
+  UnsubscribeVaultEventsMessage,
+  UnsubscribeVaultManagementMessage
+]);
+const WebsocketControlMessage = z.discriminatedUnion("method", [
+  AuthMessage,
+  PingMessage,
+  SubscribeMessage,
+  UnsubscribeMessage
+]);
+
+export { MAX_VAULTS_PER_CONNECTION, WebsocketControlMessage, WebsocketPublicParams, WebsocketRequestId, WebsocketTriggerEventsParams, WebsocketUserEventsParams, WebsocketVaultEventsParams };