Merge pull request #33 from nervosnetwork/quake/get_indexer_info

feat: add get_indexer_info rpc

README.md

@@ -237,3 +237,25 @@ echo '{
 | curl -H 'content-type: application/json' -d @- \
 http://localhost:8116
 ```
+
+### `get_indexer_info`
+
+Returns the indexer service information.
+
+#### Returns
+
+    version - indexer version
+
+#### Examples
+
+```bash
+echo '{
+    "id": 2,
+    "jsonrpc": "2.0",
+    "method": "get_indexer_info",
+    "params": []
+}' \
+| tr -d '\n' \
+| curl -H 'content-type: application/json' -d @- \
+http://localhost:8116
+```

rust-toolchain

@@ -1 +1 @@
-1.46.0
+1.51.0

src/main.rs

@@ -34,6 +34,7 @@ async fn main() {
         matches.value_of("store_path").expect("required arg"),
         matches.value_of("listen_uri").unwrap_or("127.0.0.1:8116"),
         std::time::Duration::from_secs(2),
+        crate_version!().to_string(),
     );
 
     let rpc_server = service.start();

src/service.rs

@@ -27,22 +27,30 @@ pub struct Service {
     store: RocksdbStore,
     poll_interval: Duration,
     listen_address: String,
+    version: String,
 }
 
 impl Service {
-    pub fn new(store_path: &str, listen_address: &str, poll_interval: Duration) -> Self {
+    pub fn new(
+        store_path: &str,
+        listen_address: &str,
+        poll_interval: Duration,
+        version: String,
+    ) -> Self {
         let store = RocksdbStore::new(store_path);
         Self {
             store,
             listen_address: listen_address.to_string(),
             poll_interval,
+            version,
         }
     }
 
     pub fn start(&self) -> Server {
         let mut io_handler = IoHandler::new();
         let rpc_impl = IndexerRpcImpl {
             store: self.store.clone(),
+            version: self.version.clone(),
         };
         io_handler.extend_with(rpc_impl.to_delegate());
 
@@ -183,6 +191,9 @@ pub trait IndexerRpc {
 
     #[rpc(name = "get_cells_capacity")]
     fn get_cells_capacity(&self, search_key: SearchKey) -> Result<Option<CellsCapacity>>;
+
+    #[rpc(name = "get_indexer_info")]
+    fn get_indexer_info(&self) -> Result<IndexerInfo>;
 }
 
 #[derive(Deserialize)]
@@ -227,6 +238,11 @@ pub struct CellsCapacity {
     block_number: BlockNumber,
 }
 
+#[derive(Serialize)]
+pub struct IndexerInfo {
+    version: String,
+}
+
 #[derive(Serialize)]
 pub struct Cell {
     output: CellOutput,
@@ -260,6 +276,7 @@ pub struct Pagination<T> {
 
 pub struct IndexerRpcImpl {
     pub store: RocksdbStore,
+    pub version: String,
 }
 
 impl IndexerRpc for IndexerRpcImpl {
@@ -617,6 +634,12 @@ impl IndexerRpc for IndexerRpcImpl {
             .into(),
         }))
     }
+
+    fn get_indexer_info(&self) -> Result<IndexerInfo> {
+        Ok(IndexerInfo {
+            version: self.version.clone(),
+        })
+    }
 }
 
 const MAX_PREFIX_SEARCH_SIZE: usize = u16::max_value() as usize;
@@ -744,7 +767,10 @@ mod tests {
     fn rpc() {
         let store = new_store("rpc");
         let indexer = Indexer::new(store.clone(), 10, 100);
-        let rpc = IndexerRpcImpl { store };
+        let rpc = IndexerRpcImpl {
+            store,
+            version: "0.2.1".to_owned(),
+        };
 
         // setup test data
         let lock_script1 = ScriptBuilder::default()
@@ -1114,5 +1140,8 @@ mod tests {
             capacity.capacity.value(),
             "last block live cell"
         );
+
+        // test get_indexer_info rpc
+        assert_eq!("0.2.1", rpc.get_indexer_info().unwrap().version);
     }
 }