Operator Methods

public registerOperator (operatorName, publicKey, operatorFee)

Description: registers a new operator (key) with a set fee, fails if fee is less than the minimal fee.

Parameter

Type

Description

operatorName

string

The operator’s display name.

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)

public removeOperator (operatorId)

Description: changes operator status to inactive, which will result in ceasing operation of all its managed validators. Please note that this process is irreversible.

Parameter

Type

Description

operatorId

uint32

The operator id

public getOperatorById (operatorId)

Description: returns operator’s data.

Parameter

Type

Description

operatorId

uint32

The operator id

Return values

Parameter

Type

Description

name

string

The operator’s display name

ownerAddress

address

The operator’s admin address (for management purposes).

publicKey

bytes

The operator public key

validators

uint256

The amount of managed validators

fee

uint256

The fee charged by the operator (denominated as $SSV tokens per block)

score

uint256

The operator score

active

boolean

Operator network status

public declareOperatorFee (operatorId, operatorFee)

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 his fee with executeOperatorFee(). If he decides changing fee is no longer necessary, he can cancel fee update request with cancelDeclaredOperatorFee().

Parameter

Type

Description

operatorId

uint32

The operator id

operatorFee

uint256 (casted to uint64)

New fee (denominated as $SSV tokens per block).

public executeOperatorFee ()

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

uint32

The operator id

public cancelDeclaredOperatorFee (operatorId)

Description: Cancels operator’s fee change requested in previously called declareOperatorFee().

Parameter

Type

Description

operatorId

uint32

The operator id

public getOperatorDeclaredFee (operatorId)

Description: returns the declared fee (not actual fee) together with the execution time window.

Parameter

Type

Description

operatorId

uint32

The operator id

Return values

Parameter

Type

Description

declaredFee

uint256

The declared fee to be charged by the operator (denominated as $SSV tokens per block)

executionBeginTime

uint256

The timestamp of when the operator can execute the declared fee

executionExpirationTime

uint256

The timestamp of when the declared fee is expired

public getOperatorFee (operatorId)

Description: returns actual operator’s fee (not declared).

Parameter

Type

Description

operatorId

uint32

The operator id

Return values

Parameter

Type

Description

declaredFee

uint256

The fee charged by the operator (denominated as $SSV tokens per block)

Last updated