stealth-lib 1.0.1

ZK-friendly cryptographic primitives (MiMC hash, Merkle trees)
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

# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [1.0.0] - 2026-02-01

### Added

- **New module structure**:
  - `hash::MimcHasher` - Configurable MiMC hash function
  - `merkle::MerkleTree` - Improved Merkle tree with proof support
  - `merkle::MerkleProof` - Merkle inclusion proofs
  - `error::Error` - Typed error enum
  - `encoding` - Hex encoding utilities

- **Merkle proof generation and verification**:
  ```rust
  let proof = tree.prove(leaf_index)?;
  assert!(proof.verify(root, &tree.hasher()));
  ```

- **Typed error handling** - All operations return `Result<T, Error>`

- **Feature flags**:
  - `std` (default) - Standard library support
  - `serde` - Serde serialization
  - `borsh` - Borsh serialization for Solana
  - `experimental` - Educational crypto code (DO NOT USE IN PRODUCTION)

- **`no_std` support** - Disable `std` feature for embedded/WASM

- **Comprehensive documentation** with examples for all public APIs

- **Benchmarks** using Criterion

### Changed

- **BREAKING**: `MerkleTree::new()` now returns `Result<Self, Error>`
  ```rust
  // Before
  let tree = MerkleTree::new(20);
  
  // After  
  let tree = MerkleTree::new(20)?;
  ```

- **BREAKING**: `MerkleTree::insert()` returns `Result<u32, Error>` (was `Result<u8, SolanaError>`)
  - Index type changed from `u8` to `u32` to support larger trees

- **BREAKING**: Error type renamed from `SolanaError` to `Error`
  - Migration: `use stealth_lib::Error;`

- **BREAKING**: `Hasher` renamed to `MimcHasher` and moved to `hash` module
  - Migration: `use stealth_lib::hash::MimcHasher;`

- `borsh` dependency is now optional (enable with `borsh` feature)

- `primitive-types` dependency removed

### Deprecated

- `stealth_lib::hasher::Hasher` - Use `MimcHasher` instead
- `stealth_lib::merkle_tree::MerkleTree` - Use `stealth_lib::MerkleTree` instead
- `stealth_lib::utils::SolanaError` - Use `stealth_lib::Error` instead
- `MerkleTree::get_last_root()` - Use `MerkleTree::root()` instead

### Security

- Added `#![deny(unsafe_code)]` crate-wide
- Removed all `expect()`/`unwrap()` from non-test code paths
- All user-facing errors are typed (no panics for invalid input)
- Added `#![warn(missing_docs)]` for documentation coverage

### Migration Guide

#### Error Handling

```rust
// v0.x - Could panic
let tree = MerkleTree::new(20);
let root = tree.get_last_root();

// v1.0 - Explicit error handling
let tree = MerkleTree::new(20)?;
let root = tree.root().ok_or("No root")?;
```

#### Import Changes

```rust
// v0.x
use stealth_lib::hasher::Hasher;
use stealth_lib::merkle_tree::MerkleTree;
use stealth_lib::utils::SolanaError;

// v1.0
use stealth_lib::{MimcHasher, MerkleTree, Error};
// or
use stealth_lib::hash::MimcHasher;
use stealth_lib::merkle::MerkleTree;
use stealth_lib::error::Error;
```

#### Feature Flags

```toml
# v0.x - borsh always included
[dependencies]
stealth-lib = "0.1"

# v1.0 - borsh is optional
[dependencies]
stealth-lib = { version = "1.0", features = ["borsh"] }
```

## [0.1.4] - Previous Release

- Initial release with MiMC hasher and Merkle tree
- Basic ZKP utilities