move ckb-rpc-gen to devtools

nervosnetwork · Oct 11, 2023 · deb0d06 · deb0d06
1 parent 2209d45
commit deb0d06
Show file tree

Hide file tree

Showing 8 changed files with 28 additions and 10 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -89,6 +89,7 @@ members = [
     "util/launcher/migration-template",
     "util/light-client-protocol-server",
     "util/launcher",
+    "devtools/doc/rpc-gen",
     "ckb-bin"
 ]
 

diff --git a/Makefile b/Makefile
@@ -107,8 +107,8 @@ doc-deps: ## Build the documentation for the local package and all dependencies.
 
 .PHONY: gen-rpc-doc
 gen-rpc-doc:  ## Generate rpc documentation
-	cd rpc && cargo build
-	./target/debug/ckb-rpc-gen-doc rpc/README.md
+	cd devtools/doc/rpc-gen && cargo build
+	./target/debug/ckb-rpc-gen rpc/README.md
 
 .PHONY: gen-hashes
 gen-hashes: ## Generate docs/hashes.toml

diff --git a/devtools/doc/rpc-gen/Cargo.toml b/devtools/doc/rpc-gen/Cargo.toml
@@ -0,0 +1,10 @@
+[package]
+name = "ckb-rpc-gen"
+version = "0.1.0"
+edition = "2021"
+
+[dependencies]
+ckb-rpc ={ path = "../../../rpc", version = "= 0.112.0-pre" }
+schemars = { git = "https://github.com/chenyukang/schemars", branch = "fix-derive" }
+serde = { version = "1.0", features = ["derive"] }
+serde_json = "~1.0"
diff --git a/rpc/src/gen_doc/gen.rs → devtools/doc/rpc-gen/src/gen.rs b/rpc/src/gen_doc/gen.rs → devtools/doc/rpc-gen/src/gen.rs
@@ -333,7 +333,7 @@ fn gen_errors_content(res: &mut String) {
 /// generate subscription module, which is handled specially here
 /// since jsonrpc-utils ignore the `SubscriptionRpc`
 fn gen_subscription_rpc_doc(res: &mut String) {
-    let pubsub_module_source = include_str!("../module/subscription.rs");
+    let pubsub_module_source = include_str!("../../../../rpc/src/module/subscription.rs");
     // read comments before `pub trait SubscriptionRpc` and treat it as module summary
     let summary = pubsub_module_source
         .lines()

diff --git a/rpc/src/gen_doc/main.rs → devtools/doc/rpc-gen/src/main.rs b/rpc/src/gen_doc/main.rs → devtools/doc/rpc-gen/src/main.rs
@@ -26,7 +26,8 @@ fn dump_openrpc_json() -> Result<(), Box<dyn std::error::Error>> {
     Ok(())
 }
 
-fn gen_rpc_readme(readme_path: &str) -> Result<(), Box<dyn std::error::Error>> {
+/// Generate rpc readme
+pub fn gen_rpc_readme(readme_path: &str) -> Result<(), Box<dyn std::error::Error>> {
     let all_rpc = vec![
         alert_rpc_doc(),
         net_rpc_doc(),

diff --git a/rpc/Cargo.toml b/rpc/Cargo.toml
@@ -8,10 +8,6 @@ description = "CKB RPC server."
 homepage = "https://github.com/nervosnetwork/ckb"
 repository = "https://github.com/nervosnetwork/ckb"
 
-[[bin]]
-name = "ckb-rpc-gen-doc"
-path = "src/gen_doc/main.rs"
-
 [dependencies]
 ckb-chain-spec = { path = "../spec", version = "= 0.112.0-pre" }
 ckb-types = { path = "../util/types", version = "= 0.112.0-pre" }
@@ -53,7 +49,7 @@ futures-util = { version = "0.3.21" }
 tower-http = { version = "0.3.5", features = ["timeout"] }
 async-stream = "0.3.3"
 ckb-async-runtime = { path = "../util/runtime", version = "= 0.112.0-pre" }
-schemars = { git = "https://github.com/chenyukang/schemars", branch = "fix-derive"}
+schemars = { git = "https://github.com/chenyukang/schemars", branch = "fix-derive" }
 #schemars = "0.8.15"
 
 [dev-dependencies]

diff --git a/rpc/src/module/alert.rs b/rpc/src/module/alert.rs
@@ -57,7 +57,7 @@ pub trait AlertRpc {
     ///
     /// Response
     ///
-    /// ```json
+        /// ```json
     /// {
     ///   "error": {
     ///     "code": -1000,