RISC Zero Ethereum Deployment Guide

Welcome to the RISC Zero Ethereum Deployment guide!

Once you've written your contracts and your methods, and tested your program, you're ready to deploy your contract.

You can either:

Deploy your project to a local network
Deploy to a testnet
Deploy to Ethereum Mainnet

Deploy your project on a local network using our CLI

You can deploy your contracts and run an end-to-end test or demo as follows:

Start a local fork of testnet with anvil by running:
```
anvil --fork-url https://eth-sepolia.g.alchemy.com/v2/${ALCHEMY_API_KEY:?}
```
This will create local copy of sepolia testnet (not a full copy, will only request needed data, not a 12 TB full archive node). Very convinient since we are going to use automata quote verification ecosystem that consists of 10 contracts. Would be huge pain to deploy them every time for local testing. And also it does not work, I tried, something is wrong with their instructions.

Once anvil is started, keep it running in the terminal, and switch to a new terminal.

Set your environment variables (remember, you need other key for testnet):

# Anvil sets up a number of default wallets, and this private key is one of them.
export ETH_WALLET_PRIVATE_KEY=0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80

Build your project:

cargo build

run tests:

cargo test
forge test
python3 cli/test.py

Deploy data feeder contract by running:
```
python3 cli/deploy_feeder.py -n local
```
this contract creates storage contracts on deployment and writes proven data into them
Parse data from binance and create proof:
```
python3 cli/parse_and_prove.py --binance
```
also you can use test quote and prove data on machine without sgx
```
python3 cli/parse_and_prove.py --test-data
```
Deploy data to chain:
```
python3 cli/feed_feeder.py -n local
```

Now You can request data from data feed storage:

python3 cli/request_storage.py --network local --pair ETHBTC --method latestRoundData

or

python3 cli/request_storage.py --network local --pair BTCUSDT --method latestRoundData

Repeat parsing and proving

python3 cli/parse_and_prove.py --binance
python3 cli/feed_feeder.py -n local

Price onchain has changed:

python3 cli/request_storage.py -n local -p BTCUSDT --m latestRoundData

Interact with sepolia contract using our CLI

Set your environment variables (NOT the one from anvil! You need to change this viriable if you worked locally!):

export ALCHEMY_API_KEY="YOUR_ALCHEMY_API_KEY" # the API_KEY provided with an alchemy account
export ETH_WALLET_PRIVATE_KEY="YOUR_WALLET_PRIVATE_KEY" # the private hex-encoded key of your Sepolia testnet wallet

Build your project:
```
cargo build
```
No instruction for deployment because contracts are already deployed

Parse data from binance and prove it:

python3 cli/parse_and_prove.py --binance

publish it to sepolia:
```
python3 cli/feed_feeder.py -n sepolia
```
once proven, data can be reused, you can publish the same data on neon
```
python3 cli/feed_feeder.py -n neon_devnet
```
Now You can request data from data feed storage:
```
python3 cli/request_storage.py --network sepolia --pair BTCUSDT --method latestRoundData
```
list of avaliable pairs is stored in cli/addresses/sepolia

Deploy your project on a local network manually (I don't want to update these docs)

You can deploy your contracts and run an end-to-end test or demo as follows:

Start a local testnet with anvil by running:
```
anvil
```
Once anvil is started, keep it running in the terminal, and switch to a new terminal.

Set your environment variables:

Note: This requires having access to a Bonsai API Key. To request an API key complete the form here. Alternatively you can generate your proofs locally, assuming you have a machine with an x86 architecture and Docker installed. In this case do not export Bonsai related env variables.

# Anvil sets up a number of default wallets, and this private key is one of them.
export ETH_WALLET_PRIVATE_KEY=0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80
export BONSAI_API_KEY="YOUR_API_KEY" # see form linked in the previous section
export BONSAI_API_URL="BONSAI_API_URL" # provided with your api key

Build your project:
```
cargo build
```

Deploy your contract by running:

forge script --rpc-url http://localhost:8545 --broadcast script/Deploy.s.sol

This command should output something similar to:

...
== Logs ==
You are deploying on ChainID 31337
Deployed RiscZeroGroth16Verifier to 0x5FbDB2315678afecb367f032d93F642f64180aa3
Deployed DataFeedFeeder to 0xe7f1725E7734CE288F8367e1Bb143E90bb3F0512
...

Save the DataFeedFeeder contract address to an env variable:

export DATA_FEEDER_ADDRESS=#COPY DATA FEEDER ADDRESS FROM DEPLOY LOGS

You can also use the following command to set the contract address if you have jq installed:
export DATA_FEEDER_ADDRESS=$(jq -re '.transactions[] | select(.contractName == "DataFeedFeeder") | .contractAddress' ./broadcast/Deploy.s.sol/31337/run-latest.json)

Interact with your local deployment

Query the dataFeedStorage address of the ETHBTC pair

cast call --rpc-url http://localhost:8545 ${DATA_FEEDER_ADDRESS:?} 'getPairStorageAddress(string)(address)' 'ETHBTC'

Save the ETHBTC dataFeedStorage address to an env variable

export ETHBTC_FEED_STORAGE_ADDRESS=#COPY ADDRESS FROM QUERY RESPONSE

Publish price data

cargo run --bin publisher -- \
    --chain-id=31337 \
    --rpc-url= \
    --contract=${DATA_FEEDER_ADDRESS:?} \
    --json-path="test_inputs/01.json"

Query the state:
```
cast call --rpc-url http://localhost:8545 ${ETHBTC_FEED_STORAGE_ADDRESS:?} 'latestRoundData()(uint80, uint256, uint256, uint256, uint80)'
```
You will receive 5 numbers: last round Id, answer (price), startedAt(timestamp), updatedAt(same timestamp), answeredInRound (current round Id)

Publish next round of price data

cargo run --bin publisher -- \
    --chain-id=31337 \
    --rpc-url=http://localhost:8545 \
    --contract=${DATA_FEEDER_ADDRESS:?} \
    --json-path="test_inputs/02.json"

Query the state:

cast call --rpc-url http://localhost:8545 ${ETHBTC_FEED_STORAGE_ADDRESS:?} 'latestRoundData()(uint80, uint256, uint256, uint256, uint80)'

Now the numbers will be changed to those specified in test_inputs/02.json

Deploy your project on Sepolia testnet

You can deploy your contracts on the Sepolia testnet and run an end-to-end test or demo as follows:

Get access to Bonsai and an Ethereum node running on Sepolia testnet (in this example, we will be using Alchemy as our Ethereum node provider) and export the following environment variables:

Note: This requires having access to a Bonsai API Key. To request an API key complete the form here. Alternatively you can generate your proofs locally, assuming you have a machine with an x86 architecture and Docker installed. In this case do not export Bonsai related env variables.
```
export BONSAI_API_KEY="YOUR_API_KEY" # see form linked in the previous section
export BONSAI_API_URL="BONSAI_API_URL" # provided with your api key
export ALCHEMY_API_KEY="YOUR_ALCHEMY_API_KEY" # the API_KEY provided with an alchemy account
export ETH_WALLET_PRIVATE_KEY="YOUR_WALLET_PRIVATE_KEY" # the private hex-encoded key of your Sepolia testnet wallet
```
Build your project:
```
cargo build
```

Deploy your contract by running:

forge script script/Deploy.s.sol --rpc-url https://eth-sepolia.g.alchemy.com/v2/${ALCHEMY_API_KEY:?} --broadcast

This command uses the sepolia profile defined in the config file, and should output something similar to:

...
== Logs ==
You are deploying on ChainID 11155111
Deploying using config profile: sepolia
Using IRiscZeroVerifier contract deployed at 0x925d8331ddc0a1F0d96E68CF073DFE1d92b69187
Deployed DataFeedFeeder to 0xe7f1725E7734CE288F8367e1Bb143E90bb3F0512
...

Save the DataFeedFeeder contract address to an env variable:

export DATA_FEEDER_ADDRESS=#COPY DATA FEEDER ADDRESS FROM DEPLOY LOGS

You can also use the following command to set the contract address if you have jq installed:
export DATA_FEEDER_ADDRESS=$(jq -re '.transactions[] | select(.contractName == "DataFeedFeeder") | .contractAddress' ./broadcast/Deploy.s.sol/11155111/run-latest.json)

Interact with your Sepolia testnet deployment

Query the state:

cast call --rpc-url https://eth-sepolia.g.alchemy.com/v2/${ALCHEMY_API_KEY:?} ${DATA_FEEDER_ADDRESS:?} 'get()(uint256, uint256)'

Publish a new state

cargo run --bin publisher -- \
    --chain-id=11155111 \
    --rpc-url=https://eth-sepolia.g.alchemy.com/v2/${ALCHEMY_API_KEY:?} \
    --contract=${DATA_FEEDER_ADDRESS:?} \
    --input=1234 \
    --input=2=5678

Query the state again to see the change:

cast call --rpc-url https://eth-sepolia.g.alchemy.com/v2/${ALCHEMY_API_KEY:?} ${DATA_FEEDER_ADDRESS:?} 'get()(uint256, uint256)'

Deploy your project on Ethereum mainnet

You can deploy your contract on Ethereum Mainnet as follows:

Get access to Bonsai and an Ethereum node running on Mainnet (in this example, we will be using Alchemy as our Ethereum node provider) and export the following environment variables:

Note: This requires having access to a Bonsai API Key. To request an API key complete the form here. Alternatively you can generate your proofs locally, assuming you have a machine with an x86 architecture and Docker installed. In this case do not export Bonsai related env variables.
```
export BONSAI_API_KEY="YOUR_API_KEY" # see form linked in the previous section
export BONSAI_API_URL="BONSAI_API_URL" # provided with your api key
export ALCHEMY_API_KEY="YOUR_ALCHEMY_API_KEY" # the API_KEY provided with an alchemy account
export ETH_WALLET_ADDRESS="YOUR_WALLET_ADDRESS" # the account address you want to use for deployment
```
Build your project:
```
cargo build
```

Deploy your contract by running:

You'll need to pass options to forge script to connect to your deployer wallet. See the Foundry documentation. The example command below configures Forge to use a Ledger hardware wallet.

forge script script/Deploy.s.sol --rpc-url https://eth-mainnet.g.alchemy.com/v2/${ALCHEMY_API_KEY:?} --broadcast --ledger

This command uses the mainnet profile defined in the config file, and should output something similar to:

...
== Logs ==
You are deploying on ChainID 1
Deploying using config profile: mainnet
Using IRiscZeroVerifier contract deployed at 0x8EaB2D97Dfce405A1692a21b3ff3A172d593D319
Deployed DataFeedFeeder to 0xe7f1725E7734CE288F8367e1Bb143E90bb3F0512
...

Save the DataFeedFeeder contract address to an env variable:

export DATA_FEEDER_ADDRESS=#COPY DATA FEEDER ADDRESS FROM DEPLOY LOGS

You can also use the following command to set the contract address if you have jq installed:
export DATA_FEEDER_ADDRESS=$(jq -re '.transactions[] | select(.contractName == "DataFeedFeeder") | .contractAddress' ./broadcast/Deploy.s.sol/1/run-latest.json)

Interact with your Ethereum Mainnet deployment

Query the state:

cast call --rpc-url https://eth-mainnet.g.alchemy.com/v2/${ALCHEMY_API_KEY:?} ${DATA_FEEDER_ADDRESS:?} 'get()(uint256, uint256)'

Publish a new state

NOTE: Currently only a local wallet, provided by the ETH_WALLET_PRIVATE_KEY env var is implemented in the example publisher app. Please see risc0/risc0-foundry-template#121 for more details.

cargo run --bin publisher -- \
    --chain-id=1 \
    --rpc-url=https://eth-mainnet.g.alchemy.com/v2/${ALCHEMY_API_KEY:?} \
    --contract=${DATA_FEEDER_ADDRESS:?} \
    --input=1234 \
    --input=2=5678

Query the state again to see the change:

cast call --rpc-url https://eth-mainnet.g.alchemy.com/v2/${ALCHEMY_API_KEY:?} ${DATA_FEEDER_ADDRESS:?} 'get()(uint256, uint256)'

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

deployment-guide.md

deployment-guide.md

RISC Zero Ethereum Deployment Guide

Deploy your project on a local network using our CLI

Interact with sepolia contract using our CLI

Deploy your project on a local network manually (I don't want to update these docs)

Interact with your local deployment

Deploy your project on Sepolia testnet

Interact with your Sepolia testnet deployment

Deploy your project on Ethereum mainnet

Interact with your Ethereum Mainnet deployment

Files

deployment-guide.md

Latest commit

History

deployment-guide.md

File metadata and controls

RISC Zero Ethereum Deployment Guide

Deploy your project on a local network using our CLI

Interact with sepolia contract using our CLI

Deploy your project on a local network manually (I don't want to update these docs)

Interact with your local deployment

Deploy your project on Sepolia testnet

Interact with your Sepolia testnet deployment

Deploy your project on Ethereum mainnet

Interact with your Ethereum Mainnet deployment