-
Notifications
You must be signed in to change notification settings - Fork 28
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
doc: Install Stone from sources (#70)
* doc: Install Stone from sources Co-authored-by: Dmitry Mirgaleev <[email protected]>
- Loading branch information
1 parent
46ab25c
commit e7111e9
Showing
1 changed file
with
130 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,130 @@ | ||
# Build from Source | ||
This guide provides step-by-step instructions for building the Stone prover and verifier from source on Linux and macOS devices. | ||
|
||
## Linux | ||
### Step 1: Install System Dependencies | ||
Install the necessary system libraries using your os package manager. | ||
```sh | ||
sudo apt-get update | ||
sudo apt-get install -y libtinfo5 libdw-dev libgmp3-dev git wget python3 python3-pip | ||
``` | ||
|
||
### Step 2: Install Python Packages | ||
Install the required Python packages, including specific versions of sympy and cairo-lang, along with cpplint, pytest, and numpy. | ||
```sh | ||
pip install cpplint pytest numpy sympy==1.12.1 cairo-lang==0.12.0 | ||
``` | ||
|
||
### Step 3: Download and Set Up Bazelisk | ||
Install the Bazelisk binary to build the stone prover/verifier. | ||
```sh | ||
wget "https://github.com/bazelbuild/bazelisk/releases/download/v1.20.0/bazelisk-linux-amd64" | ||
chmod 755 "bazelisk-linux-amd64" | ||
sudo mv "bazelisk-linux-amd64" /usr/bin/bazelisk | ||
``` | ||
|
||
### Step 4: Clone the Stone Prover Repository | ||
Clone the Stone prover repository from GitHub. | ||
```sh | ||
git clone https://github.com/baking-bad/stone-prover.git /tmp/stone-prover | ||
``` | ||
|
||
### Step 5: Navigate to the Project Directory | ||
Change to the Stone prover project directory. | ||
```sh | ||
cd /tmp/stone-prover | ||
``` | ||
|
||
### Step 6: Build the Project with Bazelisk | ||
Build the Stone prover and verifier using Bazelisk. Ensure the architecture is passed correctly. | ||
```sh | ||
bazelisk build //... | ||
``` | ||
|
||
### Step 7: Run Tests with Bazelisk | ||
Run the tests to verify the build. | ||
```sh | ||
bazelisk test //... | ||
``` | ||
|
||
### Step 8: Create Symbolic Links for Prover and Verifier | ||
To easily access the built prover and verifier binaries, create symbolic links in /usr/local/bin. | ||
```sh | ||
ln -s /tmp/stone-prover/build/bazelbin/src/starkware/main/cpu/cpu_air_prover /usr/local/bin/cpu_air_prover | ||
ln -s /tmp/stone-prover/build/bazelbin/src/starkware/main/cpu/cpu_air_verifier /usr/local/bin/cpu_air_verifier | ||
``` | ||
|
||
### Step 9: Locating the built binaries | ||
```sh | ||
which cpu_air_prover | ||
which cpu_air_verifier | ||
# cpu_air_prover --help | ||
# cpu_air_verifier --help | ||
``` | ||
|
||
## macOS | ||
### Step 1: Install Dependencies | ||
Homebrew is most likely already installed. If not: | ||
```sh | ||
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" | ||
``` | ||
|
||
To install the software, you'll need the following dependencies: | ||
```sh | ||
brew install git | ||
brew install gmp | ||
brew install [email protected] | ||
``` | ||
|
||
### Step 2: Install Python Packages | ||
Install the required Python packages, including specific versions of sympy and cairo-lang, along with cpplint, pytest, and numpy. | ||
```sh | ||
python3 -m pip install --upgrade pip | ||
# --break-system-packages is specified to avoid issues related to PEP 668 https://peps.python.org/pep-0668/ | ||
python3 -m pip install cpplint pytest numpy sympy==1.12.1 cairo-lang==0.12.0 --break-system-packages | ||
``` | ||
|
||
### Step 3: Install Bazelisk | ||
Install the Bazelisk binary to build the stone prover/verifier. | ||
```sh | ||
brew install bazelisk | ||
``` | ||
|
||
### Step 4: Clone the Stone Prover Repository | ||
Clone the Stone prover repository from GitHub. | ||
```sh | ||
git clone https://github.com/baking-bad/stone-prover.git /tmp/stone-prover | ||
``` | ||
|
||
### Step 5: Navigate to the Project Directory | ||
Change to the Stone prover project directory. | ||
```sh | ||
cd /tmp/stone-prover | ||
``` | ||
|
||
### Step 6: Build the Project with Bazelisk | ||
Build the Stone prover and verifier using Bazelisk. Ensure the architecture is passed correctly. | ||
```sh | ||
bazelisk build //... | ||
``` | ||
|
||
### Step 7: Run Tests with Bazelisk | ||
Run the tests to verify the build. | ||
```sh | ||
bazelisk test //... | ||
``` | ||
|
||
### Step 8: Create Symbolic Links for Prover and Verifier | ||
To easily access the built prover and verifier binaries, create symbolic links in /usr/local/bin. | ||
```sh | ||
ln -s /tmp/stone-prover/build/bazelbin/src/starkware/main/cpu/cpu_air_prover /usr/local/bin/cpu_air_prover | ||
ln -s /tmp/stone-prover/build/bazelbin/src/starkware/main/cpu/cpu_air_verifier /usr/local/bin/cpu_air_verifier | ||
``` | ||
|
||
### Step 9: Locating the built binaries | ||
```sh | ||
which cpu_air_prover | ||
which cpu_air_verifier | ||
# cpu_air_prover --help | ||
# cpu_air_verifier --help | ||
``` |