stateful-storage: check hash in signed extension

e2e/stateful-pallet-storage/handleItemized.test.ts

@@ -180,7 +180,10 @@ describe('📗 Stateful Pallet Storage', function () {
         add_actions,
         0
       );
-      await assert.rejects(itemized_add_result_1.fundAndSend(fundingSource), { name: 'StalePageState' });
+      await assert.rejects(itemized_add_result_1.signAndSend('current'), {
+        name: 'RpcError',
+        message: /1010: Invalid Transaction: Custom error: 9/,
+      });
     });
   });
 
@@ -285,7 +288,10 @@ describe('📗 Stateful Pallet Storage', function () {
       };
       const remove_actions = [remove_action];
       const op = ExtrinsicHelper.applyItemActions(providerKeys, schemaId_deletable, msa_id, remove_actions, 0);
-      await assert.rejects(op.fundAndSend(fundingSource), { name: 'StalePageState' });
+      await assert.rejects(op.signAndSend('current'), {
+        name: 'RpcError',
+        message: /1010: Invalid Transaction: Custom error: 9/,
+      });
     });
   });
 

e2e/stateful-pallet-storage/handlePaginated.test.ts

@@ -201,9 +201,9 @@ describe('📗 Stateful Pallet Storage', function () {
       const payload_1 = new Bytes(ExtrinsicHelper.api.registry, 'Hello World From Frequency');
 
       const paginated_add_result_1 = ExtrinsicHelper.upsertPage(providerKeys, schemaId, msa_id, page_id, payload_1, 0);
-      await assert.rejects(paginated_add_result_1.fundAndSend(fundingSource), {
-        name: 'StalePageState',
-        section: 'statefulStorage',
+      await assert.rejects(paginated_add_result_1.signAndSend('current'), {
+        name: 'RpcError',
+        message: /1010: Invalid Transaction: Custom error: 9/,
       });
     });
   });
@@ -242,10 +242,10 @@ describe('📗 Stateful Pallet Storage', function () {
     });
 
     it('🛑 should fail call to remove page with stale target hash', async function () {
-      const paginated_add_result_1 = ExtrinsicHelper.removePage(providerKeys, schemaId, msa_id, 0, 0);
-      await assert.rejects(paginated_add_result_1.fundAndSend(fundingSource), {
-        name: 'StalePageState',
-        section: 'statefulStorage',
+      const paginated_add_result_1 = ExtrinsicHelper.removePage(providerKeys, schemaId, msa_id, 0, 1000);
+      await assert.rejects(paginated_add_result_1.signAndSend('current'), {
+        name: 'RpcError',
+        message: /1010: Invalid Transaction: Custom error: 9/,
       });
     });
   });

node/cli/Cargo.toml

@@ -24,6 +24,7 @@ frequency-service = { package = "frequency-service", path = "../service", defaul
 pallet-msa = { package = "pallet-msa", path = "../../pallets/msa", default-features = false }
 pallet-frequency-tx-payment = { package = "pallet-frequency-tx-payment", path = "../../pallets/frequency-tx-payment", default-features = false }
 pallet-handles = { package = "pallet-handles", path = "../../pallets/handles", default-features = false }
+pallet-stateful-storage = { package = "pallet-stateful-storage", path = "../../pallets/stateful-storage", default-features = false }
 cli-opt = { default-features = false, path = "../cli-opt" }
 
 # Substrate

node/cli/src/benchmarking.rs

@@ -118,8 +118,10 @@ pub fn create_benchmark_extrinsic(
 		.unwrap_or(2) as u64;
 	let extra: runtime::SignedExtra = (
 		frame_system::CheckNonZeroSender::<runtime::Runtime>::new(),
-		frame_system::CheckSpecVersion::<runtime::Runtime>::new(),
-		frame_system::CheckTxVersion::<runtime::Runtime>::new(),
+		(
+			frame_system::CheckSpecVersion::<runtime::Runtime>::new(),
+			frame_system::CheckTxVersion::<runtime::Runtime>::new(),
+		),
 		frame_system::CheckGenesis::<runtime::Runtime>::new(),
 		frame_system::CheckEra::<runtime::Runtime>::from(sp_runtime::generic::Era::mortal(
 			period,
@@ -130,6 +132,7 @@ pub fn create_benchmark_extrinsic(
 		pallet_frequency_tx_payment::ChargeFrqTransactionPayment::<runtime::Runtime>::from(0),
 		pallet_msa::CheckFreeExtrinsicUse::<runtime::Runtime>::new(),
 		pallet_handles::handles_signed_extension::HandlesSignedExtension::<runtime::Runtime>::new(),
+		pallet_stateful_storage::signed_extension::StatefulStorageSignedExtension::<runtime::Runtime>::new(),
 		frame_metadata_hash_extension::CheckMetadataHash::<runtime::Runtime>::new(false),
 		cumulus_primitives_storage_weight_reclaim::StorageWeightReclaim::<runtime::Runtime>::new(),
 	);
@@ -139,15 +142,15 @@ pub fn create_benchmark_extrinsic(
 		extra.clone(),
 		(
 			(),
-			runtime::VERSION.spec_version,
-			runtime::VERSION.transaction_version,
+			(runtime::VERSION.spec_version, runtime::VERSION.transaction_version),
 			genesis_hash,
 			best_hash,
 			(),
 			(),
 			(),
 			(),
 			(),
+			(),
 			None,
 			(),
 		),

pallets/stateful-storage/src/lib.rs

@@ -40,6 +40,7 @@ use sp_std::prelude::*;
 mod stateful_child_tree;
 pub mod types;
 
+pub mod signed_extension;
 pub mod weights;
 
 use crate::{stateful_child_tree::StatefulChildTree, types::*};
@@ -939,7 +940,7 @@ impl<T: Config> Pallet<T> {
 	}
 
 	/// Gets a paginated storage for desired parameters
-	fn get_paginated_page_for(
+	pub fn get_paginated_page_for(
 		msa_id: MessageSourceId,
 		schema_id: SchemaId,
 		page_id: PageId,
@@ -955,7 +956,7 @@ impl<T: Config> Pallet<T> {
 	}
 
 	/// Gets an itemized storage for desired parameters
-	fn get_itemized_page_for(
+	pub fn get_itemized_page_for(
 		msa_id: MessageSourceId,
 		schema_id: SchemaId,
 	) -> Result<Option<ItemizedPage<T>>, DispatchError> {

pallets/stateful-storage/src/signed_extension.rs

@@ -0,0 +1,200 @@
+//! Substrate Signed Extension for validating requests to the stateful storage pallet
+use crate::{Call, Config, Error, Pallet};
+use common_primitives::{
+	msa::{MessageSourceId, MsaValidator, SchemaId},
+	stateful_storage::{PageHash, PageId},
+};
+use core::marker::PhantomData;
+use frame_support::{
+	dispatch::DispatchInfo, ensure, pallet_prelude::ValidTransaction, traits::IsSubType,
+};
+use parity_scale_codec::{Decode, Encode};
+use scale_info::TypeInfo;
+use sp_runtime::{
+	traits::{DispatchInfoOf, Dispatchable, SignedExtension},
+	transaction_validity::{InvalidTransaction, TransactionValidity, TransactionValidityError},
+	DispatchError,
+};
+
+/// The SignedExtension trait is implemented on StatefulStorageSignedExtension to validate the
+/// request. The purpose of this is to ensure that the target_hash is verified in transaction pool
+/// before getting into block. This is to reduce the chance of capacity consumption due to stale hash
+#[derive(Encode, Decode, Clone, Eq, PartialEq, TypeInfo)]
+#[scale_info(skip_type_params(T))]
+pub struct StatefulStorageSignedExtension<T: Config + Send + Sync>(PhantomData<T>);
+
+impl<T: Config + Send + Sync> StatefulStorageSignedExtension<T> {
+	/// Create new `SignedExtension`.
+	pub fn new() -> Self {
+		Self(sp_std::marker::PhantomData)
+	}
+
+	/// Verifies the hashes for an Itemized Stateful Storage extrinsic
+	fn verify_hash_itemized(
+		msa_id: &MessageSourceId,
+		schema_id: &SchemaId,
+		target_hash: &PageHash,
+	) -> TransactionValidity {
+		const TAG_PREFIX: &str = "StatefulStorageHashItemized";
+
+		if let Ok(Some(page)) = Pallet::<T>::get_itemized_page_for(*msa_id, *schema_id) {
+			let current_hash: PageHash = page.get_hash();
+
+			ensure!(
+				&current_hash == target_hash,
+				map_dispatch_error(Error::<T>::StalePageState.into())
+			);
+
+			return ValidTransaction::with_tag_prefix(TAG_PREFIX)
+				.and_provides((msa_id, schema_id))
+				.build()
+		}
+		Ok(Default::default())
+	}
+
+	/// Verifies the hashes for a Paginated Stateful Storage extrinsic
+	fn verify_hash_paginated(
+		msa_id: &MessageSourceId,
+		schema_id: &SchemaId,
+		page_id: &PageId,
+		target_hash: &PageHash,
+	) -> TransactionValidity {
+		const TAG_PREFIX: &str = "StatefulStorageHashPaginated";
+		if let Ok(Some(page)) = Pallet::<T>::get_paginated_page_for(*msa_id, *schema_id, *page_id) {
+			let current_hash: PageHash = page.get_hash();
+
+			ensure!(
+				&current_hash == target_hash,
+				map_dispatch_error(Error::<T>::StalePageState.into())
+			);
+
+			return ValidTransaction::with_tag_prefix(TAG_PREFIX)
+				.and_provides((msa_id, schema_id, page_id))
+				.build()
+		}
+
+		Ok(Default::default())
+	}
+}
+
+impl<T: Config + Send + Sync> sp_std::fmt::Debug for StatefulStorageSignedExtension<T> {
+	#[cfg(feature = "std")]
+	fn fmt(&self, f: &mut sp_std::fmt::Formatter) -> sp_std::fmt::Result {
+		write!(f, "StatefulStorageSignedExtension<{:?}>", self.0)
+	}
+	#[cfg(not(feature = "std"))]
+	fn fmt(&self, _: &mut sp_std::fmt::Formatter) -> sp_std::fmt::Result {
+		Ok(())
+	}
+}
+
+/// Map a module DispatchError to an InvalidTransaction::Custom error
+pub fn map_dispatch_error(err: DispatchError) -> InvalidTransaction {
+	InvalidTransaction::Custom(match err {
+		DispatchError::Module(module_err) =>
+			<u32 as Decode>::decode(&mut module_err.error.as_slice())
+				.unwrap_or_default()
+				.try_into()
+				.unwrap_or_default(),
+		_ => 255u8,
+	})
+}
+
+impl<T: Config + Send + Sync> SignedExtension for StatefulStorageSignedExtension<T>
+where
+	T::RuntimeCall: Dispatchable<Info = DispatchInfo> + IsSubType<Call<T>>,
+{
+	type AccountId = T::AccountId;
+	type Call = T::RuntimeCall;
+	type AdditionalSigned = ();
+	type Pre = ();
+	const IDENTIFIER: &'static str = "StatefulStorageSignedExtension";
+
+	/// Additional signed
+	fn additional_signed(&self) -> sp_std::result::Result<(), TransactionValidityError> {
+		Ok(())
+	}
+
+	/// Pre dispatch
+	fn pre_dispatch(
+		self,
+		_who: &Self::AccountId,
+		_call: &Self::Call,
+		_info: &DispatchInfoOf<Self::Call>,
+		_len: usize,
+	) -> Result<Self::Pre, TransactionValidityError> {
+		// Since we already check the hash in stateful-storage-pallet extrinsics we do not need to
+		// check the hash before dispatching
+		Ok(())
+	}
+
+	/// Filters stateful extrinsics and verifies the hashes to ensure we are not proceeding
+	/// with a stale one
+	fn validate(
+		&self,
+		_who: &Self::AccountId,
+		call: &Self::Call,
+		_info: &DispatchInfoOf<Self::Call>,
+		_len: usize,
+	) -> TransactionValidity {
+		match call.is_sub_type() {
+			Some(Call::apply_item_actions {
+				state_owner_msa_id, schema_id, target_hash, ..
+			}) => Self::verify_hash_itemized(state_owner_msa_id, schema_id, target_hash),
+			Some(Call::upsert_page {
+				state_owner_msa_id, schema_id, target_hash, page_id, ..
+			}) |
+			Some(Call::delete_page {
+				state_owner_msa_id, schema_id, target_hash, page_id, ..
+			}) => Self::verify_hash_paginated(state_owner_msa_id, schema_id, page_id, target_hash),
+			Some(Call::apply_item_actions_with_signature { payload, .. }) =>
+				Self::verify_hash_itemized(
+					&payload.msa_id,
+					&payload.schema_id,
+					&payload.target_hash,
+				),
+			Some(Call::upsert_page_with_signature { payload, .. }) => Self::verify_hash_paginated(
+				&payload.msa_id,
+				&payload.schema_id,
+				&payload.page_id,
+				&payload.target_hash,
+			),
+			Some(Call::delete_page_with_signature { payload, .. }) => Self::verify_hash_paginated(
+				&payload.msa_id,
+				&payload.schema_id,
+				&payload.page_id,
+				&payload.target_hash,
+			),
+			Some(Call::apply_item_actions_with_signature_v2 { payload, delegator_key, .. }) => {
+				let state_owner_msa_id = T::MsaInfoProvider::ensure_valid_msa_key(delegator_key)
+					.map_err(|e| map_dispatch_error(e))?;
+				Self::verify_hash_itemized(
+					&state_owner_msa_id,
+					&payload.schema_id,
+					&payload.target_hash,
+				)
+			},
+			Some(Call::upsert_page_with_signature_v2 { payload, delegator_key, .. }) => {
+				let state_owner_msa_id = T::MsaInfoProvider::ensure_valid_msa_key(delegator_key)
+					.map_err(|e| map_dispatch_error(e))?;
+				Self::verify_hash_paginated(
+					&state_owner_msa_id,
+					&payload.schema_id,
+					&payload.page_id,
+					&payload.target_hash,
+				)
+			},
+			Some(Call::delete_page_with_signature_v2 { payload, delegator_key, .. }) => {
+				let state_owner_msa_id = T::MsaInfoProvider::ensure_valid_msa_key(delegator_key)
+					.map_err(|e| map_dispatch_error(e))?;
+				Self::verify_hash_paginated(
+					&state_owner_msa_id,
+					&payload.schema_id,
+					&payload.page_id,
+					&payload.target_hash,
+				)
+			},
+			_ => Ok(Default::default()),
+		}
+	}
+}

pallets/stateful-storage/src/tests/mod.rs

@@ -5,4 +5,5 @@ mod child_tree_tests;
 mod delete_page_tests;
 mod itemized_operations_tests;
 mod other_tests;
+mod signed_extension_tests;
 mod upsert_page_tests;