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/README.md

53 lines
2.6 KiB
Markdown
Raw Normal View History

Ledger abstraction for accounts cache (#1824) * Provide TDD/debug facility for inspecting `persistBlocks()` working detail: + Make sure that the last block of a test sample is the first batch item in `persistBlocks()`. + Additionally, allow `AccountsCache` API tracing by setting the flag `extraTraceMessages = true` in the file `accounts_cache.nim` * Overload AccountsCache by abstraction wrapper details: Can facilitate CoreDb API switch, details in `ledger/README.md`.
2023-10-18 19:27:22 +00:00
The file `accounts_cache.nim` has been relocated
================================================
Background
----------
The new *LedgerRef* module unifies different implementations of the
Aristo resume off line syncing on pre loaded database (#2203) * Update some docu & messages * Remove cruft from the ledger modules * Must not overwrite genesis data on an initialised database why: This will overwrite the global state of the Aristo single state DB. Otherwise resuming at the last synced state becomes impossible. * Provide latest block number from journal why: This relates the global state of the DB directly to the corresponding block number. * Implemented unit test providing DB pre-load and resume
2024-05-22 13:41:14 +00:00
legacy *accounts_cache*. It is intended to be used as new base method for
all of the *AccountsCache* implementations. The legacy *accounts_cache*
version has been removed.
Ledger abstraction for accounts cache (#1824) * Provide TDD/debug facility for inspecting `persistBlocks()` working detail: + Make sure that the last block of a test sample is the first batch item in `persistBlocks()`. + Additionally, allow `AccountsCache` API tracing by setting the flag `extraTraceMessages = true` in the file `accounts_cache.nim` * Overload AccountsCache by abstraction wrapper details: Can facilitate CoreDb API switch, details in `ledger/README.md`.
2023-10-18 19:27:22 +00:00
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(..) |
| | |