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
// 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.
//! Handling different blockchain specifications.
use std::collections::BTreeMap;
use alloy_primitives::{b256, BlockNumber, BlockTimestamp, ChainId, B256};
use anyhow::bail;
use revm::primitives::SpecId;
use serde::{Deserialize, Serialize};
use sha2::{digest::Output, Digest, Sha256};
/// The condition at which a fork is activated.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum ForkCondition {
/// The fork is activated with a certain block.
Block(BlockNumber),
/// The fork is activated with a specific timestamp.
Timestamp(BlockTimestamp),
}
impl ForkCondition {
/// Returns whether the condition has been met.
#[inline]
pub fn active(&self, block_number: BlockNumber, timestamp: u64) -> bool {
match self {
ForkCondition::Block(block) => *block <= block_number,
ForkCondition::Timestamp(ts) => *ts <= timestamp,
}
}
}
/// Specification of a specific chain.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ChainSpec {
/// Chain identifier.
pub chain_id: ChainId,
/// Map revm specification IDs to their respective activation condition.
pub forks: BTreeMap<SpecId, ForkCondition>,
}
impl Default for ChainSpec {
/// Defaults to Ethereum Chain ID using the latest specification.
#[inline]
fn default() -> Self {
Self::new_single(1, SpecId::LATEST)
}
}
impl ChainSpec {
/// Digest of the default configuration, i.e. `ChainSpec::default().digest()`.
pub const DEFAULT_DIGEST: B256 =
b256!("0e0fe3926625a8ffdd4123ad55bf3a419918885daa2e506df18c0e3d6b6c5009");
/// Creates a new configuration consisting of only one specification ID.
///
/// For example, this can be used to create a [ChainSpec] for an anvil instance:
/// ```rust
/// # use revm::primitives::SpecId;
/// # use risc0_steel::config::ChainSpec;
/// let spec = ChainSpec::new_single(31337, SpecId::CANCUN);
/// ```
pub fn new_single(chain_id: ChainId, spec_id: SpecId) -> Self {
ChainSpec {
chain_id,
forks: BTreeMap::from([(spec_id, ForkCondition::Block(0))]),
}
}
/// Returns the network chain ID.
#[inline]
pub fn chain_id(&self) -> ChainId {
self.chain_id
}
/// Returns the cryptographic digest of the entire network configuration.
#[inline]
pub fn digest(&self) -> B256 {
<[u8; 32]>::from(StructHash::digest::<Sha256>(self)).into()
}
/// Returns the [SpecId] for a given block number and timestamp or an error if not supported.
pub fn active_fork(&self, block_number: BlockNumber, timestamp: u64) -> anyhow::Result<SpecId> {
for (spec_id, fork) in self.forks.iter().rev() {
if fork.active(block_number, timestamp) {
return Ok(*spec_id);
}
}
bail!("no supported fork for block {}", block_number)
}
}
// NOTE: We do not want to make this public, to avoid having multiple traits with the `digest`
// function in the RISC Zero ecosystem of crates.
/// A simple structured hasher.
trait StructHash {
fn digest<D: Digest>(&self) -> Output<D>;
}
impl StructHash for (&SpecId, &ForkCondition) {
/// Computes the cryptographic digest of a fork.
/// The hash is H(SpecID || ForkCondition::name || ForkCondition::value )
fn digest<D: Digest>(&self) -> Output<D> {
let mut hasher = D::new();
hasher.update([*self.0 as u8]);
match self.1 {
ForkCondition::Block(n) => {
hasher.update(b"Block");
hasher.update(n.to_le_bytes());
}
ForkCondition::Timestamp(ts) => {
hasher.update(b"Timestamp");
hasher.update(ts.to_le_bytes());
}
}
hasher.finalize()
}
}
impl StructHash for ChainSpec {
/// Computes the cryptographic digest of a chain spec.
///
/// This is equivalent to the `tagged_struct` structural hashing routines used for RISC Zero
/// data structures:
/// `tagged_struct("ChainSpec(chain_id,forks)", forks.into_vec(), &[chain_id, chain_id >> 32])`
fn digest<D: Digest>(&self) -> Output<D> {
let tag_digest = D::digest(b"ChainSpec(chain_id,forks)");
let mut hasher = D::new();
hasher.update(tag_digest);
// down
self.forks
.iter()
.for_each(|fork| hasher.update(fork.digest::<D>()));
// data
hasher.update(self.chain_id.to_le_bytes());
// down.len() as u16
hasher.update(u16::try_from(self.forks.len()).unwrap().to_le_bytes());
hasher.finalize()
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn active_fork() {
let spec = ChainSpec {
chain_id: 1,
forks: BTreeMap::from([
(SpecId::MERGE, ForkCondition::Block(2)),
(SpecId::CANCUN, ForkCondition::Timestamp(60)),
]),
};
assert!(spec.active_fork(0, 0).is_err());
assert_eq!(spec.active_fork(2, 0).unwrap(), SpecId::MERGE);
assert_eq!(spec.active_fork(u64::MAX, 59).unwrap(), SpecId::MERGE);
assert_eq!(spec.active_fork(0, 60).unwrap(), SpecId::CANCUN);
assert_eq!(
spec.active_fork(u64::MAX, u64::MAX).unwrap(),
SpecId::CANCUN
);
}
#[test]
fn default_digest() {
let exp: [u8; 32] = {
let mut h = Sha256::new();
h.update(Sha256::digest(b"ChainSpec(chain_id,forks)"));
h.update((&SpecId::LATEST, &ForkCondition::Block(0)).digest::<Sha256>());
h.update((1u64 as u32).to_le_bytes());
h.update(((1u64 >> 32) as u32).to_le_bytes());
h.update(1u16.to_le_bytes());
h.finalize().into()
};
assert_eq!(ChainSpec::DEFAULT_DIGEST.0, exp);
assert_eq!(ChainSpec::default().digest().0, exp);
}
}