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

feat: add a staking endpoint to return a stake summary per account #2535

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: add a staking endpoint to return a stake summary per account #2535

wants to merge 1 commit into from

Conversation

cprussin
Copy link
Collaborator

Summary

Adds an endpoint to the staking app to return a stake summary per account.

Rationale

This is required to calculate Fogo flames

How has this been tested?

  • Current tests cover my changes
  • Added new tests
  • Manually tested the code

@cprussin cprussin requested a review from a team as a code owner March 31, 2025 21:44
@vercel Vercel
Copy link

vercel bot commented Mar 31, 2025 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
api-reference ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 1, 2025 5:52am
component-library ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 1, 2025 5:52am
entropy-debugger ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 1, 2025 5:52am
insights ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 1, 2025 5:52am
proposals ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 1, 2025 5:52am
staking ❌ Failed (Inspect) Apr 1, 2025 5:52am

@cprussin cprussin requested a review from keyvankhademi March 31, 2025 21:44
@cprussin cprussin force-pushed the cprussin/add-staking-endpoint-to-return-positions-by-wallet branch from 22de8e2 to 64177c2 Compare March 31, 2025 21:52
keyvankhademi
keyvankhademi reviewed Mar 31, 2025
View reviewed changes
governance/pyth_staking_sdk/src/pyth-staking-client.ts
Comment on lines +1127 to +1129
// Safe because `min(1)` guarantees that `data` is nonempty
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
Buffer.from(data[0]!, "base64"),
Copy link
Contributor

@keyvankhademi keyvankhademi Mar 31, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

nit: can we use an if to avoid having !?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

In this case we actually want ! because the min(1) line from Zod already guarantees the length, but can't encode that in the type. I generally prefer letting Zod verify this kind of thing since it will generate nice consistent error messages, but it requires the ! to avoid having a second null check at runtime. In this case since it's so many accounts, it's not huge but it is actually a relevant optimization.

I usually wrap this kind of thing into a nonEmptyArray Zod helper which returns [T, ...T[]] instead of T[] which typescript can then guarantee is nonempty...

@cprussin cprussin force-pushed the cprussin/add-staking-endpoint-to-return-positions-by-wallet branch from 64177c2 to cfd9a57 Compare March 31, 2025 21:54
@cprussin cprussin force-pushed the cprussin/add-staking-endpoint-to-return-positions-by-wallet branch from cfd9a57 to 2724816 Compare March 31, 2025 22:02
@cprussin cprussin force-pushed the cprussin/add-staking-endpoint-to-return-positions-by-wallet branch from 2724816 to 9bbc2ed Compare April 1, 2025 05:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@keyvankhademi keyvankhademi keyvankhademi approved these changes

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

Successfully merging this pull request may close these issues.
2 participants
@cprussin @keyvankhademi