From e5e6742b961e232f6448d5ceb2590f26c8c28595 Mon Sep 17 00:00:00 2001 From: Gary Hu <43922980+Gy-Hu@users.noreply.github.com> Date: Fri, 24 Apr 2026 16:28:18 +0800 Subject: [PATCH] docs: fix typos across README, CLI help, and public identifiers User-facing strings: - README: "Contritubions" -> "Contributions", "Belobog is inspired" -> "Movy is inspired" (the surrounding list is the set of projects Movy was inspired by, including Belobog itself), and "inreases" inside the counter test snippet - test-data/counter/tests/movy.move: matching "inreases" -> "increases" - movy sui fuzz --help: "Ouput directory" -> "Output directory" - movy sui fuzz error message: "MOVY_FORCE_REMOVAl" -> "MOVY_FORCE_REMOVAL" (the actual env var, defined on the same arg, was already spelt correctly) - movy-replay: "Commiting movy_init effects..." -> "Committing ..." Public identifiers (mechanical rename, rustc-verified): - FunctionData.return_paramters -> return_parameters (17 call sites across movy-types, movy-analysis, movy-fuzz) - movy/src/analysis::AnlaysisArgs -> AnalysisArgs (4 sites in movy/src/main.rs and movy/src/analysis/mod.rs) cargo check --workspace is clean; cargo build -p movy --release builds; `movy sui fuzz --help` and the existing-output-dir error path print the corrected strings. --- Readme.md | 6 +++--- crates/movy-analysis/src/type_graph.rs | 2 +- crates/movy-fuzz/src/meta.rs | 4 ++-- crates/movy-fuzz/src/mutators/object_data.rs | 4 ++-- crates/movy-fuzz/src/mutators/sequence/append.rs | 6 +++--- crates/movy-fuzz/src/mutators/sequence/post.rs | 2 +- crates/movy-fuzz/src/mutators/utils.rs | 6 +++--- crates/movy-replay/src/env.rs | 2 +- crates/movy-types/src/abi.rs | 10 +++++----- crates/movy/src/analysis/mod.rs | 4 ++-- crates/movy/src/main.rs | 4 ++-- crates/movy/src/sui/fuzz.rs | 4 ++-- test-data/counter/tests/movy.move | 2 +- 13 files changed, 28 insertions(+), 28 deletions(-) diff --git a/Readme.md b/Readme.md index 933ecb0..e00f911 100644 --- a/Readme.md +++ b/Readme.md @@ -81,7 +81,7 @@ public fun movy_post_increment( let state = context::borrow_state(movy); let previous_val = bag::borrow(state, ctr_id); if (*previous_val + n != new_val) { - crash_because(b"Increment does not correctly inreases internal value.".to_string()); + crash_because(b"Increment does not correctly increases internal value.".to_string()); } } ``` @@ -145,7 +145,7 @@ To write invariants for contracts, see [the counter sample](./test-data/counter/ movy = {git = "https://github.com/BitsLabSec/movy", subdir = "move/movy", rev = "master"} ``` -## Contritubions +## Contributions **Movy** is very open to contributions! We expect your feedbacks and pull requests. See the roadmap or contact us for further information. @@ -159,7 +159,7 @@ At this moment, `movy` is in very early-alpha state with the folloing features m ## Credits -Belobog is inspired by several pioneering projects: +Movy is inspired by several pioneering projects: - [Belobog](https://github.com/abortfuzz/belobog) - [ityfuzz](https://github.com/fuzzland/ityfuzz) diff --git a/crates/movy-analysis/src/type_graph.rs b/crates/movy-analysis/src/type_graph.rs index 70e00ca..c04b877 100644 --- a/crates/movy-analysis/src/type_graph.rs +++ b/crates/movy-analysis/src/type_graph.rs @@ -93,7 +93,7 @@ impl MoveTypeGraph { self.graph.add_edge(ty_node_idx, fidx, edge); } - for rt in function.return_paramters.iter() { + for rt in function.return_parameters.iter() { let ty = if let Some(deref) = rt.dereference() { *deref.clone() } else { diff --git a/crates/movy-fuzz/src/meta.rs b/crates/movy-fuzz/src/meta.rs index ad365d3..033baef 100644 --- a/crates/movy-fuzz/src/meta.rs +++ b/crates/movy-fuzz/src/meta.rs @@ -198,7 +198,7 @@ fn should_skip_function(base: &Metadata, func_data: &MoveFunctionAbi) -> bool { || matches!(t, MoveAbiSignatureToken::Reference(_)) || t.is_tx_context() }) && func_data - .return_paramters + .return_parameters .iter() .all(|t| t.is_mutable() || t.ability().is_some_and(|a| a.contains(MoveAbility::DROP))) { @@ -206,7 +206,7 @@ fn should_skip_function(base: &Metadata, func_data: &MoveFunctionAbi) -> bool { return true; } - for ret_ty in func_data.return_paramters.iter() { + for ret_ty in func_data.return_parameters.iter() { let self_used = func_data .parameters .iter() diff --git a/crates/movy-fuzz/src/mutators/object_data.rs b/crates/movy-fuzz/src/mutators/object_data.rs index 5337c67..0127156 100644 --- a/crates/movy-fuzz/src/mutators/object_data.rs +++ b/crates/movy-fuzz/src/mutators/object_data.rs @@ -230,7 +230,7 @@ impl ObjectData { } } - for (j, ret_ty) in function.return_paramters.iter().enumerate() { + for (j, ret_ty) in function.return_parameters.iter().enumerate() { if let MoveAbiSignatureToken::Vector(inner) = ret_ty { let instantiated_ret_ty = ret_ty.subst(ty_args_map).unwrap(); match inner.as_ref() { @@ -271,7 +271,7 @@ impl ObjectData { if !matches!(instantiated_ret_ty, MoveTypeTag::Struct(_)) { continue; // Only process struct return types } - let res_arg = if function.return_paramters.len() == 1 { + let res_arg = if function.return_parameters.len() == 1 { SequenceArgument::Result(i as u16) } else { SequenceArgument::NestedResult(i as u16, j as u16) diff --git a/crates/movy-fuzz/src/mutators/sequence/append.rs b/crates/movy-fuzz/src/mutators/sequence/append.rs index ad4b8a5..2e5089a 100644 --- a/crates/movy-fuzz/src/mutators/sequence/append.rs +++ b/crates/movy-fuzz/src/mutators/sequence/append.rs @@ -237,7 +237,7 @@ where ); let Some((arg_ty_arg, mut producing_ty_arg, mapping, ret_idx)) = pre_func .1 - .return_paramters + .return_parameters .iter() .enumerate() .filter_map(|(i, ret_ty)| { @@ -462,11 +462,11 @@ where ); let arguments = movecall.arguments.clone(); - let returns = if function.return_paramters.len() == 1 { + let returns = if function.return_parameters.len() == 1 { vec![SequenceArgument::Result(ptb.commands.len() as u16)] } else { function - .return_paramters + .return_parameters .iter() .enumerate() .map(|(j, _)| SequenceArgument::NestedResult(ptb.commands.len() as u16, j as u16)) diff --git a/crates/movy-fuzz/src/mutators/sequence/post.rs b/crates/movy-fuzz/src/mutators/sequence/post.rs index 04e2546..05916e6 100644 --- a/crates/movy-fuzz/src/mutators/sequence/post.rs +++ b/crates/movy-fuzz/src/mutators/sequence/post.rs @@ -53,7 +53,7 @@ pub fn process_balance(ptb: &mut MoveSequence, state: &(impl HasFuzzMetadata + H ) .unwrap(); let Some(MoveAbiSignatureToken::StructInstantiation(_, type_arguments)) = - function.return_paramters.get(ret_idx as usize) + function.return_parameters.get(ret_idx as usize) else { panic!("Expected balance return type to be a struct"); }; diff --git a/crates/movy-fuzz/src/mutators/utils.rs b/crates/movy-fuzz/src/mutators/utils.rs index 2f1801b..3db1fb9 100644 --- a/crates/movy-fuzz/src/mutators/utils.rs +++ b/crates/movy-fuzz/src/mutators/utils.rs @@ -297,7 +297,7 @@ where .iter() .any(|param| param.contains_type_param(i as u16)) && !function - .return_paramters + .return_parameters .iter() .any(|ret| ret.contains_type_param(i as u16)) { @@ -327,10 +327,10 @@ where if !function .parameters .iter() - .chain(function.return_paramters.iter()) + .chain(function.return_parameters.iter()) .any(|param| param.contains_type_param(i as u16)) && !function - .return_paramters + .return_parameters .iter() .any(|ret| ret.contains_type_param(i as u16)) { diff --git a/crates/movy-replay/src/env.rs b/crates/movy-replay/src/env.rs index b60f9a4..d1bf962 100644 --- a/crates/movy-replay/src/env.rs +++ b/crates/movy-replay/src/env.rs @@ -164,7 +164,7 @@ impl< gas, None, )?; - log::info!("Commiting movy_init effects..."); + log::info!("Committing movy_init effects..."); log::debug!( "Status: {:?} Changed Objects: {}, Removed Objects: {}", results.effects.status(), diff --git a/crates/movy-types/src/abi.rs b/crates/movy-types/src/abi.rs index 7c152eb..ed72396 100644 --- a/crates/movy-types/src/abi.rs +++ b/crates/movy-types/src/abi.rs @@ -985,7 +985,7 @@ impl From for MoveFunctionVisibility { pub struct MoveFunctionAbi { pub name: String, pub parameters: Vec, - pub return_paramters: Vec, + pub return_parameters: Vec, pub type_parameters: Vec, pub visibility: MoveFunctionVisibility, // TODO: Aptos's acquires @@ -1052,12 +1052,12 @@ impl Display for MoveFunctionAbi { v.to_string() }) .join(", "), - if self.return_paramters.is_empty() { + if self.return_parameters.is_empty() { "".to_string() } else { format!( ": {}", - self.return_paramters + self.return_parameters .iter() .map(|v| if f.alternate() { format!("{:#}", v) @@ -1100,7 +1100,7 @@ impl MoveFunctionAbi { type_parameters: ftys, visibility: vis, parameters, - return_paramters: returns, + return_parameters: returns, } } pub fn from_module_def(fdef: &FunctionDefinition, module: &CompiledModule) -> Self { @@ -1227,7 +1227,7 @@ impl MovePackageAbi { for ty in fc.parameters.iter_mut() { ty.published_at(prev, address); } - for ty in fc.return_paramters.iter_mut() { + for ty in fc.return_parameters.iter_mut() { ty.published_at(prev, address); } } diff --git a/crates/movy/src/analysis/mod.rs b/crates/movy/src/analysis/mod.rs index 4dadb2a..61ab439 100644 --- a/crates/movy/src/analysis/mod.rs +++ b/crates/movy/src/analysis/mod.rs @@ -71,12 +71,12 @@ pub enum AnalysisSubcommand { } #[derive(Args)] -pub struct AnlaysisArgs { +pub struct AnalysisArgs { #[clap(subcommand)] pub cmd: AnalysisSubcommand, } -impl AnlaysisArgs { +impl AnalysisArgs { pub async fn run(self) -> Result<(), MovyError> { match self.cmd { AnalysisSubcommand::TypeGraph(args) => args.run().await?, diff --git a/crates/movy/src/main.rs b/crates/movy/src/main.rs index 22aa421..3f08241 100644 --- a/crates/movy/src/main.rs +++ b/crates/movy/src/main.rs @@ -1,6 +1,6 @@ use clap::{Parser, Subcommand}; -use crate::{analysis::AnlaysisArgs, sui::SuiArgs}; +use crate::{analysis::AnalysisArgs, sui::SuiArgs}; mod analysis; mod aptos; @@ -9,7 +9,7 @@ mod sui; #[derive(Subcommand)] pub enum MovySubcommand { Sui(SuiArgs), - Analysis(AnlaysisArgs), // Aptos(AptosArgs) + Analysis(AnalysisArgs), // Aptos(AptosArgs) } #[derive(Parser)] diff --git a/crates/movy/src/sui/fuzz.rs b/crates/movy/src/sui/fuzz.rs index f0803d2..e6ada0a 100644 --- a/crates/movy/src/sui/fuzz.rs +++ b/crates/movy/src/sui/fuzz.rs @@ -127,7 +127,7 @@ pub struct SuiFuzzArgs { pub time_limit: Option, #[arg(long, help = "rng seeds")] pub seed: Option, - #[arg(short, long, help = "Ouput directory to save all contents")] + #[arg(short, long, help = "Output directory to save all contents")] pub output: Option, #[arg( short, @@ -171,7 +171,7 @@ impl SuiFuzzArgs { if self.force_removal { std::fs::remove_dir_all(output)?; } else { - return Err(eyre!("The given output is already there, pass -f or env MOVY_FORCE_REMOVAl to always remove it").into()); + return Err(eyre!("The given output is already there, pass -f or env MOVY_FORCE_REMOVAL to always remove it").into()); } } std::fs::create_dir_all(output)?; diff --git a/test-data/counter/tests/movy.move b/test-data/counter/tests/movy.move index dcc20bc..e0abf75 100644 --- a/test-data/counter/tests/movy.move +++ b/test-data/counter/tests/movy.move @@ -88,6 +88,6 @@ public fun movy_post_increment( let previous_val = bag::borrow(state, ctr_id); log_keyed_u64(b"post-increment".to_string(), new_val); if (*previous_val + n != new_val) { - crash_because(b"Increment does not correctly inreases internal value.".to_string()); + crash_because(b"Increment does not correctly increases internal value.".to_string()); } } \ No newline at end of file