Skip to content

Latest commit

 

History

History
261 lines (191 loc) · 9.37 KB

deployment-guide.md

File metadata and controls

261 lines (191 loc) · 9.37 KB
Raw

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 on a local network

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

  1. 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.

  2. 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

  3. Build your project:

    cargo build

  4. 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 EvenNumber to 0xe7f1725E7734CE288F8367e1Bb143E90bb3F0512
...

    Save the EvenNumber contract address to an env variable:

    export EVEN_NUMBER_ADDRESS=#COPY EVEN NUMBER ADDRESS FROM DEPLOY LOGS

    You can also use the following command to set the contract address if you have jq installed:

    export EVEN_NUMBER_ADDRESS=$(jq -re '.transactions[] | select(.contractName == "EvenNumber") | .contractAddress' ./broadcast/Deploy.s.sol/31337/run-latest.json)

Interact with your local deployment

  1. Query the state:

    cast call --rpc-url http://localhost:8545 ${EVEN_NUMBER_ADDRESS:?} 'get()(uint256)'

  2. Publish a new state

    cargo run --bin publisher -- \
    --chain-id=31337 \
    --rpc-url=http://localhost:8545 \
    --contract=${EVEN_NUMBER_ADDRESS:?} \
    --input=12345678

  3. Query the state again to see the change:

    cast call --rpc-url http://localhost:8545 ${EVEN_NUMBER_ADDRESS:?} 'get()(uint256)'

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:

  1. 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

  2. Build your project:

    cargo build

  3. 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 EvenNumber to 0xe7f1725E7734CE288F8367e1Bb143E90bb3F0512
...

    Save the EvenNumber contract address to an env variable:

    export EVEN_NUMBER_ADDRESS=#COPY EVEN NUMBER ADDRESS FROM DEPLOY LOGS

    You can also use the following command to set the contract address if you have jq installed:

    export EVEN_NUMBER_ADDRESS=$(jq -re '.transactions[] | select(.contractName == "EvenNumber") | .contractAddress' ./broadcast/Deploy.s.sol/11155111/run-latest.json)

Interact with your Sepolia testnet deployment

  1. Query the state:

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

  2. Publish a new state

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

  3. Query the state again to see the change:

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

Deploy your project on Ethereum mainnet

You can deploy your contract on Ethereum Mainnet as follows:

  1. 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

  2. Build your project:

    cargo build

  3. 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 EvenNumber to 0xe7f1725E7734CE288F8367e1Bb143E90bb3F0512
...

    Save the EvenNumber contract address to an env variable:

    export EVEN_NUMBER_ADDRESS=#COPY EVEN NUMBER ADDRESS FROM DEPLOY LOGS

    You can also use the following command to set the contract address if you have jq installed:

    export EVEN_NUMBER_ADDRESS=$(jq -re '.transactions[] | select(.contractName == "EvenNumber") | .contractAddress' ./broadcast/Deploy.s.sol/1/run-latest.json)

Interact with your Ethereum Mainnet deployment

  1. Query the state:

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

  2. 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 #121 for more details.

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

  3. Query the state again to see the change:

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