new pallet: whitelist pallet (#10159)

* pallet whitelist * refactor a bit * fmt * address audit * improve tests * return Ok + refund * add test for dispatching failing * add dispatch_whitelisted_call_with_preimage * fmt * better name * Consume all data on decode Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Add error docs Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Remove phantom data Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Use rust 2021 Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Update crate features Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Fmt Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Make compile Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * cargo run --quiet --profile=production --features=runtime-benchmarks --manifest-path=bin/node/cli/Cargo.toml -- benchmark --chain=dev --steps=50 --repeat=20 --pallet=pallet_whitelist --extrinsic=* --execution=wasm --wasm-execution=compiled --heap-pages=4096 --output=./frame/whitelist/src/weights.rs --template=./.maintain/frame-weight-template.hbs * Bump Preimage max size Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * cargo run --quiet --profile=production --features=runtime-benchmarks --manifest-path=bin/node/cli/Cargo.toml -- benchmark --chain=dev --steps=50 --repeat=20 --pallet=pallet_whitelist --extrinsic=* --execution=wasm --wasm-execution=compiled --heap-pages=4096 --output=./frame/whitelist/src/weights.rs --template=./.maintain/frame-weight-template.hbs * Fmt Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> Co-authored-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> Co-authored-by: Parity Bot <admin@parity.io>
2026-06-20 10:31:03 +00:00 · 2022-03-01 14:31:51 +01:00
parent 5ae3ed3b95
commit e71c7b259d
13 changed files with 873 additions and 3 deletions
@@ -0,0 +1,175 @@
+// This file is part of Substrate.
+
+// Copyright (C) 2021 Parity Technologies (UK) Ltd.
+// SPDX-License-Identifier: Apache-2.0
+
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// 	http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+// Tests for Whitelist Pallet
+
+use crate::mock::*;
+use codec::Encode;
+use frame_support::{assert_noop, assert_ok, dispatch::GetDispatchInfo, traits::PreimageProvider};
+use sp_runtime::{traits::Hash, DispatchError};
+
+#[test]
+fn test_whitelist_call_and_remove() {
+	new_test_ext().execute_with(|| {
+		let call = Call::System(frame_system::Call::remark { remark: vec![] });
+		let encoded_call = call.encode();
+		let call_hash = <Test as frame_system::Config>::Hashing::hash(&encoded_call[..]);
+
+		assert_noop!(
+			Whitelist::remove_whitelisted_call(Origin::root(), call_hash),
+			crate::Error::<Test>::CallIsNotWhitelisted,
+		);
+
+		assert_noop!(
+			Whitelist::whitelist_call(Origin::signed(1), call_hash),
+			DispatchError::BadOrigin,
+		);
+
+		assert_ok!(Whitelist::whitelist_call(Origin::root(), call_hash));
+
+		assert!(Preimage::preimage_requested(&call_hash));
+
+		assert_noop!(
+			Whitelist::whitelist_call(Origin::root(), call_hash),
+			crate::Error::<Test>::CallAlreadyWhitelisted,
+		);
+
+		assert_noop!(
+			Whitelist::remove_whitelisted_call(Origin::signed(1), call_hash),
+			DispatchError::BadOrigin,
+		);
+
+		assert_ok!(Whitelist::remove_whitelisted_call(Origin::root(), call_hash));
+
+		assert!(!Preimage::preimage_requested(&call_hash));
+
+		assert_noop!(
+			Whitelist::remove_whitelisted_call(Origin::root(), call_hash),
+			crate::Error::<Test>::CallIsNotWhitelisted,
+		);
+	});
+}
+
+#[test]
+fn test_whitelist_call_and_execute() {
+	new_test_ext().execute_with(|| {
+		let call = Call::System(frame_system::Call::remark_with_event { remark: vec![1] });
+		let call_weight = call.get_dispatch_info().weight;
+		let encoded_call = call.encode();
+		let call_hash = <Test as frame_system::Config>::Hashing::hash(&encoded_call[..]);
+
+		assert_noop!(
+			Whitelist::dispatch_whitelisted_call(Origin::root(), call_hash, call_weight),
+			crate::Error::<Test>::CallIsNotWhitelisted,
+		);
+
+		assert_ok!(Whitelist::whitelist_call(Origin::root(), call_hash));
+
+		assert_noop!(
+			Whitelist::dispatch_whitelisted_call(Origin::signed(1), call_hash, call_weight),
+			DispatchError::BadOrigin,
+		);
+
+		assert_noop!(
+			Whitelist::dispatch_whitelisted_call(Origin::root(), call_hash, call_weight),
+			crate::Error::<Test>::UnavailablePreImage,
+		);
+
+		assert_ok!(Preimage::note_preimage(Origin::root(), encoded_call));
+
+		assert!(Preimage::preimage_requested(&call_hash));
+
+		assert_noop!(
+			Whitelist::dispatch_whitelisted_call(Origin::root(), call_hash, call_weight - 1),
+			crate::Error::<Test>::InvalidCallWeightWitness,
+		);
+
+		assert_ok!(Whitelist::dispatch_whitelisted_call(Origin::root(), call_hash, call_weight));
+
+		assert!(!Preimage::preimage_requested(&call_hash));
+
+		assert_noop!(
+			Whitelist::dispatch_whitelisted_call(Origin::root(), call_hash, call_weight),
+			crate::Error::<Test>::CallIsNotWhitelisted,
+		);
+	});
+}
+
+#[test]
+fn test_whitelist_call_and_execute_failing_call() {
+	new_test_ext().execute_with(|| {
+		let call = Call::Whitelist(crate::Call::dispatch_whitelisted_call {
+			call_hash: Default::default(),
+			call_weight_witness: 0,
+		});
+		let call_weight = call.get_dispatch_info().weight;
+		let encoded_call = call.encode();
+		let call_hash = <Test as frame_system::Config>::Hashing::hash(&encoded_call[..]);
+
+		assert_ok!(Whitelist::whitelist_call(Origin::root(), call_hash));
+		assert_ok!(Preimage::note_preimage(Origin::root(), encoded_call));
+		assert!(Preimage::preimage_requested(&call_hash));
+		assert_ok!(Whitelist::dispatch_whitelisted_call(Origin::root(), call_hash, call_weight));
+		assert!(!Preimage::preimage_requested(&call_hash));
+	});
+}
+
+#[test]
+fn test_whitelist_call_and_execute_without_note_preimage() {
+	new_test_ext().execute_with(|| {
+		let call =
+			Box::new(Call::System(frame_system::Call::remark_with_event { remark: vec![1] }));
+		let call_hash = <Test as frame_system::Config>::Hashing::hash_of(&call);
+
+		assert_ok!(Whitelist::whitelist_call(Origin::root(), call_hash));
+		assert!(Preimage::preimage_requested(&call_hash));
+
+		assert_ok!(Whitelist::dispatch_whitelisted_call_with_preimage(
+			Origin::root(),
+			call.clone()
+		));
+
+		assert!(!Preimage::preimage_requested(&call_hash));
+
+		assert_noop!(
+			Whitelist::dispatch_whitelisted_call_with_preimage(Origin::root(), call),
+			crate::Error::<Test>::CallIsNotWhitelisted,
+		);
+	});
+}
+
+#[test]
+fn test_whitelist_call_and_execute_decode_consumes_all() {
+	new_test_ext().execute_with(|| {
+		let call = Call::System(frame_system::Call::remark_with_event { remark: vec![1] });
+		let call_weight = call.get_dispatch_info().weight;
+		let mut call = call.encode();
+		// Appending something does not make the encoded call invalid.
+		// This tests that the decode function consumes all data.
+		call.extend(call.clone());
+
+		let call_hash = <Test as frame_system::Config>::Hashing::hash(&call[..]);
+
+		assert_ok!(Preimage::note_preimage(Origin::root(), call));
+		assert_ok!(Whitelist::whitelist_call(Origin::root(), call_hash));
+
+		assert_noop!(
+			Whitelist::dispatch_whitelisted_call(Origin::root(), call_hash, call_weight),
+			crate::Error::<Test>::UndecodableCall,
+		);
+	});
+}