@pear-protocol/types 2.0.0 → 2.1.0

package/dist/auth/api-keys.d.ts

@@ -51,6 +51,7 @@ export declare const ApiKeyMeResponse: z.ZodObject<{
     role: z.ZodEnum<{
         basic: "basic";
         pro: "pro";
+        vault: "vault";
     }>;
     scope: z.ZodEnum<{
         read: "read";

package/dist/auth/api-keys.js

@@ -34,7 +34,8 @@ const ApiKeyMeResponse = z.object({
   id: z.uuid().describe("User UUID that owns the API key"),
   role: z.enum([
     "basic",
-    "pro"
+    "pro",
+    "vault"
   ]).describe("User role"),
   scope: ApiKeyScope,
   authMethod: z.literal("api_key")

package/dist/auth/entities.d.ts

@@ -10,6 +10,7 @@ export declare const AuthenticatedUser: z.ZodObject<{
     role: z.ZodEnum<{
         basic: "basic";
         pro: "pro";
+        vault: "vault";
     }>;
     providerId: z.ZodNullable<z.ZodString>;
     loginMethod: z.ZodEnum<{

package/dist/auth/entities.js

@@ -10,7 +10,8 @@ const AuthenticatedUser = z.object({
   id: z.uuid().describe("User UUID"),
   role: z.enum([
     "basic",
-    "pro"
+    "pro",
+    "vault"
   ]).describe("User role"),
   providerId: z.string().nullable().describe("Provider identifier (wallet address or email)"),
   loginMethod: LoginMethod.describe("Authentication provider used for the current session")

package/dist/auth/response.d.ts

@@ -7,6 +7,7 @@ export declare const LoginResponse: z.ZodObject<{
         role: z.ZodEnum<{
             basic: "basic";
             pro: "pro";
+            vault: "vault";
         }>;
         providerId: z.ZodNullable<z.ZodString>;
         loginMethod: z.ZodEnum<{
@@ -77,6 +78,7 @@ export declare const MeResponse: z.ZodObject<{
     role: z.ZodEnum<{
         basic: "basic";
         pro: "pro";
+        vault: "vault";
     }>;
     providerId: z.ZodNullable<z.ZodString>;
     loginMethod: z.ZodEnum<{

package/dist/bundle.d.ts

@@ -11,6 +11,7 @@ export * from './instrument';
 export * from './instrument-precision';
 export * from './ladder';
 export * from './leverage';
+export * from './margin';
 export * from './market';
 export * from './misc';
 export * from './notification';

package/dist/bundle.js

@@ -11,6 +11,7 @@ export * from './instrument';
 export * from './instrument-precision';
 export * from './ladder';
 export * from './leverage';
+export * from './margin';
 export * from './market';
 export * from './misc';
 export * from './notification';

package/dist/fee/entities.d.ts

@@ -23,6 +23,7 @@ export type FeeConnector = z.output<typeof FeeConnector>;
 export declare const FeeRole: z.ZodEnum<{
     basic: "basic";
     pro: "pro";
+    vault: "vault";
 }>;
 export type FeeRole = z.output<typeof FeeRole>;
 export declare const FeeBps: z.ZodString;

package/dist/fee/entities.js

@@ -17,7 +17,8 @@ const FeeDiscountScope = z.enum([
 const FeeConnector = z.enum(Connector.options);
 const FeeRole = z.enum([
   "basic",
-  "pro"
+  "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');

package/dist/margin/index.d.ts

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

package/dist/margin/index.js

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

package/dist/margin/payloads.d.ts

@@ -0,0 +1,7 @@
+import { z } from 'zod';
+export declare const AdjustIsolatedMargin: z.ZodObject<{
+    symbol: z.ZodString;
+    amount: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
+    idempotencyKey: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type AdjustIsolatedMargin = z.infer<typeof AdjustIsolatedMargin>;

package/dist/margin/payloads.js

@@ -0,0 +1,20 @@
+import { z } from 'zod';
+import { SignedDecimalString } from '../common/schema';
+import { InstrumentId } from '../instrument/entities';
+
+const AdjustIsolatedMargin = z.object({
+  symbol: InstrumentId,
+  /**
+  * Signed margin movement in USD: `"+50"` adds 50 to the position, `"-50"` removes 50 from it.
+  * The sign is required, so a movement can never mean the opposite of what was intended.
+  */
+  amount: SignedDecimalString.refine((amount) => Number(amount) !== 0, "Amount must not be zero"),
+  /**
+  * Optional caller-supplied idempotency key, scoped to the trade account. A retry carrying the
+  * same key attaches to the first attempt and receives its outcome instead of moving the margin
+  * again. Omitted, the server mints one; either way it is returned as `adjustmentId`.
+  */
+  idempotencyKey: z.string().min(1).max(128).optional()
+});
+
+export { AdjustIsolatedMargin };

package/dist/margin/response.d.ts

@@ -0,0 +1,5 @@
+import { z } from 'zod';
+export declare const AdjustIsolatedMarginResponse: z.ZodObject<{
+    adjustmentId: z.ZodString;
+}, z.core.$strip>;
+export type AdjustIsolatedMarginResponse = z.infer<typeof AdjustIsolatedMarginResponse>;

package/dist/margin/response.js

@@ -0,0 +1,11 @@
+import { z } from 'zod';
+
+const AdjustIsolatedMarginResponse = z.object({
+  /**
+  * The caller's `idempotencyKey` when supplied, otherwise a server-minted UUID. Reusing it as the
+  * request key replays this movement's outcome.
+  */
+  adjustmentId: z.string().min(1).max(128)
+});
+
+export { AdjustIsolatedMarginResponse };

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

@@ -20,6 +20,10 @@ export declare const TradeAccount: z.ZodObject<{
         okx: "okx";
         lighter: "lighter";
     }>;
+    kind: z.ZodEnum<{
+        vault: "vault";
+        eoa: "eoa";
+    }>;
     exchangeIdentifier: z.ZodString;
     metadata: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
         agentWalletAddress: z.ZodString;

package/dist/trade-accounts/entities.js

@@ -17,6 +17,10 @@ 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"),
+  kind: z.enum([
+    "eoa",
+    "vault"
+  ]).describe("Whether the account trades an EOA or a Pear vault"),
   exchangeIdentifier: z.string().describe("User identifier on the exchange"),
   metadata: ConnectorMetadata.describe("Connector-specific metadata"),
   createdAt: z.string().describe("Creation timestamp (ISO 8601)"),

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

@@ -109,6 +109,16 @@ export declare const CreateTradeAccount: z.ZodDiscriminatedUnion<[z.ZodObject<{
         l1_address: z.ZodPipe<z.ZodString, z.ZodTransform<`0x${string}`, string>>;
     }, z.core.$strip>;
 }, z.core.$strip>], "connector">;
+/**
+ * Payload to create a Pear-vault-backed Hyperliquid trade account. The backend
+ * generates and approves the API wallet itself (via pear-vault-service), so
+ * the payload carries no credentials.
+ */
+export declare const CreateVaultTradeAccount: z.ZodObject<{
+    vaultAddress: z.ZodPipe<z.ZodString, z.ZodTransform<`0x${string}`, string>>;
+    alias: z.ZodString;
+    idempotencyKey: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
 /**
  * Payload to update a trade account
  */
@@ -174,6 +184,8 @@ export type CreateLighterCredentials = z.infer<typeof CreateLighterCredentials>;
 export type CreateLighterMetadata = z.infer<typeof CreateLighterMetadata>;
 export type CreateTradeAccountInput = z.input<typeof CreateTradeAccount>;
 export type CreateTradeAccount = z.output<typeof CreateTradeAccount>;
+export type CreateVaultTradeAccountInput = z.input<typeof CreateVaultTradeAccount>;
+export type CreateVaultTradeAccount = z.output<typeof CreateVaultTradeAccount>;
 export type UpdateTradeAccountInput = z.input<typeof UpdateTradeAccount>;
 export type UpdateTradeAccount = z.output<typeof UpdateTradeAccount>;
 export {};

package/dist/trade-accounts/payloads.js

@@ -104,6 +104,15 @@ const CreateTradeAccount = z.discriminatedUnion("connector", [
   CreateOkxAccount,
   CreateLighterAccount
 ]);
+const CreateVaultTradeAccount = z.object({
+  vaultAddress: EthereumAddress,
+  alias: AccountAlias,
+  /**
+  * Optional caller-supplied key. Reusing it attaches a transport retry to the first attempt;
+  * omitting it starts a new create attempt.
+  */
+  idempotencyKey: z.string().min(1).max(128).optional()
+});
 const UpdateTradeAccount = z.discriminatedUnion("connector", [
   UpdateHyperliquidAccount,
   UpdateBinanceAccount,
@@ -112,4 +121,4 @@ const UpdateTradeAccount = z.discriminatedUnion("connector", [
   UpdateLighterAccount
 ]);
 
-export { CreateTradeAccount, UpdateTradeAccount };
+export { CreateTradeAccount, CreateVaultTradeAccount, UpdateTradeAccount };

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

@@ -10,6 +10,10 @@ export declare const TradeAccountResponse: z.ZodObject<{
             okx: "okx";
             lighter: "lighter";
         }>;
+        kind: z.ZodEnum<{
+            vault: "vault";
+            eoa: "eoa";
+        }>;
         exchangeIdentifier: z.ZodString;
         metadata: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
             agentWalletAddress: z.ZodString;
@@ -35,6 +39,10 @@ export declare const TradeAccountListResponse: z.ZodObject<{
             okx: "okx";
             lighter: "lighter";
         }>;
+        kind: z.ZodEnum<{
+            vault: "vault";
+            eoa: "eoa";
+        }>;
         exchangeIdentifier: z.ZodString;
         metadata: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
             agentWalletAddress: z.ZodString;
@@ -49,6 +57,79 @@ export declare const TradeAccountListResponse: z.ZodObject<{
     }, z.core.$strip>>;
 }, z.core.$strip>;
 export type TradeAccountListResponse = z.infer<typeof TradeAccountListResponse>;
+/**
+ * Whether a vault already has a pear-pro trade account (UI: create vs trade). The account is owned by
+ * the vault's own synthetic user, so it never shows up in the caller's own list — this is where an
+ * authorized owner/trader gets it in order to trade as the vault (via the `pear-vault-address` header).
+ */
+export declare const VaultTradeAccountStatus: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    exists: z.ZodLiteral<false>;
+}, z.core.$strip>, z.ZodObject<{
+    exists: z.ZodLiteral<true>;
+    tradeAccountId: z.ZodString;
+    account: z.ZodObject<{
+        id: z.ZodUUID;
+        alias: z.ZodString;
+        connector: z.ZodEnum<{
+            hyperliquid: "hyperliquid";
+            binance: "binance";
+            bybit: "bybit";
+            okx: "okx";
+            lighter: "lighter";
+        }>;
+        kind: z.ZodEnum<{
+            vault: "vault";
+            eoa: "eoa";
+        }>;
+        exchangeIdentifier: z.ZodString;
+        metadata: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
+            agentWalletAddress: z.ZodString;
+            isSubaccount: z.ZodBoolean;
+            mainAccountAddress: z.ZodString;
+        }, z.core.$strip>, z.ZodObject<{
+            l1_address: z.ZodString;
+        }, z.core.$strip>]>>;
+        createdAt: z.ZodString;
+        updatedAt: z.ZodString;
+        deletedAt: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>;
+}, z.core.$strip>], "exists">;
+export type VaultTradeAccountStatus = z.infer<typeof VaultTradeAccountStatus>;
+export declare const VaultTradeAccountStatusResponse: z.ZodObject<{
+    status: z.ZodDiscriminatedUnion<[z.ZodObject<{
+        exists: z.ZodLiteral<false>;
+    }, z.core.$strip>, z.ZodObject<{
+        exists: z.ZodLiteral<true>;
+        tradeAccountId: z.ZodString;
+        account: z.ZodObject<{
+            id: z.ZodUUID;
+            alias: z.ZodString;
+            connector: z.ZodEnum<{
+                hyperliquid: "hyperliquid";
+                binance: "binance";
+                bybit: "bybit";
+                okx: "okx";
+                lighter: "lighter";
+            }>;
+            kind: z.ZodEnum<{
+                vault: "vault";
+                eoa: "eoa";
+            }>;
+            exchangeIdentifier: z.ZodString;
+            metadata: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
+                agentWalletAddress: z.ZodString;
+                isSubaccount: z.ZodBoolean;
+                mainAccountAddress: z.ZodString;
+            }, z.core.$strip>, z.ZodObject<{
+                l1_address: z.ZodString;
+            }, z.core.$strip>]>>;
+            createdAt: z.ZodString;
+            updatedAt: z.ZodString;
+            deletedAt: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>;
+    }, z.core.$strip>], "exists">;
+}, z.core.$strip>;
+export type VaultTradeAccountStatusResponse = z.infer<typeof VaultTradeAccountStatusResponse>;
 export declare const ExchangeCredentialsResponse: z.ZodDiscriminatedUnion<[z.ZodObject<{
     connector: z.ZodLiteral<"hyperliquid">;
     account: z.ZodObject<{
@@ -61,6 +142,10 @@ export declare const ExchangeCredentialsResponse: z.ZodDiscriminatedUnion<[z.Zod
             okx: "okx";
             lighter: "lighter";
         }>;
+        kind: z.ZodEnum<{
+            vault: "vault";
+            eoa: "eoa";
+        }>;
         exchangeIdentifier: z.ZodString;
         metadata: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
             agentWalletAddress: z.ZodString;
@@ -88,6 +173,10 @@ export declare const ExchangeCredentialsResponse: z.ZodDiscriminatedUnion<[z.Zod
             okx: "okx";
             lighter: "lighter";
         }>;
+        kind: z.ZodEnum<{
+            vault: "vault";
+            eoa: "eoa";
+        }>;
         exchangeIdentifier: z.ZodString;
         metadata: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
             agentWalletAddress: z.ZodString;
@@ -122,6 +211,10 @@ export declare const ExchangeCredentialsResponse: z.ZodDiscriminatedUnion<[z.Zod
             okx: "okx";
             lighter: "lighter";
         }>;
+        kind: z.ZodEnum<{
+            vault: "vault";
+            eoa: "eoa";
+        }>;
         exchangeIdentifier: z.ZodString;
         metadata: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
             agentWalletAddress: z.ZodString;
@@ -150,6 +243,10 @@ export declare const ExchangeCredentialsResponse: z.ZodDiscriminatedUnion<[z.Zod
             okx: "okx";
             lighter: "lighter";
         }>;
+        kind: z.ZodEnum<{
+            vault: "vault";
+            eoa: "eoa";
+        }>;
         exchangeIdentifier: z.ZodString;
         metadata: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
             agentWalletAddress: z.ZodString;
@@ -179,6 +276,10 @@ export declare const ExchangeCredentialsResponse: z.ZodDiscriminatedUnion<[z.Zod
             okx: "okx";
             lighter: "lighter";
         }>;
+        kind: z.ZodEnum<{
+            vault: "vault";
+            eoa: "eoa";
+        }>;
         exchangeIdentifier: z.ZodString;
         metadata: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
             agentWalletAddress: z.ZodString;

package/dist/trade-accounts/response.js

@@ -7,6 +7,19 @@ const TradeAccountResponse = z.object({
 const TradeAccountListResponse = z.object({
   accounts: z.array(TradeAccount)
 });
+const VaultTradeAccountStatus = z.discriminatedUnion("exists", [
+  z.object({
+    exists: z.literal(false)
+  }),
+  z.object({
+    exists: z.literal(true),
+    tradeAccountId: z.string(),
+    account: TradeAccount
+  })
+]);
+const VaultTradeAccountStatusResponse = z.object({
+  status: VaultTradeAccountStatus
+});
 const HyperliquidCredentialsResponse = z.object({
   connector: z.literal("hyperliquid"),
   account: TradeAccount,
@@ -59,4 +72,4 @@ const ExchangeCredentialsResponse = z.discriminatedUnion("connector", [
   LighterCredentialsResponse
 ]);
 
-export { ExchangeCredentialsResponse, TradeAccountListResponse, TradeAccountResponse };
+export { ExchangeCredentialsResponse, TradeAccountListResponse, TradeAccountResponse, VaultTradeAccountStatus, VaultTradeAccountStatusResponse };

package/dist/users/entities.d.ts

@@ -8,6 +8,7 @@ export declare const UserProfile: z.ZodObject<{
     role: z.ZodEnum<{
         basic: "basic";
         pro: "pro";
+        vault: "vault";
     }>;
     address: z.ZodNullable<z.ZodString>;
     email: z.ZodNullable<z.ZodString>;

package/dist/users/entities.js

@@ -10,7 +10,8 @@ const UserProfile = z.object({
   displayName: z.string().describe("Public display name"),
   role: z.enum([
     "basic",
-    "pro"
+    "pro",
+    "vault"
   ]).describe("User role"),
   address: z.string().nullable().describe("Linked wallet address (for evm_wallet provider)"),
   email: z.string().nullable().describe("Linked email address (for email provider)"),

package/dist/users/response.d.ts

@@ -6,6 +6,7 @@ export declare const ProfileResponse: z.ZodObject<{
         role: z.ZodEnum<{
             basic: "basic";
             pro: "pro";
+            vault: "vault";
         }>;
         address: z.ZodNullable<z.ZodString>;
         email: z.ZodNullable<z.ZodString>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pear-protocol/types",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "Pear Protocol Types definitions",
   "private": false,
   "type": "module",