82 lines
1.5 KiB
Plaintext
82 lines
1.5 KiB
Plaintext
import {
|
|
DocBlock,
|
|
DocSideBySide,
|
|
CodeParams,
|
|
Parameter,
|
|
Field,
|
|
Values,
|
|
CodeSnippets,
|
|
} from "../../../components/CodeDocBlock";
|
|
|
|
<DocBlock>
|
|
|
|
## getEpochInfo
|
|
|
|
Returns information about the current epoch
|
|
|
|
<DocSideBySide>
|
|
|
|
<CodeParams>
|
|
|
|
### Parameters:
|
|
|
|
<Parameter type={"object"} optional={true}>
|
|
|
|
Configuration object containing the following fields:
|
|
|
|
<Field
|
|
name="commitment"
|
|
type="string"
|
|
optional={true}
|
|
href="/api/http#configuring-state-commitment"
|
|
></Field>
|
|
|
|
<Field name="minContextSlot" type="number" optional={true}>
|
|
The minimum slot that the request can be evaluated at
|
|
</Field>
|
|
|
|
</Parameter>
|
|
|
|
### Result:
|
|
|
|
The result field will be an object with the following fields:
|
|
|
|
- `absoluteSlot: <u64>` - the current slot
|
|
- `blockHeight: <u64>` - the current block height
|
|
- `epoch: <u64>` - the current epoch
|
|
- `slotIndex: <u64>` - the current slot relative to the start of the current epoch
|
|
- `slotsInEpoch: <u64>` - the number of slots in this epoch
|
|
- `transactionCount: <u64|null>` - total number of transactions processed without error since genesis
|
|
|
|
</CodeParams>
|
|
<CodeSnippets>
|
|
|
|
### Code sample:
|
|
|
|
```bash
|
|
curl http://localhost:8899 -X POST -H "Content-Type: application/json" -d '
|
|
{"jsonrpc":"2.0","id":1, "method":"getEpochInfo"}
|
|
'
|
|
```
|
|
|
|
### Response:
|
|
|
|
```json
|
|
{
|
|
"jsonrpc": "2.0",
|
|
"result": {
|
|
"absoluteSlot": 166598,
|
|
"blockHeight": 166500,
|
|
"epoch": 27,
|
|
"slotIndex": 2790,
|
|
"slotsInEpoch": 8192,
|
|
"transactionCount": 22661093
|
|
},
|
|
"id": 1
|
|
}
|
|
```
|
|
|
|
</CodeSnippets>
|
|
</DocSideBySide>
|
|
</DocBlock>
|