feat: add Terminal module for CKB-TUI data provision (#4989)

<!--
Thank you for contributing to nervosnetwork/ckb!

If you haven't already, please read
[CONTRIBUTING](https://github.com/nervosnetwork/ckb/blob/develop/CONTRIBUTING.md)
document.

If you're unsure about anything, just ask; somebody should be along to
answer within a day or two.

PR Title Format:
1. module [, module2, module3]: what's changed
2. *: what's changed
-->

### What problem does this PR solve?

* Introduce a new Terminal module to supply essential data for CKB-TUI
* Include system data and basic mining data in the current
implementation


### Related changes

- PR to update `owner/repo`:
- Need to cherry-pick to the release branch

### Check List <!--REMOVE the items that are not applicable-->

Tests <!-- At least one of them must be included. -->

- Unit test
- Integration test
- Manual test (add detailed scripts or steps below)

Side effects

- Performance regression
- Breaking backward compatibility

### Release note <!-- Choose from None, Title Only and Note. Bugfixes or
new features need a release note. -->

```release-note
Note: Add a note under the PR title in the release note.
```

Author: zhangsoledad

Cargo.lock

@@ -315,6 +315,7 @@ yansi = "0.5"
 seq-macro = "0.3"
 strum = { version = "0.27", default-features = false, features = ["derive"] }
 phf = { version = "0.12", features = ["macros"] }
+sysinfo = "0.37"
 
 [profile.release]
 overflow-checks = true

Cargo.toml

@@ -7,8 +7,8 @@ use ckb_app_config::DBConfig;
 use ckb_db_schema::Col;
 use ckb_logger::info;
 use rocksdb::ops::{
-    CompactRangeCF, CreateCF, DropCF, GetColumnFamilys, GetPinned, GetPinnedCF, IterateCF, OpenCF,
-    Put, SetOptions, WriteOps,
+    CompactRangeCF, CreateCF, DropCF, GetColumnFamilys, GetPinned, GetPinnedCF, GetPropertyCF,
+    IterateCF, OpenCF, Put, SetOptions, WriteOps,
 };
 use rocksdb::{
     BlockBasedIndexType, BlockBasedOptions, Cache, ColumnFamily, ColumnFamilyDescriptor,
@@ -18,6 +18,8 @@ use rocksdb::{
 use std::path::Path;
 use std::sync::Arc;
 
+const PROPERTY_NUM_KEYS: &str = "rocksdb.estimate-num-keys";
+
 /// RocksDB wrapper base on OptimisticTransactionDB
 ///
 /// <https://github.com/facebook/rocksdb/wiki/Transactions#optimistictransactiondb>
@@ -329,6 +331,15 @@ impl RocksDB {
             .ok_or_else(|| internal_error("drop_cf get_mut failed"))?;
         inner.drop_cf(col).map_err(internal_error)
     }
+
+    /// "rocksdb.estimate-num-keys" - returns estimated number of total keys in
+    /// the active and unflushed immutable memtables and storage.
+    pub fn estimate_num_keys_cf(&self, col: Col) -> Result<Option<u64>> {
+        let cf = cf_handle(&self.inner, col)?;
+        self.inner
+            .property_int_value_cf(cf, PROPERTY_NUM_KEYS)
+            .map_err(internal_error)
+    }
 }
 
 #[inline]

db/src/db.rs

@@ -30,6 +30,7 @@ pub(crate) fn all_rpc_docs() -> Vec<(String, Value)> {
         indexer_rpc_doc,
         rich_indexer_rpc_doc,
         experiment_rpc_doc,
+        terminal_rpc_doc,
     )
     .into()
 }

devtools/doc/rpc-gen/src/utils.rs

@@ -186,10 +186,10 @@ listen_address = "127.0.0.1:8114" # {{
 # Default is 10MiB = 10 * 1024 * 1024
 max_request_body_size = 10485760
 
-# List of API modules: ["Net", "Pool", "Miner", "Chain", "Stats", "Subscription", "Experiment", "Debug", "Indexer", "RichIndexer"]
-modules = ["Net", "Pool", "Miner", "Chain", "Stats", "Subscription", "Experiment"] # {{
-# dev => modules = ["Net", "Pool", "Miner", "Chain", "Stats", "Subscription", "Experiment", "Debug"]
-# integration => modules = ["Net", "Pool", "Miner", "Chain", "Experiment", "Stats", "IntegrationTest"]
+# List of API modules: ["Net", "Pool", "Miner", "Chain", "Stats", "Subscription", "Experiment", "Debug", "Indexer", "RichIndexer", "Terminal"]
+modules = ["Net", "Pool", "Miner", "Chain", "Stats", "Subscription", "Experiment", "Terminal"] # {{
+# dev => modules = ["Net", "Pool", "Miner", "Chain", "Stats", "Subscription", "Experiment", "Debug", "Terminal"]
+# integration => modules = ["Net", "Pool", "Miner", "Chain", "Experiment", "Stats", "IntegrationTest", "Terminal"]
 # }}
 
 # By default RPC only binds to HTTP service, you can bind it to TCP and WebSocket.

resource/ckb.toml

@@ -43,6 +43,8 @@ ckb-indexer.workspace = true
 ckb-indexer-sync.workspace = true
 ckb-rich-indexer.workspace = true
 ckb-stop-handler.workspace = true
+ckb-dao-utils.workspace = true
+ckb-db-schema.workspace = true
 itertools.workspace = true
 tokio.workspace = true
 async-trait.workspace = true
@@ -53,6 +55,10 @@ tower-http = { workspace = true, features = ["timeout", "cors"] }
 async-stream.workspace = true
 ckb-async-runtime.workspace = true
 schemars.workspace = true
+sysinfo.workspace = true
+bitflags.workspace = true
+lru.workspace = true
+
 
 [dev-dependencies]
 reqwest = { workspace = true, features = ["blocking", "json"] }