Skip to main content

Crate lib_compression

Crate lib_compression 

Source
Expand description

Sovereign Compression Library

Universal lossless compression via network-wide deduplication with optional zero-knowledge proofs.

§Features

  • Content-defined chunking (FastCDC)
  • Pattern-based deduplication (ZKC)
  • SovereignCodec (BWT + MTF + RLE + Range coding)
  • Optional ZK proofs (feature: zk-proofs)
  • Optional ML compression (feature: ml-support)

§Example

use lib_compression::{ContentChunker, ZkcCompressor, SovereignCodec};

// Chunk file
let chunker = ContentChunker::default();
let shards = chunker.chunk(&data)?;

// Compress with ZKC
let compressor = ZkcCompressor::new();
let compressed = compressor.compress(&shards)?;

Re-exports§

pub use chunker::ContentChunker;
pub use shard::Shard;
pub use shard::ShardId;
pub use shard::ShardManager;
pub use assembler::JitAssembler;
pub use error::CompressionError;
pub use error::Result;
pub use transport::ShardTransport;
pub use transport::TransportConfig;
pub use patterns::Pattern;
pub use patterns::PatternId;
pub use patterns::PatternMiner;
pub use patterns::PatternMinerConfig;
pub use pattern_dict::PatternDictionary;
pub use pattern_dict::DictionaryEntry;
pub use zkc_compressor::ZkcCompressor;
pub use zkc_compressor::CompressedShard;
pub use zkc_compressor::CompressionStats;
pub use zkc_decompressor::ZkcDecompressor;
pub use zkc_decompressor::DecompressionStats;
pub use sovereign_codec::SovereignCodec;
pub use sovereign_codec::CodecParams;
pub use model_compressor::SovereignCodecCompressor;
pub use model_compressor::AdaptiveCodecCompressor;
pub use traits::ProofBackend;
pub use traits::DhtStorage;
pub use traits::ModelCompressor;
pub use traits::DefaultProofBackend;
pub use traits::MemoryDht;
pub use traits::DefaultModelCompressor;
pub use traits::MerkleProof;

Modules§

assembler
JIT assembler for shards
chunker
Content-defined chunking using FastCDC
error
Error types for compression operations
model_compressor
Model compressor bridge implementations
pattern_dict
Global pattern dictionary
patterns
Pattern mining for ZKC
shard
Shard data structures
sovereign_codec
Sovereign Codec (SFC) - BWT + MTF + RLE + Range coding
traits
Abstraction traits for external dependencies
transport
Shard transport layer
zkc_compressor
ZKC Compressor
zkc_decompressor
ZKC Decompressor

Constants§

AVG_SHARD_SIZE
DEFAULT_REDUNDANCY
MAX_SHARD_SIZE
MIN_SHARD_SIZE
PROTOCOL_VERSION