ChainSync framework

.gitignore

@@ -4,4 +4,5 @@
 .idea/
 config.toml
 .DS_STORE
-.vscode
+.vscode
+/chain_db

Cargo.toml

@@ -4,9 +4,8 @@ members = [
     "blockchain",
     "blockchain/blocks",
     "blockchain/chain",
-    "blockchain/chain_sync",
-    "blockchain/sync_manager",
     "blockchain/state_manager",
+    "blockchain/chain_sync",
     "vm",
     "vm/actor",
     "vm/address",

Makefile

@@ -10,7 +10,6 @@ clean:
 	@cargo clean -p blockchain
 	@cargo clean -p forest_blocks
 	@cargo clean -p chain_sync
-	@cargo clean -p sync_manager
 	@cargo clean -p vm
 	@cargo clean -p forest_address
 	@cargo clean -p actor

blockchain/blocks/src/header.rs

@@ -42,7 +42,7 @@ use std::time::{SystemTime, UNIX_EPOCH};
 ///     .build_and_validate()
 ///     .unwrap();
 /// ```
-#[derive(Clone, Debug, PartialEq, Builder)]
+#[derive(Clone, Debug, PartialEq, Builder, Default)]
 #[builder(name = "BlockHeaderBuilder")]
 pub struct BlockHeader {
     // CHAIN LINKING

blockchain/blocks/src/tipset.rs

@@ -22,10 +22,10 @@ pub struct TipSetKeys {
 }
 
 impl TipSetKeys {
-    /// constructor
     pub fn new(cids: Vec<Cid>) -> Self {
         Self { cids }
     }
+
     /// checks whether the set contains exactly the same CIDs as another.
     fn equals(&self, key: &TipSetKeys) -> bool {
         if self.cids.len() != key.cids.len() {
@@ -38,8 +38,9 @@ impl TipSetKeys {
         }
         true
     }
-    /// Returns tipset keys
-    pub fn tipset_keys(&self) -> &[Cid] {
+
+    /// Returns tipset header cids
+    pub fn cids(&self) -> &[Cid] {
         &self.cids
     }
 }
@@ -65,7 +66,7 @@ impl<'de> de::Deserialize<'de> for TipSetKeys {
 
 /// An immutable set of blocks at the same height with the same parent set.
 /// Blocks in a tipset are canonically ordered by ticket size.
-#[derive(Clone, PartialEq, Debug, Default)]
+#[derive(Clone, PartialEq, Debug)]
 pub struct Tipset {
     blocks: Vec<BlockHeader>,
     key: TipSetKeys,
@@ -145,6 +146,10 @@ impl Tipset {
             },
         })
     }
+    /// Returns epoch of the tipset
+    pub fn epoch(&self) -> &ChainEpoch {
+        &self.blocks[0].epoch()
+    }
     /// Returns all blocks in tipset
     pub fn blocks(&self) -> &[BlockHeader] {
         &self.blocks
@@ -181,6 +186,10 @@ impl Tipset {
     pub fn key(&self) -> &TipSetKeys {
         &self.key
     }
+    /// Returns slice of Cids for the current tipset
+    pub fn cids(&self) -> &[Cid] {
+        &self.key.cids()
+    }
     /// Returns the CIDs of the parents of the blocks in the tipset
     pub fn parents(&self) -> &TipSetKeys {
         &self.blocks[0].parents()
@@ -196,6 +205,7 @@ impl Tipset {
 }
 
 /// FullTipSet is an expanded version of the TipSet that contains all the blocks and messages
+#[derive(Debug, PartialEq, Clone)]
 pub struct FullTipset {
     blocks: Vec<Block>,
 }

blockchain/chain/Cargo.toml

@@ -5,7 +5,6 @@ authors = ["ChainSafe Systems <info@chainsafe.io>"]
 edition = "2018"
 
 [dependencies]
-forest_libp2p = { path = "../../node/forest_libp2p" }
 blocks = { package = "forest_blocks", path = "../blocks" }
 db = { path = "../../node/db" }
 cid = { package = "forest_cid", path = "../../ipld/cid" }
@@ -14,6 +13,7 @@ encoding = { package = "forest_encoding", path = "../../encoding" }
 serde = { version = "1.0", features = ["derive"] }
 num-bigint = { path = "../../math/bigint", package = "forest_bigint" }
 message = { package = "forest_message", path = "../../vm/message" }
+ipld_blockstore = { path = "../../ipld/blockstore" }
 
 [dev-dependencies]
 address = { package = "forest_address", path = "../../vm/address" }

blockchain/chain/src/store/chain_store.rs

@@ -2,47 +2,49 @@
 // SPDX-License-Identifier: Apache-2.0, MIT
 
 use super::{Error, TipIndex, TipSetMetadata};
-use blocks::{BlockHeader, Tipset};
+use blocks::{BlockHeader, TipSetKeys, Tipset};
 use cid::Cid;
-use db::{Error as DbError, Read, RocksDb as Blockstore, Write};
+use db::Error as DbError;
 use encoding::{de::DeserializeOwned, from_slice, Cbor};
+use ipld_blockstore::BlockStore;
 use message::{SignedMessage, UnsignedMessage};
 use num_bigint::BigUint;
-use std::path::Path;
+use std::sync::Arc;
+
+const GENESIS_KEY: &str = "gen_block";
 
 /// Generic implementation of the datastore trait and structures
-pub struct ChainStore<'a> {
+pub struct ChainStore<'db, DB> {
     // TODO add IPLD Store
     // TODO add StateTreeLoader
     // TODO add a pubsub channel that publishes an event every time the head changes.
 
     // key-value datastore
-    db: Blockstore,
-
-    // CID of the genesis block.
-    genesis: Cid,
+    db: &'db DB,
 
     // Tipset at the head of the best-known chain.
-    heaviest: &'a Tipset,
+    // TODO revisit if this should be pointer to tipset on heap
+    heaviest: Arc<Tipset>,
 
     // tip_index tracks tipsets by epoch/parentset for use by expected consensus.
     tip_index: TipIndex,
 }
 
-impl<'a> ChainStore<'a> {
+impl<'db, DB> ChainStore<'db, DB>
+where
+    DB: BlockStore,
+{
     /// constructor
-    pub fn new(path: &Path, gen: Cid, heaviest: &'a Tipset) -> Result<Self, Error> {
-        let mut db = Blockstore::new(path.to_path_buf());
-        // initialize key-value store
-        db.open()?;
-
-        Ok(Self {
+    pub fn new(db: &'db DB) -> Self {
+        // TODO pull heaviest tipset from data storage
+        let heaviest = Arc::new(Tipset::new(vec![BlockHeader::default()]).unwrap());
+        Self {
             db,
             tip_index: TipIndex::new(),
-            genesis: gen,
             heaviest,
-        })
+        }
     }
+
     /// Sets tip_index tracker
     pub fn set_tipset_tracker(&mut self, header: &BlockHeader) -> Result<(), Error> {
         let ts: Tipset = Tipset::new(vec![header.clone()])?;
@@ -58,11 +60,14 @@ impl<'a> ChainStore<'a> {
         // TODO
         Ok(BigUint::from(0 as u32))
     }
+
     /// Writes genesis to blockstore
     pub fn set_genesis(&self, header: BlockHeader) -> Result<(), DbError> {
+        self.db.write(GENESIS_KEY, header.marshal_cbor()?)?;
         let ts: Tipset = Tipset::new(vec![header])?;
         Ok(self.persist_headers(&ts)?)
     }
+
     /// Writes encoded blockheader data to blockstore
     pub fn persist_headers(&self, tip: &Tipset) -> Result<(), DbError> {
         let mut raw_header_data = Vec::new();
@@ -76,6 +81,7 @@ impl<'a> ChainStore<'a> {
         }
         Ok(self.db.bulk_write(&keys, &raw_header_data)?)
     }
+
     /// Writes encoded message data to blockstore
     pub fn put_messages<T: Cbor>(&self, msgs: &[T]) -> Result<(), Error> {
         for m in msgs {
@@ -88,32 +94,33 @@ impl<'a> ChainStore<'a> {
         }
         Ok(())
     }
+
     /// Returns genesis blockheader from blockstore
-    pub fn genesis(&self) -> Result<BlockHeader, Error> {
-        let bz = self.db.read(self.genesis.key())?;
-        match bz {
-            None => Err(Error::UndefinedKey(
-                "Genesis key does not exist".to_string(),
-            )),
-            Some(ref x) => from_slice(&x)?,
-        }
+    pub fn genesis(&self) -> Result<Option<BlockHeader>, Error> {
+        Ok(match self.db.read(GENESIS_KEY)? {
+            Some(bz) => Some(BlockHeader::unmarshal_cbor(&bz)?),
+            None => None,
+        })
     }
+
     /// Returns heaviest tipset from blockstore
-    pub fn heaviest_tipset(&self) -> &Tipset {
-        &self.heaviest
+    pub fn heaviest_tipset(&self) -> Arc<Tipset> {
+        self.heaviest.clone()
     }
+
     /// Returns key-value store instance
-    pub fn blockstore(&self) -> &Blockstore {
+    pub fn blockstore(&self) -> &DB {
         &self.db
     }
+
     /// Returns Tipset from key-value store from provided cids
-    pub fn tipset(&self, cids: &[Cid]) -> Result<Tipset, Error> {
+    pub fn tipset_from_keys(&self, tsk: &TipSetKeys) -> Result<Tipset, Error> {
         let mut block_headers = Vec::new();
-        for c in cids {
+        for c in tsk.cids() {
             let raw_header = self.db.read(c.key())?;
             if let Some(x) = raw_header {
                 // decode raw header into BlockHeader
-                let bh = from_slice(&x)?;
+                let bh = BlockHeader::unmarshal_cbor(&x)?;
                 block_headers.push(bh);
             } else {
                 return Err(Error::KeyValueStore(
@@ -138,6 +145,7 @@ impl<'a> ChainStore<'a> {
         let secp_msgs: Vec<SignedMessage> = self.messages_from_cids(Vec::new())?;
         Ok((bls_msgs, secp_msgs))
     }
+
     /// Returns messages from key-value store
     pub fn messages_from_cids<T>(&self, keys: Vec<&Cid>) -> Result<Vec<T>, Error>
     where
@@ -154,3 +162,24 @@ impl<'a> ChainStore<'a> {
             .collect()
     }
 }
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[test]
+    fn genesis_test() {
+        let db = db::MemoryDB::default();
+
+        let cs = ChainStore::new(&db);
+        let gen_block = BlockHeader::builder()
+            .epoch(1.into())
+            .weight((2 as u32).into())
+            .build_and_validate()
+            .unwrap();
+
+        assert_eq!(cs.genesis().unwrap(), None);
+        cs.set_genesis(gen_block.clone()).unwrap();
+        assert_eq!(cs.genesis().unwrap(), Some(gen_block));
+    }
+}

blockchain/chain_sync/Cargo.toml

@@ -5,5 +5,23 @@ authors = ["ChainSafe Systems <info@chainsafe.io>"]
 edition = "2018"
 
 [dependencies]
-libp2p = "0.15.0"
+address = { package = "forest_address", path = "../../vm/address" }
+amt = { package = "ipld_amt", path = "../../ipld/amt" }
 blocks = { package = "forest_blocks", path = "../blocks" }
+db = { path = "../../node/db" }
+encoding = { package = "forest_encoding", path = "../../encoding" }
+libp2p = "0.15.0"
+cid = { package = "forest_cid", path = "../../ipld/cid" }
+ipld_blockstore = { path = "../../ipld/blockstore" }
+chain = { path = "../chain" }
+message = { package = "forest_message", path = "../../vm/message" }
+state_tree = { path = "../../vm/state_tree/" }
+state_manager = { path = "../state_manager/" }
+num-bigint = { path = "../../math/bigint", package = "forest_bigint" }
+crypto = { path = "../../crypto" }
+log = "0.4.8"
+async-std = { version = "1.4.0", features = ["unstable"] }
+forest_libp2p = { path = "../../node/forest_libp2p" }
+pin-project = "0.4.8"
+futures = "0.3.2"
+lru = "0.4.3"