Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/keep-starknet-strange/ziggy-starkdust
⚡ Cairo VM in Zig ⚡
https://github.com/keep-starknet-strange/ziggy-starkdust
cairo starknet virtual-machine zig zig-lang
Last synced: 30 days ago
JSON representation
⚡ Cairo VM in Zig ⚡
- Host: GitHub
- URL: https://github.com/keep-starknet-strange/ziggy-starkdust
- Owner: keep-starknet-strange
- License: mit
- Created: 2023-09-26T16:13:58.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-15T12:39:28.000Z (7 months ago)
- Last Synced: 2024-05-19T05:23:39.684Z (7 months ago)
- Topics: cairo, starknet, virtual-machine, zig, zig-lang
- Language: Zig
- Homepage: https://keep-starknet-strange.github.io/ziggy-starkdust/
- Size: 37 MB
- Stars: 71
- Watchers: 4
- Forks: 38
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- Contributing: docs/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: docs/CODE_OF_CONDUCT.md
- Security: docs/SECURITY.md
Awesome Lists containing this project
- awesome-cairo - `cairo-zig` - Cairo VM in Zig. (Cairo VM)
- awesome-zig - keep-starknet-strange/ziggy-starkdust
- awesome-zig - ziggy-starkdust🗒️Cairo VM in Zig
README
ziggy-starkdust
[](https://github.com/keep-starknet-strange)
> _Note that `ziggy-starkdust` is still experimental. Breaking changes will be made before the first stable release. The library is also NOT audited or reviewed for security at the moment. Use at your own risk._
## 📦 Installation
### 📋 Prerequisites
- [Zig](https://ziglang.org/)
Alternatively, if you have [nix](https://nixos.org/) installed, you can get the full development environment `nix develop`.
- Also you need installed python, so we can compile cairo0 programs in benchmarks/integration tests, to insatll them just run:
```bash
make deps
```
if u got macos:
```bash
make deps-macos
```
- After you need compile all cairo0 programs, to use test or benchmarks:
```bash
make compile-cairo-programs
```
## ⚡ Wanna get up to speed fast?
👇 ⚡ Zig
- [Zig language reference](https://ziglang.org/documentation/master/)
- [Zig Learn](https://ziglearn.org/)
- [Ziglings](https://ziglings.org/)
👇 🐺 Cairo VM
- [Cairo Whitepaper](https://eprint.iacr.org/2021/1063.pdf)
- [OG Cairo VM in Python](https://github.com/starkware-libs/cairo-lang/tree/master/src/starkware/cairo/lang/vm)
- [Cairo VM in Rust](https://github.com/lambdaclass/cairo-vm)
- [Cairo VM in Go](https://github.com/lambdaclass/cairo-vm_in_go)
## 🔧 Build
```bash
make build
```
## 🤖 Usage
You can display the help message by running:
```bash
./zig-out/bin/ziggy-starkdust --help
```
### Run a cairo program
Without proof mode:
```bash
./zig-out/bin/ziggy-starkdust execute --filename cairo_programs/fibonacci.json
```
With proof mode:
```bash
./zig-out/bin/ziggy-starkdust execute --filename cairo_programs/fibonacci.json --proof-mode
```
With memory layout, trace, proof mode and custom layout:
```bash
./zig-out/bin/ziggy-starkdust execute --filename cairo_programs/fibonacci.json --memory-file=/dev/null --trace-file=/dev/null --proof-mode=true --layout all_cairo
```
### 🧪 Testing
Run all integration tests with summary:
```bash
make build-integration-test
./zig-out/bin/integration_test
```
Run all benchmarks and compare:
```bash
make build-compare-benchmarks
```
Run all programs and compare output memory/trace for Zig/Rust cairo-vm:
```bash
make build-compare-output
```
Run all unit tests with test summary:
```bash
make test
```
Run a single test, for example, the "Felt252 zero" test:
```console
$ make test-filter FILTER="Felt252 zero"
All 2 tests passed.
```
Notice that 2 tests passed despite running only 1 test, because
our tests are wrapped in another test call within `src/tests.zig`.
In order to compare two memory files or trace files, use the following command:
`vbindiff cairo_programs/expected_fibonacci.trace cairo_programs/fibonacci.trace`
## 📊 Benchmarks
### Installing benchmark dependencies
In order to compile programs you need to install the cairo-lang package.
Running the `make deps` (or the `make deps-macos` if you are runnning in MacOS) command will create a virtual environment with all the required dependencies.
Run the complete benchmark suite with Make:
```bash
make build-compare-benchmarks
```
### 🔒 Security
#### Security guidelines
For security guidelines, please refer to [SECURITY.md](docs/SECURITY.md).
#### OpenSSF Scorecard
We are using the [OpenSSF Scorecard](https://securityscorecards.dev/) to track the security of this project.
Scorecard assesses open source projects for security risks through a series of automated checks.
You can see the current scorecard for this project [here](https://securityscorecards.dev/viewer/?uri=github.com/keep-starknet-strange/ziggy-starkdust).
## 🙏 Acknowledgments
- The structure of the project and some initial code related to prime field functions is based on [verkle-cryto](https://github.com/jsign/verkle-crypto) repository by [jsign](https://github.com/jsign).
- The design of the Cairo VM is inspired by [Cairo VM in Rust](https://github.com/lambdaclass/cairo-vm) and [Cairo VM in Go](https://github.com/lambdaclass/cairo-vm_in_go) by [lambdaclass](https://lambdaclass.com/).
- Some cryptographic primitive code generation has been done using the amazing [fiat-crypto](https://github.com/mit-plv/fiat-crypto) by [mit-plv](https://github.com/mit-plv).
- [sig](https://github.com/Syndica/sig) has been a great source of inspiration for the project structure and the way to use Zig.
- [nektro](https://github.com/nektro/) for the [zig-time](https://github.com/nektro/zig-time) library.
- The Cairo files used in this project are sourced from the [Cairo VM in Rust](https://github.com/lambdaclass/cairo-vm) by [lambdaclass](https://lambdaclass.com/).
## ⚡ Why Zig?
👇 ⚡
Choosing Zig for a third implementation of the Cairo VM brings several advantages, offering a unique blend of features not entirely covered by the existing Rust and Go implementations.
### 1. Simplicity and Readability
Zig aims for simplicity and clarity, enabling developers to read and understand the code quickly. It omits certain features like classes and exceptions to keep the language simple, which can be particularly useful for a VM where performance and maintainability are key.
### 2. Performance
Zig compiles to highly efficient native code, similar to Rust, making it an excellent choice for computationally-intensive tasks. The language's design gives the programmer direct control over memory and CPU, without unnecessary abstractions.
### 3. Explicit Control with Safety Features
Zig provides an environment where you have explicit control over memory allocation, similar to C and C++. While this does mean you're responsible for managing memory yourself, Zig offers certain safety features to catch common errors, like undefined behavior, during compile time or by providing runtime checks. This approach allows for a blend of performance and safety, making it a suitable choice for a VM where you often need fine-grained control.
### 4. C Interoperability
Zig offers first-class C interoperability without requiring any bindings or wrappers. This feature can be a game-changer for integrating with existing technologies.
### 5. Flexibility
Zig's comptime (compile-time) features offer powerful metaprogramming capabilities. This allows for expressive yet efficient code, as you can generate specialized routines at compile-time, reducing the need for runtime polymorphism.
### 6. Minimal Dependencies
Zig aims to reduce dependencies to a minimum, which could simplify the deployment and distribution of Cairo VM. This is particularly advantageous for systems that require high-reliability or have limited resources.
### 7. Community and Ecosystem
Although younger than Rust and Go, Zig's community is enthusiastic and rapidly growing. Adopting Zig at this stage means you can be a significant contributor to its ecosystem.
By choosing Zig for the third implementation of Cairo VM, we aim to leverage these features to build a high-performance, reliable, and maintainable virtual machine.
## 📄 License
This project is licensed under the MIT license.
See [LICENSE](LICENSE) for more information.
Happy coding! 🎉
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
Abdel @ StarkWare
💻
bing
💻
Francesco Ceccon
💻
Thomas Coratger
💻
lambda-0x
💻
Nils
💻
johann bestowrous
💻
lanaivina
💻
Dhruv Kelawala
💻
Godspower Eze
💻
tedison
💻
ptisserand
💻
ndcroos
📖
Icosahedron
💻
Pierre-Jean
💻
iwantanode
📖
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!