Merge #42: Fix TxOut::is_fee, add confidential is_explicit and unwrap_explicit, add Transaction::fee

cbb9674 Add tests for fee getter to all vectors (Steven Roose)
413c3c7 Add Transaction::fee getter (Steven Roose)
6a5c4c3 Add explicit() method for confidential::Value (Steven Roose)
0194fb0 Fix Transaction::is_fee (Steven Roose)
4fb43b4 Add is_explicit methods to confidential types (Steven Roose)

Pull request description:

ACKs for top commit:
  jonasnick:
    ACK cbb9674

Tree-SHA512: c1afe499bec0838790c09482107a89d4d110d4b42d12aa813fadb1fb00cf8937f653fe6c943f32c27d9a7de348795b88aa5dd1b4212eb7d5ba1eb987e1e0a1a7

Author: jonasnick

src/confidential.rs

@@ -182,6 +182,23 @@ impl Value {
             Value::Confidential(..) => 33,
         }
     }
+
+    /// Check if the value is explicit.
+    pub fn is_explicit(&self) -> bool {
+        match *self {
+            Value::Explicit(_) => true,
+            _ => false,
+        }
+    }
+
+    /// Returns the explicit value.
+    /// Returns [None] if [is_explicit] returns false.
+    pub fn explicit(&self) -> Option<u64> {
+        match *self {
+            Value::Explicit(v) => Some(v),
+            _ => None,
+        }
+    }
 }
 
 /// A CT commitment to an asset
@@ -205,6 +222,23 @@ impl Asset {
             Asset::Confidential(..) => 33,
         }
     }
+
+    /// Check if the asset is explicit.
+    pub fn is_explicit(&self) -> bool {
+        match *self {
+            Asset::Explicit(_) => true,
+            _ => false,
+        }
+    }
+
+    /// Unwrap the explicit value of this type.
+    /// Panics if [is_explicit] returns false.
+    pub fn unwrap_explicit(&self) -> sha256d::Hash {
+        match *self {
+            Asset::Explicit(v) => v,
+            _ => panic!("Called unwrap_explicit on non-explicit asset: {:?}", self),
+        }
+    }
 }
 
 
@@ -231,6 +265,23 @@ impl Nonce {
             Nonce::Confidential(..) => 33,
         }
     }
+
+    /// Check if the nonce is explicit.
+    pub fn is_explicit(&self) -> bool {
+        match *self {
+            Nonce::Explicit(_) => true,
+            _ => false,
+        }
+    }
+
+    /// Unwrap the explicit value of this type.
+    /// Panics if [is_explicit] returns false.
+    pub fn unwrap_explicit(&self) -> sha256d::Hash {
+        match *self {
+            Nonce::Explicit(v) => v,
+            _ => panic!("Called unwrap_explicit on non-explicit nonce: {:?}", self),
+        }
+    }
 }
 
 #[cfg(test)]

src/transaction.rs

@@ -462,7 +462,7 @@ impl TxOut {
 
     /// Whether or not this output is a fee output
     pub fn is_fee(&self) -> bool {
-        self.script_pubkey.is_empty()
+        self.script_pubkey.is_empty() && self.value.is_explicit() && self.asset.is_explicit()
     }
 
     /// Extracts the minimum value from the rangeproof, if there is one, or returns 0.
@@ -612,6 +612,12 @@ impl Transaction {
         self.consensus_encode(&mut enc).unwrap();
         bitcoin::Wtxid::from_engine(enc)
     }
+
+    /// Get the total transaction fee.
+    pub fn fee(&self) -> u64 {
+        // All values should be explicit, so we don't have to assert that here.
+        self.output.iter().filter(|o| o.is_fee()).filter_map(|o| o.value.explicit()).sum()
+    }
 }
 
 //TODO(stevenroose) remove this, it's incorrect
@@ -745,6 +751,7 @@ mod tests {
         assert_eq!(tx.output[1].value, confidential::Value::Explicit(      3300));
         assert_eq!(tx.output[0].minimum_value(), 9999996700);
         assert_eq!(tx.output[1].minimum_value(),       3300);
+        assert_eq!(tx.fee(), 3300);
 
         // CT transaction with explicit input (with script witness) and confidential outputs
         let tx: Transaction = hex_deserialize!(
@@ -963,6 +970,8 @@ mod tests {
         assert_eq!(tx.output[1].is_null_data(), false);
         assert_eq!(tx.output[2].is_null_data(), false);
 
+        assert_eq!(tx.fee(), 36480);
+
         // Coinbase tx
         let tx: Transaction = hex_deserialize!(
             "0200000001010000000000000000000000000000000000000000000000000000\
@@ -997,6 +1006,7 @@ mod tests {
         assert_eq!(tx.output[1].is_pegout(), false);
         assert_eq!(tx.output[0].pegout_data(), None);
         assert_eq!(tx.output[1].pegout_data(), None);
+        assert_eq!(tx.fee(), 0);
     }
 
     #[test]
@@ -1120,6 +1130,7 @@ mod tests {
         assert_eq!(tx.output[1].is_pegout(), false);
         assert_eq!(tx.output[0].pegout_data(), None);
         assert_eq!(tx.output[1].pegout_data(), None);
+        assert_eq!(tx.fee(), 6260);
     }
 
     #[test]
@@ -1147,6 +1158,7 @@ mod tests {
         assert_eq!(tx.output.len(), 1);
         assert_eq!(tx.output[0].is_null_data(), true);
         assert_eq!(tx.output[0].is_pegout(), true);
+        assert_eq!(tx.fee(), 0);
         assert_eq!(
             tx.output[0].pegout_data(),
             Some(super::PegoutData {
@@ -1498,6 +1510,7 @@ mod tests {
         assert_eq!(tx.input.len(), 1);
         assert_eq!(tx.output.len(), 3);
         assert_eq!(tx.input[0].has_issuance, true);
+        assert_eq!(tx.fee(), 56400);
         assert_eq!(
             tx.input[0].asset_issuance,
             AssetIssuance {
@@ -1620,6 +1633,7 @@ mod tests {
 
         assert_eq!(tx.output[0].asset, tx.output[1].asset);
         assert_eq!(tx.output[2].asset, tx.output[1].asset);
+        assert_eq!(tx.fee(), 1788);
     }
 
     #[test]
@@ -1661,6 +1675,7 @@ mod tests {
 
         assert_eq!(tx.output[0].asset, tx.output[1].asset);
         assert_eq!(tx.output[2].asset, tx.output[1].asset);
+        assert_eq!(tx.fee(), 1788);
     }
 
     #[test]
@@ -1701,6 +1716,7 @@ mod tests {
 
         assert_eq!(tx.output[0].asset, tx.output[1].asset);
         assert_eq!(tx.output[2].asset, tx.output[1].asset);
+        assert_eq!(tx.fee(), 1788);
     }
 }