mirror of
https://github.com/status-im/nimbus-eth1.git
synced 2025-01-30 05:55:30 +00:00
1b4572ed3b
* Re-arrange fetching storage slots in batch module why; Previously, fetching partial slot ranges first has a chance of terminating the worker peer 9due to network error) while there were many inheritable storage slots on the queue. Now, inheritance is checked first, then full slot ranges and finally partial ranges. * Update logging * Bundled node information for healing into single object `NodeSpecs` why: Previously, partial paths and node keys were kept in separate variables. This approach was error prone due to copying/reassembling function argument objects. As all partial paths, keys, and node data types are more or less handled as `Blob`s over the network (using Eth/6x, or Snap/1) it makes sense to hold these `Blob`s as named field in a single object (even if not all fields are active for the current purpose.) * For good housekeeping, using `NodeKey` type only for account keys why: previously, a mixture of `NodeKey` and `Hash256` was used. Now, only state or storage root keys use the `Hash256` type. * Always accept latest pivot (and not a slightly older one) why; For testing it was tried to use a slightly older pivot state root than available. Some anecdotal tests seemed to suggest an advantage so that more peers are willing to serve on that older pivot. But this could not be confirmed in subsequent tests (still anecdotal, though.) As a side note, the distance of the latest pivot to its predecessor is at least 128 (or whatever the constant `minPivotBlockDistance` is assigned to.) * Reshuffle name components for some file and function names why: Clarifies purpose: "storages" becomes: "storage slots" "store" becomes: "range fetch" * Stash away currently unused modules in sub-folder named "notused"
173 lines
6.6 KiB
Nim
173 lines
6.6 KiB
Nim
# Nimbus
|
|
# Copyright (c) 2021 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.
|
|
|
|
## This module fetches the Ethereum account state trie from network peers by
|
|
## traversing leaves of the trie in leaf path order, making network requests
|
|
## using the `snap` protocol.
|
|
|
|
import
|
|
std/sequtils,
|
|
chronos,
|
|
eth/[common, p2p, trie/trie_defs],
|
|
stew/interval_set,
|
|
"../../.."/[protocol, protocol/trace_config],
|
|
"../.."/[range_desc, worker_desc],
|
|
./com_error
|
|
|
|
{.push raises: [Defect].}
|
|
|
|
logScope:
|
|
topics = "snap-fetch"
|
|
|
|
type
|
|
GetAccountRange* = object
|
|
consumed*: NodeTagRange ## Real accounts interval covered
|
|
data*: PackedAccountRange ## Re-packed reply data
|
|
withStorage*: seq[AccountSlotsHeader] ## Accounts with non-idle storage root
|
|
|
|
# ------------------------------------------------------------------------------
|
|
# Private functions
|
|
# ------------------------------------------------------------------------------
|
|
|
|
proc getAccountRangeReq(
|
|
buddy: SnapBuddyRef;
|
|
root: Hash256;
|
|
iv: NodeTagRange;
|
|
): Future[Result[Option[SnapAccountRange],void]] {.async.} =
|
|
let
|
|
peer = buddy.peer
|
|
try:
|
|
let reply = await peer.getAccountRange(
|
|
root, iv.minPt.to(Hash256), iv.maxPt.to(Hash256), snapRequestBytesLimit)
|
|
return ok(reply)
|
|
except CatchableError as e:
|
|
trace trSnapRecvError & "waiting for GetAccountRange reply", peer,
|
|
error=e.msg
|
|
return err()
|
|
|
|
# ------------------------------------------------------------------------------
|
|
# Public functions
|
|
# ------------------------------------------------------------------------------
|
|
|
|
proc getAccountRange*(
|
|
buddy: SnapBuddyRef;
|
|
stateRoot: Hash256;
|
|
iv: NodeTagRange;
|
|
): Future[Result[GetAccountRange,ComError]] {.async.} =
|
|
## Fetch data using the `snap#` protocol, returns the range covered.
|
|
let
|
|
peer = buddy.peer
|
|
if trSnapTracePacketsOk:
|
|
trace trSnapSendSending & "GetAccountRange", peer,
|
|
accRange=iv, stateRoot, bytesLimit=snapRequestBytesLimit
|
|
|
|
var dd = block:
|
|
let rc = await buddy.getAccountRangeReq(stateRoot, iv)
|
|
if rc.isErr:
|
|
return err(ComNetworkProblem)
|
|
if rc.value.isNone:
|
|
trace trSnapRecvTimeoutWaiting & "for reply to GetAccountRange", peer
|
|
return err(ComResponseTimeout)
|
|
let snAccRange = rc.value.get
|
|
GetAccountRange(
|
|
consumed: iv,
|
|
data: PackedAccountRange(
|
|
proof: snAccRange.proof,
|
|
accounts: snAccRange.accounts
|
|
# Re-pack accounts data
|
|
.mapIt(PackedAccount(
|
|
accKey: it.accHash.to(NodeKey),
|
|
accBlob: it.accBody.encode))),
|
|
withStorage: snAccRange.accounts
|
|
# Collect accounts with non-empty storage
|
|
.filterIt(it.accBody.storageRoot != emptyRlpHash).mapIt(
|
|
AccountSlotsHeader(
|
|
accKey: it.accHash.to(NodeKey),
|
|
storageRoot: it.accBody.storageRoot)))
|
|
let
|
|
nAccounts = dd.data.accounts.len
|
|
nProof = dd.data.proof.len
|
|
|
|
if nAccounts == 0:
|
|
# github.com/ethereum/devp2p/blob/master/caps/snap.md#getaccountrange-0x00:
|
|
# Notes:
|
|
# * Nodes must always respond to the query.
|
|
# * If the node does not have the state for the requested state root, it
|
|
# must return an empty reply. It is the responsibility of the caller to
|
|
# query an state not older than 128 blocks.
|
|
# * The responding node is allowed to return less data than requested (own
|
|
# QoS limits), but the node must return at least one account. If no
|
|
# accounts exist between startingHash and limitHash, then the first (if
|
|
# any) account after limitHash must be provided.
|
|
if nProof == 0:
|
|
# Maybe try another peer
|
|
trace trSnapRecvReceived & "empty AccountRange", peer,
|
|
nAccounts, nProof, accRange="n/a", reqRange=iv, stateRoot
|
|
return err(ComNoAccountsForStateRoot)
|
|
|
|
# So there is no data, otherwise an account beyond the interval end
|
|
# `iv.maxPt` would have been returned.
|
|
dd.consumed = NodeTagRange.new(iv.minPt, high(NodeTag))
|
|
trace trSnapRecvReceived & "terminal AccountRange", peer,
|
|
nAccounts, nProof, accRange=dd.consumed, reqRange=iv, stateRoot
|
|
return ok(dd)
|
|
|
|
let (accMinPt, accMaxPt) = (
|
|
dd.data.accounts[0].accKey.to(NodeTag),
|
|
dd.data.accounts[^1].accKey.to(NodeTag))
|
|
|
|
if nProof == 0:
|
|
# github.com/ethereum/devp2p/blob/master/caps/snap.md#accountrange-0x01
|
|
# Notes:
|
|
# * If the account range is the entire state (requested origin was 0x00..0
|
|
# and all accounts fit into the response), no proofs should be sent along
|
|
# the response. This is unlikely for accounts, but since it's a common
|
|
# situation for storage slots, this clause keeps the behavior the same
|
|
# across both.
|
|
if 0.to(NodeTag) < iv.minPt:
|
|
trace trSnapRecvProtocolViolation & "proof-less AccountRange", peer,
|
|
nAccounts, nProof, accRange=NodeTagRange.new(iv.minPt, accMaxPt),
|
|
reqRange=iv, stateRoot
|
|
return err(ComMissingProof)
|
|
|
|
if accMinPt < iv.minPt:
|
|
# Not allowed
|
|
trace trSnapRecvProtocolViolation & "min too small in AccountRange", peer,
|
|
nAccounts, nProof, accRange=NodeTagRange.new(accMinPt, accMaxPt),
|
|
reqRange=iv, stateRoot
|
|
return err(ComAccountsMinTooSmall)
|
|
|
|
if iv.maxPt < accMaxPt:
|
|
# github.com/ethereum/devp2p/blob/master/caps/snap.md#getaccountrange-0x00:
|
|
# Notes:
|
|
# * [..]
|
|
# * [..]
|
|
# * [..] If no accounts exist between startingHash and limitHash, then the
|
|
# first (if any) account after limitHash must be provided.
|
|
if 1 < nAccounts:
|
|
# Geth always seems to allow the last account to be larger than the
|
|
# limit (seen with Geth/v1.10.18-unstable-4b309c70-20220517.)
|
|
if iv.maxPt < dd.data.accounts[^2].accKey.to(NodeTag):
|
|
# The segcond largest should not excceed the top one requested.
|
|
trace trSnapRecvProtocolViolation & "AccountRange top exceeded", peer,
|
|
nAccounts, nProof, accRange=NodeTagRange.new(iv.minPt, accMaxPt),
|
|
reqRange=iv, stateRoot
|
|
return err(ComAccountsMaxTooLarge)
|
|
|
|
dd.consumed = NodeTagRange.new(iv.minPt, max(iv.maxPt,accMaxPt))
|
|
trace trSnapRecvReceived & "AccountRange", peer,
|
|
nAccounts, nProof, accRange=dd.consumed, reqRange=iv, stateRoot
|
|
|
|
return ok(dd)
|
|
|
|
# ------------------------------------------------------------------------------
|
|
# End
|
|
# ------------------------------------------------------------------------------
|