Process Upgrade transaction inside of the Interpreter

CHANGELOG.md

@@ -11,6 +11,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 #### Breaking
 
+- [#712](https://github.com/FuelLabs/fuel-vm/pull/712): The `Interpreter` supports the processing of the `Upgrade` transaction. The change affects `InterpreterStorage`, adding 5 new methods that must be implemented.
 - [#707](https://github.com/FuelLabs/fuel-vm/pull/707): The change adds a new `Upgrade` transaction that allows upgrading either consensus parameters or state transition function used by the network to produce future blocks.
     The purpose of the upgrade is defined by the `Upgrade Purpose` type:
 

fuel-asm/src/panic_reason.rs

@@ -137,6 +137,12 @@ enum_from! {
         /// Attempting to read or write uninitialized memory.
         /// Also occurs when boundary crosses from stack to heap.
         UninitalizedMemoryAccess = 0x30,
+        /// Overriding consensus parameters is not allowed.
+        OverridingConsensusParameters = 0x31,
+        /// The storage doesn't know about the hash of the state transition bytecode.
+        UnknownStateTransactionBytecodeHash = 0x32,
+        /// Overriding the state transition bytecode is not allowed.
+        OverridingStateTransactionBytecode = 0x33,
     }
 }
 

fuel-tx/src/lib.rs

@@ -80,6 +80,8 @@ pub use transaction::{
     policies,
     Cacheable,
     Chargeable,
+    ChargeableMetadata,
+    ChargeableTransaction,
     ConsensusParameters,
     ContractParameters,
     Create,
@@ -102,6 +104,7 @@ pub use transaction::{
     TxParameters,
     Upgrade,
     UpgradeBody,
+    UpgradeMetadata,
     UpgradePurpose,
     UtxoId,
     ValidityError,

fuel-tx/src/transaction/types.rs

@@ -9,6 +9,10 @@ mod upgrade;
 mod utxo_id;
 mod witness;
 
+pub use chargeable_transaction::{
+    ChargeableMetadata,
+    ChargeableTransaction,
+};
 pub use create::{
     Create,
     CreateBody,
@@ -22,6 +26,7 @@ pub use storage::StorageSlot;
 pub use upgrade::{
     Upgrade,
     UpgradeBody,
+    UpgradeMetadata,
     UpgradePurpose,
 };
 pub use utxo_id::UtxoId;

fuel-vm/src/interpreter/blockchain/code_tests.rs

@@ -15,7 +15,7 @@ use fuel_tx::Contract;
 
 #[test]
 fn test_load_contract() -> IoResult<(), Infallible> {
-    let mut storage = MemoryStorage::new(Default::default(), Default::default());
+    let mut storage = MemoryStorage::default();
     let mut memory: Memory = vec![1u8; MEM_SIZE].try_into().unwrap();
     let mut pc = 4;
     let mut cgas = 1000;
@@ -70,7 +70,7 @@ fn test_load_contract() -> IoResult<(), Infallible> {
 
 #[test]
 fn test_code_copy() -> IoResult<(), Infallible> {
-    let mut storage = MemoryStorage::new(Default::default(), Default::default());
+    let mut storage = MemoryStorage::default();
     let mut memory: Memory = vec![1u8; MEM_SIZE].try_into().unwrap();
     let mut cgas = 1000;
     let mut ggas = 1000;

fuel-vm/src/interpreter/blockchain/croo_tests.rs

@@ -54,7 +54,7 @@ fn test_code_root() {
     // Given
     let contract_id = new_contract_id();
 
-    let mut storage = MemoryStorage::new(Default::default(), Default::default());
+    let mut storage = MemoryStorage::default();
     let mut memory: Memory = vec![1u8; MEM_SIZE].try_into().unwrap();
     memory[0..ContractId::LEN].copy_from_slice(contract_id.as_slice());
 
@@ -114,7 +114,7 @@ fn test_code_root_contract_not_found() {
     // Given
     let contract_id = new_contract_id();
 
-    let storage = MemoryStorage::new(Default::default(), Default::default());
+    let storage = MemoryStorage::default();
     let mut memory: Memory = vec![1u8; MEM_SIZE].try_into().unwrap();
     memory[0..ContractId::LEN].copy_from_slice(contract_id.as_slice());
 
@@ -161,7 +161,7 @@ fn test_code_root_contract_not_in_inputs() {
     // Given
     let contract_id = new_contract_id();
 
-    let storage = MemoryStorage::new(Default::default(), Default::default());
+    let storage = MemoryStorage::default();
     let mut memory: Memory = vec![1u8; MEM_SIZE].try_into().unwrap();
     memory[0..ContractId::LEN].copy_from_slice(contract_id.as_slice());
 

fuel-vm/src/interpreter/blockchain/other_tests.rs

@@ -30,7 +30,7 @@ fn test_burn(
     amount: Word,
     sub_id: [u8; 32],
 ) -> IoResult<(), Infallible> {
-    let mut storage = MemoryStorage::new(Default::default(), Default::default());
+    let mut storage = MemoryStorage::default();
     let mut memory: Memory = vec![1u8; MEM_SIZE].try_into().unwrap();
     let contract_id = ContractId::from([3u8; 32]);
     memory[0..ContractId::LEN].copy_from_slice(contract_id.as_slice());
@@ -108,7 +108,7 @@ fn test_mint(
     amount: Word,
     sub_id: [u8; 32],
 ) -> IoResult<(), Infallible> {
-    let mut storage = MemoryStorage::new(Default::default(), Default::default());
+    let mut storage = MemoryStorage::default();
     let mut memory: Memory = vec![1u8; MEM_SIZE].try_into().unwrap();
     let contract_id = ContractId::from([3u8; 32]);
     memory[0..ContractId::LEN].copy_from_slice(contract_id.as_slice());
@@ -176,7 +176,7 @@ fn test_mint(
 
 #[test]
 fn test_block_hash() {
-    let storage = MemoryStorage::new(Default::default(), Default::default());
+    let storage = MemoryStorage::default();
     let mut memory: Memory = vec![1u8; MEM_SIZE].try_into().unwrap();
     let owner = OwnershipRegisters {
         sp: 1000,
@@ -207,7 +207,7 @@ fn test_block_height() {
 
 #[test]
 fn test_coinbase() {
-    let storage = MemoryStorage::new(Default::default(), Default::default());
+    let storage = MemoryStorage::new(Default::default(), ContractId::zeroed());
     let mut memory: Memory = vec![1u8; MEM_SIZE].try_into().unwrap();
     let owner = OwnershipRegisters {
         sp: 1000,
@@ -227,7 +227,7 @@ fn test_coinbase() {
 #[test]
 fn test_code_size() {
     let contract_id = ContractId::new([3u8; ContractId::LEN]);
-    let mut storage = MemoryStorage::new(Default::default(), Default::default());
+    let mut storage = MemoryStorage::default();
     let mut memory: Memory = vec![1u8; MEM_SIZE].try_into().unwrap();
     memory[0..ContractId::LEN].copy_from_slice(contract_id.as_slice());
     StorageAsMut::storage::<ContractsRawCode>(&mut storage)
@@ -294,7 +294,7 @@ fn test_code_size() {
 
 #[test]
 fn test_timestamp() {
-    let storage = MemoryStorage::new(Default::default(), Default::default());
+    let storage = MemoryStorage::default();
     let mut pc = 4;
     let mut result = 0;
     let _ = timestamp(

fuel-vm/src/interpreter/blockchain/smo_tests.rs

@@ -216,7 +216,7 @@ fn test_smo(
         memory[offset..offset + bytes.len()].copy_from_slice(bytes.as_slice());
     }
     let mut receipts = Default::default();
-    let mut storage = MemoryStorage::new(Default::default(), Default::default());
+    let mut storage = MemoryStorage::default();
     let old_balance = storage
         .contract_asset_id_balance_insert(
             &ContractId::default(),

fuel-vm/src/interpreter/blockchain/test.rs

@@ -67,7 +67,7 @@ fn test_state_read_word(
     insert: impl Into<Option<Word>>,
     key: Word,
 ) -> Result<(Word, Word), RuntimeError<Infallible>> {
-    let mut storage = MemoryStorage::new(Default::default(), Default::default());
+    let mut storage = MemoryStorage::default();
     let mut memory: Memory = vec![1u8; MEM_SIZE].try_into().unwrap();
     memory[0..ContractId::LEN].copy_from_slice(&[3u8; ContractId::LEN][..]);
     memory[32..64].copy_from_slice(&[4u8; 32][..]);
@@ -137,7 +137,7 @@ fn test_state_write_word(
     insert: bool,
     key: Word,
 ) -> Result<Word, RuntimeError<Infallible>> {
-    let mut storage = MemoryStorage::new(Default::default(), Default::default());
+    let mut storage = MemoryStorage::default();
     let mut memory: Memory = vec![1u8; MEM_SIZE].try_into().unwrap();
     memory[0..ContractId::LEN].copy_from_slice(&[3u8; ContractId::LEN][..]);
     memory[32..64].copy_from_slice(&[4u8; 32][..]);

fuel-vm/src/interpreter/blockchain/test/scwq.rs

@@ -101,7 +101,7 @@ fn test_state_clear_qword(
         storage_slots,
         memory,
     } = input;
-    let mut storage = MemoryStorage::new(Default::default(), Default::default());
+    let mut storage = MemoryStorage::default();
 
     for (k, v) in storage_slots {
         storage

fuel-vm/src/interpreter/blockchain/test/srwq.rs

@@ -166,7 +166,7 @@ fn test_state_read_qword(
         origin_key_pointer,
         num_slots,
     } = input;
-    let mut storage = MemoryStorage::new(Default::default(), Default::default());
+    let mut storage = MemoryStorage::default();
     for (k, v) in storage_slots {
         storage
             .storage::<ContractsState>()

fuel-vm/src/interpreter/blockchain/test/swwq.rs

@@ -221,7 +221,7 @@ fn test_state_write_qword(
         storage_slots,
         memory,
     } = input;
-    let mut storage = MemoryStorage::new(Default::default(), Default::default());
+    let mut storage = MemoryStorage::default();
 
     for (k, v) in storage_slots {
         storage

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

@@ -29,7 +29,7 @@ fn test_contract_balance(b: Word, c: Word) -> IoResult<(), Infallible> {
     memory[c as usize..(c as usize + ContractId::LEN)]
         .copy_from_slice(&[3u8; ContractId::LEN][..]);
     let contract_id = ContractId::from([3u8; 32]);
-    let mut storage = MemoryStorage::new(Default::default(), Default::default());
+    let mut storage = MemoryStorage::default();
     let old_balance = storage
         .contract_asset_id_balance_insert(&contract_id, &AssetId::from([2u8; 32]), 33)
         .unwrap();
@@ -97,7 +97,7 @@ fn test_transfer(
     memory[fp as usize..(fp as usize + ContractId::LEN)]
         .copy_from_slice(SOURCE_CONTRACT_ID.as_ref());
 
-    let mut storage = MemoryStorage::new(Default::default(), Default::default());
+    let mut storage = MemoryStorage::default();
 
     let initial_recipient_contract_balance = 0;
     let initial_source_contract_balance = 60;
@@ -240,7 +240,7 @@ fn test_transfer_output(
     memory[fp as usize..(fp as usize + ContractId::LEN)]
         .copy_from_slice(SOURCE_CONTRACT_ID.as_ref());
 
-    let mut storage = MemoryStorage::new(Default::default(), Default::default());
+    let mut storage = MemoryStorage::default();
 
     let initial_contract_balance = 60;
 
@@ -359,7 +359,7 @@ fn test_balance_increase(
 ) -> IoResult<(), Infallible> {
     let contract_id = ContractId::from([3u8; 32]);
     let asset_id = AssetId::from([2u8; 32]);
-    let mut storage = MemoryStorage::new(Default::default(), Default::default());
+    let mut storage = MemoryStorage::default();
     let initial = initial.into();
     if let Some(initial) = initial {
         let old_balance = storage
@@ -397,7 +397,7 @@ fn test_balance_decrease(
 ) -> IoResult<(), Infallible> {
     let contract_id = ContractId::from([3u8; 32]);
     let asset_id = AssetId::from([2u8; 32]);
-    let mut storage = MemoryStorage::new(Default::default(), Default::default());
+    let mut storage = MemoryStorage::default();
     let initial = initial.into();
     if let Some(initial) = initial {
         let old_balance = storage

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

@@ -1,3 +1,4 @@
+use alloc::borrow::Cow;
 use core::fmt::Debug;
 use hashbrown::HashMap;
 
@@ -6,6 +7,7 @@ use fuel_storage::{
     StorageSize,
     StorageWrite,
 };
+use fuel_tx::ConsensusParameters;
 use fuel_types::{
     BlockHeight,
     Bytes32,
@@ -395,6 +397,14 @@ where
         self.0.block_height()
     }
 
+    fn consensus_parameters_version(&self) -> Result<u32, Self::DataError> {
+        self.0.consensus_parameters_version()
+    }
+
+    fn state_transition_version(&self) -> Result<u32, Self::DataError> {
+        self.0.state_transition_version()
+    }
+
     fn timestamp(&self, height: BlockHeight) -> Result<Word, Self::DataError> {
         self.0.timestamp(height)
     }
@@ -407,6 +417,30 @@ where
         self.0.coinbase()
     }
 
+    fn set_consensus_parameters(
+        &mut self,
+        version: u32,
+        consensus_parameters: &ConsensusParameters,
+    ) -> Result<Option<Cow<'_, ConsensusParameters>>, Self::DataError> {
+        self.0
+            .set_consensus_parameters(version, consensus_parameters)
+    }
+
+    fn contains_state_transition_bytecode_hash(
+        &self,
+        hash: &Bytes32,
+    ) -> Result<bool, Self::DataError> {
+        self.0.contains_state_transition_bytecode_hash(hash)
+    }
+
+    fn set_state_transition_bytecode(
+        &mut self,
+        version: u32,
+        hash: &Bytes32,
+    ) -> Result<Option<Cow<'_, Bytes32>>, Self::DataError> {
+        self.0.set_state_transition_bytecode(version, hash)
+    }
+
     fn contract_state_range(
         &self,
         id: &ContractId,