Skip to content

Commit 6b36667

Browse files
committed
move architecture to the root of the protocol directory
1 parent 267bab5 commit 6b36667

File tree

3 files changed

+24
-41
lines changed

3 files changed

+24
-41
lines changed

protocol/README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,27 @@
88
- **[`pcp`](./pcp/README.md)**: the Postconfirmation sub-protocol implementation for `ffs`.
99
- **[`fcp`](./fcp/README.md)**: the Fastconfirmation sub-protocol implementation for `ffs`.
1010
- **[`ffs`](./ffs/README.md)**: the full `ffs` protocol implementation.
11+
12+
## Architecture for each protocol unit
13+
14+
- `cli/` - Command line interface tools
15+
- `client/` - CLI tool for users to interact with the protocol (posting commitments, querying state)
16+
- `deployer/` - CLI tool for deploying the protocol contracts
17+
- `protocol/` - CLI tool for protocol-specific operations
18+
19+
- `clients/` - Protocol client implementations
20+
- `eth/` - Ethereum client implementation that handles blockchain interactions
21+
- `mock/` - Mock client for testing
22+
- `util/` - Shared utilities for clients
23+
24+
- `dlu/` - Deployment and Lifecycle Utilities
25+
- `eth/` - Ethereum-specific deployment tools
26+
- `contracts/` - Smart contract implementations. Includes settlement contracts for block commitments, staking contracts for validator management, token contracts for custody.
27+
- `deployer-core/` - Core deployment logic
28+
- `anvil/` - Local testnet configuration
29+
30+
- `manager/` - Protocol management and orchestration. Manages block commitments by batching and submitting them, interacts with clients, and processes commitment events (acceptance or rejection) for the settlement system.
31+
32+
- [`util/`](util/) - Shared utilities
33+
- `config/` - Configuration management
34+
- `types/` - Common type definitions

protocol/mcr/README.md

Lines changed: 0 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -9,27 +9,3 @@ This directory contains the implementation of the MCR protocol, which handles ro
99
The distinguishing feature to PCP is that there is only one type of actor, which is the attester.
1010

1111
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).
12-
13-
## Architecture
14-
15-
- [`cli/`](cli/) - Command line interface tools
16-
- [`client/`](cli/client/) - CLI tool for users to interact with the protocol (posting commitments, querying state)
17-
- [`deployer/`](cli/deployer/) - CLI tool for deploying the protocol contracts
18-
- [`protocol/`](cli/protocol/) - CLI tool for protocol-specific operations
19-
20-
- [`clients/`](clients/) - Protocol client implementations
21-
- [`eth/`](clients/eth/) - Ethereum client implementation that handles blockchain interactions
22-
- [`mock/`](clients/mock/) - Mock client for testing
23-
- [`util/`](clients/util/) - Shared utilities for clients
24-
25-
- [`dlu/`](dlu/) - Deployment and Lifecycle Utilities
26-
- [`eth/`](dlu/eth/) - Ethereum-specific deployment tools
27-
- [`contracts/`](dlu/eth/contracts/) - Smart contract implementations. Includes settlement contracts for block commitments, staking contracts for validator management, token contracts for custody.
28-
- [`deployer-core/`](dlu/eth/deployer-core/) - Core deployment logic
29-
- [`anvil/`](dlu/eth/anvil/) - Local testnet configuration
30-
31-
- [`manager/`](manager/) - Protocol management and orchestration. Manages block commitments by batching and submitting them, interacts with clients, and processes commitment events (acceptance or rejection) for the settlement system.
32-
33-
- [`util/`](util/) - Shared utilities
34-
- [`config/`](util/config/) - Configuration management
35-
- [`types/`](util/types/) - Common type definitions

protocol/pcp/README.md

Lines changed: 0 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -9,20 +9,3 @@ This directory contains the implementation of the PCP protocol, which handles co
99
The distinguishing feature to MCR is that there are two types of actors, which are the attesters and the acceptors.
1010

1111
For further details see the [MIP-37](https://github.com/movementlabsxyz/MIP/blob/main/MIP/mip-37).
12-
13-
## Architecture
14-
15-
- [`cli/`](cli/) - Command line interface tools
16-
- [`client/`](cli/client/) - CLI tool for users to interact with the protocol (posting commitments, querying state)
17-
- [`deployer/`](cli/deployer/) - CLI tool for deploying the protocol contracts
18-
- [`protocol/`](cli/protocol/) - CLI tool for protocol-specific operations
19-
20-
- [`dlu/`](dlu/) - Deployment and Lifecycle Utilities
21-
- [`eth/`](dlu/eth/) - Ethereum-specific deployment tools
22-
- [`contracts/`](dlu/eth/contracts/) - Smart contract implementations for post-confirmation settlement
23-
- [`deployer-core/`](dlu/eth/deployer-core/) - Core deployment logic for contracts
24-
- [`anvil/`](dlu/eth/anvil/) - Local testnet configuration for development
25-
26-
- [`util/`](util/) - Shared utilities
27-
- [`config/`](util/config/) - Configuration management for PCP clients and deployments
28-
- [`types/`](util/types/) - Common type definitions for PCP protocol

0 commit comments

Comments
 (0)