Skip to content

Commit

Permalink
Merge branch 'main' into mip-crosschain-bridges-background
Browse files Browse the repository at this point in the history
  • Loading branch information
apenzk authored Jan 17, 2025
2 parents d0037b2 + a53539f commit cda8a95
Show file tree
Hide file tree
Showing 28 changed files with 2,360 additions and 204 deletions.
12 changes: 4 additions & 8 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -1,20 +1,16 @@
# Reviewers that should be generally notified.
* @l-monninger
* @andyjsbell
* @apenzk

# Authors and reviewers that should be added for specific files
/MIP/mip-0/ @l-monninger @apenzk
/MD/md-0/ @l-monninger @apenzk
/MG/mg-0/ @l-monninger @apenzk

/MIP/mip1/ @l-monninger

/MIP/mip-1/ @l-monninger
/MD/md-3/ @l-monninger

/MIP/mip-15/ @l-monninger @apenzk
/MD/md-15/ @l-monninger @apenzk

/MIP/mip-39/ @franck44
/MIP/mip-53/ @l-monninger

/MIP/mip-60/ @franck44 @apenzk
/MIP/mip-58/ @primata @apenzk
/MIP/mip-60/ @franck44 @apenzk
44 changes: 44 additions & 0 deletions .github/workflows/mipbook.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
name: Build mipBook

on:
push:
branches:
- '*'
pull_request:
branches:
- '*'

env:
MIPBOOK_VERSION: 0.4.43

jobs:
build:
runs-on: ubuntu-latest
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
permissions:
contents: write
pull-requests: read
steps:
- name: Checkout new repo
uses: actions/checkout@v3

- name: Install Dependencies
run: |
sudo apt-get update
sudo apt-get install -y jq curl
- name: Install mipbook
run: |
mkdir mipbook
curl -Lf https://github.com/rust-lang/mdBook/releases/download/v${{ env.MIPBOOK_VERSION }}/mdbook-v${{ env.MIPBOOK_VERSION }}-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=./mipbook
echo `pwd`/mipbook >> $GITHUB_PATH
- name: Generate Book
run: ./generate_book.sh

- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./book
3 changes: 2 additions & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
{
"stm32-for-vscode.openOCDPath": false,
"stm32-for-vscode.armToolchainPath": false
"stm32-for-vscode.armToolchainPath": false,
"spellright.userDictionary": "${workspaceFolder}/.vscode/spellright.dict"
}
5 changes: 5 additions & 0 deletions .vscode/spellright.dict
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Fastconfirmation
multisig
timelock
timelocks
trustlessness
14 changes: 11 additions & 3 deletions GLOSSARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@

Alphabetically ordered list of terms defined through MGs.

| Term | Short Definition | #MG |
|---------------|--------------------------------|-------------------------------------------------------------------------------------------------------|
| | | |
**\$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**
wrapped version of the \$L1MOVE token. > [MG-39](./MG/mg-39/README.md)

**\$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**
The bridge that allows the transfer of tokens between L1 and L2, which hold \$L1MOVE and \$L2MOVE token, respectively. The native bridge has the capability to mint \$L2MOVE tokens. > [MG-39](./MG/mg-39/README.md)
51 changes: 6 additions & 45 deletions MD/md-0/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,8 @@
- **Description**: Provide formal structure for proposing non-trivial improvements to Movement.
- **Authors**: [Liam Monninger](mailto:[email protected])


<!--
This template is for drafting Desiderata. It ensures a structured representation of wishes, requirements, or needs related to the overarching objective mentioned in the title. After filling in the requisite fields, please delete these comments.
Note that an MD number will be assigned by an editor. When opening a pull request to submit your MD, please use an abbreviated title in the filename, `md-draft_title_abbrev.md`.
TODO: Remove this comment before finalizing.
-->

## Overview

Provide formal structure for proposing non-trivial improvements to Movement. This should be used for specifying complex changes to Movement technologies--particularly those that may require third-parties to adjust their usage of said technologies.

## Definitions
Expand All @@ -20,51 +12,20 @@ Provide definitions that you think will empower the reader to quickly dive into

## Desiderata

<!--
List out the specific desiderata. Each entry should consist of:
1. Title: A concise name for the desideratum.
2. User Journey: A one or two-sentence statement focusing on the "user" (could be a human, machine, software, etc.) and their interaction or experience.
3. Description (optional): A more detailed explanation if needed.
4. Justification: The reasoning behind the desideratum. Why is it necessary or desired?
5. Recommendations (optional): Suggestions or guidance related to the desideratum.
Format as:
### Desideratum Title
**User Journey**: [user] can [action].
**Description**: <More detailed explanation if needed (optional)>
**Justification**: <Why this is a significant or required desideratum>
**Guidance and suggestions**: <Any specific guidance or suggestions (optional)>
TODO: Remove this comment before finalizing.
-->
### D1: Draft and publish standardized proposals

**User Journey**: Proposer/Researcher can adhere to a standardized template for proposing changes to Movement technologies.

**Justification**: Offering a standardized means for researching a proposing changes to Movement technologies will help guide research both in written structure and by facilitating engagment. The likelihood of producing successful proposals from such a structure should be expected to be higher than otherwise.
**Justification**: Offering a standardized means for researching a proposing changes to Movement technologies will help guide research both in written structure and by facilitating engagement. The likelihood of producing successful proposals from such a structure should be expected to be higher than otherwise.

### D2: Implement against clear and accountable specifications

**User Journey**: Developers can confidently implement complex systems against a clear and accountable specification.

**Justification**: The standardization and review process should produce clearer specifications. The contributors responsible for these specifications should be--encouraging higher quality.

**Guidance and suggestions**:
- As referenced above, the formalized proposals supported by the desired process should be reserved for changes to Movement technologies that are of the highest complexity and quality. Otherwise, the effort of the standardization will likely be counterproductive.

## Errata
<!--
Errata should be maintained after publication.
1. **Transparency and Clarity**: An erratum acknowledges any corrections made post-publication, ensuring that readers are not misled and are always equipped with the most accurate information.

2. **Accountability**: By noting errors openly, we maintain a high level of responsibility and ownership over our content. It’s an affirmation that we value precision and are ready to correct oversights.
Each erratum should briefly describe the discrepancy and the correction made, accompanied by a reference to the date and version of the desiderata in which the error was identified.
- As referenced above, the formalized proposals supported by the desired process should be reserved for changes to Movement technologies that are of the highest complexity and quality. Otherwise, the effort of the standardization will likely be counterproductive.

TODO: Maintain this comment.
-->
## Changelog
13 changes: 1 addition & 12 deletions MD/md-15/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,15 +48,4 @@ In order to communicate with more specificity in all contexts, Movement Labs sho
**Recommendations**:
- MD can also introduce MG to further aid in clarity, but they will not be ratified until they have been supported in an MIP.

## Errata
<!--
Errata should be maintained after publication.
1. **Transparency and Clarity**: An erratum acknowledges any corrections made post-publication, ensuring that readers are not misled and are always equipped with the most accurate information.
2. **Accountability**: By noting errors openly, we maintain a high level of responsibility and ownership over our content. It’s an affirmation that we value precision and are ready to correct oversights.
Each erratum should briefly describe the discrepancy and the correction made, accompanied by a reference to the date and version of the desiderata in which the error was identified.
TODO: Maintain this comment.
-->
## Changelog
13 changes: 1 addition & 12 deletions MD/md-3/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,15 +67,4 @@ These and other phenomena are listed in the desiderata below.
**Recommendations**:
- Start by reviewing the [Asynchronous Upgrades, Fork Creation, and Fork Stake Problems](./asychronous-upgrades-problem.md).

## Errata
<!--
Errata should be maintained after publication.
1. **Transparency and Clarity**: An erratum acknowledges any corrections made post-publication, ensuring that readers are not misled and are always equipped with the most accurate information.
2. **Accountability**: By noting errors openly, we maintain a high level of responsibility and ownership over our content. It’s an affirmation that we value precision and are ready to correct oversights.
Each erratum should briefly describe the discrepancy and the correction made, accompanied by a reference to the date and version of the desiderata in which the error was identified.
TODO: Maintain this comment.
-->
## Changelog
16 changes: 5 additions & 11 deletions MG/mg-0/README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,15 @@
# MG-0: gloss
# MG-0: Gloss Example

- **Authors**: [Liam Monninger]([email protected])

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
<!--
Document any post-publication corrections to the glossary entry.
-->
### Changelog
21 changes: 21 additions & 0 deletions MG/mg-39/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# MG-39: MOVE Token -- Bridge Design
- **Authors**: [Franck Cassez](mailto:[email protected])


### `$MOVE`

see [MIP-39](../../MIP/mip-39/README.mde)


### `$L1MOVE`

see [MIP-39](../../MIP/mip-39/README.mde)


### `$L2MOVE`

see [MIP-39](../../MIP/mip-39/README.mde)

### Native Bridge

see [MIP-39](../../MIP/mip-39/README.mde)
Loading

0 comments on commit cda8a95

Please sign in to comment.