Add RPC devel_snapshot

Author: foriequal0

core/src/client/client.rs

@@ -45,7 +45,7 @@ use super::{
 };
 use crate::block::{ClosedBlock, IsBlock, OpenBlock, SealedBlock};
 use crate::blockchain::{BlockChain, BlockProvider, BodyProvider, HeaderProvider, InvoiceProvider, TransactionAddress};
-use crate::client::{ConsensusClient, TermInfo};
+use crate::client::{ConsensusClient, SnapshotClient, TermInfo};
 use crate::consensus::{CodeChainEngine, EngineError};
 use crate::encoded;
 use crate::error::{BlockImportError, Error, ImportError, SchemeError};
@@ -965,3 +965,11 @@ impl FindActionHandler for Client {
         self.engine.find_action_handler_for(id)
     }
 }
+
+impl SnapshotClient for Client {
+    fn notify_snapshot(&self, id: BlockId) {
+        if let Some(header) = self.block_header(&id) {
+            self.engine.send_snapshot_notify(header.hash())
+        }
+    }
+}

core/src/client/mod.rs

@@ -348,3 +348,7 @@ pub trait StateInfo {
     /// is unknown.
     fn state_at(&self, id: BlockId) -> Option<TopLevelState>;
 }
+
+pub trait SnapshotClient {
+    fn notify_snapshot(&self, id: BlockId);
+}

core/src/consensus/mod.rs

@@ -268,6 +268,8 @@ pub trait ConsensusEngine: Sync + Send {
 
     fn register_snapshot_notify_sender(&self, _sender: SnapshotNotifySender) {}
 
+    fn send_snapshot_notify(&self, _block_hash: BlockHash) {}
+
     fn get_best_block_from_best_proposal_header(&self, header: &HeaderView) -> BlockHash {
         header.hash()
     }

core/src/consensus/solo/mod.rs

@@ -20,13 +20,14 @@ use std::sync::{Arc, Weak};
 
 use ckey::Address;
 use cstate::{ActionHandler, HitHandler};
-use ctypes::{CommonParams, Header};
+use ctypes::{BlockHash, CommonParams, Header};
 use parking_lot::RwLock;
 
 use self::params::SoloParams;
 use super::stake;
 use super::{ConsensusEngine, Seal};
 use crate::block::{ExecutedBlock, IsBlock};
+use crate::client::snapshot_notify::NotifySender;
 use crate::client::ConsensusClient;
 use crate::codechain_machine::CodeChainMachine;
 use crate::consensus::{EngineError, EngineType};
@@ -38,6 +39,7 @@ pub struct Solo {
     params: SoloParams,
     machine: CodeChainMachine,
     action_handlers: Vec<Arc<dyn ActionHandler>>,
+    snapshot_notify_sender: Arc<RwLock<Option<NotifySender>>>,
 }
 
 impl Solo {
@@ -54,6 +56,7 @@ impl Solo {
             params,
             machine,
             action_handlers,
+            snapshot_notify_sender: Arc::new(RwLock::new(None)),
         }
     }
 
@@ -150,6 +153,18 @@ impl ConsensusEngine for Solo {
         1
     }
 
+    fn register_snapshot_notify_sender(&self, sender: NotifySender) {
+        let mut guard = self.snapshot_notify_sender.write();
+        assert!(guard.is_none(), "snapshot_notify_sender is registered twice");
+        *guard = Some(sender);
+    }
+
+    fn send_snapshot_notify(&self, block_hash: BlockHash) {
+        if let Some(sender) = self.snapshot_notify_sender.read().as_ref() {
+            sender.notify(block_hash)
+        }
+    }
+
     fn action_handlers(&self) -> &[Arc<dyn ActionHandler>] {
         &self.action_handlers
     }

core/src/lib.rs

@@ -88,8 +88,8 @@ pub use crate::client::snapshot_notify;
 pub use crate::client::Error::Database;
 pub use crate::client::{
     AccountData, AssetClient, BlockChainClient, BlockChainTrait, ChainNotify, Client, ClientConfig, DatabaseClient,
-    EngineClient, EngineInfo, ExecuteClient, ImportBlock, MiningBlockChainClient, Shard, StateInfo, TermInfo,
-    TestBlockChainClient, TextClient,
+    EngineClient, EngineInfo, ExecuteClient, ImportBlock, MiningBlockChainClient, Shard, SnapshotClient, StateInfo,
+    TermInfo, TestBlockChainClient, TextClient,
 };
 pub use crate::consensus::{EngineType, TimeGapParams};
 pub use crate::db::{COL_STATE, NUM_COLUMNS};

rpc/src/v1/impls/devel.rs

@@ -23,7 +23,7 @@ use std::vec::Vec;
 
 use ccore::{
     BlockId, DatabaseClient, EngineClient, EngineInfo, MinerService, MiningBlockChainClient, SignedTransaction,
-    TermInfo, COL_STATE,
+    SnapshotClient, TermInfo, COL_STATE,
 };
 use ccrypto::Blake;
 use cjson::bytes::Bytes;
@@ -33,7 +33,7 @@ use csync::BlockSyncEvent;
 use ctypes::transaction::{
     Action, AssetMintOutput, AssetOutPoint, AssetTransferInput, AssetTransferOutput, Transaction,
 };
-use ctypes::{Tracker, TxHash};
+use ctypes::{BlockHash, Tracker, TxHash};
 use jsonrpc_core::Result;
 use kvdb::KeyValueDB;
 use primitives::{H160, H256};
@@ -70,7 +70,7 @@ where
 
 impl<C, M> Devel for DevelClient<C, M>
 where
-    C: DatabaseClient + EngineInfo + EngineClient + MiningBlockChainClient + TermInfo + 'static,
+    C: DatabaseClient + EngineInfo + EngineClient + MiningBlockChainClient + TermInfo + SnapshotClient + 'static,
     M: MinerService + 'static,
 {
     fn get_state_trie_keys(&self, offset: usize, limit: usize) -> Result<Vec<H256>> {
@@ -108,6 +108,11 @@ where
         }
     }
 
+    fn snapshot(&self, block_hash: BlockHash) -> Result<()> {
+        self.client.notify_snapshot(BlockId::Hash(block_hash));
+        Ok(())
+    }
+
     fn test_tps(&self, setting: TPSTestSetting) -> Result<f64> {
         let common_params = self.client.common_params(BlockId::Latest).unwrap();
         let mint_fee = common_params.min_asset_mint_cost();

rpc/src/v1/traits/devel.rs

@@ -17,6 +17,7 @@
 use std::net::SocketAddr;
 
 use cjson::bytes::Bytes;
+use ctypes::BlockHash;
 use jsonrpc_core::Result;
 use primitives::H256;
 
@@ -39,6 +40,9 @@ pub trait Devel {
     #[rpc(name = "devel_getBlockSyncPeers")]
     fn get_block_sync_peers(&self) -> Result<Vec<SocketAddr>>;
 
+    #[rpc(name = "devel_snapshot")]
+    fn snapshot(&self, hash: BlockHash) -> Result<()>;
+
     #[rpc(name = "devel_testTPS")]
     fn test_tps(&self, setting: TPSTestSetting) -> Result<f64>;
 }

spec/JSON-RPC.md

@@ -367,6 +367,7 @@ When `Transaction` is included in any response, there will be an additional fiel
 ***
  * [devel_getStateTrieKeys](#devel_getstatetriekeys)
  * [devel_getStateTrieValue](#devel_getstatetrievalue)
+ * [devel_snapshot](#devel_snapshot)
  * [devel_startSealing](#devel_startsealing)
  * [devel_stopSealing](#devel_stopsealing)
  * [devel_getBlockSyncPeers](#devel_getblocksyncpeers)
@@ -2979,6 +2980,33 @@ Gets the value of the state trie with the given key.
 
 [Back to **List of methods**](#list-of-methods)
 
+## devel_snapshot
+Snapshot the state of the given block hash.
+
+### Params
+ 1. key: `H256`
+
+### Returns
+
+### Request Example
+```
+  curl \
+    -H 'Content-Type: application/json' \
+    -d '{"jsonrpc": "2.0", "method": "devel_snapshot", "params": ["0xfc196ede542b03b55aee9f106004e7e3d7ea6a9600692e964b4735a260356b50"], "id": null}' \
+    localhost:8080
+```
+
+### Response Example
+```
+{
+  "jsonrpc":"2.0",
+  "result":[],
+  "id":null
+}
+```
+
+[Back to **List of methods**](#list-of-methods)
+
 ## devel_startSealing
 Starts and enables sealing blocks by the miner.