ethrex-storage-rollup 18.0.0

Rollup batch and prover-input storage for the ethrex L2 Ethereum client
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
use std::{
    collections::HashMap,
    fmt::Debug,
    sync::{Arc, Mutex, MutexGuard},
};

use crate::error::RollupStoreError;
use ethrex_common::{
    H256,
    types::{
        AccountUpdate, Blob, BlockNumber, balance_diff::BalanceDiff, batch::Batch,
        fee_config::FeeConfig,
    },
};
use ethrex_l2_common::prover::{ProverInputData, ProverOutput, ProverType};

use crate::api::StoreEngineRollup;

#[derive(Default, Clone)]
pub struct Store(Arc<Mutex<StoreInner>>);

#[derive(Default, Debug)]
struct StoreInner {
    /// Map of batches by block numbers
    batches_by_block: HashMap<BlockNumber, u64>,
    /// Map of l1 message hashes by batch numbers
    l1_out_message_hashes_by_batch: HashMap<u64, Vec<H256>>,
    /// Map of balance diffs by batch numbers
    balance_diffs_by_batch: HashMap<u64, Vec<BalanceDiff>>,
    /// Map of batch number to block numbers
    block_numbers_by_batch: HashMap<u64, Vec<BlockNumber>>,
    /// Map of batch number to deposit logs hash
    l1_in_messages_rolling_hashes: HashMap<u64, H256>,
    /// Map of batch number to L2 in message rolling hashes
    l2_in_message_rolling_hashes: HashMap<u64, Vec<(u64, H256)>>,
    /// Map of batch number to non-privileged transactions count
    non_privileged_transactions_by_batch: HashMap<u64, u64>,
    /// Map of batch number to state root
    state_roots: HashMap<u64, H256>,
    /// Map of batch number to blob
    blobs: HashMap<u64, Vec<Blob>>,
    /// (batch_number, verified_at_secs) for the latest batch verified on-chain
    latest_verified_batch_proof: (u64, u64),
    /// batch_number for latest proof sent to Aligned gateway
    latest_sent_to_aligned: u64,
    /// Metrics for transaction, deposits and messages count
    operations_counts: [u64; 3],
    /// Map of signatures from the sequencer by block hashes
    signatures_by_block: HashMap<H256, ethereum_types::Signature>,
    /// Map of signatures from the sequencer by batch numbers
    signatures_by_batch: HashMap<u64, ethereum_types::Signature>,
    /// Map of block number to account updates
    account_updates_by_block_number: HashMap<BlockNumber, Vec<AccountUpdate>>,
    /// Map of (ProverType, batch_number) to batch proof data
    batch_proofs: HashMap<(ProverType, u64), ProverOutput>,
    /// Map of batch number to commit transaction hash
    commit_txs: HashMap<u64, H256>,
    /// Map of batch number to verify transaction hash
    verify_txs: HashMap<u64, H256>,
    /// Map of (batch_number, prover_version) to serialized prover input data
    batch_prover_input: HashMap<(u64, String), Vec<u8>>,
    /// Map of block number to FeeConfig
    fee_config_by_block: HashMap<BlockNumber, FeeConfig>,
}

impl Store {
    pub fn new() -> Self {
        Self::default()
    }
    fn inner(&self) -> Result<MutexGuard<'_, StoreInner>, RollupStoreError> {
        self.0
            .lock()
            .map_err(|_| RollupStoreError::Custom("Failed to lock the store".to_string()))
    }
}

#[async_trait::async_trait]
impl StoreEngineRollup for Store {
    async fn get_batch_number_by_block(
        &self,
        block_number: BlockNumber,
    ) -> Result<Option<u64>, RollupStoreError> {
        Ok(self.inner()?.batches_by_block.get(&block_number).copied())
    }

    async fn get_l1_out_message_hashes_by_batch(
        &self,
        batch_number: u64,
    ) -> Result<Option<Vec<H256>>, RollupStoreError> {
        Ok(self
            .inner()?
            .l1_out_message_hashes_by_batch
            .get(&batch_number)
            .cloned())
    }

    async fn get_balance_diffs_by_batch(
        &self,
        batch_number: u64,
    ) -> Result<Option<Vec<BalanceDiff>>, RollupStoreError> {
        Ok(self
            .inner()?
            .balance_diffs_by_batch
            .get(&batch_number)
            .cloned())
    }

    /// Returns the block numbers for a given batch_number
    async fn get_block_numbers_by_batch(
        &self,
        batch_number: u64,
    ) -> Result<Option<Vec<BlockNumber>>, RollupStoreError> {
        let block_numbers = self
            .inner()?
            .block_numbers_by_batch
            .get(&batch_number)
            .cloned();
        Ok(block_numbers)
    }

    async fn get_l1_in_messages_rolling_hash_by_batch_number(
        &self,
        batch_number: u64,
    ) -> Result<Option<H256>, RollupStoreError> {
        Ok(self
            .inner()?
            .l1_in_messages_rolling_hashes
            .get(&batch_number)
            .cloned())
    }

    async fn get_l2_in_message_rolling_hashes_by_batch(
        &self,
        batch_number: u64,
    ) -> Result<Option<Vec<(u64, H256)>>, RollupStoreError> {
        Ok(self
            .inner()?
            .l2_in_message_rolling_hashes
            .get(&batch_number)
            .cloned())
    }

    async fn get_state_root_by_batch_number(
        &self,
        batch_number: u64,
    ) -> Result<Option<H256>, RollupStoreError> {
        Ok(self.inner()?.state_roots.get(&batch_number).cloned())
    }

    async fn get_blob_bundle_by_batch_number(
        &self,
        batch_number: u64,
    ) -> Result<Option<Vec<Blob>>, RollupStoreError> {
        Ok(self.inner()?.blobs.get(&batch_number).cloned())
    }

    async fn get_commit_tx_by_batch(
        &self,
        batch_number: u64,
    ) -> Result<Option<H256>, RollupStoreError> {
        Ok(self.inner()?.commit_txs.get(&batch_number).cloned())
    }

    async fn store_commit_tx_by_batch(
        &self,
        batch_number: u64,
        commit_tx: H256,
    ) -> Result<(), RollupStoreError> {
        self.inner()?.commit_txs.insert(batch_number, commit_tx);
        Ok(())
    }

    async fn get_verify_tx_by_batch(
        &self,
        batch_number: u64,
    ) -> Result<Option<H256>, RollupStoreError> {
        Ok(self.inner()?.verify_txs.get(&batch_number).cloned())
    }

    async fn store_verify_tx_by_batch(
        &self,
        batch_number: u64,
        verify_tx: H256,
    ) -> Result<(), RollupStoreError> {
        self.inner()?.verify_txs.insert(batch_number, verify_tx);
        Ok(())
    }

    async fn contains_batch(&self, batch_number: &u64) -> Result<bool, RollupStoreError> {
        Ok(self
            .inner()?
            .block_numbers_by_batch
            .contains_key(batch_number))
    }

    async fn update_operations_count(
        &self,
        transaction_inc: u64,
        privileged_tx_inc: u64,
        messages_inc: u64,
    ) -> Result<(), RollupStoreError> {
        let mut values = self.inner()?.operations_counts;
        values[0] += transaction_inc;
        values[1] += privileged_tx_inc;
        values[2] += messages_inc;
        Ok(())
    }

    async fn get_operations_count(&self) -> Result<[u64; 3], RollupStoreError> {
        Ok(self.inner()?.operations_counts)
    }

    async fn store_signature_by_block(
        &self,
        block_hash: H256,
        signature: ethereum_types::Signature,
    ) -> Result<(), RollupStoreError> {
        self.inner()?
            .signatures_by_block
            .insert(block_hash, signature);
        Ok(())
    }

    async fn get_signature_by_block(
        &self,
        block_hash: H256,
    ) -> Result<Option<ethereum_types::Signature>, RollupStoreError> {
        Ok(self.inner()?.signatures_by_block.get(&block_hash).cloned())
    }

    async fn store_signature_by_batch(
        &self,
        batch_number: u64,
        signature: ethereum_types::Signature,
    ) -> Result<(), RollupStoreError> {
        self.inner()?
            .signatures_by_batch
            .insert(batch_number, signature);
        Ok(())
    }

    async fn get_signature_by_batch(
        &self,
        batch_number: u64,
    ) -> Result<Option<ethereum_types::Signature>, RollupStoreError> {
        Ok(self
            .inner()?
            .signatures_by_batch
            .get(&batch_number)
            .cloned())
    }

    async fn get_latest_verified_batch_proof(&self) -> Result<(u64, u64), RollupStoreError> {
        Ok(self.inner()?.latest_verified_batch_proof)
    }

    async fn set_latest_verified_batch_proof(
        &self,
        batch_number: u64,
        verified_at: u64,
    ) -> Result<(), RollupStoreError> {
        self.inner()?.latest_verified_batch_proof = (batch_number, verified_at);
        Ok(())
    }

    async fn get_latest_sent_to_aligned(&self) -> Result<u64, RollupStoreError> {
        Ok(self.inner()?.latest_sent_to_aligned)
    }

    async fn set_latest_sent_to_aligned(&self, batch_number: u64) -> Result<(), RollupStoreError> {
        self.inner()?.latest_sent_to_aligned = batch_number;
        Ok(())
    }

    async fn get_account_updates_by_block_number(
        &self,
        block_number: BlockNumber,
    ) -> Result<Option<Vec<AccountUpdate>>, RollupStoreError> {
        Ok(self
            .inner()?
            .account_updates_by_block_number
            .get(&block_number)
            .cloned())
    }

    async fn store_account_updates_by_block_number(
        &self,
        block_number: BlockNumber,
        account_updates: Vec<AccountUpdate>,
    ) -> Result<(), RollupStoreError> {
        self.inner()?
            .account_updates_by_block_number
            .insert(block_number, account_updates);
        Ok(())
    }

    async fn store_proof_by_batch_and_type(
        &self,
        batch_number: u64,
        proof_type: ProverType,
        proof: ProverOutput,
    ) -> Result<(), RollupStoreError> {
        self.inner()?
            .batch_proofs
            .insert((proof_type, batch_number), proof);
        Ok(())
    }

    async fn get_proof_by_batch_and_type(
        &self,
        batch_number: u64,
        proof_type: ProverType,
    ) -> Result<Option<ProverOutput>, RollupStoreError> {
        Ok(self
            .inner()?
            .batch_proofs
            .get(&(proof_type, batch_number))
            .cloned())
    }

    async fn get_non_privileged_transactions_by_batch(
        &self,
        batch_number: u64,
    ) -> Result<Option<u64>, RollupStoreError> {
        Ok(self
            .inner()?
            .non_privileged_transactions_by_batch
            .get(&batch_number)
            .cloned())
    }

    async fn revert_to_batch(&self, batch_number: u64) -> Result<(), RollupStoreError> {
        let mut store = self.inner()?;
        store
            .batches_by_block
            .retain(|_, batch| *batch <= batch_number);
        store
            .l1_out_message_hashes_by_batch
            .retain(|batch, _| *batch <= batch_number);
        store
            .block_numbers_by_batch
            .retain(|batch, _| *batch <= batch_number);
        store
            .l1_in_messages_rolling_hashes
            .retain(|batch, _| *batch <= batch_number);
        store.state_roots.retain(|batch, _| *batch <= batch_number);
        store.blobs.retain(|batch, _| *batch <= batch_number);
        store
            .batch_prover_input
            .retain(|(batch, _), _| *batch <= batch_number);
        Ok(())
    }

    async fn seal_batch(&self, batch: Batch) -> Result<(), RollupStoreError> {
        let mut inner = self.inner()?;
        let blocks: Vec<u64> = (batch.first_block..=batch.last_block).collect();

        for block_number in blocks.iter() {
            inner.batches_by_block.insert(*block_number, batch.number);
        }

        inner.block_numbers_by_batch.insert(batch.number, blocks);

        inner
            .l1_out_message_hashes_by_batch
            .insert(batch.number, batch.l1_out_message_hashes);

        inner
            .l1_in_messages_rolling_hashes
            .insert(batch.number, batch.l1_in_messages_rolling_hash);

        inner
            .non_privileged_transactions_by_batch
            .insert(batch.number, batch.non_privileged_transactions);

        inner
            .balance_diffs_by_batch
            .insert(batch.number, batch.balance_diffs);

        inner
            .l2_in_message_rolling_hashes
            .insert(batch.number, batch.l2_in_message_rolling_hashes);

        inner.blobs.insert(batch.number, batch.blobs_bundle.blobs);

        inner.state_roots.insert(batch.number, batch.state_root);

        if let Some(commit_tx) = batch.commit_tx {
            inner.commit_txs.insert(batch.number, commit_tx);
        }
        if let Some(verify_tx) = batch.verify_tx {
            inner.verify_txs.insert(batch.number, verify_tx);
        }
        Ok(())
    }

    async fn seal_batch_with_prover_input(
        &self,
        batch: Batch,
        prover_version: &str,
        prover_input_data: ProverInputData,
    ) -> Result<(), RollupStoreError> {
        let batch_number = batch.number;

        // There is no problem in performing these two operations not atomically
        // as in the in-memory store restarts will lose all data anyway.
        self.seal_batch(batch).await?;
        self.store_prover_input_by_batch_and_version(
            batch_number,
            prover_version,
            prover_input_data,
        )
        .await
    }

    async fn delete_proof_by_batch_and_type(
        &self,
        batch_number: u64,
        proof_type: ProverType,
    ) -> Result<(), RollupStoreError> {
        let mut inner = self.inner()?;
        inner.batch_proofs.remove(&(proof_type, batch_number));
        Ok(())
    }

    async fn get_last_batch_number(&self) -> Result<Option<u64>, RollupStoreError> {
        Ok(self.inner()?.state_roots.keys().max().cloned())
    }

    async fn store_prover_input_by_batch_and_version(
        &self,
        batch_number: u64,
        prover_version: &str,
        prover_input: ProverInputData,
    ) -> Result<(), RollupStoreError> {
        let witness_bytes = rkyv::to_bytes::<rkyv::rancor::Error>(&prover_input)
            .map_err(|e| RollupStoreError::Custom(format!("Failed to serialize witness: {}", e)))?
            .to_vec();

        self.inner()?
            .batch_prover_input
            .insert((batch_number, prover_version.to_string()), witness_bytes);

        Ok(())
    }

    async fn get_prover_input_by_batch_and_version(
        &self,
        batch_number: u64,
        prover_version: &str,
    ) -> Result<Option<ProverInputData>, RollupStoreError> {
        let Some(witness_bytes) = self
            .inner()?
            .batch_prover_input
            .get(&(batch_number, prover_version.to_string()))
            .cloned()
        else {
            return Ok(None);
        };

        let prover_input = rkyv::from_bytes::<ProverInputData, rkyv::rancor::Error>(&witness_bytes)
            .map_err(|e| {
                RollupStoreError::Custom(format!(
                    "Failed to deserialize prover input for batch {batch_number} and version {prover_version}: {e}",
                ))
            })?;

        Ok(Some(prover_input))
    }

    async fn store_fee_config_by_block(
        &self,
        block_number: BlockNumber,
        fee_config: FeeConfig,
    ) -> Result<(), RollupStoreError> {
        self.inner()?
            .fee_config_by_block
            .insert(block_number, fee_config);
        Ok(())
    }

    async fn get_fee_config_by_block(
        &self,
        block_number: BlockNumber,
    ) -> Result<Option<FeeConfig>, RollupStoreError> {
        Ok(self
            .inner()?
            .fee_config_by_block
            .get(&block_number)
            .cloned())
    }
}

impl Debug for Store {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("In Memory L2 Store").finish()
    }
}