Skip to main content

getRedeemerExitQueuePositions

Description:

Returns the OsTokenRedeemer exit queue positions for a specific user.

Arguments:

NameTypeRequiredDescription
userAddressstringYesThe user address
isClaimedbooleanNoWhether the exit request is claimed. Defaults to false

Returns:

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

type Position = {
positionTicket: string
exitQueueIndex: string
}

type Output = {
total: bigint
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)
withdrawableAssets available for withdrawal (e.g. ETH)

Example:

await sdk.osToken.getRedeemerExitQueuePositions({
userAddress: '0x...',
})