Struct reth_provider::providers::DatabaseProviderRW

source · 
pub struct DatabaseProviderRW<DB: Database>(pub DatabaseProvider<<DB as Database>::TXMut>);
Expand description

A DatabaseProvider that holds a read-write database transaction.

Ideally this would be an alias type. However, there’s some weird compiler error (https://github.com/rust-lang/rust/issues/102211), that forces us to wrap this in a struct instead. Once that issue is solved, we can probably revert back to being an alias type.

Tuple Fields§

§0: DatabaseProvider<<DB as Database>::TXMut>

Implementations§

source§

impl<DB: Database> DatabaseProviderRW<DB>

source

pub fn commit(self) -> ProviderResult<bool>

Commit database transaction and static file if it exists.

source

pub fn into_tx(self) -> <DB as Database>::TXMut

Consume DbTx or DbTxMut.

source§

impl<DB: Database> DatabaseProviderRW<DB>

source

pub fn insert_historical_block( &self, block: SealedBlockWithSenders, ) -> ProviderResult<StoredBlockBodyIndices>

Inserts an historical block. Used for setting up test environments

Methods from Deref<Target = DatabaseProvider<<DB as Database>::TXMut>>§

source

pub fn static_file_provider(&self) -> &StaticFileProvider

Returns a static file provider

source

pub fn prune_modes_ref(&self) -> &PruneModes

Returns reference to prune modes.

source

pub fn tx_mut(&mut self) -> &mut TX

Pass DbTx or DbTxMut mutable reference.

source

pub fn tx_ref(&self) -> &TX

Pass DbTx or DbTxMut immutable reference.

source

pub fn chain_spec(&self) -> &ChainSpec

Returns a reference to the [ChainSpec].

source

pub fn table<T: Table>(&self) -> Result<Vec<KeyValue<T>>, DatabaseError>
where T::Key: Default + Ord,

Return full table as Vec

source

pub fn get<T: Table>( &self, range: impl RangeBounds<T::Key>, ) -> Result<Vec<KeyValue<T>>, DatabaseError>

Return a list of entries from the table, based on the given range.

source

pub fn get_block_range( &self, range: impl RangeBounds<BlockNumber> + Clone, ) -> ProviderResult<Vec<SealedBlockWithSenders>>

Get the given range of blocks.

source

pub fn get_state( &self, range: RangeInclusive<BlockNumber>, ) -> ProviderResult<Option<ExecutionOutcome>>

Return the last N blocks of state, recreating the ExecutionOutcome.

  1. Iterate over the BlockBodyIndices table to get all the transaction ids.
  2. Iterate over the StorageChangeSets table and the AccountChangeSets tables in reverse order to reconstruct the changesets.
    • In order to have both the old and new values in the changesets, we also access the plain state tables.
  3. While iterating over the changeset tables, if we encounter a new account or storage slot, we:
    1. Take the old value from the changeset
    2. Take the new value from the plain state
    3. Save the old value to the local state
  4. While iterating over the changeset tables, if we encounter an account/storage slot we have seen before we:
    1. Take the old value from the changeset
    2. Take the new value from the local state
    3. Set the local state to the value in the changeset

If the range is empty, or there are no blocks for the given range, then this returns None.

source

pub fn remove_state( &self, range: RangeInclusive<BlockNumber>, ) -> ProviderResult<()>

Remove the last N blocks of state.

The latest state will be unwound

  1. Iterate over the BlockBodyIndices table to get all the transaction ids.
  2. Iterate over the StorageChangeSets table and the AccountChangeSets tables in reverse order to reconstruct the changesets.
    • In order to have both the old and new values in the changesets, we also access the plain state tables.
  3. While iterating over the changeset tables, if we encounter a new account or storage slot, we:
    1. Take the old value from the changeset
    2. Take the new value from the plain state
    3. Save the old value to the local state
  4. While iterating over the changeset tables, if we encounter an account/storage slot we have seen before we:
    1. Take the old value from the changeset
    2. Take the new value from the local state
    3. Set the local state to the value in the changeset
source

pub fn take_state( &self, range: RangeInclusive<BlockNumber>, ) -> ProviderResult<ExecutionOutcome>

Take the last N blocks of state, recreating the ExecutionOutcome.

The latest state will be unwound and returned back with all the blocks

  1. Iterate over the BlockBodyIndices table to get all the transaction ids.
  2. Iterate over the StorageChangeSets table and the AccountChangeSets tables in reverse order to reconstruct the changesets.
    • In order to have both the old and new values in the changesets, we also access the plain state tables.
  3. While iterating over the changeset tables, if we encounter a new account or storage slot, we:
    1. Take the old value from the changeset
    2. Take the new value from the plain state
    3. Save the old value to the local state
  4. While iterating over the changeset tables, if we encounter an account/storage slot we have seen before we:
    1. Take the old value from the changeset
    2. Take the new value from the local state
    3. Set the local state to the value in the changeset
source

pub fn remove<T: Table>( &self, range: impl RangeBounds<T::Key>, ) -> Result<usize, DatabaseError>

Remove list of entries from the table. Returns the number of entries removed.

source

pub fn take<T: Table>( &self, range: impl RangeBounds<T::Key>, ) -> Result<Vec<KeyValue<T>>, DatabaseError>

Return a list of entries from the table, and remove them, based on the given range.

source

pub fn remove_block_transaction_range( &self, range: impl RangeBounds<BlockNumber> + Clone, ) -> ProviderResult<()>

Remove requested block transactions, without returning them.

This will remove block data for the given range from the following tables:

source

pub fn take_block_transaction_range( &self, range: impl RangeBounds<BlockNumber> + Clone, ) -> ProviderResult<Vec<(BlockNumber, Vec<TransactionSignedEcRecovered>)>>

Get requested blocks transaction with senders, also removing them from the database

This will remove block data for the given range from the following tables:

source

pub fn remove_block_range( &self, range: impl RangeBounds<BlockNumber> + Clone, ) -> ProviderResult<()>

Remove the given range of blocks, without returning any of the blocks.

This will remove block data for the given range from the following tables:

This will also remove transaction data according to remove_block_transaction_range.

source

pub fn take_block_range( &self, range: impl RangeBounds<BlockNumber> + Clone, ) -> ProviderResult<Vec<SealedBlockWithSenders>>

Remove the given range of blocks, and return them.

This will remove block data for the given range from the following tables:

This will also remove transaction data according to take_block_transaction_range.

source

pub fn unwind_table_by_num<T>(&self, num: u64) -> Result<usize, DatabaseError>
where T: Table<Key = u64>,

Unwind table by some number key. Returns number of rows unwound.

Note: Key is not inclusive and specified key would stay in db.

source

pub fn unwind_table_by_walker<T1, T2>( &self, range: impl RangeBounds<T1::Key>, ) -> Result<(), DatabaseError>
where T1: Table, T2: Table<Key = T1::Value>,

Unwind a table forward by a [Walker][reth_db_api::cursor::Walker] on another table.

Note: Range is inclusive and first key in the range is removed.

Trait Implementations§

source§

impl<DB: Database> AsRef<DatabaseProvider<<DB as Database>::TXMut>> for DatabaseProviderRW<DB>

source§

fn as_ref(&self) -> &DatabaseProvider<<DB as Database>::TXMut>

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl<DB: Debug + Database> Debug for DatabaseProviderRW<DB>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<DB: Database> Deref for DatabaseProviderRW<DB>

source§

type Target = DatabaseProvider<<DB as Database>::TXMut>

The resulting type after dereferencing.
source§

fn deref(&self) -> &Self::Target

Dereferences the value.
source§

impl<DB: Database> DerefMut for DatabaseProviderRW<DB>

source§

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.
source§

impl<DB: Database> From<DatabaseProviderRW<DB>> for DatabaseProvider<<DB as Database>::TXMut>

source§

fn from(provider: DatabaseProviderRW<DB>) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

§

impl<DB> Freeze for DatabaseProviderRW<DB>
where <DB as Database>::TXMut: Freeze,

§

impl<DB> !RefUnwindSafe for DatabaseProviderRW<DB>

§

impl<DB> Send for DatabaseProviderRW<DB>

§

impl<DB> Sync for DatabaseProviderRW<DB>

§

impl<DB> Unpin for DatabaseProviderRW<DB>
where <DB as Database>::TXMut: Unpin,

§

impl<DB> !UnwindSafe for DatabaseProviderRW<DB>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> Conv for T

§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
§

impl<T> FmtForward for T

§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pipe for T
where T: ?Sized,

§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> Same for T

source§

type Output = T

Should always be Self
§

impl<T> Tap for T

§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
§

impl<T> TryConv for T

§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
§

impl<T> MaybeDebug for T
where T: Debug,

Layout§

Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.