grassrootseconomics/openethereum
5
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Improve Tracer documentation (#9237)

Browse Source
This commit is contained in:
John-John Tedro 2018-07-30 13:59:01 +02:00 committed by Marek Kotewicz
parent 771ea47d37
commit f9814381a7
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
ethcore/src/trace/mod.rs
View File

@ -49,15 +49,21 @@ pub trait Tracer: Send {
type Output; type Output;
/// Prepares call trace for given params. Noop tracer should return None. /// Prepares call trace for given params. Noop tracer should return None.
///
/// This is called before a call has been executed.
fn prepare_trace_call(&self, params: &ActionParams) -> Option<Call>; fn prepare_trace_call(&self, params: &ActionParams) -> Option<Call>;
/// Prepares create trace for given params. Noop tracer should return None. /// Prepares create trace for given params. Noop tracer should return None.
///
/// This is called before a create has been executed.
fn prepare_trace_create(&self, params: &ActionParams) -> Option<Create>; fn prepare_trace_create(&self, params: &ActionParams) -> Option<Create>;
/// Prepare trace output. Noop tracer should return None. /// Prepare trace output. Noop tracer should return None.
fn prepare_trace_output(&self) -> Option<Bytes>; fn prepare_trace_output(&self) -> Option<Bytes>;
/// Stores trace call info. /// Stores trace call info.
///
/// This is called after a call has completed successfully.
fn trace_call( fn trace_call(
&mut self, &mut self,
call: Option<Call>, call: Option<Call>,
@ -67,6 +73,8 @@ pub trait Tracer: Send {
); );
/// Stores trace create info. /// Stores trace create info.
///
/// This is called after a create has completed successfully.
fn trace_create( fn trace_create(
&mut self, &mut self,
create: Option<Create>, create: Option<Create>,
@ -77,9 +85,13 @@ pub trait Tracer: Send {
); );
/// Stores failed call trace. /// Stores failed call trace.
///
/// This is called after a call has completed erroneously.
fn trace_failed_call(&mut self, call: Option<Call>, subs: Vec<Self::Output>, error: TraceError); fn trace_failed_call(&mut self, call: Option<Call>, subs: Vec<Self::Output>, error: TraceError);
/// Stores failed create trace. /// Stores failed create trace.
///
/// This is called after a create has completed erroneously.
fn trace_failed_create(&mut self, create: Option<Create>, subs: Vec<Self::Output>, error: TraceError); fn trace_failed_create(&mut self, create: Option<Create>, subs: Vec<Self::Output>, error: TraceError);
/// Stores suicide info. /// Stores suicide info.