RPC doc updates for last reward/state SN variables (#1244)

This commit is contained in:
Jason Rhinelander 2020-09-02 01:50:26 -03:00 committed by GitHub
parent b0f8ffa859
commit 6a9776c4f2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -2074,11 +2074,11 @@ namespace rpc {
uint64_t registration_height; // The height at which the registration for the Service Node arrived on the blockchain.
uint16_t registration_hf_version; // The hard fork at which the registration for the Service Node arrived on the blockchain.
uint64_t requested_unlock_height; // The height at which contributions will be released and the Service Node expires. 0 if not requested yet.
uint64_t last_reward_block_height; // The last height at which this Service Node received a reward.
uint32_t last_reward_transaction_index; // When multiple Service Nodes register on the same height, the order the transaction arrive dictate the order you receive rewards.
uint64_t last_reward_block_height; // The height that determines when this service node will next receive a reward. This field is updated when receiving a reward, but is also updated when a SN is activated, recommissioned, or has an IP change position reset.
uint32_t last_reward_transaction_index; // When multiple Service Nodes register (or become active/reactivated) at the same height (i.e. have the same last_reward_block_height), this field contains the activating transaction position in the block which is used to break ties in determining which SN is next in the reward list.
bool active; // True if fully funded and not currently decommissioned (and so `active && !funded` implicitly defines decommissioned)
bool funded; // True if the required stakes have been submitted to activate this Service Node
uint64_t state_height; // If active: the state at which registration was completed; if decommissioned: the decommissioning height; if awaiting: the last contribution (or registration) height
uint64_t state_height; // If active: the state at which the service node became active (i.e. fully staked height, or last recommissioning); if decommissioned: the decommissioning height; if awaiting: the last contribution (or registration) height
uint32_t decommission_count; // The number of times the Service Node has been decommissioned since registration
int64_t earned_downtime_blocks; // The number of blocks earned towards decommissioning, or the number of blocks remaining until deregistration if currently decommissioned
std::array<uint16_t, 3> service_node_version; // The major, minor, patch version of the Service Node respectively.