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

package/dist/types/account.d.ts

@@ -0,0 +1,229 @@
+import type { Asset } from './asset.js';
+import type { ActionType, ActivityType, FillClassification, FillStatus, LiquidityRole, MarginMode, OrderSide, OrderType, PositionSide } from './enums.js';
+import type { MarketDisplay } from './market.js';
+import type { Address } from './primitives.js';
+/** @public */
+export interface FeeTier {
+    maker: string;
+    taker: string;
+}
+/** @public */
+export interface Position {
+    market: MarketDisplay;
+    side: PositionSide;
+    size: string;
+    entryPrice: string;
+    markPrice: string;
+    liquidationPrice: string;
+    unrealizedPnl: string;
+    leverage: number;
+    marginUsed: string;
+    marginMode: MarginMode;
+}
+/** @public */
+export interface OpenOrder {
+    orderId: string;
+    market: MarketDisplay;
+    side: OrderSide;
+    type: OrderType;
+    size: string;
+    price: string;
+    filledSize: string;
+    reduceOnly: boolean;
+    label?: string;
+    createdAt: string;
+}
+/** @public */
+export interface Balance {
+    /** Which category/venue this balance sits in — references a {@link ProviderCategory}. */
+    categoryId: string;
+    asset: Asset;
+    units: string;
+    /** USD value the SDK fills from the prices map; consumers render with zero math. */
+    valueUsd: string;
+}
+/** @public */
+export interface AccountResponse {
+    provider: string;
+    address: Address;
+    /** Flat, NON-collateral holdings. */
+    balances: Balance[];
+    /** SDK-determined collateral subset: spot balances in a category's quote asset. */
+    collateralBalances: Balance[];
+    marginUsed: string;
+    unrealizedPnl: string;
+    feeTier: FeeTier;
+    config: AccountConfig;
+}
+/** @public */
+export interface AccountSummary {
+    portfolioValue: string;
+    availableMargin: string;
+    marginUsed: string;
+    unrealizedPnl: string;
+}
+/** @public */
+export interface TriggerOrder {
+    orderId: string;
+    market: MarketDisplay;
+    type: OrderType;
+    size: string;
+    triggerPrice: string;
+    limitPrice?: string;
+    label?: string;
+    createdAt: string;
+}
+/** @public */
+export interface PositionsResponse {
+    provider: string;
+    positions: Position[];
+    pagination: Pagination;
+}
+/** @public */
+export interface OrdersResponse {
+    provider: string;
+    openOrders: OpenOrder[];
+    triggerOrders: TriggerOrder[];
+    pagination: Pagination;
+}
+/** @public */
+export interface Fill {
+    id: string;
+    orderId: string;
+    market: MarketDisplay;
+    side: OrderSide;
+    type: OrderType;
+    size: string;
+    price: string;
+    status: FillStatus;
+    liquidity: LiquidityRole;
+    filledSize?: string;
+    fee?: string;
+    realizedPnl?: string | null;
+    startPosition?: string;
+    classification: FillClassification;
+    createdAt: string;
+    explorerLink?: string;
+}
+/** @public */
+export interface Pagination {
+    limit: number;
+    hasMore: boolean;
+    cursor?: string;
+    nextUrl?: string;
+}
+/** @public */
+export interface FillsResponse {
+    provider: string;
+    items: Fill[];
+    pagination: Pagination;
+}
+/** @public */
+export interface BaseActivity {
+    id: string;
+    provider: string;
+    timestamp: string;
+}
+/** @public */
+export interface DepositActivity extends BaseActivity {
+    type: ActivityType.DEPOSIT;
+    amount: string;
+    explorerLink?: string;
+}
+/** @public */
+export interface WithdrawalActivity extends BaseActivity {
+    type: ActivityType.WITHDRAWAL;
+    amount: string;
+    fee: string;
+    explorerLink?: string;
+}
+/** @public */
+export interface LiquidatedPosition {
+    market: MarketDisplay;
+    size: string;
+}
+/** @public */
+export interface LiquidationActivity extends BaseActivity {
+    type: ActivityType.LIQUIDATION;
+    liquidatedNotionalPosition: string;
+    accountValue: string;
+    leverageType: string;
+    liquidatedPositions: LiquidatedPosition[];
+}
+/** @public */
+export interface FundingActivity extends BaseActivity {
+    type: ActivityType.FUNDING;
+    market: MarketDisplay;
+    amount: string;
+    positionSize: string;
+    fundingRate: string;
+}
+/** @public */
+export type TransferActivity = BaseActivity & {
+    type: ActivityType.TRANSFER;
+    direction: 'IN' | 'OUT';
+    asset: string;
+    amount: string;
+    meta?: Record<string, unknown>;
+    explorerLink?: string;
+} & ({
+    counterpartyAccountIndex: number;
+    counterpartyAddress?: string;
+} | {
+    counterpartyAccountIndex?: number;
+    counterpartyAddress: string;
+});
+/** @public */
+export type ActivityItem = DepositActivity | WithdrawalActivity | LiquidationActivity | FundingActivity | TransferActivity;
+/** @public */
+export interface ActivitiesResponse {
+    provider: string;
+    items: ActivityItem[];
+    pagination: Pagination;
+}
+/** @public */
+export type HyperliquidAgent = Record<string, unknown>;
+/** @public */
+export interface HyperliquidBuilderFeeApproval {
+    builderAddress: string;
+    /** Basis points as a string. */
+    maxFeeRate: string;
+    approved: boolean;
+}
+/** @public */
+export interface HyperliquidAccountConfig {
+    provider: 'hyperliquid';
+    /** `null` means abstraction has never been set. */
+    abstractionMode: string | null;
+    agents: HyperliquidAgent[];
+    builderFeeApproval?: HyperliquidBuilderFeeApproval;
+}
+/** @public */
+export interface LighterAccountConfig {
+    provider: 'lighter';
+    accountIndex: number;
+    apiKeyIndex: number;
+    apiKeyRegistered: boolean;
+    accountType: number;
+    readOnlyTokenApproved: boolean;
+    /** Unix seconds. Present iff `readOnlyTokenApproved === true`. */
+    readOnlyTokenExpiry?: number;
+    /** Present iff `readOnlyTokenApproved === true`. */
+    readOnlyTokenScope?: 'single' | 'all';
+}
+/** @public */
+export type AccountConfig = HyperliquidAccountConfig | LighterAccountConfig;
+/** @public */
+export interface AccountConfigValue {
+    name: string;
+    /** `null` means no current value — consumers fall back to the descriptor default. */
+    value: string | number | boolean | null;
+}
+/** @public */
+export interface AccountConfigSetting {
+    type: ActionType;
+    values: AccountConfigValue[];
+    /** `undefined` means satisfaction is tracked outside `AccountConfig` (e.g. backend `checkSetup`). */
+    satisfied?: boolean;
+}
+//# sourceMappingURL=account.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"account.d.ts","sourceRoot":"","sources":["../../src/account.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AACvC,OAAO,KAAK,EACV,UAAU,EACV,YAAY,EACZ,kBAAkB,EAClB,UAAU,EACV,aAAa,EACb,UAAU,EACV,SAAS,EACT,SAAS,EACT,YAAY,EACb,MAAM,YAAY,CAAA;AACnB,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,aAAa,CAAA;AAChD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAA;AAE9C,cAAc;AACd,MAAM,WAAW,OAAO;IACtB,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;CACd;AAED,cAAc;AACd,MAAM,WAAW,QAAQ;IACvB,MAAM,EAAE,aAAa,CAAA;IACrB,IAAI,EAAE,YAAY,CAAA;IAClB,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,EAAE,MAAM,CAAA;IAClB,SAAS,EAAE,MAAM,CAAA;IACjB,gBAAgB,EAAE,MAAM,CAAA;IACxB,aAAa,EAAE,MAAM,CAAA;IACrB,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,UAAU,CAAA;CACvB;AAED,cAAc;AACd,MAAM,WAAW,SAAS;IACxB,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,aAAa,CAAA;IACrB,IAAI,EAAE,SAAS,CAAA;IACf,IAAI,EAAE,SAAS,CAAA;IACf,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,OAAO,CAAA;IACnB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,cAAc;AACd,MAAM,WAAW,OAAO;IACtB,yFAAyF;IACzF,UAAU,EAAE,MAAM,CAAA;IAClB,KAAK,EAAE,KAAK,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,oFAAoF;IACpF,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED,cAAc;AACd,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,OAAO,CAAA;IAChB,qCAAqC;IACrC,QAAQ,EAAE,OAAO,EAAE,CAAA;IACnB,mFAAmF;IACnF,kBAAkB,EAAE,OAAO,EAAE,CAAA;IAC7B,UAAU,EAAE,MAAM,CAAA;IAClB,aAAa,EAAE,MAAM,CAAA;IACrB,OAAO,EAAE,OAAO,CAAA;IAChB,MAAM,EAAE,aAAa,CAAA;CACtB;AAED,cAAc;AACd,MAAM,WAAW,cAAc;IAC7B,cAAc,EAAE,MAAM,CAAA;IACtB,eAAe,EAAE,MAAM,CAAA;IACvB,UAAU,EAAE,MAAM,CAAA;IAClB,aAAa,EAAE,MAAM,CAAA;CACtB;AAED,cAAc;AACd,MAAM,WAAW,YAAY;IAC3B,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,aAAa,CAAA;IACrB,IAAI,EAAE,SAAS,CAAA;IACf,IAAI,EAAE,MAAM,CAAA;IACZ,YAAY,EAAE,MAAM,CAAA;IACpB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,cAAc;AACd,MAAM,WAAW,iBAAiB;IAChC,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,QAAQ,EAAE,CAAA;IACrB,UAAU,EAAE,UAAU,CAAA;CACvB;AAED,cAAc;AACd,MAAM,WAAW,cAAc;IAC7B,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,SAAS,EAAE,CAAA;IACvB,aAAa,EAAE,YAAY,EAAE,CAAA;IAC7B,UAAU,EAAE,UAAU,CAAA;CACvB;AAED,cAAc;AACd,MAAM,WAAW,IAAI;IACnB,EAAE,EAAE,MAAM,CAAA;IACV,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,aAAa,CAAA;IACrB,IAAI,EAAE,SAAS,CAAA;IACf,IAAI,EAAE,SAAS,CAAA;IACf,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,UAAU,CAAA;IAClB,SAAS,EAAE,aAAa,CAAA;IACxB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,cAAc,EAAE,kBAAkB,CAAA;IAClC,SAAS,EAAE,MAAM,CAAA;IAGjB,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;AAED,cAAc;AACd,MAAM,WAAW,UAAU;IACzB,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,OAAO,CAAA;IAChB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED,cAAc;AACd,MAAM,WAAW,aAAa;IAC5B,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,EAAE,IAAI,EAAE,CAAA;IACb,UAAU,EAAE,UAAU,CAAA;CACvB;AAED,cAAc;AACd,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAA;IACV,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,cAAc;AACd,MAAM,WAAW,eAAgB,SAAQ,YAAY;IACnD,IAAI,EAAE,YAAY,CAAC,OAAO,CAAA;IAC1B,MAAM,EAAE,MAAM,CAAA;IAEd,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;AAED,cAAc;AACd,MAAM,WAAW,kBAAmB,SAAQ,YAAY;IACtD,IAAI,EAAE,YAAY,CAAC,UAAU,CAAA;IAC7B,MAAM,EAAE,MAAM,CAAA;IACd,GAAG,EAAE,MAAM,CAAA;IAEX,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;AAED,cAAc;AACd,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,aAAa,CAAA;IACrB,IAAI,EAAE,MAAM,CAAA;CACb;AAED,cAAc;AACd,MAAM,WAAW,mBAAoB,SAAQ,YAAY;IACvD,IAAI,EAAE,YAAY,CAAC,WAAW,CAAA;IAC9B,0BAA0B,EAAE,MAAM,CAAA;IAClC,YAAY,EAAE,MAAM,CAAA;IACpB,YAAY,EAAE,MAAM,CAAA;IACpB,mBAAmB,EAAE,kBAAkB,EAAE,CAAA;CAC1C;AAED,cAAc;AACd,MAAM,WAAW,eAAgB,SAAQ,YAAY;IACnD,IAAI,EAAE,YAAY,CAAC,OAAO,CAAA;IAC1B,MAAM,EAAE,aAAa,CAAA;IACrB,MAAM,EAAE,MAAM,CAAA;IACd,YAAY,EAAE,MAAM,CAAA;IACpB,WAAW,EAAE,MAAM,CAAA;CACpB;AAID,cAAc;AACd,MAAM,MAAM,gBAAgB,GAAG,YAAY,GAAG;IAC5C,IAAI,EAAE,YAAY,CAAC,QAAQ,CAAA;IAC3B,SAAS,EAAE,IAAI,GAAG,KAAK,CAAA;IACvB,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAE9B,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB,GAAG,CACE;IAAE,wBAAwB,EAAE,MAAM,CAAC;IAAC,mBAAmB,CAAC,EAAE,MAAM,CAAA;CAAE,GAClE;IAAE,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAAC,mBAAmB,EAAE,MAAM,CAAA;CAAE,CACrE,CAAA;AAEH,cAAc;AACd,MAAM,MAAM,YAAY,GACpB,eAAe,GACf,kBAAkB,GAClB,mBAAmB,GACnB,eAAe,GACf,gBAAgB,CAAA;AAEpB,cAAc;AACd,MAAM,WAAW,kBAAkB;IACjC,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,EAAE,YAAY,EAAE,CAAA;IACrB,UAAU,EAAE,UAAU,CAAA;CACvB;AAID,cAAc;AACd,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;AAEtD,cAAc;AACd,MAAM,WAAW,6BAA6B;IAC5C,cAAc,EAAE,MAAM,CAAA;IACtB,gCAAgC;IAChC,UAAU,EAAE,MAAM,CAAA;IAClB,QAAQ,EAAE,OAAO,CAAA;CAClB;AAED,cAAc;AACd,MAAM,WAAW,wBAAwB;IACvC,QAAQ,EAAE,aAAa,CAAA;IACvB,mDAAmD;IACnD,eAAe,EAAE,MAAM,GAAG,IAAI,CAAA;IAC9B,MAAM,EAAE,gBAAgB,EAAE,CAAA;IAC1B,kBAAkB,CAAC,EAAE,6BAA6B,CAAA;CACnD;AAED,cAAc;AACd,MAAM,WAAW,oBAAoB;IACnC,QAAQ,EAAE,SAAS,CAAA;IACnB,YAAY,EAAE,MAAM,CAAA;IACpB,WAAW,EAAE,MAAM,CAAA;IACnB,gBAAgB,EAAE,OAAO,CAAA;IACzB,WAAW,EAAE,MAAM,CAAA;IACnB,qBAAqB,EAAE,OAAO,CAAA;IAC9B,kEAAkE;IAClE,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,oDAAoD;IACpD,kBAAkB,CAAC,EAAE,QAAQ,GAAG,KAAK,CAAA;CACtC;AAED,cAAc;AACd,MAAM,MAAM,aAAa,GAAG,wBAAwB,GAAG,oBAAoB,CAAA;AAE3E,cAAc;AACd,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,CAAA;IACZ,qFAAqF;IACrF,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAA;CACxC;AAED,cAAc;AACd,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,UAAU,CAAA;IAChB,MAAM,EAAE,kBAAkB,EAAE,CAAA;IAC5B,qGAAqG;IACrG,SAAS,CAAC,EAAE,OAAO,CAAA;CACpB"}

package/dist/types/action.d.ts

@@ -0,0 +1,248 @@
+import type { AcceptTermsParams } from './acceptTerms.js';
+import type { ActionType, MarginMode, OrderSide, OrderStatus, OrderType, TimeInForce, TriggerCondition } from './enums.js';
+import type { MarketDisplay, MarketRef } from './market.js';
+import type { Address, Hex } from './primitives.js';
+import type { PerpsTypedData } from './typedData.js';
+import type { VoteParams } from './vote.js';
+/** @public */
+export interface Eip712ActionStep {
+    action: ActionType;
+    typedData: PerpsTypedData;
+}
+/** @public */
+export interface WasmBlobActionStep {
+    action: ActionType;
+    wasmSignParams: Record<string, unknown>;
+}
+/** @public */
+export interface EvmTxActionStep {
+    action: ActionType;
+    txParams: Record<string, unknown>;
+}
+/** @public */
+export type ActionStep = Eip712ActionStep | WasmBlobActionStep | EvmTxActionStep;
+/** @public */
+export interface Eip712SignedActionStep {
+    action: ActionType;
+    typedData: PerpsTypedData;
+    signature: Hex;
+}
+/** @public */
+export interface WasmBlobSignedActionStep {
+    action: ActionType;
+    wasmSignParams: Record<string, unknown>;
+    signedTx: {
+        txType: number;
+        txInfo: string;
+        txHash: string;
+    };
+}
+/** @public */
+export interface EvmTxSignedActionStep {
+    action: ActionType;
+    txParams: Record<string, unknown>;
+    txHash: string;
+}
+/** @public */
+export type SignedActionStep = Eip712SignedActionStep | WasmBlobSignedActionStep | EvmTxSignedActionStep;
+/** @public */
+export type ActionResult = {
+    action: ActionType;
+    success: true;
+    orderId?: string;
+} | {
+    action: ActionType;
+    success: false;
+    error: string;
+};
+/** @public */
+export interface TriggerOrderInput {
+    triggerPrice: string;
+    limitPrice?: string;
+}
+/** @public */
+export interface ModifyOrderInput {
+    id: string;
+    price?: string;
+    size?: string;
+    triggerPrice?: string;
+    limitPrice?: string;
+}
+/** @public */
+export interface Order {
+    orderId: string;
+    market: MarketDisplay;
+    side: OrderSide;
+    type: OrderType;
+    price?: string;
+    originalSize: string;
+    remainingSize: string;
+    filledSize: string;
+    timeInForce?: TimeInForce;
+    expiresAt?: string;
+    reduceOnly?: boolean;
+    isTrigger?: boolean;
+    triggerPrice?: string;
+    triggerCondition?: TriggerCondition;
+    status: OrderStatus;
+    /** Human-readable reason for a terminal non-FILLED status; undefined when no actionable detail. */
+    statusReason?: string;
+    averagePrice?: string;
+    createdAt: string;
+    updatedAt: string;
+}
+/** @public */
+export interface PlaceOrderParams {
+    market: MarketRef;
+    side: OrderSide;
+    type?: OrderType;
+    size: string;
+    price?: string;
+    leverage?: number;
+    /** Omitted falls back to the provider's default (currently CROSS). */
+    marginMode?: MarginMode;
+    reduceOnly?: boolean;
+    timeInForce?: TimeInForce;
+    expiresAt?: string;
+    takeProfit?: TriggerOrderInput;
+    stopLoss?: TriggerOrderInput;
+}
+/** @public */
+export interface PlaceTriggerOrderParams {
+    market: MarketRef;
+    side: OrderSide;
+    takeProfit?: TriggerOrderInput;
+    stopLoss?: TriggerOrderInput;
+}
+/** @public */
+export interface CancelOrderParams {
+    ids: string[];
+}
+/** @public */
+export interface ModifyOrderParams {
+    modifications: ModifyOrderInput[];
+}
+/** @public */
+export interface UpdateLeverageParams {
+    market: MarketRef;
+    leverage: number;
+    /** Omitted falls back to the provider's default (currently CROSS). */
+    marginMode?: MarginMode;
+}
+/** @public */
+export interface UpdatePositionMarginParams {
+    market: MarketRef;
+    action: 'add' | 'remove';
+    amount: string;
+}
+/** @public */
+export interface WithdrawalParams {
+    destination: Address;
+    amount: string;
+}
+/** @public */
+export interface DepositParams {
+    /** Amount of the token to deposit (human-readable, e.g. "100.5"). */
+    amount: string;
+    /** ERC-20 token address on the source chain. */
+    tokenAddress: Address;
+    /** Chain ID of the source chain (e.g. 1 for Ethereum, 42161 for Arbitrum). */
+    chainId: number;
+}
+/** @public */
+export interface ApproveAgentParams {
+    agentAddress: string;
+    agentTtlMs?: number;
+}
+/** @public */
+export interface AccountModeParams {
+    mode: string;
+}
+/** @public */
+export interface AccountTypeParams {
+    tier: string;
+}
+/** @public */
+export interface SendAssetParams {
+    collateral: string;
+    sourceDex: string;
+    destinationDex: string;
+    amount: string;
+}
+/** @public */
+export interface CancelAllOrdersParams {
+    /** 0=immediate (cancel GTC), 1=scheduled, 2=abort scheduled */
+    timeInForce: number;
+    /** Unix timestamp in milliseconds (required for scheduled cancels) */
+    timestampMs?: number;
+}
+/** @public */
+export interface RegisterApiKeyParams {
+    /** The API key slot index to register (0-255). Reusing a fixed slot overwrites the old key. */
+    apiKeyIndex: number;
+    /**
+     * The SDK's currently-stored Lighter public key for this slot, if any. The
+     * backend returns `[]` (already satisfied) only when this equals the
+     * on-chain pubkey at the slot; otherwise it stages a ChangePubKey blob so
+     * the slot can be (re-)registered. Omit when the SDK has no local key.
+     */
+    knownPublicKey?: string;
+}
+/** @public */
+export interface ApproveReadOnlyTokenParams {
+    accountIndex: number;
+    /** Absolute unix-seconds expiry. Lighter requires lifetime between 1 day and 10 years. */
+    expirySeconds: number;
+    scope: 'single' | 'all';
+}
+/** @public */
+export interface ActionParamsMap {
+    [ActionType.APPROVE_AGENT]: ApproveAgentParams;
+    [ActionType.APPROVE_BUILDER_FEE]: Record<string, never>;
+    [ActionType.ACCOUNT_MODE]: AccountModeParams;
+    [ActionType.ACCOUNT_TYPE]: AccountTypeParams;
+    [ActionType.SEND_ASSET]: SendAssetParams;
+    [ActionType.WITHDRAWAL]: WithdrawalParams;
+    [ActionType.TRANSFER]: Record<string, never>;
+    [ActionType.PLACE_ORDER]: PlaceOrderParams;
+    [ActionType.PLACE_TRIGGER_ORDER]: PlaceTriggerOrderParams;
+    [ActionType.CANCEL_ORDER]: CancelOrderParams;
+    [ActionType.CANCEL_ALL_ORDERS]: CancelAllOrdersParams;
+    [ActionType.MODIFY_ORDER]: ModifyOrderParams;
+    [ActionType.UPDATE_LEVERAGE]: UpdateLeverageParams;
+    [ActionType.UPDATE_POSITION_MARGIN]: UpdatePositionMarginParams;
+    [ActionType.REGISTER_API_KEY]: RegisterApiKeyParams;
+    [ActionType.APPROVE_READ_ONLY_TOKEN]: ApproveReadOnlyTokenParams;
+    [ActionType.DEPOSIT]: DepositParams;
+    [ActionType.META_VOTE]: VoteParams;
+    [ActionType.META_ACCEPT_TERMS]: AcceptTermsParams;
+}
+/** @public */
+export type CreateActionRequest = {
+    [K in ActionType]: {
+        provider: string;
+        address: Address;
+        signerAddress?: Address;
+        action: K;
+        params: ActionParamsMap[K];
+    };
+}[ActionType];
+/** @public */
+export interface CreateActionResponse {
+    actions: ActionStep[];
+}
+/** @public */
+export type ExecuteActionRequest = {
+    [K in ActionType]: {
+        provider: string;
+        address: Address;
+        signerAddress?: Address;
+        action: K;
+        actions: SignedActionStep[];
+    };
+}[ActionType];
+/** @public */
+export interface ExecuteActionResponse {
+    results: ActionResult[];
+}
+//# sourceMappingURL=action.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"action.d.ts","sourceRoot":"","sources":["../../src/action.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAA;AACzD,OAAO,KAAK,EACV,UAAU,EACV,UAAU,EACV,SAAS,EACT,WAAW,EACX,SAAS,EACT,WAAW,EACX,gBAAgB,EACjB,MAAM,YAAY,CAAA;AACnB,OAAO,KAAK,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAC3D,OAAO,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,iBAAiB,CAAA;AACnD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AACpD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,WAAW,CAAA;AAE3C,cAAc;AACd,MAAM,WAAW,gBAAgB;IAC/B,MAAM,EAAE,UAAU,CAAA;IAClB,SAAS,EAAE,cAAc,CAAA;CAC1B;AAED,cAAc;AACd,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,UAAU,CAAA;IAClB,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACxC;AAED,cAAc;AACd,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,UAAU,CAAA;IAClB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAClC;AAED,cAAc;AACd,MAAM,MAAM,UAAU,GAAG,gBAAgB,GAAG,kBAAkB,GAAG,eAAe,CAAA;AAEhF,cAAc;AACd,MAAM,WAAW,sBAAsB;IACrC,MAAM,EAAE,UAAU,CAAA;IAClB,SAAS,EAAE,cAAc,CAAA;IACzB,SAAS,EAAE,GAAG,CAAA;CACf;AAED,cAAc;AACd,MAAM,WAAW,wBAAwB;IACvC,MAAM,EAAE,UAAU,CAAA;IAClB,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACvC,QAAQ,EAAE;QACR,MAAM,EAAE,MAAM,CAAA;QACd,MAAM,EAAE,MAAM,CAAA;QACd,MAAM,EAAE,MAAM,CAAA;KACf,CAAA;CACF;AAED,cAAc;AACd,MAAM,WAAW,qBAAqB;IACpC,MAAM,EAAE,UAAU,CAAA;IAClB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACjC,MAAM,EAAE,MAAM,CAAA;CACf;AAED,cAAc;AACd,MAAM,MAAM,gBAAgB,GACxB,sBAAsB,GACtB,wBAAwB,GACxB,qBAAqB,CAAA;AAEzB,cAAc;AACd,MAAM,MAAM,YAAY,GACpB;IACE,MAAM,EAAE,UAAU,CAAA;IAClB,OAAO,EAAE,IAAI,CAAA;IACb,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB,GACD;IACE,MAAM,EAAE,UAAU,CAAA;IAClB,OAAO,EAAE,KAAK,CAAA;IACd,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAEL,cAAc;AACd,MAAM,WAAW,iBAAiB;IAChC,YAAY,EAAE,MAAM,CAAA;IACpB,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED,cAAc;AACd,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED,cAAc;AACd,MAAM,WAAW,KAAK;IACpB,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,aAAa,CAAA;IACrB,IAAI,EAAE,SAAS,CAAA;IACf,IAAI,EAAE,SAAS,CAAA;IACf,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,YAAY,EAAE,MAAM,CAAA;IACpB,aAAa,EAAE,MAAM,CAAA;IACrB,UAAU,EAAE,MAAM,CAAA;IAClB,WAAW,CAAC,EAAE,WAAW,CAAA;IACzB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,gBAAgB,CAAC,EAAE,gBAAgB,CAAA;IACnC,MAAM,EAAE,WAAW,CAAA;IACnB,mGAAmG;IACnG,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,cAAc;AACd,MAAM,WAAW,gBAAgB;IAC/B,MAAM,EAAE,SAAS,CAAA;IACjB,IAAI,EAAE,SAAS,CAAA;IACf,IAAI,CAAC,EAAE,SAAS,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,sEAAsE;IACtE,UAAU,CAAC,EAAE,UAAU,CAAA;IACvB,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,WAAW,CAAC,EAAE,WAAW,CAAA;IACzB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,UAAU,CAAC,EAAE,iBAAiB,CAAA;IAC9B,QAAQ,CAAC,EAAE,iBAAiB,CAAA;CAC7B;AAED,cAAc;AACd,MAAM,WAAW,uBAAuB;IACtC,MAAM,EAAE,SAAS,CAAA;IACjB,IAAI,EAAE,SAAS,CAAA;IACf,UAAU,CAAC,EAAE,iBAAiB,CAAA;IAC9B,QAAQ,CAAC,EAAE,iBAAiB,CAAA;CAC7B;AAED,cAAc;AACd,MAAM,WAAW,iBAAiB;IAChC,GAAG,EAAE,MAAM,EAAE,CAAA;CACd;AAED,cAAc;AACd,MAAM,WAAW,iBAAiB;IAChC,aAAa,EAAE,gBAAgB,EAAE,CAAA;CAClC;AAED,cAAc;AACd,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE,SAAS,CAAA;IACjB,QAAQ,EAAE,MAAM,CAAA;IAChB,sEAAsE;IACtE,UAAU,CAAC,EAAE,UAAU,CAAA;CACxB;AAED,cAAc;AACd,MAAM,WAAW,0BAA0B;IACzC,MAAM,EAAE,SAAS,CAAA;IACjB,MAAM,EAAE,KAAK,GAAG,QAAQ,CAAA;IACxB,MAAM,EAAE,MAAM,CAAA;CACf;AAED,cAAc;AACd,MAAM,WAAW,gBAAgB;IAC/B,WAAW,EAAE,OAAO,CAAA;IACpB,MAAM,EAAE,MAAM,CAAA;CACf;AAED,cAAc;AACd,MAAM,WAAW,aAAa;IAC5B,qEAAqE;IACrE,MAAM,EAAE,MAAM,CAAA;IACd,gDAAgD;IAChD,YAAY,EAAE,OAAO,CAAA;IACrB,8EAA8E;IAC9E,OAAO,EAAE,MAAM,CAAA;CAChB;AAED,cAAc;AACd,MAAM,WAAW,kBAAkB;IACjC,YAAY,EAAE,MAAM,CAAA;IACpB,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED,cAAc;AACd,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAA;CACb;AAED,cAAc;AACd,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAA;CACb;AAED,cAAc;AACd,MAAM,WAAW,eAAe;IAC9B,UAAU,EAAE,MAAM,CAAA;IAClB,SAAS,EAAE,MAAM,CAAA;IACjB,cAAc,EAAE,MAAM,CAAA;IACtB,MAAM,EAAE,MAAM,CAAA;CACf;AAED,cAAc;AACd,MAAM,WAAW,qBAAqB;IACpC,+DAA+D;IAC/D,WAAW,EAAE,MAAM,CAAA;IACnB,sEAAsE;IACtE,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED,cAAc;AACd,MAAM,WAAW,oBAAoB;IACnC,+FAA+F;IAC/F,WAAW,EAAE,MAAM,CAAA;IACnB;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,CAAA;CACxB;AAED,cAAc;AACd,MAAM,WAAW,0BAA0B;IACzC,YAAY,EAAE,MAAM,CAAA;IACpB,0FAA0F;IAC1F,aAAa,EAAE,MAAM,CAAA;IACrB,KAAK,EAAE,QAAQ,GAAG,KAAK,CAAA;CACxB;AAED,cAAc;AACd,MAAM,WAAW,eAAe;IAC9B,CAAC,UAAU,CAAC,aAAa,CAAC,EAAE,kBAAkB,CAAA;IAC9C,CAAC,UAAU,CAAC,mBAAmB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAA;IACvD,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE,iBAAiB,CAAA;IAC5C,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE,iBAAiB,CAAA;IAC5C,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,eAAe,CAAA;IACxC,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,gBAAgB,CAAA;IACzC,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAA;IAC5C,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,gBAAgB,CAAA;IAC1C,CAAC,UAAU,CAAC,mBAAmB,CAAC,EAAE,uBAAuB,CAAA;IACzD,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE,iBAAiB,CAAA;IAC5C,CAAC,UAAU,CAAC,iBAAiB,CAAC,EAAE,qBAAqB,CAAA;IACrD,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE,iBAAiB,CAAA;IAC5C,CAAC,UAAU,CAAC,eAAe,CAAC,EAAE,oBAAoB,CAAA;IAClD,CAAC,UAAU,CAAC,sBAAsB,CAAC,EAAE,0BAA0B,CAAA;IAC/D,CAAC,UAAU,CAAC,gBAAgB,CAAC,EAAE,oBAAoB,CAAA;IACnD,CAAC,UAAU,CAAC,uBAAuB,CAAC,EAAE,0BAA0B,CAAA;IAChE,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,aAAa,CAAA;IACnC,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,UAAU,CAAA;IAClC,CAAC,UAAU,CAAC,iBAAiB,CAAC,EAAE,iBAAiB,CAAA;CAClD;AAED,cAAc;AACd,MAAM,MAAM,mBAAmB,GAAG;KAC/B,CAAC,IAAI,UAAU,GAAG;QACjB,QAAQ,EAAE,MAAM,CAAA;QAChB,OAAO,EAAE,OAAO,CAAA;QAChB,aAAa,CAAC,EAAE,OAAO,CAAA;QACvB,MAAM,EAAE,CAAC,CAAA;QACT,MAAM,EAAE,eAAe,CAAC,CAAC,CAAC,CAAA;KAC3B;CACF,CAAC,UAAU,CAAC,CAAA;AAEb,cAAc;AACd,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,UAAU,EAAE,CAAA;CACtB;AAED,cAAc;AACd,MAAM,MAAM,oBAAoB,GAAG;KAChC,CAAC,IAAI,UAAU,GAAG;QACjB,QAAQ,EAAE,MAAM,CAAA;QAChB,OAAO,EAAE,OAAO,CAAA;QAChB,aAAa,CAAC,EAAE,OAAO,CAAA;QACvB,MAAM,EAAE,CAAC,CAAA;QACT,OAAO,EAAE,gBAAgB,EAAE,CAAA;KAC5B;CACF,CAAC,UAAU,CAAC,CAAA;AAEb,cAAc;AACd,MAAM,WAAW,qBAAqB;IACpC,OAAO,EAAE,YAAY,EAAE,CAAA;CACxB"}

package/dist/types/asset.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Underlying token/registry entry. The base entity of the perps taxonomy:
+ * a tradable unit referenced by markets (as base/quote legs) and held by
+ * accounts (as balances). NOT a market — see {@link BaseMarket}.
+ * @public
+ */
+export interface Asset {
+    providerId: string;
+    /**
+     * The asset's own provider-native id. Lighter: numeric `asset_id`, stringified.
+     * Hyperliquid spot: the venue token index (`spotMeta.tokens[].index`, the
+     * value HL carries in a balance's `token` field) — identical to that token's
+     * spot `Market.baseAsset.id`, so a held balance resolves to its market by
+     * identity. NEVER the coin symbol (that is `displaySymbol`).
+     */
+    id: string;
+    displaySymbol: string;
+    logoURI: string;
+    displayName?: string;
+}
+/** @public */
+export interface AssetsResponse {
+    assets: Asset[];
+}
+//# sourceMappingURL=asset.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"asset.d.ts","sourceRoot":"","sources":["../../src/asset.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,WAAW,KAAK;IACpB,UAAU,EAAE,MAAM,CAAA;IAClB;;;;;;OAMG;IACH,EAAE,EAAE,MAAM,CAAA;IACV,aAAa,EAAE,MAAM,CAAA;IACrB,OAAO,EAAE,MAAM,CAAA;IACf,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED,cAAc;AACd,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,KAAK,EAAE,CAAA;CAChB"}