Skip to content

Commit 5e200cd

Browse files
committed
docs: rotate current version
By running 'make update-current' command.
1 parent 4a2b566 commit 5e200cd

37 files changed

+515
-354
lines changed

docs/website/versioned_docs/version-maintained/glossary.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Below is a comprehensive list of definitions for some common terms used in the M
88

99
## Beacon
1010

11-
A beacon represents a point of the blockchain for which a [Mithril certificate](#certificate) is created. It embeds at least the version of the [Cardano network](#cardano-network) that is targeted, the associated [epoch](#epoch), and the [immutable file number](#immutable-file-number).
11+
A beacon represents a point of the blockchain for which a [Mithril certificate](#certificate) is created. It embeds the [epoch](#epoch) of the [Cardano network](#cardano-network) that is targeted, and either the block number or the [immutable file number](#immutable-file-number).
1212

1313
## Cardano network
1414

@@ -34,7 +34,7 @@ A Cardano transactions set snapshot represents, in a succinct way, the Cardano t
3434

3535
The Mithril aggregator combines the produced [multi-signature](#multi-signature) and some metadata into a Mithril certificate that will be later used by the [Mithril client](#mithril-client) to verify the authenticity of a [snapshot](#snapshot). The certificates are chained so that the [stake distribution](#stake-distribution) used to create the signatures is verifiably genuine.
3636

37-
> More information is available on the [certificates page](./mithril/mithril-protocol/certificates.md).
37+
> More information is available on the [certificates page](./mithril/advanced/mithril-protocol/certificates.md).
3838
3939
## Epoch
4040

@@ -48,45 +48,45 @@ Inside the database of a [Cardano node](#cardano-node), the blockchain state is
4848

4949
For each [beacon](#beacon), the [Mithril signers](#mithril-signer) will compute on their end a message representing the blockchain state, and sign it with their verification keys to create an [individual signature](#individual-signature). Upon winning one or more lotteries, the Mithril signer will be able to use this individual signature to participate in the creation of a [multi-signature](#multi-signature).
5050

51-
> More information is available on the [protocol page](./mithril/mithril-protocol/protocol.md).
51+
> More information is available on the [protocol page](./mithril/advanced/mithril-protocol/protocol.md).
5252
5353
## Mithril aggregator
5454

5555
The Mithril aggregator is a trustless node of the [Mithril network](#mithril-network) that orchestrates the work of the [Mithril signer](#mithril-signer) nodes and gathers their [individual signatures](#individual-signature) to produce [Mithril multi-signatures](#multi-signature) and their associated [certificates](#certificate).
5656

5757
It is also in charge of creating and storing the [snapshot](#snapshot) archive.
5858

59-
> More information is available on the [aggregator page](./mithril/mithril-network/aggregator.md).
59+
> More information is available on the [aggregator page](./mithril/advanced/mithril-network/aggregator.md).
6060
6161
## Mithril client
6262

6363
The Mithril client node within the [Mithril network](#mithril-network) is used to restore a [Cardano full node](#cardano-node) by retrieving, from a [Mithril aggregator](#mithril-aggregator), a remote [snapshot](#snapshot) and its [certificate](#certificate) chain. Finally, it is used to verify snapshot and certificate validity using the Mithril cryptographic primitives.
6464

65-
> More information is available on the [client page](./mithril/mithril-network/client.md).
65+
> More information is available on the [client page](./mithril/advanced/mithril-network/client.md).
6666
6767
## Mithril network
6868

6969
In its current version, the Mithril network is a network of nodes responsible for creating [snapshots](#snapshot) and [certificates](#certificate) that enable fast bootstrap of a [Cardano node](#cardano-node). It runs on top of the [Cardano network](#cardano-network).
7070

71-
> More information is available on the [architecture page](./mithril/mithril-network/architecture.md).
71+
> More information is available on the [architecture page](./mithril/advanced/mithril-network/architecture.md).
7272
7373
## Mithril protocol
7474

7575
The Mithril protocol allows stakeholders in a proof-of-stake blockchain network to individually sign messages that are aggregated into a multi-signature which guarantees that they represent a minimum share of the total stake.
7676

77-
> More information is on the [protocol page](./mithril/mithril-protocol/protocol.md).
77+
> More information is on the [protocol page](./mithril/advanced/mithril-protocol/protocol.md).
7878
7979
## Mithril signer
8080

8181
The Mithril signer is a node of the [Mithril network](#mithril-network) that works transparently on top of the [stake pool operator](#stake-pool-operator-spo) Cardano nodes and which individually signs the ledger state.
8282

83-
> More information is available on the [signer page](./mithril/mithril-network/signer.md).
83+
> More information is available on the [signer page](./mithril/advanced/mithril-network/signer.md).
8484
8585
## Multi-signature
8686

8787
The Mithril multi-signature is an aggregate of [individual signatures](#individual-signature), which guarantees that a minimum share of the total stake has participated in its creation.
8888

89-
> More information is available on the [protocol page](./mithril/mithril-protocol/protocol.md).
89+
> More information is available on the [protocol page](./mithril/advanced/mithril-protocol/protocol.md).
9090
9191
## Snapshot
9292

@@ -106,4 +106,4 @@ A stake pool operator, also known as an SPO, represents a party that holds (via
106106

107107
To create [individual signatures](#individual-signature), [Mithril signers](#mithril-signer) must register their signing public key: the verification key. To guarantee their genuineness, they are signed by the associated [Cardano key pair](#cardano-key-pair). It is worth mentioning that a [Mithril signer](#mithril-signer) must be aware of the verification keys of all the other Mithril signers to produce valid individual signatures.
108108

109-
> More information is available on the [protocol page](./mithril/mithril-protocol/protocol.md).
109+
> More information is available on the [protocol page](./mithril/advanced/mithril-protocol/protocol.md).

docs/website/versioned_docs/version-maintained/manual/develop/README.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,6 @@ This node verifies and restores a snapshot along with other types of data, facil
2222

2323
:::tip
2424

25-
For more information about the Mithril protocol, refer to the [about Mithril](../../mithril/mithril-protocol/protocol.md) section.
25+
For more information about the Mithril protocol, refer to the [about Mithril](../../mithril/advanced/mithril-protocol/protocol.md) section.
2626

2727
:::

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

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ Mithril aggregator is responsible for collecting individual signatures from the
1414

1515
:::tip
1616

17-
- For more information about the **Mithril network**, please see the [architecture](../../../mithril/mithril-network/architecture.md) overview
17+
- For more information about the **Mithril network**, please see the [architecture](../../../mithril/advanced/mithril-network/architecture.md) overview
1818

19-
- For more information about the **Mithril aggregator**, please see the [aggregator node](../../../mithril/mithril-network/aggregator.md) overview.
19+
- For more information about the **Mithril aggregator**, please see the [aggregator node](../../../mithril/advanced/mithril-network/aggregator.md) overview.
2020

2121
:::
2222

@@ -398,6 +398,7 @@ Here are the available subcommands:
398398
| **genesis sign** | Signs the genesis payload with the genesis secret key |
399399
| **genesis import** | Imports the genesis signature (the payload signed with the genesis secret key) and creates and imports a genesis certificate in the store |
400400
| **genesis bootstrap** | Bootstraps a genesis certificate (test only usage) |
401+
| **genesis generate-keypair** | Generates a genesis keypair |
401402
| **era list** | Lists the supported eras |
402403
| **era generate-tx-datum** | Generates the era markers transaction datum to be stored on-chain |
403404
| **tools recompute-certificates-hash** | Loads all certificates in the database, recomputing their hash, and updating all related entities |
@@ -483,6 +484,12 @@ Here is a list of the available parameters:
483484
| `target_signed_payload_path` | `--target-signed-payload-path` | - | - | Path of the signed payload to export. | - | - | - |
484485
| `genesis_secret_key_path` | `--genesis-secret-key-path` | - | - | Path of the genesis secret key. | - | - | - |
485486

487+
`genesis generate-keypair` command:
488+
489+
| Parameter | Command line (long) | Command line (short) | Environment variable | Description | Default value | Example | Mandatory |
490+
| ------------- | ------------------- | :------------------: | -------------------- | ------------------------------------- | ------------- | ------- | :----------------: |
491+
| `target_path` | `--target-path` | - | - | Target path for the generated keypair | - | - | :heavy_check_mark: |
492+
486493
`era list` command:
487494

488495
| Parameter | Command line (long) | Command line (short) | Environment variable | Description | Default value | Example | Mandatory |

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ It is responsible for handling the different types of data certified by Mithril
2020

2121
:::tip
2222

23-
- For more information about the **Mithril network**, please see the [architecture](../../../mithril/mithril-network/architecture.md) overview.
23+
- For more information about the **Mithril network**, please see the [architecture](../../../mithril/advanced/mithril-network/architecture.md) overview.
2424

2525
:::
2626

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@ It is responsible for handling the different types of data certified by Mithril
2020

2121
:::tip
2222

23-
- For more information about the **Mithril network**, please see the [architecture](../../../mithril/mithril-network/architecture.md) overview
23+
- For more information about the **Mithril network**, please see the [architecture](../../../mithril/advanced/mithril-network/architecture.md) overview
2424

25-
- For more information about the **Mithril client** node, please see [this overview](../../../mithril/mithril-network/client.md)
25+
- For more information about the **Mithril client** node, please see [this overview](../../../mithril/advanced/mithril-network/client.md)
2626

2727
- Check out the [`Bootstrap a Cardano node`](../../getting-started/bootstrap-cardano-node.md) guide.
2828

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,10 @@ Mithril client is responsible for restoring the **Cardano** blockchain on an emp
1515
:::tip
1616

1717
- For more information about the **Mithril network**, please see
18-
the [architecture](../../../mithril/mithril-network/architecture.md) overview
18+
the [architecture](../../../mithril/advanced/mithril-network/architecture.md) overview
1919

2020
- For more information about the **Mithril client** node, please
21-
see [this overview](../../../mithril/mithril-network/client.md)
21+
see [this overview](../../../mithril/advanced/mithril-network/client.md)
2222

2323
- Check out the [`Bootstrap a Cardano node`](../../getting-started/bootstrap-cardano-node.md) guide.
2424

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ Mithril signer is responsible for producing individual signatures that are colle
1414

1515
:::tip
1616

17-
- For more information about the **Mithril network**, please see the [architecture](../../../mithril/mithril-network/architecture.md) overview
17+
- For more information about the **Mithril network**, please see the [architecture](../../../mithril/advanced/mithril-network/architecture.md) overview
1818

19-
- For more information about the **Mithril signer** node, please see [this overview](../../../mithril/mithril-network/signer.md)
19+
- For more information about the **Mithril signer** node, please see [this overview](../../../mithril/advanced/mithril-network/signer.md)
2020

2121
- Check out the [`Run a Mithril signer node`](../../operate/run-signer-node.md) guide.
2222

docs/website/versioned_docs/version-maintained/manual/develop/protocol-simulation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -294,6 +294,6 @@ Party #0: aggregate signature not found 7724e03fb8d84a376a43b8f41518a11c
294294
295295
:::tip
296296
297-
For more information about the Mithril protocol, refer to the [about Mithril](../../mithril/mithril-protocol/protocol.md) section.
297+
For more information about the Mithril protocol, refer to the [about Mithril](../../mithril/advanced/mithril-protocol/protocol.md) section.
298298
299299
:::

0 commit comments

Comments
 (0)