Skip to content

One command to getting started with ZK execution proofs on Ethereum.

Notifications You must be signed in to change notification settings

sasha-computer/create-steel-app

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 

Repository files navigation

create-steel-app

What does this script do?

The create-steel-app script will allow you to set up the erc20-counter example locally in one command. This example will act as your skeleton project structure for your own application. Once the script is finished, you can run through a test workflow with either local proving or Bonsai proving. You can also read along at Core Concepts of Steel.

Dependencies

Make sure to have the following installed:

  1. Rust
  2. Foundry
  3. cargo-risczero

Usage

sh -c "$(curl -fsSL https://raw.githubusercontent.com/sashaaldrick/create-steel-app/main/create-steel-app)"

The script will automatically detect your current cargo-risczero version and use that for the corresponding version of the erc20-counter example. You also have the manual choice between between two release versions: 1.0 and 1.1.

Once the script is finished running, you should:

cd PROJECT_NAME
cargo build
forge build

After this, you can export the necessary Bonsai environment variables:

export BONSAI_API_KEY="YOUR_API_KEY" 
export BONSAI_API_URL="BONSAI_URL" # provided with your api key

Note: To request an API key complete the form here.

At this point, you will be able to test against a local deployment by running the provided bash script:

./test-local-deployment.sh

About

One command to getting started with ZK execution proofs on Ethereum.

Resources

Stars

Watchers

Forks

Languages