Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[update] definition of glossary and MG #45

Open
wants to merge 14 commits into
base: main
Choose a base branch
from
60 changes: 60 additions & 0 deletions GLOSSARY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
# Glossary

Alphabetically ordered list of terms used in this repository.

**Blob**
The set of transactions that is sent to the the DA before transactions are ordered.

**Block**
More common term for L2Block. May be mixed up with the batch of transactions sent to the sequencer, the L1Block or with the batch of L2Blocks that should be processed by the L1-contract. So treat with care.

**Circulating token**
Token that is not locked and in circulation on L1 or L2.

**FFS - Fast Finality Settlement**
The objective of the Fast-Finality-Settlement (FFS) protocol is to confirm that transactions are processed correctly and back this confirmation through crypto-economic security. It does not relate to the ordering of transactions.

**\$GasToken**
Token used to pay for fees on L2. Could be \$L2MOVE.

**Governed Gas Pool**
A token pool on L2 that holds the gas token (\$L2MOVE).

**Informer**
An entity that monitors L1 **and** L2 to understand token supply.

**\$L1MOVE**
ERC-20 type token for the Movement Network with the source contract on L1. See also \$MOVE. > [MG-39](./MG/mg-39/README.md)

**\$L2MOVE**
Native token on L2. Used to pay for L2 gas. > [MG-39](./MG/mg-39/README.md)

**L2Block**
A block of transactions that is processed by the FFS protocol. It contains information about the state root produced by the transactions in the block.

**\$MOVE**
ERC-20 type token for the Movement Network with the source contract on L1. See also \$L1MOVE. > [MG-39](./MG/mg-39/README.md)

**Native Bridge**
Native bridge that permits to exchange of \$L1MOVE into \$L2MOVE, and vice versa. This bridge mints \$L2MOVE.

**Postconfirmation**
The process of confirming a (sequence of) blocks after it has been processed by the FFS protocol on L1.

**Potential token**
Token that could potentially be converted to circulating \$L1MOVE or \$L2MOVE token. A bridge transfer releases the potential token on the target change, while it locks source chain tokens into the potential token.

**Potential total supply**
Total supply plus potential token supply.

**ProtoBlock**
A block of ordered transaction provided by sequencer or DA on L2. No execution applied at this point.

**\$StakingToken**
Token used for staking on L1. Could be \$L1MOVE.

**SuperBlock**
A range of L2Blocks that is processed by the FFS protocol. It contains information about the state root produced by the sequence of L2Blocks in the superBlock.

**Validator**
A validator is a node that participates in the FFS protocol. Validators execute transactions from sequencer-batches and validate their correctness.
11 changes: 9 additions & 2 deletions MG/mg-0/README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,28 @@
# MG-0: gloss
- **Authors**: [Liam Monninger]([email protected])

- **Authors**: [Liam Monninger]([email protected])
- **Introducing Document: [MIP-0](../../MIP/mip-0/README.md)**
A short description of a term as would feature as an entry in a glossary.

## Gloss

A **gloss** is a short description of a term as would feature as an entry in a glossary.

### Related Work

<!--
Enumerate key usages of the term or related terms in other contexts.
-->
1. [Merriam-Webster's Definition of "gloss"](https://www.merriam-webster.com/dictionary/gloss)

### Example Usages

<!--
Provide examples of the term's usage in context.
-->
1. He updated the **gloss** to include a more detailed explanation.

### Errata
### Changelog
<!--
Document any post-publication corrections to the glossary entry.
-->
61 changes: 44 additions & 17 deletions MIP/mip-15/README.md
Original file line number Diff line number Diff line change
@@ -1,48 +1,75 @@
# MIP-15: MG (Movement Gloss)
- **Description**: Introduces the Movement Gloss (MG) document type and establishes a process for introducing new glossary terms. Introduces the [Glossary](../GLOSSARY.md), which contains an overview of all terms defined through MGs.

- **Description**: Terms should be well defined. This is achieved through the [Glossary](https://github.com/movementlabsxyz/MIP/wiki/glossary) and the Movement Gloss (MG) process.
- **Authors**: [Liam Monninger](mailto:[email protected])
- **Reviewer**: Andreas Penzkofer
- **Desiderata**: [MD-15](../MD/md-15/README.md)

## Abstract

This MIP introduces the Movement Gloss (MG) document type and establishes a process for introducing new glossary terms. The MG document type will be used to define terms unique to Movement Labs and to provide specific definitions for terms that are used in a unique way, underspecified in the literature, or have a specific meaning in the context of Movement Labs.
This MIP defines the [Glossary](../GLOSSARY.md), which contains an overview of relevant terms used in this repo. This glossary defines terms that are frequently used.

Furthermore, this MIP introduces the Movement Gloss (MG) document type and establishes a process for introducing new glossary terms. The MG document type will be used to define terms unique to Movement Labs and to provide specific definitions for terms that are used in a unique way, underspecified in the literature, or have a specific meaning in the context of Movement Labs.

## Motivation

In order to communicate with more specificity in all contexts, Movement Labs should introduce a glossary. This glossary should define terms both unique to Movement Labs and general terms that are used in a unique way, underspecified in the literature, or have a specific meaning in the context of Movement Labs.
In order to communicate with more specificity in all contexts, Movement Labs should introduce a glossary. We require alignment of terms across this repository and beyond.

Furthermore, terms may be underspecified in literature, are used in a unique way, or have a specific meaning in the context of Movement Labs. These terms may require additional extensive definition. This necessitates the introduction of the Movement Gloss (MG) document type.

## Specification

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119 and RFC 8174.
> _The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119 and RFC 8174._

### Glossary

The [Glossary](../GLOSSARY.md) is an alphabetically ordered list of terms defined through MGs. Any term introduced through an MG MUST be declared in the Glossary.
The [Glossary](https://github.com/movementlabsxyz/MIP/wiki/glossary) is an alphabetically ordered list of terms that should be defined and may be frequently referenced. The glossary should be a living document that is updated as new terms are introduced or as terms are redefined.

The Glossary file contains:

The Glossary table contains the following columns:
- The Term
- A short definition
- The number of the MG that introduces the term
- (Optional) The number of the MG/MIP/MD that introduces the term.

### MG Document Type
A template for the MG is provided at [mg-template](../../md-template.md). An example MG is provided at [mg-0](../../MG/mg-0/README.md). These templates cover the requested elements listed in [MD-15.D1](../MD/md-15/README.md).
The format is as follows:

### MG Process
1. A new glossary term MUST be defined in an MG document matching the provided templates.
2. An MG document MUST not be accepted unless justified in an MIP.
```markdown
**<Term>**
<Definition> → [MD-x](MD/md-x/README.md), [MG-y](MG/mg-y/README.md)
```

For example, herein, we justify the introduction of [MG-0](../../MG/mg-0/README.md). MG-0 defines the term "gloss" which is used in the context of Movement Labs to denote the definition of a term as would feature as an entry in a glossary. It is important to include in the glossary both clarify as the acronym "MG" and to provide an example gloss.
### MG (Movement Gloss)

## Reference Implementation
See the MG document type template at [mg-template](../../md-template.md) and the example MG at [mg-0](../../MG/mg-0/README.md).
An MG is a definition of a term that requires detailed explanation. Any term introduced through an MG MUST be declared in the Glossary.

A template for the MG is provided at [mg-template](../../md-template.md). The template covers the requested elements listed in [MD-15.D1](../MD/md-15/README.md).

## Verification
An example MG is provided at [mg-0](../../MG/mg-0/README.md).

An MG document MUST not be accepted unless it is required by an MIP or MD. For example, herein, we justify the introduction of [MG-0](../../MG/mg-0/README.md). MG-0 defines the term "gloss" which is used in the context of Movement Labs to denote the definition of a term as would feature as an entry in a glossary. For the MGs, it is important to include in the glossary both clarify as the acronym "MG" and to provide an example gloss.

#### MG Structure

## Errata
**Term**
Definition of the term.

**Related Work**
Enumerate key usages of the term or related terms in other contexts.

**Example Usages**
Provide examples of the term's usage in context.

**Changelog**
Document any post-publication changes to the glossary entry.

## Reference Implementation

See the [Glossary](../../GLOSSARY.md).

See the MG document type template at [mg-template](../../md-template.md) and the example MG at [mg-0](../../MG/mg-0/README.md).

## Verification

## Errata

## Appendix
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@

# MIP, MD and MG

We differentiate between MD and MIPs.
We differentiate between MD and MIP.

An overview of the MIPs and MDs can be found in the [OVERVIEW](https://movementlabsxyz.github.io/MIP/).

In addition MG serves as a glossary for terms defined in the MIPs and MDs.
The [Glossary](https://github.com/movementlabsxyz/MIP/wiki/glossary) contains an alphabetically ordered list of terms used in this repository. In addition MG serves as a platform to define glossary terms, which are used in the MIPs and MDs.

## Movement Desiderata (MD)

Expand Down Expand Up @@ -37,14 +37,14 @@ You **SHOULD NOT** draft an MIP, if any of the following are true:
- You only intend to request a change to software units or processes without overseeing specification and review.
- The change is trivial. In the event that an MIP is required by governance, such trivial changes usually be handled as either errata or appendices of an existing MIP.

## Movement Glossary (MG)
## Glossary and Movement Gloss (MG)

See [MG-0](./MG/mg-0) to get started. A template is provided at [mg-template](mg-template.md).

An alphabetically ordered list of terms is provided in the [glossary](GLOSSARY.md).
An alphabetically ordered list of terms is provided in the [glossary](https://github.com/movementlabsxyz/MIP/wiki/glossary).

MGs serve to capture the **definitions** of terms introduced in the MIPs and MDs. The creation of a new MG requires an MIP or MG (since new terms are introduced through the MIP or MG).

See [MG-0](./MG/mg-0) for an example to get started. A template is provided at [mg-template](mg-template.md).

## Files and numbering

Each MIP, MD or MG is stored in a separate subdirectory with a name `mip-<number>`, `md-<number>` or `mg-<number>`. The subdirectory contains a `README.md` that describes the MIP, MD, or MG. All assets related to the MIP, MD or MG are stored in the same subdirectory.
Expand Down
11 changes: 9 additions & 2 deletions mg-template.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,16 @@
# MG-\<number\>: \<term-in-appropriate-case\>

- **Authors**: [Author](mailto:[email protected])
- **Introducing Document: [MIP/MD-\<number\>](../MIP/mip-\<number\>/README.md)**

## \<Term\>

<!--
Write a concise gloss for the term.
-->

### Related Work

<!--
Enumerate key usages of the term or related terms in other contexts.
-->
Expand All @@ -14,14 +19,16 @@
3. [Reference 3](https://example.com)

### Example Usages

<!--
Provide examples of the term's usage in context.
-->
1. Example 1
2. Example 2
3. Example 3

### Errata
### Changelog

<!--
Document any post-publication corrections to the glossary entry.
Document any post-publication changes to the glossary entry.
-->