Skip to content

Commit

Permalink
Prefixed crate names with zksync_consensus_ (#25)
Browse files Browse the repository at this point in the history
Prefixed crate names with zksync_consensus_ to make the names more scope
specific.
We cannot afford keeping the generic names we used so far, as this repo
will be used in zksync-era now.
The exception is zksync_concurrency (not zksync_consensus_concurrency)
which is intended to be extracted from this repo eventually.
  • Loading branch information
pompon0 authored Nov 7, 2023
1 parent 8a6838a commit 3330c83
Show file tree
Hide file tree
Showing 126 changed files with 639 additions and 603 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/protobuf_conformance.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ jobs:
path: "protobuf"
- uses: mozilla-actions/[email protected]
- name: build test
run: cargo build -p schema --bin conformance_test
run: cargo build -p zksync_consensus_schema --bin conformance_test
working-directory: "this/node"
- name: Cache Bazel
uses: actions/cache@v3
Expand Down
6 changes: 3 additions & 3 deletions docs/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The architecture of era-bft loosely follows the [Actor model](https://en.wikiped

The actor crates are where the vast majority of the work is done. Each of them maintains its own separate state and communicate with each other through message passing. We have the following actor crates:

- the `consensus` crate implements the logic for the consensus algorithm.
- the `bft` crate implements the logic for the consensus algorithm.

- the `executor` crate is responsible for parsing the configuration parameters given by the user, and initializing the actors and the storage. It's basically the bootloader for the node. It also dispatches messages between the rest of the actors. They all send messages to the executor and it then converts and forwards the messages to the desired destination. This improves the encapsulation of the actors.

Expand Down Expand Up @@ -44,7 +44,7 @@ This section provides a physical map of folders & files in this repository.

- `/actors`: Crates that implement specific actor components.

- `/consensus`: The consensus actor.
- `/bft`: The consensus actor.
- `/executor`: The actor orchestrator.
- `/network`: The networking actor.
- `/sync_blocks`: The block syncing actor.
Expand All @@ -58,4 +58,4 @@ This section provides a physical map of folders & files in this repository.
- `/storage`: Storage layer for the node.
- `/utils`: Collection of small utilities.

- `/tools`: Utility binaries needed to work with and test the node.
- `/tools`: Utility binaries needed to work with and test the node.
Loading

0 comments on commit 3330c83

Please sign in to comment.