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

README updates for Partial ETH rewards #36

Merged
merged 4 commits into from
May 16, 2024
Merged

Conversation

marcin-cb
Copy link
Contributor

@marcin-cb marcin-cb commented May 16, 2024

Description Of Change

  • Update the Rewards example in the README to showcase Partial ETH rewards.
  • Update the TS example file
  • Updated eslint package

Testing Procedure

Locally

Copy link
Contributor

Choose a reason for hiding this comment

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

Do you think it'd be valuable to keep both examples? One for a validator, one for a partial ETH staker?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Are you saying creating a separate file with validator rewards in the example but leave the README only for partial ETH staker?

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes, exactly.

I was thinking it might be useful since they're slightly different. For validators, the user enters a public key. For partial ETH, users enter an address. I could go either way on if keeping both examples is helpful though. I trust your judgement 😄.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Okay I added it to the same example file. The only difference between the two examples is the address and filter. The rest of the logic is the same, didn't feel the need to have a separate file for that.

Copy link
Contributor

@ProfMoo ProfMoo left a comment

Choose a reason for hiding this comment

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

LGTM!

@marcin-cb marcin-cb requested a review from ProfMoo May 16, 2024 18:45
Copy link
Contributor

@ProfMoo ProfMoo left a comment

Choose a reason for hiding this comment

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

LGTM!

@marcin-cb marcin-cb merged commit a941e53 into main May 16, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants