solana/docs/src/api/websocket/_slotSubscribe.mdx

73 lines
1.0 KiB
Plaintext

import {
DocBlock,
DocSideBySide,
CodeParams,
Parameter,
Field,
Values,
CodeSnippets,
} from "../../../components/CodeDocBlock";
<DocBlock>
## slotSubscribe
Subscribe to receive notification anytime a slot is processed by the validator
<DocSideBySide>
<CodeParams>
### Parameters:
**None**
### Result:
`<integer>` - Subscription id \(needed to unsubscribe\)
</CodeParams>
<CodeSnippets>
### Code sample:
```json
{ "jsonrpc": "2.0", "id": 1, "method": "slotSubscribe" }
```
### Response:
```json
{ "jsonrpc": "2.0", "result": 0, "id": 1 }
```
</CodeSnippets>
</DocSideBySide>
#### Notification Format:
The notification will be an object with the following fields:
- `parent: <u64>` - The parent slot
- `root: <u64>` - The current root slot
- `slot: <u64>` - The newly set slot value
Example:
```json
{
"jsonrpc": "2.0",
"method": "slotNotification",
"params": {
"result": {
"parent": 75,
"root": 44,
"slot": 76
},
"subscription": 0
}
}
```
</DocBlock>