Comment on page
SSVNetwork
The SSVNetwork contract is the main contract for operations and management.
Description: Registers a new operator (key) with a set fee, fails if fee is less than the minimal fee.
Parameter | Type | Description |
publicKey | bytes | The operator public key (generated as part of the node setup). |
operatorFee | uint256
(casted to uint64) | The fee charged by the operator (denominated as $SSV tokens per block) |
Events:
OperatorAdded(uint64 indexed operatorId, address indexed owner, bytes publicKey, uint256 fee)
Description: Permanently removes the operator from the network (irreversible).
Parameter | Type | Description |
operatorId | uint64 | The operator id |
Events:
OperatorRemoved(uint64 indexed operatorId)
Description: Withdraws a specified amount of SSV tokens from provided operator balance to msg.sender, will fail if msg.sender is not the operator owner.
Parameter | Type | Description |
operatorId | uint64 | The operator id |
amount | uint256 (casted to uint64) | Amount to be withdrawn |
Events:
OperatorWithdrawn(address indexed owner, uint64 indexed operatorId, uint256 value)
Description: Withdraws all SSV tokens earnings from provided operator balance to msg.sender, will fail if msg.sender is not the operator owner.
Parameter | Type | Description |
operatorId | uint64 | The operator id |
Events:
OperatorWithdrawn(address indexed owner, uint64 indexed operatorId, uint256 value)
Description: Sets a whitelisted address that can select him as their operator (setting a whitelist address transitions the operator from public to permissioned).
Parameter | Type | Description |
operatorId | uint64 | The operator id |
whitelisted | address | The ETH1 address that is whitelisted.
Use 0x0000000000000000000000000000000000000000 to set operator back to public. |
Events:
OperatorWhitelistUpdated(uint64 indexed operatorId, address whitelisted)
Description: Initiates the first step of the operator fee update cycle - declaration of a new fee. After specified time window operator will be able to change to the new fee with executeOperatorFee().
Parameter | Type | Description |
operatorId | uint64 | The operator id |
operatorFee | uint256 (casted to uint64) | New fee (denominated as $SSV tokens per block). |
Events:
OperatorFeeDeclared(address indexed owner, uint64 indexed operatorId, uint256 blockNumber, uint256 fee)
Description: Activates operator’s fee change specified in previously called declareOperatorFee(). This function needs to be called within a certain time window following declareOperatorFee().
Parameter | Type | Description |
operatorId | uint64 | The operator id |
Events:
OperatorFeeExecuted(address indexed owner, uint64 indexed operatorId, uint256 blockNumber, uint256 fee)
Description: Cancels operator’s fee change requested in previously called declareOperatorFee().
Parameter | Type | Description |
operatorId | uint64 | The operator id |
Events:
OperatorFeeDeclarationCancelled(address indexed owner, uint64 indexed operatorId)
Description: Reduce the operator fee, does not abide by the restrictions of fee increase
Parameter | Type | Description |
operatorId | uint64 | The operator id |
fee | uint256 (casted to uint64) | New fee (denominated as $SSV tokens per block). |
Events:
OperatorFeeExecuted(address indexed owner, uint64 indexed operatorId, uint256 blockNumber, uint256 fee)
Description: sets a fee recipient address to receive tips from user transactions (part block proposal rewards). This address will be set for all the account’s validators (all clusters).
Parameter | Type | Description |
feeRecipientAddress | address | An ETH1 address that receives fee recipient rewards. |
Events:
FeeRecipientAddressUpdated(address indexed owner, address recipientAddress)
Description: Registers new validator to a cluster of provided operators (ids + shares), fails if number of operatorIds is greater than 13..
Parameter | Type | Description |
publicKey | bytes | The validator’s public key. |
operatorIds | unit64[] | List of cluster operators Ids. |
sharesData | bytes | |
amount | uint256 (casted to uint64) | Amount of SSV token to be deposited as payment (not mandatory) |
cluster | tuple[] | Object containing the latest cluster snapshot data - obtained using the SSV Scanner tool.
If this is the 1st validator within a specific cluster (unique set of operators), use - {0,0,0,true,0} |
Events:
ValidatorAdded(address indexed owner, uint64[] operatorIds, bytes publicKey, bytes shares, Cluster cluster)
Description: Removes validator from the SSV network.
Parameter | Type | Description |
publicKey | bytes | The validator’s public key. |
operatorIds | unit64[] | List of cluster operators Ids. |
cluster | tuple[] |
Events:
ValidatorRemoved(address indexed owner, uint64[] operatorIds, bytes publicKey, Cluster cluster)
Description: Deposits SSV token into a cluster, will fail if not enough tokens are approved.
Parameter | Type | Description |
owner | address | The cluster owner address |
operatorIds | unit64[] | List of cluster operators Ids. |
amount | uint256 (casted to uint64) | $SSV amount to be deposited |
cluster | tuple[] |
Events:
ClusterDeposited(address indexed owner, uint64[] operatorIds, uint256 value, Cluster cluster)
Description: Withdraws a specified amount of SSV tokens from cluster of msg.sender, will fail if msg.sender tries to withdraw more than the cluster’s liquidation collateral. To withdraw the entire cluster balance and stop its operation use liquidate().
Parameter | Type | Description |
operatorIds | unit64[] | List of cluster operators Ids. |
amount | uint256 (casted to uint64) | Amount to be withdrawn |
cluster | tuple[] |
Events:
ClusterWithdrawn(address indexed owner, uint64[] operatorIds, uint256 value, Cluster cluster)
Description: Reactivates a liquidated cluster, will fail if insufficient SSV tokens to cover the cluster’s liquidation collateral have been deposited.
Parameter | Type | Description |
operatorIds | unit64[] | List of cluster operators Ids. |
amount | uint256 (casted to uint64) | $SSV amount to be deposited |
cluster | tuple[] |
Events:
ClusterReactivated(address indexed owner, uint64[] operatorIds, Cluster cluster)
Write methods for liquidators
Description: Liquidates a cluster sends their balances to the msg.sender (the Liquidator), will fail if the cluster is not liquidatable (see isLiquidatable()).
Parameter | Type | Description |
owner | address | The cluster owner address |
operatorIds | unit64[] | List of cluster operators Ids. |
cluster | tuple[] |
Events:
ClusterLiquidated(address indexed owner, uint64[] operatorIds, Cluster cluster)
Description: Updates network fee.
Parameter | Type | Description |
networkFee | uint256 (casted to uint64) | The fee charged by the network per validator (denominated as $SSV tokens per block). |
Events:
NetworkFeeUpdated(uint256 oldFee, uint256 newFee)
Description: Withdraws accumulated network fees in SSV token to DAO treasury.
Parameter | Type | Description |
amount | uint256 (casted to uint64) | Amount to be withdrawn |
Events:
NetworkEarningsWithdrawn(uint256 value, address recipient)
Description: Sets the minimum period (in blocks) after which a cluster can be liquidated.
Parameter | Type | Description |
blocks | uint64 | Duration in blocks to have sufficient balance |
Events:
LiquidationThresholdPeriodUpdated(uint64 value)
Description: Sets the minimum collateral (in $SSV) each cluster must keep in his balance.
Parameter | Type | Description |
amount | uint256 (casted to uint64) | Amount of SSV collateral |
Events:
MinimumLiquidationCollateralUpdated(uint256 value)
Description: Sets the max amount by which operators can increase fees in each fee update cycle. This does not limit max operator fee, only the rate (%) by which it can be increased within each fee update cycle.
Parameter | Type | Description |
newOperatorMaxFeeIncrease | uint64 | Maximum increase percentage |
Events:
OperatorFeeIncreaseLimitUpdated(uint64 value)
Description: Sets the time window (in seconds) between the declaration and activation of a new operator fee.
Parameter | Type | Description |
updateDeclareOperatorFeePeriod | uint64 | Period in seconds until an operator can execute a fee after declaring it. |
Events:
DeclareOperatorFeePeriodUpdated(uint64 value)
Description: Sets the time window (in seconds) in which an operator can activate a new fee.
Parameter | Type | Description |
seconds | uint64 | Period in seconds that an operator can execute a fee until it expires. |
Events:
ExecuteOperatorFeePeriodUpdated(uint64 value)
Last modified 1mo ago