getPendingWithdrawRequests

Read the queued (not yet claimable) withdraw requests for a subaccount. Scans a range of request ids and returns only the non-terminal ones found.


import { getPendingWithdrawRequests } from "@symmio/trading-core";
 
const pending = await getPendingWithdrawRequests(config, { user });

Parameters

userAddressrequired

The subaccount whose pending requests to list.

startbigintdefault 1n

First request id to scan (inclusive). Request ids start at 1.

sizebigintdefault 200n

Number of request ids to scan from start. The returned array contains only the non-terminal requests found in that range, so its length may be smaller.

chainIdnumberoptional

Optional chain override.

Returns

readonly WithdrawRequest[]

idbigint

Sequential request id (starts at 1 per user).

userAddress

The subaccount the request belongs to.

partsreadonly WithdrawReceiverPart[]

The receiver parts the withdrawal is split into.

timestampbigint

Block timestamp at which the request was created.

cooldownEndTimebigint

Earliest timestamp the request can be finalized.

statusWithdrawStatus

Current lifecycle status.

speedUpboolean

Whether the request opted into the cooldown speed-up flow.

isCooldownModifiedboolean

Whether the cooldown was modified after creation (e.g. by an accepted speed-up).

providerAddress

The provider bound to the request, or the zero address for a classic withdrawal.

isPureVirtualboolean

Whether the request is a pure-virtual (cross-chain, no express) withdrawal.

providerDataHex

Opaque provider data (e.g. a signed option), or 0x.

totalAmountbigint

Total collateral amount across all parts.

totalVirtualAmountbigint

Total amount delivered via virtual providers.

Query options


import { getPendingWithdrawRequestsQueryOptions } from "@symmio/trading-core";
import { useQuery } from "@tanstack/react-query";
 
useQuery(getPendingWithdrawRequestsQueryOptions(config, { user }));