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.

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

added reward cycle example image to shelley spec #2282

Merged
merged 1 commit into from
May 20, 2021

Conversation

JaredCorduan
Copy link
Contributor

I've added this image:

reward-cycle

with an accompanying explanation to the Shelley formal spec. Feedback is welcome!

@JaredCorduan JaredCorduan changed the title add snapshot delegation cycle image to spec added reward cycle example image to shelley spec May 13, 2021
@JaredCorduan JaredCorduan force-pushed the jc/example-illustration-reward-cycle branch from a88ddb1 to d8f62f2 Compare May 13, 2021 02:19
@polinavino
Copy link
Contributor

Impressive LaTeX drawings!

I think the looping light green arrow is a bit confusing, I would maybe draw it to the end of e2, with a caption on the arrow something like "parameters not yet in effect (Alice's opportunity to redelegate)"

@polinavino
Copy link
Contributor

Also, the green square on blue arrow (and light green on light blue) isn't easy to figure out without reading the text, as it seems like a specific e4 block is used in the stake calculation, rather than all the data about block production gathered in e3.

Maybe use a triangle or a circle, to distinguish, instead?

@JaredCorduan
Copy link
Contributor Author

Impressive LaTeX drawings!

I think the looping light green arrow is a bit confusing, I would maybe draw it to the end of e2, with a caption on the arrow something like "parameters not yet in effect (Alice's opportunity to redelegate)"

Thanks!

The source of truth for the current (un-snapshotted) pool parameters, the poolParams map in PState, is updated with the cached change on the epoch boundary (right after the snapshot is taken), which is what that loopy arrow is trying to show.

@JaredCorduan
Copy link
Contributor Author

Also, the green square on blue arrow (and light green on light blue) isn't easy to figure out without reading the text, as it seems like a specific e4 block is used in the stake calculation, rather than all the data about block production gathered in e3.

Maybe use a triangle or a circle, to distinguish, instead?

yea, I agree, it's not clear. Maybe a darker green Bob? 🤔

@JaredCorduan
Copy link
Contributor Author

I removed the potentially confusing green squares on the snapshots, and replaced it with "4 blocks" on the darker blue line.

@JaredCorduan JaredCorduan force-pushed the jc/example-illustration-reward-cycle branch from d8f62f2 to 68812fd Compare May 18, 2021 13:05
Copy link
Contributor

@polinavino polinavino left a comment

Choose a reason for hiding this comment

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

👍✔️

@JaredCorduan JaredCorduan force-pushed the jc/example-illustration-reward-cycle branch from 68812fd to b443d8c Compare May 20, 2021 18:14
@JaredCorduan JaredCorduan merged commit 2d85607 into master May 20, 2021
@iohk-bors iohk-bors bot deleted the jc/example-illustration-reward-cycle branch May 20, 2021 18:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants