Fix spelling mistakes across the whole repository (#3808)

**Update:** Pushed additional changes based on the review comments.

**This pull request fixes various spelling mistakes in this
repository.**

Most of the changes are contained in the first **3** commits:

- `Fix spelling mistakes in comments and docs`

- `Fix spelling mistakes in test names`

- `Fix spelling mistakes in error messages, panic messages, logs and
tracing`

Other source code spelling mistakes are separated into individual
commits for easier reviewing:

- `Fix the spelling of 'authority'`

- `Fix the spelling of 'REASONABLE_HEADERS_IN_JUSTIFICATION_ANCESTRY'`

- `Fix the spelling of 'prev_enqueud_messages'`

- `Fix the spelling of 'endpoint'`

- `Fix the spelling of 'children'`

- `Fix the spelling of 'PenpalSiblingSovereignAccount'`

- `Fix the spelling of 'PenpalSudoAccount'`

- `Fix the spelling of 'insufficient'`

- `Fix the spelling of 'PalletXcmExtrinsicsBenchmark'`

- `Fix the spelling of 'subtracted'`

- `Fix the spelling of 'CandidatePendingAvailability'`

- `Fix the spelling of 'exclusive'`

- `Fix the spelling of 'until'`

- `Fix the spelling of 'discriminator'`

- `Fix the spelling of 'nonexistent'`

- `Fix the spelling of 'subsystem'`

- `Fix the spelling of 'indices'`

- `Fix the spelling of 'committed'`

- `Fix the spelling of 'topology'`

- `Fix the spelling of 'response'`

- `Fix the spelling of 'beneficiary'`

- `Fix the spelling of 'formatted'`

- `Fix the spelling of 'UNKNOWN_PROOF_REQUEST'`

- `Fix the spelling of 'succeeded'`

- `Fix the spelling of 'reopened'`

- `Fix the spelling of 'proposer'`

- `Fix the spelling of 'InstantiationNonce'`

- `Fix the spelling of 'depositor'`

- `Fix the spelling of 'expiration'`

- `Fix the spelling of 'phantom'`

- `Fix the spelling of 'AggregatedKeyValue'`

- `Fix the spelling of 'randomness'`

- `Fix the spelling of 'defendant'`

- `Fix the spelling of 'AquaticMammal'`

- `Fix the spelling of 'transactions'`

- `Fix the spelling of 'PassingTracingSubscriber'`

- `Fix the spelling of 'TxSignaturePayload'`

- `Fix the spelling of 'versioning'`

- `Fix the spelling of 'descendant'`

- `Fix the spelling of 'overridden'`

- `Fix the spelling of 'network'`

Let me know if this structure is adequate.

**Note:** The usage of the words `Merkle`, `Merkelize`, `Merklization`,
`Merkelization`, `Merkleization`, is somewhat inconsistent but I left it
as it is.

~~**Note:** In some places the term `Receival` is used to refer to
message reception, IMO `Reception` is the correct word here, but I left
it as it is.~~

~~**Note:** In some places the term `Overlayed` is used instead of the
more acceptable version `Overlaid` but I also left it as it is.~~

~~**Note:** In some places the term `Applyable` is used instead of the
correct version `Applicable` but I also left it as it is.~~

**Note:** Some usage of British vs American english e.g. `judgement` vs
`judgment`, `initialise` vs `initialize`, `optimise` vs `optimize` etc.
are both present in different places, but I suppose that's
understandable given the number of contributors.

~~**Note:** There is a spelling mistake in `.github/CODEOWNERS` but it
triggers errors in CI when I make changes to it, so I left it as it
is.~~
This commit is contained in:
Dcompoze
2024-03-26 13:57:57 +00:00
committed by GitHub
parent b839c995c0
commit 002d9260f9
463 changed files with 1119 additions and 1017 deletions
@@ -230,7 +230,7 @@ impl ApprovalEntry {
Ok(())
}
// Get the assignment certiticate and claimed candidates.
// Get the assignment certificate and claimed candidates.
pub fn assignment(&self) -> (IndirectAssignmentCertV2, CandidateBitfield) {
(self.assignment.clone(), self.assignment_claimed_candidates.clone())
}
@@ -404,7 +404,7 @@ impl Knowledge {
},
};
// In case of succesful insertion of multiple candidate assignments create additional
// In case of successful insertion of multiple candidate assignments create additional
// entries for each assigned candidate. This fakes knowledge of individual assignments, but
// we need to share the same `MessageSubject` with the followup approval candidate index.
if kind == MessageKind::Assignment && success && message.1.count_ones() > 1 {
@@ -1897,10 +1897,10 @@ impl State {
_ => break,
};
// Any peer which is in the `known_by` see and we know its peer_id authorithy id
// Any peer which is in the `known_by` see and we know its peer_id authority id
// mapping has already been sent all messages it's meant to get for that block and
// all in-scope prior blocks. In case, we just learnt about its peer_id
// authorithy-id mapping we have to retry sending the messages that should be sent
// authority-id mapping we have to retry sending the messages that should be sent
// to it for all un-finalized blocks.
if entry.known_by.contains_key(&peer_id) && !retry_known_blocks {
break
@@ -2199,7 +2199,7 @@ impl State {
sanitized_assignments
}
// Filter out obviously invalid candidate indicies.
// Filter out obviously invalid candidate indices.
async fn sanitize_v1_approvals(
&mut self,
peer_id: PeerId,
@@ -2226,7 +2226,7 @@ impl State {
sanitized_approvals
}
// Filter out obviously invalid candidate indicies.
// Filter out obviously invalid candidate indices.
async fn sanitize_v2_approvals(
&mut self,
peer_id: PeerId,
@@ -2260,7 +2260,7 @@ impl State {
// The modifier accepts as inputs the current required-routing state, whether
// the message is locally originating, and the validator index of the message issuer.
//
// Then, if the topology is known, this progates messages to all peers in the required
// Then, if the topology is known, this propagates messages to all peers in the required
// routing set which are aware of the block. Peers which are unaware of the block
// will have the message sent when it enters their view in `unify_with_peer`.
//
@@ -2440,7 +2440,7 @@ impl ApprovalDistribution {
gum::trace!(target: LOG_TARGET, "active leaves signal (ignored)");
// the relay chain blocks relevant to the approval subsystems
// are those that are available, but not finalized yet
// actived and deactivated heads hence are irrelevant to this subsystem, other than
// activated and deactivated heads hence are irrelevant to this subsystem, other than
// for tracing purposes.
if let Some(activated) = update.activated {
let head = activated.hash;
@@ -299,7 +299,7 @@ impl MetricsTrait for Metrics {
prometheus::CounterVec::new(
prometheus::Opts::new(
"polkadot_parachain_assignments_received_result",
"Result of a processed assignement",
"Result of a processed assignment",
),
&["status"]
)?,
@@ -394,7 +394,7 @@ fn try_import_the_same_assignment() {
setup_peer_with_view(overseer, &peer_b, view![hash], ValidationVersion::V1).await;
setup_peer_with_view(overseer, &peer_c, view![hash], ValidationVersion::V1).await;
// Set up a gossip topology, where a, b, c and d are topology neighboors to the node under
// Set up a gossip topology, where a, b, c and d are topology neighbors to the node under
// testing.
let peers_with_optional_peer_id = peers
.iter()
@@ -491,7 +491,7 @@ fn try_import_the_same_assignment_v2() {
setup_peer_with_view(overseer, &peer_b, view![hash], ValidationVersion::V3).await;
setup_peer_with_view(overseer, &peer_c, view![hash], ValidationVersion::V3).await;
// Set up a gossip topology, where a, b, c and d are topology neighboors to the node under
// Set up a gossip topology, where a, b, c and d are topology neighbors to the node under
// testing.
let peers_with_optional_peer_id = peers
.iter()
@@ -744,7 +744,7 @@ fn peer_sending_us_the_same_we_just_sent_them_is_ok() {
.iter()
.map(|(peer_id, authority)| (Some(*peer_id), authority.clone()))
.collect_vec();
// Setup a topology where peer_a is neigboor to current node.
// Setup a topology where peer_a is neighbor to current node.
setup_gossip_topology(
overseer,
make_gossip_topology(1, &peers_with_optional_peer_id, &[0], &[2], 1),
@@ -850,7 +850,7 @@ fn import_approval_happy_path_v1_v2_peers() {
.iter()
.map(|(peer_id, authority)| (Some(*peer_id), authority.clone()))
.collect_vec();
// Set up a gossip topology, where a, b, and c are topology neighboors to the node.
// Set up a gossip topology, where a, b, and c are topology neighbors to the node.
setup_gossip_topology(
overseer,
make_gossip_topology(1, &peers_with_optional_peer_id, &[0, 1], &[2, 4], 3),
@@ -972,7 +972,7 @@ fn import_approval_happy_path_v2() {
.iter()
.map(|(peer_id, authority)| (Some(*peer_id), authority.clone()))
.collect_vec();
// Set up a gossip topology, where a, b, and c are topology neighboors to the node.
// Set up a gossip topology, where a, b, and c are topology neighbors to the node.
setup_gossip_topology(
overseer,
make_gossip_topology(1, &peers_with_optional_peer_id, &[0, 1], &[2, 4], 3),
@@ -1083,7 +1083,7 @@ fn multiple_assignments_covered_with_one_approval_vote() {
.iter()
.map(|(peer_id, authority)| (Some(*peer_id), authority.clone()))
.collect_vec();
// Set up a gossip topology, where a, b, and c, d are topology neighboors to the node.
// Set up a gossip topology, where a, b, and c, d are topology neighbors to the node.
setup_gossip_topology(
overseer,
make_gossip_topology(1, &peers_with_optional_peer_id, &[0, 1], &[2, 4], 3),
@@ -1273,7 +1273,7 @@ fn unify_with_peer_multiple_assignments_covered_with_one_approval_vote() {
.iter()
.map(|(peer_id, authority)| (Some(*peer_id), authority.clone()))
.collect_vec();
// Set up a gossip topology, where a, b, and c, d are topology neighboors to the node.
// Set up a gossip topology, where a, b, and c, d are topology neighbors to the node.
setup_gossip_topology(
overseer,
make_gossip_topology(1, &peers_with_optional_peer_id, &[0, 1], &[2, 4], 3),
@@ -1631,7 +1631,7 @@ fn update_peer_view() {
.iter()
.map(|(peer_id, authority)| (Some(*peer_id), authority.clone()))
.collect_vec();
// Setup a topology where peer_a is neigboor to current node.
// Setup a topology where peer_a is neighbor to current node.
setup_gossip_topology(
overseer,
make_gossip_topology(1, &peers_with_optional_peer_id, &[0], &[2], 1),
@@ -1758,7 +1758,7 @@ fn update_peer_view() {
assert!(state.blocks.get(&hash_c).unwrap().known_by.get(peer).is_none());
}
// Tests that updating the known peer_id for a given authorithy updates the topology
// Tests that updating the known peer_id for a given authority updates the topology
// and sends the required messages
#[test]
fn update_peer_authority_id() {
@@ -1770,9 +1770,9 @@ fn update_peer_authority_id() {
let neighbour_x_index = 0;
let neighbour_y_index = 2;
let local_index = 1;
// X neighbour, we simulate that PeerId is not known in the beginining.
// X neighbour, we simulate that PeerId is not known in the beginning.
let neighbour_x = peers.get(neighbour_x_index).unwrap().0;
// Y neighbour, we simulate that PeerId is not known in the beginining.
// Y neighbour, we simulate that PeerId is not known in the beginning.
let neighbour_y = peers.get(neighbour_y_index).unwrap().0;
let _state = test_harness(State::default(), |mut virtual_overseer| async move {
@@ -1814,7 +1814,7 @@ fn update_peer_authority_id() {
})
.collect_vec();
// Setup a topology where peer_a is neigboor to current node.
// Setup a topology where peer_a is neighbor to current node.
setup_gossip_topology(
overseer,
make_gossip_topology(
@@ -2053,7 +2053,7 @@ fn sends_assignments_even_when_state_is_approved() {
.iter()
.map(|(peer_id, authority)| (Some(*peer_id), authority.clone()))
.collect_vec();
// Setup a topology where peer_a is neigboor to current node.
// Setup a topology where peer_a is neighbor to current node.
setup_gossip_topology(
overseer,
make_gossip_topology(1, &peers_with_optional_peer_id, &[0], &[2], 1),
@@ -2125,7 +2125,7 @@ fn sends_assignments_even_when_state_is_approved() {
}
/// Same as `sends_assignments_even_when_state_is_approved_v2` but with `VRFModuloCompact`
/// assignemnts.
/// assignments.
#[test]
fn sends_assignments_even_when_state_is_approved_v2() {
let peers = make_peers_and_authority_ids(8);
@@ -2153,7 +2153,7 @@ fn sends_assignments_even_when_state_is_approved_v2() {
.iter()
.map(|(peer_id, authority)| (Some(*peer_id), authority.clone()))
.collect_vec();
// Setup a topology where peer_a is neigboor to current node.
// Setup a topology where peer_a is neighbor to current node.
setup_gossip_topology(
overseer,
make_gossip_topology(1, &peers_with_optional_peer_id, &[0], &[2], 1),
@@ -3509,7 +3509,7 @@ fn import_versioned_approval() {
setup_peer_with_view(overseer, &peer_b, view![hash], ValidationVersion::V1).await;
setup_peer_with_view(overseer, &peer_c, view![hash], ValidationVersion::V2).await;
// Set up a gossip topology, where a, b, c and d are topology neighboors to the node under
// Set up a gossip topology, where a, b, c and d are topology neighbors to the node under
// testing.
let peers_with_optional_peer_id = peers
.iter()