blockchain-compression 0.1.0

High-performance compression library optimized for blockchain data structures
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

# Installation

## Basic Setup

Add `blockchain-compression` to your `Cargo.toml`:

```toml
[dependencies]
blockchain-compression = { version = "0.1", features = ["zstd"] }
```

## Feature Flags

The library uses feature flags to control which compression backends are compiled:

| Feature | Backend | Default | Description |
|---------|---------|---------|-------------|
| `deflate` | DEFLATE (flate2) | Yes | General-purpose compression, widely compatible |
| `zstd` | Zstandard | No | Recommended for blockchain data -- best ratios |
| `lz4` | LZ4 | No | Fastest compression/decompression speed |

### Recommended: Zstandard

For blockchain data, use the `zstd` feature. It provides the best compression ratios with custom dictionary support:

```toml
blockchain-compression = { version = "0.1", features = ["zstd"] }
```

### Multiple Backends

You can enable multiple backends simultaneously:

```toml
blockchain-compression = { version = "0.1", features = ["zstd", "deflate", "lz4"] }
```

### Default Feature

The `deflate` feature is enabled by default. To use only `zstd`:

```toml
blockchain-compression = { version = "0.1", default-features = false, features = ["zstd"] }
```

## System Requirements

- **Rust**: 1.70+
- **OS**: Linux, macOS, Windows
- **zstd feature**: Requires a C compiler for `zstd-sys` (automatically handled by `cc` crate)

## Building from Source

```bash
git clone https://github.com/cryptuon/blockchain-compression.git
cd blockchain-compression

# Build with zstd
cargo build --features zstd

# Run tests
cargo test --features zstd

# Build in release mode
cargo build --release --features zstd
```