Merge pull request #24 from keep-starknet-strange/mk/readme

Add project overview and roadmap

README.md

@@ -9,58 +9,84 @@
 <a href="https://exploration.starkware.co/"><img src="https://img.shields.io/badge/Exploration Team-000.svg?&style=for-the-badge&logo=data:image/svg%2bxml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz48c3ZnIGlkPSJhIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAxODEgMTgxIj48ZGVmcz48c3R5bGU+LmJ7ZmlsbDojZmZmO308L3N0eWxlPjwvZGVmcz48cGF0aCBjbGFzcz0iYiIgZD0iTTE3Ni43Niw4OC4xOGwtMzYtMzcuNDNjLTEuMzMtMS40OC0zLjQxLTIuMDQtNS4zMS0xLjQybC0xMC42MiwyLjk4LTEyLjk1LDMuNjNoLjc4YzUuMTQtNC41Nyw5LjktOS41NSwxNC4yNS0xNC44OSwxLjY4LTEuNjgsMS44MS0yLjcyLDAtNC4yN0w5Mi40NSwuNzZxLTEuOTQtMS4wNC00LjAxLC4xM2MtMTIuMDQsMTIuNDMtMjMuODMsMjQuNzQtMzYsMzcuNjktMS4yLDEuNDUtMS41LDMuNDQtLjc4LDUuMThsNC4yNywxNi41OGMwLDIuNzIsMS40Miw1LjU3LDIuMDcsOC4yOS00LjczLTUuNjEtOS43NC0xMC45Ny0xNS4wMi0xNi4wNi0xLjY4LTEuODEtMi41OS0xLjgxLTQuNCwwTDQuMzksODguMDVjLTEuNjgsMi4zMy0xLjgxLDIuMzMsMCw0LjUzbDM1Ljg3LDM3LjNjMS4zNiwxLjUzLDMuNSwyLjEsNS40NCwxLjQybDExLjQtMy4xMSwxMi45NS0zLjYzdi45MWMtNS4yOSw0LjE3LTEwLjIyLDguNzYtMTQuNzYsMTMuNzNxLTMuNjMsMi45OC0uNzgsNS4zMWwzMy40MSwzNC44NGMyLjIsMi4yLDIuOTgsMi4yLDUuMTgsMGwzNS40OC0zNy4xN2MxLjU5LTEuMzgsMi4xNi0zLjYsMS40Mi01LjU3LTEuNjgtNi4wOS0zLjI0LTEyLjMtNC43OS0xOC4zOS0uNzQtMi4yNy0xLjIyLTQuNjItMS40Mi02Ljk5LDQuMyw1LjkzLDkuMDcsMTEuNTIsMTQuMjUsMTYuNzEsMS42OCwxLjY4LDIuNzIsMS42OCw0LjQsMGwzNC4zMi0zNS43NHExLjU1LTEuODEsMC00LjAxWm0tNzIuMjYsMTUuMTVjLTMuMTEtLjc4LTYuMDktMS41NS05LjE5LTIuNTktMS43OC0uMzQtMy42MSwuMy00Ljc5LDEuNjhsLTEyLjk1LDEzLjg2Yy0uNzYsLjg1LTEuNDUsMS43Ni0yLjA3LDIuNzJoLS42NWMxLjMtNS4zMSwyLjcyLTEwLjYyLDQuMDEtMTUuOGwxLjY4LTYuNzNjLjg0LTIuMTgsLjE1LTQuNjUtMS42OC02LjA5bC0xMi45NS0xNC4xMmMtLjY0LS40NS0xLjE0LTEuMDgtMS40Mi0xLjgxbDE5LjA0LDUuMTgsMi41OSwuNzhjMi4wNCwuNzYsNC4zMywuMTQsNS43LTEuNTVsMTIuOTUtMTQuMzhzLjc4LTEuMDQsMS42OC0xLjE3Yy0xLjgxLDYuNi0yLjk4LDE0LjEyLTUuNDQsMjAuNDYtMS4wOCwyLjk2LS4wOCw2LjI4LDIuNDYsOC4xNiw0LjI3LDQuMTQsOC4yOSw4LjU1LDEyLjk1LDEyLjk1LDAsMCwxLjMsLjkxLDEuNDIsMi4wN2wtMTMuMzQtMy42M1oiLz48L3N2Zz4=" alt="Exploration Team" height="30"></a>
 </div>
 
-## About
+## Overview
 
 Raito is a zero-knowledge Bitcoin client implemented in Cairo. It aims to provide trustless validation of the Bitcoin blockchain through STARK proof verification. It is heavily inspired by [ZeroSync](https://github.com/ZeroSync/ZeroSynchttps://github.com/ZeroSync/ZeroSync) project.
 
 > **Disclaimer:** This project is in the early stages of development and should not be used in production. It will evolve rapidly, expect breaking changes.
 
-Design goals:
+```mermaid
+flowchart TB
+Pnm1(STARK proof of the chain state<br>up to the block <i>n - 1</i>) --> Vp(zk verifier)
+Bn(blocks <i>n..m</i>) ----> Vb
+
+subgraph Cairo
+    Vp{{STARK verifier}}-->ChS(verified chain state)
+    ChS --> Vb{{validate block<br>against the chain state}}
+    Vb --> ChS
+end
+
+Vb --> Pn(STARK proof of the chain state<br>up to the block <i>m</i>)
+
+style Bn fill:pink
+style Pn fill:lightgreen
+style Pnm1 fill:lightgreen
+style ChS fill:greenyellow
+style Vp fill:gold
+style Vb fill:gold
+```
+
+Raito, at its core, accepts two inputs: a batch of consecutive blocks <i>n</i> to <i>m</i> and a STARK proof of the state of the chain up to block <i>n−1</i>. It ensures that the historical chain state is valid by verifying the STARK proof. Then, it produces a new chain state by applying the new blocks on top of the historical state. As a result, a proof of the new state is generated.
+
+## Applications
+
+Although this is a highly experimental project without immediate plans for deployment, there are many potential applications:
 
-- **Usability:** One-click install and run. WebAssembly compatibility for browser-based execution.
-- **Maintainability:** Emphasis on simplicity and clean code structure.
-- **Performance:** Optimized for speed and efficiency, leveraging STWO's next-generation prover.
+* light clients
+* IBD speedup
+* non custodial bridges
+* layer 2s
+
+## Roadmap
+
+* [ ] verify block header (block hash, previous block hash, Merkle root, proof-of-work, median time, and difficulty adjustment)
+* [ ] verify transactions
+* [ ] integrate with Shinigami and verify scripts
+* [ ] verify previous chain proofs
+* [ ] add utreexo accumulator to the chain state
 
 ## Name reference
 
 Raito is a reference to Light Yagami (夜神月, Yagami Raito) from the manga/anime Death Note.
 
-- Raito in Japanese means "Light", which in turns can refer to Lightning ⚡ (and hence both a reference to speed of verification of the Bitcoin blockchain using a ZKP and a reference to the Lightning Network)
-- Raito can work in tandem with [Shinigami](https://github.com/keep-starknet-strange/shinigami) that enables verification of Bitcoin Script programs. Raito = Consensus and Shinigami = Execution. Since Shinigami was named after Ryuk (Shinigami in Death Note), Raito was named after Light (Raito in Death Note).
-- What Raito writes in the Death Note always happen, so you can see it as a source of truth, similarly to how you use a Zero-Knowledge Proof to verify the integrity of a computation.
+* Raito in Japanese means "Light", which in turns can refer to Lightning ⚡ (and hence both a reference to speed of verification of the Bitcoin blockchain using a ZKP and a reference to the Lightning Network)
+* Raito can work in tandem with [Shinigami](https://github.com/keep-starknet-strange/shinigami) that enables verification of Bitcoin Script programs. Raito = Consensus and Shinigami = Execution. Since Shinigami was named after Ryuk (Shinigami in Death Note), Raito was named after Light (Raito in Death Note).
+* What Raito writes in the Death Note always happen, so you can see it as a source of truth, similarly to how you use a Zero-Knowledge Proof to verify the integrity of a computation.
 
 ![Raito and Raito](./docs/img/memes/raito_shinigami_fusion.jpg)
 
-### Running
+## Usage
 
-```bash
-scarb cairo-run --available-gas=200000000
-```
-
-This will run the provided Bitcoin Script in Cairo.
-
-### Building
+This will compile all the components:
 
 ```bash
 scarb build
-```
 
-This will compile all the components.
+```
 
-### Testing
+This will run the test-suite:
 
 ```bash
 scarb test
 ```
 
-This will run the test-suite for all op-codes, integration, and test Bitcoin Scripts.
-
 ## References
 
-- [STWO](https://github.com/starkware-libs/stwo)
-- [Cairo](https://www.cairo-lang.org/)
-- [Circle STARK paper](https://eprint.iacr.org/2024/278)
-- [ZeroSync](https://github.com/ZeroSync/ZeroSync)
+* [STWO](https://github.com/starkware-libs/stwo)
+* [Cairo](https://www.cairo-lang.org/)
+* [Circle STARK paper](https://eprint.iacr.org/2024/278)
+* [ZeroSync](https://github.com/ZeroSync/ZeroSync)
+* [Shinigami](https://github.com/keep-starknet-strange/shinigami)
 
 ## Contributors ✨