Update to beyond alpha.7

Cargo.toml

@@ -32,11 +32,14 @@ members = [
 	"runtimes/api-runtime",
 	"runtimes/babe-grandpa-runtime",
 	"runtimes/ocw-runtime",
+	"runtimes/minimal-grandpa-runtime",
 	"runtimes/super-runtime",
 	"runtimes/weight-fee-runtime",
 	"nodes/babe-grandpa-node",
 	"nodes/basic-pow",
+	"nodes/hybrid-consensus",
 	"nodes/kitchen-node",
 	"nodes/manual-seal",
 	"nodes/rpc-node",
+	"consensus/sha3pow",
 ]

README.md

@@ -22,4 +22,4 @@ The Substrate Recipes are [GPL 3.0 Licensed](LICENSE) It is open source and [ope
 
 ## Using Recipes in External Projects
 
-The pallets and runtimes provided here are tested and ready to be used in other Substrate-based blockchains. The big caveat is that you must use the same upstream Substrate version throughout the project. The recipes currently use Substrate@`v2.0.0-alpha.6`.
+The pallets and runtimes provided here are tested and ready to be used in other Substrate-based blockchains. The big caveat is that you must use the same upstream Substrate version throughout the project. The recipes currently use Substrate@`v2.0.0-alpha.7`.

consensus/sha3pow/Cargo.toml

@@ -0,0 +1,18 @@
+[package]
+authors = ['Joshy Orndorff, Wei Tang']
+edition = '2018'
+homepage = 'https://substrate.dev/recipes'
+name = 'sha3pow'
+repository = 'https://github.com/substrate-developer-hub/recipes'
+version = "2.0.0-alpha.7"
+description = 'Sha3-based Proof of Work algorithms for Substrate'
+
+[dependencies]
+parity-scale-codec = '1.3.0'
+sha3 = "0.8"
+rand = { version = "0.7", features = ["small_rng"] }
+sc-consensus-pow = { version = '0.8.0-alpha.7', git = 'https://github.com/paritytech/substrate', rev = '7f73312aa0bf4a4107860141f085e9770ec01b72' }
+sp-api = { version = '2.0.0-alpha.7', git = 'https://github.com/paritytech/substrate', rev = '7f73312aa0bf4a4107860141f085e9770ec01b72' }
+sp-consensus-pow = { version = '0.8.0-alpha.7', git = 'https://github.com/paritytech/substrate', rev = '7f73312aa0bf4a4107860141f085e9770ec01b72' }
+sp-core = { version = '2.0.0-alpha.7', git = 'https://github.com/paritytech/substrate', rev = '7f73312aa0bf4a4107860141f085e9770ec01b72' }
+sp-runtime = { version = '2.0.0-alpha.7', git = 'https://github.com/paritytech/substrate', rev = '7f73312aa0bf4a4107860141f085e9770ec01b72' }

nodes/basic-pow/src/pow.rs → consensus/sha3pow/src/lib.rs

@@ -3,13 +3,11 @@ use sp_runtime::generic::BlockId;
 use sp_runtime::traits::Block as BlockT;
 use parity_scale_codec::{Encode, Decode};
 use sc_consensus_pow::{PowAlgorithm, Error};
-use sp_consensus_pow::Seal as RawSeal;
+use sp_consensus_pow::{Seal as RawSeal, DifficultyApi};
 use sha3::{Sha3_256, Digest};
 use rand::{thread_rng, SeedableRng, rngs::SmallRng};
-
-/// A concrete PoW Algorithm that uses Sha3 hashing.
-#[derive(Clone)]
-pub struct Sha3Algorithm;
+use std::sync::Arc;
+use sp_api::ProvideRuntimeApi;
 
 /// Determine whether the given hash satisfies the given difficulty.
 /// The test is done by multiplying the two together. If the product
@@ -52,14 +50,18 @@ impl Compute {
 	}
 }
 
+/// A minimal PoW algorithm that uses Sha3 hashing.
+/// Difficulty is fixed at 1_000_000
+#[derive(Clone)]
+pub struct MinimalSha3Algorithm;
+
 // Here we implement the general PowAlgorithm trait for our concrete Sha3Algorithm
-impl<B: BlockT<Hash=H256>> PowAlgorithm<B> for Sha3Algorithm {
+impl<B: BlockT<Hash=H256>> PowAlgorithm<B> for MinimalSha3Algorithm {
 	type Difficulty = U256;
 
 	fn difficulty(&self, _parent: B::Hash) -> Result<Self::Difficulty, Error<B>> {
-		// This basic PoW uses a fixed difficulty.
-		// Raising this difficulty will make the block time slower.
-		Ok(U256::from(1000_000))
+		// Fixed difficulty hardcoded here
+		Ok(U256::from(1_000_000))
 	}
 
 	fn verify(
@@ -129,3 +131,115 @@ impl<B: BlockT<Hash=H256>> PowAlgorithm<B> for Sha3Algorithm {
 		Ok(None)
 	}
 }
+
+
+
+/// A complete PoW Algorithm that uses Sha3 hashing.
+/// Needs a reference to the client so it can grab the difficulty from the runtime.
+pub struct Sha3Algorithm<C> {
+	client: Arc<C>,
+}
+
+impl<C> Sha3Algorithm<C> {
+	pub fn new(client: Arc<C>) -> Self {
+		Self { client }
+	}
+}
+
+// Manually implement clone. Deriving doesn't work because
+// it'll derive impl<C: Clone> Clone for Sha3Algorithm<C>. But C in practice isn't Clone.
+impl<C> Clone for Sha3Algorithm<C> {
+	fn clone(&self) -> Self {
+		Self::new(self.client.clone())
+	}
+}
+
+// Here we implement the general PowAlgorithm trait for our concrete Sha3Algorithm
+impl<B: BlockT<Hash=H256>, C> PowAlgorithm<B> for Sha3Algorithm<C> where
+	C: ProvideRuntimeApi<B>,
+	C::Api: DifficultyApi<B, U256>,
+{
+	type Difficulty = U256;
+
+	fn difficulty(&self, parent: B::Hash) -> Result<Self::Difficulty, Error<B>> {
+		let parent_id = BlockId::<B>::hash(parent);
+		self.client.runtime_api().difficulty(&parent_id)
+			.map_err(|e| sc_consensus_pow::Error::Environment(
+				format!("Fetching difficulty from runtime failed: {:?}", e)
+			))
+	}
+
+	fn verify(
+		&self,
+		_parent: &BlockId<B>,
+		pre_hash: &H256,
+		seal: &RawSeal,
+		difficulty: Self::Difficulty
+	) -> Result<bool, Error<B>> {
+		// Try to construct a seal object by decoding the raw seal given
+		let seal = match Seal::decode(&mut &seal[..]) {
+			Ok(seal) => seal,
+			Err(_) => return Ok(false),
+		};
+
+		// See whether the hash meets the difficulty requirement. If not, fail fast.
+		if !hash_meets_difficulty(&seal.work, difficulty) {
+			return Ok(false)
+		}
+
+		// Make sure the provided work actually comes from the correct pre_hash
+		let compute = Compute {
+			difficulty,
+			pre_hash: *pre_hash,
+			nonce: seal.nonce,
+		};
+
+		if compute.compute() != seal {
+			return Ok(false)
+		}
+
+		Ok(true)
+	}
+
+	fn mine(
+		&self,
+		_parent: &BlockId<B>,
+		pre_hash: &H256,
+		difficulty: Self::Difficulty,
+		round: u32 // The number of nonces to try during this call
+	) -> Result<Option<RawSeal>, Error<B>> {
+		// Get a randomness source from the environment; fail if one isn't available
+		let mut rng = SmallRng::from_rng(&mut thread_rng())
+			.map_err(|e| Error::Environment(format!("Initialize RNG failed for mining: {:?}", e)))?;
+
+		// Loop the specified number of times
+		for _ in 0..round {
+
+			// Choose a new nonce
+			let nonce = H256::random_using(&mut rng);
+
+			// Calculate the seal
+			let compute = Compute {
+				difficulty,
+				pre_hash: *pre_hash,
+				nonce,
+			};
+			let seal = compute.compute();
+
+			// If we solved the PoW then return, otherwise loop again
+			if hash_meets_difficulty(&seal.work, difficulty) {
+				return Ok(Some(seal.encode()))
+			}
+		}
+
+		// Tried the specified number of rounds and never found a solution
+		Ok(None)
+	}
+}
+
+#[test]
+fn clone_works() {
+	let client = Arc::new(());
+	let algo1 = Sha3Algorithm::<()>::new(client);
+	let algo2 = algo1.clone();
+}

nodes/babe-grandpa-node/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "babe-grandpa-node"
-version = "2.0.0-alpha.6"
+version = "2.0.0-alpha.7"
 edition = "2018"
 authors = ['Joshy Orndorff', '4meta5', 'Jimmy Chu']
 homepage = 'https://substrate.dev/recipes'
@@ -23,39 +23,41 @@ tokio = "0.1.22"
 exit-future = "0.2.0"
 parking_lot = "0.9.0"
 trie-root = "0.15.2"
-sp-io = '2.0.0-alpha.6'
-sc-cli = '0.8.0-alpha.6'
-sc-client-api = '2.0.0-alpha.6'
-sp-core = '2.0.0-alpha.6'
-sp-runtime = '2.0.0-alpha.6'
-sc-executor = '0.8.0-alpha.6'
-sc-service = '0.8.0-alpha.6'
-sp-inherents = '2.0.0-alpha.6'
-sc-transaction-pool = '2.0.0-alpha.6'
-sp-transaction-pool = '2.0.0-alpha.6'
-sc-network = '0.8.0-alpha.6'
-sc-consensus-babe = '0.8.0-alpha.6'
-sp-consensus-babe = '0.8.0-alpha.6'
-sc-finality-grandpa = '0.8.0-alpha.6'
-sp-finality-grandpa = '2.0.0-alpha.6'
-sc-client = '0.8.0-alpha.6'
-sc-basic-authorship = '0.8.0-alpha.6'
-sp-consensus = '0.8.0-alpha.6'
+sp-io = { version = '2.0.0-alpha.7', git = 'https://github.com/paritytech/substrate', rev = '7f73312aa0bf4a4107860141f085e9770ec01b72' }
+sc-cli = { version = '0.8.0-alpha.7', git = 'https://github.com/paritytech/substrate', rev = '7f73312aa0bf4a4107860141f085e9770ec01b72' }
+sc-client-api = { version = '2.0.0-alpha.7', git = 'https://github.com/paritytech/substrate', rev = '7f73312aa0bf4a4107860141f085e9770ec01b72' }
+sc-consensus = { version = '0.8.0-alpha.7', git = 'https://github.com/paritytech/substrate', rev = '7f73312aa0bf4a4107860141f085e9770ec01b72' }
+sp-core = { version = '2.0.0-alpha.7', git = 'https://github.com/paritytech/substrate', rev = '7f73312aa0bf4a4107860141f085e9770ec01b72' }
+sp-runtime = { version = '2.0.0-alpha.7', git = 'https://github.com/paritytech/substrate', rev = '7f73312aa0bf4a4107860141f085e9770ec01b72' }
+sc-executor = { version = '0.8.0-alpha.7', git = 'https://github.com/paritytech/substrate', rev = '7f73312aa0bf4a4107860141f085e9770ec01b72' }
+sc-service = { version = '0.8.0-alpha.7', git = 'https://github.com/paritytech/substrate', rev = '7f73312aa0bf4a4107860141f085e9770ec01b72' }
+sp-inherents = { version = '2.0.0-alpha.7', git = 'https://github.com/paritytech/substrate', rev = '7f73312aa0bf4a4107860141f085e9770ec01b72' }
+sc-transaction-pool = { version = '2.0.0-alpha.7', git = 'https://github.com/paritytech/substrate', rev = '7f73312aa0bf4a4107860141f085e9770ec01b72' }
+sp-transaction-pool = { version = '2.0.0-alpha.7', git = 'https://github.com/paritytech/substrate', rev = '7f73312aa0bf4a4107860141f085e9770ec01b72' }
+sc-network = { version = '0.8.0-alpha.7', git = 'https://github.com/paritytech/substrate', rev = '7f73312aa0bf4a4107860141f085e9770ec01b72' }
+sc-consensus-babe = { version = '0.8.0-alpha.7', git = 'https://github.com/paritytech/substrate', rev = '7f73312aa0bf4a4107860141f085e9770ec01b72' }
+sp-consensus-babe = { version = '0.8.0-alpha.7', git = 'https://github.com/paritytech/substrate', rev = '7f73312aa0bf4a4107860141f085e9770ec01b72' }
+sc-finality-grandpa = { version = '0.8.0-alpha.7', git = 'https://github.com/paritytech/substrate', rev = '7f73312aa0bf4a4107860141f085e9770ec01b72' }
+sp-finality-grandpa = { version = '2.0.0-alpha.7', git = 'https://github.com/paritytech/substrate', rev = '7f73312aa0bf4a4107860141f085e9770ec01b72' }
+sc-basic-authorship = { version = '0.8.0-alpha.7', git = 'https://github.com/paritytech/substrate', rev = '7f73312aa0bf4a4107860141f085e9770ec01b72' }
+sp-consensus = { version = '0.8.0-alpha.7', git = 'https://github.com/paritytech/substrate', rev = '7f73312aa0bf4a4107860141f085e9770ec01b72' }
 
 # This node only works with runtimes that can provide babe and grandpa authorities.
 # No other runtimes that come with the recipes provide these APIs, but the substrate demonstration
 # runtime does.
 runtime = { package = "babe-grandpa-runtime", path = "../../runtimes/babe-grandpa-runtime" }
 
-# In theory the main Substrate node's runtime should work, but it is not published on crates.io
-# so a git dependency is necessary which leads to:
-# `perhaps two different versions of crate `sp_runtime` are being used?`
-# runtime = { package = "node-runtime", git = "https://github.com/paritytech/substrate/", tag = "v2.0.0-alpha.6" }
+# In theory the main Substrate node's runtime is compatible, but there are several practical limitations
+# 1. It isn't published on crates.io so a git dependency is needed which leads to
+#    `perhaps two different versions of crate `sp_runtime` are being used?`
+# 2. That runtime doesn't have an `opaque` module
+# 3. That runtime doesn't have a genesis module
+# runtime = { package = "node-runtime", git = "https://github.com/paritytech/substrate/", rev = '7f73312aa0bf4a4107860141f085e9770ec01b72' }
 
 
 [build-dependencies]
 vergen = "3.0.4"
-substrate-build-script-utils = '2.0.0-alpha.6'
+substrate-build-script-utils = { version = '2.0.0-alpha.7', git = 'https://github.com/paritytech/substrate', rev = '7f73312aa0bf4a4107860141f085e9770ec01b72' }
 
 [features]
 ocw = []

nodes/babe-grandpa-node/src/service.rs

@@ -2,7 +2,7 @@
 
 use std::sync::Arc;
 use std::time::Duration;
-use sc_client::LongestChain;
+use sc_consensus::LongestChain;
 use sc_client_api::ExecutorProvider;
 use runtime::{self, opaque::Block, RuntimeApi};
 use sc_service::{error::{Error as ServiceError}, AbstractService, Configuration, ServiceBuilder};
@@ -36,13 +36,17 @@ macro_rules! new_full_start {
 			runtime::opaque::Block, runtime::RuntimeApi, crate::service::Executor
 		>($config)?
 			.with_select_chain(|_config, backend| {
-				Ok(sc_client::LongestChain::new(backend.clone()))
+				Ok(sc_consensus::LongestChain::new(backend.clone()))
 			})?
-			.with_transaction_pool(|config, client, _fetcher| {
+			.with_transaction_pool(|config, client, _fetcher, prometheus_registry| {
 				let pool_api = sc_transaction_pool::FullChainApi::new(client.clone());
-				Ok(sc_transaction_pool::BasicPool::new(config, std::sync::Arc::new(pool_api)))
+				Ok(sc_transaction_pool::BasicPool::new(
+					config,
+					std::sync::Arc::new(pool_api),
+					prometheus_registry,
+				))
 			})?
-			.with_import_queue(|_config, client, mut select_chain, _transaction_pool| {
+			.with_import_queue(|_config, client, mut select_chain, _transaction_pool, spawn_task_handle| {
 				let select_chain = select_chain.take()
 					.ok_or_else(|| sc_service::Error::SelectChainRequired)?;
 				let (grandpa_block_import, grandpa_link) =
@@ -64,6 +68,7 @@ macro_rules! new_full_start {
 					None,
 					client,
 					inherent_data_providers.clone(),
+					spawn_task_handle,
 				)?;
 
 				import_setup = Some((babe_block_import, grandpa_link, babe_link));
@@ -160,6 +165,7 @@ pub fn new_full(config: Configuration)
 			telemetry_on_connect: Some(service.telemetry_on_connect_stream()),
 			voting_rule: sc_finality_grandpa::VotingRulesBuilder::default().build(),
 			prometheus_registry: service.prometheus_registry(),
+			shared_voter_state: sc_finality_grandpa::SharedVoterState::empty(),
 		};
 
 		// the GRANDPA voter task is considered infallible, i.e.
@@ -189,16 +195,19 @@ pub fn new_light(config: Configuration)
 		.with_select_chain(|_config, backend| {
 			Ok(LongestChain::new(backend.clone()))
 		})?
-		.with_transaction_pool(|config, client, fetcher| {
+		.with_transaction_pool(|config, client, fetcher, prometheus_registry| {
 			let fetcher = fetcher
 				.ok_or_else(|| "Trying to start light transaction pool without active fetcher")?;
 			let pool_api = sc_transaction_pool::LightChainApi::new(client.clone(), fetcher.clone());
 			let pool = sc_transaction_pool::BasicPool::with_revalidation_type(
-				config, Arc::new(pool_api), sc_transaction_pool::RevalidationType::Light,
+				config,
+				Arc::new(pool_api),
+				prometheus_registry,
+				sc_transaction_pool::RevalidationType::Light,
 			);
 			Ok(pool)
 		})?
-		.with_import_queue_and_fprb(|_config, client, backend, fetcher, _select_chain, _tx_pool| {
+		.with_import_queue_and_fprb(|_config, client, backend, fetcher, _select_chain, _tx_pool, spawn_task_handle| {
 			let fetch_checker = fetcher
 				.map(|fetcher| fetcher.checker().clone())
 				.ok_or_else(|| "Trying to start light import queue without active fetch checker")?;
@@ -223,6 +232,7 @@ pub fn new_light(config: Configuration)
 				Some(Box::new(finality_proof_import)),
 				client.clone(),
 				inherent_data_providers.clone(),
+				spawn_task_handle,
 			)?;
 
 			Ok((import_queue, finality_proof_request_builder))