mirror of https://github.com/status-im/nim-eth.git
Merge pull request #347 from status-im/discv4-strict
Discv4 with chronos strict usage
This commit is contained in:
Kim De Mey
GitHub
commit
04f641c923
|
|
@ -47,15 +47,11 @@ task test_discv4, "Run discovery v4 tests":
|
|||
runTest("tests/p2p/test_discovery", chronosStrict = false)
|
||||
|
||||
task test_p2p, "Run p2p tests":
|
||||
test_discv5_task()
|
||||
runTest("tests/p2p/all_tests")
|
||||
|
||||
# Code that still requires chronosStrict = false
|
||||
for filename in [
|
||||
"les/test_flow_control",
|
||||
"test_auth",
|
||||
"test_crypt",
|
||||
"test_discovery",
|
||||
"test_ecies",
|
||||
"test_enode",
|
||||
"test_rlpx_thunk",
|
||||
"test_shh",
|
||||
"test_shh_config",
|
||||
|
|
|
|||
|
|
@ -1,9 +1,16 @@
|
|||
# nim-eth
|
||||
# Copyright (c) 2020-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.
|
||||
|
||||
{.push raises: [Defect].}
|
||||
|
||||
import
|
||||
std/[tables, hashes],
|
||||
stew/results, stew/shims/net as stewNet, chronos, chronicles
|
||||
|
||||
{.push raises: [Defect].}
|
||||
|
||||
type
|
||||
IpLimits* = object
|
||||
limit*: uint
|
||||
|
|
|
|||
|
|
@ -1,12 +1,11 @@
|
|||
#
|
||||
# Ethereum P2P
|
||||
# (c) Copyright 2018
|
||||
# Status Research & Development GmbH
|
||||
#
|
||||
# Licensed under either of
|
||||
# Apache License, version 2.0, (LICENSE-APACHEv2)
|
||||
# MIT license (LICENSE-MIT)
|
||||
#
|
||||
# nim-eth
|
||||
# Copyright (c) 2018-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.
|
||||
|
||||
{.push raises: [Defect].}
|
||||
|
||||
import
|
||||
std/times,
|
||||
|
|
@ -57,9 +56,9 @@ proc append*(w: var RlpWriter, a: IpAddress) =
|
|||
of IpAddressFamily.IPv4:
|
||||
w.append(a.address_v4)
|
||||
|
||||
proc append(w: var RlpWriter, p: Port) {.inline.} = w.append(p.int)
|
||||
proc append(w: var RlpWriter, pk: PublicKey) {.inline.} = w.append(pk.toRaw())
|
||||
proc append(w: var RlpWriter, h: MDigest[256]) {.inline.} = w.append(h.data)
|
||||
proc append(w: var RlpWriter, p: Port) = w.append(p.int)
|
||||
proc append(w: var RlpWriter, pk: PublicKey) = w.append(pk.toRaw())
|
||||
proc append(w: var RlpWriter, h: MDigest[256]) = w.append(h.data)
|
||||
|
||||
proc pack(cmdId: CommandId, payload: openArray[byte], pk: PrivateKey): seq[byte] =
|
||||
## Create and sign a UDP message to be sent to a remote node.
|
||||
|
|
@ -90,7 +89,8 @@ proc recoverMsgPublicKey(msg: openArray[byte]): DiscResult[PublicKey] =
|
|||
let sig = ? Signature.fromRaw(msg.toOpenArray(MAC_SIZE, HEAD_SIZE))
|
||||
recover(sig, msg.toOpenArray(HEAD_SIZE, msg.high))
|
||||
|
||||
proc unpack(msg: openArray[byte]): tuple[cmdId: CommandId, payload: seq[byte]] =
|
||||
proc unpack(msg: openArray[byte]): tuple[cmdId: CommandId, payload: seq[byte]]
|
||||
{.raises: [DiscProtocolError, Defect].} =
|
||||
# Check against possible RangeError
|
||||
if msg[HEAD_SIZE].int < CommandId.low.ord or
|
||||
msg[HEAD_SIZE].int > CommandId.high.ord:
|
||||
|
|
@ -103,14 +103,14 @@ proc expiration(): uint32 =
|
|||
|
||||
# Wire protocol
|
||||
|
||||
proc send(d: DiscoveryProtocol, n: Node, data: seq[byte]) =
|
||||
proc send(d: DiscoveryProtocol, n: Node, data: seq[byte]) {.raises: [Defect].} =
|
||||
let ta = initTAddress(n.node.address.ip, n.node.address.udpPort)
|
||||
let f = d.transp.sendTo(ta, data)
|
||||
f.callback = proc(data: pointer) {.gcsafe.} =
|
||||
if f.failed:
|
||||
debug "Discovery send failed", msg = f.readError.msg
|
||||
|
||||
proc sendPing*(d: DiscoveryProtocol, n: Node): seq[byte] =
|
||||
proc sendPing*(d: DiscoveryProtocol, n: Node): seq[byte] {.raises: [Defect].} =
|
||||
let payload = rlp.encode((PROTO_VERSION, d.address, n.node.address,
|
||||
expiration()))
|
||||
let msg = pack(cmdPing, payload, d.privKey)
|
||||
|
|
@ -165,17 +165,18 @@ proc newDiscoveryProtocol*(privKey: PrivateKey, address: Address,
|
|||
result.thisNode = newNode(privKey.toPublicKey(), address)
|
||||
result.kademlia = newKademliaProtocol(result.thisNode, result, rng = rng)
|
||||
|
||||
proc recvPing(d: DiscoveryProtocol, node: Node,
|
||||
msgHash: MDigest[256]) {.inline.} =
|
||||
proc recvPing(d: DiscoveryProtocol, node: Node, msgHash: MDigest[256])
|
||||
{.raises: [ValueError, Defect].} =
|
||||
d.kademlia.recvPing(node, msgHash)
|
||||
|
||||
proc recvPong(d: DiscoveryProtocol, node: Node, payload: seq[byte]) {.inline.} =
|
||||
proc recvPong(d: DiscoveryProtocol, node: Node, payload: seq[byte])
|
||||
{.raises: [RlpError, Defect].} =
|
||||
let rlp = rlpFromBytes(payload)
|
||||
let tok = rlp.listElem(1).toBytes()
|
||||
d.kademlia.recvPong(node, tok)
|
||||
|
||||
proc recvNeighbours(d: DiscoveryProtocol, node: Node,
|
||||
payload: seq[byte]) {.inline.} =
|
||||
proc recvNeighbours(d: DiscoveryProtocol, node: Node, payload: seq[byte])
|
||||
{.raises: [RlpError, Defect].} =
|
||||
let rlp = rlpFromBytes(payload)
|
||||
let neighboursList = rlp.listElem(0)
|
||||
let sz = neighboursList.listLen()
|
||||
|
|
@ -206,7 +207,8 @@ proc recvNeighbours(d: DiscoveryProtocol, node: Node,
|
|||
neighbours.add(newNode(pk[], Address(ip: ip, udpPort: udpPort, tcpPort: tcpPort)))
|
||||
d.kademlia.recvNeighbours(node, neighbours)
|
||||
|
||||
proc recvFindNode(d: DiscoveryProtocol, node: Node, payload: openArray[byte]) {.inline, gcsafe.} =
|
||||
proc recvFindNode(d: DiscoveryProtocol, node: Node, payload: openArray[byte])
|
||||
{.raises: [RlpError, ValueError, Defect].} =
|
||||
let rlp = rlpFromBytes(payload)
|
||||
trace "<<< find_node from ", node
|
||||
let rng = rlp.listElem(0).toBytes
|
||||
|
|
@ -218,7 +220,7 @@ proc recvFindNode(d: DiscoveryProtocol, node: Node, payload: openArray[byte]) {.
|
|||
trace "Invalid target public key received"
|
||||
|
||||
proc expirationValid(cmdId: CommandId, rlpEncodedPayload: openArray[byte]):
|
||||
bool {.inline, raises:[DiscProtocolError, RlpError].} =
|
||||
bool {.raises: [DiscProtocolError, RlpError].} =
|
||||
## Can only raise `DiscProtocolError` and all of `RlpError`
|
||||
# Check if there is a payload
|
||||
if rlpEncodedPayload.len <= 0:
|
||||
|
|
@ -233,8 +235,8 @@ proc expirationValid(cmdId: CommandId, rlpEncodedPayload: openArray[byte]):
|
|||
else:
|
||||
raise newException(DiscProtocolError, "Invalid RLP list for this packet id")
|
||||
|
||||
proc receive*(d: DiscoveryProtocol, a: Address, msg: openArray[byte]) {.gcsafe.} =
|
||||
## Can raise `DiscProtocolError` and all of `RlpError`
|
||||
proc receive*(d: DiscoveryProtocol, a: Address, msg: openArray[byte])
|
||||
{.raises: [DiscProtocolError, RlpError, ValueError, Defect].} =
|
||||
# Note: export only needed for testing
|
||||
let msgHash = validateMsgHash(msg)
|
||||
if msgHash.isOk():
|
||||
|
|
@ -260,36 +262,36 @@ proc receive*(d: DiscoveryProtocol, a: Address, msg: openArray[byte]) {.gcsafe.}
|
|||
else:
|
||||
notice "Wrong msg mac from ", a
|
||||
|
||||
proc processClient(transp: DatagramTransport,
|
||||
raddr: TransportAddress): Future[void] {.async, gcsafe.} =
|
||||
proc processClient(transp: DatagramTransport, raddr: TransportAddress):
|
||||
Future[void] {.async, raises: [Defect].} =
|
||||
var proto = getUserData[DiscoveryProtocol](transp)
|
||||
let buf = try: transp.getMessage()
|
||||
except TransportOsError as e:
|
||||
# This is likely to be local network connection issues.
|
||||
warn "Transport getMessage", exception = e.name, msg = e.msg
|
||||
return
|
||||
let a = Address(ip: raddr.address, udpPort: raddr.port, tcpPort: raddr.port)
|
||||
try:
|
||||
# TODO: Maybe here better to use `peekMessage()` to avoid allocation,
|
||||
# but `Bytes` object is just a simple seq[byte], and `ByteRange` object
|
||||
# do not support custom length.
|
||||
var buf = transp.getMessage()
|
||||
let a = Address(ip: raddr.address, udpPort: raddr.port, tcpPort: raddr.port)
|
||||
proto.receive(a, buf)
|
||||
except RlpError as e:
|
||||
debug "Receive failed", exc = e.name, err = e.msg
|
||||
except DiscProtocolError as e:
|
||||
debug "Receive failed", exc = e.name, err = e.msg
|
||||
except Exception as e:
|
||||
except ValueError as e:
|
||||
debug "Receive failed", exc = e.name, err = e.msg
|
||||
raise e
|
||||
|
||||
proc open*(d: DiscoveryProtocol) =
|
||||
proc open*(d: DiscoveryProtocol) {.raises: [Defect, CatchableError].} =
|
||||
# TODO allow binding to specific IP / IPv6 / etc
|
||||
let ta = initTAddress(IPv4_any(), d.address.udpPort)
|
||||
d.transp = newDatagramTransport(processClient, udata = d, local = ta)
|
||||
|
||||
proc lookupRandom*(d: DiscoveryProtocol): Future[seq[Node]] {.inline.} =
|
||||
proc lookupRandom*(d: DiscoveryProtocol): Future[seq[Node]] =
|
||||
d.kademlia.lookupRandom()
|
||||
|
||||
proc run(d: DiscoveryProtocol) {.async.} =
|
||||
while true:
|
||||
discard await d.lookupRandom()
|
||||
await sleepAsync(3000)
|
||||
await sleepAsync(chronos.seconds(3))
|
||||
trace "Discovered nodes", nodes = d.kademlia.nodesDiscovered
|
||||
|
||||
proc bootstrap*(d: DiscoveryProtocol) {.async.} =
|
||||
|
|
@ -299,7 +301,7 @@ proc bootstrap*(d: DiscoveryProtocol) {.async.} =
|
|||
proc resolve*(d: DiscoveryProtocol, n: NodeId): Future[Node] =
|
||||
d.kademlia.resolve(n)
|
||||
|
||||
proc randomNodes*(d: DiscoveryProtocol, count: int): seq[Node] {.inline.} =
|
||||
proc randomNodes*(d: DiscoveryProtocol, count: int): seq[Node] =
|
||||
d.kademlia.randomNodes(count)
|
||||
|
||||
when isMainModule:
|
||||
|
|
|
|||
|
|
@ -1,8 +1,18 @@
|
|||
# nim-eth - Node Discovery Protocol v5
|
||||
# Copyright (c) 2020-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.
|
||||
#
|
||||
## Discovery v5 packet encoding as specified at
|
||||
## https://github.com/ethereum/devp2p/blob/master/discv5/discv5-wire.md#packet-encoding
|
||||
## And handshake/sessions as specified at
|
||||
## https://github.com/ethereum/devp2p/blob/master/discv5/discv5-theory.md#sessions
|
||||
##
|
||||
|
||||
{.push raises: [Defect].}
|
||||
|
||||
import
|
||||
std/[tables, options, hashes, net],
|
||||
nimcrypto, stint, chronicles, bearssl, stew/[results, byteutils],
|
||||
|
|
@ -13,8 +23,6 @@ from stew/objects import checkedEnumAssign
|
|||
|
||||
export keys
|
||||
|
||||
{.push raises: [Defect].}
|
||||
|
||||
logScope:
|
||||
topics = "discv5"
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,14 @@
|
|||
# ENR implementation according to specification in EIP-778:
|
||||
# https://github.com/ethereum/EIPs/blob/master/EIPS/eip-778.md
|
||||
# nim-eth - Node Discovery Protocol v5
|
||||
# Copyright (c) 2020-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.
|
||||
#
|
||||
## ENR implementation according to specification in EIP-778:
|
||||
## https://github.com/ethereum/EIPs/blob/master/EIPS/eip-778.md
|
||||
|
||||
{.push raises: [Defect].}
|
||||
|
||||
import
|
||||
std/[strutils, macros, algorithm, options],
|
||||
|
|
@ -8,8 +17,6 @@ import
|
|||
|
||||
export options
|
||||
|
||||
{.push raises: [Defect].}
|
||||
|
||||
const
|
||||
maxEnrSize = 300 ## Maximum size of an encoded node record, in bytes.
|
||||
minRlpListLen = 4 ## Minimum node record RLP list has: signature, seqId,
|
||||
|
|
|
|||
|
|
@ -1,12 +1,10 @@
|
|||
# nim-eth - Node Discovery Protocol v5
|
||||
# Copyright (c) 2021 Status Research & Development GmbH
|
||||
# Licensed under either of
|
||||
# * Apache License, version 2.0, (LICENSE-APACHEv2)
|
||||
# * MIT license (LICENSE-MIT)
|
||||
# at your option.
|
||||
# This file may not be copied, modified, or distributed except
|
||||
# according to those terms.
|
||||
|
||||
# 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.
|
||||
#
|
||||
## IP:port address votes implemented similarly as in
|
||||
## https://github.com/sigp/discv5
|
||||
##
|
||||
|
|
@ -17,6 +15,8 @@
|
|||
## To select the right address, a majority count is done. This is done over a
|
||||
## sort of moving window as votes expire after `IpVoteTimeout`.
|
||||
|
||||
{.push raises: [Defect].}
|
||||
|
||||
import
|
||||
std/[tables, options],
|
||||
chronos,
|
||||
|
|
@ -24,8 +24,6 @@ import
|
|||
|
||||
export options
|
||||
|
||||
{.push raises: [Defect].}
|
||||
|
||||
const IpVoteTimeout = 5.minutes ## Duration until a vote expires
|
||||
|
||||
type
|
||||
|
|
|
|||
|
|
@ -1,14 +1,22 @@
|
|||
# nim-eth - Node Discovery Protocol v5
|
||||
# Copyright (c) 2020-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.
|
||||
#
|
||||
## Discovery v5 Protocol Messages as specified at
|
||||
## https://github.com/ethereum/devp2p/blob/master/discv5/discv5-wire.md#protocol-messages
|
||||
## These messages get RLP encoded.
|
||||
##
|
||||
|
||||
{.push raises: [Defect].}
|
||||
|
||||
import
|
||||
std/[hashes, net],
|
||||
stew/arrayops,
|
||||
../../rlp, ./enr
|
||||
|
||||
{.push raises: [Defect].}
|
||||
|
||||
type
|
||||
MessageKind* = enum
|
||||
# TODO This is needed only to make Nim 1.2.6 happy
|
||||
|
|
|
|||
|
|
@ -1,3 +1,12 @@
|
|||
# nim-eth - Node Discovery Protocol v5
|
||||
# Copyright (c) 2020-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.
|
||||
|
||||
{.push raises: [Defect].}
|
||||
|
||||
import
|
||||
std/hashes,
|
||||
nimcrypto, stint, chronos, stew/shims/net, chronicles,
|
||||
|
|
@ -5,8 +14,6 @@ import
|
|||
|
||||
export stint
|
||||
|
||||
{.push raises: [Defect].}
|
||||
|
||||
type
|
||||
NodeId* = UInt256
|
||||
|
||||
|
|
|
|||
|
|
@ -1,10 +1,9 @@
|
|||
# nim-eth - Node Discovery Protocol v5
|
||||
# Copyright (c) 2020-2021 Status Research & Development GmbH
|
||||
# Licensed under either of
|
||||
# * Apache License, version 2.0, (LICENSE-APACHEv2)
|
||||
# * MIT license (LICENSE-MIT)
|
||||
# at your option. This file may not be copied, modified, or distributed except
|
||||
# according to those terms.
|
||||
# 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.
|
||||
|
||||
## Node Discovery Protocol v5
|
||||
##
|
||||
|
|
@ -72,6 +71,8 @@
|
|||
## more requests will be needed for a lookup (adding bandwidth and latency).
|
||||
## This might be a concern for mobile devices.
|
||||
|
||||
{.push raises: [Defect].}
|
||||
|
||||
import
|
||||
std/[tables, sets, options, math, sequtils, algorithm],
|
||||
stew/shims/net as stewNet, json_serialization/std/net,
|
||||
|
|
@ -83,8 +84,6 @@ import nimcrypto except toHex
|
|||
|
||||
export options
|
||||
|
||||
{.push raises: [Defect].}
|
||||
|
||||
declareCounter discovery_message_requests_outgoing,
|
||||
"Discovery protocol outgoing message requests", labels = ["response"]
|
||||
declareCounter discovery_message_requests_incoming,
|
||||
|
|
|
|||
|
|
@ -1,3 +1,12 @@
|
|||
# nim-eth - Node Discovery Protocol v5
|
||||
# Copyright (c) 2020-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.
|
||||
|
||||
{.push raises: [Defect].}
|
||||
|
||||
import
|
||||
std/[algorithm, times, sequtils, bitops, sets, options],
|
||||
stint, chronicles, metrics, bearssl, chronos, stew/shims/net as stewNet,
|
||||
|
|
@ -6,8 +15,6 @@ import
|
|||
|
||||
export options
|
||||
|
||||
{.push raises: [Defect].}
|
||||
|
||||
declarePublicGauge routing_table_nodes,
|
||||
"Discovery routing table nodes", labels = ["state"]
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,16 @@
|
|||
# nim-eth - Node Discovery Protocol v5
|
||||
# Copyright (c) 2020-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.
|
||||
#
|
||||
## Session cache as mentioned at
|
||||
## https://github.com/ethereum/devp2p/blob/master/discv5/discv5-theory.md#session-cache
|
||||
##
|
||||
|
||||
{.push raises: [Defect].}
|
||||
|
||||
import
|
||||
std/options,
|
||||
stint, stew/endians2, stew/shims/net,
|
||||
|
|
@ -8,8 +18,6 @@ import
|
|||
|
||||
export lru
|
||||
|
||||
{.push raises: [Defect].}
|
||||
|
||||
const
|
||||
aesKeySize* = 128 div 8
|
||||
keySize = sizeof(NodeId) +
|
||||
|
|
|
|||
|
|
@ -1,12 +1,11 @@
|
|||
#
|
||||
# Ethereum P2P
|
||||
# (c) Copyright 2018
|
||||
# Status Research & Development GmbH
|
||||
#
|
||||
# Licensed under either of
|
||||
# Apache License, version 2.0, (LICENSE-APACHEv2)
|
||||
# MIT license (LICENSE-MIT)
|
||||
#
|
||||
# nim-eth
|
||||
# Copyright (c) 2018-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.
|
||||
|
||||
{.push raises: [Defect].}
|
||||
|
||||
import
|
||||
std/[tables, hashes, times, algorithm, sets, sequtils, random],
|
||||
|
|
@ -26,7 +25,7 @@ type
|
|||
routing: RoutingTable
|
||||
pongFutures: Table[seq[byte], Future[bool]]
|
||||
pingFutures: Table[Node, Future[bool]]
|
||||
neighboursCallbacks: Table[Node, proc(n: seq[Node]) {.gcsafe.}]
|
||||
neighboursCallbacks: Table[Node, proc(n: seq[Node]) {.gcsafe, raises: [Defect].}]
|
||||
rng: ref BrHmacDrbgContext
|
||||
|
||||
NodeId* = UInt256
|
||||
|
|
@ -79,7 +78,8 @@ proc `$`*(n: Node): string =
|
|||
"Node[" & $n.node.address.ip & ":" & $n.node.address.udpPort & "]"
|
||||
|
||||
proc hash*(n: Node): hashes.Hash = hash(n.node.pubkey.toRaw)
|
||||
proc `==`*(a, b: Node): bool = (a.isNil and b.isNil) or (not a.isNil and not b.isNil and a.node.pubkey == b.node.pubkey)
|
||||
proc `==`*(a, b: Node): bool = (a.isNil and b.isNil) or
|
||||
(not a.isNil and not b.isNil and a.node.pubkey == b.node.pubkey)
|
||||
|
||||
proc newKBucket(istart, iend: NodeId): KBucket =
|
||||
result.new()
|
||||
|
|
@ -95,8 +95,8 @@ proc distanceTo(k: KBucket, id: NodeId): UInt256 = k.midpoint xor id
|
|||
proc nodesByDistanceTo(k: KBucket, id: NodeId): seq[Node] =
|
||||
sortedByIt(k.nodes, it.distanceTo(id))
|
||||
|
||||
proc len(k: KBucket): int {.inline.} = k.nodes.len
|
||||
proc head(k: KBucket): Node {.inline.} = k.nodes[0]
|
||||
proc len(k: KBucket): int = k.nodes.len
|
||||
proc head(k: KBucket): Node = k.nodes[0]
|
||||
|
||||
proc add(k: KBucket, n: Node): Node =
|
||||
## Try to add the given node to this bucket.
|
||||
|
|
@ -137,15 +137,15 @@ proc split(k: KBucket): tuple[lower, upper: KBucket] =
|
|||
let bucket = if node.id <= splitid: result.lower else: result.upper
|
||||
bucket.replacementCache.add(node)
|
||||
|
||||
proc inRange(k: KBucket, n: Node): bool {.inline.} =
|
||||
proc inRange(k: KBucket, n: Node): bool =
|
||||
k.istart <= n.id and n.id <= k.iend
|
||||
|
||||
proc isFull(k: KBucket): bool = k.len == BUCKET_SIZE
|
||||
|
||||
proc contains(k: KBucket, n: Node): bool = n in k.nodes
|
||||
|
||||
proc binaryGetBucketForNode(buckets: openarray[KBucket],
|
||||
n: Node): KBucket {.inline.} =
|
||||
proc binaryGetBucketForNode(buckets: openarray[KBucket], n: Node):
|
||||
KBucket {.raises: [ValueError, Defect].} =
|
||||
## Given a list of ordered buckets, returns the bucket for a given node.
|
||||
let bucketPos = lowerBound(buckets, n.id) do(a: KBucket, b: NodeId) -> int:
|
||||
cmp(a.iend, b)
|
||||
|
|
@ -174,7 +174,7 @@ proc computeSharedPrefixBits(nodes: openarray[Node]): int =
|
|||
|
||||
doAssert(false, "Unable to calculate number of shared prefix bits")
|
||||
|
||||
proc init(r: var RoutingTable, thisNode: Node) {.inline.} =
|
||||
proc init(r: var RoutingTable, thisNode: Node) =
|
||||
r.thisNode = thisNode
|
||||
r.buckets = @[newKBucket(0.u256, high(Uint256))]
|
||||
randomize() # for later `randomNodes` selection
|
||||
|
|
@ -185,13 +185,15 @@ proc splitBucket(r: var RoutingTable, index: int) =
|
|||
r.buckets[index] = a
|
||||
r.buckets.insert(b, index + 1)
|
||||
|
||||
proc bucketForNode(r: RoutingTable, n: Node): KBucket =
|
||||
proc bucketForNode(r: RoutingTable, n: Node): KBucket
|
||||
{.raises: [ValueError, Defect].} =
|
||||
binaryGetBucketForNode(r.buckets, n)
|
||||
|
||||
proc removeNode(r: var RoutingTable, n: Node) =
|
||||
proc removeNode(r: var RoutingTable, n: Node) {.raises: [ValueError, Defect].} =
|
||||
r.bucketForNode(n).removeNode(n)
|
||||
|
||||
proc addNode(r: var RoutingTable, n: Node): Node =
|
||||
proc addNode(r: var RoutingTable, n: Node): Node
|
||||
{.raises: [ValueError, Defect].} =
|
||||
if n == r.thisNode:
|
||||
warn "Trying to add ourselves to the routing table", node = n
|
||||
return
|
||||
|
|
@ -209,7 +211,8 @@ proc addNode(r: var RoutingTable, n: Node): Node =
|
|||
# Nothing added, ping evictionCandidate
|
||||
return evictionCandidate
|
||||
|
||||
proc contains(r: RoutingTable, n: Node): bool = n in r.bucketForNode(n)
|
||||
proc contains(r: RoutingTable, n: Node): bool {.raises: [ValueError, Defect].} =
|
||||
n in r.bucketForNode(n)
|
||||
|
||||
proc bucketsByDistanceTo(r: RoutingTable, id: NodeId): seq[KBucket] =
|
||||
sortedByIt(r.buckets, it.distanceTo(id))
|
||||
|
|
@ -243,9 +246,11 @@ proc newKademliaProtocol*[Wire](
|
|||
result.routing.init(thisNode)
|
||||
result.rng = rng
|
||||
|
||||
proc bond(k: KademliaProtocol, n: Node): Future[bool] {.async, gcsafe.}
|
||||
proc bond(k: KademliaProtocol, n: Node): Future[bool] {.async.}
|
||||
proc bondDiscard(k: KademliaProtocol, n: Node) {.async.}
|
||||
|
||||
proc updateRoutingTable(k: KademliaProtocol, n: Node) {.gcsafe.} =
|
||||
proc updateRoutingTable(k: KademliaProtocol, n: Node)
|
||||
{.raises: [ValueError, Defect].} =
|
||||
## Update the routing table entry for the given node.
|
||||
let evictionCandidate = k.routing.addNode(n)
|
||||
if not evictionCandidate.isNil:
|
||||
|
|
@ -253,17 +258,17 @@ proc updateRoutingTable(k: KademliaProtocol, n: Node) {.gcsafe.} =
|
|||
# with the least recently seen node on that bucket. If the bonding fails the node will
|
||||
# be removed from the bucket and a new one will be picked from the bucket's
|
||||
# replacement cache.
|
||||
asyncCheck k.bond(evictionCandidate)
|
||||
asyncSpawn k.bondDiscard(evictionCandidate)
|
||||
|
||||
proc doSleep(p: proc() {.gcsafe.}) {.async, gcsafe.} =
|
||||
proc doSleep(p: proc() {.gcsafe, raises: [Defect].}) {.async.} =
|
||||
await sleepAsync(REQUEST_TIMEOUT)
|
||||
p()
|
||||
|
||||
template onTimeout(b: untyped) =
|
||||
asyncCheck doSleep() do():
|
||||
asyncSpawn doSleep() do():
|
||||
b
|
||||
|
||||
proc pingId(n: Node, token: seq[byte]): seq[byte] {.inline.} =
|
||||
proc pingId(n: Node, token: seq[byte]): seq[byte] =
|
||||
result = token & @(n.node.pubkey.toRaw)
|
||||
|
||||
proc waitPong(k: KademliaProtocol, n: Node, pingid: seq[byte]): Future[bool] =
|
||||
|
|
@ -280,7 +285,7 @@ proc ping(k: KademliaProtocol, n: Node): seq[byte] =
|
|||
doAssert(n != k.thisNode)
|
||||
result = k.wire.sendPing(n)
|
||||
|
||||
proc waitPing(k: KademliaProtocol, n: Node): Future[bool] {.gcsafe.} =
|
||||
proc waitPing(k: KademliaProtocol, n: Node): Future[bool] =
|
||||
result = newFuture[bool]("waitPing")
|
||||
doAssert(n notin k.pingFutures)
|
||||
k.pingFutures[n] = result
|
||||
|
|
@ -290,12 +295,13 @@ proc waitPing(k: KademliaProtocol, n: Node): Future[bool] {.gcsafe.} =
|
|||
k.pingFutures.del(n)
|
||||
fut.complete(false)
|
||||
|
||||
proc waitNeighbours(k: KademliaProtocol, remote: Node): Future[seq[Node]] =
|
||||
proc waitNeighbours(k: KademliaProtocol, remote: Node):
|
||||
Future[seq[Node]] {.raises: [Defect].} =
|
||||
doAssert(remote notin k.neighboursCallbacks)
|
||||
result = newFuture[seq[Node]]("waitNeighbours")
|
||||
let fut = result
|
||||
var neighbours = newSeqOfCap[Node](BUCKET_SIZE)
|
||||
k.neighboursCallbacks[remote] = proc(n: seq[Node]) =
|
||||
k.neighboursCallbacks[remote] = proc(n: seq[Node]) {.gcsafe, raises: [Defect].} =
|
||||
# This callback is expected to be called multiple times because nodes usually
|
||||
# split the neighbours replies into multiple packets, so we only complete the
|
||||
# future event.set() we've received enough neighbours.
|
||||
|
|
@ -336,9 +342,21 @@ proc findNode*(k: KademliaProtocol, nodesSeen: ref HashSet[Node],
|
|||
# 3. Deduplicates candidates
|
||||
candidates.keepItIf(not nodesSeen[].containsOrIncl(it))
|
||||
trace "Got new candidates", count = candidates.len
|
||||
let bonded = await all(candidates.mapIt(k.bond(it)))
|
||||
for i in 0 ..< bonded.len:
|
||||
if not bonded[i]: candidates[i] = nil
|
||||
|
||||
var bondedNodes: seq[Future[bool]] = @[]
|
||||
for node in candidates:
|
||||
bondedNodes.add(k.bond(node))
|
||||
|
||||
await allFutures(bondedNodes)
|
||||
|
||||
for i in 0..<bondedNodes.len:
|
||||
let b = bondedNodes[i]
|
||||
# `bond` will not raise so there should be no failures,
|
||||
# and for cancellation this should be fine to raise for now.
|
||||
doAssert(b.finished() and not(b.failed()))
|
||||
let bonded = b.read()
|
||||
if not bonded: candidates[i] = nil
|
||||
|
||||
candidates.keepItIf(not it.isNil)
|
||||
trace "Bonded with candidates", count = candidates.len
|
||||
result = candidates
|
||||
|
|
@ -350,9 +368,9 @@ proc populateNotFullBuckets(k: KademliaProtocol) =
|
|||
## When the bonding succeeds the node is automatically added to the bucket.
|
||||
for bucket in k.routing.notFullBuckets:
|
||||
for node in bucket.replacementCache:
|
||||
asyncCheck k.bond(node)
|
||||
asyncSpawn k.bondDiscard(node)
|
||||
|
||||
proc bond(k: KademliaProtocol, n: Node): Future[bool] {.async, gcsafe.} =
|
||||
proc bond(k: KademliaProtocol, n: Node): Future[bool] {.async.} =
|
||||
## Bond with the given node.
|
||||
##
|
||||
## Bonding consists of pinging the node, waiting for a pong and maybe a ping as well.
|
||||
|
|
@ -388,6 +406,9 @@ proc bond(k: KademliaProtocol, n: Node): Future[bool] {.async, gcsafe.} =
|
|||
k.updateRoutingTable(n)
|
||||
return true
|
||||
|
||||
proc bondDiscard(k: KademliaProtocol, n: Node) {.async.} =
|
||||
discard (await k.bond(n))
|
||||
|
||||
proc sortByDistance(nodes: var seq[Node], nodeId: NodeId, maxResults = 0) =
|
||||
nodes = nodes.sortedByIt(it.distanceTo(nodeId))
|
||||
if maxResults != 0 and nodes.len > maxResults:
|
||||
|
|
@ -411,9 +432,19 @@ proc lookup*(k: KademliaProtocol, nodeId: NodeId): Future[seq[Node]] {.async.} =
|
|||
while nodesToAsk.len != 0:
|
||||
trace "Node lookup; querying ", nodesToAsk
|
||||
nodesAsked.incl(nodesToAsk.toHashSet())
|
||||
let results = await all(nodesToAsk.mapIt(k.findNode(nodesSeen, nodeId, it)))
|
||||
for candidates in results:
|
||||
closest.add(candidates)
|
||||
|
||||
var findNodeRequests: seq[Future[seq[Node]]] = @[]
|
||||
for node in nodesToAsk:
|
||||
findNodeRequests.add(k.findNode(nodesSeen, nodeId, node))
|
||||
|
||||
await allFutures(findNodeRequests)
|
||||
|
||||
for candidates in findNodeRequests:
|
||||
# `findNode` will not raise so there should be no failures,
|
||||
# and for cancellation this should be fine to raise for now.
|
||||
doAssert(candidates.finished() and not(candidates.failed()))
|
||||
closest.add(candidates.read())
|
||||
|
||||
sortByDistance(closest, nodeId, BUCKET_SIZE)
|
||||
nodesToAsk = excludeIfAsked(closest)
|
||||
|
||||
|
|
@ -440,7 +471,15 @@ proc bootstrap*(k: KademliaProtocol, bootstrapNodes: seq[Node], retries = 0) {.a
|
|||
var numTries = 0
|
||||
if bootstrapNodes.len != 0:
|
||||
while true:
|
||||
let bonded = await all(bootstrapNodes.mapIt(k.bond(it)))
|
||||
var bondedNodes: seq[Future[bool]] = @[]
|
||||
for node in bootstrapNodes:
|
||||
bondedNodes.add(k.bond(node))
|
||||
await allFutures(bondedNodes)
|
||||
|
||||
# `bond` will not raise so there should be no failures,
|
||||
# and for cancellation this should be fine to raise for now.
|
||||
let bonded = bondedNodes.mapIt(it.read())
|
||||
|
||||
if true notin bonded:
|
||||
inc numTries
|
||||
if retries == 0 or numTries < retries:
|
||||
|
|
@ -463,7 +502,8 @@ proc recvPong*(k: KademliaProtocol, n: Node, token: seq[byte]) =
|
|||
if k.pongFutures.take(pingid, future):
|
||||
future.complete(true)
|
||||
|
||||
proc recvPing*(k: KademliaProtocol, n: Node, msgHash: any) =
|
||||
proc recvPing*(k: KademliaProtocol, n: Node, msgHash: any)
|
||||
{.raises: [ValueError, Defect].} =
|
||||
trace "<<< ping from ", n
|
||||
k.updateRoutingTable(n)
|
||||
k.wire.sendPong(n, msgHash)
|
||||
|
|
@ -486,7 +526,8 @@ proc recvNeighbours*(k: KademliaProtocol, remote: Node, neighbours: seq[Node]) =
|
|||
else:
|
||||
trace "Unexpected neighbours, probably came too late", remote
|
||||
|
||||
proc recvFindNode*(k: KademliaProtocol, remote: Node, nodeId: NodeId) {.gcsafe.} =
|
||||
proc recvFindNode*(k: KademliaProtocol, remote: Node, nodeId: NodeId)
|
||||
{.raises: [ValueError, Defect].} =
|
||||
if remote notin k.routing:
|
||||
# FIXME: This is not correct; a node we've bonded before may have become unavailable
|
||||
# and thus removed from self.routing, but once it's back online we should accept
|
||||
|
|
@ -520,7 +561,7 @@ proc randomNodes*(k: KademliaProtocol, count: int): seq[Node] =
|
|||
result.add(node)
|
||||
seen.incl(node)
|
||||
|
||||
proc nodesDiscovered*(k: KademliaProtocol): int {.inline.} = k.routing.len
|
||||
proc nodesDiscovered*(k: KademliaProtocol): int = k.routing.len
|
||||
|
||||
when isMainModule:
|
||||
proc randomNode(): Node =
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
{.used.}
|
||||
|
||||
import
|
||||
./test_enr,
|
||||
./test_hkdf,
|
||||
|
|
|
|||
|
|
@ -0,0 +1,7 @@
|
|||
import
|
||||
./all_discv5_tests,
|
||||
./test_auth,
|
||||
./test_crypt,
|
||||
./test_discovery,
|
||||
./test_ecies,
|
||||
./test_enode
|
||||
|
|
@ -10,12 +10,6 @@ proc localAddress*(port: int): Address =
|
|||
result = Address(udpPort: port, tcpPort: port,
|
||||
ip: parseIpAddress("127.0.0.1"))
|
||||
|
||||
proc startDiscoveryNode*(privKey: PrivateKey, address: Address,
|
||||
bootnodes: seq[ENode]): Future[DiscoveryProtocol] {.async.} =
|
||||
result = newDiscoveryProtocol(privKey, address, bootnodes)
|
||||
result.open()
|
||||
await result.bootstrap()
|
||||
|
||||
proc setupTestNode*(
|
||||
rng: ref BrHmacDrbgContext,
|
||||
capabilities: varargs[ProtocolInfo, `protocolInfo`]): EthereumNode {.gcsafe.} =
|
||||
|
|
@ -27,13 +21,6 @@ proc setupTestNode*(
|
|||
for capability in capabilities:
|
||||
result.addCapability capability
|
||||
|
||||
proc packData*(payload: openArray[byte], pk: PrivateKey): seq[byte] =
|
||||
let
|
||||
payloadSeq = @payload
|
||||
signature = @(pk.sign(payload).toRaw())
|
||||
msgHash = keccak256.digest(signature & payloadSeq)
|
||||
result = @(msgHash.data) & signature & payloadSeq
|
||||
|
||||
template sourceDir*: string = currentSourcePath.rsplit(DirSep, 1)[0]
|
||||
|
||||
proc recvMsgMock*(msg: openArray[byte]): tuple[msgId: int, msgData: Rlp] =
|
||||
|
|
|
|||
|
|
@ -7,6 +7,8 @@
|
|||
# distribution, for details about the copyright.
|
||||
#
|
||||
|
||||
{.used.}
|
||||
|
||||
import
|
||||
std/unittest,
|
||||
nimcrypto/[utils, keccak],
|
||||
|
|
|
|||
|
|
@ -7,6 +7,8 @@
|
|||
# distribution, for details about the copyright.
|
||||
#
|
||||
|
||||
{.used.}
|
||||
|
||||
import
|
||||
std/unittest,
|
||||
nimcrypto/[utils, sysrand, keccak],
|
||||
|
|
|
|||
|
|
@ -7,119 +7,139 @@
|
|||
# distribution, for details about the copyright.
|
||||
#
|
||||
|
||||
{.used.}
|
||||
|
||||
import
|
||||
std/[sequtils, unittest],
|
||||
chronos, stew/byteutils,
|
||||
../../eth/[keys, rlp], ../../eth/p2p/[discovery, kademlia, enode],
|
||||
./p2p_test_helper
|
||||
std/sequtils,
|
||||
chronos, stew/byteutils, nimcrypto, testutils/unittests,
|
||||
../../eth/keys, ../../eth/p2p/[discovery, kademlia, enode]
|
||||
|
||||
proc localAddress(port: int): Address =
|
||||
let port = Port(port)
|
||||
result = Address(udpPort: port, tcpPort: port,
|
||||
ip: parseIpAddress("127.0.0.1"))
|
||||
|
||||
proc initDiscoveryNode(privKey: PrivateKey, address: Address,
|
||||
bootnodes: seq[ENode]): DiscoveryProtocol =
|
||||
let node = newDiscoveryProtocol(privKey, address, bootnodes)
|
||||
node.open()
|
||||
|
||||
return node
|
||||
|
||||
proc packData(payload: openArray[byte], pk: PrivateKey): seq[byte] =
|
||||
let
|
||||
payloadSeq = @payload
|
||||
signature = @(pk.sign(payload).toRaw())
|
||||
msgHash = keccak256.digest(signature & payloadSeq)
|
||||
result = @(msgHash.data) & signature & payloadSeq
|
||||
|
||||
proc nodeIdInNodes(id: NodeId, nodes: openarray[Node]): bool =
|
||||
for n in nodes:
|
||||
if id == n.id: return true
|
||||
|
||||
proc test() {.async.} =
|
||||
suite "Discovery Tests":
|
||||
procSuite "Discovery Tests":
|
||||
let
|
||||
bootNodeKey = PrivateKey.fromHex(
|
||||
"a2b50376a79b1a8c8a3296485572bdfbf54708bb46d3c25d73d2723aaaf6a617")[]
|
||||
bootNodeAddr = localAddress(20301)
|
||||
bootENode = ENode(pubkey: bootNodeKey.toPublicKey(), address: bootNodeAddr)
|
||||
bootNode = initDiscoveryNode(bootNodeKey, bootNodeAddr, @[])
|
||||
waitFor bootNode.bootstrap()
|
||||
|
||||
asyncTest "Discover nodes":
|
||||
let nodeKeys = [
|
||||
PrivateKey.fromHex(
|
||||
"a2b50376a79b1a8c8a3296485572bdfbf54708bb46d3c25d73d2723aaaf6a618")[],
|
||||
PrivateKey.fromHex(
|
||||
"a2b50376a79b1a8c8a3296485572bdfbf54708bb46d3c25d73d2723aaaf6a619")[],
|
||||
PrivateKey.fromHex(
|
||||
"a2b50376a79b1a8c8a3296485572bdfbf54708bb46d3c25d73d2723aaaf6a620")[]
|
||||
]
|
||||
|
||||
var nodes: seq[DiscoveryProtocol]
|
||||
for i in 0..<nodeKeys.len:
|
||||
let node = initDiscoveryNode(nodeKeys[i], localAddress(20302 + i),
|
||||
@[bootENode])
|
||||
nodes.add(node)
|
||||
|
||||
await allFutures(nodes.mapIt(it.bootstrap()))
|
||||
nodes.add(bootNode)
|
||||
|
||||
for i in nodes:
|
||||
for j in nodes:
|
||||
if j != i:
|
||||
check(nodeIdInNodes(i.thisNode.id, j.randomNodes(nodes.len - 1)))
|
||||
|
||||
test "Test Vectors":
|
||||
# These are the test vectors from EIP-8:
|
||||
# https://github.com/ethereum/EIPs/blob/master/EIPS/eip-8.md#rlpx-discovery-protocol
|
||||
# However they are unpacked and the expiration is changed from 0x43b9a355
|
||||
# to 0x6fd3aed7 so that they remain valid for a while
|
||||
let validProtocolData = [
|
||||
# ping packet with version 4, additional list elements
|
||||
"01ec04cb847f000001820cfa8215a8d790000000000000000000000000000000018208ae820d05846fd3aed70102",
|
||||
# ping packet with version 555, additional list elements and additional random data
|
||||
"01f83e82022bd79020010db83c4d001500000000abcdef12820cfa8215a8d79020010db885a308d313198a2e037073488208ae82823a846fd3aed7c5010203040531b9019afde696e582a78fa8d95ea13ce3297d4afb8ba6433e4154caa5ac6431af1b80ba76023fa4090c408f6b4bc3701562c031041d4702971d102c9ab7fa5eed4cd6bab8f7af956f7d565ee1917084a95398b6a21eac920fe3dd1345ec0a7ef39367ee69ddf092cbfe5b93e5e568ebc491983c09c76d922dc3",
|
||||
# pong packet with additional list elements and additional random data
|
||||
"02f846d79020010db885a308d313198a2e037073488208ae82823aa0fbc914b16819237dcd8801d7e53f69e9719adecb3cc0e790c57e91ca4461c954846fd3aed7c6010203c2040506a0c969a58f6f9095004c0177a6b47f451530cab38966a25cca5cb58f055542124e",
|
||||
# findnode packet with additional list elements and additional random data
|
||||
"03f84eb840ca634cae0d49acb401d8a4c6b6fe8c55b70d115bf400769cc1400f3258cd31387574077f301b421bc84df7266c44e9e6d569fc56be00812904767bf5ccd1fc7f846fd3aed782999983999999280dc62cc8255c73471e0a61da0c89acdc0e035e260add7fc0c04ad9ebf3919644c91cb247affc82b69bd2ca235c71eab8e49737c937a2c396",
|
||||
# neighbours packet with additional list elements and additional random data
|
||||
"04f9015bf90150f84d846321163782115c82115db8403155e1427f85f10a5c9a7755877748041af1bcd8d474ec065eb33df57a97babf54bfd2103575fa829115d224c523596b401065a97f74010610fce76382c0bf32f84984010203040101b840312c55512422cf9b8a4097e9a6ad79402e87a15ae909a4bfefa22398f03d20951933beea1e4dfa6f968212385e829f04c2d314fc2d4e255e0d3bc08792b069dbf8599020010db83c4d001500000000abcdef12820d05820d05b84038643200b172dcfef857492156971f0e6aa2c538d8b74010f8e140811d53b98c765dd2d96126051913f44582e8c199ad7c6d6819e9a56483f637feaac9448aacf8599020010db885a308d313198a2e037073488203e78203e8b8408dcab8618c3253b558d459da53bd8fa68935a719aff8b811197101a4b2b47dd2d47295286fc00cc081bb542d760717d1bdd6bec2c37cd72eca367d6dd3b9df73846fd3aed7010203b525a138aa34383fec3d2719a0",
|
||||
]
|
||||
let
|
||||
bootNodeKey = PrivateKey.fromHex(
|
||||
"a2b50376a79b1a8c8a3296485572bdfbf54708bb46d3c25d73d2723aaaf6a617")[]
|
||||
bootNodeAddr = localAddress(20301)
|
||||
bootENode = ENode(pubkey: bootNodeKey.toPublicKey(), address: bootNodeAddr)
|
||||
bootNode = await startDiscoveryNode(bootNodeKey, bootNodeAddr, @[])
|
||||
address = localAddress(20302)
|
||||
nodeKey = PrivateKey.fromHex(
|
||||
"b71c71a67e1177ad4e901695e1b4b9ee17ae16c6668d313eac2f96dbcda3f291")[]
|
||||
|
||||
test "Discover nodes":
|
||||
let nodeKeys = [
|
||||
PrivateKey.fromHex(
|
||||
"a2b50376a79b1a8c8a3296485572bdfbf54708bb46d3c25d73d2723aaaf6a618")[],
|
||||
PrivateKey.fromHex(
|
||||
"a2b50376a79b1a8c8a3296485572bdfbf54708bb46d3c25d73d2723aaaf6a619")[],
|
||||
PrivateKey.fromHex(
|
||||
"a2b50376a79b1a8c8a3296485572bdfbf54708bb46d3c25d73d2723aaaf6a620")[]
|
||||
]
|
||||
var nodeAddrs = newSeqOfCap[Address](nodeKeys.len)
|
||||
for i in 0 ..< nodeKeys.len: nodeAddrs.add(localAddress(20302 + i))
|
||||
for data in validProtocolData:
|
||||
# none of these may raise
|
||||
bootNode.receive(address, packData(hexToSeqByte(data), nodeKey))
|
||||
|
||||
var nodes = await all(zip(nodeKeys, nodeAddrs).mapIt(
|
||||
startDiscoveryNode(it[0], it[1], @[bootENode]))
|
||||
)
|
||||
nodes.add(bootNode)
|
||||
test "Invalid protocol data":
|
||||
let invalidProtocolData = [
|
||||
"0x00", # invalid msg id
|
||||
"0x01", # empty payload
|
||||
"0x03b8", # no list but string
|
||||
"0x01C0", # empty list
|
||||
# FindNode target that is 1 byte too long
|
||||
# We currently do not raise on this, so can't really test it
|
||||
# "0x03f847b841AA0000000000000000000000000000000000000000000000000000000000000000a99a96bd988e1839272f93257bd9dfb2e558390e1f9bff28cdc8f04c9b5d06b1846fd3aed7",
|
||||
]
|
||||
let
|
||||
address = localAddress(20302)
|
||||
nodeKey = PrivateKey.fromHex(
|
||||
"a2b50376a79b1a8c8a3296485572bdfbf54708bb46d3c25d73d2723aaaf6a618")[]
|
||||
|
||||
for i in nodes:
|
||||
for j in nodes:
|
||||
if j != i:
|
||||
check(nodeIdInNodes(i.thisNode.id, j.randomNodes(nodes.len - 1)))
|
||||
|
||||
test "Test Vectors":
|
||||
# These are the test vectors from EIP-8:
|
||||
# https://github.com/ethereum/EIPs/blob/master/EIPS/eip-8.md#rlpx-discovery-protocol
|
||||
# However they are unpacked and the expiration is changed from 0x43b9a355
|
||||
# to 0x6fd3aed7 so that they remain valid for a while
|
||||
let validProtocolData = [
|
||||
# ping packet with version 4, additional list elements
|
||||
"01ec04cb847f000001820cfa8215a8d790000000000000000000000000000000018208ae820d05846fd3aed70102",
|
||||
# ping packet with version 555, additional list elements and additional random data
|
||||
"01f83e82022bd79020010db83c4d001500000000abcdef12820cfa8215a8d79020010db885a308d313198a2e037073488208ae82823a846fd3aed7c5010203040531b9019afde696e582a78fa8d95ea13ce3297d4afb8ba6433e4154caa5ac6431af1b80ba76023fa4090c408f6b4bc3701562c031041d4702971d102c9ab7fa5eed4cd6bab8f7af956f7d565ee1917084a95398b6a21eac920fe3dd1345ec0a7ef39367ee69ddf092cbfe5b93e5e568ebc491983c09c76d922dc3",
|
||||
# pong packet with additional list elements and additional random data
|
||||
"02f846d79020010db885a308d313198a2e037073488208ae82823aa0fbc914b16819237dcd8801d7e53f69e9719adecb3cc0e790c57e91ca4461c954846fd3aed7c6010203c2040506a0c969a58f6f9095004c0177a6b47f451530cab38966a25cca5cb58f055542124e",
|
||||
# findnode packet with additional list elements and additional random data
|
||||
"03f84eb840ca634cae0d49acb401d8a4c6b6fe8c55b70d115bf400769cc1400f3258cd31387574077f301b421bc84df7266c44e9e6d569fc56be00812904767bf5ccd1fc7f846fd3aed782999983999999280dc62cc8255c73471e0a61da0c89acdc0e035e260add7fc0c04ad9ebf3919644c91cb247affc82b69bd2ca235c71eab8e49737c937a2c396",
|
||||
# neighbours packet with additional list elements and additional random data
|
||||
"04f9015bf90150f84d846321163782115c82115db8403155e1427f85f10a5c9a7755877748041af1bcd8d474ec065eb33df57a97babf54bfd2103575fa829115d224c523596b401065a97f74010610fce76382c0bf32f84984010203040101b840312c55512422cf9b8a4097e9a6ad79402e87a15ae909a4bfefa22398f03d20951933beea1e4dfa6f968212385e829f04c2d314fc2d4e255e0d3bc08792b069dbf8599020010db83c4d001500000000abcdef12820d05820d05b84038643200b172dcfef857492156971f0e6aa2c538d8b74010f8e140811d53b98c765dd2d96126051913f44582e8c199ad7c6d6819e9a56483f637feaac9448aacf8599020010db885a308d313198a2e037073488203e78203e8b8408dcab8618c3253b558d459da53bd8fa68935a719aff8b811197101a4b2b47dd2d47295286fc00cc081bb542d760717d1bdd6bec2c37cd72eca367d6dd3b9df73846fd3aed7010203b525a138aa34383fec3d2719a0",
|
||||
]
|
||||
let
|
||||
address = localAddress(20302)
|
||||
nodeKey = PrivateKey.fromHex(
|
||||
"b71c71a67e1177ad4e901695e1b4b9ee17ae16c6668d313eac2f96dbcda3f291")[]
|
||||
|
||||
for data in validProtocolData:
|
||||
# none of these may raise
|
||||
for data in invalidProtocolData:
|
||||
expect DiscProtocolError:
|
||||
bootNode.receive(address, packData(hexToSeqByte(data), nodeKey))
|
||||
|
||||
test "Invalid protocol data":
|
||||
let invalidProtocolData = [
|
||||
"0x00", # invalid msg id
|
||||
"0x01", # empty payload
|
||||
"0x03b8", # no list but string
|
||||
"0x01C0", # empty list
|
||||
# FindNode target that is 1 byte too long
|
||||
# We currently do not raise on this, so can't really test it
|
||||
# "0x03f847b841AA0000000000000000000000000000000000000000000000000000000000000000a99a96bd988e1839272f93257bd9dfb2e558390e1f9bff28cdc8f04c9b5d06b1846fd3aed7",
|
||||
]
|
||||
let
|
||||
address = localAddress(20302)
|
||||
nodeKey = PrivateKey.fromHex(
|
||||
"a2b50376a79b1a8c8a3296485572bdfbf54708bb46d3c25d73d2723aaaf6a618")[]
|
||||
# empty msg id and payload, doesn't raise, just fails and prints wrong
|
||||
# msg mac
|
||||
bootNode.receive(address, packData(@[], nodeKey))
|
||||
|
||||
for data in invalidProtocolData:
|
||||
expect DiscProtocolError:
|
||||
bootNode.receive(address, packData(hexToSeqByte(data), nodeKey))
|
||||
asyncTest "Two findNode calls for the same peer in rapid succession":
|
||||
let targetKey = PrivateKey.fromHex(
|
||||
"a2b50376a79b1a8c8a3296485572bdfbf54708bb46d3c25d73d2723aaaf6a618")[]
|
||||
let peerKey = PrivateKey.fromHex(
|
||||
"a2b50376a79b1a8c8a3296485572bdfbf54708bb46d3c25d73d2723aaaf6a619")[]
|
||||
|
||||
# empty msg id and payload, doesn't raise, just fails and prints wrong
|
||||
# msg mac
|
||||
bootNode.receive(address, packData(@[], nodeKey))
|
||||
let targetNodeId = kademlia.toNodeId(targetKey.toPublicKey)
|
||||
let peerNode = kademlia.newNode(peerKey.toPublicKey, localAddress(20302))
|
||||
let nodesSeen = new(HashSet[Node])
|
||||
|
||||
test "Two findNode calls for the same peer in rapid succession":
|
||||
let targetKey = PrivateKey.fromHex(
|
||||
"a2b50376a79b1a8c8a3296485572bdfbf54708bb46d3c25d73d2723aaaf6a618")[]
|
||||
let peerKey = PrivateKey.fromHex(
|
||||
"a2b50376a79b1a8c8a3296485572bdfbf54708bb46d3c25d73d2723aaaf6a619")[]
|
||||
# Start `findNode` but don't `await` yet, so the reply can't be processed yet.
|
||||
let neighbours1Future = bootNode.kademlia.findNode(nodesSeen, targetNodeId, peerNode)
|
||||
|
||||
let targetNodeId = kademlia.toNodeId(targetKey.toPublicKey)
|
||||
let peerNode = kademlia.newNode(peerKey.toPublicKey, localAddress(20302))
|
||||
let nodesSeen = new(HashSet[Node])
|
||||
# This will raise an assertion error if `findNode` doesn't check for and ignore
|
||||
# this second call to the same target and peer in rapid successfion.
|
||||
let neighbours2Future = bootNode.kademlia.findNode(nodesSeen, targetNodeId, peerNode)
|
||||
|
||||
# Start `findNode` but don't `await` yet, so the reply can't be processed yet.
|
||||
let neighbours1Future = bootNode.kademlia.findNode(nodesSeen, targetNodeId, peerNode)
|
||||
# Just for completness, verify the result is empty from the second call.
|
||||
let neighbours2 = await neighbours2Future
|
||||
check(neighbours2.len == 0)
|
||||
|
||||
# This will raise an assertion error if `findNode` doesn't check for and ignore
|
||||
# this second call to the same target and peer in rapid successfion.
|
||||
let neighbours2Future = bootNode.kademlia.findNode(nodesSeen, targetNodeId, peerNode)
|
||||
|
||||
# Just for completness, verify the result is empty from the second call.
|
||||
let neighbours2 = await neighbours2Future
|
||||
check(neighbours2.len == 0)
|
||||
|
||||
# Just for completeness, wait for the first result out of order.
|
||||
# Max delay 5 seconds.
|
||||
discard await neighbours1Future
|
||||
|
||||
waitFor test()
|
||||
# Just for completeness, wait for the first result out of order.
|
||||
# Max delay 5 seconds.
|
||||
discard await neighbours1Future
|
||||
|
|
|
|||
|
|
@ -7,6 +7,8 @@
|
|||
# distribution, for details about the copyright.
|
||||
#
|
||||
|
||||
{.used.}
|
||||
|
||||
import
|
||||
std/unittest,
|
||||
nimcrypto/[utils, sha2, hmac, rijndael],
|
||||
|
|
|
|||
|
|
@ -7,6 +7,8 @@
|
|||
# Apache License, version 2.0, (LICENSE-APACHEv2)
|
||||
# MIT license (LICENSE-MIT)
|
||||
|
||||
{.used.}
|
||||
|
||||
import
|
||||
std/[unittest, net, options],
|
||||
../../eth/p2p/enode
|
||||
|
|
|
|||
Loading…
Reference in New Issue