@stryke-xyz/premarket-sdk 1.1.4 → 1.1.7

package/dist/cjs/api/orderbook-api/deserializers.js

@@ -98,15 +98,17 @@ function _object_spread_props(target, source) {
  * Note: Most endpoints now return pre-formatted string values,
  * so minimal deserialization is needed. These helpers are provided
  * for cases where BigInt conversion is preferred on the client side.
- */ function parseOptionalBigInt(value) {
+ */ /** @deprecated Use `instruments` instead. */ function parseOptionalBigInt(value) {
     return value == null ? null : BigInt(value);
 }
 function parseIsCall(value) {
     return value === true || value === 1;
 }
 function submarketToBigInt(submarket) {
+    var _submarket_marketId;
     return {
         id: submarket.id,
+        marketId: (_submarket_marketId = submarket.marketId) !== null && _submarket_marketId !== void 0 ? _submarket_marketId : submarket.id,
         name: submarket.name,
         tokenAddress: submarket.tokenAddress,
         tokenDecimals: submarket.tokenDecimals,
@@ -148,6 +150,7 @@ function submarketToBigInt(submarket) {
 /**
  * Convert string market fields to BigInt while preserving addresses and labels.
  */ function marketToBigInt(market) {
+    var _market_logoUri, _market_hasFinalTick;
     var baseMarket = {
         id: market.id,
         groupId: market.groupId,
@@ -163,14 +166,17 @@ function submarketToBigInt(submarket) {
         collateralToken: market.collateralToken,
         collateralDecimals: market.collateralDecimals,
         maxDecimals: parseOptionalBigInt(market.maxDecimals),
-        marketType: market.marketType
+        marketType: market.marketType,
+        logoUri: (_market_logoUri = market.logoUri) !== null && _market_logoUri !== void 0 ? _market_logoUri : null,
+        hasFinalTick: (_market_hasFinalTick = market.hasFinalTick) !== null && _market_hasFinalTick !== void 0 ? _market_hasFinalTick : false
     };
     if (market.type === "erc20") {
+        var _ref, _market_instruments;
         return _object_spread_props(_object_spread({}, baseMarket), {
             type: "erc20",
             underlying: market.underlying,
             underlyingDecimals: market.underlyingDecimals,
-            submarkets: market.submarkets.map(submarketToBigInt)
+            instruments: ((_ref = (_market_instruments = market.instruments) !== null && _market_instruments !== void 0 ? _market_instruments : market.submarkets) !== null && _ref !== void 0 ? _ref : []).map(submarketToBigInt)
         });
     }
     return _object_spread_props(_object_spread({}, baseMarket), {

package/dist/cjs/api/orderbook-api/index.js

@@ -708,7 +708,9 @@ function _ts_generator(thisArg, body) {
             // USER POSITION & PNL METHODS
             // ============================================================================
             /**
-   * Returns current user positions derived from vault activity.
+   * Returns enriched user positions including market name, instrument name,
+   * logo, collateral info, PnL, and role (isOPrm / isOpen).
+   * Also includes a `grouped` array keyed by market.
    */ function getUserPositions(userAddress) {
                 return _async_to_generator(function() {
                     return _ts_generator(this, function(_state) {
@@ -826,8 +828,9 @@ function _ts_generator(thisArg, body) {
             // HISTORY METHODS
             // ============================================================================
             /**
-   * Returns grouped user history across mint, redeem, unwind, withdraw,
-   * rollover, transfer, fill, and cancel events.
+   * Returns grouped + enriched user history. Every event carries marketName,
+   * instrumentName, logoUri, collateralDecimals, collateralToken, and a `type`
+   * discriminator. The `timeline` field is a flat chronological list of all events.
    */ function getUserHistories(userAddress, opts) {
                 return _async_to_generator(function() {
                     var limit, marketId, tokenId;

package/dist/cjs/package.json

@@ -1 +1 @@
-{"name":"@stryke-xyz/premarket-sdk","version":"1.1.4","type":"commonjs"}
+{"name":"@stryke-xyz/premarket-sdk","version":"1.1.7","type":"commonjs"}

package/dist/cjs/shared/types.js

@@ -25,16 +25,24 @@ Object.defineProperty(exports, "OrderStatus", {
     OrderStatus["CANCELLED"] = "CANCELLED";
     OrderStatus["EXPIRED"] = "EXPIRED";
     return OrderStatus;
-}({})/** If true, amount is in maker's makingAmount units. If false, amount is in maker's takingAmount units. */ /** The amount to pass to Exchange.fillOrder */ /** Whether fillAmount is in maker's makingAmount units (true) or takingAmount units (false) */ /** True if the user-submitted order's `amount` is in maker's makingAmount units. */ /** Set to "awaiting match" when the engine's match tail did not arrive within the API's wait window. */ // ============================================================================
+}({})// Enriched by the order-queue when returning user orders
+/** If true, amount is in maker's makingAmount units. If false, amount is in maker's takingAmount units. */ /** The amount to pass to Exchange.fillOrder */ /** Whether fillAmount is in maker's makingAmount units (true) or takingAmount units (false) */ /** True if the user-submitted order's `amount` is in maker's makingAmount units. */ /** Set to "awaiting match" when the engine's match tail did not arrive within the API's wait window. */ // ============================================================================
 // MARKET TYPES
 // ============================================================================
-// ============================================================================
+/** True when the on-chain FinalTick event has been indexed for this market's current expiry. */ /** Numeric market_id of this sub-market (same as id for standalone, member id for grouped). */ /** Sub-markets / instruments in this ERC20 group. */ /** @deprecated Use `instruments` instead. Kept for backward compatibility. */ // ============================================================================
 // POSITION & PNL TYPES
 // ============================================================================
-/** PnL contribution from limit-order trades */ /** PnL contribution from redemption / exercise settlements */ // ============================================================================
+/** PnL contribution from limit-order trades */ /** PnL contribution from redemption / exercise settlements */ /**
+ * Market/instrument metadata the API attaches to positions and history events.
+ * All fields are optional so existing decoders stay backward-compatible.
+ */ /** Position enriched with market/instrument context returned by /positions. */ /** true when holding > 0 */ /** true = oPRM (outcome position), false = PRM (write/minted) */ /** Flat list sorted by updatedAt desc. */ /** Same positions grouped by market for convenient access. */ // ============================================================================
 // HISTORY TYPES
 // ============================================================================
-/** Net proceeds after fees (profit - fees), as a string */ /** true = ask (maker sells), false = bid (maker buys); from API when available */ /** Recent trade item as returned by getMarketRecentTrades */ // ============================================================================
+/** Net proceeds after fees (profit - fees), as a string */ /** true = ask (maker sells), false = bid (maker buys); from API when available */ /** Recent trade item as returned by getMarketRecentTrades */ /**
+   * All of the above merged and sorted chronologically (newest first).
+   * Each event has a `type` discriminator field.
+   * Populated by /history — may be absent on sub-routes like /history/mints.
+   */ // ============================================================================
 // DEPTH TYPES
 // ============================================================================
 // Note: DepthLevel is exported from sync/clients/order-client.ts

package/dist/esm/api/orderbook-api/deserializers.js

@@ -56,15 +56,17 @@ function _object_spread_props(target, source) {
  * Note: Most endpoints now return pre-formatted string values,
  * so minimal deserialization is needed. These helpers are provided
  * for cases where BigInt conversion is preferred on the client side.
- */ function parseOptionalBigInt(value) {
+ */ /** @deprecated Use `instruments` instead. */ function parseOptionalBigInt(value) {
     return value == null ? null : BigInt(value);
 }
 function parseIsCall(value) {
     return value === true || value === 1;
 }
 function submarketToBigInt(submarket) {
+    var _submarket_marketId;
     return {
         id: submarket.id,
+        marketId: (_submarket_marketId = submarket.marketId) !== null && _submarket_marketId !== void 0 ? _submarket_marketId : submarket.id,
         name: submarket.name,
         tokenAddress: submarket.tokenAddress,
         tokenDecimals: submarket.tokenDecimals,
@@ -106,6 +108,7 @@ function submarketToBigInt(submarket) {
 /**
  * Convert string market fields to BigInt while preserving addresses and labels.
  */ export function marketToBigInt(market) {
+    var _market_logoUri, _market_hasFinalTick;
     var baseMarket = {
         id: market.id,
         groupId: market.groupId,
@@ -121,14 +124,17 @@ function submarketToBigInt(submarket) {
         collateralToken: market.collateralToken,
         collateralDecimals: market.collateralDecimals,
         maxDecimals: parseOptionalBigInt(market.maxDecimals),
-        marketType: market.marketType
+        marketType: market.marketType,
+        logoUri: (_market_logoUri = market.logoUri) !== null && _market_logoUri !== void 0 ? _market_logoUri : null,
+        hasFinalTick: (_market_hasFinalTick = market.hasFinalTick) !== null && _market_hasFinalTick !== void 0 ? _market_hasFinalTick : false
     };
     if (market.type === "erc20") {
+        var _ref, _market_instruments;
         return _object_spread_props(_object_spread({}, baseMarket), {
             type: "erc20",
             underlying: market.underlying,
             underlyingDecimals: market.underlyingDecimals,
-            submarkets: market.submarkets.map(submarketToBigInt)
+            instruments: ((_ref = (_market_instruments = market.instruments) !== null && _market_instruments !== void 0 ? _market_instruments : market.submarkets) !== null && _ref !== void 0 ? _ref : []).map(submarketToBigInt)
         });
     }
     return _object_spread_props(_object_spread({}, baseMarket), {

package/dist/esm/api/orderbook-api/index.js

@@ -698,7 +698,9 @@ function _ts_generator(thisArg, body) {
             // USER POSITION & PNL METHODS
             // ============================================================================
             /**
-   * Returns current user positions derived from vault activity.
+   * Returns enriched user positions including market name, instrument name,
+   * logo, collateral info, PnL, and role (isOPrm / isOpen).
+   * Also includes a `grouped` array keyed by market.
    */ function getUserPositions(userAddress) {
                 return _async_to_generator(function() {
                     return _ts_generator(this, function(_state) {
@@ -816,8 +818,9 @@ function _ts_generator(thisArg, body) {
             // HISTORY METHODS
             // ============================================================================
             /**
-   * Returns grouped user history across mint, redeem, unwind, withdraw,
-   * rollover, transfer, fill, and cancel events.
+   * Returns grouped + enriched user history. Every event carries marketName,
+   * instrumentName, logoUri, collateralDecimals, collateralToken, and a `type`
+   * discriminator. The `timeline` field is a flat chronological list of all events.
    */ function getUserHistories(userAddress, opts) {
                 return _async_to_generator(function() {
                     var limit, marketId, tokenId;

package/dist/esm/package.json

@@ -1 +1 @@
-{"name":"@stryke-xyz/premarket-sdk","version":"1.1.4","type":"module"}
+{"name":"@stryke-xyz/premarket-sdk","version":"1.1.7","type":"module"}

package/dist/esm/shared/types.js

@@ -15,16 +15,24 @@
     OrderStatus["CANCELLED"] = "CANCELLED";
     OrderStatus["EXPIRED"] = "EXPIRED";
     return OrderStatus;
-}({})/** If true, amount is in maker's makingAmount units. If false, amount is in maker's takingAmount units. */ /** The amount to pass to Exchange.fillOrder */ /** Whether fillAmount is in maker's makingAmount units (true) or takingAmount units (false) */ /** True if the user-submitted order's `amount` is in maker's makingAmount units. */ /** Set to "awaiting match" when the engine's match tail did not arrive within the API's wait window. */ // ============================================================================
+}({})// Enriched by the order-queue when returning user orders
+/** If true, amount is in maker's makingAmount units. If false, amount is in maker's takingAmount units. */ /** The amount to pass to Exchange.fillOrder */ /** Whether fillAmount is in maker's makingAmount units (true) or takingAmount units (false) */ /** True if the user-submitted order's `amount` is in maker's makingAmount units. */ /** Set to "awaiting match" when the engine's match tail did not arrive within the API's wait window. */ // ============================================================================
 // MARKET TYPES
 // ============================================================================
-// ============================================================================
+/** True when the on-chain FinalTick event has been indexed for this market's current expiry. */ /** Numeric market_id of this sub-market (same as id for standalone, member id for grouped). */ /** Sub-markets / instruments in this ERC20 group. */ /** @deprecated Use `instruments` instead. Kept for backward compatibility. */ // ============================================================================
 // POSITION & PNL TYPES
 // ============================================================================
-/** PnL contribution from limit-order trades */ /** PnL contribution from redemption / exercise settlements */ // ============================================================================
+/** PnL contribution from limit-order trades */ /** PnL contribution from redemption / exercise settlements */ /**
+ * Market/instrument metadata the API attaches to positions and history events.
+ * All fields are optional so existing decoders stay backward-compatible.
+ */ /** Position enriched with market/instrument context returned by /positions. */ /** true when holding > 0 */ /** true = oPRM (outcome position), false = PRM (write/minted) */ /** Flat list sorted by updatedAt desc. */ /** Same positions grouped by market for convenient access. */ // ============================================================================
 // HISTORY TYPES
 // ============================================================================
-/** Net proceeds after fees (profit - fees), as a string */ /** true = ask (maker sells), false = bid (maker buys); from API when available */ /** Recent trade item as returned by getMarketRecentTrades */ // ============================================================================
+/** Net proceeds after fees (profit - fees), as a string */ /** true = ask (maker sells), false = bid (maker buys); from API when available */ /** Recent trade item as returned by getMarketRecentTrades */ /**
+   * All of the above merged and sorted chronologically (newest first).
+   * Each event has a `type` discriminator field.
+   * Populated by /history — may be absent on sub-routes like /history/mints.
+   */ // ============================================================================
 // DEPTH TYPES
 // ============================================================================
 // Note: DepthLevel is exported from sync/clients/order-client.ts

package/dist/types/api/orderbook-api/deserializers.d.ts

@@ -50,6 +50,8 @@ export interface BigIntBaseMarket {
     collateralDecimals: number;
     maxDecimals: bigint | null;
     marketType: "ERC20xERC20" | "ERC20xERC6909";
+    logoUri: string | null;
+    hasFinalTick: boolean;
 }
 export interface BigIntErc6909Market extends BigIntBaseMarket {
     type: "erc6909";
@@ -77,6 +79,7 @@ export interface BigIntErc6909Market extends BigIntBaseMarket {
 }
 export interface BigIntErc20Submarket {
     id: string;
+    marketId: string;
     name: string;
     tokenAddress: string;
     tokenDecimals: number;
@@ -88,7 +91,9 @@ export interface BigIntErc20Market extends BigIntBaseMarket {
     type: "erc20";
     underlying: string | null;
     underlyingDecimals: number | null;
-    submarkets: BigIntErc20Submarket[];
+    instruments: BigIntErc20Submarket[];
+    /** @deprecated Use `instruments` instead. */
+    submarkets?: BigIntErc20Submarket[];
 }
 export type BigIntMarket = BigIntErc6909Market | BigIntErc20Market;
 /**

package/dist/types/api/orderbook-api/index.d.ts

@@ -1,5 +1,5 @@
 import { Address, Hex } from "viem";
-import type { StoredOrder, CreateOrderParams, CreateOrderResult, MarketsResponse, MarketResponse, UserPosition, TradingPnL, UserPnL, TokenPnL, Erc20PnL, UserHistories, OrderbookApiConfig, PaginatedOrdersResponse, MarketTradeItem, AuthChallenge } from "../../shared/types.js";
+import type { StoredOrder, CreateOrderParams, CreateOrderResult, MarketsResponse, MarketResponse, TradingPnL, UserPnL, TokenPnL, Erc20PnL, UserHistories, EnrichedPositionsResponse, OrderbookApiConfig, PaginatedOrdersResponse, MarketTradeItem, AuthChallenge } from "../../shared/types.js";
 /**
  * Unified HTTP client for orderbook, market, position, and history endpoints.
  */
@@ -64,9 +64,11 @@ export declare class OrderbookApi {
      */
     getMarket(marketId: string): Promise<MarketResponse["data"] | null>;
     /**
-     * Returns current user positions derived from vault activity.
+     * Returns enriched user positions including market name, instrument name,
+     * logo, collateral info, PnL, and role (isOPrm / isOpen).
+     * Also includes a `grouped` array keyed by market.
      */
-    getUserPositions(userAddress: string): Promise<UserPosition[]>;
+    getUserPositions(userAddress: string): Promise<EnrichedPositionsResponse>;
     /**
      * Returns realized trading PnL for limit-order activity.
      */
@@ -84,8 +86,9 @@ export declare class OrderbookApi {
      */
     getErc20PnL(userAddress: string, tokenAddress: string): Promise<Erc20PnL>;
     /**
-     * Returns grouped user history across mint, redeem, unwind, withdraw,
-     * rollover, transfer, fill, and cancel events.
+     * Returns grouped + enriched user history. Every event carries marketName,
+     * instrumentName, logoUri, collateralDecimals, collateralToken, and a `type`
+     * discriminator. The `timeline` field is a flat chronological list of all events.
      */
     getUserHistories(userAddress: string, opts?: {
         limit?: number;

package/dist/types/shared/types.d.ts

@@ -61,6 +61,9 @@ export interface StoredOrder {
     status: OrderStatus;
     side: "bid" | "ask";
     price: number;
+    marketName?: string;
+    instrumentName?: string;
+    logoUri?: string | null;
 }
 export type MatchableOrder = StoredOrder;
 export interface MatchRequest {
@@ -137,6 +140,9 @@ export interface BaseMarket {
     collateralDecimals: number;
     maxDecimals: string | null;
     marketType: "ERC20xERC20" | "ERC20xERC6909";
+    logoUri: string | null;
+    /** True when the on-chain FinalTick event has been indexed for this market's current expiry. */
+    hasFinalTick: boolean;
 }
 export interface BaseMarketInstrument {
     id: string;
@@ -168,6 +174,8 @@ export interface SpreadMarketInstrument extends BaseMarketInstrument {
 export type MarketInstrument = VanillaMarketInstrument | SpreadMarketInstrument;
 export interface Erc20Submarket {
     id: string;
+    /** Numeric market_id of this sub-market (same as id for standalone, member id for grouped). */
+    marketId: string;
     name: string;
     tokenAddress: string;
     tokenDecimals: number;
@@ -204,7 +212,10 @@ export interface Erc20Market extends BaseMarket {
     type: "erc20";
     underlying: string | null;
     underlyingDecimals: number | null;
-    submarkets: Erc20Submarket[];
+    /** Sub-markets / instruments in this ERC20 group. */
+    instruments: Erc20Submarket[];
+    /** @deprecated Use `instruments` instead. Kept for backward compatibility. */
+    submarkets?: Erc20Submarket[];
 }
 export type ApiMarket = Erc6909Market | Erc20Market;
 export type Market = ApiMarket;
@@ -232,6 +243,45 @@ export interface UserPosition {
     redeemExercisePnl: string;
     updatedAt: string;
 }
+/**
+ * Market/instrument metadata the API attaches to positions and history events.
+ * All fields are optional so existing decoders stay backward-compatible.
+ */
+export interface EventEnrichment {
+    collateralSymbol?: string;
+    marketId?: string | null;
+    marketName?: string;
+    instrumentName?: string;
+    logoUri?: string | null;
+    collateralDecimals?: number;
+    collateralToken?: string;
+}
+/** Position enriched with market/instrument context returned by /positions. */
+export interface EnrichedPosition extends UserPosition, EventEnrichment {
+    /** true when holding > 0 */
+    isOpen: boolean;
+    /** true = oPRM (outcome position), false = PRM (write/minted) */
+    isOPrm: boolean;
+    marketId: string;
+    marketName: string;
+    instrumentName: string;
+    logoUri: string | null;
+    collateralDecimals: number;
+    collateralToken: string;
+}
+export interface EnrichedPositionsResponse {
+    /** Flat list sorted by updatedAt desc. */
+    positions: EnrichedPosition[];
+    /** Same positions grouped by market for convenient access. */
+    grouped: Array<{
+        marketId: string;
+        marketName: string;
+        logoUri: string | null;
+        collateralDecimals: number;
+        collateralToken: string;
+        positions: EnrichedPosition[];
+    }>;
+}
 export interface TradingPnL {
     id: string;
     asset: `0x${string}`;
@@ -274,7 +324,7 @@ export interface Erc20PnL {
     trading: TradingPnL | null;
     totalPnl: string;
 }
-export interface MintHistoryItem {
+export interface MintHistoryItem extends EventEnrichment {
     id: string;
     marketId: string;
     prmTokenId: string;
@@ -289,8 +339,9 @@ export interface MintHistoryItem {
     transactionHash: `0x${string}`;
     blockNumber: string;
     timestamp: string;
+    type?: "mint";
 }
-export interface RedeemHistoryItem {
+export interface RedeemHistoryItem extends EventEnrichment {
     id: string;
     oPrmTokenId: string;
     prmTokenId: string;
@@ -304,8 +355,9 @@ export interface RedeemHistoryItem {
     transactionHash: `0x${string}`;
     blockNumber: string;
     timestamp: string;
+    type?: "redeem";
 }
-export interface UnwindHistoryItem {
+export interface UnwindHistoryItem extends EventEnrichment {
     id: string;
     marketId: string;
     prmTokenId: string;
@@ -320,8 +372,9 @@ export interface UnwindHistoryItem {
     transactionHash: `0x${string}`;
     blockNumber: string;
     timestamp: string;
+    type?: "unwind";
 }
-export interface TransferHistoryItem {
+export interface TransferHistoryItem extends EventEnrichment {
     id: string;
     vaultId: string;
     caller: `0x${string}`;
@@ -333,8 +386,9 @@ export interface TransferHistoryItem {
     transactionHash: `0x${string}`;
     blockNumber: string;
     timestamp: string;
+    type?: "transfer";
 }
-export interface OrderFillHistoryItem {
+export interface OrderFillHistoryItem extends EventEnrichment {
     id: string;
     orderHash: `0x${string}`;
     maker: `0x${string}`;
@@ -353,10 +407,11 @@ export interface OrderFillHistoryItem {
     timestamp: string;
     /** true = ask (maker sells), false = bid (maker buys); from API when available */
     isAsk?: boolean;
+    type?: "fill";
 }
 /** Recent trade item as returned by getMarketRecentTrades */
 export type MarketTradeItem = OrderFillHistoryItem;
-export interface WithdrawHistoryItem {
+export interface WithdrawHistoryItem extends EventEnrichment {
     id: string;
     marketId: string;
     prmTokenId: string;
@@ -370,8 +425,9 @@ export interface WithdrawHistoryItem {
     transactionHash: `0x${string}`;
     blockNumber: string;
     timestamp: string;
+    type?: "withdraw";
 }
-export interface RolloverHistoryItem {
+export interface RolloverHistoryItem extends EventEnrichment {
     id: string;
     marketId: string;
     oldMarketId: string | null;
@@ -390,8 +446,9 @@ export interface RolloverHistoryItem {
     transactionHash: `0x${string}`;
     blockNumber: string;
     timestamp: string;
+    type?: "rollover";
 }
-export interface OrderCancelHistoryItem {
+export interface OrderCancelHistoryItem extends EventEnrichment {
     id: string;
     marketId: string;
     tokenId: string;
@@ -400,7 +457,9 @@ export interface OrderCancelHistoryItem {
     transactionHash: `0x${string}`;
     blockNumber: string;
     timestamp: string;
+    type?: "cancel";
 }
+export type AnyHistoryEvent = MintHistoryItem | RedeemHistoryItem | UnwindHistoryItem | WithdrawHistoryItem | RolloverHistoryItem | TransferHistoryItem | OrderFillHistoryItem | OrderCancelHistoryItem;
 export interface UserHistories {
     mints: MintHistoryItem[];
     redeems: RedeemHistoryItem[];
@@ -410,6 +469,12 @@ export interface UserHistories {
     transfers: TransferHistoryItem[];
     fills: OrderFillHistoryItem[];
     cancels: OrderCancelHistoryItem[];
+    /**
+     * All of the above merged and sorted chronologically (newest first).
+     * Each event has a `type` discriminator field.
+     * Populated by /history — may be absent on sub-routes like /history/mints.
+     */
+    timeline?: AnyHistoryEvent[];
 }
 export interface PaginatedOrdersResponse {
     orders: StoredOrder[];

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@stryke-xyz/premarket-sdk",
-	"version": "1.1.4",
+	"version": "1.1.7",
 	"type": "module",
 	"module": "dist/esm/index.js",
 	"main": "dist/cjs/index.js",