Skip to main content

getQueuePosition

Description:

Get unlock position data

Arguments:

NameTypeRequiredDescription
userAddressstringYesThe user address
vaultAddressstringYesThe address of the vault

Returns:

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

type Output = {
totalShares: bigint
totalAssets: bigint
isClaimable: boolean
duration: number | null
position: ClaimPosition | null
}
NameDescription
totalSharesUnlock osToken count
totalAssetsUnlock rewards count
isClaimableAvailable for claim or not
durationApproximate time of position in the queue
positionThe data that will be needed for the claim operation

Example:

await sdk.boost.getQueuePosition({
userAddress: '0x...',
vaultAddress: '0x...',
})