feat: trait-based storage API #12616

klkvr · 2024-11-17T20:55:42Z

This PR introduces a way to customize how DatabaseProvider writes primitive types to storage. This is done by introducing the following traits:

reth/crates/storage/storage-api/src/chain.rs

Lines 12 to 34 in 0f40ad2

    
           /// Trait that implements how block bodies are written to the storage. 
        
           /// 
        
           /// Note: Within the current abstraction, this should only write to tables unrelated to 
        
           /// transactions. Writing of transactions is handled separately. 
        
           #[auto_impl::auto_impl(&, Arc)] 
        
           pub trait BlockBodyWriter<Provider, Body: BlockBody> { 
        
               /// Writes a set of block bodies to the storage. 
        
               fn write_block_bodies( 
        
                   &self, 
        
                   provider: &Provider, 
        
                   bodies: Vec<(BlockNumber, Option<Body>)>, 
        
               ) -> ProviderResult<()>; 
        
           } 
        
           /// Trait that implements how chain-specific types are written to the storage. 
        
           pub trait ChainStorageWriter<Provider, Primitives: FullNodePrimitives>: 
        
               BlockBodyWriter<Provider, <Primitives::Block as Block>::Body> 
        
           { 
        
           } 
        
           impl<T, Provider, Primitives: FullNodePrimitives> ChainStorageWriter<Provider, Primitives> for T where 
        
               T: BlockBodyWriter<Provider, <Primitives::Block as Block>::Body> 
        
           { 
        
           }

Those are generic over provider and primitive types and allow to define type that given a specifc provider implementation knows how to use it to write given object to database.

Additionaly we define the actual ChainStorage trait which is responsible for giving DatabaseProvider the storage implementations:

reth/crates/storage/provider/src/providers/database/chain.rs

Lines 7 to 14 in 0f40ad2

    
           /// Trait that provides access to implementations of [`ChainStorage`] 
        
           pub trait ChainStorage<Primitives: FullNodePrimitives>: Send + Sync { 
        
               /// Provides access to the chain writer. 
        
               fn writer<TX, Types>(&self) -> impl ChainStorageWriter<DatabaseProvider<TX, Types>, Primitives> 
        
               where 
        
                   TX: DbTxMut + DbTx + 'static, 
        
                   Types: NodeTypes<Primitives = Primitives>; 
        
           }

This trait is required due to DatabaseProvider being generic over TX and Types and thus not allowing us to express requirements through just a single bound like Storage: ChainStorage<DatabaseProvider<???, N>, N::Primitives>

Co-authored-by: joshie <[email protected]>

klkvr and others added 2 commits November 18, 2024 00:47

wip

6fcf6f8

Co-authored-by: joshie <[email protected]>

simplify bounds

0f40ad2

klkvr requested review from joshieDo, rkrasiuk, rakita, shekhirin, onbjerg, Rjected, mattsse, fgimenez, emhane and gakonst as code owners November 17, 2024 20:55

klkvr added 2 commits November 18, 2024 01:06

fix

a366bfd

fix

773c43a

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: trait-based storage API #12616

feat: trait-based storage API #12616

klkvr commented Nov 17, 2024

	/// Trait that implements how block bodies are written to the storage.
	///
	/// Note: Within the current abstraction, this should only write to tables unrelated to
	/// transactions. Writing of transactions is handled separately.
	#[auto_impl::auto_impl(&, Arc)]
	pub trait BlockBodyWriter<Provider, Body: BlockBody> {
	/// Writes a set of block bodies to the storage.
	fn write_block_bodies(
	&self,
	provider: &Provider,
	bodies: Vec<(BlockNumber, Option<Body>)>,
	) -> ProviderResult<()>;
	}

	/// Trait that implements how chain-specific types are written to the storage.
	pub trait ChainStorageWriter<Provider, Primitives: FullNodePrimitives>:
	BlockBodyWriter<Provider, <Primitives::Block as Block>::Body>
	{
	}
	impl<T, Provider, Primitives: FullNodePrimitives> ChainStorageWriter<Provider, Primitives> for T where
	T: BlockBodyWriter<Provider, <Primitives::Block as Block>::Body>
	{
	}

	/// Trait that provides access to implementations of [`ChainStorage`]
	pub trait ChainStorage<Primitives: FullNodePrimitives>: Send + Sync {
	/// Provides access to the chain writer.
	fn writer<TX, Types>(&self) -> impl ChainStorageWriter<DatabaseProvider<TX, Types>, Primitives>
	where
	TX: DbTxMut + DbTx + 'static,
	Types: NodeTypes<Primitives = Primitives>;
	}

feat: trait-based storage API #12616

Are you sure you want to change the base?

feat: trait-based storage API #12616

Conversation

klkvr commented Nov 17, 2024