@lifi/perps-types 4.0.0 → 4.0.1

package/dist/esm/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/esm/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

package/dist/esm/subscriptions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"subscriptions.d.ts","sourceRoot":"","sources":["../../src/subscriptions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,OAAO,EACP,IAAI,EACJ,SAAS,EACT,QAAQ,EACR,YAAY,EACb,MAAM,cAAc,CAAA;AACrB,OAAO,KAAK,EACV,MAAM,EACN,aAAa,EACb,aAAa,EACb,iBAAiB,EACjB,KAAK,EACN,MAAM,aAAa,CAAA;AACpB,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAA;AAE9C,cAAc;AACd,MAAM,MAAM,0BAA0B,GAAG;IACvC,OAAO,EAAE,gBAAgB,CAAA;IACzB,GAAG,EAAE,MAAM,CAAA;CACZ,CAAA;AACD,cAAc;AACd,MAAM,MAAM,yBAAyB,GAAG;IACtC,OAAO,EAAE,eAAe,CAAA;IACxB,GAAG,EAAE,MAAM,CAAA;IACX,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AACD,cAAc;AACd,MAAM,MAAM,qBAAqB,GAAG;IAClC,OAAO,EAAE,WAAW,CAAA;IACpB,GAAG,EAAE,MAAM,CAAA;IACX,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB,CAAA;AACD,cAAc;AACd,MAAM,MAAM,kBAAkB,GAAG;IAC/B,OAAO,EAAE,QAAQ,CAAA;IACjB,GAAG,EAAE,MAAM,CAAA;IACX,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,aAAa,CAAA;CACxB,CAAA;AACD,cAAc;AACd,MAAM,MAAM,kBAAkB,GAAG;IAC/B,OAAO,EAAE,QAAQ,CAAA;IACjB,GAAG,EAAE,MAAM,CAAA;IACX,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AACD,cAAc;AACd,MAAM,MAAM,wBAAwB,GAAG;IACrC,OAAO,EAAE,cAAc,CAAA;IACvB,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AACD,cAAc;AACd,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,EAAE,OAAO,CAAA;IAChB,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AACD,cAAc;AACd,MAAM,MAAM,qBAAqB,GAAG;IAClC,OAAO,EAAE,WAAW,CAAA;IACpB,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AACD,cAAc;AACd,MAAM,MAAM,wBAAwB,GAAG;IACrC,OAAO,EAAE,cAAc,CAAA;IACvB,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AACD,cAAc;AACd,MAAM,MAAM,0BAA0B,GAAG;IACvC,OAAO,EAAE,gBAAgB,CAAA;IACzB,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AAED,cAAc;AACd,MAAM,MAAM,YAAY,GACpB,0BAA0B,GAC1B,yBAAyB,GACzB,qBAAqB,GACrB,kBAAkB,GAClB,kBAAkB,GAClB,wBAAwB,GACxB,iBAAiB,GACjB,qBAAqB,GACrB,wBAAwB,GACxB,0BAA0B,CAAA;AAE9B,cAAc;AACd,MAAM,MAAM,mBAAmB,GAAG;IAChC,OAAO,EAAE,gBAAgB,CAAA;IACzB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAA;CACpC,CAAA;AACD,cAAc;AACd,MAAM,MAAM,kBAAkB,GAAG;IAC/B,OAAO,EAAE,eAAe,CAAA;IACxB,IAAI,EAAE,aAAa,CAAA;CACpB,CAAA;AACD,cAAc;AACd,MAAM,MAAM,cAAc,GAAG;IAAE,OAAO,EAAE,WAAW,CAAC;IAAC,IAAI,EAAE,iBAAiB,CAAA;CAAE,CAAA;AAC9E,cAAc;AACd,MAAM,MAAM,WAAW,GAAG;IAAE,OAAO,EAAE,QAAQ,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAAA;AAC7D,cAAc;AACd,MAAM,MAAM,WAAW,GAAG;IAAE,OAAO,EAAE,QAAQ,CAAC;IAAC,IAAI,EAAE,KAAK,EAAE,CAAA;CAAE,CAAA;AAC9D,cAAc;AACd,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,EAAE,cAAc,CAAA;IACvB,IAAI,EAAE;QACJ,4CAA4C;QAC5C,UAAU,EAAE,SAAS,EAAE,CAAA;QACvB,8DAA8D;QAC9D,aAAa,EAAE,YAAY,EAAE,CAAA;QAC7B;;;WAGG;QACH,UAAU,EAAE,MAAM,EAAE,CAAA;KACrB,CAAA;CACF,CAAA;AACD,cAAc;AACd,MAAM,MAAM,UAAU,GAAG;IAAE,OAAO,EAAE,OAAO,CAAC;IAAC,IAAI,EAAE,IAAI,EAAE,CAAA;CAAE,CAAA;AAC3D;;;;;;GAMG;AACH,MAAM,MAAM,cAAc,GAAG;IAAE,OAAO,EAAE,WAAW,CAAC;IAAC,IAAI,EAAE,QAAQ,EAAE,CAAA;CAAE,CAAA;AACvE;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,EAAE,cAAc,CAAA;IACvB,IAAI,EAAE,CAAC,OAAO,GAAG;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC,EAAE,CAAA;CACvC,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,OAAO,EAAE,gBAAgB,CAAA;IACzB,IAAI,EAAE,cAAc,CAAA;CACrB,CAAA;AAED,cAAc;AACd,MAAM,MAAM,iBAAiB,GACzB,mBAAmB,GACnB,kBAAkB,GAClB,cAAc,GACd,WAAW,GACX,WAAW,GACX,iBAAiB,GACjB,UAAU,GACV,cAAc,GACd,iBAAiB,GACjB,mBAAmB,CAAA"}
+{"version":3,"file":"subscriptions.d.ts","sourceRoot":"","sources":["../../src/subscriptions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,OAAO,EACP,IAAI,EACJ,SAAS,EACT,QAAQ,EACR,YAAY,EACb,MAAM,cAAc,CAAA;AACrB,OAAO,KAAK,EACV,MAAM,EACN,aAAa,EACb,aAAa,EACb,iBAAiB,EACjB,KAAK,EACN,MAAM,aAAa,CAAA;AACpB,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAA;AAE9C,+EAA+E;AAC/E,MAAM,MAAM,0BAA0B,GAAG;IACvC,OAAO,EAAE,gBAAgB,CAAA;IACzB,GAAG,EAAE,MAAM,CAAA;CACZ,CAAA;AACD,iEAAiE;AACjE,MAAM,MAAM,yBAAyB,GAAG;IACtC,OAAO,EAAE,eAAe,CAAA;IACxB,GAAG,EAAE,MAAM,CAAA;IACX,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AACD,2EAA2E;AAC3E,MAAM,MAAM,qBAAqB,GAAG;IAClC,OAAO,EAAE,WAAW,CAAA;IACpB,GAAG,EAAE,MAAM,CAAA;IACX,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB,CAAA;AACD,iFAAiF;AACjF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,OAAO,EAAE,QAAQ,CAAA;IACjB,GAAG,EAAE,MAAM,CAAA;IACX,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,aAAa,CAAA;CACxB,CAAA;AACD,oEAAoE;AACpE,MAAM,MAAM,kBAAkB,GAAG;IAC/B,OAAO,EAAE,QAAQ,CAAA;IACjB,GAAG,EAAE,MAAM,CAAA;IACX,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AACD,wEAAwE;AACxE,MAAM,MAAM,wBAAwB,GAAG;IACrC,OAAO,EAAE,cAAc,CAAA;IACvB,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AACD,uEAAuE;AACvE,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,EAAE,OAAO,CAAA;IAChB,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AACD,2EAA2E;AAC3E,MAAM,MAAM,qBAAqB,GAAG;IAClC,OAAO,EAAE,WAAW,CAAA;IACpB,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AACD,qEAAqE;AACrE,MAAM,MAAM,wBAAwB,GAAG;IACrC,OAAO,EAAE,cAAc,CAAA;IACvB,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AACD,kFAAkF;AAClF,MAAM,MAAM,0BAA0B,GAAG;IACvC,OAAO,EAAE,gBAAgB,CAAA;IACzB,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,YAAY,GACpB,0BAA0B,GAC1B,yBAAyB,GACzB,qBAAqB,GACrB,kBAAkB,GAClB,kBAAkB,GAClB,wBAAwB,GACxB,iBAAiB,GACjB,qBAAqB,GACrB,wBAAwB,GACxB,0BAA0B,CAAA;AAE9B,yEAAyE;AACzE,MAAM,MAAM,mBAAmB,GAAG;IAChC,OAAO,EAAE,gBAAgB,CAAA;IACzB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAA;CACpC,CAAA;AACD,0DAA0D;AAC1D,MAAM,MAAM,kBAAkB,GAAG;IAC/B,OAAO,EAAE,eAAe,CAAA;IACxB,IAAI,EAAE,aAAa,CAAA;CACpB,CAAA;AACD,iEAAiE;AACjE,MAAM,MAAM,cAAc,GAAG;IAAE,OAAO,EAAE,WAAW,CAAC;IAAC,IAAI,EAAE,iBAAiB,CAAA;CAAE,CAAA;AAC9E,iDAAiD;AACjD,MAAM,MAAM,WAAW,GAAG;IAAE,OAAO,EAAE,QAAQ,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAAA;AAC7D,8CAA8C;AAC9C,MAAM,MAAM,WAAW,GAAG;IAAE,OAAO,EAAE,QAAQ,CAAC;IAAC,IAAI,EAAE,KAAK,EAAE,CAAA;CAAE,CAAA;AAC9D,qEAAqE;AACrE,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,EAAE,cAAc,CAAA;IACvB,IAAI,EAAE;QACJ,4CAA4C;QAC5C,UAAU,EAAE,SAAS,EAAE,CAAA;QACvB,8DAA8D;QAC9D,aAAa,EAAE,YAAY,EAAE,CAAA;QAC7B;;;WAGG;QACH,UAAU,EAAE,MAAM,EAAE,CAAA;KACrB,CAAA;CACF,CAAA;AACD,gEAAgE;AAChE,MAAM,MAAM,UAAU,GAAG;IAAE,OAAO,EAAE,OAAO,CAAC;IAAC,IAAI,EAAE,IAAI,EAAE,CAAA;CAAE,CAAA;AAC3D;;;;;;GAMG;AACH,MAAM,MAAM,cAAc,GAAG;IAAE,OAAO,EAAE,WAAW,CAAC;IAAC,IAAI,EAAE,QAAQ,EAAE,CAAA;CAAE,CAAA;AACvE;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,EAAE,cAAc,CAAA;IACvB,IAAI,EAAE,CAAC,OAAO,GAAG;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC,EAAE,CAAA;CACvC,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,OAAO,EAAE,gBAAgB,CAAA;IACzB,IAAI,EAAE,cAAc,CAAA;CACrB,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GACzB,mBAAmB,GACnB,kBAAkB,GAClB,cAAc,GACd,WAAW,GACX,WAAW,GACX,iBAAiB,GACjB,UAAU,GACV,cAAc,GACd,iBAAiB,GACjB,mBAAmB,CAAA"}

package/dist/esm/typedData.d.ts

@@ -1,5 +1,10 @@
 import type { Address, Hex } from './primitives.js';
-/** @public */
+/**
+ * EIP-712 domain fields used to identify a signing domain. `chainId` is the
+ * numeric EVM chain id when present.
+ *
+ * @public
+ */
 export interface TypedDataDomain {
     name?: string;
     version?: string;
@@ -7,21 +12,26 @@ export interface TypedDataDomain {
     verifyingContract?: Address;
     salt?: Hex;
 }
-/** @public */
+/** One named field in an EIP-712 primary type definition. @public */
 export interface TypedDataParameter {
     name: string;
     type: string;
 }
-/** @public */
+/** Primary-type name used by a perps EIP-712 payload. @public */
 export type PerpsPrimaryType = string;
-/** @public */
+/**
+ * Provider-neutral EIP-712 payload passed between backend and SDK. `message`
+ * intentionally remains open because each action defines its own fields.
+ *
+ * @public
+ */
 export type PerpsTypedData = {
     domain: TypedDataDomain;
     types: Record<string, readonly TypedDataParameter[]>;
     primaryType: PerpsPrimaryType;
     message: Record<string, any>;
 };
-/** @public */
+/** EIP-712 payload accompanied by its client-produced signature. @public */
 export type PerpsSignedTypedData = PerpsTypedData & {
     signature: Hex;
 };

package/dist/esm/typedData.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"typedData.d.ts","sourceRoot":"","sources":["../../src/typedData.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,iBAAiB,CAAA;AAEnD,cAAc;AACd,MAAM,WAAW,eAAe;IAC9B,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAC3B,IAAI,CAAC,EAAE,GAAG,CAAA;CACX;AAED,cAAc;AACd,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;CACb;AAED,cAAc;AACd,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAA;AAErC,cAAc;AACd,MAAM,MAAM,cAAc,GAAG;IAC3B,MAAM,EAAE,eAAe,CAAA;IACvB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,kBAAkB,EAAE,CAAC,CAAA;IACpD,WAAW,EAAE,gBAAgB,CAAA;IAC7B,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC7B,CAAA;AAED,cAAc;AACd,MAAM,MAAM,oBAAoB,GAAG,cAAc,GAAG;IAClD,SAAS,EAAE,GAAG,CAAA;CACf,CAAA"}
+{"version":3,"file":"typedData.d.ts","sourceRoot":"","sources":["../../src/typedData.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,iBAAiB,CAAA;AAEnD;;;;;GAKG;AACH,MAAM,WAAW,eAAe;IAC9B,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAC3B,IAAI,CAAC,EAAE,GAAG,CAAA;CACX;AAED,qEAAqE;AACrE,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;CACb;AAED,iEAAiE;AACjE,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAA;AAErC;;;;;GAKG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,MAAM,EAAE,eAAe,CAAA;IACvB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,kBAAkB,EAAE,CAAC,CAAA;IACpD,WAAW,EAAE,gBAAgB,CAAA;IAC7B,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC7B,CAAA;AAED,4EAA4E;AAC5E,MAAM,MAAM,oBAAoB,GAAG,cAAc,GAAG;IAClD,SAAS,EAAE,GAAG,CAAA;CACf,CAAA"}

package/dist/esm/vote.d.ts

@@ -7,7 +7,7 @@ import type { PerpsTypedData, TypedDataParameter } from './typedData.js';
  * @public
  */
 export declare const META_PROVIDER = "meta";
-/** @public */
+/** Type alias for the {@link META_PROVIDER} provider-independent sentinel. @public */
 export type MetaProvider = typeof META_PROVIDER;
 /**
  * Vote direction. `up` endorses the subject; `down` opposes it.
@@ -29,7 +29,6 @@ export type VoteType = 'provider';
  * @public
  */
 export interface VoteParams {
-    /** Key of the inactive provider being voted on (the voted-on subject). */
     targetProvider: string;
     direction: VoteDirection;
     voteType: VoteType;
@@ -39,7 +38,6 @@ export interface VoteParams {
  * @public
  */
 export interface VoteMessage {
-    /** Key of the inactive provider being voted on. */
     targetProvider: string;
     direction: VoteDirection;
     voteType: VoteType;

package/dist/esm/vote.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"vote.d.ts","sourceRoot":"","sources":["../../src/vote.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAA;AAC9C,OAAO,KAAK,EAAE,cAAc,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAA;AAExE;;;;;GAKG;AACH,eAAO,MAAM,aAAa,SAAS,CAAA;AAEnC,cAAc;AACd,MAAM,MAAM,YAAY,GAAG,OAAO,aAAa,CAAA;AAE/C;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,IAAI,GAAG,MAAM,CAAA;AAEzC;;;;GAIG;AACH,MAAM,MAAM,QAAQ,GAAG,UAAU,CAAA;AAEjC;;;;;;;GAOG;AACH,MAAM,WAAW,UAAU;IACzB,0EAA0E;IAC1E,cAAc,EAAE,MAAM,CAAA;IACtB,SAAS,EAAE,aAAa,CAAA;IACxB,QAAQ,EAAE,QAAQ,CAAA;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B,mDAAmD;IACnD,cAAc,EAAE,MAAM,CAAA;IACtB,SAAS,EAAE,aAAa,CAAA;IACxB,QAAQ,EAAE,QAAQ,CAAA;IAClB,KAAK,EAAE,OAAO,CAAA;IACd,sCAAsC;IACtC,SAAS,EAAE,MAAM,CAAA;CAClB;AAED;;;;GAIG;AACH,eAAO,MAAM,cAAc,EAAE,SAAS,kBAAkB,EAMvD,CAAA;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAc,SAAQ,cAAc;IACnD,WAAW,EAAE,MAAM,CAAA;IACnB,KAAK,EAAE;QAAE,IAAI,EAAE,SAAS,kBAAkB,EAAE,CAAA;KAAE,GAAG,cAAc,CAAC,OAAO,CAAC,CAAA;IACxE,OAAO,EAAE,WAAW,CAAA;CACrB"}
+{"version":3,"file":"vote.d.ts","sourceRoot":"","sources":["../../src/vote.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAA;AAC9C,OAAO,KAAK,EAAE,cAAc,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAA;AAExE;;;;;GAKG;AACH,eAAO,MAAM,aAAa,SAAS,CAAA;AAEnC,sFAAsF;AACtF,MAAM,MAAM,YAAY,GAAG,OAAO,aAAa,CAAA;AAE/C;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,IAAI,GAAG,MAAM,CAAA;AAEzC;;;;GAIG;AACH,MAAM,MAAM,QAAQ,GAAG,UAAU,CAAA;AAEjC;;;;;;;GAOG;AACH,MAAM,WAAW,UAAU;IACzB,cAAc,EAAE,MAAM,CAAA;IACtB,SAAS,EAAE,aAAa,CAAA;IACxB,QAAQ,EAAE,QAAQ,CAAA;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B,cAAc,EAAE,MAAM,CAAA;IACtB,SAAS,EAAE,aAAa,CAAA;IACxB,QAAQ,EAAE,QAAQ,CAAA;IAClB,KAAK,EAAE,OAAO,CAAA;IACd,sCAAsC;IACtC,SAAS,EAAE,MAAM,CAAA;CAClB;AAED;;;;GAIG;AACH,eAAO,MAAM,cAAc,EAAE,SAAS,kBAAkB,EAMvD,CAAA;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAc,SAAQ,cAAc;IACnD,WAAW,EAAE,MAAM,CAAA;IACnB,KAAK,EAAE;QAAE,IAAI,EAAE,SAAS,kBAAkB,EAAE,CAAA;KAAE,GAAG,cAAc,CAAC,OAAO,CAAC,CAAA;IACxE,OAAO,EAAE,WAAW,CAAA;CACrB"}

package/dist/esm/vote.js.map

@@ -1 +1 @@
-{"version":3,"file":"vote.js","sourceRoot":"","sources":["../../src/vote.ts"],"names":[],"mappings":"AAGA;;;;;GAKG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,MAAM,CAAA;AA+CnC;;;;GAIG;AACH,MAAM,CAAC,MAAM,cAAc,GAAkC;IAC3D,EAAE,IAAI,EAAE,gBAAgB,EAAE,IAAI,EAAE,QAAQ,EAAE;IAC1C,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,QAAQ,EAAE;IACrC,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,QAAQ,EAAE;IACpC,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE;IAClC,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,SAAS,EAAE;CACvC,CAAA"}
+{"version":3,"file":"vote.js","sourceRoot":"","sources":["../../src/vote.ts"],"names":[],"mappings":"AAGA;;;;;GAKG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,MAAM,CAAA;AA6CnC;;;;GAIG;AACH,MAAM,CAAC,MAAM,cAAc,GAAkC;IAC3D,EAAE,IAAI,EAAE,gBAAgB,EAAE,IAAI,EAAE,QAAQ,EAAE;IAC1C,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,QAAQ,EAAE;IACrC,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,QAAQ,EAAE;IACpC,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE;IAClC,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,SAAS,EAAE;CACvC,CAAA"}

package/dist/types/account.d.ts

@@ -2,22 +2,43 @@ import type { Asset } from './asset.js';
 import type { ActionType, ActivityType, FillClassification, FillStatus, LiquidityRole, MarginMode, OrderSide, OrderType, PositionSide } from './enums.js';
 import type { MarketDisplay, PerpsMarketDisplay } from './market.js';
 import type { Address } from './primitives.js';
-/** @public */
+/**
+ * Maker and taker fee rates for the account's current venue tier.
+ * Values are decimal fractions represented as strings (for example, `"0.0002"`).
+ *
+ * @public
+ */
 export interface FeeTier {
+    /** Decimal fraction charged to maker fills, represented as a string. */
     maker: string;
+    /** Decimal fraction charged to taker fills, represented as a string. */
     taker: string;
 }
-/** @public */
+/**
+ * Normalized open perpetual position with prices, margin, and PnL expressed as
+ * decimal strings to preserve provider precision.
+ *
+ * @public
+ */
 export interface Position {
     market: PerpsMarketDisplay;
     side: PositionSide;
+    /** Position quantity in base-asset units. */
     size: string;
+    /** Average entry price in quote-asset units. */
     entryPrice: string;
+    /** Current provider mark price in quote-asset units. */
     markPrice: string;
+    /** Estimated liquidation price in quote-asset units. */
     liquidationPrice: string;
+    /** Unrealized PnL in quote-currency units. */
     unrealizedPnl: string;
+    /** Position leverage as a numeric multiple. */
     leverage: number;
-    /** Margin allocated to the position, excluding unrealized PnL. */
+    /**
+     * Margin allocated and reserved by this position as a decimal string,
+     * excluding unrealized PnL.
+     */
     marginUsed: string;
     /**
      * Exact initial margin the venue currently requires for this position.
@@ -38,20 +59,33 @@ export interface PositionMarginConstraints {
     /** Smallest accepted margin amount, as an exact decimal string. */
     amountIncrement: string;
 }
-/** @public */
+/**
+ * Normalized non-trigger order currently open at a provider.
+ *
+ * @public
+ */
 export interface OpenOrder {
     orderId: string;
     market: MarketDisplay;
     side: OrderSide;
     type: OrderType;
+    /** Remaining order quantity in base-asset units. */
     size: string;
+    /** Limit/order price in quote-asset units. */
     price: string;
+    /** Quantity already filled in base-asset units. */
     filledSize: string;
     reduceOnly: boolean;
     label?: string;
+    /** ISO-8601 creation timestamp. */
     createdAt: string;
 }
-/** @public */
+/**
+ * Asset balance normalized across providers. `units` and `valueUsd` are
+ * decimal strings; `valueUsd` is the balance's USD valuation.
+ *
+ * @public
+ */
 export interface Balance {
     /** Which category/venue this balance sits in — references a {@link ProviderCategory}. */
     categoryId: string;
@@ -66,7 +100,12 @@ export interface Balance {
      */
     collateralWeight?: number;
 }
-/** @public */
+/**
+ * Account snapshot returned by a provider, including balances, positions,
+ * aggregate margin/PnL, and provider-specific configuration.
+ *
+ * @public
+ */
 export interface AccountResponse {
     provider: string;
     address: Address;
@@ -76,16 +115,27 @@ export interface AccountResponse {
     collateralBalances: Balance[];
     /** Open positions the snapshot already computed; equals the unfiltered `getPositions` output. */
     positions: Position[];
+    /** Margin reserved across the account, represented as a decimal string. */
     marginUsed: string;
+    /** Unrealized account PnL, represented as a decimal string. */
     unrealizedPnl: string;
     feeTier: FeeTier;
     config: AccountConfig;
 }
-/** @public */
+/**
+ * Aggregate account values for a provider stream or response. Monetary values
+ * are decimal strings in USD.
+ *
+ * @public
+ */
 export interface AccountSummary {
+    /** Total account portfolio value in USD. */
     portfolioValue: string;
+    /** Margin currently available for new orders in USD. */
     availableMargin: string;
+    /** Margin currently reserved by open positions/orders in USD. */
     marginUsed: string;
+    /** Aggregate unrealized PnL in USD. */
     unrealizedPnl: string;
 }
 /**
@@ -98,31 +148,50 @@ export interface MarketSettings {
     marginMode: MarginMode;
     leverage: number;
 }
-/** @public */
+/**
+ * Normalized take-profit or stop-loss order waiting for its trigger condition.
+ *
+ * @public
+ */
 export interface TriggerOrder {
     orderId: string;
     market: MarketDisplay;
     type: OrderType;
+    /** Triggered quantity in base-asset units. */
     size: string;
+    /** Price at which the trigger activates, in quote-asset units. */
     triggerPrice: string;
+    /** Optional limit price submitted after activation, in quote-asset units. */
     limitPrice?: string;
     label?: string;
     createdAt: string;
 }
-/** @public */
+/**
+ * Paginated open-position response for one provider and account.
+ *
+ * @public
+ */
 export interface PositionsResponse {
     provider: string;
     positions: Position[];
     pagination: Pagination;
 }
-/** @public */
+/**
+ * Paginated open-order response containing regular and trigger orders.
+ *
+ * @public
+ */
 export interface OrdersResponse {
     provider: string;
     openOrders: OpenOrder[];
     triggerOrders: TriggerOrder[];
     pagination: Pagination;
 }
-/** @public */
+/**
+ * Normalized execution/fill record for an order.
+ *
+ * @public
+ */
 export interface Fill {
     id: string;
     orderId: string;
@@ -144,46 +213,81 @@ export interface Fill {
     startPosition?: string;
     classification: FillClassification;
     createdAt: string;
+    /** Fully-resolved block-explorer URL for the settling on-chain tx. Absent when
+     * the fill has no on-chain settlement tx. */
     explorerLink?: string;
 }
-/** @public */
+/**
+ * Cursor pagination metadata. `cursor` and `nextUrl` are provider-specific
+ * continuation values and are absent when no further page exists.
+ *
+ * @public
+ */
 export interface Pagination {
     limit: number;
     hasMore: boolean;
     cursor?: string;
     nextUrl?: string;
 }
-/** @public */
+/**
+ * Paginated fill response for one provider and account.
+ *
+ * @public
+ */
 export interface FillsResponse {
     provider: string;
     items: Fill[];
     pagination: Pagination;
 }
-/** @public */
+/**
+ * Common identity and timestamp fields shared by account activity records.
+ * `timestamp` is an ISO-8601 timestamp string.
+ *
+ * @public
+ */
 export interface BaseActivity {
     id: string;
     provider: string;
     timestamp: string;
 }
-/** @public */
+/**
+ * Account activity representing a completed deposit.
+ *
+ * @public
+ */
 export interface DepositActivity extends BaseActivity {
     type: ActivityType.DEPOSIT;
     amount: string;
+    /** Fully-resolved block-explorer URL for the on-chain deposit tx. */
     explorerLink?: string;
 }
-/** @public */
+/**
+ * Account activity representing a completed withdrawal. `amount` and `fee`
+ * are decimal strings in the transferred asset's units.
+ *
+ * @public
+ */
 export interface WithdrawalActivity extends BaseActivity {
     type: ActivityType.WITHDRAWAL;
     amount: string;
     fee: string;
+    /** Fully-resolved block-explorer URL for the on-chain withdrawal tx. */
     explorerLink?: string;
 }
-/** @public */
+/**
+ * Position details attached to a liquidation activity.
+ *
+ * @public
+ */
 export interface LiquidatedPosition {
     market: MarketDisplay;
     size: string;
 }
-/** @public */
+/**
+ * Account activity representing a liquidation event.
+ *
+ * @public
+ */
 export interface LiquidationActivity extends BaseActivity {
     type: ActivityType.LIQUIDATION;
     liquidatedNotionalPosition: string;
@@ -191,7 +295,12 @@ export interface LiquidationActivity extends BaseActivity {
     leverageType: string;
     liquidatedPositions: LiquidatedPosition[];
 }
-/** @public */
+/**
+ * Account activity representing a periodic funding payment. Amount and rate
+ * retain provider precision as decimal strings.
+ *
+ * @public
+ */
 export interface FundingActivity extends BaseActivity {
     type: ActivityType.FUNDING;
     market: MarketDisplay;
@@ -199,13 +308,19 @@ export interface FundingActivity extends BaseActivity {
     positionSize: string;
     fundingRate: string;
 }
-/** @public */
+/**
+ * Account activity representing an inbound or outbound transfer. At least one
+ * counterparty identifier is required by the type-level union below.
+ *
+ * @public
+ */
 export type TransferActivity = BaseActivity & {
     type: ActivityType.TRANSFER;
     direction: 'IN' | 'OUT';
     asset: string;
     amount: string;
     meta?: Record<string, unknown>;
+    /** Fully-resolved block-explorer URL for the on-chain transfer tx. */
     explorerLink?: string;
 } & ({
     counterpartyAccountIndex: number;
@@ -214,24 +329,45 @@ export type TransferActivity = BaseActivity & {
     counterpartyAccountIndex?: number;
     counterpartyAddress: string;
 });
-/** @public */
+/**
+ * Discriminated union of all activity records returned by a provider.
+ *
+ * @public
+ */
 export type ActivityItem = DepositActivity | WithdrawalActivity | LiquidationActivity | FundingActivity | TransferActivity;
-/** @public */
+/**
+ * Paginated account-activity response for one provider and account.
+ *
+ * @public
+ */
 export interface ActivitiesResponse {
     provider: string;
     items: ActivityItem[];
     pagination: Pagination;
 }
-/** @public */
+/**
+ * Provider-specific Hyperliquid agent configuration. The record contents are
+ * provider-defined and intentionally left opaque to the shared type package.
+ *
+ * @public
+ */
 export type HyperliquidAgent = Record<string, unknown>;
-/** @public */
+/**
+ * Hyperliquid builder-fee approval state for an account.
+ *
+ * @public
+ */
 export interface HyperliquidBuilderFeeApproval {
     builderAddress: string;
     /** Basis points as a string. */
     maxFeeRate: string;
     approved: boolean;
 }
-/** @public */
+/**
+ * Hyperliquid account configuration returned in {@link AccountResponse.config}.
+ *
+ * @public
+ */
 export interface HyperliquidAccountConfig {
     provider: 'hyperliquid';
     /** `null` means abstraction has never been set. */
@@ -239,7 +375,11 @@ export interface HyperliquidAccountConfig {
     agents: HyperliquidAgent[];
     builderFeeApproval?: HyperliquidBuilderFeeApproval;
 }
-/** @public */
+/**
+ * Lighter spot-asset collateral setting for a single asset.
+ *
+ * @public
+ */
 export interface LighterAssetCollateral {
     /** Provider-native spot asset id (matches `Asset.id`). */
     assetId: string;
@@ -255,7 +395,12 @@ export interface LighterAssetCollateral {
  * @public
  */
 export type LighterProviderKey = 'lighter' | 'lighter-rh';
-/** @public */
+/**
+ * Lighter account configuration returned in {@link AccountResponse.config}.
+ * Numeric identifiers and account modes use the provider's wire values.
+ *
+ * @public
+ */
 export interface LighterAccountConfig {
     provider: LighterProviderKey;
     accountIndex: number;
@@ -285,7 +430,12 @@ export interface LighterAccountConfig {
      */
     referralPresent: boolean;
 }
-/** @public */
+/**
+ * Ondo account/session configuration returned in {@link AccountResponse.config}.
+ * Expiry values are Unix timestamps in seconds.
+ *
+ * @public
+ */
 export interface OndoAccountConfig {
     provider: 'ondo';
     loggedIn: boolean;
@@ -300,15 +450,28 @@ export interface OndoAccountConfig {
     /** Canonical Ethereum USDC deposit address, or `null` when none is provisioned. */
     depositAddress: string | null;
 }
-/** @public */
+/**
+ * Provider-specific account configuration discriminated by its `provider` key.
+ *
+ * @public
+ */
 export type AccountConfig = HyperliquidAccountConfig | LighterAccountConfig | OndoAccountConfig;
-/** @public */
+/**
+ * Named account-configuration value exposed to clients.
+ *
+ * @public
+ */
 export interface AccountConfigValue {
     name: string;
     /** `null` means no current value — consumers fall back to the descriptor default. */
     value: string | number | boolean | null;
 }
-/** @public */
+/**
+ * Account-configuration action and its available values, optionally including
+ * whether the setting is currently satisfied.
+ *
+ * @public
+ */
 export interface AccountConfigSetting {
     type: ActionType;
     values: AccountConfigValue[];