zksync_object_store 0.1.0

ZKsync implementation of object stores
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134

use std::fmt::Debug;

use async_trait::async_trait;
use tokio::{fs, io};

use crate::raw::{Bucket, ObjectStore, ObjectStoreError};

impl From<io::Error> for ObjectStoreError {
    fn from(err: io::Error) -> Self {
        match err.kind() {
            io::ErrorKind::NotFound => ObjectStoreError::KeyNotFound(err.into()),
            kind => ObjectStoreError::Other {
                is_transient: matches!(kind, io::ErrorKind::Interrupted | io::ErrorKind::TimedOut),
                source: err.into(),
            },
        }
    }
}

/// [`ObjectStore`] implementation storing objects as files in a local filesystem. Mostly useful for local testing.
#[derive(Debug)]
pub struct FileBackedObjectStore {
    base_dir: String,
}

impl FileBackedObjectStore {
    /// Creates a new file-backed store with its root at the specified path.
    ///
    /// # Errors
    ///
    /// Propagates I/O errors.
    pub async fn new(base_dir: String) -> Result<Self, ObjectStoreError> {
        for bucket in &[
            Bucket::ProverJobs,
            Bucket::WitnessInput,
            Bucket::LeafAggregationWitnessJobs,
            Bucket::NodeAggregationWitnessJobs,
            Bucket::SchedulerWitnessJobs,
            Bucket::ProverJobsFri,
            Bucket::LeafAggregationWitnessJobsFri,
            Bucket::NodeAggregationWitnessJobsFri,
            Bucket::SchedulerWitnessJobsFri,
            Bucket::ProofsFri,
            Bucket::StorageSnapshot,
            Bucket::TeeVerifierInput,
        ] {
            let bucket_path = format!("{base_dir}/{bucket}");
            fs::create_dir_all(&bucket_path).await?;
        }
        Ok(FileBackedObjectStore { base_dir })
    }

    fn filename(&self, bucket: Bucket, key: &str) -> String {
        format!("{}/{bucket}/{key}", self.base_dir)
    }
}

#[async_trait]
impl ObjectStore for FileBackedObjectStore {
    async fn get_raw(&self, bucket: Bucket, key: &str) -> Result<Vec<u8>, ObjectStoreError> {
        let filename = self.filename(bucket, key);
        fs::read(filename).await.map_err(From::from)
    }

    async fn put_raw(
        &self,
        bucket: Bucket,
        key: &str,
        value: Vec<u8>,
    ) -> Result<(), ObjectStoreError> {
        let filename = self.filename(bucket, key);
        fs::write(filename, value).await.map_err(From::from)
    }

    async fn remove_raw(&self, bucket: Bucket, key: &str) -> Result<(), ObjectStoreError> {
        let filename = self.filename(bucket, key);
        fs::remove_file(filename).await.map_err(From::from)
    }

    fn storage_prefix_raw(&self, bucket: Bucket) -> String {
        format!("{}/{}", self.base_dir, bucket)
    }
}

#[cfg(test)]
mod test {
    use tempfile::TempDir;

    use super::*;

    #[tokio::test]
    async fn test_get() {
        let dir = TempDir::new().unwrap();
        let path = dir.into_path().into_os_string().into_string().unwrap();
        let object_store = FileBackedObjectStore::new(path).await.unwrap();
        let expected = vec![9, 0, 8, 9, 0, 7];
        object_store
            .put_raw(Bucket::ProverJobs, "test-key.bin", expected.clone())
            .await
            .unwrap();
        let bytes = object_store
            .get_raw(Bucket::ProverJobs, "test-key.bin")
            .await
            .unwrap();
        assert_eq!(expected, bytes, "expected didn't match");
    }

    #[tokio::test]
    async fn test_put() {
        let dir = TempDir::new().unwrap();
        let path = dir.into_path().into_os_string().into_string().unwrap();
        let object_store = FileBackedObjectStore::new(path).await.unwrap();
        let bytes = vec![9, 0, 8, 9, 0, 7];
        object_store
            .put_raw(Bucket::ProverJobs, "test-key.bin", bytes)
            .await
            .unwrap();
    }

    #[tokio::test]
    async fn test_remove() {
        let dir = TempDir::new().unwrap();
        let path = dir.into_path().into_os_string().into_string().unwrap();
        let object_store = FileBackedObjectStore::new(path).await.unwrap();
        object_store
            .put_raw(Bucket::ProverJobs, "test-key.bin", vec![0, 1])
            .await
            .unwrap();
        object_store
            .remove_raw(Bucket::ProverJobs, "test-key.bin")
            .await
            .unwrap();
    }
}