@pear-protocol/types 2.17.0 → 2.19.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (43) hide show
  1. package/dist/bundle.d.ts +1 -0
  2. package/dist/bundle.js +1 -0
  3. package/dist/common/refinement.d.ts +0 -1
  4. package/dist/common/refinement.js +1 -9
  5. package/dist/instrument/entities.d.ts +1 -0
  6. package/dist/instrument/responses.d.ts +1 -0
  7. package/dist/instrument-precision/index.d.ts +1 -0
  8. package/dist/instrument-precision/index.js +6 -1
  9. package/dist/realtime/channels.d.ts +19 -0
  10. package/dist/realtime/channels.js +16 -0
  11. package/dist/realtime/frames.d.ts +923 -0
  12. package/dist/realtime/frames.js +140 -0
  13. package/dist/realtime/index.d.ts +6 -0
  14. package/dist/realtime/index.js +6 -0
  15. package/dist/realtime/messages.d.ts +243 -0
  16. package/dist/realtime/messages.js +118 -0
  17. package/dist/realtime/public-events.d.ts +342 -0
  18. package/dist/realtime/public-events.js +92 -0
  19. package/dist/realtime/user-events.d.ts +32 -0
  20. package/dist/realtime/user-events.js +32 -0
  21. package/dist/realtime/vault-events.d.ts +71 -0
  22. package/dist/realtime/vault-events.js +42 -0
  23. package/dist/schedule/entities.d.ts +53 -163
  24. package/dist/schedule/entities.js +62 -3
  25. package/dist/schedule/queries.d.ts +7 -0
  26. package/dist/schedule/queries.js +15 -1
  27. package/dist/schedule/responses.d.ts +150 -115
  28. package/dist/schedule/responses.js +6 -2
  29. package/dist/statistics/entities.d.ts +0 -1
  30. package/dist/statistics/entities.js +0 -2
  31. package/dist/statistics/responses.d.ts +0 -1
  32. package/dist/sync/payloads.d.ts +0 -162
  33. package/dist/sync/payloads.js +1 -35
  34. package/dist/trade-accounts/entities.d.ts +0 -16
  35. package/dist/trade-accounts/entities.js +0 -2
  36. package/dist/trade-accounts/payloads.d.ts +0 -12
  37. package/dist/trade-accounts/payloads.js +1 -7
  38. package/dist/trade-accounts/response.d.ts +0 -120
  39. package/dist/traders/public.d.ts +0 -1
  40. package/dist/traders/public.js +0 -1
  41. package/dist/vaults/responses.d.ts +1 -0
  42. package/dist/vaults/responses.js +2 -1
  43. package/package.json +1 -1
@@ -1,10 +1,14 @@
1
1
  import { z } from 'zod';
2
2
  import { CursorResponse } from '../common';
3
- import { Schedule } from './entities';
3
+ import { Schedule, ScheduleSlice } from './entities';
4
4
 
5
5
  const ScheduleListResponse = CursorResponse.extend({
6
6
  schedules: z.array(Schedule)
7
7
  });
8
+ const ScheduleDetailResponse = CursorResponse.extend({
9
+ schedule: Schedule,
10
+ slices: z.array(ScheduleSlice)
11
+ });
8
12
  const CreateScheduleResponse = z.object({
9
13
  schedule: Schedule
10
14
  });
@@ -15,4 +19,4 @@ const CancelAllSchedulesResponse = z.object({
15
19
  ids: z.array(z.uuid())
16
20
  });
17
21
 
18
- export { CancelAllSchedulesResponse, CancelScheduleResponse, CreateScheduleResponse, ScheduleListResponse };
22
+ export { CancelAllSchedulesResponse, CancelScheduleResponse, CreateScheduleResponse, ScheduleDetailResponse, ScheduleListResponse };
@@ -10,7 +10,6 @@ export declare const LeaderboardRow: z.ZodObject<{
10
10
  lighter: "lighter";
11
11
  lighter_rhc: "lighter_rhc";
12
12
  }>;
13
- copyingEnabled: z.ZodBoolean;
14
13
  followers: z.ZodArray<z.ZodObject<{
15
14
  tradeAccountId: z.ZodUUID;
16
15
  status: z.ZodLiteral<"ACTIVE">;
@@ -14,8 +14,6 @@ const LeaderboardRow = z.object({
14
14
  // tradeAccountId and omit the exchange identifier, including when the owner shows X identity.
15
15
  userId: z.string(),
16
16
  connector: Connector,
17
- // Current owner consent; venue support and admission availability also apply.
18
- copyingEnabled: z.boolean().describe("Whether the owner allows new copy subscriptions; venue support and admission availability also apply"),
19
17
  // Followers when this board was cached, independent of the performance date range.
20
18
  followers: z.array(CopyFollower),
21
19
  followerCount: z.number().int().nonnegative(),
@@ -11,7 +11,6 @@ export declare const LeaderboardResponse: z.ZodObject<{
11
11
  lighter: "lighter";
12
12
  lighter_rhc: "lighter_rhc";
13
13
  }>;
14
- copyingEnabled: z.ZodBoolean;
15
14
  followers: z.ZodArray<z.ZodObject<{
16
15
  tradeAccountId: z.ZodUUID;
17
16
  status: z.ZodLiteral<"ACTIVE">;
@@ -25,177 +25,15 @@ export declare const UnknownExternalFill: z.ZodObject<{
25
25
  mark: z.ZodString;
26
26
  }, z.core.$strip>>;
27
27
  }, z.core.$strip>;
28
- export declare const ConfirmableExternalFill: z.ZodObject<{
29
- type: z.ZodLiteral<"confirm">;
30
- exchangeFillId: z.ZodString;
31
- cloid: z.ZodString;
32
- positionId: z.ZodUUID;
33
- connector: z.ZodEnum<{
34
- hyperliquid: "hyperliquid";
35
- binance: "binance";
36
- bybit: "bybit";
37
- okx: "okx";
38
- lighter: "lighter";
39
- lighter_rhc: "lighter_rhc";
40
- }>;
41
- symbol: z.ZodString;
42
- quantity: z.ZodString;
43
- timestamp: z.ZodNumber;
44
- tradeFee: z.ZodString;
45
- builderFee: z.ZodString;
46
- }, z.core.$strip>;
47
- export declare const ReconcileReplacementExternalFill: z.ZodObject<{
48
- exchangeFillId: z.ZodString;
49
- cloid: z.ZodString;
50
- connector: z.ZodEnum<{
51
- hyperliquid: "hyperliquid";
52
- binance: "binance";
53
- bybit: "bybit";
54
- okx: "okx";
55
- lighter: "lighter";
56
- lighter_rhc: "lighter_rhc";
57
- }>;
58
- symbol: z.ZodString;
59
- price: z.ZodString;
60
- quantity: z.ZodString;
61
- side: z.ZodEnum<{
62
- BUY: "BUY";
63
- SELL: "SELL";
64
- }>;
65
- reduceOnly: z.ZodBoolean;
66
- timestamp: z.ZodNumber;
67
- tradeFee: z.ZodString;
68
- builderFee: z.ZodString;
69
- liquidation: z.ZodNullable<z.ZodObject<{
70
- mark: z.ZodString;
71
- }, z.core.$strip>>;
72
- }, z.core.$strip>;
73
- export declare const ConfirmFillsRequest: z.ZodRecord<z.ZodUUID, z.ZodTuple<[z.ZodObject<{
74
- type: z.ZodLiteral<"confirm">;
75
- exchangeFillId: z.ZodString;
76
- cloid: z.ZodString;
77
- positionId: z.ZodUUID;
78
- connector: z.ZodEnum<{
79
- hyperliquid: "hyperliquid";
80
- binance: "binance";
81
- bybit: "bybit";
82
- okx: "okx";
83
- lighter: "lighter";
84
- lighter_rhc: "lighter_rhc";
85
- }>;
86
- symbol: z.ZodString;
87
- quantity: z.ZodString;
88
- timestamp: z.ZodNumber;
89
- tradeFee: z.ZodString;
90
- builderFee: z.ZodString;
91
- }, z.core.$strip>], z.ZodObject<{
92
- type: z.ZodLiteral<"confirm">;
93
- exchangeFillId: z.ZodString;
94
- cloid: z.ZodString;
95
- positionId: z.ZodUUID;
96
- connector: z.ZodEnum<{
97
- hyperliquid: "hyperliquid";
98
- binance: "binance";
99
- bybit: "bybit";
100
- okx: "okx";
101
- lighter: "lighter";
102
- lighter_rhc: "lighter_rhc";
103
- }>;
104
- symbol: z.ZodString;
105
- quantity: z.ZodString;
106
- timestamp: z.ZodNumber;
107
- tradeFee: z.ZodString;
108
- builderFee: z.ZodString;
109
- }, z.core.$strip>>>;
110
- export declare const ReconcileFillsRequest: z.ZodRecord<z.ZodString, z.ZodTuple<[z.ZodObject<{
111
- exchangeFillId: z.ZodString;
112
- cloid: z.ZodString;
113
- connector: z.ZodEnum<{
114
- hyperliquid: "hyperliquid";
115
- binance: "binance";
116
- bybit: "bybit";
117
- okx: "okx";
118
- lighter: "lighter";
119
- lighter_rhc: "lighter_rhc";
120
- }>;
121
- symbol: z.ZodString;
122
- price: z.ZodString;
123
- quantity: z.ZodString;
124
- side: z.ZodEnum<{
125
- BUY: "BUY";
126
- SELL: "SELL";
127
- }>;
128
- reduceOnly: z.ZodBoolean;
129
- timestamp: z.ZodNumber;
130
- tradeFee: z.ZodString;
131
- builderFee: z.ZodString;
132
- liquidation: z.ZodNullable<z.ZodObject<{
133
- mark: z.ZodString;
134
- }, z.core.$strip>>;
135
- }, z.core.$strip>, z.ZodObject<{
136
- exchangeFillId: z.ZodString;
137
- cloid: z.ZodString;
138
- connector: z.ZodEnum<{
139
- hyperliquid: "hyperliquid";
140
- binance: "binance";
141
- bybit: "bybit";
142
- okx: "okx";
143
- lighter: "lighter";
144
- lighter_rhc: "lighter_rhc";
145
- }>;
146
- symbol: z.ZodString;
147
- price: z.ZodString;
148
- quantity: z.ZodString;
149
- side: z.ZodEnum<{
150
- BUY: "BUY";
151
- SELL: "SELL";
152
- }>;
153
- reduceOnly: z.ZodBoolean;
154
- timestamp: z.ZodNumber;
155
- tradeFee: z.ZodString;
156
- builderFee: z.ZodString;
157
- liquidation: z.ZodNullable<z.ZodObject<{
158
- mark: z.ZodString;
159
- }, z.core.$strip>>;
160
- }, z.core.$strip>], z.ZodObject<{
161
- exchangeFillId: z.ZodString;
162
- cloid: z.ZodString;
163
- connector: z.ZodEnum<{
164
- hyperliquid: "hyperliquid";
165
- binance: "binance";
166
- bybit: "bybit";
167
- okx: "okx";
168
- lighter: "lighter";
169
- lighter_rhc: "lighter_rhc";
170
- }>;
171
- symbol: z.ZodString;
172
- price: z.ZodString;
173
- quantity: z.ZodString;
174
- side: z.ZodEnum<{
175
- BUY: "BUY";
176
- SELL: "SELL";
177
- }>;
178
- reduceOnly: z.ZodBoolean;
179
- timestamp: z.ZodNumber;
180
- tradeFee: z.ZodString;
181
- builderFee: z.ZodString;
182
- liquidation: z.ZodNullable<z.ZodObject<{
183
- mark: z.ZodString;
184
- }, z.core.$strip>>;
185
- }, z.core.$strip>>>;
186
28
  export declare const SyncFillsSinceRequest: z.ZodObject<{
187
29
  overlapMs: z.ZodNumber;
188
30
  }, z.core.$strip>;
189
31
  export declare const SyncFundingSinceRequest: z.ZodObject<{
190
32
  overlapMs: z.ZodNumber;
191
33
  }, z.core.$strip>;
192
- export type ConfirmFillsRequest = z.output<typeof ConfirmFillsRequest>;
193
- export type ReconcileFillsRequest = z.output<typeof ReconcileFillsRequest>;
194
34
  export type SyncFillsSinceRequest = z.output<typeof SyncFillsSinceRequest>;
195
35
  export type SyncFundingSinceRequest = z.output<typeof SyncFundingSinceRequest>;
196
36
  export type UnknownExternalFill = z.output<typeof UnknownExternalFill>;
197
- export type ReconcileReplacementExternalFill = z.output<typeof ReconcileReplacementExternalFill>;
198
- export type ConfirmableExternalFill = z.output<typeof ConfirmableExternalFill>;
199
37
  /**
200
38
  * An exchange-reported open position snapshot. The exchange position API is the
201
39
  * source of truth for current exposure; sizes are normalized to BASE units
@@ -1,5 +1,4 @@
1
1
  import { z } from 'zod';
2
- import { RefineMinimumOneKeyValuePair } from '../common/refinement';
3
2
  import { UnsignedDecimalString, DecimalString, Side, SignedDecimalString } from '../common/schema';
4
3
  import { Connector } from '../connector';
5
4
  import { InstrumentId } from '../instrument';
@@ -31,39 +30,6 @@ const UnknownExternalFill = z.object({
31
30
  builderFee: UnsignedDecimalString,
32
31
  liquidation: LiquidationMark
33
32
  });
34
- const ConfirmableExternalFill = z.object({
35
- type: z.literal("confirm"),
36
- exchangeFillId: ExchangeFillId,
37
- cloid: z.string(),
38
- positionId: z.uuid().describe("Position ID"),
39
- connector: Connector,
40
- symbol: InstrumentId,
41
- quantity: UnsignedDecimalString,
42
- timestamp: MsTimestamp,
43
- tradeFee: TradeFee,
44
- builderFee: UnsignedDecimalString
45
- });
46
- const ReconcileReplacementExternalFill = z.object({
47
- exchangeFillId: ExchangeFillId,
48
- cloid: z.string(),
49
- connector: Connector,
50
- symbol: InstrumentId,
51
- price: UnsignedDecimalString,
52
- quantity: UnsignedDecimalString,
53
- side: Side,
54
- reduceOnly: z.boolean(),
55
- timestamp: MsTimestamp,
56
- tradeFee: TradeFee,
57
- builderFee: UnsignedDecimalString,
58
- liquidation: LiquidationMark
59
- });
60
- const ConfirmFillsRequest = z.record(z.uuid().describe("Position ID"), z.tuple([
61
- ConfirmableExternalFill
62
- ]).rest(ConfirmableExternalFill)).superRefine(RefineMinimumOneKeyValuePair);
63
- const ReconcileFillsRequest = z.record(z.string().trim().min(1, "CLOID must be non-empty"), z.tuple([
64
- ReconcileReplacementExternalFill,
65
- ReconcileReplacementExternalFill
66
- ]).rest(ReconcileReplacementExternalFill)).superRefine(RefineMinimumOneKeyValuePair);
67
33
  const SyncFillsSinceRequest = z.object({
68
34
  overlapMs: z.number().int().positive()
69
35
  });
@@ -167,4 +133,4 @@ function refineNewestFillTsPairsWithWatermark(meta, ctx) {
167
133
  }
168
134
  __name(refineNewestFillTsPairsWithWatermark, "refineNewestFillTsPairsWithWatermark");
169
135
 
170
- export { ApplicableFill, ApplicableMetadata, ApplicablePosition, ConfirmFillsRequest, ConfirmableExternalFill, CreateApplicablesBulkFields, CreateApplicablesMeta, CreateApplicablesRequest, CreateFundingPaymentsRequest, ExternalPosition, FundingPaymentEntry, ReconcileFillsRequest, ReconcileReplacementExternalFill, SyncFillsSinceRequest, SyncFundingSinceRequest, SyncMeta, UnknownExternalFill, WATERMARK_FUTURE_SKEW_MS };
136
+ export { ApplicableFill, ApplicableMetadata, ApplicablePosition, CreateApplicablesBulkFields, CreateApplicablesMeta, CreateApplicablesRequest, CreateFundingPaymentsRequest, ExternalPosition, FundingPaymentEntry, SyncFillsSinceRequest, SyncFundingSinceRequest, SyncMeta, UnknownExternalFill, WATERMARK_FUTURE_SKEW_MS };
@@ -25,8 +25,6 @@ declare const HyperliquidTradeAccount: z.ZodObject<{
25
25
  eoa: "eoa";
26
26
  }>;
27
27
  exchangeIdentifier: z.ZodString;
28
- sharingEnabled: z.ZodBoolean;
29
- copyingEnabled: z.ZodBoolean;
30
28
  createdAt: z.ZodString;
31
29
  updatedAt: z.ZodString;
32
30
  deletedAt: z.ZodOptional<z.ZodString>;
@@ -44,8 +42,6 @@ declare const LighterTradeAccount: z.ZodObject<{
44
42
  eoa: "eoa";
45
43
  }>;
46
44
  exchangeIdentifier: z.ZodString;
47
- sharingEnabled: z.ZodBoolean;
48
- copyingEnabled: z.ZodBoolean;
49
45
  createdAt: z.ZodString;
50
46
  updatedAt: z.ZodString;
51
47
  deletedAt: z.ZodOptional<z.ZodString>;
@@ -72,8 +68,6 @@ export declare const TradeAccount: z.ZodDiscriminatedUnion<[z.ZodObject<{
72
68
  eoa: "eoa";
73
69
  }>;
74
70
  exchangeIdentifier: z.ZodString;
75
- sharingEnabled: z.ZodBoolean;
76
- copyingEnabled: z.ZodBoolean;
77
71
  createdAt: z.ZodString;
78
72
  updatedAt: z.ZodString;
79
73
  deletedAt: z.ZodOptional<z.ZodString>;
@@ -90,8 +84,6 @@ export declare const TradeAccount: z.ZodDiscriminatedUnion<[z.ZodObject<{
90
84
  eoa: "eoa";
91
85
  }>;
92
86
  exchangeIdentifier: z.ZodString;
93
- sharingEnabled: z.ZodBoolean;
94
- copyingEnabled: z.ZodBoolean;
95
87
  createdAt: z.ZodString;
96
88
  updatedAt: z.ZodString;
97
89
  deletedAt: z.ZodOptional<z.ZodString>;
@@ -107,8 +99,6 @@ export declare const TradeAccount: z.ZodDiscriminatedUnion<[z.ZodObject<{
107
99
  eoa: "eoa";
108
100
  }>;
109
101
  exchangeIdentifier: z.ZodString;
110
- sharingEnabled: z.ZodBoolean;
111
- copyingEnabled: z.ZodBoolean;
112
102
  createdAt: z.ZodString;
113
103
  updatedAt: z.ZodString;
114
104
  deletedAt: z.ZodOptional<z.ZodString>;
@@ -123,8 +113,6 @@ export declare const TradeAccount: z.ZodDiscriminatedUnion<[z.ZodObject<{
123
113
  eoa: "eoa";
124
114
  }>;
125
115
  exchangeIdentifier: z.ZodString;
126
- sharingEnabled: z.ZodBoolean;
127
- copyingEnabled: z.ZodBoolean;
128
116
  createdAt: z.ZodString;
129
117
  updatedAt: z.ZodString;
130
118
  deletedAt: z.ZodOptional<z.ZodString>;
@@ -138,8 +126,6 @@ export declare const TradeAccount: z.ZodDiscriminatedUnion<[z.ZodObject<{
138
126
  eoa: "eoa";
139
127
  }>;
140
128
  exchangeIdentifier: z.ZodString;
141
- sharingEnabled: z.ZodBoolean;
142
- copyingEnabled: z.ZodBoolean;
143
129
  createdAt: z.ZodString;
144
130
  updatedAt: z.ZodString;
145
131
  deletedAt: z.ZodOptional<z.ZodString>;
@@ -153,8 +139,6 @@ export declare const TradeAccount: z.ZodDiscriminatedUnion<[z.ZodObject<{
153
139
  eoa: "eoa";
154
140
  }>;
155
141
  exchangeIdentifier: z.ZodString;
156
- sharingEnabled: z.ZodBoolean;
157
- copyingEnabled: z.ZodBoolean;
158
142
  createdAt: z.ZodString;
159
143
  updatedAt: z.ZodString;
160
144
  deletedAt: z.ZodOptional<z.ZodString>;
@@ -17,8 +17,6 @@ const commonFields = {
17
17
  "vault"
18
18
  ]).describe("Whether the account trades an EOA or a Pear vault"),
19
19
  exchangeIdentifier: z.string().describe("User identifier on the exchange"),
20
- sharingEnabled: z.boolean().describe("Whether the owner allows public viewing"),
21
- copyingEnabled: z.boolean().describe("Whether the owner allows copying while public sharing is enabled"),
22
20
  createdAt: z.string().describe("Creation timestamp (ISO 8601)"),
23
21
  updatedAt: z.string().describe("Last update timestamp (ISO 8601)"),
24
22
  deletedAt: z.string().describe("Deletion timestamp (ISO 8601)").optional()
@@ -197,10 +197,6 @@ export declare const UpdateTradeAccount: z.ZodDiscriminatedUnion<[z.ZodObject<{
197
197
  }, z.core.$strip>>;
198
198
  connector: z.ZodLiteral<"lighter_rhc">;
199
199
  }, z.core.$strip>], "connector">;
200
- /** Payload to set public viewing consent independently of account settings. */
201
- export declare const UpdateTradeAccountSharing: z.ZodObject<{
202
- sharingEnabled: z.ZodBoolean;
203
- }, z.core.$strip>;
204
200
  export type CreateHyperliquidCredentials = z.infer<typeof CreateHyperliquidCredentials>;
205
201
  export type CreateHyperliquidMetadata = z.infer<typeof CreateHyperliquidMetadata>;
206
202
  export type CreateBinanceCredentials = z.infer<typeof CreateBinanceCredentials>;
@@ -214,12 +210,4 @@ export type CreateVaultTradeAccountInput = z.input<typeof CreateVaultTradeAccoun
214
210
  export type CreateVaultTradeAccount = z.output<typeof CreateVaultTradeAccount>;
215
211
  export type UpdateTradeAccountInput = z.input<typeof UpdateTradeAccount>;
216
212
  export type UpdateTradeAccount = z.output<typeof UpdateTradeAccount>;
217
- export type UpdateTradeAccountSharingInput = z.input<typeof UpdateTradeAccountSharing>;
218
- export type UpdateTradeAccountSharing = z.output<typeof UpdateTradeAccountSharing>;
219
- /** Payload to set copying consent independently of public visibility. */
220
- export declare const UpdateTradeAccountCopying: z.ZodObject<{
221
- copyingEnabled: z.ZodBoolean;
222
- }, z.core.$strip>;
223
- export type UpdateTradeAccountCopyingInput = z.input<typeof UpdateTradeAccountCopying>;
224
- export type UpdateTradeAccountCopying = z.output<typeof UpdateTradeAccountCopying>;
225
213
  export {};
@@ -128,11 +128,5 @@ const UpdateTradeAccount = z.discriminatedUnion("connector", [
128
128
  UpdateLighterAccount,
129
129
  UpdateLighterRhcAccount
130
130
  ]);
131
- const UpdateTradeAccountSharing = z.object({
132
- sharingEnabled: z.boolean()
133
- });
134
- const UpdateTradeAccountCopying = z.object({
135
- copyingEnabled: z.boolean()
136
- });
137
131
 
138
- export { CreateTradeAccount, CreateVaultTradeAccount, UpdateTradeAccount, UpdateTradeAccountCopying, UpdateTradeAccountSharing };
132
+ export { CreateTradeAccount, CreateVaultTradeAccount, UpdateTradeAccount };