merge from master

.github/pull_request_template.md

@@ -0,0 +1,18 @@
+---
+name: Pull Request
+about: Pull Request checklist
+title: ''
+labels: ''
+assignees: ''
+
+---
+If your PR is a work in progress, please feel free to create it and include a [WIP] tag in the PR name. We encourage everyone to PR early and often so that other developers know what you're working on.
+
+Before submitting your PR for final review, please ensure that it:
+
+* Includes a proper description of what problems the PR addresses, as well as a detailed explanation as to what it changes
+* Explains whether/how the change is consensus breaking or breaks existing client functionality
+* Contains unit tests exercising new/changed functionality
+* Fully considers the potential impact of the change on other parts of the system
+* Describes how you've tested the change (e.g. against Floonet, etc)
+* Updates any documentation that's affected by the PR

CONTRIBUTING.md

@@ -6,7 +6,23 @@ The [list of issues](https://github.com/mimblewimble/grin/issues) is a good plac
 
 Additional tests are rewarded with an immense amount of positive karma.
 
-More documentation or updates/fixes to existing documentation are also very welcome. However, if submitting a PR(Pull-Request) consisting of documentation changes only, please try to ensure that the change is significantly more substantial than one or two lines. For example, working through an install document and making changes and updates throughout as you find issues is worth a PR. For typos and other small changes, either contact one of the developers, or if you think it's a significant enough error to cause problems for other users, please feel free to open an issue.
+More documentation or updates/fixes to existing documentation are also very welcome. 
+
+# PR Guidelines
+
+We generally prefer you to PR your work earlier rather than later. This ensures everyone else has a better idea of what's being worked on, and can help reduce wasted effort. If work on your PR has just begun, please feel free to create the PR with [WIP] (work in progress) in the PR title, and let us know when it's ready for review in the comments.
+
+Since mainnet has been released, the bar for having PRs accepted has been raised. Before submitting your PR for approval, please be ensure it:
+* Includes a proper description of what problems the PR addresses, as well as a detailed explanation as to what it changes
+* Explains whether/how the change is consensus breaking or breaks existing client functionality
+* Contains unit tests exercising new/changed functionality
+* Fully considers the potential impact of the change on other parts of the system
+* Describes how you've tested the change (e.g. against Floonet, etc)
+* Updates any documentation that's affected by the PR
+
+If submitting a PR consisting of documentation changes only, please try to ensure that the change is significantly more substantial than one or two lines. For example, working through an install document and making changes and updates throughout as you find issues is worth a PR. For typos and other small changes, either contact one of the developers, or if you think it's a significant enough error to cause problems for other users, please feel free to open an issue.
+
+The development team will be happy to help and guide you with any of these points and work with you getting your PR submitted for approval. Create a PR with [WIP] in the title and ask for specific assistance within the issue, or contact the dev team on any of the channels below.
 
 # Find Us
 

api/Cargo.toml

@@ -30,9 +30,9 @@ futures = "0.1.21"
 rustls = "0.13"
 url = "1.7.0"
 
-grin_core = { path = "../core", version = "1.0.1" }
-grin_chain = { path = "../chain", version = "1.0.1" }
-grin_p2p = { path = "../p2p", version = "1.0.1" }
-grin_pool = { path = "../pool", version = "1.0.1" }
-grin_store = { path = "../store", version = "1.0.1" }
-grin_util = { path = "../util", version = "1.0.1" }
+grin_core = { path = "../core", version = "1.1.0" }
+grin_chain = { path = "../chain", version = "1.1.0" }
+grin_p2p = { path = "../p2p", version = "1.1.0" }
+grin_pool = { path = "../pool", version = "1.1.0" }
+grin_store = { path = "../store", version = "1.1.0" }
+grin_util = { path = "../util", version = "1.1.0" }

api/src/client.rs

@@ -52,6 +52,15 @@ where
 	}
 }
 
+/// Helper function to easily issue a HTTP GET request
+/// on a given URL that returns nothing. Handles request
+/// building and response code checking.
+pub fn get_no_ret(url: &str, api_secret: Option<String>) -> Result<(), Error> {
+	let req = build_request(url, "GET", api_secret, None)?;
+	send_request(req)?;
+	Ok(())
+}
+
 /// Helper function to easily issue a HTTP POST request with the provided JSON
 /// object as body on a given URL that returns a JSON object. Handles request
 /// building, JSON serialization and deserialization, and response code

api/src/handlers/blocks_api.rs

@@ -11,7 +11,6 @@
 // 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.
-
 use super::utils::{get_output, w};
 use crate::chain;
 use crate::core::core::hash::Hash;
@@ -68,10 +67,7 @@ impl HeaderHandler {
 
 impl Handler for HeaderHandler {
 	fn get(&self, req: Request<Body>) -> ResponseFuture {
-		let el = match req.uri().path().trim_right_matches('/').rsplit('/').next() {
-			None => return response(StatusCode::BAD_REQUEST, "invalid url"),
-			Some(el) => el,
-		};
+		let el = right_path_element!(req);
 		result_to_response(self.get_header(el.to_string()))
 	}
 }
@@ -130,11 +126,7 @@ fn check_block_param(input: &String) -> Result<(), Error> {
 
 impl Handler for BlockHandler {
 	fn get(&self, req: Request<Body>) -> ResponseFuture {
-		let el = match req.uri().path().trim_right_matches('/').rsplit('/').next() {
-			None => return response(StatusCode::BAD_REQUEST, "invalid url"),
-			Some(el) => el,
-		};
-
+		let el = right_path_element!(req);
 		let h = match self.parse_input(el.to_string()) {
 			Err(e) => {
 				return response(

api/src/handlers/chain_api.rs

@@ -22,9 +22,7 @@ use crate::util;
 use crate::util::secp::pedersen::Commitment;
 use crate::web::*;
 use hyper::{Body, Request, StatusCode};
-use std::collections::HashMap;
 use std::sync::Weak;
-use url::form_urlencoded;
 
 /// Chain handler. Get the head details.
 /// GET /v1/chain
@@ -101,21 +99,9 @@ impl OutputHandler {
 	fn outputs_by_ids(&self, req: &Request<Body>) -> Result<Vec<Output>, Error> {
 		let mut commitments: Vec<String> = vec![];
 
-		let query = match req.uri().query() {
-			Some(q) => q,
-			None => return Err(ErrorKind::RequestError("no query string".to_owned()))?,
-		};
-		let params = form_urlencoded::parse(query.as_bytes())
-			.into_owned()
-			.collect::<Vec<(String, String)>>();
-
-		for (k, id) in params {
-			if k == "id" {
-				for id in id.split(',') {
-					commitments.push(id.to_owned());
-				}
-			}
-		}
+		let query = must_get_query!(req);
+		let params = QueryParams::from(query);
+		params.process_multival_param("id", |id| commitments.push(id.to_owned()));
 
 		let mut outputs: Vec<Output> = vec![];
 		for x in commitments {
@@ -159,49 +145,17 @@ impl OutputHandler {
 	// returns outputs for a specified range of blocks
 	fn outputs_block_batch(&self, req: &Request<Body>) -> Result<Vec<BlockOutputs>, Error> {
 		let mut commitments: Vec<Commitment> = vec![];
-		let mut start_height = 1;
-		let mut end_height = 1;
-		let mut include_rp = false;
-
-		let query = match req.uri().query() {
-			Some(q) => q,
-			None => return Err(ErrorKind::RequestError("no query string".to_owned()))?,
-		};
-
-		let params = form_urlencoded::parse(query.as_bytes()).into_owned().fold(
-			HashMap::new(),
-			|mut hm, (k, v)| {
-				hm.entry(k).or_insert(vec![]).push(v);
-				hm
-			},
-		);
 
-		if let Some(ids) = params.get("id") {
-			for id in ids {
-				for id in id.split(',') {
-					if let Ok(x) = util::from_hex(String::from(id)) {
-						commitments.push(Commitment::from_vec(x));
-					}
-				}
+		let query = must_get_query!(req);
+		let params = QueryParams::from(query);
+		params.process_multival_param("id", |id| {
+			if let Ok(x) = util::from_hex(String::from(id)) {
+				commitments.push(Commitment::from_vec(x));
 			}
-		}
-		if let Some(heights) = params.get("start_height") {
-			for height in heights {
-				start_height = height
-					.parse()
-					.map_err(|_| ErrorKind::RequestError("invalid start_height".to_owned()))?;
-			}
-		}
-		if let Some(heights) = params.get("end_height") {
-			for height in heights {
-				end_height = height
-					.parse()
-					.map_err(|_| ErrorKind::RequestError("invalid end_height".to_owned()))?;
-			}
-		}
-		if let Some(_) = params.get("include_rp") {
-			include_rp = true;
-		}
+		});
+		let start_height = parse_param!(params, "start_height", 1);
+		let end_height = parse_param!(params, "end_height", 1);
+		let include_rp = params.get("include_rp").is_some();
 
 		debug!(
 			"outputs_block_batch: {}-{}, {:?}, {:?}",
@@ -223,11 +177,7 @@ impl OutputHandler {
 
 impl Handler for OutputHandler {
 	fn get(&self, req: Request<Body>) -> ResponseFuture {
-		let command = match req.uri().path().trim_right_matches('/').rsplit('/').next() {
-			Some(c) => c,
-			None => return response(StatusCode::BAD_REQUEST, "invalid url"),
-		};
-		match command {
+		match right_path_element!(req) {
 			"byids" => result_to_response(self.outputs_by_ids(&req)),
 			"byheight" => result_to_response(self.outputs_block_batch(&req)),
 			_ => response(StatusCode::BAD_REQUEST, ""),

api/src/handlers/peers_api.rs

@@ -14,7 +14,7 @@
 
 use super::utils::w;
 use crate::p2p;
-use crate::p2p::types::{PeerInfoDisplay, ReasonForBan};
+use crate::p2p::types::{PeerAddr, PeerInfoDisplay, ReasonForBan};
 use crate::router::{Handler, ResponseFuture};
 use crate::web::*;
 use hyper::{Body, Request, StatusCode};
@@ -37,11 +37,11 @@ pub struct PeersConnectedHandler {
 
 impl Handler for PeersConnectedHandler {
 	fn get(&self, _req: Request<Body>) -> ResponseFuture {
-		let mut peers: Vec<PeerInfoDisplay> = vec![];
-		for p in &w(&self.peers).connected_peers() {
-			let peer_info = p.info.clone();
-			peers.push(peer_info.into());
-		}
+		let peers: Vec<PeerInfoDisplay> = w(&self.peers)
+			.connected_peers()
+			.iter()
+			.map(|p| p.info.clone().into())
+			.collect();
 		json_response(&peers)
 	}
 }
@@ -56,20 +56,26 @@ pub struct PeerHandler {
 
 impl Handler for PeerHandler {
 	fn get(&self, req: Request<Body>) -> ResponseFuture {
-		let command = match req.uri().path().trim_right_matches('/').rsplit('/').next() {
-			Some(c) => c,
-			None => return response(StatusCode::BAD_REQUEST, "invalid url"),
-		};
-		if let Ok(addr) = command.parse() {
-			match w(&self.peers).get_peer(addr) {
-				Ok(peer) => json_response(&peer),
-				Err(_) => response(StatusCode::NOT_FOUND, "peer not found"),
-			}
+		let command = right_path_element!(req);
+
+		// We support both "ip" and "ip:port" here for peer_addr.
+		// "ip:port" is only really useful for local usernet testing on loopback address.
+		// Normally we map peers to ip and only allow a single peer per ip address.
+		let peer_addr;
+		if let Ok(ip_addr) = command.parse() {
+			peer_addr = PeerAddr::from_ip(ip_addr);
+		} else if let Ok(addr) = command.parse() {
+			peer_addr = PeerAddr(addr);
 		} else {
-			response(
+			return response(
 				StatusCode::BAD_REQUEST,
 				format!("peer address unrecognized: {}", req.uri().path()),
-			)
+			);
+		}
+
+		match w(&self.peers).get_peer(peer_addr) {
+			Ok(peer) => json_response(&peer),
+			Err(_) => response(StatusCode::NOT_FOUND, "peer not found"),
 		}
 	}
 	fn post(&self, req: Request<Body>) -> ResponseFuture {
@@ -80,20 +86,23 @@ impl Handler for PeerHandler {
 		};
 		let addr = match path_elems.next() {
 			None => return response(StatusCode::BAD_REQUEST, "invalid url"),
-			Some(a) => match a.parse() {
-				Err(e) => {
+			Some(a) => {
+				if let Ok(ip_addr) = a.parse() {
+					PeerAddr::from_ip(ip_addr)
+				} else if let Ok(addr) = a.parse() {
+					PeerAddr(addr)
+				} else {
 					return response(
 						StatusCode::BAD_REQUEST,
-						format!("invalid peer address: {}", e),
+						format!("invalid peer address: {}", req.uri().path()),
 					);
 				}
-				Ok(addr) => addr,
-			},
+			}
 		};
 
 		match command {
-			"ban" => w(&self.peers).ban_peer(&addr, ReasonForBan::ManualBan),
-			"unban" => w(&self.peers).unban_peer(&addr),
+			"ban" => w(&self.peers).ban_peer(addr, ReasonForBan::ManualBan),
+			"unban" => w(&self.peers).unban_peer(addr),
 			_ => return response(StatusCode::BAD_REQUEST, "invalid command"),
 		};
 

api/src/handlers/pool_api.rs

@@ -23,12 +23,11 @@ use crate::types::*;
 use crate::util;
 use crate::util::RwLock;
 use crate::web::*;
+use failure::ResultExt;
 use futures::future::ok;
 use futures::Future;
 use hyper::{Body, Request, StatusCode};
-use std::collections::HashMap;
 use std::sync::Weak;
-use url::form_urlencoded;
 
 /// Get basic information about the transaction pool.
 /// GET /v1/pool
@@ -61,15 +60,7 @@ pub struct PoolPushHandler {
 
 impl PoolPushHandler {
 	fn update_pool(&self, req: Request<Body>) -> Box<dyn Future<Item = (), Error = Error> + Send> {
-		let params = match req.uri().query() {
-			Some(query_string) => form_urlencoded::parse(query_string.as_bytes())
-				.into_owned()
-				.fold(HashMap::new(), |mut hm, (k, v)| {
-					hm.entry(k).or_insert(vec![]).push(v);
-					hm
-				}),
-			None => HashMap::new(),
-		};
+		let params = QueryParams::from(req.uri().query());
 
 		let fluff = params.get("fluff").is_some();
 		let pool_arc = w(&self.tx_pool).clone();
@@ -99,13 +90,14 @@ impl PoolPushHandler {
 
 					//  Push to tx pool.
 					let mut tx_pool = pool_arc.write();
-					let header = tx_pool.blockchain.chain_head().unwrap();
-					tx_pool
+					let header = tx_pool
+						.blockchain
+						.chain_head()
+						.context(ErrorKind::Internal("Failed to get chain head".to_owned()))?;
+					let res = tx_pool
 						.add_to_pool(source, tx, !fluff, &header)
-						.map_err(|e| {
-							error!("update_pool: failed with error: {:?}", e);
-							ErrorKind::Internal(format!("Failed to update pool: {:?}", e)).into()
-						})
+						.context(ErrorKind::Internal("Failed to update pool".to_owned()))?;
+					Ok(res)
 				}),
 		)
 	}