Merge pull request #79 from paritytech/gav-demo

Substrate demo (a basic blockchain made with substrate)

.gitignore

@@ -5,4 +5,5 @@
 polkadot/runtime/wasm/target/
 substrate/executor/wasm/target/
 substrate/test-runtime/wasm/target/
+demo/runtime/wasm/target/
 **/._*

Cargo.toml

@@ -40,9 +40,14 @@ members = [
 	"substrate/serializer",
 	"substrate/state-machine",
 	"substrate/test-runtime",
+	"demo/runtime",
+	"demo/primitives",
+	"demo/executor",
+	"demo/cli",
 ]
 exclude = [
 	"polkadot/runtime/wasm",
+	"demo/runtime/wasm",
 	"substrate/executor/wasm",
 	"substrate/pwasm-alloc",
 	"substrate/pwasm-libc",

build.sh

@@ -3,3 +3,4 @@
 cd substrate/executor/wasm && ./build.sh && cd ../../..
 cd substrate/test-runtime/wasm && ./build.sh && cd ../../..
 cd polkadot/runtime/wasm && ./build.sh && cd ../../..
+cd demo/runtime/wasm && ./build.sh && cd ../../..

demo/cli/Cargo.toml

@@ -0,0 +1,24 @@
+[package]
+name = "demo-cli"
+version = "0.1.0"
+authors = ["Parity Technologies <admin@parity.io>"]
+description = "Substrate Demo node implementation in Rust."
+
+[dependencies]
+clap = { version = "2.27", features = ["yaml"] }
+env_logger = "0.4"
+error-chain = "0.11"
+log = "0.3"
+hex-literal = "0.1"
+triehash = "0.1"
+ed25519 = { path = "../../substrate/ed25519" }
+substrate-client = { path = "../../substrate/client" }
+substrate-codec = { path = "../../substrate/codec" }
+substrate-runtime-io = { path = "../../substrate/runtime-io" }
+substrate-state-machine = { path = "../../substrate/state-machine" }
+substrate-executor = { path = "../../substrate/executor" }
+substrate-primitives = { path = "../../substrate/primitives" }
+substrate-rpc-servers = { path = "../../substrate/rpc-servers" }
+demo-primitives = { path = "../primitives" }
+demo-executor = { path = "../executor" }
+demo-runtime = { path = "../runtime" }

demo/cli/src/cli.yml

@@ -0,0 +1,12 @@
+name: substrate-demo
+author: "Parity Team <admin@parity.io>"
+about: Substrate Demo Node Rust Implementation
+args:
+  - log:
+      short: l
+      value_name: LOG_PATTERN
+      help: Sets a custom logging
+      takes_value: true
+subcommands:
+  - validator:
+      about: Run validator node

demo/cli/src/error.rs

@@ -0,0 +1,29 @@
+// Copyright 2017 Parity Technologies (UK) Ltd.
+// This file is part of Substrate Demo.
+
+// Substrate Demo 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 Demo 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 Demo.  If not, see <http://www.gnu.org/licenses/>.
+
+//! Initialization errors.
+
+use client;
+
+error_chain! {
+	foreign_links {
+		Io(::std::io::Error) #[doc="IO error"];
+		Cli(::clap::Error) #[doc="CLI error"];
+	}
+	links {
+		Client(client::error::Error, client::error::ErrorKind) #[doc="Client error"];
+    }
+}

demo/cli/src/lib.rs

@@ -0,0 +1,134 @@
+// Copyright 2017 Parity Technologies (UK) Ltd.
+// This file is part of Substrate Demo.
+
+// Substrate Demo 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 Demo 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 Demo.  If not, see <http://www.gnu.org/licenses/>.
+
+//! Substrate Demo CLI library.
+
+#![warn(missing_docs)]
+
+extern crate env_logger;
+extern crate ed25519;
+extern crate triehash;
+extern crate substrate_codec as codec;
+extern crate substrate_state_machine as state_machine;
+extern crate substrate_client as client;
+extern crate substrate_primitives as primitives;
+extern crate substrate_rpc_servers as rpc;
+extern crate demo_primitives;
+extern crate demo_executor;
+extern crate demo_runtime;
+
+#[macro_use]
+extern crate hex_literal;
+#[macro_use]
+extern crate clap;
+#[macro_use]
+extern crate error_chain;
+#[macro_use]
+extern crate log;
+
+pub mod error;
+
+use codec::Slicable;
+use demo_runtime::genesismap::{additional_storage_with_genesis, GenesisConfig};
+use client::genesis;
+
+/// Parse command line arguments and start the node.
+///
+/// IANA unassigned port ranges that we could use:
+/// 6717-6766		Unassigned
+/// 8504-8553		Unassigned
+/// 9556-9591		Unassigned
+/// 9803-9874		Unassigned
+/// 9926-9949		Unassigned
+pub fn run<I, T>(args: I) -> error::Result<()> where
+	I: IntoIterator<Item = T>,
+	T: Into<std::ffi::OsString> + Clone,
+{
+	let yaml = load_yaml!("./cli.yml");
+	let matches = clap::App::from_yaml(yaml).version(crate_version!()).get_matches_from_safe(args)?;
+
+	// TODO [ToDr] Split parameters parsing from actual execution.
+	let log_pattern = matches.value_of("log").unwrap_or("");
+	init_logger(log_pattern);
+
+	// Create client
+	let executor = demo_executor::Executor::new();
+	let mut storage = Default::default();
+	let god_key = hex!["3d866ec8a9190c8343c2fc593d21d8a6d0c5c4763aaab2349de3a6111d64d124"];
+
+	let genesis_config = GenesisConfig {
+		validators: vec![god_key.clone()],
+		authorities: vec![god_key.clone()],
+		balances: vec![(god_key.clone(), 1u64 << 63)].into_iter().collect(),
+		block_time: 5,			// 5 second block time.
+		session_length: 720,	// that's 1 hour per session.
+		sessions_per_era: 24,	// 24 hours per era.
+		bonding_duration: 90,	// 90 days per bond.
+		launch_period: 120 * 24 * 14,	// 2 weeks per public referendum
+		voting_period: 120 * 24 * 28,	// 4 weeks to discuss & vote on an active referendum
+		minimum_deposit: 1000,	// 1000 as the minimum deposit for a referendum
+		candidacy_bond: 1000,	// 1000 to become a council candidate
+		voter_bond: 100,		// 100 down to vote for a candidate
+		present_slash_per_voter: 1,	// slash by 1 per voter for an invalid presentation.
+		carry_count: 24,		// carry over the 24 runners-up to the next council election
+		presentation_duration: 120 * 24,	// one day for presenting winners.
+		council_election_voting_period: 7 * 120 * 24,	// one week period between possible council elections.
+		council_term_duration: 180 * 120 * 24,	// 180 day term duration for the council.
+		desired_seats: 0, // start with no council: we'll raise this once the stake has been dispersed a bit.
+		inactive_grace_period: 1,	// one addition vote should go by before an inactive voter can be reaped.
+		cooloff_period: 90 * 120 * 24, // 90 day cooling off period if council member vetoes a proposal.
+		council_proposal_voting_period: 7 * 120 * 24, // 7 day voting period for council members.
+	};
+	let prepare_genesis = || {
+		storage = genesis_config.genesis_map();
+		let block = genesis::construct_genesis_block(&storage);
+		storage.extend(additional_storage_with_genesis(&block));
+		(primitives::block::Header::decode(&mut block.header.encode().as_ref()).expect("to_vec() always gives a valid serialisation; qed"), storage.into_iter().collect())
+	};
+	let client = client::new_in_mem(executor, prepare_genesis)?;
+
+	let address = "127.0.0.1:9933".parse().unwrap();
+	let handler = rpc::rpc_handler(client);
+	let server = rpc::start_http(&address, handler)?;
+
+	if let Some(_) = matches.subcommand_matches("validator") {
+		info!("Starting validator.");
+		server.wait();
+		return Ok(());
+	}
+
+	println!("No command given.\n");
+	let _ = clap::App::from_yaml(yaml).print_long_help();
+
+	Ok(())
+}
+
+fn init_logger(pattern: &str) {
+	let mut builder = env_logger::LogBuilder::new();
+	// Disable info logging by default for some modules:
+	builder.filter(Some("hyper"), log::LogLevelFilter::Warn);
+	// Enable info for others.
+	builder.filter(None, log::LogLevelFilter::Info);
+
+	if let Ok(lvl) = std::env::var("RUST_LOG") {
+		builder.parse(&lvl);
+	}
+
+	builder.parse(pattern);
+
+
+	builder.init().expect("Logger initialized only once.");
+}

demo/executor/Cargo.toml

@@ -0,0 +1,21 @@
+[package]
+name = "demo-executor"
+version = "0.1.0"
+authors = ["Parity Technologies <admin@parity.io>"]
+description = "Substrate Demo node implementation in Rust."
+
+[dependencies]
+hex-literal = "0.1"
+triehash = { version = "0.1" }
+ed25519 = { path = "../../substrate/ed25519" }
+substrate-codec = { path = "../../substrate/codec" }
+substrate-runtime-io = { path = "../../substrate/runtime-io" }
+substrate-runtime-support = { path = "../../substrate/runtime-support" }
+substrate-state-machine = { path = "../../substrate/state-machine" }
+substrate-executor = { path = "../../substrate/executor" }
+substrate-primitives = { path = "../../substrate/primitives" }
+demo-primitives = { path = "../primitives" }
+demo-runtime = { path = "../runtime" }
+
+[dev-dependencies]
+substrate-keyring = { path = "../../substrate/keyring" }