Skip to main content

getExitQueuePositions

Description:

Returns the withdrawal queue for a specific user.

Arguments:

NameTypeRequiredDescription
userAddressstringYesThe user address
vaultAddressstringYesThe address of the vault
isClaimedbooleanNoWhether the user has claimed rewards

Returns:

type ExitRequest = {
withdrawalTimestamp: string | null
exitQueueIndex: string | null
positionTicket: string
isClaimable: boolean
exitedAssets: bigint
totalAssets: bigint
isClaimed: boolean
timestamp: string
}

type Position = {
exitQueueIndex: string
positionTicket: string
timestamp: string
}

type Output = {
total: bigint
duration: number | null
withdrawable: bigint
positions: Position[]
requests: ExitRequest[]
}
NameDescription
requestsArray of all requests
positionsPositions in a special format that are required for claiming
totalTotal queued assets (e.g. ETH)
durationQueue duration time (in seconds).
- It represents the approximate time after which the assets can be collected (in seconds).
- If the value is null, the time is still being calculated.
- If the value is 0, the assets are available and can be collected.
withdrawableAssets available for withdrawal (e.g. ETH)

Example:

await sdk.vault.getExitQueuePositions({
vaultAddress: '0x...',
userAddress: '0x...',
})