hdp 0.9.0

All Herodotus Data Processor
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
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
use super::provider::EvmProvider;
use crate::primitives::processed_types::account::ProcessedAccount;
use crate::primitives::processed_types::block_proofs::{
    convert_to_mmr_with_headers, EvmBlockProofs, ProcessedBlockProofs,
};
use crate::primitives::processed_types::header::ProcessedHeader;
use crate::primitives::processed_types::mmr::MMRMeta;
use crate::primitives::processed_types::mpt::ProcessedMPTProof;
use crate::primitives::processed_types::receipt::ProcessedReceipt;
use crate::primitives::processed_types::storage::ProcessedStorage;
use crate::primitives::processed_types::transaction::ProcessedTransaction;
use crate::provider::error::ProviderError;
use crate::provider::key::{
    CategorizedFetchKeys, EvmAccountKey, EvmBlockReceiptKey, EvmBlockTxKey, EvmHeaderKey,
    EvmStorageKey,
};
use alloy::hex;
use alloy::primitives::{Address, BlockNumber, Bytes, TxIndex, B256};
use alloy::transports::{RpcError, TransportErrorKind};
use eth_trie_proofs::tx_receipt_trie::TxReceiptsMptHandler;
use eth_trie_proofs::tx_trie::TxsMptHandler;
use eth_trie_proofs::EthTrieError;
use std::collections::{HashMap, HashSet};
use std::time::Instant;
use tracing::info;

impl EvmProvider {
    /// This is the public entry point of provider.
    pub async fn fetch_proofs_from_keys(
        &self,
        fetch_keys: CategorizedFetchKeys,
    ) -> Result<ProcessedBlockProofs, ProviderError> {
        let chain_id = self.header_provider.from_chain_id.to_numeric_id();
        // fetch proofs using keys and construct result
        let mmr_with_headers = self.get_headers_from_keys(fetch_keys.evm_headers).await?;
        let mut accounts = if fetch_keys.evm_accounts.is_empty() {
            HashSet::new()
        } else {
            self.get_accounts_from_keys(fetch_keys.evm_accounts).await?
        };
        let (accounts_from_storage_key, storages) = if fetch_keys.evm_storages.is_empty() {
            (HashSet::new(), HashSet::new())
        } else {
            self.get_storages_from_keys(fetch_keys.evm_storages).await?
        };
        let transactions = if fetch_keys.evm_txs.is_empty() {
            vec![]
        } else {
            self.get_txs_from_keys(fetch_keys.evm_txs).await?
        };
        let transaction_receipts = if fetch_keys.evm_receipts.is_empty() {
            vec![]
        } else {
            self.get_tx_receipts_from_keys(fetch_keys.evm_receipts)
                .await?
        };
        accounts.extend(accounts_from_storage_key);
        let accounts_result: Vec<ProcessedAccount> = accounts.into_iter().collect();
        Ok(ProcessedBlockProofs::Evm(EvmBlockProofs {
            chain_id: format!("0x{}", hex::encode(chain_id.to_be_bytes())),
            mmr_with_headers: convert_to_mmr_with_headers(mmr_with_headers),
            accounts: accounts_result,
            storages: storages.into_iter().collect(),
            transactions,
            transaction_receipts,
        }))
    }

    async fn get_headers_from_keys(
        &self,
        keys: HashSet<EvmHeaderKey>,
    ) -> Result<HashMap<MMRMeta, HashSet<ProcessedHeader>>, ProviderError> {
        let start_fetch = Instant::now();

        let block_range = keys.iter().map(|x| x.block_number).collect::<Vec<_>>();
        if block_range.is_empty() {
            return Err(ProviderError::FetchKeyError(
                "Block range is empty".to_string(),
            ));
        }
        let target_blocks_batch: Vec<Vec<BlockNumber>> = if block_range.len() == 1 {
            vec![block_range]
        } else {
            self._chunk_vec_blocks_for_indexer(block_range)
        };

        // let chain_id = keys.iter().next().unwrap().chain_id;
        let mut fetched_headers_proofs: HashMap<MMRMeta, HashSet<ProcessedHeader>> = HashMap::new();

        let real_target_blocks = keys.iter().map(|x| x.block_number).collect::<HashSet<_>>();
        for target_blocks in target_blocks_batch {
            let (start_block, end_block) =
                (target_blocks[0], target_blocks[target_blocks.len() - 1]);

            let indexer_response = self
                .header_provider
                .get_headers_proof(start_block, end_block)
                .await?;

            // filter only the keys that are in the real target blocks and create ProcessedHeaders
            let keys_in_real_target_blocks: Vec<ProcessedHeader> = indexer_response
                .headers
                .into_iter()
                .filter(|(block_number, _)| real_target_blocks.contains(block_number))
                .map(|(_, header_proof)| {
                    ProcessedHeader::new(
                        header_proof.block_header.get_evm_block_header(),
                        header_proof.element_index,
                        header_proof.siblings_hashes,
                    )
                })
                .collect();

            let fetched_mmr = indexer_response.mmr_meta;
            let mmr_meta = MMRMeta::from_indexer(fetched_mmr);
            fetched_headers_proofs
                .entry(mmr_meta)
                .and_modify(|existing_headers| {
                    existing_headers.extend(keys_in_real_target_blocks.iter().cloned());
                })
                .or_insert_with(|| keys_in_real_target_blocks.into_iter().collect());
        }

        let duration = start_fetch.elapsed();
        info!("time taken (Headers Proofs Fetch): {:?}", duration);

        if !fetched_headers_proofs.is_empty() {
            Ok(fetched_headers_proofs)
        } else {
            Err(ProviderError::MmrNotFound)
        }
    }

    async fn get_accounts_from_keys(
        &self,
        keys: HashSet<EvmAccountKey>,
    ) -> Result<HashSet<ProcessedAccount>, ProviderError> {
        let mut fetched_accounts_proofs: HashSet<ProcessedAccount> = HashSet::new();
        let start_fetch = Instant::now();

        // group by address
        let mut address_to_block_range: HashMap<Address, Vec<BlockNumber>> = HashMap::new();
        for key in keys {
            let block_range = address_to_block_range.entry(key.address).or_default();
            block_range.push(key.block_number);
        }

        // loop through each address and fetch storages
        for (address, block_range) in address_to_block_range {
            if block_range.is_empty() {
                return Err(ProviderError::FetchKeyError(
                    "Block range is empty".to_string(),
                ));
            }
            let target_blocks_batch: Vec<Vec<BlockNumber>> = if block_range.len() == 1 {
                vec![block_range]
            } else {
                self._chunk_vec_blocks_for_mpt(block_range)
            };

            let mut account_mpt_proofs: Vec<ProcessedMPTProof> = vec![];
            for target_blocks in target_blocks_batch {
                let account_proofs = self
                    .rpc_provider
                    .get_account_proofs(target_blocks.clone(), address)
                    .await?;

                for block in target_blocks {
                    let account_proof = account_proofs
                        .get(&block)
                        .expect("Target block's account proof had not fetched as response")
                        .clone();
                    let account_proof = ProcessedMPTProof::new(block, account_proof.account_proof);
                    account_mpt_proofs.push(account_proof);
                }
            }
            fetched_accounts_proofs.insert(ProcessedAccount::new(address, account_mpt_proofs));
        }
        let duration = start_fetch.elapsed();
        info!("time taken (Accounts Proofs Fetch): {:?}", duration);

        Ok(fetched_accounts_proofs)
    }

    async fn get_storages_from_keys(
        &self,
        keys: HashSet<EvmStorageKey>,
    ) -> Result<(HashSet<ProcessedAccount>, HashSet<ProcessedStorage>), ProviderError> {
        let mut fetched_accounts_proofs: HashSet<ProcessedAccount> = HashSet::new();
        let mut fetched_storage_proofs: HashSet<ProcessedStorage> = HashSet::new();
        let start_fetch = Instant::now();

        // group by address and slot
        let mut address_slot_to_block_range: HashMap<(Address, B256), Vec<u64>> = HashMap::new();
        for key in keys {
            let block_range = address_slot_to_block_range
                .entry((key.address, key.key))
                .or_default();
            block_range.push(key.block_number);
        }

        // loop through each address and fetch storages
        for ((address, storage_slot), block_range) in address_slot_to_block_range {
            if block_range.is_empty() {
                return Err(ProviderError::FetchKeyError(
                    "Block range is empty".to_string(),
                ));
            }
            let target_blocks_batch: Vec<Vec<BlockNumber>> = if block_range.len() == 1 {
                vec![block_range]
            } else {
                self._chunk_vec_blocks_for_mpt(block_range)
            };

            let mut storage_mpt_proof: Vec<ProcessedMPTProof> = vec![];
            let mut account_mpt_proofs: Vec<ProcessedMPTProof> = vec![];
            for target_blocks in target_blocks_batch {
                let storage_proof = self
                    .rpc_provider
                    .get_storage_proofs(target_blocks.clone(), address, storage_slot)
                    .await?;

                for block in target_blocks {
                    let account_proof_response = storage_proof
                        .get(&block)
                        .expect("Target block's account proof had not fetched as response")
                        .clone();
                    account_mpt_proofs.push(ProcessedMPTProof::new(
                        block,
                        account_proof_response.account_proof,
                    ));
                    storage_mpt_proof.push(ProcessedMPTProof::new(
                        block,
                        account_proof_response.storage_proof[0].proof.clone(),
                    ));
                }
            }
            fetched_accounts_proofs.insert(ProcessedAccount::new(address, account_mpt_proofs));
            fetched_storage_proofs.insert(ProcessedStorage::new(
                address,
                storage_slot,
                storage_mpt_proof,
            ));
        }
        let duration = start_fetch.elapsed();
        info!("time taken (Storage Proofs Fetch): {:?}", duration);

        Ok((fetched_accounts_proofs, fetched_storage_proofs))
    }

    pub async fn get_txs_from_keys(
        &self,
        keys: HashSet<EvmBlockTxKey>,
    ) -> Result<Vec<ProcessedTransaction>, ProviderError> {
        let mut fetched_transactions = vec![];
        let start_fetch = Instant::now();

        // group by block number
        let mut block_to_tx_range: HashMap<BlockNumber, Vec<TxIndex>> = HashMap::new();
        for key in keys {
            let tx_range = block_to_tx_range.entry(key.block_number).or_default();
            tx_range.push(key.index);
        }

        for (block_number, tx_range) in block_to_tx_range {
            let mut tx_trie_provider = TxsMptHandler::new(self.tx_provider_url.clone())?;
            loop {
                let trie_response = tx_trie_provider
                    .build_tx_tree_from_block(block_number)
                    .await;

                match trie_response {
                    Ok(_) => break,
                    Err(EthTrieError::RPC(RpcError::Transport(TransportErrorKind::HttpError(
                        http_error,
                    )))) if http_error.status == 429 => {
                        // retry if 429 error
                        tokio::time::sleep(tokio::time::Duration::from_secs(1)).await;
                        continue;
                    }
                    Err(e) => return Err(ProviderError::EthTrieError(e)),
                }
            }

            for tx_index in tx_range {
                let proof = tx_trie_provider
                    .get_proof(tx_index)?
                    .into_iter()
                    .map(Bytes::from)
                    .collect::<Vec<_>>();

                fetched_transactions.push(ProcessedTransaction::new(tx_index, block_number, proof));
            }
        }
        let duration = start_fetch.elapsed();
        info!("time taken (Transaction Fetch): {:?}", duration);
        Ok(fetched_transactions)
    }

    pub async fn get_tx_receipts_from_keys(
        &self,
        keys: HashSet<EvmBlockReceiptKey>,
    ) -> Result<Vec<ProcessedReceipt>, ProviderError> {
        let mut fetched_transaction_receipts = vec![];
        let start_fetch = Instant::now();
        // group by block number
        let mut block_to_tx_range: HashMap<BlockNumber, Vec<TxIndex>> = HashMap::new();
        for key in keys {
            let tx_range = block_to_tx_range.entry(key.block_number).or_default();
            tx_range.push(key.index);
        }

        for (block_number, tx_range) in block_to_tx_range {
            let mut tx_receipt_trie_provider =
                TxReceiptsMptHandler::new(self.tx_provider_url.clone())?;
            loop {
                let trie_response = tx_receipt_trie_provider
                    .build_tx_receipts_tree_from_block(block_number)
                    .await;

                match trie_response {
                    Ok(_) => break,
                    Err(EthTrieError::RPC(RpcError::Transport(TransportErrorKind::HttpError(
                        http_error,
                    )))) if http_error.status == 429 => {
                        // retry if 429 error
                        tokio::time::sleep(tokio::time::Duration::from_secs(1)).await;
                        continue;
                    }
                    Err(e) => return Err(ProviderError::EthTrieError(e)),
                }
            }

            for tx_index in tx_range {
                let proof = tx_receipt_trie_provider
                    .get_proof(tx_index)?
                    .into_iter()
                    .map(Bytes::from)
                    .collect::<Vec<_>>();

                fetched_transaction_receipts.push(ProcessedReceipt::new(
                    tx_index,
                    block_number,
                    proof,
                ));
            }
        }
        let duration = start_fetch.elapsed();
        info!("time taken (Transaction Receipts Fetch): {:?}", duration);
        Ok(fetched_transaction_receipts)
    }
}

#[cfg(test)]
#[cfg(feature = "test_utils")]
mod tests {
    use super::*;
    use crate::provider::evm::provider::EvmProvider;
    use crate::provider::key::categorize_fetch_keys;
    use crate::provider::key::FetchKeyEnvelope;
    use crate::provider::key::{EvmAccountKey, EvmHeaderKey};
    use alloy::primitives::address;
    use dotenv::dotenv;
    use std::sync::Once;

    static INIT: Once = Once::new();

    fn initialize() {
        INIT.call_once(|| {
            dotenv().ok();
        });
    }

    #[tokio::test]
    #[cfg(feature = "test_utils")]
    async fn test_get_proofs_from_header_keys() {
        initialize();
        let target_chain_id = crate::primitives::ChainId::EthereumSepolia;
        let provider = EvmProvider::default();
        let keys = vec![
            FetchKeyEnvelope::EvmHeader(EvmHeaderKey::new(target_chain_id, 1)),
            FetchKeyEnvelope::EvmHeader(EvmHeaderKey::new(target_chain_id, 2)),
            FetchKeyEnvelope::EvmHeader(EvmHeaderKey::new(target_chain_id, 3)),
        ];
        let (chain_id, fetched_keys) = categorize_fetch_keys(keys).into_iter().next().unwrap();
        assert_eq!(chain_id, target_chain_id);
        let proofs = provider
            .fetch_proofs_from_keys(fetched_keys)
            .await
            .unwrap()
            .get_evm_proofs()
            .unwrap();
        assert_eq!(proofs.mmr_with_headers[0].headers.len(), 3);
    }

    #[tokio::test]
    #[cfg(feature = "test_utils")]
    async fn test_get_proofs_from_accounts_keys() {
        initialize();
        let target_chain_id = crate::primitives::ChainId::EthereumSepolia;
        let provider = EvmProvider::default();
        let target_address = address!("7f2c6f930306d3aa736b3a6c6a98f512f74036d4");
        let keys = vec![
            FetchKeyEnvelope::EvmAccount(EvmAccountKey::new(
                target_chain_id,
                6127485,
                target_address,
            )),
            FetchKeyEnvelope::EvmAccount(EvmAccountKey::new(target_chain_id, 0, target_address)),
            FetchKeyEnvelope::EvmAccount(EvmAccountKey::new(
                target_chain_id,
                6127487,
                target_address,
            )),
        ];
        let (chain_id, fetched_keys) = categorize_fetch_keys(keys).into_iter().next().unwrap();
        assert_eq!(chain_id, target_chain_id);
        let proofs = provider
            .fetch_proofs_from_keys(fetched_keys)
            .await
            .unwrap()
            .get_evm_proofs()
            .unwrap();
        assert_eq!(proofs.accounts[0].proofs.len(), 3);
        assert_eq!(proofs.mmr_with_headers[0].headers.len(), 3);
    }

    #[tokio::test]
    #[cfg(feature = "test_utils")]
    async fn test_proofs_from_storage_keys() {
        initialize();
        let start_fetch = Instant::now();
        let target_chain_id = crate::primitives::ChainId::EthereumSepolia;
        let provider = EvmProvider::default();
        let target_address = address!("7f2c6f930306d3aa736b3a6c6a98f512f74036d4");
        let target_slot = B256::ZERO;
        let keys = vec![
            FetchKeyEnvelope::EvmStorage(EvmStorageKey::new(
                target_chain_id,
                0,
                target_address,
                target_slot,
            )),
            FetchKeyEnvelope::EvmStorage(EvmStorageKey::new(
                target_chain_id,
                6127486,
                target_address,
                target_slot,
            )),
            FetchKeyEnvelope::EvmStorage(EvmStorageKey::new(
                target_chain_id,
                6127487,
                target_address,
                target_slot,
            )),
            FetchKeyEnvelope::EvmStorage(EvmStorageKey::new(
                target_chain_id,
                4127497,
                target_address,
                target_slot,
            )),
            FetchKeyEnvelope::EvmStorage(EvmStorageKey::new(
                target_chain_id,
                4127487,
                target_address,
                target_slot,
            )),
            FetchKeyEnvelope::EvmStorage(EvmStorageKey::new(
                target_chain_id,
                4127477,
                target_address,
                target_slot,
            )),
        ];
        let (chain_id, fetched_keys) = categorize_fetch_keys(keys).into_iter().next().unwrap();
        assert_eq!(chain_id, target_chain_id);
        let proofs = provider
            .fetch_proofs_from_keys(fetched_keys)
            .await
            .unwrap()
            .get_evm_proofs()
            .unwrap();
        let duration = start_fetch.elapsed();
        println!("Time taken (Total Proofs Fetch): {:?}", duration);
        assert_eq!(proofs.mmr_with_headers[0].headers.len(), 6);
        assert_eq!(proofs.accounts[0].proofs.len(), 6);
        assert_eq!(proofs.storages[0].proofs.len(), 6);
    }

    #[tokio::test]
    #[cfg(feature = "test_utils")]
    async fn test_get_proofs_from_tx_keys() {
        initialize();
        let target_chain_id = crate::primitives::ChainId::EthereumSepolia;
        let provider = EvmProvider::default();
        let keys = vec![
            FetchKeyEnvelope::EvmTx(EvmBlockTxKey::new(target_chain_id, 1000, 0)),
            FetchKeyEnvelope::EvmTx(EvmBlockTxKey::new(target_chain_id, 1001, 1)),
            FetchKeyEnvelope::EvmTx(EvmBlockTxKey::new(target_chain_id, 1000, 2)),
        ];
        let (chain_id, fetched_keys) = categorize_fetch_keys(keys).into_iter().next().unwrap();
        assert_eq!(chain_id, target_chain_id);
        let proofs = provider
            .fetch_proofs_from_keys(fetched_keys)
            .await
            .unwrap()
            .get_evm_proofs()
            .unwrap();
        assert_eq!(proofs.mmr_with_headers[0].headers.len(), 2);
        assert_eq!(proofs.transactions.len(), 3);
    }
}