[Miscellaneous] klay_getTotalSupply
Returns the native token token supply by tracking block rewards and various burning mechanisms. If some components are not available then a partial result is returned.
JSONRPC: klay_getTotalSupply
Request
- application/json
Body
Array [
- IntegerBlockNumber
- HexadecimalBlockNumber
- BlockTag
]
params
undefined[]
BlockNumberOrTag
object
oneOf
the block number with type integer
number
the block number with type hexadecimal
string
the block tag [latest, pending, earliest]
string
If specified and equals true, the API will return a best-effort partial information even if block states or TreasuryRebalance memos are missing. Otherwise, the API will fail when some information is unavailable.
Responses
- 200
Returns the native token token supply by tracking block rewards and various burning mechanisms. If some components are not available then a partial result is returned.
- application/json
- Schema
- Example (from schema)
Schema
error
object
A Number that indicates the error type that occurred. This MUST be an integer.
code | message | description |
---|---|---|
-32700 | Parse error | invalid JSON was received by the server. An error occurred on the server while parsing the JSON text. |
-32602 | Invalid params | Invalid method parameter(s). |
A String providing a short description of the error. The message SHOULD be limited to a concise single sentence.
A Primitive or Structured value that contains additional information about the error. This may be omitted. The value of this member is defined by the Server (e.g. detailed error information, nested errors etc.).
result
object
The last block number the token supply is accumulated to.
Accumulated block rewards minted up to number plus the genesis total supply.
Accumulated transaction fees burnt.
The balance of the address 0x0, which is a canonical burn address. It is null if the state at the requested block is not available.
The balance of the address 0xdead, which is another canonical burn address. It is null if the state at the requested block is not available.
The amounts burnt by KIP-103 TreasuryRebalance, if executed. It is null if KIP-103 is configured and the hardfork block passed but memo field is not set in the contract. It is 0 if KIP-103 is not configured or the hardfork block is larger than the requested block.
The amounts burnt by KIP-160 TreasuryRebalanceV2, if executed. It is null if KIP-160 is configured and the hardfork block passed but memo field is not set in the contract. It is 0 if KIP-160 is not configured or the hardfork block is larger than the requested block.
Sum of the burns from above reasons. It is null if some components cannot be determined.
The calculated total supply of the native token at the given block. Difference between totalMinted and totalBurnt. It is null if some components cannot be determined.
{
"burntFee": "0x29ec817ffd11a9cd3a4b3",
"deadBurn": "0x40c166a428511ad626d306",
"kip103Burn": "0x111d0449fb2a238eca3b1720",
"kip160Burn": "0x0",
"number": "0x93295ce",
"totalBurnt": "0x11606478b75245c43d358ed9",
"totalMinted": "0x249a79581de10f4cd3000000",
"totalSupply": "0x133a14df668ec98895ca7127",
"zeroBurn": "0x0"
}