status-im/nimbus-eth1
2
0
Fork 0
mirror of https://github.com/status-im/nimbus-eth1.git synced 2025-01-12 13:24:21 +00:00
Code Issues Projects Releases Wiki Activity

Add contains handler to portal protocol.

Browse Source
This commit is contained in:
bhartnett 2024-11-01 14:02:02 +08:00
parent 37c795b391
commit 39aa06f0ad
No known key found for this signature in database
GPG Key ID: 076F2830DA6BD535
8 changed files with 102 additions and 65 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
fluffy/database/content_db.nim
View File

@ -497,6 +497,12 @@ proc createStoreHandler*(db: ContentDB, cfg: RadiusConfig): DbStoreHandler =
db.put(contentId, content)
)
proc createContainsHandler*(db: ContentDB): DbContainsHandler =
return (
proc(contentKey: ContentKeyByteList, contentId: ContentId): bool =
db.contains(contentId)
)
proc createRadiusHandler*(db: ContentDB): DbRadiusHandler =
return (
proc(): UInt256 {.raises: [], gcsafe.} =

128
fluffy/network/beacon/beacon_db.nim
View File

@ -442,68 +442,72 @@ func keepBootstrapsFrom*(db: BeaconDb, minSlot: Slot) =
let res = db.bootstraps.keepFromStmt.exec(minSlot.int64)
res.expect("SQL query OK")
proc getHandlerImpl(
db: BeaconDb, contentKey: ContentKeyByteList, contentId: ContentId
): results.Opt[seq[byte]] =
let contentKey = contentKey.decode().valueOr:
# TODO: as this should not fail, maybe it is better to raiseAssert ?
return Opt.none(seq[byte])
case contentKey.contentType
of unused:
raiseAssert "Should not be used and fail at decoding"
of lightClientBootstrap:
db.getBootstrap(contentId)
of lightClientUpdate:
let
# TODO: add validation that startPeriod is not from the future,
# this requires db to be aware off the current beacon time
startPeriod = contentKey.lightClientUpdateKey.startPeriod
# get max 128 updates
numOfUpdates = min(
uint64(MAX_REQUEST_LIGHT_CLIENT_UPDATES), contentKey.lightClientUpdateKey.count
)
toPeriod = startPeriod + numOfUpdates # Not inclusive
updates = db.getLightClientUpdates(startPeriod, toPeriod)
if len(updates) == 0:
Opt.none(seq[byte])
else:
# Note that this might not return all of the requested updates.
# This might seem faulty/tricky as it is also used in handleOffer to
# check if an offer should be accepted.
# But it is actually fine as this will occur only when the node is
# synced and it would not be able to verify the older updates in the
# range anyhow.
Opt.some(SSZ.encode(updates))
of lightClientFinalityUpdate:
# TODO:
# Return only when the update is better than what is requested by
# contentKey. This is currently not possible as the contentKey does not
# include best update information.
if db.finalityUpdateCache.isSome():
let slot = contentKey.lightClientFinalityUpdateKey.finalizedSlot
let cache = db.finalityUpdateCache.get()
if cache.lastFinalityUpdateSlot >= slot:
Opt.some(cache.lastFinalityUpdate)
else:
Opt.none(seq[byte])
else:
Opt.none(seq[byte])
of lightClientOptimisticUpdate:
# TODO same as above applies here too.
if db.optimisticUpdateCache.isSome():
let slot = contentKey.lightClientOptimisticUpdateKey.optimisticSlot
let cache = db.optimisticUpdateCache.get()
if cache.lastOptimisticUpdateSlot >= slot:
Opt.some(cache.lastOptimisticUpdate)
else:
Opt.none(seq[byte])
else:
Opt.none(seq[byte])
of beacon_content.ContentType.historicalSummaries:
db.get(contentId)
proc createGetHandler*(db: BeaconDb): DbGetHandler =
return (
proc(contentKey: ContentKeyByteList, contentId: ContentId): results.Opt[seq[byte]] =
let contentKey = contentKey.decode().valueOr:
# TODO: as this should not fail, maybe it is better to raiseAssert ?
return Opt.none(seq[byte])
case contentKey.contentType
of unused:
raiseAssert "Should not be used and fail at decoding"
of lightClientBootstrap:
db.getBootstrap(contentId)
of lightClientUpdate:
let
# TODO: add validation that startPeriod is not from the future,
# this requires db to be aware off the current beacon time
startPeriod = contentKey.lightClientUpdateKey.startPeriod
# get max 128 updates
numOfUpdates = min(
uint64(MAX_REQUEST_LIGHT_CLIENT_UPDATES),
contentKey.lightClientUpdateKey.count,
)
toPeriod = startPeriod + numOfUpdates # Not inclusive
updates = db.getLightClientUpdates(startPeriod, toPeriod)
if len(updates) == 0:
Opt.none(seq[byte])
else:
# Note that this might not return all of the requested updates.
# This might seem faulty/tricky as it is also used in handleOffer to
# check if an offer should be accepted.
# But it is actually fine as this will occur only when the node is
# synced and it would not be able to verify the older updates in the
# range anyhow.
Opt.some(SSZ.encode(updates))
of lightClientFinalityUpdate:
# TODO:
# Return only when the update is better than what is requested by
# contentKey. This is currently not possible as the contentKey does not
# include best update information.
if db.finalityUpdateCache.isSome():
let slot = contentKey.lightClientFinalityUpdateKey.finalizedSlot
let cache = db.finalityUpdateCache.get()
if cache.lastFinalityUpdateSlot >= slot:
Opt.some(cache.lastFinalityUpdate)
else:
Opt.none(seq[byte])
else:
Opt.none(seq[byte])
of lightClientOptimisticUpdate:
# TODO same as above applies here too.
if db.optimisticUpdateCache.isSome():
let slot = contentKey.lightClientOptimisticUpdateKey.optimisticSlot
let cache = db.optimisticUpdateCache.get()
if cache.lastOptimisticUpdateSlot >= slot:
Opt.some(cache.lastOptimisticUpdate)
else:
Opt.none(seq[byte])
else:
Opt.none(seq[byte])
of beacon_content.ContentType.historicalSummaries:
db.get(contentId)
db.getHandlerImpl(contentKey, contentId)
)
proc createStoreHandler*(db: BeaconDb): DbStoreHandler =
@ -573,6 +577,12 @@ proc createStoreHandler*(db: BeaconDb): DbStoreHandler =
db.put(contentId, content)
)
proc createContainsHandler*(db: BeaconDb): DbContainsHandler =
return (
proc(contentKey: ContentKeyByteList, contentId: ContentId): bool =
db.getHandlerImpl(contentKey, contentId).isSome()
)
proc createRadiusHandler*(db: BeaconDb): DbRadiusHandler =
return (
proc(): UInt256 {.raises: [], gcsafe.} =

1
fluffy/network/beacon/beacon_network.nim
View File

@ -208,6 +208,7 @@ proc new*(
toContentIdHandler,
createGetHandler(beaconDb),
createStoreHandler(beaconDb),
createContainsHandler(beaconDb),
createRadiusHandler(beaconDb),
stream,
bootstrapRecords,

1
fluffy/network/history/history_network.nim
View File

@ -677,6 +677,7 @@ proc new*(
toContentIdHandler,
createGetHandler(contentDB),
createStoreHandler(contentDB, portalConfig.radiusConfig),
createContainsHandler(contentDB),
createRadiusHandler(contentDB),
stream,
bootstrapRecords,

1
fluffy/network/state/state_network.nim
View File

@ -64,6 +64,7 @@ proc new*(
toContentIdHandler,
createGetHandler(contentDB),
createStoreHandler(contentDB, portalConfig.radiusConfig),
createContainsHandler(contentDB),
createRadiusHandler(contentDB),
s,
bootstrapRecords,

10
fluffy/network/wire/portal_protocol.nim
View File

@ -151,6 +151,10 @@ type
contentKey: ContentKeyByteList, contentId: ContentId, content: seq[byte]
) {.raises: [], gcsafe.}
DbContainsHandler* = proc(contentKey: ContentKeyByteList, contentId: ContentId): bool {.
raises: [], gcsafe
.}
DbRadiusHandler* = proc(): UInt256 {.raises: [], gcsafe.}
PortalProtocolId* = array[2, byte]
@ -183,6 +187,7 @@ type
contentCache: ContentCache
dbGet*: DbGetHandler
dbPut*: DbStoreHandler
dbContains*: DbContainsHandler
dataRadius*: DbRadiusHandler
bootstrapRecords*: seq[Record]
lastLookup: chronos.Moment
@ -474,7 +479,7 @@ proc handleOffer(p: PortalProtocol, o: OfferMessage, srcId: NodeId): seq[byte] =
)
if p.inRange(contentId):
if p.dbGet(contentKey, contentId).isErr:
if not p.dbContains(contentKey, contentId):
contentKeysBitList.setBit(i)
discard contentKeys.add(contentKey)
else:
@ -561,6 +566,7 @@ proc new*(
toContentId: ToContentIdHandler,
dbGet: DbGetHandler,
dbPut: DbStoreHandler,
dbContains: DbContainsHandler,
dbRadius: DbRadiusHandler,
stream: PortalStream,
bootstrapRecords: openArray[Record] = [],
@ -580,6 +586,7 @@ proc new*(
ContentCache.init(if config.disableContentCache: 0 else: config.contentCacheSize),
dbGet: dbGet,
dbPut: dbPut,
dbContains: dbContains,
dataRadius: dbRadius,
bootstrapRecords: @bootstrapRecords,
stream: stream,
@ -1627,7 +1634,6 @@ proc getLocalContent*(
# Check first if content is in range, as this is a cheaper operation
# than the database lookup.
if p.inRange(contentId):
doAssert(p.dbGet != nil)
p.dbGet(contentKey, contentId)
else:
Opt.none(seq[byte])

18
fluffy/tests/test_content_db.nim
View File

@ -24,29 +24,39 @@ suite "Content Database":
"", uint32.high, RadiusConfig(kind: Dynamic), testId, inMemory = true
)
key = ContentId(UInt256.high()) # Some key
dbGet = db.createGetHandler()
block:
let val = dbGet(ContentKeyByteList.init(@[]), key)
var val = Opt.none(seq[byte])
proc onData(data: openArray[byte]) =
val = Opt.some(@data)
check:
db.get(key, onData) == false
val.isNone()
db.contains(key) == false
block:
discard db.putAndPrune(key, [byte 0, 1, 2, 3])
let val = dbGet(ContentKeyByteList.init(@[]), key)
var val = Opt.none(seq[byte])
proc onData(data: openArray[byte]) =
val = Opt.some(@data)
check:
db.get(key, onData) == true
val.isSome()
val.get() == [byte 0, 1, 2, 3]
db.contains(key) == true
block:
db.del(key)
let val = dbGet(ContentKeyByteList.init(@[]), key)
var val = Opt.none(seq[byte])
proc onData(data: openArray[byte]) =
val = Opt.some(@data)
check:
db.get(key, onData) == false
val.isNone()
db.contains(key) == false

2
fluffy/tests/wire_protocol_tests/test_portal_wire_protocol.nim
View File

@ -50,6 +50,7 @@ proc initPortalProtocol(
toContentId,
createGetHandler(db),
createStoreHandler(db, defaultRadiusConfig),
createContainsHandler(db),
createRadiusHandler(db),
stream,
bootstrapRecords = bootstrapRecords,
@ -346,6 +347,7 @@ procSuite "Portal Wire Protocol Tests":
toContentId,
createGetHandler(db),
createStoreHandler(db, defaultRadiusConfig),
createContainsHandler(db),
createRadiusHandler(db),
stream,
)