edb-engine 0.0.1

EDB's core analysis and instrumentation engine
Documentation 
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

// EDB - Ethereum Debugger
// Copyright (C) 2024 Zhuo Zhang and Wuqi Zhang
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program. If not, see <https://www.gnu.org/licenses/>.

//! Expression evaluation system for EDB.
//!
//! This module provides a comprehensive expression evaluation system that enables
//! real-time evaluation of Solidity-like expressions against debug snapshots.
//! It supports variables, function calls, arithmetic operations, and blockchain context.
//!
//! # Main Components
//!
//! - [`ExpressionEvaluator`] - Main evaluator for parsing and executing expressions
//! - [`handlers`] - Handler traits and implementations for different evaluation contexts
//! - Common types and utilities for expression evaluation
//!
//! # Basic Usage
//!
//! ```rust,ignore
//! use edb_engine::eval::{ExpressionEvaluator, handlers::EdbHandler};
//!
//! // Create evaluator with EDB handlers
//! let handlers = EdbHandler::create_handlers(engine_context);
//! let evaluator = ExpressionEvaluator::new(handlers);
//!
//! // Evaluate expressions
//! let result = evaluator.eval("balances[msg.sender]", snapshot_id)?;
//! let result = evaluator.eval("totalSupply() > 1000000", snapshot_id)?;
//! let result = evaluator.eval("block.timestamp - lastUpdate > 3600", snapshot_id)?;
//! ```
//!
//! # Supported Expressions
//!
//! - **Variables**: `balance`, `owner`, `this`
//! - **Mappings/Arrays**: `balances[addr]`, `users[0]`
//! - **Function Calls**: `balanceOf(user)`, `totalSupply()`
//! - **Member Access**: `token.symbol`, `addr.balance`
//! - **Arithmetic**: `+`, `-`, `*`, `/`, `%`, `**`
//! - **Comparison**: `==`, `!=`, `<`, `<=`, `>`, `>=`
//! - **Logical**: `&&`, `||`, `!`
//! - **Ternary**: `condition ? true_value : false_value`
//! - **Type Casting**: `uint256(value)`, `address(0x123...)`
//! - **Blockchain Context**: `msg.sender`, `msg.value`, `block.number`, `tx.origin`

mod common;
pub use common::*;

mod evaluator;
pub mod handlers;
mod utils;

pub use evaluator::ExpressionEvaluator;