Merge branch 'master' into feature/predicate-verfiicaiton-error

CHANGELOG.md

@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 #### Breaking
 
+- [#629](https://github.com/FuelLabs/fuel-vm/pull/629): Charge the user for VM initialization.
 - [#628](https://github.com/FuelLabs/fuel-vm/pull/628): Renamed `transaction::CheckError` to `transaction::ValidityError`.
   Created a new `checked_transaction::CheckError` that combines `ValidityError`
   and `PredicateVerificationFailed` errors into one. It allows the return of the
@@ -43,6 +44,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
     - If the `max_fee > policies.max_fee`, then transaction will be rejected.
     - If the `witnessses_size > policies.witness_limit`, then transaction will be rejected.
     - GTF opcode changed its hardcoded constants for fields. It should be updated according to the values from the specification on the Sway side.
+- [#633](https://github.com/FuelLabs/fuel-vm/pull/633): Limit receipt count to `u16::MAX`.
 
 ### Fixed
 

fuel-asm/src/panic_reason.rs

@@ -95,8 +95,9 @@ enum_from! {
         ExpectedOutputVariable = 0x1d,
         /// The expected context of the stack parent is internal.
         ExpectedParentInternalContext = 0x1e,
-        /// The jump instruction cannot move backwards in predicate verification.
-        IllegalJump = 0x1f,
+        /// The predicate returned non `1`. The `1` means successful verification
+        /// of the predicate, all other values means unsuccessful.
+        PredicateReturnedNonOne = 0x1f,
         /// The contract ID is already deployed and can't be overwritten.
         ContractIdAlreadyDeployed = 0x20,
         /// The loaded contract mismatch expectations.
@@ -119,6 +120,8 @@ enum_from! {
         PolicyIsNotSet = 0x28,
         /// The policy is not found across policies.
         PolicyNotFound = 0x29,
+        /// Receipt context is full
+        TooManyReceipts = 0x2a,
     }
 }
 

fuel-tx/src/transaction/consensus_parameters/gas.rs

@@ -321,6 +321,7 @@ pub struct GasCostsValues {
     // Non-opcode costs
     pub contract_root: DependentCost,
     pub state_root: DependentCost,
+    pub vm_initialization: Word,
 }
 
 /// Dependent cost is a cost that depends on the number of units.
@@ -472,8 +473,11 @@ impl GasCostsValues {
             smo: DependentCost::free(),
             srwq: DependentCost::free(),
             swwq: DependentCost::free(),
+
+            // Non-opcode costs
             contract_root: DependentCost::free(),
             state_root: DependentCost::free(),
+            vm_initialization: 0,
         }
     }
 
@@ -586,8 +590,11 @@ impl GasCostsValues {
             smo: DependentCost::unit(),
             srwq: DependentCost::unit(),
             swwq: DependentCost::unit(),
+
+            // Non-opcode costs
             contract_root: DependentCost::unit(),
             state_root: DependentCost::unit(),
+            vm_initialization: 1,
         }
     }
 }

fuel-tx/src/transaction/consensus_parameters/gas/default_gas_costs.rs

@@ -161,6 +161,8 @@ pub fn default_gas_costs() -> GasCostsValues {
             base: 44,
             units_per_gas: 5,
         },
+
+        // Non-opcode costs
         contract_root: DependentCost::LightOperation {
             base: 75,
             units_per_gas: 1,
@@ -169,5 +171,6 @@ pub fn default_gas_costs() -> GasCostsValues {
             base: 412,
             units_per_gas: 1,
         },
+        vm_initialization: 2000,
     }
 }

fuel-tx/src/transaction/fee.rs

@@ -130,6 +130,7 @@ pub trait Chargeable: field::Inputs + field::Witnesses + field::Policies {
         self.gas_used_by_inputs(gas_costs)
             .saturating_add(self.gas_used_by_metadata(gas_costs))
             .saturating_add(bytes_gas)
+            .saturating_add(gas_costs.vm_initialization)
     }
 
     /// Returns the maximum possible gas after the end of transaction execution.
@@ -237,7 +238,8 @@ pub trait Chargeable: field::Inputs + field::Witnesses + field::Policies {
                 }) => gas_costs
                     .contract_root
                     .resolve(predicate.len() as u64)
-                    .saturating_add(*predicate_gas_used),
+                    .saturating_add(*predicate_gas_used)
+                    .saturating_add(gas_costs.vm_initialization),
                 // Charge nothing for all other inputs
                 _ => 0,
             })

fuel-vm/src/checked_transaction.rs

@@ -1009,6 +1009,7 @@ mod tests {
 
         let min_fee = fee.min_fee();
         let expected_min_fee = (tx.metered_bytes_size() as u64 * fee_params.gas_per_byte
+            + gas_costs.vm_initialization
             + 3 * gas_costs.ecr1
             + gas_costs.s256.resolve(tx.size() as u64))
             * gas_price;
@@ -1060,6 +1061,7 @@ mod tests {
         // be recovered once. Therefore, we charge only once for the address
         // recovery of the signed inputs.
         let expected_min_fee = (tx.metered_bytes_size() as u64 * fee_params.gas_per_byte
+            + gas_costs.vm_initialization
             + gas_costs.ecr1
             + gas_costs.s256.resolve(tx.size() as u64))
             * gas_price;
@@ -1124,9 +1126,11 @@ mod tests {
 
         let min_fee = fee.min_fee();
         let expected_min_fee = (tx.metered_bytes_size() as u64 * fee_params.gas_per_byte
+            + gas_costs.vm_initialization
             + gas_costs.contract_root.resolve(predicate_1.len() as u64)
             + gas_costs.contract_root.resolve(predicate_2.len() as u64)
             + gas_costs.contract_root.resolve(predicate_3.len() as u64)
+            + 3 * gas_costs.vm_initialization
             + 50
             + 100
             + 200
@@ -1208,9 +1212,11 @@ mod tests {
         let min_fee = fee.min_fee();
         let expected_min_fee = (tx.metered_bytes_size() as u64 * fee_params.gas_per_byte
             + 3 * gas_costs.ecr1
+            + gas_costs.vm_initialization
             + gas_costs.contract_root.resolve(predicate_1.len() as u64)
             + gas_costs.contract_root.resolve(predicate_2.len() as u64)
             + gas_costs.contract_root.resolve(predicate_3.len() as u64)
+            + 3 * gas_costs.vm_initialization
             + 50
             + 100
             + 200
@@ -1248,6 +1254,7 @@ mod tests {
         let expected_min_fee = (tx.metered_bytes_size() as u64 * fee_params.gas_per_byte
             + gas_costs.state_root.resolve(storage_slots_len as Word)
             + gas_costs.contract_root.resolve(bytecode_len as Word)
+            + gas_costs.vm_initialization
             + gas_costs.s256.resolve(100)
             + gas_costs.s256.resolve(tx.size() as u64))
             * gas_price;
@@ -1280,6 +1287,7 @@ mod tests {
         let expected_min_fee = (tx.metered_bytes_size() as u64 * fee_params.gas_per_byte
             + gas_costs.state_root.resolve(0)
             + gas_costs.contract_root.resolve(0)
+            + gas_costs.vm_initialization
             + gas_costs.s256.resolve(100)
             + gas_costs.s256.resolve(tx.size() as u64))
             * gas_price;
@@ -1567,7 +1575,8 @@ mod tests {
         let gas_used_by_metadata = tx.gas_used_by_metadata(gas_costs);
         let min_gas = gas_used_by_bytes
             .saturating_add(gas_used_by_inputs)
-            .saturating_add(gas_used_by_metadata);
+            .saturating_add(gas_used_by_metadata)
+            .saturating_add(gas_costs.vm_initialization);
 
         // use different division mechanism than impl
         let witness_limit_allowance = tx
@@ -1605,7 +1614,8 @@ mod tests {
         let gas_used_by_metadata = tx.gas_used_by_metadata(gas_costs);
         let gas = gas_used_by_bytes
             .saturating_add(gas_used_by_inputs)
-            .saturating_add(gas_used_by_metadata);
+            .saturating_add(gas_used_by_metadata)
+            .saturating_add(gas_costs.vm_initialization);
         let total = gas as u128 * tx.price() as u128;
         // use different division mechanism than impl
         let fee = total / fee_params.gas_price_factor as u128;

fuel-vm/src/error.rs

@@ -348,6 +348,10 @@ pub enum BugVariant {
     /// Refund cannot be computed in the current vm state.
     #[strum(message = "Refund cannot be computed in the current vm state.")]
     UncomputableRefund,
+
+    /// Receipts context is full, but there's an attempt to add more receipts.
+    #[strum(message = "Receipts context is full, cannot add new receipts.")]
+    ReceiptsCtxFull,
 }
 
 impl fmt::Display for BugVariant {

fuel-vm/src/interpreter/blockchain.rs

@@ -622,7 +622,7 @@ where
 
         let receipt = Receipt::burn(*sub_id, *contract_id, a, *self.pc, *self.is);
 
-        append_receipt(self.append, receipt);
+        append_receipt(self.append, receipt)?;
 
         Ok(inc_pc(self.pc)?)
     }
@@ -660,7 +660,7 @@ where
 
         let receipt = Receipt::mint(*sub_id, *contract_id, a, *self.pc, *self.is);
 
-        append_receipt(self.append, receipt);
+        append_receipt(self.append, receipt)?;
 
         Ok(inc_pc(self.pc)?)
     }
@@ -1021,7 +1021,7 @@ where
                 memory: self.memory,
             },
             receipt,
-        );
+        )?;
 
         Ok(inc_pc(self.pc)?)
     }

fuel-vm/src/interpreter/contract.rs

@@ -268,7 +268,7 @@ impl<'vm, S, Tx> TransferCtx<'vm, S, Tx> {
                 memory: self.memory,
             },
             receipt,
-        );
+        )?;
 
         Ok(inc_pc(self.pc)?)
     }
@@ -340,7 +340,7 @@ impl<'vm, S, Tx> TransferCtx<'vm, S, Tx> {
                 memory: self.memory,
             },
             receipt,
-        );
+        )?;
 
         Ok(inc_pc(self.pc)?)
     }

fuel-vm/src/interpreter/diff/tests.rs

@@ -126,7 +126,7 @@ fn reset_vm_state_receipts() {
         Default::default(),
         Default::default(),
     );
-    b.receipts.push(receipt);
+    b.receipts.push(receipt).expect("not full");
     assert_ne!(a.receipts, b.receipts);
     let diff: Diff<InitialVmState> = a.diff(&b).into();
     b.reset_vm_state(&diff);

fuel-vm/src/interpreter/executors/instruction.rs

@@ -600,7 +600,7 @@ where
                 self.gas_charge(self.gas_costs().rvrt)?;
                 let a = rvrt.unpack();
                 let ra = r!(a);
-                self.revert(ra);
+                self.revert(ra)?;
                 return Ok(ExecuteState::Revert(ra))
             }
 

fuel-vm/src/interpreter/executors/main.rs

@@ -560,7 +560,7 @@ where
 
             let receipt = Receipt::script_result(status, gas_used);
 
-            self.append_receipt(receipt);
+            self.append_receipt(receipt)?;
 
             if program.is_debug() {
                 self.debugger_set_last_state(program);

fuel-vm/src/interpreter/executors/predicate.rs

@@ -45,7 +45,7 @@ where
                     if r == 1 {
                         return Ok(ProgramState::Return(r))
                     } else {
-                        return Err(PanicReason::ContractInstructionNotAllowed.into())
+                        return Err(PanicReason::PredicateReturnedNonOne.into())
                     }
                 }
 

fuel-vm/src/interpreter/flow.rs

@@ -137,7 +137,7 @@ where
         input.ret_data(a, b)
     }
 
-    pub(crate) fn revert(&mut self, a: Word) {
+    pub(crate) fn revert(&mut self, a: Word) -> SimpleResult<()> {
         let current_contract =
             current_contract(&self.context, self.registers.fp(), self.memory.as_ref())
                 .map_or_else(|_| Some(ContractId::zeroed()), Option::<&_>::copied);
@@ -172,7 +172,8 @@ where
         };
         self.panic_context = PanicContext::None;
 
-        self.append_receipt(receipt);
+        self.append_receipt(receipt)
+            .expect("Appending a panic receipt cannot fail");
     }
 }
 
@@ -227,7 +228,7 @@ impl RetCtx<'_> {
             set_frame_pointer(context, registers.fp_mut(), fp);
         }
 
-        append_receipt(self.append, receipt);
+        append_receipt(self.append, receipt)?;
 
         Ok(inc_pc(self.registers.pc_mut())?)
     }
@@ -261,15 +262,15 @@ pub(crate) fn revert(
     pc: Reg<PC>,
     is: Reg<IS>,
     a: Word,
-) {
+) -> SimpleResult<()> {
     let receipt = Receipt::revert(
         current_contract.unwrap_or_else(ContractId::zeroed),
         a,
         *pc,
         *is,
     );
 
-    append_receipt(append, receipt);
+    append_receipt(append, receipt)
 }
 
 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
@@ -628,7 +629,7 @@ where
                 memory: self.memory.memory,
             },
             receipt,
-        );
+        )?;
 
         self.frames.push(frame);
 

fuel-vm/src/interpreter/flow/ret_tests.rs

@@ -179,7 +179,7 @@ fn test_revert() {
     };
     let pc = 10;
     let is = 20;
-    revert(append, None, Reg::new(&pc), Reg::new(&is), 99);
+    revert(append, None, Reg::new(&pc), Reg::new(&is), 99).expect("should be ok");
     assert_eq!(
         *receipts.as_ref().last().unwrap(),
         Receipt::revert(ContractId::default(), 99, pc, is)

fuel-vm/src/interpreter/internal.rs

@@ -55,7 +55,7 @@ where
         update_memory_output(&mut self.tx, &mut self.memory, tx_offset, idx)
     }
 
-    pub(crate) fn append_receipt(&mut self, receipt: Receipt) {
+    pub(crate) fn append_receipt(&mut self, receipt: Receipt) -> SimpleResult<()> {
         let tx_offset = self.tx_offset();
         append_receipt(
             AppendReceipt {
@@ -128,14 +128,14 @@ pub(crate) struct AppendReceipt<'vm> {
     pub memory: &'vm mut [u8; MEM_SIZE],
 }
 
-pub(crate) fn append_receipt(input: AppendReceipt, receipt: Receipt) {
+pub(crate) fn append_receipt(input: AppendReceipt, receipt: Receipt) -> SimpleResult<()> {
     let AppendReceipt {
         receipts,
         script,
         tx_offset,
         memory,
     } = input;
-    receipts.push(receipt);
+    receipts.push(receipt)?;
 
     if let Some(script) = script {
         let offset = tx_offset + script.receipts_root_offset();
@@ -151,6 +151,8 @@ pub(crate) fn append_receipt(input: AppendReceipt, receipt: Receipt) {
         // guaranteed to fit
         memory[offset..offset + Bytes32::LEN].copy_from_slice(&root[..]);
     }
+
+    Ok(())
 }
 
 impl<S, Tx, Ecal> Interpreter<S, Tx, Ecal> {

fuel-vm/src/interpreter/log.rs

@@ -102,7 +102,7 @@ impl LogInput<'_> {
                 memory: self.memory,
             },
             receipt,
-        );
+        )?;
 
         Ok(inc_pc(self.pc)?)
     }
@@ -128,7 +128,7 @@ impl LogInput<'_> {
                 memory: self.memory,
             },
             receipt,
-        );
+        )?;
 
         Ok(inc_pc(self.pc)?)
     }