Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: typos in documentation files #532

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions consensus/src/terminator.rs
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ impl Terminator {
if !self.parent_exit.is_terminated() {
debug!(
target: self.component_name,
"Terminator has not recieved exit from parent: synchronization canceled.",
"Terminator has not received exit from parent: synchronization canceled.",
);
return;
}
Expand All @@ -104,7 +104,7 @@ impl Terminator {
offspring_receivers.push((receiver, name));
}

// Make sure that all descendants recieved exit and won't be communicating with other components
// Make sure that all descendants received exit and won't be communicating with other components
for (receiver, name) in offspring_receivers {
if receiver.await.is_err() {
debug!(
Expand Down Expand Up @@ -143,7 +143,7 @@ impl Terminator {
} else {
debug!(
target: self.component_name,
"Terminator recieved shutdown permission from parent component."
"Terminator received shutdown permission from parent component."
);
}
}
Expand Down
2 changes: 1 addition & 1 deletion docs/src/aleph_bft_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ Let `round_delay` be the average delay between two consecutive rounds in the Dag
We note that the issue of an honest node's data not being included in the stream is not too dangerous for most of the applications. For instance, for the two example scenarios:

1. For the **finality gadget** example, most honest nodes see the same blocks and there is a high level of redundancy, so it does not quite matter that some of the nodes are possibly censored.
2. For the **state machine replication** example one must assume that there is some redundancy in the way transactions are distributed among nodes. For instance if there is a gurantee (that one can easily achieve by randomly gossiping each transaction to a smal random subset of nodes) that each transaction appears in the pools of at least `5` nodes, then the issue of censorship essentially goes away.
2. For the **state machine replication** example one must assume that there is some redundancy in the way transactions are distributed among nodes. For instance if there is a gurantee (that one can easily achieve by randomly gossiping each transaction to a small random subset of nodes) that each transaction appears in the pools of at least `5` nodes, then the issue of censorship essentially goes away.

Still, the most important thing to take away from this section is that if censorship happens, then the configuration of AlephBFT is suboptimal and one should increase the `round_delay`.

Expand Down