Update notification format info to be consistent (#18354)

This commit is contained in:
Tyera Eulberg 2021-06-30 23:49:30 -06:00 committed by GitHub
parent 8e7d393b70
commit cc80197349
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 18 additions and 10 deletions

View File

@ -3919,6 +3919,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",
@ -3935,15 +3949,6 @@ Result:
}
```
Types:
- "firstShredReceived"
- "completed"
- "createdBank"
- "frozen"
- "dead"
- "optimisticConfirmation"
- "root"
### slotsUpdatesUnsubscribe
Unsubscribe from slot-update notifications
@ -4067,7 +4072,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
{