mirror of
https://github.com/logos-blockchain/logos-execution-zone.git
synced 2026-07-24 06:33:20 +00:00
Decentralized-sequencing foundation: a shared chain_state crate (two-tier head/final ChainState, apply_block, AcceptOutcome, StallReason, and the absorbed channel-consistency machinery), turn-gated block production, the publisher follow path for adopted/orphaned/finalized peer blocks, and persistence that keeps disk order equal to apply order under the chain lock. Rebased onto dev after #600/#606: chain_consistency is absorbed into chain_state, the sequencer bootstrap's verify_and_reconstruct is re-wired onto the two-tier ChainState (reconstruction applies channel history through the final tier and persists via the follow-path primitives), and test fixtures adopt the SequencerSetup builder extended with with_bedrock_signing_key. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
832 lines
30 KiB
Rust
832 lines
30 KiB
Rust
use std::{path::Path, sync::Arc};
|
|
|
|
use borsh::{BorshDeserialize, BorshSerialize};
|
|
use common::{
|
|
HashType,
|
|
block::{BedrockStatus, Block, BlockMeta},
|
|
};
|
|
use lee::V03State;
|
|
use rocksdb::{
|
|
BoundColumnFamily, ColumnFamilyDescriptor, DBWithThreadMode, IteratorMode, MultiThreaded,
|
|
Options, WriteBatch,
|
|
};
|
|
|
|
use crate::{
|
|
CF_BLOCK_NAME, CF_META_NAME, DB_META_FIRST_BLOCK_IN_DB_KEY, DBIO, DbResult,
|
|
cells::{
|
|
SimpleStorableCell,
|
|
shared_cells::{BlockCell, FirstBlockCell, FirstBlockSetCell, LastBlockCell},
|
|
},
|
|
error::DbError,
|
|
sequencer::sequencer_cells::{
|
|
FinalBlockMetaCellOwned, FinalBlockMetaCellRef, FinalLeeStateCellOwned,
|
|
FinalLeeStateCellRef, LEEStateCellOwned, LEEStateCellRef, LastFinalizedBlockIdCell,
|
|
LatestBlockMetaCellOwned, LatestBlockMetaCellRef, PendingDepositEventRecord,
|
|
PendingDepositEventsCellOwned, PendingDepositEventsCellRef, UnseenWithdrawCountCell,
|
|
WithdrawalReconciliationKey, ZoneAnchorCell, ZoneAnchorRecord, ZoneSdkCheckpointCellOwned,
|
|
ZoneSdkCheckpointCellRef,
|
|
},
|
|
};
|
|
|
|
pub mod sequencer_cells;
|
|
|
|
/// Key base for storing metainformation about the last finalized block on Bedrock.
|
|
pub const DB_META_LAST_FINALIZED_BLOCK_ID: &str = "last_finalized_block_id";
|
|
/// Key base for storing metainformation about the latest block meta.
|
|
pub const DB_META_LATEST_BLOCK_META_KEY: &str = "latest_block_meta";
|
|
/// Key base for storing the zone-sdk sequencer checkpoint (opaque bytes).
|
|
pub const DB_META_ZONE_SDK_CHECKPOINT_KEY: &str = "zone_sdk_checkpoint";
|
|
/// Key base for storing the last channel block read back and verified from
|
|
/// Bedrock (its L1 slot + `id`/`hash`) — the anchor for the startup
|
|
/// consistency check and the resume point for reconstruction.
|
|
pub const DB_META_ZONE_CURSOR_KEY: &str = "zone_cursor";
|
|
/// Key base for storing queued deposit events that were not yet
|
|
/// fulfilled on L2.
|
|
pub const DB_META_PENDING_DEPOSIT_EVENTS_KEY: &str = "pending_deposit_events";
|
|
/// Key base for counting unseen L2 withdraw intents.
|
|
pub const DB_META_UNSEEN_WITHDRAW_COUNT_KEY: &str = "unseen_withdraw_count";
|
|
|
|
/// Key base for storing the LEE state.
|
|
pub const DB_LEE_STATE_KEY: &str = "lee_state";
|
|
/// Key base for storing the LEE state at the last L1-finalized block.
|
|
pub const DB_FINAL_LEE_STATE_KEY: &str = "final_lee_state";
|
|
/// Key base for storing `(id, hash)` of the last L1-finalized block.
|
|
pub const DB_FINAL_BLOCK_META_KEY: &str = "final_block_meta";
|
|
|
|
/// Name of state column family.
|
|
pub const CF_LEE_STATE_NAME: &str = "cf_lee_state";
|
|
|
|
/// A single key/value entry from a column family, used inside [`DbDump`].
|
|
#[derive(BorshSerialize, BorshDeserialize)]
|
|
pub struct DbDumpEntry {
|
|
pub cf_name: String,
|
|
pub key: Vec<u8>,
|
|
pub value: Vec<u8>,
|
|
}
|
|
|
|
/// Schema-agnostic single-blob snapshot of a store: every key/value pair across all column
|
|
/// families. Lets a prebuilt store ship as one committed file instead of a rocksdb directory.
|
|
#[derive(BorshSerialize, BorshDeserialize)]
|
|
pub struct DbDump {
|
|
pub entries: Vec<DbDumpEntry>,
|
|
}
|
|
|
|
impl DbDump {
|
|
/// Serialize the dump to a zstd-compressed borsh blob.
|
|
pub fn to_bytes(&self) -> DbResult<Vec<u8>> {
|
|
/// zstd compression level for [`DbDump::to_bytes`]. Level 19 keeps the committed fixture
|
|
/// small without a meaningful decompression cost.
|
|
const DUMP_ZSTD_LEVEL: i32 = 19;
|
|
|
|
let borsh = borsh::to_vec(self).map_err(|err| {
|
|
DbError::borsh_cast_message(err, Some("Failed to serialize DbDump".to_owned()))
|
|
})?;
|
|
zstd::encode_all(borsh.as_slice(), DUMP_ZSTD_LEVEL).map_err(|err| {
|
|
DbError::compression_error(err, Some("Failed to compress DbDump".to_owned()))
|
|
})
|
|
}
|
|
|
|
/// Deserialize a dump produced by [`Self::to_bytes`].
|
|
pub fn from_bytes(bytes: &[u8]) -> DbResult<Self> {
|
|
let borsh = zstd::decode_all(bytes).map_err(|err| {
|
|
DbError::db_interaction_error(format!("Failed to decompress DbDump: {err}"))
|
|
})?;
|
|
borsh::from_slice(&borsh).map_err(|err| {
|
|
DbError::compression_error(err, Some("Failed to deserialize DbDump".to_owned()))
|
|
})
|
|
}
|
|
}
|
|
|
|
pub struct RocksDBIO {
|
|
pub db: DBWithThreadMode<MultiThreaded>,
|
|
}
|
|
|
|
impl DBIO for RocksDBIO {
|
|
fn db(&self) -> &DBWithThreadMode<MultiThreaded> {
|
|
&self.db
|
|
}
|
|
}
|
|
|
|
impl RocksDBIO {
|
|
pub fn open(path: &Path) -> DbResult<Self> {
|
|
let db_opts = Options::default();
|
|
Self::open_inner(path, &db_opts)
|
|
}
|
|
|
|
pub fn create(path: &Path, genesis_block: &Block, genesis_state: &V03State) -> DbResult<Self> {
|
|
let mut db_opts = Options::default();
|
|
db_opts.create_missing_column_families(true);
|
|
db_opts.create_if_missing(true);
|
|
let dbio = Self::open_inner(path, &db_opts)?;
|
|
|
|
let is_start_set = dbio.get_meta_is_first_block_set()?;
|
|
if !is_start_set {
|
|
let block_id = genesis_block.header.block_id;
|
|
// TODO: Shouldn't this be atomic (batched)?
|
|
dbio.put_meta_first_block_in_db(genesis_block)?;
|
|
dbio.put_meta_is_first_block_set()?;
|
|
dbio.put_meta_last_block_in_db(block_id)?;
|
|
dbio.put_meta_last_finalized_block_id(None)?;
|
|
dbio.put_meta_latest_block_meta(&BlockMeta {
|
|
id: genesis_block.header.block_id,
|
|
hash: genesis_block.header.hash,
|
|
})?;
|
|
dbio.put_lee_state_in_db(genesis_state)?;
|
|
}
|
|
|
|
Ok(dbio)
|
|
}
|
|
|
|
/// Dump every key/value pair across all column families into a [`DbDump`]. Column families are
|
|
/// discovered from disk, so new ones are captured without a hardcoded list.
|
|
pub fn dump_all(&self) -> DbResult<DbDump> {
|
|
let cf_names =
|
|
DBWithThreadMode::<MultiThreaded>::list_cf(&Options::default(), self.db.path())
|
|
.map_err(|rerr| {
|
|
DbError::rocksdb_cast_message(
|
|
rerr,
|
|
Some("Failed to list column families for dump".to_owned()),
|
|
)
|
|
})?;
|
|
|
|
let mut entries = Vec::new();
|
|
for cf_name in cf_names {
|
|
let cf = self.db.cf_handle(&cf_name).ok_or_else(|| {
|
|
DbError::db_interaction_error(format!(
|
|
"Column family {cf_name:?} listed on disk but not opened; add it to `open_inner`"
|
|
))
|
|
})?;
|
|
for item in self.db.iterator_cf(&cf, IteratorMode::Start) {
|
|
let (key, value) = item.map_err(|rerr| {
|
|
DbError::rocksdb_cast_message(
|
|
rerr,
|
|
Some(format!(
|
|
"Failed to iterate column family {cf_name:?} for dump"
|
|
)),
|
|
)
|
|
})?;
|
|
entries.push(DbDumpEntry {
|
|
cf_name: cf_name.clone(),
|
|
key: key.into_vec(),
|
|
value: value.into_vec(),
|
|
});
|
|
}
|
|
}
|
|
Ok(DbDump { entries })
|
|
}
|
|
|
|
/// Create a fresh rocksdb at `path` populated from a [`DbDump`].
|
|
pub fn restore_from_dump(path: &Path, dump: &DbDump) -> DbResult<Self> {
|
|
let mut db_opts = Options::default();
|
|
db_opts.create_missing_column_families(true);
|
|
db_opts.create_if_missing(true);
|
|
let dbio = Self::open_inner(path, &db_opts)?;
|
|
|
|
let mut batch = WriteBatch::default();
|
|
for entry in &dump.entries {
|
|
let cf = dbio.db.cf_handle(&entry.cf_name).ok_or_else(|| {
|
|
DbError::db_interaction_error(format!(
|
|
"Unknown column family {:?} in dump",
|
|
entry.cf_name
|
|
))
|
|
})?;
|
|
batch.put_cf(&cf, &entry.key, &entry.value);
|
|
}
|
|
dbio.db.write(batch).map_err(|rerr| {
|
|
DbError::rocksdb_cast_message(
|
|
rerr,
|
|
Some("Failed to write dump restore batch".to_owned()),
|
|
)
|
|
})?;
|
|
|
|
Ok(dbio)
|
|
}
|
|
|
|
fn open_inner(path: &Path, db_opts: &Options) -> DbResult<Self> {
|
|
let mut cf_opts = Options::default();
|
|
cf_opts.set_max_write_buffer_number(16);
|
|
|
|
// ToDo: Add more column families for different data
|
|
let cfb = ColumnFamilyDescriptor::new(CF_BLOCK_NAME, cf_opts.clone());
|
|
let cfmeta = ColumnFamilyDescriptor::new(CF_META_NAME, cf_opts.clone());
|
|
let cfstate = ColumnFamilyDescriptor::new(CF_LEE_STATE_NAME, cf_opts.clone());
|
|
|
|
let db = DBWithThreadMode::<MultiThreaded>::open_cf_descriptors(
|
|
db_opts,
|
|
path,
|
|
vec![cfb, cfmeta, cfstate],
|
|
)
|
|
.map_err(|err| DbError::RocksDbError {
|
|
error: err,
|
|
additional_info: Some("Failed to open or create DB".to_owned()),
|
|
})?;
|
|
|
|
let dbio = Self { db };
|
|
Ok(dbio)
|
|
}
|
|
|
|
pub fn destroy(path: &Path) -> DbResult<()> {
|
|
let mut cf_opts = Options::default();
|
|
cf_opts.set_max_write_buffer_number(16);
|
|
// ToDo: Add more column families for different data
|
|
let _cfb = ColumnFamilyDescriptor::new(CF_BLOCK_NAME, cf_opts.clone());
|
|
let _cfmeta = ColumnFamilyDescriptor::new(CF_META_NAME, cf_opts.clone());
|
|
let _cfstate = ColumnFamilyDescriptor::new(CF_LEE_STATE_NAME, cf_opts.clone());
|
|
|
|
let mut db_opts = Options::default();
|
|
db_opts.create_missing_column_families(true);
|
|
db_opts.create_if_missing(true);
|
|
DBWithThreadMode::<MultiThreaded>::destroy(&db_opts, path)
|
|
.map_err(|rerr| DbError::rocksdb_cast_message(rerr, None))
|
|
}
|
|
|
|
// Columns
|
|
|
|
pub fn meta_column(&self) -> Arc<BoundColumnFamily<'_>> {
|
|
self.db
|
|
.cf_handle(CF_META_NAME)
|
|
.expect("Meta column should exist")
|
|
}
|
|
|
|
pub fn block_column(&self) -> Arc<BoundColumnFamily<'_>> {
|
|
self.db
|
|
.cf_handle(CF_BLOCK_NAME)
|
|
.expect("Block column should exist")
|
|
}
|
|
|
|
pub fn lee_state_column(&self) -> Arc<BoundColumnFamily<'_>> {
|
|
self.db
|
|
.cf_handle(CF_LEE_STATE_NAME)
|
|
.expect("State should exist")
|
|
}
|
|
|
|
// Meta
|
|
|
|
pub fn get_meta_first_block_in_db(&self) -> DbResult<u64> {
|
|
self.get::<FirstBlockCell>(()).map(|cell| cell.0)
|
|
}
|
|
|
|
pub fn get_meta_last_block_in_db(&self) -> DbResult<u64> {
|
|
self.get::<LastBlockCell>(()).map(|cell| cell.0)
|
|
}
|
|
|
|
pub fn get_meta_is_first_block_set(&self) -> DbResult<bool> {
|
|
Ok(self.get_opt::<FirstBlockSetCell>(())?.is_some())
|
|
}
|
|
|
|
pub fn put_lee_state_in_db(&self, state: &V03State) -> DbResult<()> {
|
|
self.put(&LEEStateCellRef(state), ())
|
|
}
|
|
|
|
pub fn put_lee_state_in_db_batch(
|
|
&self,
|
|
state: &V03State,
|
|
batch: &mut WriteBatch,
|
|
) -> DbResult<()> {
|
|
self.put_batch(&LEEStateCellRef(state), (), batch)
|
|
}
|
|
|
|
pub fn put_meta_first_block_in_db(&self, block: &Block) -> DbResult<()> {
|
|
let cf_meta = self.meta_column();
|
|
self.db
|
|
.put_cf(
|
|
&cf_meta,
|
|
borsh::to_vec(&DB_META_FIRST_BLOCK_IN_DB_KEY).map_err(|err| {
|
|
DbError::borsh_cast_message(
|
|
err,
|
|
Some("Failed to serialize DB_META_FIRST_BLOCK_IN_DB_KEY".to_owned()),
|
|
)
|
|
})?,
|
|
borsh::to_vec(&block.header.block_id).map_err(|err| {
|
|
DbError::borsh_cast_message(
|
|
err,
|
|
Some("Failed to serialize first block id".to_owned()),
|
|
)
|
|
})?,
|
|
)
|
|
.map_err(|rerr| DbError::rocksdb_cast_message(rerr, None))?;
|
|
|
|
let mut batch = WriteBatch::default();
|
|
self.put_block(block, true, &mut batch)?;
|
|
self.db.write(batch).map_err(|rerr| {
|
|
DbError::rocksdb_cast_message(
|
|
rerr,
|
|
Some("Failed to write first block in db".to_owned()),
|
|
)
|
|
})?;
|
|
|
|
Ok(())
|
|
}
|
|
|
|
pub fn put_meta_last_block_in_db(&self, block_id: u64) -> DbResult<()> {
|
|
self.put(&LastBlockCell(block_id), ())
|
|
}
|
|
|
|
fn put_meta_last_block_in_db_batch(
|
|
&self,
|
|
block_id: u64,
|
|
batch: &mut WriteBatch,
|
|
) -> DbResult<()> {
|
|
self.put_batch(&LastBlockCell(block_id), (), batch)
|
|
}
|
|
|
|
pub fn put_meta_last_finalized_block_id(&self, block_id: Option<u64>) -> DbResult<()> {
|
|
self.put(&LastFinalizedBlockIdCell(block_id), ())
|
|
}
|
|
|
|
pub fn put_meta_is_first_block_set(&self) -> DbResult<()> {
|
|
self.put(&FirstBlockSetCell(true), ())
|
|
}
|
|
|
|
fn put_meta_latest_block_meta(&self, block_meta: &BlockMeta) -> DbResult<()> {
|
|
self.put(&LatestBlockMetaCellRef(block_meta), ())
|
|
}
|
|
|
|
fn put_meta_latest_block_meta_batch(
|
|
&self,
|
|
block_meta: &BlockMeta,
|
|
batch: &mut WriteBatch,
|
|
) -> DbResult<()> {
|
|
self.put_batch(&LatestBlockMetaCellRef(block_meta), (), batch)
|
|
}
|
|
|
|
pub fn latest_block_meta(&self) -> DbResult<Option<BlockMeta>> {
|
|
self.get_opt::<LatestBlockMetaCellOwned>(())
|
|
.map(|val| val.map(|cell| cell.0))
|
|
}
|
|
|
|
pub fn get_zone_sdk_checkpoint_bytes(&self) -> DbResult<Option<Vec<u8>>> {
|
|
Ok(self
|
|
.get_opt::<ZoneSdkCheckpointCellOwned>(())?
|
|
.map(|cell| cell.0))
|
|
}
|
|
|
|
pub fn put_zone_sdk_checkpoint_bytes(&self, bytes: &[u8]) -> DbResult<()> {
|
|
self.put(&ZoneSdkCheckpointCellRef(bytes), ())
|
|
}
|
|
|
|
/// Remove the persisted zone-sdk checkpoint so the next startup is treated as a fresh start.
|
|
pub fn delete_zone_sdk_checkpoint_bytes(&self) -> DbResult<()> {
|
|
self.del::<ZoneSdkCheckpointCellOwned>(())
|
|
}
|
|
|
|
pub fn get_zone_anchor(&self) -> DbResult<Option<ZoneAnchorRecord>> {
|
|
Ok(self.get_opt::<ZoneAnchorCell>(())?.map(|cell| cell.0))
|
|
}
|
|
|
|
pub fn put_zone_anchor(&self, anchor: &ZoneAnchorRecord) -> DbResult<()> {
|
|
self.put(&ZoneAnchorCell(*anchor), ())
|
|
}
|
|
|
|
pub fn get_pending_deposit_events(&self) -> DbResult<Vec<PendingDepositEventRecord>> {
|
|
Ok(self
|
|
.get_opt::<PendingDepositEventsCellOwned>(())?
|
|
.map_or_else(Vec::new, |cell| cell.0))
|
|
}
|
|
|
|
fn put_pending_deposit_events(&self, records: &[PendingDepositEventRecord]) -> DbResult<()> {
|
|
self.put(&PendingDepositEventsCellRef(records), ())
|
|
}
|
|
|
|
fn put_pending_deposit_events_batch(
|
|
&self,
|
|
records: &[PendingDepositEventRecord],
|
|
batch: &mut WriteBatch,
|
|
) -> DbResult<()> {
|
|
self.put_batch(&PendingDepositEventsCellRef(records), (), batch)
|
|
}
|
|
|
|
pub fn add_pending_deposit_event(&self, event: PendingDepositEventRecord) -> DbResult<bool> {
|
|
let mut records = self.get_pending_deposit_events()?;
|
|
if records
|
|
.iter()
|
|
.any(|record| record.deposit_op_id == event.deposit_op_id)
|
|
{
|
|
return Ok(false);
|
|
}
|
|
records.push(event);
|
|
self.put_pending_deposit_events(&records)?;
|
|
Ok(true)
|
|
}
|
|
|
|
/// Marks the given deposit events submitted in `block_id`, in one write.
|
|
pub fn mark_deposit_events_submitted(
|
|
&self,
|
|
deposit_op_ids: &[HashType],
|
|
submitted_block_id: u64,
|
|
) -> DbResult<()> {
|
|
if deposit_op_ids.is_empty() {
|
|
return Ok(());
|
|
}
|
|
let mut batch = WriteBatch::default();
|
|
self.mark_pending_deposit_events_submitted(deposit_op_ids, submitted_block_id, &mut batch)?;
|
|
self.db.write(batch).map_err(|rerr| {
|
|
DbError::rocksdb_cast_message(
|
|
rerr,
|
|
Some("Failed to mark deposit events submitted".to_owned()),
|
|
)
|
|
})
|
|
}
|
|
|
|
fn mark_pending_deposit_events_submitted(
|
|
&self,
|
|
deposit_op_ids: &[HashType],
|
|
submitted_block_id: u64,
|
|
batch: &mut WriteBatch,
|
|
) -> DbResult<usize> {
|
|
let mut records = self.get_pending_deposit_events()?;
|
|
let mut updated: usize = 0;
|
|
|
|
for record in records
|
|
.iter_mut()
|
|
.filter(|record| deposit_op_ids.contains(&record.deposit_op_id))
|
|
{
|
|
record.submitted_in_block_id = Some(submitted_block_id);
|
|
updated = updated.saturating_add(1);
|
|
}
|
|
|
|
if updated > 0 {
|
|
self.put_pending_deposit_events_batch(&records, batch)?;
|
|
}
|
|
|
|
Ok(updated)
|
|
}
|
|
|
|
pub fn remove_fulfilled_pending_deposit_events_up_to_block(
|
|
&self,
|
|
finalized_block_id: u64,
|
|
) -> DbResult<usize> {
|
|
let mut records = self.get_pending_deposit_events()?;
|
|
let before = records.len();
|
|
records.retain(|record| {
|
|
record
|
|
.submitted_in_block_id
|
|
.is_none_or(|submitted_id| submitted_id > finalized_block_id)
|
|
});
|
|
|
|
let removed = before.saturating_sub(records.len());
|
|
if removed > 0 {
|
|
self.put_pending_deposit_events(&records)?;
|
|
}
|
|
|
|
Ok(removed)
|
|
}
|
|
|
|
/// Whether a bridge deposit for `deposit_op_id` is already recorded as
|
|
/// included in a block (its pending record is marked submitted).
|
|
pub fn is_deposit_event_submitted(&self, deposit_op_id: HashType) -> DbResult<bool> {
|
|
Ok(self.get_pending_deposit_events()?.iter().any(|record| {
|
|
record.deposit_op_id == deposit_op_id && record.submitted_in_block_id.is_some()
|
|
}))
|
|
}
|
|
|
|
fn increment_unseen_withdraw_count(
|
|
&self,
|
|
withdrawal: WithdrawalReconciliationKey,
|
|
batch: &mut WriteBatch,
|
|
) -> DbResult<u64> {
|
|
let current = self
|
|
.get_opt::<UnseenWithdrawCountCell>(withdrawal)?
|
|
.map_or(0, |cell| cell.0);
|
|
|
|
let next = current.checked_add(1).ok_or_else(|| {
|
|
DbError::db_interaction_error("Unseen withdraw counter overflow".to_owned())
|
|
})?;
|
|
|
|
self.put_batch(&UnseenWithdrawCountCell(next), withdrawal, batch)?;
|
|
|
|
Ok(next)
|
|
}
|
|
|
|
pub fn consume_unseen_withdraw_count(
|
|
&self,
|
|
withdrawal: WithdrawalReconciliationKey,
|
|
) -> DbResult<bool> {
|
|
let Some(current) = self
|
|
.get_opt::<UnseenWithdrawCountCell>(withdrawal)?
|
|
.map(|cell| cell.0)
|
|
else {
|
|
return Ok(false);
|
|
};
|
|
|
|
if let Some(next) = current.checked_sub(1) {
|
|
self.put(&UnseenWithdrawCountCell(next), withdrawal)?;
|
|
} else {
|
|
let cf_meta = self.meta_column();
|
|
let db_key =
|
|
<UnseenWithdrawCountCell as SimpleStorableCell>::key_constructor(withdrawal)?;
|
|
|
|
self.db.delete_cf(&cf_meta, db_key).map_err(|rerr| {
|
|
DbError::rocksdb_cast_message(
|
|
rerr,
|
|
Some("Failed to delete unseen withdraw count".to_owned()),
|
|
)
|
|
})?;
|
|
}
|
|
|
|
Ok(true)
|
|
}
|
|
|
|
pub fn put_block(&self, block: &Block, first: bool, batch: &mut WriteBatch) -> DbResult<()> {
|
|
if !first {
|
|
// A produced block is the new head tip by construction: pin the
|
|
// tip meta and drop any stale higher blocks a preceding reorg left
|
|
// behind (mirrors `store_followed_blocks`).
|
|
let last_curr_block = self.get_meta_last_block_in_db()?;
|
|
for stale_id in block.header.block_id.saturating_add(1)..=last_curr_block {
|
|
self.delete_block_payload(stale_id, batch)?;
|
|
}
|
|
self.put_meta_last_block_in_db_batch(block.header.block_id, batch)?;
|
|
self.put_meta_latest_block_meta_batch(&BlockMeta::from(block), batch)?;
|
|
}
|
|
|
|
self.put_block_payload(block, batch)
|
|
}
|
|
|
|
/// Stages deletion of a block payload into `batch`.
|
|
fn delete_block_payload(&self, block_id: u64, batch: &mut WriteBatch) -> DbResult<()> {
|
|
let cf_block = self.block_column();
|
|
batch.delete_cf(
|
|
&cf_block,
|
|
borsh::to_vec(&block_id).map_err(|err| {
|
|
DbError::borsh_cast_message(err, Some("Failed to serialize block id".to_owned()))
|
|
})?,
|
|
);
|
|
Ok(())
|
|
}
|
|
|
|
/// Stages just the block payload into `batch`, without touching the tip meta.
|
|
fn put_block_payload(&self, block: &Block, batch: &mut WriteBatch) -> DbResult<()> {
|
|
let cf_block = self.block_column();
|
|
batch.put_cf(
|
|
&cf_block,
|
|
borsh::to_vec(&block.header.block_id).map_err(|err| {
|
|
DbError::borsh_cast_message(err, Some("Failed to serialize block id".to_owned()))
|
|
})?,
|
|
borsh::to_vec(block).map_err(|err| {
|
|
DbError::borsh_cast_message(err, Some("Failed to serialize block data".to_owned()))
|
|
})?,
|
|
);
|
|
Ok(())
|
|
}
|
|
|
|
pub fn get_block(&self, block_id: u64) -> DbResult<Option<Block>> {
|
|
self.get_opt::<BlockCell>(block_id)
|
|
.map(|opt| opt.map(|val| val.0))
|
|
}
|
|
|
|
/// `(state, meta)` at the last L1-finalized block; `None` until the first
|
|
/// finalization is observed.
|
|
pub fn get_final_snapshot(&self) -> DbResult<Option<(V03State, BlockMeta)>> {
|
|
let Some(meta) = self.get_opt::<FinalBlockMetaCellOwned>(())? else {
|
|
return Ok(None);
|
|
};
|
|
let state = self.get::<FinalLeeStateCellOwned>(())?;
|
|
Ok(Some((state.0, meta.0)))
|
|
}
|
|
|
|
fn put_final_snapshot_batch(
|
|
&self,
|
|
state: &V03State,
|
|
meta: &BlockMeta,
|
|
batch: &mut WriteBatch,
|
|
) -> DbResult<()> {
|
|
self.put_batch(&FinalLeeStateCellRef(state), (), batch)?;
|
|
self.put_batch(&FinalBlockMetaCellRef(meta), (), batch)
|
|
}
|
|
|
|
pub fn get_lee_state(&self) -> DbResult<V03State> {
|
|
self.get::<LEEStateCellOwned>(()).map(|val| val.0)
|
|
}
|
|
|
|
pub fn delete_block(&self, block_id: u64) -> DbResult<()> {
|
|
let cf_block = self.block_column();
|
|
let key = borsh::to_vec(&block_id).map_err(|err| {
|
|
DbError::borsh_cast_message(err, Some("Failed to serialize block id".to_owned()))
|
|
})?;
|
|
|
|
if self
|
|
.db
|
|
.get_cf(&cf_block, &key)
|
|
.map_err(|rerr| DbError::rocksdb_cast_message(rerr, None))?
|
|
.is_none()
|
|
{
|
|
return Err(DbError::db_interaction_error(format!(
|
|
"Block with id {block_id} not found"
|
|
)));
|
|
}
|
|
|
|
self.db
|
|
.delete_cf(&cf_block, key)
|
|
.map_err(|rerr| DbError::rocksdb_cast_message(rerr, None))?;
|
|
|
|
Ok(())
|
|
}
|
|
|
|
/// Mark every pending block with `block_id <= last_finalized` as finalized.
|
|
/// Idempotent — already-finalized blocks are skipped.
|
|
pub fn clean_pending_blocks_up_to(&self, last_finalized: u64) -> DbResult<()> {
|
|
let pending_ids: Vec<u64> = self
|
|
.get_all_blocks()
|
|
.filter_map(Result::ok)
|
|
.filter(|b| matches!(b.bedrock_status, BedrockStatus::Pending))
|
|
.map(|b| b.header.block_id)
|
|
.filter(|id| *id <= last_finalized)
|
|
.collect();
|
|
for id in pending_ids {
|
|
self.mark_block_as_finalized(id)?;
|
|
}
|
|
Ok(())
|
|
}
|
|
|
|
pub fn mark_block_as_finalized(&self, block_id: u64) -> DbResult<()> {
|
|
self.set_block_bedrock_status(block_id, BedrockStatus::Finalized)
|
|
}
|
|
|
|
/// Reset every stored block to [`BedrockStatus::Pending`], for snapshotting a store to replay
|
|
/// against a fresh Bedrock instance that knows none of the blocks yet.
|
|
pub fn reset_all_blocks_to_pending(&self) -> DbResult<()> {
|
|
let block_ids: Vec<u64> = self
|
|
.get_all_blocks()
|
|
.filter_map(Result::ok)
|
|
.filter(|block| !matches!(block.bedrock_status, BedrockStatus::Pending))
|
|
.map(|block| block.header.block_id)
|
|
.collect();
|
|
for id in block_ids {
|
|
self.set_block_bedrock_status(id, BedrockStatus::Pending)?;
|
|
}
|
|
Ok(())
|
|
}
|
|
|
|
fn set_block_bedrock_status(&self, block_id: u64, status: BedrockStatus) -> DbResult<()> {
|
|
let mut block = self.get_block(block_id)?.ok_or_else(|| {
|
|
DbError::db_interaction_error(format!("Block with id {block_id} not found"))
|
|
})?;
|
|
block.bedrock_status = status;
|
|
|
|
let cf_block = self.block_column();
|
|
self.db
|
|
.put_cf(
|
|
&cf_block,
|
|
borsh::to_vec(&block_id).map_err(|err| {
|
|
DbError::borsh_cast_message(
|
|
err,
|
|
Some("Failed to serialize block id".to_owned()),
|
|
)
|
|
})?,
|
|
borsh::to_vec(&block).map_err(|err| {
|
|
DbError::borsh_cast_message(
|
|
err,
|
|
Some("Failed to serialize block data".to_owned()),
|
|
)
|
|
})?,
|
|
)
|
|
.map_err(|rerr| {
|
|
DbError::rocksdb_cast_message(
|
|
rerr,
|
|
Some(format!("Failed to set block {block_id} bedrock status")),
|
|
)
|
|
})?;
|
|
|
|
Ok(())
|
|
}
|
|
|
|
/// One-block form of [`Self::store_followed_blocks`], with the block as the
|
|
/// head tip and no final snapshot. Production always uses the batch form.
|
|
#[cfg(test)]
|
|
fn store_followed_block(
|
|
&self,
|
|
block: &Block,
|
|
state: &V03State,
|
|
finalized: bool,
|
|
) -> DbResult<()> {
|
|
self.store_followed_blocks(
|
|
&[(block, finalized)],
|
|
Some(&BlockMeta::from(block)),
|
|
state,
|
|
None,
|
|
)
|
|
}
|
|
|
|
/// Persists a batch of followed blocks, the caller's head-tip `state`, and
|
|
/// the optional final-tier snapshot in one atomic write.
|
|
///
|
|
/// The tip meta is pinned to `head_tip`, and blocks stored above it (left
|
|
/// behind by a net-shortening reorg) are deleted in the same write, so
|
|
/// restart replay never walks past the tip.
|
|
///
|
|
/// Per block: skips the payload write when the store already holds it (by
|
|
/// id and hash), unless `finalized` is set, which rewrites it with the
|
|
/// finalized status. A no-op update (nothing to write, tip unchanged)
|
|
/// writes nothing.
|
|
///
|
|
/// TODO: the zone-sdk checkpoint is persisted by `on_checkpoint` *before*
|
|
/// this write. Full `BlocksProcessed` atomicity (checkpoint, blocks, state
|
|
/// and orphan reverts in one batch) is a follow-up.
|
|
pub fn store_followed_blocks(
|
|
&self,
|
|
blocks: &[(&Block, bool)],
|
|
head_tip: Option<&BlockMeta>,
|
|
state: &V03State,
|
|
final_snapshot: Option<(&V03State, &BlockMeta)>,
|
|
) -> DbResult<()> {
|
|
let last_block_in_db = self.get_meta_last_block_in_db()?;
|
|
let mut batch = WriteBatch::default();
|
|
|
|
for (block, finalized) in blocks {
|
|
let already_stored = self
|
|
.get_block(block.header.block_id)?
|
|
.filter(|stored| stored.header.hash == block.header.hash);
|
|
|
|
let mut to_write = match already_stored {
|
|
Some(_) if !finalized => continue,
|
|
Some(stored) => stored,
|
|
None => (*block).clone(),
|
|
};
|
|
if *finalized {
|
|
to_write.bedrock_status = BedrockStatus::Finalized;
|
|
}
|
|
self.put_block_payload(&to_write, &mut batch)?;
|
|
}
|
|
|
|
// A shrink-only update (orphans without adopted replacements) has no
|
|
// payloads to write but must still rewind the tip meta, or the stored
|
|
// state tears against the stale disk head on the next produce.
|
|
let tip_rewound = head_tip.is_some_and(|tip| tip.id < last_block_in_db);
|
|
if batch.is_empty() && final_snapshot.is_none() && !tip_rewound {
|
|
return Ok(());
|
|
}
|
|
|
|
if let Some(tip) = head_tip {
|
|
for stale_id in tip.id.saturating_add(1)..=last_block_in_db {
|
|
self.delete_block_payload(stale_id, &mut batch)?;
|
|
}
|
|
self.put_meta_last_block_in_db_batch(tip.id, &mut batch)?;
|
|
self.put_meta_latest_block_meta_batch(tip, &mut batch)?;
|
|
}
|
|
self.put_lee_state_in_db_batch(state, &mut batch)?;
|
|
if let Some((final_state, final_meta)) = final_snapshot {
|
|
self.put_final_snapshot_batch(final_state, final_meta, &mut batch)?;
|
|
}
|
|
|
|
self.db.write(batch).map_err(|rerr| {
|
|
DbError::rocksdb_cast_message(
|
|
rerr,
|
|
Some("Failed to write followed blocks batch".to_owned()),
|
|
)
|
|
})
|
|
}
|
|
|
|
pub fn get_all_blocks(&self) -> impl Iterator<Item = DbResult<Block>> {
|
|
let cf_block = self.block_column();
|
|
self.db
|
|
.iterator_cf(&cf_block, rocksdb::IteratorMode::Start)
|
|
.map(|res| {
|
|
let (_key, value) = res.map_err(|rerr| {
|
|
DbError::rocksdb_cast_message(
|
|
rerr,
|
|
Some("Failed to get key value pair".to_owned()),
|
|
)
|
|
})?;
|
|
|
|
borsh::from_slice::<Block>(&value).map_err(|err| {
|
|
DbError::borsh_cast_message(
|
|
err,
|
|
Some("Failed to deserialize block data".to_owned()),
|
|
)
|
|
})
|
|
})
|
|
}
|
|
|
|
pub fn atomic_update(
|
|
&self,
|
|
block: &Block,
|
|
deposit_op_ids: &[HashType],
|
|
withdrawals: Vec<WithdrawalReconciliationKey>,
|
|
state: &V03State,
|
|
) -> DbResult<()> {
|
|
let block_id = block.header.block_id;
|
|
let mut batch = WriteBatch::default();
|
|
|
|
self.put_block(block, false, &mut batch)?;
|
|
|
|
self.mark_pending_deposit_events_submitted(deposit_op_ids, block_id, &mut batch)?;
|
|
|
|
for withdrawal in withdrawals {
|
|
self.increment_unseen_withdraw_count(withdrawal, &mut batch)?;
|
|
}
|
|
|
|
self.put_lee_state_in_db_batch(state, &mut batch)?;
|
|
|
|
self.db.write(batch).map_err(|rerr| {
|
|
DbError::rocksdb_cast_message(
|
|
rerr,
|
|
Some(format!("Failed to udpate db with block {block_id}")),
|
|
)
|
|
})
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod tests;
|