kakarot: A Cairo repository from 0xLucqs

EVM interpreter written in Cairo, a sort of ZK-EVM emulator, leveraging STARK proof system.

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 an EVM bytecode program. Hence, Kakarot can be used to run Ethereum smart contracts on StarkNet. Kakarot is the super sayajin ZK-EVM ! Why ? Because: It's over 9000!!!!!. It is a work in progress, and it is not ready for production.

Getting started • Supported opcodes • Build • Test . Report a bug

Supported opcodes

%%{init: {'theme': 'forest', 'themeVariables': { 'darkMode': 'false'}}}%%

pie title Kakarot EMV opcodes support (128 / 142)
    "Supported" : 128
    "Not supported" : 14
    "Partially supported" : 0

Here is the list of supported opcodes: opcodes

For the moment the list is maintained manually, but it will likely be generated automatically in the future. If you want to contribute, you can help us by adding the missing opcodes. And if you implement a new opcode, please update the list.

Documentation

Architecture

✅ Kakarot is a smart contract, deployed on Starknet (goerli). It is written in Cairo.
✅ Kakarot can: (a) execute arbitrary EVM bytecode, (b) deploy an EVM smart contract as is, (c) call a Kakarot-deployed EVM smart contract's functions (views and write methods).
✅ Kakarot is an EVM bytecode interpreter.
❌ Kakarot is not a blockchain
❌ Kakarot is not a compiler. Check out Warp for a Solidity -> Cairo transpiler

Main execution flow

sequenceDiagram
    title Simple bytecode execution flow example: [PUSH1 0x01 PUSH1 0x02 ADD]
    actor User
    participant Kakarot
    participant ExecutionContext
    participant EVMInstructions
    participant ArithmeticOperations
    participant PushOperations
    participant Stack
    User->>+Kakarot: execute(value, code, calldata)
    Kakarot->>+EVMInstructions: generate_instructions()
    EVMInstructions->>-Kakarot: instructions
    Kakarot->>+ExecutionContext: compute_intrinsic_gas_cost()
    ExecutionContext->>-Kakarot: ctx
    Kakarot->>Kakarot: run(instructions, ctx)
    loop opcode
        Kakarot->>+EVMInstructions: decode_and_execute(instructions, ctx)
        EVMInstructions->>EVMInstructions: retrieve the current program counter
        Note over EVMInstructions: revert if pc < 0, stop if pc > length of code
        EVMInstructions->>EVMInstructions: read opcode associated function from instruction set
        Note over PushOperations, Stack: x2 PUSH a=1, PUSH b=2
        EVMInstructions->>+PushOperations: exec_push1(ctx)
        PushOperations->>Stack: push(stack, element)
        PushOperations->>-EVMInstructions: ctx
        EVMInstructions->>+ArithmeticOperations: exec_add(ctx)
        Note over PushOperations, Stack: x2 POP a, POP b
        ArithmeticOperations->>Stack: pop(stack)
        Stack->>ArithmeticOperations: element
        ArithmeticOperations->>Stack: push(stack, result)
        ArithmeticOperations->>-EVMInstructions: ctx
        EVMInstructions->>-Kakarot: ctx
    end
    Kakarot->>-User: ctx

Execution sample

Execution of a simple EVM bytecode program on Kakarot.

The bytecode is the following:

6001600503600301610166016002026105b40460020500

Which corresponds to the following EVM program:

0x60 - PUSH1
0x60 - PUSH1
0x03 - SUB
0x60 - PUSH1
0x01 - ADD
0x61 - PUSH2
0x01 - ADD
0x60 - PUSH1
0x02 - MUL
0x61 - PUSH2
0x04 - DIV
0x60 - PUSH1
0x05 - SDIV
0x00 - STOP

Here is the execution trace of the program on Kakarot:

Installation

Install the requirements:

# install poetry if you don't have it already
# curl -sSL https://install.python-poetry.org | python3 -
make setup

For Mac M1s (using brew, miniforge and conda):

brew install gmp
conda create --name cairo python=3.9
conda activate cairo
conda update -n base -c conda-forge conda
conda install pip
CFLAGS=-I`brew --prefix gmp`/include LDFLAGS=-L`brew --prefix gmp`/lib /opt/homebrew/Caskroom/miniforge/base/envs/cairo/bin/pip install ecdsa fastecdsa sympy
CFLAGS=-I`brew --prefix gmp`/include LDFLAGS=-L`brew --prefix gmp`/lib /opt/homebrew/Caskroom/miniforge/base/envs/cairo/bin/pip install cairo-lang cairo_coverage openzeppelin-cairo-contracts

Build

make build

Test

Running the tests requires to have docker available in the machine. Check their doc for how to install it.

# Run all tests
make test

# Run only unit tests
make test-units

# Run only integration tests
make test-integration

# Run a specific test file
pytest <PATH_TO_FILE>  # with pytest
python3 -m unittest <PATH_TO_FILE>  # with unittest

# Run a specific test mark (markers in pyproject.toml)
make run-test-mark mark=<MARK>
make run-test-mark-log mark=<MARK> # with log

Deploy

# On testnet
./scripts/deploy_kakarot.sh -p testnet -a admin

With:

testnet profile defined in protostar config file (testnet for alpha-goerli)
admin alias to the admin account (optional if it is your __default__ account, see also starknet account documentation)

Contract addresses will be logged into the prompt.

Inputs

To manage inputs sent to constructor during the deployment, you can customize the config files.

License

kakarot is released under the MIT.

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.

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!

Contributors

_{Abdel @ StarkWare} 💻 ⚠️ 📖 🚇 📆 🧑‍🏫	_Lucas 💻 ⚠️ 📖 🧑‍🏫	_{Mentor Reka} 💻 ⚠️ 📖 🚇	_danilowhk 💻 ⚠️	_Lenny 💻 ⚠️	_{Florian Bellotti} 💻 ⚠️	_Henri 💻 ⚠️
_FreshPizza 💻 ⚠️	_{Clément Walter} 📖 ⚠️	_{Rich Warner} 💻 ⚠️	_pscott 💻 ⚠️	_{Elias Tazartes} 💻 ⚠️	_Riad15l 💻 ⚠️	_{Tyler Smith} ⚠️