IOperatorsRegistryV1
Alluvial Finance Inc.
Operators Registry Interface (v1)
This interface exposes methods to handle the list of operators and their keys
Methods
addOperator
function addOperator(string _name, address _operator) external nonpayable returns (uint256)Adds an operator to the registry
Only callable by the administrator
Parameters
_name
string
The name identifying the operator
_operator
address
The address representing the operator, receiving the rewards
Returns
_0
uint256
The index of the new operator
addValidators
function addValidators(uint256 _index, uint32 _keyCount, bytes _publicKeysAndSignatures) external nonpayableAdds new keys for an operator
Only callable by the administrator or the operator address
Parameters
_index
uint256
The operator index
_keyCount
uint32
The amount of keys provided
_publicKeysAndSignatures
bytes
Public keys of the validator, concatenated
demandValidatorExits
function demandValidatorExits(uint256 _count, uint256 _depositedValidatorCount) external nonpayableIncreases the exit request demand
This method is only callable by the river contract, and to actually forward the information to the node operators via event emission, the unprotected requestValidatorExits method must be called
Parameters
_count
uint256
The amount of exit requests to add to the demand
_depositedValidatorCount
uint256
The total deposited validator count
getCurrentValidatorExitsDemand
function getCurrentValidatorExitsDemand() external view returns (uint256)Get the current exit request demand waiting to be triggeredThis value is the amount of exit requests that are demanded and not yet performed by the contract
Returns
_0
uint256
The current exit request demand
getNextValidatorsToDepositFromActiveOperators
function getNextValidatorsToDepositFromActiveOperators(uint256 _count) external view returns (bytes[] publicKeys, bytes[] signatures)Get the next validators that would be funded
Parameters
_count
uint256
Count of validators that would be funded next
Returns
publicKeys
bytes[]
An array of fundable public keys
signatures
bytes[]
An array of signatures linked to the public keys
getOperator
function getOperator(uint256 _index) external view returns (struct OperatorsV2.Operator)Get operator details
Parameters
_index
uint256
The index of the operator
Returns
_0
OperatorsV2.Operator
The details of the operator
getOperatorCount
function getOperatorCount() external view returns (uint256)Get operator count
Returns
_0
uint256
The operator count
getOperatorStoppedValidatorCount
function getOperatorStoppedValidatorCount(uint256 _idx) external view returns (uint32)Retrieve the stopped validator count for an operator index
Parameters
_idx
uint256
The index of the operator
Returns
_0
uint32
The stopped validator count of the operator
getRiver
function getRiver() external view returns (address)Retrieve the River address
Returns
_0
address
The address of River
getStoppedAndRequestedExitCounts
function getStoppedAndRequestedExitCounts() external view returns (uint32, uint256)Retrieve the total stopped and requested exit count
Returns
_0
uint32
The total stopped count
_1
uint256
The total requested exit count
getStoppedValidatorCountPerOperator
function getStoppedValidatorCountPerOperator() external view returns (uint32[])Retrieve the raw stopped validators array from storage
Returns
_0
uint32[]
The stopped validator array
getTotalStoppedValidatorCount
function getTotalStoppedValidatorCount() external view returns (uint32)Retrieve the total stopped validator count
Returns
_0
uint32
The total stopped validator count
getTotalValidatorExitsRequested
function getTotalValidatorExitsRequested() external view returns (uint256)Retrieve the total requested exit countThis value is the amount of exit requests that have been performed, emitting an event for operators to catch
Returns
_0
uint256
The total requested exit count
getValidator
function getValidator(uint256 _operatorIndex, uint256 _validatorIndex) external view returns (bytes publicKey, bytes signature, bool funded)Get the details of a validator
Parameters
_operatorIndex
uint256
The index of the operator
_validatorIndex
uint256
The index of the validator
Returns
publicKey
bytes
The public key of the validator
signature
bytes
The signature used during deposit
funded
bool
True if validator has been funded
initOperatorsRegistryV1
function initOperatorsRegistryV1(address _admin, address _river) external nonpayableInitializes the operators registry
Parameters
_admin
address
Admin in charge of managing operators
_river
address
Address of River system
initOperatorsRegistryV1_1
function initOperatorsRegistryV1_1() external nonpayableInitializes the operators registry for V1_1
listActiveOperators
function listActiveOperators() external view returns (struct OperatorsV2.Operator[])Retrieve the active operator set
Returns
_0
OperatorsV2.Operator[]
The list of active operators and their details
pickNextValidatorsToDeposit
function pickNextValidatorsToDeposit(uint256 _count) external nonpayable returns (bytes[] publicKeys, bytes[] signatures)Retrieve validator keys based on operator statuses
Parameters
_count
uint256
Max amount of keys requested
Returns
publicKeys
bytes[]
An array of public keys
signatures
bytes[]
An array of signatures linked to the public keys
removeValidators
function removeValidators(uint256 _index, uint256[] _indexes) external nonpayableRemove validator keys
Only callable by the administrator or the operator address. The indexes must be provided sorted in decreasing order and duplicate-free, otherwise the method will revertThe operator limit will be set to the lowest deleted key index if the operator's limit wasn't equal to its total key count. The operator or the admin cannot remove funded keysWhen removing validators, the indexes of specific unfunded keys can be changed in order to properly remove the keys from the storage array. Beware of this specific behavior when chaining calls as the targeted public key indexes can point to a different key after a first call was made and performed some swaps
Parameters
_index
uint256
The operator index
_indexes
uint256[]
The indexes of the keys to remove
reportStoppedValidatorCounts
function reportStoppedValidatorCounts(uint32[] _stoppedValidatorCounts, uint256 _depositedValidatorCount) external nonpayableAllows river to override the stopped validators arrayThis actions happens during the Oracle report processing
Parameters
_stoppedValidatorCounts
uint32[]
The new stopped validators array
_depositedValidatorCount
uint256
The total deposited validator count
requestValidatorExits
function requestValidatorExits(uint256 _count) external nonpayablePublic endpoint to consume the exit request demand and perform the actual exit requestsThe selection algorithm will pick validators based on their active validator countsThis value is computed by using the count of funded keys and taking into account the stopped validator counts and exit requests
Parameters
_count
uint256
Max amount of exits to request
setOperatorAddress
function setOperatorAddress(uint256 _index, address _newOperatorAddress) external nonpayableChanges the operator address of an operator
Only callable by the administrator or the previous operator address
Parameters
_index
uint256
The operator index
_newOperatorAddress
address
The new address of the operator
setOperatorLimits
function setOperatorLimits(uint256[] _operatorIndexes, uint32[] _newLimits, uint256 _snapshotBlock) external nonpayableChanges the operator staking limit
Only callable by the administratorThe operator indexes must be in increasing order and contain no duplicateThe limit cannot exceed the total key count of the operatorThe _indexes and _newLimits must have the same length.Each limit value is applied to the operator index at the same index in the _indexes array.
Parameters
_operatorIndexes
uint256[]
The operator indexes, in increasing order and duplicate free
_newLimits
uint32[]
The new staking limit of the operators
_snapshotBlock
uint256
The block number at which the snapshot was computed
setOperatorName
function setOperatorName(uint256 _index, string _newName) external nonpayableChanges the operator name
Only callable by the administrator or the operator
Parameters
_index
uint256
The operator index
_newName
string
The new operator name
setOperatorStatus
function setOperatorStatus(uint256 _index, bool _newStatus) external nonpayableChanges the operator status
Only callable by the administrator
Parameters
_index
uint256
The operator index
_newStatus
bool
The new status of the operator
Events
AddedOperator
event AddedOperator(uint256 indexed index, string name, address indexed operatorAddress)A new operator has been added to the registry
Parameters
index indexed
uint256
The operator index
name
string
The operator display name
operatorAddress indexed
address
The operator address
AddedValidatorKeys
event AddedValidatorKeys(uint256 indexed index, bytes publicKeysAndSignatures)The operator or the admin added new validator keys and signatures
The public keys and signatures are concatenatedA public key is 48 bytes longA signature is 96 bytes long[P1, S1, P2, S2, ..., PN, SN] where N is the bytes length divided by (96 + 48)
Parameters
index indexed
uint256
The operator index
publicKeysAndSignatures
bytes
The concatenated public keys and signatures
FundedValidatorKeys
event FundedValidatorKeys(uint256 indexed index, bytes[] publicKeys, bool deferred)A validator key got funded on the deposit contract. This event was introduced during a contract upgrade, in order to cover all possible public keys, this event will be replayed for past funded keys in order to have a complete coverage of all the funded public keys.In this particular scenario, the deferred value will be set to true, to indicate that we are not going to have the expected additional events and side effects in the same transaction (deposit to official DepositContract etc ...) because the event was synthetically crafted.
Parameters
index indexed
uint256
The operator index
publicKeys
bytes[]
BLS Public key that got funded
deferred
bool
True if event has been replayed in the context of a migration
OperatorEditsAfterSnapshot
event OperatorEditsAfterSnapshot(uint256 indexed index, uint256 currentLimit, uint256 newLimit, uint256 indexed latestKeysEditBlockNumber, uint256 indexed snapshotBlock)The operator edited its keys after the snapshot block
This means that we cannot assume that its key set is checked by the snapshotThis happens only if the limit was meant to be increased
Parameters
index indexed
uint256
The operator index
currentLimit
uint256
The current operator limit
newLimit
uint256
The new operator limit that was attempted to be set
latestKeysEditBlockNumber indexed
uint256
The last block number at which the operator changed its keys
snapshotBlock indexed
uint256
The block number of the snapshot
OperatorLimitUnchanged
event OperatorLimitUnchanged(uint256 indexed index, uint256 limit)The call didn't alter the limit of the operator
Parameters
index indexed
uint256
The operator index
limit
uint256
The limit of the operator
RemovedValidatorKey
event RemovedValidatorKey(uint256 indexed index, bytes publicKey)The operator or the admin removed a public key and its signature from the registry
Parameters
index indexed
uint256
The operator index
publicKey
bytes
The BLS public key that has been removed
RequestedValidatorExits
event RequestedValidatorExits(uint256 indexed index, uint256 count)The requested exit count has been updated
Parameters
index indexed
uint256
The operator index
count
uint256
The count of requested exits
SetCurrentValidatorExitsDemand
event SetCurrentValidatorExitsDemand(uint256 previousValidatorExitsDemand, uint256 nextValidatorExitsDemand)The exit request demand has been updated
Parameters
previousValidatorExitsDemand
uint256
The previous exit request demand
nextValidatorExitsDemand
uint256
The new exit request demand
SetOperatorAddress
event SetOperatorAddress(uint256 indexed index, address indexed newOperatorAddress)The operator address has been changed
Parameters
index indexed
uint256
The operator index
newOperatorAddress indexed
address
The new operator address
SetOperatorLimit
event SetOperatorLimit(uint256 indexed index, uint256 newLimit)The operator limit has been changed
Parameters
index indexed
uint256
The operator index
newLimit
uint256
The new operator staking limit
SetOperatorName
event SetOperatorName(uint256 indexed index, string newName)The operator display name has been changed
Parameters
index indexed
uint256
The operator index
newName
string
The new display name
SetOperatorStatus
event SetOperatorStatus(uint256 indexed index, bool active)The operator status has been changed
Parameters
index indexed
uint256
The operator index
active
bool
True if the operator is active
SetOperatorStoppedValidatorCount
event SetOperatorStoppedValidatorCount(uint256 indexed index, uint256 newStoppedValidatorCount)The operator stopped validator count has been changed
Parameters
index indexed
uint256
The operator index
newStoppedValidatorCount
uint256
The new stopped validator count
SetRiver
event SetRiver(address indexed river)The stored river address has been changed
Parameters
river indexed
address
The new river address
SetTotalValidatorExitsRequested
event SetTotalValidatorExitsRequested(uint256 previousTotalValidatorExitsRequested, uint256 newTotalValidatorExitsRequested)The total requested exit has been updated
Parameters
previousTotalValidatorExitsRequested
uint256
The previous total requested exit
newTotalValidatorExitsRequested
uint256
The new total requested exit
UpdatedRequestedValidatorExitsUponStopped
event UpdatedRequestedValidatorExitsUponStopped(uint256 indexed index, uint32 oldRequestedExits, uint32 newRequestedExits)The requested exit count has been update to fill the gap with the reported stopped count
Parameters
index indexed
uint256
The operator index
oldRequestedExits
uint32
The old requested exit count
newRequestedExits
uint32
The new requested exit count
UpdatedStoppedValidators
event UpdatedStoppedValidators(uint32[] stoppedValidatorCounts)The stopped validator array has been changedA validator is considered stopped if exiting, exited or slashedThis event is emitted when the oracle reports new stopped validators counts
Parameters
stoppedValidatorCounts
uint32[]
The new stopped validator counts
Errors
InactiveOperator
error InactiveOperator(uint256 index)The calling operator is inactive
Parameters
index
uint256
The operator index
InvalidArrayLengths
error InvalidArrayLengths()The provided operator and limits array have different lengths
InvalidEmptyArray
error InvalidEmptyArray()The provided operator and limits array are empty
InvalidEmptyStoppedValidatorCountsArray
error InvalidEmptyStoppedValidatorCountsArray()Thrown when an invalid empty stopped validator array is provided
InvalidFundedKeyDeletionAttempt
error InvalidFundedKeyDeletionAttempt()A funded key deletion has been attempted
InvalidIndexOutOfBounds
error InvalidIndexOutOfBounds()The index that is removed is out of bounds
InvalidKeyCount
error InvalidKeyCount()The provided key count is 0
InvalidKeysLength
error InvalidKeysLength()The provided concatenated keys do not have the expected length
InvalidStoppedValidatorCountsSum
error InvalidStoppedValidatorCountsSum()Thrown when the sum of stopped validators is invalid
InvalidUnsortedIndexes
error InvalidUnsortedIndexes()The index provided are not sorted properly (descending order)
NoExitRequestsToPerform
error NoExitRequestsToPerform()Thrown when no exit requests can be performed
OperatorLimitTooHigh
error OperatorLimitTooHigh(uint256 index, uint256 limit, uint256 keyCount)The value for the operator limit is too high
Parameters
index
uint256
The operator index
limit
uint256
The new limit provided
keyCount
uint256
The operator key count
OperatorLimitTooLow
error OperatorLimitTooLow(uint256 index, uint256 limit, uint256 fundedKeyCount)The value for the limit is too low
Parameters
index
uint256
The operator index
limit
uint256
The new limit provided
fundedKeyCount
uint256
The operator funded key count
StoppedValidatorCountAboveFundedCount
error StoppedValidatorCountAboveFundedCount(uint256 operatorIndex, uint32 stoppedCount, uint32 fundedCount)The provided stopped validator count of an operator is above its funded validator count
Parameters
operatorIndex
uint256
undefined
stoppedCount
uint32
undefined
fundedCount
uint32
undefined
StoppedValidatorCountArrayShrinking
error StoppedValidatorCountArrayShrinking()The provided stopped validator count array is shrinking
StoppedValidatorCountsDecreased
error StoppedValidatorCountsDecreased()Throw when an element in the stopped validator array is decreasing
StoppedValidatorCountsTooHigh
error StoppedValidatorCountsTooHigh()Thrown when the number of elements in the array is too high compared to operator count
UnorderedOperatorList
error UnorderedOperatorList()The provided list of operators is not in increasing order
Last updated