Skip to content

Fix false 'Blake3' advertising (checksum is xxHash3-64) and the rmp envelope doc #46

@27Bslash6

Description

@27Bslash6

Summary

The PyO3 module description and docs advertise "Blake3 checksums", but ByteStorage uses xxHash3-64 (xxhash-rust, no blake3 dependency exists). Separately, DEVELOPMENT.md documents the envelope as a fixed binary header [version:1][format:1][checksum:8][data], but the real envelope is an rmp_serde (MessagePack) serialization of StorageEnvelope — no version byte, no fixed offsets.

Evidence

  • rust/src/lib.rs:46,52 — "Blake3 checksums" (false); actual: byte_storage.rs:17,88,136 xxHash3-64; Cargo.toml has no blake3
  • Envelope: byte_storage.rs:56-66 (struct), serialized at :193 via rmp_serde
  • Crate-level docs (cachekit-core/src/lib.rs:3,13,60) are already correct

Impact

Cross-SDK implementers reading the docs will compute the wrong checksum algorithm and parse the wrong envelope layout.

Fix

Replace "Blake3" with "xxHash3-64" in module strings + md docs; correct the envelope description to the actual rmp_serde StorageEnvelope.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationrustPull requests that update rust code

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions