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

docs: Update staking rewards graph #774

Merged
merged 1 commit into from
Apr 3, 2024
Merged

docs: Update staking rewards graph #774

merged 1 commit into from
Apr 3, 2024

Conversation

amela
Copy link
Member

@amela amela commented Mar 27, 2024 •
edited
Loading

@amela amela force-pushed the amela/update-staking-rewards-graph branch from 332b9f4 to ca13682 Compare March 27, 2024 10:21
@netlify Netlify
Copy link

netlify bot commented Mar 27, 2024 •
edited
Loading

✅ Deploy Preview for oasisprotocol-docs ready!

Name Link
🔨 Latest commit 603d3dd
🔍 Latest deploy log https://app.netlify.com/sites/oasisprotocol-docs/deploys/660bca44dda8ea0008445139
😎 Deploy Preview https://deploy-preview-774--oasisprotocol-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@amela amela force-pushed the amela/update-staking-rewards-graph branch 3 times, most recently from a54ca4f to efd3c8f Compare March 27, 2024 10:46
@amela amela requested review from matevz and kostko March 27, 2024 10:50
@amela amela marked this pull request as ready for review March 27, 2024 10:50
matevz
matevz requested changes Mar 27, 2024
View reviewed changes
Copy link
Member

@matevz matevz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add a record to the Changelog section at the end of this page. Something like:

- Mar 28, 2024:
  - Updated Staking Rewards Schedule based on the [Staking parameters change proposal](https://www.oasisscan.com/proposals/4) passed Mar 26 2024.

kostko
kostko reviewed Mar 27, 2024
View reviewed changes
Copy link
Member

@kostko kostko left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also update the change log section to specify that the reward schedule has been adjusted after governance proposal 4 passed which changed the schedule.

@amela amela force-pushed the amela/update-staking-rewards-graph branch 3 times, most recently from 13e1964 to 0b161dc Compare March 27, 2024 13:08
@amela amela requested review from kostko and matevz March 27, 2024 13:13
lukaw3d
lukaw3d reviewed Mar 27, 2024
View reviewed changes
src/staking_rewards/data.csv Outdated
36858,2024-11-22T19:18:00.888Z,0.000003,0.0269
36882,2024-11-23T18:42:36.598Z,0.000002,0.0180
36930,2024-11-25T17:31:48.019Z,0.000001,0.0090
81662,2030-01-01T00:00Z,0.000283,2.5741
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

data.json says until epoch 90000, not 81662

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thought it would look nicer if the graph ended in 2030 rather than on a random date. Do the JSON and csv need to match?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That doesn't make sense. CSV doesn't affect the graph

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Either way, don't manipulate the data, especially the data that users download and analyze and make own graphs out of. IF we want to display less data then we should change that in the display component 🤷

and that can be a separate pullrequest if tadej insists on not letting users to zoom where they want to

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, this makes sense. I changed the CSV to include epoch 90000. We can create a new pr for the display component if needed. I also think it is nicer to show all the data and then can users to zoom in if they want.

tjanez
tjanez reviewed Mar 27, 2024
View reviewed changes
Copy link
Member

@tjanez tjanez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The new graph looks too wide because it is effectively computed until year 2031.
Can we start by narrowing it to 2020 -> 2028?

@amela amela force-pushed the amela/update-staking-rewards-graph branch 2 times, most recently from 1405820 to 518f2bb Compare March 29, 2024 08:17
@amela
Copy link
Member Author

amela commented Mar 29, 2024

@tjanez @lukaw3d, if we narrow it down to 2020 -> 2028, the data in the CSV will not match the JSON (90000). Is that okay? Until now, the JSON had the same data as the staking rewards schedule.

@amela amela requested review from lukaw3d and tjanez March 29, 2024 08:32
@amela amela force-pushed the amela/update-staking-rewards-graph branch from 518f2bb to 4fd8773 Compare April 2, 2024 08:53
@amela amela force-pushed the amela/update-staking-rewards-graph branch from 4fd8773 to 603d3dd Compare April 2, 2024 09:05
@amela amela requested a review from kostko April 3, 2024 09:37
kostko
kostko approved these changes Apr 3, 2024
View reviewed changes
Copy link
Member

@kostko kostko left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is good as it reflects the updated schedule. We can further adjust the chart in subsequent PRs.

@amela amela merged commit 7505384 into main Apr 3, 2024
6 checks passed
@amela amela deleted the amela/update-staking-rewards-graph branch April 3, 2024 09:58
@matevz matevz mentioned this pull request Apr 16, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kostko kostko kostko approved these changes

@matevz matevz matevz approved these changes

@lukaw3d lukaw3d Awaiting requested review from lukaw3d

@tjanez tjanez Awaiting requested review from tjanez

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@amela @matevz @kostko @tjanez @lukaw3d