@pear-protocol/types 1.16.0 → 1.17.0

package/dist/instrument/entities.d.ts

@@ -7,6 +7,15 @@ export declare const InstrumentType: z.ZodEnum<{
     hip3: "hip3";
 }>;
 export type InstrumentType = z.infer<typeof InstrumentType>;
+/**
+ * The margin modes a market offers. Distinct from the account-level `MarginMode`, which is the user's choice.
+ */
+export declare const InstrumentMarginMode: z.ZodEnum<{
+    any: "any";
+    isolated: "isolated";
+    cross: "cross";
+}>;
+export type InstrumentMarginMode = z.infer<typeof InstrumentMarginMode>;
 export declare const InstrumentTradeabilityStatus: z.ZodEnum<{
     tradable: "tradable";
     reduce_only: "reduce_only";
@@ -41,6 +50,11 @@ export declare const Instrument: z.ZodObject<{
         hip3: "hip3";
     }>;
     leverage: z.ZodInt;
+    marginMode: z.ZodEnum<{
+        any: "any";
+        isolated: "isolated";
+        cross: "cross";
+    }>;
     precision: z.ZodObject<{
         quantity: z.ZodObject<{
             decimals: z.ZodInt;
@@ -70,6 +84,11 @@ export type Instrument = z.output<typeof Instrument>;
 export declare const InstrumentLite: z.ZodObject<{
     id: z.ZodString;
     base: z.ZodString;
+    marginMode: z.ZodEnum<{
+        any: "any";
+        isolated: "isolated";
+        cross: "cross";
+    }>;
     precision: z.ZodObject<{
         quantity: z.ZodObject<{
             contractSize: z.ZodNumber;

package/dist/instrument/entities.js

@@ -4,6 +4,7 @@ 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 InstrumentMarginMode = z.enum(["isolated", "cross", "any"]);
 const InstrumentTradeabilityStatus = z.enum(["tradable", "reduce_only", "not_tradable"]);
 const InstrumentTradeabilityReason = z.string().nullable();
 const InstrumentTradeability = z.object({
@@ -45,6 +46,11 @@ const Instrument = z.object({
    * @example 1
    */
   leverage: z.int().min(1),
+  /**
+   * The margin modes this market offers, not the mode selected for an account.
+   * `isolated` and `cross` mean the venue permits only that mode; `any` means the user chooses.
+   */
+  marginMode: InstrumentMarginMode,
   /**
    * The precision of the instrument.
    */
@@ -66,6 +72,11 @@ const InstrumentLite = z.object({
    * @example "BTC"
    */
   base: z.string(),
+  /**
+   * The margin modes this market offers, not the mode selected for an account.
+   * `isolated` and `cross` mean the venue permits only that mode; `any` means the user chooses.
+   */
+  marginMode: InstrumentMarginMode,
   /**
    * Minimal precision — only the contract size the syncer needs for BASE-unit normalization.
    */
@@ -76,4 +87,4 @@ const InstrumentLite = z.object({
   })
 });
 
-export { Instrument, InstrumentId, InstrumentLite, InstrumentTradeability, InstrumentTradeabilityReason, InstrumentTradeabilityStatus, InstrumentType };
+export { Instrument, InstrumentId, InstrumentLite, InstrumentMarginMode, InstrumentTradeability, InstrumentTradeabilityReason, InstrumentTradeabilityStatus, InstrumentType };

package/dist/instrument/responses.d.ts

@@ -17,6 +17,11 @@ export declare const InstrumentListResponse: z.ZodObject<{
             hip3: "hip3";
         }>;
         leverage: z.ZodInt;
+        marginMode: z.ZodEnum<{
+            any: "any";
+            isolated: "isolated";
+            cross: "cross";
+        }>;
         precision: z.ZodObject<{
             quantity: z.ZodObject<{
                 decimals: z.ZodInt;
@@ -52,6 +57,11 @@ export declare const InstrumentListLiteResponse: z.ZodObject<{
     instruments: z.ZodArray<z.ZodObject<{
         id: z.ZodString;
         base: z.ZodString;
+        marginMode: z.ZodEnum<{
+            any: "any";
+            isolated: "isolated";
+            cross: "cross";
+        }>;
         precision: z.ZodObject<{
             quantity: z.ZodObject<{
                 contractSize: z.ZodNumber;

package/dist/instrument/responses.js

@@ -12,7 +12,7 @@ const InstrumentSymbolToIdMapResponse = z.object({
 });
 const InstrumentListLiteResponse = z.object({
   /**
-   * The list of instruments, trimmed to the fields the account syncer reads.
+   * The list of instruments, trimmed to the lightweight consumer fields.
    */
   instruments: z.array(InstrumentLite)
 });

package/dist/leverage/payloads.d.ts

@@ -1,15 +1,15 @@
 import { z } from 'zod';
 export declare const MarginMode: z.ZodEnum<{
-    cross: "cross";
     isolated: "isolated";
+    cross: "cross";
 }>;
 export type MarginMode = z.infer<typeof MarginMode>;
 export declare const SetLeverage: z.ZodObject<{
     symbol: z.ZodString;
     leverage: z.ZodInt;
     marginMode: z.ZodOptional<z.ZodEnum<{
-        cross: "cross";
         isolated: "isolated";
+        cross: "cross";
     }>>;
 }, z.core.$strip>;
 export type SetLeverage = z.infer<typeof SetLeverage>;

package/dist/market/entities.d.ts

@@ -37,8 +37,14 @@ export declare const BasketMarket: z.ZodObject<{
     }>;
     basketKey: z.ZodString;
     displaySymbol: z.ZodString;
-    longInstrumentIds: z.ZodArray<z.ZodString>;
-    shortInstrumentIds: z.ZodArray<z.ZodString>;
+    legs: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        symbol: z.ZodString;
+        side: z.ZodEnum<{
+            BUY: "BUY";
+            SELL: "SELL";
+        }>;
+    }, z.core.$strip>>;
     price: z.ZodString;
     priceChange24h: z.ZodString;
     weightRatio: z.ZodString;
@@ -58,6 +64,21 @@ export declare const BasketMarket: z.ZodObject<{
     hasMaterializedStats: z.ZodBoolean;
 }, z.core.$strip>;
 export type BasketMarket = z.output<typeof BasketMarket>;
+/**
+ * How many positions — and how many distinct traders — have ever opened one requested
+ * basket, with its key echoed back so a row needs no positional matching.
+ *
+ * Both numbers are cumulative counters bumped when an open completes and never
+ * decremented, so they read as the basket's popularity, not its live open interest,
+ * and they are best-effort: a bump lost to a failure is accepted. `traders` is
+ * distinct per venue: a trader who opened the basket on two venues counts on each.
+ */
+export declare const MarketBasketPositionCounts: z.ZodObject<{
+    basketKey: z.ZodString;
+    opened: z.ZodNumber;
+    traders: z.ZodNumber;
+}, z.core.$strip>;
+export type MarketBasketPositionCounts = z.output<typeof MarketBasketPositionCounts>;
 export declare const MarketTotals: z.ZodObject<{
     markets: z.ZodNumber;
     volume24h: z.ZodString;

package/dist/market/entities.js

@@ -1,4 +1,5 @@
 import { z } from 'zod';
+import { Side } from '../common/schema';
 import { Connector } from '../connector';
 import { InstrumentTradeability, InstrumentId } from '../instrument';
 
@@ -16,12 +17,16 @@ const Market = z.object({
   tradeability: InstrumentTradeability,
   updatedAt: z.number()
 });
+const BasketMarketLeg = z.object({
+  id: InstrumentId,
+  symbol: z.string().min(1),
+  side: Side
+});
 const BasketMarket = z.object({
   connector: Connector,
   basketKey: z.string(),
   displaySymbol: z.string(),
-  longInstrumentIds: z.array(InstrumentId),
-  shortInstrumentIds: z.array(InstrumentId),
+  legs: z.array(BasketMarketLeg),
   price: z.string(),
   priceChange24h: z.string(),
   weightRatio: z.string(),
@@ -33,10 +38,15 @@ const BasketMarket = z.object({
   updatedAt: z.number(),
   hasMaterializedStats: z.boolean()
 });
+const MarketBasketPositionCounts = z.object({
+  basketKey: z.string(),
+  opened: z.number(),
+  traders: z.number()
+});
 const MarketTotals = z.object({
   markets: z.number(),
   volume24h: z.string(),
   openInterest: z.string()
 });
 
-export { BasketMarket, Market, MarketTotals };
+export { BasketMarket, Market, MarketBasketPositionCounts, MarketTotals };

package/dist/market/index.d.ts

@@ -1,3 +1,4 @@
 export * from './entities';
+export * from './payloads';
 export * from './queries';
 export * from './responses';

package/dist/market/index.js

@@ -1,3 +1,4 @@
 export * from './entities';
+export * from './payloads';
 export * from './queries';
 export * from './responses';

package/dist/market/payloads.d.ts

@@ -0,0 +1,22 @@
+import { z } from 'zod';
+export declare const MARKET_BASKET_POSITION_COUNTS_MAX_BASKETS = 500;
+/**
+ * Count the positions that hold each of these baskets, named by their canonical keys.
+ *
+ * A key spells instrument ids, so it is venue-specific wherever venues name the same
+ * asset differently; counts are summed over the connectors in scope that stored the
+ * key. An absent `connector` puts every venue in scope; an empty list is rejected
+ * rather than read as one, since it states no venue at all.
+ */
+export declare const MarketBasketPositionCountsPayload: z.ZodObject<{
+    connector: z.ZodOptional<z.ZodArray<z.ZodEnum<{
+        hyperliquid: "hyperliquid";
+        binance: "binance";
+        bybit: "bybit";
+        okx: "okx";
+        lighter: "lighter";
+    }>>>;
+    basketKeys: z.ZodArray<z.ZodString>;
+}, z.core.$strip>;
+export type MarketBasketPositionCountsPayloadInput = z.input<typeof MarketBasketPositionCountsPayload>;
+export type MarketBasketPositionCountsPayload = z.output<typeof MarketBasketPositionCountsPayload>;

package/dist/market/payloads.js

@@ -0,0 +1,11 @@
+import { z } from 'zod';
+import { Connector } from '../connector';
+
+const MARKET_BASKET_POSITION_COUNTS_MAX_BASKETS = 500;
+const BasketKey = z.string().regex(/^[0-9a-f]{64}$/, "A basket key is 64 lowercase hex characters \u2014 see deriveBasketKey in @pear-protocol/utils");
+const MarketBasketPositionCountsPayload = z.object({
+  connector: z.array(Connector).min(1, "Name at least one connector, or omit the field for every venue").optional().describe("Absent means every connector, summed"),
+  basketKeys: z.array(BasketKey).min(1, "At least one basket key is required").max(MARKET_BASKET_POSITION_COUNTS_MAX_BASKETS, "Too many basket keys in one request").describe("Canonical basket keys, as /markets/baskets reports them")
+});
+
+export { MARKET_BASKET_POSITION_COUNTS_MAX_BASKETS, MarketBasketPositionCountsPayload };

package/dist/market/responses.d.ts

@@ -48,8 +48,14 @@ export declare const MarketBasketsResponse: z.ZodObject<{
         }>;
         basketKey: z.ZodString;
         displaySymbol: z.ZodString;
-        longInstrumentIds: z.ZodArray<z.ZodString>;
-        shortInstrumentIds: z.ZodArray<z.ZodString>;
+        legs: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            symbol: z.ZodString;
+            side: z.ZodEnum<{
+                BUY: "BUY";
+                SELL: "SELL";
+            }>;
+        }, z.core.$strip>>;
         price: z.ZodString;
         priceChange24h: z.ZodString;
         weightRatio: z.ZodString;
@@ -70,3 +76,11 @@ export declare const MarketBasketsResponse: z.ZodObject<{
     }, z.core.$strip>>;
 }, z.core.$strip>;
 export type MarketBasketsResponse = z.output<typeof MarketBasketsResponse>;
+export declare const MarketBasketPositionCountsResponse: z.ZodObject<{
+    counts: z.ZodArray<z.ZodObject<{
+        basketKey: z.ZodString;
+        opened: z.ZodNumber;
+        traders: z.ZodNumber;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type MarketBasketPositionCountsResponse = z.output<typeof MarketBasketPositionCountsResponse>;

package/dist/market/responses.js

@@ -1,5 +1,5 @@
 import { z } from 'zod';
-import { MarketTotals, Market, BasketMarket } from './entities';
+import { MarketTotals, Market, BasketMarket, MarketBasketPositionCounts } from './entities';
 
 const MarketsResponse = z.object({
   markets: z.array(Market),
@@ -11,5 +11,8 @@ const MarketBasketsResponse = z.object({
   count: z.number(),
   markets: z.array(BasketMarket)
 });
+const MarketBasketPositionCountsResponse = z.object({
+  counts: z.array(MarketBasketPositionCounts)
+});
 
-export { MarketBasketsResponse, MarketsResponse };
+export { MarketBasketPositionCountsResponse, MarketBasketsResponse, MarketsResponse };