pmmiranda 411a3cadfa
Renamed 'nimbus' directory and its references to 'execution_chain' (#3052)
* renamed nimbus folder to execution_chain

* Renamed "nimbus" references to "execution_chain"

* fixed wrongly changed http reference

* delete snap types file given that it was deleted before this PR merge

* missing 'execution_chain' replacement

---------

Co-authored-by: pmmiranda <pedro.miranda@nimbus.team>
2025-02-11 22:28:42 +00:00

129 lines
4.3 KiB
Nim

# nimbus-eth1
# Copyright (c) 2023-2025 Status Research & Development GmbH
# Licensed under either of
# * Apache License, version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or
# http://www.apache.org/licenses/LICENSE-2.0)
# * MIT license ([LICENSE-MIT](LICENSE-MIT) or
# http://opensource.org/licenses/MIT)
# at your option. This file may not be copied, modified, or distributed
# except according to those terms.
## Read vertex record on the layered Aristo DB delta architecture
## ==============================================================
{.push raises: [].}
import
results,
"."/[aristo_desc, aristo_layers]
# ------------------------------------------------------------------------------
# Public functions
# ------------------------------------------------------------------------------
proc getTuvBe*(
db: AristoDbRef;
): Result[VertexID,AristoError] =
## Get the ID generator state from the backened if available.
let be = db.backend
if not be.isNil:
return be.getTuvFn()
err(GetTuvNotFound)
proc getLstBe*(
db: AristoDbRef;
): Result[SavedState,AristoError] =
## Get the last saved state
let be = db.backend
if not be.isNil:
return be.getLstFn()
err(GetLstNotFound)
proc getVtxBe*(
db: AristoDbRef;
rvid: RootedVertexID;
flags: set[GetVtxFlag] = {};
): Result[VertexRef,AristoError] =
## Get the vertex from the backened if available.
let be = db.backend
if not be.isNil:
return be.getVtxFn(rvid, flags)
err GetVtxNotFound
proc getKeyBe*(
db: AristoDbRef;
rvid: RootedVertexID;
flags: set[GetVtxFlag];
): Result[(HashKey, VertexRef),AristoError] =
## Get the Merkle hash/key from the backend if available.
let be = db.backend
if not be.isNil:
return be.getKeyFn(rvid, flags)
err GetKeyNotFound
# ------------------
proc getVtxRc*(
db: AristoTxRef;
rvid: RootedVertexID;
flags: set[GetVtxFlag] = {};
): Result[(VertexRef, int),AristoError] =
## Cascaded attempt to fetch a vertex from the cache layers or the backend.
##
block body:
# If the vertex marked is to be deleted on the backend, a `VertexRef(nil)`
# entry is kept in the local table in which case it is returned as the
# error symbol `GetVtxNotFound`.
let vtx = db.layersGetVtx(rvid).valueOr:
break body
if vtx[0].isValid:
return ok vtx
else:
return err(GetVtxNotFound)
ok (?db.db.getVtxBe(rvid, flags), -2)
proc getVtx*(db: AristoTxRef; rvid: RootedVertexID, flags: set[GetVtxFlag] = {}): VertexRef =
## Cascaded attempt to fetch a vertex from the cache layers or the backend.
## The function returns `nil` on error or failure.
##
db.getVtxRc(rvid).valueOr((VertexRef(nil), 0))[0]
proc getKeyRc*(
db: AristoTxRef; rvid: RootedVertexID, flags: set[GetVtxFlag]): Result[((HashKey, VertexRef), int),AristoError] =
## Cascaded attempt to fetch a Merkle hash from the cache layers or the
## backend. This function will never return a `VOID_HASH_KEY` but rather
## some `GetKeyNotFound` or `GetKeyUpdateNeeded` error.
##
block body:
let key = db.layersGetKey(rvid).valueOr:
break body
# If there is a zero key value, the entry is either marked for being
# updated or for deletion on the database. So check below.
if key[0].isValid:
return ok ((key[0], nil), key[1])
# The zero key value does not refer to an update mark if there is no
# valid vertex (either on the cache or the backend whatever comes first.)
let vtx = db.layersGetVtx(rvid).valueOr:
# There was no vertex on the cache. So there must be one the backend (the
# reason for the key label to exists, at all.)
return err(GetKeyNotFound)
if vtx[0].isValid:
return ok ((VOID_HASH_KEY, vtx[0]), vtx[1])
else:
# The vertex is to be deleted. So is the value key.
return err(GetKeyNotFound)
ok (?db.db.getKeyBe(rvid, flags), -2)
proc getKey*(db: AristoTxRef; rvid: RootedVertexID): HashKey =
## Cascaded attempt to fetch a vertex from the cache layers or the backend.
## The function returns `nil` on error or failure.
##
(db.getKeyRc(rvid, {}).valueOr(((VOID_HASH_KEY, nil), 0)))[0][0]
# ------------------------------------------------------------------------------
# End
# ------------------------------------------------------------------------------