Return Result type instead of Option

Result allows for a more descriptive error messaging.

Author: yancyribbens

units/src/amount/tests.rs

@@ -1467,8 +1467,8 @@ fn math_op_errors() {
 fn to_effective_value() {
     let amt = "1 cBTC".parse::<Amount>().unwrap();
     let fee_rate = FeeRate::from_sat_per_kwu(10);
-    let effective_value =
-        amt.to_effective_value(fee_rate, Weight::from_wu(272)).unwrap();
+    let effective_value = amt.to_effective_value(
+        fee_rate, Weight::from_wu(272)).unwrap();
 
     // 10 sat/kwu * 272 wu = 4 sats (rounding up)
     let expected_fee = "3 sats".parse::<SignedAmount>().unwrap();
@@ -1478,7 +1478,7 @@ fn to_effective_value() {
 
 #[test]
 #[cfg(feature = "alloc")]
-fn effective_value_fee_rate_does_not_overflow() {
-    let eff_value =Amount::ZERO.to_effective_value(FeeRate::MAX, Weight::from_wu(272));
-    assert!(eff_value.is_none());
+fn to_effective_value_error() {
+    let eff_val = Amount::ZERO.to_effective_value(FeeRate::MAX, Weight::from_wu(272));
+    assert_eq!(eff_val, Err(OutOfRangeError::too_big(false)));
 }

units/src/amount/unsigned.rs

@@ -248,13 +248,23 @@ impl Amount {
     ///
     /// * `fee_rate` - the fee rate of the transaction being created.
     /// * `weight` - the predicted input weight.
+    ///
+    /// # Errors
+    ///  
+    /// If fee_rate multiplied by weight exceeds SignedAmount::MAX
     pub fn to_effective_value(
         &self,
         fee_rate: FeeRate,
-        weight: Weight,
-    ) -> Option<SignedAmount> {
-        let signed_input_fee = fee_rate.to_fee(weight)?.to_signed();
-        self.to_signed().checked_sub(signed_input_fee)
+        weight: Weight
+    ) -> Result<SignedAmount, OutOfRangeError> {
+        let signed_input_fee = fee_rate.to_fee(weight).ok_or(
+            OutOfRangeError { is_signed: false, is_greater_than_max: true }
+        )?.to_signed();
+
+        // it's not possible to overflow when subtracted by the smallest given:
+        // Amount::MIN - SignedAmount::MAX = SignedAmount::MIN
+        let eff_val = (self.to_signed() - signed_input_fee).unwrap();  //unwrap ok
+        Ok(eff_val)
     }
 
     /// Converts this [`Amount`] in floating-point notation in the given [`Denomination`].