Use serde to build package json and check npm package name. (#2428)

Author: mootz12

Cargo.lock

@@ -15,7 +15,7 @@ soroban-spec = { workspace = true }
 thiserror = "1.0.32"
 serde = "1.0.82"
 serde_derive = "1.0.82"
-serde_json = "1.0.82"
+serde_json = { version = "1.0.82", features = ["preserve_order"] }
 sha2 = "0.9.9"
 prettyplease = "0.2.4"
 include_dir = { version = "0.7.3", features = ["glob"] }

cmd/crates/soroban-spec-typescript/Cargo.toml

@@ -8,7 +8,7 @@ use std::{
 };
 use stellar_xdr::curr::ScSpecEntry;
 
-use super::generate;
+use super::{generate, validate_npm_package_name};
 
 static PROJECT_DIR: Dir<'_> = include_dir!("$CARGO_MANIFEST_DIR/src/project_template");
 
@@ -52,6 +52,14 @@ impl Project {
         network_passphrase: Option<&str>,
         spec: &[ScSpecEntry],
     ) -> std::io::Result<()> {
+        validate_npm_package_name(contract_name).map_err(|e| {
+            std::io::Error::new(
+                std::io::ErrorKind::InvalidInput,
+                format!(
+                    "output directory name '{contract_name}' is not a valid npm package name: {e}"
+                ),
+            )
+        })?;
         self.replace_placeholder_patterns(contract_name, contract_id, rpc_url, network_passphrase)?;
         self.append_index_ts(spec, contract_id, network_passphrase)
     }
@@ -87,7 +95,12 @@ impl Project {
             ),
         ];
         let root: &Path = self.as_ref();
-        ["package.json", "README.md", "src/index.ts"]
+
+        // Handle package.json with proper JSON serialization
+        replace_package_json(root, contract_name)?;
+
+        // Handle non-JSON files with string replacement
+        ["README.md", "src/index.ts"]
             .into_iter()
             .try_for_each(|file_name| {
                 let file = &root.join(file_name);
@@ -139,6 +152,38 @@ impl Project {
     }
 }
 
+fn replace_package_json(root: &Path, contract_name: &str) -> std::io::Result<()> {
+    let file = root.join("package.json");
+    let contents = fs::read_to_string(&file)?;
+    let mut json: serde_json::Value = serde_json::from_str(&contents).map_err(|e| {
+        std::io::Error::new(
+            std::io::ErrorKind::InvalidData,
+            format!("failed to parse package.json template: {e}"),
+        )
+    })?;
+
+    if let Some(obj) = json.as_object_mut() {
+        obj.insert(
+            "name".to_string(),
+            serde_json::Value::String(contract_name.to_string()),
+        );
+    } else {
+        return Err(std::io::Error::new(
+            std::io::ErrorKind::InvalidData,
+            "package.json template must be a JSON object",
+        ));
+    }
+
+    let serialized = serde_json::to_string_pretty(&json).map_err(|e| {
+        std::io::Error::new(
+            std::io::ErrorKind::InvalidData,
+            format!("failed to serialize package.json: {e}"),
+        )
+    })?;
+    // Append trailing newline to match standard formatting
+    fs::write(&file, format!("{serialized}\n"))
+}
+
 #[cfg(test)]
 mod test {
     use temp_dir::TempDir;
@@ -189,6 +234,51 @@ mod test {
         println!("Updated Snapshot!");
     }
 
+    #[test]
+    fn test_package_json_name_is_set_correctly() {
+        let temp_dir = TempDir::new().unwrap();
+        let _project = init(temp_dir.path()).unwrap();
+        let pkg_json_path = temp_dir.path().join("package.json");
+        let contents = fs::read_to_string(&pkg_json_path).unwrap();
+        let json: serde_json::Value = serde_json::from_str(&contents).unwrap();
+        assert_eq!(json["name"], "test_custom_types");
+        let obj = json.as_object().unwrap();
+        let expected_keys = [
+            "version",
+            "name",
+            "type",
+            "exports",
+            "typings",
+            "scripts",
+            "dependencies",
+            "devDependencies",
+        ];
+        for key in expected_keys {
+            assert!(
+                obj.contains_key(key),
+                "missing expected key in package.json: {key}"
+            );
+        }
+    }
+
+    #[test]
+    fn test_init_rejects_invalid_contract_name() {
+        let temp_dir = TempDir::new().unwrap();
+        let p: Project = temp_dir.path().to_path_buf().try_into().unwrap();
+        let spec = soroban_spec::read::from_wasm(EXAMPLE_WASM).unwrap();
+        let result = p.init(
+            r#"foo","optionalDependencies":{"evil":"1"},"z":""#,
+            Some("CA3D5KRYM6CB7OWQ6TWYRR3Z4T7GNZLKERYNZGGA5SOAOPIFY6YQGAXE"),
+            Some("https://rpc-futurenet.stellar.org:443"),
+            Some("Test SDF Future Network ; October 2022"),
+            &spec,
+        );
+        assert!(result.is_err());
+        let err = result.unwrap_err();
+        assert_eq!(err.kind(), std::io::ErrorKind::InvalidInput);
+        assert!(err.to_string().contains("not a valid npm package name"));
+    }
+
     fn assert_dirs_equal<P: AsRef<Path>>(dir1: P, dir2: P) {
         let walker1 = WalkDir::new(&dir1);
         let walker2 = WalkDir::new(&dir2);

cmd/crates/soroban-spec-typescript/src/boilerplate.rs

@@ -415,6 +415,68 @@ fn sanitize_string(s: &str) -> String {
         .replace('\r', "\\r")
 }
 
+/// Validate that a string is a valid npm package name.
+///
+/// Valid names must:
+/// - Be non-empty and at most 214 characters
+/// - Contain only lowercase alphanumeric characters, hyphens, dots, and underscores
+/// - Not start with a dot or underscore
+///
+/// Scoped names (e.g. `@scope/name`) are also accepted.
+pub fn validate_npm_package_name(name: &str) -> Result<(), String> {
+    if name.is_empty() {
+        return Err("npm package name must not be empty".to_string());
+    }
+    if name.len() > 214 {
+        return Err(format!(
+            "npm package name must be at most 214 characters, got {}",
+            name.len()
+        ));
+    }
+
+    // Handle scoped packages like @scope/name
+    let name_to_check = if let Some(rest) = name.strip_prefix('@') {
+        match rest.split_once('/') {
+            Some((scope, pkg)) => {
+                if scope.is_empty() || pkg.is_empty() {
+                    return Err(format!(
+                        "scoped npm package name '{name}' must have non-empty scope and package"
+                    ));
+                }
+                validate_npm_name_segment(scope)?;
+                pkg
+            }
+            None => {
+                return Err(format!(
+                    "scoped npm package name '{name}' must contain a '/'"
+                ));
+            }
+        }
+    } else {
+        name
+    };
+
+    validate_npm_name_segment(name_to_check)
+}
+
+fn validate_npm_name_segment(segment: &str) -> Result<(), String> {
+    if segment.starts_with('.') || segment.starts_with('_') {
+        return Err(format!(
+            "npm package name segment '{segment}' must not start with '.' or '_'"
+        ));
+    }
+    if let Some(c) = segment
+        .chars()
+        .find(|c| !matches!(c, 'a'..='z' | '0'..='9' | '-' | '.' | '_'))
+    {
+        return Err(format!(
+            "npm package name segment '{segment}' contains invalid character '{c}'. \
+             Only lowercase alphanumeric characters, hyphens, dots, and underscores are allowed"
+        ));
+    }
+    Ok(())
+}
+
 #[cfg(test)]
 mod tests {
     use super::*;
@@ -664,4 +726,41 @@ mod tests {
         assert!(!result.contains(DOC_TEST));
         assert!(!result.contains(METHOD_TEST));
     }
+
+    #[test]
+    fn test_validate_npm_package_name_valid() {
+        assert!(validate_npm_package_name("my-contract").is_ok());
+        assert!(validate_npm_package_name("foo.bar").is_ok());
+        assert!(validate_npm_package_name("a123").is_ok());
+        assert!(validate_npm_package_name("test_custom_types").is_ok());
+        assert!(validate_npm_package_name("@scope/my-pkg").is_ok());
+    }
+
+    #[test]
+    fn test_validate_npm_package_name_invalid() {
+        // Empty
+        assert!(validate_npm_package_name("").is_err());
+        // Leading dot
+        assert!(validate_npm_package_name(".hidden").is_err());
+        // Leading underscore
+        assert!(validate_npm_package_name("_private").is_err());
+        // Uppercase
+        assert!(validate_npm_package_name("MyContract").is_err());
+        // Special characters
+        assert!(validate_npm_package_name("foo\"bar").is_err());
+        assert!(validate_npm_package_name("foo bar").is_err());
+        assert!(validate_npm_package_name("foo{bar}").is_err());
+        // JSON injection payload
+        assert!(
+            validate_npm_package_name(r#"foo","optionalDependencies":{"evil":"1"},"z":""#).is_err()
+        );
+        // Too long (215 chars)
+        assert!(validate_npm_package_name(&"a".repeat(215)).is_err());
+        // Exactly 214 is ok
+        assert!(validate_npm_package_name(&"a".repeat(214)).is_ok());
+        // Bad scoped names
+        assert!(validate_npm_package_name("@/pkg").is_err());
+        assert!(validate_npm_package_name("@scope/").is_err());
+        assert!(validate_npm_package_name("@scope").is_err());
+    }
 }

cmd/crates/soroban-spec-typescript/src/lib.rs

@@ -39,6 +39,8 @@ pub enum Error {
     Spec(#[from] spec_tools::Error),
     #[error("Failed to get file name from path: {0:?}")]
     FailedToGetFileName(PathBuf),
+    #[error("--output-dir basename '{0}' is not a valid npm package name: {1}. Use only lowercase alphanumeric characters, hyphens, dots, and underscores")]
+    InvalidContractName(String, String),
     #[error(transparent)]
     WasmOrContract(#[from] contract_spec::Error),
     #[error(transparent)]
@@ -82,6 +84,8 @@ impl Cmd {
         let contract_name = &file_name
             .to_str()
             .ok_or_else(|| Error::NotUtf8(file_name.to_os_string()))?;
+        soroban_spec_typescript::validate_npm_package_name(contract_name)
+            .map_err(|reason| Error::InvalidContractName((*contract_name).to_string(), reason))?;
         let (resolved_address, network) = match source {
             contract_spec::Source::Contract {
                 resolved_address,