mirror of https://github.com/status-im/nimbus-eth1.git synced 2025-01-10 04:15:54 +00:00

Core db+aristo provides tracer funtionality (#2089 )

* Aristo: Provide descriptor fork based on search in transaction stack

details:
  Try to find the tx that has a particular pair `(vertex-id,hash-key)`,
  and by extension try filter and backend if the former fails.

* Cleanup & docu

* CoreDb+Aristo: Implement context re-position to earlier in-memory state

why:
  It is a easy way to explore how there can be concurrent access to the
  same backend storage DB with different view states. This one can access
  an earlier state from the transaction stack.

* CoreDb+Aristo: Populate tracer stubs with real functionality

* Update `tracer.nim` to new API

why:
  Legacy API does not sufficiently support `Aristo`

* Fix logging problems in tracer

details:
  Debug logging turned off by default

* Fix function prototypes

* Add Copyright header

* Add tables import

why:
  For older compiler versions on CI

2024-03-21 10:45:57 +00:00

3.5 KiB

Raw Blame History

Core database replacement wrapper object

This wrapper replaces the TrieDatabaseRef and its derivatives by the new object CoreDbRef.

Relations to current TrieDatabaseRef implementation

Here are some incomplete translations for objects and constructors.

Object types:

Legacy notation	CoreDbRef based replacement

ChainDB	(don't use/avoid)
ChainDbRef	CoreDbRef
TrieDatabaseRef	CoreDbKvtRef
HexaryTrie	CoreDbMptRef
SecureHexaryTrie	CoreDbPhkRef
DbTransaction	CoreDbTxRef
TransactionID	CoreDbTxID

Constructors:

Legacy notation	CoreDbRef based replacement

trieDB newChainDB("..")	newCoreDbRef(LegacyDbPersistent,"..")
newMemoryDB()	newCoreDbRef(LegacyDbMemory)
--
initHexaryTrie(db,..)	db.mpt(..) (no pruning)
	db.mptPrune(..) (w/pruning true/false)
--
initSecureHexaryTrie(db,..)	db.phk(..) (no pruning)
	db.phkPrune(..) (w/pruning true/false)
--
newCaptureDB(db,memDB)	db.capture() (see below)

Usage of the replacement wrapper

Objects pedigree:

    CoreDbRef                        -- base descriptor
     | | |
     | | +--- CoreDbCtxRef           -- MPT context descriptor
     | |        | |
     | |        | +-- CoreDbMptRef   -- hexary trie instance
     | |        | |    :                    :
     | |        | +-- CoreDbMptRef   -- hexary trie instance
     | |        |
     | |        |
     | |        +---- CoreDbPhkRef   -- pre-hashed key hexary trie instance
     | |        |      :                    :
     | |        +---- CoreDbPhkRef   -- pre-hashed key hexary trie instance
     | |
     | |
     | +------ CoreDbKvtRef          -- single static key-value table
     |
     |
     +-------- CoreDbCaptRef         -- tracer support descriptor

Instantiating legacy standard database object descriptors works as follows:

    let
      db = newCoreDbRef(..)           # new base descriptor
      mpt = db.mpt(..)                # hexary trie/Merkle Patricia Tree
      phk = db.phk(..)                # pre-hashed key hexary trie/MPT
      kvt = db.kvt                    # key-value table

Tracer support setup by hiding the current CoreDbRef behind a replacement:

    let
      capture = db.capture()
      db = capture.recorder           # use the recorder in place of db
    ...

    for key,value in capture.recorder.kvt:
     ...                              # process recorded data

3.5 KiB Raw Blame History