https://github.com/pluto/ronkathon
Cryptography Educational Foundations
https://github.com/pluto/ronkathon
cryptography mathematics rustlang zero-knowledge
Last synced: 1 day ago
JSON representation
Cryptography Educational Foundations
- Host: GitHub
- URL: https://github.com/pluto/ronkathon
- Owner: pluto
- License: apache-2.0
- Created: 2024-05-01T18:00:52.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2025-04-11T17:11:30.000Z (5 days ago)
- Last Synced: 2025-04-11T18:29:41.666Z (5 days ago)
- Topics: cryptography, mathematics, rustlang, zero-knowledge
- Language: Rust
- Homepage: https://ronkathon.pluto.xyz
- Size: 18.8 MB
- Stars: 295
- Watchers: 4
- Forks: 41
- Open Issues: 44
-
Metadata Files:
- Readme: README.md
- License: LICENSE-MIT
Awesome Lists containing this project
- awesome-cryptography-rust - Ronkathon
README
ronkathon
## Overview
Ronkathon is a collection of cryptographic primitives implemented in Rust. It is inspired by the [python plonkathon repository](https://github.com/0xPARC/plonkathon) and [plonk-by-hand](https://research.metastate.dev/plonk-by-hand-part-1/). We use the same curve and field as plonk-by-hand (which is not secure) and the goal of this repository is to work towards building everything from scratch to understand everything from first principles.
## Primitives
- **Fundamental Algebraic Structures**
- [Group](src/algebra/group/README.md)
- [Fields and Their Extensions](src/algebra/field/README.md)
- [Binary Fields](src/algebra/field/binary_towers/README.md)
- [Curves and Their Pairings](src/curve/README.md)
- [Polynomials](src/polynomial/mod.rs)
- [KZG Commitments](src/kzg/README.md)
- [Reed-Solomon Codes](src/codes/README.md)
- [Merkle Proofs](src/tree/README.md)
- [DSL](src/compiler/README.md)
### Signatures
- [Digital Signature Algorithms](src/dsa/README.md)
- [Elliptic Curve Digital Signature Algorithm(ECDSA)](src/dsa/ecdsa.rs)
- [Edwards-Curve Digital Signature Algorithm(EdDSA)](src/dsa/eddsa/mod.rs)
### Encryption
#### Asymmetric
- [RSA](src/encryption/asymmetric/rsa/README.md)
#### Symmetric
- **Ciphers:**
+ [DES](src/encryption/symmetric/des/README.md)
+ [AES](src/encryption/symmetric/aes/README.md)
+ [ChaCha](src/encryption/symmetric/chacha/README.md)
- [**Modes of Operation**](src/encryption/symmetric/modes/README.md)
+ ECB, CBC, CTR, GCM
### Hash
- [Sha256 Hash](src/hashes/README.md)
- [Poseidon Hash](src/hashes/poseidon/README.md)
## Resources
We have found the following resources helpful in understanding the foundational mathematics behind this implementation. After going through these, you should be able to understand the codebase
### Theoretic Resources
- [Plonk by Hand P1](https://research.metastate.dev/plonk-by-hand-part-1/)
- [Plonk by Hand P2](https://research.metastate.dev/plonk-by-hand-part-2-the-proof/)
- [Plonk by Hand P3](https://research.metastate.dev/plonk-by-hand-part-3-verification/)
### Code References
- [Plonkathon](https://github.com/0xPARC/plonkathon/blob/main/README.md)
- [Plonky3](https://github.com/Plonky3/Plonky3)
- [py_pairing](https://github.com/ethereum/py_pairing/tree/master)
- [arkworks](https://github.com/arkworks-rs)
## Math
To see computations used in the background, go to the `math/` directory.
From there, you can run the `.sage` files in a SageMath environment.
In particular, the `math/field.sage` computes roots of unity in the `PlutoField` which is of size 101. To install sage on your machine, follow the instructions [here](https://doc.sagemath.org/html/en/installation/index.html). If you are on a Mac, you can install it via homebrew with `brew install --cask sage`.
## Building mdBook
To locally build/serve the [mdBook](https://github.com/rust-lang/mdBook) site, install mdBook and [mdbook-katex](https://github.com/lzanini/mdbook-katex):
```ignore
cargo install mdbook
cargo install mdbook-katex
```
To build, run:
```ignore
cargo run --bin create_mdbook
cp -r assets book/
mdbook build
```
If you want to serve locally, run `mdbook serve`.
## License
Licensed under the Apache License, Version 2.0 ([LICENSE-APACHE](./LICENSE) or http://www.apache.org/licenses/LICENSE-2.0)
## Contributing
We welcome contributions to our open-source projects. If you want to contribute or follow along with contributor discussions, join our [main Telegram channel](https://t.me/pluto_xyz/1) to chat about Pluto's development.
Our contributor guidelines can be found at [CONTRIBUTING.md](https://github.com/pluto/.github/blob/main/profile/CONTRIBUTING.md). A good starting point is issues labelled 'bounty' in our repositories.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be licensed as above, without any additional terms or conditions.