Skip to content

Commit c07f297

Browse files
authored
Merge pull request #1158 from NeilBurgess42/ECS-3156-glossary
ECS-3156 Review glossary. Adjust capitalization and bolding.
2 parents bbb995c + c5cce2a commit c07f297

File tree

1 file changed

+45
-45
lines changed

1 file changed

+45
-45
lines changed

docs/website/root/glossary.md

Lines changed: 45 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -4,100 +4,100 @@ sidebar_position: 1
44

55
# Glossary
66

7-
Here is a comprehensive list of definitions for some common terms used in this guide.
7+
Below is a comprehensive list of definitions for some common terms used in the Mithril guide.
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, and the associated [**epoch**](#epoch) and [**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 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).
1212

13-
## Cardano Network
13+
## Cardano network
1414

15-
The **Cardano Network** is a **Proof-of-Stake** Blockchain platform that supports the ADA cryptocurrency.
15+
The Cardano network is a proof-of-stake blockchain platform that supports the ada cryptocurrency.
1616

17-
> More information is available [here](https://docs.cardano.org/introduction)
17+
> More information is available on the [introduction page](https://docs.cardano.org/introduction).
1818
19-
## Cardano Node
19+
## Cardano node
2020

21-
A **Cardano Node** is a node that runs in a [**Cardano Network**](#cardano-network). There are several types of nodes, among them are **Cardano Full Nodes** that hold a copy of the whole Blockchain. They can be used by **Wallets**, [**Stake Pool Operator**](#stake-pool-operator-spo), **Exchanges** or **Dapps**. One of the use cases of the [**Mithril Network**](#mithril-network) is to bootsrap rapidly a **Cardano Full Node**.
21+
A Cardano node is a node that runs in a [Cardano network](#cardano-network). There are several types of nodes, among them Cardano full nodes that hold a copy of the whole blockchain. They can be used by wallets, [stake pool operators](#stake-pool-operator-spo), exchanges or DApps. One of the uses of the [Mithril network](#mithril-network) is to rapidly bootstrap a Cardano full node.
2222

23-
## Cardano Key Pair
23+
## Cardano key pair
2424

25-
A **Cardano Key Pair** is an asymmetric key pair used to identify a [**Stake Pool Operator**](#stake-pool-operator-spo) on the [**Cardano Network**](#cardano-network).
25+
A Cardano key pair is an asymmetric key pair used to identify a [stake pool operator](#stake-pool-operator-spo) on the [Cardano network](#cardano-network).
2626

2727
## Certificate
2828

29-
The **Mithril Aggregator** combines the produced [**multi signature**](#multi-signature) and some metadata into a [**Mithril Certificate**](#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.
29+
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.
3030

31-
> More information is available [here](./mithril/mithril-protocol/certificates.md)
31+
> More information is available on the [certificates page](./mithril/mithril-protocol/certificates.md).
3232
3333
## Epoch
3434

35-
The [**Cardano Network**](#cardano-network) uses **Epochs** to group blocks computed in a certain amount of time (approximately 5 days). It is part of the design of its **Proof-of-Stake** consensus **Ouroboros**. At the end of each epoch, the [**stake distribution**](#stake-distribution) of the ending epoch is computed.
35+
The [Cardano network](#cardano-network) uses epochs to group blocks computed in a certain amount of time (approximately five days). It is part of the design of its proof-of-stake consensus Ouroboros. At the end of each epoch, the [stake distribution](#stake-distribution) of the ending epoch is computed.
3636

37-
## Immutable File Number
37+
## Immutable file number
3838

39-
Inside a the database of a [**Cardano Node**](#cardano-node), the Blockchain state is stored in **Immutable files** which never change once committed. These immutable files are designed so that they are deterministically produced and thus are the same on any **Cardano Node**. These files are created by following an incremental number, the **Immutable File Number** and there are three different immutable files for each number (i.e. _chunk_, _primary_ and _secondary_). Only the files up to the penultimate **Immutable File Number** are considered as committed and final, the last **Immutable File Number** files are constantly evolving. The [**Snapshots**](#snapshot) produced by the [**Mithril Network**](#mithril-network) rely on these **immutable files**.
39+
Inside the database of a [Cardano node](#cardano-node), the blockchain state is stored in immutable files which never change once committed. These immutable files are designed so that they are deterministically produced and thus are the same on any Cardano node. These files are created by following an incremental number, the immutable file number, and there are three different immutable files for each number (ie, _chunk_, _primary_, and _secondary_). Only the files up to the penultimate immutable file number are considered as committed and final, the last immutable file number files are constantly evolving. The [snapshots](#snapshot) produced by the [Mithril network](#mithril-network) rely on these immutable files.
4040

41-
## Individual Signature
41+
## Individual signature
4242

43-
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** in order to create an [**Individual Signature**](#individual-signature). Upon winning one or multiple lotteries, the **Mithril Signer** will be able to use this **Individual Signature** to participate in the creation of a [**Multi Signature**](#multi-signature).
43+
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).
4444

45-
> More information is available [here](./mithril/mithril-protocol/protocol.md)
45+
> More information is available on the [protocol page](./mithril/mithril-protocol/protocol.md).
4646
47-
## Mithril Aggregator
47+
## Mithril aggregator
4848

49-
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 that gathers their [**individual signatures**](#individual-signature) to produce [**Mithril multi signatures**](#multi-signature) and their associated [**certificates**](#certificate).
49+
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).
5050

51-
It is also in charge of creating and storing the [**snapshot**](#snapshot) archive.
51+
It is also in charge of creating and storing the [snapshot](#snapshot) archive.
5252

53-
> More information is available [here](./mithril/mithril-network/aggregator.md)
53+
> More information is available on the [aggregator page](./mithril/mithril-network/aggregator.md).
5454
55-
## Mithril Client
55+
## Mithril client
5656

57-
The **Mithril Client** node of 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), its [**certificate**](#certificate) chain and by verifying their validity thanks to the Mithril cryptographic primitives.
57+
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.
5858

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

63-
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).
63+
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).
6464

65-
> More information is available [here](./mithril/mithril-network/architecture.md)
65+
> More information is available on the [architecture page](./mithril/mithril-network/architecture.md).
6666
67-
## Mithril Protocol
67+
## Mithril protocol
6868

69-
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 stakes.
69+
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.
7070

71-
> More information is available [here](./mithril/mithril-protocol/protocol.md)
71+
> More information is on the [protocol page](./mithril/mithril-protocol/protocol.md).
7272
73-
## Mithril Signer
73+
## Mithril signer
7474

75-
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.
75+
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.
7676

77-
> More information is available [here](./mithril/mithril-network/signer.md)
77+
> More information is available on the [signer page](./mithril/mithril-network/signer.md).
7878
79-
## Multi Signature
79+
## Multi-signature
8080

81-
The **Mithril Multi Signature** is an aggregate of [**Individual Signatures**](#individual-signature) which guarantees that a minimum share of the total stakes has participated in its creation.
81+
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.
8282

83-
> More information is available [here](./mithril/mithril-protocol/protocol.md)
83+
> More information is available on the [protocol page](./mithril/mithril-protocol/protocol.md).
8484
8585
## Snapshot
8686

87-
A Mithril Snapshot is a signed archive of the Blockchain state that can be used by [**Mithril Clients**](#mithril-client) to restore a [**Cardano Full Node**](#cardano-node). It is uniquely identified by its fingerprint or **Digest** which is part of the message signed by the [**Mithril Network**](#mithril-network).
87+
A Mithril snapshot is a signed archive of the blockchain state that can be used by [Mithril clients](#mithril-client) to restore a [Cardano full node](#cardano-node). It is uniquely identified by its fingerprint or digest which is part of the message signed by the [Mithril network](#mithril-network).
8888

89-
## Stake Distribution
89+
## Stake distribution
9090

91-
The **Cardano Stake Distribution** is the list of all the [**Stake Pool Operators**](#stake-pool-operator-spo) **Pool Id** addresses and their associated **Stakes Share** of the total **Stakes** of the [**Cardano Network**](#cardano-network).
91+
The Cardano stake distribution is the list of all the [stake pool operators'](#stake-pool-operator-spo) pool Id addresses and their associated share of the total stake of the [Cardano network](#cardano-network).
9292

93-
The **Mithril Stake Distribution** is the list of all the [**Stake Pool Operators**](#stake-pool-operator-spo) (that are running a [**Mithril Signer**](#mithril-signer)) **Pool Id** addresses, their associated **Stakes Share** of the total **Stakes** of the [**Cardano Network**](#cardano-network), and their signing [**Verification Key**](#verification-key).
93+
The Mithril stake distribution is the list of all the [stake pool operators'](#stake-pool-operator-spo) (that are running a [Mithril signer](#mithril-signer)) pool Id addresses, their associated share of the total stake of the [Cardano network](#cardano-network), and their signing [verification key](#verification-key).
9494

95-
## Stake Pool Operator (SPO)
95+
## Stake pool operator (SPO)
9696

97-
A **Stake Pool Operator**, also known as a **SPO**, represents a party that holds (via delegation) **Stakes** in the [**Cardano Network**](#cardano-network). The stakes entitle it to participate in the block production thanks to the Cardano consensus mechanism.
97+
A stake pool operator, also known as an SPO, represents a party that holds (via delegation) stake in the [Cardano network](#cardano-network). The stake entitles it to participate in block production thanks to the Cardano consensus mechanism.
9898

99-
## Verification Key
99+
## Verification key
100100

101-
In order to create [**Individual Signatures**](#individual-signature), the [**Mithril Signers**](#mithril-signer) must register their signing public key: the **Verification Keys**. To garantee 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** in order to produce valid **Individual Signatures**.
101+
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.
102102

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

0 commit comments

Comments
 (0)