@lifi/perps-sdk-provider-hyperliquid 21.0.0 → 23.0.0

package/src/services/getOrders.ts

@@ -19,6 +19,7 @@ import type {
 import { withExplorerLinks } from '../utils/explorer.js'
 import { assetIsOutcome, mapOrder, perpsDexNames } from '../utils/index.js'
 import { hlInfoOptions, infoRequest } from '../utils/infoClient.js'
+import { requireAccountExists } from './getAccountExists.js'
 
 /** Parameters for a lifecycle-filtered Hyperliquid order read. */
 export type GetOrdersParams = ProviderGetOrdersParams
@@ -65,6 +66,8 @@ export const getOrders = async (
   options?: SDKRequestOptions
 ): Promise<OrdersResponse> => {
   const statuses = params.statuses ?? [...ACTIVE_ORDER_STATUSES]
+  const infoOpts = hlInfoOptions(client, options)
+  await requireAccountExists(apiUrl, params.address, infoOpts)
   if (statuses.length === 0) {
     return {
       provider: PROVIDER_KEY,
@@ -74,7 +77,6 @@ export const getOrders = async (
   }
   const registry = getMarketRegistry(client, PROVIDER_KEY)
   const markets = await registry.sync()
-  const infoOpts = hlInfoOptions(client, options)
   const active = statuses.some(isActiveOrderStatus)
   const terminal = statuses.some((status) => !isActiveOrderStatus(status))
   const [open, historical, twaps] = await Promise.all([

package/src/services/getPortfolioHistory.ts

@@ -15,6 +15,7 @@ import type {
 } from '../types/index.js'
 import { isUnifiedAbstraction } from '../utils/abstractionMode.js'
 import { hlInfoOptions, infoRequest } from '../utils/infoClient.js'
+import { requireAccountExists } from './getAccountExists.js'
 
 /** Parameters for {@link getPortfolioHistory}. @public */
 export interface GetPortfolioHistoryParams {
@@ -83,6 +84,7 @@ export async function getPortfolioHistory(
 ): Promise<PortfolioHistoryResponse> {
   const { client, apiUrl } = ctx
   const infoOpts = hlInfoOptions(client, options)
+  await requireAccountExists(apiUrl, params.address, infoOpts)
   const [portfolio, abstraction] = await Promise.all([
     infoRequest<HlPortfolio>(
       apiUrl,

package/src/services/getPositions.ts

@@ -15,6 +15,7 @@ import {
   perpsDexNames,
 } from '../utils/index.js'
 import { hlInfoOptions, infoRequest } from '../utils/infoClient.js'
+import { requireAccountExists } from './getAccountExists.js'
 
 /**
  * Parameters for {@link getPositions}.
@@ -42,9 +43,10 @@ export const getPositions = async (
   params: GetPositionsParams,
   options?: SDKRequestOptions
 ): Promise<PositionsResponse> => {
+  const infoOpts = hlInfoOptions(client, options)
+  await requireAccountExists(apiUrl, params.address, infoOpts)
   const registry = getMarketRegistry(client, PROVIDER_KEY)
   const markets = await registry.sync()
-  const infoOpts = hlInfoOptions(client, options)
 
   const stateResults = await Promise.all(
     perpsDexNames(markets).map((name) =>

package/src/services/getWithdrawableBalances.ts

@@ -16,6 +16,7 @@ import type {
 } from '../types/index.js'
 import { hlInfoOptions, infoRequest } from '../utils/infoClient.js'
 import { hyperliquidWithdrawableBalances } from '../utils/withdrawableBalances.js'
+import { requireAccountExists } from './getAccountExists.js'
 
 /**
  * Parameters for {@link getWithdrawableBalances}.
@@ -46,6 +47,7 @@ export const getWithdrawableBalances = async (
 ): Promise<ProviderWithdrawableBalance[]> => {
   const registry = getMarketRegistry(client, PROVIDER_KEY)
   const infoOpts = hlInfoOptions(client, options)
+  await requireAccountExists(apiUrl, params.address, infoOpts)
 
   const [{ providers }, markets, abstraction, state, spotState] =
     await Promise.all([

package/src/utils/transferMargin.ts

@@ -1,9 +1,12 @@
-import { PerpsError } from '@lifi/perps-sdk'
 import {
-  PerpsErrorCode,
-  type Position,
+  PerpsError,
   positionSupportsMarginAdjustment,
   positionSupportsMarginRemoval,
+} from '@lifi/perps-sdk'
+import {
+  type DecimalString,
+  PerpsErrorCode,
+  type Position,
 } from '@lifi/perps-types'
 import Big from 'big.js'
 
@@ -49,7 +52,7 @@ function positivePositionAmount(value: string, field: string): Big {
  */
 export function positionRemovableMargin(
   position: Position
-): string | undefined {
+): DecimalString | undefined {
   if (!positionSupportsMarginAdjustment(position)) {
     return undefined
   }

package/src/websocket/HyperliquidWsProvider.ts

@@ -5,6 +5,7 @@ import {
   isActiveMarket,
   isActiveOrderStatus,
   type MarketRegistry,
+  numberToDecimalString,
   PerpsError,
   type PerpsSDKClient,
   type ProviderGetQuoteParams,
@@ -31,12 +32,13 @@ import type {
 } from '@lifi/perps-types'
 import { PerpsErrorCode } from '@lifi/perps-types'
 import Big from 'big.js'
-import { isAddress } from 'viem'
+import { type Address, isAddress } from 'viem'
 import {
   DEFAULT_HYPERLIQUID_API_URL,
   HYPERLIQUID_FEE_TIER_FALLBACK,
   SPOT_MARKET_ID,
 } from '../constants.js'
+import { requireAccountExists } from '../services/getAccountExists.js'
 import type {
   HlActiveAssetData,
   HlAssetPosition,
@@ -138,6 +140,7 @@ export class HyperliquidWsProvider extends WsProviderBase<object> {
   private readonly clearinghouseRefs = new Map<string, number>()
   private readonly client: PerpsSDKClient | undefined
   private readonly registry: MarketRegistry | undefined
+  private readonly accountChecksByUser = new Map<string, Promise<void>>()
   // Spot-funded modes need both spot valuation and clearinghouse margin state.
   private readonly abstractionByUser = new Map<
     string,
@@ -230,6 +233,26 @@ export class HyperliquidWsProvider extends WsProviderBase<object> {
     this.orderApiUrl = orderApiUrl.origin
   }
 
+  private ensureAccountExists(address: Address): Promise<void> {
+    const user = normalizeHlAddress(address)
+    const existing = this.accountChecksByUser.get(user)
+    if (existing !== undefined) {
+      return existing
+    }
+    const check = requireAccountExists(
+      this.orderApiUrl,
+      address,
+      this.client === undefined ? undefined : hlInfoOptions(this.client)
+    )
+    this.accountChecksByUser.set(user, check)
+    void check.catch(() => {
+      if (this.accountChecksByUser.get(user) === check) {
+        this.accountChecksByUser.delete(user)
+      }
+    })
+    return check
+  }
+
   override async subscribe(
     sub: Subscription,
     listener: SubscriptionListener,
@@ -279,23 +302,19 @@ export class HyperliquidWsProvider extends WsProviderBase<object> {
   }
 
   protected async openChannel(sub: Subscription): Promise<() => void> {
-    // Must run synchronously, before any await, so two concurrent opens
-    // cannot both pass the exclusivity check.
-    if (sub.channel === 'orderUpdates') {
-      this.claimOrderUpdatesKey(this.toKey(sub))
-    }
-
-    await this.registry?.sync()
-
+    const registry = this.registry
+    let marketValidated = false
     if (
-      this.registry !== undefined &&
+      registry !== undefined &&
       (sub.channel === 'marketContext' ||
         sub.channel === 'orderbook' ||
         sub.channel === 'candle' ||
         sub.channel === 'trades' ||
         sub.channel === 'availableToTrade')
     ) {
-      const market = this.registry.requireActive(sub.marketId)
+      await registry.sync()
+      marketValidated = true
+      const market = registry.requireActive(sub.marketId)
       if (
         sub.channel === 'availableToTrade' &&
         market.categoryId === SPOT_MARKET_ID
@@ -309,6 +328,18 @@ export class HyperliquidWsProvider extends WsProviderBase<object> {
       }
     }
 
+    if ('address' in sub) {
+      await this.ensureAccountExists(sub.address)
+    }
+
+    if (sub.channel === 'orderUpdates') {
+      this.claimOrderUpdatesKey(this.toKey(sub))
+    }
+
+    if (registry !== undefined && !marketValidated) {
+      await registry.sync()
+    }
+
     // Markets context aggregates slower asset-context feeds with fast mid/mark
     // ticks from `fastAssetCtxs`.
     if (sub.channel === 'marketsContext') {
@@ -1578,10 +1609,12 @@ export class HyperliquidWsProvider extends WsProviderBase<object> {
 const isObject = (v: unknown): v is Record<string, unknown> =>
   typeof v === 'object' && v !== null
 
-const toMarketContextString = (value: unknown): string | undefined =>
-  typeof value === 'string' || typeof value === 'number'
-    ? String(value)
-    : undefined
+const toMarketContextString = (value: unknown): string | undefined => {
+  if (typeof value === 'number') {
+    return numberToDecimalString(value)
+  }
+  return typeof value === 'string' ? value : undefined
+}
 
 const toMarketCapString = (
   price: unknown,