Skip to content

Feat: implement /status route to expose aggregator information #2107

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
Merged
merged 12 commits into from
Nov 13, 2024
Merged

Feat: implement /status route to expose aggregator information #2107

merged 12 commits into from
Nov 13, 2024

Conversation

@dlachaume
Copy link
Collaborator

@dlachaume dlachaume commented Nov 12, 2024 •
edited
Loading

Content

This PR includes the creation of a /status route on the aggregator REST API that exposes essential information about the aggregator's status.

Pre-submit checklist

  • Branch
    • Tests are provided (if possible)
    • Crates versions are updated (if relevant)
    • CHANGELOG file is updated (if relevant)
    • Commit sequence broadly makes sense
    • Key commits have useful messages
  • PR
    • No clippy warnings in the CI
    • Self-reviewed the diff
    • Useful pull request description
    • Reviewer requested
  • Documentation
    • Update README file (if relevant)
    • Update documentation website (if relevant)
    • Add dev blog post (if relevant)

Issue(s)

Closes #2071

@dlachaume dlachaume self-assigned this Nov 12, 2024
@github-actions
Copy link

github-actions bot commented Nov 12, 2024 •
edited
Loading

Test Results

    4 files  ±0     51 suites  ±0   11m 49s ⏱️ +39s
1 449 tests +6  1 449 ✅ +6  0 💤 ±0  0 ❌ ±0 
1 660 runs  +6  1 660 ✅ +6  0 💤 ±0  0 ❌ ±0 

Results for commit 99b0c4d. ± Comparison against base commit 913172d.

♻️ This comment has been updated with latest results.

@dlachaume dlachaume temporarily deployed to testing-sanchonet November 12, 2024 16:10 — with GitHub Actions Inactive
@dlachaume dlachaume marked this pull request as ready for review November 12, 2024 16:15
jpraynaud
jpraynaud approved these changes Nov 12, 2024
View reviewed changes
sfauvel
sfauvel approved these changes Nov 12, 2024
View reviewed changes
Copy link
Collaborator

@sfauvel sfauvel left a comment

Choose a reason for hiding this comment

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

LGTM

@dlachaume dlachaume temporarily deployed to testing-sanchonet November 13, 2024 10:34 — with GitHub Actions Inactive
jpraynaud
jpraynaud approved these changes Nov 13, 2024
View reviewed changes
Copy link
Member

@jpraynaud jpraynaud left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@dlachaume
feat: implement /status route to return an `AggregatorStatusMessage…
ecf09de 
…` with the current epoch
@dlachaume
feat: add Cardano and Mithril eras to the /status route
b57b2d2
@dlachaume
feat: add Cardano node and Aggregator versions to the /status route…
5149f3f 
… response
@dlachaume
feat: add current and next Protocol parameters to the /status rout…
d76af04 
…e response
@dlachaume
feat: add total number of signers for current and next epoch to the …
eec0da6 
…`/status` route response
@dlachaume
feat: add total stakes of signers for current and next epoch to the …
bb7d3c5 
…`/status` route response
@dlachaume
refactor: move type aliases to common for use in other modules
132db44
@dlachaume
feat: add total Cardano stake and SPOs to the /status route response
c8c0ae1
@dlachaume
fix: renaming based on PR review
25a4aa8 
- rename `aggregator_status` to `status`
- update comments and descriptions
@dlachaume
refactor: compute total_stakes_signers and `total_next_stakes_signe…
573b462 
…rs` once per epoch instead of on each HTTP call to the `/status` route
@dlachaume dlachaume force-pushed the dlachaume/2071/create-status-route branch 3 times, most recently from 76341c2 to 924071f Compare November 13, 2024 15:31
@dlachaume
chore: add a reference to the feature in the CHANGELOG
8540256
@dlachaume
chore: upgrade crate versions and openapi.yaml version
99b0c4d 
* mithril-aggregator from `0.5.108` to `0.5.110`
* mithril-common from `0.4.84` to `0.4.86`
* openapi.yaml from `0.1.36` to `0.1.37`
@dlachaume dlachaume force-pushed the dlachaume/2071/create-status-route branch from 924071f to 99b0c4d Compare November 13, 2024 15:32
@dlachaume dlachaume temporarily deployed to testing-sanchonet November 13, 2024 15:49 — with GitHub Actions Inactive
@dlachaume dlachaume merged commit e2fa1e0 into main Nov 13, 2024
48 checks passed
@dlachaume dlachaume deleted the dlachaume/2071/create-status-route branch November 13, 2024 15:52
@dlachaume dlachaume mentioned this pull request Nov 13, 2024
Closed
24 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Alenar Alenar Alenar approved these changes

@jpraynaud jpraynaud jpraynaud approved these changes

+1 more reviewer

@sfauvel sfauvel sfauvel approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@dlachaume dlachaume

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Create a new /status route in aggregator

5 participants

@dlachaume @Alenar @sfauvel @jpraynaud