@lifi/perps-types 4.0.0 → 4.1.0

package/dist/types/enums.d.ts

@@ -1,4 +1,8 @@
-/** @public */
+/**
+ * Numeric error codes returned by the perps API.
+ *
+ * @public
+ */
 export declare enum PerpsErrorCode {
     DefaultError = 2000,
     ServerError = 2001,
@@ -24,12 +28,12 @@ export declare enum PerpsErrorCode {
     PayloadMismatch = 2050,
     RouteNotFound = 2060
 }
-/** @public */
+/** Side of an order or execution, using provider wire values. @public */
 export declare enum OrderSide {
     BUY = "BUY",
     SELL = "SELL"
 }
-/** @public */
+/** Supported regular and trigger order kinds, using provider wire values. @public */
 export declare enum OrderType {
     MARKET = "MARKET",
     LIMIT = "LIMIT",
@@ -39,12 +43,12 @@ export declare enum OrderType {
     TAKE_PROFIT_LIMIT = "TAKE_PROFIT_LIMIT",
     TRIGGER_ONLY = "TRIGGER_ONLY"
 }
-/** @public */
+/** Direction of an open position. @public */
 export declare enum PositionSide {
     LONG = "LONG",
     SHORT = "SHORT"
 }
-/** @public */
+/** Margin allocation mode for a position. @public */
 export declare enum MarginMode {
     ISOLATED = "ISOLATED",
     CROSS = "CROSS"
@@ -58,14 +62,14 @@ export declare enum PositionMarginAdjustment {
     /** Margin can be added and removed. */
     ADD_AND_REMOVE = "ADD_AND_REMOVE"
 }
-/** @public */
+/** Provider order time-in-force policies. @public */
 export declare enum TimeInForce {
     GTC = "GTC",
     IOC = "IOC",
     POST_ONLY = "POST_ONLY",
     GTT = "GTT"
 }
-/** @public */
+/** Lifecycle status of a provider order. @public */
 export declare enum OrderStatus {
     PENDING = "PENDING",
     OPEN = "OPEN",
@@ -76,19 +80,24 @@ export declare enum OrderStatus {
     EXPIRED = "EXPIRED",
     TRIGGERED = "TRIGGERED"
 }
-/** @public */
+/** Lifecycle status of an execution/fill. @public */
 export declare enum FillStatus {
     FILLED = "FILLED",
     PARTIALLY_FILLED = "PARTIALLY_FILLED",
     CANCELLED = "CANCELLED",
     REJECTED = "REJECTED"
 }
-/** @public */
+/** Whether a fill supplied maker or taker liquidity. @public */
 export declare enum LiquidityRole {
     MAKER = "maker",
     TAKER = "taker"
 }
-/** @public */
+/**
+ * Action identifiers used in setup, create-action, and execute-action
+ * requests. Values are the backend wire strings.
+ *
+ * @public
+ */
 export declare enum ActionType {
     APPROVE_AGENT = "approveAgent",
     APPROVE_BUILDER_FEE = "approveBuilderFee",
@@ -119,23 +128,23 @@ export declare enum ActionType {
     /** Provider-independent: sent with the `META_PROVIDER` sentinel, not a real provider key. */
     META_ACCEPT_TERMS = "metaAcceptTerms"
 }
-/** @public */
+/** Price relation that activates a trigger order. @public */
 export declare enum TriggerCondition {
     ABOVE = "ABOVE",
     BELOW = "BELOW"
 }
-/** @public */
+/** Take-profit or stop-loss trigger order classification. @public */
 export declare enum TriggerOrderType {
     TAKE_PROFIT = "TAKE_PROFIT",
     STOP_LOSS = "STOP_LOSS"
 }
-/** @public */
+/** Lifecycle status of a trigger order. @public */
 export declare enum TriggerOrderStatus {
     WAITING = "WAITING",
     TRIGGERED = "TRIGGERED",
     CANCELLED = "CANCELLED"
 }
-/** @public */
+/** Account activity record categories. @public */
 export declare enum ActivityType {
     DEPOSIT = "DEPOSIT",
     WITHDRAWAL = "WITHDRAWAL",
@@ -143,7 +152,7 @@ export declare enum ActivityType {
     FUNDING = "FUNDING",
     TRANSFER = "TRANSFER"
 }
-/** @public */
+/** Human-readable classification of how a fill changed a position. @public */
 export declare enum FillClassification {
     OPENED_LONG = "Opened Long",
     OPENED_SHORT = "Opened Short",
@@ -158,21 +167,21 @@ export declare enum FillClassification {
     SPOT_BUY = "Spot Buy",
     SPOT_SELL = "Spot Sell"
 }
-/** @public */
+/** Classification emitted for a liquidation activity. @public */
 export declare enum LiquidationClassification {
     LIQUIDATED = "Liquidated"
 }
-/** @public */
+/** Classification emitted for a funding activity. @public */
 export declare enum FundingClassification {
     FUNDING = "Funding"
 }
-/** @public */
+/** Classification emitted for an inbound, outbound, or internal transfer. @public */
 export declare enum TransferClassification {
     DEPOSIT = "Deposit",
     WITHDRAWAL = "Withdrawal",
     TRANSFER = "Transfer"
 }
-/** @public */
+/** Union of classifications emitted by all activity record categories. @public */
 export type ActivityClassification = FillClassification | LiquidationClassification | FundingClassification | TransferClassification;
 /**
  * Who completes signing for an action.
@@ -187,7 +196,12 @@ export declare enum PerpsSigner {
     USER = "USER",
     SDK = "SDK"
 }
-/** @public */
+/**
+ * Signing mechanisms supported by action steps. Values are serialized in
+ * provider metadata and action responses.
+ *
+ * @public
+ */
 export declare enum SigningMethod {
     EIP712 = "eip712",
     WASM_BLOB = "wasmBlob",

package/dist/types/enums.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"enums.d.ts","sourceRoot":"","sources":["../../src/enums.ts"],"names":[],"mappings":"AAAA,cAAc;AACd,oBAAY,cAAc;IAExB,YAAY,OAAO;IACnB,WAAW,OAAO;IAClB,eAAe,OAAO;IACtB,YAAY,OAAO;IACnB,eAAe,OAAO;IACtB,QAAQ,OAAO;IAGf,gBAAgB,OAAO;IACvB,iBAAiB,OAAO;IACxB,gBAAgB,OAAO;IACvB,8EAA8E;IAC9E,YAAY,OAAO;IAGnB,gBAAgB,OAAO;IACvB,kBAAkB,OAAO;IACzB,mBAAmB,OAAO;IAC1B,cAAc,OAAO;IACrB,aAAa,OAAO;IACpB,gBAAgB,OAAO;IACvB,eAAe,OAAO;IAGtB,YAAY,OAAO;IACnB,gBAAgB,OAAO;IACvB,YAAY,OAAO;IAGnB,eAAe,OAAO;IAGtB,aAAa,OAAO;CACrB;AAED,cAAc;AACd,oBAAY,SAAS;IACnB,GAAG,QAAQ;IACX,IAAI,SAAS;CACd;AAED,cAAc;AACd,oBAAY,SAAS;IACnB,MAAM,WAAW;IACjB,KAAK,UAAU;IACf,WAAW,gBAAgB;IAC3B,UAAU,eAAe;IACzB,kBAAkB,uBAAuB;IACzC,iBAAiB,sBAAsB;IACvC,YAAY,iBAAiB;CAC9B;AAED,cAAc;AACd,oBAAY,YAAY;IACtB,IAAI,SAAS;IACb,KAAK,UAAU;CAChB;AAED,cAAc;AACd,oBAAY,UAAU;IACpB,QAAQ,aAAa;IACrB,KAAK,UAAU;CAChB;AAED,mFAAmF;AACnF,oBAAY,wBAAwB;IAClC,4DAA4D;IAC5D,IAAI,SAAS;IACb,iDAAiD;IACjD,QAAQ,aAAa;IACrB,uCAAuC;IACvC,cAAc,mBAAmB;CAClC;AAED,cAAc;AACd,oBAAY,WAAW;IACrB,GAAG,QAAQ;IACX,GAAG,QAAQ;IACX,SAAS,cAAc;IACvB,GAAG,QAAQ;CACZ;AAED,cAAc;AACd,oBAAY,WAAW;IACrB,OAAO,YAAY;IACnB,IAAI,SAAS;IACb,gBAAgB,qBAAqB;IACrC,MAAM,WAAW;IACjB,SAAS,cAAc;IACvB,QAAQ,aAAa;IACrB,OAAO,YAAY;IACnB,SAAS,cAAc;CACxB;AAED,cAAc;AACd,oBAAY,UAAU;IACpB,MAAM,WAAW;IACjB,gBAAgB,qBAAqB;IACrC,SAAS,cAAc;IACvB,QAAQ,aAAa;CACtB;AAED,cAAc;AACd,oBAAY,aAAa;IACvB,KAAK,UAAU;IACf,KAAK,UAAU;CAChB;AAED,cAAc;AACd,oBAAY,UAAU;IACpB,aAAa,iBAAiB;IAC9B,mBAAmB,sBAAsB;IACzC,kBAAkB,sBAAsB;IACxC,YAAY,gBAAgB;IAC5B,YAAY,gBAAgB;IAC5B,YAAY,gBAAgB;IAC5B,UAAU,cAAc;IACxB,UAAU,eAAe;IACzB,QAAQ,aAAa;IACrB,WAAW,eAAe;IAC1B,mBAAmB,sBAAsB;IACzC,YAAY,gBAAgB;IAC5B,iBAAiB,oBAAoB;IACrC,YAAY,gBAAgB;IAC5B,eAAe,mBAAmB;IAClC,sBAAsB,yBAAyB;IAC/C,uBAAuB,0BAA0B;IACjD,gBAAgB,mBAAmB;IACnC,uBAAuB,yBAAyB;IAChD,UAAU,cAAc;IACxB,sBAAsB,yBAAyB;IAC/C,sLAAsL;IACtL,qBAAqB,wBAAwB;IAC7C,OAAO,YAAY;IACnB,6FAA6F;IAC7F,SAAS,aAAa;IACtB,6FAA6F;IAC7F,iBAAiB,oBAAoB;CACtC;AAED,cAAc;AACd,oBAAY,gBAAgB;IAC1B,KAAK,UAAU;IACf,KAAK,UAAU;CAChB;AAED,cAAc;AACd,oBAAY,gBAAgB;IAC1B,WAAW,gBAAgB;IAC3B,SAAS,cAAc;CACxB;AAED,cAAc;AACd,oBAAY,kBAAkB;IAC5B,OAAO,YAAY;IACnB,SAAS,cAAc;IACvB,SAAS,cAAc;CACxB;AAED,cAAc;AACd,oBAAY,YAAY;IACtB,OAAO,YAAY;IACnB,UAAU,eAAe;IACzB,WAAW,gBAAgB;IAC3B,OAAO,YAAY;IACnB,QAAQ,aAAa;CACtB;AAED,cAAc;AACd,oBAAY,kBAAkB;IAC5B,WAAW,gBAAgB;IAC3B,YAAY,iBAAiB;IAC7B,cAAc,mBAAmB;IACjC,eAAe,oBAAoB;IACnC,YAAY,iBAAiB;IAC7B,aAAa,kBAAkB;IAC/B,WAAW,gBAAgB;IAC3B,YAAY,iBAAiB;IAC7B,aAAa,kBAAkB;IAC/B,cAAc,mBAAmB;IACjC,QAAQ,aAAa;IACrB,SAAS,cAAc;CACxB;AAED,cAAc;AACd,oBAAY,yBAAyB;IACnC,UAAU,eAAe;CAC1B;AAED,cAAc;AACd,oBAAY,qBAAqB;IAC/B,OAAO,YAAY;CACpB;AAED,cAAc;AACd,oBAAY,sBAAsB;IAChC,OAAO,YAAY;IACnB,UAAU,eAAe;IACzB,QAAQ,aAAa;CACtB;AAED,cAAc;AACd,MAAM,MAAM,sBAAsB,GAC9B,kBAAkB,GAClB,yBAAyB,GACzB,qBAAqB,GACrB,sBAAsB,CAAA;AAE1B;;;;;;;;GAQG;AACH,oBAAY,WAAW;IACrB,IAAI,SAAS;IACb,GAAG,QAAQ;CACZ;AAED,cAAc;AACd,oBAAY,aAAa;IACvB,MAAM,WAAW;IACjB,SAAS,aAAa;IACtB,MAAM,UAAU;IAChB,sIAAsI;IACtI,IAAI,SAAS;IACb,qEAAqE;IACrE,IAAI,SAAS;IACb,gJAAgJ;IAChJ,OAAO,YAAY;CACpB"}
+{"version":3,"file":"enums.d.ts","sourceRoot":"","sources":["../../src/enums.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,oBAAY,cAAc;IAExB,YAAY,OAAO;IACnB,WAAW,OAAO;IAClB,eAAe,OAAO;IACtB,YAAY,OAAO;IACnB,eAAe,OAAO;IACtB,QAAQ,OAAO;IAGf,gBAAgB,OAAO;IACvB,iBAAiB,OAAO;IACxB,gBAAgB,OAAO;IACvB,8EAA8E;IAC9E,YAAY,OAAO;IAGnB,gBAAgB,OAAO;IACvB,kBAAkB,OAAO;IACzB,mBAAmB,OAAO;IAC1B,cAAc,OAAO;IACrB,aAAa,OAAO;IACpB,gBAAgB,OAAO;IACvB,eAAe,OAAO;IAGtB,YAAY,OAAO;IACnB,gBAAgB,OAAO;IACvB,YAAY,OAAO;IAGnB,eAAe,OAAO;IAGtB,aAAa,OAAO;CACrB;AAED,yEAAyE;AACzE,oBAAY,SAAS;IACnB,GAAG,QAAQ;IACX,IAAI,SAAS;CACd;AAED,qFAAqF;AACrF,oBAAY,SAAS;IACnB,MAAM,WAAW;IACjB,KAAK,UAAU;IACf,WAAW,gBAAgB;IAC3B,UAAU,eAAe;IACzB,kBAAkB,uBAAuB;IACzC,iBAAiB,sBAAsB;IACvC,YAAY,iBAAiB;CAC9B;AAED,6CAA6C;AAC7C,oBAAY,YAAY;IACtB,IAAI,SAAS;IACb,KAAK,UAAU;CAChB;AAED,qDAAqD;AACrD,oBAAY,UAAU;IACpB,QAAQ,aAAa;IACrB,KAAK,UAAU;CAChB;AAED,mFAAmF;AACnF,oBAAY,wBAAwB;IAClC,4DAA4D;IAC5D,IAAI,SAAS;IACb,iDAAiD;IACjD,QAAQ,aAAa;IACrB,uCAAuC;IACvC,cAAc,mBAAmB;CAClC;AAED,qDAAqD;AACrD,oBAAY,WAAW;IACrB,GAAG,QAAQ;IACX,GAAG,QAAQ;IACX,SAAS,cAAc;IACvB,GAAG,QAAQ;CACZ;AAED,oDAAoD;AACpD,oBAAY,WAAW;IACrB,OAAO,YAAY;IACnB,IAAI,SAAS;IACb,gBAAgB,qBAAqB;IACrC,MAAM,WAAW;IACjB,SAAS,cAAc;IACvB,QAAQ,aAAa;IACrB,OAAO,YAAY;IACnB,SAAS,cAAc;CACxB;AAED,qDAAqD;AACrD,oBAAY,UAAU;IACpB,MAAM,WAAW;IACjB,gBAAgB,qBAAqB;IACrC,SAAS,cAAc;IACvB,QAAQ,aAAa;CACtB;AAED,gEAAgE;AAChE,oBAAY,aAAa;IACvB,KAAK,UAAU;IACf,KAAK,UAAU;CAChB;AAED;;;;;GAKG;AACH,oBAAY,UAAU;IACpB,aAAa,iBAAiB;IAC9B,mBAAmB,sBAAsB;IACzC,kBAAkB,sBAAsB;IACxC,YAAY,gBAAgB;IAC5B,YAAY,gBAAgB;IAC5B,YAAY,gBAAgB;IAC5B,UAAU,cAAc;IACxB,UAAU,eAAe;IACzB,QAAQ,aAAa;IACrB,WAAW,eAAe;IAC1B,mBAAmB,sBAAsB;IACzC,YAAY,gBAAgB;IAC5B,iBAAiB,oBAAoB;IACrC,YAAY,gBAAgB;IAC5B,eAAe,mBAAmB;IAClC,sBAAsB,yBAAyB;IAC/C,uBAAuB,0BAA0B;IACjD,gBAAgB,mBAAmB;IACnC,uBAAuB,yBAAyB;IAChD,UAAU,cAAc;IACxB,sBAAsB,yBAAyB;IAC/C,sLAAsL;IACtL,qBAAqB,wBAAwB;IAC7C,OAAO,YAAY;IACnB,6FAA6F;IAC7F,SAAS,aAAa;IACtB,6FAA6F;IAC7F,iBAAiB,oBAAoB;CACtC;AAED,6DAA6D;AAC7D,oBAAY,gBAAgB;IAC1B,KAAK,UAAU;IACf,KAAK,UAAU;CAChB;AAED,qEAAqE;AACrE,oBAAY,gBAAgB;IAC1B,WAAW,gBAAgB;IAC3B,SAAS,cAAc;CACxB;AAED,mDAAmD;AACnD,oBAAY,kBAAkB;IAC5B,OAAO,YAAY;IACnB,SAAS,cAAc;IACvB,SAAS,cAAc;CACxB;AAED,kDAAkD;AAClD,oBAAY,YAAY;IACtB,OAAO,YAAY;IACnB,UAAU,eAAe;IACzB,WAAW,gBAAgB;IAC3B,OAAO,YAAY;IACnB,QAAQ,aAAa;CACtB;AAED,8EAA8E;AAC9E,oBAAY,kBAAkB;IAC5B,WAAW,gBAAgB;IAC3B,YAAY,iBAAiB;IAC7B,cAAc,mBAAmB;IACjC,eAAe,oBAAoB;IACnC,YAAY,iBAAiB;IAC7B,aAAa,kBAAkB;IAC/B,WAAW,gBAAgB;IAC3B,YAAY,iBAAiB;IAC7B,aAAa,kBAAkB;IAC/B,cAAc,mBAAmB;IACjC,QAAQ,aAAa;IACrB,SAAS,cAAc;CACxB;AAED,iEAAiE;AACjE,oBAAY,yBAAyB;IACnC,UAAU,eAAe;CAC1B;AAED,6DAA6D;AAC7D,oBAAY,qBAAqB;IAC/B,OAAO,YAAY;CACpB;AAED,qFAAqF;AACrF,oBAAY,sBAAsB;IAChC,OAAO,YAAY;IACnB,UAAU,eAAe;IACzB,QAAQ,aAAa;CACtB;AAED,kFAAkF;AAClF,MAAM,MAAM,sBAAsB,GAC9B,kBAAkB,GAClB,yBAAyB,GACzB,qBAAqB,GACrB,sBAAsB,CAAA;AAE1B;;;;;;;;GAQG;AACH,oBAAY,WAAW;IACrB,IAAI,SAAS;IACb,GAAG,QAAQ;CACZ;AAED;;;;;GAKG;AACH,oBAAY,aAAa;IACvB,MAAM,WAAW;IACjB,SAAS,aAAa;IACtB,MAAM,UAAU;IAChB,sIAAsI;IACtI,IAAI,SAAS;IACb,qEAAqE;IACrE,IAAI,SAAS;IACb,gJAAgJ;IAChJ,OAAO,YAAY;CACpB"}

package/dist/types/errors.d.ts

@@ -1,5 +1,10 @@
 import type { PerpsErrorCode } from './enums.js';
-/** @public */
+/**
+ * Structured perps API error payload. `code` is the stable classification;
+ * `tool` identifies the backend tool when the provider supplies one.
+ *
+ * @public
+ */
 export interface PerpsErrorBody {
     code: PerpsErrorCode;
     tool?: string;

package/dist/types/errors.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/errors.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA;AAEhD,cAAc;AACd,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,cAAc,CAAA;IACpB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,MAAM,CAAA;CAChB"}
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/errors.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA;AAEhD;;;;;GAKG;AACH,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,cAAc,CAAA;IACpB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,MAAM,CAAA;CAChB"}

package/dist/types/index.d.ts

@@ -14,6 +14,7 @@ export * from './enums.js';
 export * from './errors.js';
 export * from './market.js';
 export * from './meta.js';
+export * from './positionMargin.js';
 export * from './primitives.js';
 export * from './providers.js';
 export * from './quote.js';

package/dist/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,cAAc,kBAAkB,CAAA;AAChC,cAAc,cAAc,CAAA;AAC5B,cAAc,aAAa,CAAA;AAC3B,cAAc,YAAY,CAAA;AAC1B,cAAc,YAAY,CAAA;AAC1B,cAAc,aAAa,CAAA;AAC3B,cAAc,aAAa,CAAA;AAC3B,cAAc,WAAW,CAAA;AACzB,cAAc,iBAAiB,CAAA;AAC/B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,YAAY,CAAA;AAC1B,cAAc,oBAAoB,CAAA;AAClC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,WAAW,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,cAAc,kBAAkB,CAAA;AAChC,cAAc,cAAc,CAAA;AAC5B,cAAc,aAAa,CAAA;AAC3B,cAAc,YAAY,CAAA;AAC1B,cAAc,YAAY,CAAA;AAC1B,cAAc,aAAa,CAAA;AAC3B,cAAc,aAAa,CAAA;AAC3B,cAAc,WAAW,CAAA;AACzB,cAAc,qBAAqB,CAAA;AACnC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,YAAY,CAAA;AAC1B,cAAc,oBAAoB,CAAA;AAClC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,WAAW,CAAA"}

package/dist/types/market.d.ts

@@ -1,21 +1,32 @@
 import type { Asset } from './asset.js';
 import type { PositionMarginAdjustment } from './enums.js';
-/** @public */
+/**
+ * Current funding rate and next funding timestamp for a perpetual market.
+ * `rate` is a decimal fraction; `nextFundingTime` is Unix milliseconds.
+ *
+ * @public
+ */
 export interface FundingInfo {
+    /** Funding rate as a decimal fraction. */
     rate: string;
+    /** Next funding timestamp in Unix milliseconds. */
     nextFundingTime: number;
 }
-/** @public */
+/**
+ * Shared market metadata for perpetual and spot instruments.
+ *
+ * @public
+ */
 export interface BaseMarket {
     providerId: string;
     /** Opaque provider market id; referenced elsewhere as `marketId`. */
     id: string;
-    /** Whether the venue has delisted this market. */
     isDelisted?: boolean;
     /** References a {@link ProviderCategory} by id. */
     categoryId: string;
     baseAsset: Asset;
     quoteAsset: Asset;
+    /** Maximum fractional precision accepted for order sizes. */
     szDecimals: number;
     /**
      * Maximum decimal places the venue accepts for order prices on this market.
@@ -39,7 +50,11 @@ export interface BaseMarket {
      */
     sizeIncrement?: string;
 }
-/** @public */
+/**
+ * Perpetual market metadata, including leverage and margin constraints.
+ *
+ * @public
+ */
 export interface PerpsMarket extends BaseMarket {
     maxLeverage: number;
     onlyIsolated: boolean;
@@ -59,9 +74,14 @@ export interface PerpsMarket extends BaseMarket {
 export interface SpotMarket extends BaseMarket {
     positionMarginAdjustment?: never;
 }
-/** @public */
+/** Union of perpetual and spot market representations. @public */
 export type Market = PerpsMarket | SpotMarket;
-/** @public */
+/**
+ * UI-safe market projection containing identity, category, assets, and
+ * delisting state without provider-specific trading constraints.
+ *
+ * @public
+ */
 export type MarketDisplay = Pick<BaseMarket, 'providerId' | 'id' | 'categoryId' | 'baseAsset' | 'quoteAsset' | 'isDelisted'>;
 /** Perpetual-market identity embedded on an open {@link Position}. @public */
 export type PerpsMarketDisplay = Pick<PerpsMarket, 'providerId' | 'id' | 'categoryId' | 'baseAsset' | 'quoteAsset' | 'isDelisted' | 'positionMarginAdjustment'>;
@@ -75,7 +95,7 @@ export interface MarketRef {
     marketId: string;
     categoryId: string;
 }
-/** @public */
+/** Response containing all markets returned for a provider. @public */
 export interface MarketsResponse {
     markets: Market[];
 }
@@ -89,8 +109,11 @@ export interface MarketsResponse {
  * @public
  */
 export interface MarketContext {
+    /** Opaque provider market identifier for this context frame. */
     marketId: string;
+    /** Current order-book midpoint, as a decimal quote string. */
     midPrice: string;
+    /** Provider mark price, as a decimal quote string. */
     markPrice: string;
     oraclePrice?: string;
     prevDayPrice?: string;
@@ -100,11 +123,16 @@ export interface MarketContext {
     openInterest?: string;
     funding?: FundingInfo;
 }
-/** @public */
+/** Response containing live context for requested markets. @public */
 export interface PricesResponse {
     prices: MarketContext[];
 }
-/** @public */
+/**
+ * OHLCV candle with Unix-millisecond open time and decimal-string OHLCV
+ * values. Field names follow the compact provider response shape.
+ *
+ * @public
+ */
 export interface Candle {
     t: number;
     o: string;
@@ -113,21 +141,26 @@ export interface Candle {
     c: string;
     v: string;
 }
-/** @public */
+/** Response containing candles for one provider market and interval. @public */
 export interface OhlcvResponse {
     provider: string;
     marketId: string;
     interval: string;
     candles: Candle[];
 }
-/** @public */
+/**
+ * Supported OHLCV intervals. Values are wire interval strings (`1M` is one
+ * month; lowercase `m` values are minutes).
+ *
+ * @public
+ */
 export type OhlcvInterval = '1m' | '3m' | '5m' | '15m' | '30m' | '1h' | '2h' | '4h' | '8h' | '12h' | '1d' | '3d' | '1w' | '1M';
-/** @public */
+/** One price/size level in an order book; both values are decimal strings. @public */
 export interface OrderbookLevel {
     price: string;
     size: string;
 }
-/** @public */
+/** Snapshot of bids and asks for one market. `timestamp` is Unix milliseconds. @public */
 export interface OrderbookResponse {
     provider: string;
     marketId: string;
@@ -135,7 +168,7 @@ export interface OrderbookResponse {
     asks: OrderbookLevel[];
     timestamp: number;
 }
-/** @public */
+/** Recent trade normalized for a market; `timestamp` is Unix milliseconds. @public */
 export interface Trade {
     provider: string;
     marketId: string;

package/dist/types/market.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"market.d.ts","sourceRoot":"","sources":["../../src/market.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AACvC,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,YAAY,CAAA;AAE1D,cAAc;AACd,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAA;IACZ,eAAe,EAAE,MAAM,CAAA;CACxB;AAED,cAAc;AACd,MAAM,WAAW,UAAU;IACzB,UAAU,EAAE,MAAM,CAAA;IAClB,qEAAqE;IACrE,EAAE,EAAE,MAAM,CAAA;IACV,kDAAkD;IAClD,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,mDAAmD;IACnD,UAAU,EAAE,MAAM,CAAA;IAClB,SAAS,EAAE,KAAK,CAAA;IAChB,UAAU,EAAE,KAAK,CAAA;IACjB,UAAU,EAAE,MAAM,CAAA;IAClB;;;;;OAKG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB;;;;;OAKG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB;AAED,cAAc;AACd,MAAM,WAAW,WAAY,SAAQ,UAAU;IAC7C,WAAW,EAAE,MAAM,CAAA;IACnB,YAAY,EAAE,OAAO,CAAA;IACrB,sEAAsE;IACtE,wBAAwB,EAAE,wBAAwB,CAAA;IAClD;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAA;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,UAAW,SAAQ,UAAU;IAC5C,wBAAwB,CAAC,EAAE,KAAK,CAAA;CACjC;AAED,cAAc;AACd,MAAM,MAAM,MAAM,GAAG,WAAW,GAAG,UAAU,CAAA;AAE7C,cAAc;AACd,MAAM,MAAM,aAAa,GAAG,IAAI,CAC9B,UAAU,EACV,YAAY,GAAG,IAAI,GAAG,YAAY,GAAG,WAAW,GAAG,YAAY,GAAG,YAAY,CAC/E,CAAA;AAED,8EAA8E;AAC9E,MAAM,MAAM,kBAAkB,GAAG,IAAI,CACnC,WAAW,EACT,YAAY,GACZ,IAAI,GACJ,YAAY,GACZ,WAAW,GACX,YAAY,GACZ,YAAY,GACZ,0BAA0B,CAC7B,CAAA;AAED;;;;;GAKG;AACH,MAAM,WAAW,SAAS;IACxB,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,MAAM,CAAA;CACnB;AAED,cAAc;AACd,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,MAAM,EAAE,CAAA;CAClB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,aAAa;IAC5B,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,MAAM,CAAA;IACjB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,OAAO,CAAC,EAAE,WAAW,CAAA;CACtB;AAED,cAAc;AACd,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,aAAa,EAAE,CAAA;CACxB;AAED,cAAc;AACd,MAAM,WAAW,MAAM;IACrB,CAAC,EAAE,MAAM,CAAA;IACT,CAAC,EAAE,MAAM,CAAA;IACT,CAAC,EAAE,MAAM,CAAA;IACT,CAAC,EAAE,MAAM,CAAA;IACT,CAAC,EAAE,MAAM,CAAA;IACT,CAAC,EAAE,MAAM,CAAA;CACV;AAED,cAAc;AACd,MAAM,WAAW,aAAa;IAC5B,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,MAAM,EAAE,CAAA;CAClB;AAED,cAAc;AACd,MAAM,MAAM,aAAa,GACrB,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,KAAK,GACL,KAAK,GACL,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,KAAK,GACL,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,CAAA;AAER,cAAc;AACd,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;CACb;AAED,cAAc;AACd,MAAM,WAAW,iBAAiB;IAChC,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,cAAc,EAAE,CAAA;IACtB,IAAI,EAAE,cAAc,EAAE,CAAA;IACtB,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,cAAc;AACd,MAAM,WAAW,KAAK;IACpB,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,EAAE,MAAM,CAAA;IACjB,IAAI,EAAE,KAAK,GAAG,MAAM,CAAA;IACpB,EAAE,CAAC,EAAE,MAAM,CAAA;CACZ"}
+{"version":3,"file":"market.d.ts","sourceRoot":"","sources":["../../src/market.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AACvC,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,YAAY,CAAA;AAE1D;;;;;GAKG;AACH,MAAM,WAAW,WAAW;IAC1B,0CAA0C;IAC1C,IAAI,EAAE,MAAM,CAAA;IACZ,mDAAmD;IACnD,eAAe,EAAE,MAAM,CAAA;CACxB;AAED;;;;GAIG;AACH,MAAM,WAAW,UAAU;IACzB,UAAU,EAAE,MAAM,CAAA;IAClB,qEAAqE;IACrE,EAAE,EAAE,MAAM,CAAA;IACV,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,mDAAmD;IACnD,UAAU,EAAE,MAAM,CAAA;IAClB,SAAS,EAAE,KAAK,CAAA;IAChB,UAAU,EAAE,KAAK,CAAA;IACjB,6DAA6D;IAC7D,UAAU,EAAE,MAAM,CAAA;IAClB;;;;;OAKG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB;;;;;OAKG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB;AAED;;;;GAIG;AACH,MAAM,WAAW,WAAY,SAAQ,UAAU;IAC7C,WAAW,EAAE,MAAM,CAAA;IACnB,YAAY,EAAE,OAAO,CAAA;IACrB,sEAAsE;IACtE,wBAAwB,EAAE,wBAAwB,CAAA;IAClD;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAA;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,UAAW,SAAQ,UAAU;IAC5C,wBAAwB,CAAC,EAAE,KAAK,CAAA;CACjC;AAED,kEAAkE;AAClE,MAAM,MAAM,MAAM,GAAG,WAAW,GAAG,UAAU,CAAA;AAE7C;;;;;GAKG;AACH,MAAM,MAAM,aAAa,GAAG,IAAI,CAC9B,UAAU,EACV,YAAY,GAAG,IAAI,GAAG,YAAY,GAAG,WAAW,GAAG,YAAY,GAAG,YAAY,CAC/E,CAAA;AAED,8EAA8E;AAC9E,MAAM,MAAM,kBAAkB,GAAG,IAAI,CACnC,WAAW,EACT,YAAY,GACZ,IAAI,GACJ,YAAY,GACZ,WAAW,GACX,YAAY,GACZ,YAAY,GACZ,0BAA0B,CAC7B,CAAA;AAED;;;;;GAKG;AACH,MAAM,WAAW,SAAS;IACxB,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,MAAM,CAAA;CACnB;AAED,uEAAuE;AACvE,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,MAAM,EAAE,CAAA;CAClB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,aAAa;IAC5B,gEAAgE;IAChE,QAAQ,EAAE,MAAM,CAAA;IAChB,8DAA8D;IAC9D,QAAQ,EAAE,MAAM,CAAA;IAChB,sDAAsD;IACtD,SAAS,EAAE,MAAM,CAAA;IACjB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,OAAO,CAAC,EAAE,WAAW,CAAA;CACtB;AAED,sEAAsE;AACtE,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,aAAa,EAAE,CAAA;CACxB;AAED;;;;;GAKG;AACH,MAAM,WAAW,MAAM;IACrB,CAAC,EAAE,MAAM,CAAA;IACT,CAAC,EAAE,MAAM,CAAA;IACT,CAAC,EAAE,MAAM,CAAA;IACT,CAAC,EAAE,MAAM,CAAA;IACT,CAAC,EAAE,MAAM,CAAA;IACT,CAAC,EAAE,MAAM,CAAA;CACV;AAED,gFAAgF;AAChF,MAAM,WAAW,aAAa;IAC5B,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,MAAM,EAAE,CAAA;CAClB;AAED;;;;;GAKG;AACH,MAAM,MAAM,aAAa,GACrB,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,KAAK,GACL,KAAK,GACL,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,KAAK,GACL,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,CAAA;AAER,sFAAsF;AACtF,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;CACb;AAED,0FAA0F;AAC1F,MAAM,WAAW,iBAAiB;IAChC,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,cAAc,EAAE,CAAA;IACtB,IAAI,EAAE,cAAc,EAAE,CAAA;IACtB,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,sFAAsF;AACtF,MAAM,WAAW,KAAK;IACpB,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,EAAE,MAAM,CAAA;IACjB,IAAI,EAAE,KAAK,GAAG,MAAM,CAAA;IACpB,EAAE,CAAC,EAAE,MAAM,CAAA;CACZ"}

package/dist/types/positionMargin.d.ts

@@ -0,0 +1,16 @@
+import type { Position } from './account.js';
+/**
+ * Whether this position can take a margin adjustment at all: it holds margin of
+ * its own and its market exposes individual position margin.
+ *
+ * @public
+ */
+export declare function positionSupportsMarginAdjustment(position: Position): boolean;
+/**
+ * Whether a removal is among the adjustments this position permits. An
+ * `ADD_ONLY` market takes adds and no withdrawal.
+ *
+ * @public
+ */
+export declare function positionSupportsMarginRemoval(position: Position): boolean;
+//# sourceMappingURL=positionMargin.d.ts.map

package/dist/types/positionMargin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"positionMargin.d.ts","sourceRoot":"","sources":["../../src/positionMargin.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAA;AAG5C;;;;;GAKG;AACH,wBAAgB,gCAAgC,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAK5E;AAED;;;;;GAKG;AACH,wBAAgB,6BAA6B,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAMzE"}

package/dist/types/primitives.d.ts

@@ -1,5 +1,15 @@
-/** @public */
+/**
+ * Hex-prefixed EVM address string. The type validates only the `0x` prefix;
+ * checksum and byte-length validation remain runtime/provider concerns.
+ *
+ * @public
+ */
 export type Address = `0x${string}`;
-/** @public */
+/**
+ * Hex-prefixed byte string used for hashes, signatures, salts, and other EVM
+ * wire values. The type does not constrain byte length.
+ *
+ * @public
+ */
 export type Hex = `0x${string}`;
 //# sourceMappingURL=primitives.d.ts.map

package/dist/types/primitives.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"primitives.d.ts","sourceRoot":"","sources":["../../src/primitives.ts"],"names":[],"mappings":"AAAA,cAAc;AACd,MAAM,MAAM,OAAO,GAAG,KAAK,MAAM,EAAE,CAAA;AAEnC,cAAc;AACd,MAAM,MAAM,GAAG,GAAG,KAAK,MAAM,EAAE,CAAA"}
+{"version":3,"file":"primitives.d.ts","sourceRoot":"","sources":["../../src/primitives.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,MAAM,OAAO,GAAG,KAAK,MAAM,EAAE,CAAA;AAEnC;;;;;GAKG;AACH,MAAM,MAAM,GAAG,GAAG,KAAK,MAAM,EAAE,CAAA"}

package/dist/types/providers.d.ts

@@ -1,12 +1,16 @@
 import type { Asset, DepositAsset } from './asset.js';
 import type { ActionType, PerpsSigner, SigningMethod } from './enums.js';
 import type { OhlcvInterval } from './market.js';
-/** @public */
+/** A fixed option value presented for a provider action parameter. @public */
 export interface ParamOption {
     value: string;
     label: string;
 }
-/** @public */
+/**
+ * Metadata describing one provider action parameter and its UI constraints.
+ *
+ * @public
+ */
 export interface Param {
     /** Wire key for the action params object: `{ [param.name]: value }`. */
     name: string;
@@ -55,7 +59,11 @@ export interface TradeNotice {
     /** Plaintext; any URL is rendered as text, not a hyperlink. */
     message: string;
 }
-/** @public */
+/**
+ * Provider category metadata, including quote asset and optional market notice.
+ *
+ * @public
+ */
 export interface ProviderCategory {
     id: string;
     logoURI?: string;
@@ -63,14 +71,19 @@ export interface ProviderCategory {
     quoteAsset: Asset | null;
     tradeNotice?: TradeNotice;
 }
-/** @public */
+/** Provider-wide funding cadence metadata, expressed in seconds. @public */
 export interface ProviderFunding {
     /** Number of seconds represented by the provider's funding rate. */
     ratePeriodSeconds: number;
     /** Number of seconds between funding payouts. */
     payoutCadenceSeconds: number;
 }
-/** @public */
+/**
+ * Provider descriptor containing capabilities, actions, categories, and
+ * optional deposit/trading limits.
+ *
+ * @public
+ */
 export interface Provider {
     key: string;
     name: string;
@@ -134,7 +147,7 @@ export interface Provider {
      */
     supportedIntervals: OhlcvInterval[];
 }
-/** @public */
+/** Response containing provider descriptors available to the client. @public */
 export interface ProvidersResponse {
     providers: Provider[];
 }

package/dist/types/providers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"providers.d.ts","sourceRoot":"","sources":["../../src/providers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,YAAY,CAAA;AACrD,OAAO,KAAK,EAAE,UAAU,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,YAAY,CAAA;AACxE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,aAAa,CAAA;AAEhD,cAAc;AACd,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;CACd;AAED,cAAc;AACd,MAAM,WAAW,KAAK;IACpB,wEAAwE;IACxE,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,QAAQ,CAAA;IACd,yFAAyF;IACzF,MAAM,CAAC,EAAE,WAAW,EAAE,CAAA;IACtB,OAAO,CAAC,EAAE,WAAW,CAAA;IACrB,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,UAAU,CAAA;IAChB,OAAO,EAAE,WAAW,EAAE,CAAA;IACtB,aAAa,EAAE,aAAa,CAAA;IAC5B;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,0EAA0E;IAC1E,MAAM,CAAC,EAAE,KAAK,EAAE,CAAA;IAChB;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB;AAED;;;;GAIG;AACH,MAAM,WAAW,WAAW;IAC1B,2EAA2E;IAC3E,KAAK,EAAE,MAAM,GAAG,MAAM,CAAA;IACtB,+DAA+D;IAC/D,OAAO,EAAE,MAAM,CAAA;CAChB;AAED,cAAc;AACd,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAA;IACV,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,8DAA8D;IAC9D,UAAU,EAAE,KAAK,GAAG,IAAI,CAAA;IACxB,WAAW,CAAC,EAAE,WAAW,CAAA;CAC1B;AAED,cAAc;AACd,MAAM,WAAW,eAAe;IAC9B,oEAAoE;IACpE,iBAAiB,EAAE,MAAM,CAAA;IACzB,iDAAiD;IACjD,oBAAoB,EAAE,MAAM,CAAA;CAC7B;AAED,cAAc;AACd,MAAM,WAAW,QAAQ;IACvB,GAAG,EAAE,MAAM,CAAA;IACX,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,CAAA;IACf,aAAa,EAAE,aAAa,CAAA;IAC5B,+EAA+E;IAC/E,MAAM,EAAE,OAAO,CAAA;IACf,KAAK,EAAE,cAAc,EAAE,CAAA;IACvB,OAAO,EAAE,cAAc,EAAE,CAAA;IACzB,OAAO,EAAE,cAAc,EAAE,CAAA;IACzB,UAAU,EAAE,gBAAgB,EAAE,CAAA;IAC9B,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,sEAAsE;IACtE,OAAO,CAAC,EAAE,eAAe,CAAA;IACzB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,0CAA0C;IAC1C,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;;;;;;;;OASG;IACH,aAAa,CAAC,EAAE,YAAY,EAAE,CAAA;IAC9B;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB;;;;OAIG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAA;IAC/B,8EAA8E;IAC9E,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,oFAAoF;IACpF,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,uFAAuF;IACvF,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,wFAAwF;IACxF,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB;;;;OAIG;IACH,kBAAkB,EAAE,aAAa,EAAE,CAAA;CACpC;AAED,cAAc;AACd,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,QAAQ,EAAE,CAAA;CACtB"}
+{"version":3,"file":"providers.d.ts","sourceRoot":"","sources":["../../src/providers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,YAAY,CAAA;AACrD,OAAO,KAAK,EAAE,UAAU,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,YAAY,CAAA;AACxE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,aAAa,CAAA;AAEhD,8EAA8E;AAC9E,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;CACd;AAED;;;;GAIG;AACH,MAAM,WAAW,KAAK;IACpB,wEAAwE;IACxE,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,QAAQ,CAAA;IACd,yFAAyF;IACzF,MAAM,CAAC,EAAE,WAAW,EAAE,CAAA;IACtB,OAAO,CAAC,EAAE,WAAW,CAAA;IACrB,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,UAAU,CAAA;IAChB,OAAO,EAAE,WAAW,EAAE,CAAA;IACtB,aAAa,EAAE,aAAa,CAAA;IAC5B;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,0EAA0E;IAC1E,MAAM,CAAC,EAAE,KAAK,EAAE,CAAA;IAChB;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB;AAED;;;;GAIG;AACH,MAAM,WAAW,WAAW;IAC1B,2EAA2E;IAC3E,KAAK,EAAE,MAAM,GAAG,MAAM,CAAA;IACtB,+DAA+D;IAC/D,OAAO,EAAE,MAAM,CAAA;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAA;IACV,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,8DAA8D;IAC9D,UAAU,EAAE,KAAK,GAAG,IAAI,CAAA;IACxB,WAAW,CAAC,EAAE,WAAW,CAAA;CAC1B;AAED,4EAA4E;AAC5E,MAAM,WAAW,eAAe;IAC9B,oEAAoE;IACpE,iBAAiB,EAAE,MAAM,CAAA;IACzB,iDAAiD;IACjD,oBAAoB,EAAE,MAAM,CAAA;CAC7B;AAED;;;;;GAKG;AACH,MAAM,WAAW,QAAQ;IACvB,GAAG,EAAE,MAAM,CAAA;IACX,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,CAAA;IACf,aAAa,EAAE,aAAa,CAAA;IAC5B,+EAA+E;IAC/E,MAAM,EAAE,OAAO,CAAA;IACf,KAAK,EAAE,cAAc,EAAE,CAAA;IACvB,OAAO,EAAE,cAAc,EAAE,CAAA;IACzB,OAAO,EAAE,cAAc,EAAE,CAAA;IACzB,UAAU,EAAE,gBAAgB,EAAE,CAAA;IAC9B,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,sEAAsE;IACtE,OAAO,CAAC,EAAE,eAAe,CAAA;IACzB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,0CAA0C;IAC1C,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;;;;;;;;OASG;IACH,aAAa,CAAC,EAAE,YAAY,EAAE,CAAA;IAC9B;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB;;;;OAIG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAA;IAC/B,8EAA8E;IAC9E,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,oFAAoF;IACpF,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,uFAAuF;IACvF,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,wFAAwF;IACxF,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB;;;;OAIG;IACH,kBAAkB,EAAE,aAAa,EAAE,CAAA;CACpC;AAED,gFAAgF;AAChF,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,QAAQ,EAAE,CAAA;CACtB"}

package/dist/types/quote.d.ts

@@ -1,8 +1,8 @@
 import type { FeeTier } from './account.js';
 import type { FundingInfo } from './market.js';
-/** @public */
+/** Side of the quoted market order, using lowercase wire values. @public */
 export type QuoteSide = 'buy' | 'sell';
-/** @public */
+/** Trade instrument kind represented by the quote. @public */
 export type TradeType = 'perps' | 'spot';
 /**
  * One-shot fill estimate for a market order of `sizeUsd` notional on a single

package/dist/types/quote.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"quote.d.ts","sourceRoot":"","sources":["../../src/quote.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAC3C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAA;AAE9C,cAAc;AACd,MAAM,MAAM,SAAS,GAAG,KAAK,GAAG,MAAM,CAAA;AAEtC,cAAc;AACd,MAAM,MAAM,SAAS,GAAG,OAAO,GAAG,MAAM,CAAA;AAExC;;;;;;;;;GASG;AACH,MAAM,WAAW,KAAK;IACpB,QAAQ,EAAE,MAAM,CAAA;IAChB,0EAA0E;IAC1E,MAAM,EAAE,MAAM,CAAA;IACd,mCAAmC;IACnC,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,SAAS,CAAA;IACf,IAAI,EAAE,SAAS,CAAA;IACf,6BAA6B;IAC7B,OAAO,EAAE,MAAM,CAAA;IACf,oGAAoG;IACpG,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,MAAM,CAAA;IACjB,6DAA6D;IAC7D,iBAAiB,EAAE,MAAM,CAAA;IACzB,qEAAqE;IACrE,cAAc,EAAE,MAAM,CAAA;IACtB,oEAAoE;IACpE,OAAO,EAAE,OAAO,CAAA;IAChB,uFAAuF;IACvF,gBAAgB,EAAE,OAAO,CAAA;IACzB,iFAAiF;IACjF,MAAM,EAAE,MAAM,CAAA;IACd,kDAAkD;IAClD,OAAO,EAAE,WAAW,GAAG,IAAI,CAAA;IAC3B,4GAA4G;IAC5G,qBAAqB,EAAE,OAAO,CAAA;IAC9B,gDAAgD;IAChD,SAAS,EAAE,MAAM,CAAA;CAClB"}
+{"version":3,"file":"quote.d.ts","sourceRoot":"","sources":["../../src/quote.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAC3C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAA;AAE9C,4EAA4E;AAC5E,MAAM,MAAM,SAAS,GAAG,KAAK,GAAG,MAAM,CAAA;AAEtC,8DAA8D;AAC9D,MAAM,MAAM,SAAS,GAAG,OAAO,GAAG,MAAM,CAAA;AAExC;;;;;;;;;GASG;AACH,MAAM,WAAW,KAAK;IACpB,QAAQ,EAAE,MAAM,CAAA;IAChB,0EAA0E;IAC1E,MAAM,EAAE,MAAM,CAAA;IACd,mCAAmC;IACnC,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,SAAS,CAAA;IACf,IAAI,EAAE,SAAS,CAAA;IACf,6BAA6B;IAC7B,OAAO,EAAE,MAAM,CAAA;IACf,oGAAoG;IACpG,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,MAAM,CAAA;IACjB,6DAA6D;IAC7D,iBAAiB,EAAE,MAAM,CAAA;IACzB,qEAAqE;IACrE,cAAc,EAAE,MAAM,CAAA;IACtB,oEAAoE;IACpE,OAAO,EAAE,OAAO,CAAA;IAChB,uFAAuF;IACvF,gBAAgB,EAAE,OAAO,CAAA;IACzB,iFAAiF;IACjF,MAAM,EAAE,MAAM,CAAA;IACd,kDAAkD;IAClD,OAAO,EAAE,WAAW,GAAG,IAAI,CAAA;IAC3B,4GAA4G;IAC5G,qBAAqB,EAAE,OAAO,CAAA;IAC9B,gDAAgD;IAChD,SAAS,EAAE,MAAM,CAAA;CAClB"}

package/dist/types/subscriptions.d.ts

@@ -1,18 +1,18 @@
 import type { AccountSummary, Balance, Fill, OpenOrder, Position, TriggerOrder } from './account.js';
 import type { Candle, MarketContext, OhlcvInterval, OrderbookResponse, Trade } from './market.js';
 import type { Address } from './primitives.js';
-/** @public */
+/** Subscription for the provider's aggregate market-context stream. @public */
 export type MarketsContextSubscription = {
     channel: 'marketsContext';
     dex: string;
 };
-/** @public */
+/** Subscription for one market's live context stream. @public */
 export type MarketContextSubscription = {
     channel: 'marketContext';
     dex: string;
     marketId: string;
 };
-/** @public */
+/** Subscription for streamed order-book updates for one market. @public */
 export type OrderbookSubscription = {
     channel: 'orderbook';
     dex: string;
@@ -26,77 +26,81 @@ export type OrderbookSubscription = {
      */
     priceStep?: number;
 };
-/** @public */
+/** Subscription for OHLCV candle updates for one market and interval. @public */
 export type CandleSubscription = {
     channel: 'candle';
     dex: string;
     marketId: string;
     interval: OhlcvInterval;
 };
-/** @public */
+/** Subscription for recent trade updates for one market. @public */
 export type TradesSubscription = {
     channel: 'trades';
     dex: string;
     marketId: string;
 };
-/** @public */
+/** Subscription for order lifecycle updates for one account. @public */
 export type OrderUpdatesSubscription = {
     channel: 'orderUpdates';
     dex: string;
     address: Address;
 };
-/** @public */
+/** Subscription for execution/fill updates for one account. @public */
 export type FillsSubscription = {
     channel: 'fills';
     dex: string;
     address: Address;
 };
-/** @public */
+/** Subscription for the full open-position set for one account. @public */
 export type PositionsSubscription = {
     channel: 'positions';
     dex: string;
     address: Address;
 };
-/** @public */
+/** Subscription for spot-balance updates for one account. @public */
 export type SpotBalancesSubscription = {
     channel: 'spotBalances';
     dex: string;
     address: Address;
 };
-/** @public */
+/** Subscription for aggregate account-summary updates for one account. @public */
 export type AccountSummarySubscription = {
     channel: 'accountSummary';
     dex: string;
     address: Address;
 };
-/** @public */
+/**
+ * Union of all websocket subscription request shapes.
+ *
+ * @public
+ */
 export type Subscription = MarketsContextSubscription | MarketContextSubscription | OrderbookSubscription | CandleSubscription | TradesSubscription | OrderUpdatesSubscription | FillsSubscription | PositionsSubscription | SpotBalancesSubscription | AccountSummarySubscription;
-/** @public */
+/** Event containing the provider's aggregate market contexts. @public */
 export type MarketsContextEvent = {
     channel: 'marketsContext';
     data: Record<string, MarketContext>;
 };
-/** @public */
+/** Event containing one market's live context. @public */
 export type MarketContextEvent = {
     channel: 'marketContext';
     data: MarketContext;
 };
-/** @public */
+/** Event containing an order-book snapshot or update. @public */
 export type OrderbookEvent = {
     channel: 'orderbook';
     data: OrderbookResponse;
 };
-/** @public */
+/** Event containing one OHLCV candle. @public */
 export type CandleEvent = {
     channel: 'candle';
     data: Candle;
 };
-/** @public */
+/** Event containing recent trades. @public */
 export type TradesEvent = {
     channel: 'trades';
     data: Trade[];
 };
-/** @public */
+/** Event containing order upserts and terminal order ids. @public */
 export type OrderUpdatesEvent = {
     channel: 'orderUpdates';
     data: {
@@ -111,7 +115,7 @@ export type OrderUpdatesEvent = {
         terminated: string[];
     };
 };
-/** @public */
+/** Event containing newly observed executions/fills. @public */
 export type FillsEvent = {
     channel: 'fills';
     data: Fill[];
@@ -148,6 +152,10 @@ export type AccountSummaryEvent = {
     channel: 'accountSummary';
     data: AccountSummary;
 };
-/** @public */
+/**
+ * Union of all websocket event frame shapes emitted for subscriptions.
+ *
+ * @public
+ */
 export type SubscriptionEvent = MarketsContextEvent | MarketContextEvent | OrderbookEvent | CandleEvent | TradesEvent | OrderUpdatesEvent | FillsEvent | PositionsEvent | SpotBalancesEvent | AccountSummaryEvent;
 //# sourceMappingURL=subscriptions.d.ts.map