Staking Miner

Cargo.toml

@@ -79,6 +79,7 @@ members = [
 	"parachain/test-parachains",
 	"parachain/test-parachains/adder",
 	"parachain/test-parachains/adder/collator",
+	"utils/staking-miner",
 ]
 
 # We want to be able to build the bridge relayer without pulling it (and all of its

runtime/kusama/src/lib.rs

@@ -101,6 +101,7 @@ pub use pallet_staking::StakerStatus;
 pub use sp_runtime::BuildStorage;
 pub use pallet_timestamp::Call as TimestampCall;
 pub use pallet_balances::Call as BalancesCall;
+pub use pallet_election_provider_multi_phase::Call as EPMCall;
 
 /// Constant values used within the runtime.
 pub mod constants;

runtime/polkadot/src/lib.rs

@@ -77,6 +77,7 @@ pub use pallet_staking::StakerStatus;
 pub use sp_runtime::BuildStorage;
 pub use pallet_timestamp::Call as TimestampCall;
 pub use pallet_balances::Call as BalancesCall;
+pub use pallet_election_provider_multi_phase::Call as EPMCall;
 
 /// Constant values used within the runtime.
 pub mod constants;

runtime/westend/src/lib.rs

@@ -100,6 +100,7 @@ pub use pallet_staking::StakerStatus;
 pub use sp_runtime::BuildStorage;
 pub use pallet_timestamp::Call as TimestampCall;
 pub use pallet_balances::Call as BalancesCall;
+pub use pallet_election_provider_multi_phase::Call as EPMCall;
 
 /// Constant values used within the runtime.
 pub mod constants;

utils/staking-miner/.gitignore

@@ -0,0 +1,2 @@
+*.key
+*.bin

utils/staking-miner/Cargo.toml

@@ -0,0 +1,47 @@
+[package]
+name = "staking-miner"
+version = "0.9.0"
+authors = ["Parity Technologies <admin@parity.io>"]
+edition = "2018"
+
+[dependencies]
+codec = { package = "parity-scale-codec", version = "2.0.0" }
+tokio = { version = "0.2", features = ["macros"] }
+log = "0.4.11"
+env_logger = "0.8.3"
+structopt = "0.3.0"
+jsonrpsee-ws-client = { version = "0.2.0", default-features = false, features = ["tokio02"] }
+jsonrpsee-types = { version = "0.2.0" }
+jsonrpsee = "=0.2.0-alpha.6"
+serde_json = "1.0"
+serde = "1.0.0"
+hex = "0.4.0"
+lazy_static = "1.4.0"
+paste = "1.0.5"
+thiserror = "1.0.0"
+
+remote-externalities = { git = "https://github.com/paritytech/substrate", branch = "master" }
+
+sp-core = { git = "https://github.com/paritytech/substrate", branch = "master" }
+sp-io = { git = "https://github.com/paritytech/substrate", branch = "master" }
+sp-runtime = { git = "https://github.com/paritytech/substrate", branch = "master" }
+sp-npos-elections = { git = "https://github.com/paritytech/substrate", branch = "master" }
+sp-transaction-pool = { git = "https://github.com/paritytech/substrate", branch = "master" }
+
+
+frame-system = { git = "https://github.com/paritytech/substrate", branch = "master" }
+frame-support = { git = "https://github.com/paritytech/substrate", branch = "master" }
+frame-election-provider-support = { git = "https://github.com/paritytech/substrate", branch = "master" }
+pallet-election-provider-multi-phase = { git = "https://github.com/paritytech/substrate", branch = "master" }
+pallet-staking = { git = "https://github.com/paritytech/substrate", branch = "master" }
+pallet-transaction-payment = { git = "https://github.com/paritytech/substrate", branch = "master" }
+
+core-primitives = { package = "polkadot-core-primitives", path = "../../core-primitives" }
+
+runtime-common = { package = "polkadot-runtime-common", path = "../../runtime/common" }
+polkadot-runtime = { path = "../../runtime/polkadot" }
+kusama-runtime = { path = "../../runtime/kusama" }
+westend-runtime = { path = "../../runtime/westend" }
+
+[dev-dependencies]
+sp-version = { git = "https://github.com/paritytech/substrate", branch = "master" }

utils/staking-miner/src/dry_run.rs

@@ -0,0 +1,97 @@
+// Copyright 2021 Parity Technologies (UK) Ltd.
+// This file is part of Polkadot.
+
+// Polkadot 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.
+
+// Polkadot 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 Polkadot.  If not, see <http://www.gnu.org/licenses/>.
+
+//! The dry-run command.
+
+use crate::{prelude::*, Signer, SharedConfig, DryRunConfig, WsClient, Error, rpc_helpers::*, params};
+use codec::Encode;
+
+/// Forcefully create the snapshot. This can be used to compute the election at anytime.
+fn force_create_snapshot<T: EPM::Config>(ext: &mut Ext) -> Result<(), Error> {
+	ext.execute_with(|| {
+		if <EPM::Snapshot<T>>::exists() {
+			log::info!(target: LOG_TARGET, "snapshot already exists.");
+			Ok(())
+		} else {
+			log::info!(target: LOG_TARGET, "creating a fake snapshot now.");
+			<EPM::Pallet<T>>::create_snapshot().map(|_| ()).map_err(Into::into)
+		}
+	})
+}
+
+/// Helper method to print the encoded size of the snapshot.
+fn measure_snapshot_size<T: EPM::Config>(ext: &mut Ext) {
+	ext.execute_with(|| {
+		log::info!(target: LOG_TARGET, "Metadata: {:?}", <EPM::Pallet<T>>::snapshot_metadata());
+		log::info!(
+			target: LOG_TARGET,
+			"Encoded Length: {:?}",
+			<EPM::Pallet<T>>::snapshot()
+				.expect("snapshot must exist before calling `measure_snapshot_size`")
+				.encode()
+				.len()
+		);
+	})
+}
+
+/// Fir the stake threshold to in order to have at most `count` voters.
+#[allow(unused)]
+fn find_threshold<T: EPM::Config>(ext: &mut Ext, count: usize) {
+	ext.execute_with(|| {
+		let mut voters = <EPM::Pallet<T>>::snapshot()
+			.expect("snapshot must exist before calling `measure_snapshot_size`")
+			.voters;
+		voters.sort_by_key(|v| v.1);
+		println!("smallest allowed voter is {:?}", voters.into_iter().rev().take(count).last());
+	})
+}
+
+macro_rules! dry_run_cmd_for { ($runtime:ident) => { paste::paste! {
+	/// Execute the dry-run command.
+	pub(crate) async fn [<dry_run_cmd_ $runtime>](
+		client: WsClient,
+		shared: SharedConfig,
+		config: DryRunConfig,
+		signer: Signer,
+	) -> Result<(), Error> {
+		use $crate::[<$runtime _runtime_exports>]::*;
+		let mut ext = crate::create_election_ext::<Runtime, Block>(shared.uri.clone(), config.at, true).await?;
+		force_create_snapshot::<Runtime>(&mut ext)?;
+		measure_snapshot_size::<Runtime>(&mut ext);
+		let (raw_solution, witness) = crate::mine_unchecked::<Runtime>(&mut ext, 100)?;
+		log::info!(target: LOG_TARGET, "mined solution with {:?}", &raw_solution.score);
+
+		let nonce = crate::get_account_info::<Runtime>(&client, &signer.account, config.at)
+			.await?
+			.map(|i| i.nonce)
+			.expect("signer account is checked to exist upon startup; it can only die if it \
+				transfers funds out of it, or get slashed. If it does not exist at this point, \
+				it is likely due to a bug, or the signer got slashed. Terminating."
+			);
+		let tip = 0 as Balance;
+		let era = sp_runtime::generic::Era::Immortal;
+		let extrinsic = ext.execute_with(|| create_uxt(raw_solution, witness, signer.clone(), nonce, tip, era));
+
+		let bytes = sp_core::Bytes(extrinsic.encode().to_vec());
+		let outcome = rpc_decode::<sp_runtime::ApplyExtrinsicResult>(&client, "system_dryRun", params!{ bytes }).await?;
+		log::info!(target: LOG_TARGET, "dry-run outcome is {:?}", outcome);
+		Ok(())
+	}
+}}}
+
+dry_run_cmd_for!(polkadot);
+dry_run_cmd_for!(kusama);
+dry_run_cmd_for!(westend);

utils/staking-miner/src/emergency_solution.rs

@@ -0,0 +1,53 @@
+// Copyright 2021 Parity Technologies (UK) Ltd.
+// This file is part of Polkadot.
+
+// Polkadot 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.
+
+// Polkadot 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 Polkadot.  If not, see <http://www.gnu.org/licenses/>.
+
+//! The emergency-solution command.
+
+use crate::{prelude::*, SharedConfig, WsClient, Error};
+use std::io::Write;
+use codec::Encode;
+
+macro_rules! emergency_solution_cmd_for { ($runtime:ident) => { paste::paste! {
+	/// Execute the emergency-solution command.
+	pub(crate) async fn [<emergency_solution_cmd_ $runtime>](
+		_client: WsClient,
+		shared: SharedConfig,
+	) -> Result<(), Error> {
+		use $crate::[<$runtime _runtime_exports>]::*;
+		let mut ext = crate::create_election_ext::<Runtime, Block>(shared.uri.clone(), None, false).await?;
+		ext.execute_with(|| {
+			assert!(EPM::Pallet::<Runtime>::current_phase().is_emergency());
+			// NOTE: this internally calls feasibility_check, but we just re-do it here as an easy way
+			// to get a `ReadySolution`.
+			let (raw_solution, _) = <EPM::Pallet<Runtime>>::mine_solution(50)?;
+			log::info!(target: LOG_TARGET, "mined solution with {:?}", &raw_solution.score);
+			let ready_solution = EPM::Pallet::<Runtime>::feasibility_check(raw_solution, EPM::ElectionCompute::Signed)?;
+			let encoded_ready = ready_solution.encode();
+			let encoded_support = ready_solution.supports.encode();
+			let mut solution_file = std::fs::File::create("solution.bin")?;
+			let mut supports_file = std::fs::File::create("solution.supports.bin")?;
+			solution_file.write_all(&encoded_ready)?;
+			supports_file.write_all(&encoded_support)?;
+			log::info!(target: LOG_TARGET, "ReadySolution: size {:?} / score = {:?}", encoded_ready.len(), ready_solution.score);
+			log::trace!(target: LOG_TARGET, "Supports: {}", sp_core::hexdisplay::HexDisplay::from(&encoded_support));
+			Ok(())
+		})
+	}
+}}}
+
+emergency_solution_cmd_for!(polkadot);
+emergency_solution_cmd_for!(kusama);
+emergency_solution_cmd_for!(westend);