OperatorsRegistryV1

Kiln

Operators Registry (v1)

This contract handles the list of operators and their keys

Methods

acceptAdmin

function acceptAdmin() external nonpayable

Accept the transfer of ownership

Only callable by the pending admin. Resets the pending admin if succesful.

addOperator

function addOperator(string _name, address _operator) external nonpayable returns (uint256)

Adds an operator to the registry

Only callable by the administrator

Parameters

Name	Type	Description
_name	string	The name identifying the operator
_operator	address	The address representing the operator, receiving the rewards

Returns

Name	Type	Description
_0	uint256	The index of the new operator

addValidators

function addValidators(uint256 _index, uint256 _keyCount, bytes _publicKeysAndSignatures) external nonpayable

Adds new keys for an operator

Only callable by the administrator or the operator address

Parameters

Name	Type	Description
_index	uint256	The operator index
_keyCount	uint256	The amount of keys provided
_publicKeysAndSignatures	bytes	Public keys of the validator, concatenated

getAdmin

function getAdmin() external view returns (address)

Retrieves the current admin address

Returns

Name	Type	Description
_0	address	The admin address

getOperator

function getOperator(uint256 _index) external view returns (struct Operators.Operator)

Get operator details

Parameters

Name	Type	Description
_index	uint256	The index of the operator

Returns

Name	Type	Description
_0	Operators.Operator	The details of the operator

getOperatorCount

function getOperatorCount() external view returns (uint256)

Get operator count

Returns

Name	Type	Description
_0	uint256	The operator count

getPendingAdmin

function getPendingAdmin() external view returns (address)

Retrieve the current pending admin address

Returns

Name	Type	Description
_0	address	The pending admin address

getRiver

function getRiver() external view returns (address)

Retrieve the River address

Returns

Name	Type	Description
_0	address	The address of River

getValidator

function getValidator(uint256 _operatorIndex, uint256 _validatorIndex) external view returns (bytes publicKey, bytes signature, bool funded)

Get the details of a validator

Parameters

Name	Type	Description
_operatorIndex	uint256	The index of the operator
_validatorIndex	uint256	The index of the validator

Returns

Name	Type	Description
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 nonpayable

Initializes the operators registry

Parameters

Name	Type	Description
_admin	address	Admin in charge of managing operators
_river	address	Address of River system

listActiveOperators

function listActiveOperators() external view returns (struct Operators.Operator[])

Retrieve the active operator set

Returns

Name	Type	Description
_0	Operators.Operator[]	The list of active operators and their details

pickNextValidators

function pickNextValidators(uint256 _count) external nonpayable returns (bytes[] publicKeys, bytes[] signatures)

Retrieve validator keys based on operator statuses

Parameters

Name	Type	Description
_count	uint256	Max amount of keys requested

Returns

Name	Type	Description
publicKeys	bytes[]	An array of public keys
signatures	bytes[]	An array of signatures linked to the public keys

proposeAdmin

function proposeAdmin(address _newAdmin) external nonpayable

Proposes a new address as admin

This security prevents setting an invalid address as an admin. The pendingadmin has to claim its ownership of the contract, and prove that the newaddress is able to perform regular transactions.

Parameters

Name	Type	Description
_newAdmin	address	New admin address

removeValidators

function removeValidators(uint256 _index, uint256[] _indexes) external nonpayable

Remove validator keys

Only callable by the administrator or the operator addressThe 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 countThe operator or the admin cannot remove funded keysWhen removing validators, the indexes of specific unfunded keys can be changed in order to properlyremove the keys from the storage array. Beware of this specific behavior when chaining calls as thetargeted public key indexes can point to a different key after a first call was made and performedsome swaps

Parameters

Name	Type	Description
_index	uint256	The operator index
_indexes	uint256[]	The indexes of the keys to remove

setOperatorAddress

function setOperatorAddress(uint256 _index, address _newOperatorAddress) external nonpayable

Changes the operator address of an operator

Only callable by the administrator or the previous operator address

Parameters

Name	Type	Description
_index	uint256	The operator index
_newOperatorAddress	address	The new address of the operator

setOperatorLimits

function setOperatorLimits(uint256[] _operatorIndexes, uint256[] _newLimits, uint256 _snapshotBlock) external nonpayable

Changes 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

Name	Type	Description
_operatorIndexes	uint256[]	The operator indexes, in increasing order and duplicate free
_newLimits	uint256[]	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 nonpayable

Changes the operator name

Only callable by the administrator or the operator

Parameters

Name	Type	Description
_index	uint256	The operator index
_newName	string	The new operator name

setOperatorStatus

function setOperatorStatus(uint256 _index, bool _newStatus) external nonpayable

Changes the operator status

Only callable by the administrator

Parameters

Name	Type	Description
_index	uint256	The operator index
_newStatus	bool	The new status of the operator

setOperatorStoppedValidatorCount

function setOperatorStoppedValidatorCount(uint256 _index, uint256 _newStoppedValidatorCount) external nonpayable

Changes the operator stopped validator count

Only callable by the administrator

Parameters

Name	Type	Description
_index	uint256	The operator index
_newStoppedValidatorCount	uint256	The new stopped validator count 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

Name	Type	Description
index indexed	uint256	undefined
name	string	undefined
operatorAddress indexed	address	undefined

AddedValidatorKeys

event AddedValidatorKeys(uint256 indexed index, bytes publicKeysAndSignatures)

The operator or the admin added new validator keys and signatures

Parameters

Name	Type	Description
index indexed	uint256	undefined
publicKeysAndSignatures	bytes	undefined

Initialize

event Initialize(uint256 version, bytes cdata)

Emitted when the contract is properly initialized

Parameters

Name	Type	Description
version	uint256	undefined
cdata	bytes	undefined

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

Parameters

Name	Type	Description
index indexed	uint256	undefined
currentLimit	uint256	undefined
newLimit	uint256	undefined
latestKeysEditBlockNumber indexed	uint256	undefined
snapshotBlock indexed	uint256	undefined

OperatorLimitUnchanged

event OperatorLimitUnchanged(uint256 indexed index, uint256 limit)

The call didn't alter the limit of the operator

Parameters

Name	Type	Description
index indexed	uint256	undefined
limit	uint256	undefined

RemovedValidatorKey

event RemovedValidatorKey(uint256 indexed index, bytes publicKey)

The operator or the admin removed a public key and its signature from the registry

Parameters

Name	Type	Description
index indexed	uint256	undefined
publicKey	bytes	undefined

SetAdmin

event SetAdmin(address indexed admin)

The admin address changed

Parameters

Name	Type	Description
admin indexed	address	undefined

SetOperatorAddress

event SetOperatorAddress(uint256 indexed index, address indexed newOperatorAddress)

The operator address has been changed

Parameters

Name	Type	Description
index indexed	uint256	undefined
newOperatorAddress indexed	address	undefined

SetOperatorLimit

event SetOperatorLimit(uint256 indexed index, uint256 newLimit)

The operator limit has been changed

Parameters

Name	Type	Description
index indexed	uint256	undefined
newLimit	uint256	undefined

SetOperatorName

event SetOperatorName(uint256 indexed index, string newName)

The operator display name has been changed

Parameters

Name	Type	Description
index indexed	uint256	undefined
newName	string	undefined

SetOperatorStatus

event SetOperatorStatus(uint256 indexed index, bool active)

The operator status has been changed

Parameters

Name	Type	Description
index indexed	uint256	undefined
active	bool	undefined

SetOperatorStoppedValidatorCount

event SetOperatorStoppedValidatorCount(uint256 indexed index, uint256 newStoppedValidatorCount)

The operator stopped validator count has been changed

Parameters

Name	Type	Description
index indexed	uint256	undefined
newStoppedValidatorCount	uint256	undefined

SetPendingAdmin

event SetPendingAdmin(address indexed pendingAdmin)

The pending admin address changed

Parameters

Name	Type	Description
pendingAdmin indexed	address	undefined

SetRiver

event SetRiver(address indexed river)

The stored River address has been changed

Parameters

Name	Type	Description
river indexed	address	undefined

Errors

InactiveOperator

error InactiveOperator(uint256 index)

The calling operator is inactive

Parameters

Name	Type	Description
index	uint256	The operator index

InvalidArgument

error InvalidArgument()

The argument was invalid

InvalidArrayLengths

error InvalidArrayLengths()

The provided operator and limits array have different lengths

InvalidEmptyArray

error InvalidEmptyArray()

The provided operator and limits array are empty

InvalidEmptyStoppedValidatorCountsArray

Thrown when an invalid empty stopped validator array is provided

error InvalidEmptyStoppedValidatorCountsArray();

InvalidEmptyString

error InvalidEmptyString()

The string is empty

InvalidFundedKeyDeletionAttempt

error InvalidFundedKeyDeletionAttempt()

A funded key deletion has been attempted

InvalidIndexOutOfBounds

error InvalidIndexOutOfBounds()

The index that is removed is out of bounds

InvalidInitialization

error InvalidInitialization(uint256 version, uint256 expectedVersion)

An error occured during the initialization

Parameters

Name	Type	Description
version	uint256	The version that was attempting to be initialized
expectedVersion	uint256	The version that was expected

InvalidKeyCount

error InvalidKeyCount()

The provided key count is 0

InvalidKeysLength

error InvalidKeysLength()

The provided concatenated keys do not have the expected length

InvalidStoppedValidatorCountsSum

Thrown when the sum of stopped validators is invalid

error InvalidStoppedValidatorCountsSum();

InvalidUnsortedIndexes

error InvalidUnsortedIndexes()

The index provided are not sorted properly (descending order)

InvalidZeroAddress

error InvalidZeroAddress()

The address is zero

NoExitRequestsToPerform

Thrown when no exit requests can be performed

error NoExitRequestsToPerform();

OperatorLimitTooHigh

error OperatorLimitTooHigh(uint256 index, uint256 limit, uint256 keyCount)

The value for the operator limit is too high

Parameters

Name	Type	Description
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

Name	Type	Description
index	uint256	The operator index
limit	uint256	The new limit provided
fundedKeyCount	uint256	The operator funded key count

OperatorNotFound

error OperatorNotFound(uint256 index)

The operator was not found

Parameters

Name	Type	Description
index	uint256	The provided index

SliceOutOfBounds

error SliceOutOfBounds()

The slice is outside of the initial bytes bounds

SliceOverflow

error SliceOverflow()

The length overflows an uint

StoppedValidatorCountArrayShrinking

The provided stopped validator count array is shrinking

error StoppedValidatorCountArrayShrinking();

StoppedValidatorCountAboveFundedCount

The provided stopped validator count of an operator is above its funded validator count

error StoppedValidatorCountAboveFundedCount(uint256 operatorIndex, uint32 stoppedCount, uint32 fundedCount);

StoppedValidatorCountsDecreased

Throw when an element in the stopped validator array is decreasing

error StoppedValidatorCountsDecreased();

StoppedValidatorCountsTooHigh

Thrown when the number of elements in the array is too high compared to operator count

error StoppedValidatorCountsTooHigh();

Unauthorized

error Unauthorized(address caller)

The operator is unauthorized for the caller

Parameters

Name	Type	Description
caller	address	Address performing the call

UnorderedOperatorList

error UnorderedOperatorList()

The provided list of operators is not in increasing order