From 058620853a9e712a3348e2766fe586bc09714402 Mon Sep 17 00:00:00 2001 From: Hideaki Takahashi Date: Fri, 20 Dec 2024 14:04:38 -0500 Subject: [PATCH] Update Readme (#9) * Update * update --- README.md | 46 ++++++++++++++++++++- book/book.toml | 2 +- book/src/README.md | 48 +++++++++++++++++++++- book/src/SUMMARY.md | 2 +- book/src/number_theory/subsec2.md | 2 +- docs/404.html | 21 ++-------- docs/index.html | 64 +++++++++++++++++++++--------- docs/number_theory/index.html | 21 ++-------- docs/number_theory/subsec1.html | 21 ++-------- docs/number_theory/subsec2.html | 25 +++--------- docs/number_theory/subsec3.html | 21 ++-------- docs/number_theory/subsec4.html | 21 ++-------- docs/number_theory/subsec5.html | 21 ++-------- docs/number_theory/subsec6.html | 21 ++-------- docs/number_theory/subsec7.html | 21 ++-------- docs/print.html | 66 ++++++++++++++++++++++--------- docs/searchindex.js | 2 +- docs/searchindex.json | 2 +- docs/zksnark/index.html | 21 ++-------- docs/zksnark/subsec2.html | 21 ++-------- docs/zksnark/subsec3.html | 21 ++-------- docs/zkstark/index.html | 21 ++-------- docs/zkvm/index.html | 21 ++-------- script/build_book.sh | 0 24 files changed, 246 insertions(+), 286 deletions(-) mode change 100644 => 100755 script/build_book.sh diff --git a/README.md b/README.md index 95e4d48..450717e 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,49 @@ ╚═╝ ╚═╝ ╚═╝ ╚══════╝ ╚═╝ ╚═╝ ╚═╝ ``` -# Building Zero Knowledge Proof from Scratch in Rust +# 🚀 Building Zero Knowledge Proofs from Scratch in Rust + +**MyZKP** is a Rust implementation of zero-knowledge protocols built entirely from scratch! This project serves as an educational resource for understanding and working with zero-knowledge proofs. 📚 Explore the accompanying textbook: [**Book of MyZKP**](https://koukyosyumei.github.io/MyZKP/). > [!WARNING] -> Warn: This repo is still working in progress. It is likely to contain bugs/wrong-information. \ No newline at end of file +> This repository is a work in progress and may contain bugs or inaccuracies. Contributions and feedback are welcome! + + +## Index + +**🧮 Basic of Number Theory** + +- 📝 [Computation Rule and Properties](https://koukyosyumei.github.io/MyZKP/number_theory/subsec1.html) +- ⚙️ [Semigroup, Group, Ring, and Field](https://koukyosyumei.github.io/MyZKP/number_theory/subsec2.html) +- 🔢 [Polynomials](https://koukyosyumei.github.io/MyZKP/number_theory/subsec3.html) +- 🌐 [Galois Field](https://koukyosyumei.github.io/MyZKP/number_theory/subsec4.html) +- 📈 [Elliptic Curve](https://koukyosyumei.github.io/MyZKP/number_theory/subsec5.html) +- 🔗 [Pairing](https://koukyosyumei.github.io/MyZKP/number_theory/subsec6.html) +- 🤔 [Useful Assumptions](https://koukyosyumei.github.io/MyZKP/number_theory/subsec7.html) + +**🔒 Basic of zk-SNARKs** + +- ⚡ [Arithmetization](https://koukyosyumei.github.io/MyZKP/zksnark/subsec2.html) +- 🛠️ [Proving Single Polynomial](https://koukyosyumei.github.io/MyZKP/zksnark/subsec3.html) + +**🌟 Basic of zk-STARKs** + +- ✍️ TBD + +**💻 Basic of zkVM** + +- ✍️ TBD + +## 🛠️ Code Reference + +| Module | 📂 File Path | +|---------------------|---------------------------------------------------| +| **Ring** | [ring.rs](./myzkp/src/modules/ring.rs) | +| **Field** | [field.rs](./myzkp/src/modules/field.rs) | +| **Extended Field** | [efield.rs](./myzkp/src/modules/efield.rs) | +| **Polynomial** | [polynomial.rs](./myzkp/src/modules/polynomial.rs)| +| **Elliptic Curve** | [curve.rs](./myzkp/src/modules/curve.rs) | +| **zkSNARKs** | ✍️ Coming soon | + +## ✨ **Contributions are Welcome!** +Feel free to submit issues or pull requests to enhance the project. \ No newline at end of file diff --git a/book/book.toml b/book/book.toml index 943efad..2191048 100644 --- a/book/book.toml +++ b/book/book.toml @@ -8,4 +8,4 @@ title = "Book of MyZKP" [output.html] mathjax-support = true additional-css = ["theme/css/custom.css"] -it-repository-url = "https://github.com/Koukyosyumei/MyZKP/tree/main" +git-repository-url = "https://github.com/Koukyosyumei/MyZKP/tree/main" diff --git a/book/src/README.md b/book/src/README.md index 52b4454..89f5f8f 100644 --- a/book/src/README.md +++ b/book/src/README.md @@ -1,4 +1,4 @@ -# MyZKP: Building Zero Knowledge Proof from Scratch in Rust +# 🚀 MyZKP: Building Zero Knowledge Proof from Scratch in Rust ``` ███╗ ███╗ ██╗ ██╗ ███████╗ ██╗ ██╗ ██████╗ @@ -7,4 +7,48 @@ ██║╚██╔╝██║ ╚██╔╝ ███╔╝ ██╔═██╗ ██╔═══╝ ██║ ╚═╝ ██║ ██║ ███████╗ ██║ ██╗ ██║ ╚═╝ ╚═╝ ╚═╝ ╚══════╝ ╚═╝ ╚═╝ ╚═╝ -``` \ No newline at end of file +``` + +**MyZKP** is a Rust implementation of zero-knowledge protocols built entirely from scratch! This project serves as an educational resource for understanding and working with zero-knowledge proofs. + +> ⚠️ **Warning:** +> This repository is a work in progress and may contain bugs or inaccuracies. Contributions and feedback are welcome! + +## Index + +**🧮 Basic of Number Theory** + +- 📝 [Computation Rule and Properties](https://koukyosyumei.github.io/MyZKP/number_theory/subsec1.html) +- ⚙️ [Semigroup, Group, Ring, and Field](https://koukyosyumei.github.io/MyZKP/number_theory/subsec2.html) +- 🔢 [Polynomials](https://koukyosyumei.github.io/MyZKP/number_theory/subsec3.html) +- 🌐 [Galois Field](https://koukyosyumei.github.io/MyZKP/number_theory/subsec4.html) +- 📈 [Elliptic Curve](https://koukyosyumei.github.io/MyZKP/number_theory/subsec5.html) +- 🔗 [Pairing](https://koukyosyumei.github.io/MyZKP/number_theory/subsec6.html) +- 🤔 [Useful Assumptions](https://koukyosyumei.github.io/MyZKP/number_theory/subsec7.html) + +**🔒 Basic of zk-SNARKs** + +- ⚡ [Arithmetization](https://koukyosyumei.github.io/MyZKP/zksnark/subsec2.html) +- 🛠️ [Proving Single Polynomial](https://koukyosyumei.github.io/MyZKP/zksnark/subsec3.html) + +**🌟 Basic of zk-STARKs** + +- ✍️ TBD + +**💻 Basic of zkVM** + +- ✍️ TBD + +## 🛠️ Code Reference + +| Module | 📂 File Path | +|---------------------|---------------------------------------------------| +| **Ring** | [ring.rs](https://github.com/Koukyosyumei/MyZKP/tree/main/myzkp/src/modules/ring.rs) | +| **Field** | [field.rs](https://github.com/Koukyosyumei/MyZKP/tree/main/myzkp/src/modules/field.rs) | +| **Extended Field** | [efield.rs](https://github.com/Koukyosyumei/MyZKP/tree/main/myzkp/src/modules/efield.rs) | +| **Polynomial** | [polynomial.rs](https://github.com/Koukyosyumei/MyZKP/tree/main/myzkp/src/modules/polynomial.rs)| +| **Elliptic Curve** | [curve.rs](https://github.com/Koukyosyumei/MyZKP/tree/main/myzkp/src/modules/curve.rs) | +| **zkSNARKs** | ✍️ Coming soon | + +## ✨ **Contributions are Welcome!** +Feel free to submit issues or pull requests to enhance the project. \ No newline at end of file diff --git a/book/src/SUMMARY.md b/book/src/SUMMARY.md index 3aafa95..ab188e0 100644 --- a/book/src/SUMMARY.md +++ b/book/src/SUMMARY.md @@ -3,7 +3,7 @@ - [Introduction](./README.md) - [Basics of Number Theory](./number_theory/README.md) - [Computation Rule and Properties](./number_theory/subsec1.md) - - [Semigroup, Group, Ring](./number_theory/subsec2.md) + - [Semigroup, Group, Ring, and Field](./number_theory/subsec2.md) - [Polynomials](./number_theory/subsec3.md) - [Galois Field](./number_theory/subsec4.md) - [Elliptic Curve](./number_theory/subsec5.md) diff --git a/book/src/number_theory/subsec2.md b/book/src/number_theory/subsec2.md index 3dd8f15..28f1257 100644 --- a/book/src/number_theory/subsec2.md +++ b/book/src/number_theory/subsec2.md @@ -1,4 +1,4 @@ -# Semigroup, Group, Ring +# Semigroup, Group, Ring, and Field ### Definition: Semigroup diff --git a/docs/404.html b/docs/404.html index f7ba931..55beab7 100644 --- a/docs/404.html +++ b/docs/404.html @@ -92,7 +92,7 @@