cli: Require explicit overflow-checks flag (#2716)

CHANGELOG.md

@@ -28,6 +28,7 @@ The minor version will be incremented upon a breaking change and the patch versi
 ### Breaking
 
 - cli: Make `cargo build-sbf` the default build command ([#2694](https://github.com/coral-xyz/anchor/pull/2694)).
+- cli: Require explicit `overflow-checks` flag ([#2716](https://github.com/coral-xyz/anchor/pull/2716)).
 
 ## [0.29.0] - 2023-10-16
 

bench/BINARY_SIZE.md

@@ -16,9 +16,9 @@ The programs and their tests are located in [/tests/bench](https://github.com/co
 
 Solana version: 1.17.0
 
-| Program | Binary Size | -   |
-| ------- | ----------- | --- |
-| bench   | 735,800     | -   |
+| Program | Binary Size | -                   |
+| ------- | ----------- | ------------------- |
+| bench   | 743,208     | 🔴 **+152 (0.02%)** |
 
 ### Notable changes
 
@@ -30,7 +30,7 @@ Solana version: 1.17.0
 
 | Program | Binary Size | +/-                      |
 | ------- | ----------- | ------------------------ |
-| bench   | 735,800     | 🟢 **-417,936 (36.22%)** |
+| bench   | 743,056     | 🟢 **-417,904 (36.00%)** |
 
 ### Notable changes
 
@@ -46,7 +46,7 @@ Solana version: 1.16.0
 
 | Program | Binary Size | +/-                    |
 | ------- | ----------- | ---------------------- |
-| bench   | 1,153,736   | 🔴 **+35,000 (3.13%)** |
+| bench   | 1,160,960   | 🔴 **+23,272 (2.05%)** |
 
 ### Notable changes
 
@@ -60,6 +60,6 @@ Solana version: 1.14.16
 
 | Program | Binary Size | +/- |
 | ------- | ----------- | --- |
-| bench   | 1,118,736   | N/A |
+| bench   | 1,137,688   | N/A |
 
 ---

cli/src/checks.rs

@@ -0,0 +1,22 @@
+use std::path::Path;
+
+use anyhow::{anyhow, Result};
+
+use crate::config::Manifest;
+
+/// Check whether `overflow-checks` codegen option is enabled.
+///
+/// https://doc.rust-lang.org/rustc/codegen-options/index.html#overflow-checks
+pub fn check_overflow(cargo_toml_path: impl AsRef<Path>) -> Result<bool> {
+    Manifest::from_path(cargo_toml_path)?
+        .profile
+        .release
+        .as_ref()
+        .and_then(|profile| profile.overflow_checks)
+        .ok_or(anyhow!(
+            "`overflow-checks` is not enabled. To enable, add:\n\n\
+    [profile.release]\n\
+    overflow-checks = true\n\n\
+    in workspace root Cargo.toml.",
+        ))
+}

cli/src/config.rs

@@ -125,12 +125,11 @@ impl Manifest {
                         format!("Error reading the directory with path: {}", cwd.display())
                     })?
                     .path();
-                if let Some(filename) = p.file_name() {
-                    if filename.to_str() == Some("Cargo.toml") {
-                        let m = WithPath::new(Manifest::from_path(&p)?, p);
-                        return Ok(Some(m));
+                if let Some(filename) = p.file_name().and_then(|name| name.to_str()) {
+                    if filename == "Cargo.toml" {
+                        return Ok(Some(WithPath::new(Manifest::from_path(&p)?, p)));
                     }
-                    if filename.to_str() == Some("Anchor.toml") {
+                    if filename == "Anchor.toml" {
                         anchor_toml = true;
                     }
                 }

cli/src/lib.rs

@@ -11,6 +11,7 @@ use anchor_syn::idl::types::{
     IdlTypeDefinitionTy,
 };
 use anyhow::{anyhow, Context, Result};
+use checks::check_overflow;
 use clap::Parser;
 use dirs::home_dir;
 use flate2::read::GzDecoder;
@@ -49,6 +50,7 @@ use std::str::FromStr;
 use std::string::ToString;
 use tar::Archive;
 
+mod checks;
 pub mod config;
 pub mod rust_template;
 pub mod solidity_template;
@@ -1183,15 +1185,13 @@ pub fn build(
     }
 
     let cfg = Config::discover(cfg_override)?.expect("Not in workspace.");
-    let build_config = BuildConfig {
-        verifiable,
-        solana_version: solana_version.or_else(|| cfg.toolchain.solana_version.clone()),
-        docker_image: docker_image.unwrap_or_else(|| cfg.docker()),
-        bootstrap,
-    };
     let cfg_parent = cfg.path().parent().expect("Invalid Anchor.toml");
 
-    let cargo = Manifest::discover()?;
+    // Require overflow checks
+    let workspace_cargo_toml_path = cfg_parent.join("Cargo.toml");
+    if workspace_cargo_toml_path.exists() {
+        check_overflow(workspace_cargo_toml_path)?;
+    }
 
     let idl_out = match idl {
         Some(idl) => Some(PathBuf::from(idl)),
@@ -1205,10 +1205,17 @@ pub fn build(
     };
     fs::create_dir_all(idl_ts_out.as_ref().unwrap())?;
 
-    if !&cfg.workspace.types.is_empty() {
+    if !cfg.workspace.types.is_empty() {
         fs::create_dir_all(cfg_parent.join(&cfg.workspace.types))?;
     };
 
+    let cargo = Manifest::discover()?;
+    let build_config = BuildConfig {
+        verifiable,
+        solana_version: solana_version.or_else(|| cfg.toolchain.solana_version.clone()),
+        docker_image: docker_image.unwrap_or_else(|| cfg.docker()),
+        bootstrap,
+    };
     match cargo {
         // No Cargo.toml so build the entire workspace.
         None => build_all(

examples/tutorial/basic-0/Cargo.toml

@@ -2,3 +2,6 @@
 members = [
   "programs/*"
 ]
+
+[profile.release]
+overflow-checks = true

examples/tutorial/basic-1/Cargo.toml

@@ -2,3 +2,6 @@
 members = [
   "programs/*"
 ]
+
+[profile.release]
+overflow-checks = true

examples/tutorial/basic-2/Cargo.toml

@@ -2,3 +2,6 @@
 members = [
   "programs/*"
 ]
+
+[profile.release]
+overflow-checks = true

examples/tutorial/basic-3/Cargo.toml

@@ -2,3 +2,6 @@
 members = [
     "programs/*"
 ]
+
+[profile.release]
+overflow-checks = true

examples/tutorial/basic-4/Cargo.toml

@@ -2,3 +2,6 @@
 members = [
     "programs/*"
 ]
+
+[profile.release]
+overflow-checks = true

examples/tutorial/basic-5/Cargo.toml

@@ -1,4 +1,7 @@
 [workspace]
 members = [
     "programs/*"
-]
+]
+
+[profile.release]
+overflow-checks = true

tests/auction-house/Cargo.toml

@@ -3,3 +3,6 @@ members = [
     "programs/*"
 ]
 resolver = "2"
+
+[profile.release]
+overflow-checks = true

tests/bench/Cargo.toml

@@ -3,3 +3,6 @@ members = [
     "programs/*"
 ]
 resolver = "2"
+
+[profile.release]
+overflow-checks = true