fix: TODOs and disabled tests (#13)

Author: hedgar2017

CONTRIBUTING.md

@@ -23,7 +23,7 @@ for guidance how to work with PRs created from a fork.
 
 ## Licenses
 
-If you contribute to this project, your contributions will be made to the project under TODO: license.
+If you contribute to this project, your contributions will be made to the project under the GPL-3.0 license.
 
 ## Code of Conduct
 

era-solidity

@@ -67,13 +67,9 @@ impl Contract {
         self,
         path: String,
         output_metadata: bool,
-        output_assembly: bool,
         output_binary: bool,
     ) -> anyhow::Result<()> {
         writeln!(std::io::stdout(), "\n======= {path} =======")?;
-        if output_assembly {
-            writeln!(std::io::stdout(), "Assembly:\nTODO")?;
-        }
         if output_metadata {
             writeln!(std::io::stdout(), "Metadata:\n{}", self.metadata_json)?;
         }
@@ -96,7 +92,6 @@ impl Contract {
         self,
         output_path: &Path,
         output_metadata: bool,
-        output_assembly: bool,
         output_binary: bool,
         overwrite: bool,
     ) -> anyhow::Result<()> {
@@ -133,25 +128,6 @@ impl Contract {
             }
         }
 
-        if output_assembly {
-            let output_name = format!(
-                "{}.{}",
-                self.name.name.as_deref().unwrap_or(file_name),
-                "asm"
-            );
-            let mut output_path = output_path.clone();
-            output_path.push(output_name.as_str());
-
-            if output_path.exists() && !overwrite {
-                anyhow::bail!(
-                    "Refusing to overwrite an existing file {output_path:?} (use --overwrite to force)."
-                );
-            } else {
-                std::fs::write(output_path.as_path(), "TODO".as_bytes())
-                    .map_err(|error| anyhow::anyhow!("File {output_path:?} writing: {error}"))?;
-            }
-        }
-
         if output_binary {
             let output_name = format!(
                 "{}.{}",

solx/src/build_evm/contract.rs

@@ -94,27 +94,23 @@ impl Build {
     pub fn write_to_terminal(
         mut self,
         output_metadata: bool,
-        output_assembly: bool,
         output_binary: bool,
     ) -> anyhow::Result<()> {
         self.take_and_write_warnings();
         self.exit_on_error();
 
-        if !output_metadata && !output_assembly && !output_binary {
+        if !output_metadata && !output_binary {
             writeln!(
                 std::io::stderr(),
-                "Compiler run successful. No output requested. Use flags --metadata, --asm, --bin."
+                "Compiler run successful. No output requested. Use flags `--bin` and `--metadata`."
             )?;
             return Ok(());
         }
 
         for (path, build) in self.results.into_iter() {
-            build.expect("Always valid").write_to_terminal(
-                path,
-                output_metadata,
-                output_assembly,
-                output_binary,
-            )?;
+            build
+                .expect("Always valid")
+                .write_to_terminal(path, output_metadata, output_binary)?;
         }
 
         Ok(())
@@ -127,7 +123,6 @@ impl Build {
         mut self,
         output_directory: &Path,
         output_metadata: bool,
-        output_assembly: bool,
         output_binary: bool,
         overwrite: bool,
     ) -> anyhow::Result<()> {
@@ -140,7 +135,6 @@ impl Build {
             build.expect("Always valid").write_to_directory(
                 output_directory,
                 output_metadata,
-                output_assembly,
                 output_binary,
                 overwrite,
             )?;

solx/src/build_evm/mod.rs

@@ -63,7 +63,7 @@ pub struct Arguments {
 
     /// Pass arbitrary space-separated options to LLVM.
     /// The argument must be a single-quoted string following a `=` separator.
-    /// Example: `--llvm-options='-eravm-jump-table-density-threshold=10'`. TODO: update
+    /// Example: `--llvm-options='arg1 arg2 arg3 ... argN'`.
     #[arg(long)]
     pub llvm_options: Option<String>,
 
@@ -120,10 +120,6 @@ pub struct Arguments {
     #[arg(long)]
     pub metadata_literal: bool,
 
-    /// Output assembly of the compiled contracts.
-    #[arg(long = "asm")]
-    pub output_assembly: bool,
-
     /// Output metadata of the compiled project.
     #[arg(long = "metadata")]
     pub output_metadata: bool,
@@ -253,7 +249,7 @@ impl Arguments {
         }
 
         if self.standard_json.is_some() {
-            if self.output_assembly || self.output_metadata || self.output_binary {
+            if self.output_metadata || self.output_binary {
                 messages.push(solx_solc::StandardJsonOutputError::new_error(
                     "Cannot output data outside of JSON in standard JSON mode.",
                     None,

solx/src/solx/arguments.rs

@@ -202,16 +202,11 @@ fn main_inner(
         build.write_to_directory(
             &output_directory,
             arguments.output_metadata,
-            arguments.output_assembly,
             arguments.output_binary,
             arguments.overwrite,
         )?;
     } else {
-        build.write_to_terminal(
-            arguments.output_metadata,
-            arguments.output_assembly,
-            arguments.output_binary,
-        )?;
+        build.write_to_terminal(arguments.output_metadata, arguments.output_binary)?;
     }
 
     Ok(())

solx/src/solx/main.rs

@@ -256,7 +256,6 @@ impl FunctionCall {
             }
             Name::Pop => {
                 let _arguments = self.pop_arguments_llvm::<1>(context)?;
-                // TODO
                 Ok(None)
             }
 

solx/src/yul/parser/statement/expression/function_call.rs

@@ -21,21 +21,14 @@ fn no_arguments() -> anyhow::Result<()> {
     Ok(())
 }
 
-#[test_case(
-    crate::common::SOLIDITY_BIN_OUTPUT_NAME,
-    crate::common::SOLIDITY_ASM_OUTPUT_NAME
-)]
-fn multiple_output_options(
-    bin_output_file_name: &str,
-    asm_output_file_name: &str,
-) -> anyhow::Result<()> {
+#[test_case(crate::common::SOLIDITY_BIN_OUTPUT_NAME)]
+fn multiple_output_options(bin_output_file_name: &str) -> anyhow::Result<()> {
     crate::common::setup()?;
     let tmp_dir = TempDir::new()?;
     let args = &[
         crate::common::TEST_SOLIDITY_CONTRACT_PATH,
         "-O3",
         "--bin",
-        "--asm",
         "--output-dir",
         tmp_dir.path().to_str().unwrap(),
     ];
@@ -51,19 +44,11 @@ fn multiple_output_options(
         .path()
         .join(crate::common::TEST_SOLIDITY_CONTRACT_NAME)
         .join(bin_output_file_name);
-    let asm_output_file = tmp_dir
-        .path()
-        .join(crate::common::TEST_SOLIDITY_CONTRACT_NAME)
-        .join(asm_output_file_name);
 
     assert!(bin_output_file.exists());
-    assert!(asm_output_file.exists());
     assert!(!crate::cli::is_file_empty(
         bin_output_file.to_str().unwrap()
     )?);
-    assert!(!crate::cli::is_file_empty(
-        asm_output_file.to_str().unwrap()
-    )?);
 
     Ok(())
 }

solx/tests/cli/asm.rs

@@ -8,7 +8,6 @@ use assert_cmd::assert::OutputAssertExt;
 use assert_cmd::cargo::CommandCargoExt;
 
 mod allow_paths;
-mod asm;
 mod base_path;
 mod bin;
 mod debug_output_dir;