update docs

ssvlabs · Jun 6, 2024 · 632e156 · 632e156
1 parent d078a87
commit 632e156
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,6 +8,7 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 ### [v1.2.0] 2024-05-21
 - [Feature] Support for mulitple whitelist addresses for operators (see [docs/operators.md](docs/operators.md)).
 - [Feature] Support for external whitelisting contracts (see [docs/operators.md](docs/operators.md)).
+- [Feature] Set the privacy status when registering an operator (see [docs/operators.md](docs/operators.md)).
 
 ## [Released]
 

diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
@@ -22,6 +22,9 @@
 - `function isWhitelistingContract(address contractAddress) external view returns (bool)`
 - `function isAddressWhitelistedInWhitelistingContract(address addressToCheck, uint256 operatorId, address whitelistingContract) external view returns (bool sWhitelisted)`
 
+#### Modified
+- `function registerOperator(bytes calldata publicKey, uint256 fee, bool setPrivate) external returns (uint64 id)`
+
 ### Errors
 
 #### New

diff --git a/docs/operators.md b/docs/operators.md
@@ -7,6 +7,7 @@ The function `SSVNetwork.registerOperator()` is used to register a validator.
 Input parameters:
 `publicKey`: The public key of the operator
 `fee`: Should be `0` or greater than `100000000` and less than the value returned by `SSVNetworkViews.getMaximumOperatorFee()`
+`setPrivate`: Flag to set the privacy status of the operator. Public means anyone can use the operator for registering validators. Private means only the operator's whitelisted addresses can.
 
 After the operator is registered, the caller becomes the `owner`, the `fee` is set and the `whitelisted` status is set to `false`.
 The `whitelisted` flag of the operator indicates if the operator is private (when set to `true`) or public (`false`),