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

Docs Syncing (maxApy,rewards structure,etc) #324

Merged
merged 7 commits into from
Jan 21, 2025
Merged

Conversation

surbhit14
Copy link
Collaborator

@surbhit14 surbhit14 commented Jan 9, 2025

This PR covers the following changes to the documentation

  • Changes apy to maxApy
  • Update the response structure for rewards
  • Add withRewards query parameter for /stakers/address endpoint

@surbhit14 surbhit14 marked this pull request as draft January 10, 2025 07:04
@surbhit14 surbhit14 changed the title Change apy to maxApy in docs (Docs Syncing) Docs Syncing (maxApy,rewards structure,etc) Jan 10, 2025
apy: z.string().describe('The latest APY recorded for the operator').openapi({ example: '1.0' }),
maxApy: z
.string()
.describe('The max APY for the AVS Operator across all the strategies')
Copy link
Collaborator

Choose a reason for hiding this comment

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

The max APY when each unique strategy APY is summed across all AVS Operators

@surbhit14 surbhit14 marked this pull request as ready for review January 14, 2025 03:45
@uditdc uditdc merged commit 333d30b into dev Jan 21, 2025
1 check passed
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.

3 participants