From cc80197349e1dc096e9a416391aa2e05fdc03958 Mon Sep 17 00:00:00 2001 From: Tyera Eulberg Date: Wed, 30 Jun 2021 23:49:30 -0600 Subject: [PATCH] Update notification format info to be consistent (#18354) --- docs/src/developing/clients/jsonrpc-api.md | 28 ++++++++++++++-------- 1 file changed, 18 insertions(+), 10 deletions(-) diff --git a/docs/src/developing/clients/jsonrpc-api.md b/docs/src/developing/clients/jsonrpc-api.md index a1ecab5bea..e68942459c 100644 --- a/docs/src/developing/clients/jsonrpc-api.md +++ b/docs/src/developing/clients/jsonrpc-api.md @@ -3919,6 +3919,20 @@ Result: #### Notification Format: +The notification will be an object with the following fields: + +- `parent: ` - The parent slot +- `slot: ` - The newly updated slot +- `timestamp: ` - The Unix timestamp of the update +- `type: ` - 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: ` - The vote hash +- `slots: ` - The slots covered by the vote, as an array of u64 integers +- `timestamp: ` - The timestamp of the vote ```json {