cleanup comments

DreamWuGit · DreamWuGit · commit 56b22a6e0a3f · 2023-12-12T14:41:45.000+08:00
diff --git a/zkevm-circuits/src/evm_circuit/execution/logs.rs b/zkevm-circuits/src/evm_circuit/execution/logs.rs
@@ -207,8 +207,6 @@ impl<F: Field> ExecutionGadget<F> for LogGadget<F> {
         let [memory_start, msize] =
             [step.rw_indices[0], step.rw_indices[1]].map(|idx| block.rws[idx].stack_value());
 
-        //self.mstart_word.assign(region, offset, memory_start)?;
-
         let memory_address = self
             .memory_address
             .assign(region, offset, memory_start, msize)?;
diff --git a/zkevm-circuits/src/evm_circuit/execution/precompiles/ecrecover.rs b/zkevm-circuits/src/evm_circuit/execution/precompiles/ecrecover.rs
@@ -172,11 +172,7 @@ impl<F: Field> ExecutionGadget<F> for EcrecoverGadget<F> {
                     .expect("sig_v is 32 bytes"),
             ),
         );
-        // cb.require_equal(
-        //     "Secp256k1::Fq modulus assigned correctly",
-        //     fq_modulus.expr(),
-        //     cb.word_rlc::<N_BYTES_WORD>(FQ_MODULUS.to_le_bytes().map(|b| b.expr())),
-        // );
+
         cb.require_equal(
             "Secp256k1::Fq modulus assigned correctly",
             cb.word_rlc::<N_BYTES_WORD>(fq_modulus.clone().limbs.map(|cell| cell.expr())),
diff --git a/zkevm-circuits/src/evm_circuit/execution/return_revert.rs b/zkevm-circuits/src/evm_circuit/execution/return_revert.rs
@@ -413,8 +413,6 @@ impl<F: Field> ExecutionGadget<F> for ReturnRevertGadget<F> {
             self.keccak_code_hash.assign_u256(
                 region,
                 offset,
-                //region.word_rlc(U256::from_big_endian(&keccak_code_hash)),
-                //TODO: from_little_endiam
                 U256::from_big_endian(&keccak_code_hash),
             )?;
 
diff --git a/zkevm-circuits/src/evm_circuit/execution/swap.rs b/zkevm-circuits/src/evm_circuit/execution/swap.rs
@@ -32,7 +32,6 @@ impl<F: Field> ExecutionGadget<F> for SwapGadget<F> {
     fn configure(cb: &mut EVMConstraintBuilder<F>) -> Self {
         let opcode = cb.query_cell();
 
-        //let phase2_values = [cb.query_cell_phase2(), cb.query_cell_phase2()];
         let values = [cb.query_word_unchecked(), cb.query_word_unchecked()];
 
         // The stack index we have to peek, deduced from the 'x' value of
diff --git a/zkevm-circuits/src/evm_circuit/step.rs b/zkevm-circuits/src/evm_circuit/step.rs
@@ -84,8 +84,6 @@ pub enum ExecutionState {
     BLOCKCTXU64,  // TIMESTAMP, NUMBER, GASLIMIT
     BLOCKCTXU160, // COINBASE
     BLOCKCTXU256, // BASEFEE, DIFFICULTY (for non-scroll)
-    /// TIMESTAMP, NUMBER, GASLIMIT, COINBASE, DIFFICULTY, BASEFEE
-    // BLOCKCTX,
     #[cfg(feature = "scroll")]
     DIFFICULTY, // DIFFICULTY
     CHAINID,
@@ -282,26 +280,6 @@ impl ExecutionState {
                     vec![OpcodeId::DIFFICULTY, OpcodeId::BASEFEE]
                 }
             }
-            // Self::BLOCKCTX => {
-            //     if cfg!(feature = "scroll") {
-            //         vec![
-            //             OpcodeId::TIMESTAMP,
-            //             OpcodeId::NUMBER,
-            //             OpcodeId::GASLIMIT,
-            //             OpcodeId::COINBASE,
-            //             OpcodeId::DIFFICULTY,
-            //         ]
-            //     } else {
-            //         vec![
-            //             OpcodeId::TIMESTAMP,
-            //             OpcodeId::NUMBER,
-            //             OpcodeId::GASLIMIT,
-            //             OpcodeId::COINBASE,
-            //             OpcodeId::DIFFICULTY,
-            //             OpcodeId::BASEFEE,
-            //         ]
-            //     }
-            // }
             #[cfg(feature = "scroll")]
             Self::DIFFICULTY => vec![OpcodeId::DIFFICULTY],
             Self::CHAINID => vec![OpcodeId::CHAINID],
diff --git a/zkevm-circuits/src/evm_circuit/table.rs b/zkevm-circuits/src/evm_circuit/table.rs
@@ -229,7 +229,7 @@ pub(crate) enum Lookup<F> {
         /// field_tag is Calldata, otherwise should be set to 0.
         index: Expression<F>,
         /// Value of the field.
-        // value: Word<Expression<F>>,
+        // value: Word<Expression<F>>, change to word in stage2
         value: Expression<F>,
     },
     /// Lookup to read-write table, which contains read-write access records of
@@ -457,6 +457,7 @@ impl<F: Field> Lookup<F> {
                 number,
                 value,
             } => {
+                // used in stage2 after block table to word
                 //vec![field_tag.clone(), number.clone(), value.lo(), value.hi()]
                 vec![field_tag.clone(), number.clone(), value.clone()]
             }
diff --git a/zkevm-circuits/src/evm_circuit/util/common_gadget.rs b/zkevm-circuits/src/evm_circuit/util/common_gadget.rs
@@ -1064,7 +1064,6 @@ pub(crate) struct CommonCallGadget<F, MemAddrGadget, const IS_SUCCESS_CALL: bool
     // phase2_callee_code_hash
     pub callee_code_hash: WordCell<F>,
     pub is_empty_code_hash: IsEqualWordGadget<F, WordCell<F>, Word<Expression<F>>>,
-    //pub is_empty_code_hash: IsEqualGadget<F>,
 
     //pub callee_not_exists: IsZeroGadget<F>,
     pub callee_not_exists: IsZeroWordGadget<F, WordCell<F>>,
@@ -1496,7 +1495,6 @@ impl<F: Field> CommonErrorGadget<F> {
     ) -> Self {
         cb.opcode_lookup_rlc(opcode.expr(), push_rlc);
 
-        //let rw_counter_end_of_reversion = cb.query_cell();
         // rw_counter_end_of_reversion just used for read lookup, therefore skip range check
         let rw_counter_end_of_reversion = cb.query_word_unchecked();
 
@@ -1640,9 +1638,7 @@ impl<F: Field, const VALID_BYTES: usize> WordByteCapGadget<F, VALID_BYTES> {
         self.lt_cap.expr()
     }
 
-    // pub(crate) fn original_ref(&self) -> &Word<F> {
-    //     self.word.original.clone()
-    // }
+    // orginal ref of word limbs
     pub(crate) fn original_ref(&self) -> &Word32Cell<F> {
         self.word.original_ref()
     }
diff --git a/zkevm-circuits/src/evm_circuit/util/constraint_builder.rs b/zkevm-circuits/src/evm_circuit/util/constraint_builder.rs
@@ -566,7 +566,6 @@ impl<'a, F: Field> EVMConstraintBuilder<'a, F> {
     // poseidon codehash if enalbe scroll or poseidon-codehash, else keccak_hash.
     pub(crate) fn empty_code_hash(&self) -> Word<Expression<F>> {
         if cfg!(feature = "poseidon-codehash") {
-            //let codehash = POSEIDON_CODE_HASH_EMPTY.to_word().to_scalar().unwrap();
             Word32::new(
                 POSEIDON_CODE_HASH_EMPTY
                     .to_word()
@@ -575,7 +574,6 @@ impl<'a, F: Field> EVMConstraintBuilder<'a, F> {
             )
             .to_word()
         } else {
-            //self.word_rlc((*EMPTY_CODE_HASH_LE).map(|byte| byte.expr()))
             Word32::new(EMPTY_CODE_HASH_LE.map(|byte| byte.expr())).to_word()
         }
     }
@@ -834,7 +832,7 @@ impl<'a, F: Field> EVMConstraintBuilder<'a, F> {
         id: Expression<F>,
         field_tag: TxContextFieldTag,
         index: Option<Expression<F>>,
-        //value: Word<Expression<F>>,
+        //value: Word<Expression<F>>, used in stage2 for tx table to word
         value: Expression<F>,
     ) {
         self.add_lookup(
diff --git a/zkevm-circuits/src/evm_circuit/util/math_gadget/modulo.rs b/zkevm-circuits/src/evm_circuit/util/math_gadget/modulo.rs
@@ -85,12 +85,8 @@ impl<F: Field> ModGadget<F> {
 
         self.k.assign_u256(region, offset, k)?;
         self.a_or_zero.assign_u256(region, offset, a_or_zero)?;
-        //let n_sum = (0..32).fold(0, |acc, idx| acc + n.byte(idx) as u64);
-        //let a_or_zero_sum = (0..32).fold(0, |acc, idx| acc + a_or_zero.byte(idx) as u64);
-        //self.n_is_zero.assign(region, offset, F::from(n_sum))?;
+
         self.n_is_zero.assign(region, offset, word::Word::from(n))?;
-        // self.a_or_is_zero
-        //     .assign(region, offset, F::from(a_or_zero_sum))?;
         self.a_or_is_zero
             .assign(region, offset, word::Word::from(a_or_zero))?;
         self.mul_add_words
diff --git a/zkevm-circuits/src/evm_circuit/util/math_gadget/rlp.rs b/zkevm-circuits/src/evm_circuit/util/math_gadget/rlp.rs
@@ -411,7 +411,6 @@ impl<F: Field, const IS_CREATE2: bool> ContractCreateGadget<F, IS_CREATE2> {
                 + (self.caller_address_rlc(cb) * challenge_power_64)
                 + (self.salt_keccak_rlc(cb) * challenge_power_32)
                 + self.keccak_code_hash_keccak_rlc(cb)
-            //+ self.code_hash_rlc.expr()
         } else {
             // RLC(RLP([caller_address, caller_nonce]))
             let challenge_power_21 = challenges[20].clone();
diff --git a/zkevm-circuits/src/evm_circuit/util/memory_gadget.rs b/zkevm-circuits/src/evm_circuit/util/memory_gadget.rs
@@ -148,10 +148,6 @@ impl<F: Field> MemoryAddressGadget<F> {
         memory_offset: WordCell<F>,
         memory_length: MemoryAddress<F>,
     ) -> Self {
-        // debug_assert_eq!(
-        //     CellType::StoragePhase2,
-        //     cb.curr.cell_manager.columns()[memory_offset.cell_column_index].cell_type
-        // );
         let memory_length_is_zero = IsZeroGadget::construct(cb, sum::expr(&memory_length.limbs));
         let memory_offset_bytes = cb.query_memory_address();
 
diff --git a/zkevm-circuits/src/mpt_circuit.rs b/zkevm-circuits/src/mpt_circuit.rs
@@ -51,7 +51,7 @@ pub struct MptCircuitConfigArgs {
     pub poseidon_table: PoseidonTable,
     /// MptTable
     pub mpt_table: MptTable,
-    // Challenges
+    // Challenges no need after word hi lo
     // pub challenges: Challenges,
 }
 
@@ -71,7 +71,6 @@ impl SubCircuitConfig<Fr> for MptCircuitConfig<Fr> {
         Self::ConfigArgs {
             poseidon_table,
             mpt_table,
-            // challenges,
         }: Self::ConfigArgs,
     ) -> Self {
         let conf = mpt::MptCircuitConfig::configure(meta, &poseidon_table);
@@ -177,7 +176,6 @@ impl Circuit<Fr> for MptCircuit<Fr> {
                 MptCircuitConfigArgs {
                     poseidon_table,
                     mpt_table,
-                    // challenges,
                 },
             )
         };
diff --git a/zkevm-circuits/src/state_circuit.rs b/zkevm-circuits/src/state_circuit.rs
@@ -130,13 +130,6 @@ impl<F: Field> SubCircuitConfig<F> for StateCircuitConfig<F> {
         let id = MpiChip::configure(meta, selector, [rw_table.id], lookups);
         let address = MpiChip::configure(meta, selector, [rw_table.address], lookups);
 
-        // let storage_key = RlcChip::configure(
-        //     meta,
-        //     selector,
-        //     rw_table.storage_key,
-        //     lookups,
-        //     challenges.evm_word(),
-        // );
         let storage_key = MpiChip::configure(
             meta,
             selector,
@@ -179,7 +172,6 @@ impl<F: Field> SubCircuitConfig<F> for StateCircuitConfig<F> {
             storage_key,
             rw_counter,
         };
-        //let power_of_randomness: [Expression<F>; 31] =
         // challenges.evm_word_powers_of_randomness();
         let power_of_randomness: [Expression<F>; 31] = challenges.keccak_powers_of_randomness();
         let lexicographic_ordering = LexicographicOrderingConfig::configure(
@@ -266,15 +258,10 @@ impl<F: Field> StateCircuitConfig<F> {
         );
         let rows_len = rows.len();
 
-        // let mut state_root: Value<F> =
-        //     randomness.map(|randomness| rlc::value(&updates.old_root().to_le_bytes(),
-        // randomness));
         let mut state_root = updates.old_root();
 
         let mut start_state_root: Option<word::Word<AssignedCell<F, F>>> = None;
         let mut end_state_root: Option<word::Word<AssignedCell<F, F>>> = None;
-        //let mut start_state_root: Option<AssignedCell<_, F>> = None;
-        //let mut end_state_root: Option<AssignedCell<_, F>> = None;
         // annotate columns
         self.annotate_circuit_in_region(region);
 
@@ -553,19 +540,6 @@ impl<F: Field> StateCircuitConfig<F> {
 
             // Identify non-existing if both committed value and new value are zero and field tag is
             // CodeHash
-            // let is_non_exist_inputs = randomness.map(|randomness| {
-            //     let (_, committed_value) = updates
-            //         .get(row)
-            //         .map(|u| u.value_assignments(randomness))
-            //         .unwrap_or_default();
-            //     let value = row.value_assignment(randomness);
-            //     [
-            //         F::from(row.field_tag().unwrap_or_default())
-            //             - F::from(AccountFieldTag::CodeHash as u64),
-            //         committed_value,
-            //         value,
-            //     ]
-            // });
             let (committed_value, value) = {
                 let (_, committed_value) = updates
                     .get(row)
@@ -633,9 +607,6 @@ impl<F: Field> StateCircuitConfig<F> {
     ) -> Result<StateCircuitExports<Assigned<F>>, Error> {
         let rows_len = rows.len();
 
-        // let mut state_root =
-        //     randomness.map(|randomness| rlc::value(&updates.old_root().to_le_bytes(),
-        // randomness));
         let mut state_root = updates.old_root();
 
         let mut start_state_root: Option<word::Word<AssignedCell<_, F>>> = None;
@@ -806,7 +777,7 @@ impl<F: Field> StateCircuitConfig<F> {
                                 self.initial_value,
                                 indices.len() - 1,
                             )?;
-
+                            // upstream rename to initial_value, disable for scroll
                             // region.assign_advice(
                             //     || "initial_value",
                             //     column,
diff --git a/zkevm-circuits/src/state_circuit/constraint_builder.rs b/zkevm-circuits/src/state_circuit/constraint_builder.rs
@@ -54,8 +54,6 @@ pub struct Queries<F: Field> {
     pub id: MpiQueries<F, N_LIMBS_ID>,
     pub is_tag_and_id_unchanged: Expression<F>,
     pub address: MpiQueries<F, N_LIMBS_ACCOUNT_ADDRESS>,
-    // upstream storage_key: MpiQueries<F, N_LIMBS_WORD>
-    // check it later if can take upstream way.
     pub storage_key: MpiQueries<F, N_LIMBS_WORD>,
     pub initial_value: word::Word<Expression<F>>,
     pub initial_value_prev: word::Word<Expression<F>>,
diff --git a/zkevm-circuits/src/table.rs b/zkevm-circuits/src/table.rs
@@ -1734,7 +1734,6 @@ impl CopyTable {
         Self {
             q_enable,
             is_first: meta.advice_column(),
-            // id: meta.advice_column_in(SecondPhase),
             id: word::Word::new([meta.advice_column(), meta.advice_column()]),
             tag: BinaryNumberChip::configure(meta, q_enable, None),
             addr: meta.advice_column(),
@@ -1800,7 +1799,6 @@ impl CopyTable {
         let mut reader = CopyThread {
             tag: copy_event.src_type,
             is_rw: copy_event.is_source_rw(),
-            //id: number_or_hash_to_field(&copy_event.src_id, challenges.evm_word()),
             id: number_or_hash_to_word(&copy_event.src_id),
             front_mask: true,
             addr: copy_event.src_addr,
@@ -1814,7 +1812,6 @@ impl CopyTable {
         let mut writer = CopyThread {
             tag: copy_event.dst_type,
             is_rw: copy_event.is_destination_rw(),
-            //id: number_or_hash_to_field(&copy_event.dst_id, challenges.evm_word()),
             id: number_or_hash_to_word(&copy_event.dst_id),
             front_mask: true,
             addr: copy_event.dst_addr,
@@ -1902,15 +1899,9 @@ impl CopyTable {
                 *value_word_bytes = [0; 32];
                 *value_word_prev_bytes = [0; 32];
             }
-            // thread.word_rlc = thread.word_rlc * challenges.evm_word() + value;
-            // thread.word_rlc_prev = if is_read_step {
-            //     thread.word_rlc // Reader does not change the word.
-            // } else {
-            //     thread.word_word_prev * challenges.evm_word() + value_prev
-            // };
+
             let word_index = (step_idx as u64 / 2) % 32;
             value_word_bytes[word_index as usize] = copy_step.value;
-            //println!("word_index {}, value_word_bytes {:?}", word_index, value_word_bytes);
 
             let u256_word = U256::from_big_endian(value_word_bytes);
             thread.value_word = word::Word::from(u256_word).into_value();
@@ -2079,19 +2070,17 @@ impl<F: Field> LookupTable<F> for CopyTable {
         vec![
             meta.query_fixed(self.q_enable, Rotation::cur()),
             meta.query_advice(self.is_first, Rotation::cur()),
-            //meta.query_advice(self.id, Rotation::cur()), // src_id
             meta.query_advice(self.id.lo(), Rotation::cur()), // src_id
             meta.query_advice(self.id.hi(), Rotation::cur()), // src_id
             self.tag.value(Rotation::cur())(meta),            // src_tag
-            //meta.query_advice(self.id, Rotation::next()), // dst_id
             meta.query_advice(self.id.lo(), Rotation::next()), // dst_id
             meta.query_advice(self.id.hi(), Rotation::next()), // dst_id
-            self.tag.value(Rotation::next())(meta),            // dst_tag
-            meta.query_advice(self.addr, Rotation::cur()),     // src_addr
+            self.tag.value(Rotation::next())(meta),           // dst_tag
+            meta.query_advice(self.addr, Rotation::cur()),    // src_addr
             meta.query_advice(self.src_addr_end, Rotation::cur()), // src_addr_end
-            meta.query_advice(self.addr, Rotation::next()),    // dst_addr
+            meta.query_advice(self.addr, Rotation::next()),   // dst_addr
             meta.query_advice(self.real_bytes_left, Rotation::cur()), // real_length
-            meta.query_advice(self.rlc_acc, Rotation::cur()),  // rlc_acc
+            meta.query_advice(self.rlc_acc, Rotation::cur()), // rlc_acc
             meta.query_advice(self.rw_counter, Rotation::cur()), // rw_counter
             meta.query_advice(self.rwc_inc_left, Rotation::cur()), // rwc_inc_left
         ]
diff --git a/zkevm-circuits/src/tx_circuit.rs b/zkevm-circuits/src/tx_circuit.rs
@@ -208,7 +208,6 @@ pub struct TxCircuitConfigArgs<F: Field> {
     pub u8_table: U8Table,
     /// Reusable u16 lookup table,
     pub u16_table: U16Table,
-
     /// Challenges
     pub challenges: crate::util::Challenges<Expression<F>>,
 }
diff --git a/zkevm-circuits/src/util/word.rs b/zkevm-circuits/src/util/word.rs
diff --git a/zkevm-circuits/src/witness/bytecode.rs b/zkevm-circuits/src/witness/bytecode.rs
diff --git a/zkevm-circuits/src/witness/mpt.rs b/zkevm-circuits/src/witness/mpt.rs
