Skip to content

Commit

Permalink
docs(glossary): Added glossary page
Browse files Browse the repository at this point in the history
  • Loading branch information
serg-temchenko committed Jun 5, 2024
1 parent 9384b7a commit 1d89832
Showing 1 changed file with 152 additions and 0 deletions.
152 changes: 152 additions & 0 deletions docs/glossary.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,152 @@
# Glossary and Anti-Glossary

This document provides definitions and explanations for terms used throughout the project, as well as a list of terms
that should not be used.

## Table of Contents

- [Glossary](#glossary)
- [Storage User](#storage-user)
- [Storage Provider](#storage-provider)
- [Node](#node)
- [Full Node](#full-node)
- [Polkadot](#polkadot)
- [Relay Chain](#relay-chain)
- [Parachain](#parachain)
- [System Parachain](#system-parachain)
- [Actor](#actor)
- [Collator](#collator)
- [Collateral](#collateral)
- [Slashing](#slashing)
- [Staking](#staking)
- [Slot Auction](#slot-auction)
- [Crowdloan](#crowdloan)
- [Anti-Glossary](#anti-glossary)
- [Miner](#term-to-avoid-miner)
- [Pledge](#term-to-avoid-pledge)

## Glossary

This section lists terms used throughout the project.

### Storage User

**_Aka Client:_** The user who initiates storage deals by providing data to be stored on the network by the [Storage
Provider](#storage-provider).

### Storage Provider

The user who offers storage space on their devices to store data for others.

### Node

A device (computer) that participates in running the protocol software of a decentralized network; in other words, a
participant of the blockchain network who runs it locally.

### Full Node

A device (computer) that fully downloads and stores the entire blockchain of the parachain, validating and relaying
transactions and blocks within the network. It is one of the [node](#node) types.

### Polkadot

“Layer-0” blockchain platform designed to facilitate interoperability, scalability and security among different
“Layer-1” blockchains, called [parachains](#parachain).

### Relay Chain

The Relay Chain in [Polkadot](#polkadot) is the central chain (blockchain) responsible for the network's shared
security, consensus, and cross-chain interoperability.

### Parachain

A parachain is a specialized blockchain that runs in parallel to other parachains within a larger network, benefiting
from shared security and interoperability, and can be validated by the validators of the [Relay Chain](#relay-chain).

### System Parachain

System-level chains move functionality from the [Relay Chain](#relay-chain) into [parachains](#parachain), minimizing
the administrative use of the [Relay Chain](#relay-chain). For example, a governance [parachain](#parachain) could move
all the [Polkadot](#polkadot) governance processes from the [Relay Chain](#relay-chain) into a [parachain](#parachain).

### Actor

In [Filecoin](https://docs.filecoin.io), an [actor](https://spec.filecoin.io/#section-glossary.actor) is an on-chain
object with its own state and set of methods.
[Actors](https://docs.filecoin.io/reference/built-in-actors#types-of-built-in-actors) define how
the [Filecoin](https://docs.filecoin.io) network manages and updates global state.

### Collator

Collators maintain [parachains](#parachain) by collecting [parachain](#parachain) transactions from users and producing
state transition proofs for [Relay Chain](#relay-chain) validators. In other words, collators maintain
[parachains](#parachain) by aggregating [parachain](#parachain) transactions into [parachain](#parachain) block
candidates and producing state transition proofs (Proof-of-Validity, PoV) for validators. They need to provide a
financial commitment ([collateral](#collateral)) to ensure they are incentivized to perform their duties correctly and
to dissuade malicious behavior.

### Collateral

Collaterals are assets that are locked up or deposited as a form of security to mitigate risks and ensure the
performance of certain actions. Collateral acts as a guarantee that an individual will fulfill their obligations.
Failing to meet obligations or behaving maliciously can result in the loss of staked assets or collateral as a penalty
for non-compliance or misconduct by [slashing](#slashing).

### Slashing

The process of penalizing network participants, including validators, nominators, and collators, for various protocol
violations. These violations could include producing invalid blocks, equivocation (double signing), or other malicious
activities. As a result of slashing, participants may face a reduction in their [staked](#staking) funds or other
penalties depending on the severity of the violation.

### Staking

Staking is the process where DOT holders lock up their tokens to support the network's security and operations. In
return, they can earn rewards. There are two main roles involved in staking:

- **Validators**: Validators are responsible for producing new blocks, validating transactions, and securing the
network. They are selected based on their stake and performance. Validators need to run a [node](#node) and have the
technical capability to maintain it.

- **Nominators**: Nominators support the network by backing (nominating) validators they trust with their DOT tokens.
Nominators share in the rewards earned by the validators they support. This allows DOT holders who don't want to run a
validator node to still participate in the network's security and earn rewards.

Our parachain will use staking to back up the [collators](#collator) in a similar way as "Nominators" do.

### Slot Auction

To secure a [parachain](#parachain) slot, a project must win an auction by [pledging](#term-to-avoid-pledge) (locking
up) a significant amount of DOT tokens. These tokens are used as [collateral](#collateral) to secure the slot for a
specified period. Once the slot is secured, the project can launch and operate its [parachain](#parachain).

### Crowdloan

Projects can raise DOT tokens from the community through crowdloans. Participants pledge their DOT tokens to help the
project win a parachain slot auction. If successful, the tokens are locked up for the duration of the parachain lease,
and participants might receive rewards or tokens from the project in return.

## Anti-Glossary

This section lists terms that should not be used within the project, along with preferred alternatives.

### Term to Avoid: Miner

In [Filecoin](https://docs.filecoin.io), a "Lotus Miner" is responsible for storage-related operations, such as sealing
sectors ([PoRep (Proof-of-Replication)](https://spec.filecoin.io/#section-algorithms.pos.porep)), proving storage
([PoSt (Proof-of-Spacetime)](https://spec.filecoin.io/#section-algorithms.pos.post)), and participating in
the [Filecoin](https://docs.filecoin.io/) network as a storage miner.

**Reason**: In the [Filecoin](https://docs.filecoin.io) network, the miner plays the roles of both
[storage provider](#storage-provider) and block producer simultaneously. However, in the [Polkadot](#polkadot)
ecosystem, this term cannot be used because there are no block producers in [parachains](#parachain);
the [Relay Chain](#relay-chain) is responsible for block production. [Parachains](#parachain) can only prepare block
candidates via the [Collator](#collator) node and pass them to the [Relay Chain](#relay-chain).

### Term to Avoid: Pledge

It's better to apply this term within its proper context rather than avoiding it altogether. It's easy to confuse it
with [staking](#staking), but they have distinct meanings.

**Reason**: Pledging generally refers to locking up tokens as [collateral](#collateral) to participate in certain
network activities or services like: [Parachain Slot Auctions](#slot-auction) and [Crowdloans](#crowdloan).

0 comments on commit 1d89832

Please sign in to comment.