API Reference for the Rotate Signers Service (1.0)
Download OpenAPI specification:Download
The Rotating Signers service can be configured to have different target signers count, rotation size, and rotation interval. It also allows for the rotation algorithm to be configurable, although currently the only supported algorithm is "oldest-first", meaning the signers that have been active the longest will be voted out in the next rotation. We welcome feedback on the need for other algorithms.
The Rotating Signers service can be activated, to start the timer on the rotator, and deactivated, to stop the rotations.
Client applications can query for the current set of signers that are active, and future set of signers that are expected to be rotated in.
Configure the Rotating Signers service for various runtime parameters
Authorizations:
path Parameters
| service_id required | string |
Request Body schema: application/json
| targetSignerCount | integer [ 4 .. 20 ] Default: 4 The number of signers that should be active in each rotation |
| rotationInterval | integer >= 5 Default: 5 The length of period, in minutes, between signer rotations |
| rotationSize | integer Default: 1 The number of signers from the active set that should be rotated out and the equal amount should be voted in |
| rotationAlgorithm | string Value: "oldest-first" The algorithm used to decide which signers to vote out and which signers to vote in during each rotation |
Responses
Request samples
- Payload
{- "targetSignerCount": 4,
- "rotationInterval": 5,
- "rotationSize": 1,
- "rotationAlgorithm": "oldest-first"
}Response samples
- 200
{- "targetSignerCount": 4,
- "rotationInterval": 5,
- "rotationSize": 1,
- "rotationAlgorithm": "oldest-first"
}