signer retrieves registrations with epoch settings route #1913

sfauvel · 2024-09-03T15:24:19Z

Content

In order to decentralize further the protocol, we want to get rid of the centralized orchestration of the signatures which is done with the pending certificate mechanism. The signer registrations for the current and the next epoch should be accessible from a different route than the /certificate-pending route and this should be the source of the signer registrations for the current and the next epoch for all the signers.

This PR depreciates fields in openapiand CertificatePendingMessage (protocol_parameters, next_protocol_parameters, signers and next_signers).
An EpochService is added to store Epoch settings (epoch, current signers, next signers, nex protocol parameters) and the signer use it to get information instead of using the pending certificate.

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)

Comments

Fields have been deprecated from CertificatePendingMessage but not removed from CertificatePending

Issue(s)

Closes #1897

mithril-signer/src/runtime/runner.rs

mithril-signer/src/services/epoch_service.rs

github-actions · 2024-09-03T15:31:10Z

Test Results

4 files ±0 53 suites ±0 9m 26s ⏱️ -1s
1 250 tests +3 1 250 ✅ +3 0 💤 ±0 0 ❌ ±0
1 461 runs +3 1 461 ✅ +3 0 💤 ±0 0 ❌ ±0

Results for commit 59a8894. ± Comparison against base commit 82b2f93.

This pull request removes 5 and adds 8 tests. Note that renamed tests count towards both.

mithril-aggregator ‑ message_adapters::to_epoch_settings_message::tests::test_simple_message
mithril-common ‑ entities::certificate_pending::tests::certificate_pending_get_signers
mithril-common ‑ messages::epoch_settings::tests::test_v1
mithril-signer ‑ message_adapters::from_pending_certificate_message::tests::adapt_signers
mithril-signer ‑ runtime::runner::tests::test_associate_signers_with_stake

mithril-common ‑ messages::epoch_settings::tests::test_actual_json_deserialized_into_actual_message
mithril-common ‑ messages::epoch_settings::tests::test_actual_json_deserialized_into_previous_message
mithril-signer ‑ services::epoch_service::tests::test_data_are_available_after_register_epoch_settings_call
mithril-signer ‑ services::epoch_service::tests::test_retrieve_data_return_error_before_register_epoch_settings_was_call
mithril-signer ‑ services::epoch_service::tests::test_signers_with_stake_are_available_after_register_epoch_settings_call
mithril-signer::create_cardano_transaction_single_signature ‑ test_extensions::certificate_handler::tests::retrieve_epoch_settings
mithril-signer::create_immutable_files_full_single_signature ‑ test_extensions::certificate_handler::tests::retrieve_epoch_settings
mithril-signer::era_switch ‑ test_extensions::certificate_handler::tests::retrieve_epoch_settings

♻️ This comment has been updated with latest results.

mithril-common/src/messages/epoch_settings.rs

mithril-common/src/messages/message_parts/signer.rs

openapi.yaml

mithril-signer/src/services/epoch_service.rs

mithril-signer/tests/test_extensions/certificate_handler.rs

mithril-signer/src/runtime/runner.rs

mithril-common/src/messages/message_parts/signer.rs

mithril-signer/src/runtime/runner.rs

jpraynaud

Overall looks almost good 👍

I left few suggestions and comments below.

mithril-common/src/messages/epoch_settings.rs

mithril-common/src/messages/message_parts/signer.rs

mithril-signer/src/message_adapters/from_epoch_settings.rs

mithril-signer/src/message_adapters/from_pending_certificate_message.rs

mithril-signer/src/runtime/runner.rs

mithril-signer/src/services/epoch_service.rs

Alenar

LGTM

jpraynaud

LGTM 👍

…ttings route

…igner with stake from runner

…in EpochService

…gnerWithStake registered to signed transition

…ignature` in `runner`

…`inform_epoch_settings`

… from `EpochService`

…ervice implementation

…protocol_parameters` from `CertificatePendingMessage`

…emarks

* mithril-aggregator from `0.5.60` to `0.5.61` * mithril-common from `0.4.49` to `0.4.50` * mithril-signer from `0.2.179` to `0.2.180` * mithril-aggregator-fake from `0.3.8` to `0.3.9` * openapi.yaml from `0.1.28` to `0.1.29`

github-advanced-security bot found potential problems Sep 3, 2024

View reviewed changes

mithril-signer/src/runtime/runner.rs Fixed Show fixed Hide fixed

mithril-signer/src/services/epoch_service.rs Fixed Show fixed Hide fixed

sfauvel changed the title ~~Ensemble/1897/signer retrieves registrations with epoch settings route~~ signer retrieves registrations with epoch settings route Sep 3, 2024

sfauvel marked this pull request as ready for review September 3, 2024 15:45

Alenar reviewed Sep 3, 2024

View reviewed changes

github-advanced-security bot found potential problems Sep 6, 2024

View reviewed changes

sfauvel force-pushed the ensemble/1897/signer_retrieves_registrations_with_epoch_settings_route branch from d60e407 to 429beca Compare September 6, 2024 09:22

jpraynaud reviewed Sep 6, 2024

View reviewed changes

sfauvel force-pushed the ensemble/1897/signer_retrieves_registrations_with_epoch_settings_route branch from 429beca to f5fcf39 Compare September 9, 2024 13:29

sfauvel temporarily deployed to testing-preview September 9, 2024 13:37 — with GitHub Actions Inactive

sfauvel temporarily deployed to testing-sanchonet September 9, 2024 13:37 — with GitHub Actions Inactive

Alenar approved these changes Sep 9, 2024

View reviewed changes

sfauvel force-pushed the ensemble/1897/signer_retrieves_registrations_with_epoch_settings_route branch from b39dae0 to 9339988 Compare September 9, 2024 16:06

jpraynaud approved these changes Sep 9, 2024

View reviewed changes

sfauvel added 16 commits September 9, 2024 18:12

Add current_signers and next_signers to EpochSettings in mithril-common

76ad12c

Adapt mithril-aggregator to send current and next signers in epoch-se…

bded99e

…ttings route

Adapt signer to work with new attributes on EpochSettings

be10cb0

Update state machine to register epoch_settings information and get s…

41804fa

…igner with stake from runner

Add an epoch_service that provide signers with stake

b2d1bc6

Move EpochService into services module and use an EpochData struct …

d54b2ca

…in EpochService

Add some test on EpochService and remove commented code

2852338

Store only signer when inform_epoch_settings in Signer and compute Si…

0a29cec

…gnerWithStake registered to signed transition

Create function to get signers with stack from EpochService

ea16c69

Remove signers parameter from compute_message and `compute_single_s…

169874f

…ignature` in `runner`

Give the EpochSetting ownership to the EpochService when calling …

6dff44b

…`inform_epoch_settings`

Remove register_signer_to_aggregator parameters and retrieve values…

df20a54

… from `EpochService`

Improve building of EpochSettingMessage

417c9b4

Fix some clippy issues

1cf3f79

Remove duplication in FakeAggregator

d582e7b

Use SignerMessagePart::from_signers instead of a specific function

1c31204

sfauvel added 13 commits September 9, 2024 18:12

Remove associate_signers_with_stake from runner and improve epoch_s…

2d55a0b

…ervice implementation

Fix next_protocol_multi_signerbuild in FakeEpochService::with_data

aac8161

Depreciate signers, next_signers, protocol_parameters and next_…

632a99b

…protocol_parameters` from `CertificatePendingMessage`

Fix clippy suggestions and remove useless comments

f908f37

Remove unused ToEpochSettingsMessageAdapter

1d6ab33

Fix typo and unused import

36fe621

Fix OpenAPI deprecation syntax

47a16ac

Improve test and allow deprecated in Adapter

598a722

Add a SignerMessagePart fallible conversion to Signer

1298283

Move functions from Runner trait to the implementation and fix PR r…

f6a8f65

…emarks

Remove signers assignation in FromPendingCertificateMessageAdapter

0344ca1

Update Mithril Aggregator Fake data

eb44059

Taking into account the remarks of the PR

4c4463a

sfauvel temporarily deployed to testing-preview September 9, 2024 16:14 — with GitHub Actions Inactive

sfauvel temporarily deployed to testing-sanchonet September 9, 2024 16:14 — with GitHub Actions Inactive

Upgrade crate versions

59a8894

* mithril-aggregator from `0.5.60` to `0.5.61` * mithril-common from `0.4.49` to `0.4.50` * mithril-signer from `0.2.179` to `0.2.180` * mithril-aggregator-fake from `0.3.8` to `0.3.9` * openapi.yaml from `0.1.28` to `0.1.29`

sfauvel force-pushed the ensemble/1897/signer_retrieves_registrations_with_epoch_settings_route branch from 9339988 to 59a8894 Compare September 10, 2024 06:25

sfauvel temporarily deployed to testing-preview September 10, 2024 06:33 — with GitHub Actions Inactive

sfauvel temporarily deployed to testing-sanchonet September 10, 2024 06:33 — with GitHub Actions Inactive

dlachaume approved these changes Sep 10, 2024

View reviewed changes

sfauvel merged commit aff35a8 into main Sep 10, 2024
39 of 40 checks passed

sfauvel deleted the ensemble/1897/signer_retrieves_registrations_with_epoch_settings_route branch September 10, 2024 07:20

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

signer retrieves registrations with epoch settings route #1913

signer retrieves registrations with epoch settings route #1913

sfauvel commented Sep 3, 2024 •

edited

Loading

github-actions bot commented Sep 3, 2024 •

edited

Loading

jpraynaud left a comment

Alenar left a comment

jpraynaud left a comment

signer retrieves registrations with epoch settings route #1913

signer retrieves registrations with epoch settings route #1913

Conversation

sfauvel commented Sep 3, 2024 • edited Loading

Content

Pre-submit checklist

Comments

Issue(s)

github-actions bot commented Sep 3, 2024 • edited Loading

Test Results

jpraynaud left a comment

Choose a reason for hiding this comment

Alenar left a comment

Choose a reason for hiding this comment

jpraynaud left a comment

Choose a reason for hiding this comment

sfauvel commented Sep 3, 2024 •

edited

Loading

github-actions bot commented Sep 3, 2024 •

edited

Loading