CSModule
CSModule.sol is a core module contract conforming to the IStakingModule interface. It stores information about Node Operators and deposit data (DD). This contract is responsible for all interactions with the StakingRouter, namely, the DD queue management and some of the Node Operator's parameters. Node Operators manage their validator keys and other parameters they can modify through this contract.
Changes in v2:
- Node Operator creation methods were replaced with a single permissioned method. Node Operators creation is now possible only through Entry Gates or Extensions contracts attached to
CSModule.solviaCREATE_NODE_OPERATOR_ROLE; - Rewards claims and bond top-ups are moved to
CSAccounting.sol; - The slashing reporting method is removed;
- Node-Operator-type-related parameters moved to
CSParametersRegistry.sol; - DD queue mechanism was reworked to allow for multiple priority queues;
- Public release mechanism (used for Early Access purpose) was deprecated. Permissioned CSM is now possible with the use of the Vetted Gates without Permissionless Gate while setting a key limit for the corresponding Node Operator type;
- Reset bond curve removed for cases of slashing and settled EL stealing penalty due to the introduction of the Node Operator types associated with the bond curve;
Upgradability
The contract uses OssifiableProxy for upgradability.
State Variables
PAUSE_ROLE
bytes32 public constant PAUSE_ROLE = keccak256("PAUSE_ROLE");
RESUME_ROLE
bytes32 public constant RESUME_ROLE = keccak256("RESUME_ROLE");
STAKING_ROUTER_ROLE
bytes32 public constant STAKING_ROUTER_ROLE = keccak256("STAKING_ROUTER_ROLE");
REPORT_EL_REWARDS_STEALING_PENALTY_ROLE
bytes32 public constant REPORT_EL_REWARDS_STEALING_PENALTY_ROLE = keccak256("REPORT_EL_REWARDS_STEALING_PENALTY_ROLE");
SETTLE_EL_REWARDS_STEALING_PENALTY_ROLE
bytes32 public constant SETTLE_EL_REWARDS_STEALING_PENALTY_ROLE = keccak256("SETTLE_EL_REWARDS_STEALING_PENALTY_ROLE");
VERIFIER_ROLE
bytes32 public constant VERIFIER_ROLE = keccak256("VERIFIER_ROLE");
RECOVERER_ROLE
bytes32 public constant RECOVERER_ROLE = keccak256("RECOVERER_ROLE");
CREATE_NODE_OPERATOR_ROLE
bytes32 public constant CREATE_NODE_OPERATOR_ROLE = keccak256("CREATE_NODE_OPERATOR_ROLE");
DEPOSIT_SIZE
uint256 public constant DEPOSIT_SIZE = 32 ether;
LIDO_LOCATOR
ILidoLocator public immutable LIDO_LOCATOR;
STETH
IStETH public immutable STETH;
PARAMETERS_REGISTRY
ICSParametersRegistry public immutable PARAMETERS_REGISTRY;
ACCOUNTING
ICSAccounting public immutable ACCOUNTING;
EXIT_PENALTIES
ICSExitPenalties public immutable EXIT_PENALTIES;
FEE_DISTRIBUTOR
address public immutable FEE_DISTRIBUTOR;
QUEUE_LOWEST_PRIORITY
QUEUE_LOWEST_PRIORITY identifies the range of available priorities: [0; QUEUE_LOWEST_PRIORITY].
uint256 public immutable QUEUE_LOWEST_PRIORITY;
QUEUE_LEGACY_PRIORITY
QUEUE_LEGACY_PRIORITY is the priority for the CSM v1 queue.
uint256 public immutable QUEUE_LEGACY_PRIORITY;
Functions
resume
Resume creation of the Node Operators and keys upload
function resume() external onlyRole(RESUME_ROLE);
pauseFor
Pause creation of the Node Operators and keys upload for duration seconds.
Existing NO management and reward claims are still available.
To pause reward claims use pause method on CSAccounting
function pauseFor(uint256 duration) external onlyRole(PAUSE_ROLE);
Parameters
| Name | Type | Description |
|---|---|---|
duration | uint256 | Duration of the pause in seconds |
createNodeOperator
Permissioned method to add a new Node Operator
Should be called by *Gate.sol contracts. See PermissionlessGate.sol and VettedGate.sol for examples
function createNodeOperator(
address from,
NodeOperatorManagementProperties calldata managementProperties,
address referrer
) external onlyRole(CREATE_NODE_OPERATOR_ROLE) whenResumed returns (uint256 nodeOperatorId);
Parameters
| Name | Type | Description |
|---|---|---|
from | address | Sender address. Initial sender address to be used as a default manager and reward addresses. Gates must pass the correct address in order to specify which address should be the owner of the Node Operator. |
managementProperties | NodeOperatorManagementProperties | Optional. Management properties to be used for the Node Operator. managerAddress: Used as managerAddress for the Node Operator. If not passed from will be used. rewardAddress: Used as rewardAddress for the Node Operator. If not passed from will be used. extendedManagerPermissions: Flag indicating that managerAddress will be able to change rewardAddress. If set to true resetNodeOperatorManagerAddress method will be disabled |
referrer | address | Optional. Referrer address. Should be passed when Node Operator is created using partners integration |
addValidatorKeysETH
Add new keys to the existing Node Operator using ETH as a bond
function addValidatorKeysETH(
address from,
uint256 nodeOperatorId,
uint256 keysCount,
bytes calldata publicKeys,
bytes calldata signatures
) external payable whenResumed;
Parameters
| Name | Type | Description |
|---|---|---|
from | address | Sender address. Commonly equals to msg.sender except for the case of Node Operator creation by *Gate.sol contracts |
nodeOperatorId | uint256 | ID of the Node Operator |
keysCount | uint256 | Signing keys count |
publicKeys | bytes | Public keys to submit |
signatures | bytes | Signatures of (deposit_message_root, domain) tuples https://github.com/ethereum/consensus-specs/blob/v1.4.0/specs/phase0/beacon-chain.md#signingdata |
addValidatorKeysStETH
Add new keys to the existing Node Operator using stETH as a bond
function addValidatorKeysStETH(
address from,
uint256 nodeOperatorId,
uint256 keysCount,
bytes calldata publicKeys,
bytes calldata signatures,
ICSAccounting.PermitInput calldata permit
) external whenResumed;
Parameters
| Name | Type | Description |
|---|---|---|
from | address | Sender address. Commonly equals to msg.sender except for the case of Node Operator creation by *Gate.sol contracts |
nodeOperatorId | uint256 | ID of the Node Operator |
keysCount | uint256 | Signing keys count |
publicKeys | bytes | Public keys to submit |
signatures | bytes | Signatures of (deposit_message_root, domain) tuples https://github.com/ethereum/consensus-specs/blob/v1.4.0/specs/phase0/beacon-chain.md#signingdata |
permit | ICSAccounting.PermitInput | Optional. Permit to use stETH as bond |
addValidatorKeysWstETH
Add new keys to the existing Node Operator using wstETH as a bond
function addValidatorKeysWstETH(
address from,
uint256 nodeOperatorId,
uint256 keysCount,
bytes calldata publicKeys,
bytes calldata signatures,
ICSAccounting.PermitInput calldata permit
) external whenResumed;
Parameters
| Name | Type | Description |
|---|---|---|
from | address | Sender address. Commonly equals to msg.sender except for the case of Node Operator creation by *Gate.sol contracts |
nodeOperatorId | uint256 | ID of the Node Operator |
keysCount | uint256 | Signing keys count |
publicKeys | bytes | Public keys to submit |
signatures | bytes | Signatures of (deposit_message_root, domain) tuples https://github.com/ethereum/consensus-specs/blob/v1.4.0/specs/phase0/beacon-chain.md#signingdata |
permit | ICSAccounting.PermitInput | Optional. Permit to use wstETH as bond |
proposeNodeOperatorManagerAddressChange
Propose a new manager address for the Node Operator
function proposeNodeOperatorManagerAddressChange(uint256 nodeOperatorId, address proposedAddress) external;
Parameters
| Name | Type | Description |
|---|---|---|
nodeOperatorId | uint256 | ID of the Node Operator |
proposedAddress | address | Proposed manager address |
confirmNodeOperatorManagerAddressChange
Confirm a new manager address for the Node Operator. Should be called from the currently proposed address
function confirmNodeOperatorManagerAddressChange(uint256 nodeOperatorId) external;
Parameters
| Name | Type | Description |
|---|---|---|
nodeOperatorId | uint256 | ID of the Node Operator |
proposeNodeOperatorRewardAddressChange
Propose a new reward address for the Node Operator
function proposeNodeOperatorRewardAddressChange(uint256 nodeOperatorId, address proposedAddress) external;
Parameters
| Name | Type | Description |
|---|---|---|
nodeOperatorId | uint256 | ID of the Node Operator |
proposedAddress | address | Proposed reward address |
confirmNodeOperatorRewardAddressChange
Confirm a new reward address for the Node Operator. Should be called from the currently proposed address
function confirmNodeOperatorRewardAddressChange(uint256 nodeOperatorId) external;
Parameters
| Name | Type | Description |
|---|---|---|
nodeOperatorId | uint256 | ID of the Node Operator |
resetNodeOperatorManagerAddress
Reset the manager address to the reward address. Should be called from the reward address
function resetNodeOperatorManagerAddress(uint256 nodeOperatorId) external;
Parameters
| Name | Type | Description |
|---|---|---|
nodeOperatorId | uint256 | ID of the Node Operator |
changeNodeOperatorRewardAddress
Change rewardAddress if extendedManagerPermissions is enabled for the Node Operator
function changeNodeOperatorRewardAddress(uint256 nodeOperatorId, address newAddress) external;
Parameters
| Name | Type | Description |
|---|---|---|
nodeOperatorId | uint256 | ID of the Node Operator |
newAddress | address | Proposed reward address |
onRewardsMinted
Called by StakingRouter to signal that stETH rewards were minted for this module.
Passes through the minted stETH shares to the fee distributor
function onRewardsMinted(uint256 totalShares) external onlyRole(STAKING_ROUTER_ROLE);
Parameters
| Name | Type | Description |
|---|---|---|
totalShares | uint256 | Amount of stETH shares that were minted to reward all node operators. |
updateExitedValidatorsCount
Updates the number of the validators in the EXITED state for node operator with given id
function updateExitedValidatorsCount(bytes calldata nodeOperatorIds, bytes calldata exitedValidatorsCounts)
external
onlyRole(STAKING_ROUTER_ROLE);
Parameters
| Name | Type | Description |
|---|---|---|
nodeOperatorIds | bytes | bytes packed array of the node operators id |
exitedValidatorsCounts | bytes | bytes packed array of the new number of EXITED validators for the node operators |
updateTargetValidatorsLimits
Updates the limit of the validators that can be used for deposit
function updateTargetValidatorsLimits(uint256 nodeOperatorId, uint256 targetLimitMode, uint256 targetLimit)
external
onlyRole(STAKING_ROUTER_ROLE);
Parameters
| Name | Type | Description |
|---|---|---|
nodeOperatorId | uint256 | ID of the Node Operator |
targetLimitMode | uint256 | Target limit mode for the Node Operator (see https://hackmd.io/@lido/BJXRTxMRp) 0 - disabled 1 - soft mode 2 - forced mode |
targetLimit | uint256 | Target limit of validators |
onExitedAndStuckValidatorsCountsUpdated
Called by StakingRouter after it finishes updating exited and stuck validators counts for this module's node operators. Guaranteed to be called after an oracle report is applied, regardless of whether any node operator in this module has actually received any updated counts as a result of the report but given that the total number of exited validators returned from getStakingModuleSummary is the same as StakingRouter expects based on the total count received from the oracle.
This method is not used in CSM, hence it does nothing
NOTE: No role checks because of empty body to save bytecode.
function onExitedAndStuckValidatorsCountsUpdated() external;
unsafeUpdateValidatorsCount
Unsafely updates the number of validators in the EXITED/STUCK states for node operator with given id 'unsafely' means that this method can both increase and decrease exited and stuck counters
function unsafeUpdateValidatorsCount(uint256 nodeOperatorId, uint256 exitedValidatorsKeysCount)
external
onlyRole(STAKING_ROUTER_ROLE);
Parameters
| Name | Type | Description |
|---|---|---|
nodeOperatorId | uint256 | |
exitedValidatorsKeysCount | uint256 |
decreaseVettedSigningKeysCount
Called by StakingRouter to decrease the number of vetted keys for Node Operators with given ids
function decreaseVettedSigningKeysCount(bytes calldata nodeOperatorIds, bytes calldata vettedSigningKeysCounts)
external
onlyRole(STAKING_ROUTER_ROLE);
Parameters
| Name | Type | Description |
|---|---|---|
nodeOperatorIds | bytes | Bytes packed array of the Node Operator ids |
vettedSigningKeysCounts | bytes | Bytes packed array of the new numbers of vetted keys for the Node Operators |
removeKeys
Remove keys for the Node Operator and confiscate removal charge for each deleted key
This method is a part of the Optimistic Vetting scheme. After key deletion totalVettedKeys
is set equal to totalAddedKeys. If invalid keys are not removed, the unvetting process will be repeated
and decreaseVettedSigningKeysCount will be called by StakingRouter.
function removeKeys(uint256 nodeOperatorId, uint256 startIndex, uint256 keysCount) external;
Parameters
| Name | Type | Description |
|---|---|---|
nodeOperatorId | uint256 | ID of the Node Operator |
startIndex | uint256 | Index of the first key |
keysCount | uint256 | Keys count to delete |
updateDepositableValidatorsCount
Update depositable validators data and enqueue all unqueued keys for the given Node Operator. Unqueued stands for vetted but not enqueued keys.
*The following rules are applied:
- Unbonded keys can not be depositable
- Unvetted keys can not be depositable
- Depositable keys count should respect targetLimit value*
function updateDepositableValidatorsCount(uint256 nodeOperatorId) external;
Parameters
| Name | Type | Description |
|---|---|---|
nodeOperatorId | uint256 | ID of the Node Operator |
migrateToPriorityQueue
Performs a one-time migration of allocated seats from the legacy or default queue to a priority queue for an eligible node operator. This is possible, e.g., in the following scenario: A node operator uploaded keys before CSM v2 and have no deposits due to a long queue. After the CSM v2 release, the node operator has claimed the ICS or other priority node operator type. This node operator type gives the node operator the ability to get several deposits through the priority queue. So, by calling the migration method, the node operator can obtain seats in the priority queue, even though they already have seats in the legacy queue. The method can also be used by the node operators who joined CSM v2 permissionlessly after the release and had their node operator type upgraded to ICS or another priority type. The method does not remove the old queue items. Hence, the node operator can upload additional keys that will take the place of the migrated keys in the original queue.
function migrateToPriorityQueue(uint256 nodeOperatorId) external;
Parameters
| Name | Type | Description |
|---|---|---|
nodeOperatorId | uint256 | ID of the Node Operator |
reportELRewardsStealingPenalty
Report EL rewards stealing for the given Node Operator
function reportELRewardsStealingPenalty(uint256 nodeOperatorId, bytes32 blockHash, uint256 amount)
external
onlyRole(REPORT_EL_REWARDS_STEALING_PENALTY_ROLE);
Parameters
| Name | Type | Description |
|---|---|---|
nodeOperatorId | uint256 | ID of the Node Operator |
blockHash | bytes32 | Execution layer block hash of the proposed block with EL rewards stealing |
amount | uint256 | Amount of stolen EL rewards in ETH |
cancelELRewardsStealingPenalty
Cancel previously reported and not settled EL rewards stealing penalty for the given Node Operator
function cancelELRewardsStealingPenalty(uint256 nodeOperatorId, uint256 amount)
external
onlyRole(REPORT_EL_REWARDS_STEALING_PENALTY_ROLE);
Parameters
| Name | Type | Description |
|---|---|---|
nodeOperatorId | uint256 | ID of the Node Operator |
amount | uint256 | Amount of penalty to cancel |
settleELRewardsStealingPenalty
Settle locked bond for the given Node Operators
SETTLE_EL_REWARDS_STEALING_PENALTY_ROLE role is expected to be assigned to Easy Track
function settleELRewardsStealingPenalty(uint256[] calldata nodeOperatorIds)
external
onlyRole(SETTLE_EL_REWARDS_STEALING_PENALTY_ROLE);
Parameters
| Name | Type | Description |
|---|---|---|
nodeOperatorIds | uint256[] | IDs of the Node Operators |
compensateELRewardsStealingPenalty
Compensate EL rewards stealing penalty for the given Node Operator to prevent further validator exits
Can only be called by the Node Operator manager
function compensateELRewardsStealingPenalty(uint256 nodeOperatorId) external payable;
Parameters
| Name | Type | Description |
|---|---|---|
nodeOperatorId | uint256 | ID of the Node Operator |
submitWithdrawals
Report Node Operator's keys as withdrawn and settle withdrawn amount
function submitWithdrawals(ValidatorWithdrawalInfo[] calldata withdrawalsInfo) external onlyRole(VERIFIER_ROLE);
Parameters
| Name | Type | Description |
|---|---|---|
withdrawalsInfo | ValidatorWithdrawalInfo[] | An array for the validator withdrawals info structs |
onWithdrawalCredentialsChanged
Called by StakingRouter when withdrawal credentials are changed.
Changing the WC means that the current deposit data in the queue is not valid anymore and can't be deposited. DSM will unvet current keys due to nonce change. The key removal charge should be reset to 0 manually by the DAO to allow Node Operators to remove the keys without any charge. After keys removal the DAO should set the new key removal charge.
function onWithdrawalCredentialsChanged() external onlyRole(STAKING_ROUTER_ROLE);
reportValidatorExitDelay
Handles tracking and penalization logic for a validator that remains active beyond its eligible exit window.
This function is called by the StakingRouter to report the current exit-related status of a validator belonging to a specific node operator. It accepts a validator's public key, associated with the duration (in seconds) it was eligible to exit but has not exited. This data could be used to trigger penalties for the node operator if the validator has exceeded the allowed exit window.
function reportValidatorExitDelay(
uint256 nodeOperatorId,
uint256,
bytes calldata publicKey,
uint256 eligibleToExitInSec
) external onlyRole(STAKING_ROUTER_ROLE);
Parameters
| Name | Type | Description |
|---|---|---|
nodeOperatorId | uint256 | |
<none> | uint256 | |
publicKey | bytes | |
eligibleToExitInSec | uint256 |
onValidatorExitTriggered
Handles the triggerable exit event for a validator belonging to a specific node operator.
This function is called by the StakingRouter when a validator is exited using the triggerable exit request on the Execution Layer (EL).
function onValidatorExitTriggered(
uint256 nodeOperatorId,
bytes calldata publicKey,
uint256 withdrawalRequestPaidFee,
uint256 exitType
) external onlyRole(STAKING_ROUTER_ROLE);
Parameters
| Name | Type | Description |
|---|---|---|
nodeOperatorId | uint256 | |
publicKey | bytes | |
withdrawalRequestPaidFee | uint256 | |
exitType | uint256 |
obtainDepositData
Get the next depositsCount of depositable keys with signatures from the queue
The method does not update depositable keys count for the Node Operators before the queue processing start. Hence, in the rare cases of negative stETH rebase the method might return unbonded keys. This is a trade-off between the gas cost and the correctness of the data. Due to module design, any unbonded keys will be requested to exit by VEBO.
Second param depositCalldata is not used
function obtainDepositData(uint256 depositsCount, bytes calldata)
external
onlyRole(STAKING_ROUTER_ROLE)
returns (bytes memory publicKeys, bytes memory signatures);
Parameters
| Name | Type | Description |
|---|---|---|
depositsCount | uint256 | Number of deposits to be done |
<none> | bytes |
Returns
| Name | Type | Description |
|---|---|---|
publicKeys | bytes | Batch of the concatenated public validators keys |
signatures | bytes | Batch of the concatenated deposit signatures for returned public keys |
cleanDepositQueue
Clean the deposit queue from batches with no depositable keys
Use eth_call to check how many items will be removed
function cleanDepositQueue(uint256 maxItems) external returns (uint256 removed, uint256 lastRemovedAtDepth);
Parameters
| Name | Type | Description |
|---|---|---|
maxItems | uint256 | How many queue items to review |
Returns
| Name | Type | Description |
|---|---|---|
removed | uint256 | Count of batches to be removed by visiting maxItems batches |
lastRemovedAtDepth | uint256 | The value to use as maxItems to remove removed batches if the static call of the method was used |
getInitializedVersion
Returns the initialized version of the contract
function getInitializedVersion() external view returns (uint64);
depositQueuePointers
Get the pointers to the head and tail of queue with the given priority.
function depositQueuePointers(uint256 queuePriority) external view returns (uint128 head, uint128 tail);
Parameters
| Name | Type | Description |
|---|---|---|
queuePriority | uint256 | Priority of the queue to get the pointers. |
Returns
| Name | Type | Description |
|---|---|---|
head | uint128 | Pointer to the head of the queue. |
tail | uint128 | Pointer to the tail of the queue. |
depositQueueItem
Get the deposit queue item by an index
function depositQueueItem(uint256 queuePriority, uint128 index) external view returns (Batch);
Parameters
| Name | Type | Description |
|---|---|---|
queuePriority | uint256 | Priority of the queue to get an item from |
index | uint128 | Index of a queue item |
Returns
| Name | Type | Description |
|---|---|---|
<none> | Batch | Deposit queue item from the priority queue |
isValidatorWithdrawn
Check if the given Node Operator's key is reported as withdrawn
function isValidatorWithdrawn(uint256 nodeOperatorId, uint256 keyIndex) external view returns (bool);
Parameters
| Name | Type | Description |
|---|---|---|
nodeOperatorId | uint256 | ID of the Node Operator |
keyIndex | uint256 | index of the key to check |
Returns
| Name | Type | Description |
|---|---|---|
<none> | bool | Is validator reported as withdrawn or not |
getType
Returns the type of the staking module
function getType() external view returns (bytes32);
Returns
| Name | Type | Description |
|---|---|---|
<none> | bytes32 | Module type |
getStakingModuleSummary
Returns all-validators summary in the staking module
function getStakingModuleSummary()
external
view
returns (uint256 totalExitedValidators, uint256 totalDepositedValidators, uint256 depositableValidatorsCount);
Returns
| Name | Type | Description |
|---|---|---|
totalExitedValidators | uint256 | total number of validators in the EXITED state on the Consensus Layer. This value can't decrease in normal conditions |
totalDepositedValidators | uint256 | total number of validators deposited via the official Deposit Contract. This value is a cumulative counter: even when the validator goes into EXITED state this counter is not decreasing |
depositableValidatorsCount | uint256 | number of validators in the set available for deposit |
getNodeOperator
Get Node Operator info
function getNodeOperator(uint256 nodeOperatorId) external view returns (NodeOperator memory);
Parameters
| Name | Type | Description |
|---|---|---|
nodeOperatorId | uint256 | ID of the Node Operator |
Returns
| Name | Type | Description |
|---|---|---|
<none> | NodeOperator | Node Operator info |
getNodeOperatorManagementProperties
Get Node Operator management properties
function getNodeOperatorManagementProperties(uint256 nodeOperatorId)
external
view
returns (NodeOperatorManagementProperties memory);
Parameters
| Name | Type | Description |
|---|---|---|
nodeOperatorId | uint256 | ID of the Node Operator |
Returns
| Name | Type | Description |
|---|---|---|
<none> | NodeOperatorManagementProperties | Node Operator management properties |
getNodeOperatorOwner
Get Node Operator owner. Owner is manager address if extendedManagerPermissions is enabled and reward address otherwise
function getNodeOperatorOwner(uint256 nodeOperatorId) external view returns (address);
Parameters
| Name | Type | Description |
|---|---|---|
nodeOperatorId | uint256 | ID of the Node Operator |
Returns
| Name | Type | Description |
|---|---|---|
<none> | address | Node Operator owner |
getNodeOperatorNonWithdrawnKeys
Get Node Operator non-withdrawn keys
function getNodeOperatorNonWithdrawnKeys(uint256 nodeOperatorId) external view returns (uint256);
Parameters
| Name | Type | Description |
|---|---|---|
nodeOperatorId | uint256 | ID of the Node Operator |
Returns
| Name | Type | Description |
|---|---|---|
<none> | uint256 | Non-withdrawn keys count |
getNodeOperatorSummary
depositableValidatorsCount depends on:
- totalVettedKeys
- totalDepositedKeys
- totalExitedKeys
- targetLimitMode
- targetValidatorsCount
- totalUnbondedKeys
function getNodeOperatorSummary(uint256 nodeOperatorId)
external
view
returns (
uint256 targetLimitMode,
uint256 targetValidatorsCount,
uint256 stuckValidatorsCount,
uint256 refundedValidatorsCount,
uint256 stuckPenaltyEndTimestamp,
uint256 totalExitedValidators,
uint256 totalDepositedValidators,
uint256 depositableValidatorsCount
);
Parameters
| Name | Type | Description |
|---|---|---|
nodeOperatorId | uint256 | id of the operator to return report for |
Returns
| Name | Type | Description |
|---|---|---|
targetLimitMode | uint256 | shows whether the current target limit applied to the node operator (1 = soft mode, 2 = forced mode) |
targetValidatorsCount | uint256 | relative target active validators limit for operator |
stuckValidatorsCount | uint256 | number of validators with an expired request to exit time |
refundedValidatorsCount | uint256 | number of validators that can't be withdrawn, but deposit costs were compensated to the Lido by the node operator |
stuckPenaltyEndTimestamp | uint256 | time when the penalty for stuck validators stops applying to node operator rewards |
totalExitedValidators | uint256 | total number of validators in the EXITED state on the Consensus Layer. This value can't decrease in normal conditions |
totalDepositedValidators | uint256 | total number of validators deposited via the official Deposit Contract. This value is a cumulative counter: even when the validator goes into EXITED state this counter is not decreasing |
depositableValidatorsCount | uint256 | number of validators in the set available for deposit |
getNodeOperatorTotalDepositedKeys
Get Node Operator total deposited keys
function getNodeOperatorTotalDepositedKeys(uint256 nodeOperatorId) external view returns (uint256 totalDepositedKeys);
Parameters
| Name | Type | Description |
|---|---|---|
nodeOperatorId | uint256 | ID of the Node Operator |
Returns
| Name | Type | Description |
|---|---|---|
totalDepositedKeys | uint256 | Total deposited keys count |
getSigningKeys
Get Node Operator signing keys
function getSigningKeys(uint256 nodeOperatorId, uint256 startIndex, uint256 keysCount)
external
view
returns (bytes memory);
Parameters
| Name | Type | Description |
|---|---|---|
nodeOperatorId | uint256 | ID of the Node Operator |
startIndex | uint256 | Index of the first key |
keysCount | uint256 | Count of keys to get |
Returns
| Name | Type | Description |
|---|---|---|
<none> | bytes | Signing keys |
getSigningKeysWithSignatures
Get Node Operator signing keys with signatures
function getSigningKeysWithSignatures(uint256 nodeOperatorId, uint256 startIndex, uint256 keysCount)
external
view
returns (bytes memory keys, bytes memory signatures);
Parameters
| Name | Type | Description |
|---|---|---|
nodeOperatorId | uint256 | ID of the Node Operator |
startIndex | uint256 | Index of the first key |
keysCount | uint256 | Count of keys to get |
Returns
| Name | Type | Description |
|---|---|---|
keys | bytes | Signing keys |
signatures | bytes | Signatures of (deposit_message_root, domain) tuples https://github.com/ethereum/consensus-specs/blob/v1.4.0/specs/phase0/beacon-chain.md#signingdata |
getNonce
Returns a counter that MUST change its value whenever the deposit data set changes. Below is the typical list of actions that requires an update of the nonce:
- a node operator's deposit data is added
- a node operator's deposit data is removed
- a node operator's ready-to-deposit data size is changed
- a node operator was activated/deactivated
- a node operator's deposit data is used for the deposit Note: Depending on the StakingModule implementation above list might be extended
In some scenarios, it's allowed to update nonce without actual change of the deposit data subset, but it MUST NOT lead to the DOS of the staking module via continuous update of the nonce by the malicious actor
function getNonce() external view returns (uint256);
getNodeOperatorsCount
Returns total number of node operators
function getNodeOperatorsCount() external view returns (uint256);
getActiveNodeOperatorsCount
Returns number of active node operators
function getActiveNodeOperatorsCount() external view returns (uint256);
getNodeOperatorIsActive
Returns if the node operator with given id is active
function getNodeOperatorIsActive(uint256 nodeOperatorId) external view returns (bool);
Parameters
| Name | Type | Description |
|---|---|---|
nodeOperatorId | uint256 | Id of the node operator |
getNodeOperatorIds
Returns up to limit node operator ids starting from the offset. The order of
the returned ids is not defined and might change between calls.
This view must not revert in case of invalid data passed. When offset exceeds the
total node operators count or when limit is equal to 0 MUST be returned empty array.
function getNodeOperatorIds(uint256 offset, uint256 limit) external view returns (uint256[] memory nodeOperatorIds);
isValidatorExitDelayPenaltyApplicable
Determines whether a validator's exit status should be updated and will have an effect on the Node Operator.
function isValidatorExitDelayPenaltyApplicable(
uint256 nodeOperatorId,
uint256,
bytes calldata publicKey,
uint256 eligibleToExitInSec
) external view returns (bool);
Parameters
| Name | Type | Description |
|---|---|---|
nodeOperatorId | uint256 | |
<none> | uint256 | |
publicKey | bytes | |
eligibleToExitInSec | uint256 |
Returns
| Name | Type | Description |
|---|---|---|
<none> | bool | bool Returns true if the contract should receive the updated status of the validator. |
exitDeadlineThreshold
Returns the number of seconds after which a validator is considered late.
function exitDeadlineThreshold(uint256 nodeOperatorId) external view returns (uint256);
Parameters
| Name | Type | Description |
|---|---|---|
nodeOperatorId | uint256 |
Returns
| Name | Type | Description |
|---|---|---|
<none> | uint256 | The exit deadline threshold in seconds. |
accounting
This function is used to get the accounting contract from immutables to save bytecode and for backwards compatibility
function accounting() public view returns (ICSAccounting);
Events
NodeOperatorAdded
event NodeOperatorAdded(
uint256 indexed nodeOperatorId,
address indexed managerAddress,
address indexed rewardAddress,
bool extendedManagerPermissions
);
ReferrerSet
event ReferrerSet(uint256 indexed nodeOperatorId, address indexed referrer);
DepositableSigningKeysCountChanged
event DepositableSigningKeysCountChanged(uint256 indexed nodeOperatorId, uint256 depositableKeysCount);
VettedSigningKeysCountChanged
event VettedSigningKeysCountChanged(uint256 indexed nodeOperatorId, uint256 vettedKeysCount);
VettedSigningKeysCountDecreased
event VettedSigningKeysCountDecreased(uint256 indexed nodeOperatorId);
DepositedSigningKeysCountChanged
event DepositedSigningKeysCountChanged(uint256 indexed nodeOperatorId, uint256 depositedKeysCount);
ExitedSigningKeysCountChanged
event ExitedSigningKeysCountChanged(uint256 indexed nodeOperatorId, uint256 exitedKeysCount);
TotalSigningKeysCountChanged
event TotalSigningKeysCountChanged(uint256 indexed nodeOperatorId, uint256 totalKeysCount);
TargetValidatorsCountChanged
event TargetValidatorsCountChanged(
uint256 indexed nodeOperatorId, uint256 targetLimitMode, uint256 targetValidatorsCount
);
WithdrawalSubmitted
event WithdrawalSubmitted(uint256 indexed nodeOperatorId, uint256 keyIndex, uint256 amount, bytes pubkey);
BatchEnqueued
event BatchEnqueued(uint256 indexed queuePriority, uint256 indexed nodeOperatorId, uint256 count);
KeyRemovalChargeApplied
event KeyRemovalChargeApplied(uint256 indexed nodeOperatorId);
ELRewardsStealingPenaltyReported
event ELRewardsStealingPenaltyReported(uint256 indexed nodeOperatorId, bytes32 proposedBlockHash, uint256 stolenAmount);
ELRewardsStealingPenaltyCancelled
event ELRewardsStealingPenaltyCancelled(uint256 indexed nodeOperatorId, uint256 amount);
ELRewardsStealingPenaltyCompensated
event ELRewardsStealingPenaltyCompensated(uint256 indexed nodeOperatorId, uint256 amount);
ELRewardsStealingPenaltySettled
event ELRewardsStealingPenaltySettled(uint256 indexed nodeOperatorId);