Update notification format info to be consistent (#18354) (#18356)

(cherry picked from commit cc80197349)

Co-authored-by: Tyera Eulberg <teulberg@gmail.com>
This commit is contained in:
mergify[bot]
2021-07-01 06:14:03 +00:00
committed by GitHub
parent 4466aa39c4
commit 820abacf49

View File

@ -3897,6 +3897,20 @@ Result:
#### Notification Format:
The notification will be an object with the following fields:
- `parent: <u64>` - The parent slot
- `slot: <u64>` - The newly updated slot
- `timestamp: <i64>` - The Unix timestamp of the update
- `type: <string>` - The update type, one of:
- "firstShredReceived"
- "completed"
- "createdBank"
- "frozen"
- "dead"
- "optimisticConfirmation"
- "root"
```bash
{
"jsonrpc": "2.0",
@ -3913,15 +3927,6 @@ Result:
}
```
Types:
- "firstShredReceived"
- "completed"
- "createdBank"
- "frozen"
- "dead"
- "optimisticConfirmation"
- "root"
### slotsUpdatesUnsubscribe
Unsubscribe from slot-update notifications
@ -4045,7 +4050,10 @@ Result:
#### Notification Format:
The result is the latest vote, containing its hash, a list of voted slots, and an optional timestamp.
The notification will be an object with the following fields:
- `hash: <string>` - The vote hash
- `slots: <array>` - The slots covered by the vote, as an array of u64 integers
- `timestamp: <i64 | null>` - The timestamp of the vote
```json
{