@pear-protocol/types 0.0.19 → 0.0.21

package/dist/bundle.d.ts

@@ -11,6 +11,7 @@ export * from './misc';
 export * from './order';
 export * from './position';
 export * from './price';
+export * from './rebalance';
 export * from './schedule';
 export * from './statistics';
 export * from './sync';

package/dist/bundle.js

@@ -11,6 +11,7 @@ export * from './misc';
 export * from './order';
 export * from './position';
 export * from './price';
+export * from './rebalance';
 export * from './schedule';
 export * from './statistics';
 export * from './sync';

package/dist/instrument/entities.d.ts

@@ -7,6 +7,23 @@ export declare const InstrumentType: z.ZodEnum<{
     hip3: "hip3";
 }>;
 export type InstrumentType = z.infer<typeof InstrumentType>;
+export declare const InstrumentTradeabilityStatus: z.ZodEnum<{
+    tradable: "tradable";
+    reduce_only: "reduce_only";
+    not_tradable: "not_tradable";
+}>;
+export type InstrumentTradeabilityStatus = z.infer<typeof InstrumentTradeabilityStatus>;
+export declare const InstrumentTradeabilityReason: z.ZodNullable<z.ZodString>;
+export type InstrumentTradeabilityReason = z.infer<typeof InstrumentTradeabilityReason>;
+export declare const InstrumentTradeability: z.ZodObject<{
+    status: z.ZodEnum<{
+        tradable: "tradable";
+        reduce_only: "reduce_only";
+        not_tradable: "not_tradable";
+    }>;
+    reason: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>;
+export type InstrumentTradeability = z.output<typeof InstrumentTradeability>;
 export declare const Instrument: z.ZodObject<{
     id: z.ZodString;
     base: z.ZodString;
@@ -40,5 +57,13 @@ export declare const Instrument: z.ZodObject<{
             max: z.ZodNullable<z.ZodOptional<z.ZodPipe<z.ZodNumber, z.ZodTransform<number | undefined, number>>>>;
         }, z.core.$strip>>;
     }, z.core.$strip>;
+    tradeability: z.ZodObject<{
+        status: z.ZodEnum<{
+            tradable: "tradable";
+            reduce_only: "reduce_only";
+            not_tradable: "not_tradable";
+        }>;
+        reason: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>;
 }, z.core.$strip>;
 export type Instrument = z.output<typeof Instrument>;

package/dist/instrument/entities.js

@@ -4,6 +4,12 @@ import { InstrumentPrecision } from '../instrument-precision';
 
 const InstrumentId = z.string().trim().min(1, "Instrument ID is required").max(64, "Instrument ID must be at most 64 characters").regex(/^[^\s][^\s]*$/, "Instrument ID contains invalid characters");
 const InstrumentType = z.enum(["spot", "perp", "hip3"]);
+const InstrumentTradeabilityStatus = z.enum(["tradable", "reduce_only", "not_tradable"]);
+const InstrumentTradeabilityReason = z.string().nullable();
+const InstrumentTradeability = z.object({
+  status: InstrumentTradeabilityStatus,
+  reason: InstrumentTradeabilityReason
+});
 const Instrument = z.object({
   /**
    * Exchange specific instrument identifier
@@ -42,7 +48,11 @@ const Instrument = z.object({
   /**
    * The precision of the instrument.
    */
-  precision: InstrumentPrecision
+  precision: InstrumentPrecision,
+  /**
+   * Whether this instrument can be traded normally.
+   */
+  tradeability: InstrumentTradeability
 });
 
-export { Instrument, InstrumentId, InstrumentType };
+export { Instrument, InstrumentId, InstrumentTradeability, InstrumentTradeabilityReason, InstrumentTradeabilityStatus, InstrumentType };

package/dist/instrument/queries.d.ts

@@ -1,4 +1,11 @@
 import { z } from 'zod';
+export declare const InstrumentScope: z.ZodEnum<{
+    tradable: "tradable";
+    reduce_only: "reduce_only";
+    not_tradable: "not_tradable";
+    all: "all";
+}>;
+export type InstrumentScope = z.infer<typeof InstrumentScope>;
 export declare const InstrumentListParams: z.ZodObject<{
     connector: z.ZodEnum<{
         hyperliquid: "hyperliquid";
@@ -7,5 +14,12 @@ export declare const InstrumentListParams: z.ZodObject<{
         okx: "okx";
         lighter: "lighter";
     }>;
+    scope: z.ZodDefault<z.ZodEnum<{
+        tradable: "tradable";
+        reduce_only: "reduce_only";
+        not_tradable: "not_tradable";
+        all: "all";
+    }>>;
 }, z.core.$strip>;
+export type InstrumentListParamsInput = z.input<typeof InstrumentListParams>;
 export type InstrumentListParams = z.output<typeof InstrumentListParams>;

package/dist/instrument/queries.js

@@ -1,8 +1,10 @@
 import { z } from 'zod';
 import { Connector } from '../connector';
 
+const InstrumentScope = z.enum(["tradable", "reduce_only", "not_tradable", "all"]);
 const InstrumentListParams = z.object({
-  connector: Connector
+  connector: Connector,
+  scope: InstrumentScope.default("all")
 });
 
-export { InstrumentListParams };
+export { InstrumentListParams, InstrumentScope };

package/dist/instrument/responses.d.ts

@@ -33,6 +33,14 @@ export declare const InstrumentListResponse: z.ZodObject<{
                 max: z.ZodNullable<z.ZodOptional<z.ZodPipe<z.ZodNumber, z.ZodTransform<number | undefined, number>>>>;
             }, z.core.$strip>>;
         }, z.core.$strip>;
+        tradeability: z.ZodObject<{
+            status: z.ZodEnum<{
+                tradable: "tradable";
+                reduce_only: "reduce_only";
+                not_tradable: "not_tradable";
+            }>;
+            reason: z.ZodNullable<z.ZodString>;
+        }, z.core.$strip>;
     }, z.core.$strip>>;
 }, z.core.$strip>;
 export type InstrumentListResponse = z.output<typeof InstrumentListResponse>;

package/dist/rebalance/index.d.ts

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

package/dist/rebalance/index.js

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

package/dist/rebalance/payloads.d.ts

@@ -0,0 +1,11 @@
+import { z } from 'zod';
+export declare const RebalanceManually: z.ZodObject<{
+    orderType: z.ZodEnum<{
+        MARKET: "MARKET";
+    }>;
+    weightings: z.ZodArray<z.ZodObject<{
+        symbol: z.ZodString;
+        weight: z.ZodNumber;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type RebalanceManually = z.output<typeof RebalanceManually>;

package/dist/rebalance/payloads.js

@@ -0,0 +1,16 @@
+import { z } from 'zod';
+import { RefineWeightingSum, RefineUniqueSymbols } from '../common/refinement';
+import { ExecutionOrderType } from '../execution';
+import { InstrumentId } from '../instrument';
+
+const RebalanceManually = z.object({
+  orderType: ExecutionOrderType,
+  weightings: z.array(
+    z.object({
+      symbol: InstrumentId,
+      weight: z.number().positive({ message: "Weight must be greater than 0" }).max(1, { message: "Weight must be less than 1" })
+    })
+  ).superRefine(RefineWeightingSum).superRefine(RefineUniqueSymbols).describe("Array of weightings to rebalance the position")
+});
+
+export { RebalanceManually };

package/dist/rebalance/responses.d.ts

@@ -0,0 +1,10 @@
+import { z } from 'zod';
+export declare const RebalanceManuallyResponse: z.ZodObject<{
+    plan: z.ZodUnion<readonly [z.ZodObject<{
+        outcome: z.ZodLiteral<"full_rebalance">;
+    }, z.core.$strip>, z.ZodObject<{
+        outcome: z.ZodUnion<readonly [z.ZodLiteral<"partial_rebalance">, z.ZodLiteral<"no_rebalance">]>;
+        messages: z.ZodTuple<[z.ZodString], z.ZodString>;
+    }, z.core.$strip>]>;
+}, z.core.$strip>;
+export type RebalanceManuallyResponse = z.output<typeof RebalanceManuallyResponse>;

package/dist/rebalance/responses.js

@@ -0,0 +1,15 @@
+import { z } from 'zod';
+
+const RebalanceManuallyResponse = z.object({
+  plan: z.union([
+    z.object({
+      outcome: z.literal("full_rebalance")
+    }),
+    z.object({
+      outcome: z.union([z.literal("partial_rebalance"), z.literal("no_rebalance")]),
+      messages: z.tuple([z.string()]).rest(z.string())
+    })
+  ])
+});
+
+export { RebalanceManuallyResponse };

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

@@ -51,11 +51,55 @@ export declare const TradeAccountListResponse: z.ZodObject<{
 export type TradeAccountListResponse = z.infer<typeof TradeAccountListResponse>;
 export declare const ExchangeCredentialsResponse: z.ZodDiscriminatedUnion<[z.ZodObject<{
     connector: z.ZodLiteral<"hyperliquid">;
+    account: z.ZodObject<{
+        id: z.ZodUUID;
+        alias: z.ZodString;
+        connector: z.ZodEnum<{
+            hyperliquid: "hyperliquid";
+            binance: "binance";
+            bybit: "bybit";
+            okx: "okx";
+            lighter: "lighter";
+        }>;
+        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>;
     credentials: z.ZodObject<{
         signer_key: z.ZodString;
     }, z.core.$strip>;
 }, z.core.$strip>, z.ZodObject<{
     connector: z.ZodLiteral<"binance">;
+    account: z.ZodObject<{
+        id: z.ZodUUID;
+        alias: z.ZodString;
+        connector: z.ZodEnum<{
+            hyperliquid: "hyperliquid";
+            binance: "binance";
+            bybit: "bybit";
+            okx: "okx";
+            lighter: "lighter";
+        }>;
+        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>;
     credentials: z.ZodObject<{
         read: z.ZodObject<{
             api_key: z.ZodString;
@@ -68,12 +112,56 @@ export declare const ExchangeCredentialsResponse: z.ZodDiscriminatedUnion<[z.Zod
     }, z.core.$strip>;
 }, z.core.$strip>, z.ZodObject<{
     connector: z.ZodLiteral<"bybit">;
+    account: z.ZodObject<{
+        id: z.ZodUUID;
+        alias: z.ZodString;
+        connector: z.ZodEnum<{
+            hyperliquid: "hyperliquid";
+            binance: "binance";
+            bybit: "bybit";
+            okx: "okx";
+            lighter: "lighter";
+        }>;
+        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>;
     credentials: z.ZodObject<{
         api_key: z.ZodString;
         api_secret: z.ZodString;
     }, z.core.$strip>;
 }, z.core.$strip>, z.ZodObject<{
     connector: z.ZodLiteral<"okx">;
+    account: z.ZodObject<{
+        id: z.ZodUUID;
+        alias: z.ZodString;
+        connector: z.ZodEnum<{
+            hyperliquid: "hyperliquid";
+            binance: "binance";
+            bybit: "bybit";
+            okx: "okx";
+            lighter: "lighter";
+        }>;
+        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>;
     credentials: z.ZodObject<{
         api_key: z.ZodString;
         api_secret: z.ZodString;
@@ -81,6 +169,28 @@ export declare const ExchangeCredentialsResponse: z.ZodDiscriminatedUnion<[z.Zod
     }, z.core.$strip>;
 }, z.core.$strip>, z.ZodObject<{
     connector: z.ZodLiteral<"lighter">;
+    account: z.ZodObject<{
+        id: z.ZodUUID;
+        alias: z.ZodString;
+        connector: z.ZodEnum<{
+            hyperliquid: "hyperliquid";
+            binance: "binance";
+            bybit: "bybit";
+            okx: "okx";
+            lighter: "lighter";
+        }>;
+        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>;
     credentials: z.ZodObject<{
         api_private_key: z.ZodString;
         api_key_index: z.ZodNumber;

package/dist/trade-accounts/response.js

@@ -5,6 +5,7 @@ const TradeAccountResponse = z.object({ account: TradeAccount });
 const TradeAccountListResponse = z.object({ accounts: z.array(TradeAccount) });
 const HyperliquidCredentialsResponse = z.object({
   connector: z.literal("hyperliquid"),
+  account: TradeAccount,
   credentials: z.object({
     signer_key: z.string()
   })
@@ -15,6 +16,7 @@ const BinanceApiKeyPairResponse = z.object({
 });
 const BinanceCredentialsResponse = z.object({
   connector: z.literal("binance"),
+  account: TradeAccount,
   credentials: z.object({
     read: BinanceApiKeyPairResponse,
     write: BinanceApiKeyPairResponse
@@ -22,6 +24,7 @@ const BinanceCredentialsResponse = z.object({
 });
 const BybitCredentialsResponse = z.object({
   connector: z.literal("bybit"),
+  account: TradeAccount,
   credentials: z.object({
     api_key: z.string(),
     api_secret: z.string()
@@ -29,6 +32,7 @@ const BybitCredentialsResponse = z.object({
 });
 const OkxCredentialsResponse = z.object({
   connector: z.literal("okx"),
+  account: TradeAccount,
   credentials: z.object({
     api_key: z.string(),
     api_secret: z.string(),
@@ -37,6 +41,7 @@ const OkxCredentialsResponse = z.object({
 });
 const LighterCredentialsResponse = z.object({
   connector: z.literal("lighter"),
+  account: TradeAccount,
   credentials: z.object({
     api_private_key: z.string(),
     api_key_index: z.number()

package/package.json

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