nimbus-eth1/nimbus/db/aristo/aristo_serialise.nim
Jacek Sieka 58cde36656
Remove RawData from possible leaf payload types (#2794)
This kind of data is not used except in tests where it is used only to
create databases that don't match actual usage of aristo.

Removing simplifies future optimizations that can focus on processing
specific leaf types more efficiently.

A casualty of this removal is some test code as well as some proof
generation code that is unused - on the surface, it looks like it should
be possible to port both of these to the more specific data types -
doing so would ensure that a database written by one part of the
codebase can interact with the other - as it stands, there is confusion
on this point since using the proof generation code will result in a
database of a shape that is incompatible with the rest of eth1.
2024-11-02 10:29:16 +01:00

160 lines
4.6 KiB
Nim

# nimbus-eth1
# Copyright (c) 2023-2024 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.
{.push raises: [].}
import
eth/[common, rlp],
results,
"."/[aristo_constants, aristo_desc, aristo_get]
type
ResolveVidFn = proc(
vid: VertexID;
): Result[HashKey,AristoError]
{.gcsafe, raises: [].}
## Resolve storage root vertex ID
# ------------------------------------------------------------------------------
# Private helper
# ------------------------------------------------------------------------------
proc serialise(
pyl: LeafPayload;
getKey: ResolveVidFn;
): Result[seq[byte],(VertexID,AristoError)] =
## Encode the data payload of the argument `pyl` as RLP `seq[byte]` if it is
## of account type, otherwise pass the data as is.
##
case pyl.pType:
of AccountData:
let key = block:
if pyl.stoID.isValid:
pyl.stoID.vid.getKey.valueOr:
let w = (pyl.stoID.vid, error)
return err(w)
else:
VOID_HASH_KEY
ok rlp.encode Account(
nonce: pyl.account.nonce,
balance: pyl.account.balance,
storageRoot: key.to(Hash32),
codeHash: pyl.account.codeHash)
of StoData:
ok rlp.encode pyl.stoData
# ------------------------------------------------------------------------------
# Public RLP transcoder mixins
# ------------------------------------------------------------------------------
func append*(w: var RlpWriter; key: HashKey) =
if 1 < key.len and key.len < 32:
w.appendRawBytes key.data
else:
w.append key.data
# ---------------------
proc to*(node: NodeRef; T: type seq[seq[byte]]): T =
## Convert the argument pait `w` to a single or a double item list item of
## `<rlp-encoded-node>` type entries. Only in case of a combined extension
## and branch vertex argument, there will be a double item list result.
##
case node.vtx.vType:
of Branch:
# Do branch node
var wr = initRlpWriter()
wr.startList(17)
for n in 0..15:
wr.append node.key[n]
wr.append EmptyBlob
let brData = wr.finish()
if 0 < node.vtx.pfx.len:
# Prefix branch by embedded extension node
let brHash = brData.digestTo(HashKey)
var wrx = initRlpWriter()
wrx.startList(2)
wrx.append node.vtx.pfx.toHexPrefix(isleaf = false).data()
wrx.append brHash
result.add wrx.finish()
result.add brData
else:
# Do for pure branch node
result.add brData
of Leaf:
proc getKey0(
vid: VertexID;
): Result[HashKey,AristoError]
{.gcsafe, raises: [].} =
ok(node.key[0]) # always succeeds
var wr = initRlpWriter()
wr.startList(2)
wr.append node.vtx.pfx.toHexPrefix(isleaf = true).data()
wr.append node.vtx.lData.serialise(getKey0).value
result.add (wr.finish())
proc digestTo*(node: NodeRef; T: type HashKey): T =
## Convert the argument `node` to the corresponding Merkle hash key. Note
## that a `Dummy` node is encoded as as a `Leaf`.
##
var wr = initRlpWriter()
case node.vtx.vType:
of Branch:
# Do branch node
wr.startList(17)
for n in 0..15:
wr.append node.key[n]
wr.append EmptyBlob
# Do for embedded extension node
if 0 < node.vtx.pfx.len:
let brHash = wr.finish().digestTo(HashKey)
wr = initRlpWriter()
wr.startList(2)
wr.append node.vtx.pfx.toHexPrefix(isleaf = false).data()
wr.append brHash
of Leaf:
proc getKey0(
vid: VertexID;
): Result[HashKey,AristoError]
{.gcsafe, raises: [].} =
ok(node.key[0]) # always succeeds
wr.startList(2)
wr.append node.vtx.pfx.toHexPrefix(isleaf = true).data()
wr.append node.vtx.lData.serialise(getKey0).value
wr.finish().digestTo(HashKey)
proc serialise*(
db: AristoDbRef;
root: VertexID;
pyl: LeafPayload;
): Result[seq[byte],(VertexID,AristoError)] =
## Encode the data payload of the argument `pyl` as RLP `seq[byte]` if it is
## of account type, otherwise pass the data as is.
##
proc getKey(vid: VertexID): Result[HashKey,AristoError] =
ok (?db.getKeyRc((root, vid)))[0]
pyl.serialise getKey
# ------------------------------------------------------------------------------
# End
# ------------------------------------------------------------------------------