Feat: implement signature publisher decorators in signer #2468

dlachaume · 2025-05-06T16:04:49Z

Content

This PR includes the implementation of signature publisher decorators in the signer node, introducing a retrier publisher and a delayer publisher to facilitate future integration with a DMQ-based diffusion mechanism.

Additionally, signature publisher parameters have been made configurable to support execution in both end-to-end test and production environments. The default values are:
SIGNATURE_PUBLISHER_RETRY_ATTEMPTS: 3 attempts
SIGNATURE_PUBLISHER_RETRY_DELAY_MS: 2,000 milliseconds
SIGNATURE_PUBLISHER_DELAY_MS: 10,000 milliseconds

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
- All check jobs of the CI have succeeded
- 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)
- Add ADR blog post or Dev ADR entry (if relevant)
- No new TODOs introduced

Issue(s)

Closes #2461

github-actions · 2025-05-06T16:28:52Z

Test Results

3 files ±0 57 suites ±0 11m 52s ⏱️ +6s
1 905 tests +9 1 905 ✅ +9 0 💤 ±0 0 ❌ ±0
2 379 runs +9 2 379 ✅ +9 0 💤 ±0 0 ❌ ±0

Results for commit 2b40cb3. ± Comparison against base commit 346b447.

♻️ This comment has been updated with latest results.

jpraynaud

LGTM 👍

jpraynaud · 2025-05-07T16:16:45Z

docs/website/root/manual/develop/nodes/mithril-signer.md

@@ -259,3 +259,6 @@ Here is a list of the available parameters:
 | `transactions_import_block_chunk_size`                           | -                                          |          -           | `TRANSACTIONS_IMPORT_BLOCK_CHUNK_SIZE`                           | Chunk size for importing transactions, combined with transaction pruning it reduces the storage footprint of the signer by reducing the number of transactions stored on disk at any given time. | `1500`        | -                                                                                                                       |                                                                                         -                                                                                         |
 | `cardano_transactions_block_streamer_max_roll_forwards_per_poll` | -                                          |          -           | `CARDANO_TRANSACTIONS_BLOCK_STREAMER_MAX_ROLL_FORWARDS_PER_POLL` | The maximum number of roll forwards during a poll of the block streamer when importing transactions.                                                                                             | `1000`        | -                                                                                                                       |                                                                                         -                                                                                         |
 | `preloading_refresh_interval_in_seconds`                         | `--preloading-refresh-interval-in-seconds` |          -           | `PRELOADING_REFRESH_INTERVAL_IN_SECONDS`                         | The preloading refresh interval in seconds.                                                                                                                                                      | `7200`        | -                                                                                                                       |                                                                                         -                                                                                         |
+| `signature_publisher_retry_attempts`                             | `--signature-publisher-retry-attempts`     |          -           | `SIGNATURE_PUBLISHER_RETRY_ATTEMPTS`                             | Number of retry attempts when publishing the signature.                                                                                                                                          | `3`           | -                                                                                                                       |                                                                                         -                                                                                         |
+| `signature_publisher_retry_delay_ms`                             | `--signature-publisher-retry-delay-ms`     |          -           | `SIGNATURE_PUBLISHER_RETRY_DELAY_MS`                             | Delay (in milliseconds) between two retry attempts when publishing the signature.                                                                                                                | `2000`        | -                                                                                                                       |                                                                                         -                                                                                         |
+| `signature_publisher_delay_ms`                                   | `--signature-publisher-delay-ms`           |          -           | `SIGNATURE_PUBLISHER_DELAY_MS`                                   | Delay (in milliseconds) between two separate signature publishers being called.                                                                                                                  | `10000`       | -                                                                                                                       |                                                                                         -                                                                                         |


The name is not specific enough, it would be more clear like this:

Suggested change

| `signature_publisher_delay_ms` | `--signature-publisher-delay-ms` | - | `SIGNATURE_PUBLISHER_DELAY_MS` | Delay (in milliseconds) between two separate signature publishers being called. | `10000` | - | - |

| `signature_publisher_delayer_delay_ms` | `--signature-publisher-delayer-delay-ms` | - | `SIGNATURE_PUBLISHER_DELAY_MS` | Delay (in milliseconds) between two separate publications done by the delayer signature publisher. | `10000` | - | - |

jpraynaud · 2025-05-07T16:18:06Z

mithril-signer/src/configuration.rs

@@ -121,6 +121,15 @@ pub struct Configuration {

    /// Preloading refresh interval in seconds
    pub preloading_refresh_interval_in_seconds: u64,
+
+    /// Number of retry attempts when publishing the signature
+    pub signature_publisher_retry_attempts: usize,


Maybe this is enough?

Suggested change

pub signature_publisher_retry_attempts: usize,

pub signature_publisher_retry_attempts: u8,

jpraynaud · 2025-05-07T16:18:49Z

mithril-signer/src/dependency_injection/builder.rs

@@ -386,7 +387,30 @@ impl<'a> DependenciesBuilder<'a> {
            self.root_logger(),
        ));

-        let signature_publisher: Arc<dyn SignaturePublisher> = aggregator_client.clone();
+        let signature_publisher = {
+            // Temporary no-op publisher used to prepare the delayer for a future DMQ-based diffusion.


Suggested change

// Temporary no-op publisher used to prepare the delayer for a future DMQ-based diffusion.

// Temporary no-op publisher before a DMQ-based implementation is available.

jpraynaud · 2025-05-07T16:20:36Z

mithril-signer/src/services/signature_publisher/signature_publisher_delayer.rs

+
+use super::SignaturePublisher;
+
+/// A decorator of [SignaturePublisher] that delays the publishing of signatures to a second publisher


Suggested change

/// A decorator of [SignaturePublisher] that delays the publishing of signatures to a second publisher

/// A decorator of [SignaturePublisher] that publishes right away on a first publisher and with a delay on the second publisher.

jpraynaud · 2025-05-07T16:21:15Z

mithril-signer/src/services/signature_publisher/signature_publisher_delayer.rs

+            .publish(signed_entity_type, signature, protocol_message)
+            .await
+        {
+            warn!(self.logger, "Failed to publish signature: {e}");


Suggested change

warn!(self.logger, "Failed to publish signature: {e}");

error!(self.logger, "Delayer failed to publish first signature: {e}");

jpraynaud · 2025-05-07T16:21:57Z

mithril-signer/src/services/signature_publisher/signature_publisher_delayer.rs

+
+        tokio::time::sleep(self.delay_between_publish).await;
+
+        self.second_publisher


Maybe you can also add an error log here?

jpraynaud · 2025-05-07T16:23:22Z

mithril-signer/src/services/signature_publisher/signature_publisher_noop.rs

+/// It is useful to prepare the coexistence phase of the DMQ and HTTP implementations,
+/// with the introduction of delay logic.


This can be removed IMO

jpraynaud · 2025-05-07T16:24:09Z

mithril-signer/src/services/signature_publisher/signature_publisher_retrier.rs

The naming Upload should be replaced by Publish or similar in this module

…tion for DMQ/HTTP coexistence

…isherRetrier` and `SignaturePublisherDelayer`

…er in e2e test

…h the new parameters

dlachaume self-assigned this May 6, 2025

dlachaume changed the title ~~Dlachaume/2461/signer signature publisher decorators~~ Feat: implement signer signature publisher decorators May 6, 2025

dlachaume changed the title ~~Feat: implement signer signature publisher decorators~~ Feat: implement signature publisher decorators in signer May 6, 2025

dlachaume force-pushed the dlachaume/2461/signer-signature-publisher-decorators branch from 1d4e2d3 to d62bf6b Compare May 7, 2025 08:51

dlachaume temporarily deployed to testing-preview May 7, 2025 14:40 — with GitHub Actions Inactive

dlachaume force-pushed the dlachaume/2461/signer-signature-publisher-decorators branch 2 times, most recently from 91119b5 to 324823e Compare May 7, 2025 14:45

dlachaume marked this pull request as ready for review May 7, 2025 14:54

dlachaume requested review from jpraynaud and turmelclem May 7, 2025 14:54

dlachaume temporarily deployed to testing-preview May 7, 2025 14:54 — with GitHub Actions Inactive

jpraynaud approved these changes May 7, 2025

View reviewed changes

dlachaume added 7 commits May 7, 2025 18:40

feat(signer): implement a retrier decorator SignaturePublisherRetrier

088bdfb

feat(signer): Implement a delayer decorator SignaturePublisherDelayer

2d61d36

feat(signer): add SignaturePublisherNoop for delay logic in prepara…

b33f044

…tion for DMQ/HTTP coexistence

feat(signer): update the dependency injection with the `SignaturePubl…

91229dc

…isherRetrier` and `SignaturePublisherDelayer`

feat(signer): make signature publisher parameters configurable

58cb184

ci(end-to-end): configure signature publisher parameters for the sign…

5661ebd

…er in e2e test

docs(website): update the signer node configuration documentation wit…

2b40cb3

…h the new parameters

dlachaume force-pushed the dlachaume/2461/signer-signature-publisher-decorators branch from 324823e to 2b40cb3 Compare May 7, 2025 16:45

dlachaume deployed to testing-preview May 7, 2025 16:54 — with GitHub Actions Active

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feat: implement signature publisher decorators in signer #2468

Feat: implement signature publisher decorators in signer #2468

dlachaume commented May 6, 2025 •

edited

Loading

github-actions bot commented May 6, 2025 •

edited

Loading

jpraynaud left a comment

jpraynaud May 7, 2025

jpraynaud May 7, 2025

jpraynaud May 7, 2025

jpraynaud May 7, 2025

jpraynaud May 7, 2025

jpraynaud May 7, 2025

jpraynaud May 7, 2025

jpraynaud May 7, 2025

	\| `signature_publisher_delay_ms` \| `--signature-publisher-delay-ms` \| - \| `SIGNATURE_PUBLISHER_DELAY_MS` \| Delay (in milliseconds) between two separate signature publishers being called. \| `10000` \| - \| - \|
	\| `signature_publisher_delayer_delay_ms` \| `--signature-publisher-delayer-delay-ms` \| - \| `SIGNATURE_PUBLISHER_DELAY_MS` \| Delay (in milliseconds) between two separate publications done by the delayer signature publisher. \| `10000` \| - \| - \|

	pub signature_publisher_retry_attempts: usize,
	pub signature_publisher_retry_attempts: u8,

	// Temporary no-op publisher used to prepare the delayer for a future DMQ-based diffusion.
	// Temporary no-op publisher before a DMQ-based implementation is available.


		use super::SignaturePublisher;

		/// A decorator of [SignaturePublisher] that delays the publishing of signatures to a second publisher

	warn!(self.logger, "Failed to publish signature: {e}");
	error!(self.logger, "Delayer failed to publish first signature: {e}");


		tokio::time::sleep(self.delay_between_publish).await;

		self.second_publisher

		/// It is useful to prepare the coexistence phase of the DMQ and HTTP implementations,
		/// with the introduction of delay logic.

Feat: implement signature publisher decorators in signer #2468

Are you sure you want to change the base?

Feat: implement signature publisher decorators in signer #2468

Conversation

dlachaume commented May 6, 2025 • edited Loading

Content

Pre-submit checklist

Issue(s)

github-actions bot commented May 6, 2025 • edited Loading

Test Results

jpraynaud left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dlachaume commented May 6, 2025 •

edited

Loading

github-actions bot commented May 6, 2025 •

edited

Loading