@lifi/perps-types 0.0.0-preview-a5f5e3b

package/dist/types/typedData.d.ts

@@ -0,0 +1,28 @@
+import type { Address, Hex } from './primitives.js';
+/** @public */
+export interface TypedDataDomain {
+    name?: string;
+    version?: string;
+    chainId?: number;
+    verifyingContract?: Address;
+    salt?: Hex;
+}
+/** @public */
+export interface TypedDataParameter {
+    name: string;
+    type: string;
+}
+/** @public */
+export type PerpsPrimaryType = string;
+/** @public */
+export type PerpsTypedData = {
+    domain: TypedDataDomain;
+    types: Record<string, readonly TypedDataParameter[]>;
+    primaryType: PerpsPrimaryType;
+    message: Record<string, any>;
+};
+/** @public */
+export type PerpsSignedTypedData = PerpsTypedData & {
+    signature: Hex;
+};
+//# sourceMappingURL=typedData.d.ts.map

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

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

package/dist/types/vote.d.ts

@@ -0,0 +1,68 @@
+import type { Address } from './primitives.js';
+import type { PerpsTypedData, TypedDataParameter } from './typedData.js';
+/**
+ * Sentinel sent in the `provider` field for provider-independent actions
+ * (e.g. {@link "./enums.js".ActionType.META_VOTE}). The backend dispatches
+ * on this value instead of resolving a real provider plugin.
+ * @public
+ */
+export declare const META_PROVIDER = "meta";
+/** @public */
+export type MetaProvider = typeof META_PROVIDER;
+/**
+ * Vote direction. `up` endorses the subject; `down` opposes it.
+ * @public
+ */
+export type VoteDirection = 'up' | 'down';
+/**
+ * Discriminates what a vote is about, leaving room for future product-level
+ * vote subjects without changing the EIP-712 `primaryType`.
+ * @public
+ */
+export type VoteType = 'provider';
+/**
+ * Params for an {@link "./enums.js".ActionType.META_VOTE} action.
+ *
+ * `targetProvider` is the voted-on subject — kept distinct from the transport
+ * `provider` field, which carries the {@link META_PROVIDER} sentinel for this
+ * provider-independent action.
+ * @public
+ */
+export interface VoteParams {
+    /** Key of the inactive provider being voted on (the voted-on subject). */
+    targetProvider: string;
+    direction: VoteDirection;
+    voteType: VoteType;
+}
+/**
+ * EIP-712 message body for a `Vote`. Field order matches {@link voteTypeFields}.
+ * @public
+ */
+export interface VoteMessage {
+    /** Key of the inactive provider being voted on. */
+    targetProvider: string;
+    direction: VoteDirection;
+    voteType: VoteType;
+    voter: Address;
+    /** Unix timestamp in milliseconds. */
+    timestamp: number;
+}
+/**
+ * EIP-712 type member list for the `Vote` primary type. Field order is part of
+ * the signed digest and must match the backend's encoder.
+ * @public
+ */
+export declare const voteTypeFields: readonly TypedDataParameter[];
+/**
+ * EIP-712 typed data for a vote, as returned by `createAction` and signed
+ * client-side. `primaryType` is always `'Vote'`.
+ * @public
+ */
+export interface VoteTypedData extends PerpsTypedData {
+    primaryType: 'Vote';
+    types: {
+        Vote: readonly TypedDataParameter[];
+    } & PerpsTypedData['types'];
+    message: VoteMessage;
+}
+//# sourceMappingURL=vote.d.ts.map

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

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

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@lifi/perps-types",
+  "version": "0.0.0-preview-a5f5e3b",
+  "description": "Shared types for the LI.FI perps stack",
+  "keywords": [
+    "lifi",
+    "perps",
+    "perpetuals",
+    "types",
+    "defi",
+    "trading",
+    "cross-chain"
+  ],
+  "homepage": "https://github.com/lifinance/perps-sdk",
+  "bugs": {
+    "url": "https://github.com/lifinance/perps-sdk/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/lifinance/perps-sdk.git"
+  },
+  "license": "Apache-2.0",
+  "author": "LI.FI <dev@li.fi>",
+  "type": "module",
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/esm/index.js",
+  "types": "./dist/types/index.d.ts",
+  "typings": "./dist/types/index.d.ts",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/types/index.d.ts",
+      "import": "./dist/esm/index.js",
+      "default": "./dist/cjs/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist/**",
+    "!dist/**/*.tsbuildinfo",
+    "src/**/*.ts",
+    "!src/**/*.spec.ts",
+    "!src/**/*.test.ts",
+    "!src/**/*.tsbuildinfo"
+  ],
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/src/acceptTerms.ts

@@ -0,0 +1,53 @@
+import type { Address } from './primitives.js'
+import type { PerpsTypedData, TypedDataParameter } from './typedData.js'
+
+/**
+ * Params for an {@link "./enums.js".ActionType.META_ACCEPT_TERMS} action.
+ *
+ * Provider-independent: cast with the {@link "./vote.js".META_PROVIDER}
+ * sentinel in the transport `provider` field.
+ * @public
+ */
+export interface AcceptTermsParams {
+  /** Terms-of-Service version being accepted; backend-owned, relayed verbatim. */
+  termsVersion: string
+}
+
+/**
+ * EIP-712 message body for an `AcceptTerms`. Field order matches
+ * {@link acceptTermsTypeFields}.
+ * @public
+ */
+export interface AcceptTermsMessage {
+  /** Human-readable action, e.g. `"Accept LI.FI Perps Terms of Service v3"`. */
+  action: string
+  acceptor: Address
+  termsVersion: string
+  /** Unix timestamp in milliseconds. */
+  timestamp: number
+}
+
+/**
+ * EIP-712 type member list for the `AcceptTerms` primary type. Field order is
+ * part of the signed digest and must match the backend's encoder.
+ * @public
+ */
+export const acceptTermsTypeFields: readonly TypedDataParameter[] = [
+  { name: 'action', type: 'string' },
+  { name: 'acceptor', type: 'address' },
+  { name: 'termsVersion', type: 'string' },
+  { name: 'timestamp', type: 'uint256' },
+]
+
+/**
+ * EIP-712 typed data for a terms acceptance, as returned by `createAction` and
+ * signed client-side. `primaryType` is always `'AcceptTerms'`.
+ * @public
+ */
+export interface AcceptTermsTypedData extends PerpsTypedData {
+  primaryType: 'AcceptTerms'
+  types: {
+    AcceptTerms: readonly TypedDataParameter[]
+  } & PerpsTypedData['types']
+  message: AcceptTermsMessage
+}

package/src/account.ts

@@ -0,0 +1,277 @@
+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
+  // Fully-resolved block-explorer URL for the settling on-chain tx. Absent when
+  // the fill has no on-chain settlement tx.
+  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
+  // Fully-resolved block-explorer URL for the on-chain deposit tx.
+  explorerLink?: string
+}
+
+/** @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 */
+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
+}
+
+// At least one of `counterpartyAccountIndex` / `counterpartyAddress` is always
+// present; both may appear together.
+/** @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; 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
+}
+
+// Account configuration state — typed `AccountResponse.config`.
+
+/** @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
+}