@pear-protocol/types 0.0.1

package/dist/trade/responses.js

@@ -0,0 +1,9 @@
+import { z } from 'zod';
+import { Execution } from '../execution/entities';
+
+const CreateTradeOpenResponse = z.object({ execution: Execution });
+const CreateTradeAdjustResponse = z.object({ execution: Execution });
+const CreateTradeCloseResponse = z.object({ execution: Execution });
+const CreateTradeCloseAllResponse = z.object({ executions: z.array(Execution) });
+
+export { CreateTradeAdjustResponse, CreateTradeCloseAllResponse, CreateTradeCloseResponse, CreateTradeOpenResponse };

package/dist/trade-accounts/entities.d.ts

@@ -0,0 +1,50 @@
+import { z } from 'zod';
+/**
+ * Hyperliquid connector metadata
+ */
+declare const HyperliquidMetadata: z.ZodObject<{
+    address: z.ZodString;
+    isSubaccount: z.ZodBoolean;
+}, z.core.$strip>;
+/**
+ * Binance USDM connector metadata (empty for now)
+ */
+declare const BinanceUSDMMetadata: z.ZodOptional<z.ZodObject<{}, z.core.$strip>>;
+/**
+ * Bybit connector metadata (empty for now)
+ */
+declare const BybitMetadata: z.ZodOptional<z.ZodObject<{}, z.core.$strip>>;
+/**
+ * OKX connector metadata (empty for now)
+ */
+declare const OkxMetadata: z.ZodOptional<z.ZodObject<{}, z.core.$strip>>;
+/**
+ * Union of all connector metadata schemas
+ */
+declare const ConnectorMetadata: z.ZodNullable<z.ZodUnion<readonly [z.ZodObject<{
+    address: z.ZodString;
+    isSubaccount: z.ZodBoolean;
+}, z.core.$strip>, z.ZodOptional<z.ZodObject<{}, z.core.$strip>>, z.ZodOptional<z.ZodObject<{}, z.core.$strip>>, z.ZodOptional<z.ZodObject<{}, z.core.$strip>>]>>;
+export declare const TradeAccount: z.ZodObject<{
+    id: z.ZodUUID;
+    alias: z.ZodString;
+    connector: z.ZodEnum<{
+        hyperliquid: "hyperliquid";
+        binanceusdm: "binanceusdm";
+        bybit: "bybit";
+        okx: "okx";
+    }>;
+    metadata: z.ZodNullable<z.ZodUnion<readonly [z.ZodObject<{
+        address: z.ZodString;
+        isSubaccount: z.ZodBoolean;
+    }, z.core.$strip>, z.ZodOptional<z.ZodObject<{}, z.core.$strip>>, z.ZodOptional<z.ZodObject<{}, z.core.$strip>>, z.ZodOptional<z.ZodObject<{}, z.core.$strip>>]>>;
+    createdAt: z.ZodString;
+    updatedAt: z.ZodString;
+}, z.core.$strip>;
+export type TradeAccount = z.infer<typeof TradeAccount>;
+export type HyperliquidMetadata = z.infer<typeof HyperliquidMetadata>;
+export type BinanceUSDMMetadata = z.infer<typeof BinanceUSDMMetadata>;
+export type BybitMetadata = z.infer<typeof BybitMetadata>;
+export type OkxMetadata = z.infer<typeof OkxMetadata>;
+export type ConnectorMetadata = z.infer<typeof ConnectorMetadata>;
+export {};

package/dist/trade-accounts/entities.js

@@ -0,0 +1,18 @@
+import { z } from 'zod';
+import { Connector } from '../connector';
+
+const HyperliquidMetadata = z.object({ address: z.string(), isSubaccount: z.boolean() });
+const BinanceUSDMMetadata = z.object({}).optional();
+const BybitMetadata = z.object({}).optional();
+const OkxMetadata = z.object({}).optional();
+const ConnectorMetadata = z.union([HyperliquidMetadata, BinanceUSDMMetadata, BybitMetadata, OkxMetadata]).nullable();
+const TradeAccount = z.object({
+  id: z.uuid().describe("Trade account UUID"),
+  alias: z.string().describe("User-defined trade account alias"),
+  connector: Connector.describe("Exchange connector type"),
+  metadata: ConnectorMetadata.describe("Connector-specific metadata"),
+  createdAt: z.string().describe("Creation timestamp (ISO 8601)"),
+  updatedAt: z.string().describe("Last update timestamp (ISO 8601)")
+});
+
+export { TradeAccount };

package/dist/trade-accounts/index.d.ts

@@ -0,0 +1,3 @@
+export * from './entities';
+export * from './payloads';
+export * from './response';

package/dist/trade-accounts/index.js

@@ -0,0 +1,3 @@
+export * from './entities';
+export * from './payloads';
+export * from './response';

package/dist/trade-accounts/payloads.d.ts

@@ -0,0 +1,137 @@
+import { z } from 'zod';
+/**
+ * Hyperliquid connector credentials
+ */
+declare const CreateHyperliquidCredentials: z.ZodObject<{
+    signer_key: z.ZodString;
+}, z.core.$strip>;
+/**
+ * Hyperliquid connector metadata
+ */
+declare const CreateHyperliquidMetadata: z.ZodObject<{
+    address: z.ZodString;
+    isSubaccount: z.ZodBoolean;
+}, z.core.$strip>;
+/**
+ * Binance USDM connector credentials
+ */
+declare const CreateBinanceUSDMCredentials: z.ZodObject<{
+    api_key: z.ZodString;
+    api_secret: z.ZodString;
+}, z.core.$strip>;
+/**
+ * Binance USDM connector metadata (empty for now)
+ */
+declare const CreateBinanceUSDMMetadata: z.ZodOptional<z.ZodObject<{}, z.core.$strip>>;
+/**
+ * Bybit connector credentials
+ */
+declare const CreateBybitCredentials: z.ZodObject<{
+    api_key: z.ZodString;
+    api_secret: z.ZodString;
+}, z.core.$strip>;
+/**
+ * Bybit connector metadata (empty for now)
+ */
+declare const CreateBybitMetadata: z.ZodOptional<z.ZodObject<{}, z.core.$strip>>;
+/**
+ * OKX connector credentials
+ */
+declare const CreateOkxCredentials: z.ZodObject<{
+    api_key: z.ZodString;
+    api_secret: z.ZodString;
+    api_pass: z.ZodString;
+}, z.core.$strip>;
+/**
+ * OKX connector metadata (empty for now)
+ */
+declare const CreateOkxMetadata: z.ZodOptional<z.ZodObject<{}, z.core.$strip>>;
+/**
+ * Payload to create a new trade account
+ */
+export declare const CreateTradeAccount: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    connector: z.ZodLiteral<"hyperliquid">;
+    alias: z.ZodString;
+    credentials: z.ZodObject<{
+        signer_key: z.ZodString;
+    }, z.core.$strip>;
+    metadata: z.ZodObject<{
+        address: z.ZodString;
+        isSubaccount: z.ZodBoolean;
+    }, z.core.$strip>;
+}, z.core.$strip>, z.ZodObject<{
+    connector: z.ZodLiteral<"binanceusdm">;
+    alias: z.ZodString;
+    credentials: z.ZodObject<{
+        api_key: z.ZodString;
+        api_secret: z.ZodString;
+    }, z.core.$strip>;
+    metadata: z.ZodOptional<z.ZodObject<{}, z.core.$strip>>;
+}, z.core.$strip>, z.ZodObject<{
+    connector: z.ZodLiteral<"bybit">;
+    alias: z.ZodString;
+    credentials: z.ZodObject<{
+        api_key: z.ZodString;
+        api_secret: z.ZodString;
+    }, z.core.$strip>;
+    metadata: z.ZodOptional<z.ZodObject<{}, z.core.$strip>>;
+}, z.core.$strip>, z.ZodObject<{
+    connector: z.ZodLiteral<"okx">;
+    alias: z.ZodString;
+    credentials: z.ZodObject<{
+        api_key: z.ZodString;
+        api_secret: z.ZodString;
+        api_pass: z.ZodString;
+    }, z.core.$strip>;
+    metadata: z.ZodOptional<z.ZodObject<{}, z.core.$strip>>;
+}, z.core.$strip>], "connector">;
+/**
+ * Payload to update a trade account for a specific connector.
+ */
+export declare const UpdateTradeAccount: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    connector: z.ZodLiteral<"hyperliquid">;
+    alias: z.ZodOptional<z.ZodString>;
+    credentials: z.ZodOptional<z.ZodObject<{
+        signer_key: z.ZodString;
+    }, z.core.$strip>>;
+    metadata: z.ZodOptional<z.ZodObject<{
+        address: z.ZodString;
+        isSubaccount: z.ZodBoolean;
+    }, z.core.$strip>>;
+}, z.core.$strip>, z.ZodObject<{
+    connector: z.ZodLiteral<"binanceusdm">;
+    alias: z.ZodOptional<z.ZodString>;
+    credentials: z.ZodOptional<z.ZodObject<{
+        api_key: z.ZodString;
+        api_secret: z.ZodString;
+    }, z.core.$strip>>;
+    metadata: z.ZodOptional<z.ZodOptional<z.ZodObject<{}, z.core.$strip>>>;
+}, z.core.$strip>, z.ZodObject<{
+    connector: z.ZodLiteral<"bybit">;
+    alias: z.ZodOptional<z.ZodString>;
+    credentials: z.ZodOptional<z.ZodObject<{
+        api_key: z.ZodString;
+        api_secret: z.ZodString;
+    }, z.core.$strip>>;
+    metadata: z.ZodOptional<z.ZodOptional<z.ZodObject<{}, z.core.$strip>>>;
+}, z.core.$strip>, z.ZodObject<{
+    connector: z.ZodLiteral<"okx">;
+    alias: z.ZodOptional<z.ZodString>;
+    credentials: z.ZodOptional<z.ZodObject<{
+        api_key: z.ZodString;
+        api_secret: z.ZodString;
+        api_pass: z.ZodString;
+    }, z.core.$strip>>;
+    metadata: z.ZodOptional<z.ZodOptional<z.ZodObject<{}, z.core.$strip>>>;
+}, z.core.$strip>], "connector">;
+export type CreateHyperliquidCredentials = z.infer<typeof CreateHyperliquidCredentials>;
+export type CreateHyperliquidMetadata = z.infer<typeof CreateHyperliquidMetadata>;
+export type CreateBinanceUSDMMetadata = z.infer<typeof CreateBinanceUSDMMetadata>;
+export type CreateBinanceUSDMCredentials = z.infer<typeof CreateBinanceUSDMCredentials>;
+export type CreateBybitCredentials = z.infer<typeof CreateBybitCredentials>;
+export type CreateBybitMetadata = z.infer<typeof CreateBybitMetadata>;
+export type CreateOkxCredentials = z.infer<typeof CreateOkxCredentials>;
+export type CreateOkxMetadata = z.infer<typeof CreateOkxMetadata>;
+export type CreateTradeAccount = z.infer<typeof CreateTradeAccount>;
+export type UpdateTradeAccount = z.infer<typeof UpdateTradeAccount>;
+export {};

package/dist/trade-accounts/payloads.js

@@ -0,0 +1,84 @@
+import { z } from 'zod';
+
+const CreateHyperliquidCredentials = z.object({
+  signer_key: z.string().min(1, "Signer key is required")
+});
+const CreateHyperliquidMetadata = z.object({
+  address: z.string().regex(/^0x[a-fA-F0-9]{40}$/, "Invalid Ethereum address"),
+  isSubaccount: z.boolean()
+});
+const CreateBinanceUSDMCredentials = z.object({
+  api_key: z.string().min(1, "API key is required"),
+  api_secret: z.string().min(1, "API secret is required")
+});
+const CreateBinanceUSDMMetadata = z.object({}).optional();
+const CreateBybitCredentials = z.object({
+  api_key: z.string().min(1, "API key is required"),
+  api_secret: z.string().min(1, "API secret is required")
+});
+const CreateBybitMetadata = z.object({}).optional();
+const CreateOkxCredentials = z.object({
+  api_key: z.string().min(1, "API key is required"),
+  api_secret: z.string().min(1, "API secret is required"),
+  api_pass: z.string().min(1, "API passphrase is required")
+});
+const CreateOkxMetadata = z.object({}).optional();
+const AccountAlias = z.string().min(1, "Alias is required").max(100, "Alias must be 100 characters or less");
+const CreateHyperliquidAccount = z.object({
+  connector: z.literal("hyperliquid"),
+  alias: AccountAlias,
+  credentials: CreateHyperliquidCredentials,
+  metadata: CreateHyperliquidMetadata
+});
+const CreateBinanceUSDMAccount = z.object({
+  connector: z.literal("binanceusdm"),
+  alias: AccountAlias,
+  credentials: CreateBinanceUSDMCredentials,
+  metadata: CreateBinanceUSDMMetadata
+});
+const CreateBybitAccount = z.object({
+  connector: z.literal("bybit"),
+  alias: AccountAlias,
+  credentials: CreateBybitCredentials,
+  metadata: CreateBybitMetadata
+});
+const CreateOkxAccount = z.object({
+  connector: z.literal("okx"),
+  alias: AccountAlias,
+  credentials: CreateOkxCredentials,
+  metadata: CreateOkxMetadata
+});
+const CreateTradeAccount = z.discriminatedUnion("connector", [
+  CreateHyperliquidAccount,
+  CreateBinanceUSDMAccount,
+  CreateBybitAccount,
+  CreateOkxAccount
+]);
+const UpdateTradeAccount = z.discriminatedUnion("connector", [
+  z.object({
+    connector: z.literal("hyperliquid"),
+    alias: AccountAlias.optional(),
+    credentials: CreateHyperliquidCredentials.optional(),
+    metadata: CreateHyperliquidMetadata.optional()
+  }),
+  z.object({
+    connector: z.literal("binanceusdm"),
+    alias: AccountAlias.optional(),
+    credentials: CreateBinanceUSDMCredentials.optional(),
+    metadata: CreateBinanceUSDMMetadata.optional()
+  }),
+  z.object({
+    connector: z.literal("bybit"),
+    alias: AccountAlias.optional(),
+    credentials: CreateBybitCredentials.optional(),
+    metadata: CreateBybitMetadata.optional()
+  }),
+  z.object({
+    connector: z.literal("okx"),
+    alias: AccountAlias.optional(),
+    credentials: CreateOkxCredentials.optional(),
+    metadata: CreateOkxMetadata.optional()
+  })
+]);
+
+export { CreateTradeAccount, UpdateTradeAccount };

package/dist/trade-accounts/response.d.ts

@@ -0,0 +1,65 @@
+import { z } from 'zod';
+export declare const TradeAccountResponse: z.ZodObject<{
+    account: z.ZodObject<{
+        id: z.ZodUUID;
+        alias: z.ZodString;
+        connector: z.ZodEnum<{
+            hyperliquid: "hyperliquid";
+            binanceusdm: "binanceusdm";
+            bybit: "bybit";
+            okx: "okx";
+        }>;
+        metadata: z.ZodNullable<z.ZodUnion<readonly [z.ZodObject<{
+            address: z.ZodString;
+            isSubaccount: z.ZodBoolean;
+        }, z.core.$strip>, z.ZodOptional<z.ZodObject<{}, z.core.$strip>>, z.ZodOptional<z.ZodObject<{}, z.core.$strip>>, z.ZodOptional<z.ZodObject<{}, z.core.$strip>>]>>;
+        createdAt: z.ZodString;
+        updatedAt: z.ZodString;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type TradeAccountResponse = z.infer<typeof TradeAccountResponse>;
+export declare const TradeAccountListResponse: z.ZodObject<{
+    accounts: z.ZodArray<z.ZodObject<{
+        id: z.ZodUUID;
+        alias: z.ZodString;
+        connector: z.ZodEnum<{
+            hyperliquid: "hyperliquid";
+            binanceusdm: "binanceusdm";
+            bybit: "bybit";
+            okx: "okx";
+        }>;
+        metadata: z.ZodNullable<z.ZodUnion<readonly [z.ZodObject<{
+            address: z.ZodString;
+            isSubaccount: z.ZodBoolean;
+        }, z.core.$strip>, z.ZodOptional<z.ZodObject<{}, z.core.$strip>>, z.ZodOptional<z.ZodObject<{}, z.core.$strip>>, z.ZodOptional<z.ZodObject<{}, z.core.$strip>>]>>;
+        createdAt: z.ZodString;
+        updatedAt: z.ZodString;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type TradeAccountListResponse = z.infer<typeof TradeAccountListResponse>;
+export declare const ExchangeCredentialsResponse: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    connector: z.ZodLiteral<"hyperliquid">;
+    credentials: z.ZodObject<{
+        signer_key: z.ZodString;
+    }, z.core.$strip>;
+}, z.core.$strip>, z.ZodObject<{
+    connector: z.ZodLiteral<"binanceusdm">;
+    credentials: z.ZodObject<{
+        api_key: z.ZodString;
+        api_secret: z.ZodString;
+    }, z.core.$strip>;
+}, z.core.$strip>, z.ZodObject<{
+    connector: z.ZodLiteral<"bybit">;
+    credentials: z.ZodObject<{
+        api_key: z.ZodString;
+        api_secret: z.ZodString;
+    }, z.core.$strip>;
+}, z.core.$strip>, z.ZodObject<{
+    connector: z.ZodLiteral<"okx">;
+    credentials: z.ZodObject<{
+        api_key: z.ZodString;
+        api_secret: z.ZodString;
+        api_pass: z.ZodString;
+    }, z.core.$strip>;
+}, z.core.$strip>], "connector">;
+export type ExchangeCredentialsResponse = z.infer<typeof ExchangeCredentialsResponse>;

package/dist/trade-accounts/response.js

@@ -0,0 +1,41 @@
+import { z } from 'zod';
+import { TradeAccount } from './entities';
+
+const TradeAccountResponse = z.object({ account: TradeAccount });
+const TradeAccountListResponse = z.object({ accounts: z.array(TradeAccount) });
+const HyperliquidCredentialsResponse = z.object({
+  connector: z.literal("hyperliquid"),
+  credentials: z.object({
+    signer_key: z.string()
+  })
+});
+const BinanceUSDMCredentialsResponse = z.object({
+  connector: z.literal("binanceusdm"),
+  credentials: z.object({
+    api_key: z.string(),
+    api_secret: z.string()
+  })
+});
+const BybitCredentialsResponse = z.object({
+  connector: z.literal("bybit"),
+  credentials: z.object({
+    api_key: z.string(),
+    api_secret: z.string()
+  })
+});
+const OkxCredentialsResponse = z.object({
+  connector: z.literal("okx"),
+  credentials: z.object({
+    api_key: z.string(),
+    api_secret: z.string(),
+    api_pass: z.string()
+  })
+});
+const ExchangeCredentialsResponse = z.discriminatedUnion("connector", [
+  HyperliquidCredentialsResponse,
+  BinanceUSDMCredentialsResponse,
+  BybitCredentialsResponse,
+  OkxCredentialsResponse
+]);
+
+export { ExchangeCredentialsResponse, TradeAccountListResponse, TradeAccountResponse };