Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rotate documentation for 2423 distribution #1732

Merged
merged 1 commit into from
Jun 12, 2024
Merged

Rotate documentation for 2423 distribution #1732

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions ...ioned_docs/version-maintained/manual/developer-docs/nodes/mithril-aggregator.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@ Mithril aggregator is responsible for collecting individual signatures from the

* Install the latest stable version of the [correctly configured](https://www.rust-lang.org/learn/get-started) Rust toolchain.

* Install Build Tools `build-essential` and `m4`. For example, on Ubuntu/Debian/Mint, run `sudo apt install build-essential m4`.

* Install OpenSSL development libraries. For example, on Ubuntu/Debian/Mint, run `apt install libssl-dev`.

## Download the source file
Expand Down Expand Up @@ -446,6 +448,7 @@ Here is a list of the available parameters:
| `snapshot_compression_algorithm` | `--snapshot-compression-algorithm` | - | `SNAPSHOT_COMPRESSION_ALGORITHM` | Compression algorithm of the snapshot archive | `zstandard` | `gzip` or `zstandard` | - |
| `zstandard_parameters` | - | - | `ZSTANDARD_PARAMETERS__LEVEL` and `ZSTANDARD_PARAMETERS__NUMBER_OF_WORKERS` | Zstandard specific parameters | - | `{ level: 9, number_of_workers: 4 }` | - |
| `allow_unparsable_block` | `--allow-unparsable-block` | - | `ALLOW_UNPARSABLE_BLOCK` | If set no error is returned in case of unparsable block and an error log is written instead. Will be ignored on (pre)production networks. | `false` | - | - |
| `cardano_transactions_signing_config` | - | - | `CARDANO_TRANSACTIONS_SIGNING_CONFIG__SECURITY_PARAMETER` and `CARDANO_TRANSACTIONS_SIGNING_CONFIG__STEP` | Cardano transactions signing configuration | - | `{ security_parameter: 3000, step: 120 }` | - |

`genesis bootstrap` command:

Expand Down
2 changes: 2 additions & 0 deletions ...d_docs/version-maintained/manual/developer-docs/nodes/mithril-client-library.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,8 @@ It is responsible for handling the different types of data certified by Mithril,

* Install the latest stable version of the [correctly configured](https://www.rust-lang.org/learn/get-started) Rust toolchain.

* Install Build Tools `build-essential` and `m4`. For example, on Ubuntu/Debian/Mint, run `sudo apt install build-essential m4`.

* Install OpenSSL development libraries. For example, on Ubuntu/Debian/Mint, run `apt install libssl-dev`

## Installation
Expand Down
27 changes: 7 additions & 20 deletions ...versioned_docs/version-maintained/manual/developer-docs/nodes/mithril-client.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@ Mithril client is responsible for restoring the **Cardano** blockchain on an emp
* Install the latest stable version of the [correctly configured](https://www.rust-lang.org/learn/get-started) Rust
toolchain.

* Install Build Tools `build-essential` and `m4`. For example, on Ubuntu/Debian/Mint, run `sudo apt install build-essential m4`.

* Install OpenSSL development libraries. For example, on Ubuntu/Debian/Mint, run `apt install libssl-dev`

## Download the source file
Expand Down Expand Up @@ -126,7 +128,6 @@ This program shows, downloads and verifies certified blockchain artifacts.
Usage: mithril-client [OPTIONS] <COMMAND>

Commands:
snapshot Deprecated, use `cardano-db` instead
cardano-db Cardano db management (alias: cdb)
mithril-stake-distribution Mithril Stake Distribution management (alias: msd)
cardano-transaction [unstable] Cardano transactions management (alias: ctx)
Expand Down Expand Up @@ -176,7 +177,7 @@ GENESIS_VERIFICATION_KEY=$(wget -q -O - **YOUR_GENESIS_VERIFICATION_KEY**) AGGRE
To display results in JSON format for the `list` and `show` commands, simply use the `--json` (or `-j`) option:

```bash
./mithril-client-cli snapshot list --json
./mithril-client-cli cardano-db snapshot list --json
```

:::
Expand Down Expand Up @@ -278,7 +279,7 @@ make docker-run

Here are the subcommands available:

### Cardano DB (previously: Snapshot)
### Cardano DB

| Subcommand | Performed action |
|------------|------------------|
Expand All @@ -287,20 +288,6 @@ Here are the subcommands available:
| **snapshot list** | Lists available cardano-db snapshots|
| **snapshot show** | Shows information about a cardano-db snapshot|

### Snapshot

:::warning
The `snapshot` commands are now **deprecated** and has been superseded by the `cardano-db` commands.
The `snapshot` commands will be removed in the near future.
:::

| Subcommand | Performed action |
|------------|------------------|
| **download** | Downloads and restores a cardano-db snapshot|
| **help** | Prints this message or the help for the given subcommand(s)|
| **list** | Lists available cardano-db snapshots|
| **show** | Shows information about a cardano-db snapshot|

### Mithril stake distribution

| Subcommand | Performed action |
Expand Down Expand Up @@ -339,20 +326,20 @@ Here is a list of the available parameters:
| `log_format_json` | `--log-format-json` | - | - | Enable JSON output for logs | - | - | - |
| `log_output` | `--log-output` | `-o` | - | Redirect the logs to a file | - | `./mithril-client.log` | - |

`cardano-db snapshot show` or `snapshot show` command:
`cardano-db snapshot show` command:

| Parameter | Command line (long) | Command line (short) | Environment variable | Description | Default value | Example | Mandatory |
|-----------|---------------------|:---------------------:|----------------------|-------------|---------------|---------|:---------:|
| `digest` | `--digest` | - | `DIGEST` | Cardano DB digest or `latest` for the latest digest | - | - | :heavy_check_mark: |
| `json` | `--json` | - | - | Enable JSON output for command results | - | - | - |

`cardano-db snapshot list` or `snapshot list` command:
`cardano-db snapshot list` command:

| Parameter | Command line (long) | Command line (short) | Environment variable | Description | Default value | Example | Mandatory |
|-----------|---------------------|:---------------------:|----------------------|-------------|---------------|---------|:---------:|
| `json` | `--json` | - | - | Enable JSON output for command results | - | - | - |

`cardano-db download` or `snapshot download` command:
`cardano-db download` command:

| Parameter | Command line (long) | Command line (short) | Environment variable | Description | Default value | Example | Mandatory |
|-----------|---------------------|:---------------------:|----------------------|-------------|---------------|---------|:---------:|
Expand Down
2 changes: 2 additions & 0 deletions ...versioned_docs/version-maintained/manual/developer-docs/nodes/mithril-signer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,8 @@ Mithril signer is responsible for producing individual signatures that are colle

* Install the latest stable version of the [correctly configured](https://www.rust-lang.org/learn/get-started) Rust toolchain.

* Install Build Tools `build-essential` and `m4`. For example, on Ubuntu/Debian/Mint, run `sudo apt install build-essential m4`.

* Install OpenSSL development libraries. For example, on Ubuntu/Debian/Mint, run `apt install libssl-dev`.

## Download the source file
Expand Down
5 changes: 4 additions & 1 deletion ...sioned_docs/version-maintained/manual/getting-started/bootstrap-cardano-node.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,9 @@ Before proceeding with the installation, ensure that you have the following pre-

1. **Install a [correctly configured](https://www.rust-lang.org/learn/get-started) Rust toolchain**: make sure you have the latest stable version of Rust installed

2. **Install OpenSSL development libraries**: On Ubuntu/Debian/Mint, run the following command to install the required OpenSSL development libraries:
2. **Install Build Tools `build-essential` and `m4`**: On Ubuntu/Debian/Mint, run `sudo apt install build-essential m4`.

3. **Install OpenSSL development libraries**: On Ubuntu/Debian/Mint, run the following command to install the required OpenSSL development libraries:

```
sudo apt install libssl-dev
Expand Down Expand Up @@ -113,6 +115,7 @@ This program shows, downloads and verifies certified blockchain artifacts.
Usage: mithril-client [OPTIONS] <COMMAND>

Commands:
snapshot Deprecated, use `cardano-db` instead
cardano-db Cardano db management (alias: cdb)
mithril-stake-distribution Mithril Stake Distribution management (alias: msd)
cardano-transaction [unstable] Cardano transactions management (alias: ctx)
Expand Down
2 changes: 2 additions & 0 deletions .../versioned_docs/version-maintained/manual/getting-started/run-mithril-devnet.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@ More information about the private Cardano/Mithril `devnet` is available [here](

* Install the latest stable version of a [correctly configured](https://www.rust-lang.org/learn/get-started) Rust toolchain.

* Install Build Tools `build-essential` and `m4`. For example, on Ubuntu/Debian/Mint, run `sudo apt install build-essential m4`.

* Install the OpenSSL development libraries. For example, on Ubuntu/Debian/Mint, run `apt install libssl-dev`.

## Download the source file
Expand Down
2 changes: 2 additions & 0 deletions ...ite/versioned_docs/version-maintained/manual/getting-started/run-signer-node.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,8 @@ Note that this guide works on a Linux machine only.

* Install a correctly configured Rust toolchain (latest stable version). You can follow the instructions provided [here](https://www.rust-lang.org/learn/get-started).

* Install Build Tools `build-essential` and `m4`. For example, on Ubuntu/Debian/Mint, run `sudo apt install build-essential m4`.

* Install OpenSSL development libraries. For example, on Ubuntu/Debian/Mint, run `apt install libssl-dev`.

* Install a recent version of `jq` (version 1.6+). You can install it by running `apt install jq`.
Expand Down
Loading