Add documentation to SubmitSignedTransaction and actually make it work (#4200)

* Add documentation to signed transactions and actually make them work. * Fix naming and bounds. * Forgotten import. * Remove warning. * Make accounts optional, fix logic. * Split the method to avoid confusing type error message. * Move executor tests to integration. * Add submit transactions tests. * Make `submit_transaction` tests compile * Remove a file that was accidently committed * Add can_sign helper function. * Fix compilation. * Add a key to keystore. * Fix the tests. * Remove env_logger. * Fix sending multiple transactions. * Remove commented code. * Bring back criterion. * Remove stray debug log. * Apply suggestions from code review Co-Authored-By: Bastian Köcher <bkchr@users.noreply.github.com> * Make sure to initialize block correctly. * Initialize block for offchain workers. * Add test for transaction validity. * Fix tests. * Review suggestions. * Remove redundant comment. * Make sure to use correct block number of authoring. * Change the runtime API. * Support both versions. * Bump spec version, fix RPC test. Co-authored-by: Hernando Castano <HCastano@users.noreply.github.com> Co-authored-by: Gavin Wood <github@gavwood.com> Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com>
2026-04-26 08:47:57 +00:00 · 2020-01-10 01:46:55 +01:00
parent a1e0076aa8
commit 74d6e660c6
29 changed files with 2096 additions and 1413 deletions
@@ -0,0 +1,184 @@
+// Copyright 2018-2020 Parity Technologies (UK) Ltd.
+// This file is part of Substrate.
+
+// Substrate is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// Substrate is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with Substrate.  If not, see <http://www.gnu.org/licenses/>.
+
+use node_runtime::{
+	Call, Executive, Indices, Runtime, SubmitTransaction, UncheckedExtrinsic,
+};
+use sp_application_crypto::AppKey;
+use sp_core::testing::KeyStore;
+use sp_core::traits::KeystoreExt;
+use sp_core::offchain::{
+	TransactionPoolExt,
+	testing::TestTransactionPoolExt,
+};
+use frame_system::offchain::{SubmitSignedTransaction, SubmitUnsignedTransaction};
+use pallet_im_online::sr25519::AuthorityPair as Key;
+use codec::Decode;
+
+mod common;
+use self::common::*;
+
+#[test]
+fn should_submit_unsigned_transaction() {
+	let mut t = new_test_ext(COMPACT_CODE, false);
+	let (pool, state) = TestTransactionPoolExt::new();
+	t.register_extension(TransactionPoolExt::new(pool));
+
+	t.execute_with(|| {
+		let signature = Default::default();
+		let heartbeat_data = pallet_im_online::Heartbeat {
+			block_number: 1,
+			network_state: Default::default(),
+			session_index: 1,
+			authority_index: 0,
+		};
+
+		let call = pallet_im_online::Call::heartbeat(heartbeat_data, signature);
+		<SubmitTransaction as SubmitUnsignedTransaction<Runtime, Call>>
+			::submit_unsigned(call)
+			.unwrap();
+
+		assert_eq!(state.read().transactions.len(), 1)
+	});
+}
+
+const PHRASE: &str = "news slush supreme milk chapter athlete soap sausage put clutch what kitten";
+
+#[test]
+fn should_submit_signed_transaction() {
+	let mut t = new_test_ext(COMPACT_CODE, false);
+	let (pool, state) = TestTransactionPoolExt::new();
+	t.register_extension(TransactionPoolExt::new(pool));
+
+	let keystore = KeyStore::new();
+	keystore.write().sr25519_generate_new(Key::ID, Some(&format!("{}/hunter1", PHRASE))).unwrap();
+	keystore.write().sr25519_generate_new(Key::ID, Some(&format!("{}/hunter2", PHRASE))).unwrap();
+	keystore.write().sr25519_generate_new(Key::ID, Some(&format!("{}/hunter3", PHRASE))).unwrap();
+	t.register_extension(KeystoreExt(keystore));
+
+	t.execute_with(|| {
+		let keys = <SubmitTransaction as SubmitSignedTransaction<Runtime, Call>>
+			::find_all_local_keys();
+		assert_eq!(keys.len(), 3, "Missing keys: {:?}", keys);
+
+		let can_sign = <SubmitTransaction as SubmitSignedTransaction<Runtime, Call>>
+			::can_sign();
+		assert!(can_sign, "Since there are keys, `can_sign` should return true");
+
+		let call = pallet_balances::Call::transfer(Default::default(), Default::default());
+		let results =
+			<SubmitTransaction as SubmitSignedTransaction<Runtime, Call>>::submit_signed(call);
+
+		let len = results.len();
+		assert_eq!(len, 3);
+		assert_eq!(results.into_iter().filter_map(|x| x.1.ok()).count(), len);
+		assert_eq!(state.read().transactions.len(), len);
+	});
+}
+
+#[test]
+fn should_submit_signed_twice_from_the_same_account() {
+	let mut t = new_test_ext(COMPACT_CODE, false);
+	let (pool, state) = TestTransactionPoolExt::new();
+	t.register_extension(TransactionPoolExt::new(pool));
+
+	let keystore = KeyStore::new();
+	keystore.write().sr25519_generate_new(Key::ID, Some(&format!("{}/hunter1", PHRASE))).unwrap();
+	t.register_extension(KeystoreExt(keystore));
+
+	t.execute_with(|| {
+		let call = pallet_balances::Call::transfer(Default::default(), Default::default());
+		let results =
+			<SubmitTransaction as SubmitSignedTransaction<Runtime, Call>>::submit_signed(call);
+
+		let len = results.len();
+		assert_eq!(len, 1);
+		assert_eq!(results.into_iter().filter_map(|x| x.1.ok()).count(), len);
+		assert_eq!(state.read().transactions.len(), 1);
+
+		// submit another one from the same account. The nonce should be incremented.
+		let call = pallet_balances::Call::transfer(Default::default(), Default::default());
+		let results =
+			<SubmitTransaction as SubmitSignedTransaction<Runtime, Call>>::submit_signed(call);
+
+		let len = results.len();
+		assert_eq!(len, 1);
+		assert_eq!(results.into_iter().filter_map(|x| x.1.ok()).count(), len);
+		assert_eq!(state.read().transactions.len(), 2);
+
+		// now check that the transaction nonces are not equal
+		let s = state.read();
+		fn nonce(tx: UncheckedExtrinsic) -> frame_system::CheckNonce<Runtime> {
+			let extra = tx.signature.unwrap().2;
+			extra.3
+		}
+		let nonce1 = nonce(UncheckedExtrinsic::decode(&mut &*s.transactions[0]).unwrap());
+		let nonce2 = nonce(UncheckedExtrinsic::decode(&mut &*s.transactions[1]).unwrap());
+		assert!(
+			nonce1 != nonce2,
+			"Transactions should have different nonces. Got: {:?}", nonce1
+		);
+	});
+}
+
+#[test]
+fn submitted_transaction_should_be_valid() {
+	use codec::Encode;
+	use frame_support::storage::StorageMap;
+	use sp_runtime::transaction_validity::ValidTransaction;
+	use sp_runtime::traits::StaticLookup;
+
+	let mut t = new_test_ext(COMPACT_CODE, false);
+	let (pool, state) = TestTransactionPoolExt::new();
+	t.register_extension(TransactionPoolExt::new(pool));
+
+	let keystore = KeyStore::new();
+	keystore.write().sr25519_generate_new(Key::ID, Some(&format!("{}/hunter1", PHRASE))).unwrap();
+	t.register_extension(KeystoreExt(keystore));
+
+	t.execute_with(|| {
+		let call = pallet_balances::Call::transfer(Default::default(), Default::default());
+		let results =
+			<SubmitTransaction as SubmitSignedTransaction<Runtime, Call>>::submit_signed(call);
+		let len = results.len();
+		assert_eq!(len, 1);
+		assert_eq!(results.into_iter().filter_map(|x| x.1.ok()).count(), len);
+	});
+
+	// check that transaction is valid, but reset environment storage,
+	// since CreateTransaction increments the nonce
+	let tx0 = state.read().transactions[0].clone();
+	let mut t = new_test_ext(COMPACT_CODE, false);
+	t.execute_with(|| {
+		let extrinsic = UncheckedExtrinsic::decode(&mut &*tx0).unwrap();
+		// add balance to the account
+		let author = extrinsic.signature.clone().unwrap().0;
+		let address = Indices::lookup(author).unwrap();
+		<pallet_balances::FreeBalance<Runtime, _>>::insert(&address, 5_000_000_000_000);
+
+		// check validity
+		let res = Executive::validate_transaction(extrinsic);
+
+		assert_eq!(res.unwrap(), ValidTransaction {
+			priority: 2_411_002_000_000,
+			requires: vec![],
+			provides: vec![(address, 0).encode()],
+			longevity: 127,
+			propagate: true,
+		});
+	});
+}
+