1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238
// Copyright 2025 RISC Zero, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
use crate::{
history::beacon_roots::BeaconRootsContract, state::WrapStateDb, Commitment, EvmBlockHeader,
GuestEvmEnv,
};
use alloy_primitives::U256;
use anyhow::{ensure, Context};
/// Represents a verifier for validating Steel commitments within Steel.
///
/// The verifier is used to validate Steel commitments representing a historical blockchain state.
///
/// ### Usage
/// - **Preflight verification on the Host:** To prepare verification on the host environment and
/// build the necessary proof, use [SteelVerifier::preflight]. The environment can be initialized
/// using the [EthEvmEnv::builder] or [EvmEnv::builder].
/// - **Verification in the Guest:** To initialize the verifier in the guest environment, use
/// [SteelVerifier::new]. The environment should be constructed using [EvmInput::into_env].
///
/// ### Examples
/// ```rust,no_run
/// # use risc0_steel::{ethereum::EthEvmEnv, SteelVerifier, Commitment};
/// # use url::Url;
///
/// # #[tokio::main(flavor = "current_thread")]
/// # async fn main() -> anyhow::Result<()> {
/// // Host:
/// let rpc_url = Url::parse("https://ethereum-rpc.publicnode.com")?;
/// let mut env = EthEvmEnv::builder().rpc(rpc_url).build().await?;
///
/// // Preflight the verification of a commitment
/// let commitment = Commitment::default(); // Your commitment here
/// SteelVerifier::preflight(&mut env).verify(&commitment).await?;
///
/// let evm_input = env.into_input().await?;
///
/// // Guest:
/// let evm_env = evm_input.into_env();
/// let verifier = SteelVerifier::new(&evm_env);
/// verifier.verify(&commitment); // Panics if verification fails
/// # Ok(())
/// # }
/// ```
///
/// [EthEvmEnv::builder]: crate::ethereum::EthEvmEnv
/// [EvmEnv::builder]: crate::EvmEnv
/// [EvmInput::into_env]: crate::EvmInput::into_env
#[stability::unstable(feature = "verifier")]
pub struct SteelVerifier<E> {
env: E,
}
impl<'a, H: EvmBlockHeader> SteelVerifier<&'a GuestEvmEnv<H>> {
/// Constructor for verifying Steel commitments in the guest.
pub fn new(env: &'a GuestEvmEnv<H>) -> Self {
Self { env }
}
/// Verifies the commitment in the guest and panics on failure.
pub fn verify(&self, commitment: &Commitment) {
let (id, version) = commitment.decode_id();
match version {
0 => {
let block_number =
validate_block_number(self.env.header().inner(), id).expect("Invalid id");
let block_hash = self.env.db().block_hash(block_number);
assert_eq!(block_hash, commitment.digest, "Invalid digest");
}
1 => {
let db = WrapStateDb::new(self.env.db(), self.env.header());
let beacon_root = BeaconRootsContract::get_from_db(db, id)
.expect("calling BeaconRootsContract failed");
assert_eq!(beacon_root, commitment.digest, "Invalid digest");
}
v => unimplemented!("Invalid commitment version {}", v),
}
}
}
#[cfg(feature = "host")]
mod host {
use super::*;
use crate::{history::beacon_roots, host::HostEvmEnv};
use anyhow::Context;
use revm::Database;
impl<'a, D, H: EvmBlockHeader, C> SteelVerifier<&'a mut HostEvmEnv<D, H, C>>
where
D: crate::EvmDatabase + Send + 'static,
beacon_roots::Error: From<<D as Database>::Error>,
anyhow::Error: From<<D as Database>::Error>,
<D as Database>::Error: Send + 'static,
{
/// Constructor for preflighting Steel commitment verifications on the host.
///
/// Initializes the environment for verifying Steel commitments, fetching necessary data via
/// RPC, and generating a storage proof for any accessed elements using
/// [EvmEnv::into_input].
///
/// [EvmEnv::into_input]: crate::EvmEnv::into_input
pub fn preflight(env: &'a mut HostEvmEnv<D, H, C>) -> Self {
Self { env }
}
/// Preflights the commitment verification on the host.
pub async fn verify(self, commitment: &Commitment) -> anyhow::Result<()> {
log::info!("Executing preflight verifying {:?}", commitment);
let (id, version) = commitment.decode_id();
match version {
0 => {
let block_number = validate_block_number(self.env.header().inner(), id)
.context("invalid id")?;
let block_hash = self
.env
.spawn_with_db(move |db| db.block_hash(block_number))
.await?;
ensure!(block_hash == commitment.digest, "invalid digest");
Ok(())
}
1 => {
let beacon_root = self
.env
.spawn_with_db(move |db| BeaconRootsContract::get_from_db(db, id))
.await
.with_context(|| format!("calling BeaconRootsContract({}) failed", id))?;
ensure!(beacon_root == commitment.digest, "invalid digest");
Ok(())
}
v => unimplemented!("Invalid commitment version {}", v),
}
}
}
}
fn validate_block_number(header: &impl EvmBlockHeader, block_number: U256) -> anyhow::Result<u64> {
let block_number = block_number.try_into().context("invalid block number")?;
// if block_number > header.number(), this will also be caught in the following `ensure`
let diff = header.number().saturating_sub(block_number);
ensure!(
diff > 0 && diff <= 256,
"valid range is the last 256 blocks (not including the current one)"
);
Ok(block_number)
}
#[cfg(test)]
mod tests {
use super::*;
use crate::{config::ChainSpec, ethereum::EthEvmEnv, CommitmentVersion};
use alloy::{
consensus::BlockHeader,
network::{primitives::HeaderResponse, BlockResponse},
providers::{Provider, ProviderBuilder},
rpc::types::BlockNumberOrTag as AlloyBlockNumberOrTag,
};
use test_log::test;
const EL_URL: &str = "https://ethereum-rpc.publicnode.com";
#[test(tokio::test)]
#[ignore = "queries actual RPC nodes"]
async fn verify_block_commitment() {
let el = ProviderBuilder::new().connect(EL_URL).await.unwrap();
// create block commitment to the previous block
let latest = el.get_block_number().await.unwrap();
let block = el
.get_block_by_number((latest - 1).into())
.await
.expect("eth_getBlockByNumber failed")
.unwrap();
let header = block.header();
let commit = Commitment::new(
CommitmentVersion::Block as u16,
header.number(),
header.hash(),
ChainSpec::DEFAULT_DIGEST,
);
// preflight the verifier
let mut env = EthEvmEnv::builder().provider(el).build().await.unwrap();
SteelVerifier::preflight(&mut env)
.verify(&commit)
.await
.unwrap();
// mock guest execution, by executing the verifier on the GuestEvmEnv
let env = env.into_input().await.unwrap().into_env();
SteelVerifier::new(&env).verify(&commit);
}
#[test(tokio::test)]
#[ignore = "queries actual RPC nodes"]
async fn verify_beacon_commitment() {
let el = ProviderBuilder::new().connect(EL_URL).await.unwrap();
// create Beacon commitment from latest block
let block = el
.get_block_by_number(AlloyBlockNumberOrTag::Latest)
.await
.expect("eth_getBlockByNumber failed")
.unwrap();
let header = block.header();
let commit = Commitment::new(
CommitmentVersion::Beacon as u16,
header.timestamp,
header.parent_beacon_block_root.unwrap(),
ChainSpec::DEFAULT_DIGEST,
);
// preflight the verifier
let mut env = EthEvmEnv::builder().provider(el).build().await.unwrap();
SteelVerifier::preflight(&mut env)
.verify(&commit)
.await
.unwrap();
// mock guest execution, by executing the verifier on the GuestEvmEnv
let env = env.into_input().await.unwrap().into_env();
SteelVerifier::new(&env).verify(&commit);
}
}