Awesome

<a href="https://github.com/keep-starknet-strange/ziggy-starkdust/actions/workflows/test.yml"><img alt="GitHub Workflow Status (with event)" src="https://img.shields.io/github/actions/workflow/status/keep-starknet-strange/ziggy-starkdust/test.yml?style=for-the-badge" height=30></a> <a href="https://securityscorecards.dev/viewer/?uri=github.com/keep-starknet-strange/ziggy-starkdust"><img alt="OpenSSF Scorecard Report" src="https://img.shields.io/ossf-scorecard/github.com/keep-starknet-strange/ziggy-starkdust?label=openssf%20scorecard&style=for-the-badge" height=30></a> <a href="https://github.com/keep-starknet-strange/ziggy-starkdust/blob/main/LICENSE"><img src="https://img.shields.io/github/license/keep-starknet-strange/ziggy-starkdust.svg?style=for-the-badge" alt="Project license" height="30"></a> <a href="https://twitter.com/StarknetZig"><img src="https://img.shields.io/twitter/follow/StarknetZig?style=for-the-badge&logo=twitter" alt="Follow StarknetZig on Twitter" height="30"></a>

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

Alternatively, if you have nix 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:

  make deps
  

  if u got macos:

  make deps-macos
  

• After you need compile all cairo0 programs, to use test or benchmarks:

  make compile-cairo-programs
  

⚡ Wanna get up to speed fast?

• Zig language reference
• Zig Learn
• Ziglings

• Cairo Whitepaper
• OG Cairo VM in Python
• Cairo VM in Rust
• Cairo VM in Go

🔧 Build

make build

🤖 Usage

You can display the help message by running:

./zig-out/bin/ziggy-starkdust --help

Run a cairo program

Without proof mode:

./zig-out/bin/ziggy-starkdust execute --filename cairo_programs/fibonacci.json

With proof mode:

./zig-out/bin/ziggy-starkdust execute --filename cairo_programs/fibonacci.json --proof-mode

With memory layout, trace, proof mode and custom layout:

./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:

make build-integration-test
./zig-out/bin/integration_test

Run all benchmarks and compare:

make build-compare-benchmarks

Run all programs and compare output memory/trace for Zig/Rust cairo-vm:

make build-compare-output

Run all unit tests with test summary:

make test

Run a single test, for example, the "Felt252 zero" test:

$ 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:

make build-compare-benchmarks

🔒 Security

Security guidelines

For security guidelines, please refer to SECURITY.md.

OpenSSF Scorecard

We are using the OpenSSF Scorecard 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.

🙏 Acknowledgments

• The structure of the project and some initial code related to prime field functions is based on verkle-cryto repository by jsign.
• The design of the Cairo VM is inspired by Cairo VM in Rust and Cairo VM in Go by lambdaclass.
• Some cryptographic primitive code generation has been done using the amazing fiat-crypto by mit-plv.
• sig has been a great source of inspiration for the project structure and the way to use Zig.
• nektro for the zig-time library.
• The Cairo files used in this project are sourced from the Cairo VM in Rust by lambdaclass.

⚡ 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 for more information.

Happy coding! 🎉

Contributors ✨

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!