Install dependency

• Install Rust

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

• Install forge (if you launch local network)

curl -L https://foundry.paradigm.xyz | bash
foundryup

• Install sqlx-cli

cargo install sqlx-cli

• Install wasm-pack

cargo install wasm-pack

Preparation

Launch local network

anvil  

Contract deployment

cd tests
cargo test -r -p tests deploy_contracts -- --nocapture

Launch database

docker compose up -d db

Copy env file

You need to run cp .env.example .env in each directory.

Start server

1. Start Store-vault-server. Example port: 9000

cd store-vault-server && sqlx database setup && cargo run -r

2. Start balance-prover. Example port: 9001

cd balance-prover && cargo run -r

3. Start validity-prover. Example port: 9002

cd validity-prover && sqlx database setup && cargo run -r

4. Start validity-prover-worker

cd validity-prover-worker && cargo run -r

5. Start withdrawal-server Example port: 9003

cd withdrawal-server && sqlx database setup && cargo run -r

6. Start block-builder. Example port: 9004

cd block-builder && cargo run -r

CLI

Please refer to the examples of cli

Reset DB

(cd store-vault-server && sqlx database reset -y && cd ../legacy-store-vault-server && sqlx database reset -y && sqlx database setup && cd ../validity-prover && sqlx database reset -y && sqlx database setup && cd ../withdrawal-server && sqlx database reset -y && sqlx database setup)

When you update the sql queries

cargo sqlx prepare --workspace  -- --all-targets --all-features

Overview

store-vault-server: A server that stores backups of user's local states. It also acts as a mailbox for sending necessary data to a receiver during transfers.

balance-prover: A server that generates client-side ZKPs on behalf of users. This server maintains no state.

validity-prover: A server that generates ZKPs related to onchain information. It collects onchain data and generates corresponding ZKPs.

block-builder: A server that receives transactions from users and generates blocks.

withdrawal-server: A server that receives withdrawal requests from users and writes them to the database.

For Developer

Set-up Local Environment

initial setup for Rust Tools:

rustup component add rustfmt clippy

install lefthook:

brew install lefthook

and initial setup:

lefthook install

install typos-cli:

brew install typos-cli