[1.1.0] Merge master into 1.1.0 (#2720)

* cleanup legacy "3 dot" check (#2625)

* Allow to peers behind NAT to get up to preferred_max connections (#2543)

Allow to peers behind NAT to get up to preffered_max connections

If peer has only outbound connections it's mot likely behind NAT and we should not stop it from getting more outbound connections

* Reduce usage of unwrap in p2p crate (#2627)

Also change store crate a bit

* Simplify (and fix) output_pos cleanup during chain compaction (#2609)

* expose leaf pos iterator
use it for various things in txhashset when iterating over outputs

* fix

* cleanup

* rebuild output_pos index (and clear it out first) when compacting the chain

* fixup tests

* refactor to match on (output, proof) tuple

* add comments to compact() to explain what is going on.

* get rid of some boxing around the leaf_set iterator

* cleanup

* [docs] Add switch commitment documentation (#2526)

* remove references to no-longer existing switch commitment hash

(as switch commitments were removed in ca8447f3bd
and moved into the blinding factor of the Pedersen Commitment)

* some rewording (points vs curves) and fix of small formatting issues

* Add switch commitment documentation

* [docs] Documents in grin repo had translated in Korean.  (#2604)

*  Start to M/W intro translate in Korean
*  translate in Korean
*  add korean translation  on intro
* table_of_content.md translate in Korean.
*  table_of_content_KR.md finish translate in Korean, start to translate State_KR.md
*  add state_KR.md & commit some translation in State_KR.md
*  WIP stat_KR.md translation
*  add build_KR.md && stratum_KR.md
*  finish translate stratum_KR.md & table_of_content_KR.md
*  rename intro.KR.md to intro_KR.md
*  add intro_KR.md file path each language's  intro.md
*  add Korean translation file path to stratum.md & table_of_contents.md
*  fix difference with grin/master

* Fix TxHashSet file filter for Windows. (#2641)

* Fix TxHashSet file filter for Windows.

* rustfmt

* Updating regexp

* Adding in test case

* Display the current download rate rather than the average when syncing the chain (#2633)

* When syncing the chain, calculate the displayed download speed using the current rate from the most recent iteration, rather than the average download speed from the entire syncing process.

* Replace the explicitly ignored variables in the pattern with an implicit ignore

* remove root = true from editorconfig (#2655)

* Add Medium post to intro (#2654)

Spoke to @yeastplume who agreed it makes sense to add the "Grin Transactions Explained, Step-by-Step" Medium post to intro.md

Open for suggestions on a better location.

* add a new configure item for log_max_files (#2601)

* add a new configure item for log_max_files

* rustfmt

* use a constant instead of multiple 32

* rustfmt

* Fix the build warning of deprecated trim_right_matches (#2662)

* [DOC] state.md, build.md and chain directory documents translate in Korean.  (#2649)

*  add md files for translation.

*  start to translation fast-sync, code_structure. add file build_KR.md, states_KR.md

* add dandelion_KR.md && simulation_KR.md for Korean translation.

*  add md files for translation.

*  start to translation fast-sync, code_structure. add file build_KR.md, states_KR.md

* add dandelion_KR.md && simulation_KR.md for Korean translation.

* remove some useless md files for translation. this is rearrange set up translation order.

*  add dot end of sentence & translate build.md in korean

*  remove fast-sync_KR.md

*  finish build_KR.md translation

*  finish build_KR.md translation

*  finish translation state_KR.md & add phrase in state.md to move other language md file

* translate blocks_and_headers.md && chain_sync.md in Korean

*  add . in chain_sync.md , translation finished in doc/chain dir.

* fix some miss typos

* Api documentation fixes (#2646)

* Fix the API documentation for Chain Validate (v1/chain/validate).  It was documented as a POST, but it is actually a GET request, which can be seen in its handler ChainValidationHandler
* Update the API V1 route list response to include the headers and merkleproof routes.  Also clarify that for the chain/outputs route you must specify either byids or byheight to select outputs.

* refactor(ci): reorganize CI related code (#2658)

Break-down the CI related code into smaller more maintainable pieces.

* Specify grin or nanogrins in API docs where applicable (#2642)

* Set Content-Type in API client (#2680)

* Reduce number of unwraps in chain crate (#2679)

* fix: the restart of state sync doesn't work sometimes (#2687)

* let check_txhashset_needed return true on abnormal case (#2684)

*  Reduce number of unwwaps in api crate  (#2681)

* Reduce number of unwwaps in api crate

* Format use section

* Small QoL improvements for wallet developers (#2651)

* Small changes for wallet devs

* Move create_nonce into Keychain trait

* Replace match by map_err

* Add flag to Slate to skip fee check

* Fix secp dependency

* Remove check_fee flag in Slate

* Add Japanese edition of build.md (#2697)

* catch the panic to avoid peer thread quit early (#2686)

* catch the panic to avoid peer thread quit before taking the chance to ban
* move catch wrapper logic down into the util crate
* log the panic info
* keep txhashset.rs untouched
* remove a warning

* [DOC] dandelion.md, simulation.md ,fast-sync.md and pruning.md documents translate in Korean. (#2678)

* Show response code in API client error message (#2683)

It's hard to investigate what happens when an API client error is
printed out

* Add some better logging for get_outputs_by_id failure states (#2705)

* Switch commitment doc fixes (#2645)

Fix some typos and remove the use of parentheses in a
couple of places to make the reading flow a bit better.

* docs: update/add new README.md badges (#2708)

Replace existing badges with SVG counterparts and add a bunch of new ones.

* Update intro.md (#2702)

Add mention of censoring attack prevented by range proofs

* use sandbox folder for txhashset validation on state sync (#2685)

* use sandbox folder for txhashset validation on state sync

* rustfmt

* use temp directory as the sandbox instead actual db_root txhashset dir

* rustfmt

* move txhashset overwrite to the end of full validation

* fix travis-ci test

* rustfmt

* fix: hashset have 2 folders including txhashset and header

* rustfmt

* 
(1)switch to rebuild_header_mmr instead of copy the sandbox header mmr 
(2)lock txhashset when overwriting and opening and rebuild

* minor improve on sandbox_dir

* add Japanese edition of state.md (#2703)

* Attempt to fix broken TUI locale (#2713)

Can confirm that on the same machine 1.0.2 TUI looks great and is broken on
the current master. Bump of `cursive` version fixed it for me.
Fixes #2676

* clean the header folder in sandbox (#2716)

* forgot to clean the header folder in sandbox in #2685

* Reduce number of unwraps in servers crate (#2707)

It doesn't include stratum server which is sufficiently changed in 1.1
branch and adapters, which is big enough for a separate PR.

* rustfmt

* change version to beta

util/src/logger.rs

@@ -18,7 +18,7 @@ use std::ops::Deref;
 use backtrace::Backtrace;
 use std::{panic, thread};
 
-use crate::types::{LogLevel, LoggingConfig};
+use crate::types::{self, LogLevel, LoggingConfig};
 
 use log::{LevelFilter, Record};
 use log4rs;
@@ -124,8 +124,11 @@ pub fn init_logger(config: Option<LoggingConfig>) {
 			let filter = Box::new(ThresholdFilter::new(level_file));
 			let file: Box<dyn Append> = {
 				if let Some(size) = c.log_max_size {
+					let count = c
+						.log_max_files
+						.unwrap_or_else(|| types::DEFAULT_ROTATE_LOG_FILES);
 					let roller = FixedWindowRoller::builder()
-						.build(&format!("{}.{{}}.gz", c.log_file_path), 32)
+						.build(&format!("{}.{{}}.gz", c.log_file_path), count)
 						.unwrap();
 					let trigger = SizeTrigger::new(size);
 

util/src/types.rs

@@ -29,6 +29,9 @@ pub enum LogLevel {
 	Trace,
 }
 
+/// 32 log files to rotate over by default
+pub const DEFAULT_ROTATE_LOG_FILES: u32 = 32 as u32;
+
 /// Logging config
 #[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
 pub struct LoggingConfig {
@@ -46,6 +49,8 @@ pub struct LoggingConfig {
 	pub log_file_append: bool,
 	/// Size of the log in bytes to rotate over (optional)
 	pub log_max_size: Option<u64>,
+	/// Number of the log files to rotate over (optional)
+	pub log_max_files: Option<u32>,
 	/// Whether the tui is running (optional)
 	pub tui_running: Option<bool>,
 }
@@ -60,6 +65,7 @@ impl Default for LoggingConfig {
 			log_file_path: String::from("grin.log"),
 			log_file_append: true,
 			log_max_size: Some(1024 * 1024 * 16), // 16 megabytes default
+			log_max_files: Some(DEFAULT_ROTATE_LOG_FILES),
 			tui_running: None,
 		}
 	}

util/src/zip.rs

@@ -15,6 +15,7 @@
 use std::fs::{self, File};
 /// Wrappers around the `zip-rs` library to compress and decompress zip archives.
 use std::io;
+use std::panic;
 use std::path::Path;
 use walkdir::WalkDir;
 
@@ -64,58 +65,80 @@ pub fn compress(src_dir: &Path, dst_file: &File) -> ZipResult<()> {
 /// Decompress a source file into the provided destination path.
 pub fn decompress<R, F>(src_file: R, dest: &Path, expected: F) -> ZipResult<usize>
 where
-	R: io::Read + io::Seek,
-	F: Fn(&Path) -> bool,
+	R: io::Read + io::Seek + panic::UnwindSafe,
+	F: Fn(&Path) -> bool + panic::UnwindSafe,
 {
 	let mut decompressed = 0;
-	let mut archive = zip_rs::ZipArchive::new(src_file)?;
 
-	for i in 0..archive.len() {
-		let mut file = archive.by_index(i)?;
-		let san_name = file.sanitized_name();
-		if san_name.to_str().unwrap_or("").replace("\\", "/") != file.name().replace("\\", "/")
-			|| !expected(&san_name)
-		{
-			info!(
-				"ignoring a suspicious file: {}, got {:?}",
-				file.name(),
-				san_name.to_str()
-			);
-			continue;
-		}
-		let file_path = dest.join(san_name);
+	// catch the panic to avoid the thread quit
+	panic::set_hook(Box::new(|panic_info| {
+		error!(
+			"panic occurred: {:?}",
+			panic_info.payload().downcast_ref::<&str>().unwrap()
+		);
+	}));
+	let result = panic::catch_unwind(move || {
+		let mut archive = zip_rs::ZipArchive::new(src_file)?;
 
-		if (&*file.name()).ends_with('/') {
-			fs::create_dir_all(&file_path)?;
-		} else {
-			if let Some(p) = file_path.parent() {
-				if !p.exists() {
-					fs::create_dir_all(&p)?;
+		for i in 0..archive.len() {
+			let mut file = archive.by_index(i)?;
+			let san_name = file.sanitized_name();
+			if san_name.to_str().unwrap_or("").replace("\\", "/") != file.name().replace("\\", "/")
+				|| !expected(&san_name)
+			{
+				info!(
+					"ignoring a suspicious file: {}, got {:?}",
+					file.name(),
+					san_name.to_str()
+				);
+				continue;
+			}
+			let file_path = dest.join(san_name);
+
+			if (&*file.name()).ends_with('/') {
+				fs::create_dir_all(&file_path)?;
+			} else {
+				if let Some(p) = file_path.parent() {
+					if !p.exists() {
+						fs::create_dir_all(&p)?;
+					}
+				}
+				let res = fs::File::create(&file_path);
+				let mut outfile = match res {
+					Err(e) => {
+						error!("{:?}", e);
+						return Err(zip::result::ZipError::Io(e));
+					}
+					Ok(r) => r,
+				};
+				io::copy(&mut file, &mut outfile)?;
+				decompressed += 1;
+			}
+
+			// Get and Set permissions
+			#[cfg(unix)]
+			{
+				use std::os::unix::fs::PermissionsExt;
+				if let Some(mode) = file.unix_mode() {
+					fs::set_permissions(
+						&file_path.to_str().unwrap(),
+						PermissionsExt::from_mode(mode),
+					)?;
 				}
 			}
-			let res = fs::File::create(&file_path);
-			let mut outfile = match res {
-				Err(e) => {
-					error!("{:?}", e);
-					return Err(zip::result::ZipError::Io(e));
-				}
-				Ok(r) => r,
-			};
-			io::copy(&mut file, &mut outfile)?;
-			decompressed += 1;
 		}
-
-		// Get and Set permissions
-		#[cfg(unix)]
-		{
-			use std::os::unix::fs::PermissionsExt;
-			if let Some(mode) = file.unix_mode() {
-				fs::set_permissions(
-					&file_path.to_str().unwrap(),
-					PermissionsExt::from_mode(mode),
-				)?;
-			}
+		Ok(decompressed)
+	});
+	match result {
+		Ok(res) => match res {
+			Err(e) => Err(e.into()),
+			Ok(_) => res,
+		},
+		Err(_) => {
+			error!("panic occurred on zip::decompress!");
+			Err(zip::result::ZipError::InvalidArchive(
+				"panic occurred on zip::decompress",
+			))
 		}
 	}
-	Ok(decompressed)
 }