Clean up old unused code and unused imports (#877)

This commit is contained in:
Kim De Mey 2021-10-22 21:36:53 +02:00 committed by GitHub
parent 92dfb02ad7
commit 02e8b2eb12
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 5 additions and 237 deletions

View File

@ -7,7 +7,7 @@
import
std/[options, sugar],
stew/[results, byteutils],
stew/results,
eth/p2p/discoveryv5/[protocol, node, enr],
../../content_db,
../wire/portal_protocol,

View File

@ -1,207 +0,0 @@
# Nimbus - Portal Network- Message types
# Copyright (c) 2021 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://hackmd.io/ctTNH9xsSu2ci9DeGidUsQ?view
{.push raises: [Defect].}
import
std/options,
stint, stew/[results, objects],
eth/ssz/ssz_serialization, eth/common/eth_types,
../../common/common_types
export ssz_serialization, stint, common_types
# TODO
# 1. There are a lot of similiarities beetween chain history, portal and overlay
# ultimaltly it would be nice to refector similar parts. Ideally
# ping/pong/findnodes/nodes would be the part of overlay network and findcontent/condtent
# will be parts of content network
# 2. Add some tests to check compatibility with other clients as soon as there will
# be some implementation
# 3. Ultimatly store/offer/accept and findcontent/content will most probably change
# as payloads in history network are larger then max udp packet size, therefore
# we will ned some mechanism to open utp streams
# 4. There is still no merkle accumulator specified but it will be needed when receiving
# headers
type
ContentType* = enum
BlockHeader = 0x01
BlockBody = 0x02
Receipts = 0x03
ChainId* = uint16
BlockHash* = Hash256
ContentKey* = object
chainId*: ChainId
contentType*: ContentType
nodeHash*: BlockHash
MessageKind* = enum
unused = 0x00
ping = 0x01
pong = 0x02
findnode = 0x03
nodes = 0x04
findcontent = 0x05
foundcontent = 0x06
offer = 0x07
accept = 0x08
store = 0x09
PingMessage* = object
enrSeq*: uint64
dataRadius*: UInt256
PongMessage* = object
enrSeq*: uint64
dataRadius*: UInt256
FindNodeMessage* = object
distances*: List[uint16, 256]
NodesMessage* = object
total*: uint8
enrs*: List[ByteList, 32] # ByteList here is the rlp encoded ENR. This could
# also be limited to 300 bytes instead of 2048
FindContentMessage* = object
contentKey*: ByteList
FoundContentMessage* = object
enrs*: List[ByteList, 32]
payload*: ByteList
OfferMessage* = object
contentKey*: ByteList
AcceptMessage* = object
contentKey*: ByteList
StoreMessage* = object
content*: ByteList
Message* = object
case kind*: MessageKind
of ping:
ping*: PingMessage
of pong:
pong*: PongMessage
of findnode:
findNode*: FindNodeMessage
of nodes:
nodes*: NodesMessage
of findcontent:
findcontent*: FindContentMessage
of foundcontent:
foundcontent*: FoundContentMessage
of offer:
offer*: OfferMessage
of accept:
accept*: AcceptMessage
of store:
store*: StoreMessage
else:
discard
SomeMessage* =
PingMessage or PongMessage or
FindNodeMessage or NodesMessage or
FindContentMessage or FoundContentMessage or
OfferMessage or AcceptMessage or StoreMessage
template messageKind*(T: typedesc[SomeMessage]): MessageKind =
when T is PingMessage: ping
elif T is PongMessage: pong
elif T is FindNodeMessage: findNode
elif T is NodesMessage: nodes
elif T is FindContentMessage: findcontent
elif T is FoundContentMessage: foundcontent
elif T is OfferMessage: offer
elif T is AcceptMessage: accept
elif T is StoreMessage: store
template toSszType*(x: UInt256): array[32, byte] =
toBytesLE(x)
template toSszType*(x: auto): auto =
x
func fromSszBytes*(T: type UInt256, data: openArray[byte]):
T {.raises: [MalformedSszError, Defect].} =
if data.len != sizeof(result):
raiseIncorrectSize T
T.fromBytesLE(data)
proc encodeMessage*[T: SomeMessage](m: T): seq[byte] =
ord(messageKind(T)).byte & SSZ.encode(m)
proc decodeMessage*(body: openarray[byte]): Result[Message, cstring] =
# Decodes to the specific `Message` type.
if body.len < 1:
return err("No message data")
var kind: MessageKind
if not checkedEnumAssign(kind, body[0]):
return err("Invalid message type")
var message = Message(kind: kind)
try:
case kind
of unused: return err("Invalid message type")
of ping:
message.ping = SSZ.decode(body.toOpenArray(1, body.high), PingMessage)
of pong:
message.pong = SSZ.decode(body.toOpenArray(1, body.high), PongMessage)
of findNode:
message.findNode = SSZ.decode(body.toOpenArray(1, body.high), FindNodeMessage)
of nodes:
message.nodes = SSZ.decode(body.toOpenArray(1, body.high), NodesMessage)
of findcontent:
message.findcontent = SSZ.decode(body.toOpenArray(1, body.high), FindContentMessage)
of foundcontent:
message.foundcontent = SSZ.decode(body.toOpenArray(1, body.high), FoundContentMessage)
of offer:
message.offer = SSZ.decode(body.toOpenArray(1, body.high), OfferMessage)
of accept:
message.accept = SSZ.decode(body.toOpenArray(1, body.high), AcceptMessage)
of store:
message.store = SSZ.decode(body.toOpenArray(1, body.high), StoreMessage)
except SszError:
return err("Invalid message encoding")
ok(message)
template innerMessage[T: SomeMessage](message: Message, expected: MessageKind): Option[T] =
if (message.kind == expected):
some[T](message.expected)
else:
none[T]()
# All our Message variants coresponds to enum MessageKind, therefore we are able to
# zoom in on inner structure of message by defining expected type T.
# If expected variant is not active, retrun None
proc getInnnerMessage*[T: SomeMessage](m: Message): Option[T] =
innerMessage[T](m, messageKind(T))
# Simple conversion from Option to Result, looks like somethif which coul live in
# Result library.
proc optToResult*[T, E](opt: Option[T], e: E): Result[T, E] =
if (opt.isSome()):
ok(opt.unsafeGet())
else:
err(e)
proc getInnerMessageResult*[T: SomeMessage](m: Message, errMessage: cstring): Result[T, cstring] =
optToResult(getInnnerMessage[T](m), errMessage)

View File

@ -10,9 +10,9 @@
{.push raises: [Defect].}
import
std/[options, sugar],
std/options,
nimcrypto/[sha2, hash], stew/objects, stint,
eth/ssz/ssz_serialization, eth/trie/[hexary, db],
eth/ssz/ssz_serialization,
../../common/common_types
export ssz_serialization, common_types
@ -80,28 +80,3 @@ func toContentId*(contentKey: ByteList): ContentId =
func toContentId*(contentKey: ContentKey): ContentId =
toContentId(encode(contentKey))
type
ContentStorage* = object
# TODO: Quick implementation for now where we just use HexaryTrie, current
# idea is to move in here a more direct storage of the trie nodes, but have
# an `ContentProvider` "interface" that could provide the trie nodes via
# this direct storage, via the HexaryTrie (for full nodes), or also without
# storage, via json rpc client requesting data from a full eth1 client.
trie*: HexaryTrie
proc get*(storage: ContentStorage, key: ContentKey): Option[seq[byte]] =
if storage.trie.db == nil: # TODO: for now...
return none(seq[byte])
let val = storage.trie.db.get(key.nodeHash.data)
if val.len > 0:
some(val)
else:
none(seq[byte])
proc get*(storage: ContentStorage, contentKey: ByteList): Option[seq[byte]] =
decode(contentKey).flatMap((key: ContentKey) => get(storage, key))
proc newEmptyInMemoryStorage*(): ContentStorage =
let trie = initHexaryTrie(newMemoryDb())
ContentStorage(trie: trie)

View File

@ -7,7 +7,7 @@
import
std/[options, sugar],
stew/[results, byteutils],
stew/results,
eth/p2p/discoveryv5/[protocol, node, enr],
../../content_db,
../wire/portal_protocol,

View File

@ -8,7 +8,7 @@
{.used.}
import
chronos, testutils/unittests, stew/shims/net, stew/byteutils,
chronos, testutils/unittests, stew/shims/net,
eth/keys, eth/p2p/discoveryv5/routing_table, nimcrypto/[hash, sha2],
eth/p2p/discoveryv5/protocol as discv5_protocol,
../network/wire/portal_protocol,