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

Implement Cardano stake distribution HTTP routes #1872

Merged
merged 17 commits into from
Aug 5, 2024
Merged

Implement Cardano stake distribution HTTP routes #1872

merged 17 commits into from
Aug 5, 2024

Conversation

dlachaume
Copy link
Collaborator

@dlachaume dlachaume commented Jul 31, 2024 •
edited
Loading

Content

This PR introduces new HTTP routes in the Aggregator REST API specifically for handling the signed entity type CardanoStakeDistribution:

  • /artifact/cardano-stake-distributions
  • /artifact/cardano-stake-distribution/{hash}
  • /artifact/cardano-stake-distribution/epoch/{epoch}

The end to end test has been updated to include the verification of CardanoStakeDistribution certification, ensuring that the new routes respond correctly.

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 #1841

@dlachaume dlachaume requested a review from jpraynaud July 31, 2024 10:35
@dlachaume dlachaume self-assigned this Jul 31, 2024
@dlachaume dlachaume requested a review from sfauvel July 31, 2024 10:35
@github-actions GitHub Actions
Copy link

github-actions bot commented Jul 31, 2024 •
edited
Loading

Test Results

    4 files  ± 0     53 suites  +1   9m 21s ⏱️ +14s
1 215 tests +23  1 215 ✅ +23  0 💤 ±0  0 ❌ ±0 
1 381 runs  +23  1 381 ✅ +23  0 💤 ±0  0 ❌ ±0 

Results for commit 6639770. ± Comparison against base commit a2faf35.

♻️ This comment has been updated with latest results.

jpraynaud
jpraynaud reviewed Jul 31, 2024
View reviewed changes
CHANGELOG.md Outdated Show resolved Hide resolved
mithril-aggregator/src/message_adapters/to_cardano_stake_distribution_message.rs Show resolved Hide resolved
mithril-aggregator/src/message_adapters/to_cardano_stake_distribution_message.rs Outdated Show resolved Hide resolved
mithril-common/src/messages/cardano_stake_distribution.rs Outdated Show resolved Hide resolved
mithril-aggregator/src/database/record/signed_entity.rs Outdated Show resolved Hide resolved
mithril-aggregator/src/database/query/signed_entity/get_signed_entity.rs Outdated Show resolved Hide resolved
mithril-aggregator/src/database/query/signed_entity/get_signed_entity.rs Outdated Show resolved Hide resolved
openapi.yaml Outdated Show resolved Hide resolved
openapi.yaml Show resolved Hide resolved
mithril-test-lab/mithril-end-to-end/src/end_to_end_spec.rs Outdated Show resolved Hide resolved
sfauvel
sfauvel approved these changes Jul 31, 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
Just a few questions about the way of testing

mithril-aggregator/src/database/query/signed_entity/get_signed_entity.rs Outdated Show resolved Hide resolved
mithril-aggregator/src/database/query/signed_entity/get_signed_entity.rs Outdated Show resolved Hide resolved
mithril-aggregator/src/database/record/signed_entity.rs Show resolved Hide resolved
mithril-aggregator/src/database/repository/signed_entity_store.rs Show resolved Hide resolved
@dlachaume dlachaume force-pushed the dlachaume/1841/implement-cardano-stake-distribution-routes branch from 6f683a2 to 3aa5077 Compare August 1, 2024 16:10
dlachaume and others added 14 commits August 2, 2024 14:11
@dlachaume
feat: create CardanoStakeDistributionMessage
74495dd 
Add test tooling for `CardanoStakeDistributionMessage` and `CardanoStakeDistribution` signed entity
@dlachaume
feat: implement get_cardano_stake_distribution_message for `Mithril…
54b8c2f 
…MessageService`
@dlachaume
feat: create CardanoStakeDistributionListItemMessage
40d418b
@dlachaume
feat: implement get_cardano_stake_distribution_list_message for `Mi…
6a7ad54 
…thrilMessageService`
@dlachaume
feat: add new query to get a signed entity by its inner epoch
5aaa62e
@dlachaume
feat: implement get_cardano_stake_distribution_message_by_epoch for…
a3dcb03 
… `MithrilMessageService`
@dlachaume
feat: implement routes and update OpenAPI specs
02cc0ea
@dlachaume
test: extend E2E test to check the CardanoStakeDistribution certifi…
0cc8ff6 
…cation
@dlachaume
chore: reference the feature in the CHANGELOG
ed0a7fa
@dlachaume
feat: add migration to create a unique index on signed_entity table…
7d0c27e 
… on `signed_entity_type_id` and `beacon`
@dlachaume @sfauvel
feat: add specific query function to get a CardanoStakeDistribution…
8816650 
… by epoch

Co-authored-by: Sébastien Fauvel <sfauvel@users.noreply.github.com>
@dlachaume
feat: wire MithrilMessageService with new implementation to get a `…
c213fce 
…CardanoStakeDistribution` by epoch

Remove previous implementation
@dlachaume
fix: use the epoch from the beacon of the CardanoStakeDistribution …
3b440de 
…signed entity instead of using the epoch of the artifact to build the messages
@dlachaume @sfauvel
fix: env variable DELEGATION_ROUND is not assigned in AMOUNT_STAKED
63fdc28 
Co-authored-by: Sébastien Fauvel <sfauvel@users.noreply.github.com>
@dlachaume dlachaume force-pushed the dlachaume/1841/implement-cardano-stake-distribution-routes branch from 3aa5077 to 03f838d Compare August 2, 2024 16:35
@dlachaume dlachaume force-pushed the dlachaume/1841/implement-cardano-stake-distribution-routes branch from 03f838d to af00dec Compare August 2, 2024 16:47
@dlachaume dlachaume force-pushed the dlachaume/1841/implement-cardano-stake-distribution-routes branch 2 times, most recently from bccf5be to a8fd4b5 Compare August 5, 2024 13:50
@dlachaume dlachaume force-pushed the dlachaume/1841/implement-cardano-stake-distribution-routes branch from a8fd4b5 to 66a4aa1 Compare August 5, 2024 15:39
jpraynaud
jpraynaud approved these changes Aug 5, 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 dlachaume merged commit dcf8f63 into main Aug 5, 2024
40 checks passed
@dlachaume dlachaume deleted the dlachaume/1841/implement-cardano-stake-distribution-routes branch August 5, 2024 15:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sfauvel sfauvel sfauvel approved these changes

@jpraynaud jpraynaud jpraynaud approved these changes

Assignees

@dlachaume dlachaume

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Implement routes for Cardano Stake Distribution in aggregator REST API
3 participants
@dlachaume @sfauvel @jpraynaud