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

package/src/services/getAccount.ts

@@ -1,11 +1,10 @@
 import {
+  calculateTransferable,
   getMarketRegistry,
   getMarketsContext,
-  maxOf,
-  minOf,
   type ProviderGetAccountParams,
+  parseDecimal,
   type SDKRequestOptions,
-  stringToFloat,
   toPerpsMarketDisplay,
 } from '@lifi/perps-sdk'
 import type {
@@ -16,7 +15,7 @@ import type {
   HyperliquidDexAccountState,
   Position,
 } from '@lifi/perps-types'
-import Big from 'big.js'
+import type Big from 'big.js'
 import { PROVIDER_KEY } from '../constants.js'
 import type { HyperliquidContext } from '../context.js'
 import type {
@@ -83,13 +82,12 @@ const buildBalances = (
         const total = toWireBig(b.total, 'spotClearinghouseState.total')
         return {
           ...spotBalance(spotAssetFromToken(b), b.total, priceById),
-          transferable: minOf(
-            maxOf(
-              total.minus(toWireBig(b.hold, 'spotClearinghouseState.hold')),
-              new Big(0)
-            ),
+          transferable: calculateTransferable(
             total
-          ).toFixed(),
+              .minus(toWireBig(b.hold, 'spotClearinghouseState.hold'))
+              .toFixed(),
+            total.toFixed()
+          ),
         }
       }),
     quoteAssetIds
@@ -114,13 +112,13 @@ const buildBalances = (
         units: value.toFixed(),
         valueUsd: value.toFixed(),
         price: '1',
-        transferable: minOf(
-          maxOf(
-            toWireBig(state.withdrawable, 'clearinghouseState.withdrawable'),
-            new Big(0)
-          ),
-          value
-        ).toFixed(),
+        transferable: calculateTransferable(
+          toWireBig(
+            state.withdrawable,
+            'clearinghouseState.withdrawable'
+          ).toFixed(),
+          value.toFixed()
+        ),
       })
     }
   }
@@ -209,7 +207,9 @@ export const getAccount = async (
 
   const priceById = spotPriceById(
     markets,
-    new Map(prices.map((p) => [p.marketId, stringToFloat(p.markPrice)]))
+    new Map(
+      prices.map((p) => [p.marketId, parseDecimal(p.markPrice) ?? Number.NaN])
+    )
   )
 
   const positions: Position[] = stateResults.flatMap((state) =>

package/src/services/getWithdrawableBalances.ts

@@ -89,6 +89,6 @@ export const getWithdrawableBalances = async (
     state,
     spotState,
     quoteAsset.id,
-    feeUsd === undefined ? undefined : String(feeUsd)
+    feeUsd
   )
 }

package/src/utils/index.ts

@@ -45,9 +45,9 @@ export {
 export { isOpenAssetPosition, mapPosition } from './mapPosition.js'
 export { coinAsset, perpsDexNames } from './marketDisplay.js'
 export {
-  formatOrderPrice,
-  formatOrderSize,
   getMaxPriceDecimals,
+  snapOrderPrice,
+  snapOrderSize,
 } from './orderFormatting.js'
 export { priceStepToAggregation } from './priceStepToAggregation.js'
 export {

package/src/utils/liquidation.ts

@@ -12,7 +12,7 @@
  * - margin_available = isolated_margin - maintenance_margin_required
  */
 
-import { estimateIsolatedLiquidationPrice } from '@lifi/perps-sdk'
+import { estimateLiquidationPrice } from '@lifi/perps-sdk'
 
 /**
  * Calculate the maintenance margin fraction for a Hyperliquid asset.
@@ -65,7 +65,7 @@ export function calculateLiquidationPrice(
   if (mmr === undefined) {
     return undefined
   }
-  return estimateIsolatedLiquidationPrice({
+  return estimateLiquidationPrice({
     entryPrice,
     leverage,
     isLong,

package/src/utils/orderFormatting.ts

@@ -1,12 +1,13 @@
 /**
- * Hyperliquid order size and price formatting for exchange submission.
+ * Hyperliquid order size and price snapping for exchange submission.
  *
- * These encode Hyperliquid-specific order submission rules. Getting size/price
- * formatting wrong causes rejected orders.
+ * These encode Hyperliquid-specific order submission rules. Snapping a size or
+ * a price onto the wrong grid causes rejected orders.
  *
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/tick-and-lot-size
  */
 
+import type { DecimalString } from '@lifi/perps-types'
 import Big from 'big.js'
 
 /**
@@ -36,28 +37,30 @@ export function getMaxPriceDecimals(
 }
 
 /**
- * Format a size value for order submission.
+ * Snap a size onto the asset's lot grid for order submission.
  *
  * Per Hyperliquid docs (tick-and-lot-size):
  * - Size must be rounded to the asset's szDecimals
  * - Trailing zeroes must be removed for signing
  *
- * @param size - The size value to format
+ * @param size - The size to snap, as a decimal string
  * @param szDecimals - Number of decimal places allowed for this asset (from meta)
- * @returns Size as a string with correct precision, no trailing zeros
+ * @returns Size as a decimal string with correct precision, no trailing zeros
  * @public
  */
-export function formatOrderSize(size: number, szDecimals: number): string {
+export function snapOrderSize(
+  size: DecimalString,
+  szDecimals: number
+): DecimalString {
   // Big.roundDown truncates toward zero — never round a size up, it could
-  // exceed available balance. Exact decimal arithmetic: flooring the float
-  // product dropped a lot step (0.29 * 100 === 28.999999999999996).
+  // exceed available balance.
   const truncated = new Big(size).round(szDecimals, Big.roundDown)
   // toFixed() with no dp always emits plain notation; eq(0) guards '-0'
   return truncated.eq(0) ? '0' : truncated.toFixed()
 }
 
 /**
- * Format a price value for order submission.
+ * Snap a price onto the asset's tick grid for order submission.
  *
  * Per Hyperliquid docs (tick-and-lot-size):
  * - Maximum 5 significant figures
@@ -66,19 +69,20 @@ export function formatOrderSize(size: number, szDecimals: number): string {
  * - Trailing zeroes must be removed for signing
  *
  * Rounding is half-up (away from zero at exact halfway) on the true decimal
- * value, not on the binary float — (1.005).toFixed(2) would give '1.00'.
+ * value, which is why the price arrives as a string: `(1.005).toFixed(2)`
+ * would give `'1.00'`.
  *
- * @param price - The price value to format
+ * @param price - The price to snap, as a decimal string
  * @param szDecimals - The asset's szDecimals (affects max price decimals)
  * @param market - Optional market type (e.g. 'spot'). Defaults to perps rules.
- * @returns Price as a string with correct precision, no trailing zeros
+ * @returns Price as a decimal string with correct precision, no trailing zeros
  * @public
  */
-export function formatOrderPrice(
-  price: number,
+export function snapOrderPrice(
+  price: DecimalString,
   szDecimals: number,
   market?: string
-): string {
+): DecimalString {
   const maxPriceDecimals = getMaxPriceDecimals(szDecimals, market)
 
   let rounded = new Big(price).round(maxPriceDecimals, Big.roundHalfUp)

package/src/utils/spotBalance.ts

@@ -1,4 +1,4 @@
-import { stringToFloat } from '@lifi/perps-sdk'
+import { numberToDecimalString, parseDecimal } from '@lifi/perps-sdk'
 import type { Asset, Balance, Market } from '@lifi/perps-types'
 import { SPOT_MARKET_ID } from '../constants.js'
 import type { HlSpotBalance } from '../types/index.js'
@@ -52,8 +52,10 @@ export const spotBalance = (
     categoryId: SPOT_MARKET_ID,
     asset,
     units: total,
-    valueUsd: (stringToFloat(total) * price).toString(),
+    valueUsd: numberToDecimalString(
+      (parseDecimal(total) ?? Number.NaN) * price
+    ),
     // A zero entry means the map holds no mark for the asset, not a free asset.
-    ...(price > 0 ? { price: price.toString() } : {}),
+    ...(price > 0 ? { price: numberToDecimalString(price) } : {}),
   }
 }

package/src/utils/withdrawableBalances.ts

@@ -1,4 +1,7 @@
-import type { ProviderWithdrawableBalance } from '@lifi/perps-sdk'
+import {
+  calculateWithdrawMax,
+  type ProviderWithdrawableBalance,
+} from '@lifi/perps-sdk'
 import type {
   HlAbstractionMode,
   HlClearinghouseState,
@@ -50,24 +53,26 @@ export const hyperliquidWithdrawableBalances = (
       )
       if (spot.gt(0)) {
         const assetId = String(balance.token)
-        rows.push({
+        const row = {
           assetId,
-          route: 'spot',
+          route: 'spot' as const,
           available: spot.toFixed(),
           ...feeFor(assetId),
-        })
+        }
+        rows.push({ ...row, max: calculateWithdrawMax(row) })
       }
     }
   }
 
   const perps = toWireBig(state.withdrawable, 'clearinghouseState.withdrawable')
   if (perps.gt(0)) {
-    rows.push({
+    const row = {
       assetId: quoteAssetId,
-      route: 'perps',
+      route: 'perps' as const,
       available: perps.toFixed(),
       ...feeFor(quoteAssetId),
-    })
+    }
+    rows.push({ ...row, max: calculateWithdrawMax(row) })
   }
 
   return rows

package/src/websocket/HyperliquidWsProvider.ts

@@ -1,4 +1,5 @@
 import {
+  calculateTransferable,
   DecodeChain,
   getMarketRegistry,
   isActiveMarket,
@@ -1507,10 +1508,19 @@ export class HyperliquidWsProvider extends WsProviderBase<object> {
       }
       return
     }
-    const rows = balances.map((balance) => ({
-      ...spotBalance(spotAssetFromToken(balance), balance.total, priceById),
-      locked: balance.hold,
-    }))
+    const rows = balances.map((balance) => {
+      const total = toWireBig(balance.total, 'spotState.balances.total')
+      return {
+        ...spotBalance(spotAssetFromToken(balance), balance.total, priceById),
+        locked: balance.hold,
+        transferable: calculateTransferable(
+          total
+            .minus(toWireBig(balance.hold, 'spotState.balances.hold'))
+            .toFixed(),
+          total.toFixed()
+        ),
+      }
+    })
     this.emit(`spotState:${user}`, {
       channel: 'spotBalances',
       data: rows,