@lifi/perps-sdk 4.4.2 → 6.0.0

package/src/utils/transferMargin.ts

@@ -0,0 +1,103 @@
+import {
+  MarginMode,
+  PerpsErrorCode,
+  type Position,
+  PositionMarginAdjustment,
+  type PositionMarginConstraints,
+} from '@lifi/perps-types'
+import Big from 'big.js'
+import { PerpsError } from '../errors/PerpsError.js'
+
+function positionAmount(value: string, field: string): Big {
+  try {
+    return new Big(value)
+  } catch {
+    throw new PerpsError(
+      PerpsErrorCode.ValidationError,
+      `Invalid decimal string on Position.${field}: '${value}'`
+    )
+  }
+}
+
+function constraintAmount(value: string, field: string): Big {
+  try {
+    return new Big(value)
+  } catch {
+    throw new PerpsError(
+      PerpsErrorCode.ValidationError,
+      `Invalid decimal string on PositionMarginConstraints.${field}: '${value}'`
+    )
+  }
+}
+
+function requirePositive(value: Big, field: string): Big {
+  if (value.lte(0)) {
+    throw new PerpsError(
+      PerpsErrorCode.ValidationError,
+      `${field} must be greater than zero.`
+    )
+  }
+  return value
+}
+
+/**
+ * Exact inputs for {@link removableIsolatedMargin}.
+ *
+ * @public
+ */
+export interface RemovableIsolatedMarginParams {
+  position: Position
+  constraints: PositionMarginConstraints
+}
+
+/**
+ * Calculate margin that can be removed from an isolated position using the
+ * provider's exact retained-margin requirement. Position equity is allocated
+ * margin plus unrealized PnL.
+ *
+ * The result snaps down to the provider's accepted amount increment. Markets
+ * that are add-only and cross-margined positions return `'0'`.
+ *
+ * @throws {PerpsError} `ValidationError` for malformed, non-positive, or
+ *   inconsistent risk inputs.
+ * @public
+ */
+export function removableIsolatedMargin({
+  position,
+  constraints,
+}: RemovableIsolatedMarginParams): string {
+  if (
+    position.marginMode !== MarginMode.ISOLATED ||
+    position.market.positionMarginAdjustment !==
+      PositionMarginAdjustment.ADD_AND_REMOVE
+  ) {
+    return '0'
+  }
+
+  const marginUsed = requirePositive(
+    positionAmount(position.marginUsed, 'marginUsed'),
+    'Position.marginUsed'
+  )
+  const unrealizedPnl = positionAmount(position.unrealizedPnl, 'unrealizedPnl')
+  const minimumMargin = requirePositive(
+    constraintAmount(
+      constraints.minimumMarginRequirement,
+      'minimumMarginRequirement'
+    ),
+    'PositionMarginConstraints.minimumMarginRequirement'
+  )
+  const amountIncrement = requirePositive(
+    constraintAmount(constraints.amountIncrement, 'amountIncrement'),
+    'PositionMarginConstraints.amountIncrement'
+  )
+
+  const removable = marginUsed.plus(unrealizedPnl).minus(minimumMargin)
+  if (removable.lte(0)) {
+    return '0'
+  }
+  return removable
+    .div(amountIncrement)
+    .round(0, Big.roundDown)
+    .times(amountIncrement)
+    .toFixed()
+}

package/src/version.ts

@@ -1,2 +1,2 @@
 export const name = '@lifi/perps-sdk'
-export const version = '4.4.2'
+export const version = '6.0.0'

package/dist/cjs/utils/depositChain.d.ts

@@ -1,6 +0,0 @@
-import type { AccountConfig } from '@lifi/perps-types';
-import { ChainId } from '@lifi/types';
-export type DepositProviderKey = AccountConfig['provider'];
-export declare const LIFI_DEPOSIT_CHAIN_BY_PROVIDER: Partial<Record<DepositProviderKey, ChainId>>;
-export declare function lifiDepositChainForProvider(providerKey: string): ChainId | undefined;
-//# sourceMappingURL=depositChain.d.ts.map

package/dist/cjs/utils/depositChain.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"depositChain.d.ts","sourceRoot":"","sources":["../../../src/utils/depositChain.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAA;AACtD,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AASrC,MAAM,MAAM,kBAAkB,GAAG,aAAa,CAAC,UAAU,CAAC,CAAA;AAS1D,eAAO,MAAM,8BAA8B,EAAE,OAAO,CAClD,MAAM,CAAC,kBAAkB,EAAE,OAAO,CAAC,CAKpC,CAAA;AASD,wBAAgB,2BAA2B,CACzC,WAAW,EAAE,MAAM,GAClB,OAAO,GAAG,SAAS,CAErB"}

package/dist/cjs/utils/depositChain.js

@@ -1,14 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.LIFI_DEPOSIT_CHAIN_BY_PROVIDER = void 0;
-exports.lifiDepositChainForProvider = lifiDepositChainForProvider;
-const types_1 = require("@lifi/types");
-exports.LIFI_DEPOSIT_CHAIN_BY_PROVIDER = {
-    hyperliquid: types_1.ChainId.HPL,
-    lighter: types_1.ChainId.LTR,
-    'lighter-rh': types_1.ChainId.OUT,
-};
-function lifiDepositChainForProvider(providerKey) {
-    return exports.LIFI_DEPOSIT_CHAIN_BY_PROVIDER[providerKey];
-}
-//# sourceMappingURL=depositChain.js.map

package/dist/cjs/utils/depositChain.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"depositChain.js","sourceRoot":"","sources":["../../../src/utils/depositChain.ts"],"names":[],"mappings":";;;AAkCA,kEAIC;AArCD,uCAAqC;AAkBxB,QAAA,8BAA8B,GAEvC;IACF,WAAW,EAAE,eAAO,CAAC,GAAG;IACxB,OAAO,EAAE,eAAO,CAAC,GAAG;IACpB,YAAY,EAAE,eAAO,CAAC,GAAG;CAC1B,CAAA;AASD,SAAgB,2BAA2B,CACzC,WAAmB;IAEnB,OAAO,sCAA8B,CAAC,WAAiC,CAAC,CAAA;AAC1E,CAAC"}

package/dist/esm/utils/depositChain.d.ts

@@ -1,27 +0,0 @@
-import type { AccountConfig } from '@lifi/perps-types';
-import { ChainId } from '@lifi/types';
-/**
- * Perps provider keys that may declare a LI.FI deposit-target chain. Absent
- * from the map means the provider is not funded via a LI.FI swap (e.g. ondo's
- * custodial provisioned-address deposits).
- *
- * @public
- */
-export type DepositProviderKey = AccountConfig['provider'];
-/**
- * Declared single source of truth: perps provider key → the LI.FI chain a
- * client opens the swap widget against to fund that provider. Values come from
- * the `@lifi/types` `ChainId` enum; never hardcode the numeric ids.
- *
- * @public
- */
-export declare const LIFI_DEPOSIT_CHAIN_BY_PROVIDER: Partial<Record<DepositProviderKey, ChainId>>;
-/**
- * Resolve the LI.FI deposit-target chain for a perps provider key.
- *
- * @returns The `@lifi/types` `ChainId`, or `undefined` for a provider key with
- *   no declared deposit chain (the `/providers` wire key is an open `string`).
- * @public
- */
-export declare function lifiDepositChainForProvider(providerKey: string): ChainId | undefined;
-//# sourceMappingURL=depositChain.d.ts.map

package/dist/esm/utils/depositChain.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"depositChain.d.ts","sourceRoot":"","sources":["../../../src/utils/depositChain.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAA;AACtD,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAErC;;;;;;GAMG;AACH,MAAM,MAAM,kBAAkB,GAAG,aAAa,CAAC,UAAU,CAAC,CAAA;AAE1D;;;;;;GAMG;AACH,eAAO,MAAM,8BAA8B,EAAE,OAAO,CAClD,MAAM,CAAC,kBAAkB,EAAE,OAAO,CAAC,CAKpC,CAAA;AAED;;;;;;GAMG;AACH,wBAAgB,2BAA2B,CACzC,WAAW,EAAE,MAAM,GAClB,OAAO,GAAG,SAAS,CAErB"}

package/dist/esm/utils/depositChain.js

@@ -1,24 +0,0 @@
-import { ChainId } from '@lifi/types';
-/**
- * Declared single source of truth: perps provider key → the LI.FI chain a
- * client opens the swap widget against to fund that provider. Values come from
- * the `@lifi/types` `ChainId` enum; never hardcode the numeric ids.
- *
- * @public
- */
-export const LIFI_DEPOSIT_CHAIN_BY_PROVIDER = {
-    hyperliquid: ChainId.HPL,
-    lighter: ChainId.LTR,
-    'lighter-rh': ChainId.OUT,
-};
-/**
- * Resolve the LI.FI deposit-target chain for a perps provider key.
- *
- * @returns The `@lifi/types` `ChainId`, or `undefined` for a provider key with
- *   no declared deposit chain (the `/providers` wire key is an open `string`).
- * @public
- */
-export function lifiDepositChainForProvider(providerKey) {
-    return LIFI_DEPOSIT_CHAIN_BY_PROVIDER[providerKey];
-}
-//# sourceMappingURL=depositChain.js.map

package/dist/esm/utils/depositChain.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"depositChain.js","sourceRoot":"","sources":["../../../src/utils/depositChain.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAWrC;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,8BAA8B,GAEvC;IACF,WAAW,EAAE,OAAO,CAAC,GAAG;IACxB,OAAO,EAAE,OAAO,CAAC,GAAG;IACpB,YAAY,EAAE,OAAO,CAAC,GAAG;CAC1B,CAAA;AAED;;;;;;GAMG;AACH,MAAM,UAAU,2BAA2B,CACzC,WAAmB;IAEnB,OAAO,8BAA8B,CAAC,WAAiC,CAAC,CAAA;AAC1E,CAAC"}

package/dist/types/utils/depositChain.d.ts

@@ -1,27 +0,0 @@
-import type { AccountConfig } from '@lifi/perps-types';
-import { ChainId } from '@lifi/types';
-/**
- * Perps provider keys that may declare a LI.FI deposit-target chain. Absent
- * from the map means the provider is not funded via a LI.FI swap (e.g. ondo's
- * custodial provisioned-address deposits).
- *
- * @public
- */
-export type DepositProviderKey = AccountConfig['provider'];
-/**
- * Declared single source of truth: perps provider key → the LI.FI chain a
- * client opens the swap widget against to fund that provider. Values come from
- * the `@lifi/types` `ChainId` enum; never hardcode the numeric ids.
- *
- * @public
- */
-export declare const LIFI_DEPOSIT_CHAIN_BY_PROVIDER: Partial<Record<DepositProviderKey, ChainId>>;
-/**
- * Resolve the LI.FI deposit-target chain for a perps provider key.
- *
- * @returns The `@lifi/types` `ChainId`, or `undefined` for a provider key with
- *   no declared deposit chain (the `/providers` wire key is an open `string`).
- * @public
- */
-export declare function lifiDepositChainForProvider(providerKey: string): ChainId | undefined;
-//# sourceMappingURL=depositChain.d.ts.map

package/dist/types/utils/depositChain.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"depositChain.d.ts","sourceRoot":"","sources":["../../../src/utils/depositChain.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAA;AACtD,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAErC;;;;;;GAMG;AACH,MAAM,MAAM,kBAAkB,GAAG,aAAa,CAAC,UAAU,CAAC,CAAA;AAE1D;;;;;;GAMG;AACH,eAAO,MAAM,8BAA8B,EAAE,OAAO,CAClD,MAAM,CAAC,kBAAkB,EAAE,OAAO,CAAC,CAKpC,CAAA;AAED;;;;;;GAMG;AACH,wBAAgB,2BAA2B,CACzC,WAAW,EAAE,MAAM,GAClB,OAAO,GAAG,SAAS,CAErB"}

package/src/utils/depositChain.ts

@@ -1,39 +0,0 @@
-import type { AccountConfig } from '@lifi/perps-types'
-import { ChainId } from '@lifi/types'
-
-/**
- * Perps provider keys that may declare a LI.FI deposit-target chain. Absent
- * from the map means the provider is not funded via a LI.FI swap (e.g. ondo's
- * custodial provisioned-address deposits).
- *
- * @public
- */
-export type DepositProviderKey = AccountConfig['provider']
-
-/**
- * Declared single source of truth: perps provider key → the LI.FI chain a
- * client opens the swap widget against to fund that provider. Values come from
- * the `@lifi/types` `ChainId` enum; never hardcode the numeric ids.
- *
- * @public
- */
-export const LIFI_DEPOSIT_CHAIN_BY_PROVIDER: Partial<
-  Record<DepositProviderKey, ChainId>
-> = {
-  hyperliquid: ChainId.HPL,
-  lighter: ChainId.LTR,
-  'lighter-rh': ChainId.OUT,
-}
-
-/**
- * Resolve the LI.FI deposit-target chain for a perps provider key.
- *
- * @returns The `@lifi/types` `ChainId`, or `undefined` for a provider key with
- *   no declared deposit chain (the `/providers` wire key is an open `string`).
- * @public
- */
-export function lifiDepositChainForProvider(
-  providerKey: string
-): ChainId | undefined {
-  return LIFI_DEPOSIT_CHAIN_BY_PROVIDER[providerKey as DepositProviderKey]
-}