DepositDataRegistry
Inherits: Multicall →, IDepositDataRegistry
Defines the functionality for the Vault's deposit data management.
Events
DepositDataManagerUpdated
Event emitted on deposit data manager update
event DepositDataManagerUpdated(address indexed vault, address depositDataManager);
Parameters
| Name | Type | Description |
|---|---|---|
vault | address | The address of the vault |
depositDataManager | address | The address of the new deposit data manager |
DepositDataRootUpdated
Event emitted on deposit data root update
event DepositDataRootUpdated(address indexed vault, bytes32 depositDataRoot);
Parameters
| Name | Type | Description |
|---|---|---|
vault | address | The address of the vault |
depositDataRoot | bytes32 | The new deposit data Merkle tree root |
DepositDataMigrated
Event emitted on deposit data migration
event DepositDataMigrated(
address indexed vault, bytes32 depositDataRoot, uint256 validatorIndex, address depositDataManager
);
Parameters
| Name | Type | Description |
|---|---|---|
vault | address | The address of the vault |
depositDataRoot | bytes32 | The deposit data root |
validatorIndex | uint256 | The index of the next validator to be registered |
depositDataManager | address | The address of the deposit data manager |
Functions
onlyValidVault
Modifier to check if the caller is a valid vault
modifier onlyValidVault(address vault) ;
Parameters
| Name | Type | Description |
|---|---|---|
vault | address | The address of the vault |
depositDataIndexes
The vault deposit data index
function depositDataIndexes(address vault) external view returns (uint256 validatorIndex);
Parameters
| Name | Type | Description |
|---|---|---|
vault | address | The address of the vault |
Returns
| Name | Type | Description |
|---|---|---|
validatorIndex | uint256 | The index of the next validator to be registered |
depositDataRoots
The vault deposit data root
function depositDataRoots(address vault) external view returns (bytes32 depositDataRoot);
Parameters
| Name | Type | Description |
|---|---|---|
vault | address | The address of the vault |
Returns
| Name | Type | Description |
|---|---|---|
depositDataRoot | bytes32 | The deposit data root |
getDepositDataManager
The vault deposit data manager. Defaults to the vault admin if not set.
function getDepositDataManager(address vault) public view override returns (address);
Parameters
| Name | Type | Description |
|---|---|---|
vault | address | The address of the vault |
Returns
| Name | Type | Description |
|---|---|---|
<none> | address | depositDataManager The address of the deposit data manager |
setDepositDataManager
Function for setting the deposit data manager for the vault. Can only be called by the vault admin.
function setDepositDataManager(address vault, address depositDataManager) external override onlyValidVault(vault);
Parameters
| Name | Type | Description |
|---|---|---|
vault | address | The address of the vault |
depositDataManager | address | The address of the new deposit data manager |
setDepositDataRoot
Function for setting the deposit data root for the vault. Can only be called by the deposit data manager.
function setDepositDataRoot(address vault, bytes32 depositDataRoot) external override onlyValidVault(vault);
Parameters
| Name | Type | Description |
|---|---|---|
vault | address | The address of the vault |
depositDataRoot | bytes32 | The new deposit data Merkle tree root |
updateVaultState
Updates the vault state. Can be used in multicall to update state and register validator(s).
function updateVaultState(address vault, IKeeperRewards.HarvestParams calldata harvestParams) external override;
Parameters
| Name | Type | Description |
|---|---|---|
vault | address | The address of the vault |
harvestParams | IKeeperRewards.HarvestParams | The harvest params to use for updating the vault state |
registerValidator
Function for registering single validator
function registerValidator(
address vault,
IKeeperValidators.ApprovalParams calldata keeperParams,
bytes32[] calldata proof
) external override onlyValidVault(vault);
Parameters
| Name | Type | Description |
|---|---|---|
vault | address | The address of the vault |
keeperParams | IKeeperValidators.ApprovalParams | The parameters for getting approval from Keeper oracles |
proof | bytes32[] | The proof used to verify that the validator is part of the deposit data merkle tree |
registerValidators
Function for registering multiple validators
function registerValidators(
address vault,
IKeeperValidators.ApprovalParams calldata keeperParams,
uint256[] calldata indexes,
bool[] calldata proofFlags,
bytes32[] calldata proof
) external override onlyValidVault(vault);
Parameters
| Name | Type | Description |
|---|---|---|
vault | address | The address of the vault |
keeperParams | IKeeperValidators.ApprovalParams | The parameters for getting approval from Keeper oracles |
indexes | uint256[] | The indexes of the leaves for the merkle tree multi proof verification |
proofFlags | bool[] | The multi proof flags for the merkle tree verification |
proof | bytes32[] | The proof used for the merkle tree verification |
migrate
Function for migrating the deposit data of the Vault. Can only be called once by a vault during an upgrade.
function migrate(bytes32 depositDataRoot, uint256 validatorIndex, address depositDataManager)
external
override
onlyValidVault(msg.sender);
Parameters
| Name | Type | Description |
|---|---|---|
depositDataRoot | bytes32 | The current deposit data root |
validatorIndex | uint256 | The current index of the next validator to be registered |
depositDataManager | address | The address of the deposit data manager |