@lifi/perps-sdk 0.0.0-preview-697b8c5 → 0.0.0-preview-1edeff0

package/src/utils/depositAssets.ts

@@ -0,0 +1,77 @@
+import { ChainId } from '@lifi/types'
+import { zeroAddress } from 'viem'
+import type { DeclaredDepositAsset } from '../types/deposit.js'
+
+/**
+ * USDC on Ethereum mainnet — the collateral leg of Lighter's first-deposit
+ * pipeline, and the token Ondo's provisioned deposit address is funded in.
+ *
+ * @public
+ */
+export const ETHEREUM_USDC: DeclaredDepositAsset = {
+  chainId: ChainId.ETH,
+  address: '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48',
+  decimals: 6,
+}
+
+/**
+ * Ether on Ethereum mainnet, to broadcast the first-deposit pipeline's legs
+ * with.
+ *
+ * @public
+ */
+export const ETHEREUM_NATIVE_GAS: DeclaredDepositAsset = {
+  chainId: ChainId.ETH,
+  address: zeroAddress,
+  decimals: 18,
+}
+
+/**
+ * USDC on the Hyperliquid venue chain: the 6-decimal perps contract. The same
+ * chain also lists an 8-decimal spot `USDC` at
+ * `0x6d1e7cde53bA9467B783Cb7c530CE05400000000`, so a deposit destination
+ * resolved by symbol lands on the wrong token and the wrong scale.
+ *
+ * @public
+ */
+export const HYPERLIQUID_USDC: DeclaredDepositAsset = {
+  chainId: ChainId.HPL,
+  address: '0xaf88d065e77c8cC2239327C5EDb3A432268e5831',
+  decimals: 6,
+}
+
+/**
+ * USDC on the Lighter venue chain. The venue chain reuses the mainnet USDC
+ * address, so `chainId` is what distinguishes it from {@link ETHEREUM_USDC}.
+ *
+ * @public
+ */
+export const LIGHTER_USDC: DeclaredDepositAsset = {
+  chainId: ChainId.LTR,
+  address: '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48',
+  decimals: 6,
+}
+
+/**
+ * USDG on Robinhood Chain — the collateral the Lighter Robinhood instance is
+ * funded in.
+ *
+ * @public
+ */
+export const ROBINHOOD_USDG: DeclaredDepositAsset = {
+  chainId: ChainId.OUT,
+  address: '0x5fc5360D0400a0Fd4f2af552ADD042D716F1d168',
+  decimals: 6,
+}
+
+/**
+ * Ether on Robinhood Chain, to broadcast the Robinhood first-deposit pipeline's
+ * legs with.
+ *
+ * @public
+ */
+export const ROBINHOOD_NATIVE_GAS: DeclaredDepositAsset = {
+  chainId: ChainId.OUT,
+  address: zeroAddress,
+  decimals: 18,
+}

package/src/utils/scaleToInteger.ts

@@ -0,0 +1,56 @@
+import { PerpsErrorCode } from '@lifi/perps-types'
+import Big from 'big.js'
+import { PerpsError } from '../errors/PerpsError.js'
+
+/**
+ * Off-grid resolution for {@link scaleToInteger}:
+ * - `truncate` — toward zero, for sizes and collateral amounts. The wire
+ *   value never exceeds the caller's intent.
+ * - `round` — half away from zero, for prices, which snap to the nearest
+ *   tick.
+ * @public
+ */
+export type ScaleToIntegerPolicy = 'truncate' | 'round'
+
+/**
+ * Scale a human-readable decimal string to a scaled integer in exact decimal
+ * arithmetic — an on-grid input maps to its exact scaled integer with no
+ * binary float artifacts (`'0.29'` at 2 decimals is 29, never 28).
+ * Off-grid input resolves per `policy`; there is no silent default.
+ *
+ * @throws {PerpsError} `ValidationError` when `value` is not a decimal
+ *   numeric string, `decimals` is not a non-negative integer, or the scaled
+ *   result's magnitude exceeds `Number.MAX_SAFE_INTEGER`.
+ * @public
+ */
+export const scaleToInteger = (
+  value: string,
+  decimals: number,
+  policy: ScaleToIntegerPolicy
+): number => {
+  if (!Number.isInteger(decimals) || decimals < 0) {
+    throw new PerpsError(
+      PerpsErrorCode.ValidationError,
+      `Invalid decimals for integer scaling: ${decimals}`
+    )
+  }
+  let parsed: Big
+  try {
+    parsed = new Big(value)
+  } catch {
+    throw new PerpsError(
+      PerpsErrorCode.ValidationError,
+      `Invalid decimal string for integer scaling: '${value}'`
+    )
+  }
+  const scaled = parsed
+    .times(new Big(10).pow(decimals))
+    .round(0, policy === 'truncate' ? Big.roundDown : Big.roundHalfUp)
+  if (scaled.abs().gt(Number.MAX_SAFE_INTEGER)) {
+    throw new PerpsError(
+      PerpsErrorCode.ValidationError,
+      `Scaled value ${scaled.toFixed()} exceeds Number.MAX_SAFE_INTEGER and cannot be encoded exactly.`
+    )
+  }
+  return scaled.toNumber()
+}

package/src/utils/setupActions.ts

@@ -0,0 +1,24 @@
+import type { ProviderAction } from '@lifi/perps-types'
+import { PerpsSigner } from '@lifi/perps-types'
+
+/**
+ * Select the `Provider.setup` descriptors a user is responsible for satisfying:
+ * those whose `signers` include {@link PerpsSigner.USER}. Descriptors the SDK
+ * signs on its own (no `USER` signer) are held back — `checkSetup` completes
+ * them inline, so surfacing them would render inert cards the user can't act on.
+ *
+ * Membership is a property of the descriptor's `signers` alone, independent of
+ * any account: use this to build the onboarding list, then layer each entry's
+ * satisfied/unsatisfied state on top from a live `checkSetup` so the tick never
+ * goes stale.
+ *
+ * @param setup The provider's `setup` descriptors, in their declared order.
+ * @public
+ */
+export function selectUserSetupActions(
+  setup: ProviderAction[]
+): ProviderAction[] {
+  return setup.filter((descriptor) =>
+    descriptor.signers.includes(PerpsSigner.USER)
+  )
+}

package/src/version.ts

@@ -1,2 +1,2 @@
 export const name = '@lifi/perps-sdk'
-export const version = '0.0.0-preview-697b8c5'
+export const version = '0.0.0-preview-1edeff0'

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,CAIpC,CAAA;AASD,wBAAgB,2BAA2B,CACzC,WAAW,EAAE,MAAM,GAClB,OAAO,GAAG,SAAS,CAErB"}

package/dist/cjs/utils/depositChain.js

@@ -1,13 +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,
-};
-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":";;;AAiCA,kEAIC;AApCD,uCAAqC;AAkBxB,QAAA,8BAA8B,GAEvC;IACF,WAAW,EAAE,eAAO,CAAC,GAAG;IACxB,OAAO,EAAE,eAAO,CAAC,GAAG;CACrB,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,CAIpC,CAAA;AAED;;;;;;GAMG;AACH,wBAAgB,2BAA2B,CACzC,WAAW,EAAE,MAAM,GAClB,OAAO,GAAG,SAAS,CAErB"}

package/dist/esm/utils/depositChain.js

@@ -1,23 +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,
-};
-/**
- * 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;CACrB,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,CAIpC,CAAA;AAED;;;;;;GAMG;AACH,wBAAgB,2BAA2B,CACzC,WAAW,EAAE,MAAM,GAClB,OAAO,GAAG,SAAS,CAErB"}

package/src/utils/depositChain.ts

@@ -1,38 +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,
-}
-
-/**
- * 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]
-}