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 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400
use eth_types::{Field, OpsIdentity};
use gadgets::util::Scalar;
use halo2_proofs::plonk::{Error, Expression, VirtualCells};
use super::{
helpers::{MPTConstraintBuilder, RLPItemView},
param::ARITY,
rlp_gadgets::{RLPItemWitness, RLPListDataGadget},
witness_row::Node,
MPTContext,
};
use crate::{
circuit,
circuit_tools::{
cached_region::CachedRegion,
cell_manager::{Cell, WordLoHiCell},
constraint_builder::RLCChainableRev,
gadgets::LtGadget,
},
mpt_circuit::{
helpers::{nibble_rlc, Indexable, MptCellType, KECCAK},
param::{HASH_WIDTH, RLP_NIL},
MPTConfig, MptMemory, RlpItemType,
},
util::word::WordLoHi,
};
#[derive(Clone, Debug)]
pub(crate) struct BranchState<F> {
pub(crate) key_rlc_post_branch: Expression<F>,
pub(crate) key_mult_post_branch: Expression<F>,
pub(crate) key_rlc_post_drifted: Expression<F>,
pub(crate) key_mult_post_drifted: Expression<F>,
pub(crate) num_nibbles: Expression<F>,
pub(crate) is_key_odd: Expression<F>,
pub(crate) mod_word: [WordLoHi<Expression<F>>; 2],
pub(crate) mod_rlc: [Expression<F>; 2],
}
#[derive(Clone, Debug, Default)]
pub(crate) struct BranchGadget<F> {
rlp_list: [RLPListDataGadget<F>; 2],
is_modified: [Cell<F>; ARITY],
is_drifted: [Cell<F>; ARITY],
mod_word: [WordLoHiCell<F>; 2],
mod_rlc: [Cell<F>; 2],
is_not_hashed: [LtGadget<F, 2>; 2],
// Post branch state
post_state: Option<BranchState<F>>,
}
impl<F: Field> BranchGadget<F> {
#[allow(clippy::too_many_arguments)]
pub fn configure(
meta: &mut VirtualCells<'_, F>,
cb: &mut MPTConstraintBuilder<F>,
ctx: MPTContext<F>,
is_placeholder: &[Cell<F>; 2],
parent_hash: &[WordLoHi<Expression<F>>; 2],
parent_rlc: &[Expression<F>; 2],
is_root: &[Expression<F>; 2],
key_rlc: Expression<F>,
key_mult: Expression<F>,
num_nibbles: Expression<F>,
is_key_odd: Expression<F>,
) -> Self {
let mut config = BranchGadget::default();
circuit!([meta, cb], {
// Data
let children: [RLPItemView<F>; ARITY + 1] =
array_init::array_init(|i| ctx.rlp_item(meta, cb, i, RlpItemType::Node));
let mut num_bytes_left = vec![0.expr(); 2];
let mut node_rlc = vec![0.expr(); 2];
for is_s in [true, false] {
// Read the list
config.rlp_list[is_s.idx()] = RLPListDataGadget::construct(cb);
// Start RLC encoding the RLP data starting with the list RLP bytes
node_rlc[is_s.idx()] = config.rlp_list[is_s.idx()]
.rlp_list
.rlc_rlp_only_rev(&cb.keccak_r)
.0;
// Keep track of how many bytes the branch contains to make sure it's correct.
num_bytes_left[is_s.idx()] = config.rlp_list[is_s.idx()].rlp_list.len();
config.mod_word[is_s.idx()] = cb.query_word_unchecked();
config.mod_rlc[is_s.idx()] = cb.query_cell_with_type(MptCellType::StoragePhase2);
// Check if the branch is hashed or not
config.is_not_hashed[is_s.idx()] = LtGadget::construct(
&mut cb.base,
config.rlp_list[is_s.idx()].rlp_list.num_bytes(),
HASH_WIDTH.expr(),
);
}
let mut modified_index = 0.expr();
let mut drifted_index = 0.expr();
for node_index in 0..ARITY {
config.is_modified[node_index] = cb.base.query_bool();
config.is_drifted[node_index] = cb.base.query_bool();
// Calculate the modified and drifted index from `is_modified`/`is_drifted`
modified_index = modified_index.expr()
+ config.is_modified[node_index].expr() * node_index.expr();
drifted_index =
drifted_index.expr() + config.is_drifted[node_index].expr() * node_index.expr();
}
// Process the branch children
for node_index in 0..ARITY {
for is_s in [true, false] {
// Get the correct child.
// All s children are stored directly in the circuit, but the only modified
// child branch for c is stored in child 0.
let child = &children[node_index + 1];
let mod_child = &children[0];
let (rlc, rlc_mult, num_bytes, length) = if is_s {
(
child.rlc_chain_data().0,
child.rlc_chain_data().1,
child.num_bytes(),
child.len(),
)
} else {
ifx! {config.is_modified[node_index] => {
(mod_child.rlc_chain_data().0, mod_child.rlc_chain_data().1, mod_child.num_bytes(), mod_child.len())
} elsex {
(child.rlc_chain_data().0, child.rlc_chain_data().1, child.num_bytes(), child.len())
}}
};
// Keep track of how many bytes of the list we've processed
num_bytes_left[is_s.idx()] =
num_bytes_left[is_s.idx()].expr() - num_bytes.expr();
// Update the full branch node RLC with the data of this branch
node_rlc[is_s.idx()] = node_rlc[is_s.idx()].rlc_chain_rev((rlc, rlc_mult));
// When in a placeholder branch, both branches are the same - the placeholder
// branch and its parallel counterpart, which is not a
// placeholder, but a regular branch (newly added branch).
// The regular branch has only two non-nil nodes,
// because the placeholder branch appears only when an existing
// leaf drifts down into a newly added branch. Besides an
// existing leaf, we have a leaf that was being added and that caused
// a new branch to be added. So we need to check that there are exactly two
// non-nil nodes (otherwise the attacker could add more
// new leaves at the same time). The non-nil nodes need to be at
// `is_modified` and `is_drifted`, elsewhere there have
// to be zeros.
ifx! {is_placeholder[is_s.idx()] => {
ifx! {or::expr(&[config.is_modified[node_index].expr(), config.is_drifted[node_index].expr()]) => {
require!(length => HASH_WIDTH);
} elsex {
require!(length => 0);
}}
// Make sure that `modified_index != drifted_index`
require!(config.is_modified[node_index].expr() + config.is_drifted[node_index].expr() => bool);
}}
}
}
for is_s in [true, false] {
// Number of bytes left needs to be 1 because ValueNode which occupies 1 byte
require!(num_bytes_left[is_s.idx()] => 1);
// TODO: acc currently doesn't have branch ValueNode info
node_rlc[is_s.idx()] =
node_rlc[is_s.idx()].rlc_chain_rev((RLP_NIL.expr(), cb.keccak_r.expr()));
}
// `is_modified` needs to be set to 1 at exactly 1 branch child
let is_modified_values = (0..ARITY)
.map(|rot| config.is_modified[rot].expr())
.collect::<Vec<_>>();
require!(sum::expr(&is_modified_values) => 1);
// When there's a placeholder, `is_drifted` needs to be set to 1 at exactly 1
// branch child
ifx! {or::expr(&[is_placeholder[true.idx()].expr(), is_placeholder[false.idx()].expr()]) => {
let is_drifted_values = (0..ARITY).map(|rot| config.is_drifted[rot].expr()).collect::<Vec<_>>();
require!(sum::expr(&is_drifted_values) => 1);
}}
// Check if the branch is in its parent
for is_s in [true, false] {
let (rlc, num_bytes, is_not_hashed) = {
(
node_rlc[is_s.idx()].expr(),
config.rlp_list[is_s.idx()].rlp_list.num_bytes(),
config.is_not_hashed[is_s.idx()].expr(),
)
};
ifx! {not!(is_placeholder[is_s.idx()]) => {
ifx!{or::expr(&[is_root[is_s.idx()].expr(), not!(is_not_hashed)]) => {
// Hashed branch hash in parent branch
let hash = &parent_hash[is_s.idx()];
require!((1.expr(), rlc.expr(), num_bytes, hash.lo(), hash.hi()) =>> @KECCAK);
} elsex {
// Non-hashed branch hash in parent branch
require!(rlc => parent_rlc[is_s.idx()].expr());
}}
}}
}
// Update the key RLC and multiplier for the branch nibble.
let (key_rlc_post_branch, key_mult_post_branch) = nibble_rlc(
cb,
key_rlc.expr(),
key_mult.expr(),
is_key_odd.expr(),
modified_index.expr(),
&cb.key_r.expr(),
);
// Also calculate the key RLC and multiplier for the drifted nibble.
let (key_rlc_post_drifted, key_mult_post_drifted) = nibble_rlc(
cb,
key_rlc.expr(),
key_mult.expr(),
is_key_odd.expr(),
drifted_index.expr(),
&cb.key_r.expr(),
);
// Update the nibble counter
let num_nibbles = num_nibbles + 1.expr();
// Update key parity
let is_key_odd = not!(is_key_odd);
// Set the branch we'll take
for is_s in [true, false] {
ifx! {is_placeholder[is_s.idx()] => {
for node_index in 0..ARITY {
ifx!{config.is_drifted[node_index].expr() => {
require!(config.mod_rlc[is_s.idx()] =>
children[node_index + 1].rlc_rlp());
require!(config.mod_word[is_s.idx()] =>
children[node_index + 1].word());
}}
}
} elsex {
if is_s {
for node_index in 0..ARITY {
ifx!{config.is_modified[node_index].expr() => {
require!(config.mod_rlc[is_s.idx()] =>
children[node_index + 1].rlc_rlp());
require!(config.mod_word[is_s.idx()] =>
children[node_index + 1].word());
}}
}
} else {
require!(config.mod_rlc[is_s.idx()] => children[0].rlc_rlp());
require!(config.mod_word[is_s.idx()] => children[0].word());
}
}}
}
// Store the post branch state
config.post_state = Some(BranchState {
key_rlc_post_branch,
key_mult_post_branch,
key_rlc_post_drifted,
key_mult_post_drifted,
num_nibbles,
is_key_odd,
mod_word: [
config.mod_word[true.idx()].expr(),
config.mod_word[false.idx()].expr(),
],
mod_rlc: [
config.mod_rlc[true.idx()].expr(),
config.mod_rlc[false.idx()].expr(),
],
});
});
config
}
pub(crate) fn get_post_state(&self) -> BranchState<F> {
self.post_state.as_ref().unwrap().clone()
}
#[allow(clippy::collapsible_else_if)]
#[allow(clippy::too_many_arguments)]
#[allow(clippy::type_complexity)]
pub(crate) fn assign(
&self,
region: &mut CachedRegion<'_, '_, F>,
_mpt_config: &MPTConfig<F>,
_memory: &mut MptMemory<F>,
offset: usize,
is_placeholder: &[bool; 2],
key_rlc: &mut F,
key_mult: &mut F,
num_nibbles: &mut usize,
is_key_odd: &mut bool,
node: &Node,
rlp_values: &[RLPItemWitness],
) -> Result<(F, F, F, [WordLoHi<F>; 2], [F; 2]), Error> {
let branch = &node.extension_branch.clone().unwrap().branch;
for is_s in [true, false] {
let rlp_list_witness = self.rlp_list[is_s.idx()].assign(
region,
offset,
&branch.list_rlp_bytes[is_s.idx()],
)?;
self.is_not_hashed[is_s.idx()].assign(
region,
offset,
rlp_list_witness.num_bytes().scalar(),
HASH_WIDTH.scalar(),
)?;
}
for node_index in 0..ARITY {
self.is_modified[node_index].assign(
region,
offset,
(node_index == branch.modified_index).scalar(),
)?;
self.is_drifted[node_index].assign(
region,
offset,
(node_index == branch.drifted_index).scalar(),
)?;
}
// one nibble is used for position in branch
*num_nibbles += 1;
// Update key parity
*is_key_odd = !*is_key_odd;
// Update the key RLC and multiplier for the branch nibble.
let (nibble_mult, mult): (F, F) = if *is_key_odd {
// The nibble will be added as the most significant nibble using the same
// multiplier
(16.scalar(), 1.scalar())
} else {
// The nibble will be added as the least significant nibble, the multiplier
// needs to advance
(1.scalar(), region.key_r)
};
let key_rlc_post_branch =
*key_rlc + F::from(branch.modified_index as u64) * nibble_mult * *key_mult;
let key_rlc_post_drifted =
*key_rlc + F::from(branch.drifted_index as u64) * nibble_mult * *key_mult;
let key_mult_post_branch = *key_mult * mult;
// Set the branch we'll take
let mut mod_node_hash_word = [WordLoHi::zero(); 2];
let mut mod_node_hash_rlc = [0.scalar(); 2];
for is_s in [true, false] {
(
mod_node_hash_rlc[is_s.idx()],
mod_node_hash_word[is_s.idx()],
) = if is_placeholder[is_s.idx()] {
(
rlp_values[1 + branch.drifted_index].rlc_rlp_rev(region.keccak_r),
rlp_values[1 + branch.drifted_index].word(),
)
} else {
if is_s {
(
rlp_values[1 + branch.modified_index].rlc_rlp_rev(region.keccak_r),
rlp_values[1 + branch.modified_index].word(),
)
} else {
(
rlp_values[0].rlc_rlp_rev(region.keccak_r),
rlp_values[0].word(),
)
}
};
self.mod_word[is_s.idx()].lo().assign(
region,
offset,
mod_node_hash_word[is_s.idx()].lo(),
)?;
self.mod_word[is_s.idx()].hi().assign(
region,
offset,
mod_node_hash_word[is_s.idx()].hi(),
)?;
self.mod_rlc[is_s.idx()].assign(region, offset, mod_node_hash_rlc[is_s.idx()])?;
}
Ok((
key_rlc_post_branch,
key_rlc_post_drifted,
key_mult_post_branch,
mod_node_hash_word,
mod_node_hash_rlc,
))
}
}