Skip to content

Commit cd28d19

Browse files
jpraynaudjpraynaud
committed
docs: rotate current documentation
With release of distribution '2624' by running 'make update-current' command.
1 parent 7d13b76 commit cd28d19

22 files changed

Lines changed: 190 additions & 1077 deletions

File tree

‎docs/website/openapi.current.yaml‎

Lines changed: 20 additions & 316 deletions
Large diffs are not rendered by default.

‎docs/website/root/use-cases/bridges.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ A [WASM package](https://www.npmjs.com/package/@mithril-dev/mithril-client-wasm)
4141
The core flow is straightforward:
4242

4343
1. Observe the lock or burn transaction on Cardano
44-
2. Query the Mithril aggregator for a transaction proof of membership once the transation hash is known
44+
2. Query the Mithril aggregator for a transaction proof of membership once the transaction hash is known
4545
3. Verify the proof against the current Mithril certificate chain
4646
4. Apply your finality criteria, then authorize the corresponding action on the destination chain.
4747

‎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 & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -527,7 +527,7 @@ Here is a list of the available parameters for the serve command:
527527
| `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` | - | - |
528528
| `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 | - | - | - |
529529
| `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` | - |
530+
| `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` | - |
531531
| `snapshot_compression_algorithm` | `--snapshot-compression-algorithm` | - | `SNAPSHOT_COMPRESSION_ALGORITHM` | Compression algorithm of the snapshot archive | `zstandard` | `gzip` or `zstandard` | - |
532532
| `zstandard_parameters` | - | - | `ZSTANDARD_PARAMETERS__LEVEL` and `ZSTANDARD_PARAMETERS__NUMBER_OF_WORKERS` | Zstandard specific parameters | - | `{ level: 9, number_of_workers: 4 }` | - |
533533
| `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 +582,7 @@ Here is a list of the available parameters for the serve command:
582582
| -------------------------- | ---------------------------- | :------------------: | -------------------------- | ------------------------------------------------------------------ | ------------- | ---------------------------------- | :----------------: |
583583
| `signed_payload_path` | `--signed-payload-path` | - | - | Path of the payload to import. | - | - | :heavy_check_mark: |
584584
| `genesis_verification_key` | `--genesis-verification-key` | - | - | Genesis verification key | - | - | :heavy_check_mark: |
585+
| `mithril_era` | `--mithril-era` | - | - | Mithril era to use for the genesis certificate | - | - | - |
585586
| `data_stores_directory` | - | - | `DATA_STORES_DIRECTORY` | Directory to store aggregator databases | - | `./mithril-aggregator/stores` | :heavy_check_mark: |
586587
| `cardano_node_socket_path` | - | - | `CARDANO_NODE_SOCKET_PATH` | Path of the socket opened by the Cardano node | - | `/ipc/node.socket` | :heavy_check_mark: |
587588
| `cardano_cli_path` | - | - | `CARDANO_CLI_PATH` | Cardano CLI tool path | - | `cardano-cli` | - |
@@ -591,11 +592,12 @@ Here is a list of the available parameters for the serve command:
591592

592593
`genesis sign` command:
593594

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. | - | - | - |
595+
| Parameter | Command line (long) | Command line (short) | Environment variable | Description | Default value | Example | Mandatory |
596+
| ---------------------------- | ------------------------------ | :------------------: | -------------------- | ---------------------------------------------- | ------------- | ------- | :-------: |
597+
| `to_sign_payload_path` | `--to-sign-payload-path` | - | - | Path of the payload to sign. | - | - | - |
598+
| `target_signed_payload_path` | `--target-signed-payload-path` | - | - | Path of the signed payload to export. | - | - | - |
599+
| `genesis_secret_key_path` | `--genesis-secret-key-path` | - | - | Path of the genesis secret key. | - | - | - |
600+
| `mithril_era` | `--mithril-era` | - | - | Mithril era to use for the genesis certificate | - | - | - |
599601

600602
`genesis generate-keypair` command:
601603

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -861,7 +861,9 @@ This command is not compatible with **Linux ARM environments**.
861861
| `db_directory` | `--db-directory` | - | - | Path to the Cardano node database directory | - | - | :heavy_check_mark: |
862862
| `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: |
863863
| `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: |
864+
| `binary-path` | `--binary-path` | - | - | Path to the Cardano snapshot converter binary | - | - | - |
865+
| `config-path` | `--config-path` | - | - | Path to JSON configuration file for the Cardano snapshot converter | - | - | - |
866+
| `utxo_hd_flavor` | `--utxo-hd-flavor` | - | - | UTxO-HD flavor to convert the ledger snapshot to (`Legacy`, `LMDB` or `LSM`) | - | - | :heavy_check_mark: |
865867
| `commit` | `--commit` | - | - | Replaces the current ledger state in the `db_directory`. | `false` | - | - |
866868
| `github_token` | `--github-token` | - | `GITHUB_TOKEN` | GitHub token for authenticated API calls | - | - | - |
867869
| `run_mode` | `--run-mode` | - | `RUN_MODE` | Run Mode | `dev` | - | - |

0 commit comments

Comments
 (0)