Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update API documentation for saturation and relative stake #2155

Closed
2 tasks
Anviking opened this issue Sep 21, 2020 · 1 comment
Closed
2 tasks

Update API documentation for saturation and relative stake #2155

Anviking opened this issue Sep 21, 2020 · 1 comment
Assignees
@Anviking

Comments

@Anviking
Copy link
Member

Anviking commented Sep 21, 2020 •
edited
Loading

Context

#1980, ADP-431

With cardano-node 1.20.0, the relative_stake field is now relative to the total stake, not the active stake. This makes the saturation calculation correct (tracked by #1980), but it also provides an opportunity to clarify concepts in the API docs.

1.20.0 also made changes to from which snapshot the relative_stake is reported. I believe

- 1.19.0 node + wallet 1.20.0 node + wallet
saturation in ranking active (taken at end of e-2) live
wallet api saturation field non-sensical correct (and live)
relative_stake snapshot active (taken at end of e-2) live
relative_stake relative to "active" (delegated) stake total stake

Relevant upstream PRs:

Decision

Review and revise the API documentation.

Acceptance Criteria

  • API documentation for relative_stake, saturation, and non_myopic_member_rewards must be correct
  • API documentation for relative_stake, saturation and non_myopic_member_rewards should be helpful

Development

#2162

QA

Docs updated in #2162 . Some context on the individual changes is provided in that PR.
@Anviking Anviking self-assigned this Sep 21, 2020
@Anviking Anviking mentioned this issue Sep 22, 2020
Merged
1 task
iohk-bors bot added a commit that referenced this issue Sep 22, 2020
@iohk-bors @Anviking
Merge #2162
226c1c8 
2162: Update API docs on saturation, rewards, and relative stake r=Anviking a=Anviking

# Issue Number

#2155 

# Overview

<!-- Detail in a few bullet points the work accomplished in this PR -->

- [x] Tweaked API docs


# Comments

- Not sure if we should rush this to be in the release or not

<!-- Additional comments or screenshots to attach if any -->

<!-- 
Don't forget to:

 ✓ Self-review your changes to make sure nothing unexpected slipped through
 ✓ Assign yourself to the PR
 ✓ Assign one or several reviewer(s)
 ✓ Once created, link this PR to its corresponding ticket
 ✓ Assign the PR to a corresponding milestone
 ✓ Acknowledge any changes required to the Wiki
-->


Co-authored-by: Johannes Lund <[email protected]>
@Anviking Anviking mentioned this issue Sep 23, 2020
Closed
@piotr-iohk
Copy link
Contributor

lgtm

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Anviking Anviking

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@Anviking @piotr-iohk