From 51577d4972e29ae7b652aa2b0f798984dc941b9c Mon Sep 17 00:00:00 2001 From: James Date: Fri, 1 Aug 2025 15:43:52 -0400 Subject: [PATCH 1/2] chore: some db readme --- crates/db/README.md | 17 +++++++++++++++++ crates/db/src/chain.rs | 2 +- crates/db/src/lib.rs | 11 ++--------- crates/db/src/traits.rs | 21 +-------------------- 4 files changed, 21 insertions(+), 30 deletions(-) create mode 100644 crates/db/README.md diff --git a/crates/db/README.md b/crates/db/README.md new file mode 100644 index 0000000..04f59dc --- /dev/null +++ b/crates/db/README.md @@ -0,0 +1,17 @@ +# Signet Database + +Extensions and modifications to reth's Database system for use in the Signet +Node. + +This library contains the following: + +- Traits for reading and writing Signet events +- Table definitions for Signet Events, Headers, and JournalHashes +- Helpers for reading, writing, reverting, Signet EVM blocks and headers + +## Significant Traits + +- `RuWriter` - Encapsulates logic for reading and writing Signet events, state, + headers, etc. +- `DbProviderExt` - Extends the reth `DatabaseProviderRW` with a scope-guarded + `update` method. diff --git a/crates/db/src/chain.rs b/crates/db/src/chain.rs index a51d37b..b32a929 100644 --- a/crates/db/src/chain.rs +++ b/crates/db/src/chain.rs @@ -16,7 +16,7 @@ pub struct DbExtractionResults { pub enter_tokens: Vec, } -/// Equivalent of [`Chain`] but also containing zenith headers. +/// Equivalent of [`Chain`] but also containing zenith events and information. #[derive(Debug, Clone, Default, PartialEq, Eq)] pub struct RuChain { /// Inner chain of RU blocks. diff --git a/crates/db/src/lib.rs b/crates/db/src/lib.rs index 2153caf..976343a 100644 --- a/crates/db/src/lib.rs +++ b/crates/db/src/lib.rs @@ -1,11 +1,4 @@ -//! Database access for Signet Node. -//! -//! This library contains the following: -//! -//! - Traits for reading and writing Signet events -//! - Table definitions for Signet Events and Headers -//! - Helpers for reading and writing Signet EVM blocks and headers - +#![doc = include_str!("../README.md")] #![warn( missing_copy_implementations, missing_debug_implementations, @@ -33,4 +26,4 @@ pub use tables::{ }; mod traits; -pub use traits::{DbProviderExt, RuEnterReader, RuWriter}; +pub use traits::{DbProviderExt, RuWriter}; diff --git a/crates/db/src/traits.rs b/crates/db/src/traits.rs index 2cc221e..1bf7005 100644 --- a/crates/db/src/traits.rs +++ b/crates/db/src/traits.rs @@ -10,28 +10,9 @@ use signet_evm::BlockResult; use signet_node_types::{NodeTypesDbTrait, SignetNodeTypes}; use signet_types::primitives::RecoveredBlock; use signet_zenith::{Passage, Transactor, Zenith}; -use std::{ - collections::BTreeMap, - ops::{RangeBounds, RangeInclusive}, -}; +use std::{collections::BTreeMap, ops::RangeInclusive}; use tracing::trace; -/// Reader for [`Passage::Enter`] events stored in the DB. -pub trait RuEnterReader { - /// Get an enter by height and index. - fn enter_by_height_and_index( - &self, - height: u64, - index: u64, - ) -> ProviderResult>; - - /// Get enters by height. - fn get_enters_by_height( - &self, - height: impl RangeBounds + Clone, - ) -> ProviderResult>; -} - /// Writer for [`Passage::Enter`] events. pub trait RuWriter { /// Get the last block number From adc0c6bf402d02a03e52af1038bcfb115de33afd Mon Sep 17 00:00:00 2001 From: James Date: Fri, 1 Aug 2025 15:48:54 -0400 Subject: [PATCH 2/2] fix: add datacompat --- crates/db/README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/crates/db/README.md b/crates/db/README.md index 04f59dc..cf95ed3 100644 --- a/crates/db/README.md +++ b/crates/db/README.md @@ -15,3 +15,5 @@ This library contains the following: headers, etc. - `DbProviderExt` - Extends the reth `DatabaseProviderRW` with a scope-guarded `update` method. +- `DataCompat` - Provides methods for converting between Signet and reth data + structures, such as `ExecutionOutcome` and `Receipt`.