Skip to content

Commit

Permalink
apply mip number
Browse files Browse the repository at this point in the history
  • Loading branch information
apenzk committed Jan 13, 2025
1 parent dbc6a67 commit e771dee
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 19 deletions.
2 changes: 2 additions & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,5 @@
/MD/md-15/ @l-monninger @apenzk
/MIP/mip-39/ @franck44
/MIP/mip-53/ @l-monninger
/MD/md-85/ @franck44
/MIP/mip-85/ @franck44
19 changes: 3 additions & 16 deletions MD/md-85/README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,21 @@
# MD-85: Bridge Architecture Requirements

- **Description**: Elicit the requirements of the native bridge.
- **Authors**: [Franck Cassez](mailto:[email protected])


## Overview

This MD summarises the requirements of the _Native Bridge_ (bridge in the sequel).
This MD summarizes the requirements of the _Native Bridge_ (bridge in the sequel).

## Desiderata


### D1: High-level Description of the Native Bridge

**Description**: A high-level diagram of the architecture

**Justification**: Provides a reference for documentation and implementation.

**Recommendations**:
**Recommendations**:

### D2: List the expected functionalities of the bridge

Expand All @@ -30,22 +29,10 @@ This MD summarises the requirements of the _Native Bridge_ (bridge in the sequel

**Justification**: Provides a reference for documentation and implementation and governance.


### D4: Explain how the bridge transfers work

**Description**: Provide sequence diagrams to explain how bridging from Move to Ethereum (and back) works.

**Justification**: Explain the sequence of actions required on the chains and their ordering, to complete a bridge transfer.

## Change Logs
<!--
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.
-->
7 changes: 4 additions & 3 deletions MIP/mip-bridge-archi/README.md → MIP/mip-85/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# MIP-\<number\>: Lock/Mint bridge high-level description.
# MIP-85: Lock/Mint bridge high-level description

- **Description**: Provides a high-level description of the native lock/mint bridge.
- **Authors**: [Frabck Cassez](mailto:[email protected])
- **Desiderata**: [MIP-\<number\>](../MIP/mip-\<number\>)
- **Desiderata**: [MD-85](../../MD/md-85)

<!--
READ MIP-1 BEFORE USING THIS TEMPLATE!
Expand Down Expand Up @@ -35,7 +36,7 @@ This MIP is associated with [MD-85](../../MD/md-85/README.md).
TODO: Remove this comment before finalizing
-->

> [!NOTE]
> [!NOTE]
> 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.

Expand Down

0 comments on commit e771dee

Please sign in to comment.