Merge pull request #81 from vacp2p/Pravdyvyi/periodic-snapshots-storing

Periodic snapshooting

accounts/src/account_core/mod.rs

@@ -16,6 +16,7 @@ use crate::key_management::{
 pub type PublicKey = AffinePoint;
 pub type AccountAddress = TreeHashType;
 
+#[derive(Debug, Serialize)]
 pub struct Account {
     pub key_holder: AddressKeyHolder,
     pub address: AccountAddress,

accounts/src/key_management/mod.rs

@@ -6,6 +6,7 @@ use ephemeral_key_holder::EphemeralKeyHolder;
 use k256::AffinePoint;
 use log::info;
 use secret_holders::{SeedHolder, TopSecretKeyHolder, UTXOSecretKeyHolder};
+use serde::Serialize;
 
 use crate::account_core::PublicKey;
 
@@ -13,7 +14,7 @@ pub mod constants_types;
 pub mod ephemeral_key_holder;
 pub mod secret_holders;
 
-#[derive(Clone)]
+#[derive(Debug, Serialize, Clone)]
 ///Entrypoint to key management
 pub struct AddressKeyHolder {
     //Will be useful in future

accounts/src/key_management/secret_holders.rs

@@ -2,6 +2,7 @@ use common::merkle_tree_public::TreeHashType;
 use elliptic_curve::PrimeField;
 use k256::{AffinePoint, FieldBytes, Scalar};
 use rand::{rngs::OsRng, RngCore};
+use serde::Serialize;
 use sha2::{digest::FixedOutput, Digest};
 
 use super::constants_types::{NULLIFIER_SECRET_CONST, VIEWING_SECRET_CONST};
@@ -13,13 +14,13 @@ pub struct SeedHolder {
     seed: Scalar,
 }
 
-#[derive(Debug, Clone)]
+#[derive(Debug, Serialize, Clone)]
 ///Secret spending key holder. Produces `UTXOSecretKeyHolder` objects.
 pub struct TopSecretKeyHolder {
     pub secret_spending_key: Scalar,
 }
 
-#[derive(Debug, Clone)]
+#[derive(Debug, Serialize, Clone)]
 ///Nullifier secret key and viewing secret key holder. Produces public keys. Can produce address. Can produce shared secret for recepient.
 pub struct UTXOSecretKeyHolder {
     pub nullifier_secret_key: Scalar,

node_core/src/chain_storage/block_store.rs

@@ -2,6 +2,7 @@ use std::path::Path;
 
 use anyhow::{anyhow, Result};
 use common::block::Block;
+use log::error;
 use storage::sc_db_utils::{DataBlob, DataBlobChangeVariant};
 use storage::RocksDBIO;
 
@@ -56,6 +57,38 @@ impl NodeBlockStore {
     pub fn get_sc_sc_state(&self, sc_addr: &str) -> Result<Vec<DataBlob>> {
         Ok(self.dbio.get_sc_sc_state(sc_addr)?)
     }
+
+    pub fn put_snapshot_at_block_id(
+        &self,
+        id: u64,
+        accounts_ser: Vec<u8>,
+        comm_ser: Vec<u8>,
+        txs_ser: Vec<u8>,
+        nullifiers_ser: Vec<u8>,
+    ) -> Result<()> {
+        //Error notification for writing into DB error
+        self.dbio
+            .put_snapshot_block_id_db(id)
+            .inspect_err(|err| error!("Failed to store snapshot block id with error {err:#?}"))?;
+        self.dbio
+            .put_snapshot_account_db(accounts_ser)
+            .inspect_err(|err| error!("Failed to store snapshot accounts with error {err:#?}"))?;
+        self.dbio
+            .put_snapshot_commitement_db(comm_ser)
+            .inspect_err(|err| {
+                error!("Failed to store snapshot commitments with error {err:#?}")
+            })?;
+        self.dbio
+            .put_snapshot_transaction_db(txs_ser)
+            .inspect_err(|err| {
+                error!("Failed to store snapshot transactions with error {err:#?}")
+            })?;
+        self.dbio
+            .put_snapshot_nullifier_db(nullifiers_ser)
+            .inspect_err(|err| error!("Failed to store snapshot nullifiers with error {err:#?}"))?;
+
+        Ok(())
+    }
 }
 
 #[cfg(test)]
@@ -159,4 +192,41 @@ mod tests {
         let result = node_store.get_block_at_id(42);
         assert!(result.is_err());
     }
+
+    #[test]
+    fn test_put_snapshot_at_block_id() {
+        let temp_dir = tempdir().unwrap();
+        let path = temp_dir.path();
+
+        let genesis_block = create_genesis_block();
+        let node_store = NodeBlockStore::open_db_with_genesis(path, Some(genesis_block)).unwrap();
+
+        let id = 3;
+        let accounts_ser = vec![1, 2, 3, 4];
+        let comm_ser = vec![5, 6, 7, 8];
+        let txs_ser = vec![9, 10, 11, 12];
+        let nullifiers_ser = vec![13, 14, 15, 16];
+
+        node_store
+            .put_snapshot_at_block_id(
+                id,
+                accounts_ser.clone(),
+                comm_ser.clone(),
+                txs_ser.clone(),
+                nullifiers_ser.clone(),
+            )
+            .unwrap();
+
+        assert_eq!(node_store.dbio.get_snapshot_block_id().unwrap(), id);
+        assert_eq!(
+            node_store.dbio.get_snapshot_account().unwrap(),
+            accounts_ser
+        );
+        assert_eq!(node_store.dbio.get_snapshot_commitment().unwrap(), comm_ser);
+        assert_eq!(node_store.dbio.get_snapshot_transaction().unwrap(), txs_ser);
+        assert_eq!(
+            node_store.dbio.get_snapshot_nullifier().unwrap(),
+            nullifiers_ser
+        );
+    }
 }

node_core/src/chain_storage/mod.rs

@@ -1,7 +1,4 @@
-use std::{
-    collections::{BTreeMap, HashMap, HashSet},
-    path::Path,
-};
+use std::collections::{BTreeMap, HashMap, HashSet};
 
 use accounts::account_core::{Account, AccountAddress};
 use anyhow::Result;
@@ -13,10 +10,11 @@ use common::{
     utxo_commitment::UTXOCommitment,
 };
 use k256::AffinePoint;
+use log::{info, warn};
 use public_context::PublicSCContext;
 use utxo::utxo_core::UTXO;
 
-use crate::ActionData;
+use crate::{config::NodeConfig, ActionData};
 
 pub mod accounts_store;
 pub mod block_store;
@@ -28,10 +26,11 @@ pub struct NodeChainStore {
     pub nullifier_store: HashSet<UTXONullifier>,
     pub utxo_commitments_store: UTXOCommitmentsMerkleTree,
     pub pub_tx_store: PublicTransactionMerkleTree,
+    pub node_config: NodeConfig,
 }
 
 impl NodeChainStore {
-    pub fn new_with_genesis(home_dir: &Path, genesis_block: Block) -> Self {
+    pub fn new_with_genesis(config: NodeConfig, genesis_block: Block) -> Self {
         let acc_map = HashMap::new();
         let nullifier_store = HashSet::new();
         let utxo_commitments_store = UTXOCommitmentsMerkleTree::new(vec![]);
@@ -40,7 +39,7 @@ impl NodeChainStore {
         //Sequencer should panic if unable to open db,
         //as fixing this issue may require actions non-native to program scope
         let block_store =
-            NodeBlockStore::open_db_with_genesis(&home_dir.join("rocksdb"), Some(genesis_block))
+            NodeBlockStore::open_db_with_genesis(&config.home.join("rocksdb"), Some(genesis_block))
                 .unwrap();
 
         Self {
@@ -49,10 +48,13 @@ impl NodeChainStore {
             nullifier_store,
             utxo_commitments_store,
             pub_tx_store,
+            node_config: config,
         }
     }
 
     pub fn dissect_insert_block(&mut self, block: Block) -> Result<()> {
+        let block_id = block.block_id;
+
         for tx in &block.transactions {
             if !tx.execution_input.is_empty() {
                 let public_action = serde_json::from_slice::<ActionData>(&tx.execution_input);
@@ -136,6 +138,47 @@ impl NodeChainStore {
 
         self.block_store.put_block_at_id(block)?;
 
+        //Snapshot
+        if block_id % self.node_config.shapshot_frequency_in_blocks == 0 {
+            //Serializing all important data structures
+
+            //If we fail serialization, it is not the reason to stop running
+            //Logging on warn level in this cases
+
+            if let Ok(accounts_ser) = serde_json::to_vec(&self.acc_map).inspect_err(|err| {
+                warn!("Failed to serialize accounts data {err:#?}");
+            }) {
+                if let Ok(comm_ser) =
+                    serde_json::to_vec(&self.utxo_commitments_store).inspect_err(|err| {
+                        warn!("Failed to serialize commitments {err:#?}");
+                    })
+                {
+                    if let Ok(txs_ser) = serde_json::to_vec(&self.pub_tx_store).inspect_err(|err| {
+                        warn!("Failed to serialize transactions {err:#?}");
+                    }) {
+                        if let Ok(nullifiers_ser) = serde_json::to_vec(&self.nullifier_store)
+                            .inspect_err(|err| {
+                                warn!("Failed to serialize nullifiers {err:#?}");
+                            })
+                        {
+                            let snapshot_trace = self.block_store.put_snapshot_at_block_id(
+                                block_id,
+                                accounts_ser,
+                                comm_ser,
+                                txs_ser,
+                                nullifiers_ser,
+                            );
+
+                            info!(
+                                "Snapshot executed at {:?} with results {snapshot_trace:#?}",
+                                block_id
+                            );
+                        }
+                    }
+                }
+            }
+        }
+
         Ok(())
     }
 

node_core/src/config.rs

@@ -49,4 +49,6 @@ pub struct NodeConfig {
     pub port: u16,
     ///Gas config
     pub gas_config: GasConfig,
+    ///Frequency of snapshots
+    pub shapshot_frequency_in_blocks: u64,
 }

node_core/src/lib.rs

@@ -94,11 +94,11 @@ impl NodeCore {
         let client = Arc::new(SequencerClient::new(config.clone())?);
 
         let genesis_id = client.get_genesis_id().await?;
-        info!("Gesesis id is {genesis_id:?}");
+        info!("Genesis id is {genesis_id:?}");
 
         let genesis_block = client.get_block(genesis_id.genesis_id).await?.block;
 
-        let mut storage = NodeChainStore::new_with_genesis(&config.home, genesis_block);
+        let mut storage = NodeChainStore::new_with_genesis(config.clone(), genesis_block);
 
         pre_start::setup_empty_sc_states(&storage).await?;
 

node_runner/configs/debug/node_config.json

@@ -12,5 +12,6 @@
         "gas_cost_deploy": 1000,
         "gas_limit_deploy": 30000000,
         "gas_limit_runtime": 30000000
-    }
+    },
+    "shapshot_frequency_in_blocks": 10
 }