DPoS API
和DxChain3.0系统合约相关的console API 、JSON-RPC API。
JSON-RPC
示例:
curl -H 'content-type:application/json' -d '{"jsonrpc":"2.0","method":"dpos_getBaseInfos","params":[],"id":1}' RPC_URL指定区块高度查询时,需要确保
RPC-URL开启了归档(archive)节点模式。
dpos_getBaseInfos
dpos.base() in console.
获取系统合约相关的全部基本参数。
参数 Parameters
blockNum:可选参数
null |'latest' | 'earliest' | 'pending' | 'hex number'
params: [
null |'latest' | 'earliest' | 'pending' | 'hex number'
]返回值 Returns
系统合约相关的全部基本参数。
示例 Example
curl -H 'content-type:application/json' -d '{"jsonrpc":"2.0","method":"dpos_getBaseInfos","params":["latest"],"id":1}' RPC_URL
// dpos.base("latest")
// result
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"BLACK_HOLE_ADDRESS": "0x0000000000000000000000000000000000000000",
"BLOCK_SECONDS": 3,
"EPOCH_BLOCKS": 28800,
"MAX_LEVEL_VALIDATOR_COUNT": 120,
"MAX_PUNISH_COUNT": 278,
"MAX_RATE": 100,
"MAX_VALIDATORS_COUNT": 210,
"MAX_VALIDATOR_COUNT_LV1": 21,
"MAX_VALIDATOR_COUNT_LV2": 33,
"MAX_VALIDATOR_COUNT_LV3": 66,
"MAX_VALIDATOR_COUNT_LV4": 99,
"MAX_VALIDATOR_DETAIL_LENGTH": 1000,
"MEDIUM_LEVEL_VALIDATOR_COUNT": 90,
"MIN_DEPOSIT": 40000000000000000000000000,
"MIN_LEVEL_VALIDATOR_COUNT": 60,
"MIN_RATE": 70,
"PROPOSAL_DURATION_EPOCHS": 7,
"RATE_SET_LOCK_EPOCHS": 1,
"REWARD_DEPOSIT_FROM_LV1_TO_LV2": 128250000000000000000,
"REWARD_DEPOSIT_FROM_LV2_TO_LV3": 157125000000000000000,
"REWARD_DEPOSIT_FROM_LV3_TO_LV4": 180750000000000000000,
"REWARD_DEPOSIT_FROM_LV4_TO_LV5": 199875000000000000000,
"REWARD_DEPOSIT_OVER_LV5": 214125000000000000000,
"REWARD_DEPOSIT_UNDER_LV1": 95250000000000000000,
"SAFE_MULTIPLIER": 1000000000000000000,
"TOTAL_DEPOSIT_LV1": 15000000000000000000000000000,
"TOTAL_DEPOSIT_LV2": 20000000000000000000000000000,
"TOTAL_DEPOSIT_LV3": 25000000000000000000000000000,
"TOTAL_DEPOSIT_LV4": 30000000000000000000000000000,
"TOTAL_DEPOSIT_LV5": 35000000000000000000000000000,
"VALIDATOR_REWARD_LOCK_EPOCHS": 7,
"VALIDATOR_UNSTAKE_LOCK_EPOCHS": 1,
"VOTE_CANCEL_EPOCHS": 1
}
}dpos_getAllProposalSets
dpos.allProposalIds()in console.
获取所有的节点申请记录的(bytes4)id。
参数
blockNum:可选参数
null |'latest' | 'earliest' | 'pending' | 'hex number'
返回值
包含所有的节点申请记录的(bytes4)id的列表。
示例
dpos_getAddressProposalSets
dpos.addressProposalIds(address)in console.
获取某个地址的节点申请记录的(bytes4)id。
参数
address:查询地址
blockNum:可选参数
null |'latest' | 'earliest' | 'pending' | 'hex number'
返回值
包含某个地址的节点申请记录的(bytes4)id的列表。
示例
dpos_getProposal
dpos.proposal(id)in console.
获取某个节点申请记录的详细信息。
参数
id:节点申请记录id
blockNum:可选参数
null |'latest' | 'earliest' | 'pending' | 'hex number'
返回值
Id:节点申请id
Proposer:节点申请发起地址
Deposit:质押数量
Rate:分配比例
Details:节点描述
Name:节点名称
InitBlock:申请时的区块高度
Guarantee:同意人地址
UpdateBlock:记录更新块高
PType:类型
0为申请节点
Status:状态(ps:该字段并不完全代表申请的状态,需要和'申请有效期'结合)
0:申请中 pending
1:通过 success
2:已取消 cancel
示例
dpos_getAllProposals
dpos.allProposals()in console.
获取所有节点的申请记录的详细信息列表。
参数
blockNum:可选参数
null |'latest' | 'earliest' | 'pending' | 'hex number'
返回值
包含所有节点的申请记录的详细信息列表。
示例
dpos_getAddressProposals
dpos.addressProposals(address)in console.
获取该地址的所有申请记录详细信息列表。
参数
address:查询地址
blockNum:可选参数
null |'latest' | 'earliest' | 'pending' | 'hex number'
返回值
包含该地址的所有申请记录详细信息列表。
示例
dpos_getValidator
dpos.validator(validator)in console.
获取节点的详细信息。
参数
validator:查询地址
blockNum:可选参数
null |'latest' | 'earliest' | 'pending' | 'hex number'
返回值
Deposit:自身质押
Details:节点描述
Name:节点名称
Rate:节点分配比例(%)
RateSettLockingEndBlock:下一次可修改rate的区块高度
UnstakeLockingEndBlock:赎回节点质押的区块高度
Votes:用户投票数
Status:节点状态
0:默认状态:已取消、非节点
1:取消中且未赎回质押
2:取消节点队列中
3:节点被踢除
4:有效节点
示例
dpos_getCurrentEpochValidators
dpos.currentEpochValidators()in console.
获取最新周期的出块节点地址列表。
参数
blockNum:可选参数
null |'latest' | 'earliest' | 'pending' | 'hex number'
返回值
最新周期的出块节点地址列表。
示例
dpos_isEffictiveValidator
dpos.isEffictiveValidator(address)in console.
判断地址是否有效的验证节点。
参数
address:地址
blockNum:可选参数
null |'latest' | 'earliest' | 'pending' | 'hex number'
返回值
bool:地址是否有效的验证节点。
示例
dpos_effictiveValsLength
dpos.effictiveValsLength()in console.
获取当前有效节点个数。
参数
blockNum:可选参数
null |'latest' | 'earliest' | 'pending' | 'hex number'
返回值
当前有效节点个数。
示例
dpos_getEffictiveValidators
dpos.effictiveValidators()in console.
获取当前有效节点地址列表。
参数
blockNum:可选参数
null |'latest' | 'earliest' | 'pending' | 'hex number'
返回值
当前有效节点地址列表。
示例
dpos_cancelQueueValidatorsLength
dpos.cancelQueueValsLength()in console.
获取该周期内取消节点队列长度。
参数
blockNum:可选参数
null |'latest' | 'earliest' | 'pending' | 'hex number'
返回值
该周期内取消节点队列长度。
示例
dpos_getCancelQueueValidators
dpos.cancelQueueValidators()in console.
获取该周期内的取消节点队列。
参数
blockNum:可选参数
null |'latest' | 'earliest' | 'pending' | 'hex number'
返回值
该周期内的取消节点队列。
示例
dpos_validatorVotersLength
dpos.validatorVotersLength(validator)in console.
获取验证节点的投票人个数。
参数
validator:验证节点地址
blockNum:可选参数
null |'latest' | 'earliest' | 'pending' | 'hex number'
返回值
验证节点的投票人个数。
示例
dpos_getValidatorVoters
dpos.validatorVoters(validator)in console.
获取验证节点的投票人地址列表。
参数
validator:验证节点地址
blockNum:可选参数
null |'latest' | 'earliest' | 'pending' | 'hex number'
返回值
验证节点的投票人地址列表。
示例
dpos_pendingValidatorReward
dpos.pendingValidatorReward(validator)in console.
获取节点的奖励信息。
参数
validator:验证节点地址
blockNum:可选参数
null |'latest' | 'earliest' | 'pending' | 'hex number'
返回值
avaliable:可领取奖励
frozen:锁定奖励
示例
dpos_validatorRewardsInfo
dpos.validatorRewardsInfo(validator)in console.
获取节点的奖励、赎回信息、奖励锁定周期信息。
参数
validator:验证节点地址
blockNum:可选参数
null |'latest' | 'earliest' | 'pending' | 'hex number'
返回值
Epochs:存在锁定奖励的周期
DelegatorsRewards:周期对应的分配给投票人的奖励
Rates:周期对应的奖励分配比例
ValidatorRewards:周期对应的节点出块奖励
FrozenReward:锁定总奖励
PendingReward:可领取的奖励
RewardPerVote:该节点的每一票可领取的投票奖励
示例
dpos_validatorRewardInfoByEpoch
dpos.validatorRewardInfoByEpoch(validator, epoch)in console.
获取节点该周期的奖励分配信息:出块奖励、分配给投票人的奖励、分配比例
参数
validator:验证节点地址
epoch:周期
blockNum:可选参数
null |'latest' | 'earliest' | 'pending' | 'hex number'
返回值
DelegatorsReward:本周期节点分配给投票人的奖励
Rate:本周期节点的奖励分配比例
ValidatorReward:本周期节点自身的出块奖励
示例
dpos_pendingVoteReward
dpos.pendingVoteReward(validator, voter)in console.
获取投票人对某个验证节点的投票奖励。
参数
validator:验证节点地址
voter:投票人地址
blockNum:可选参数
null |'latest' | 'earliest' | 'pending' | 'hex number'
返回值
投票人对某个验证节点的投票奖励。
示例
dpos_votesRewardRedeemInfo
dpos.votesRewardRedeemInfo(validator, voter)in console.
获取投票人对某个节点的投票、奖励、赎回信息。
参数
validator:验证节点地址
voter:投票人地址
blockNum:可选参数
null |'latest' | 'earliest' | 'pending' | 'hex number'
返回值
Amount:投票数量
LockRedeemEpochs:可赎回投票的周期
LockRedeemVotes:可赎回投票周期对应的投票数量
PendingRedeem:当前即可赎回的投票数量
PendingReward:可领取的奖励
ValidatorTotalVotes:节点当前的总得票数
Validator:节点地址
ValidatorName:节点名称
ValidatorRate:节点当前分配比例
示例
dpos_votesRewardRedeemInfos
dpos.votesRewardRedeemInfos(voter)in console.
获取投票人对所有它投票的节点的投票、奖励、赎回信息。
参数
voter:投票人地址
blockNum:可选参数
null |'latest' | 'earliest' | 'pending' | 'hex number'
返回值
投票人对所有它投票的节点的投票、奖励、赎回信息。
示例
dpos_getTotalDeposit
dpos.totalDeposit()in console.
获取所有有效节点的总质押量。
参数
blockNum:可选参数
null |'latest' | 'earliest' | 'pending' | 'hex number'
返回值
所有有效节点的总质押量。
示例
dpos_getTotalVotes
dpos.totalVotes()in console.
获取所有投票人的总投票数量。
参数
blockNum:可选参数
null |'latest' | 'earliest' | 'pending' | 'hex number'
返回值
所有投票人的总投票数量。
示例
dpos_epochInfo
dpos.epochInfo(epoch)in console.
获取本周期的区块奖励、出块节点个数、总锁定量Tvl、周期开始时的超级节点数量。
参数
epoch:周期
blockNum:可选参数
null |'latest' | 'earliest' | 'pending' | 'hex number'
返回值
BlockReward:本周期的出块奖励
ValidatorCount:本周期的出块节点个数
effictiveValCount:周期开始时的有效验证节点数量
Tvl:总锁定量=节点质押+用户投票
示例
dpos_kickoutInfo
dpos.kickoutInfo(epoch)in console.
获取该周期被踢除的节点地址列表。
参数
epoch:周期
blockNum:可选参数
null |'latest' | 'earliest' | 'pending' | 'hex number'
返回值
该周期被踢除的节点地址列表。
示例
dpos_punishInfo
dpos.punishInfo(validator,epoch)in console.
获取该周期某个节点被惩罚的详细信息。
参数
validator:节点地址
epoch:周期
blockNum:可选参数
null |'latest' | 'earliest' | 'pending' | 'hex number'
返回值
Count:惩罚次数
PunishBlocks:惩罚记录的块高
BurnRewards:每次kickout销毁的奖励
KickoutBlocks:kickout记录的块高
示例
Last updated
Was this helpful?