@pear-protocol/exchanges-sdk 0.9.1 → 0.10.0

package/dist/client/lighter/rest.js

@@ -63,9 +63,11 @@ __name(createCctpDepositIntentAddress, "createCctpDepositIntentAddress");
 async function fetchDepositHistory(params, demo = false) {
   const query = new URLSearchParams({
     account_index: params.accountIndex.toString(),
-    l1_address: params.l1Address,
-    filter: "all"
+    l1_address: params.l1Address
   });
+  if (params.cursor) {
+    query.set("cursor", params.cursor);
+  }
   const response = await authenticatedLighterFetch(`${getLighterBaseUrl(demo)}/api/v1/deposit/history?${query.toString()}`, params.authToken);
   const data = await readLighterResponse(response, "/deposit/history");
   const deposits = [];
@@ -88,9 +90,48 @@ async function fetchDepositHistory(params, demo = false) {
       l1TxHash: typeof deposit.l1_tx_hash === "string" ? deposit.l1_tx_hash : ""
     });
   }
-  return deposits;
+  return {
+    deposits,
+    nextCursor: readHistoryCursor(data.cursor)
+  };
 }
 __name(fetchDepositHistory, "fetchDepositHistory");
+async function fetchWithdrawHistory(params, demo = false) {
+  const query = new URLSearchParams({
+    account_index: params.accountIndex.toString()
+  });
+  if (params.cursor) {
+    query.set("cursor", params.cursor);
+  }
+  const response = await authenticatedLighterFetch(`${getLighterBaseUrl(demo)}/api/v1/withdraw/history?${query.toString()}`, params.authToken);
+  const data = await readLighterResponse(response, "/withdraw/history");
+  const withdraws = [];
+  for (const withdraw of data.withdraws ?? []) {
+    if (typeof withdraw !== "object" || withdraw === null) {
+      continue;
+    }
+    if (typeof withdraw.id !== "string" || typeof withdraw.amount !== "string" || !isLighterWithdrawStatus(withdraw.status) || !isLighterWithdrawType(withdraw.type)) {
+      continue;
+    }
+    if (typeof withdraw.timestamp !== "number" || !Number.isSafeInteger(withdraw.timestamp)) {
+      continue;
+    }
+    withdraws.push({
+      id: withdraw.id,
+      assetId: typeof withdraw.asset_id === "number" ? withdraw.asset_id : -1,
+      amount: withdraw.amount,
+      timestamp: withdraw.timestamp,
+      status: withdraw.status,
+      type: withdraw.type,
+      l1TxHash: typeof withdraw.l1_tx_hash === "string" ? withdraw.l1_tx_hash : ""
+    });
+  }
+  return {
+    withdraws,
+    nextCursor: readHistoryCursor(data.cursor)
+  };
+}
+__name(fetchWithdrawHistory, "fetchWithdrawHistory");
 async function fetchApiKeys(accountIndex, demo = false) {
   const url = `${getLighterBaseUrl(demo)}/api/v1/apikeys?account_index=${accountIndex}`;
   const response = await proxyFetch(url);
@@ -283,6 +324,38 @@ function isLighterDepositStatus(value) {
   return value === "failed" || value === "pending" || value === "completed" || value === "claimable";
 }
 __name(isLighterDepositStatus, "isLighterDepositStatus");
+function isLighterWithdrawStatus(value) {
+  return value === "failed" || value === "pending" || value === "claimable" || value === "refunded" || value === "completed";
+}
+__name(isLighterWithdrawStatus, "isLighterWithdrawStatus");
+function isLighterWithdrawType(value) {
+  return value === "secure" || value === "fast";
+}
+__name(isLighterWithdrawType, "isLighterWithdrawType");
+function readHistoryCursor(cursor) {
+  if (typeof cursor !== "string" || cursor.length === 0) {
+    return null;
+  }
+  if (isSpentHistoryCursor(cursor)) {
+    return null;
+  }
+  return cursor;
+}
+__name(readHistoryCursor, "readHistoryCursor");
+function isSpentHistoryCursor(cursor) {
+  let decoded;
+  try {
+    decoded = JSON.parse(atob(cursor));
+  } catch {
+    return false;
+  }
+  if (typeof decoded !== "object" || decoded === null) {
+    return false;
+  }
+  const indexes = Object.values(decoded).filter((value) => typeof value === "number");
+  return indexes.length > 0 && indexes.every((index) => index < 0);
+}
+__name(isSpentHistoryCursor, "isSpentHistoryCursor");
 async function readLighterResponse(response, endpoint, acceptedCodes = [
   200
 ]) {
@@ -302,4 +375,4 @@ async function readLighterResponse(response, endpoint, acceptedCodes = [
 }
 __name(readLighterResponse, "readLighterResponse");
 
-export { createCctpDepositIntentAddress, fetchAccount, fetchAccountLimits, fetchAccountMetadata, fetchAccountsByL1Address, fetchApiKeys, fetchAssetDetails, fetchDepositHistory, fetchDepositNetworks, fetchOrderBookDetails, fetchPositionFundingSince, fetchPublicAccount, fetchPublicOrderBookDetails, fetchTradesSince };
+export { createCctpDepositIntentAddress, fetchAccount, fetchAccountLimits, fetchAccountMetadata, fetchAccountsByL1Address, fetchApiKeys, fetchAssetDetails, fetchDepositHistory, fetchDepositNetworks, fetchOrderBookDetails, fetchPositionFundingSince, fetchPublicAccount, fetchPublicOrderBookDetails, fetchTradesSince, fetchWithdrawHistory };

package/dist/helper/lighter/cctp-deposit.helper.js

@@ -167,11 +167,12 @@ async function watchCctpDeposit(ownerAddress, txHash, watch, onProgress, sdk, de
     let deposits;
     try {
       const authToken = await retrieveLighterAuthToken(sdk, watch, demo);
-      deposits = await fetchDepositHistory({
+      const page = await fetchDepositHistory({
         accountIndex: watch.accountIndex,
         l1Address: ownerAddress,
         authToken
       }, demo);
+      deposits = page.deposits;
     } catch {
       continue;
     }

package/dist/helper/lighter/helper.js

@@ -5,6 +5,7 @@ import { resolveAssetDecimals } from './asset-decimals.helper';
 import { listCctpDepositNetworks } from './cctp-deposit.helper';
 import { createDepositAddressForRoute, depositThroughRoute } from './deposit.helper';
 import { writeWithdraw } from './ethereum';
+import { readWithdrawHistory, readDepositHistory } from './history.helper';
 import { LIGHTER_ACCOUNT_NOT_REGISTERED_CODE, readOnboardingStatus } from './onboarding.helper';
 import { MIN_LIGHTER_FAST_WITHDRAW_USDC } from './types';
 
@@ -189,6 +190,14 @@ function createLighterHelper(sdk, demo = false) {
       return {
         txHash
       };
+    },
+    /** Reads one page of the account's deposit history, newest first. */
+    async getDepositHistory(params) {
+      return readDepositHistory(sdk, params, demo);
+    },
+    /** Reads one page of the account's withdrawal history, newest first. */
+    async getWithdrawHistory(params) {
+      return readWithdrawHistory(sdk, params, demo);
     }
   };
   return helper;

package/dist/helper/lighter/history.helper.js

@@ -0,0 +1,26 @@
+import { fetchDepositHistory, fetchWithdrawHistory } from '../../client/lighter/rest';
+import { retrieveLighterAuthToken } from './auth-token.helper';
+
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+async function readDepositHistory(sdk, params, demo) {
+  const authToken = await retrieveLighterAuthToken(sdk, params.credentials, demo);
+  return fetchDepositHistory({
+    accountIndex: params.credentials.accountIndex,
+    l1Address: params.l1Address,
+    authToken,
+    cursor: params.cursor
+  }, demo);
+}
+__name(readDepositHistory, "readDepositHistory");
+async function readWithdrawHistory(sdk, params, demo) {
+  const authToken = await retrieveLighterAuthToken(sdk, params.credentials, demo);
+  return fetchWithdrawHistory({
+    accountIndex: params.credentials.accountIndex,
+    authToken,
+    cursor: params.cursor
+  }, demo);
+}
+__name(readWithdrawHistory, "readWithdrawHistory");
+
+export { readDepositHistory, readWithdrawHistory };

package/dist/index.d.ts

@@ -279,11 +279,46 @@ type LighterDeposit = {
     assetId: number;
     /** Human-readable amount Lighter credited; the intent record never carries this. */
     amount: string;
-    /** Unix seconds since epoch, matching Lighter's deposit-history wire format. */
+    /** Unix MILLISECONDS since epoch. Lighter's OpenAPI example shows seconds; mainnet sends ms. */
     timestamp: number;
     status: LighterDepositStatus;
     l1TxHash: string;
 };
+/** One page of deposits, newest first, and the cursor that reads the page before it. */
+type LighterDepositPage = {
+    deposits: LighterDeposit[];
+    /** Null once Lighter holds no older page. */
+    nextCursor: string | null;
+};
+/**
+ * The states Lighter reports for a withdrawal.
+ *
+ * A secure withdrawal stops at `claimable` and never reads `completed`: reaching L1 is a separate
+ * claim Lighter usually makes on the owner's behalf, and the history does not report it. Read the
+ * mainnet contract's `getPendingBalance()` to learn whether a claimable withdrawal has been paid.
+ * Only a fast withdrawal through Arbitrum reaches `completed` here.
+ */
+type LighterWithdrawStatus = 'failed' | 'pending' | 'claimable' | 'refunded' | 'completed';
+/** Which withdrawal path carried the funds, which decides how far its status can travel. */
+type LighterWithdrawType = 'secure' | 'fast';
+/** One withdrawal in Lighter's per-account history, paid out or still in flight. */
+type LighterWithdraw = {
+    id: string;
+    assetId: number;
+    /** Human-readable amount Lighter debited, in the asset's own units. */
+    amount: string;
+    /** Unix MILLISECONDS since epoch. Lighter's OpenAPI example shows seconds; mainnet sends ms. */
+    timestamp: number;
+    status: LighterWithdrawStatus;
+    type: LighterWithdrawType;
+    l1TxHash: string;
+};
+/** One page of withdrawals, newest first, and the cursor that reads the page before it. */
+type LighterWithdrawPage = {
+    withdraws: LighterWithdraw[];
+    /** Null once Lighter holds no older page. */
+    nextCursor: string | null;
+};
 
 /** Shares one live Lighter auth token per account without crossing rotated credentials. */
 
@@ -690,6 +725,20 @@ type FastWithdrawResult = {
     /** Integer USDC units Lighter charged on top of the amount. */
     fee: number;
 };
+type LighterDepositHistoryParams = {
+    /** Signs the read, and its `accountIndex` names the account whose deposits come back. */
+    credentials: LighterAuthCredentials;
+    /** The L1 address owning that account; Lighter's deposit history requires both identifiers. */
+    l1Address: string;
+    /** The `nextCursor` of the page just read; omit to read the newest page. */
+    cursor?: string;
+};
+type LighterWithdrawHistoryParams = {
+    /** Signs the read, and its `accountIndex` names the account whose withdrawals come back. */
+    credentials: LighterAuthCredentials;
+    /** The `nextCursor` of the page just read; omit to read the newest page. */
+    cursor?: string;
+};
 /**
  * The next action an L1 address must take before it can hold a Lighter trade account.
  *
@@ -721,6 +770,10 @@ interface LighterHelper {
     }>>;
     fastWithdraw(walletClient: WalletClientWithAccount, params: FastWithdrawParams): Promise<FastWithdrawResult>;
     withdraw(walletClient: WalletClientWithAccount, params: WithdrawParams): Promise<WithdrawResult>;
+    /** Reads one page of the account's deposit history, newest first. */
+    getDepositHistory(params: LighterDepositHistoryParams): Promise<LighterDepositPage>;
+    /** Reads one page of the account's withdrawal history, newest first. */
+    getWithdrawHistory(params: LighterWithdrawHistoryParams): Promise<LighterWithdrawPage>;
 }
 type LighterLookupResult = {
     mainAccountIndex: number;
@@ -2550,4 +2603,4 @@ declare class ExchangesSDK {
     private fetchCredentials;
 }
 
-export { ACCOUNT_MODE_LABELS, ASSET_DECIMALS, AccountBalance, AccountBalanceCore, type AccountHealthStatus, AccountMode, type AccountPosition, type AccountSnapshot, type AccountStatus, type AccountSyncer, type AccountSyncerConfig, type AccountTierCallback, type AccountTracker, type AccountTrackerConfig, type AccountWarningReason, type ApiKey, type ApproveIntegratorParams, type ApproveIntegratorResult, AssetId, type AssetSnapshotMap, type BalanceCallback, BaseAccountSyncer, BaseAccountTracker, BaseWs, BasketLeg, BinanceAccountSyncer, BinanceAccountTracker, type BinanceAccountTrackerConfig, BinanceExchangeWs, BinanceMultiAssetBalance, BinanceSingleAssetBalance, BinanceUserDataWs, type BinanceUserDataWsConfig, BinanceWsApi, type BinanceWsApiConfig, BybitAccountSyncer, BybitAccountTracker, type BybitAccountTrackerConfig, BybitExchangeWs, BybitIsolatedMarginBalance, BybitPortfolioMarginBalance, BybitRegularMarginBalance, BybitWs, type BybitWsConfig, type CappedBasketLeg, type CctpDepositAddressParams, type CctpDepositAddressResult, type CctpDepositHistorySettlement, type CctpDepositParams, type CctpDepositRegistrationSettlement, type CctpDepositResult, type CctpDepositSettlement, type ChangeAccountTierParams, type ChangeAccountTierResult, type CheckApiWalletParams, CollateralBalance, type ConnectOptions, type ConnectWalletParams, type ConnectWalletResult, type CreateAccountTrackerConfig, type CreateExchangeWsConfig, DecimalString, type EthereumDepositParams, type EthereumDepositResult, type ExchangeConnection, type ExchangeHelperExchange, type ExchangeHelperMap, type ExchangeState, ExchangeWs, type ExchangeWsByConnector, ExchangesSDK, type ExchangesSDKConfig, FUNXYZ_DEPOSIT_MINIMUMS_USD, FUNXYZ_ETHEREUM_MAINNET_CHAIN_ID, FUNXYZ_EVM_CHAIN_NAMES, type FastWithdrawParams, type FastWithdrawResult, type FillSyncOutcome, type FundingSyncOutcome, type FunxyzAccountState, type FunxyzAsset, type FunxyzDepositAddressParams, type FunxyzDepositAddressResult, type FunxyzDepositCredit, type FunxyzDepositParams, type FunxyzDepositResult, type FunxyzDepositSettlement, type FunxyzDepositSource, type FunxyzMarket, HyperliquidAccountSyncer, HyperliquidAccountTracker, type HyperliquidAccountTrackerConfig, HyperliquidDexState, HyperliquidExchangeWs, type HyperliquidHelper, HyperliquidPortfolioMarginBalance, HyperliquidPortfolioMarginCollateral, HyperliquidStandardBalance, HyperliquidUnifiedBalance, HyperliquidWs, type IntegratorApprovalRequirements, L2_ASSET_DECIMALS, LIGHTER_NATIVE_USDC_ADDRESSES, LIGHTER_USDC_DECIMALS, LighterAccountSyncer, type LighterAccountTier, LighterAccountTracker, type LighterAccountTrackerConfig, type LighterAuthCredentials, LighterClassicBalance, type LighterDeposit, type LighterDepositAddressParams, type LighterDepositAddressResult, type LighterDepositCredit, type LighterDepositNetwork, type LighterDepositParams, type LighterDepositProgress, type LighterDepositResult, type LighterDepositWalletAdapter, LighterExchangeWs, type LighterHelper, type LighterLookupResult, type LighterOnboardingStatus, LighterUnifiedBalance, LighterWs, type ListExternalFillsParams, type ListExternalFundingParams, type ListExternalPositionsParams, MAX_API_KEY_INDEX, MIN_LIGHTER_CCTP_DEPOSIT_USDC, MIN_LIGHTER_FAST_WITHDRAW_USDC, MIN_USER_API_KEY_INDEX, MarginMode, type MaxBasketSizeCalculation, MaxBasketSizeInput, MaxBasketSizeResult, type MessageListener, OkxAccountSyncer, OkxAccountTracker, type OkxAccountTrackerConfig, OkxExchangeWs, OkxFuturesBalance, OkxMultiCurrencyMarginBalance, OkxPortfolioMarginBalance, OkxSpotBalance, OkxWs, type OkxWsConfig, type OpenListener, type PositionsCallback, RouteType, Side, SignedDecimalString, type StateUpdate, type SupportedCredentials, type TrackedAssetCallback, type TrackedAssetInfo, type WalletClientWithAccount, type WithdrawParams, type WithdrawResult, type WsMessage, computeMaxBasketSize, createAccountSyncer, createAccountTracker, createExchangeWs, createHyperliquidHelper, createLighterHelper, findAvailableApiKeyIndex, getAssetDecimals, getLighterNativeUsdcAddress, listFunxyzTransferableChains, readFunxyzChainSource, readFunxyzMinimumUsd, retrieveLighterAuthToken, usdcAbi };
+export { ACCOUNT_MODE_LABELS, ASSET_DECIMALS, AccountBalance, AccountBalanceCore, type AccountHealthStatus, AccountMode, type AccountPosition, type AccountSnapshot, type AccountStatus, type AccountSyncer, type AccountSyncerConfig, type AccountTierCallback, type AccountTracker, type AccountTrackerConfig, type AccountWarningReason, type ApiKey, type ApproveIntegratorParams, type ApproveIntegratorResult, AssetId, type AssetSnapshotMap, type BalanceCallback, BaseAccountSyncer, BaseAccountTracker, BaseWs, BasketLeg, BinanceAccountSyncer, BinanceAccountTracker, type BinanceAccountTrackerConfig, BinanceExchangeWs, BinanceMultiAssetBalance, BinanceSingleAssetBalance, BinanceUserDataWs, type BinanceUserDataWsConfig, BinanceWsApi, type BinanceWsApiConfig, BybitAccountSyncer, BybitAccountTracker, type BybitAccountTrackerConfig, BybitExchangeWs, BybitIsolatedMarginBalance, BybitPortfolioMarginBalance, BybitRegularMarginBalance, BybitWs, type BybitWsConfig, type CappedBasketLeg, type CctpDepositAddressParams, type CctpDepositAddressResult, type CctpDepositHistorySettlement, type CctpDepositParams, type CctpDepositRegistrationSettlement, type CctpDepositResult, type CctpDepositSettlement, type ChangeAccountTierParams, type ChangeAccountTierResult, type CheckApiWalletParams, CollateralBalance, type ConnectOptions, type ConnectWalletParams, type ConnectWalletResult, type CreateAccountTrackerConfig, type CreateExchangeWsConfig, DecimalString, type EthereumDepositParams, type EthereumDepositResult, type ExchangeConnection, type ExchangeHelperExchange, type ExchangeHelperMap, type ExchangeState, ExchangeWs, type ExchangeWsByConnector, ExchangesSDK, type ExchangesSDKConfig, FUNXYZ_DEPOSIT_MINIMUMS_USD, FUNXYZ_ETHEREUM_MAINNET_CHAIN_ID, FUNXYZ_EVM_CHAIN_NAMES, type FastWithdrawParams, type FastWithdrawResult, type FillSyncOutcome, type FundingSyncOutcome, type FunxyzAccountState, type FunxyzAsset, type FunxyzDepositAddressParams, type FunxyzDepositAddressResult, type FunxyzDepositCredit, type FunxyzDepositParams, type FunxyzDepositResult, type FunxyzDepositSettlement, type FunxyzDepositSource, type FunxyzMarket, HyperliquidAccountSyncer, HyperliquidAccountTracker, type HyperliquidAccountTrackerConfig, HyperliquidDexState, HyperliquidExchangeWs, type HyperliquidHelper, HyperliquidPortfolioMarginBalance, HyperliquidPortfolioMarginCollateral, HyperliquidStandardBalance, HyperliquidUnifiedBalance, HyperliquidWs, type IntegratorApprovalRequirements, L2_ASSET_DECIMALS, LIGHTER_NATIVE_USDC_ADDRESSES, LIGHTER_USDC_DECIMALS, LighterAccountSyncer, type LighterAccountTier, LighterAccountTracker, type LighterAccountTrackerConfig, type LighterAuthCredentials, LighterClassicBalance, type LighterDeposit, type LighterDepositAddressParams, type LighterDepositAddressResult, type LighterDepositCredit, type LighterDepositHistoryParams, type LighterDepositNetwork, type LighterDepositPage, type LighterDepositParams, type LighterDepositProgress, type LighterDepositResult, type LighterDepositStatus, type LighterDepositWalletAdapter, LighterExchangeWs, type LighterHelper, type LighterLookupResult, type LighterOnboardingStatus, LighterUnifiedBalance, type LighterWithdraw, type LighterWithdrawHistoryParams, type LighterWithdrawPage, type LighterWithdrawStatus, type LighterWithdrawType, LighterWs, type ListExternalFillsParams, type ListExternalFundingParams, type ListExternalPositionsParams, MAX_API_KEY_INDEX, MIN_LIGHTER_CCTP_DEPOSIT_USDC, MIN_LIGHTER_FAST_WITHDRAW_USDC, MIN_USER_API_KEY_INDEX, MarginMode, type MaxBasketSizeCalculation, MaxBasketSizeInput, MaxBasketSizeResult, type MessageListener, OkxAccountSyncer, OkxAccountTracker, type OkxAccountTrackerConfig, OkxExchangeWs, OkxFuturesBalance, OkxMultiCurrencyMarginBalance, OkxPortfolioMarginBalance, OkxSpotBalance, OkxWs, type OkxWsConfig, type OpenListener, type PositionsCallback, RouteType, Side, SignedDecimalString, type StateUpdate, type SupportedCredentials, type TrackedAssetCallback, type TrackedAssetInfo, type WalletClientWithAccount, type WithdrawParams, type WithdrawResult, type WsMessage, computeMaxBasketSize, createAccountSyncer, createAccountTracker, createExchangeWs, createHyperliquidHelper, createLighterHelper, findAvailableApiKeyIndex, getAssetDecimals, getLighterNativeUsdcAddress, listFunxyzTransferableChains, readFunxyzChainSource, readFunxyzMinimumUsd, retrieveLighterAuthToken, usdcAbi };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pear-protocol/exchanges-sdk",
-  "version": "0.9.1",
+  "version": "0.10.0",
   "description": "Pear Protocol Exchanges SDK",
   "private": false,
   "type": "module",
@@ -28,7 +28,7 @@
   },
   "dependencies": {
     "@pear-protocol/core-sdk": "^1.19.0",
-    "@pear-protocol/types": "^1.29.0",
+    "@pear-protocol/types": "^1.30.0",
     "@pear-protocol/utils": "^0.5.3",
     "bignumber.js": "^11.1.1",
     "partysocket": "^1.0.3",