Skip to content
stake.link

esp staking contracts

EspressoFundFlowController: ESP Unbonding and Rewards

EspressoFundFlowController manages deposits and withdrawals for Espresso staking vaults, including unbonding, restaking, and reward management. It coordinates with the strategy and withdrawal pool contracts and exposes functions for vault and reward state queries.

View Functions

Section titled “View Functions”

strategy

Section titled “strategy”

Returns the address of the staking strategy contract.

function strategy() public view returns (address)

Return Values

Section titled “Return Values”
Name Type Description
strategy address Staking strategy address

withdrawalPool

Section titled “withdrawalPool”

Returns the address of the withdrawal pool contract.

function withdrawalPool() public view returns (address)

Return Values

Section titled “Return Values”
Name Type Description
withdrawalPool address Withdrawal pool address

depositController

Section titled “depositController”

Returns the address authorized to deposit queued tokens into vaults.

function depositController() public view returns (address)

Return Values

Section titled “Return Values”
Name Type Description
depositController address Deposit controller address

minTimeBetweenUnbonding

Section titled “minTimeBetweenUnbonding”

Returns the minimum number of seconds between unbonding calls.

function minTimeBetweenUnbonding() public view returns (uint64)

Return Values

Section titled “Return Values”
Name Type Description
minTimeBetweenUnbonding uint64 Minimum seconds between unbonding

timeOfLastUnbond

Section titled “timeOfLastUnbond”

Returns the time of the last unbonding call.

function timeOfLastUnbond() public view returns (uint64)

Return Values

Section titled “Return Values”
Name Type Description
timeOfLastUnbond uint64 Time of last unbonding

shouldDepositQueuedTokens

Section titled “shouldDepositQueuedTokens”

Returns whether tokens should be deposited and the amount available for deposit.

function shouldDepositQueuedTokens() external view returns (bool, uint256)

Return Values

Section titled “Return Values”
Name Type Description
canDeposit bool true if deposit is allowed
amount uint256 Amount of tokens available to deposit

shouldUnbondVaults

Section titled “shouldUnbondVaults”

Returns whether vaults should be unbonded.

function shouldUnbondVaults() external view returns (bool)

Return Values

Section titled “Return Values”
Name Type Description
shouldUnbond bool true if unbonding is needed

shouldWithdrawVaults

Section titled “shouldWithdrawVaults”

Returns whether vaults are unbonded and ready to be withdrawn from, and the list of withdrawable vaults.

function shouldWithdrawVaults() external view returns (bool, uint256[] memory)

Return Values

Section titled “Return Values”
Name Type Description
canWithdraw bool true if withdrawal is possible
vaultIds uint256[] List of withdrawable vault IDs

getVaultDeposits

Section titled “getVaultDeposits”

Returns a list of total deposits for all vaults.

function getVaultDeposits() external view returns (uint256[] memory)

Return Values

Section titled “Return Values”
Name Type Description
deposits uint256[] List of vault deposits

getVaultRewards

Section titled “getVaultRewards”

Returns a list of unclaimed rewards for all vaults.

function getVaultRewards() external view returns (uint256[] memory)

Return Values

Section titled “Return Values”
Name Type Description
rewards uint256[] List of vault rewards

getUnbondingVaults

Section titled “getUnbondingVaults”

Returns a list of currently unbonding vaults.

function getUnbondingVaults() external view returns (uint256[] memory)

Return Values

Section titled “Return Values”
Name Type Description
vaultIds uint256[] List of unbonding vaults

getWithdrawableVaults

Section titled “getWithdrawableVaults”

Returns a list of currently withdrawable vaults.

function getWithdrawableVaults() public view returns (uint256[] memory)

Return Values

Section titled “Return Values”
Name Type Description
vaultIds uint256[] List of withdrawable vaults

getInactiveVaults

Section titled “getInactiveVaults”

Returns a list of inactive vaults (validators that have exited).

function getInactiveVaults() public view returns (uint256[] memory)

Return Values

Section titled “Return Values”
Name Type Description
vaultIds uint256[] List of inactive vaults

getInactiveWithdrawableVaults

Section titled “getInactiveWithdrawableVaults”

Returns a list of inactive and currently withdrawable vaults.

function getInactiveWithdrawableVaults() public view returns (uint256[] memory)

Return Values

Section titled “Return Values”
Name Type Description
vaultIds uint256[] List of inactive withdrawable vaults

Write Functions

Section titled “Write Functions”

depositQueuedTokens

Section titled “depositQueuedTokens”

Deposits queued tokens into vaults.

function depositQueuedTokens(uint256[] calldata _vaultIds, uint256[] calldata _amounts) external

Parameters

Section titled “Parameters”
Name Type Description
_vaultIds uint256[] List of vault IDs
_amounts uint256[] Amounts to deposit per vault

unbondVaults

Section titled “unbondVaults”

Unbonds vaults if needed.

function unbondVaults() external

forceUnbondVaults

Section titled “forceUnbondVaults”

Unbonds vaults to rebalance deposits between vaults.

function forceUnbondVaults(uint256[] calldata _vaultIds, uint256[] calldata _amounts) external

Parameters

Section titled “Parameters”
Name Type Description
_vaultIds uint256[] List of vault IDs
_amounts uint256[] Amounts to unbond per vault

withdrawVaults

Section titled “withdrawVaults”

Withdraws from vaults and triggers withdrawal pool upkeep if needed.

function withdrawVaults(uint256[] calldata _vaultIds) external

Parameters

Section titled “Parameters”
Name Type Description
_vaultIds uint256[] List of vault IDs

restakeRewards

Section titled “restakeRewards”

Restakes vault rewards for given vaults.

function restakeRewards(uint256[] calldata _vaultIds, uint256[] calldata _lifetimeRewards, bytes[] calldata _authData) external

Parameters

Section titled “Parameters”
Name Type Description
_vaultIds uint256[] List of vault IDs
_lifetimeRewards uint256[] Lifetime rewards values for each vault
_authData bytes[] Authorization data for each vault

withdrawRewards

Section titled “withdrawRewards”

Withdraws vault rewards for given vaults.

function withdrawRewards(uint256[] calldata _vaultIds, uint256[] calldata _lifetimeRewards, bytes[] calldata _authData) external

Parameters

Section titled “Parameters”
Name Type Description
_vaultIds uint256[] List of vault IDs
_lifetimeRewards uint256[] Lifetime rewards values for each vault
_authData bytes[] Authorization data for each vault

setDepositController

Section titled “setDepositController”

Sets the address authorized to deposit queued tokens.

function setDepositController(address _depositController) external

Parameters

Section titled “Parameters”
Name Type Description
_depositController address Deposit controller address

setMinTimeBetweenUnbonding

Section titled “setMinTimeBetweenUnbonding”

Sets the minimum time between unbonding calls.

function setMinTimeBetweenUnbonding(uint64 _minTimeBetweenUnbonding) external

Parameters

Section titled “Parameters”
Name Type Description
_minTimeBetweenUnbonding uint64 Minimum seconds between unbonding