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

Stacking page API work #2112

Open
BLuEScioN opened this issue Oct 7, 2024 · 1 comment
Open

Stacking page API work #2112

BLuEScioN opened this issue Oct 7, 2024 · 1 comment
Assignees

Comments

@BLuEScioN
Copy link
Collaborator

BLuEScioN commented Oct 7, 2024

The explorer needs the API team to add certain stacking related data to existing API endpoints and new endpoints in order to make the new stacking page designs possible

Stacking page design: https://www.figma.com/design/gsgfw9WmMbETBEC4FbY2H9/Stacks-Explorer-%5BRedesign%5D?node-id=18-992&node-type=canvas&t=zJcwzoSDx8txT3UW-0

This notion doc describes this work in detail: https://www.notion.so/hiropbc/Stacking-Page-API-Requirements-a90981dbeef6465ba23b96a9297d6128

@zone117x
Copy link
Member

zone117x commented Oct 8, 2024

So far I think we're looking at the following tasks:

  • Add pool addr to /extended/v2/pox/cycles/<cycle>/signers/<signer_key>/stackers response for stacker_type: pooled entries.
  • Create new endpoint /extended/v2/pox/cycle/<cycle>/pools which lists previously seen delegated_to: <principal> pools (queried from the stacking events table).
  • Add BTC rewards to the new endpoint /extended/v2/pox/cycle/<cycle>/pools (should be queryable from the /new_burn_block event data).
  • Add total STX stacked and total BTC paid to the /extended/v2/pox/cycles/{cycle_number} endpoint (btc amounts also queried from the /new_burn_block event data).
  • Modify stacks-core /new_block event to include something like a pox_cycle: { cycle_id: number; burn_block_start: number; burn_block_end: number; } property. Or modify the stack-core /new_burn_block event to include pox cycle ID. Unless we can already determine this from existing data, I don't think we can currently calculate BTC rewards for a pox cycle.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 🆕 New
Development

No branches or pull requests

2 participants