memvid-core 2.0.139

Core library for Memvid v2, a crash-safe, deterministic, single-file AI memory.
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
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
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
use bincode::serde::{decode_from_slice, encode_to_vec};
use blake3::Hasher;
use serde::{Deserialize, Serialize};

use crate::{
    error::{MemvidError, Result},
    types::{
        Frame, IndexManifests, MemoryBinding, SegmentCatalog, SegmentMeta, TemporalTrackManifest,
        TicketRef, TimeIndexManifest, Toc,
    },
};

#[allow(clippy::cast_possible_truncation)]
fn canonical_config() -> impl bincode::config::Config {
    bincode::config::standard()
        .with_fixed_int_encoding()
        .with_little_endian()
        .with_limit::<{ crate::MAX_INDEX_BYTES as usize }>()
}

/// Legacy TOC format without `memories_track` field (pre-v2.0.105).
/// Used for backwards compatibility with older .mv2 files.
#[derive(Serialize, Deserialize, Debug, Clone)]
struct LegacyTocV1 {
    pub toc_version: u64,
    pub segments: Vec<SegmentMeta>,
    pub frames: Vec<Frame>,
    pub indexes: IndexManifests,
    pub time_index: Option<TimeIndexManifest>,
    pub temporal_track: Option<TemporalTrackManifest>,
    // Note: memories_track, logic_mesh, replay_manifest NOT present
    pub segment_catalog: SegmentCatalog,
    pub ticket_ref: TicketRef,
    pub memory_binding: Option<MemoryBinding>,
    pub merkle_root: [u8; 32],
    pub toc_checksum: [u8; 32],
}

/// Legacy TOC format with `memories_track` but without `replay_manifest` (pre-v2.0.116).
/// Used for backwards compatibility with files created before replay feature.
#[derive(Serialize, Deserialize, Debug, Clone)]
struct LegacyTocV2 {
    pub toc_version: u64,
    pub segments: Vec<SegmentMeta>,
    pub frames: Vec<Frame>,
    pub indexes: IndexManifests,
    pub time_index: Option<TimeIndexManifest>,
    pub temporal_track: Option<TemporalTrackManifest>,
    pub memories_track: Option<crate::types::MemoriesTrackManifest>,
    pub logic_mesh: Option<crate::types::LogicMeshManifest>,
    pub segment_catalog: SegmentCatalog,
    pub ticket_ref: TicketRef,
    pub memory_binding: Option<MemoryBinding>,
    // Note: replay_manifest NOT present in this version
    pub merkle_root: [u8; 32],
    pub toc_checksum: [u8; 32],
}

impl From<LegacyTocV1> for Toc {
    fn from(legacy: LegacyTocV1) -> Self {
        Toc {
            toc_version: legacy.toc_version,
            segments: legacy.segments,
            frames: legacy.frames,
            indexes: legacy.indexes,
            time_index: legacy.time_index,
            temporal_track: legacy.temporal_track,
            memories_track: None, // Default for legacy files
            logic_mesh: None,     // Default for legacy files
            sketch_track: None,   // Default for legacy files
            segment_catalog: legacy.segment_catalog,
            ticket_ref: legacy.ticket_ref,
            memory_binding: legacy.memory_binding,
            replay_manifest: None,                // Default for legacy files
            enrichment_queue: Default::default(), // Default for legacy files
            merkle_root: legacy.merkle_root,
            toc_checksum: legacy.toc_checksum,
        }
    }
}

impl From<LegacyTocV2> for Toc {
    fn from(legacy: LegacyTocV2) -> Self {
        Toc {
            toc_version: legacy.toc_version,
            segments: legacy.segments,
            frames: legacy.frames,
            indexes: legacy.indexes,
            time_index: legacy.time_index,
            temporal_track: legacy.temporal_track,
            memories_track: legacy.memories_track,
            logic_mesh: legacy.logic_mesh,
            sketch_track: None, // Default for pre-sketch files
            segment_catalog: legacy.segment_catalog,
            ticket_ref: legacy.ticket_ref,
            memory_binding: legacy.memory_binding,
            replay_manifest: None, // Default for pre-replay files
            enrichment_queue: Default::default(), // Default for legacy files
            merkle_root: legacy.merkle_root,
            toc_checksum: legacy.toc_checksum,
        }
    }
}

impl Toc {
    /// Serialises the TOC using the canonical bincode configuration.
    pub fn encode(&self) -> Result<Vec<u8>> {
        Ok(encode_to_vec(self, canonical_config())?)
    }

    /// Deserialises bytes into a TOC, rejecting any trailing data.
    /// Supports current format and legacy formats (pre-replay_manifest, pre-memories_track).
    pub fn decode(bytes: &[u8]) -> Result<Self> {
        // Try current format first (with replay_manifest)
        if let Ok((toc, bytes_read)) = decode_from_slice::<Toc, _>(bytes, canonical_config()) {
            if bytes_read != bytes.len() {
                return Err(MemvidError::InvalidToc {
                    reason: "unexpected trailing bytes".into(),
                });
            }
            return Ok(toc);
        }

        // Try V2 format (with memories_track/logic_mesh, without replay_manifest)
        if let Ok((legacy, bytes_read)) =
            decode_from_slice::<LegacyTocV2, _>(bytes, canonical_config())
        {
            if bytes_read != bytes.len() {
                return Err(MemvidError::InvalidToc {
                    reason: "unexpected trailing bytes in V2 format".into(),
                });
            }
            tracing::debug!("Decoded TOC V2 format (pre-replay_manifest)");
            return Ok(legacy.into());
        }

        // Try V1 format (without memories_track/logic_mesh/replay_manifest)
        match decode_from_slice::<LegacyTocV1, _>(bytes, canonical_config()) {
            Ok((legacy, bytes_read)) => {
                if bytes_read != bytes.len() {
                    return Err(MemvidError::InvalidToc {
                        reason: "unexpected trailing bytes in V1 format".into(),
                    });
                }
                tracing::debug!("Decoded TOC V1 format (pre-memories_track)");
                Ok(legacy.into())
            }
            Err(e) => Err(e.into()),
        }
    }

    /// Deserialises bytes into a TOC, allowing trailing data (for recovery).
    /// Supports current format and legacy formats (pre-replay_manifest, pre-memories_track).
    pub fn decode_lenient(bytes: &[u8]) -> Result<Self> {
        // Try current format first (with replay_manifest)
        if let Ok((toc, _)) = decode_from_slice::<Toc, _>(bytes, canonical_config()) {
            return Ok(toc);
        }
        // Try V2 format (with memories_track/logic_mesh, without replay_manifest)
        if let Ok((legacy, _)) = decode_from_slice::<LegacyTocV2, _>(bytes, canonical_config()) {
            tracing::debug!("Decoded TOC V2 format (pre-replay_manifest) in lenient mode");
            return Ok(legacy.into());
        }
        // Try V1 format (without memories_track/logic_mesh/replay_manifest)
        match decode_from_slice::<LegacyTocV1, _>(bytes, canonical_config()) {
            Ok((legacy, _)) => {
                tracing::debug!("Decoded TOC V1 format (pre-memories_track) in lenient mode");
                Ok(legacy.into())
            }
            Err(e) => Err(e.into()),
        }
    }
}

impl LegacyTocV1 {
    /// Encode legacy TOC format for checksum verification.
    fn encode(&self) -> Result<Vec<u8>> {
        Ok(encode_to_vec(self, canonical_config())?)
    }
}

impl LegacyTocV2 {
    /// Encode V2 TOC format for checksum verification.
    fn encode(&self) -> Result<Vec<u8>> {
        Ok(encode_to_vec(self, canonical_config())?)
    }
}

impl Toc {
    /// Computes the BLAKE3 checksum used for the TOC integrity field.
    #[must_use]
    pub fn calculate_checksum(bytes: &[u8]) -> [u8; 32] {
        let mut hasher = Hasher::new();
        hasher.update(bytes);
        *hasher.finalize().as_bytes()
    }

    /// Verifies that the stored TOC checksum matches the deterministic encoding.
    /// Supports current format and legacy format checksums for backwards compatibility.
    pub fn verify_checksum(&self) -> Result<()> {
        // Try current format first (with replay_manifest)
        let mut clone = self.clone();
        clone.toc_checksum = [0u8; 32];
        let bytes = clone.encode()?;
        let digest = Self::calculate_checksum(&bytes);
        if digest == self.toc_checksum {
            return Ok(());
        }

        // Try V2 format (with memories_track/logic_mesh, without replay_manifest)
        // Only try if replay_manifest is None (indicates pre-replay origin)
        if self.replay_manifest.is_none() {
            let legacy_v2 = LegacyTocV2 {
                toc_version: self.toc_version,
                segments: self.segments.clone(),
                frames: self.frames.clone(),
                indexes: self.indexes.clone(),
                time_index: self.time_index.clone(),
                temporal_track: self.temporal_track.clone(),
                memories_track: self.memories_track.clone(),
                logic_mesh: self.logic_mesh.clone(),
                segment_catalog: self.segment_catalog.clone(),
                ticket_ref: self.ticket_ref.clone(),
                memory_binding: self.memory_binding.clone(),
                merkle_root: self.merkle_root,
                toc_checksum: [0u8; 32],
            };
            let v2_bytes = legacy_v2.encode()?;
            let v2_digest = Self::calculate_checksum(&v2_bytes);
            if v2_digest == self.toc_checksum {
                tracing::debug!("TOC checksum verified using V2 format (pre-replay)");
                return Ok(());
            }
        }

        // Try V1 format (without memories_track/logic_mesh/replay_manifest)
        // Only try if memories_track is None (indicates V1 origin)
        if self.memories_track.is_none() && self.replay_manifest.is_none() {
            let legacy_v1 = LegacyTocV1 {
                toc_version: self.toc_version,
                segments: self.segments.clone(),
                frames: self.frames.clone(),
                indexes: self.indexes.clone(),
                time_index: self.time_index.clone(),
                temporal_track: self.temporal_track.clone(),
                segment_catalog: self.segment_catalog.clone(),
                ticket_ref: self.ticket_ref.clone(),
                memory_binding: self.memory_binding.clone(),
                merkle_root: self.merkle_root,
                toc_checksum: [0u8; 32],
            };
            let v1_bytes = legacy_v1.encode()?;
            let v1_digest = Self::calculate_checksum(&v1_bytes);
            if v1_digest == self.toc_checksum {
                tracing::debug!("TOC checksum verified using V1 format (pre-memories_track)");
                return Ok(());
            }
        }

        Err(MemvidError::ChecksumMismatch { context: "toc" })
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::types::{
        CanonicalEncoding, Frame, FrameId, FrameRole, FrameStatus, IndexManifests, SegmentCatalog,
        SegmentCompression, SegmentMeta, TicketRef, TimeIndexManifest,
    };
    use std::collections::BTreeMap;

    fn sample_toc() -> Toc {
        Toc {
            toc_version: 1,
            segments: vec![SegmentMeta {
                id: 0,
                frame_range: (0, 2),
                primary_checksum: [0x11; 32],
                compression: SegmentCompression::None,
                bytes_offset: 4096,
                bytes_length: 512,
            }],
            frames: vec![
                Frame {
                    id: 0 as FrameId,
                    timestamp: 1_700_000_000,
                    anchor_ts: None,
                    anchor_source: None,
                    kind: Some("text".into()),
                    track: Some("default".into()),
                    payload_offset: 4096,
                    payload_length: 128,
                    checksum: [0x22; 32],
                    uri: Some("mv2://sample/0".into()),
                    title: Some("Sample 0".into()),
                    canonical_encoding: CanonicalEncoding::Plain,
                    canonical_length: Some(128),
                    metadata: None,
                    search_text: None,
                    tags: Vec::new(),
                    labels: Vec::new(),
                    extra_metadata: BTreeMap::new(),
                    content_dates: Vec::new(),
                    role: FrameRole::Document,
                    parent_id: None,
                    chunk_index: None,
                    chunk_count: None,
                    chunk_manifest: None,
                    status: FrameStatus::Active,
                    supersedes: None,
                    superseded_by: None,
                    source_sha256: None,
                    source_path: None,
                    enrichment_state: crate::types::EnrichmentState::default(),
                },
                Frame {
                    id: 1 as FrameId,
                    timestamp: 1_700_000_100,
                    anchor_ts: None,
                    anchor_source: None,
                    kind: None,
                    track: None,
                    payload_offset: 4224,
                    payload_length: 64,
                    checksum: [0x33; 32],
                    uri: Some("mv2://sample/1".into()),
                    title: Some("Sample 1".into()),
                    canonical_encoding: CanonicalEncoding::Plain,
                    canonical_length: Some(64),
                    metadata: None,
                    search_text: None,
                    tags: Vec::new(),
                    labels: Vec::new(),
                    extra_metadata: BTreeMap::new(),
                    content_dates: Vec::new(),
                    role: FrameRole::Document,
                    parent_id: None,
                    chunk_index: None,
                    chunk_count: None,
                    chunk_manifest: None,
                    status: FrameStatus::Active,
                    supersedes: None,
                    superseded_by: None,
                    source_sha256: None,
                    source_path: None,
                    enrichment_state: crate::types::EnrichmentState::default(),
                },
            ],
            indexes: IndexManifests::default(),
            time_index: Some(TimeIndexManifest {
                bytes_offset: 8192,
                bytes_length: 96,
                entry_count: 2,
                checksum: [0x44; 32],
            }),
            temporal_track: None,
            memories_track: None,
            logic_mesh: None,
            sketch_track: None,
            segment_catalog: SegmentCatalog::default(),
            ticket_ref: TicketRef {
                issuer: "memvid".into(),
                seq_no: 0,
                expires_in_secs: 3600,
                capacity_bytes: 0,
                verified: false,
            },
            memory_binding: None,
            replay_manifest: None,
            enrichment_queue: Default::default(),
            merkle_root: [0x55; 32],
            toc_checksum: [0u8; 32],
        }
    }

    fn stamp_checksum(mut toc: Toc) -> Toc {
        let mut checksum_target = toc.clone();
        checksum_target.toc_checksum = [0u8; 32];
        let bytes = checksum_target.encode().expect("encode for checksum");
        toc.toc_checksum = Toc::calculate_checksum(&bytes);
        toc
    }

    #[test]
    fn serialize_deserialize_roundtrip() {
        let toc = stamp_checksum(sample_toc());
        let encoded = toc.encode().expect("encode toc");
        let decoded = Toc::decode(&encoded).expect("decode toc");
        decoded.verify_checksum().expect("checksum matches");
        assert_eq!(decoded.toc_checksum, toc.toc_checksum);
    }

    #[test]
    fn detect_checksum_mismatch() {
        let mut toc = stamp_checksum(sample_toc());
        toc.toc_checksum[0] ^= 0xFF;
        let err = toc.verify_checksum().expect_err("must fail");
        matches!(err, MemvidError::ChecksumMismatch { .. });
    }

    #[test]
    fn reject_trailing_bytes() {
        let toc = stamp_checksum(sample_toc());
        let mut bytes = toc.encode().expect("encode toc");
        bytes.push(0);
        let err = Toc::decode(&bytes).expect_err("should reject");
        matches!(err, MemvidError::InvalidToc { .. });
    }
}