.png%3Falt%3Dmedia%26token%3Dbac8f114-f7a7-4e88-8396-75aa9cbef3e2){kind=spacer}
.png%3Falt%3Dmedia%26token%3Dbac8f114-f7a7-4e88-8396-75aa9cbef3e2){kind=spacer}
governance
APIs related to the Klaytn Governance.
For the governance of the network, Klaytn provides the following APIs under
governance namespace.In Klaytn, there are three different governance modes.
none: All nodes participating in the network have the right to change the configuration.single: Only one designated node has the right to change the configuration.ballot: All nodes which have voting power can vote for a change. When more than half of total voting power gathered, the vote passes.
Based on the governance mode, a proposer is able to cast a vote about network parameters such as unit price, minimum staking amount, etc. In order to be a proposer, the candidate nodes are required to deposit a minimum amount of KLAY. All the qualified nodes are always eligible to propose a block, but the chance is propositional to the stake amount.
When calculating the staking proportions to determine the number of slots(the number of chances) to become a proposer within a certain period, it is possible that a node may not be allocated any slots as a result of rounding numbers. However, a slot is guaranteed to a qualified node that has deposited a minimum amount of KLAY.
That is, if a node is not qualified - the node does not stake enough amount of KLAY - it won't be given a chance to propose nor validate a block.
Caveat
- A governing node is always qualified in
singlemode as an exception. - A vote will be casted when a block is proposed. This vote is applied after two epochs including the epoch where the block is proposed. As an exception, only addValidator/removeValidator is applied immediately.
The
vote method submits a new vote. If the node has the right to vote based on governance mode, the vote can be placed. If not, an error message will be returned and the vote will be ignored.Parameters
Key: Name of the configuration setting to be changed. Key has the form ofdomain.fieldValue: Various types of value for each key.
Key | Description |
|---|---|
"governance.governancemode" | STRING. One of the three governance modes. "none", "single", "ballot" |
"governance.governingnode" | ADDRESS. Designated governing node's address. It only works if the governance mode is "single" e.g.,"0xe733cb4d279da696f30d470f8c04decb54fcb0d2" |
"governance.unitprice" | NUMBER. Price of unit gas. e.g., 25000000000 |
"governance.addvalidator" | ADDRESS. Address of a new validator candidate. e.g., 0xe733cb4d279da696f30d470f8c04decb54fcb0d2 |
"governance.removevalidator" | ADDRESS. Address of a current validator which need to be removed. e.g., 0xe733cb4d279da696f30d470f8c04decb54fcb0d2 |
"governance.deriveshaimpl" | NUMBER. Policy to generate the transaction hash and receipt hash in a block header. See here for available options. e.g., 2 (DeriveShaConcat) |
"governance.govparamcontract" | ADDRESS. Address of the GovParam contract. e.g., 0xe733cb4d279da696f30d470f8c04decb54fcb0d2 |
"istanbul.epoch" | NUMBER. A period in which votes are gathered in blocks. When an epoch end, all votes which haven't been passed will be cleared. e.g., 86400 |
"istanbul.committeesize" | NUMBER. The number of validators in a committee.(sub in chain configuration) e.g., 7 |
"reward.mintingamount" | STRING. Amount of Peb minted when a block is generated. Double quotation marks are needed for a value. e.g., "9600000000000000000" |
"reward.ratio" | STRING. Distribution rate for a CN/KGF/KIR separated by "/". The sum of all values has to be 100. e.g., "50/40/10" meaning CN 50%, KGF 40%, KIR 10% |
"reward.kip82ratio" | STRING. Distribution ratio of the block proposer to stakers separated by "/". The sum of all values has to be "100". See KIP-82 for further details. e.g., "20/80" means that the proposer takes 20% while stakers take 80%. |
"reward.useginicoeff" | BOOL. Use the Gini coefficient or not. true, false |
"reward.deferredtxfee" | BOOL. The way of giving transaction fee to a proposer. If true, it means the tx fee will be summed up with block reward and distributed to the proposer, KIR and KGF. If not, all tx fee will be given to the proposer. true, false |
"reward.minimumstake" | STRING. Amount of Klay required to be a CN (Consensus Node). Double quotation marks are needed for a value. e.g., "5000000" |
"kip71.lowerboundbasefee" | |
"kip71.upperboundbasefee" | NUMBER. The highest possible base fee. e.g., 750000000000 |
"kip71.gastarget" | NUMBER. The block gas that base fee wants to achieve. The base fee increases when parent block contains more than gas target, and decreases when parent block contains less than gas target. e.g., 30000000 |
"kip71.basefeedenominator" | NUMBER. Controls how fast base fee changes. e.g., 20 |
"kip71.maxblockgasusedforbasefee" | NUMBER. The maximum block gas perceived in base fee calculation. e.g., 60000000 |
Return Value
Type | Description |
|---|---|
String | Result of vote submission |
Example
> governance.vote ("governance.governancemode", "ballot")
"Your vote was successfully placed."
​
> governance.vote ("governance.governingnode", "0x12345678990123456789901234567899012345678990")
"Your vote was successfully placed."
​
> governance.vote("istanbul.epoch", 604800)
"Your vote was successfully placed."
​
> governance.vote("governance.unitprice", 25000000000)
"Your vote was successfully placed."
​
> governance.vote("istanbul.committeesize", 7)
"Your vote was successfully placed."
​
> governance.vote("reward.mintingamount", "9600000000000000000")
"Your vote was successfully placed."
​
> governance.vote("reward.ratio", "40/30/30")
"Your vote was successfully placed."
​
> governance.vote("reward.useginicoeff", false)
"Your vote was successfully placed."
​
// If wrong data are given
> governance.vote("reward.ratio", 100)
"Your vote couldn't be placed. Please check your vote's key and value"
​
> governance.vote("governance.governingnode", 1234)
"Your vote couldn't be placed. Please check your vote's key and value"
​
// when `governancemode` is "single" and the node is not `governingnode`
> governance.vote("governance.governancemode", "ballot")
"You don't have the right to vote"
The
showTally property provides the current tally of governance votes. It shows the aggregated approval rate in percentage. When it goes over 50%, the vote passes.Parameters
None
Return Value
Type | Description |
|---|---|
Tally | Each vote's value and approval rate in percentage |
Example
> governance.showTally
[{
ApprovalPercentage: 36.2,
Key: "unitprice",
Value: 25000000000
}, {
ApprovalPercentage: 72.5,
Key: "mintingamount",
Value: "9600000000000000000"
}]
The
totalVotingPower property provides the sum of all voting power that CNs have. Each CN has 1.0 ~ 2.0 voting power. In "none", "single" governance mode, totalVotingPower don't provide any information.Parameters
None
Return Value
Type | Description |
|---|---|
Float | Total Voting Power or error message |
Example
// In "ballot" governance mode
> governance.totalVotingPower
32.452
​
// In "none", "single" governance mode
> governance.totalVotingPower
"In current governance mode, voting power is not available"
The
myVotingPower property provides the voting power of the node. The voting power can be 1.0 ~ 2.0. In "none", "single" governance mode, totalVotingPower don't provide any information.Parameters
None
Return Value
Type | Description |
|---|---|
Float | Node's Voting Power or error message |
Example
// In "ballot" governance mode
> governance.myVotingPower
1.323
​
// In "none", "single" governance mode
> governance.myVotingPower
"In current governance mode, voting power is not available"
The
myVotes property provides my vote information in the epoch. Each vote is stored in a block when the user's node generates a new block. After current epoch ends, this information is cleared.Parameters
None
Return Value
Type | Description |
|---|---|
Vote List | Node's Voting status in the epoch
- BlockNum: The block number that this vote is stored
- Casted: If this vote is stored in a block or not
- Key/Value: The content of the vote |
Example
> governance.vote("governance.governancemode", "ballot")
"Your vote was successfully placed."
​
> governance.myVotes
[{
BlockNum: 403,
Casted: true,
Key: "governance.governancemode",
Value: "ballot"
}]
​
The
getChainConfig returns the chain configuration at a specific block. If the parameter is not set, it returns the chain configuration at the latest block.Parameters
Type | Description |
|---|---|
QUANTITY | TAG | Integer or hexadecimal block number, or the string "earliest", "latest" or "pending" as in the default block parameter. |
NOTE: The block number can be larger than the latest block number, in which case the API returns the tentative value based on the current chain state. The future governance parameters are subject to change via additional governance votes or GovParam contract state changes.
Return Value
Type | Description |
|---|---|
JSON | Chain configuration at the given block number |
Example
> governance.getChainConfig()
{
chainId: 1001,
deriveShaImpl: 0,
ethTxTypeCompatibleBlock: 86513895,
governance: {
govParamContract: "0x84214cec245d752a9f2faf355b59ddf7f58a6edb",
governanceMode: "single",
governingNode: "0x99fb17d324fa0e07f23b49d09028ac0919414db6",
kip71: {
basefeedenominator: 20,
gastarget: 30000000,
lowerboundbasefee: 25000000000,
maxblockgasusedforbasefee: 60000000,
upperboundbasefee: 750000000000
},
reward: {
deferredTxFee: true,
kip82ratio: "20/80",
minimumStake: 5000000,
mintingAmount: 6400000000000000000,
proposerUpdateInterval: 3600,
ratio: "50/40/10",
stakingUpdateInterval: 86400,
useGiniCoeff: true
}
},
istanbul: {
epoch: 604800,
policy: 2,
sub: 22
},
istanbulCompatibleBlock: 75373312,
koreCompatibleBlock: 111736800,
londonCompatibleBlock: 80295291,
magmaCompatibleBlock: 98347376,
unitPrice: 250000000000
}
The
chainConfig property provides the latest chain configuration. This is equivalent to chainConfigAt() with an empty parameter.governance_chainConfig API will be deprecated since Klaytn v1.11 (see klaytn#1783). Use governance_getChainConfig instead.NOTE: the RPC API will be deprecated since v1.11. However, the
governance.chainConfig property in the Klaytn JavaScript console is removed since Klaytn v1.10.2.NOTE: In versions earlier than Klaytn v1.10.0, this API returned the initial chain configuration. However, due to its confusing name, it is updated since Klaytn v1.10.0. To query the initial chain configuration, use
chainConfigAt(0) instead.Parameters
None
Return Value
Type | Description |
|---|---|
JSON | Current chain configuration |
Example
> governance.chainConfig
{
chainId: 1001,
deriveShaImpl: 2,
governance: {
govParamContract: "0x0000000000000000000000000000000000000000",
governanceMode: "ballot",
governingNode: "0xe733cb4d279da696f30d470f8c04decb54fcb0d2",
kip71: {
basefeedenominator: 20,
gastarget: 30000000,
lowerboundbasefee: 25000000000,
maxblockgasusedforbasefee: 60000000,
upperboundbasefee: 750000000000
},
reward: {
deferredTxFee: true,
kip82ratio: "20/80",
minimumStake: 5000000,
mintingAmount: 6400000000000000000,
proposerUpdateInterval: 3600,
ratio: "50/40/10",
stakingUpdateInterval: 20,
useGiniCoeff: false
}
},
istanbul: {
epoch: 20,
policy: 2,
sub: 1
},
istanbulCompatibleBlock: 0,
koreCompatibleBlock: 0,
londonCompatibleBlock: 0,
magmaCompatibleBlock: 0,
unitPrice: 25000000000
}
The
chainConfigAt returns the chain configuration at a specific block. If the parameter is not set, it returns the chain configuration at the latest block.governance_chainConfigAt API will be deprecated since Klaytn v1.11 (see klaytn#1783). Use governance_getChainConfig instead.Parameters
Type | Description |
|---|---|
QUANTITY | TAG | Integer or hexadecimal block number, or the string "earliest", "latest" or "pending" as in the default block parameter. |
NOTE: The block number can be larger than the latest block number, in which case the API returns the tentative value based on the current chain state. The future governance parameters are subject to change via additional governance votes or GovParam contract state changes.
Return Value
Type | Description |
|---|---|
JSON | Chain configuration at the given block number |
Example
> governance.chainConfigAt()
{
chainId: 1001,
deriveShaImpl: 2,
governance: {
govParamContract: "0x0000000000000000000000000000000000000000",
governanceMode: "ballot",
governingNode: "0xe733cb4d279da696f30d470f8c04decb54fcb0d2",
kip71: {
basefeedenominator: 20,
gastarget: 30000000,
lowerboundbasefee: 25000000000,
maxblockgasusedforbasefee: 60000000,
upperboundbasefee: 750000000000
},
reward: {
deferredTxFee: true,
kip82ratio: "20/80",
minimumStake: 5000000,
mintingAmount: 6400000000000000000,
proposerUpdateInterval: 3600,
ratio: "50/40/10",
stakingUpdateInterval: 20,
useGiniCoeff: false
}
},
istanbul: {
epoch: 20,
policy: 2,
sub: 1
},
istanbulCompatibleBlock: 0,
koreCompatibleBlock: 0,
londonCompatibleBlock: 0,
magmaCompatibleBlock: 0,
unitPrice: 25000000000
}
The
nodeAddress property provides the address of the node that a user is using. It is derived from the nodekey and used to sign consensus messages. And the value of "governingnode" has to be one of validator's node address.Parameters
None
Return Value
Type | Description |
|---|---|
ADDRESS | 20 BYTE address of a node |
Example
> governance.nodeAddress
"0xe733cb4d279da696f30d470f8c04decb54fcb0d2"
The
getParams returns governance parameters at a specific block.Parameters
Type | Description |
|---|---|
QUANTITY | TAG | Integer or hexadecimal block number, or the string "earliest", "latest" or "pending" as in the default block parameter. |
NOTE: The block number can be larger than the latest block number, in which case the API returns the tentative value based on the current chain state. The future governance parameters are subject to change via additional governance votes or GovParam contract state changes.
Return Value
Type | Description |
|---|---|
JSON | governance parameters |
Example
> governance.getParams(89)
{
governance.deriveshaimpl: 2,
governance.governancemode: "single",
governance.governingnode: "0x99fb17d324fa0e07f23b49d09028ac0919414db6",
governance.govparamcontract: "0x0000000000000000000000000000000000000000",
governance.unitprice: 25000000000,
istanbul.committeesize: 22,
istanbul.epoch: 604800,
istanbul.policy: 2,
kip71.basefeedenominator: 20,
kip71.gastarget: 30000000,
kip71.lowerboundbasefee: 25000000000,
kip71.maxblockgasusedforbasefee: 60000000,
kip71.upperboundbasefee: 750000000000,
reward.deferredtxfee: true,
reward.kip82ratio: "20/80",
reward.minimumstake: "5000000",
reward.mintingamount: "9600000000000000000",
reward.proposerupdateinterval: 3600,
reward.ratio: "34/54/12",
reward.stakingupdateinterval: 86400,
reward.useginicoeff: true
}
The
itemsAt returns governance parameters at a specific block.governance_itemsAt API will be deprecated since Klaytn v1.11 (see klaytn#1783). Use governance_getParams instead.Parameters
Type | Description |
|---|---|
QUANTITY | TAG | Integer or hexadecimal block number, or the string "earliest", "latest" or "pending" as in the default block parameter. |
NOTE: In versions earlier than Klaytn v1.7.0, only integer block number, the string
"earliest" and "latest" are available.NOTE: The block number can be larger than the latest block number, in which case the API returns the tentative value based on the current chain state. The future governance parameters are subject to change via additional governance votes or GovParam contract state changes.
Return Value
Type | Description |
|---|---|
JSON | governance items |
Example
> governance.itemsAt(89)
{
governance.deriveshaimpl: 2,
governance.governancemode: "single",
governance.governingnode: "0x7bf29f69b3a120dae17bca6cf344cf23f2daf208",
governance.govparamcontract: "0x0000000000000000000000000000000000000000",
governance.unitprice: 25000000000,
istanbul.committeesize: 13,
istanbul.epoch: 30,
istanbul.policy: 2,
kip71.basefeedenominator: 20,
kip71.gastarget: 30000000,
kip71.lowerboundbasefee: 25000000000,
kip71.maxblockgasusedforbasefee: 60000000,
kip71.upperboundbasefee: 750000000000,
reward.deferredtxfee: true,
reward.kip82ratio: "20/80",
reward.minimumstake: "5000000",
reward.mintingamount: "9600000000000000000",
reward.proposerupdateinterval: 30,
reward.ratio: "34/54/12",
reward.stakingupdateinterval: 60,
reward.useginicoeff: true
}
The
pendingChanges returns the list of items that have received enough number of votes but not yet finalized. At the end of the current epoch, these changes will be finalized and the result will be in effect from the epoch after next epoch.Parameters
None
Return Value
Type | Description |
|---|---|
Vote List | Currently pending changes composed of keys and values |
Example
> governance.pendingChanges
{
reward.minimumstake: "5000000",
reward.useginicoeff: false
}
The
votes returns the votes from all nodes in the epoch. These votes are gathered from the header of each block.Parameters
None
Return Value
Type | Description |
|---|---|
Vote List | Current votes composed of keys, values and node addresses |
Example
> governance.votes
[{
key: "reward.minimumstake",
validator: "0xe733cb4d279da696f30d470f8c04decb54fcb0d2",
value: "5000000"
}, {
key: "reward.useginicoeff",
validator: "0xa5bccb4d279419abe2d470f8c04dec0789ac2d54",
value: false
}]
The
idxCache property returns an array of current idxCache in the memory cache. idxCache contains the block numbers where governance change happened. The cache can have up to 1000 block numbers in memory by default.Parameters
None
Return Value
Type | Description |
|---|---|
uint64 array | Block numbers where governance change happened |
Example
> governance.idxCache
[0, 30]
The
idxCacheFromDb returns an array that contains all block numbers on which a governance change ever happened. The result of idxCacheFromDb is the same or longer than that of idxCacheParameters
None
Return Value
Type | Description |
|---|---|
uint64 array | Every block numbers where governance change happened |
Example
> governance.idxCacheFromDb
[0, 30]
The
itemCacheFromDb returns the governance information stored in the given block. If no changes were stored in the given block, the function returns null.Parameters
Type | Description |
|---|---|
uint64 | A block number to query the governance change made in the block. |
Return Value
Type | Description |
|---|---|
JSON | Stored governance information at a given block |
Example
> governance.itemCacheFromDb(0)
{
governance.governancemode: "single",
governance.governingnode: "0xe733cb4d279da696f30d470f8c04decb54fcb0d2",
governance.unitprice: 25000000000,
istanbul.committeesize: 1,
istanbul.epoch: 30,
istanbul.policy: 2,
reward.deferredtxfee: true,
reward.minimumstake: "5000000",
reward.mintingamount: "6400000000000000000",
reward.proposerupdateinterval: 3600,
reward.ratio: "50/40/10",
reward.stakingupdateinterval: 20,
reward.useginicoeff: false
}
The
getStakingInfo returns staking information at a specific block. The result includes the following information.BlockNum: The block number at which the staking information is given.CouncilNodeAddrs: The addresses of the consensus node.CouncilRewardAddrs: The addresses to which the block reward of the associated nodes is sent.CouncilStakingAddrs: The contract addresses in which the associated nodes deploy for staking.CouncilStakingAmounts: The amount of KLAY which the associated nodes stake.Gini: Gini coefficient.KIRAddr: The contract address of KIR.PoCAddr: The contract address of KGF. PoC is the previous name of KGF.UseGini: The boolean value whether or not the Gini coefficient is used.
Note that the order of all addresses and the staking amounts are matched.
Parameters
Type | Description |
|---|---|
QUANTITY | TAG | Integer of a block number, or the string "earliest", "latest" or "pending", as in the default block parameter. |
Return Value
Type | Description |
|---|---|
JSON | Staking information |
Example
> governance.getStakingInfo("latest")
{
BlockNum: 57801600,
CouncilNodeAddrs: ["0x99fb17d324fa0e07f23b49d09028ac0919414db6", "0x571e53df607be97431a5bbefca1dffe5aef56f4d", "0xb74ff9dea397fe9e231df545eb53fe2adf776cb2", "0x5cb1a7dccbd0dc446e3640898ede8820368554c8", "0x776817c0ef3d06d794cf01ae9afa33d7397b9b40", "0xc180ca565b34b5b63877674f5fe647e7da079022", "0x03497f51c31fe8b402df0bde90fd5a85f87aa943"],
CouncilRewardAddrs: ["0xb2bd3178affccd9f9f5189457f1cad7d17a01c9d", "0x6559a7b6248b342bc11fbcdf9343212bbc347edc", "0x82829a60c6eac4e3e9d6ed00891c69e88537fd4d", "0xa86fd667c6a340c53cc5d796ba84dbe1f29cb2f7", "0x6e22cbe2b8bbd1df9f1d3c8ebae6d7ff5414a734", "0x24e593fb29731e54905025c230727dc28d229f77", "0x2b2a7a1d29a203f60e0a964fc64231265a49cd97"],
CouncilStakingAddrs: ["0x12fa1ab4c3e17c1c08c1b5a945c864c8e8bf707e", "0xfd56604f1a20268ff7a0eab2ab48e25ee1e0f653", "0x1e0f6aaa9baa6081dc4910a854eebf8854c262ab", "0x5e6988415ebe0f6b088f5a676003ba60f572875a", "0xbb44998c2af35b8faee694cffe216558056d747e", "0x68cba498b7175cde9de08fc2e85ad3e9c8caefa8", "0x98efb31eeccafe35d53a6926e2a54c0858d9eebc"],
CouncilStakingAmounts: [5000000, 5000000, 5000000, 5000000, 5000000, 5000000, 5000000],
Gini: 0,
KIRAddr: "0x716f89d9bc333286c79db4ebb05516897c8d208a",
PoCAddr: "0x2bcf9d3e4a846015e7e3152a614c684de16f37c6",
UseGini: true
}
Last modified 1mo ago