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 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910
use crate::{
evm_circuit::{
execution::ExecutionGadget,
param::{N_BYTES_ACCOUNT_ADDRESS, N_BYTES_GAS},
step::ExecutionState,
util::{
and,
common_gadget::TransferGadget,
constraint_builder::{
ConstrainBuilderCommon, EVMConstraintBuilder, ReversionInfo, StepStateTransition,
Transition::{Delta, To},
},
is_precompiled,
math_gadget::{
ContractCreateGadget, IsEqualWordGadget, IsZeroGadget, IsZeroWordGadget,
RangeCheckGadget,
},
not, rlc,
tx::{BeginTxHelperGadget, TxDataGadget},
AccountAddress, CachedRegion, Cell, StepRws,
},
witness::{Block, Call, Chunk, ExecStep, Transaction},
},
table::{AccountFieldTag, BlockContextFieldTag, CallContextFieldTag, TxContextFieldTag},
util::{
word::{Word32Cell, WordExpr, WordLoHi, WordLoHiCell},
Expr,
},
};
use bus_mapping::{circuit_input_builder::CopyDataType, state_db::CodeDB};
use eth_types::{evm_types::PRECOMPILE_COUNT, keccak256, Field, OpsIdentity, ToWord, U256};
use halo2_proofs::{
circuit::Value,
plonk::{Error, Expression},
};
#[derive(Clone, Debug)]
pub(crate) struct BeginTxGadget<F> {
begin_tx: BeginTxHelperGadget<F>,
tx: TxDataGadget<F>,
tx_caller_address_is_zero: IsZeroWordGadget<F, WordLoHiCell<F>>,
call_callee_address: AccountAddress<F>,
reversion_info: ReversionInfo<F>,
sufficient_gas_left: RangeCheckGadget<F, N_BYTES_GAS>,
transfer_with_gas_fee: TransferGadget<F, true>,
code_hash: WordLoHiCell<F>,
is_empty_code_hash: IsEqualWordGadget<F, WordLoHi<Expression<F>>, WordLoHi<Expression<F>>>,
caller_nonce_hash_bytes: Word32Cell<F>,
calldata_length: Cell<F>,
calldata_length_is_zero: IsZeroGadget<F>,
calldata_rlc: Cell<F>,
create: ContractCreateGadget<F, false>,
callee_not_exists: IsZeroWordGadget<F, WordLoHiCell<F>>,
is_caller_callee_equal: Cell<F>,
// EIP-3651 (Warm COINBASE)
coinbase: WordLoHiCell<F>,
// Caller, callee and a list addresses are added to the access list before
// coinbase, and may be duplicate.
// <https://github.com/ethereum/go-ethereum/blob/604e215d1bb070dff98fb76aa965064c74e3633f/core/state/statedb.go#LL1119C9-L1119C9>
is_coinbase_warm: Cell<F>,
}
impl<F: Field> ExecutionGadget<F> for BeginTxGadget<F> {
const NAME: &'static str = "BeginTx";
const EXECUTION_STATE: ExecutionState = ExecutionState::BeginTx;
fn configure(cb: &mut EVMConstraintBuilder<F>) -> Self {
// Use rw_counter of the step which triggers next call as its call_id.
let call_id = cb.curr.state.rw_counter.clone();
let begin_tx = BeginTxHelperGadget::configure(cb);
let tx_id = begin_tx.tx_id.expr();
let tx = TxDataGadget::configure(cb, tx_id.expr(), false);
let mut reversion_info = cb.reversion_info_write_unchecked(None); // rwc_delta += 2
cb.call_context_lookup_write(
Some(call_id.expr()),
CallContextFieldTag::IsSuccess,
WordLoHi::from_lo_unchecked(reversion_info.is_persistent()),
); // rwc_delta += 1
// Check gas_left is sufficient
let gas_left = tx.gas.expr() - tx.intrinsic_gas();
let sufficient_gas_left = RangeCheckGadget::construct(cb, gas_left.clone());
let tx_caller_address_is_zero = cb.is_zero_word(&tx.caller_address);
cb.require_equal(
"CallerAddress != 0 (not a padding tx)",
tx_caller_address_is_zero.expr(),
false.expr(),
);
let call_callee_address = cb.query_account_address();
cb.condition(not::expr(tx.is_create.expr()), |cb| {
cb.require_equal_word(
"Tx to non-zero address",
tx.callee_address.to_word(),
call_callee_address.to_word(),
);
});
// Increase caller's nonce.
// (tx caller's nonce always increases even tx ends with error)
cb.account_write(
tx.caller_address.to_word(),
AccountFieldTag::Nonce,
WordLoHi::from_lo_unchecked(tx.nonce.expr() + 1.expr()),
WordLoHi::from_lo_unchecked(tx.nonce.expr()),
None,
); // rwc_delta += 1
// Add precompile contract address to access list
for addr in 1..=PRECOMPILE_COUNT {
cb.account_access_list_write_unchecked(
tx_id.expr(),
WordLoHi::new([addr.expr(), 0.expr()]),
1.expr(),
0.expr(),
None,
);
} // rwc_delta += PRECOMPILE_COUNT
// Prepare access list of caller and callee
cb.account_access_list_write_unchecked(
tx_id.expr(),
tx.caller_address.to_word(),
1.expr(),
0.expr(),
None,
); // rwc_delta += 1
let is_caller_callee_equal = cb.query_bool();
cb.account_access_list_write_unchecked(
tx_id.expr(),
tx.callee_address.to_word(),
1.expr(),
// No extra constraint being used here.
// Correctness will be enforced in build_tx_access_list_account_constraints
is_caller_callee_equal.expr(),
None,
); // rwc_delta += 1
// Query coinbase address.
let coinbase = cb.query_word_unchecked();
let is_coinbase_warm = cb.query_bool();
cb.block_lookup(
BlockContextFieldTag::Coinbase.expr(),
None,
coinbase.to_word(),
);
cb.account_access_list_write_unchecked(
tx_id.expr(),
coinbase.to_word(),
1.expr(),
is_coinbase_warm.expr(),
None,
); // rwc_delta += 1
// Read code_hash of callee
let code_hash = cb.query_word_unchecked();
let is_empty_code_hash = cb.is_eq_word(&code_hash.to_word(), &cb.empty_code_hash());
let callee_not_exists = cb.is_zero_word(&code_hash);
// no_callee_code is true when the account exists and has empty
// code hash, or when the account doesn't exist (which we encode with
// code_hash = 0).
let no_callee_code = is_empty_code_hash.expr() + callee_not_exists.expr();
// TODO: And not precompile
// i think this needs to be removed....
cb.account_read(
tx.callee_address.to_word(),
AccountFieldTag::CodeHash,
code_hash.to_word(),
);
// Transfer value from caller to callee, creating account if necessary.
let transfer_with_gas_fee = TransferGadget::construct(
cb,
tx.caller_address.to_word(),
tx.callee_address.to_word(),
not::expr(callee_not_exists.expr()),
tx.is_create.expr(),
tx.value.clone(),
&mut reversion_info,
Some(tx.mul_gas_fee_by_gas.product().clone()),
);
let caller_nonce_hash_bytes = cb.query_word32();
let calldata_length = cb.query_cell();
let calldata_length_is_zero = cb.is_zero(calldata_length.expr());
let calldata_rlc = cb.query_cell_phase2();
let create = ContractCreateGadget::construct(cb);
cb.require_equal_word(
"tx caller address equivalence",
tx.caller_address.to_word(),
create.caller_address(),
);
cb.require_equal(
"tx nonce equivalence",
tx.nonce.expr(),
create.caller_nonce(),
);
// 1. Handle contract creation transaction.
cb.condition(tx.is_create.expr(), |cb| {
cb.require_equal_word(
"call callee address equivalence",
call_callee_address.to_word(),
AccountAddress::<F>::new(
caller_nonce_hash_bytes.limbs[0..N_BYTES_ACCOUNT_ADDRESS]
.to_vec()
.try_into()
.unwrap(),
)
.to_word(),
);
cb.keccak_table_lookup(
create.input_rlc(cb),
create.input_length(),
caller_nonce_hash_bytes.to_word(),
);
cb.tx_context_lookup(
tx_id.expr(),
TxContextFieldTag::CallDataLength,
None,
WordLoHi::from_lo_unchecked(calldata_length.expr()),
);
// If calldata_length > 0 we use the copy circuit to calculate the calldata_rlc for the
// keccack input.
cb.condition(not::expr(calldata_length_is_zero.expr()), |cb| {
cb.copy_table_lookup(
WordLoHi::from_lo_unchecked(tx_id.expr()),
CopyDataType::TxCalldata.expr(),
WordLoHi::zero(),
CopyDataType::RlcAcc.expr(),
0.expr(),
calldata_length.expr(),
0.expr(),
calldata_length.expr(),
calldata_rlc.expr(),
0.expr(),
)
});
// If calldata_length == 0, the copy circuit will not contain any entry, so we skip the
// lookup and instead force calldata_rlc to be 0 for the keccack input.
cb.condition(calldata_length_is_zero.expr(), |cb| {
cb.require_equal("calldata_rlc = 0", calldata_rlc.expr(), 0.expr());
});
cb.keccak_table_lookup(
calldata_rlc.expr(),
calldata_length.expr(),
cb.curr.state.code_hash.to_word(),
);
cb.account_write(
call_callee_address.to_word(),
AccountFieldTag::Nonce,
WordLoHi::one(),
WordLoHi::zero(),
Some(&mut reversion_info),
);
for (field_tag, value) in [
(CallContextFieldTag::Depth, WordLoHi::one()),
(
CallContextFieldTag::CallerAddress,
tx.caller_address.to_word(),
),
(
CallContextFieldTag::CalleeAddress,
call_callee_address.to_word(),
),
(CallContextFieldTag::CallDataOffset, WordLoHi::zero()),
(
CallContextFieldTag::CallDataLength,
WordLoHi::from_lo_unchecked(tx.call_data_length.expr()),
),
(CallContextFieldTag::Value, tx.value.to_word()),
(CallContextFieldTag::IsStatic, WordLoHi::zero()),
(CallContextFieldTag::LastCalleeId, WordLoHi::zero()),
(
CallContextFieldTag::LastCalleeReturnDataOffset,
WordLoHi::zero(),
),
(
CallContextFieldTag::LastCalleeReturnDataLength,
WordLoHi::zero(),
),
(CallContextFieldTag::IsRoot, WordLoHi::one()),
(CallContextFieldTag::IsCreate, WordLoHi::one()),
(
CallContextFieldTag::CodeHash,
cb.curr.state.code_hash.to_word(),
),
] {
cb.call_context_lookup_write(Some(call_id.expr()), field_tag, value);
}
cb.require_step_state_transition(StepStateTransition {
// 21 + a reads and writes:
// - Write CallContext TxId
// - Write CallContext RwCounterEndOfReversion
// - Write CallContext IsPersistent
// - Write CallContext IsSuccess
// - Write Account (Caller) Nonce
// - Write TxAccessListAccount (Precompile) x PRECOMPILE_COUNT
// - Write TxAccessListAccount (Caller)
// - Write TxAccessListAccount (Callee)
// - Write TxAccessListAccount (Coinbase) for EIP-3651
// - a TransferWithGasFeeGadget
// - Write Account (Callee) Nonce (Reversible)
// - Write CallContext Depth
// - Write CallContext CallerAddress
// - Write CallContext CalleeAddress
// - Write CallContext CallDataOffset
// - Write CallContext CallDataLength
// - Write CallContext Value
// - Write CallContext IsStatic
// - Write CallContext LastCalleeId
// - Write CallContext LastCalleeReturnDataOffset
// - Write CallContext LastCalleeReturnDataLength
// - Write CallContext IsRoot
// - Write CallContext IsCreate
// - Write CallContext CodeHash
rw_counter: Delta(
23.expr() + transfer_with_gas_fee.rw_delta() + PRECOMPILE_COUNT.expr(),
),
call_id: To(call_id.expr()),
is_root: To(true.expr()),
is_create: To(tx.is_create.expr()),
code_hash: To(cb.curr.state.code_hash.to_word()),
gas_left: To(gas_left.clone()),
// There are a + 1 reversible writes:
// - a TransferWithGasFeeGadget
// - Callee Account Nonce
reversible_write_counter: To(transfer_with_gas_fee.reversible_w_delta() + 1.expr()),
log_id: To(0.expr()),
..StepStateTransition::new_context()
});
});
// TODO: 2. Handle call to precompiled contracts.
// 3. Call to account with empty code.
cb.condition(
and::expr([not::expr(tx.is_create.expr()), no_callee_code.clone()]),
|cb| {
cb.require_equal(
"Tx to account with empty code should be persistent",
reversion_info.is_persistent(),
1.expr(),
);
cb.require_equal(
"Go to EndTx when Tx to account with empty code",
cb.next.execution_state_selector([ExecutionState::EndTx]),
1.expr(),
);
cb.require_step_state_transition(StepStateTransition {
// 8 reads and writes:
// - Write CallContext TxId
// - Write CallContext RwCounterEndOfReversion
// - Write CallContext IsPersistent
// - Write CallContext IsSuccess
// - Write Account Nonce
// - Write TxAccessListAccount (Precompile) x PRECOMPILE_COUNT
// - Write TxAccessListAccount (Caller)
// - Write TxAccessListAccount (Callee)
// - Write TxAccessListAccount (Coinbase) for EIP-3651
// - Read Account CodeHash
// - a TransferWithGasFeeGadget
rw_counter: Delta(
9.expr() + transfer_with_gas_fee.rw_delta() + PRECOMPILE_COUNT.expr(),
),
call_id: To(call_id.expr()),
..StepStateTransition::any()
});
},
);
// 4. Call to account with non-empty code.
cb.condition(
and::expr([not::expr(tx.is_create.expr()), not::expr(no_callee_code)]),
|cb| {
// Setup first call's context.
for (field_tag, value) in [
(CallContextFieldTag::Depth, WordLoHi::one()),
(
CallContextFieldTag::CallerAddress,
tx.caller_address.to_word(),
),
(
CallContextFieldTag::CalleeAddress,
tx.callee_address.to_word(),
),
(CallContextFieldTag::CallDataOffset, WordLoHi::zero()),
(
CallContextFieldTag::CallDataLength,
WordLoHi::from_lo_unchecked(tx.call_data_length.expr()),
),
(CallContextFieldTag::Value, tx.value.to_word()),
(CallContextFieldTag::IsStatic, WordLoHi::zero()),
(CallContextFieldTag::LastCalleeId, WordLoHi::zero()),
(
CallContextFieldTag::LastCalleeReturnDataOffset,
WordLoHi::zero(),
),
(
CallContextFieldTag::LastCalleeReturnDataLength,
WordLoHi::zero(),
),
(CallContextFieldTag::IsRoot, WordLoHi::one()),
(
CallContextFieldTag::IsCreate,
WordLoHi::from_lo_unchecked(tx.is_create.expr()),
),
(CallContextFieldTag::CodeHash, code_hash.to_word()),
] {
cb.call_context_lookup_write(Some(call_id.expr()), field_tag, value);
}
cb.require_step_state_transition(StepStateTransition {
// 21 reads and writes:
// - Write CallContext TxId
// - Write CallContext RwCounterEndOfReversion
// - Write CallContext IsPersistent
// - Write CallContext IsSuccess
// - Write Account Nonce
// - Write TxAccessListAccount (Precompile) x PRECOMPILE_COUNT
// - Write TxAccessListAccount (Caller)
// - Write TxAccessListAccount (Callee)
// - Write TxAccessListAccount (Coinbase) for EIP-3651
// - Read Account CodeHash
// - a TransferWithGasFeeGadget
// - Write CallContext Depth
// - Write CallContext CallerAddress
// - Write CallContext CalleeAddress
// - Write CallContext CallDataOffset
// - Write CallContext CallDataLength
// - Write CallContext Value
// - Write CallContext IsStatic
// - Write CallContext LastCalleeId
// - Write CallContext LastCalleeReturnDataOffset
// - Write CallContext LastCalleeReturnDataLength
// - Write CallContext IsRoot
// - Write CallContext IsCreate
// - Write CallContext CodeHash
rw_counter: Delta(
22.expr() + transfer_with_gas_fee.rw_delta() + PRECOMPILE_COUNT.expr(),
),
call_id: To(call_id.expr()),
is_root: To(true.expr()),
is_create: To(tx.is_create.expr()),
code_hash: To(code_hash.to_word()),
gas_left: To(gas_left),
reversible_write_counter: To(transfer_with_gas_fee.reversible_w_delta()),
log_id: To(0.expr()),
..StepStateTransition::new_context()
});
},
);
Self {
begin_tx,
tx,
tx_caller_address_is_zero,
call_callee_address,
reversion_info,
sufficient_gas_left,
transfer_with_gas_fee,
code_hash,
is_empty_code_hash,
caller_nonce_hash_bytes,
calldata_length,
calldata_length_is_zero,
calldata_rlc,
create,
callee_not_exists,
is_caller_callee_equal,
coinbase,
is_coinbase_warm,
}
}
fn assign_exec_step(
&self,
region: &mut CachedRegion<'_, '_, F>,
offset: usize,
block: &Block<F>,
_chunk: &Chunk<F>,
tx: &Transaction,
call: &Call,
step: &ExecStep,
) -> Result<(), Error> {
let gas_fee = tx.gas_price * tx.gas();
let zero = eth_types::Word::zero();
let mut rws = StepRws::new(block, step);
rws.offset_add(7);
rws.offset_add(PRECOMPILE_COUNT as usize);
let is_coinbase_warm = rws.next().tx_access_list_value_pair().1;
let mut callee_code_hash = zero;
if !is_precompiled(&tx.to_or_contract_addr()) {
callee_code_hash = rws.next().account_codehash_pair().1;
}
let callee_exists =
is_precompiled(&tx.to_or_contract_addr()) || !callee_code_hash.is_zero();
self.transfer_with_gas_fee.assign(
region,
offset,
&mut rws,
callee_exists,
tx.value,
tx.is_create(),
Some(gas_fee),
)?;
self.begin_tx.assign(region, offset, tx)?;
self.tx.assign(region, offset, tx)?;
self.tx_caller_address_is_zero.assign_u256(
region,
offset,
U256::from_big_endian(&tx.from.to_fixed_bytes()),
)?;
self.call_callee_address
.assign_h160(region, offset, tx.to_or_contract_addr())?;
self.is_caller_callee_equal.assign(
region,
offset,
Value::known(F::from((tx.from == tx.to_or_contract_addr()) as u64)),
)?;
self.reversion_info.assign(
region,
offset,
call.rw_counter_end_of_reversion,
call.is_persistent,
)?;
self.sufficient_gas_left
.assign(region, offset, F::from(tx.gas() - step.gas_cost))?;
self.code_hash
.assign_u256(region, offset, callee_code_hash)?;
self.is_empty_code_hash.assign_u256(
region,
offset,
callee_code_hash,
CodeDB::empty_code_hash().to_word(),
)?;
self.callee_not_exists
.assign_u256(region, offset, callee_code_hash)?;
let untrimmed_contract_addr = {
let mut stream = ethers_core::utils::rlp::RlpStream::new();
stream.begin_list(2);
stream.append(&tx.from);
stream.append(&tx.nonce.to_word());
let rlp_encoding = stream.out().to_vec();
keccak256(&rlp_encoding)
};
self.caller_nonce_hash_bytes.assign_u256(
region,
offset,
U256::from_big_endian(&untrimmed_contract_addr),
)?;
self.calldata_length.assign(
region,
offset,
Value::known(F::from(tx.call_data.len() as u64)),
)?;
self.calldata_length_is_zero
.assign(region, offset, F::from(tx.call_data.len() as u64))?;
let calldata_rlc = region
.challenges()
.keccak_input()
.map(|randomness| rlc::value(tx.call_data.iter().rev(), randomness));
self.calldata_rlc.assign(region, offset, calldata_rlc)?;
self.create.assign(
region,
offset,
tx.from,
tx.nonce.as_u64(),
Some(callee_code_hash),
None,
)?;
self.coinbase
.assign_h160(region, offset, block.context.coinbase)?;
self.is_coinbase_warm.assign(
region,
offset,
Value::known(F::from(is_coinbase_warm as u64)),
)?;
Ok(())
}
}
#[cfg(test)]
mod test {
use crate::{evm_circuit::test::rand_bytes, test_util::CircuitTestBuilder};
use bus_mapping::evm::OpcodeId;
use eth_types::{self, bytecode, evm_types::GasCost, word, Address, Bytecode, Word};
use ethers_core::utils::get_contract_address;
use mock::{eth, gwei, MockTransaction, TestContext, MOCK_ACCOUNTS};
use std::vec;
fn gas(call_data: &[u8]) -> Word {
Word::from(
GasCost::TX
+ 2 * OpcodeId::PUSH32.constant_gas_cost()
+ call_data
.iter()
.map(|&x| if x == 0 { 4 } else { 16 })
.sum::<u64>(),
)
}
fn code_with_return() -> Bytecode {
bytecode! {
PUSH1(0)
PUSH1(0)
RETURN
}
}
fn code_with_revert() -> Bytecode {
bytecode! {
PUSH1(0)
PUSH1(0)
REVERT
}
}
fn test_ok(tx: eth_types::Transaction, code: Option<Bytecode>) {
// Get the execution steps from the external tracer
let ctx = TestContext::<2, 1>::new(
None,
|accs| {
accs[0].address(MOCK_ACCOUNTS[0]).balance(eth(10));
if let Some(code) = code {
accs[0].code(code);
}
accs[1].address(MOCK_ACCOUNTS[1]).balance(eth(10));
},
|mut txs, _accs| {
txs[0]
.to(tx.to.unwrap())
.from(tx.from)
.gas_price(tx.gas_price.unwrap())
.gas(tx.gas)
.input(tx.input)
.value(tx.value);
},
|block, _tx| block.number(0xcafeu64),
)
.unwrap();
CircuitTestBuilder::new_from_test_ctx(ctx).run();
}
fn mock_tx(value: Word, gas_price: Word, calldata: Vec<u8>) -> eth_types::Transaction {
let from = MOCK_ACCOUNTS[1];
let to = MOCK_ACCOUNTS[0];
let mock_transaction = MockTransaction::default()
.from(from)
.to(to)
.value(value)
.gas(gas(&calldata))
.gas_price(gas_price)
.input(calldata.into())
.build();
eth_types::Transaction::from(mock_transaction)
}
#[test]
fn begin_tx_gadget_simple() {
// Transfer 1 ether to account with empty code, successfully
test_ok(mock_tx(eth(1), gwei(2), vec![]), None);
// Transfer 1 ether, successfully
test_ok(mock_tx(eth(1), gwei(2), vec![]), Some(code_with_return()));
// Transfer 1 ether, tx reverts
test_ok(mock_tx(eth(1), gwei(2), vec![]), Some(code_with_revert()));
// Transfer nothing with some calldata
test_ok(
mock_tx(eth(0), gwei(2), vec![1, 2, 3, 4, 0, 0, 0, 0]),
Some(code_with_return()),
);
}
#[test]
fn begin_tx_large_nonce() {
// This test checks that the rw table assignment and evm circuit are consistent
// in not applying an RLC to account and tx nonces.
// https://github.com/privacy-scaling-explorations/zkevm-circuits/issues/592
let multibyte_nonce = 700;
let to = MOCK_ACCOUNTS[0];
let from = MOCK_ACCOUNTS[1];
let code = bytecode! {
STOP
};
let ctx = TestContext::<2, 1>::new(
None,
|accs| {
accs[0].address(to).balance(eth(1)).code(code);
accs[1].address(from).balance(eth(1)).nonce(multibyte_nonce);
},
|mut txs, _| {
txs[0].to(to).from(from);
},
|block, _| block,
)
.unwrap();
CircuitTestBuilder::new_from_test_ctx(ctx).run();
}
#[test]
fn begin_tx_gadget_rand() {
let random_amount = Word::from_little_endian(&rand_bytes(32)) % eth(1);
let random_gas_price = Word::from_little_endian(&rand_bytes(32)) % gwei(2);
// If this test fails, we want these values to appear in the CI logs.
dbg!(random_amount, random_gas_price);
for (value, gas_price, calldata, code) in [
// Transfer random ether to account with empty code, successfully
(random_amount, gwei(2), vec![], None),
// Transfer nothing with random gas_price to account with empty code, successfully
(eth(0), random_gas_price, vec![], None),
// Transfer random ether, successfully
(random_amount, gwei(2), vec![], Some(code_with_return())),
// Transfer nothing with random gas_price, successfully
(eth(0), random_gas_price, vec![], Some(code_with_return())),
// Transfer random ether, tx reverts
(random_amount, gwei(2), vec![], Some(code_with_revert())),
// Transfer nothing with random gas_price, tx reverts
(eth(0), random_gas_price, vec![], Some(code_with_revert())),
] {
test_ok(mock_tx(value, gas_price, calldata), code);
}
}
#[test]
fn begin_tx_no_code() {
let ctx = TestContext::<2, 1>::new(
None,
|accs| {
accs[0].address(MOCK_ACCOUNTS[0]).balance(eth(20));
accs[1].address(MOCK_ACCOUNTS[1]).balance(eth(10));
},
|mut txs, _accs| {
txs[0]
.from(MOCK_ACCOUNTS[0])
.to(MOCK_ACCOUNTS[1])
.gas_price(gwei(2))
.gas(Word::from(0x10000))
.value(eth(2));
},
|block, _tx| block.number(0xcafeu64),
)
.unwrap();
CircuitTestBuilder::new_from_test_ctx(ctx).run();
}
#[test]
fn begin_tx_no_account() {
let ctx = TestContext::<1, 1>::new(
None,
|accs| {
accs[0].address(MOCK_ACCOUNTS[0]).balance(eth(20));
},
|mut txs, _accs| {
txs[0]
.from(MOCK_ACCOUNTS[0])
.to(MOCK_ACCOUNTS[1])
.gas_price(gwei(2))
.gas(Word::from(0x10000))
.value(eth(2));
},
|block, _tx| block.number(0xcafeu64),
)
.unwrap();
CircuitTestBuilder::new_from_test_ctx(ctx).run();
}
fn begin_tx_deploy(nonce: u64) {
let code = bytecode! {
// [ADDRESS, STOP]
PUSH32(word!("3000000000000000000000000000000000000000000000000000000000000000"))
PUSH1(0)
MSTORE
PUSH1(2)
PUSH1(0)
RETURN
};
let ctx = TestContext::<1, 1>::new(
None,
|accs| {
accs[0]
.address(MOCK_ACCOUNTS[0])
.balance(eth(20))
.nonce(nonce);
},
|mut txs, _accs| {
txs[0]
.from(MOCK_ACCOUNTS[0])
.gas_price(gwei(2))
.gas(Word::from(0x10000))
.value(eth(2))
.input(code.into());
},
|block, _tx| block.number(0xcafeu64),
)
.unwrap();
CircuitTestBuilder::new_from_test_ctx(ctx).run();
}
#[test]
fn begin_tx_deploy_nonce_zero() {
begin_tx_deploy(0);
}
#[test]
fn begin_tx_deploy_nonce_small_1byte() {
begin_tx_deploy(1);
begin_tx_deploy(127);
}
#[test]
fn begin_tx_deploy_nonce_big_1byte() {
begin_tx_deploy(128);
begin_tx_deploy(255);
}
#[test]
fn begin_tx_deploy_nonce_2bytes() {
begin_tx_deploy(0x0100u64);
begin_tx_deploy(0x1020u64);
begin_tx_deploy(0xffffu64);
}
#[test]
fn begin_tx_deploy_nonce_3bytes() {
begin_tx_deploy(0x010000u64);
begin_tx_deploy(0x102030u64);
begin_tx_deploy(0xffffffu64);
}
#[test]
fn begin_tx_deploy_nonce_4bytes() {
begin_tx_deploy(0x01000000u64);
begin_tx_deploy(0x10203040u64);
begin_tx_deploy(0xffffffffu64);
}
#[test]
fn begin_tx_deploy_nonce_5bytes() {
begin_tx_deploy(0x0100000000u64);
begin_tx_deploy(0x1020304050u64);
begin_tx_deploy(0xffffffffffu64);
}
#[test]
fn begin_tx_deploy_nonce_6bytes() {
begin_tx_deploy(0x010000000000u64);
begin_tx_deploy(0x102030405060u64);
begin_tx_deploy(0xffffffffffffu64);
}
#[test]
fn begin_tx_deploy_nonce_7bytes() {
begin_tx_deploy(0x01000000000000u64);
begin_tx_deploy(0x10203040506070u64);
begin_tx_deploy(0xffffffffffffffu64);
}
#[test]
fn begin_tx_deploy_nonce_8bytes() {
begin_tx_deploy(0x0100000000000000u64);
begin_tx_deploy(0x1020304050607080u64);
begin_tx_deploy(0xfffffffffffffffeu64);
}
#[test]
fn create_tx_for_existing_account() {
let address = Address::repeat_byte(23);
let nonce = 10;
let new_address = get_contract_address(address, nonce + 1);
let ctx = TestContext::<1, 2>::new(
None,
|accs| {
accs[0].address(address).nonce(nonce).balance(eth(10));
},
|mut txs, _| {
txs[0].from(address).to(new_address).value(eth(2)); // Initialize new_address with some balance and an empty code hash
txs[1].from(address); // Run a CREATE tx on new_address
},
|block, _| block,
)
.unwrap();
CircuitTestBuilder::new_from_test_ctx(ctx).run();
}
}