Skip to content

Commit e32fe35

Browse files
authored
feat: update readme
1 parent ff35966 commit e32fe35

1 file changed

Lines changed: 35 additions & 3 deletions

File tree

README.md

Lines changed: 35 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,35 @@
1-
# raven
1+
<p align="center">
2+
<img alt="Raven: a PIR framework for blockchain state" src="https://github.com/user-attachments/assets/c5cdc7c6-4d67-4ad3-a1a4-ba0009ca2d03" width="820" />
3+
</p>
24

3-
A multi-scheme PIR framework.
5+
## Why
6+
7+
Hiding your IP (Tor, mixnets) doesn't hide _what_ you asked for. A shielded wallet still hands the RPC server a leaf index or commitment hash on every read, and that pointer is enough to reconstruct who you are.
8+
9+
Raven closes that gap on the query layer. The wallet sends an encrypted query, the server runs computation over the database without ever decrypting which row is the target, and the wallet recovers the record locally. Same proofs, same chain, blind reads.
10+
11+
## How it works
12+
13+
- **Encoders** turn a logical store (Merkle tree, key-value map) into a flat array of fixed-width rows that the PIR server can answer queries over. The same engine handles per-leaf, per-path, per-node, or per-key layouts depending on what the workload needs.
14+
- **Sharding** maps every entry to one shard at one offset. Updates re-encode only the affected shards, not the whole database.
15+
- **Blue-green rebuilds** keep a second engine warm. It absorbs new chain events in the background and atomically swaps in when ready, so live queries never block on indexing.
16+
17+
## PIR schemes
18+
19+
| Scheme | Status |
20+
| --------------------------------------------------- | ----------- |
21+
| [InsPIRe](https://eprint.iacr.org/2026/030) | Integrated. |
22+
| [iSimplePIR](https://eprint.iacr.org/2025/1352) | WIP |
23+
24+
## Adapters
25+
26+
Currently one: **Railgun**.
27+
28+
- Uses InsPIRe for both static and dynamic state.
29+
- Blue-green rebuild pattern keeps PPOI status, PPOI paths, and commit-tree paths fresh against live chain head.
30+
- Drop-in `POINodeInterface` for the Railgun wallet stack.
31+
32+
Live demo: <https://demo.railgun.hisoka.io/>
433

534
## Build
635

@@ -9,4 +38,7 @@ cargo test --workspace
938
cargo check --workspace --target wasm32-unknown-unknown
1039
```
1140

12-
[Apache-2.0](./LICENSE)
41+
## License
42+
43+
[Apache-2.0](./LICENSE) © Hisoka.io
44+

0 commit comments

Comments
 (0)