tweak: Disallow dec!(".123") and require "0.123"

radixdlt · Sep 20, 2023 · d208ef7 · d208ef7
1 parent 22f7a12
commit d208ef7
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 9 deletions.
diff --git a/radix-engine-common/src/math/decimal.rs b/radix-engine-common/src/math/decimal.rs
@@ -757,7 +757,9 @@ impl FromStr for Decimal {
                     unreachable!("InvalidLength is only for parsing &[u8], not &str")
                 }
                 ParseI192Error::InvalidDigit => return Err(ParseDecimalError::InvalidDigit),
-                ParseI192Error::Empty => I192::ZERO, // Allows parsing ".123"
+                // We have decided to be restrictive to force people to type "0.123" instead of ".123"
+                // for clarity, and to align with how rust's float literal works
+                ParseI192Error::Empty => return Err(ParseDecimalError::EmptyIntegralPart),
             },
         };
 
@@ -849,6 +851,7 @@ impl fmt::Debug for Decimal {
 pub enum ParseDecimalError {
     InvalidDigit,
     Overflow,
+    EmptyIntegralPart,
     EmptyFractionalPart,
     MoreThanEighteenDecimalPlaces,
     MoreThanOneDecimalPoint,
@@ -980,8 +983,8 @@ mod tests {
             Err(ParseDecimalError::Overflow),
         );
         assert_eq!(
-            Decimal::from_str(".000000000000000231").unwrap(),
-            Decimal(231.into()),
+            Decimal::from_str(".000000000000000231"),
+            Err(ParseDecimalError::EmptyIntegralPart),
         );
         assert_eq!(
             Decimal::from_str("231."),

diff --git a/radix-engine-common/src/math/precise_decimal.rs b/radix-engine-common/src/math/precise_decimal.rs
@@ -795,7 +795,9 @@ impl FromStr for PreciseDecimal {
                     unreachable!("InvalidLength is only for parsing &[u8], not &str")
                 }
                 ParseI256Error::InvalidDigit => return Err(ParsePreciseDecimalError::InvalidDigit),
-                ParseI256Error::Empty => I256::ZERO,
+                // We have decided to be restrictive to force people to type "0.123" instead of ".123"
+                // for clarity, and to align with how rust's float literal works
+                ParseI256Error::Empty => return Err(ParsePreciseDecimalError::EmptyIntegralPart),
             },
         };
 
@@ -891,6 +893,7 @@ impl fmt::Debug for PreciseDecimal {
 pub enum ParsePreciseDecimalError {
     InvalidDigit,
     Overflow,
+    EmptyIntegralPart,
     EmptyFractionalPart,
     MoreThanThirtySixDecimalPlaces,
     MoreThanOneDecimalPoint,
@@ -1072,8 +1075,8 @@ mod tests {
             Err(ParsePreciseDecimalError::Overflow),
         );
         assert_eq!(
-            PreciseDecimal::from_str(".000000000000000231").unwrap(),
-            PreciseDecimal(I256::from(231) * I256::TEN.pow(18)),
+            PreciseDecimal::from_str(".000000000000000231"),
+            Err(ParsePreciseDecimalError::EmptyIntegralPart),
         );
         assert_eq!(
             PreciseDecimal::from_str("231."),

diff --git a/radix-engine-macros/src/decimal.rs b/radix-engine-macros/src/decimal.rs
@@ -72,8 +72,11 @@ fn decimal_error_reason(error: ParseDecimalError) -> &'static str {
     match error {
         ParseDecimalError::InvalidDigit => "There is an invalid character.",
         ParseDecimalError::Overflow => "The number is too large to fit in a decimal.",
+        ParseDecimalError::EmptyIntegralPart => {
+            "If there is a decimal point, the number must include at least one digit before it. Use a 0 if necessary."
+        },
         ParseDecimalError::EmptyFractionalPart => {
-            "The number cannot have an empty fractional part."
+            "If there is a decimal point, the number must include at least one digit after it."
         }
         ParseDecimalError::MoreThanEighteenDecimalPlaces => {
             "A decimal cannot have more than eighteen decimal places."
@@ -93,8 +96,11 @@ fn precise_decimal_error_reason(error: ParsePreciseDecimalError) -> &'static str
         ParsePreciseDecimalError::Overflow => {
             "The number being too large to fit in a precise decimal"
         }
+        ParsePreciseDecimalError::EmptyIntegralPart => {
+            "If there is a decimal point, the number must include at least one digit before it. Use a 0 if necessary."
+        }
         ParsePreciseDecimalError::EmptyFractionalPart => {
-            "The number cannot have an empty fractional part."
+            "If there is a decimal point, the number must include at least one digit after it."
         }
         ParsePreciseDecimalError::MoreThanThirtySixDecimalPlaces => {
             "A precise decimal cannot have more than thirty-six decimal places."

diff --git a/radix-engine-tests/tests/decimal.rs b/radix-engine-tests/tests/decimal.rs
@@ -51,7 +51,7 @@ fn test_dec_macro() {
     const X13: Decimal = dec!("-3138550867693340381917894711603833208051.177722232017256448");
     assert_eq!(X13, Decimal::MIN);
 
-    const X14: Decimal = dec!(".000000000000000048");
+    const X14: Decimal = dec!("0.000000000000000048");
     assert_eq!(X14, Decimal(I192::from(48)));
 }