jobez / kakarot-ssj

Kakarot ZK-EVM in Cairo 1.0 🐺 ⚡

Table of Contents

• About
• Getting Started
  • Prerequisites
  • Installation
• Usage
  • Build
  • Run
  • Test
  • Format
• Roadmap
• Support
• Project assistance
• Contributing
• Authors & contributors
• Security
• License
• Acknowledgements
• Contributors ✨

---

About

Kakarot is an Ethereum Virtual Machine written in Cairo. It means it can be deployed on StarkNet, a layer 2 scaling solution for Ethereum, and run any EVM bytecode program. Hence, Kakarot can be used to run Ethereum smart contracts on StarkNet. Kakarot is the super sayajin zkEVM! Why? Because: It's over 9000!!!!!.

It is a work in progress, and it is not ready for production.

Getting Started

Prerequisites

• Cairo
• Rust

Installation

[TODO]

Usage

Build

make build

Run

make run

Test

make test

Format

make format

Roadmap

See the open issues for a list of proposed features (and known issues).

• Top Feature Requests (Add your votes using the 👍 reaction)
• Top Bugs (Add your votes using the 👍 reaction)
• Newest Bugs

Support

Reach out to the maintainer at one of the following places:

• GitHub Discussions
• Contact options listed on this GitHub profile

Project assistance

If you want to say thank you or/and support active development of Kakarot:

• Add a GitHub Star to the project.
• Tweet about the Kakarot.
• Write interesting articles about the project on Dev.to, Medium or your personal blog.

Together, we can make Kakarot better!

Contributing

First off, thanks for taking the time to contribute! Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make will benefit everybody else and are greatly appreciated.

Please read our contribution guidelines, and thank you for being involved!

Authors & contributors

For a full list of all authors and contributors, see the contributors page.

Security

Kakarot follows good practices of security, but 100% security cannot be assured. Kakarot is provided "as is" without any warranty. Use at your own risk.

For more information and to report security issues, please refer to our security documentation.

License

This project is licensed under the MIT license.

See LICENSE for more information.

Acknowledgements

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Abdel @ StarkWare 💻	johann bestowrous 💻
Add your contributions

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