construstor 0.2.1

A tool for analyzing Solidity smart contracts to detect zero address validation patterns
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69

//! CLI module for handling command-line arguments

use std::error::Error;

use clap::{Arg, Command};

/// CLI configuration
#[derive(Debug)]
pub struct CliConfig {
    pub input_path: String,
    pub summary_only: bool,
    pub json_output: bool,
    pub all_functions: bool,
}

impl CliConfig {
    /// Parse command line arguments
    pub fn from_args() -> Result<Self, Box<dyn Error>> {
        let matches = Command::new("construstor")
            .version(env!("CARGO_PKG_VERSION"))
            .author(env!("CARGO_PKG_AUTHORS"))
            .about("Analyze Solidity smart contracts for zero address validation patterns in constructors, initialize functions, and all functions with address parameters")
            .arg(
                Arg::new("input")
                    .help("Path to Solidity file or directory to analyze")
                    .required(false)
                    .index(1),
            )
            .arg(
                Arg::new("summary")
                    .short('s')
                    .long("summary")
                    .help("Show only summary statistics")
                    .action(clap::ArgAction::SetTrue),
            )
            .arg(
                Arg::new("json")
                    .short('j')
                    .long("json")
                    .help("Output results in JSON format")
                    .action(clap::ArgAction::SetTrue),
            )
            .arg(
                Arg::new("all-functions")
                    .short('a')
                    .long("all-functions")
                    .help("Analyze all functions with address parameters, not just constructors and initialize functions")
                    .action(clap::ArgAction::SetTrue),
            )
            .get_matches();

        let input_path = if let Some(path) = matches.get_one::<String>("input") {
            path.clone()
        } else {
            // If no path provided, prompt user
            use dialoguer::Input;
            Input::new()
                .with_prompt("What is the path to the file or folder?")
                .interact_text()?
        };

        Ok(CliConfig {
            input_path,
            summary_only: matches.get_flag("summary"),
            json_output: matches.get_flag("json"),
            all_functions: matches.get_flag("all-functions"),
        })
    }
}