feat(aggregator): publish snapshot dir to IPNS

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

@@ -588,6 +588,7 @@ Here is a list of the available parameters for the serve command:
 | `cardano_prover_max_hashes_allowed_by_request`                   | `--cardano-prover-max-hashes-allowed-by-request`                   |          -           | `CARDANO_PROVER_MAX_HASHES_ALLOWED_BY_REQUEST`                              | Maximum number of hashes allowed by request to the Cardano prover (applies to both transaction hashes and block hashes)                                                                                                                                                                                                                                                                                                                                                | `100`           | `100`                                                                                                                                                                                                                                                                                            |                        -                        |
 | `cardano_transactions_block_streamer_max_roll_forwards_per_poll` | `--cardano-transactions-block-streamer-max-roll-forwards-per-poll` |          -           | `CARDANO_TRANSACTIONS_BLOCK_STREAMER_MAX_ROLL_FORWARDS_PER_POLL`            | Maximum number of roll forwards during a poll of the block streamer when importing transactions                                                                                                                                                                                                                                                                                                                                                                        | `1000`          | `1000`                                                                                                                                                                                                                                                                                           |                        -                        |
 | `preload_security_parameter`                                     | -                                                                  |          -           | `PRELOAD_SECURITY_PARAMETER`                                                | Blocks offset, from the tip of the chain, to exclude during the cardano transactions preload<br/>`[default: 2160]`.                                                                                                                                                                                                                                                                                                                                                    | `2160`          | -                                                                                                                                                                                                                                                                                                |               :heavy_check_mark:                |
+| `ipfs_rpc_server_config`                                         | -                                                                  |          -           | `IPFS_RPC_SERVER_CONFIG`                                                    | URL of a Kubo IPFS RPC API, setting this will enable IPFS upload for immutable snapshots<br/><br/>`mfs_folder_name` (optional) allows overriding the name of the folder in the IPFS MFS (Mutable File System)<br/>where the snapshots will be stored. Defaults to "mithril" if not specified.<br/>`ipns_key_name` (optional) if set, publishes the snapshot MFS folder to IPNS under this key name. The<br/>key must already exist in the Kubo node keystore.          | -               | `{ "url": "http://localhost:5001/" }`or `{ "url": "http://localhost:5001/", "mfs_folder_name": "custom-folder", "ipns_key_name": "ipns-key" }`                                                                                                                                                   |                        -                        |
 | `enable_metrics_server`                                          | `--enable-metrics-server`                                          |          -           | `ENABLE_METRICS_SERVER`                                                     | Enable metrics HTTP server (Prometheus endpoint on /metrics)                                                                                                                                                                                                                                                                                                                                                                                                           | `false`         | -                                                                                                                                                                                                                                                                                                |                        -                        |
 | `metrics_server_ip`                                              | `--metrics-server-ip`                                              |          -           | `METRICS_SERVER_IP`                                                         | Metrics HTTP server IP                                                                                                                                                                                                                                                                                                                                                                                                                                                 | `0.0.0.0`       | -                                                                                                                                                                                                                                                                                                |                        -                        |
 | `metrics_server_port`                                            | `--metrics-server-port`                                            |          -           | `METRICS_SERVER_PORT`                                                       | Metrics HTTP server listening port                                                                                                                                                                                                                                                                                                                                                                                                                                     | `9090`          | -                                                                                                                                                                                                                                                                                                |                        -                        |

mithril-aggregator/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "mithril-aggregator"
-version = "0.10.20"
+version = "0.10.21"
 description = "A Mithril Aggregator server"
 authors = { workspace = true }
 edition = { workspace = true }

mithril-aggregator/src/configuration.rs

@@ -501,9 +501,11 @@ pub struct ServeCommandConfiguration {
     ///
     /// `mfs_folder_name` (optional) allows overriding the name of the folder in the IPFS MFS (Mutable File System)
     /// where the snapshots will be stored. Defaults to "mithril" if not specified.
+    /// `ipns_key_name` (optional) if set, publishes the snapshot MFS folder to IPNS under this key name. The
+    /// key must already exist in the Kubo node keystore.
     #[example = "\
     `{ \"url\": \"http://localhost:5001/\" }`\
-    or `{ \"url\": \"http://localhost:5001/\", \"mfs_folder_name\": \"custom-folder\" }`\
+    or `{ \"url\": \"http://localhost:5001/\", \"mfs_folder_name\": \"custom-folder\", \"ipns_key_name\": \"ipns-key\" }`\
     "]
     #[serde(
         default,
@@ -718,6 +720,12 @@ pub struct IpfsRpcServerConfig {
     /// Defaults to "mithril" if not specified.
     #[serde(default = "default_mfs_folder_name")]
     pub mfs_folder_name: String,
+
+    /// Optional name of the IPNS key used to publish the snapshot MFS folder.
+    ///
+    /// The key must already exist in the IPFS node keystore. If it is missing or the publication
+    /// fails, a warning is logged and the snapshot upload still succeeds.
+    pub ipns_key_name: Option<String>,
 }
 
 impl IpfsRpcServerConfig {
@@ -1519,13 +1527,14 @@ mod test {
 
     #[test]
     fn deserializing_ipfs_rpc_server_parameters() {
-        let deserialized_without_mfs_dir: IpfsRpcServerConfig =
+        let deserialized_with_defaults: IpfsRpcServerConfig =
             serde_json::from_str(r#"{ "url": "http://localhost:5001/" }"#).unwrap();
         assert_eq!(
-            deserialized_without_mfs_dir,
+            deserialized_with_defaults,
             IpfsRpcServerConfig {
                 url: "http://localhost:5001/".to_string(),
                 mfs_folder_name: default_mfs_folder_name(),
+                ipns_key_name: None,
             }
         );
 
@@ -1538,6 +1547,20 @@ mod test {
             IpfsRpcServerConfig {
                 url: "http://localhost:5001/".to_string(),
                 mfs_folder_name: "altered".to_string(),
+                ipns_key_name: None,
+            }
+        );
+
+        let deserialized_with_ipns_key_name: IpfsRpcServerConfig = serde_json::from_str(
+            r#"{ "url": "http://localhost:5001/", "ipns_key_name": "my-key" }"#,
+        )
+        .unwrap();
+        assert_eq!(
+            deserialized_with_ipns_key_name,
+            IpfsRpcServerConfig {
+                url: "http://localhost:5001/".to_string(),
+                mfs_folder_name: default_mfs_folder_name(),
+                ipns_key_name: Some("my-key".to_string()),
             }
         );
     }

mithril-aggregator/src/dependency_injection/builder/protocol/artifacts.rs

@@ -282,6 +282,7 @@ impl DependenciesBuilder {
         Ok(IpfsUploader::new(
             Arc::new(rpc_api_client),
             IpfsMfsDirPath::from(ipfs_rpc_config.mfs_folder_name),
+            ipfs_rpc_config.ipns_key_name,
             FileUploadRetryPolicy::default(),
             &self.root_logger(),
         ))