docs: add documentation about recursive search of immutables directory

Author: Clément Turmel

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

@@ -616,7 +616,7 @@ Here is a list of the available parameters:
 | -------------------------- | ---------------------------- | :------------------: | -------------------------- | --------------------------------------------------------------------------------------------------------------------- | ------------- | ------- | :----------------: |
 | `backend`                  | `--backend`                  |         `-b`         | -                          | Backend to use, either: `v1` (default, full database restoration only) or `v2` (full or partial database restoration) | `v2`          | -       |         -          |
 | `digest`                   | -                            |          -           | -                          | Digest of the Cardano db snapshot to verify or `latest` for the latest artifact                                       | -             | -       | :heavy_check_mark: |
-| `db_dir`                   | `--db-dir`                   |          -           | -                          | Directory from where the immutable will be verified                                                                   | -             | -       |         -          |
+| `db_dir`                   | `--db-dir`                   |          -           | -                          | Directory from where the immutable will be verified. It will recursively search for immutable directory.              | -             | -       |         -          |
 | `genesis_verification_key` | `--genesis-verification-key` |          -           | `GENESIS_VERIFICATION_KEY` | Genesis verification key to check the certificate chain                                                               | -             | -       |         -          |
 | `run_mode`                 | `--run-mode`                 |          -           | `RUN_MODE`                 | Run Mode                                                                                                              | `dev`         | -       |         -          |
 | `verbose`                  | `--verbose`                  |         `-v`         | -                          | Verbosity level (-v=warning, -vv=info, -vvv=debug, -vvvv=trace)                                                       | `0`           | -       |         -          |

internal/cardano-node/mithril-cardano-node-internal-database/src/entities/immutable_file.rs

@@ -133,7 +133,7 @@ impl ImmutableFile {
         Ok(hasher.finalize())
     }
 
-    /// List all [`ImmutableFile`] in a given directory.
+    /// List all [`ImmutableFile`] in a given directory by recursively searching a immutable directory.
     pub fn list_all_in_dir(dir: &Path) -> Result<Vec<ImmutableFile>, ImmutableFileListingError> {
         let immutable_dir = find_immutables_dir(dir).ok_or(
             ImmutableFileListingError::MissingImmutableFolder(dir.to_path_buf()),
@@ -169,7 +169,7 @@ impl ImmutableFile {
         }
     }
 
-    /// Check if at least one immutable file exists in the given directory
+    /// Check if at least one immutable file exists in the given directory by recursively searching a immutable directory
     pub fn at_least_one_immutable_files_exist_in_dir(
         dir: &Path,
     ) -> Result<(), ImmutableFileListingError> {

mithril-client-cli/src/commands/cardano_db/verify.rs

@@ -31,7 +31,7 @@ pub struct CardanoDbVerifyCommand {
     /// Use the `list` command to get that information.
     digest: String,
 
-    /// Directory from where the immutable will be verified.
+    /// Directory from where the immutable will be verified. It will recursively search for immutable directory.
     #[clap(long)]
     db_dir: Option<PathBuf>,
 

mithril-client/src/cardano_database_client/proving.rs

@@ -44,6 +44,8 @@ impl InternalArtifactProver {
     }
 
     /// Compute the Merkle proof of membership for the given immutable file range.
+    ///
+    /// It will recursively search for immutables directory inside the provided `database_dir`.
     pub async fn compute_merkle_proof(
         &self,
         certificate: &CertificateMessage,