Skip to content

Commit b5a250f

Browse files
jpraynaudjpraynaud
authored
Merge pull request #2748 from input-output-hk/jpraynaud/2727-rotate-doc-distribution-2543
docs: rotate documentation for `2543` distribution
2 parents d1a8a24 + 7bd6632 commit b5a250f

File tree

4 files changed

+32
-29
lines changed

4 files changed

+32
-29
lines changed

‎docs/website/versioned_docs/version-maintained/manual/develop/nodes/mithril-aggregator.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -542,6 +542,7 @@ Here is a list of the available parameters for the serve command:
542542
| `metrics_server_port` | `--metrics-server-port` | - | `METRICS_SERVER_PORT` | Metrics HTTP server listening port | `9090` | - | - |
543543
| `persist_usage_report_interval_in_seconds` | | - | `PERSIST_USAGE_REPORT_INTERVAL_IN_SECONDS` | Duration in seconds between two recording of usage metrics | `10` | `5` | - |
544544
| `leader_aggregator_endpoint` | `--leader-aggregator-endpoint` | - | `LEADER_AGGREGATOR_ENDPOINT` | Leader aggregator endpoint (used with unstable feature) | - | `https://aggregator.pre-release-preview.api.mithril.network/aggregator` | - |
545+
| `aggregate_signature_type` | - | - | `AGGREGATE_SIGNATURE_TYPE` | Aggregate signature type used to create certificates | `Concatenation` | - | :heavy_check_mark: |
545546

546547
`genesis bootstrap` command:
547548

‎docs/website/versioned_docs/version-maintained/manual/develop/nodes/mithril-client-library.md‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -349,10 +349,9 @@ async fn main() -> mithril_client::MithrilResult<()> {
349349
&immutable_file_range,
350350
allow_missing_immutables_files,
351351
&target_directory,
352-
&verified_digest,
353-
),
354-
)
355-
.await?;
352+
&verified_digests,
353+
)
354+
.await?;
356355

357356
let message = MessageBuilder::new()
358357
.compute_cardano_database_message(&certificate, &merkle_proof)

‎docs/website/versioned_docs/version-maintained/manual/develop/nodes/mithril-client.md‎

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -554,7 +554,7 @@ Here is a list of the available parameters:
554554

555555
| Parameter | Command line (long) | Command line (short) | Environment variable | Description | Default value | Example | Mandatory |
556556
| --------------------- | ----------------------- | :------------------: | --------------------- | --------------------------------------------------------------------------------------------------------------------- | ------------- | ------- | :----------------: |
557-
| `backend` | `--backend` | `-b` | - | Backend to use, either: `v1` (default, full database restoration only) or `v2` (full or partial database restoration) | `v1` | - | - |
557+
| `backend` | `--backend` | `-b` | - | Backend to use, either: `v1` (full database restoration only) or `v2` (default, full or partial database restoration) | `v2` | - | - |
558558
| `digest` | - | - | - | Digest of the Cardano db snapshot to show or `latest` for the latest artifact | - | - | :heavy_check_mark: |
559559
| `run_mode` | `--run-mode` | - | `RUN_MODE` | Run Mode | `dev` | - | - |
560560
| `verbose` | `--verbose` | `-v` | - | Verbosity level (-v=warning, -vv=info, -vvv=debug, -vvvv=trace) | `0` | - | - |
@@ -570,26 +570,27 @@ Here is a list of the available parameters:
570570

571571
`cardano-db snapshot list` command:
572572

573-
| Parameter | Command line (long) | Command line (short) | Environment variable | Description | Default value | Example | Mandatory |
574-
| --------------------- | ----------------------- | :------------------: | --------------------- | --------------------------------------------------------------------------------------------------------------------- | ------------- | ------- | :-------: |
575-
| `backend` | `--backend` | `-b` | - | Backend to use, either: `v1` (default, full database restoration only) or `v2` (full or partial database restoration) | `v1` | - | - |
576-
| `run_mode` | `--run-mode` | - | `RUN_MODE` | Run Mode | `dev` | - | - |
577-
| `verbose` | `--verbose` | `-v` | - | Verbosity level (-v=warning, -vv=info, -vvv=debug, -vvvv=trace) | `0` | - | - |
578-
| `config_directory` | `--config-directory` | - | - | Directory where configuration file is located | `./config` | - | - |
579-
| `aggregator_endpoint` | `--aggregator-endpoint` | - | `AGGREGATOR_ENDPOINT` | Override configuration Aggregator endpoint URL | - | - | - |
580-
| `json` | `--json` | - | - | Enable JSON output for command results | `false` | - | - |
581-
| `log_format_json` | `--log-format-json` | - | - | Enable JSON output for logs displayed according to verbosity level | `false` | - | - |
582-
| `log_output` | `--log-output` | - | - | Redirect the logs to a file | - | - | - |
583-
| `unstable` | `--unstable` | - | - | Enable unstable commands | `false` | - | - |
584-
| `origin_tag` | `--origin-tag` | - | - | Request origin tag | - | - | - |
585-
| `era` | `--era` | - | - | Override the Mithril era | - | - | - |
586-
| `help` | `--help` | `-h` | - | Print help (see more with '--help') | - | - | - |
573+
| Parameter | Command line (long) | Command line (short) | Environment variable | Description | Default value | Example | Mandatory |
574+
| --------------------- | ----------------------- | :------------------: | --------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | ------- | :-------: |
575+
| `backend` | `--backend` | `-b` | - | Backend to use, either: `v1` (full database restoration only) or `v2` (default, full or partial database restoration) | `v2` | - | - |
576+
| `epoch` | `--epoch` | - | - | [backend `v2` only] Epoch of the Cardano db snapshots to list, or `latest` for the latest artifact, or `latest-X` for the artifact of the latest epoch minus X | - | - | - |
577+
| `run_mode` | `--run-mode` | - | `RUN_MODE` | Run Mode | `dev` | - | - |
578+
| `verbose` | `--verbose` | `-v` | - | Verbosity level (-v=warning, -vv=info, -vvv=debug, -vvvv=trace) | `0` | - | - |
579+
| `config_directory` | `--config-directory` | - | - | Directory where configuration file is located | `./config` | - | - |
580+
| `aggregator_endpoint` | `--aggregator-endpoint` | - | `AGGREGATOR_ENDPOINT` | Override configuration Aggregator endpoint URL | - | - | - |
581+
| `json` | `--json` | - | - | Enable JSON output for command results | `false` | - | - |
582+
| `log_format_json` | `--log-format-json` | - | - | Enable JSON output for logs displayed according to verbosity level | `false` | - | - |
583+
| `log_output` | `--log-output` | - | - | Redirect the logs to a file | - | - | - |
584+
| `unstable` | `--unstable` | - | - | Enable unstable commands | `false` | - | - |
585+
| `origin_tag` | `--origin-tag` | - | - | Request origin tag | - | - | - |
586+
| `era` | `--era` | - | - | Override the Mithril era | - | - | - |
587+
| `help` | `--help` | `-h` | - | Print help (see more with '--help') | - | - | - |
587588

588589
`cardano-db download` command:
589590

590591
| Parameter | Command line (long) | Command line (short) | Environment variable | Description | Default value | Example | Mandatory |
591592
| ---------------------------- | ------------------------------ | :------------------: | ---------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ------------- | ------- | :----------------: |
592-
| `backend` | `--backend` | `-b` | - | Backend to use, either: `v1` (default, full database restoration only) or `v2` (full or partial database restoration) | `v1` | - | - |
593+
| `backend` | `--backend` | `-b` | - | Backend to use, either: `v1` (full database restoration only) or `v2` (default, full or partial database restoration) | `v2` | - | - |
593594
| `digest` | - | - | - | Digest of the Cardano db snapshot to download or `latest` for the latest artifact | - | - | :heavy_check_mark: |
594595
| `download_dir` | `--download-dir` | - | - | Directory where the immutable and ancillary files will be downloaded | - | - | - |
595596
| `genesis_verification_key` | `--genesis-verification-key` | - | `GENESIS_VERIFICATION_KEY` | Genesis verification key to check the certificate chain | - | - | :heavy_check_mark: |
@@ -614,7 +615,7 @@ Here is a list of the available parameters:
614615

615616
| Parameter | Command line (long) | Command line (short) | Environment variable | Description | Default value | Example | Mandatory |
616617
| -------------------------- | ---------------------------- | :------------------: | -------------------------- | --------------------------------------------------------------------------------------------------------------------- | ------------- | ------- | :----------------: |
617-
| `backend` | `--backend` | `-b` | - | Backend to use, either: `v1` (default, full database restoration only) or `v2` (full or partial database restoration) | `v2` | - | - |
618+
| `backend` | `--backend` | `-b` | - | Backend to use, either: `v1` (full database restoration only) or `v2` (default, full or partial database restoration) | `v2` | - | - |
618619
| `digest` | - | - | - | Digest of the Cardano db snapshot to verify or `latest` for the latest artifact | - | - | :heavy_check_mark: |
619620
| `db_dir` | `--db-dir` | - | - | Directory from where the immutable will be verified | - | - | - |
620621
| `genesis_verification_key` | `--genesis-verification-key` | - | `GENESIS_VERIFICATION_KEY` | Genesis verification key to check the certificate chain | - | - | - |

‎docs/website/versioned_docs/version-maintained/manual/develop/run-mithril-devnet.md‎

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -585,16 +585,18 @@ AGGREGATOR_ENDPOINT=$AGGREGATOR_ENDPOINT ./mithril-client cardano-db download $S
585585
You will see that the certificate chain is validated to ensure the issued certificate is genuine and then the selected snapshot archive is downloaded, unpacked and verified against the corresponding certificate.
586586
587587
```bash
588-
1/5 - Checking local disk info…
589-
2/5 - Fetching the certificate and verifying the certificate chain…
590-
3/5 - Downloading and unpacking the Cardano db
591-
4/5 - Computing the Cardano db message
592-
5/5 - Verifying the cardano db signature…
593-
Cardano db 'db5f50a060d4b813125c4263b700ecc96e5d8c8710f0430e5c80d2f0fa79b667' has been unpacked and successfully verified with Mithril.
588+
1/7 - Checking local disk info…
589+
2/7 - Fetching the certificate and verifying the certificate chain…
590+
3/7 - Downloading and unpacking the cardano db snapshot
591+
4/7 - Downloading and verifying digests…
592+
5/7 - Verifying the cardano database
593+
6/7 - Computing the cardano db snapshot message
594+
7/7 - Verifying the cardano db signature…
595+
Cardano database snapshot 'bfd6621886fe1d3810e1ffb5e366c1688f9cc2ac1ee6aa40eb99ab28f0cc1fd6' archives have been successfully unpacked. Immutable files have been successfully verified with Mithril.
594596

595-
Files in the directory '/home/mithril/data/testnet/db5f50a060d4b813125c4263b700ecc96e5d8c8710f0430e5c80d2f0fa79b667/db' can be used to run a Cardano node with version >= 10.5.1.
597+
Files in the directory 'db' can be used to run a Cardano node with version >= 10.5.1.
596598

597599
If you are using Cardano Docker image, you can restore a Cardano Node with:
598600

599-
docker run -v cardano-node-ipc:/ipc -v cardano-node-data:/data --mount type=bind,source="/home/mithril/data/testnet/db5f50a060d4b813125c4263b700ecc96e5d8c8710f0430e5c80d2f0fa79b667/db",target=/data/db/ -e NETWORK=preview ghcr.io/intersectmbo/cardano-node:10.5.1
601+
docker run -v cardano-node-ipc:/ipc -v cardano-node-data:/data --mount type=bind,source="/home/mithril/data/testnet/bfd6621886fe1d3810e1ffb5e366c1688f9cc2ac1ee6aa40eb99ab28f0cc1fd6/db",target=/data/db/ -e NETWORK=preview ghcr.io/intersectmbo/cardano-node:10.5.1
600602
```

0 commit comments

Comments
 (0)