-
Notifications
You must be signed in to change notification settings - Fork 5
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
Introduce CLI command #5
Changes from 2 commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
@@ -0,0 +1,58 @@ | ||||||||||
use clap::{arg, value_parser, Command}; | ||||||||||
|
||||||||||
fn cli() -> Command { | ||||||||||
Command::new("state-reconstruct") | ||||||||||
.about("zkSync state reconstruction tool") | ||||||||||
.subcommand_required(true) | ||||||||||
.arg_required_else_help(false) | ||||||||||
.subcommand( | ||||||||||
Command::new("import") | ||||||||||
.about("Import state") | ||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Nit: maybe "reconstruct" since we are doing a lot more than just importing the L1 state. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Initially my thinking was that there would be ...but, revisiting requirements, I think officially there won't be export functionality so I'm ok with this. I'm thinking of hidden |
||||||||||
.subcommand_required(true) | ||||||||||
.subcommand( | ||||||||||
Command::new("l1") | ||||||||||
.about("Import state from Ethereum L1") | ||||||||||
.arg( | ||||||||||
arg!(--"start-block" <START_BLOCK>) | ||||||||||
.help("Ethereum block number to start state import from") | ||||||||||
.default_value("16627460") | ||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
The default value should be a constant. |
||||||||||
.value_parser(value_parser!(u64)), | ||||||||||
) | ||||||||||
.arg( | ||||||||||
arg!(--"block-step" <BLOCK_STEP>) | ||||||||||
.help("Number of blocks to filter & process in one step") | ||||||||||
.default_value("128") | ||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
.value_parser(value_parser!(u64)), | ||||||||||
), | ||||||||||
) | ||||||||||
.subcommand( | ||||||||||
Command::new("file") | ||||||||||
.about("Import state from file") | ||||||||||
.arg(arg!(<FILE> "File to import state from")) | ||||||||||
.arg_required_else_help(true), | ||||||||||
), | ||||||||||
) | ||||||||||
} | ||||||||||
|
||||||||||
fn main() { | ||||||||||
let matches = cli().get_matches(); | ||||||||||
|
||||||||||
match matches.subcommand() { | ||||||||||
Some(("import", sub_matches)) => { | ||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Do you know if there's any way to have the commands and sub-commands as There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I briefly looked at this while writing the code. You can create an enum and workaround it here, but I personally would lean towards not having that boilerplate since I don't think these few string occurrences can cause any issues here. |
||||||||||
match sub_matches.subcommand() { | ||||||||||
Some(("l1", args)) => { | ||||||||||
let start_block = args.get_one::<u64>("start-block").expect("required"); | ||||||||||
let block_step = args.get_one::<u64>("block-step").expect("required"); | ||||||||||
println!("import from L1, starting from block number {}, processing {} blocks at a time", start_block, block_step); | ||||||||||
// TODO(tuommaki): Implement block fetch logic. | ||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'll build this in small steps 🙂 |
||||||||||
} | ||||||||||
Some(("file", args)) => { | ||||||||||
let input_file = args.get_one::<String>("FILE").expect("required"); | ||||||||||
println!("import from file (path: \"{}\")", input_file); | ||||||||||
} | ||||||||||
_ => unreachable!(), | ||||||||||
} | ||||||||||
} | ||||||||||
_ => unreachable!(), | ||||||||||
} | ||||||||||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I choose the builder style since I don't anticipate that many sub-commands or arguments and they are pretty self-descriptive this way.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Gotcha, to be honest I'm not a huge fan of the builder style in general since I think it's a lot harder to understand how everything relates even when we don't have a lot of commands. However, if it's what you prefer I'm fine with it - I know that I'll be integrating database source arguments, but other than that I can't imagine many more arguments/sub-commands for now.