Skip to content

Commit 267bab5

Browse files
committed
update protocol readmes
1 parent 010f535 commit 267bab5

File tree

4 files changed

+11
-20
lines changed

4 files changed

+11
-20
lines changed

protocol/mcr/README.md

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,9 @@ This directory contains the implementation of the MCR protocol, which handles ro
44

55
## Overview
66

7-
**MCR** implements a staking-based settlement where validators commit L2-blocks on Layer 1 (L1). MCR is responsible for aggregating multiple commitments into a single commitment. It provides:
7+
**MCR** implements a staking-based settlement where validators commit to a state from L2 on Layer 1 (L1). MCR accepts commitments from all staked attesters and aggregates them into a single confirmation. The contracts on L1 tracks block commitments, epochs, stake and rewards.
88

9-
The distinguishing feature is that there is only one type of actor, which is the attester.
10-
11-
Validators stake tokens to participate in block validation. They commit to L2-blocks on L1, and the contract on L1 tracks block commitments, epochs, and stake. The contracts also manage validators and custodian staking and unstaking. The contract validates if commitments have reached two-thirds supermajority stake, and rewards or slashes validators based on their actions.
9+
The distinguishing feature to PCP is that there is only one type of actor, which is the attester.
1210

1311
For further details see the [RFC for MCR](https://github.com/movementlabsxyz/rfcs/pull/29) and the [MIP-34](https://github.com/movementlabsxyz/MIP/blob/main/MIP/mip-34).
1412

@@ -35,11 +33,3 @@ For further details see the [RFC for MCR](https://github.com/movementlabsxyz/rfc
3533
- [`util/`](util/) - Shared utilities
3634
- [`config/`](util/config/) - Configuration management
3735
- [`types/`](util/types/) - Common type definitions
38-
39-
-----
40-
41-
TODO: remove once we have used this content at the correct place
42-
43-
- **Setup**: Prepares local environments or deploys contracts, manages configuration for local and deployment setups, and ensures contract deployment when needed.
44-
- **Runner**: Orchestrates the setup and execution of configuration tasks, applies setup steps, and logs processes for debugging.
45-

protocol/mcr/dlu/README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# Deployed Logic Units (DLU)
2-
DLUs are units of logic that are not generally run within an independent process, but which must be deployed somewhere. Smart contracts are DLU.
32

4-
In this directory, we include DLU and the means via which to deploy them to various environments.
3+
DLUs are units of logic that are not generally run within an independent process, but which must be deployed somewhere. Smart contracts are DLU.
4+
5+
In this directory, we include DLU and the means via which to deploy them to various environments.

protocol/pcp/README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,11 @@ This directory contains the implementation of the PCP protocol, which handles co
44

55
## Overview
66

7-
PCP (Postconfirmation Protocol) is responsible for handling post-confirmation commitment settlement between different parts of the system. It provides:
7+
**PCP** implements a staking-based settlement where validators commit to a state from L2 on Layer 1 (L1). PCP accepts commitments from all staked attesters. A specialized attester - the acceptor - aggregates them into a single confirmation, called a postconfirmation. The contracts on L1 tracks block commitments, epochs, stake and rewards.
88

9-
1. Contract deployment and management
10-
2. Commitment posting and verification
11-
3. Client interfaces for interacting with the protocol
12-
4. Testing and mock implementations
9+
The distinguishing feature to MCR is that there are two types of actors, which are the attesters and the acceptors.
10+
11+
For further details see the [MIP-37](https://github.com/movementlabsxyz/MIP/blob/main/MIP/mip-37).
1312

1413
## Architecture
1514

sdk/cli/ffs-client/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
# `ffs-client`
2-
The command line tool for interacting with live FFS services.
2+
3+
The command line tool for interacting with live FFS services.

0 commit comments

Comments
 (0)