status-im
/
nimbus-eth1
mirror of https://github.com/status-im/nimbus-eth1.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
nimbus-eth1/nimbus/db/ledger
History
Jordan Hrycaj 587ca3abbe
Coredb use stackable api for aristo backend (#2060) 
* Aristo/Kvt: Provide function hooks APIs

why:
  These APIs can be used for installing tracers, profiling functoinality,
  and other niceties on the databases.

* Aristo: Provide optional API profiling

details:
  It basically is a re-implementation of the `CoreDb` profiling
  implementation

* Kvt: Provide optional API profiling similar to `Aristo`

* CoreDb: Re-implementing profiling using `aristo_profile`

* Ledger: Re-implementing profiling using `aristo_profile`

* CoreDb: Update unit tests for maintainability

* update copyright dates
 		2024-02-29 21:10:24 +00:00
..
backend Implement getAccessList of db/ledger (#2055) 2024-02-29 18:16:47 +07:00
base Coredb use stackable api for aristo backend (#2060) 2024-02-29 21:10:24 +00:00
.gitignore Add check copyright year linter to CI 2023-11-01 10:41:20 +07:00
README.md Ledger abstraction for accounts cache (#1824) 2023-10-18 20:27:22 +01:00
accounts_cache.nim Implement getAccessList of db/ledger (#2055) 2024-02-29 18:16:47 +07:00
accounts_ledger.nim Implement getAccessList of db/ledger (#2055) 2024-02-29 18:16:47 +07:00
base.nim Coredb use stackable api for aristo backend (#2060) 2024-02-29 21:10:24 +00:00
base_iterators.nim Core db+ledger aristo backend update (#2006) 2024-02-02 20:23:04 +00:00
distinct_ledgers.nim Add style check to config.nims and fix styles in source code (#2038) 2024-02-20 10:07:38 +07:00

README.md

The file accounts_cache.nim has been relocated

Background

The new LedgerRef module unifies different implementations of the accounts_cache. It is intended to be used as new base method for all of the AccountsCache implementations. Only constructors differ, depending on the implementation.

This was needed to accomodate for different CoreDb API paradigms. While the overloaded legacy AccountsCache implementation is just a closure based wrapper around the accounts_cache module, the overloaded AccountsLedgerRef is a closure based wrapper around the accounts_ledger module with the new CoreDb API returning Result[] values and saparating the meaning of trie root hash and trie root reference.

This allows to use the legacy hexary database (with the new CoreDb API) as well as the Aristo database (only supported on new API.)

Instructions

Legacy notation LedgerRef replacement Comment
import accounts_cache import ledger preferred method,
AccountsCache.init(..) AccountsCache.init(..) wraps AccountsCache
methods
or
import ledger/accounts_cache stay with legacy
AccountsCache.init(..) version of
AccountsCache
--
fn(ac: AccountsCache) fn(ac: LedgerRef) function example for
preferred wrapper
or method
fn(ac: AccountsCache) with legacy version,
no change here

The constructor decides which CoreDb API is to be used

Legacy API constructor new API Constructor
import ledger import ledger
let w = AccountsCache.init(..) let w = AccountsLedgerRef.init(..)