chore: release v0.6.0

CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.6.0](https://github.com/near/cargo-near/compare/cargo-near-v0.5.2...cargo-near-v0.6.0) - 2024-02-03
+
+### Added
+- Use hello-world contract instead of the status-message contract for the new project starter
+- Enable by default release mode, embedded ABIs with doc strings
+
 ## [0.5.2](https://github.com/near/cargo-near/compare/cargo-near-v0.5.1...cargo-near-v0.5.2) - 2024-01-27
 
 ### Other

cargo-near/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "cargo-near"
-version = "0.5.2"
+version = "0.6.0"
 authors = ["Near Inc <[email protected]>"]
 edition = "2021"
 rust-version = "1.72.0"

cargo-near/src/commands/abi_command/abi.rs

@@ -201,7 +201,7 @@ pub fn run(args: super::AbiCommand) -> near_cli_rs::CliResult {
     } else {
         AbiFormat::Json
     };
-    let contract_abi = generate_abi(&crate_metadata, args.doc, false, color)?;
+    let contract_abi = generate_abi(&crate_metadata, !args.no_doc, false, color)?;
     let AbiResult { path } =
         write_to_file(&contract_abi, &crate_metadata, format, AbiCompression::NoOp)?;
 

cargo-near/src/commands/abi_command/mod.rs

@@ -6,7 +6,7 @@ pub mod abi;
 pub struct AbiCommand {
     /// Include rustdocs in the ABI file
     #[interactive_clap(long)]
-    pub doc: bool,
+    pub no_doc: bool,
     /// Generate compact (minified) JSON
     #[interactive_clap(long)]
     pub compact_abi: bool,
@@ -34,7 +34,7 @@ impl AbiCommandlContext {
         scope: &<AbiCommand as interactive_clap::ToInteractiveClapContextScope>::InteractiveClapContextScope,
     ) -> color_eyre::eyre::Result<Self> {
         let args = AbiCommand {
-            doc: scope.doc,
+            no_doc: scope.no_doc,
             compact_abi: scope.compact_abi,
             out_dir: scope.out_dir.clone(),
             manifest_path: scope.manifest_path.clone(),

cargo-near/src/commands/build_command/build.rs

@@ -51,7 +51,8 @@ pub fn run(args: super::BuildCommand) -> color_eyre::eyre::Result<util::Compilat
     let mut abi = None;
     let mut min_abi_path = None;
     if !args.no_abi {
-        let mut contract_abi = abi::generate_abi(&crate_metadata, !args.no_doc, true, color.clone())?;
+        let mut contract_abi =
+            abi::generate_abi(&crate_metadata, !args.no_doc, true, color.clone())?;
         contract_abi.metadata.build = Some(BuildInfo {
             compiler: format!("rustc {}", rustc_version::version()?),
             builder: format!("cargo-near {}", env!("CARGO_PKG_VERSION")),

integration-tests/src/lib.rs

@@ -63,7 +63,7 @@ macro_rules! invoke_cargo_near {
         match cli_args.cmd {
             Some(cargo_near::commands::CliNearCommand::Abi(cmd)) => {
                 let args = cargo_near::commands::abi_command::AbiCommand {
-                    doc: cmd.doc,
+                    no_doc: cmd.no_doc,
                     compact_abi: cmd.compact_abi,
                     out_dir: cmd.out_dir,
                     manifest_path: Some(cargo_path.into()),
@@ -73,10 +73,10 @@ macro_rules! invoke_cargo_near {
             },
             Some(cargo_near::commands::CliNearCommand::Build(cmd)) => {
                 let args = cargo_near::commands::build_command::BuildCommand {
-                    release: cmd.release,
-                    embed_abi: cmd.embed_abi,
-                    doc: cmd.doc,
+                    no_release: cmd.no_release,
                     no_abi: cmd.no_abi,
+                    no_embed_abi: cmd.no_embed_abi,
+                    no_doc: cmd.no_doc,
                     out_dir: cmd.out_dir,
                     manifest_path: Some(cargo_path.into()),
                     color: cmd.color,

integration-tests/tests/abi/opts.rs

@@ -4,9 +4,9 @@ use std::fs;
 
 #[test]
 #[named]
-fn test_abi_opt_doc() -> cargo_near::CliResult {
+fn test_abi_no_doc() -> cargo_near::CliResult {
     let abi_root = generate_abi_fn_with! {
-        Opts: "--doc";
+        Opts: "--no-doc";
         Code:
         /// Adds `a` and `b`.
         pub fn add(&self, a: u32, b: u32) -> u32 {
@@ -16,7 +16,7 @@ fn test_abi_opt_doc() -> cargo_near::CliResult {
 
     assert_eq!(abi_root.body.functions.len(), 2);
     let function = &abi_root.body.functions[0];
-    assert_eq!(function.doc.as_ref().unwrap(), " Adds `a` and `b`.");
+    assert!(function.doc.is_none());
 
     Ok(())
 }

integration-tests/tests/build/mod.rs

@@ -2,7 +2,6 @@ use crate::util;
 use cargo_near_integration_tests::build_fn;
 use function_name::named;
 
-mod embed;
 mod opts;
 
 #[tokio::test]
@@ -14,12 +13,20 @@ async fn test_build_simple() -> cargo_near::CliResult {
             a + b
         }
     };
-    let functions = build_result.abi_root.unwrap().body.functions;
-    assert_eq!(functions.len(), 2);
-    assert_eq!(functions[0].name, "add");
-    assert_eq!(functions[0].doc, None);
+    let mut abi_root = build_result.abi_root.unwrap();
+    assert_eq!(abi_root.body.functions.len(), 2);
+    let function = &abi_root.body.functions[0];
+    assert_eq!(function.name, "add");
+    assert_eq!(function.doc.as_ref().unwrap(), " Adds `a` and `b`.");
 
-    assert!(build_result.abi_compressed.is_none());
+    // WASM hash is not included in the embedded ABI
+    abi_root.metadata.wasm_hash = None;
+    assert_eq!(
+        util::fetch_contract_abi(&build_result.wasm).await?,
+        abi_root
+    );
+
+    assert!(build_result.abi_compressed.is_some());
 
     util::test_add(&build_result.wasm).await?;
 

integration-tests/tests/build/opts.rs

@@ -19,11 +19,30 @@ fn test_build_no_abi() -> cargo_near::CliResult {
     Ok(())
 }
 
+#[tokio::test]
+#[named]
+async fn test_build_no_embed_abi() -> cargo_near::CliResult {
+    let build_result = build_fn_with! {
+        Opts: "--no-embed-abi";
+        Code:
+        pub fn add(&self, a: u32, b: u32) -> u32 {
+            a + b
+        }
+    };
+
+    let worker = near_workspaces::sandbox().await?;
+    let contract = worker.dev_deploy(&build_result.wasm).await?;
+    let outcome = contract.call("__contract_abi").view().await;
+    outcome.unwrap_err();
+
+    Ok(())
+}
+
 #[test]
 #[named]
-fn test_build_opt_doc() -> cargo_near::CliResult {
+fn test_build_no_doc() -> cargo_near::CliResult {
     let build_result = build_fn_with! {
-        Opts: "--doc";
+        Opts: "--no-doc";
         Code:
         /// Adds `a` and `b`.
         pub fn add(&self, a: u32, b: u32) -> u32 {
@@ -34,7 +53,7 @@ fn test_build_opt_doc() -> cargo_near::CliResult {
     let abi_root = build_result.abi_root.unwrap();
     assert_eq!(abi_root.body.functions.len(), 2);
     let function = &abi_root.body.functions[0];
-    assert_eq!(function.doc.as_ref().unwrap(), " Adds `a` and `b`.");
+    assert!(function.doc.is_none());
 
     Ok(())
 }
@@ -66,9 +85,9 @@ fn test_build_opt_out_dir() -> cargo_near::CliResult {
 
 #[tokio::test]
 #[named]
-async fn test_build_opt_release() -> cargo_near::CliResult {
+async fn test_build_no_release() -> cargo_near::CliResult {
     let build_result = build_fn_with! {
-        Opts: "--release";
+        Opts: "--no-release";
         Code:
         pub fn add(&self, a: u32, b: u32) -> u32 {
             a + b
@@ -77,80 +96,8 @@ async fn test_build_opt_release() -> cargo_near::CliResult {
 
     let abi_root = build_result.abi_root.unwrap();
     assert_eq!(abi_root.body.functions.len(), 2);
-    assert!(build_result.abi_compressed.is_none());
+    assert!(build_result.abi_compressed.is_some());
     util::test_add(&build_result.wasm).await?;
 
     Ok(())
 }
-
-#[tokio::test]
-#[named]
-async fn test_build_opt_doc_embed() -> cargo_near::CliResult {
-    let build_result = build_fn_with! {
-        Opts: "--doc --embed-abi";
-        Code:
-        /// Adds `a` and `b`.
-        pub fn add(&self, a: u32, b: u32) -> u32 {
-            a + b
-        }
-    };
-
-    let mut abi_root = build_result.abi_root.unwrap();
-    assert_eq!(abi_root.body.functions.len(), 2);
-    let function = &abi_root.body.functions[0];
-    assert_eq!(function.doc.as_ref().unwrap(), " Adds `a` and `b`.");
-
-    // WASM hash is not included in the embedded ABI
-    abi_root.metadata.wasm_hash = None;
-    assert_eq!(
-        util::fetch_contract_abi(&build_result.wasm).await?,
-        abi_root
-    );
-
-    Ok(())
-}
-
-#[test]
-#[named]
-fn test_build_opt_no_abi_doc() -> cargo_near::CliResult {
-    fn run_test() -> cargo_near::CliResult {
-        build_fn_with! {
-            Opts: "--no-abi --doc";
-            Code:
-            /// Adds `a` and `b`.
-            pub fn add(&self, a: u32, b: u32) -> u32 {
-                a + b
-            }
-        };
-        Ok(())
-    }
-
-    assert!(run_test()
-        .unwrap_err()
-        .to_string()
-        .contains("error: the argument '--no-abi' cannot be used with '--doc'"));
-
-    Ok(())
-}
-
-#[test]
-#[named]
-fn test_build_opt_no_abi_embed() -> cargo_near::CliResult {
-    fn run_test() -> cargo_near::CliResult {
-        build_fn_with! {
-            Opts: "--no-abi --embed-abi";
-            Code:
-            /// Adds `a` and `b`.
-            pub fn add(&self, a: u32, b: u32) -> u32 {
-                a + b
-            }
-        };
-        Ok(())
-    }
-    assert!(run_test()
-        .unwrap_err()
-        .to_string()
-        .contains("error: the argument '--no-abi' cannot be used with '--embed-abi'"));
-
-    Ok(())
-}