Apply review suggestions

Signed-off-by: koushiro <koushiro.cqx@gmail.com>

Author: koushiro

bin/node-template-archive/archive.toml

@@ -1,33 +1,35 @@
 [chain]
 # Must be an absolute path to chain data db (no ~/)
 # Can also be specified via the `CHAIN_DATA_DB` environment variable
-data_path = "/home/insipx/.local/share/node-template/chains/dev/db"
+data_path = "/.local/share/node-template/chains/dev/db"
 
 # How much should the read-only database keep in cache (MB)
 # Optional, default: 128
 cache_size = 128
 
-# RocksDB secondary directory, output will be `./output/rocksdb_secondary/`
+# RocksDB secondary directory
 # Optional, default: /<local>/substrate_archive/rocksdb_secondary/
-rocksdb_secondary_path = "./output/"
+rocksdb_secondary_path = "./substrate_archive/rocksdb_secondary"
 
 [runtime]
 # Specification of different methods of executing the runtime Wasm code.
-# Optional, "Interpreted" or "Compiled", default: "Interpreted"
+# Optional, "Interpreted" or "Compiled", default: "Interpreted".
 #exec_method = "Interpreted"
 
 # Number of threads to dedicate for executing blocks
-# Optional, default: the number of logical system threads
+# Optional, default: the number of logical system threads.
 block_workers = 4
 
 # Number of 64KB Heap Pages to allocate for WASM execution
-# Optional, default: 64 * the number of logical system threads
-wasm_pages = 512
+# Optional, default: 1024.
+wasm_pages = 256
 
 [database]
 # Database url.
-# Can also be specified via the `DATABASE_URL` environment variable
-# More info on the wiki: https://github.com/paritytech/substrate-archive/wiki/1.)-Requirements
+# Each chain needs it's own PostgreSQL database
+# Can also be specified via the `DATABASE_URL` environment variable.
+# For production use, using `DATABASE_URL` is preferable.
+# More info on the wiki: https://github.com/paritytech/substrate-archive/wiki/1.)-Requirements.
 url = "postgres://user:pass@localhost:5432/archive"
 
 [log]
@@ -43,6 +45,9 @@ std = "DEBUG"
 # Optional log file name, default: "archive.log"
 #name = "archive.log"
 
+# Advanced options
+#
+# Changing these may lead to unexpected results.
 [control]
 # Number of database actors to be spawned.
 # Optional, default: 4

bin/polkadot-archive/archive.toml

@@ -1,15 +1,15 @@
 [chain]
 # Must be an absolute path to the folder where polkadot/kusama/and westend chain data is stored
 # Can also be specified via the `CHAIN_DATA_DB` environment variable
-data_path = "/home/insipx/.local/share/polkadot/chains/polkadot/db"
+data_path = "/.local/share/polkadot/chains/polkadot/db"
 
 # How much should the read-only database keep in cache (MB)
 # Optional, default: 128
 cache_size = 128
 
-# RocksDB secondary directory, output will be `./output/rocksdb_secondary/`
+# RocksDB secondary directory
 # Optional, default: /<local>/substrate_archive/rocksdb_secondary/
-rocksdb_secondary_path = "./output/"
+rocksdb_secondary_path = "./substrate_archive/rocksdb_secondary"
 
 [runtime]
 # Specification of different methods of executing the runtime Wasm code.
@@ -25,16 +25,15 @@ rocksdb_secondary_path = "./output/"
 block_workers = 8
 
 # Number of 64KB Heap Pages to allocate for WASM execution
-# Optional, default: 64 * the number of logical system threads
-wasm_pages = 2048
+# Optional, default: 1024.
+wasm_pages = 512
 
 [database]
 # Database url.
 # Each chain needs it's own PostgreSQL database
-# A fully synced Kusama PostgreSQL database (~2.8Million blocks) takes up around 70GB
-# These variables can also be exposed with DB_NAME environment variable
-# Can also be specified via the `DATABASE_URL` environment variable
-# More info on the wiki: https://github.com/paritytech/substrate-archive/wiki/1.)-Requirements
+# Can also be specified via the `DATABASE_URL` environment variable.
+# For production use, using `DATABASE_URL` is preferable.
+# More info on the wiki: https://github.com/paritytech/substrate-archive/wiki/1.)-Requirements.
 url = "postgres://postgres:123@localhost:5432/polkadot-archive"
 
 [log]
@@ -50,6 +49,9 @@ std = "DEBUG"
 # Optional log file name, default: "archive.log"
 #name = "archive.log"
 
+# Advanced options
+#
+# Changing these may lead to unexpected results.
 [control]
 # Number of database actors to be spawned.
 # Optional, default: 4

examples/simple.rs

@@ -4,8 +4,6 @@ use polkadot_service::{kusama_runtime::RuntimeApi, Block, KusamaExecutor};
 use substrate_archive::{Archive, ArchiveBuilder};
 
 pub fn main() {
-    substrate_archive::logger::init(Default::default());
-
     // get spec/runtime from node library
     let spec = polkadot_service::chain_spec::kusama_config().unwrap();
 

substrate-archive-backend/src/frontend.rs

@@ -63,16 +63,15 @@ impl From<ExecutionMethod> for WasmExecutionMethod {
 
 #[derive(Clone, Debug, Deserialize)]
 pub struct RuntimeConfig {
-	/// Specification of different methods of executing the runtime Wasm code.
+	/// How to execute the runtime code: interpreted (default) or JIT compiled.
 	#[serde(default)]
 	pub exec_method: ExecutionMethod,
-	/// number of threads to spawn for block execution.
+	/// Number of threads to spawn for block execution.
 	#[serde(default = "default_block_workers")]
 	pub block_workers: usize,
 	/// Number of 64KB Heap pages to allocate for wasm execution.
-	#[serde(default = "default_wasm_pages")]
-	pub wasm_pages: u64,
-	/// Path where WASM files exist to override the on-chain WASM.
+	pub wasm_pages: Option<u64>,
+	/// Path to WASM blobs to override the on-chain WASM with (required for state change tracing).
 	pub wasm_runtime_overrides: Option<PathBuf>,
 }
 
@@ -81,7 +80,7 @@ impl Default for RuntimeConfig {
 		Self {
 			exec_method: ExecutionMethod::Interpreted,
 			block_workers: default_block_workers(),
-			wasm_pages: default_wasm_pages(),
+			wasm_pages: None,
 			wasm_runtime_overrides: None,
 		}
 	}
@@ -92,11 +91,6 @@ fn default_block_workers() -> usize {
 	num_cpus::get()
 }
 
-// 64 * (number of logic cpu's)
-fn default_wasm_pages() -> u64 {
-	64 * num_cpus::get() as u64
-}
-
 impl From<RuntimeConfig> for ClientConfig {
 	fn from(config: RuntimeConfig) -> ClientConfig {
 		ClientConfig {
@@ -123,8 +117,7 @@ where
 {
 	let backend = Arc::new(ReadOnlyBackend::new(db, true));
 
-	let executor =
-		NativeExecutor::<Dispatch>::new(config.exec_method.into(), Some(config.wasm_pages), config.block_workers);
+	let executor = NativeExecutor::<Dispatch>::new(config.exec_method.into(), config.wasm_pages, config.block_workers);
 	let executor = LocalCallExecutor::new(backend.clone(), executor, Box::new(TaskExecutor::new()), config.into())?;
 	let client = Client::new(backend, executor, ExecutionExtensions::new(execution_strategies(), None))?;
 	Ok(client)

substrate-archive/src/actors.rs

@@ -81,20 +81,20 @@ where
 
 #[derive(Copy, Clone, Debug, Deserialize)]
 pub struct ControlConfig {
-	/// number of database actors to be spawned in the actor pool.
+	/// Number of database actors to be spawned in the actor pool.
 	#[serde(default = "default_db_actor_pool_size")]
 	pub(crate) db_actor_pool_size: usize,
-	/// number of threads to spawn for task execution.
+	/// Number of threads to spawn for task execution.
 	#[serde(default = "default_task_workers")]
 	pub(crate) task_workers: usize,
-	/// maximum amount of time coil will wait for a task to begin.
-	/// times out if tasks don't start execution in the threadpool within `task_timeout` seconds.
+	/// Maximum amount of time coil will wait for a task to begin.
+	/// Times out if tasks don't start execution in the threadpool within `task_timeout` seconds.
 	#[serde(default = "default_task_timeout")]
 	pub(crate) task_timeout: u64,
-	/// maximum tasks to queue in the threadpool.
+	/// Maximum tasks to queue in the threadpool.
 	#[serde(default = "default_task_workers")]
 	pub(crate) max_tasks: usize,
-	/// maximum amount of blocks to index at once
+	/// Maximum amount of blocks to index at once.
 	#[serde(default = "default_max_block_load")]
 	pub(crate) max_block_load: u32,
 }