Skip to content
stake.link

FundFlowController: Chainlink Vault Deposits and Unbonding

The FundFlowController manages deposits and withdrawals for Chainlink staking vaults in the OperatorVCS and CommunityVCS. Specifically, it calculates vault deposit/withdrawal order, calculates the current state of accounting across vault groups, and periodically unbonds vaults in the Chainlink staking contract to ensure there are always funds available to withdraw.

View Functions

Section titled “View Functions”

operatorVCS

Section titled “operatorVCS”

Returns the address of the Operator VCS

function operatorVCS() public view returns (address)

Return Values

Section titled “Return Values”
Name Type Description
operatorVCS address Address of Operator VCS

communityVCS

Section titled “communityVCS”

Returns the address of the Community VCS

function communityVCS() public view returns (address)

Return Values

Section titled “Return Values”
Name Type Description
communityVCS address Address of Community VCS

unbondingPeriod

Section titled “unbondingPeriod”

Returns the duration of the unbonding period in the Chainlink staking contract

function unbondingPeriod() public view returns (uint64)

Return Values

Section titled “Return Values”
Name Type Description
unbondingPeriod uint64 Unbonding period

claimPeriod

Section titled “claimPeriod”

Returns the duration of the claim period in the Chainlink staking contract

function claimPeriod() public view returns (uint64)

Return Values

Section titled “Return Values”
Name Type Description
claimPeriod uint64 Claim period

numVaultGroups

Section titled “numVaultGroups”

Returns the total number of vault groups

function numVaultGroups() public view returns (uint64)

Return Values

Section titled “Return Values”
Name Type Description
numVaultGroups uint64 Number of vault groups

curUnbondedVaultGroup

Section titled “curUnbondedVaultGroup”

Returns the index of current unbonded vault group

function curUnbondedVaultGroup() public view returns (uint64)

Return Values

Section titled “Return Values”
Name Type Description
curUnbondedVaultGroup uint64 Current unbonded vault group

timeOfLastUpdateByGroup

Section titled “timeOfLastUpdateByGroup”

Returns the time that a vault group was last unbonded

function timeOfLastUpdateByGroup() public view returns (uint64)

Parameters

Section titled “Parameters”
Name Type Description
vaultGroup uint64 Index of vault group

Return Values

Section titled “Return Values”
Name Type Description
timeOfLastUpdate uint64 Time of last update for selected group

getDepositData

Section titled “getDepositData”

Returns encoded vault deposit order for each strategy

Return data should be passed to the priority pool when depositing into the staking pool

function getDepositData(uint256 _toDeposit) external view returns (bytes[])

Parameters

Section titled “Parameters”
Name Type Description
_toDeposit uint256 amount to deposit

Return Values

Section titled “Return Values”
Name Type Description
depositData bytes[] list of encoded vault deposit data

getWithdrawalData

Section titled “getWithdrawalData”

Returns encoded vault withdrawal order for each strategy

Return data should be passed to the priority pool when withdrawing from the staking pool

function getWithdrawalData(uint256 _toWithdraw) external view returns (bytes[])

Parameters

Section titled “Parameters”
Name Type Description
_toWithdraw uint256 amount to withdraw

Return Values

Section titled “Return Values”
Name Type Description
withdrawalData bytes[] list of encoded vault withdrawal data

claimPeriodActive

Section titled “claimPeriodActive”

Returns whether claim period is active

Funds can only be withdrawn while the claim period is active

function claimPeriodActive() external view returns (bool)

Return Values

Section titled “Return Values”
Name Type Description
isActive bool true if claim period is active, false otherwise

shouldUpdateVaultGroups

Section titled “shouldUpdateVaultGroups”

Returns whether vault groups should be updated.

function shouldUpdateVaultGroups() external view returns (bool)

Return Values

Section titled “Return Values”
Name Type Description
shouldUpdate bool true if vault groups should be updated, false otherwise

Write Functions

Section titled “Write Functions”

updateVaultGroups

Section titled “updateVaultGroups”

Executes a vault group update

Re-unbonds all vaults in the current vault group and increments the current vault group
to the next one which will have just entered the claim period
an update is needed once per claim period right after the claim period expires for the
current vault group

function updateVaultGroups() external

updateOperatorVaultGroupAccounting

Section titled “updateOperatorVaultGroupAccounting”

Calculates and updates totalDepositRoom and totalUnbonded for a list of operator vault groups

Used to correct minor accounting errors that result from the removal or slashing
of operators in the Chainlink staking contract

function updateOperatorVaultGroupAccounting(uint256[] _vaultGroups) external

Parameters

Section titled “Parameters”
Name Type Description
_vaultGroups uint256[] list of vault groups

delegateVaults

Section titled “delegateVaults”

Delegates to an address for a group of vaults.

function delegateVaults(address[] _vaults, address _to, bytes32 _rights, bool _enable) external

Parameters

Section titled “Parameters”
Name Type Description
_vaults address[] List of vault addresses
_to address Address to delegate to
_rights bytes32 Rights to grant
_enable bool Whether to enable or revoke delegation

withdrawTokenRewards

Section titled “withdrawTokenRewards”

Withdraws non-LINK token rewards from a group of vaults.

function withdrawTokenRewards(address[] _vaults, address[] _tokens) external

Parameters

Section titled “Parameters”
Name Type Description
_vaults address[] List of vault addresses
_tokens address[] List of tokens to withdraw

setNonLINKRewardReceiver

Section titled “setNonLINKRewardReceiver”

Sets the address of reward receiver for non-LINK vault rewards.

function setNonLINKRewardReceiver(address _nonLINKRewardReceiver) external

Parameters

Section titled “Parameters”
Name Type Description
_nonLINKRewardReceiver address Address of reward receiver