added substrate documentation

.gitignore

@@ -52,9 +52,10 @@ report.md
 env/
 venv/
 !/detectors/ink/.vscode/
-__pycache__
+__pycache__
 
 .vs
 /scripts/cs/run-tests/bin/
 /scripts/cs/run-tests/obj/
 launchSettings.json
+basic.tar

apps/cargo-scout-audit/Cargo.toml

@@ -20,7 +20,7 @@ license = "MIT"
 name = "cargo-scout-audit"
 readme = "../../README.md"
 repository = "https://github.com/coinfabrik/scout-audit"
-version = "0.3.0"
+version = "0.3.1"
 
 [lib]
 path = "src/lib.rs"

apps/cargo-scout-audit/src/cli/mod.rs

@@ -3,6 +3,8 @@ use clap::{Parser, Subcommand, ValueEnum};
 use std::path::PathBuf;
 use thiserror::Error;
 
+use crate::utils::print::print_info;
+
 #[derive(Debug, Parser)]
 #[clap(display_name = "cargo")]
 pub struct Cli {
@@ -148,6 +150,7 @@ impl Scout {
     }
 
     pub fn validate(&self) -> Result<()> {
+        print_info("Validating CLI arguments...");
         if let Some(path) = &self.output_path {
             if path.is_dir() {
                 bail!(CliError::OutputPathIsDirectory(path.clone()));

apps/cargo-scout-audit/src/detectors/builder.rs

@@ -10,7 +10,10 @@ use super::{
     library::Library,
     source::download_git_repo,
 };
-use crate::{scout::blockchain::BlockChain, utils::telemetry::TracedError};
+use crate::{
+    scout::blockchain::BlockChain,
+    utils::{print::print_info, telemetry::TracedError},
+};
 
 #[derive(Error, Debug)]
 pub enum BuilderError {
@@ -61,12 +64,14 @@ impl<'a> DetectorBuilder<'a> {
 
     #[tracing::instrument(skip_all, level = "debug")]
     pub fn build(&self, bc: &BlockChain, used_detectors: &[String]) -> Result<Vec<PathBuf>> {
+        print_info("Compiling detectors...");
         let all_library_paths = self.build_all_libraries(bc)?;
         self.filter_detectors(&all_library_paths, used_detectors)
     }
 
     #[tracing::instrument(skip_all, level = "debug")]
     pub fn get_detector_names(&self) -> Result<Vec<String>> {
+        print_info("Getting detector names...");
         let mut all_names = Vec::new();
         let libraries = self.get_all_libraries()?;
 

apps/cargo-scout-audit/src/scout/nightly_runner.rs

@@ -1,5 +1,5 @@
-#![allow(unused_imports)]
-use anyhow::{anyhow, Context, Result};
+use crate::utils::print::{print_error, print_info};
+use anyhow::{Context, Result};
 use current_platform::CURRENT_PLATFORM;
 use lazy_static::lazy_static;
 use std::{
@@ -8,8 +8,6 @@ use std::{
     process::{Child, Command},
 };
 
-use crate::utils::print::print_error;
-
 lazy_static! {
     static ref LIBRARY_PATH_VAR: &'static str = match env::consts::OS {
         "linux" => "LD_LIBRARY_PATH",
@@ -25,7 +23,7 @@ pub fn run_scout_in_nightly(toolchain: &str) -> Result<Option<Child>> {
     use windows::{core::PCWSTR, Win32::System::LibraryLoader::SetDllDirectoryW};
 
     let user_profile = env::var("USERPROFILE")
-        .map_err(|e| anyhow!("Unable to get user profile directory: {e}"))?;
+        .map_err(|e| anyhow::anyhow!("Unable to get user profile directory: {e}"))?;
     let mut user_profile = std::path::PathBuf::from(user_profile);
     user_profile.push(".rustup");
     user_profile.push("toolchains");
@@ -40,6 +38,7 @@ pub fn run_scout_in_nightly(toolchain: &str) -> Result<Option<Child>> {
     unsafe {
         let _ = SetDllDirectoryW(PCWSTR(directory.as_ptr()));
     }
+    print_info("Re-running scout with nightly toolchain...");
     return Ok(None);
 }
 
@@ -72,5 +71,6 @@ pub fn run_scout_in_nightly(toolchain: &str) -> Result<Option<Child>> {
     let child = command
         .spawn()
         .with_context(|| "Failed to spawn scout with nightly toolchain")?;
+    print_info("Re-running scout with nightly toolchain...");
     Ok(Some(child))
 }

apps/cargo-scout-audit/src/startup.rs

@@ -15,7 +15,7 @@ use crate::{
         config::ProfileConfig,
         detectors::{get_excluded_detectors, get_filtered_detectors, list_detectors},
         detectors_info::get_detectors_info,
-        print::print_error,
+        print::{print_error, print_info},
         telemetry::TracedError,
     },
 };
@@ -223,6 +223,8 @@ fn run_dylint(
     opts: &Scout,
     inside_vscode: bool,
 ) -> Result<(bool, NamedTempFile)> {
+    print_info("Running scout...");
+
     // Convert detectors paths to string
     let detectors_paths: Vec<String> = detectors_paths
         .iter()

apps/cargo-scout-audit/src/utils/print.rs

@@ -8,10 +8,18 @@ pub fn print_error(message: &str) {
     println!("{}", pretty_error(message));
 }
 
+pub fn print_info(message: &str) {
+    println!("{}", pretty_info(message));
+}
+
 pub fn pretty_warning(message: &str) -> String {
     format!("{} {}", "[WARNING]".yellow(), message)
 }
 
 pub fn pretty_error(message: &str) -> String {
     format!("{} {}", "[ERROR]".red(), message)
 }
+
+pub fn pretty_info(message: &str) -> String {
+    format!("{} {}", "[INFO]".blue(), message)
+}