89 lines
1.6 KiB
Plaintext
89 lines
1.6 KiB
Plaintext
import {
|
|
DocBlock,
|
|
DocSideBySide,
|
|
CodeParams,
|
|
Parameter,
|
|
Field,
|
|
Values,
|
|
CodeSnippets,
|
|
} from "../../../components/CodeDocBlock";
|
|
|
|
<DocBlock>
|
|
|
|
## getTokenSupply
|
|
|
|
Returns the total supply of an SPL Token type.
|
|
|
|
<DocSideBySide>
|
|
<CodeParams>
|
|
|
|
### Parameters:
|
|
|
|
<Parameter type={"string"} required={true}>
|
|
Pubkey of the token Mint to query, as base-58 encoded string
|
|
</Parameter>
|
|
|
|
<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>
|
|
|
|
</Parameter>
|
|
|
|
### Result:
|
|
|
|
The result will be an RpcResponse JSON object with `value` equal to a JSON object containing:
|
|
|
|
- `amount: <string>` - the raw total token supply without decimals, a string representation of u64
|
|
- `decimals: <u8>` - number of base 10 digits to the right of the decimal place
|
|
- `uiAmount: <number|null>` - the total token supply, using mint-prescribed decimals **DEPRECATED**
|
|
- `uiAmountString: <string>` - the total token supply as a string, using mint-prescribed decimals
|
|
|
|
</CodeParams>
|
|
|
|
<CodeSnippets>
|
|
|
|
### Code sample:
|
|
|
|
```bash
|
|
curl http://localhost:8899 -X POST -H "Content-Type: application/json" -d '
|
|
{
|
|
"jsonrpc": "2.0", "id": 1,
|
|
"method": "getTokenSupply",
|
|
"params": [
|
|
"3wyAj7Rt1TWVPZVteFJPLa26JmLvdb1CAKEFZm3NY75E"
|
|
]
|
|
}
|
|
'
|
|
```
|
|
|
|
### Response:
|
|
|
|
```json
|
|
{
|
|
"jsonrpc": "2.0",
|
|
"result": {
|
|
"context": {
|
|
"slot": 1114
|
|
},
|
|
"value": {
|
|
"amount": "100000",
|
|
"decimals": 2,
|
|
"uiAmount": 1000,
|
|
"uiAmountString": "1000"
|
|
}
|
|
},
|
|
"id": 1
|
|
}
|
|
```
|
|
|
|
</CodeSnippets>
|
|
</DocSideBySide>
|
|
</DocBlock>
|