docs(config): add the document of config instruction (#302)

* docs: add config instrcution

* update README

* update README

* follow review opinion

* refactor move machine id to db config

* fix page

* remove useless test

* cargo clippy

Author: Eason Gao

README.md

@@ -1,3 +1,5 @@
+# Mercury
+
 ## About Mercury
 
 Mercury is a tool that handles application development on [CKB](https://github.com/nervosnetwork/ckb). 
@@ -50,13 +52,18 @@ If you want to use Mercury in a production project, please deploy and run Mercur
 - Step 1. Run a CKB node. If you already have a running node, skip this step.
   - run a [mainnet node](https://docs.nervos.org/docs/basics/guides/mainnet)
   - run a [testnet node](https://docs.nervos.org/docs/basics/guides/testnet)
-- Step 2. Edit `mainnet_config.toml` or `testnet_config.toml` respectively. These config files are located in `./devtools/config/`.
+
+- Step 2. Edit `mainnet_config.toml` or `testnet_config.toml` according to mainnet or testnet. These config files are located in `./devtools/config/`. The instrcution of config file is [here](docs/config.md).
+
 - Step 3. Download the latest version of Mercury from the [release page](https://github.com/nervosnetwork/Mercury/releases).
+
 - Step 4. Run Mercury.
+
 ```shell
-## mainnet
+# mainnet
 $ Mercury -c devtools/config/mainnet_config.toml run
-## testnet
+
+# testnet
 $ Mercury -c devtools/config/testnet_config.toml run
 ```
 
@@ -89,14 +96,17 @@ environment:
 ```
 
 - Step 3. Build Mercury images from the Dockerfile.
+
 ```shell
 $ docker build -t Mercury .
 ```
 
 - Step 4. Run Mercury via docker.
+
 ```shell
 $ docker-compose up -d
 ```
+
 or
 
 ```shell
@@ -131,5 +141,5 @@ The `Mercury` crate's minimum supported rust version is 1.55.0.
 
 ## Documentations
 
-- [Mercury API Documentation](https://github.com/nervosnetwork/Mercury/blob/main/core/rpc/README.md)
-
+- [Mercury API Documentation](core/rpc/README.md)
+- [Mercury Config Documentation](docs/config.md)

common/src/lib.rs

@@ -209,6 +209,11 @@ impl PaginationRequest {
         }
     }
 
+    pub fn set_order(mut self, order: Order) -> Self {
+        self.order = order;
+        self
+    }
+
     pub fn set_limit(mut self, limit: Option<u64>) -> Self {
         self.limit = limit;
         self

common/src/utils.rs

@@ -29,7 +29,7 @@ enum UtilsError {
 // Convert to short address, use as universal identity
 pub fn parse_address(input: &str) -> Result<Address> {
     match Address::from_str(input) {
-        Ok(addr) => Ok(to_universal_identity(addr.network(), &addr, addr.is_new)),
+        Ok(addr) => Ok(addr),
         Err(e) => Err(MercuryError::utils(UtilsError::ParseCKBAddressError(e)).into()),
     }
 }
@@ -121,8 +121,6 @@ pub fn u256_low_u64(u: U256) -> u64 {
 mod test {
     use super::*;
 
-    use crate::NetworkType;
-    use ckb_types::h160;
     use rand::random;
 
     fn rand_bytes(len: usize) -> Vec<u8> {
@@ -139,25 +137,6 @@ mod test {
         assert_eq!(a, b);
     }
 
-    #[test]
-    fn test_parse_address() {
-        let addr = "ckt1qyqr79tnk3pp34xp92gerxjc4p3mus2690psf0dd70";
-        let res = parse_address(addr);
-
-        assert!(res.is_ok());
-        assert_eq!(res.unwrap().network(), NetworkType::Testnet);
-
-        let acp_addr = "ckb1qypzygjgr5425uvg2jcq3c7cxvpuv0rp4nssh7wm4f";
-        let address = parse_address(acp_addr).unwrap();
-        let payload = AddressPayload::new_short(
-            NetworkType::Mainnet,
-            CodeHashIndex::Sighash,
-            h160!("0x2222481d2aaa718854b008e3d83303c63c61ace1"),
-        );
-        assert_eq!(address.network(), NetworkType::Mainnet);
-        assert_eq!(address.payload().clone(), payload);
-    }
-
     #[test]
     fn test_find() {
         let test = (0..10).collect::<Vec<_>>();

core/cli/src/config.rs

@@ -25,6 +25,8 @@ pub struct NetworkConfig {
 
 #[derive(Deserialize, Default, Clone, Debug)]
 pub struct DBConfig {
+    pub center_id: u16,
+    pub machine_id: u16,
     pub max_connections: u32,
     pub db_type: String,
     pub db_host: String,
@@ -44,7 +46,7 @@ pub struct LogConfig {
     pub log_level: String,
 
     #[serde(default = "default_is_spilt_file")]
-    pub use_split_file: bool,
+    pub auto_split_log_file: bool,
 
     #[serde(default = "default_file_size_limit")]
     pub file_size_limit: u64,
@@ -72,7 +74,7 @@ pub struct ScriptConfig {
 #[derive(Deserialize, Default, Clone, Debug)]
 pub struct SyncConfig {
     pub sync_block_batch_size: usize,
-    pub max_task_count: usize,
+    pub max_task_number: usize,
 }
 
 #[derive(Deserialize, Default, Clone, Debug)]
@@ -83,17 +85,15 @@ pub struct ExtensionConfig {
 
 #[derive(Deserialize, Default, Clone, Debug)]
 pub struct MercuryConfig {
-    pub center_id: u16,
-    pub machine_id: u16,
-    pub indexer_mode: bool,
+    pub sync_mode: bool,
     pub db_config: DBConfig,
     pub log_config: LogConfig,
     pub network_config: NetworkConfig,
     pub sync_config: SyncConfig,
     pub builtin_scripts: Vec<ScriptConfig>,
 
     #[serde(default = "default_need_sync")]
-    pub need_sync: bool,
+    pub allow_parallel_sync: bool,
 
     #[serde(default = "default_rpc_thread_num")]
     pub rpc_thread_num: usize,

core/cli/src/lib.rs

@@ -109,8 +109,8 @@ impl<'a> Cli<'a> {
 
         let service = Service::new(
             self.config.db_config.max_connections,
-            self.config.center_id,
-            self.config.machine_id,
+            self.config.db_config.center_id,
+            self.config.db_config.machine_id,
             Duration::from_secs(2),
             self.config.rpc_thread_num,
             &self.config.network_config.network_type,
@@ -133,17 +133,17 @@ impl<'a> Cli<'a> {
             )
             .await;
 
-        if self.config.need_sync {
+        if self.config.allow_parallel_sync {
             service
                 .do_sync(
                     self.config.sync_config.sync_block_batch_size,
-                    self.config.sync_config.max_task_count,
+                    self.config.sync_config.max_task_number,
                 )
                 .await
                 .unwrap();
         }
 
-        if self.config.indexer_mode {
+        if self.config.sync_mode {
             service
                 .start(self.config.flush_tx_pool_cache_interval)
                 .await;

core/rpc/src/lib.rs

@@ -65,7 +65,7 @@ pub trait MercuryRpc {
         payload: SimpleTransferPayload,
     ) -> RpcResult<TransactionCompletionResponse>;
 
-    #[method(name = "register_address")]
+    #[method(name = "register_addresses")]
     async fn register_addresses(&self, addresses: Vec<String>) -> RpcResult<Vec<H160>>;
 
     #[method(name = "get_mercury_info")]

core/storage/src/relational/mod.rs

@@ -16,7 +16,7 @@ use crate::relational::{
 use crate::{error::DBError, Storage};
 
 use common::{
-    async_trait, utils::to_fixed_array, Context, DetailedCell, PaginationRequest,
+    async_trait, utils::to_fixed_array, Context, DetailedCell, Order, PaginationRequest,
     PaginationResponse, Range, Result,
 };
 use common_logger::{tracing, tracing_async};
@@ -361,19 +361,24 @@ impl Storage for RelationalStorage {
         }
 
         tx_hashes.sort();
-        let next_cursor = if tx_hashes.len() as u64 <= limit {
+        let next_cursor = if count <= limit {
             None
         } else if is_asc {
             Some(tx_hashes.last().unwrap().id)
         } else {
             Some(tx_hashes.first().unwrap().id)
         };
+        let pag = if is_asc {
+            PaginationRequest::default()
+        } else {
+            PaginationRequest::default().set_order(Order::Desc)
+        };
         let tx_tables = self
             .query_transactions(
                 ctx.clone(),
                 tx_hashes.into_iter().map(|i| i.tx_hash).collect(),
                 block_range,
-                Default::default(),
+                pag,
             )
             .await?;
         let txs_wrapper = self

db/xsql/src/page.rs

@@ -1,12 +1,10 @@
-use common::{Order, PaginationRequest};
+use common::{utils::to_fixed_array, PaginationRequest};
 
 use bson2::Bson;
 use rbatis::plugin::page::{IPageRequest, PagePlugin};
 use rbatis::{core::Error as RbError, sql::TEMPLATE, DriverType};
 use serde::{Deserialize, Serialize};
 
-use std::convert::TryInto;
-
 #[derive(Default, Clone, Debug)]
 pub struct CursorPagePlugin;
 
@@ -137,18 +135,11 @@ impl From<PaginationRequest> for PageRequest {
         PageRequest {
             cursor: p
                 .cursor
-                .map(|bytes| {
-                    i64::from_be_bytes(
-                        bytes
-                            .to_vec()
-                            .try_into()
-                            .expect("slice with incorrect length"),
-                    )
-                })
-                .unwrap_or(0),
+                .map(|bytes| i64::from_be_bytes(to_fixed_array(&bytes[0..8])))
+                .unwrap_or_else(|| if p.order.is_asc() { i64::MIN } else { i64::MAX }),
             count: p.limit.unwrap_or((i64::MAX - 1) as u64),
             skip: p.skip.unwrap_or(0),
-            is_asc: p.order == Order::Asc,
+            is_asc: p.order.is_asc(),
             search_count: true,
         }
     }

devtools/config/docker_compose_config.toml

@@ -1,10 +1,6 @@
-center_id = 0
-
-machine_id = 0
+sync_mode = true
 
-need_sync = true
-
-indexer_mode = true
+allow_parallel_sync  = true
 
 rpc_thread_num = 3
 
@@ -13,10 +9,12 @@ flush_tx_pool_cache_interval = 300
 # Fill cellbase maturity in the same as the ckb genesis block.
 cellbase_maturity = 4
 
-cheque_timeout = 6
+cheque_since = 6
 
 [db_config]
 # Use your pgsql configuration
+center_id = 0
+machine_id = 0
 max_connections = 1000
 db_type = "postgres"
 db_host = "postgres"
@@ -29,7 +27,7 @@ db_log_level = "WARN"
 
 [log_config]
 log_level = "INFO"
-use_split_file = false
+auto_split_log_file = true
 log_path = "./free-space/mainnet/log"
 
 
@@ -43,7 +41,7 @@ listen_uri = "0.0.0.0:8116"
 
 [sync_config]
 sync_block_batch_size = 1000
-max_task_count = 30
+max_task_number = 30
 
 
 [[builtin_scripts]]

devtools/config/mainnet_config.toml

@@ -1,10 +1,6 @@
-center_id = 0
-
-machine_id = 0
+sync_mode = true
 
-indexer_mode = true
-
-need_sync = true
+allow_parallel_sync  = true
 
 rpc_thread_num = 3
 
@@ -13,9 +9,11 @@ flush_tx_pool_cache_interval = 300
 # Fill cellbase maturity in the same as the ckb genesis block.
 cellbase_maturity = 4
 
-cheque_timeout = 6
+cheque_since = 6
 
 [db_config]
+center_id = 0
+machine_id = 0
 max_connections = 1000
 db_type = "postgres"
 db_host = "127.0.0.1"
@@ -28,7 +26,7 @@ db_log_level = "WARN"
 
 [log_config]
 log_level = "INFO"
-use_split_file = false
+auto_split_log_file = true
 log_path = "./free-space/mainnet/log"
 
 
@@ -41,7 +39,7 @@ listen_uri = "127.0.0.1:8116"
 
 [sync_config]
 sync_block_batch_size = 1000
-max_task_count = 30
+max_task_number = 30
 
 
 [[builtin_scripts]]