Skip to content

Commit 4d18fed

Browse files
jpraynaudjpraynaud
committed
docs: rotate current documentation
With release of distribution '2630' by running 'make update-current' command.
1 parent 3254f5d commit 4d18fed

23 files changed

Lines changed: 185 additions & 1126 deletions

File tree

‎docs/website/openapi.current.yaml‎

Lines changed: 33 additions & 317 deletions
Large diffs are not rendered by default.

‎docs/website/versioned_docs/version-maintained/case-studies/daedalus.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ sidebar_label: "Case Study: Daedalus Wallet"
2323

2424
## The problem
2525

26-
Daedalus runs a full Cardano node locally. On first install, that node must sync the entire Cardano blockchain from genesis, replaying every block. Even on modern hardware, this takes many hours and significant bandwidth, historically a major friction point for users picking up a full-node wallet.
26+
Daedalus runs a full Cardano node locally. On first install, that node must sync the entire Cardano blockchain from genesis, replaying every block. Even on modern hardware, this usually takes more than 24-36 hours, historically a major friction point for users picking up a full-node wallet.
2727

2828
## How Mithril helps
2929

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

Lines changed: 8 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -451,20 +451,6 @@ If you wish to delve deeper and access several levels of logs from the Mithril a
451451

452452
<CompiledBinaries node="mithril-aggregator"/>
453453

454-
## Build and run the Docker container
455-
456-
Build a local Docker image:
457-
458-
```bash
459-
make docker-build
460-
```
461-
462-
Run a local Docker container:
463-
464-
```bash
465-
make docker-run
466-
```
467-
468454
## Subcommands
469455

470456
Here are the available subcommands:
@@ -527,7 +513,7 @@ Here is a list of the available parameters for the serve command:
527513
| `era_reader_adapter_type` | `--era-reader-adapter-type` | - | `ERA_READER_ADAPTER_TYPE` | Era reader adapter type that can be `cardano-chain`, `file` or `bootstrap`. | `bootstrap` | - | - |
528514
| `era_reader_adapter_params` | `--era-reader-adapter-params` | - | `ERA_READER_ADAPTER_PARAMS` | Era reader adapter params that is an optional JSON encoded parameters structure that is expected depending on the `era_reader_adapter_type` parameter | - | - | - |
529515
| `ancillary_files_signer_config` | - | - | `ANCILLARY_FILES_SIGNER_CONFIG` | Configuration of the ancillary files signer<br/><br/>Can either be a secret key or a key stored in a Google Cloud Platform KMS account.<br/><br/>**IMPORTANT**: The cryptographic scheme used is ED25519 | - | - secret-key:<br/>`{ "type": "secret-key", "secret_key": "136372c3138312c3138382c3130352c3233312c3135" }`<br/>- Gcp kms:<br/>`{ "type": "gcp-kms", "resource_name": "projects/project_name/locations/_location_name/keyRings/key_ring_name/cryptoKeys/key_name/cryptoKeyVersions/key_version" }` | - |
530-
| `signed_entity_types` | `--signed-entity-types` | - | `SIGNED_ENTITY_TYPES` | Signed entity types parameters (discriminants names in an ordered comma separated list) | - | `MithrilStakeDistribution,CardanoImmutableFilesFull,CardanoStakeDistribution,CardanoDatabase,CardanoTransactions` | - |
516+
| `signed_entity_types` | `--signed-entity-types` | - | `SIGNED_ENTITY_TYPES` | Signed entity types parameters (discriminants names in an ordered comma separated list) | - | `MithrilStakeDistribution,CardanoStakeDistribution,CardanoDatabase,CardanoTransactions` | - |
531517
| `snapshot_compression_algorithm` | `--snapshot-compression-algorithm` | - | `SNAPSHOT_COMPRESSION_ALGORITHM` | Compression algorithm of the snapshot archive | `zstandard` | `gzip` or `zstandard` | - |
532518
| `zstandard_parameters` | - | - | `ZSTANDARD_PARAMETERS__LEVEL` and `ZSTANDARD_PARAMETERS__NUMBER_OF_WORKERS` | Zstandard specific parameters | - | `{ level: 9, number_of_workers: 4 }` | - |
533519
| `blockfrost_parameters` | - | - | `BLOCKFROST_PARAMETERS` | Optional parameters to connect to the Blockfrost API. Used to fetch the ticker and name of<br/>the registered stake pools.<br/><br/>`base_url` (optional) allows you to override the default URL, which is otherwise automatically determined from the project ID. | - | `{ "project_id": "preprodWuV1ICdtOWfZYfdcxpZ0tsS1N9rVZomQ" }`<br/>or `{ "project_id": "preprodWuV1ICdtOWfZYfdcxpZ0tsS1N9rVZomQ", "base_url": "https://your-custom-blockfrost-server.io/api/v0/" }` | - |
@@ -582,6 +568,7 @@ Here is a list of the available parameters for the serve command:
582568
| -------------------------- | ---------------------------- | :------------------: | -------------------------- | ------------------------------------------------------------------ | ------------- | ---------------------------------- | :----------------: |
583569
| `signed_payload_path` | `--signed-payload-path` | - | - | Path of the payload to import. | - | - | :heavy_check_mark: |
584570
| `genesis_verification_key` | `--genesis-verification-key` | - | - | Genesis verification key | - | - | :heavy_check_mark: |
571+
| `mithril_era` | `--mithril-era` | - | - | Mithril era to use for the genesis certificate | - | - | - |
585572
| `data_stores_directory` | - | - | `DATA_STORES_DIRECTORY` | Directory to store aggregator databases | - | `./mithril-aggregator/stores` | :heavy_check_mark: |
586573
| `cardano_node_socket_path` | - | - | `CARDANO_NODE_SOCKET_PATH` | Path of the socket opened by the Cardano node | - | `/ipc/node.socket` | :heavy_check_mark: |
587574
| `cardano_cli_path` | - | - | `CARDANO_CLI_PATH` | Cardano CLI tool path | - | `cardano-cli` | - |
@@ -591,11 +578,12 @@ Here is a list of the available parameters for the serve command:
591578

592579
`genesis sign` command:
593580

594-
| Parameter | Command line (long) | Command line (short) | Environment variable | Description | Default value | Example | Mandatory |
595-
| ---------------------------- | ------------------------------ | :------------------: | -------------------- | ------------------------------------- | ------------- | ------- | :-------: |
596-
| `to_sign_payload_path` | `--to-sign-payload-path` | - | - | Path of the payload to sign. | - | - | - |
597-
| `target_signed_payload_path` | `--target-signed-payload-path` | - | - | Path of the signed payload to export. | - | - | - |
598-
| `genesis_secret_key_path` | `--genesis-secret-key-path` | - | - | Path of the genesis secret key. | - | - | - |
581+
| Parameter | Command line (long) | Command line (short) | Environment variable | Description | Default value | Example | Mandatory |
582+
| ---------------------------- | ------------------------------ | :------------------: | -------------------- | ---------------------------------------------- | ------------- | ------- | :-------: |
583+
| `to_sign_payload_path` | `--to-sign-payload-path` | - | - | Path of the payload to sign. | - | - | - |
584+
| `target_signed_payload_path` | `--target-signed-payload-path` | - | - | Path of the signed payload to export. | - | - | - |
585+
| `genesis_secret_key_path` | `--genesis-secret-key-path` | - | - | Path of the genesis secret key. | - | - | - |
586+
| `mithril_era` | `--mithril-era` | - | - | Mithril era to use for the genesis certificate | - | - | - |
599587

600588
`genesis generate-keypair` command:
601589

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

Lines changed: 3 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -468,38 +468,6 @@ mithril_client cardano-stake-distribution list
468468
mithril_client cardano-stake-distribution download $UNIQUE_IDENTIFIER
469469
```
470470

471-
### Local image
472-
473-
Build a local Docker image:
474-
475-
<Tabs groupId="system" queryString>
476-
<TabItem value="linux-mac" label="Linux / Mac">
477-
```bash
478-
make docker-build
479-
```
480-
</TabItem>
481-
<TabItem value="windows" label="Windows">
482-
```powershell
483-
pushd ..\; docker build -t mithril/mithril-client -f mithril-client-cli\Dockerfile . ; popd
484-
```
485-
</TabItem>
486-
</Tabs>
487-
488-
Run a local Docker container:
489-
490-
<Tabs groupId="system" queryString>
491-
<TabItem value="linux-mac" label="Linux / Mac">
492-
```bash
493-
make docker-run
494-
```
495-
</TabItem>
496-
<TabItem value="windows" label="Windows">
497-
```powershell
498-
docker run --rm --name='mithril-client' mithril/mithril-client
499-
```
500-
</TabItem>
501-
</Tabs>
502-
503471
## Subcommands
504472

505473
Here are the subcommands available:
@@ -861,7 +829,9 @@ This command is not compatible with **Linux ARM environments**.
861829
| `db_directory` | `--db-directory` | - | - | Path to the Cardano node database directory | - | - | :heavy_check_mark: |
862830
| `cardano_node_version` | `--cardano-node-version` | - | - | Cardano node version of the Mithril signed snapshot (`latest` and `pre-release` are also supported to download the latest or pre-release distribution). | - | - | :heavy_check_mark: |
863831
| `cardano_network` | `--cardano-network` | - | - | Cardano network | - | - | - |
864-
| `utxo_hd_flavor` | `--utxo-hd-flavor` | - | - | UTxO-HD flavor to convert the ledger snapshot to (`Legacy` or `LMDB`) | - | - | :heavy_check_mark: |
832+
| `binary-path` | `--binary-path` | - | - | Path to the Cardano snapshot converter binary | - | - | - |
833+
| `config-path` | `--config-path` | - | - | Path to JSON configuration file for the Cardano snapshot converter | - | - | - |
834+
| `utxo_hd_flavor` | `--utxo-hd-flavor` | - | - | UTxO-HD flavor to convert the ledger snapshot to (`Legacy`, `LMDB` or `LSM`) | - | - | :heavy_check_mark: |
865835
| `commit` | `--commit` | - | - | Replaces the current ledger state in the `db_directory`. | `false` | - | - |
866836
| `github_token` | `--github-token` | - | `GITHUB_TOKEN` | GitHub token for authenticated API calls | - | - | - |
867837
| `run_mode` | `--run-mode` | - | `RUN_MODE` | Run Mode | `dev` | - | - |

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

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -208,20 +208,6 @@ If you wish to delve deeper and access several levels of logs from the Mithril s
208208
209209
<CompiledBinaries node="mithril-signer"/>
210210
211-
## Build and run a Docker container
212-
213-
Build a local Docker image:
214-
215-
```bash
216-
make docker-build
217-
```
218-
219-
Run a local Docker container:
220-
221-
```bash
222-
make docker-run
223-
```
224-
225211
## Configuration parameters
226212
227213
The configuration parameters can be set in either of the following ways:

0 commit comments

Comments
 (0)