add external transient_storage to pallet_revive::ExecConfig

prdoc/pr_10493.prdoc

@@ -0,0 +1,12 @@
+title: add external transient_storage to pallet_revive::ExecConfig
+doc:
+- audience: Node Dev
+  description: |-
+    # Description
+
+    This PR adds the ability to supply external copy of `TransientStorage` to `pallet_revive::ExecConfig` to be used during execution.
+    This is required by testing in foundry as we only enter `pallet_revive` during a `CALL` or `CREATE` instruction and we need to carryover 
+    the transient storage to other following calls as they happen within an external tx
+crates:
+- name: pallet-revive
+  bump: major

substrate/frame/revive/src/exec.rs

@@ -1269,7 +1269,9 @@ where
 			*caller_frame = Default::default();
 		}
 
-		self.transient_storage.start_transaction();
+		self.with_transient_storage(|transient_storage| {
+			transient_storage.start_transaction();
+		});
 		let is_first_frame = self.frames.is_empty();
 
 		let do_transaction = || -> ExecResult {
@@ -1495,12 +1497,13 @@ where
 				(false, Err(error.into()))
 			},
 		};
-
-		if success {
-			self.transient_storage.commit_transaction();
-		} else {
-			self.transient_storage.rollback_transaction();
-		}
+		self.with_transient_storage(|transient_storage| {
+			if success {
+				transient_storage.commit_transaction();
+			} else {
+				transient_storage.rollback_transaction();
+			}
+		});
 		log::trace!(target: LOG_TARGET, "frame finished with: {output:?}");
 
 		self.pop_frame(success);
@@ -1630,11 +1633,11 @@ where
 		let value = BalanceWithDust::<BalanceOf<T>>::from_value::<T>(value)
 			.map_err(|_| Error::<T>::BalanceConversionFailed)?;
 		if value.is_zero() {
-			return Ok(());
+			return Ok(())
 		}
 
 		if <System<T>>::account_exists(to) {
-			return transfer_with_dust::<T>(from, to, value, preservation)
+			return transfer_with_dust::<T>(from, to, value, preservation);
 		}
 
 		let origin = origin.account_id()?;
@@ -1840,6 +1843,21 @@ where
 		}
 		true
 	}
+
+	fn with_transient_storage<R, F: FnOnce(&mut TransientStorage<T>) -> R>(&mut self, f: F) -> R {
+		if let Some(transient) = &self.exec_config.transient_storage {
+			f(&mut transient.borrow_mut())
+		} else {
+			f(&mut self.transient_storage)
+		}
+	}
+	fn with_transient_storage_ref<R, F: FnOnce(&TransientStorage<T>) -> R>(&self, f: F) -> R {
+		if let Some(transient) = &self.exec_config.transient_storage {
+			f(&transient.borrow())
+		} else {
+			f(&self.transient_storage)
+		}
+	}
 }
 
 impl<'a, T, E> Ext for Stack<'a, T, E>
@@ -2172,13 +2190,15 @@ where
 	}
 
 	fn get_transient_storage(&self, key: &Key) -> Option<Vec<u8>> {
-		self.transient_storage.read(self.account_id(), key)
+		self.with_transient_storage_ref(|transient_storage| {
+			transient_storage.read(self.account_id(), key)
+		})
 	}
 
 	fn get_transient_storage_size(&self, key: &Key) -> Option<u32> {
-		self.transient_storage
-			.read(self.account_id(), key)
-			.map(|value| value.len() as _)
+		self.with_transient_storage_ref(|transient_storage| {
+			transient_storage.read(self.account_id(), key).map(|value| value.len() as _)
+		})
 	}
 
 	fn set_transient_storage(
@@ -2188,7 +2208,9 @@ where
 		take_old: bool,
 	) -> Result<WriteOutcome, DispatchError> {
 		let account_id = self.account_id().clone();
-		self.transient_storage.write(&account_id, key, value, take_old)
+		self.with_transient_storage(|transient_storage| {
+			transient_storage.write(&account_id, key, value, take_old)
+		})
 	}
 
 	fn account_id(&self) -> &T::AccountId {

substrate/frame/revive/src/lib.rs

@@ -100,12 +100,14 @@ pub use crate::{
 		ReceiptInfo,
 	},
 	exec::{CallResources, DelegateInfo, Executable, Key, MomentOf, Origin as ExecOrigin},
+	limits::TRANSIENT_STORAGE_BYTES as TRANSIENT_STORAGE_LIMIT,
 	metering::{
 		EthTxInfo, FrameMeter, ResourceMeter, Token as WeightToken, TransactionLimits,
 		TransactionMeter,
 	},
 	pallet::{genesis, *},
 	storage::{AccountInfo, ContractInfo},
+	transient_storage::{MeterEntry, StorageMeter as TransientStorageMeter, TransientStorage},
 	vm::{BytecodeType, ContractBlob},
 };
 pub use codec;

substrate/frame/revive/src/primitives.rs

@@ -18,11 +18,12 @@
 //! A crate that hosts a common definitions that are relevant for the pallet-revive.
 
 use crate::{
-	evm::DryRunConfig, mock::MockHandler, storage::WriteOutcome, BalanceOf, Config, Time, H160,
-	U256,
+	evm::DryRunConfig, mock::MockHandler, storage::WriteOutcome,
+	transient_storage::TransientStorage, BalanceOf, Config, Time, H160, U256,
 };
-use alloc::{boxed::Box, fmt::Debug, string::String, vec::Vec};
+use alloc::{boxed::Box, fmt::Debug, rc::Rc, string::String, vec::Vec};
 use codec::{Decode, Encode, MaxEncodedLen};
+use core::cell::RefCell;
 use frame_support::{traits::tokens::Balance, weights::Weight};
 use pallet_revive_uapi::ReturnFlags;
 use scale_info::TypeInfo;
@@ -391,6 +392,10 @@ pub struct ExecConfig<T: Config> {
 	/// This is primarily used for testing purposes and should be `None` in production
 	/// environments.
 	pub mock_handler: Option<Box<dyn MockHandler<T>>>,
+	/// External transient storage useful for testing.
+	///
+	/// Should be `None`  in production environments.
+	pub transient_storage: Option<Rc<RefCell<TransientStorage<T>>>>,
 }
 
 impl<T: Config> ExecConfig<T> {
@@ -402,6 +407,7 @@ impl<T: Config> ExecConfig<T> {
 			effective_gas_price: None,
 			is_dry_run: None,
 			mock_handler: None,
+			transient_storage: None,
 		}
 	}
 
@@ -412,6 +418,7 @@ impl<T: Config> ExecConfig<T> {
 			effective_gas_price: None,
 			mock_handler: None,
 			is_dry_run: None,
+			transient_storage: None,
 		}
 	}
 
@@ -423,6 +430,7 @@ impl<T: Config> ExecConfig<T> {
 			effective_gas_price: Some(effective_gas_price),
 			mock_handler: None,
 			is_dry_run: None,
+			transient_storage: None,
 		}
 	}
 
@@ -444,6 +452,7 @@ impl<T: Config> ExecConfig<T> {
 			effective_gas_price: self.effective_gas_price,
 			is_dry_run: self.is_dry_run.clone(),
 			mock_handler: None,
+			transient_storage: None,
 		}
 	}
 }

substrate/frame/revive/src/tests/sol/contract.rs

@@ -412,6 +412,7 @@ fn mock_caller_hook_works(caller_type: FixtureType, callee_type: FixtureType) {
 					mock_call: Default::default(),
 					mock_delegate_caller: Default::default(),
 				})),
+				transient_storage: None,
 			})
 			.build_and_unwrap_result();
 
@@ -473,6 +474,7 @@ fn mock_call_hook_works(caller_type: FixtureType, callee_type: FixtureType) {
 					.collect(),
 					mock_delegate_caller: Default::default(),
 				})),
+				transient_storage: None,
 			})
 			.build_and_unwrap_result();
 
@@ -536,6 +538,7 @@ fn mock_delegatecall_hook_works(caller_type: FixtureType, callee_type: FixtureTy
 					))
 					.collect(),
 				})),
+				transient_storage: None,
 			})
 			.build_and_unwrap_result();
 
@@ -722,7 +725,7 @@ fn subcall_effectively_limited_substrate_tx(caller_type: FixtureType, callee_typ
 	{
 		// the storage stuff won't work on static or delegate call
 		if case.is_store_call && !matches!(call_type, Caller::CallType::Call) {
-			continue
+			continue;
 		}
 
 		ExtBuilder::default().build().execute_with(|| {

substrate/frame/revive/src/transient_storage.rs

@@ -29,7 +29,7 @@ use frame_support::DefaultNoBound;
 use sp_runtime::{DispatchError, DispatchResult, Saturating};
 
 /// Meter entry tracks transaction allocations.
-#[derive(Default, Debug)]
+#[derive(Default, Debug, Clone)]
 pub struct MeterEntry {
 	/// Allocations made in the current transaction.
 	pub amount: u32,
@@ -56,7 +56,7 @@ impl MeterEntry {
 
 // The storage meter enforces a limit for each transaction,
 // which is calculated as free_storage * (1 - 1/16) for each subsequent frame.
-#[derive(DefaultNoBound)]
+#[derive(DefaultNoBound, Clone)]
 pub struct StorageMeter<T: Config> {
 	nested_meters: Vec<MeterEntry>,
 	root_meter: MeterEntry,
@@ -132,6 +132,7 @@ impl<T: Config> StorageMeter<T> {
 }
 
 /// An entry representing a journal change.
+#[derive(Clone)]
 struct JournalEntry {
 	key: Vec<u8>,
 	prev_value: Option<Vec<u8>>,
@@ -150,6 +151,7 @@ impl JournalEntry {
 }
 
 /// A journal containing transient storage modifications.
+#[derive(Clone)]
 struct Journal(Vec<JournalEntry>);
 
 impl Journal {
@@ -175,7 +177,7 @@ impl Journal {
 }
 
 /// Storage for maintaining the current transaction state.
-#[derive(Default)]
+#[derive(Default, Clone)]
 struct Storage(BTreeMap<Vec<u8>, Vec<u8>>);
 
 impl Storage {
@@ -203,6 +205,7 @@ impl Storage {
 /// recorded in the journal (`write`). When the `commit_transaction` function is called, the marker
 /// to the journal index (checkpoint) of when that call was entered is discarded.
 /// On `rollback_transaction`, all entries are reverted up to the last checkpoint.
+#[derive(Clone)]
 pub struct TransientStorage<T: Config> {
 	// The storage and journal size is limited by the storage meter.
 	storage: Storage,