88 lines
1.8 KiB
Plaintext
88 lines
1.8 KiB
Plaintext
import {
|
|
DocBlock,
|
|
DocSideBySide,
|
|
CodeParams,
|
|
Parameter,
|
|
Field,
|
|
Values,
|
|
CodeSnippets,
|
|
} from "../../../components/CodeDocBlock";
|
|
|
|
<DocBlock>
|
|
|
|
## getSupply
|
|
|
|
Returns information about the current supply.
|
|
|
|
<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="excludeNonCirculatingAccountsList" type="bool" optional={true}>
|
|
exclude non circulating accounts list from response
|
|
</Field>
|
|
|
|
</Parameter>
|
|
|
|
### Result:
|
|
|
|
The result will be an RpcResponse JSON object with `value` equal to a JSON object containing:
|
|
|
|
- `total: <u64>` - Total supply in lamports
|
|
- `circulating: <u64>` - Circulating supply in lamports
|
|
- `nonCirculating: <u64>` - Non-circulating supply in lamports
|
|
- `nonCirculatingAccounts: <array>` - an array of account addresses of non-circulating accounts, as strings. If `excludeNonCirculatingAccountsList` is enabled, the returned array will be empty.
|
|
|
|
</CodeParams>
|
|
|
|
<CodeSnippets>
|
|
|
|
### Code sample:
|
|
|
|
```bash
|
|
curl http://localhost:8899 -X POST -H "Content-Type: application/json" -d '
|
|
{"jsonrpc":"2.0", "id":1, "method":"getSupply"}
|
|
'
|
|
```
|
|
|
|
### Response:
|
|
|
|
```json
|
|
{
|
|
"jsonrpc": "2.0",
|
|
"result": {
|
|
"context": {
|
|
"slot": 1114
|
|
},
|
|
"value": {
|
|
"circulating": 16000,
|
|
"nonCirculating": 1000000,
|
|
"nonCirculatingAccounts": [
|
|
"FEy8pTbP5fEoqMV1GdTz83byuA8EKByqYat1PKDgVAq5",
|
|
"9huDUZfxoJ7wGMTffUE7vh1xePqef7gyrLJu9NApncqA",
|
|
"3mi1GmwEE3zo2jmfDuzvjSX9ovRXsDUKHvsntpkhuLJ9",
|
|
"BYxEJTDerkaRWBem3XgnVcdhppktBXa2HbkHPKj2Ui4Z"
|
|
],
|
|
"total": 1016000
|
|
}
|
|
},
|
|
"id": 1
|
|
}
|
|
```
|
|
|
|
</CodeSnippets>
|
|
</DocSideBySide>
|
|
</DocBlock>
|