Skip to content

Commit 3c6d757

Browse files
authored
Add a basic README (#12)
1 parent 4835a85 commit 3c6d757

File tree

1 file changed

+40
-1
lines changed

1 file changed

+40
-1
lines changed

README.md

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,40 @@
1-
# TODO
1+
# Blobstream Zero
2+
3+
> WARNING: This project is currently experimental and not recommended for any production use cases yet
4+
5+
Blobstream Zero is an implementation of [Blobstream](https://docs.celestia.org/developers/blobstream) using the [RISC Zero zkVM](https://www.risczero.com/) to verify Celestia blocks.
6+
7+
The blocks are verified using a zk Tendermint light client with the [light-client-guest](./light-client-guest/guest/src/main.rs) program, which is composed with a proof that recursively verifies these light client proofs and builds a merkle tree of the verified blocks in [batch-guest](./batch-guest/guest/src/main.rs). This proof is then verified on Ethereum using the [Blobstream solidity contracts](./contracts/src/).
8+
9+
The ABI for the Blobstream Zero solidity contract as well as the merkle tree format for the batch proof is currently matching previous implementations to maintain as much compatibility with previous solutions as well as the [existing APIs to request Blobstream inclusion proofs](https://docs.celestia.org/developers/blobstream-proof-queries#_1-data-root-inclusion-proof).
10+
11+
### Usage
12+
13+
Clone this repository, then pull submodules:
14+
15+
```console
16+
git submodule update --init --recursive
17+
```
18+
19+
Ensure [Rust](https://www.rust-lang.org/tools/install), [Foundry](https://book.getfoundry.sh/getting-started/installation), and [the RISC Zero toolchain](https://dev.risczero.com/api/zkvm/install) are installed.
20+
21+
Build guest programs and update autogenerated files:
22+
23+
```console
24+
# Could also run `cargo build`
25+
cargo check
26+
```
27+
28+
Optionally run tests, which includes an [end to end test](./host/tests/e2e_test.rs):
29+
30+
```console
31+
cargo test
32+
```
33+
34+
Run the CLI to generate proofs or post those proofs on an Eth based network:
35+
36+
```console
37+
cargo run -p host -- --help
38+
```
39+
40+
> Note: This CLI as well as other APIs will change in the short term. If you need anything specific from this, [open an issue](https://github.com/risc0/blobstream0/issues/new)!

0 commit comments

Comments
 (0)