Include tip in fee

CHANGELOG.md

@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ### Changed
 #### Breaking
 
+- [#682](https://github.com/FuelLabs/fuel-vm/pull/682): Include `Tip` policy in fee calculation
 - [#683](https://github.com/FuelLabs/fuel-vm/pull/683): Simplify `InterpreterStorage` by removing dependency on `MerkleRootStorage` and removing `merkle_` prefix from method names.
 - [#672](https://github.com/FuelLabs/fuel-vm/pull/672): Remove `GasPrice` policy
 - [#672](https://github.com/FuelLabs/fuel-vm/pull/672): Add `gas_price` field to transaction execution

fuel-tx/src/transaction/fee.rs

@@ -1,6 +1,9 @@
 use crate::{
     field,
-    field::WitnessLimit,
+    field::{
+        Tip,
+        WitnessLimit,
+    },
     input::{
         coin::{
             CoinPredicate,
@@ -13,6 +16,7 @@ use crate::{
             MessageDataSigned,
         },
     },
+    policies::PolicyType,
     FeeParameters,
     GasCosts,
     Input,
@@ -92,10 +96,17 @@ impl TransactionFee {
     where
         T: Chargeable,
     {
+        let tip = tx.tip();
         let min_gas = tx.min_gas(gas_costs, params);
         let max_gas = tx.max_gas(gas_costs, params);
-        let min_fee = tx.min_fee(gas_costs, params, gas_price).try_into().ok()?;
-        let max_fee = tx.max_fee(gas_costs, params, gas_price).try_into().ok()?;
+        let min_fee = tx
+            .min_fee(gas_costs, params, gas_price, tip)
+            .try_into()
+            .ok()?;
+        let max_fee = tx
+            .max_fee(gas_costs, params, gas_price, tip)
+            .try_into()
+            .ok()?;
 
         if min_fee > max_fee {
             return None;
@@ -150,12 +161,14 @@ pub trait Chargeable: field::Inputs + field::Witnesses + field::Policies {
         gas_costs: &GasCosts,
         fee: &FeeParameters,
         gas_price: Word,
+        tip: Word,
     ) -> u128 {
-        gas_to_fee(
+        let gas_fee = gas_to_fee(
             self.min_gas(gas_costs, fee),
             gas_price,
             fee.gas_price_factor,
-        )
+        );
+        gas_fee + tip as u128
     }
 
     /// Returns the maximum possible fee after the end of transaction execution.
@@ -166,12 +179,14 @@ pub trait Chargeable: field::Inputs + field::Witnesses + field::Policies {
         gas_costs: &GasCosts,
         fee: &FeeParameters,
         gas_price: Word,
+        tip: Word,
     ) -> u128 {
-        gas_to_fee(
+        let gas_fee = gas_to_fee(
             self.max_gas(gas_costs, fee),
             gas_price,
             fee.gas_price_factor,
-        )
+        );
+        gas_fee + tip as u128
     }
 
     /// Returns the fee amount that can be refunded back based on the `used_gas` and
@@ -192,8 +207,9 @@ pub trait Chargeable: field::Inputs + field::Witnesses + field::Policies {
         let total_used_gas = min_gas.saturating_add(used_gas);
         let used_fee = gas_to_fee(total_used_gas, gas_price, fee.gas_price_factor);
 
+        let tip = self.policies().get(PolicyType::Tip).unwrap_or(0);
         let refund = self
-            .max_fee(gas_costs, fee, gas_price)
+            .max_fee(gas_costs, fee, gas_price, tip)
             .saturating_sub(used_fee);
         // It is okay to saturate everywhere above because it only can decrease the value
         // of `refund`. But here, because we need to return the amount we

fuel-tx/src/transaction/validity.rs

@@ -349,7 +349,8 @@ where
     }
 
     if let Some(max_fee_limit) = tx.policies().get(PolicyType::MaxFee) {
-        if tx.max_fee(gas_costs, fee_params, gas_price) > max_fee_limit as u128 {
+        let tip = tx.policies().get(PolicyType::Tip).unwrap_or(0);
+        if tx.max_fee(gas_costs, fee_params, gas_price, tip) > max_fee_limit as u128 {
             Err(ValidityError::TransactionMaxFeeLimitExceeded)?
         }
     }

fuel-vm/src/checked_transaction.rs

@@ -646,6 +646,7 @@ impl From<PredicateVerificationFailed> for CheckError {
 }
 
 #[cfg(feature = "random")]
+#[allow(non_snake_case)]
 #[cfg(test)]
 mod tests {
     #![allow(clippy::cast_possible_truncation)]
@@ -656,6 +657,7 @@ mod tests {
     use fuel_tx::{
         field::{
             ScriptGasLimit,
+            Tip,
             WitnessLimit,
             Witnesses,
         },
@@ -949,6 +951,7 @@ mod tests {
         input_amount: u64,
         gas_price_factor: u64,
         seed: u64,
+        tip: u64,
     ) -> TestResult {
         // dont divide by zero
         if gas_price_factor == 0 {
@@ -966,8 +969,8 @@ mod tests {
         // When
         let refund = tx.refund_fee(&gas_costs, &fee_params, used_gas, gas_price);
 
-        let min_fee = tx.min_fee(&gas_costs, &fee_params, gas_price);
-        let max_fee = tx.max_fee(&gas_costs, &fee_params, gas_price);
+        let min_fee = tx.min_fee(&gas_costs, &fee_params, gas_price, tip);
+        let max_fee = tx.max_fee(&gas_costs, &fee_params, gas_price, tip);
 
         // Then
         if let Some(refund) = refund {
@@ -1466,6 +1469,76 @@ mod tests {
         assert_eq!(err, CheckError::Validity(ValidityError::BalanceOverflow));
     }
 
+    fn arb_tx(rng: &mut StdRng) -> Script {
+        let input_amount = 1000;
+        let gas_limit = 1000;
+        base_asset_tx(rng, input_amount, gas_limit)
+    }
+
+    #[test]
+    fn into_checked_basic__min_fee_calc_includes_tip() {
+        let rng = &mut StdRng::seed_from_u64(2322u64);
+        let gas_price = 1;
+        let mut tx = arb_tx(rng);
+
+        // given
+        let tipless_tx = tx.clone();
+
+        let min_fee_without_tip = tipless_tx
+            .into_checked_basic(1.into(), &ConsensusParameters::standard(), gas_price)
+            .unwrap()
+            .metadata()
+            .fee
+            .min_fee();
+
+        let tip = 100;
+
+        // when
+        tx.set_tip(tip);
+
+        let min_fee_with_tip = tx
+            .into_checked_basic(1.into(), &ConsensusParameters::standard(), gas_price)
+            .unwrap()
+            .metadata()
+            .fee
+            .min_fee();
+
+        // then
+        assert_eq!(min_fee_without_tip + tip, min_fee_with_tip);
+    }
+
+    #[test]
+    fn into_checked_basic__max_fee_calc_includes_tip() {
+        let rng = &mut StdRng::seed_from_u64(2322u64);
+        let gas_price = 1;
+        let mut tx = arb_tx(rng);
+
+        // given
+        let tipless_tx = tx.clone();
+
+        let max_fee_without_tip = tipless_tx
+            .into_checked_basic(1.into(), &ConsensusParameters::standard(), gas_price)
+            .unwrap()
+            .metadata()
+            .fee
+            .max_fee();
+
+        let tip = 100;
+
+        // when
+        tx.set_tip(tip);
+
+        let max_fee_with_tip = tx
+            .into_checked_basic(1.into(), &ConsensusParameters::standard(), gas_price)
+            .unwrap()
+            .metadata()
+            .fee
+            .max_fee();
+
+        // then
+        assert_eq!(max_fee_without_tip + tip, max_fee_with_tip);
+    }
+
     #[test]
     fn gas_fee_cant_overflow() {
         let rng = &mut StdRng::seed_from_u64(2322u64);