Skip to content
stake.link

Withdrawal Pool

The WithdrawalPool allows users to queue LST withdrawals if there is insufficient liquidity in the PriorityPool to satisfy the withdrawal amount. LST withdrawals will be added to a FIFO queue and will be fulfilled as the PriorityPool receives new deposits and/or as funds become available for withdrawal within the StakingPool.

View Functions

Section titled “View Functions”

token

Section titled “token”

Returns the address of the token this pool handles

function token() external view returns (address)

Return Values

Section titled “Return Values”
Name Type Description
token address address of token

lst

Section titled “lst”

Returns the address of the liquid staking token this pool handles

function lst() external view returns (address)

Return Values

Section titled “Return Values”
Name Type Description
lst address address of lst

priorityPool

Section titled “priorityPool”

Returns the address of the priority pool

function priorityPool() external view returns (address)

Return Values

Section titled “Return Values”
Name Type Description
priorityPool address address of Priority Pool

indexOfNextWithdrawal

Section titled “indexOfNextWithdrawal”

Returns the index of the withdrawal that’s at the front of the queue

function indexOfNextWithdrawal() external view returns (uint256)

Return Values

Section titled “Return Values”
Name Type Description
indexOfNextwithdrawal uint256 index of withdrawal at front of queue

withdrawalBatchIdCutoff

Section titled “withdrawalBatchIdCutoff”

Returns the index where all batches before have had all withdrawal requests fully withdrawn

function withdrawalBatchIdCutoff() external view returns (uint128)

Return Values

Section titled “Return Values”
Name Type Description
withdrawalBatchIdCutoff uint128 batch id cutoff

withdrawalIdCutoff

Section titled “withdrawalIdCutoff”

Returns the index where all requests before have been fully withdrawn

function withdrawalIdCutoff() external view returns (uint128)

Return Values

Section titled “Return Values”
Name Type Description
withdrawalIdCutoff uint128 withdrawal id cutoff

minWithdrawalAmount

Section titled “minWithdrawalAmount”

Returns the min amount of LSTs that can be queued for withdrawal

function minWithdrawalAmount() external view returns (uint256)

Return Values

Section titled “Return Values”
Name Type Description
minWithdrawalAmount uint256 min withdrawal amount

minTimeBetweenWithdrawals

Section titled “minTimeBetweenWithdrawals”

Returns the min amount of time between execution of withdrawals

function minTimeBetweenWithdrawals() external view returns (uint64)

Return Values

Section titled “Return Values”
Name Type Description
minTimeBetweenwithdrawals uint64 min time between withdrawals

timeOfLastWithdrawal

Section titled “timeOfLastWithdrawal”

Returns the time of last execution of withdrawals

function timeOfLastWithdrawal() external view returns (uint64)

Return Values

Section titled “Return Values”
Name Type Description
timeOfLastWithdrawal uint64 time of last withdrawal

getTotalQueuedWithdrawals

Section titled “getTotalQueuedWithdrawals”

Returns the total amount of liquid staking tokens queued for withdrawal

function getTotalQueuedWithdrawals() external view returns (uint256)

Return Values

Section titled “Return Values”
Name Type Description
totalQueuedWithdrawals uint256 total amount queued for withdrawal

getAccountTotalQueuedWithdrawals

Section titled “getAccountTotalQueuedWithdrawals”

Returns the total amount of liquid staking tokens queued for withdrawal by an account

function getAccountTotalQueuedWithdrawals(address _account) external view returns (uint256)

Parameters

Section titled “Parameters”
Name Type Description
_account address address of account

Return Values

Section titled “Return Values”
Name Type Description
accountTotalQueuedWithdrawals uint256 total amount queued across all withdrawals

getWithdrawals

Section titled “getWithdrawals”

Returns a list of withdrawals

function getWithdrawals(uint256[] _withdrawalIds) external view returns (struct WithdrawalPool.Withdrawal[])

Parameters

Section titled “Parameters”
Name Type Description
_withdrawalIds uint256[] list of withdrawal ids

Return Values

Section titled “Return Values”
Name Type Description
withdrawals struct WithdrawalPool.Withdrawal[] list of withdrawals corresponding to withdrawal ids

getBatchIds

Section titled “getBatchIds”

Returns batch ids for a list of withdrawals

function getBatchIds(uint256[] _withdrawalIds) public view returns (uint256[])

Parameters

Section titled “Parameters”
Name Type Description
_withdrawalIds uint256[] list of withrawal ids

Return Values

Section titled “Return Values”
Name Type Description
batchIds uint256[] list of batch ids corresponding to withdrawal ids

getWithdrawalIdsByOwner

Section titled “getWithdrawalIdsByOwner”

Returns a list of withdrawal ids owned by an account

function getWithdrawalIdsByOwner(address _account) public view returns (uint256[])

Parameters

Section titled “Parameters”
Name Type Description
_account address address of account

Return Values

Section titled “Return Values”
Name Type Description
withdrawalIds uint256[] list of withdrawal ids

getFinalizedWithdrawalIdsByOwner

Section titled “getFinalizedWithdrawalIdsByOwner”

Returns a list of finalized and partially finalized withdrawal ids owned by an account

These withdrawals have funds available for the owner to withdraw

function getFinalizedWithdrawalIdsByOwner(address _account) external view returns (uint256[], uint256)

Parameters

Section titled “Parameters”
Name Type Description
_account address address of account

Return Values

Section titled “Return Values”
Name Type Description
withdrawalIds uint256[] list of withdrawal ids
withdrawable uint256 total withdrawable across all account’s withdrawals

checkUpkeep

Section titled “checkUpkeep”

Returns whether withdrawals should be executed based on available withdrawal space

function checkUpkeep(bytes) external view returns (bool, bytes)

Return Values

Section titled “Return Values”
Name Type Description
upkeepNeeded bool true if withdrawal should be executed, false otherwise
bytes

Write Functions

Section titled “Write Functions”

withdraw

Section titled “withdraw”

Executes a group of fully and/or partially finalized withdrawals owned by the sender

function withdraw(uint256[] _withdrawalIds, uint256[] _batchIds) external

Parameters

Section titled “Parameters”
Name Type Description
_withdrawalIds uint256[] list of withdrawal ids to execute
_batchIds uint256[] list of batch ids corresponding to withdrawal ids

forceWithdraw

Section titled “forceWithdraw”

Executes a group of fully finalized withdrawals (owner-only)

function forceWithdraw(uint256[] _withdrawalIds, uint256[] _batchIds) external

Parameters

Section titled “Parameters”
Name Type Description
_withdrawalIds uint256[] list of withdrawal ids to execute
_batchIds uint256[] list of batch ids corresponding to withdrawal ids

queueWithdrawal

Section titled “queueWithdrawal”

Queues a withdrawal of liquid staking tokens for an account

function queueWithdrawal(address _account, uint256 _amount) external

Parameters

Section titled “Parameters”
Name Type Description
_account address address of account
_amount uint256 amount of LST

deposit

Section titled “deposit”

Deposits asset tokens in exchange for liquid staking tokens, finalizing withdrawals
starting from the front of the queue

function deposit(uint256 _amount) external

Parameters

Section titled “Parameters”
Name Type Description
_amount uint256 amount of tokens to deposit

performUpkeep

Section titled “performUpkeep”

Executes withdrawals if there is sufficient available withdrawal space

function performUpkeep(bytes _performData) external

Parameters

Section titled “Parameters”
Name Type Description
_performData bytes encoded list of withdrawal data passed to staking pool strategies

updateWithdrawalBatchIdCutoff

Section titled “updateWithdrawalBatchIdCutoff”

Updates the withdrawalBatchIdCutoff

This value is used to more efficiently return data in getBatchIds by skipping old withdrawal batches

function updateWithdrawalBatchIdCutoff() external

setMinWithdrawalAmount

Section titled “setMinWithdrawalAmount”

Sets the minimum amount of liquid staking tokens that can be queued for withdrawal

function setMinWithdrawalAmount(uint256 _minWithdrawalAmount) external

Parameters

Section titled “Parameters”
Name Type Description
_minWithdrawalAmount uint256 minimum token amount

setMinTimeBetweenWithdrawals

Section titled “setMinTimeBetweenWithdrawals”

Sets the minimum amount of of time between calls to performUpkeep to finalize withdrawals

function setMinTimeBetweenWithdrawals(uint64 _minTimeBetweenWithdrawals) external

Parameters

Section titled “Parameters”
Name Type Description
_minTimeBetweenWithdrawals uint64 minimum time