mevlog 0.9.3

EVM transactions monitoring and querying CLI/TUI powered by Revm
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
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
use revm::primitives::{Address, FixedBytes, TxKind, U256};
use serde::{Deserialize, Serialize, Serializer, ser::SerializeStruct};

use crate::{
    ChainInfoNoRpcsJson,
    misc::{shared_init::TraceMode, utils::ToU128},
    models::{
        json::{
            mev_log_group_json::MEVLogGroupJson, mev_opcode_json::MEVOpcodeJson,
            mev_state_diff_json::MEVStateDiffJson,
        },
        mev_transaction::{
            CallExtract, MEVTransaction, calculate_create_address, display_token,
            display_token_and_usd, display_usd, eth_to_usd,
        },
    },
};

#[derive(Clone, Serialize, Deserialize, Debug)]
pub struct MEVTransactionJson {
    pub block_number: u64,
    pub signature: String,
    pub signature_hash: Option<String>,
    pub tx_hash: FixedBytes<32>,
    pub index: u64,
    pub from: Address,
    pub from_ens: Option<String>,
    pub to: Option<Address>,
    pub to_ens: Option<String>,
    pub nonce: u64,
    pub value: String,
    pub display_value: String,
    pub coinbase_transfer: Option<String>,
    pub display_coinbase_transfer: Option<String>,
    pub display_coinbase_transfer_usd: Option<String>,
    pub success: bool,
    pub gas_price: u128,
    pub gas_used: u64,
    pub tx_cost: u128,
    pub display_tx_cost: String,
    pub display_tx_cost_usd: Option<String>,
    pub full_tx_cost: Option<u128>,
    pub display_full_tx_cost: Option<String>,
    pub display_full_tx_cost_usd: Option<String>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub evm_calls: Vec<CallExtract>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub logs: Vec<MEVLogGroupJson>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub evm_opcodes: Vec<MEVOpcodeJson>,
    #[serde(default, skip_serializing_if = "MEVStateDiffJson::is_empty")]
    pub evm_state_diff: MEVStateDiffJson,
}

impl From<&MEVTransaction> for MEVTransactionJson {
    fn from(tx: &MEVTransaction) -> Self {
        let logs = tx.log_groups().iter().map(MEVLogGroupJson::from).collect();

        let gas_tx_cost = tx.receipt.gas_used as u128 * tx.receipt.effective_gas_price;
        let full_tx_cost = tx.full_tx_cost().map(|amt| amt.to_u128());

        let to = match tx.to {
            TxKind::Create => Some(calculate_create_address(tx.nonce, tx.from())),
            TxKind::Call(address) => Some(address),
        };

        Self {
            block_number: tx.block_number,
            signature: tx.signature.clone(),
            signature_hash: tx.signature_hash.clone(),
            tx_hash: tx.tx_hash,
            index: tx.index,
            from: tx.from(),
            from_ens: tx.from_ens_name().map(|s| s.to_string()),
            to,
            to_ens: tx.to_ens_name().map(|s| s.to_string()),
            nonce: tx.nonce,
            value: tx.value().to_string(),
            coinbase_transfer: tx.coinbase_transfer.map(|amt| amt.to_string()),
            display_coinbase_transfer: tx
                .coinbase_transfer
                .map(|amt| display_token(amt, &tx.chain.currency_symbol, false)),
            display_coinbase_transfer_usd: tx.coinbase_transfer.and_then(|amt| {
                tx.native_token_price
                    .map(|price| display_usd(eth_to_usd(amt, price)))
            }),
            success: tx.receipt.success,
            gas_price: tx.receipt.effective_gas_price,
            tx_cost: gas_tx_cost,
            display_tx_cost: display_token(
                U256::from(gas_tx_cost),
                &tx.chain.currency_symbol,
                false,
            ),
            display_tx_cost_usd: tx
                .native_token_price
                .map(|price| display_usd(eth_to_usd(U256::from(gas_tx_cost), price))),
            display_value: display_token_and_usd(
                tx.value(),
                tx.native_token_price,
                &tx.chain.currency_symbol,
            ),
            full_tx_cost,
            display_full_tx_cost: full_tx_cost
                .map(|amt| display_token(U256::from(amt), &tx.chain.currency_symbol, false)),
            display_full_tx_cost_usd: full_tx_cost.and_then(|amt| {
                tx.native_token_price
                    .map(|price| display_usd(eth_to_usd(U256::from(amt), price)))
            }),
            gas_used: tx.receipt.gas_used,
            evm_calls: tx.calls.clone().unwrap_or_default(),
            logs,
            evm_opcodes: tx
                .opcodes
                .as_ref()
                .map(|ops| ops.iter().map(MEVOpcodeJson::from).collect())
                .unwrap_or_default(),
            evm_state_diff: tx
                .state_diff
                .as_ref()
                .map(MEVStateDiffJson::from)
                .unwrap_or_default(),
        }
    }
}

#[derive(Clone, Copy)]
pub struct JsonSerializeOpts {
    pub include_logs: bool,
    pub include_evm_calls: bool,
    pub include_evm_opcodes: bool,
    pub include_evm_state_diff: bool,
}

pub struct MEVTransactionJsonOutput<'a> {
    transaction: &'a MEVTransactionJson,
    opts: JsonSerializeOpts,
}

impl Serialize for MEVTransactionJsonOutput<'_> {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        let tx = self.transaction;
        let mut output = serializer.serialize_struct("MEVTransactionJson", 22)?;

        output.serialize_field("block_number", &tx.block_number)?;
        output.serialize_field("signature", &tx.signature)?;
        output.serialize_field("signature_hash", &tx.signature_hash)?;
        output.serialize_field("tx_hash", &tx.tx_hash)?;
        output.serialize_field("index", &tx.index)?;
        output.serialize_field("from", &tx.from)?;
        output.serialize_field("from_ens", &tx.from_ens)?;
        output.serialize_field("to", &tx.to)?;
        output.serialize_field("to_ens", &tx.to_ens)?;
        output.serialize_field("nonce", &tx.nonce)?;
        output.serialize_field("value", &tx.value)?;
        output.serialize_field("display_value", &tx.display_value)?;
        output.serialize_field("coinbase_transfer", &tx.coinbase_transfer)?;
        output.serialize_field("display_coinbase_transfer", &tx.display_coinbase_transfer)?;
        output.serialize_field(
            "display_coinbase_transfer_usd",
            &tx.display_coinbase_transfer_usd,
        )?;
        output.serialize_field("success", &tx.success)?;
        output.serialize_field("gas_price", &tx.gas_price)?;
        output.serialize_field("gas_used", &tx.gas_used)?;
        output.serialize_field("tx_cost", &tx.tx_cost)?;
        output.serialize_field("display_tx_cost", &tx.display_tx_cost)?;
        output.serialize_field("display_tx_cost_usd", &tx.display_tx_cost_usd)?;
        output.serialize_field("full_tx_cost", &tx.full_tx_cost)?;
        output.serialize_field("display_full_tx_cost", &tx.display_full_tx_cost)?;
        output.serialize_field("display_full_tx_cost_usd", &tx.display_full_tx_cost_usd)?;
        if self.opts.include_evm_calls && !tx.evm_calls.is_empty() {
            output.serialize_field("evm_calls", &tx.evm_calls)?;
        }

        if self.opts.include_logs && !tx.logs.is_empty() {
            output.serialize_field("logs", &tx.logs)?;
        }

        if self.opts.include_evm_opcodes && !tx.evm_opcodes.is_empty() {
            output.serialize_field("evm_opcodes", &tx.evm_opcodes)?;
        }
        if self.opts.include_evm_state_diff && !tx.evm_state_diff.is_empty() {
            output.serialize_field("evm_state_diff", &tx.evm_state_diff)?;
        }
        output.end()
    }
}

pub fn serialize_transactions_json(
    transactions: &[MEVTransactionJson],
    opts: JsonSerializeOpts,
    pretty: bool,
) -> serde_json::Result<String> {
    let output: Vec<_> = transactions
        .iter()
        .map(|transaction| MEVTransactionJsonOutput { transaction, opts })
        .collect();

    if pretty {
        serde_json::to_string_pretty(&output)
    } else {
        serde_json::to_string(&output)
    }
}

fn is_false(v: &bool) -> bool {
    !v
}

#[derive(Serialize)]
pub struct SearchQueryParams {
    pub command: &'static str,
    pub blocks: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub limit: Option<usize>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub sort: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub sort_dir: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub from: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub to: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub position: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub touching: Option<String>,
    #[serde(skip_serializing_if = "Vec::is_empty")]
    pub event: Vec<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub not_event: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub method: Option<String>,
    #[serde(skip_serializing_if = "Vec::is_empty")]
    pub calls: Vec<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub tx_cost: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub real_tx_cost: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub gas_price: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub real_gas_price: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub value: Option<String>,
    #[serde(skip_serializing_if = "is_false")]
    pub failed: bool,
    #[serde(skip_serializing_if = "Vec::is_empty")]
    pub erc20_transfer: Vec<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub evm_trace: Option<TraceMode>,
    #[serde(skip_serializing_if = "is_false")]
    pub evm_calls: bool,
    #[serde(skip_serializing_if = "is_false")]
    pub evm_ops: bool,
    #[serde(skip_serializing_if = "is_false")]
    pub evm_state_diff: bool,
}

#[derive(Serialize)]
pub struct TxQueryParams {
    pub command: &'static str,
    pub tx_hash: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub before: Option<u8>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub after: Option<u8>,
    #[serde(skip_serializing_if = "is_false")]
    pub reverse: bool,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub evm_trace: Option<TraceMode>,
    #[serde(skip_serializing_if = "is_false")]
    pub evm_calls: bool,
    #[serde(skip_serializing_if = "is_false")]
    pub evm_ops: bool,
    #[serde(skip_serializing_if = "is_false")]
    pub evm_state_diff: bool,
}

#[derive(Serialize)]
pub struct ResponseEnvelopeJson<'a, Q: Serialize> {
    pub result: Vec<MEVTransactionJsonOutput<'a>>,
    pub result_count: usize,
    pub duration: String,
    pub chain: &'a ChainInfoNoRpcsJson,
    pub query: Q,
}

pub fn format_duration(ns: u64) -> String {
    if ns < 1_000 {
        format!("{} ns", ns)
    } else if ns < 1_000_000 {
        format!("{:.2} µs", ns as f64 / 1_000.0)
    } else if ns < 1_000_000_000 {
        format!("{:.2} ms", ns as f64 / 1_000_000.0)
    } else {
        format!("{:.2} s", ns as f64 / 1_000_000_000.0)
    }
}

pub fn serialize_json_response<Q: Serialize>(
    transactions: &[MEVTransactionJson],
    opts: JsonSerializeOpts,
    pretty: bool,
    chain: &ChainInfoNoRpcsJson,
    duration_ns: u64,
    query: Q,
) -> serde_json::Result<String> {
    let output: Vec<_> = transactions
        .iter()
        .map(|transaction| MEVTransactionJsonOutput { transaction, opts })
        .collect();

    let result_count = output.len();
    let envelope = ResponseEnvelopeJson {
        result: output,
        result_count,
        duration: format_duration(duration_ns),
        chain,
        query,
    };

    if pretty {
        serde_json::to_string_pretty(&envelope)
    } else {
        serde_json::to_string(&envelope)
    }
}

#[cfg(test)]
mod tests {
    use crate::models::json::mev_log_group_json::MEVLogGroupJson;
    use crate::models::json::mev_log_json::MEVLogJson;

    use super::*;

    fn base_fields() -> Vec<&'static str> {
        vec![
            "block_number",
            "signature",
            "signature_hash",
            "tx_hash",
            "index",
            "from",
            "from_ens",
            "to",
            "to_ens",
            "nonce",
            "value",
            "display_value",
            "coinbase_transfer",
            "display_coinbase_transfer",
            "display_coinbase_transfer_usd",
            "success",
            "gas_price",
            "gas_used",
            "tx_cost",
            "display_tx_cost",
            "display_tx_cost_usd",
            "full_tx_cost",
            "display_full_tx_cost",
            "display_full_tx_cost_usd",
        ]
    }

    fn make_tx(with_logs: bool) -> MEVTransactionJson {
        let logs = if with_logs {
            vec![MEVLogGroupJson {
                source: Address::ZERO,
                logs: vec![MEVLogJson {
                    source: Address::ZERO,
                    signature: "Transfer(address,address,uint256)".to_string(),
                    symbol: None,
                    amount: None,
                    topics: vec![],
                    data: "00".to_string(),
                }],
            }]
        } else {
            vec![]
        };

        MEVTransactionJson {
            block_number: 1,
            signature: "test()".to_string(),
            signature_hash: None,
            tx_hash: FixedBytes::ZERO,
            index: 0,
            from: Address::ZERO,
            from_ens: None,
            to: Some(Address::ZERO),
            to_ens: None,
            nonce: 0,
            value: "0".to_string(),
            display_value: "0 ETH".to_string(),
            coinbase_transfer: None,
            display_coinbase_transfer: None,
            display_coinbase_transfer_usd: None,
            success: true,
            gas_price: 0,
            gas_used: 0,
            tx_cost: 0,
            display_tx_cost: "0 ETH".to_string(),
            display_tx_cost_usd: None,
            full_tx_cost: None,
            display_full_tx_cost: None,
            display_full_tx_cost_usd: None,
            evm_calls: vec![],
            logs,
            evm_opcodes: vec![],
            evm_state_diff: MEVStateDiffJson::default(),
        }
    }

    fn get_json_keys(json: &str) -> Vec<String> {
        let arr: Vec<serde_json::Value> = serde_json::from_str(json).unwrap();
        let obj = arr[0].as_object().unwrap();
        obj.keys().cloned().collect()
    }

    fn opts_none() -> JsonSerializeOpts {
        JsonSerializeOpts {
            include_logs: false,
            include_evm_calls: false,
            include_evm_opcodes: false,
            include_evm_state_diff: false,
        }
    }

    fn opts_with_logs() -> JsonSerializeOpts {
        JsonSerializeOpts {
            include_logs: true,
            ..opts_none()
        }
    }

    #[test]
    fn test_include_logs_false_omits_log_groups() {
        let tx = make_tx(true);
        let json = serialize_transactions_json(&[tx], opts_none(), false).unwrap();
        let keys = get_json_keys(&json);

        let expected = base_fields();
        assert_eq!(keys.len(), expected.len());
        for field in &expected {
            assert!(keys.contains(&field.to_string()), "missing field: {field}");
        }
        assert!(!keys.contains(&"logs".to_string()));
    }

    #[test]
    fn test_include_logs_true_includes_log_groups() {
        let tx = make_tx(true);
        let json = serialize_transactions_json(&[tx], opts_with_logs(), false).unwrap();
        let keys = get_json_keys(&json);

        let mut expected = base_fields();
        expected.push("logs");
        assert_eq!(keys.len(), expected.len());
        for field in &expected {
            assert!(keys.contains(&field.to_string()), "missing field: {field}");
        }
    }

    #[test]
    fn test_include_logs_true_empty_logs_omits_log_groups() {
        let tx = make_tx(false);
        let json = serialize_transactions_json(&[tx], opts_with_logs(), false).unwrap();
        let keys = get_json_keys(&json);

        let expected = base_fields();
        assert_eq!(keys.len(), expected.len());
        assert!(!keys.contains(&"logs".to_string()));
    }
}