Introduce Rust VM option (0xSpaceShard#372)

* [skip ci] - a release commit follows which will run the CI/CD workflow Co-authored-by: fmoletta <[email protected]> Co-authored-by: Federica <[email protected]> Co-authored-by: jrigada <[email protected]> Co-authored-by: Juan Rigada <[email protected]>
dkillen · Dec 23, 2022 · 62be088 · 62be088
1 parent 50c38b9
commit 62be088
Show file tree

Hide file tree

Showing 16 changed files with 745 additions and 32 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -65,6 +65,11 @@ jobs:
  <<: *test_template
  docker:
  - image: cimg/python:3.9-node
+
+ test_py_min_rust:
+ <<: *test_template
+ environment:
+ STARKNET_DEVNET_CAIRO_VM: "rust"
 
  package_build_and_publish:
  docker:
@@ -120,6 +125,7 @@ workflows:
  jobs:
  - test_py_min
  - test_py_max
+ - test_py_min_rust
  - image_build:
  <<: *on_master
  - image_build_arm:

diff --git a/.dockerignore b/.dockerignore
@@ -15,3 +15,7 @@ Dockerfile
 test/
 .pylintrc
 page/
+
+# Hardhat specific
+node_modules/
+hardhat-cache/
diff --git a/Dockerfile b/Dockerfile
@@ -6,23 +6,22 @@ RUN apk add gmp-dev g++ gcc libffi-dev
 
 RUN pip3 install poetry
 
-RUN poetry build -f wheel
-
-RUN poetry export -f requirements.txt --without-hashes > requirements.txt
+# install rustc+cargo
+RUN wget https://sh.rustup.rs -O - | sh -s -- -y
+ENV PATH="/root/.cargo/bin:${PATH}"
 
+RUN poetry build -f wheel
+RUN poetry export -f requirements.txt --without-hashes --with vm > requirements.txt
 RUN pip3 wheel --no-cache-dir --no-deps --wheel-dir /wheels -r requirements.txt
 
-
 FROM python:3.9.13-alpine3.16
 
 RUN apk add --no-cache libgmpxx
 
 COPY --from=builder /dist/*.whl /wheels/
-
 COPY --from=builder /wheels /wheels
 
 RUN pip3 install --no-cache /wheels/*
-
 RUN rm -rf /wheels
 
 ENV PYTHONUNBUFFERED=1

diff --git a/page/docs/guide/development.md b/page/docs/guide/development.md
@@ -4,9 +4,9 @@ sidebar_position: 18
 
 # Development
 
-If you're a developer willing to contribute, be sure to have installed [**Poetry**](https://pypi.org/project/poetry/) and all the dependency packages by running the following script. You are expected to have [**npm**](https://www.npmjs.com/).
+If you're a developer willing to contribute, be sure to have installed [**Poetry**](https://pypi.org/project/poetry/) and all the dependency packages by running the installation script. Prerequisites for running the script: `gcc`, `g++`, `gmp`, `npm`.
 
-```text
+```bash
 ./scripts/install_dev_tools.sh
 ```
 

diff --git a/page/docs/guide/run.md b/page/docs/guide/run.md
@@ -119,3 +119,39 @@ docker run -p 127.0.0.1:5050:5050 shardlabs/starknet-devnet
 You may ignore any address-related output logged on container startup (e.g. `Running on all addresses` or `Running on http:https://172.17.0.2:5050`). What you will use is what you specified with the `-p` argument.
 
 If you don't specify the `HOST` part, the server will indeed be available on all of your host machine's addresses (localhost, local network IP, etc.), which may present a security issue if you don't want anyone from the local network to access your Devnet instance.
+
+## Run with the Rust implementation of Cairo VM
+
+By default, Devnet uses the [Python implementation](https://github.com/starkware-libs/cairo-lang/) of Cairo VM.
+
+Using the Rust implementation brings improvement for Cairo-VM-intensive operations, but introduces its own overhead, so it may not be useful for simple contracts.
+
+You can enable it by following these steps:
+
+1. Install compilers
+
+Make sure you have `gcc`, `g++` and [Rust](https://www.rust-lang.org/tools/install).
+
+2. Install [cairo-rs-py](https://github.com/lambdaclass/cairo-rs-py) in the [**same environment**](https://docs.python.org/3/library/venv.html) as Devnet:
+
+```bash
+$ pip install cairo-rs-py
+```
+
+3. Set `STARKNET_DEVNET_CAIRO_VM=rust`
+
+```bash
+$ STARKNET_DEVNET_CAIRO_VM=rust starknet-devnet
+```
+
+With Docker, use `-e`:
+
+```bash
+$ docker run -it [OPTIONS] -e STARKNET_DEVNET_CAIRO_VM=rust shardlabs/starknet-devnet [ARGS]
+```
+
+To use the Python VM, **unset** the variable or set it to `python`
+
+```bash
+$ STARKNET_DEVNET_CAIRO_VM=python starknet-devnet
+```
diff --git a/page/docs/intro.md b/page/docs/intro.md
@@ -1,11 +1,14 @@
 ---
 sidebar_position: 1
 ---
+
 # Getting Started
 
 Let's discover **[starknet-devnet](https://github.com/Shard-Labs/starknet-devnet)**.
 :::danger Take care
+
 ## ⚠️ Disclaimer ⚠️
+
 :::
 
 - Devnet should not be used as a replacement for Alpha testnet. After testing on Devnet, be sure to test on testnet (alpha-goerli)!
@@ -20,23 +23,30 @@ Works with Python versions >=3.8 and <3.10.
 
 On Ubuntu/Debian, first run:
 
-
 ```bash
-sudo apt install -y libgmp3-dev
+$ sudo apt install -y libgmp3-dev
 ```
 
 On Mac, you can use `brew`:
 
 ```bash
-brew install gmp
+$ brew install gmp
 ```
 
 ## Install
 
 ```bash
-pip install starknet-devnet
+$ pip install starknet-devnet
 ```
 
+## Run
+
+```
+$ starknet-devnet
+```
+
+For more running possibilities, see [this](https://shard-labs.github.io/starknet-devnet/docs/guide/run).
+
 ### Windows installation
 
 Follow this guide: https://www.spaceshard.io/blog/starknet-devnet-windows-tutorial
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -33,6 +33,9 @@ black = "~22.6"
 requests = "~2.28"
 isort = "^5.10.1"
 
+[tool.poetry.group.vm.dependencies]
+cairo-rs-py = "~0.1.0"
+
 [tool.isort]
 profile = "black"
 skip_gitignore = true

diff --git a/scripts/install_dev_tools.sh b/scripts/install_dev_tools.sh
@@ -12,6 +12,15 @@ echo "python3: $(python3 --version)"
 pip3 install -U poetry==1.2.1
 echo "poetry: $(poetry --version)"
 
+# https://www.rust-lang.org/tools/install
+# need rust to install cairo-rs-py
+if rustc --version; then
+ echo "rustc installed"
+else
+ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
+ source "$HOME/.cargo/env"
+fi
+
 # install dependencies
 poetry install
 poetry lock --check

diff --git a/starknet_devnet/__init__.py b/starknet_devnet/__init__.py
@@ -1,6 +1,8 @@
 """
 Contains the server implementation and its utility classes and functions.
 """
+
+import os
 import sys
 from copy import copy
 
@@ -9,6 +11,8 @@
 from starkware.crypto.signature.fast_pedersen_hash import pedersen_hash
 from starkware.starknet.services.api.contract_class import ContractClass
 
+from .util import warn
+
 __version__ = "0.4.2"
 
 
@@ -43,3 +47,20 @@ def simpler_copy(self, memo): # pylint: disable=unused-argument
 
 
 setattr(ContractClass, "__deepcopy__", simpler_copy)
+
+
+# Optionally apply cairo-rs-py monkey patch
+_VM_VAR = "STARKNET_DEVNET_CAIRO_VM"
+_cairo_vm = os.environ.get(_VM_VAR)
+if _cairo_vm == "rust":
+ from starknet_devnet.cairo_rs_py_patch import cairo_rs_py_monkeypatch
+
+ cairo_rs_py_monkeypatch()
+ warn("Using Cairo VM: Rust")
+
+elif not _cairo_vm or _cairo_vm == "python":
+ # python VM set by default
+ pass
+
+else:
+ sys.exit(f"Error: Invalid value of environment variable {_VM_VAR}: '{_cairo_vm}'")