@lifi/perps-types 0.2.0-alpha.0 → 1.0.0

package/dist/types/enums.d.ts

@@ -0,0 +1,171 @@
+/** @public */
+export declare enum PerpsErrorCode {
+    DefaultError = 2000,
+    ServerError = 2001,
+    ValidationError = 2002,
+    TimeoutError = 2003,
+    ThirdPartyError = 2004,
+    SDKError = 2005,
+    SignatureInvalid = 2010,
+    AgentUnauthorized = 2011,
+    TermsNotAccepted = 2012,
+    ExchangeRejected = 2020,
+    InsufficientMargin = 2021,
+    InsufficientBalance = 2022,
+    MarketNotFound = 2023,
+    OrderNotFound = 2024,
+    PositionNotFound = 2025,
+    AccountNotFound = 2026,
+    InvalidNonce = 2040,
+    NonceAlreadyUsed = 2041,
+    NonceExpired = 2042,
+    PayloadMismatch = 2050,
+    RouteNotFound = 2060
+}
+/** @public */
+export declare enum OrderSide {
+    BUY = "BUY",
+    SELL = "SELL"
+}
+/** @public */
+export declare enum OrderType {
+    MARKET = "MARKET",
+    LIMIT = "LIMIT",
+    STOP_MARKET = "STOP_MARKET",
+    STOP_LIMIT = "STOP_LIMIT",
+    TAKE_PROFIT_MARKET = "TAKE_PROFIT_MARKET",
+    TAKE_PROFIT_LIMIT = "TAKE_PROFIT_LIMIT",
+    TRIGGER_ONLY = "TRIGGER_ONLY"
+}
+/** @public */
+export declare enum PositionSide {
+    LONG = "LONG",
+    SHORT = "SHORT"
+}
+/** @public */
+export declare enum MarginMode {
+    ISOLATED = "ISOLATED",
+    CROSS = "CROSS"
+}
+/** @public */
+export declare enum TimeInForce {
+    GTC = "GTC",
+    IOC = "IOC",
+    POST_ONLY = "POST_ONLY",
+    GTT = "GTT"
+}
+/** @public */
+export declare enum OrderStatus {
+    PENDING = "PENDING",
+    OPEN = "OPEN",
+    PARTIALLY_FILLED = "PARTIALLY_FILLED",
+    FILLED = "FILLED",
+    CANCELLED = "CANCELLED",
+    REJECTED = "REJECTED",
+    EXPIRED = "EXPIRED",
+    TRIGGERED = "TRIGGERED"
+}
+/** @public */
+export declare enum FillStatus {
+    FILLED = "FILLED",
+    PARTIALLY_FILLED = "PARTIALLY_FILLED",
+    CANCELLED = "CANCELLED",
+    REJECTED = "REJECTED"
+}
+/** @public */
+export declare enum LiquidityRole {
+    MAKER = "maker",
+    TAKER = "taker"
+}
+/** @public */
+export declare enum ActionType {
+    APPROVE_AGENT = "approveAgent",
+    APPROVE_BUILDER_FEE = "approveBuilderFee",
+    ACCOUNT_MODE = "accountMode",
+    ACCOUNT_TYPE = "accountType",
+    SEND_ASSET = "sendAsset",
+    WITHDRAWAL = "withdrawal",
+    TRANSFER = "transfer",
+    PLACE_ORDER = "placeOrder",
+    PLACE_TRIGGER_ORDER = "placeTriggerOrder",
+    CANCEL_ORDER = "cancelOrder",
+    CANCEL_ALL_ORDERS = "cancelAllOrders",
+    MODIFY_ORDER = "modifyOrder",
+    UPDATE_LEVERAGE = "updateLeverage",
+    UPDATE_POSITION_MARGIN = "updatePositionMargin",
+    REGISTER_API_KEY = "registerApiKey",
+    APPROVE_READ_ONLY_TOKEN = "approveReadOnlyToken",
+    DEPOSIT = "deposit",
+    /** Provider-independent: sent with the `META_PROVIDER` sentinel, not a real provider key. */
+    META_VOTE = "metaVote",
+    /** Provider-independent: sent with the `META_PROVIDER` sentinel, not a real provider key. */
+    META_ACCEPT_TERMS = "metaAcceptTerms"
+}
+/** @public */
+export declare enum TriggerCondition {
+    ABOVE = "ABOVE",
+    BELOW = "BELOW"
+}
+/** @public */
+export declare enum TriggerOrderType {
+    TAKE_PROFIT = "TAKE_PROFIT",
+    STOP_LOSS = "STOP_LOSS"
+}
+/** @public */
+export declare enum TriggerOrderStatus {
+    WAITING = "WAITING",
+    TRIGGERED = "TRIGGERED",
+    CANCELLED = "CANCELLED"
+}
+/** @public */
+export declare enum ActivityType {
+    DEPOSIT = "DEPOSIT",
+    WITHDRAWAL = "WITHDRAWAL",
+    LIQUIDATION = "LIQUIDATION",
+    FUNDING = "FUNDING",
+    TRANSFER = "TRANSFER"
+}
+/** @public */
+export declare enum FillClassification {
+    OPENED_LONG = "Opened Long",
+    OPENED_SHORT = "Opened Short",
+    INCREASED_LONG = "Increased Long",
+    INCREASED_SHORT = "Increased Short",
+    REDUCED_LONG = "Reduced Long",
+    REDUCED_SHORT = "Reduced Short",
+    CLOSED_LONG = "Closed Long",
+    CLOSED_SHORT = "Closed Short",
+    SWITCHED_LONG = "Switched Long",
+    SWITCHED_SHORT = "Switched Short",
+    SPOT_BUY = "Spot Buy",
+    SPOT_SELL = "Spot Sell"
+}
+/** @public */
+export declare enum LiquidationClassification {
+    LIQUIDATED = "Liquidated"
+}
+/** @public */
+export declare enum FundingClassification {
+    FUNDING = "Funding"
+}
+/** @public */
+export declare enum TransferClassification {
+    DEPOSIT = "Deposit",
+    WITHDRAWAL = "Withdrawal",
+    TRANSFER = "Transfer"
+}
+/** @public */
+export type ActivityClassification = FillClassification | LiquidationClassification | FundingClassification | TransferClassification;
+/** @public */
+export declare enum PerpsSigner {
+    USER = "USER",
+    AGENT = "AGENT",
+    API_KEY = "API_KEY"
+}
+/** @public */
+export declare enum SigningMethod {
+    EIP712 = "eip712",
+    WASM_BLOB = "wasmBlob",
+    EVM_TX = "evmTx"
+}
+//# sourceMappingURL=enums.d.ts.map

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

@@ -0,0 +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;IAGvB,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,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,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,gBAAgB,mBAAmB;IACnC,uBAAuB,yBAAyB;IAChD,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,cAAc;AACd,oBAAY,WAAW;IACrB,IAAI,SAAS;IACb,KAAK,UAAU;IACf,OAAO,YAAY;CACpB;AAED,cAAc;AACd,oBAAY,aAAa;IACvB,MAAM,WAAW;IACjB,SAAS,aAAa;IACtB,MAAM,UAAU;CACjB"}

package/dist/types/errors.d.ts

@@ -0,0 +1,8 @@
+import type { PerpsErrorCode } from './enums.js';
+/** @public */
+export interface PerpsErrorBody {
+    code: PerpsErrorCode;
+    tool?: string;
+    message: string;
+}
+//# sourceMappingURL=errors.d.ts.map

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

@@ -0,0 +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"}

package/dist/types/index.d.ts

@@ -0,0 +1,23 @@
+/**
+ * `@lifi/perps-types` — shared cross-provider type surface for the perps SDK:
+ * account/order/market shapes, action params, enums, error codes, provider
+ * descriptors, subscriptions, and EIP-712 typed-data structures.
+ *
+ * @packageDocumentation
+ * @public
+ */
+export * from './acceptTerms.js';
+export * from './account.js';
+export * from './action.js';
+export * from './asset.js';
+export * from './enums.js';
+export * from './errors.js';
+export * from './market.js';
+export * from './meta.js';
+export * from './primitives.js';
+export * from './providers.js';
+export * from './quote.js';
+export * from './subscriptions.js';
+export * from './typedData.js';
+export * from './vote.js';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +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"}

package/dist/types/market.d.ts

@@ -0,0 +1,107 @@
+import type { Asset } from './asset.js';
+/** @public */
+export interface FundingInfo {
+    rate: string;
+    nextFundingTime: number;
+}
+/** @public */
+export interface BaseMarket {
+    providerId: string;
+    /** Opaque provider market id; referenced elsewhere as `marketId`. */
+    id: string;
+    /** References a {@link ProviderCategory} by id. */
+    categoryId: string;
+    baseAsset: Asset;
+    quoteAsset: Asset;
+    szDecimals: number;
+    /**
+     * Maximum decimal places the venue accepts for order prices on this market.
+     * Some venues impose further constraints on top of this budget (e.g. a
+     * significant-figure cap), so always format prices through the provider's
+     * `formatOrderPrice` rather than applying this field directly.
+     */
+    priceDecimals?: number;
+}
+/** @public */
+export interface PerpsMarket extends BaseMarket {
+    maxLeverage: number;
+    onlyIsolated: boolean;
+    /**
+     * Venue maintenance margin rate for this market as a fraction (e.g. `0.012`
+     * = 1.2%). Feeds client-side liquidation-price estimates via the provider's
+     * `estimateLiquidationPrice`.
+     */
+    maintenanceMarginRate?: number;
+}
+/** @public */
+export interface SpotMarket extends BaseMarket {
+}
+/** @public */
+export type Market = PerpsMarket | SpotMarket;
+/** @public */
+export type MarketDisplay = Pick<BaseMarket, 'providerId' | 'id' | 'categoryId' | 'baseAsset' | 'quoteAsset'>;
+/**
+ * Minimal market reference for write-action params: identifies a market by
+ * its opaque `marketId` within a `categoryId`. Embeds no Assets — write
+ * params reference by id, not value.
+ * @public
+ */
+export interface MarketRef {
+    marketId: string;
+    categoryId: string;
+}
+/** @public */
+export interface MarketsResponse {
+    markets: Market[];
+}
+/**
+ * Live per-market data for the `/prices` endpoint. `price` is the mid;
+ * `markPrice`, `prevDayPrice` and `volume24h` apply to every market type,
+ * while `openInterest` and `funding` are perp-only and absent for spot.
+ * @public
+ */
+export interface MarketPrice {
+    marketId: string;
+    price: string;
+    markPrice: string;
+    prevDayPrice?: string;
+    volume24h?: string;
+    openInterest?: string;
+    funding?: FundingInfo;
+}
+/** @public */
+export interface PricesResponse {
+    prices: MarketPrice[];
+}
+/** @public */
+export interface Candle {
+    t: number;
+    o: string;
+    h: string;
+    l: string;
+    c: string;
+    v: string;
+}
+/** @public */
+export interface OhlcvResponse {
+    provider: string;
+    marketId: string;
+    interval: string;
+    candles: Candle[];
+}
+/** @public */
+export type OhlcvInterval = '1m' | '3m' | '5m' | '15m' | '30m' | '1h' | '2h' | '4h' | '8h' | '12h' | '1d' | '3d' | '1w' | '1M';
+/** @public */
+export interface OrderbookLevel {
+    price: string;
+    size: string;
+}
+/** @public */
+export interface OrderbookResponse {
+    provider: string;
+    marketId: string;
+    bids: OrderbookLevel[];
+    asks: OrderbookLevel[];
+    timestamp: number;
+}
+//# sourceMappingURL=market.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"market.d.ts","sourceRoot":"","sources":["../../src/market.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AAEvC,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,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;CACvB;AAED,cAAc;AACd,MAAM,WAAW,WAAY,SAAQ,UAAU;IAC7C,WAAW,EAAE,MAAM,CAAA;IACnB,YAAY,EAAE,OAAO,CAAA;IACrB;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAA;CAC/B;AAED,cAAc;AACd,MAAM,WAAW,UAAW,SAAQ,UAAU;CAAG;AAEjD,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,CAChE,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;;;;;GAKG;AACH,MAAM,WAAW,WAAW;IAC1B,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,EAAE,MAAM,CAAA;IACb,SAAS,EAAE,MAAM,CAAA;IACjB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,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,WAAW,EAAE,CAAA;CACtB;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"}

package/dist/types/meta.d.ts

@@ -0,0 +1,37 @@
+/**
+ * A single platform-level advisory shown to all users, independent of any
+ * provider or market.
+ * @public
+ */
+export interface Notice {
+    /** Unix epoch milliseconds. */
+    timestamp: number;
+    title: string;
+    message: string;
+    /** Optional URL the notice links to; rendered as a hyperlink when present. */
+    link?: string;
+}
+/**
+ * Read-only platform metadata served by `GET /v1/perps/meta`.
+ * @public
+ */
+export interface Meta {
+    version: string;
+    notices: Notice[];
+}
+/**
+ * Current Terms-of-Service and this address's acceptance, served by
+ * `GET /v1/perps/meta/terms?address=`.
+ * @public
+ */
+export interface TermsAcceptanceStatus {
+    /** Backend-owned version identifier for the current terms. */
+    termsVersion: string;
+    /** Full current terms-of-service text. */
+    content: string;
+    /** Whether the queried address has accepted {@link TermsAcceptanceStatus.termsVersion}. */
+    accepted: boolean;
+    /** Unix epoch milliseconds the address accepted; absent when not accepted. */
+    acceptedAt?: number;
+}
+//# sourceMappingURL=meta.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"meta.d.ts","sourceRoot":"","sources":["../../src/meta.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,WAAW,MAAM;IACrB,+BAA+B;IAC/B,SAAS,EAAE,MAAM,CAAA;IACjB,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,MAAM,CAAA;IACf,8EAA8E;IAC9E,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED;;;GAGG;AACH,MAAM,WAAW,IAAI;IACnB,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,EAAE,MAAM,EAAE,CAAA;CAClB;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC,8DAA8D;IAC9D,YAAY,EAAE,MAAM,CAAA;IACpB,0CAA0C;IAC1C,OAAO,EAAE,MAAM,CAAA;IACf,2FAA2F;IAC3F,QAAQ,EAAE,OAAO,CAAA;IACjB,8EAA8E;IAC9E,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB"}

package/dist/types/primitives.d.ts

@@ -0,0 +1,5 @@
+/** @public */
+export type Address = `0x${string}`;
+/** @public */
+export type Hex = `0x${string}`;
+//# sourceMappingURL=primitives.d.ts.map

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

@@ -0,0 +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"}

package/dist/types/providers.d.ts

@@ -0,0 +1,116 @@
+import type { Asset } from './asset.js';
+import type { ActionType, PerpsSigner, SigningMethod } from './enums.js';
+import type { OhlcvInterval } from './market.js';
+/** @public */
+export interface ParamOption {
+    value: string;
+    label: string;
+}
+/** @public */
+export interface Param {
+    /** Wire key for the action params object: `{ [param.name]: value }`. */
+    name: string;
+    type: 'string';
+    /** Present iff the parameter has a fixed enumeration of admissible values. */
+    values?: ParamOption[];
+    default?: ParamOption;
+    readOnly?: boolean;
+}
+/**
+ * A single provider action. The same shape backs `Provider.setup`,
+ * `Provider.options`, and `Provider.actions` — categorisation lives in which
+ * array it sits in, not in the type. The core three fields are always present;
+ * the rest are presentation/ordering hints provided per-action in the
+ * provider's hardcoded metadata.
+ * @public
+ */
+export interface ProviderAction {
+    type: ActionType;
+    signers: PerpsSigner[];
+    signingMethod: SigningMethod;
+    /**
+     * Human label. Drives the card heading in the setup/options modals, and may
+     * also front an in-flight trading action ("{title} is working…").
+     */
+    title?: string;
+    description?: string;
+    /** UI form fields the widget renders to collect input for this action. */
+    params?: Param[];
+    /**
+     * Ascending order in which the user satisfies setup steps. Cloud-init
+     * convention: 10, 20, 30, … with 99 reserved for "always last"; the gaps
+     * leave room to insert steps later without renumbering. Lower runs first;
+     * a step may depend on every lower-sequenced step already being satisfied.
+     */
+    sequence?: number;
+}
+/**
+ * Provider-attached advisory shown against a market. Provider-agnostic: the
+ * producer decides when to emit one (e.g. an HL HIP-3 sub-dex risk warning).
+ * @public
+ */
+export interface TradeNotice {
+    /** Maps to the widget's panel styling: `warn` → warning, `info` → info. */
+    level: 'info' | 'warn';
+    /** Plaintext; any URL is rendered as text, not a hyperlink. */
+    message: string;
+}
+/** @public */
+export interface ProviderCategory {
+    id: string;
+    logoURI?: string;
+    /** `null` for the "spot" category — no single fixed quote. */
+    quoteAsset: Asset | null;
+    tradeNotice?: TradeNotice;
+}
+/** @public */
+export interface Provider {
+    key: string;
+    name: string;
+    logoURI: string;
+    signingMethod: SigningMethod;
+    /** When false, the provider is announced but not yet selectable in clients. */
+    active: boolean;
+    setup: ProviderAction[];
+    options: ProviderAction[];
+    actions: ProviderAction[];
+    categories: ProviderCategory[];
+    wsUrl?: string;
+    /** Absent means no minimum advertised. */
+    minDepositUsd?: number;
+    /**
+     * Minimum order notional value in USD. Feeds the SDK's `validateMargin`
+     * `minMarginUsd` parameter. Absent means no minimum advertised.
+     */
+    minOrderValueUsd?: number;
+    /**
+     * Minimum order notional value in USD for reduce-only orders, when the
+     * provider applies a lower floor than `minOrderValueUsd`. Absent means
+     * reduce-only orders use the same floor as `minOrderValueUsd`.
+     */
+    minReduceOrderValueUsd?: number;
+    /** Minimum withdrawal notional in USD. Absent means no minimum advertised. */
+    minWithdrawalUsd?: number;
+    /** Flat deposit fee in USD the provider charges. Absent means no fee advertised. */
+    depositFeeUsd?: number;
+    /** Flat withdrawal fee in USD the provider charges. Absent means no fee advertised. */
+    withdrawalFeeUsd?: number;
+    /**
+     * Aggregate up-votes for this provider. Populated only for inactive
+     * providers (those gathering demand before launch); absent once `active`.
+     */
+    upVotes?: number;
+    /** Aggregate down-votes. Populated only for inactive providers; see {@link upVotes}. */
+    downVotes?: number;
+    /**
+     * Candle intervals this provider supports for OHLCV/chart requests, in
+     * ascending order. Drives the client's chart interval selector. Empty for
+     * providers that expose no candle data.
+     */
+    supportedIntervals: OhlcvInterval[];
+}
+/** @public */
+export interface ProvidersResponse {
+    providers: Provider[];
+}
+//# sourceMappingURL=providers.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"providers.d.ts","sourceRoot":"","sources":["../../src/providers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AACvC,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,8EAA8E;IAC9E,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,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,0CAA0C;IAC1C,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;;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"}

package/dist/types/quote.d.ts

@@ -0,0 +1,47 @@
+import type { FeeTier } from './account.js';
+import type { FundingInfo } from './market.js';
+/** @public */
+export type QuoteSide = 'buy' | 'sell';
+/** @public */
+export type TradeType = 'perps' | 'spot';
+/**
+ * One-shot fill estimate for a market order of `sizeUsd` notional on a single
+ * venue: the VWAP fill walked from the orderbook, the price impact versus the
+ * mark, the base-tier taker fee, and (for perps) the current funding rate.
+ *
+ * `priceImpactBps` is signed-magnitude basis points (1 bps = 0.01%) of the
+ * VWAP fill's deviation from `markPrice` — always non-negative, since a buy
+ * fills above mark and a sell below.
+ * @public
+ */
+export interface Quote {
+    provider: string;
+    /** Human `displaySymbol` the quote was resolved against, e.g. `"BTC"`. */
+    symbol: string;
+    /** Opaque resolved `Market.id`. */
+    marketId: string;
+    type: TradeType;
+    side: QuoteSide;
+    /** Input notional in USD. */
+    sizeUsd: string;
+    /** Base amount the book filled for `sizeUsd` (or the most obtainable when the book is too thin). */
+    baseSize: string;
+    markPrice: string;
+    /** Volume-weighted average fill price from the book walk. */
+    expectedFillPrice: string;
+    /** VWAP deviation from `markPrice` in basis points; non-negative. */
+    priceImpactBps: string;
+    /** Base maker/taker fee fractions (not bps) for the public tier. */
+    feeTier: FeeTier;
+    /** Always `true` in v1 — quotes use the public base tier, never a per-account tier. */
+    isDefaultFeeTier: boolean;
+    /** Taker fee on the filled notional in USD: `filledNotional * feeTier.taker`. */
+    feeUsd: string;
+    /** Current funding for perps; `null` for spot. */
+    funding: FundingInfo | null;
+    /** `true` when the book could not fill the full `sizeUsd` — `baseSize`/fill reflect the best obtainable. */
+    insufficientLiquidity: boolean;
+    /** Unix milliseconds the quote was produced. */
+    timestamp: number;
+}
+//# sourceMappingURL=quote.d.ts.map

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

@@ -0,0 +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"}

package/dist/types/subscriptions.d.ts

@@ -0,0 +1,115 @@
+import type { Balance, Fill, OpenOrder, Position, TriggerOrder } from './account.js';
+import type { Candle, OhlcvInterval, OrderbookResponse } from './market.js';
+import type { Address } from './primitives.js';
+/** @public */
+export type PricesSubscription = {
+    channel: 'prices';
+    dex: string;
+};
+/** @public */
+export type OrderbookSubscription = {
+    channel: 'orderbook';
+    dex: string;
+    marketId: string;
+    depth?: number;
+    /**
+     * Desired price granularity of streamed levels, in quote currency (e.g.
+     * `10` buckets a BTC book into $10-wide levels). Providers that aggregate
+     * the book server-side honour it best-effort; providers that stream the
+     * full book ignore it. `undefined` requests full precision.
+     */
+    priceStep?: number;
+};
+/** @public */
+export type CandleSubscription = {
+    channel: 'candle';
+    dex: string;
+    marketId: string;
+    interval: OhlcvInterval;
+};
+/** @public */
+export type OrderUpdatesSubscription = {
+    channel: 'orderUpdates';
+    dex: string;
+    address: Address;
+};
+/** @public */
+export type FillsSubscription = {
+    channel: 'fills';
+    dex: string;
+    address: Address;
+};
+/** @public */
+export type PositionsSubscription = {
+    channel: 'positions';
+    dex: string;
+    address: Address;
+};
+/** @public */
+export type SpotBalancesSubscription = {
+    channel: 'spotBalances';
+    dex: string;
+    address: Address;
+};
+/** @public */
+export type Subscription = PricesSubscription | OrderbookSubscription | CandleSubscription | OrderUpdatesSubscription | FillsSubscription | PositionsSubscription | SpotBalancesSubscription;
+/** @public */
+export type PricesEvent = {
+    channel: 'prices';
+    data: Record<string, string>;
+};
+/** @public */
+export type OrderbookEvent = {
+    channel: 'orderbook';
+    data: OrderbookResponse;
+};
+/** @public */
+export type CandleEvent = {
+    channel: 'candle';
+    data: Candle;
+};
+/** @public */
+export type OrderUpdatesEvent = {
+    channel: 'orderUpdates';
+    data: {
+        /** Upserts — active orders, non-trigger. */
+        openOrders: OpenOrder[];
+        /** Upserts — active orders with trigger semantics (TP/SL). */
+        triggerOrders: TriggerOrder[];
+        /**
+         * orderIds whose status just transitioned to terminal (filled, cancelled,
+         * rejected, expired). Consumers should evict these from both buckets.
+         */
+        terminated: string[];
+    };
+};
+/** @public */
+export type FillsEvent = {
+    channel: 'fills';
+    data: Fill[];
+};
+/**
+ * Positions stream frame. `data` is always the full set of currently open
+ * positions for the subscribed address, never a partial update: zero-size
+ * entries never appear, and a close is observed as the market's absence from
+ * the next frame. Consumers replace their state; they must not merge.
+ * @public
+ */
+export type PositionsEvent = {
+    channel: 'positions';
+    data: Position[];
+};
+/**
+ * Spot holdings as typed {@link Balance}s, each carrying the venue-locked
+ * portion (`locked` = reserved against open orders; `available = units − locked`).
+ * @public
+ */
+export type SpotBalancesEvent = {
+    channel: 'spotBalances';
+    data: (Balance & {
+        locked: string;
+    })[];
+};
+/** @public */
+export type SubscriptionEvent = PricesEvent | OrderbookEvent | CandleEvent | OrderUpdatesEvent | FillsEvent | PositionsEvent | SpotBalancesEvent;
+//# sourceMappingURL=subscriptions.d.ts.map