mirror of
https://github.com/logos-messaging/logos-messaging-nim.git
synced 2026-01-08 08:53:06 +00:00
16bda047e1
* Reserve `networkconfig` name to waku network related settings * Rename cluster conf to network conf A `NetworkConf` is a Waku network configuration. # Conflicts: # tests/factory/test_waku_conf.nim # Conflicts: # tests/factory/test_waku_conf.nim * Improve sharding configuration A smarter data types simplifies the logic. * Fixing tests * fixup! rename to endpointConf * wip: autosharding is a specific configuration state and treat it like it # Conflicts: # waku/factory/external_config.nim * refactor lightpush handler some metrics error reporting were missing # Conflicts: # waku/waku_lightpush/protocol.nim * test_node_factory tests pass * remove warnings * fix tests * Revert eager previous replace-all command * fix up build tools compilation * metadata is used to store cluster id * Mount relay routes in static sharding * Rename activeRelayShards to subscribeShards To make it clearer that these are the shards the node will subscribe to. * Remove unused msg var * Improve error handling * Set autosharding as default, with 1 shard in network Also makes shards to subscribe to all shards in auto sharding, none in static sharding.
284 lines
9.6 KiB
Nim
284 lines
9.6 KiB
Nim
{.used.}
|
|
|
|
import
|
|
libp2p/crypto/[crypto, secp],
|
|
libp2p/multiaddress,
|
|
nimcrypto/utils,
|
|
std/[options, sequtils],
|
|
results,
|
|
testutils/unittests
|
|
import
|
|
waku/factory/waku_conf,
|
|
waku/factory/conf_builder/conf_builder,
|
|
waku/factory/networks_config,
|
|
waku/common/utils/parse_size_units
|
|
|
|
suite "Waku Conf - build with cluster conf":
|
|
test "Cluster Conf is passed and relay is enabled":
|
|
## Setup
|
|
let networkConf = NetworkConf.TheWakuNetworkConf()
|
|
var builder = WakuConfBuilder.init()
|
|
builder.discv5Conf.withUdpPort(9000)
|
|
builder.withRelayServiceRatio("50:50")
|
|
# Mount all shards in network
|
|
let expectedShards = toSeq[0.uint16 .. 7.uint16]
|
|
|
|
## Given
|
|
builder.rlnRelayConf.withEthClientUrls(@["https://my_eth_rpc_url/"])
|
|
builder.withNetworkConf(networkConf)
|
|
builder.withRelay(true)
|
|
builder.rlnRelayConf.withTreePath("/tmp/test-tree-path")
|
|
|
|
## When
|
|
let resConf = builder.build()
|
|
assert resConf.isOk(), $resConf.error
|
|
let conf = resConf.get()
|
|
|
|
## Then
|
|
let resValidate = conf.validate()
|
|
assert resValidate.isOk(), $resValidate.error
|
|
check conf.clusterId == networkConf.clusterId
|
|
check conf.shardingConf.kind == networkConf.shardingConf.kind
|
|
check conf.shardingConf.numShardsInCluster ==
|
|
networkConf.shardingConf.numShardsInCluster
|
|
check conf.subscribeShards == expectedShards
|
|
check conf.maxMessageSizeBytes ==
|
|
uint64(parseCorrectMsgSize(networkConf.maxMessageSize))
|
|
check conf.discv5Conf.get().bootstrapNodes == networkConf.discv5BootstrapNodes
|
|
|
|
if networkConf.rlnRelay:
|
|
assert conf.rlnRelayConf.isSome(), "RLN Relay conf is disabled"
|
|
|
|
let rlnRelayConf = conf.rlnRelayConf.get()
|
|
check rlnRelayConf.ethContractAddress.string ==
|
|
networkConf.rlnRelayEthContractAddress
|
|
check rlnRelayConf.dynamic == networkConf.rlnRelayDynamic
|
|
check rlnRelayConf.chainId == networkConf.rlnRelayChainId
|
|
check rlnRelayConf.epochSizeSec == networkConf.rlnEpochSizeSec
|
|
check rlnRelayConf.userMessageLimit == networkConf.rlnRelayUserMessageLimit
|
|
|
|
test "Cluster Conf is passed, but relay is disabled":
|
|
## Setup
|
|
let networkConf = NetworkConf.TheWakuNetworkConf()
|
|
var builder = WakuConfBuilder.init()
|
|
builder.withRelayServiceRatio("50:50")
|
|
builder.discv5Conf.withUdpPort(9000)
|
|
# Mount all shards in network
|
|
let expectedShards = toSeq[0.uint16 .. 7.uint16]
|
|
|
|
## Given
|
|
builder.rlnRelayConf.withEthClientUrls(@["https://my_eth_rpc_url/"])
|
|
builder.withNetworkConf(networkConf)
|
|
builder.withRelay(false)
|
|
|
|
## When
|
|
let resConf = builder.build()
|
|
assert resConf.isOk(), $resConf.error
|
|
let conf = resConf.get()
|
|
|
|
## Then
|
|
let resValidate = conf.validate()
|
|
assert resValidate.isOk(), $resValidate.error
|
|
check conf.clusterId == networkConf.clusterId
|
|
check conf.shardingConf.kind == networkConf.shardingConf.kind
|
|
check conf.shardingConf.numShardsInCluster ==
|
|
networkConf.shardingConf.numShardsInCluster
|
|
check conf.subscribeShards == expectedShards
|
|
check conf.maxMessageSizeBytes ==
|
|
uint64(parseCorrectMsgSize(networkConf.maxMessageSize))
|
|
check conf.discv5Conf.get().bootstrapNodes == networkConf.discv5BootstrapNodes
|
|
|
|
assert conf.rlnRelayConf.isNone
|
|
|
|
test "Cluster Conf is passed, but rln relay is disabled":
|
|
## Setup
|
|
let networkConf = NetworkConf.TheWakuNetworkConf()
|
|
var builder = WakuConfBuilder.init()
|
|
|
|
let # Mount all shards in network
|
|
expectedShards = toSeq[0.uint16 .. 7.uint16]
|
|
|
|
## Given
|
|
builder.rlnRelayConf.withEthClientUrls(@["https://my_eth_rpc_url/"])
|
|
builder.withNetworkConf(networkConf)
|
|
builder.rlnRelayConf.withEnabled(false)
|
|
|
|
## When
|
|
let resConf = builder.build()
|
|
assert resConf.isOk(), $resConf.error
|
|
let conf = resConf.get()
|
|
|
|
## Then
|
|
let resValidate = conf.validate()
|
|
assert resValidate.isOk(), $resValidate.error
|
|
check conf.clusterId == networkConf.clusterId
|
|
check conf.shardingConf.kind == networkConf.shardingConf.kind
|
|
check conf.shardingConf.numShardsInCluster ==
|
|
networkConf.shardingConf.numShardsInCluster
|
|
check conf.subscribeShards == expectedShards
|
|
check conf.maxMessageSizeBytes ==
|
|
uint64(parseCorrectMsgSize(networkConf.maxMessageSize))
|
|
check conf.discv5Conf.get().bootstrapNodes == networkConf.discv5BootstrapNodes
|
|
assert conf.rlnRelayConf.isNone
|
|
|
|
test "Cluster Conf is passed and valid shards are specified":
|
|
## Setup
|
|
let networkConf = NetworkConf.TheWakuNetworkConf()
|
|
var builder = WakuConfBuilder.init()
|
|
let shards = @[2.uint16, 3.uint16]
|
|
|
|
## Given
|
|
builder.rlnRelayConf.withEthClientUrls(@["https://my_eth_rpc_url/"])
|
|
builder.withNetworkConf(networkConf)
|
|
builder.withSubscribeShards(shards)
|
|
|
|
## When
|
|
let resConf = builder.build()
|
|
assert resConf.isOk(), $resConf.error
|
|
let conf = resConf.get()
|
|
|
|
## Then
|
|
let resValidate = conf.validate()
|
|
assert resValidate.isOk(), $resValidate.error
|
|
check conf.clusterId == networkConf.clusterId
|
|
check conf.shardingConf.kind == networkConf.shardingConf.kind
|
|
check conf.shardingConf.numShardsInCluster ==
|
|
networkConf.shardingConf.numShardsInCluster
|
|
check conf.subscribeShards == shards
|
|
check conf.maxMessageSizeBytes ==
|
|
uint64(parseCorrectMsgSize(networkConf.maxMessageSize))
|
|
check conf.discv5Conf.get().bootstrapNodes == networkConf.discv5BootstrapNodes
|
|
|
|
test "Cluster Conf is passed and invalid shards are specified":
|
|
## Setup
|
|
let networkConf = NetworkConf.TheWakuNetworkConf()
|
|
var builder = WakuConfBuilder.init()
|
|
let shards = @[2.uint16, 10.uint16]
|
|
|
|
## Given
|
|
builder.rlnRelayConf.withEthClientUrls(@["https://my_eth_rpc_url/"])
|
|
builder.withNetworkConf(networkConf)
|
|
builder.withSubscribeShards(shards)
|
|
|
|
## When
|
|
let resConf = builder.build()
|
|
|
|
## Then
|
|
assert resConf.isErr(), "Invalid shard was accepted"
|
|
|
|
test "Cluster Conf is passed and RLN contract is **not** overridden":
|
|
## Setup
|
|
let networkConf = NetworkConf.TheWakuNetworkConf()
|
|
var builder = WakuConfBuilder.init()
|
|
builder.rlnRelayConf.withEthClientUrls(@["https://my_eth_rpc_url/"])
|
|
|
|
# Mount all shards in network
|
|
let expectedShards = toSeq[0.uint16 .. 7.uint16]
|
|
let contractAddress = "0x0123456789ABCDEF"
|
|
|
|
## Given
|
|
builder.rlnRelayConf.withEthContractAddress(contractAddress)
|
|
builder.withNetworkConf(networkConf)
|
|
builder.withRelay(true)
|
|
builder.rlnRelayConf.withTreePath("/tmp/test")
|
|
|
|
## When
|
|
let resConf = builder.build()
|
|
assert resConf.isOk(), $resConf.error
|
|
let conf = resConf.get()
|
|
|
|
## Then
|
|
let resValidate = conf.validate()
|
|
assert resValidate.isOk(), $resValidate.error
|
|
check conf.clusterId == networkConf.clusterId
|
|
check conf.shardingConf.kind == networkConf.shardingConf.kind
|
|
check conf.shardingConf.numShardsInCluster ==
|
|
networkConf.shardingConf.numShardsInCluster
|
|
check conf.subscribeShards == expectedShards
|
|
check conf.maxMessageSizeBytes ==
|
|
uint64(parseCorrectMsgSize(networkConf.maxMessageSize))
|
|
check conf.discv5Conf.isSome == networkConf.discv5Discovery
|
|
check conf.discv5Conf.get().bootstrapNodes == networkConf.discv5BootstrapNodes
|
|
|
|
if networkConf.rlnRelay:
|
|
assert conf.rlnRelayConf.isSome
|
|
|
|
let rlnRelayConf = conf.rlnRelayConf.get()
|
|
check rlnRelayConf.ethContractAddress.string ==
|
|
networkConf.rlnRelayEthContractAddress
|
|
check rlnRelayConf.dynamic == networkConf.rlnRelayDynamic
|
|
check rlnRelayConf.chainId == networkConf.rlnRelayChainId
|
|
check rlnRelayConf.epochSizeSec == networkConf.rlnEpochSizeSec
|
|
check rlnRelayConf.userMessageLimit == networkConf.rlnRelayUserMessageLimit
|
|
|
|
suite "Waku Conf - node key":
|
|
test "Node key is generated":
|
|
## Setup
|
|
var builder = WakuConfBuilder.init()
|
|
builder.withClusterId(1)
|
|
|
|
## Given
|
|
|
|
## When
|
|
let resConf = builder.build()
|
|
assert resConf.isOk(), $resConf.error
|
|
let conf = resConf.get()
|
|
|
|
## Then
|
|
let resValidate = conf.validate()
|
|
assert resValidate.isOk(), $resValidate.error
|
|
let pubkey = getPublicKey(conf.nodeKey)
|
|
assert pubkey.isOk()
|
|
|
|
test "Passed node key is used":
|
|
## Setup
|
|
let nodeKeyStr =
|
|
"0011223344556677889900aabbccddeeff0011223344556677889900aabbccddeeff"
|
|
let nodeKey = block:
|
|
let key = SkPrivateKey.init(utils.fromHex(nodeKeyStr)).tryGet()
|
|
crypto.PrivateKey(scheme: Secp256k1, skkey: key)
|
|
var builder = WakuConfBuilder.init()
|
|
builder.withClusterId(1)
|
|
|
|
## Given
|
|
builder.withNodeKey(nodeKey)
|
|
|
|
## When
|
|
let resConf = builder.build()
|
|
assert resConf.isOk(), $resConf.error
|
|
let conf = resConf.get()
|
|
|
|
## Then
|
|
let resValidate = conf.validate()
|
|
assert resValidate.isOk(), $resValidate.error
|
|
assert utils.toHex(conf.nodeKey.getRawBytes().get()) ==
|
|
utils.toHex(nodeKey.getRawBytes().get()),
|
|
"Passed node key isn't in config:" & $nodeKey & $conf.nodeKey
|
|
|
|
suite "Waku Conf - extMultiaddrs":
|
|
test "Valid multiaddresses are passed and accepted":
|
|
## Setup
|
|
var builder = WakuConfBuilder.init()
|
|
builder.withClusterId(1)
|
|
|
|
## Given
|
|
let multiaddrs =
|
|
@["/ip4/127.0.0.1/udp/9090/quic", "/ip6/::1/tcp/3217", "/dns4/foo.com/tcp/80"]
|
|
builder.withExtMultiAddrs(multiaddrs)
|
|
|
|
## When
|
|
let resConf = builder.build()
|
|
assert resConf.isOk(), $resConf.error
|
|
let conf = resConf.get()
|
|
|
|
## Then
|
|
let resValidate = conf.validate()
|
|
assert resValidate.isOk(), $resValidate.error
|
|
check multiaddrs.len == conf.endpointConf.extMultiAddrs.len
|
|
let resMultiaddrs = conf.endpointConf.extMultiAddrs.map(
|
|
proc(m: MultiAddress): string =
|
|
$m
|
|
)
|
|
for m in multiaddrs:
|
|
check m in resMultiaddrs
|