@pear-protocol/types 0.0.1 → 0.0.2

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.
@@ -3,28 +3,9 @@ import { z } from 'zod';
3
3
  * Hyperliquid connector metadata
4
4
  */
5
5
  declare const HyperliquidMetadata: z.ZodObject<{
6
- address: z.ZodString;
6
+ agentWalletAddress: z.ZodString;
7
7
  isSubaccount: z.ZodBoolean;
8
8
  }, z.core.$strip>;
9
- /**
10
- * Binance USDM connector metadata (empty for now)
11
- */
12
- declare const BinanceUSDMMetadata: z.ZodOptional<z.ZodObject<{}, z.core.$strip>>;
13
- /**
14
- * Bybit connector metadata (empty for now)
15
- */
16
- declare const BybitMetadata: z.ZodOptional<z.ZodObject<{}, z.core.$strip>>;
17
- /**
18
- * OKX connector metadata (empty for now)
19
- */
20
- declare const OkxMetadata: z.ZodOptional<z.ZodObject<{}, z.core.$strip>>;
21
- /**
22
- * Union of all connector metadata schemas
23
- */
24
- declare const ConnectorMetadata: z.ZodNullable<z.ZodUnion<readonly [z.ZodObject<{
25
- address: z.ZodString;
26
- isSubaccount: z.ZodBoolean;
27
- }, z.core.$strip>, z.ZodOptional<z.ZodObject<{}, z.core.$strip>>, z.ZodOptional<z.ZodObject<{}, z.core.$strip>>, z.ZodOptional<z.ZodObject<{}, z.core.$strip>>]>>;
28
9
  export declare const TradeAccount: z.ZodObject<{
29
10
  id: z.ZodUUID;
30
11
  alias: z.ZodString;
@@ -34,17 +15,14 @@ export declare const TradeAccount: z.ZodObject<{
34
15
  bybit: "bybit";
35
16
  okx: "okx";
36
17
  }>;
37
- metadata: z.ZodNullable<z.ZodUnion<readonly [z.ZodObject<{
38
- address: z.ZodString;
18
+ exchangeIdentifier: z.ZodString;
19
+ metadata: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
20
+ agentWalletAddress: z.ZodString;
39
21
  isSubaccount: z.ZodBoolean;
40
- }, z.core.$strip>, z.ZodOptional<z.ZodObject<{}, z.core.$strip>>, z.ZodOptional<z.ZodObject<{}, z.core.$strip>>, z.ZodOptional<z.ZodObject<{}, z.core.$strip>>]>>;
22
+ }, z.core.$strip>]>>;
41
23
  createdAt: z.ZodString;
42
24
  updatedAt: z.ZodString;
43
25
  }, z.core.$strip>;
44
26
  export type TradeAccount = z.infer<typeof TradeAccount>;
45
27
  export type HyperliquidMetadata = z.infer<typeof HyperliquidMetadata>;
46
- export type BinanceUSDMMetadata = z.infer<typeof BinanceUSDMMetadata>;
47
- export type BybitMetadata = z.infer<typeof BybitMetadata>;
48
- export type OkxMetadata = z.infer<typeof OkxMetadata>;
49
- export type ConnectorMetadata = z.infer<typeof ConnectorMetadata>;
50
28
  export {};
@@ -1,15 +1,16 @@
1
1
  import { z } from 'zod';
2
2
  import { Connector } from '../connector';
3
3
 
4
- const HyperliquidMetadata = z.object({ address: z.string(), isSubaccount: z.boolean() });
5
- const BinanceUSDMMetadata = z.object({}).optional();
6
- const BybitMetadata = z.object({}).optional();
7
- const OkxMetadata = z.object({}).optional();
8
- const ConnectorMetadata = z.union([HyperliquidMetadata, BinanceUSDMMetadata, BybitMetadata, OkxMetadata]).nullable();
4
+ const HyperliquidMetadata = z.object({
5
+ agentWalletAddress: z.string(),
6
+ isSubaccount: z.boolean()
7
+ });
8
+ const ConnectorMetadata = z.union([HyperliquidMetadata]).optional();
9
9
  const TradeAccount = z.object({
10
10
  id: z.uuid().describe("Trade account UUID"),
11
11
  alias: z.string().describe("User-defined trade account alias"),
12
12
  connector: Connector.describe("Exchange connector type"),
13
+ exchangeIdentifier: z.string().describe("User identifier on the exchange"),
13
14
  metadata: ConnectorMetadata.describe("Connector-specific metadata"),
14
15
  createdAt: z.string().describe("Creation timestamp (ISO 8601)"),
15
16
  updatedAt: z.string().describe("Last update timestamp (ISO 8601)")
@@ -1,3 +1,4 @@
1
1
  export * from './entities';
2
2
  export * from './payloads';
3
+ export * from './queries';
3
4
  export * from './response';
@@ -1,3 +1,4 @@
1
1
  export * from './entities';
2
2
  export * from './payloads';
3
+ export * from './queries';
3
4
  export * from './response';
@@ -9,7 +9,7 @@ declare const CreateHyperliquidCredentials: z.ZodObject<{
9
9
  * Hyperliquid connector metadata
10
10
  */
11
11
  declare const CreateHyperliquidMetadata: z.ZodObject<{
12
- address: z.ZodString;
12
+ agentWalletAddress: z.ZodString;
13
13
  isSubaccount: z.ZodBoolean;
14
14
  }, z.core.$strip>;
15
15
  /**
@@ -19,10 +19,6 @@ declare const CreateBinanceUSDMCredentials: z.ZodObject<{
19
19
  api_key: z.ZodString;
20
20
  api_secret: z.ZodString;
21
21
  }, z.core.$strip>;
22
- /**
23
- * Binance USDM connector metadata (empty for now)
24
- */
25
- declare const CreateBinanceUSDMMetadata: z.ZodOptional<z.ZodObject<{}, z.core.$strip>>;
26
22
  /**
27
23
  * Bybit connector credentials
28
24
  */
@@ -30,10 +26,6 @@ declare const CreateBybitCredentials: z.ZodObject<{
30
26
  api_key: z.ZodString;
31
27
  api_secret: z.ZodString;
32
28
  }, z.core.$strip>;
33
- /**
34
- * Bybit connector metadata (empty for now)
35
- */
36
- declare const CreateBybitMetadata: z.ZodOptional<z.ZodObject<{}, z.core.$strip>>;
37
29
  /**
38
30
  * OKX connector credentials
39
31
  */
@@ -42,21 +34,18 @@ declare const CreateOkxCredentials: z.ZodObject<{
42
34
  api_secret: z.ZodString;
43
35
  api_pass: z.ZodString;
44
36
  }, z.core.$strip>;
45
- /**
46
- * OKX connector metadata (empty for now)
47
- */
48
- declare const CreateOkxMetadata: z.ZodOptional<z.ZodObject<{}, z.core.$strip>>;
49
37
  /**
50
38
  * Payload to create a new trade account
51
39
  */
52
40
  export declare const CreateTradeAccount: z.ZodDiscriminatedUnion<[z.ZodObject<{
53
41
  connector: z.ZodLiteral<"hyperliquid">;
54
42
  alias: z.ZodString;
43
+ exchangeIdentifier: z.ZodString;
55
44
  credentials: z.ZodObject<{
56
45
  signer_key: z.ZodString;
57
46
  }, z.core.$strip>;
58
47
  metadata: z.ZodObject<{
59
- address: z.ZodString;
48
+ agentWalletAddress: z.ZodString;
60
49
  isSubaccount: z.ZodBoolean;
61
50
  }, z.core.$strip>;
62
51
  }, z.core.$strip>, z.ZodObject<{
@@ -66,7 +55,7 @@ export declare const CreateTradeAccount: z.ZodDiscriminatedUnion<[z.ZodObject<{
66
55
  api_key: z.ZodString;
67
56
  api_secret: z.ZodString;
68
57
  }, z.core.$strip>;
69
- metadata: z.ZodOptional<z.ZodObject<{}, z.core.$strip>>;
58
+ metadata: z.ZodPipe<z.ZodVoid, z.ZodTransform<undefined, void>>;
70
59
  }, z.core.$strip>, z.ZodObject<{
71
60
  connector: z.ZodLiteral<"bybit">;
72
61
  alias: z.ZodString;
@@ -74,7 +63,7 @@ export declare const CreateTradeAccount: z.ZodDiscriminatedUnion<[z.ZodObject<{
74
63
  api_key: z.ZodString;
75
64
  api_secret: z.ZodString;
76
65
  }, z.core.$strip>;
77
- metadata: z.ZodOptional<z.ZodObject<{}, z.core.$strip>>;
66
+ metadata: z.ZodPipe<z.ZodVoid, z.ZodTransform<undefined, void>>;
78
67
  }, z.core.$strip>, z.ZodObject<{
79
68
  connector: z.ZodLiteral<"okx">;
80
69
  alias: z.ZodString;
@@ -83,10 +72,10 @@ export declare const CreateTradeAccount: z.ZodDiscriminatedUnion<[z.ZodObject<{
83
72
  api_secret: z.ZodString;
84
73
  api_pass: z.ZodString;
85
74
  }, z.core.$strip>;
86
- metadata: z.ZodOptional<z.ZodObject<{}, z.core.$strip>>;
75
+ metadata: z.ZodPipe<z.ZodVoid, z.ZodTransform<undefined, void>>;
87
76
  }, z.core.$strip>], "connector">;
88
77
  /**
89
- * Payload to update a trade account for a specific connector.
78
+ * Payload to update a trade account
90
79
  */
91
80
  export declare const UpdateTradeAccount: z.ZodDiscriminatedUnion<[z.ZodObject<{
92
81
  connector: z.ZodLiteral<"hyperliquid">;
@@ -95,7 +84,7 @@ export declare const UpdateTradeAccount: z.ZodDiscriminatedUnion<[z.ZodObject<{
95
84
  signer_key: z.ZodString;
96
85
  }, z.core.$strip>>;
97
86
  metadata: z.ZodOptional<z.ZodObject<{
98
- address: z.ZodString;
87
+ agentWalletAddress: z.ZodString;
99
88
  isSubaccount: z.ZodBoolean;
100
89
  }, z.core.$strip>>;
101
90
  }, z.core.$strip>, z.ZodObject<{
@@ -105,7 +94,7 @@ export declare const UpdateTradeAccount: z.ZodDiscriminatedUnion<[z.ZodObject<{
105
94
  api_key: z.ZodString;
106
95
  api_secret: z.ZodString;
107
96
  }, z.core.$strip>>;
108
- metadata: z.ZodOptional<z.ZodOptional<z.ZodObject<{}, z.core.$strip>>>;
97
+ metadata: z.ZodPipe<z.ZodVoid, z.ZodTransform<undefined, void>>;
109
98
  }, z.core.$strip>, z.ZodObject<{
110
99
  connector: z.ZodLiteral<"bybit">;
111
100
  alias: z.ZodOptional<z.ZodString>;
@@ -113,7 +102,7 @@ export declare const UpdateTradeAccount: z.ZodDiscriminatedUnion<[z.ZodObject<{
113
102
  api_key: z.ZodString;
114
103
  api_secret: z.ZodString;
115
104
  }, z.core.$strip>>;
116
- metadata: z.ZodOptional<z.ZodOptional<z.ZodObject<{}, z.core.$strip>>>;
105
+ metadata: z.ZodPipe<z.ZodVoid, z.ZodTransform<undefined, void>>;
117
106
  }, z.core.$strip>, z.ZodObject<{
118
107
  connector: z.ZodLiteral<"okx">;
119
108
  alias: z.ZodOptional<z.ZodString>;
@@ -122,16 +111,15 @@ export declare const UpdateTradeAccount: z.ZodDiscriminatedUnion<[z.ZodObject<{
122
111
  api_secret: z.ZodString;
123
112
  api_pass: z.ZodString;
124
113
  }, z.core.$strip>>;
125
- metadata: z.ZodOptional<z.ZodOptional<z.ZodObject<{}, z.core.$strip>>>;
114
+ metadata: z.ZodPipe<z.ZodVoid, z.ZodTransform<undefined, void>>;
126
115
  }, z.core.$strip>], "connector">;
127
116
  export type CreateHyperliquidCredentials = z.infer<typeof CreateHyperliquidCredentials>;
128
117
  export type CreateHyperliquidMetadata = z.infer<typeof CreateHyperliquidMetadata>;
129
- export type CreateBinanceUSDMMetadata = z.infer<typeof CreateBinanceUSDMMetadata>;
130
118
  export type CreateBinanceUSDMCredentials = z.infer<typeof CreateBinanceUSDMCredentials>;
131
119
  export type CreateBybitCredentials = z.infer<typeof CreateBybitCredentials>;
132
- export type CreateBybitMetadata = z.infer<typeof CreateBybitMetadata>;
133
120
  export type CreateOkxCredentials = z.infer<typeof CreateOkxCredentials>;
134
- export type CreateOkxMetadata = z.infer<typeof CreateOkxMetadata>;
135
- export type CreateTradeAccount = z.infer<typeof CreateTradeAccount>;
136
- export type UpdateTradeAccount = z.infer<typeof UpdateTradeAccount>;
121
+ export type CreateTradeAccountInput = z.input<typeof CreateTradeAccount>;
122
+ export type CreateTradeAccount = z.output<typeof CreateTradeAccount>;
123
+ export type UpdateTradeAccountInput = z.input<typeof UpdateTradeAccount>;
124
+ export type UpdateTradeAccount = z.output<typeof UpdateTradeAccount>;
137
125
  export {};
@@ -4,29 +4,27 @@ const CreateHyperliquidCredentials = z.object({
4
4
  signer_key: z.string().min(1, "Signer key is required")
5
5
  });
6
6
  const CreateHyperliquidMetadata = z.object({
7
- address: z.string().regex(/^0x[a-fA-F0-9]{40}$/, "Invalid Ethereum address"),
7
+ agentWalletAddress: z.string().regex(/^0x[a-fA-F0-9]{40}$/, "Invalid Ethereum address"),
8
8
  isSubaccount: z.boolean()
9
9
  });
10
10
  const CreateBinanceUSDMCredentials = z.object({
11
11
  api_key: z.string().min(1, "API key is required"),
12
12
  api_secret: z.string().min(1, "API secret is required")
13
13
  });
14
- const CreateBinanceUSDMMetadata = z.object({}).optional();
15
14
  const CreateBybitCredentials = z.object({
16
15
  api_key: z.string().min(1, "API key is required"),
17
16
  api_secret: z.string().min(1, "API secret is required")
18
17
  });
19
- const CreateBybitMetadata = z.object({}).optional();
20
18
  const CreateOkxCredentials = z.object({
21
19
  api_key: z.string().min(1, "API key is required"),
22
20
  api_secret: z.string().min(1, "API secret is required"),
23
21
  api_pass: z.string().min(1, "API passphrase is required")
24
22
  });
25
- const CreateOkxMetadata = z.object({}).optional();
26
23
  const AccountAlias = z.string().min(1, "Alias is required").max(100, "Alias must be 100 characters or less");
27
24
  const CreateHyperliquidAccount = z.object({
28
25
  connector: z.literal("hyperliquid"),
29
26
  alias: AccountAlias,
27
+ exchangeIdentifier: z.string().regex(/^0x[a-fA-F0-9]{40}$/, "Invalid Ethereum address"),
30
28
  credentials: CreateHyperliquidCredentials,
31
29
  metadata: CreateHyperliquidMetadata
32
30
  });
@@ -34,19 +32,43 @@ const CreateBinanceUSDMAccount = z.object({
34
32
  connector: z.literal("binanceusdm"),
35
33
  alias: AccountAlias,
36
34
  credentials: CreateBinanceUSDMCredentials,
37
- metadata: CreateBinanceUSDMMetadata
35
+ metadata: z.void({}).transform(() => void 0)
38
36
  });
39
37
  const CreateBybitAccount = z.object({
40
38
  connector: z.literal("bybit"),
41
39
  alias: AccountAlias,
42
40
  credentials: CreateBybitCredentials,
43
- metadata: CreateBybitMetadata
41
+ metadata: z.void({}).transform(() => void 0)
44
42
  });
45
43
  const CreateOkxAccount = z.object({
46
44
  connector: z.literal("okx"),
47
45
  alias: AccountAlias,
48
46
  credentials: CreateOkxCredentials,
49
- metadata: CreateOkxMetadata
47
+ metadata: z.void({}).transform(() => void 0)
48
+ });
49
+ const UpdateHyperliquidAccount = z.object({
50
+ connector: z.literal("hyperliquid"),
51
+ alias: AccountAlias.optional(),
52
+ credentials: CreateHyperliquidCredentials.optional(),
53
+ metadata: CreateHyperliquidMetadata.optional()
54
+ });
55
+ const UpdateBinanceUSDMAccount = z.object({
56
+ connector: z.literal("binanceusdm"),
57
+ alias: AccountAlias.optional(),
58
+ credentials: CreateBinanceUSDMCredentials.optional(),
59
+ metadata: z.void({}).transform(() => void 0)
60
+ });
61
+ const UpdateBybitAccount = z.object({
62
+ connector: z.literal("bybit"),
63
+ alias: AccountAlias.optional(),
64
+ credentials: CreateBybitCredentials.optional(),
65
+ metadata: z.void({}).transform(() => void 0)
66
+ });
67
+ const UpdateOkxAccount = z.object({
68
+ connector: z.literal("okx"),
69
+ alias: AccountAlias.optional(),
70
+ credentials: CreateOkxCredentials.optional(),
71
+ metadata: z.void({}).transform(() => void 0)
50
72
  });
51
73
  const CreateTradeAccount = z.discriminatedUnion("connector", [
52
74
  CreateHyperliquidAccount,
@@ -55,30 +77,10 @@ const CreateTradeAccount = z.discriminatedUnion("connector", [
55
77
  CreateOkxAccount
56
78
  ]);
57
79
  const UpdateTradeAccount = z.discriminatedUnion("connector", [
58
- z.object({
59
- connector: z.literal("hyperliquid"),
60
- alias: AccountAlias.optional(),
61
- credentials: CreateHyperliquidCredentials.optional(),
62
- metadata: CreateHyperliquidMetadata.optional()
63
- }),
64
- z.object({
65
- connector: z.literal("binanceusdm"),
66
- alias: AccountAlias.optional(),
67
- credentials: CreateBinanceUSDMCredentials.optional(),
68
- metadata: CreateBinanceUSDMMetadata.optional()
69
- }),
70
- z.object({
71
- connector: z.literal("bybit"),
72
- alias: AccountAlias.optional(),
73
- credentials: CreateBybitCredentials.optional(),
74
- metadata: CreateBybitMetadata.optional()
75
- }),
76
- z.object({
77
- connector: z.literal("okx"),
78
- alias: AccountAlias.optional(),
79
- credentials: CreateOkxCredentials.optional(),
80
- metadata: CreateOkxMetadata.optional()
81
- })
80
+ UpdateHyperliquidAccount,
81
+ UpdateBinanceUSDMAccount,
82
+ UpdateBybitAccount,
83
+ UpdateOkxAccount
82
84
  ]);
83
85
 
84
86
  export { CreateTradeAccount, UpdateTradeAccount };
@@ -0,0 +1,6 @@
1
+ import { z } from 'zod';
2
+ export declare const TradeAccountListParams: z.ZodObject<{
3
+ includeDeleted: z.ZodDefault<z.ZodOptional<z.ZodCoercedBoolean<boolean>>>;
4
+ }, z.core.$strip>;
5
+ export type TradeAccountListParamsInput = z.input<typeof TradeAccountListParams>;
6
+ export type TradeAccountListParams = z.output<typeof TradeAccountListParams>;
@@ -0,0 +1,7 @@
1
+ import { z } from 'zod';
2
+
3
+ const TradeAccountListParams = z.object({
4
+ includeDeleted: z.coerce.boolean().optional().default(false)
5
+ });
6
+
7
+ export { TradeAccountListParams };
@@ -9,10 +9,11 @@ export declare const TradeAccountResponse: z.ZodObject<{
9
9
  bybit: "bybit";
10
10
  okx: "okx";
11
11
  }>;
12
- metadata: z.ZodNullable<z.ZodUnion<readonly [z.ZodObject<{
13
- address: z.ZodString;
12
+ exchangeIdentifier: z.ZodString;
13
+ metadata: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
14
+ agentWalletAddress: z.ZodString;
14
15
  isSubaccount: z.ZodBoolean;
15
- }, z.core.$strip>, z.ZodOptional<z.ZodObject<{}, z.core.$strip>>, z.ZodOptional<z.ZodObject<{}, z.core.$strip>>, z.ZodOptional<z.ZodObject<{}, z.core.$strip>>]>>;
16
+ }, z.core.$strip>]>>;
16
17
  createdAt: z.ZodString;
17
18
  updatedAt: z.ZodString;
18
19
  }, z.core.$strip>;
@@ -28,10 +29,11 @@ export declare const TradeAccountListResponse: z.ZodObject<{
28
29
  bybit: "bybit";
29
30
  okx: "okx";
30
31
  }>;
31
- metadata: z.ZodNullable<z.ZodUnion<readonly [z.ZodObject<{
32
- address: z.ZodString;
32
+ exchangeIdentifier: z.ZodString;
33
+ metadata: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
34
+ agentWalletAddress: z.ZodString;
33
35
  isSubaccount: z.ZodBoolean;
34
- }, z.core.$strip>, z.ZodOptional<z.ZodObject<{}, z.core.$strip>>, z.ZodOptional<z.ZodObject<{}, z.core.$strip>>, z.ZodOptional<z.ZodObject<{}, z.core.$strip>>]>>;
36
+ }, z.core.$strip>]>>;
35
37
  createdAt: z.ZodString;
36
38
  updatedAt: z.ZodString;
37
39
  }, z.core.$strip>>;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pear-protocol/types",
3
- "version": "0.0.1",
3
+ "version": "0.0.2",
4
4
  "description": "Pear Protocol Types definitions",
5
5
  "private": false,
6
6
  "type": "module",