Update geth-utils and bus-mapping to build more witness (privacy-…

…scaling-explorations#292) * feat: update geth-utils and bus-mapping to build more witness * fix: use constant for gas cost and update comments * feat: extend docs in circuit_input_builder.rs Co-authored-by: Eduard S. [email protected] * fix: undo update of TimestampGadget to align with spec
csu638 · Feb 17, 2022 · c221f9b · c221f9b
1 parent 88fa4c8
commit c221f9b
Show file tree

Hide file tree

Showing 77 changed files with 2,659 additions and 1,511 deletions.
diff --git a/bus-mapping/src/circuit_input_builder.rs b/bus-mapping/src/circuit_input_builder.rs
diff --git a/bus-mapping/src/error.rs b/bus-mapping/src/error.rs
@@ -10,8 +10,6 @@ use std::error::Error as StdError;
 pub enum Error {
     /// Serde de/serialization error.
     SerdeError(serde_json::error::Error),
-    /// Error while generating a trace.
-    TracingError,
     /// JSON-RPC related error.
     JSONRpcError(ProviderError),
     /// OpcodeId is not a call type.
@@ -21,9 +19,9 @@ pub enum Error {
     /// Storage key not found in the StateDB
     StorageKeyNotFound(Address, Word),
     /// Unable to figure out error at a [`GethExecStep`]
-    UnexpectedExecStepError(&'static str, Box<GethExecStep>),
+    UnexpectedExecStepError(&'static str, GethExecStep),
     /// Invalid [`GethExecStep`] due to an invalid/unexpected value in it.
-    InvalidGethExecStep(&'static str, Box<GethExecStep>),
+    InvalidGethExecStep(&'static str, GethExecStep),
     /// Eth type related error.
     EthTypeError(eth_types::Error),
 }

diff --git a/bus-mapping/src/evm/opcodes/coinbase.rs b/bus-mapping/src/evm/opcodes/coinbase.rs
@@ -27,8 +27,10 @@ mod coinbase_tests {
         builder.handle_tx(&block.eth_tx, &block.geth_trace).unwrap();
 
         let mut test_builder = block.new_circuit_input_builder();
-        let mut tx = test_builder.new_tx(&block.eth_tx).unwrap();
-        let mut tx_ctx = TransactionContext::new(&block.eth_tx);
+        let mut tx = test_builder
+            .new_tx(&block.eth_tx, !block.geth_trace.failed)
+            .unwrap();
+        let mut tx_ctx = TransactionContext::new(&block.eth_tx, &block.geth_trace).unwrap();
 
         // Generate step corresponding to COINBASE
         let mut step = ExecStep::new(
@@ -43,7 +45,7 @@ mod coinbase_tests {
         state_ref.push_stack_op(
             RW::WRITE,
             StackAddress::from(1024 - 1),
-            block.b_constant.coinbase.to_word(),
+            block.eth_block.author.to_word(),
         );
 
         tx.steps_mut().push(step);

diff --git a/bus-mapping/src/evm/opcodes/dup.rs b/bus-mapping/src/evm/opcodes/dup.rs
@@ -59,8 +59,10 @@ mod dup_tests {
         builder.handle_tx(&block.eth_tx, &block.geth_trace).unwrap();
 
         let mut test_builder = block.new_circuit_input_builder();
-        let mut tx = test_builder.new_tx(&block.eth_tx).unwrap();
-        let mut tx_ctx = TransactionContext::new(&block.eth_tx);
+        let mut tx = test_builder
+            .new_tx(&block.eth_tx, !block.geth_trace.failed)
+            .unwrap();
+        let mut tx_ctx = TransactionContext::new(&block.eth_tx, &block.geth_trace).unwrap();
 
         // Generate steps corresponding to DUP1, DUP3, DUP5
         for (i, word) in [word!("0x3"), word!("0x2"), word!("0x1")]

diff --git a/bus-mapping/src/evm/opcodes/gas.rs b/bus-mapping/src/evm/opcodes/gas.rs
@@ -27,7 +27,7 @@ mod gas_tests {
         mock::BlockData,
         operation::StackAddress,
     };
-    use eth_types::{bytecode, bytecode::Bytecode, Word};
+    use eth_types::{bytecode, bytecode::Bytecode, evm_types::GasCost, Word};
     use mock::new_single_tx_trace_code_at_start;
 
     use super::*;
@@ -39,8 +39,8 @@ mod gas_tests {
         builder.handle_tx(&block.eth_tx, &block.geth_trace)?;
 
         let mut test_builder = block.new_circuit_input_builder();
-        let mut tx = test_builder.new_tx(&block.eth_tx)?;
-        let mut tx_ctx = TransactionContext::new(&block.eth_tx);
+        let mut tx = test_builder.new_tx(&block.eth_tx, !block.geth_trace.failed)?;
+        let mut tx_ctx = TransactionContext::new(&block.eth_tx, &block.geth_trace)?;
 
         let mut step = ExecStep::new(
             &block.geth_trace.struct_logs[0],
@@ -69,7 +69,8 @@ mod gas_tests {
     fn gas_opcode_impl() -> Result<(), Error> {
         const GAS_LIMIT: u64 = 1_000_000;
 
-        const GAS_COST: u64 = OpcodeId::PUSH1.constant_gas_cost().as_u64()
+        const GAS_COST: u64 = GasCost::TX.as_u64()
+            + OpcodeId::PUSH1.constant_gas_cost().as_u64()
             + OpcodeId::PUSH1.constant_gas_cost().as_u64()
             + OpcodeId::GAS.constant_gas_cost().as_u64();
 

diff --git a/bus-mapping/src/evm/opcodes/jump.rs b/bus-mapping/src/evm/opcodes/jump.rs
@@ -61,8 +61,10 @@ mod jump_tests {
         builder.handle_tx(&block.eth_tx, &block.geth_trace).unwrap();
 
         let mut test_builder = block.new_circuit_input_builder();
-        let mut tx = test_builder.new_tx(&block.eth_tx).unwrap();
-        let mut tx_ctx = TransactionContext::new(&block.eth_tx);
+        let mut tx = test_builder
+            .new_tx(&block.eth_tx, !block.geth_trace.failed)
+            .unwrap();
+        let mut tx_ctx = TransactionContext::new(&block.eth_tx, &block.geth_trace).unwrap();
 
         // Generate step corresponding to JUMP
         let mut step = ExecStep::new(

diff --git a/bus-mapping/src/evm/opcodes/jumpi.rs b/bus-mapping/src/evm/opcodes/jumpi.rs
@@ -68,8 +68,10 @@ mod jumpi_tests {
         builder.handle_tx(&block.eth_tx, &block.geth_trace).unwrap();
 
         let mut test_builder = block.new_circuit_input_builder();
-        let mut tx = test_builder.new_tx(&block.eth_tx).unwrap();
-        let mut tx_ctx = TransactionContext::new(&block.eth_tx);
+        let mut tx = test_builder
+            .new_tx(&block.eth_tx, !block.geth_trace.failed)
+            .unwrap();
+        let mut tx_ctx = TransactionContext::new(&block.eth_tx, &block.geth_trace).unwrap();
 
         // Generate step corresponding to JUMP
         let mut step = ExecStep::new(

diff --git a/bus-mapping/src/evm/opcodes/mload.rs b/bus-mapping/src/evm/opcodes/mload.rs
@@ -85,8 +85,10 @@ mod mload_tests {
         builder.handle_tx(&block.eth_tx, &block.geth_trace).unwrap();
 
         let mut test_builder = block.new_circuit_input_builder();
-        let mut tx = test_builder.new_tx(&block.eth_tx).unwrap();
-        let mut tx_ctx = TransactionContext::new(&block.eth_tx);
+        let mut tx = test_builder
+            .new_tx(&block.eth_tx, !block.geth_trace.failed)
+            .unwrap();
+        let mut tx_ctx = TransactionContext::new(&block.eth_tx, &block.geth_trace).unwrap();
 
         // Generate step corresponding to MLOAD
         let mut step = ExecStep::new(

diff --git a/bus-mapping/src/evm/opcodes/msize.rs b/bus-mapping/src/evm/opcodes/msize.rs
@@ -51,8 +51,10 @@ mod msize_tests {
         builder.handle_tx(&block.eth_tx, &block.geth_trace).unwrap();
 
         let mut test_builder = block.new_circuit_input_builder();
-        let mut tx = test_builder.new_tx(&block.eth_tx).unwrap();
-        let mut tx_ctx = TransactionContext::new(&block.eth_tx);
+        let mut tx = test_builder
+            .new_tx(&block.eth_tx, !block.geth_trace.failed)
+            .unwrap();
+        let mut tx_ctx = TransactionContext::new(&block.eth_tx, &block.geth_trace).unwrap();
 
         let mut step = ExecStep::new(
             &block.geth_trace.struct_logs[0],

diff --git a/bus-mapping/src/evm/opcodes/mstore.rs b/bus-mapping/src/evm/opcodes/mstore.rs
@@ -80,8 +80,10 @@ mod mstore_tests {
         builder.handle_tx(&block.eth_tx, &block.geth_trace).unwrap();
 
         let mut test_builder = block.new_circuit_input_builder();
-        let mut tx = test_builder.new_tx(&block.eth_tx).unwrap();
-        let mut tx_ctx = TransactionContext::new(&block.eth_tx);
+        let mut tx = test_builder
+            .new_tx(&block.eth_tx, !block.geth_trace.failed)
+            .unwrap();
+        let mut tx_ctx = TransactionContext::new(&block.eth_tx, &block.geth_trace).unwrap();
 
         // Generate step corresponding to MSTORE
         let mut step = ExecStep::new(
@@ -138,8 +140,10 @@ mod mstore_tests {
         builder.handle_tx(&block.eth_tx, &block.geth_trace).unwrap();
 
         let mut test_builder = block.new_circuit_input_builder();
-        let mut tx = test_builder.new_tx(&block.eth_tx).unwrap();
-        let mut tx_ctx = TransactionContext::new(&block.eth_tx);
+        let mut tx = test_builder
+            .new_tx(&block.eth_tx, !block.geth_trace.failed)
+            .unwrap();
+        let mut tx_ctx = TransactionContext::new(&block.eth_tx, &block.geth_trace).unwrap();
 
         // Generate step corresponding to MSTORE
         let mut step = ExecStep::new(

diff --git a/bus-mapping/src/evm/opcodes/pc.rs b/bus-mapping/src/evm/opcodes/pc.rs
@@ -49,8 +49,10 @@ mod pc_tests {
         builder.handle_tx(&block.eth_tx, &block.geth_trace).unwrap();
 
         let mut test_builder = block.new_circuit_input_builder();
-        let mut tx = test_builder.new_tx(&block.eth_tx).unwrap();
-        let mut tx_ctx = TransactionContext::new(&block.eth_tx);
+        let mut tx = test_builder
+            .new_tx(&block.eth_tx, !block.geth_trace.failed)
+            .unwrap();
+        let mut tx_ctx = TransactionContext::new(&block.eth_tx, &block.geth_trace).unwrap();
 
         // Generate step corresponding to MLOAD
         let mut step = ExecStep::new(

diff --git a/bus-mapping/src/evm/opcodes/pop.rs b/bus-mapping/src/evm/opcodes/pop.rs
@@ -51,8 +51,10 @@ mod pop_tests {
         builder.handle_tx(&block.eth_tx, &block.geth_trace).unwrap();
 
         let mut test_builder = block.new_circuit_input_builder();
-        let mut tx = test_builder.new_tx(&block.eth_tx).unwrap();
-        let mut tx_ctx = TransactionContext::new(&block.eth_tx);
+        let mut tx = test_builder
+            .new_tx(&block.eth_tx, !block.geth_trace.failed)
+            .unwrap();
+        let mut tx_ctx = TransactionContext::new(&block.eth_tx, &block.geth_trace).unwrap();
 
         // Generate step corresponding to POP
         let mut step = ExecStep::new(

diff --git a/bus-mapping/src/evm/opcodes/push.rs b/bus-mapping/src/evm/opcodes/push.rs
@@ -56,8 +56,10 @@ mod push_tests {
         builder.handle_tx(&block.eth_tx, &block.geth_trace).unwrap();
 
         let mut test_builder = block.new_circuit_input_builder();
-        let mut tx = test_builder.new_tx(&block.eth_tx).unwrap();
-        let mut tx_ctx = TransactionContext::new(&block.eth_tx);
+        let mut tx = test_builder
+            .new_tx(&block.eth_tx, !block.geth_trace.failed)
+            .unwrap();
+        let mut tx_ctx = TransactionContext::new(&block.eth_tx, &block.geth_trace).unwrap();
 
         // Generate steps corresponding to PUSH1 80, PUSH2 1234,
         // PUSH16 0x00112233445566778899aabbccddeeff

diff --git a/bus-mapping/src/evm/opcodes/sload.rs b/bus-mapping/src/evm/opcodes/sload.rs
@@ -28,13 +28,15 @@ impl Opcode for Sload {
 
         // Storage read
         let storage_value_read = step.storage.get_or_err(&stack_value_read)?;
-        state.push_op(StorageOp::new(
+        state.push_op(
             RW::READ,
-            state.call().address,
-            stack_value_read,
-            storage_value_read,
-            storage_value_read,
-        ));
+            StorageOp::new(
+                state.call().address,
+                stack_value_read,
+                storage_value_read,
+                storage_value_read,
+            ),
+        );
 
         // First stack write
         state.push_stack_op(RW::WRITE, stack_position, storage_value_read);
@@ -75,8 +77,10 @@ mod sload_tests {
         builder.handle_tx(&block.eth_tx, &block.geth_trace).unwrap();
 
         let mut test_builder = block.new_circuit_input_builder();
-        let mut tx = test_builder.new_tx(&block.eth_tx).unwrap();
-        let mut tx_ctx = TransactionContext::new(&block.eth_tx);
+        let mut tx = test_builder
+            .new_tx(&block.eth_tx, !block.geth_trace.failed)
+            .unwrap();
+        let mut tx_ctx = TransactionContext::new(&block.eth_tx, &block.geth_trace).unwrap();
 
         // Generate step corresponding to SLOAD
         let mut step = ExecStep::new(
@@ -89,13 +93,15 @@ mod sload_tests {
         // Add StackOp associated to the stack pop.
         state_ref.push_stack_op(RW::READ, StackAddress::from(1023), Word::from(0x0u32));
         // Add StorageOp associated to the storage read.
-        state_ref.push_op(StorageOp::new(
+        state_ref.push_op(
             RW::READ,
-            Address::from([0u8; 20]),
-            Word::from(0x0u32),
-            Word::from(0x6fu32),
-            Word::from(0x6fu32),
-        ));
+            StorageOp::new(
+                Address::from([0u8; 20]),
+                Word::from(0x0u32),
+                Word::from(0x6fu32),
+                Word::from(0x6fu32),
+            ),
+        );
         // Add StackOp associated to the stack push.
         state_ref.push_stack_op(RW::WRITE, StackAddress::from(1023), Word::from(0x6fu32));
         tx.steps_mut().push(step);

diff --git a/bus-mapping/src/evm/opcodes/stackonlyop.rs b/bus-mapping/src/evm/opcodes/stackonlyop.rs
@@ -65,8 +65,10 @@ mod stackonlyop_tests {
         builder.handle_tx(&block.eth_tx, &block.geth_trace).unwrap();
 
         let mut test_builder = block.new_circuit_input_builder();
-        let mut tx = test_builder.new_tx(&block.eth_tx).unwrap();
-        let mut tx_ctx = TransactionContext::new(&block.eth_tx);
+        let mut tx = test_builder
+            .new_tx(&block.eth_tx, !block.geth_trace.failed)
+            .unwrap();
+        let mut tx_ctx = TransactionContext::new(&block.eth_tx, &block.geth_trace).unwrap();
 
         // Generate step corresponding to NOT
         let mut step = ExecStep::new(
@@ -125,8 +127,10 @@ mod stackonlyop_tests {
         builder.handle_tx(&block.eth_tx, &block.geth_trace).unwrap();
 
         let mut test_builder = block.new_circuit_input_builder();
-        let mut tx = test_builder.new_tx(&block.eth_tx).unwrap();
-        let mut tx_ctx = TransactionContext::new(&block.eth_tx);
+        let mut tx = test_builder
+            .new_tx(&block.eth_tx, !block.geth_trace.failed)
+            .unwrap();
+        let mut tx_ctx = TransactionContext::new(&block.eth_tx, &block.geth_trace).unwrap();
 
         // Generate step corresponding to ADD
         let mut step = ExecStep::new(
@@ -187,8 +191,10 @@ mod stackonlyop_tests {
         builder.handle_tx(&block.eth_tx, &block.geth_trace).unwrap();
 
         let mut test_builder = block.new_circuit_input_builder();
-        let mut tx = test_builder.new_tx(&block.eth_tx).unwrap();
-        let mut tx_ctx = TransactionContext::new(&block.eth_tx);
+        let mut tx = test_builder
+            .new_tx(&block.eth_tx, !block.geth_trace.failed)
+            .unwrap();
+        let mut tx_ctx = TransactionContext::new(&block.eth_tx, &block.geth_trace).unwrap();
 
         // Generate step corresponding to ADDMOD
         let mut step = ExecStep::new(

diff --git a/bus-mapping/src/evm/opcodes/stop.rs b/bus-mapping/src/evm/opcodes/stop.rs
@@ -14,10 +14,11 @@ pub(crate) struct Stop;
 
 impl Opcode for Stop {
     fn gen_associated_ops(
-        _state: &mut CircuitInputStateRef,
+        state: &mut CircuitInputStateRef,
         _steps: &[GethExecStep],
     ) -> Result<(), Error> {
-        // Stop does not generate any operations
+        state.handle_return()?;
+
         Ok(())
     }
 }
diff --git a/bus-mapping/src/evm/opcodes/swap.rs b/bus-mapping/src/evm/opcodes/swap.rs
@@ -64,8 +64,10 @@ mod swap_tests {
         builder.handle_tx(&block.eth_tx, &block.geth_trace).unwrap();
 
         let mut test_builder = block.new_circuit_input_builder();
-        let mut tx = test_builder.new_tx(&block.eth_tx).unwrap();
-        let mut tx_ctx = TransactionContext::new(&block.eth_tx);
+        let mut tx = test_builder
+            .new_tx(&block.eth_tx, !block.geth_trace.failed)
+            .unwrap();
+        let mut tx_ctx = TransactionContext::new(&block.eth_tx, &block.geth_trace).unwrap();
 
         // Generate steps corresponding to DUP1, DUP3, DUP5
         for (i, (a, b)) in [(6, 5), (5, 3), (3, 1)].iter().enumerate() {

diff --git a/bus-mapping/src/evm/opcodes/timestamp.rs b/bus-mapping/src/evm/opcodes/timestamp.rs
@@ -26,8 +26,10 @@ mod timestamp_tests {
         builder.handle_tx(&block.eth_tx, &block.geth_trace).unwrap();
 
         let mut test_builder = block.new_circuit_input_builder();
-        let mut tx = test_builder.new_tx(&block.eth_tx).unwrap();
-        let mut tx_ctx = TransactionContext::new(&block.eth_tx);
+        let mut tx = test_builder
+            .new_tx(&block.eth_tx, !block.geth_trace.failed)
+            .unwrap();
+        let mut tx_ctx = TransactionContext::new(&block.eth_tx, &block.geth_trace).unwrap();
 
         // Generate step corresponding to TIMESTAMP
         let mut step = ExecStep::new(
@@ -42,7 +44,7 @@ mod timestamp_tests {
         state_ref.push_stack_op(
             RW::WRITE,
             StackAddress::from(1024 - 1),
-            block.b_constant.timestamp,
+            block.eth_block.timestamp,
         );
 
         tx.steps_mut().push(step);

diff --git a/bus-mapping/src/exec_trace.rs b/bus-mapping/src/exec_trace.rs
@@ -6,7 +6,7 @@ use std::fmt;
 #[derive(Clone, Copy, PartialEq, Eq)]
 /// The target and index of an `Operation` in the context of an
 /// `ExecutionTrace`.
-pub struct OperationRef(Target, usize);
+pub struct OperationRef(pub Target, pub usize);
 
 impl fmt::Debug for OperationRef {
     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
@@ -21,6 +21,7 @@ impl fmt::Debug for OperationRef {
                 Target::TxRefund => "TxRefund",
                 Target::Account => "Account",
                 Target::AccountDestructed => "AccountDestructed",
+                Target::CallContext => "CallContext",
             },
             self.1
         ))
@@ -40,6 +41,7 @@ impl From<(Target, usize)> for OperationRef {
             Target::TxRefund => Self(Target::TxRefund, op_ref_data.1),
             Target::Account => Self(Target::Account, op_ref_data.1),
             Target::AccountDestructed => Self(Target::AccountDestructed, op_ref_data.1),
+            Target::CallContext => Self(Target::CallContext, op_ref_data.1),
         }
     }
 }

diff --git a/bus-mapping/src/geth_errors.rs b/bus-mapping/src/geth_errors.rs
@@ -1,12 +1,8 @@
 /// Geth error message for stack overflow
 pub const GETH_ERR_STACK_OVERFLOW: &str = "stack limit reached";
-/// Geth error message for invalid opcode
-pub const GETH_ERR_INVALID_OPCODE: &str = "invalid opcode";
 /// Geth error message for stack underflow
 pub const GETH_ERR_STACK_UNDERFLOW: &str = "stack underflow";
 /// Geth error message for out of gas
 pub const GETH_ERR_OUT_OF_GAS: &str = "out of gas";
 /// Geth error message for gas uint64 overflow
 pub const GETH_ERR_GAS_UINT_OVERFLOW: &str = "gas uint64 overflow";
-/// Geth error message for write protection
-pub const GETH_ERR_WRITE_PROTECTION: &str = "write protection";