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
use crate::{
evm_circuit::{
execution::ExecutionGadget,
param::{N_BYTES_GAS, N_BYTES_MEMORY_WORD_SIZE, N_BYTES_WORD},
step::ExecutionState,
util::{
common_gadget::RestoreContextGadget,
constraint_builder::{ConstrainBuilderCommon, EVMConstraintBuilder},
math_gadget::{BinaryNumberGadget, ConstantDivisionGadget, LtGadget},
CachedRegion, Cell,
},
},
table::CallContextFieldTag,
witness::{Block, Call, Chunk, ExecStep, Transaction},
};
use bus_mapping::precompile::PrecompileCalls;
use eth_types::{evm_types::GasCost, Field, ToScalar};
use gadgets::util::{sum, Expr};
use halo2_proofs::{circuit::Value, plonk::Error};
#[derive(Clone, Debug)]
pub(crate) struct ErrorOOGPrecompileGadget<F> {
precompile_addr: Cell<F>,
addr_bits: BinaryNumberGadget<F, 4>,
call_data_length: Cell<F>,
// n_pairs: ConstantDivisionGadget<F, N_BYTES_MEMORY_WORD_SIZE>,
n_words: ConstantDivisionGadget<F, N_BYTES_MEMORY_WORD_SIZE>,
required_gas: Cell<F>,
insufficient_gas: LtGadget<F, N_BYTES_GAS>,
restore_context: RestoreContextGadget<F>,
}
impl<F: Field> ExecutionGadget<F> for ErrorOOGPrecompileGadget<F> {
const NAME: &'static str = "ErrorOutOfGasPrecompile";
const EXECUTION_STATE: ExecutionState = ExecutionState::ErrorOutOfGasPrecompile;
fn configure(cb: &mut EVMConstraintBuilder<F>) -> Self {
let required_gas = cb.query_cell();
// read callee_address
let precompile_addr = cb.call_context(None, CallContextFieldTag::CalleeAddress);
let addr_bits = BinaryNumberGadget::construct(cb, precompile_addr.expr());
// read call data length
let call_data_length = cb.call_context(None, CallContextFieldTag::CallDataLength);
// let n_pairs = cb.condition(
// addr_bits.value_equals(PrecompileCalls::Bn128Pairing),
// |cb| {
// ConstantDivisionGadget::construct(
// cb,
// call_data_length.expr(),
// N_BYTES_EC_PAIR as u64,
// )
// },
// );
let n_words = cb.condition(addr_bits.value_equals(PrecompileCalls::Identity), |cb| {
ConstantDivisionGadget::construct(
cb,
call_data_length.expr() + (N_BYTES_WORD - 1).expr(),
N_BYTES_WORD as u64,
)
});
// calculate required gas for precompile
let precompiles_required_gas = [
(
addr_bits.value_equals(PrecompileCalls::Ecrecover),
GasCost::PRECOMPILE_ECRECOVER_BASE.expr(),
),
// addr_bits.value_equals(PrecompileCalls::Sha256),
// addr_bits.value_equals(PrecompileCalls::Ripemd160),
// addr_bits.value_equals(PrecompileCalls::Blake2F),
(
addr_bits.value_equals(PrecompileCalls::Identity),
GasCost::PRECOMPILE_IDENTITY_BASE.expr()
+ n_words.quotient() * GasCost::PRECOMPILE_IDENTITY_PER_WORD.expr(),
),
// modexp is handled in ModExpGadget
// (
// addr_bits.value_equals(PrecompileCalls::Bn128Add),
// GasCost::PRECOMPILE_BN256ADD.expr(),
// ),
// (
// addr_bits.value_equals(PrecompileCalls::Bn128Mul),
// GasCost::PRECOMPILE_BN256MUL.expr(),
// ),
// (
// addr_bits.value_equals(PrecompileCalls::Bn128Pairing),
// GasCost::PRECOMPILE_BN256PAIRING.expr()
// + n_pairs.quotient() * GasCost::PRECOMPILE_BN256PAIRING_PER_PAIR.expr(),
// ),
];
cb.require_equal(
"precompile_addr must belong to precompile calls' set",
sum::expr(
precompiles_required_gas
.iter()
.map(|(cond, _)| cond)
.cloned(),
),
1.expr(),
);
cb.require_equal(
"require_gas == sum(is_precompile[addr] * required_gas[addr])",
required_gas.expr(),
precompiles_required_gas
.iter()
.fold(0.expr(), |acc, (condition, required_gas)| {
acc + condition.expr() * required_gas.expr()
}),
);
// gas_left < required_gas
let insufficient_gas = cb.is_lt(cb.curr.state.gas_left.expr(), required_gas.expr());
cb.require_equal("gas_left < required_gas", insufficient_gas.expr(), 1.expr());
let restore_context = RestoreContextGadget::construct2(
cb,
false.expr(),
cb.curr.state.gas_left.expr(),
0.expr(),
0.expr(), // ReturnDataOffset
0.expr(), // ReturnDataLength
0.expr(),
0.expr(),
);
Self {
precompile_addr,
required_gas,
insufficient_gas,
// n_pairs,
n_words,
addr_bits,
call_data_length,
restore_context,
}
}
fn assign_exec_step(
&self,
region: &mut CachedRegion<'_, '_, F>,
offset: usize,
block: &Block<F>,
_chunk: &Chunk<F>,
_transaction: &Transaction,
call: &Call,
step: &ExecStep,
) -> Result<(), Error> {
// addr_bits
let precompile_addr = call.code_address().unwrap();
self.precompile_addr.assign(
region,
offset,
Value::known(precompile_addr.to_scalar().unwrap()),
)?;
self.addr_bits
.assign(region, offset, precompile_addr.to_fixed_bytes()[19])?;
// call_data_length
self.call_data_length.assign(
region,
offset,
Value::known(F::from(call.call_data_length)),
)?;
// n_pairs
// let n_pairs = call.call_data_length / 192;
// self.n_pairs
// .assign(region, offset, call.call_data_length as u128)?;
// n_words
self.n_words.assign(
region,
offset,
(call.call_data_length + (N_BYTES_WORD as u64) - 1) as u128,
)?;
// required_gas
let precompile_call: PrecompileCalls = precompile_addr.to_fixed_bytes()[19].into();
let required_gas = match precompile_call {
PrecompileCalls::Ecrecover => precompile_call.base_gas_cost(),
// PrecompileCalls::Bn128Pairing => {
// precompile_call.base_gas_cost()
// + n_pairs * GasCost::PRECOMPILE_BN256PAIRING_PER_PAIR
// }
PrecompileCalls::Identity => {
let n_words = (call.call_data_length + 31) / 32;
precompile_call.base_gas_cost() + n_words * GasCost::PRECOMPILE_IDENTITY_PER_WORD
}
// PrecompileCalls::Bn128Add | PrecompileCalls::Bn128Mul => {
// precompile_call.base_gas_cost()
// }
_ => unreachable!(),
};
self.required_gas
.assign(region, offset, Value::known(F::from(required_gas)))?;
// insufficient_gas
self.insufficient_gas.assign(
region,
offset,
F::from(step.gas_left),
F::from(required_gas),
)?;
// restore context
self.restore_context
.assign(region, offset, block, call, step, 2)?;
Ok(())
}
}
#[cfg(test)]
mod test {
use crate::test_util::CircuitTestBuilder;
use bus_mapping::precompile::{PrecompileCallArgs, PrecompileCalls};
use eth_types::{
bytecode,
evm_types::{GasCost, OpcodeId},
word, ToWord,
};
use itertools::Itertools;
use mock::TestContext;
lazy_static::lazy_static! {
static ref TEST_VECTOR: Vec<PrecompileCallArgs> = {
vec![
PrecompileCallArgs {
name: "multi-bytes success (more than 32 bytes)",
setup_code: bytecode! {
// place params in memory
PUSH30(word!("0x0123456789abcdef0f1e2d3c4b5a6978"))
PUSH1(0x00) // place from 0x00 in memory
MSTORE
PUSH30(word!("0xaabbccdd001122331039abcdefefef84"))
PUSH1(0x20) // place from 0x20 in memory
MSTORE
},
// copy 63 bytes from memory addr 0
call_data_offset: 0x00.into(),
call_data_length: 0x3f.into(),
// return only 35 bytes and write from memory addr 72
ret_offset: 0x48.into(),
ret_size: 0x23.into(),
address: PrecompileCalls::Identity.address().to_word(),
gas: (PrecompileCalls::Identity.base_gas_cost()
+ 2 * GasCost::PRECOMPILE_IDENTITY_PER_WORD
- 1).to_word(),
..Default::default()
},
]
};
}
#[test]
fn precompile_oog_test() {
let call_kinds = vec![
OpcodeId::CALL,
OpcodeId::STATICCALL,
OpcodeId::DELEGATECALL,
OpcodeId::CALLCODE,
];
for (test_vector, &call_kind) in TEST_VECTOR.iter().cartesian_product(&call_kinds) {
let bytecode = test_vector.with_call_op(call_kind);
CircuitTestBuilder::new_from_test_ctx(
TestContext::<2, 1>::simple_ctx_with_bytecode(bytecode).unwrap(),
)
.run();
}
}
}