113 lines
3.7 KiB
Nim
113 lines
3.7 KiB
Nim
# Fluffy
|
|
# Copyright (c) 2023-2024 Status Research & Development GmbH
|
|
# Licensed and distributed under either of
|
|
# * MIT license (license terms in the root directory or at https://opensource.org/licenses/MIT).
|
|
# * Apache v2 license (license terms in the root directory or at https://www.apache.org/licenses/LICENSE-2.0).
|
|
# at your option. This file may not be copied, modified, or distributed except according to those terms.
|
|
|
|
# As per spec:
|
|
# https://github.com/ethereum/portal-network-specs/blob/master/state-network.md#content-keys-and-content-ids
|
|
|
|
{.push raises: [].}
|
|
|
|
import
|
|
nimcrypto/[hash, sha2, keccak],
|
|
results,
|
|
stint,
|
|
eth/common/eth_types,
|
|
ssz_serialization,
|
|
./nibbles
|
|
|
|
export ssz_serialization, common_types, hash, results
|
|
|
|
type
|
|
NodeHash* = KeccakHash
|
|
CodeHash* = KeccakHash
|
|
Address* = EthAddress
|
|
|
|
ContentType* = enum
|
|
# Note: Need to add this unused value as a case object with an enum without
|
|
# a 0 valueis not allowed: "low(contentType) must be 0 for discriminant".
|
|
# For prefix values that are in the enum gap, the deserialization will fail
|
|
# at runtime as is wanted.
|
|
# In the future it might be possible that this will fail at compile time for
|
|
# the SSZ Union type, but currently it is allowed in the implementation, and
|
|
# the SSZ spec is not explicit about disallowing this.
|
|
unused = 0x00
|
|
accountTrieNode = 0x20
|
|
contractTrieNode = 0x21
|
|
contractCode = 0x22
|
|
|
|
AccountTrieNodeKey* = object
|
|
path*: Nibbles
|
|
nodeHash*: NodeHash
|
|
|
|
ContractTrieNodeKey* = object
|
|
address*: Address
|
|
path*: Nibbles
|
|
nodeHash*: NodeHash
|
|
|
|
ContractCodeKey* = object
|
|
address*: Address
|
|
codeHash*: CodeHash
|
|
|
|
ContentKey* = object
|
|
case contentType*: ContentType
|
|
of unused:
|
|
discard
|
|
of accountTrieNode:
|
|
accountTrieNodeKey*: AccountTrieNodeKey
|
|
of contractTrieNode:
|
|
contractTrieNodeKey*: ContractTrieNodeKey
|
|
of contractCode:
|
|
contractCodeKey*: ContractCodeKey
|
|
|
|
func init*(T: type AccountTrieNodeKey, path: Nibbles, nodeHash: NodeHash): T =
|
|
AccountTrieNodeKey(path: path, nodeHash: nodeHash)
|
|
|
|
func init*(
|
|
T: type ContractTrieNodeKey, address: Address, path: Nibbles, nodeHash: NodeHash
|
|
): T =
|
|
ContractTrieNodeKey(address: address, path: path, nodeHash: nodeHash)
|
|
|
|
func init*(T: type ContractCodeKey, address: Address, codeHash: CodeHash): T =
|
|
ContractCodeKey(address: address, codeHash: codeHash)
|
|
|
|
func initAccountTrieNodeKey*(path: Nibbles, nodeHash: NodeHash): ContentKey =
|
|
ContentKey(
|
|
contentType: accountTrieNode,
|
|
accountTrieNodeKey: AccountTrieNodeKey.init(path, nodeHash),
|
|
)
|
|
|
|
func initContractTrieNodeKey*(
|
|
address: Address, path: Nibbles, nodeHash: NodeHash
|
|
): ContentKey =
|
|
ContentKey(
|
|
contentType: contractTrieNode,
|
|
contractTrieNodeKey: ContractTrieNodeKey.init(address, path, nodeHash),
|
|
)
|
|
|
|
func initContractCodeKey*(address: Address, codeHash: CodeHash): ContentKey =
|
|
ContentKey(
|
|
contentType: contractCode, contractCodeKey: ContractCodeKey.init(address, codeHash)
|
|
)
|
|
|
|
proc readSszBytes*(data: openArray[byte], val: var ContentKey) {.raises: [SszError].} =
|
|
mixin readSszValue
|
|
if data.len() > 0 and data[0] == ord(unused):
|
|
raise newException(MalformedSszError, "SSZ selector is unused value")
|
|
|
|
readSszValue(data, val)
|
|
|
|
func encode*(contentKey: ContentKey): ByteList =
|
|
doAssert(contentKey.contentType != unused)
|
|
ByteList.init(SSZ.encode(contentKey))
|
|
|
|
func decode*(T: type ContentKey, contentKey: ByteList): Result[T, string] =
|
|
decodeSsz(contentKey.asSeq(), T)
|
|
|
|
func toContentId*(contentKey: ByteList): ContentId =
|
|
# TODO: Should we try to parse the content key here for invalid ones?
|
|
let idHash = sha256.digest(contentKey.asSeq())
|
|
readUintBE[256](idHash.data)
|