First pass: add ClarityTypeError and cleanup RuntimeError a bit

Signed-off-by: Jacinta Ferrant <[email protected]>

Author: jacinta-stacks

Cargo.lock

@@ -160,8 +160,6 @@ pub enum RuntimeError {
     MaxStackDepthReached,
     /// The execution context depth exceeded the virtual machine's limit.
     MaxContextDepthReached,
-    /// Attempt to construct an invalid or unsupported type at runtime (e.g., malformed data structure).
-    BadTypeConstruction,
     /// Reference to an invalid or out-of-bounds block height.
     /// The `String` represents the string representation of the queried block height that was invalid.
     BadBlockHeight(String),
@@ -173,9 +171,6 @@ pub enum RuntimeError {
     NoCallerInContext,
     /// No sender principal available in the current execution context.
     NoSenderInContext,
-    /// Invalid name-value pair in contract data (e.g., map keys).
-    /// The `&'static str` represents the name of the invalid pair, and the `String` represents the offending value.
-    BadNameValue(&'static str, String),
     /// Reference to a non-existent block header hash.
     /// The `BlockHeaderHash` represents the unknown block header hash.
     UnknownBlockHeaderHash(BlockHeaderHash),

clarity-types/src/errors/analysis.rs

@@ -33,7 +33,7 @@ pub mod types;
 
 pub use errors::VmExecutionError;
 pub use representations::{ClarityName, ContractName};
-pub use types::Value;
+pub use types::{ClarityTypeError, Value};
 
 pub const MAX_CALL_STACK_DEPTH: usize = 64;
 

clarity-types/src/errors/mod.rs

@@ -23,8 +23,7 @@ use regex::Regex;
 use stacks_common::codec::{Error as codec_error, StacksMessageCodec, read_next, write_next};
 
 use crate::Value;
-use crate::errors::RuntimeError;
-use crate::types::TraitIdentifier;
+use crate::types::{ClarityTypeError, TraitIdentifier};
 
 pub const CONTRACT_MIN_NAME_LENGTH: usize = 1;
 pub const CONTRACT_MAX_NAME_LENGTH: usize = 40;
@@ -63,20 +62,18 @@ lazy_static! {
 
 guarded_string!(
     ClarityName,
-    "ClarityName",
     CLARITY_NAME_REGEX,
     MAX_STRING_LEN,
-    RuntimeError,
-    RuntimeError::BadNameValue
+    ClarityTypeError,
+    ClarityTypeError::InvalidClarityName
 );
 
 guarded_string!(
     ContractName,
-    "ContractName",
     CONTRACT_NAME_REGEX,
     MAX_STRING_LEN,
-    RuntimeError,
-    RuntimeError::BadNameValue
+    ClarityTypeError,
+    ClarityTypeError::InvalidContractName
 );
 
 impl StacksMessageCodec for ClarityName {

clarity-types/src/lib.rs

@@ -15,11 +15,11 @@
 
 use rstest::rstest;
 
-use crate::errors::RuntimeError;
 use crate::representations::{
     CONTRACT_MAX_NAME_LENGTH, CONTRACT_MIN_NAME_LENGTH, ClarityName, ContractName, MAX_STRING_LEN,
 };
 use crate::stacks_common::codec::StacksMessageCodec;
+use crate::types::ClarityTypeError;
 
 #[rstest]
 #[case::valid_name("hello")]
@@ -73,7 +73,7 @@ fn test_clarity_name_invalid(#[case] name: &str) {
     assert!(result.is_err());
     assert!(matches!(
         result.unwrap_err(),
-        RuntimeError::BadNameValue(_, _)
+        ClarityTypeError::InvalidClarityName(_)
     ));
 }
 
@@ -99,7 +99,7 @@ fn test_clarity_name_serialization(#[case] name: &str) {
 // the first byte is the length of the buffer.
 #[rstest]
 #[case::invalid_utf8(vec![4, 0xFF, 0xFE, 0xFD, 0xFC], "Failed to parse Clarity name: could not contruct from utf8")]
-#[case::invalid_name(vec![2, b'2', b'i'], "Failed to parse Clarity name: BadNameValue(\"ClarityName\", \"2i\")")] // starts with number
+#[case::invalid_name(vec![2, b'2', b'i'], "Failed to parse Clarity name: InvalidClarityName(\"2i\")")] // starts with number
 #[case::too_long(vec![MAX_STRING_LEN + 1], "Failed to deserialize clarity name: too long")]
 #[case::wrong_length(vec![3, b'a'], "failed to fill whole buffer")]
 fn test_clarity_name_deserialization_errors(#[case] buffer: Vec<u8>, #[case] error_message: &str) {
@@ -157,7 +157,7 @@ fn test_contract_name_invalid(#[case] name: &str) {
     assert!(result.is_err());
     assert!(matches!(
         result.unwrap_err(),
-        RuntimeError::BadNameValue(_, _)
+        ClarityTypeError::InvalidContractName(_)
     ));
 }
 
@@ -201,7 +201,7 @@ fn test_contract_name_serialization_too_long() {
 // the first byte is the length of the buffer.
 #[rstest]
 #[case::invalid_utf8(vec![4, 0xFF, 0xFE, 0xFD, 0xFC], "Failed to parse Contract name: could not construct from utf8")]
-#[case::invalid_name(vec![2, b'2', b'i'], "Failed to parse Contract name: BadNameValue(\"ContractName\", \"2i\")")] // starts with number
+#[case::invalid_name(vec![2, b'2', b'i'], "Failed to parse Contract name: InvalidContractName(\"2i\")")] // starts with number
 #[case::too_long(vec![MAX_STRING_LEN + 1], &format!("Failed to deserialize contract name: too short or too long: {}", MAX_STRING_LEN + 1))]
 #[case::wrong_length(vec![3, b'a'], "failed to fill whole buffer")]
 fn test_contract_name_deserialization_errors(#[case] buffer: Vec<u8>, #[case] error_message: &str) {