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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
use core::num::NonZeroUsize;

use crate::traits::{MerkleDB, EndOf, Value, ValueOf};
use crate::empty::MerkleEmpty;
use crate::raw::MerkleRaw;

const EXTEND_INDEX: NonZeroUsize = unsafe { NonZeroUsize::new_unchecked(4) };
const LEN_INDEX: NonZeroUsize = unsafe { NonZeroUsize::new_unchecked(3) };
const ITEM_ROOT_INDEX: NonZeroUsize = unsafe { NonZeroUsize::new_unchecked(2) };
const ROOT_INDEX: NonZeroUsize = unsafe { NonZeroUsize::new_unchecked(1) };

/// Binary merkle vector.
pub struct MerkleVec<DB: MerkleDB> {
    raw: MerkleRaw<DB>,
    empty: MerkleEmpty<DB>,
}

impl<DB: MerkleDB> MerkleVec<DB> where
    EndOf<DB>: From<usize> + Into<usize>,
{
    fn set_len(&mut self, db: &mut DB, len: usize) {
        self.raw.set(db, LEN_INDEX, Value::End(len.into()));
    }

    fn extend(&mut self, db: &mut DB) {
        self.empty.extend(db);
        let len_raw = self.raw.get(db, LEN_INDEX).expect("Len must exist");
        let item_root_raw = self.raw.get(db, ITEM_ROOT_INDEX).expect("Item root must exist");
        let mut new_raw = MerkleRaw::new();
        new_raw.set(db, ITEM_ROOT_INDEX, self.empty.root());
        new_raw.set(db, LEN_INDEX, len_raw);
        new_raw.set(db, EXTEND_INDEX, item_root_raw);
        self.raw.set(db, ROOT_INDEX, Value::End(Default::default()));
        self.raw = new_raw;
    }

    fn shrink(&mut self, db: &mut DB) {
        self.empty.shrink(db);
        match self.raw.get(db, EXTEND_INDEX) {
            Some(extended_value) => { self.raw.set(db, ITEM_ROOT_INDEX, extended_value); },
            None => { self.raw.set(db, ITEM_ROOT_INDEX, Value::End(Default::default())); },
        }
    }

    fn raw_index(&self, db: &DB, i: usize) -> NonZeroUsize {
        let max_len = self.max_len(db);
        NonZeroUsize::new(max_len * 2 + i).expect("Got usize must be greater than 0")
    }

    fn max_len(&self, db: &DB) -> usize {
        crate::utils::next_power_of_two(self.len(db))
    }

    /// Get value at index.
    pub fn get(&self, db: &DB, index: usize) -> EndOf<DB> {
        assert!(index < self.len(db));

        let raw_index = self.raw_index(db, index);
        self.raw.get(db, raw_index).expect("Invalid database")
            .end()
            .expect("Invalid database")
    }

    /// Set value at index.
    pub fn set(&mut self, db: &mut DB, index: usize, value: EndOf<DB>) {
        assert!(index < self.len(db));

        let raw_index = self.raw_index(db, index);
        self.raw.set(db, raw_index, Value::End(value));
    }

    /// Root of the current merkle vector.
    pub fn root(&self) -> ValueOf<DB> {
        self.raw.root()
    }

    /// Push a new value to the vector.
    pub fn push(&mut self, db: &mut DB, value: EndOf<DB>) {
        let old_len = self.len(db);
        if old_len == self.max_len(db) {
            self.extend(db);
        }
        let len = old_len + 1;
        let index = old_len;
        self.set_len(db, len);

        let raw_index = self.raw_index(db, index);
        self.raw.set(db, raw_index, Value::End(value));
    }

    /// Pop a value from the vector.
    pub fn pop(&mut self, db: &mut DB) -> Option<EndOf<DB>> {
        let old_len = self.len(db);
        if old_len == 0 {
            return None
        }

        let len = old_len - 1;
        let index = old_len - 1;
        let raw_index = self.raw_index(db, index);
        let value = self.raw.get(db, raw_index).map(|value| value.end().expect("Invalid format"));

        if len <= self.max_len(db) / 2 {
            self.shrink(db);
        }
        self.set_len(db, len);
        value
    }

    /// Length of the vector.
    pub fn len(&self, db: &DB) -> usize {
        self.raw.get(db, LEN_INDEX)
            .expect("Valid merkle vec must exist in item index 3.")
            .end()
            .expect("Invalid structure for merkle vec.")
            .into()
    }

    /// Create a new vector.
    pub fn create(db: &mut DB) -> Self {
        let empty = MerkleEmpty::new();
        let raw = MerkleRaw::new();
        let mut ret = Self { raw, empty };
        ret.set_len(db, 0);
        ret
    }

    /// Drop the current vector.
    pub fn drop(self, db: &mut DB) {
        self.raw.drop(db);
        self.empty.drop(db);
    }

    /// Leak the current vector.
    pub fn leak(self) -> (ValueOf<DB>, ValueOf<DB>) {
        (self.raw.leak(), self.empty.leak())
    }

    /// Initialize from a previously leaked one.
    pub fn from_leaked(raw_root: ValueOf<DB>, empty_root: ValueOf<DB>) -> Self {
        Self {
            raw: MerkleRaw::from_leaked(raw_root),
            empty: MerkleEmpty::from_leaked(empty_root),
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use sha2::Sha256;

    type InMemory = crate::traits::InMemoryMerkleDB<Sha256, VecValue>;

    #[derive(Clone, PartialEq, Eq, Debug, Default)]
    struct VecValue(Vec<u8>);

    impl AsRef<[u8]> for VecValue {
        fn as_ref(&self) -> &[u8] {
            self.0.as_ref()
        }
    }

    impl From<usize> for VecValue {
        fn from(value: usize) -> Self {
            VecValue((&(value as u64).to_le_bytes()[..]).into())
        }
    }

    impl Into<usize> for VecValue {
        fn into(self) -> usize {
            let mut raw = [0u8; 8];
            (&mut raw).copy_from_slice(&self.0[0..8]);
            u64::from_le_bytes(raw) as usize
        }
    }

    #[test]
    fn test_push_pop() {
        let mut db = InMemory::default();
        let mut vec = MerkleVec::create(&mut db);

        for i in 0..100 {
            assert_eq!(vec.len(&mut db), i);
            vec.push(&mut db, i.into());
        }
        assert_eq!(vec.len(&mut db), 100);
        for i in (0..100).rev() {
            let value = vec.pop(&mut db);
            assert_eq!(value, Some(i.into()));
            assert_eq!(vec.len(&mut db), i);
        }
        assert_eq!(vec.len(&mut db), 0);
    }

    #[test]
    fn test_set() {
        let mut db = InMemory::default();
        let mut vec = MerkleVec::create(&mut db);

        for i in 0..100 {
            assert_eq!(vec.len(&mut db), i);
            vec.push(&mut db, Default::default());
        }

        for i in 0..100 {
            vec.set(&mut db, i, i.into());
        }
        for i in 0..100 {
            assert_eq!(vec.get(&db, i), i.into());
        }
    }
}