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
+3 -3
View File
@@ -683,7 +683,7 @@ where
node.data
});
// Retain only roots that are descendents of the finalized block (this
// Retain only roots that are descendants of the finalized block (this
// happens if the node has been properly finalized) or that are
// ancestors (or equal) to the finalized block (in this case the node
// wasn't finalized earlier presumably because the predicate didn't
@@ -1168,7 +1168,7 @@ mod test {
Ok(Some(false)),
);
// finalizing "E" is not allowed since there are not finalized anchestors.
// finalizing "E" is not allowed since there are not finalized ancestors.
assert_eq!(
tree.finalizes_any_with_descendent_if(&"E", 15, &is_descendent_of, |c| c.effective ==
10),
@@ -1309,7 +1309,7 @@ mod test {
fn map_works() {
let (mut tree, _) = test_fork_tree();
// Extend the single root fork-tree to also excercise the roots order during map.
// Extend the single root fork-tree to also exercise the roots order during map.
let is_descendent_of = |_: &&str, _: &&str| -> Result<bool, TestError> { Ok(false) };
let is_root = tree.import("A1", 10, 1, &is_descendent_of).unwrap();
assert!(is_root);
@@ -415,7 +415,7 @@ impl PalletCmd {
.map_err(|e| {
format!("Error executing and verifying runtime benchmark: {}", e)
})?;
// Dont use these results since verification code will add overhead.
// Don't use these results since verification code will add overhead.
let _batch =
<std::result::Result<Vec<BenchmarkBatch>, String> as Decode>::decode(
&mut &result[..],
@@ -437,7 +437,7 @@ impl PalletCmd {
&pallet.clone(),
&extrinsic.clone(),
&selected_components.clone(),
false, // dont run verification code for final values
false, // don't run verification code for final values
self.repeat,
)
.encode(),
@@ -469,7 +469,7 @@ impl PalletCmd {
&pallet.clone(),
&extrinsic.clone(),
&selected_components.clone(),
false, // dont run verification code for final values
false, // don't run verification code for final values
self.repeat,
)
.encode(),
@@ -183,7 +183,7 @@ pub fn generate_thresholds<T: pallet_staking::Config>(
total_issuance: u128,
minimum_balance: u128,
) -> Result<(), std::io::Error> {
// ensure the file is accessable
// ensure the file is accessible
if let Some(parent) = output.parent() {
if !parent.exists() {
std::fs::create_dir_all(parent)?;
@@ -762,7 +762,7 @@ where
let mut sp = Spinner::with_timer(Spinners::Dots, "Inserting keys into DB...".into());
let start = Instant::now();
pending_ext.batch_insert(key_values.clone().into_iter().filter_map(|(k, v)| {
// Don't insert the child keys here, they need to be inserted seperately with all their
// Don't insert the child keys here, they need to be inserted separately with all their
// data in the load_child_remote function.
match is_default_child_storage_key(&k.0) {
true => None,
@@ -132,7 +132,7 @@ pub trait StateMigrationApi<BlockHash> {
/// Check current migration state.
///
/// This call is performed locally without submitting any transactions. Thus executing this
/// won't change any state. Nonetheless it is a VERY costy call that should be
/// won't change any state. Nonetheless it is a VERY costly call that should be
/// only exposed to trusted peers.
#[method(name = "state_trieMigrationStatus")]
fn call(&self, at: Option<BlockHash>) -> RpcResult<MigrationStatusResult>;
+4 -4
View File
@@ -21,12 +21,12 @@ to wallets providing their own dictionaries and checksum mechanism. Issues with
to CSPRNG supplied dictionary phrases.
2. Providing own dictionaries felt into the _you ain't gonna need it_ anti-pattern category on day 1. Wallet providers
(be it hardware or software) typically want their products to be compatibile with other wallets so that users can
(be it hardware or software) typically want their products to be compatible with other wallets so that users can
migrate to their product without having to migrate all their assets.
To achieve the above phrases have to be precisely encoded in _The One True Canonical Encoding_, for which UTF-8 NFKD was
chosen. This is largely irrelevant (and even ignored) for English phrases, as they encode to basically just ASCII in
virtualy every character encoding known to mankind, but immedietly becomes a problem for dictionaries that do use
virtually every character encoding known to mankind, but immediately becomes a problem for dictionaries that do use
non-ASCII characters. Even if the right encoding is used and implemented correctly, there are still [other caveats
present for some non-english dictionaries](https://github.com/bitcoin/bips/blob/master/bip-0039/bip-0039-wordlists.md),
such as normalizing spaces to a canonical form, or making some latin based characters equivalent to their base in
@@ -34,8 +34,8 @@ dictionary lookups (eg. Spanish `ñ` and `n` are meant to be interchangeable). T
headache, and opens doors for disagreements between buggy implementations, breaking compatibility.
BIP39 does already provide a form of the mnemonic that is free from all of these issues: the entropy byte array. Since
veryfing the checksum requires that we recover the entropy from which the phrase was generated, no extra work is
actually needed here. Wallet implementators can encode the dictionaries in whatever encoding they find convenient (as
verifying the checksum requires that we recover the entropy from which the phrase was generated, no extra work is
actually needed here. Wallet implementors can encode the dictionaries in whatever encoding they find convenient (as
long as they are the standard BIP39 dictionaries), no harm in using UTF-16 string primitives that Java and JavaScript
provide. Since the dictionary is fixed and known, and the checksum is done on the entropy itself, the exact character
encoding used becomes irrelevant, as are the precise codepoints and amount of whitespace around the words. It is thus
+1 -1
View File
@@ -43,7 +43,7 @@ pub enum Error {
///
/// Any other length will return an error.
///
/// `password` is analog to BIP39 seed generation itself, with an empty string being defalt.
/// `password` is analog to BIP39 seed generation itself, with an empty string being default.
pub fn mini_secret_from_entropy(entropy: &[u8], password: &str) -> Result<MiniSecretKey, Error> {
let seed = seed_from_entropy(entropy, password)?;
Ok(MiniSecretKey::from_bytes(&seed[..32]).expect("Length is always correct; qed"))
+1 -1
View File
@@ -207,7 +207,7 @@ fn get_cargo_command(target: RuntimeTarget) -> CargoCommand {
} else {
// If no command before provided us with a cargo that supports our Substrate wasm env, we
// try to search one with rustup. If that fails as well, we return the default cargo and let
// the prequisities check fail.
// the perquisites check fail.
get_rustup_command(target).unwrap_or(default_cargo)
}
}
@@ -695,7 +695,7 @@ impl BuildConfiguration {
/// "production". It would only contain the builtin profile where the custom profile
/// inherits from. This is why we inspect the build path to learn which profile is used.
///
/// When not overriden by a env variable we always default to building wasm with the `Release`
/// When not overridden by a env variable we always default to building wasm with the `Release`
/// profile even when the main build uses the debug build. This is because wasm built with the
/// `Debug` profile is too slow for normal development activities and almost never intended.
///
@@ -704,9 +704,9 @@ impl BuildConfiguration {
///
/// # Note
///
/// Can be overriden by setting [`crate::WASM_BUILD_TYPE_ENV`].
/// Can be overridden by setting [`crate::WASM_BUILD_TYPE_ENV`].
fn detect(target: RuntimeTarget, wasm_project: &Path) -> Self {
let (name, overriden) = if let Ok(name) = env::var(crate::WASM_BUILD_TYPE_ENV) {
let (name, overridden) = if let Ok(name) = env::var(crate::WASM_BUILD_TYPE_ENV) {
(name, true)
} else {
// First go backwards to the beginning of the target directory.
@@ -731,14 +731,14 @@ impl BuildConfiguration {
(name, false)
};
let outer_build_profile = Profile::iter().find(|p| p.directory() == name);
let blob_build_profile = match (outer_build_profile.clone(), overriden) {
// When not overriden by a env variable we default to using the `Release` profile
let blob_build_profile = match (outer_build_profile.clone(), overridden) {
// When not overridden by a env variable we default to using the `Release` profile
// for the wasm build even when the main build uses the debug build. This
// is because the `Debug` profile is too slow for normal development activities.
(Some(Profile::Debug), false) => Profile::Release,
// For any other profile or when overriden we take it at face value.
// For any other profile or when overridden we take it at face value.
(Some(profile), _) => profile,
// For non overriden unknown profiles we fall back to `Release`.
// For non overridden unknown profiles we fall back to `Release`.
// This allows us to continue building when a custom profile is used for the
// main builds cargo. When explicitly passing a profile via env variable we are
// not doing a fallback.