From cd5909fafe914014b4602492586e8c2b48b53349 Mon Sep 17 00:00:00 2001
From: Darshan K <35736874+darshankabariya@users.noreply.github.com>
Date: Wed, 19 Nov 2025 18:53:23 +0530
Subject: [PATCH 01/70] chore: first beta release v0.37.0 (#3607)
---
CHANGELOG.md | 59 ++++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 59 insertions(+)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index dc073792c..61e818afd 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,3 +1,62 @@
+## v0.37.0 (2025-10-01)
+
+### Notes
+
+- Deprecated parameters:
+ - `tree_path` and `rlnDB` (RLN-related storage paths)
+ - `--dns-discovery` (fully removed, including dns-discovery-name-server)
+ - `keepAlive` (deprecated, config updated accordingly)
+- Legacy `store` protocol is no longer supported by default.
+- Improved sharding configuration: now explicit and shard-specific metrics added.
+- Mix nodes are limited to IPv4 addresses only.
+- [lightpush legacy](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/19/lightpush.md) is being deprecated. Use [lightpush v3](https://github.com/waku-org/specs/blob/master/standards/core/lightpush.md) instead.
+
+### Features
+
+- Waku API: create node via API ([#3580](https://github.com/waku-org/nwaku/pull/3580)) ([bc8acf76](https://github.com/waku-org/nwaku/commit/bc8acf76))
+- Waku Sync: full topic support ([#3275](https://github.com/waku-org/nwaku/pull/3275)) ([9327da5a](https://github.com/waku-org/nwaku/commit/9327da5a))
+- Mix PoC implementation ([#3284](https://github.com/waku-org/nwaku/pull/3284)) ([eb7a3d13](https://github.com/waku-org/nwaku/commit/eb7a3d13))
+- Rendezvous: add request interval option ([#3569](https://github.com/waku-org/nwaku/pull/3569)) ([cc7a6406](https://github.com/waku-org/nwaku/commit/cc7a6406))
+- Shard-specific metrics tracking ([#3520](https://github.com/waku-org/nwaku/pull/3520)) ([c3da29fd](https://github.com/waku-org/nwaku/commit/c3da29fd))
+- Libwaku: build Windows DLL for Status-go ([#3460](https://github.com/waku-org/nwaku/pull/3460)) ([5c38a53f](https://github.com/waku-org/nwaku/commit/5c38a53f))
+- RLN: add Stateless RLN support ([#3621](https://github.com/waku-org/nwaku/pull/3621))
+- LOG: Reduce log level of messages from debug to info for better visibility ([#3622](https://github.com/waku-org/nwaku/pull/3622))
+
+### Bug Fixes
+
+- Prevent invalid pubsub topic subscription via Relay REST API ([#3559](https://github.com/waku-org/nwaku/pull/3559)) ([a36601ab](https://github.com/waku-org/nwaku/commit/a36601ab))
+- Fixed node crash when RLN is unregistered ([#3573](https://github.com/waku-org/nwaku/pull/3573)) ([3d0c6279](https://github.com/waku-org/nwaku/commit/3d0c6279))
+- REST: fixed sync protocol issues ([#3503](https://github.com/waku-org/nwaku/pull/3503)) ([393e3cce](https://github.com/waku-org/nwaku/commit/393e3cce))
+- Regex pattern fix for `username:password@` in URLs ([#3517](https://github.com/waku-org/nwaku/pull/3517)) ([89a3f735](https://github.com/waku-org/nwaku/commit/89a3f735))
+- Sharding: applied modulus fix ([#3530](https://github.com/waku-org/nwaku/pull/3530)) ([f68d7999](https://github.com/waku-org/nwaku/commit/f68d7999))
+- Metrics: switched to counter instead of gauge ([#3355](https://github.com/waku-org/nwaku/pull/3355)) ([a27eec90](https://github.com/waku-org/nwaku/commit/a27eec90))
+- Fixed lightpush metrics and diagnostics ([#3486](https://github.com/waku-org/nwaku/pull/3486)) ([0ed3fc80](https://github.com/waku-org/nwaku/commit/0ed3fc80))
+- Misc sync, dashboard, and CI fixes ([#3434](https://github.com/waku-org/nwaku/pull/3434), [#3508](https://github.com/waku-org/nwaku/pull/3508), [#3464](https://github.com/waku-org/nwaku/pull/3464))
+- Raise log level of numerous operational messages from debug to info for better visibility ([#3622](https://github.com/waku-org/nwaku/pull/3622))
+
+### Changes
+
+- Enable peer-exchange by default ([#3557](https://github.com/waku-org/nwaku/pull/3557)) ([7df526f8](https://github.com/waku-org/nwaku/commit/7df526f8))
+- Refactor peer-exchange client and service implementations ([#3523](https://github.com/waku-org/nwaku/pull/3523)) ([4379f9ec](https://github.com/waku-org/nwaku/commit/4379f9ec))
+- Updated rendezvous to use callback-based shard/capability updates ([#3558](https://github.com/waku-org/nwaku/pull/3558)) ([028bf297](https://github.com/waku-org/nwaku/commit/028bf297))
+- Config updates and explicit sharding setup ([#3468](https://github.com/waku-org/nwaku/pull/3468)) ([994d485b](https://github.com/waku-org/nwaku/commit/994d485b))
+- Bumped libp2p to v1.13.0 ([#3574](https://github.com/waku-org/nwaku/pull/3574)) ([b1616e55](https://github.com/waku-org/nwaku/commit/b1616e55))
+- Removed legacy dependencies (e.g., libpcre in Docker builds) ([#3552](https://github.com/waku-org/nwaku/pull/3552)) ([4db4f830](https://github.com/waku-org/nwaku/commit/4db4f830))
+- Benchmarks for RLN proof generation & verification ([#3567](https://github.com/waku-org/nwaku/pull/3567)) ([794c3a85](https://github.com/waku-org/nwaku/commit/794c3a85))
+- Various CI/CD & infra updates ([#3515](https://github.com/waku-org/nwaku/pull/3515), [#3505](https://github.com/waku-org/nwaku/pull/3505))
+
+### This release supports the following [libp2p protocols](https://docs.libp2p.io/concepts/protocols/):
+
+| Protocol | Spec status | Protocol id |
+| ---: | :---: | :--- |
+| [`11/WAKU2-RELAY`](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/11/relay.md) | `stable` | `/vac/waku/relay/2.0.0` |
+| [`12/WAKU2-FILTER`](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/12/filter.md) | `draft` | `/vac/waku/filter/2.0.0-beta1`
`/vac/waku/filter-subscribe/2.0.0-beta1`
`/vac/waku/filter-push/2.0.0-beta1` |
+| [`13/WAKU2-STORE`](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/13/store.md) | `draft` | `/vac/waku/store/2.0.0-beta4` |
+| [`19/WAKU2-LIGHTPUSH`](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/19/lightpush.md) | `draft` | `/vac/waku/lightpush/2.0.0-beta1` |
+| [`WAKU2-LIGHTPUSH v3`](https://github.com/waku-org/specs/blob/master/standards/core/lightpush.md) | `draft` | `/vac/waku/lightpush/3.0.0` |
+| [`66/WAKU2-METADATA`](https://github.com/waku-org/specs/blob/master/standards/core/metadata.md) | `raw` | `/vac/waku/metadata/1.0.0` |
+| [`WAKU-SYNC`](https://github.com/waku-org/specs/blob/master/standards/core/sync.md) | `draft` | `/vac/waku/sync/1.0.0` |
+
## v0.36.0 (2025-06-20)
### Notes
From adeb1a928ec8943a02d5cbd3927fc178ba2f3686 Mon Sep 17 00:00:00 2001
From: Ivan FB <128452529+Ivansete-status@users.noreply.github.com>
Date: Thu, 20 Nov 2025 08:44:15 +0100
Subject: [PATCH 02/70] fix: wakucanary now fails correctly when ping fails
(#3595)
* wakucanary add some more detail if exception
Co-authored-by: MorganaFuture
---
apps/wakucanary/wakucanary.nim | 16 ++++++++++++++--
1 file changed, 14 insertions(+), 2 deletions(-)
diff --git a/apps/wakucanary/wakucanary.nim b/apps/wakucanary/wakucanary.nim
index bcff9653e..6e02c2a8f 100644
--- a/apps/wakucanary/wakucanary.nim
+++ b/apps/wakucanary/wakucanary.nim
@@ -143,16 +143,18 @@ proc areProtocolsSupported(
proc pingNode(
node: WakuNode, peerInfo: RemotePeerInfo
-): Future[void] {.async, gcsafe.} =
+): Future[bool] {.async, gcsafe.} =
try:
let conn = await node.switch.dial(peerInfo.peerId, peerInfo.addrs, PingCodec)
let pingDelay = await node.libp2pPing.ping(conn)
info "Peer response time (ms)", peerId = peerInfo.peerId, ping = pingDelay.millis
+ return true
except CatchableError:
var msg = getCurrentExceptionMsg()
if msg == "Future operation cancelled!":
msg = "timedout"
error "Failed to ping the peer", peer = peerInfo, err = msg
+ return false
proc main(rng: ref HmacDrbgContext): Future[int] {.async.} =
let conf: WakuCanaryConf = WakuCanaryConf.load()
@@ -268,8 +270,13 @@ proc main(rng: ref HmacDrbgContext): Future[int] {.async.} =
let lp2pPeerStore = node.switch.peerStore
let conStatus = node.peerManager.switch.peerStore[ConnectionBook][peer.peerId]
+ var pingSuccess = true
if conf.ping:
- discard await pingFut
+ try:
+ pingSuccess = await pingFut
+ except CatchableError as exc:
+ pingSuccess = false
+ error "Ping operation failed or timed out", error = exc.msg
if conStatus in [Connected, CanConnect]:
let nodeProtocols = lp2pPeerStore[ProtoBook][peer.peerId]
@@ -278,6 +285,11 @@ proc main(rng: ref HmacDrbgContext): Future[int] {.async.} =
error "Not all protocols are supported",
expected = conf.protocols, supported = nodeProtocols
quit(QuitFailure)
+
+ # Check ping result if ping was enabled
+ if conf.ping and not pingSuccess:
+ error "Node is reachable and supports protocols but ping failed - connection may be unstable"
+ quit(QuitFailure)
elif conStatus == CannotConnect:
error "Could not connect", peerId = peer.peerId
quit(QuitFailure)
From e54851d9d63fd9e7e5e70844364a4464c4dba8f4 Mon Sep 17 00:00:00 2001
From: Ivan FB <128452529+Ivansete-status@users.noreply.github.com>
Date: Thu, 20 Nov 2025 13:12:16 +0100
Subject: [PATCH 03/70] fix: admin API peer shards field from metadata protocol
(#3594)
* fix: admin API peer shards field from metadata protocol
Store and return peer shard info from metadata protocol exchange instead of only checking ENR records.
* peer_manager set shard info and extend rest test to validate it
Co-authored-by: MorganaFuture
---
tests/wakunode_rest/test_rest_admin.nim | 14 +++++++++++++-
waku/node/peer_manager/peer_manager.nim | 5 +++++
waku/node/peer_manager/waku_peer_store.nim | 8 ++++++++
waku/waku_core/peers.nim | 12 +++++++++++-
4 files changed, 37 insertions(+), 2 deletions(-)
diff --git a/tests/wakunode_rest/test_rest_admin.nim b/tests/wakunode_rest/test_rest_admin.nim
index 6de886f74..ef82b8dfc 100644
--- a/tests/wakunode_rest/test_rest_admin.nim
+++ b/tests/wakunode_rest/test_rest_admin.nim
@@ -65,7 +65,7 @@ suite "Waku v2 Rest API - Admin":
): Future[void] {.async, gcsafe.} =
await sleepAsync(0.milliseconds)
- let shard = RelayShard(clusterId: clusterId, shardId: 0)
+ let shard = RelayShard(clusterId: clusterId, shardId: 5)
node1.subscribe((kind: PubsubSub, topic: $shard), simpleHandler).isOkOr:
assert false, "Failed to subscribe to topic: " & $error
node2.subscribe((kind: PubsubSub, topic: $shard), simpleHandler).isOkOr:
@@ -212,6 +212,18 @@ suite "Waku v2 Rest API - Admin":
let conn2 = await node1.peerManager.connectPeer(peerInfo2)
let conn3 = await node1.peerManager.connectPeer(peerInfo3)
+ var count = 0
+ while count < 20:
+ ## Wait ~1s at most for the peer store to update shard info
+ let getRes = await client.getPeers()
+ if getRes.data.allIt(it.shards == @[5.uint16]):
+ break
+
+ count.inc()
+ await sleepAsync(50.milliseconds)
+
+ assert count < 20, "Timeout waiting for shards to be updated in peer store"
+
# Check successful connections
check:
conn2 == true
diff --git a/waku/node/peer_manager/peer_manager.nim b/waku/node/peer_manager/peer_manager.nim
index 72b526aca..1abcc1ac0 100644
--- a/waku/node/peer_manager/peer_manager.nim
+++ b/waku/node/peer_manager/peer_manager.nim
@@ -658,6 +658,11 @@ proc onPeerMetadata(pm: PeerManager, peerId: PeerId) {.async.} =
$clusterId
break guardClauses
+ # Store the shard information from metadata in the peer store
+ if pm.switch.peerStore.peerExists(peerId):
+ let shards = metadata.shards.mapIt(it.uint16)
+ pm.switch.peerStore.setShardInfo(peerId, shards)
+
return
info "disconnecting from peer", peerId = peerId, reason = reason
diff --git a/waku/node/peer_manager/waku_peer_store.nim b/waku/node/peer_manager/waku_peer_store.nim
index 0098c1687..c9e2d4817 100644
--- a/waku/node/peer_manager/waku_peer_store.nim
+++ b/waku/node/peer_manager/waku_peer_store.nim
@@ -39,6 +39,9 @@ type
# Keeps track of the ENR (Ethereum Node Record) of a peer
ENRBook* = ref object of PeerBook[enr.Record]
+ # Keeps track of peer shards
+ ShardBook* = ref object of PeerBook[seq[uint16]]
+
proc getPeer*(peerStore: PeerStore, peerId: PeerId): RemotePeerInfo =
let addresses =
if peerStore[LastSeenBook][peerId].isSome():
@@ -55,6 +58,7 @@ proc getPeer*(peerStore: PeerStore, peerId: PeerId): RemotePeerInfo =
else:
none(enr.Record),
protocols: peerStore[ProtoBook][peerId],
+ shards: peerStore[ShardBook][peerId],
agent: peerStore[AgentBook][peerId],
protoVersion: peerStore[ProtoVersionBook][peerId],
publicKey: peerStore[KeyBook][peerId],
@@ -76,6 +80,7 @@ proc peers*(peerStore: PeerStore): seq[RemotePeerInfo] =
toSeq(peerStore[AddressBook].book.keys()),
toSeq(peerStore[ProtoBook].book.keys()),
toSeq(peerStore[KeyBook].book.keys()),
+ toSeq(peerStore[ShardBook].book.keys()),
)
.toHashSet()
@@ -127,6 +132,9 @@ proc addPeer*(peerStore: PeerStore, peer: RemotePeerInfo, origin = UnknownOrigin
if peer.enr.isSome():
peerStore[ENRBook][peer.peerId] = peer.enr.get()
+proc setShardInfo*(peerStore: PeerStore, peerId: PeerID, shards: seq[uint16]) =
+ peerStore[ShardBook][peerId] = shards
+
proc peers*(peerStore: PeerStore, proto: string): seq[RemotePeerInfo] =
peerStore.peers().filterIt(it.protocols.contains(proto))
diff --git a/waku/waku_core/peers.nim b/waku/waku_core/peers.nim
index 5591699c6..76ff29aa0 100644
--- a/waku/waku_core/peers.nim
+++ b/waku/waku_core/peers.nim
@@ -48,6 +48,7 @@ type RemotePeerInfo* = ref object
addrs*: seq[MultiAddress]
enr*: Option[enr.Record]
protocols*: seq[string]
+ shards*: seq[uint16]
agent*: string
protoVersion*: string
@@ -73,6 +74,7 @@ proc init*(
addrs: seq[MultiAddress] = @[],
enr: Option[enr.Record] = none(enr.Record),
protocols: seq[string] = @[],
+ shards: seq[uint16] = @[],
publicKey: crypto.PublicKey = crypto.PublicKey(),
agent: string = "",
protoVersion: string = "",
@@ -88,6 +90,7 @@ proc init*(
addrs: addrs,
enr: enr,
protocols: protocols,
+ shards: shards,
publicKey: publicKey,
agent: agent,
protoVersion: protoVersion,
@@ -105,9 +108,12 @@ proc init*(
addrs: seq[MultiAddress] = @[],
enr: Option[enr.Record] = none(enr.Record),
protocols: seq[string] = @[],
+ shards: seq[uint16] = @[],
): T {.raises: [Defect, ResultError[cstring], LPError].} =
let peerId = PeerID.init(peerId).tryGet()
- RemotePeerInfo(peerId: peerId, addrs: addrs, enr: enr, protocols: protocols)
+ RemotePeerInfo(
+ peerId: peerId, addrs: addrs, enr: enr, protocols: protocols, shards: shards
+ )
## Parse
@@ -326,6 +332,7 @@ converter toRemotePeerInfo*(peerInfo: PeerInfo): RemotePeerInfo =
addrs: peerInfo.listenAddrs,
enr: none(enr.Record),
protocols: peerInfo.protocols,
+ shards: @[],
agent: peerInfo.agentVersion,
protoVersion: peerInfo.protoVersion,
publicKey: peerInfo.publicKey,
@@ -361,6 +368,9 @@ proc getAgent*(peer: RemotePeerInfo): string =
return peer.agent
proc getShards*(peer: RemotePeerInfo): seq[uint16] =
+ if peer.shards.len > 0:
+ return peer.shards
+
if peer.enr.isNone():
return @[]
From 31e1a81552d72cd07133754e1953639da49ec954 Mon Sep 17 00:00:00 2001
From: Ivan FB <128452529+Ivansete-status@users.noreply.github.com>
Date: Thu, 20 Nov 2025 13:40:08 +0100
Subject: [PATCH 04/70] nix: add wakucanary Flake package (#3599)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Signed-off-by: Jakub Sokołowski
Co-authored-by: Jakub Sokołowski
---
Makefile | 1 -
flake.lock | 32 +++++++++++++++++++++++++++-----
flake.nix | 17 ++++++++++++-----
nix/atlas.nix | 12 ------------
nix/checksums.nix | 2 +-
nix/default.nix | 28 ++++++++++++----------------
nix/nimble.nix | 4 ++--
nix/sat.nix | 5 +++--
8 files changed, 57 insertions(+), 44 deletions(-)
delete mode 100644 nix/atlas.nix
diff --git a/Makefile b/Makefile
index 37341792c..029313c99 100644
--- a/Makefile
+++ b/Makefile
@@ -543,4 +543,3 @@ release-notes:
sed -E 's@#([0-9]+)@[#\1](https://github.com/waku-org/nwaku/issues/\1)@g'
# I could not get the tool to replace issue ids with links, so using sed for now,
# asked here: https://github.com/bvieira/sv4git/discussions/101
-
diff --git a/flake.lock b/flake.lock
index 359ae2579..0700e6a43 100644
--- a/flake.lock
+++ b/flake.lock
@@ -22,24 +22,46 @@
"zerokit": "zerokit"
}
},
- "zerokit": {
+ "rust-overlay": {
"inputs": {
"nixpkgs": [
+ "zerokit",
"nixpkgs"
]
},
"locked": {
- "lastModified": 1743756626,
- "narHash": "sha256-SvhfEl0bJcRsCd79jYvZbxQecGV2aT+TXjJ57WVv7Aw=",
+ "lastModified": 1748399823,
+ "narHash": "sha256-kahD8D5hOXOsGbNdoLLnqCL887cjHkx98Izc37nDjlA=",
+ "owner": "oxalica",
+ "repo": "rust-overlay",
+ "rev": "d68a69dc71bc19beb3479800392112c2f6218159",
+ "type": "github"
+ },
+ "original": {
+ "owner": "oxalica",
+ "repo": "rust-overlay",
+ "type": "github"
+ }
+ },
+ "zerokit": {
+ "inputs": {
+ "nixpkgs": [
+ "nixpkgs"
+ ],
+ "rust-overlay": "rust-overlay"
+ },
+ "locked": {
+ "lastModified": 1749115386,
+ "narHash": "sha256-UexIE2D7zr6aRajwnKongXwCZCeRZDXOL0kfjhqUFSU=",
"owner": "vacp2p",
"repo": "zerokit",
- "rev": "c60e0c33fc6350a4b1c20e6b6727c44317129582",
+ "rev": "dc0b31752c91e7b4fefc441cfa6a8210ad7dba7b",
"type": "github"
},
"original": {
"owner": "vacp2p",
"repo": "zerokit",
- "rev": "c60e0c33fc6350a4b1c20e6b6727c44317129582",
+ "rev": "dc0b31752c91e7b4fefc441cfa6a8210ad7dba7b",
"type": "github"
}
}
diff --git a/flake.nix b/flake.nix
index 760f49337..72eaebef1 100644
--- a/flake.nix
+++ b/flake.nix
@@ -9,7 +9,7 @@
inputs = {
nixpkgs.url = "github:NixOS/nixpkgs?rev=f44bd8ca21e026135061a0a57dcf3d0775b67a49";
zerokit = {
- url = "github:vacp2p/zerokit?rev=c60e0c33fc6350a4b1c20e6b6727c44317129582";
+ url = "github:vacp2p/zerokit?rev=dc0b31752c91e7b4fefc441cfa6a8210ad7dba7b";
inputs.nixpkgs.follows = "nixpkgs";
};
};
@@ -49,11 +49,18 @@
libwaku-android-arm64 = pkgs.callPackage ./nix/default.nix {
inherit stableSystems;
src = self;
- targets = ["libwaku-android-arm64"];
- androidArch = "aarch64-linux-android";
+ targets = ["libwaku-android-arm64"];
abidir = "arm64-v8a";
- zerokitPkg = zerokit.packages.${system}.zerokit-android-arm64;
+ zerokitRln = zerokit.packages.${system}.rln-android-arm64;
};
+
+ wakucanary = pkgs.callPackage ./nix/default.nix {
+ inherit stableSystems;
+ src = self;
+ targets = ["wakucanary"];
+ zerokitRln = zerokit.packages.${system}.rln;
+ };
+
default = libwaku-android-arm64;
});
@@ -61,4 +68,4 @@
default = pkgsFor.${system}.callPackage ./nix/shell.nix {};
});
};
-}
\ No newline at end of file
+}
diff --git a/nix/atlas.nix b/nix/atlas.nix
deleted file mode 100644
index 43336e07a..000000000
--- a/nix/atlas.nix
+++ /dev/null
@@ -1,12 +0,0 @@
-{ pkgs ? import { } }:
-
-let
- tools = pkgs.callPackage ./tools.nix {};
- sourceFile = ../vendor/nimbus-build-system/vendor/Nim/koch.nim;
-in pkgs.fetchFromGitHub {
- owner = "nim-lang";
- repo = "atlas";
- rev = tools.findKeyValue "^ +AtlasStableCommit = \"([a-f0-9]+)\"$" sourceFile;
- # WARNING: Requires manual updates when Nim compiler version changes.
- hash = "sha256-G1TZdgbRPSgxXZ3VsBP2+XFCLHXVb3an65MuQx67o/k=";
-}
\ No newline at end of file
diff --git a/nix/checksums.nix b/nix/checksums.nix
index d79345d24..510f2b41a 100644
--- a/nix/checksums.nix
+++ b/nix/checksums.nix
@@ -6,7 +6,7 @@ let
in pkgs.fetchFromGitHub {
owner = "nim-lang";
repo = "checksums";
- rev = tools.findKeyValue "^ +ChecksumsStableCommit = \"([a-f0-9]+)\"$" sourceFile;
+ rev = tools.findKeyValue "^ +ChecksumsStableCommit = \"([a-f0-9]+)\".*$" sourceFile;
# WARNING: Requires manual updates when Nim compiler version changes.
hash = "sha256-Bm5iJoT2kAvcTexiLMFBa9oU5gf7d4rWjo3OiN7obWQ=";
}
diff --git a/nix/default.nix b/nix/default.nix
index 29eec844d..d78f9935f 100644
--- a/nix/default.nix
+++ b/nix/default.nix
@@ -9,9 +9,8 @@
stableSystems ? [
"x86_64-linux" "aarch64-linux"
],
- androidArch,
- abidir,
- zerokitPkg,
+ abidir ? null,
+ zerokitRln,
}:
assert pkgs.lib.assertMsg ((src.submodules or true) == true)
@@ -51,7 +50,7 @@ in stdenv.mkDerivation rec {
cmake
which
lsb-release
- zerokitPkg
+ zerokitRln
nim-unwrapped-2_0
fakeGit
fakeCargo
@@ -84,27 +83,24 @@ in stdenv.mkDerivation rec {
pushd vendor/nimbus-build-system/vendor/Nim
mkdir dist
cp -r ${callPackage ./nimble.nix {}} dist/nimble
- chmod 777 -R dist/nimble
- mkdir -p dist/nimble/dist
- cp -r ${callPackage ./checksums.nix {}} dist/checksums # need both
- cp -r ${callPackage ./checksums.nix {}} dist/nimble/dist/checksums
- cp -r ${callPackage ./atlas.nix {}} dist/atlas
- chmod 777 -R dist/atlas
- mkdir dist/atlas/dist
- cp -r ${callPackage ./sat.nix {}} dist/nimble/dist/sat
- cp -r ${callPackage ./sat.nix {}} dist/atlas/dist/sat
+ cp -r ${callPackage ./checksums.nix {}} dist/checksums
cp -r ${callPackage ./csources.nix {}} csources_v2
chmod 777 -R dist/nimble csources_v2
popd
- mkdir -p vendor/zerokit/target/${androidArch}/release
- cp ${zerokitPkg}/librln.so vendor/zerokit/target/${androidArch}/release/
+ cp -r ${zerokitRln}/target vendor/zerokit/
+ find vendor/zerokit/target
+ # FIXME
+ cp vendor/zerokit/target/*/release/librln.a librln_v${zerokitRln.version}.a
'';
- installPhase = ''
+ installPhase = if abidir != null then ''
mkdir -p $out/jni
cp -r ./build/android/${abidir}/* $out/jni/
echo '${androidManifest}' > $out/jni/AndroidManifest.xml
cd $out && zip -r libwaku.aar *
+ '' else ''
+ mkdir -p $out/bin
+ cp -r build/* $out/bin
'';
meta = with pkgs.lib; {
diff --git a/nix/nimble.nix b/nix/nimble.nix
index 5bd7b0f32..f9d87da6d 100644
--- a/nix/nimble.nix
+++ b/nix/nimble.nix
@@ -6,7 +6,7 @@ let
in pkgs.fetchFromGitHub {
owner = "nim-lang";
repo = "nimble";
- rev = tools.findKeyValue "^ +NimbleStableCommit = \"([a-f0-9]+)\".+" sourceFile;
+ rev = tools.findKeyValue "^ +NimbleStableCommit = \"([a-f0-9]+)\".*$" sourceFile;
# WARNING: Requires manual updates when Nim compiler version changes.
hash = "sha256-MVHf19UbOWk8Zba2scj06PxdYYOJA6OXrVyDQ9Ku6Us=";
-}
\ No newline at end of file
+}
diff --git a/nix/sat.nix b/nix/sat.nix
index 31f264468..92db58a2e 100644
--- a/nix/sat.nix
+++ b/nix/sat.nix
@@ -6,7 +6,8 @@ let
in pkgs.fetchFromGitHub {
owner = "nim-lang";
repo = "sat";
- rev = tools.findKeyValue "^ +SatStableCommit = \"([a-f0-9]+)\"$" sourceFile;
+ rev = tools.findKeyValue "^ +SatStableCommit = \"([a-f0-9]+)\".*$" sourceFile;
+ # WARNING: Requires manual updates when Nim compiler version changes.
# WARNING: Requires manual updates when Nim compiler version changes.
hash = "sha256-JFrrSV+mehG0gP7NiQ8hYthL0cjh44HNbXfuxQNhq7c=";
-}
\ No newline at end of file
+}
From b0cd75f4cb7e98d3f5b74962f12469d6012b0a57 Mon Sep 17 00:00:00 2001
From: Prem Chaitanya Prathi
Date: Fri, 21 Nov 2025 23:15:12 +0530
Subject: [PATCH 05/70] feat: update rendezvous to broadcast and discover
WakuPeerRecords (#3617)
* update rendezvous to work with WakuPeeRecord and use libp2p updated version
* split rendezvous client and service implementation
* mount rendezvous client by default
---
Dockerfile.lightpushWithMix.compile | 2 +-
apps/chat2mix/chat2mix.nim | 18 +-
.../lightpush_mix/lightpush_publisher_mix.nim | 60 ++--
.../lightpush_publisher_mix_metrics.nim | 3 +
simulations/mixnet/run_chat_mix.sh | 3 +-
simulations/mixnet/run_chat_mix1.sh | 3 +-
tests/test_waku_rendezvous.nim | 36 ++-
tests/waku_discv5/test_waku_discv5.nim | 6 +-
vendor/nim-libp2p | 2 +-
waku.nimble | 2 +-
waku/common/callbacks.nim | 4 +-
waku/factory/node_factory.nim | 23 +-
waku/factory/waku_conf.nim | 3 +-
waku/node/peer_manager/waku_peer_store.nim | 19 +-
waku/node/waku_node.nim | 43 ++-
waku/waku_core/codecs.nim | 1 +
waku/waku_core/peers.nim | 4 +
waku/waku_lightpush/client.nim | 12 +-
waku/waku_mix/protocol.nim | 79 +++--
waku/waku_rendezvous/client.nim | 142 ++++++++
waku/waku_rendezvous/common.nim | 8 +
waku/waku_rendezvous/protocol.nim | 306 +++++++-----------
waku/waku_rendezvous/waku_peer_record.nim | 74 +++++
23 files changed, 564 insertions(+), 289 deletions(-)
create mode 100644 waku/waku_rendezvous/client.nim
create mode 100644 waku/waku_rendezvous/waku_peer_record.nim
diff --git a/Dockerfile.lightpushWithMix.compile b/Dockerfile.lightpushWithMix.compile
index 381ee60ef..8006ec50b 100644
--- a/Dockerfile.lightpushWithMix.compile
+++ b/Dockerfile.lightpushWithMix.compile
@@ -1,5 +1,5 @@
# BUILD NIM APP ----------------------------------------------------------------
-FROM rust:1.81.0-alpine3.19 AS nim-build
+FROM rustlang/rust:nightly-alpine3.19 AS nim-build
ARG NIMFLAGS
ARG MAKE_TARGET=lightpushwithmix
diff --git a/apps/chat2mix/chat2mix.nim b/apps/chat2mix/chat2mix.nim
index 5979e2936..3fdd7bc9c 100644
--- a/apps/chat2mix/chat2mix.nim
+++ b/apps/chat2mix/chat2mix.nim
@@ -124,7 +124,7 @@ proc encode*(message: Chat2Message): ProtoBuffer =
return serialised
-proc toString*(message: Chat2Message): string =
+proc `$`*(message: Chat2Message): string =
# Get message date and timestamp in local time
let time = message.timestamp.fromUnix().local().format("'<'MMM' 'dd,' 'HH:mm'>'")
@@ -331,13 +331,14 @@ proc maintainSubscription(
const maxFailedServiceNodeSwitches = 10
var noFailedSubscribes = 0
var noFailedServiceNodeSwitches = 0
- const RetryWaitMs = 2.seconds # Quick retry interval
- const SubscriptionMaintenanceMs = 30.seconds # Subscription maintenance interval
+ # Use chronos.Duration explicitly to avoid mismatch with std/times.Duration
+ let RetryWait = chronos.seconds(2) # Quick retry interval
+ let SubscriptionMaintenance = chronos.seconds(30) # Subscription maintenance interval
while true:
info "maintaining subscription at", peer = constructMultiaddrStr(actualFilterPeer)
# First use filter-ping to check if we have an active subscription
let pingErr = (await wakuNode.wakuFilterClient.ping(actualFilterPeer)).errorOr:
- await sleepAsync(SubscriptionMaintenanceMs)
+ await sleepAsync(SubscriptionMaintenance)
info "subscription is live."
continue
@@ -350,7 +351,7 @@ proc maintainSubscription(
some(filterPubsubTopic), filterContentTopic, actualFilterPeer
)
).errorOr:
- await sleepAsync(SubscriptionMaintenanceMs)
+ await sleepAsync(SubscriptionMaintenance)
if noFailedSubscribes > 0:
noFailedSubscribes -= 1
notice "subscribe request successful."
@@ -365,7 +366,7 @@ proc maintainSubscription(
# wakunode.peerManager.peerStore.delete(actualFilterPeer)
if noFailedSubscribes < maxFailedSubscribes:
- await sleepAsync(RetryWaitMs) # Wait a bit before retrying
+ await sleepAsync(RetryWait) # Wait a bit before retrying
elif not preventPeerSwitch:
# try again with new peer without delay
let actualFilterPeer = selectRandomServicePeer(
@@ -380,7 +381,7 @@ proc maintainSubscription(
noFailedSubscribes = 0
else:
- await sleepAsync(SubscriptionMaintenanceMs)
+ await sleepAsync(SubscriptionMaintenance)
{.pop.}
# @TODO confutils.nim(775, 17) Error: can raise an unlisted exception: ref IOError
@@ -450,6 +451,8 @@ proc processInput(rfd: AsyncFD, rng: ref HmacDrbgContext) {.async.} =
(await node.mountMix(conf.clusterId, mixPrivKey, conf.mixnodes)).isOkOr:
error "failed to mount waku mix protocol: ", error = $error
quit(QuitFailure)
+ await node.mountRendezvousClient(conf.clusterId)
+
await node.start()
node.peerManager.start()
@@ -587,7 +590,6 @@ proc processInput(rfd: AsyncFD, rng: ref HmacDrbgContext) {.async.} =
error "Couldn't find any service peer"
quit(QuitFailure)
- #await mountLegacyLightPush(node)
node.peerManager.addServicePeer(servicePeerInfo, WakuLightpushCodec)
node.peerManager.addServicePeer(servicePeerInfo, WakuPeerExchangeCodec)
diff --git a/examples/lightpush_mix/lightpush_publisher_mix.nim b/examples/lightpush_mix/lightpush_publisher_mix.nim
index 1e26daa9b..bb4bb4c4e 100644
--- a/examples/lightpush_mix/lightpush_publisher_mix.nim
+++ b/examples/lightpush_mix/lightpush_publisher_mix.nim
@@ -51,7 +51,6 @@ proc splitPeerIdAndAddr(maddr: string): (string, string) =
proc setupAndPublish(rng: ref HmacDrbgContext, conf: LightPushMixConf) {.async.} =
# use notice to filter all waku messaging
setupLog(logging.LogLevel.DEBUG, logging.LogFormat.TEXT)
-
notice "starting publisher", wakuPort = conf.port
let
@@ -114,17 +113,8 @@ proc setupAndPublish(rng: ref HmacDrbgContext, conf: LightPushMixConf) {.async.}
let dPeerId = PeerId.init(destPeerId).valueOr:
error "Failed to initialize PeerId", error = error
return
- var conn: Connection
- if not conf.mixDisabled:
- conn = node.wakuMix.toConnection(
- MixDestination.init(dPeerId, pxPeerInfo.addrs[0]), # destination lightpush peer
- WakuLightPushCodec, # protocol codec which will be used over the mix connection
- MixParameters(expectReply: Opt.some(true), numSurbs: Opt.some(byte(1))),
- # mix parameters indicating we expect a single reply
- ).valueOr:
- error "failed to create mix connection", error = error
- return
+ await node.mountRendezvousClient(clusterId)
await node.start()
node.peerManager.start()
node.startPeerExchangeLoop()
@@ -145,20 +135,26 @@ proc setupAndPublish(rng: ref HmacDrbgContext, conf: LightPushMixConf) {.async.}
var i = 0
while i < conf.numMsgs:
+ var conn: Connection
if conf.mixDisabled:
let connOpt = await node.peerManager.dialPeer(dPeerId, WakuLightPushCodec)
if connOpt.isNone():
error "failed to dial peer with WakuLightPushCodec", target_peer_id = dPeerId
return
conn = connOpt.get()
+ else:
+ conn = node.wakuMix.toConnection(
+ MixDestination.init(dPeerId, pxPeerInfo.addrs[0]), # destination lightpush peer
+ WakuLightPushCodec, # protocol codec which will be used over the mix connection
+ MixParameters(expectReply: Opt.some(true), numSurbs: Opt.some(byte(1))),
+ # mix parameters indicating we expect a single reply
+ ).valueOr:
+ error "failed to create mix connection", error = error
+ return
i = i + 1
let text =
"""Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nullam venenatis magna ut tortor faucibus, in vestibulum nibh commodo. Aenean eget vestibulum augue. Nullam suscipit urna non nunc efficitur, at iaculis nisl consequat. Mauris quis ultrices elit. Suspendisse lobortis odio vitae laoreet facilisis. Cras ornare sem felis, at vulputate magna aliquam ac. Duis quis est ultricies, euismod nulla ac, interdum dui. Maecenas sit amet est vitae enim commodo gravida. Proin vitae elit nulla. Donec tempor dolor lectus, in faucibus velit elementum quis. Donec non mauris eu nibh faucibus cursus ut egestas dolor. Aliquam venenatis ligula id velit pulvinar malesuada. Vestibulum scelerisque, justo non porta gravida, nulla justo tempor purus, at sollicitudin erat erat vel libero.
- Fusce nec eros eu metus tristique aliquet. Sed ut magna sagittis, vulputate diam sit amet, aliquam magna. Aenean sollicitudin velit lacus, eu ultrices magna semper at. Integer vitae felis ligula. In a eros nec risus condimentum tincidunt fermentum sit amet ex. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Nullam vitae justo maximus, fringilla tellus nec, rutrum purus. Etiam efficitur nisi dapibus euismod vestibulum. Phasellus at felis elementum, tristique nulla ac, consectetur neque.
- Maecenas hendrerit nibh eget velit rutrum, in ornare mauris molestie. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia curae; Praesent dignissim efficitur eros, sit amet rutrum justo mattis a. Fusce mollis neque at erat placerat bibendum. Ut fringilla fringilla orci, ut fringilla metus fermentum vel. In hac habitasse platea dictumst. Donec hendrerit porttitor odio. Suspendisse ornare sollicitudin mauris, sodales pulvinar velit finibus vel. Fusce id pulvinar neque. Suspendisse eget tincidunt sapien, ac accumsan turpis.
- Curabitur cursus tincidunt leo at aliquet. Nunc dapibus quam id venenatis varius. Aenean eget augue vel velit dapibus aliquam. Nulla facilisi. Curabitur cursus, turpis vel congue volutpat, tellus eros cursus lacus, eu fringilla turpis orci non ipsum. In hac habitasse platea dictumst. Nulla aliquam nisl a nunc placerat, eget dignissim felis pulvinar. Fusce sed porta mauris. Donec sodales arcu in nisl sodales, quis posuere massa ultricies. Nam feugiat massa eget felis ultricies finibus. Nunc magna nulla, interdum a elit vel, egestas efficitur urna. Ut posuere tincidunt odio in maximus. Sed at dignissim est.
- Morbi accumsan elementum ligula ut fringilla. Praesent in ex metus. Phasellus urna est, tempus sit amet elementum vitae, sollicitudin vel ipsum. Fusce hendrerit eleifend dignissim. Maecenas tempor dapibus dui quis laoreet. Cras tincidunt sed ipsum sed pellentesque. Proin ut tellus nec ipsum varius interdum. Curabitur id velit ligula. Etiam sapien nulla, cursus sodales orci eu, porta lobortis nunc. Nunc at dapibus velit. Nulla et nunc vehicula, condimentum erat quis, elementum dolor. Quisque eu metus fermentum, vestibulum tellus at, sollicitudin odio. Ut vel neque justo.
- Praesent porta porta velit, vel porttitor sem. Donec sagittis at nulla venenatis iaculis. Nullam vel eleifend felis. Nullam a pellentesque lectus. Aliquam tincidunt semper dui sed bibendum. Donec hendrerit, urna et cursus dictum, neque neque convallis magna, id condimentum sem urna quis massa. Fusce non quam vulputate, fermentum mauris at, malesuada ipsum. Mauris id pellentesque libero. Donec vel erat ullamcorper, dapibus quam id, imperdiet urna. Praesent sed ligula ut est pellentesque pharetra quis et diam. Ut placerat lorem eget mi fermentum aliquet.
+ Fusce nec eros eu metus tristique aliquet.
This is message #""" &
$i & """ sent from a publisher using mix. End of transmission."""
let message = WakuMessage(
@@ -168,25 +164,31 @@ proc setupAndPublish(rng: ref HmacDrbgContext, conf: LightPushMixConf) {.async.}
timestamp: getNowInNanosecondTime(),
) # current timestamp
- let res = await node.wakuLightpushClient.publishWithConn(
- LightpushPubsubTopic, message, conn, dPeerId
- )
+ let startTime = getNowInNanosecondTime()
- if res.isOk():
- lp_mix_success.inc()
- notice "published message",
- text = text,
- timestamp = message.timestamp,
- psTopic = LightpushPubsubTopic,
- contentTopic = LightpushContentTopic
- else:
- error "failed to publish message", error = $res.error
+ (
+ await node.wakuLightpushClient.publishWithConn(
+ LightpushPubsubTopic, message, conn, dPeerId
+ )
+ ).isOkOr:
+ error "failed to publish message via mix", error = error.desc
lp_mix_failed.inc(labelValues = ["publish_error"])
+ return
+
+ let latency = float64(getNowInNanosecondTime() - startTime) / 1_000_000.0
+ lp_mix_latency.observe(latency)
+ lp_mix_success.inc()
+ notice "published message",
+ text = text,
+ timestamp = message.timestamp,
+ latency = latency,
+ psTopic = LightpushPubsubTopic,
+ contentTopic = LightpushContentTopic
if conf.mixDisabled:
await conn.close()
await sleepAsync(conf.msgIntervalMilliseconds)
- info "###########Sent all messages via mix"
+ info "Sent all messages via mix"
quit(0)
when isMainModule:
diff --git a/examples/lightpush_mix/lightpush_publisher_mix_metrics.nim b/examples/lightpush_mix/lightpush_publisher_mix_metrics.nim
index cd06b3e3e..3c467e28c 100644
--- a/examples/lightpush_mix/lightpush_publisher_mix_metrics.nim
+++ b/examples/lightpush_mix/lightpush_publisher_mix_metrics.nim
@@ -6,3 +6,6 @@ declarePublicCounter lp_mix_success, "number of lightpush messages sent via mix"
declarePublicCounter lp_mix_failed,
"number of lightpush messages failed via mix", labels = ["error"]
+
+declarePublicHistogram lp_mix_latency,
+ "lightpush publish latency via mix in milliseconds"
diff --git a/simulations/mixnet/run_chat_mix.sh b/simulations/mixnet/run_chat_mix.sh
index 11a28c06b..3dd6f5932 100755
--- a/simulations/mixnet/run_chat_mix.sh
+++ b/simulations/mixnet/run_chat_mix.sh
@@ -1 +1,2 @@
-../../build/chat2mix --cluster-id=2 --num-shards-in-network=1 --shard=0 --servicenode="/ip4/127.0.0.1/tcp/60001/p2p/16Uiu2HAmPiEs2ozjjJF2iN2Pe2FYeMC9w4caRHKYdLdAfjgbWM6o" --log-level=TRACE --mixnode="/ip4/127.0.0.1/tcp/60002/p2p/16Uiu2HAmLtKaFaSWDohToWhWUZFLtqzYZGPFuXwKrojFVF6az5UF:9231e86da6432502900a84f867004ce78632ab52cd8e30b1ec322cd795710c2a" --mixnode="/ip4/127.0.0.1/tcp/60003/p2p/16Uiu2HAmTEDHwAziWUSz6ZE23h5vxG2o4Nn7GazhMor4bVuMXTrA:275cd6889e1f29ca48e5b9edb800d1a94f49f13d393a0ecf1a07af753506de6c" --mixnode="/ip4/127.0.0.1/tcp/60004/p2p/16Uiu2HAmPwRKZajXtfb1Qsv45VVfRZgK3ENdfmnqzSrVm3BczF6f:e0ed594a8d506681be075e8e23723478388fb182477f7a469309a25e7076fc18" --mixnode="/ip4/127.0.0.1/tcp/60005/p2p/16Uiu2HAmRhxmCHBYdXt1RibXrjAUNJbduAhzaTHwFCZT4qWnqZAu:8fd7a1a7c19b403d231452a9b1ea40eb1cc76f455d918ef8980e7685f9eeeb1f"
+../../build/chat2mix --cluster-id=2 --num-shards-in-network=1 --shard=0 --servicenode="/ip4/127.0.0.1/tcp/60001/p2p/16Uiu2HAmPiEs2ozjjJF2iN2Pe2FYeMC9w4caRHKYdLdAfjgbWM6o" --log-level=TRACE
+#--mixnode="/ip4/127.0.0.1/tcp/60002/p2p/16Uiu2HAmLtKaFaSWDohToWhWUZFLtqzYZGPFuXwKrojFVF6az5UF:9231e86da6432502900a84f867004ce78632ab52cd8e30b1ec322cd795710c2a" --mixnode="/ip4/127.0.0.1/tcp/60003/p2p/16Uiu2HAmTEDHwAziWUSz6ZE23h5vxG2o4Nn7GazhMor4bVuMXTrA:275cd6889e1f29ca48e5b9edb800d1a94f49f13d393a0ecf1a07af753506de6c" --mixnode="/ip4/127.0.0.1/tcp/60004/p2p/16Uiu2HAmPwRKZajXtfb1Qsv45VVfRZgK3ENdfmnqzSrVm3BczF6f:e0ed594a8d506681be075e8e23723478388fb182477f7a469309a25e7076fc18" --mixnode="/ip4/127.0.0.1/tcp/60005/p2p/16Uiu2HAmRhxmCHBYdXt1RibXrjAUNJbduAhzaTHwFCZT4qWnqZAu:8fd7a1a7c19b403d231452a9b1ea40eb1cc76f455d918ef8980e7685f9eeeb1f"
diff --git a/simulations/mixnet/run_chat_mix1.sh b/simulations/mixnet/run_chat_mix1.sh
index 11a28c06b..7323bb3a9 100755
--- a/simulations/mixnet/run_chat_mix1.sh
+++ b/simulations/mixnet/run_chat_mix1.sh
@@ -1 +1,2 @@
-../../build/chat2mix --cluster-id=2 --num-shards-in-network=1 --shard=0 --servicenode="/ip4/127.0.0.1/tcp/60001/p2p/16Uiu2HAmPiEs2ozjjJF2iN2Pe2FYeMC9w4caRHKYdLdAfjgbWM6o" --log-level=TRACE --mixnode="/ip4/127.0.0.1/tcp/60002/p2p/16Uiu2HAmLtKaFaSWDohToWhWUZFLtqzYZGPFuXwKrojFVF6az5UF:9231e86da6432502900a84f867004ce78632ab52cd8e30b1ec322cd795710c2a" --mixnode="/ip4/127.0.0.1/tcp/60003/p2p/16Uiu2HAmTEDHwAziWUSz6ZE23h5vxG2o4Nn7GazhMor4bVuMXTrA:275cd6889e1f29ca48e5b9edb800d1a94f49f13d393a0ecf1a07af753506de6c" --mixnode="/ip4/127.0.0.1/tcp/60004/p2p/16Uiu2HAmPwRKZajXtfb1Qsv45VVfRZgK3ENdfmnqzSrVm3BczF6f:e0ed594a8d506681be075e8e23723478388fb182477f7a469309a25e7076fc18" --mixnode="/ip4/127.0.0.1/tcp/60005/p2p/16Uiu2HAmRhxmCHBYdXt1RibXrjAUNJbduAhzaTHwFCZT4qWnqZAu:8fd7a1a7c19b403d231452a9b1ea40eb1cc76f455d918ef8980e7685f9eeeb1f"
+../../build/chat2mix --cluster-id=2 --num-shards-in-network=1 --shard=0 --servicenode="/ip4/127.0.0.1/tcp/60001/p2p/16Uiu2HAmPiEs2ozjjJF2iN2Pe2FYeMC9w4caRHKYdLdAfjgbWM6o" --log-level=TRACE
+#--mixnode="/ip4/127.0.0.1/tcp/60002/p2p/16Uiu2HAmLtKaFaSWDohToWhWUZFLtqzYZGPFuXwKrojFVF6az5UF:9231e86da6432502900a84f867004ce78632ab52cd8e30b1ec322cd795710c2a" --mixnode="/ip4/127.0.0.1/tcp/60003/p2p/16Uiu2HAmTEDHwAziWUSz6ZE23h5vxG2o4Nn7GazhMor4bVuMXTrA:275cd6889e1f29ca48e5b9edb800d1a94f49f13d393a0ecf1a07af753506de6c" --mixnode="/ip4/127.0.0.1/tcp/60004/p2p/16Uiu2HAmPwRKZajXtfb1Qsv45VVfRZgK3ENdfmnqzSrVm3BczF6f:e0ed594a8d506681be075e8e23723478388fb182477f7a469309a25e7076fc18" --mixnode="/ip4/127.0.0.1/tcp/60005/p2p/16Uiu2HAmRhxmCHBYdXt1RibXrjAUNJbduAhzaTHwFCZT4qWnqZAu:8fd7a1a7c19b403d231452a9b1ea40eb1cc76f455d918ef8980e7685f9eeeb1f"
diff --git a/tests/test_waku_rendezvous.nim b/tests/test_waku_rendezvous.nim
index fa2efbd47..d3dd6f920 100644
--- a/tests/test_waku_rendezvous.nim
+++ b/tests/test_waku_rendezvous.nim
@@ -1,12 +1,20 @@
{.used.}
-import std/options, chronos, testutils/unittests, libp2p/builders
+import
+ std/options,
+ chronos,
+ testutils/unittests,
+ libp2p/builders,
+ libp2p/protocols/rendezvous
import
waku/waku_core/peers,
+ waku/waku_core/codecs,
waku/node/waku_node,
waku/node/peer_manager/peer_manager,
waku/waku_rendezvous/protocol,
+ waku/waku_rendezvous/common,
+ waku/waku_rendezvous/waku_peer_record,
./testlib/[wakucore, wakunode]
procSuite "Waku Rendezvous":
@@ -50,18 +58,26 @@ procSuite "Waku Rendezvous":
node2.peerManager.addPeer(peerInfo3)
node3.peerManager.addPeer(peerInfo2)
- let namespace = "test/name/space"
-
- let res = await node1.wakuRendezvous.batchAdvertise(
- namespace, 60.seconds, @[peerInfo2.peerId]
- )
+ let res = await node1.wakuRendezvous.advertiseAll()
assert res.isOk(), $res.error
+ # Rendezvous Request API requires dialing first
+ let connOpt =
+ await node3.peerManager.dialPeer(peerInfo2.peerId, WakuRendezVousCodec)
+ require:
+ connOpt.isSome
- let response =
- await node3.wakuRendezvous.batchRequest(namespace, 1, @[peerInfo2.peerId])
- assert response.isOk(), $response.error
- let records = response.get()
+ var records: seq[WakuPeerRecord]
+ try:
+ records = await rendezvous.request[WakuPeerRecord](
+ node3.wakuRendezvous,
+ Opt.some(computeMixNamespace(clusterId)),
+ Opt.some(1),
+ Opt.some(@[peerInfo2.peerId]),
+ )
+ except CatchableError as e:
+ assert false, "Request failed with exception: " & e.msg
check:
records.len == 1
records[0].peerId == peerInfo1.peerId
+ #records[0].mixPubKey == $node1.wakuMix.pubKey
diff --git a/tests/waku_discv5/test_waku_discv5.nim b/tests/waku_discv5/test_waku_discv5.nim
index 6685bda32..20a0c6965 100644
--- a/tests/waku_discv5/test_waku_discv5.nim
+++ b/tests/waku_discv5/test_waku_discv5.nim
@@ -426,7 +426,6 @@ suite "Waku Discovery v5":
confBuilder.withNodeKey(libp2p_keys.PrivateKey.random(Secp256k1, myRng[])[])
confBuilder.discv5Conf.withEnabled(true)
confBuilder.discv5Conf.withUdpPort(9000.Port)
-
let conf = confBuilder.build().valueOr:
raiseAssert error
@@ -468,6 +467,9 @@ suite "Waku Discovery v5":
# leave some time for discv5 to act
await sleepAsync(chronos.seconds(10))
+ # Connect peers via peer manager to ensure identify happens
+ discard await waku0.node.peerManager.connectPeer(waku1.node.switch.peerInfo)
+
var r = waku0.node.peerManager.selectPeer(WakuPeerExchangeCodec)
assert r.isSome(), "could not retrieve peer mounting WakuPeerExchangeCodec"
@@ -480,7 +482,7 @@ suite "Waku Discovery v5":
r = waku2.node.peerManager.selectPeer(WakuPeerExchangeCodec)
assert r.isSome(), "could not retrieve peer mounting WakuPeerExchangeCodec"
- r = waku2.node.peerManager.selectPeer(RendezVousCodec)
+ r = waku2.node.peerManager.selectPeer(WakuRendezVousCodec)
assert r.isSome(), "could not retrieve peer mounting RendezVousCodec"
asyncTest "Discv5 bootstrap nodes should be added to the peer store":
diff --git a/vendor/nim-libp2p b/vendor/nim-libp2p
index 0309685cd..e82080f7b 160000
--- a/vendor/nim-libp2p
+++ b/vendor/nim-libp2p
@@ -1 +1 @@
-Subproject commit 0309685cd27d4bf763c8b3be86a76c33bcfe67ea
+Subproject commit e82080f7b1aa61c6d35fa5311b873f41eff4bb52
diff --git a/waku.nimble b/waku.nimble
index c63d20246..79fdd9fd6 100644
--- a/waku.nimble
+++ b/waku.nimble
@@ -24,7 +24,7 @@ requires "nim >= 2.2.4",
"stew",
"stint",
"metrics",
- "libp2p >= 1.14.2",
+ "libp2p >= 1.14.3",
"web3",
"presto",
"regex",
diff --git a/waku/common/callbacks.nim b/waku/common/callbacks.nim
index 9b8590152..83209ef24 100644
--- a/waku/common/callbacks.nim
+++ b/waku/common/callbacks.nim
@@ -1,5 +1,7 @@
-import ../waku_enr/capabilities
+import waku/waku_enr/capabilities, waku/waku_rendezvous/waku_peer_record
type GetShards* = proc(): seq[uint16] {.closure, gcsafe, raises: [].}
type GetCapabilities* = proc(): seq[Capabilities] {.closure, gcsafe, raises: [].}
+
+type GetWakuPeerRecord* = proc(): WakuPeerRecord {.closure, gcsafe, raises: [].}
diff --git a/waku/factory/node_factory.nim b/waku/factory/node_factory.nim
index 488d07c06..34fc958fe 100644
--- a/waku/factory/node_factory.nim
+++ b/waku/factory/node_factory.nim
@@ -163,6 +163,15 @@ proc setupProtocols(
error "Unrecoverable error occurred", error = msg
quit(QuitFailure)
+ #mount mix
+ if conf.mixConf.isSome():
+ (
+ await node.mountMix(
+ conf.clusterId, conf.mixConf.get().mixKey, conf.mixConf.get().mixnodes
+ )
+ ).isOkOr:
+ return err("failed to mount waku mix protocol: " & $error)
+
if conf.storeServiceConf.isSome():
let storeServiceConf = conf.storeServiceConf.get()
if storeServiceConf.supportV2:
@@ -327,9 +336,9 @@ proc setupProtocols(
protectedShard = shardKey.shard, publicKey = shardKey.key
node.wakuRelay.addSignedShardsValidator(subscribedProtectedShards, conf.clusterId)
- # Only relay nodes should be rendezvous points.
- if conf.rendezvous:
- await node.mountRendezvous(conf.clusterId)
+ if conf.rendezvous:
+ await node.mountRendezvous(conf.clusterId)
+ await node.mountRendezvousClient(conf.clusterId)
# Keepalive mounted on all nodes
try:
@@ -414,14 +423,6 @@ proc setupProtocols(
if conf.peerExchangeDiscovery:
await node.mountPeerExchangeClient()
- #mount mix
- if conf.mixConf.isSome():
- (
- await node.mountMix(
- conf.clusterId, conf.mixConf.get().mixKey, conf.mixConf.get().mixnodes
- )
- ).isOkOr:
- return err("failed to mount waku mix protocol: " & $error)
return ok()
## Start node
diff --git a/waku/factory/waku_conf.nim b/waku/factory/waku_conf.nim
index 89ffb366c..899008221 100644
--- a/waku/factory/waku_conf.nim
+++ b/waku/factory/waku_conf.nim
@@ -154,7 +154,8 @@ proc logConf*(conf: WakuConf) =
store = conf.storeServiceConf.isSome(),
filter = conf.filterServiceConf.isSome(),
lightPush = conf.lightPush,
- peerExchange = conf.peerExchangeService
+ peerExchange = conf.peerExchangeService,
+ rendezvous = conf.rendezvous
info "Configuration. Network", cluster = conf.clusterId
diff --git a/waku/node/peer_manager/waku_peer_store.nim b/waku/node/peer_manager/waku_peer_store.nim
index c9e2d4817..9cde53fe1 100644
--- a/waku/node/peer_manager/waku_peer_store.nim
+++ b/waku/node/peer_manager/waku_peer_store.nim
@@ -6,7 +6,8 @@ import
chronicles,
eth/p2p/discoveryv5/enr,
libp2p/builders,
- libp2p/peerstore
+ libp2p/peerstore,
+ libp2p/crypto/curve25519
import
../../waku_core,
@@ -42,6 +43,9 @@ type
# Keeps track of peer shards
ShardBook* = ref object of PeerBook[seq[uint16]]
+ # Keeps track of Mix protocol public keys of peers
+ MixPubKeyBook* = ref object of PeerBook[Curve25519Key]
+
proc getPeer*(peerStore: PeerStore, peerId: PeerId): RemotePeerInfo =
let addresses =
if peerStore[LastSeenBook][peerId].isSome():
@@ -68,6 +72,11 @@ proc getPeer*(peerStore: PeerStore, peerId: PeerId): RemotePeerInfo =
direction: peerStore[DirectionBook][peerId],
lastFailedConn: peerStore[LastFailedConnBook][peerId],
numberFailedConn: peerStore[NumberFailedConnBook][peerId],
+ mixPubKey:
+ if peerStore[MixPubKeyBook][peerId] != default(Curve25519Key):
+ some(peerStore[MixPubKeyBook][peerId])
+ else:
+ none(Curve25519Key),
)
proc delete*(peerStore: PeerStore, peerId: PeerId) =
@@ -87,6 +96,13 @@ proc peers*(peerStore: PeerStore): seq[RemotePeerInfo] =
return allKeys.mapIt(peerStore.getPeer(it))
proc addPeer*(peerStore: PeerStore, peer: RemotePeerInfo, origin = UnknownOrigin) =
+ ## Storing MixPubKey even if peer is already present as this info might be new
+ ## or updated.
+ if peer.mixPubKey.isSome():
+ trace "adding mix pub key to peer store",
+ peer_id = $peer.peerId, mix_pub_key = $peer.mixPubKey.get()
+ peerStore[MixPubKeyBook].book[peer.peerId] = peer.mixPubKey.get()
+
## Notice that the origin parameter is used to manually override the given peer origin.
## At the time of writing, this is used in waku_discv5 or waku_node (peer exchange.)
if peerStore[AddressBook][peer.peerId] == peer.addrs and
@@ -113,6 +129,7 @@ proc addPeer*(peerStore: PeerStore, peer: RemotePeerInfo, origin = UnknownOrigin
peerStore[ProtoBook][peer.peerId] = protos
## We don't care whether the item was already present in the table or not. Hence, we always discard the hasKeyOrPut's bool returned value
+
discard peerStore[AgentBook].book.hasKeyOrPut(peer.peerId, peer.agent)
discard peerStore[ProtoVersionBook].book.hasKeyOrPut(peer.peerId, peer.protoVersion)
discard peerStore[KeyBook].book.hasKeyOrPut(peer.peerId, peer.publicKey)
diff --git a/waku/node/waku_node.nim b/waku/node/waku_node.nim
index 114775951..65b2093bb 100644
--- a/waku/node/waku_node.nim
+++ b/waku/node/waku_node.nim
@@ -22,6 +22,7 @@ import
libp2p/transports/tcptransport,
libp2p/transports/wstransport,
libp2p/utility,
+ libp2p/utils/offsettedseq,
libp2p/protocols/mix,
libp2p/protocols/mix/mix_protocol
@@ -43,6 +44,8 @@ import
../waku_filter_v2/client as filter_client,
../waku_metadata,
../waku_rendezvous/protocol,
+ ../waku_rendezvous/client as rendezvous_client,
+ ../waku_rendezvous/waku_peer_record,
../waku_lightpush_legacy/client as legacy_ligntpuhs_client,
../waku_lightpush_legacy as legacy_lightpush_protocol,
../waku_lightpush/client as ligntpuhs_client,
@@ -121,6 +124,7 @@ type
libp2pPing*: Ping
rng*: ref rand.HmacDrbgContext
wakuRendezvous*: WakuRendezVous
+ wakuRendezvousClient*: rendezvous_client.WakuRendezVousClient
announcedAddresses*: seq[MultiAddress]
started*: bool # Indicates that node has started listening
topicSubscriptionQueue*: AsyncEventQueue[SubscriptionEvent]
@@ -148,6 +152,17 @@ proc getCapabilitiesGetter(node: WakuNode): GetCapabilities =
return @[]
return node.enr.getCapabilities()
+proc getWakuPeerRecordGetter(node: WakuNode): GetWakuPeerRecord =
+ return proc(): WakuPeerRecord {.closure, gcsafe, raises: [].} =
+ var mixKey: string
+ if not node.wakuMix.isNil():
+ mixKey = node.wakuMix.pubKey.to0xHex()
+ return WakuPeerRecord.init(
+ peerId = node.switch.peerInfo.peerId,
+ addresses = node.announcedAddresses,
+ mixKey = mixKey,
+ )
+
proc new*(
T: type WakuNode,
netConfig: NetConfig,
@@ -257,12 +272,12 @@ proc mountMix*(
return err("Failed to convert multiaddress to string.")
info "local addr", localaddr = localaddrStr
- let nodeAddr = localaddrStr & "/p2p/" & $node.peerId
node.wakuMix = WakuMix.new(
- nodeAddr, node.peerManager, clusterId, mixPrivKey, mixnodes
+ localaddrStr, node.peerManager, clusterId, mixPrivKey, mixnodes
).valueOr:
error "Waku Mix protocol initialization failed", err = error
return
+ #TODO: should we do the below only for exit node? Also, what if multiple protocols use mix?
node.wakuMix.registerDestReadBehavior(WakuLightPushCodec, readLp(int(-1)))
let catchRes = catch:
node.switch.mount(node.wakuMix)
@@ -346,6 +361,18 @@ proc selectRandomPeers*(peers: seq[PeerId], numRandomPeers: int): seq[PeerId] =
shuffle(randomPeers)
return randomPeers[0 ..< min(len(randomPeers), numRandomPeers)]
+proc mountRendezvousClient*(node: WakuNode, clusterId: uint16) {.async: (raises: []).} =
+ info "mounting rendezvous client"
+
+ node.wakuRendezvousClient = rendezvous_client.WakuRendezVousClient.new(
+ node.switch, node.peerManager, clusterId
+ ).valueOr:
+ error "initializing waku rendezvous client failed", error = error
+ return
+
+ if node.started:
+ await node.wakuRendezvousClient.start()
+
proc mountRendezvous*(node: WakuNode, clusterId: uint16) {.async: (raises: []).} =
info "mounting rendezvous discovery protocol"
@@ -355,6 +382,7 @@ proc mountRendezvous*(node: WakuNode, clusterId: uint16) {.async: (raises: []).}
clusterId,
node.getShardsGetter(),
node.getCapabilitiesGetter(),
+ node.getWakuPeerRecordGetter(),
).valueOr:
error "initializing waku rendezvous failed", error = error
return
@@ -362,6 +390,11 @@ proc mountRendezvous*(node: WakuNode, clusterId: uint16) {.async: (raises: []).}
if node.started:
await node.wakuRendezvous.start()
+ try:
+ node.switch.mount(node.wakuRendezvous, protocolMatcher(WakuRendezVousCodec))
+ except LPError:
+ error "failed to mount wakuRendezvous", error = getCurrentExceptionMsg()
+
proc isBindIpWithZeroPort(inputMultiAdd: MultiAddress): bool =
let inputStr = $inputMultiAdd
if inputStr.contains("0.0.0.0/tcp/0") or inputStr.contains("127.0.0.1/tcp/0"):
@@ -438,6 +471,9 @@ proc start*(node: WakuNode) {.async.} =
if not node.wakuRendezvous.isNil():
await node.wakuRendezvous.start()
+ if not node.wakuRendezvousClient.isNil():
+ await node.wakuRendezvousClient.start()
+
if not node.wakuStoreReconciliation.isNil():
node.wakuStoreReconciliation.start()
@@ -499,6 +535,9 @@ proc stop*(node: WakuNode) {.async.} =
if not node.wakuRendezvous.isNil():
await node.wakuRendezvous.stopWait()
+ if not node.wakuRendezvousClient.isNil():
+ await node.wakuRendezvousClient.stopWait()
+
node.started = false
proc isReady*(node: WakuNode): Future[bool] {.async: (raises: [Exception]).} =
diff --git a/waku/waku_core/codecs.nim b/waku/waku_core/codecs.nim
index 6dcdfe2f5..0d9394c71 100644
--- a/waku/waku_core/codecs.nim
+++ b/waku/waku_core/codecs.nim
@@ -10,3 +10,4 @@ const
WakuMetadataCodec* = "/vac/waku/metadata/1.0.0"
WakuPeerExchangeCodec* = "/vac/waku/peer-exchange/2.0.0-alpha1"
WakuLegacyStoreCodec* = "/vac/waku/store/2.0.0-beta4"
+ WakuRendezVousCodec* = "/vac/waku/rendezvous/1.0.0"
diff --git a/waku/waku_core/peers.nim b/waku/waku_core/peers.nim
index 76ff29aa0..48c994403 100644
--- a/waku/waku_core/peers.nim
+++ b/waku/waku_core/peers.nim
@@ -9,6 +9,7 @@ import
eth/p2p/discoveryv5/enr,
eth/net/utils,
libp2p/crypto/crypto,
+ libp2p/crypto/curve25519,
libp2p/crypto/secp,
libp2p/errors,
libp2p/multiaddress,
@@ -49,6 +50,7 @@ type RemotePeerInfo* = ref object
enr*: Option[enr.Record]
protocols*: seq[string]
shards*: seq[uint16]
+ mixPubKey*: Option[Curve25519Key]
agent*: string
protoVersion*: string
@@ -84,6 +86,7 @@ proc init*(
direction: PeerDirection = UnknownDirection,
lastFailedConn: Moment = Moment.init(0, Second),
numberFailedConn: int = 0,
+ mixPubKey: Option[Curve25519Key] = none(Curve25519Key),
): T =
RemotePeerInfo(
peerId: peerId,
@@ -100,6 +103,7 @@ proc init*(
direction: direction,
lastFailedConn: lastFailedConn,
numberFailedConn: numberFailedConn,
+ mixPubKey: mixPubKey,
)
proc init*(
diff --git a/waku/waku_lightpush/client.nim b/waku/waku_lightpush/client.nim
index 4d0c49a84..d68552304 100644
--- a/waku/waku_lightpush/client.nim
+++ b/waku/waku_lightpush/client.nim
@@ -45,8 +45,13 @@ proc sendPushRequest(
defer:
await connection.closeWithEOF()
-
- await connection.writeLP(req.encode().buffer)
+ try:
+ await connection.writeLP(req.encode().buffer)
+ except CatchableError:
+ error "failed to send push request", error = getCurrentExceptionMsg()
+ return lightpushResultInternalError(
+ "failed to send push request: " & getCurrentExceptionMsg()
+ )
var buffer: seq[byte]
try:
@@ -56,9 +61,8 @@ proc sendPushRequest(
return lightpushResultInternalError(
"Failed to read response from peer: " & getCurrentExceptionMsg()
)
-
let response = LightpushResponse.decode(buffer).valueOr:
- error "failed to decode response"
+ error "failed to decode response", error = $error
waku_lightpush_v3_errors.inc(labelValues = [decodeRpcFailure])
return lightpushResultInternalError(decodeRpcFailure)
diff --git a/waku/waku_mix/protocol.nim b/waku/waku_mix/protocol.nim
index 34b50f8a9..d3d765df8 100644
--- a/waku/waku_mix/protocol.nim
+++ b/waku/waku_mix/protocol.nim
@@ -6,6 +6,8 @@ import
libp2p/crypto/curve25519,
libp2p/protocols/mix,
libp2p/protocols/mix/mix_node,
+ libp2p/protocols/mix/mix_protocol,
+ libp2p/protocols/mix/mix_metrics,
libp2p/[multiaddress, multicodec, peerid],
eth/common/keys
@@ -34,22 +36,18 @@ type
multiAddr*: string
pubKey*: Curve25519Key
-proc mixPoolFilter*(cluster: Option[uint16], peer: RemotePeerInfo): bool =
+proc filterMixNodes(cluster: Option[uint16], peer: RemotePeerInfo): bool =
# Note that origin based(discv5) filtering is not done intentionally
# so that more mix nodes can be discovered.
- if peer.enr.isNone():
- trace "peer has no ENR", peer = $peer
+ if peer.mixPubKey.isNone():
+ trace "remote peer has no mix Pub Key", peer = $peer
return false
- if cluster.isSome() and peer.enr.get().isClusterMismatched(cluster.get()):
+ if cluster.isSome() and peer.enr.isSome() and
+ peer.enr.get().isClusterMismatched(cluster.get()):
trace "peer has mismatching cluster", peer = $peer
return false
- # Filter if mix is enabled
- if not peer.enr.get().supportsCapability(Capabilities.Mix):
- trace "peer doesn't support mix", peer = $peer
- return false
-
return true
proc appendPeerIdToMultiaddr*(multiaddr: MultiAddress, peerId: PeerId): MultiAddress =
@@ -74,34 +72,52 @@ func getIPv4Multiaddr*(maddrs: seq[MultiAddress]): Option[MultiAddress] =
trace "no ipv4 multiaddr found"
return none(MultiAddress)
-#[ Not deleting as these can be reused once discovery is sorted
- proc populateMixNodePool*(mix: WakuMix) =
+proc populateMixNodePool*(mix: WakuMix) =
# populate only peers that i) are reachable ii) share cluster iii) support mix
let remotePeers = mix.peerManager.switch.peerStore.peers().filterIt(
- mixPoolFilter(some(mix.clusterId), it)
+ filterMixNodes(some(mix.clusterId), it)
)
var mixNodes = initTable[PeerId, MixPubInfo]()
for i in 0 ..< min(remotePeers.len, 100):
- let remotePeerENR = remotePeers[i].enr.get()
let ipv4addr = getIPv4Multiaddr(remotePeers[i].addrs).valueOr:
trace "peer has no ipv4 address", peer = $remotePeers[i]
continue
- let maddrWithPeerId =
- toString(appendPeerIdToMultiaddr(ipv4addr, remotePeers[i].peerId))
- trace "remote peer ENR",
- peerId = remotePeers[i].peerId, enr = remotePeerENR, maddr = maddrWithPeerId
+ let maddrWithPeerId = appendPeerIdToMultiaddr(ipv4addr, remotePeers[i].peerId)
+ trace "remote peer info", info = remotePeers[i]
- let peerMixPubKey = mixKey(remotePeerENR).get()
- let mixNodePubInfo =
- createMixPubInfo(maddrWithPeerId.value, intoCurve25519Key(peerMixPubKey))
+ if remotePeers[i].mixPubKey.isNone():
+ trace "peer has no mix Pub Key", remotePeerId = $remotePeers[i]
+ continue
+
+ let peerMixPubKey = remotePeers[i].mixPubKey.get()
+ var peerPubKey: crypto.PublicKey
+ if not remotePeers[i].peerId.extractPublicKey(peerPubKey):
+ warn "Failed to extract public key from peerId, skipping node",
+ remotePeerId = remotePeers[i].peerId
+ continue
+
+ if peerPubKey.scheme != PKScheme.Secp256k1:
+ warn "Peer public key is not Secp256k1, skipping node",
+ remotePeerId = remotePeers[i].peerId, scheme = peerPubKey.scheme
+ continue
+
+ let mixNodePubInfo = MixPubInfo.init(
+ remotePeers[i].peerId,
+ ipv4addr,
+ intoCurve25519Key(peerMixPubKey),
+ peerPubKey.skkey,
+ )
+ trace "adding mix node to pool",
+ remotePeerId = remotePeers[i].peerId, multiAddr = $ipv4addr
mixNodes[remotePeers[i].peerId] = mixNodePubInfo
- mix_pool_size.set(len(mixNodes))
# set the mix node pool
mix.setNodePool(mixNodes)
+ mix_pool_size.set(len(mixNodes))
trace "mix node pool updated", poolSize = mix.getNodePoolSize()
+# Once mix protocol starts to use info from PeerStore, then this can be removed.
proc startMixNodePoolMgr*(mix: WakuMix) {.async.} =
info "starting mix node pool manager"
# try more aggressively to populate the pool at startup
@@ -115,9 +131,10 @@ proc startMixNodePoolMgr*(mix: WakuMix) {.async.} =
# TODO: make interval configurable
heartbeat "Updating mix node pool", 5.seconds:
mix.populateMixNodePool()
- ]#
-proc toMixNodeTable(bootnodes: seq[MixNodePubInfo]): Table[PeerId, MixPubInfo] =
+proc processBootNodes(
+ bootnodes: seq[MixNodePubInfo], peermgr: PeerManager
+): Table[PeerId, MixPubInfo] =
var mixNodes = initTable[PeerId, MixPubInfo]()
for node in bootnodes:
let pInfo = parsePeerInfo(node.multiAddr).valueOr:
@@ -140,6 +157,11 @@ proc toMixNodeTable(bootnodes: seq[MixNodePubInfo]): Table[PeerId, MixPubInfo] =
continue
mixNodes[peerId] = MixPubInfo.init(peerId, multiAddr, node.pubKey, peerPubKey.skkey)
+
+ peermgr.addPeer(
+ RemotePeerInfo.init(peerId, @[multiAddr], mixPubKey = some(node.pubKey))
+ )
+ mix_pool_size.set(len(mixNodes))
info "using mix bootstrap nodes ", bootNodes = mixNodes
return mixNodes
@@ -152,7 +174,7 @@ proc new*(
bootnodes: seq[MixNodePubInfo],
): WakuMixResult[T] =
let mixPubKey = public(mixPrivKey)
- info "mixPrivKey", mixPrivKey = mixPrivKey, mixPubKey = mixPubKey
+ info "mixPubKey", mixPubKey = mixPubKey
let nodeMultiAddr = MultiAddress.init(nodeAddr).valueOr:
return err("failed to parse mix node address: " & $nodeAddr & ", error: " & error)
let localMixNodeInfo = initMixNodeInfo(
@@ -160,17 +182,18 @@ proc new*(
peermgr.switch.peerInfo.publicKey.skkey, peermgr.switch.peerInfo.privateKey.skkey,
)
if bootnodes.len < mixMixPoolSize:
- warn "publishing with mix won't work as there are less than 3 mix nodes in node pool"
- let initTable = toMixNodeTable(bootnodes)
+ warn "publishing with mix won't work until there are 3 mix nodes in node pool"
+ let initTable = processBootNodes(bootnodes, peermgr)
+
if len(initTable) < mixMixPoolSize:
- warn "publishing with mix won't work as there are less than 3 mix nodes in node pool"
+ warn "publishing with mix won't work until there are 3 mix nodes in node pool"
var m = WakuMix(peerManager: peermgr, clusterId: clusterId, pubKey: mixPubKey)
procCall MixProtocol(m).init(localMixNodeInfo, initTable, peermgr.switch)
return ok(m)
method start*(mix: WakuMix) =
info "starting waku mix protocol"
- #mix.nodePoolLoopHandle = mix.startMixNodePoolMgr() This can be re-enabled once discovery is addressed
+ mix.nodePoolLoopHandle = mix.startMixNodePoolMgr()
method stop*(mix: WakuMix) {.async.} =
if mix.nodePoolLoopHandle.isNil():
diff --git a/waku/waku_rendezvous/client.nim b/waku/waku_rendezvous/client.nim
new file mode 100644
index 000000000..09e789774
--- /dev/null
+++ b/waku/waku_rendezvous/client.nim
@@ -0,0 +1,142 @@
+{.push raises: [].}
+
+import
+ std/[options, sequtils, tables],
+ results,
+ chronos,
+ chronicles,
+ libp2p/protocols/rendezvous,
+ libp2p/crypto/curve25519,
+ libp2p/switch,
+ libp2p/utils/semaphore
+
+import metrics except collect
+
+import
+ waku/node/peer_manager,
+ waku/waku_core/peers,
+ waku/waku_core/codecs,
+ ./common,
+ ./waku_peer_record
+
+logScope:
+ topics = "waku rendezvous client"
+
+declarePublicCounter rendezvousPeerFoundTotal,
+ "total number of peers found via rendezvous"
+
+type WakuRendezVousClient* = ref object
+ switch: Switch
+ peerManager: PeerManager
+ clusterId: uint16
+ requestInterval: timer.Duration
+ periodicRequestFut: Future[void]
+ # Internal rendezvous instance for making requests
+ rdv: GenericRendezVous[WakuPeerRecord]
+
+const MaxSimultanesousAdvertisements = 5
+const RendezVousLookupInterval = 10.seconds
+
+proc requestAll*(
+ self: WakuRendezVousClient
+): Future[Result[void, string]] {.async: (raises: []).} =
+ trace "waku rendezvous client requests started"
+
+ let namespace = computeMixNamespace(self.clusterId)
+
+ # Get a random WakuRDV peer
+ let rpi = self.peerManager.selectPeer(WakuRendezVousCodec).valueOr:
+ return err("could not get a peer supporting WakuRendezVousCodec")
+
+ var records: seq[WakuPeerRecord]
+ try:
+ # Use the libp2p rendezvous request method
+ records = await self.rdv.request(
+ Opt.some(namespace), Opt.some(PeersRequestedCount), Opt.some(@[rpi.peerId])
+ )
+ except CatchableError as e:
+ return err("rendezvous request failed: " & e.msg)
+
+ trace "waku rendezvous client request got peers", count = records.len
+ for record in records:
+ if not self.switch.peerStore.peerExists(record.peerId):
+ rendezvousPeerFoundTotal.inc()
+ if record.mixKey.len == 0 or record.peerId == self.switch.peerInfo.peerId:
+ continue
+ trace "adding peer from rendezvous",
+ peerId = record.peerId, addresses = $record.addresses, mixKey = record.mixKey
+ let rInfo = RemotePeerInfo.init(
+ record.peerId,
+ record.addresses,
+ mixPubKey = some(intoCurve25519Key(fromHex(record.mixKey))),
+ )
+ self.peerManager.addPeer(rInfo)
+
+ trace "waku rendezvous client request finished"
+
+ return ok()
+
+proc periodicRequests(self: WakuRendezVousClient) {.async.} =
+ info "waku rendezvous periodic requests started", interval = self.requestInterval
+
+ # infinite loop
+ while true:
+ await sleepAsync(self.requestInterval)
+
+ (await self.requestAll()).isOkOr:
+ error "waku rendezvous requests failed", error = error
+
+ # Exponential backoff
+
+#[ TODO: Reevaluate for mix, maybe be aggresive in the start until a sizeable pool is built and then backoff
+ self.requestInterval += self.requestInterval
+
+ if self.requestInterval >= 1.days:
+ break ]#
+
+proc new*(
+ T: type WakuRendezVousClient,
+ switch: Switch,
+ peerManager: PeerManager,
+ clusterId: uint16,
+): Result[T, string] {.raises: [].} =
+ # Create a minimal GenericRendezVous instance for client-side requests
+ # We don't need the full server functionality, just the request method
+ let rng = newRng()
+ let rdv = GenericRendezVous[WakuPeerRecord](
+ switch: switch,
+ rng: rng,
+ sema: newAsyncSemaphore(MaxSimultanesousAdvertisements),
+ minDuration: rendezvous.MinimumAcceptedDuration,
+ maxDuration: rendezvous.MaximumDuration,
+ minTTL: rendezvous.MinimumAcceptedDuration.seconds.uint64,
+ maxTTL: rendezvous.MaximumDuration.seconds.uint64,
+ peers: @[], # Will be populated from selectPeer calls
+ cookiesSaved: initTable[PeerId, Table[string, seq[byte]]](),
+ peerRecordValidator: checkWakuPeerRecord,
+ )
+
+ # Set codec separately as it's inherited from LPProtocol
+ rdv.codec = WakuRendezVousCodec
+
+ let client = T(
+ switch: switch,
+ peerManager: peerManager,
+ clusterId: clusterId,
+ requestInterval: RendezVousLookupInterval,
+ rdv: rdv,
+ )
+
+ info "waku rendezvous client initialized", clusterId = clusterId
+
+ return ok(client)
+
+proc start*(self: WakuRendezVousClient) {.async: (raises: []).} =
+ self.periodicRequestFut = self.periodicRequests()
+ info "waku rendezvous client started"
+
+proc stopWait*(self: WakuRendezVousClient) {.async: (raises: []).} =
+ if not self.periodicRequestFut.isNil():
+ await self.periodicRequestFut.cancelAndWait()
+
+ info "waku rendezvous client stopped"
diff --git a/waku/waku_rendezvous/common.nim b/waku/waku_rendezvous/common.nim
index 6125ac860..18c633efb 100644
--- a/waku/waku_rendezvous/common.nim
+++ b/waku/waku_rendezvous/common.nim
@@ -11,6 +11,14 @@ const DefaultRequestsInterval* = 1.minutes
const MaxRegistrationInterval* = 5.minutes
const PeersRequestedCount* = 12
+proc computeMixNamespace*(clusterId: uint16): string =
+ var namespace = "rs/"
+
+ namespace &= $clusterId
+ namespace &= "/mix"
+
+ return namespace
+
proc computeNamespace*(clusterId: uint16, shard: uint16): string =
var namespace = "rs/"
diff --git a/waku/waku_rendezvous/protocol.nim b/waku/waku_rendezvous/protocol.nim
index 0eb55d350..ed414fa42 100644
--- a/waku/waku_rendezvous/protocol.nim
+++ b/waku/waku_rendezvous/protocol.nim
@@ -1,70 +1,91 @@
{.push raises: [].}
import
- std/[sugar, options],
+ std/[sugar, options, sequtils, tables],
results,
chronos,
chronicles,
- metrics,
+ stew/byteutils,
libp2p/protocols/rendezvous,
+ libp2p/protocols/rendezvous/protobuf,
+ libp2p/discovery/discoverymngr,
+ libp2p/utils/semaphore,
+ libp2p/utils/offsettedseq,
+ libp2p/crypto/curve25519,
libp2p/switch,
libp2p/utility
+import metrics except collect
+
import
../node/peer_manager,
../common/callbacks,
../waku_enr/capabilities,
../waku_core/peers,
- ../waku_core/topics,
- ../waku_core/topics/pubsub_topic,
- ./common
+ ../waku_core/codecs,
+ ./common,
+ ./waku_peer_record
logScope:
topics = "waku rendezvous"
-declarePublicCounter rendezvousPeerFoundTotal,
- "total number of peers found via rendezvous"
-
-type WakuRendezVous* = ref object
- rendezvous: Rendezvous
+type WakuRendezVous* = ref object of GenericRendezVous[WakuPeerRecord]
peerManager: PeerManager
clusterId: uint16
getShards: GetShards
getCapabilities: GetCapabilities
+ getPeerRecord: GetWakuPeerRecord
registrationInterval: timer.Duration
periodicRegistrationFut: Future[void]
- requestInterval: timer.Duration
- periodicRequestFut: Future[void]
+const MaximumNamespaceLen = 255
-proc batchAdvertise*(
+method discover*(
+ self: WakuRendezVous, conn: Connection, d: Discover
+) {.async: (raises: [CancelledError, LPStreamError]).} =
+ # Override discover method to avoid collect macro generic instantiation issues
+ trace "Received Discover", peerId = conn.peerId, ns = d.ns
+ await procCall GenericRendezVous[WakuPeerRecord](self).discover(conn, d)
+
+proc advertise*(
self: WakuRendezVous,
namespace: string,
- ttl: Duration = DefaultRegistrationTTL,
peers: seq[PeerId],
+ ttl: timer.Duration = self.minDuration,
): Future[Result[void, string]] {.async: (raises: []).} =
- ## Register with all rendezvous peers under a namespace
+ trace "advertising via waku rendezvous",
+ namespace = namespace, ttl = ttl, peers = $peers, peerRecord = $self.getPeerRecord()
+ let se = SignedPayload[WakuPeerRecord].init(
+ self.switch.peerInfo.privateKey, self.getPeerRecord()
+ ).valueOr:
+ return
+ err("rendezvous advertisement failed: Failed to sign Waku Peer Record: " & $error)
+ let sprBuff = se.encode().valueOr:
+ return err("rendezvous advertisement failed: Wrong Signed Peer Record: " & $error)
# rendezvous.advertise expects already opened connections
# must dial first
+
var futs = collect(newSeq):
for peerId in peers:
- self.peerManager.dialPeer(peerId, RendezVousCodec)
+ self.peerManager.dialPeer(peerId, self.codec)
let dialCatch = catch:
await allFinished(futs)
- futs = dialCatch.valueOr:
- return err("batchAdvertise: " & error.msg)
+ if dialCatch.isErr():
+ return err("advertise: " & dialCatch.error.msg)
+
+ futs = dialCatch.get()
let conns = collect(newSeq):
for fut in futs:
let catchable = catch:
fut.read()
- catchable.isOkOr:
- warn "a rendezvous dial failed", cause = error.msg
+ if catchable.isErr():
+ warn "a rendezvous dial failed", cause = catchable.error.msg
continue
let connOpt = catchable.get()
@@ -74,149 +95,34 @@ proc batchAdvertise*(
conn
- let advertCatch = catch:
- await self.rendezvous.advertise(namespace, Opt.some(ttl))
-
- for conn in conns:
- await conn.close()
-
- advertCatch.isOkOr:
- return err("batchAdvertise: " & error.msg)
+ if conns.len == 0:
+ return err("could not establish any connections to rendezvous peers")
+ try:
+ await self.advertise(namespace, ttl, peers, sprBuff)
+ except Exception as e:
+ return err("rendezvous advertisement failed: " & e.msg)
+ finally:
+ for conn in conns:
+ await conn.close()
return ok()
-proc batchRequest*(
- self: WakuRendezVous,
- namespace: string,
- count: int = DiscoverLimit,
- peers: seq[PeerId],
-): Future[Result[seq[PeerRecord], string]] {.async: (raises: []).} =
- ## Request all records from all rendezvous peers matching a namespace
-
- # rendezvous.request expects already opened connections
- # must dial first
- var futs = collect(newSeq):
- for peerId in peers:
- self.peerManager.dialPeer(peerId, RendezVousCodec)
-
- let dialCatch = catch:
- await allFinished(futs)
-
- futs = dialCatch.valueOr:
- return err("batchRequest: " & error.msg)
-
- let conns = collect(newSeq):
- for fut in futs:
- let catchable = catch:
- fut.read()
-
- catchable.isOkOr:
- warn "a rendezvous dial failed", cause = error.msg
- continue
-
- let connOpt = catchable.get()
-
- let conn = connOpt.valueOr:
- continue
-
- conn
-
- let reqCatch = catch:
- await self.rendezvous.request(Opt.some(namespace), Opt.some(count), Opt.some(peers))
-
- for conn in conns:
- await conn.close()
-
- reqCatch.isOkOr:
- return err("batchRequest: " & error.msg)
-
- return ok(reqCatch.get())
-
-proc advertiseAll(
+proc advertiseAll*(
self: WakuRendezVous
): Future[Result[void, string]] {.async: (raises: []).} =
- info "waku rendezvous advertisements started"
+ trace "waku rendezvous advertisements started"
- let shards = self.getShards()
-
- let futs = collect(newSeq):
- for shardId in shards:
- # Get a random RDV peer for that shard
-
- let pubsub =
- toPubsubTopic(RelayShard(clusterId: self.clusterId, shardId: shardId))
-
- let rpi = self.peerManager.selectPeer(RendezVousCodec, some(pubsub)).valueOr:
- continue
-
- let namespace = computeNamespace(self.clusterId, shardId)
-
- # Advertise yourself on that peer
- self.batchAdvertise(namespace, DefaultRegistrationTTL, @[rpi.peerId])
-
- if futs.len < 1:
+ let rpi = self.peerManager.selectPeer(self.codec).valueOr:
return err("could not get a peer supporting RendezVousCodec")
- let catchable = catch:
- await allFinished(futs)
+ let namespace = computeMixNamespace(self.clusterId)
- catchable.isOkOr:
- return err(error.msg)
+ # Advertise yourself on that peer
+ let res = await self.advertise(namespace, @[rpi.peerId])
- for fut in catchable.get():
- if fut.failed():
- warn "a rendezvous advertisement failed", cause = fut.error.msg
+ trace "waku rendezvous advertisements finished"
- info "waku rendezvous advertisements finished"
-
- return ok()
-
-proc initialRequestAll*(
- self: WakuRendezVous
-): Future[Result[void, string]] {.async: (raises: []).} =
- info "waku rendezvous initial requests started"
-
- let shards = self.getShards()
-
- let futs = collect(newSeq):
- for shardId in shards:
- let namespace = computeNamespace(self.clusterId, shardId)
- # Get a random RDV peer for that shard
- let rpi = self.peerManager.selectPeer(
- RendezVousCodec,
- some(toPubsubTopic(RelayShard(clusterId: self.clusterId, shardId: shardId))),
- ).valueOr:
- continue
-
- # Ask for peer records for that shard
- self.batchRequest(namespace, PeersRequestedCount, @[rpi.peerId])
-
- if futs.len < 1:
- return err("could not get a peer supporting RendezVousCodec")
-
- let catchable = catch:
- await allFinished(futs)
-
- catchable.isOkOr:
- return err(error.msg)
-
- for fut in catchable.get():
- if fut.failed():
- warn "a rendezvous request failed", cause = fut.error.msg
- elif fut.finished():
- let res = fut.value()
-
- let records = res.valueOr:
- warn "a rendezvous request failed", cause = $error
- continue
-
- for record in records:
- rendezvousPeerFoundTotal.inc()
- self.peerManager.addPeer(record)
-
- info "waku rendezvous initial request finished"
-
- return ok()
+ return res
proc periodicRegistration(self: WakuRendezVous) {.async.} =
info "waku rendezvous periodic registration started",
@@ -237,22 +143,6 @@ proc periodicRegistration(self: WakuRendezVous) {.async.} =
# Back to normal interval if no errors
self.registrationInterval = DefaultRegistrationInterval
-proc periodicRequests(self: WakuRendezVous) {.async.} =
- info "waku rendezvous periodic requests started", interval = self.requestInterval
-
- # infinite loop
- while true:
- (await self.initialRequestAll()).isOkOr:
- error "waku rendezvous requests failed", error = error
-
- await sleepAsync(self.requestInterval)
-
- # Exponential backoff
- self.requestInterval += self.requestInterval
-
- if self.requestInterval >= 1.days:
- break
-
proc new*(
T: type WakuRendezVous,
switch: Switch,
@@ -260,46 +150,88 @@ proc new*(
clusterId: uint16,
getShards: GetShards,
getCapabilities: GetCapabilities,
+ getPeerRecord: GetWakuPeerRecord,
): Result[T, string] {.raises: [].} =
- let rvCatchable = catch:
- RendezVous.new(switch = switch, minDuration = DefaultRegistrationTTL)
+ let rng = newRng()
+ let wrv = T(
+ rng: rng,
+ salt: string.fromBytes(generateBytes(rng[], 8)),
+ registered: initOffsettedSeq[RegisteredData](),
+ expiredDT: Moment.now() - 1.days,
+ sema: newAsyncSemaphore(SemaphoreDefaultSize),
+ minDuration: rendezvous.MinimumAcceptedDuration,
+ maxDuration: rendezvous.MaximumDuration,
+ minTTL: rendezvous.MinimumAcceptedDuration.seconds.uint64,
+ maxTTL: rendezvous.MaximumDuration.seconds.uint64,
+ peerRecordValidator: checkWakuPeerRecord,
+ )
- let rv = rvCatchable.valueOr:
- return err(error.msg)
-
- let mountCatchable = catch:
- switch.mount(rv)
-
- mountCatchable.isOkOr:
- return err(error.msg)
-
- var wrv = WakuRendezVous()
- wrv.rendezvous = rv
wrv.peerManager = peerManager
wrv.clusterId = clusterId
wrv.getShards = getShards
wrv.getCapabilities = getCapabilities
wrv.registrationInterval = DefaultRegistrationInterval
- wrv.requestInterval = DefaultRequestsInterval
+ wrv.getPeerRecord = getPeerRecord
+ wrv.switch = switch
+ wrv.codec = WakuRendezVousCodec
+
+ proc handleStream(
+ conn: Connection, proto: string
+ ) {.async: (raises: [CancelledError]).} =
+ try:
+ let
+ buf = await conn.readLp(4096)
+ msg = Message.decode(buf).tryGet()
+ case msg.msgType
+ of MessageType.Register:
+ #TODO: override this to store peers registered with us in peerstore with their info as well.
+ await wrv.register(conn, msg.register.tryGet(), wrv.getPeerRecord())
+ of MessageType.RegisterResponse:
+ trace "Got an unexpected Register Response", response = msg.registerResponse
+ of MessageType.Unregister:
+ wrv.unregister(conn, msg.unregister.tryGet())
+ of MessageType.Discover:
+ await wrv.discover(conn, msg.discover.tryGet())
+ of MessageType.DiscoverResponse:
+ trace "Got an unexpected Discover Response", response = msg.discoverResponse
+ except CancelledError as exc:
+ trace "cancelled rendezvous handler"
+ raise exc
+ except CatchableError as exc:
+ trace "exception in rendezvous handler", description = exc.msg
+ finally:
+ await conn.close()
+
+ wrv.handler = handleStream
info "waku rendezvous initialized",
- clusterId = clusterId, shards = getShards(), capabilities = getCapabilities()
+ clusterId = clusterId,
+ shards = getShards(),
+ capabilities = getCapabilities(),
+ wakuPeerRecord = getPeerRecord()
return ok(wrv)
proc start*(self: WakuRendezVous) {.async: (raises: []).} =
+ # Start the parent GenericRendezVous (starts the register deletion loop)
+ if self.started:
+ warn "waku rendezvous already started"
+ return
+ try:
+ await procCall GenericRendezVous[WakuPeerRecord](self).start()
+ except CancelledError as exc:
+ error "failed to start GenericRendezVous", cause = exc.msg
+ return
# start registering forever
self.periodicRegistrationFut = self.periodicRegistration()
- self.periodicRequestFut = self.periodicRequests()
-
info "waku rendezvous discovery started"
proc stopWait*(self: WakuRendezVous) {.async: (raises: []).} =
if not self.periodicRegistrationFut.isNil():
await self.periodicRegistrationFut.cancelAndWait()
- if not self.periodicRequestFut.isNil():
- await self.periodicRequestFut.cancelAndWait()
+ # Stop the parent GenericRendezVous (stops the register deletion loop)
+ await GenericRendezVous[WakuPeerRecord](self).stop()
info "waku rendezvous discovery stopped"
diff --git a/waku/waku_rendezvous/waku_peer_record.nim b/waku/waku_rendezvous/waku_peer_record.nim
new file mode 100644
index 000000000..d6e700eb5
--- /dev/null
+++ b/waku/waku_rendezvous/waku_peer_record.nim
@@ -0,0 +1,74 @@
+import std/times, sugar
+
+import
+ libp2p/[
+ protocols/rendezvous,
+ signed_envelope,
+ multicodec,
+ multiaddress,
+ protobuf/minprotobuf,
+ peerid,
+ ]
+
+type WakuPeerRecord* = object
+ # Considering only mix as of now, but we can keep extending this to include all capabilities part of Waku ENR
+ peerId*: PeerId
+ seqNo*: uint64
+ addresses*: seq[MultiAddress]
+ mixKey*: string
+
+proc payloadDomain*(T: typedesc[WakuPeerRecord]): string =
+ $multiCodec("libp2p-custom-peer-record")
+
+proc payloadType*(T: typedesc[WakuPeerRecord]): seq[byte] =
+ @[(byte) 0x30, (byte) 0x00, (byte) 0x00]
+
+proc init*(
+ T: typedesc[WakuPeerRecord],
+ peerId: PeerId,
+ seqNo = getTime().toUnix().uint64,
+ addresses: seq[MultiAddress],
+ mixKey: string,
+): T =
+ WakuPeerRecord(peerId: peerId, seqNo: seqNo, addresses: addresses, mixKey: mixKey)
+
+proc decode*(
+ T: typedesc[WakuPeerRecord], buffer: seq[byte]
+): Result[WakuPeerRecord, ProtoError] =
+ let pb = initProtoBuffer(buffer)
+ var record = WakuPeerRecord()
+
+ ?pb.getRequiredField(1, record.peerId)
+ ?pb.getRequiredField(2, record.seqNo)
+ discard ?pb.getRepeatedField(3, record.addresses)
+
+ if record.addresses.len == 0:
+ return err(ProtoError.RequiredFieldMissing)
+
+ ?pb.getRequiredField(4, record.mixKey)
+
+ return ok(record)
+
+proc encode*(record: WakuPeerRecord): seq[byte] =
+ var pb = initProtoBuffer()
+
+ pb.write(1, record.peerId)
+ pb.write(2, record.seqNo)
+
+ for address in record.addresses:
+ pb.write(3, address)
+
+ pb.write(4, record.mixKey)
+
+ pb.finish()
+ return pb.buffer
+
+proc checkWakuPeerRecord*(
+ _: WakuPeerRecord, spr: seq[byte], peerId: PeerId
+): Result[void, string] {.gcsafe.} =
+ if spr.len == 0:
+ return err("Empty peer record")
+ let signedEnv = ?SignedPayload[WakuPeerRecord].decode(spr).mapErr(x => $x)
+ if signedEnv.data.peerId != peerId:
+ return err("Bad Peer ID")
+ return ok()
From 088e3108c86085c2d3c072c29964ae96f285c6d2 Mon Sep 17 00:00:00 2001
From: Prem Chaitanya Prathi
Date: Sat, 22 Nov 2025 08:11:05 +0530
Subject: [PATCH 06/70] use exit==dest approach for mix (#3642)
---
Makefile | 3 +++
apps/chat2mix/chat2mix.nim | 7 +++++--
examples/lightpush_mix/lightpush_publisher_mix.nim | 5 ++++-
simulations/mixnet/config.toml | 4 ++--
.../mixnet/{run_lp_service_node.sh => run_mix_node.sh} | 0
waku/node/kernel_api/lightpush.nim | 2 +-
waku/waku_mix/protocol.nim | 10 +++++-----
waku/waku_rendezvous/protocol.nim | 3 +++
8 files changed, 23 insertions(+), 11 deletions(-)
rename simulations/mixnet/{run_lp_service_node.sh => run_mix_node.sh} (100%)
diff --git a/Makefile b/Makefile
index 029313c99..f65daff71 100644
--- a/Makefile
+++ b/Makefile
@@ -143,6 +143,9 @@ ifeq ($(USE_LIBBACKTRACE), 0)
NIM_PARAMS := $(NIM_PARAMS) -d:disable_libbacktrace
endif
+# enable experimental exit is dest feature in libp2p mix
+NIM_PARAMS := $(NIM_PARAMS) -d:libp2p_mix_experimental_exit_is_dest
+
libbacktrace:
+ $(MAKE) -C vendor/nim-libbacktrace --no-print-directory BUILD_CXX_LIB=0
diff --git a/apps/chat2mix/chat2mix.nim b/apps/chat2mix/chat2mix.nim
index 3fdd7bc9c..45fd1fa2d 100644
--- a/apps/chat2mix/chat2mix.nim
+++ b/apps/chat2mix/chat2mix.nim
@@ -82,6 +82,8 @@ type
PrivateKey* = crypto.PrivateKey
Topic* = waku_core.PubsubTopic
+const MinMixNodePoolSize = 4
+
#####################
## chat2 protobufs ##
#####################
@@ -592,6 +594,7 @@ proc processInput(rfd: AsyncFD, rng: ref HmacDrbgContext) {.async.} =
node.peerManager.addServicePeer(servicePeerInfo, WakuLightpushCodec)
node.peerManager.addServicePeer(servicePeerInfo, WakuPeerExchangeCodec)
+ #node.peerManager.addServicePeer(servicePeerInfo, WakuRendezVousCodec)
# Start maintaining subscription
asyncSpawn maintainSubscription(
@@ -599,12 +602,12 @@ proc processInput(rfd: AsyncFD, rng: ref HmacDrbgContext) {.async.} =
)
echo "waiting for mix nodes to be discovered..."
while true:
- if node.getMixNodePoolSize() >= 3:
+ if node.getMixNodePoolSize() >= MinMixNodePoolSize:
break
discard await node.fetchPeerExchangePeers()
await sleepAsync(1000)
- while node.getMixNodePoolSize() < 3:
+ while node.getMixNodePoolSize() < MinMixNodePoolSize:
info "waiting for mix nodes to be discovered",
currentpoolSize = node.getMixNodePoolSize()
await sleepAsync(1000)
diff --git a/examples/lightpush_mix/lightpush_publisher_mix.nim b/examples/lightpush_mix/lightpush_publisher_mix.nim
index bb4bb4c4e..4219cd665 100644
--- a/examples/lightpush_mix/lightpush_publisher_mix.nim
+++ b/examples/lightpush_mix/lightpush_publisher_mix.nim
@@ -144,7 +144,7 @@ proc setupAndPublish(rng: ref HmacDrbgContext, conf: LightPushMixConf) {.async.}
conn = connOpt.get()
else:
conn = node.wakuMix.toConnection(
- MixDestination.init(dPeerId, pxPeerInfo.addrs[0]), # destination lightpush peer
+ MixDestination.exitNode(dPeerId), # destination lightpush peer
WakuLightPushCodec, # protocol codec which will be used over the mix connection
MixParameters(expectReply: Opt.some(true), numSurbs: Opt.some(byte(1))),
# mix parameters indicating we expect a single reply
@@ -163,6 +163,9 @@ proc setupAndPublish(rng: ref HmacDrbgContext, conf: LightPushMixConf) {.async.}
ephemeral: true, # tell store nodes to not store it
timestamp: getNowInNanosecondTime(),
) # current timestamp
+ let res = await node.wakuLightpushClient.publishWithConn(
+ LightpushPubsubTopic, message, conn, dPeerId
+ )
let startTime = getNowInNanosecondTime()
diff --git a/simulations/mixnet/config.toml b/simulations/mixnet/config.toml
index 17e9242d3..3719d8177 100644
--- a/simulations/mixnet/config.toml
+++ b/simulations/mixnet/config.toml
@@ -1,6 +1,6 @@
log-level = "INFO"
relay = true
-#mix = true
+mix = true
filter = true
store = false
lightpush = true
@@ -18,7 +18,7 @@ num-shards-in-network = 1
shard = [0]
agent-string = "nwaku-mix"
nodekey = "f98e3fba96c32e8d1967d460f1b79457380e1a895f7971cecc8528abe733781a"
-#mixkey = "a87db88246ec0eedda347b9b643864bee3d6933eb15ba41e6d58cb678d813258"
+mixkey = "a87db88246ec0eedda347b9b643864bee3d6933eb15ba41e6d58cb678d813258"
rendezvous = true
listen-address = "127.0.0.1"
nat = "extip:127.0.0.1"
diff --git a/simulations/mixnet/run_lp_service_node.sh b/simulations/mixnet/run_mix_node.sh
similarity index 100%
rename from simulations/mixnet/run_lp_service_node.sh
rename to simulations/mixnet/run_mix_node.sh
diff --git a/waku/node/kernel_api/lightpush.nim b/waku/node/kernel_api/lightpush.nim
index f42cb146e..8df6291b1 100644
--- a/waku/node/kernel_api/lightpush.nim
+++ b/waku/node/kernel_api/lightpush.nim
@@ -199,7 +199,7 @@ proc lightpushPublishHandler(
if mixify: #indicates we want to use mix to send the message
#TODO: How to handle multiple addresses?
let conn = node.wakuMix.toConnection(
- MixDestination.init(peer.peerId, peer.addrs[0]),
+ MixDestination.exitNode(peer.peerId),
WakuLightPushCodec,
MixParameters(expectReply: Opt.some(true), numSurbs: Opt.some(byte(1))),
# indicating we only want a single path to be used for reply hence numSurbs = 1
diff --git a/waku/waku_mix/protocol.nim b/waku/waku_mix/protocol.nim
index d3d765df8..366d5da91 100644
--- a/waku/waku_mix/protocol.nim
+++ b/waku/waku_mix/protocol.nim
@@ -21,7 +21,7 @@ import
logScope:
topics = "waku mix"
-const mixMixPoolSize = 3
+const minMixPoolSize = 4
type
WakuMix* = ref object of MixProtocol
@@ -181,12 +181,12 @@ proc new*(
peermgr.switch.peerInfo.peerId, nodeMultiAddr, mixPubKey, mixPrivKey,
peermgr.switch.peerInfo.publicKey.skkey, peermgr.switch.peerInfo.privateKey.skkey,
)
- if bootnodes.len < mixMixPoolSize:
- warn "publishing with mix won't work until there are 3 mix nodes in node pool"
+ if bootnodes.len < minMixPoolSize:
+ warn "publishing with mix won't work until atleast 3 mix nodes in node pool"
let initTable = processBootNodes(bootnodes, peermgr)
- if len(initTable) < mixMixPoolSize:
- warn "publishing with mix won't work until there are 3 mix nodes in node pool"
+ if len(initTable) < minMixPoolSize:
+ warn "publishing with mix won't work until atleast 3 mix nodes in node pool"
var m = WakuMix(peerManager: peermgr, clusterId: clusterId, pubKey: mixPubKey)
procCall MixProtocol(m).init(localMixNodeInfo, initTable, peermgr.switch)
return ok(m)
diff --git a/waku/waku_rendezvous/protocol.nim b/waku/waku_rendezvous/protocol.nim
index ed414fa42..7b97375ff 100644
--- a/waku/waku_rendezvous/protocol.nim
+++ b/waku/waku_rendezvous/protocol.nim
@@ -234,4 +234,7 @@ proc stopWait*(self: WakuRendezVous) {.async: (raises: []).} =
# Stop the parent GenericRendezVous (stops the register deletion loop)
await GenericRendezVous[WakuPeerRecord](self).stop()
+ # Stop the parent GenericRendezVous (stops the register deletion loop)
+ await GenericRendezVous[WakuPeerRecord](self).stop()
+
info "waku rendezvous discovery stopped"
From 454b098ac52df75e5d5de5010f9edb42cf8b0d52 Mon Sep 17 00:00:00 2001
From: Ivan FB <128452529+Ivansete-status@users.noreply.github.com>
Date: Mon, 24 Nov 2025 10:16:37 +0100
Subject: [PATCH 07/70] new metric in postgres_driver to estimate payload stats
(#3596)
---
.../driver/postgres_driver/postgres_driver.nim | 10 +++++++++-
1 file changed, 9 insertions(+), 1 deletion(-)
diff --git a/waku/waku_archive/driver/postgres_driver/postgres_driver.nim b/waku/waku_archive/driver/postgres_driver/postgres_driver.nim
index 842d7cbc2..9b0e14c84 100644
--- a/waku/waku_archive/driver/postgres_driver/postgres_driver.nim
+++ b/waku/waku_archive/driver/postgres_driver/postgres_driver.nim
@@ -5,6 +5,7 @@ import
stew/[byteutils, arrayops],
results,
chronos,
+ metrics,
db_connector/[postgres, db_common],
chronicles
import
@@ -16,6 +17,9 @@ import
./postgres_healthcheck,
./partitions_manager
+declarePublicGauge postgres_payload_size_bytes,
+ "Payload size in bytes of correctly stored messages"
+
type PostgresDriver* = ref object of ArchiveDriver
## Establish a separate pools for read/write operations
writeConnPool: PgAsyncPool
@@ -333,7 +337,7 @@ method put*(
return err("could not put msg in messages table: " & $error)
## Now add the row to messages_lookup
- return await s.writeConnPool.runStmt(
+ let ret = await s.writeConnPool.runStmt(
InsertRowInMessagesLookupStmtName,
InsertRowInMessagesLookupStmtDefinition,
@[messageHash, timestamp],
@@ -341,6 +345,10 @@ method put*(
@[int32(0), int32(0)],
)
+ if ret.isOk():
+ postgres_payload_size_bytes.set(message.payload.len)
+ return ret
+
method getAllMessages*(
s: PostgresDriver
): Future[ArchiveDriverResult[seq[ArchiveRow]]] {.async.} =
From c0a7debfd157a158c7973fc1135150df804f97e5 Mon Sep 17 00:00:00 2001
From: Ivan FB <128452529+Ivansete-status@users.noreply.github.com>
Date: Tue, 25 Nov 2025 10:05:40 +0100
Subject: [PATCH 08/70] Adapt makefile for libwaku windows (#3648)
---
Makefile | 6 +++-
scripts/libwaku_windows_setup.mk | 53 ++++++++++++++++++++++++++++++++
2 files changed, 58 insertions(+), 1 deletion(-)
create mode 100644 scripts/libwaku_windows_setup.mk
diff --git a/Makefile b/Makefile
index f65daff71..2f15ccd71 100644
--- a/Makefile
+++ b/Makefile
@@ -43,6 +43,9 @@ ifeq ($(detected_OS),Windows)
LIBS = -lws2_32 -lbcrypt -liphlpapi -luserenv -lntdll -lminiupnpc -lnatpmp -lpq
NIM_PARAMS += $(foreach lib,$(LIBS),--passL:"$(lib)")
+
+ export PATH := /c/msys64/usr/bin:/c/msys64/mingw64/bin:/c/msys64/usr/lib:/c/msys64/mingw64/lib:$(PATH)
+
endif
##########
@@ -424,13 +427,13 @@ docker-liteprotocoltester-push:
STATIC ?= 0
-
libwaku: | build deps librln
rm -f build/libwaku*
ifeq ($(STATIC), 1)
echo -e $(BUILD_MSG) "build/$@.a" && $(ENV_SCRIPT) nim libwakuStatic $(NIM_PARAMS) waku.nims
else ifeq ($(detected_OS),Windows)
+ make -f scripts/libwaku_windows_setup.mk windows-setup
echo -e $(BUILD_MSG) "build/$@.dll" && $(ENV_SCRIPT) nim libwakuDynamic $(NIM_PARAMS) waku.nims
else
echo -e $(BUILD_MSG) "build/$@.so" && $(ENV_SCRIPT) nim libwakuDynamic $(NIM_PARAMS) waku.nims
@@ -546,3 +549,4 @@ release-notes:
sed -E 's@#([0-9]+)@[#\1](https://github.com/waku-org/nwaku/issues/\1)@g'
# I could not get the tool to replace issue ids with links, so using sed for now,
# asked here: https://github.com/bvieira/sv4git/discussions/101
+
diff --git a/scripts/libwaku_windows_setup.mk b/scripts/libwaku_windows_setup.mk
new file mode 100644
index 000000000..503d0c405
--- /dev/null
+++ b/scripts/libwaku_windows_setup.mk
@@ -0,0 +1,53 @@
+# ---------------------------------------------------------
+# Windows Setup Makefile
+# ---------------------------------------------------------
+
+# Extend PATH (Make preserves environment variables)
+export PATH := /c/msys64/usr/bin:/c/msys64/mingw64/bin:/c/msys64/usr/lib:/c/msys64/mingw64/lib:$(PATH)
+
+# Tools required
+DEPS = gcc g++ make cmake cargo upx rustc python
+
+# Default target
+.PHONY: windows-setup
+windows-setup: check-deps update-submodules create-tmp libunwind miniupnpc libnatpmp
+ @echo "Windows setup completed successfully!"
+
+.PHONY: check-deps
+check-deps:
+ @echo "Checking libwaku build dependencies..."
+ @for dep in $(DEPS); do \
+ if ! which $$dep >/dev/null 2>&1; then \
+ echo "✗ Missing dependency: $$dep"; \
+ exit 1; \
+ else \
+ echo "✓ Found: $$dep"; \
+ fi; \
+ done
+
+.PHONY: update-submodules
+update-submodules:
+ @echo "Updating libwaku git submodules..."
+ git submodule update --init --recursive
+
+.PHONY: create-tmp
+create-tmp:
+ @echo "Creating tmp directory..."
+ mkdir -p tmp
+
+.PHONY: libunwind
+libunwind:
+ @echo "Building libunwind..."
+ cd vendor/nim-libbacktrace && make all V=1
+
+.PHONY: miniupnpc
+miniupnpc:
+ @echo "Building miniupnpc..."
+ cd vendor/nim-nat-traversal/vendor/miniupnp/miniupnpc && \
+ make -f Makefile.mingw CC=gcc CXX=g++ libminiupnpc.a V=1
+
+.PHONY: libnatpmp
+libnatpmp:
+ @echo "Building libnatpmp..."
+ cd vendor/nim-nat-traversal/vendor/libnatpmp-upstream && \
+ make CC="gcc -fPIC -D_WIN32_WINNT=0x0600 -DNATPMP_STATICLIB" libnatpmp.a V=1
From 1e73213a3604b0113a13b1ca2157db3276c78a4d Mon Sep 17 00:00:00 2001
From: Sergei Tikhomirov
Date: Fri, 28 Nov 2025 10:41:20 +0100
Subject: [PATCH 09/70] chore: Lightpush minor refactor (#3538)
* chore: refactor Lightpush (more DRY)
* chore: apply review suggestions
Co-authored-by: Ivan FB <128452529+Ivansete-status@users.noreply.github.com>
---------
Co-authored-by: Ivan FB <128452529+Ivansete-status@users.noreply.github.com>
---
.../lightpush_mix/lightpush_publisher_mix.nim | 6 +-
tests/waku_lightpush/test_ratelimit.nim | 8 +-
waku/node/kernel_api/lightpush.nim | 4 +-
waku/waku_lightpush/client.nim | 145 +++++++-----------
waku/waku_lightpush/common.nim | 15 +-
waku/waku_lightpush/protocol.nim | 12 +-
6 files changed, 76 insertions(+), 114 deletions(-)
diff --git a/examples/lightpush_mix/lightpush_publisher_mix.nim b/examples/lightpush_mix/lightpush_publisher_mix.nim
index 4219cd665..104de8552 100644
--- a/examples/lightpush_mix/lightpush_publisher_mix.nim
+++ b/examples/lightpush_mix/lightpush_publisher_mix.nim
@@ -163,9 +163,9 @@ proc setupAndPublish(rng: ref HmacDrbgContext, conf: LightPushMixConf) {.async.}
ephemeral: true, # tell store nodes to not store it
timestamp: getNowInNanosecondTime(),
) # current timestamp
- let res = await node.wakuLightpushClient.publishWithConn(
- LightpushPubsubTopic, message, conn, dPeerId
- )
+
+ let res =
+ await node.wakuLightpushClient.publish(some(LightpushPubsubTopic), message, conn)
let startTime = getNowInNanosecondTime()
diff --git a/tests/waku_lightpush/test_ratelimit.nim b/tests/waku_lightpush/test_ratelimit.nim
index b2dcdc7b5..7420a4e56 100644
--- a/tests/waku_lightpush/test_ratelimit.nim
+++ b/tests/waku_lightpush/test_ratelimit.nim
@@ -37,7 +37,7 @@ suite "Rate limited push service":
handlerFuture = newFuture[(string, WakuMessage)]()
let requestRes =
- await client.publish(some(DefaultPubsubTopic), message, peer = serverPeerId)
+ await client.publish(some(DefaultPubsubTopic), message, serverPeerId)
check await handlerFuture.withTimeout(50.millis)
@@ -66,7 +66,7 @@ suite "Rate limited push service":
var endTime = Moment.now()
var elapsed: Duration = (endTime - startTime)
await sleepAsync(tokenPeriod - elapsed + firstWaitExtend)
- firstWaitEXtend = 100.millis
+ firstWaitExtend = 100.millis
## Cleanup
await allFutures(clientSwitch.stop(), serverSwitch.stop())
@@ -99,7 +99,7 @@ suite "Rate limited push service":
let message = fakeWakuMessage()
handlerFuture = newFuture[(string, WakuMessage)]()
let requestRes =
- await client.publish(some(DefaultPubsubTopic), message, peer = serverPeerId)
+ await client.publish(some(DefaultPubsubTopic), message, serverPeerId)
discard await handlerFuture.withTimeout(10.millis)
check:
@@ -114,7 +114,7 @@ suite "Rate limited push service":
let message = fakeWakuMessage()
handlerFuture = newFuture[(string, WakuMessage)]()
let requestRes =
- await client.publish(some(DefaultPubsubTopic), message, peer = serverPeerId)
+ await client.publish(some(DefaultPubsubTopic), message, serverPeerId)
discard await handlerFuture.withTimeout(10.millis)
check:
diff --git a/waku/node/kernel_api/lightpush.nim b/waku/node/kernel_api/lightpush.nim
index 8df6291b1..9451767ac 100644
--- a/waku/node/kernel_api/lightpush.nim
+++ b/waku/node/kernel_api/lightpush.nim
@@ -210,9 +210,7 @@ proc lightpushPublishHandler(
"Waku lightpush with mix not available",
)
- return await node.wakuLightpushClient.publishWithConn(
- pubsubTopic, message, conn, peer.peerId
- )
+ return await node.wakuLightpushClient.publish(some(pubsubTopic), message, conn)
else:
return await node.wakuLightpushClient.publish(some(pubsubTopic), message, peer)
diff --git a/waku/waku_lightpush/client.nim b/waku/waku_lightpush/client.nim
index d68552304..b528b4c76 100644
--- a/waku/waku_lightpush/client.nim
+++ b/waku/waku_lightpush/client.nim
@@ -17,8 +17,8 @@ logScope:
topics = "waku lightpush client"
type WakuLightPushClient* = ref object
- peerManager*: PeerManager
rng*: ref rand.HmacDrbgContext
+ peerManager*: PeerManager
publishObservers: seq[PublishObserver]
proc new*(
@@ -29,33 +29,31 @@ proc new*(
proc addPublishObserver*(wl: WakuLightPushClient, obs: PublishObserver) =
wl.publishObservers.add(obs)
-proc sendPushRequest(
- wl: WakuLightPushClient,
- req: LightPushRequest,
- peer: PeerId | RemotePeerInfo,
- conn: Option[Connection] = none(Connection),
-): Future[WakuLightPushResult] {.async.} =
- let connection = conn.valueOr:
- (await wl.peerManager.dialPeer(peer, WakuLightPushCodec)).valueOr:
- waku_lightpush_v3_errors.inc(labelValues = [dialFailure])
- return lighpushErrorResult(
- LightPushErrorCode.NO_PEERS_TO_RELAY,
- dialFailure & ": " & $peer & " is not accessible",
- )
+proc ensureTimestampSet(message: var WakuMessage) =
+ if message.timestamp == 0:
+ message.timestamp = getNowInNanosecondTime()
- defer:
- await connection.closeWithEOF()
+## Short log string for peer identifiers (overloads for convenience)
+func shortPeerId(peer: PeerId): string =
+ shortLog(peer)
+
+func shortPeerId(peer: RemotePeerInfo): string =
+ shortLog(peer.peerId)
+
+proc sendPushRequestToConn(
+ wl: WakuLightPushClient, request: LightPushRequest, conn: Connection
+): Future[WakuLightPushResult] {.async.} =
try:
- await connection.writeLP(req.encode().buffer)
- except CatchableError:
- error "failed to send push request", error = getCurrentExceptionMsg()
+ await conn.writeLp(request.encode().buffer)
+ except LPStreamRemoteClosedError:
+ error "Failed to write request to peer", error = getCurrentExceptionMsg()
return lightpushResultInternalError(
- "failed to send push request: " & getCurrentExceptionMsg()
+ "Failed to write request to peer: " & getCurrentExceptionMsg()
)
var buffer: seq[byte]
try:
- buffer = await connection.readLp(DefaultMaxRpcSize.int)
+ buffer = await conn.readLp(DefaultMaxRpcSize.int)
except LPStreamRemoteClosedError:
error "Failed to read response from peer", error = getCurrentExceptionMsg()
return lightpushResultInternalError(
@@ -66,10 +64,12 @@ proc sendPushRequest(
waku_lightpush_v3_errors.inc(labelValues = [decodeRpcFailure])
return lightpushResultInternalError(decodeRpcFailure)
- if response.requestId != req.requestId and
- response.statusCode != LightPushErrorCode.TOO_MANY_REQUESTS:
+ let requestIdMismatch = response.requestId != request.requestId
+ let tooManyRequests = response.statusCode == LightPushErrorCode.TOO_MANY_REQUESTS
+ if requestIdMismatch and (not tooManyRequests):
+ # response with TOO_MANY_REQUESTS error code has no requestId by design
error "response failure, requestId mismatch",
- requestId = req.requestId, responseRequestId = response.requestId
+ requestId = request.requestId, responseRequestId = response.requestId
return lightpushResultInternalError("response failure, requestId mismatch")
return toPushResult(response)
@@ -78,88 +78,49 @@ proc publish*(
wl: WakuLightPushClient,
pubSubTopic: Option[PubsubTopic] = none(PubsubTopic),
wakuMessage: WakuMessage,
- peer: PeerId | RemotePeerInfo,
+ dest: Connection | PeerId | RemotePeerInfo,
): Future[WakuLightPushResult] {.async, gcsafe.} =
+ let conn =
+ when dest is Connection:
+ dest
+ else:
+ (await wl.peerManager.dialPeer(dest, WakuLightPushCodec)).valueOr:
+ waku_lightpush_v3_errors.inc(labelValues = [dialFailure])
+ return lighpushErrorResult(
+ LightPushErrorCode.NO_PEERS_TO_RELAY,
+ "Peer is not accessible: " & dialFailure & " - " & $dest,
+ )
+
+ defer:
+ await conn.closeWithEOF()
+
var message = wakuMessage
- if message.timestamp == 0:
- message.timestamp = getNowInNanosecondTime()
+ ensureTimestampSet(message)
- when peer is PeerId:
- info "publish",
- peerId = shortLog(peer),
- msg_hash = computeMessageHash(pubsubTopic.get(""), message).to0xHex
- else:
- info "publish",
- peerId = shortLog(peer.peerId),
- msg_hash = computeMessageHash(pubsubTopic.get(""), message).to0xHex
+ let msgHash = computeMessageHash(pubSubTopic.get(""), message).to0xHex()
+ info "publish",
+ myPeerId = wl.peerManager.switch.peerInfo.peerId,
+ peerId = shortPeerId(conn.peerId),
+ msgHash = msgHash,
+ sentTime = getNowInNanosecondTime()
- let pushRequest = LightpushRequest(
- requestId: generateRequestId(wl.rng), pubSubTopic: pubSubTopic, message: message
+ let request = LightpushRequest(
+ requestId: generateRequestId(wl.rng), pubsubTopic: pubSubTopic, message: message
)
- let publishedCount = ?await wl.sendPushRequest(pushRequest, peer)
+ let relayPeerCount = ?await wl.sendPushRequestToConn(request, conn)
for obs in wl.publishObservers:
obs.onMessagePublished(pubSubTopic.get(""), message)
- return lightpushSuccessResult(publishedCount)
+ return lightpushSuccessResult(relayPeerCount)
proc publishToAny*(
- wl: WakuLightPushClient, pubSubTopic: PubsubTopic, wakuMessage: WakuMessage
+ wl: WakuLightPushClient, pubsubTopic: PubsubTopic, wakuMessage: WakuMessage
): Future[WakuLightPushResult] {.async, gcsafe.} =
- ## This proc is similar to the publish one but in this case
- ## we don't specify a particular peer and instead we get it from peer manager
-
- var message = wakuMessage
- if message.timestamp == 0:
- message.timestamp = getNowInNanosecondTime()
-
+ # Like publish, but selects a peer automatically from the peer manager
let peer = wl.peerManager.selectPeer(WakuLightPushCodec).valueOr:
# TODO: check if it is matches the situation - shall we distinguish client side missing peers from server side?
return lighpushErrorResult(
LightPushErrorCode.NO_PEERS_TO_RELAY, "no suitable remote peers"
)
-
- info "publishToAny",
- my_peer_id = wl.peerManager.switch.peerInfo.peerId,
- peer_id = peer.peerId,
- msg_hash = computeMessageHash(pubsubTopic, message).to0xHex,
- sentTime = getNowInNanosecondTime()
-
- let pushRequest = LightpushRequest(
- requestId: generateRequestId(wl.rng),
- pubSubTopic: some(pubSubTopic),
- message: message,
- )
- let publishedCount = ?await wl.sendPushRequest(pushRequest, peer)
-
- for obs in wl.publishObservers:
- obs.onMessagePublished(pubSubTopic, message)
-
- return lightpushSuccessResult(publishedCount)
-
-proc publishWithConn*(
- wl: WakuLightPushClient,
- pubSubTopic: PubsubTopic,
- message: WakuMessage,
- conn: Connection,
- destPeer: PeerId,
-): Future[WakuLightPushResult] {.async, gcsafe.} =
- info "publishWithConn",
- my_peer_id = wl.peerManager.switch.peerInfo.peerId,
- peer_id = destPeer,
- msg_hash = computeMessageHash(pubsubTopic, message).to0xHex,
- sentTime = getNowInNanosecondTime()
-
- let pushRequest = LightpushRequest(
- requestId: generateRequestId(wl.rng),
- pubSubTopic: some(pubSubTopic),
- message: message,
- )
- #TODO: figure out how to not pass destPeer as this is just a hack
- let publishedCount =
- ?await wl.sendPushRequest(pushRequest, destPeer, conn = some(conn))
-
- for obs in wl.publishObservers:
- obs.onMessagePublished(pubSubTopic, message)
-
- return lightpushSuccessResult(publishedCount)
+ return await wl.publish(some(pubsubTopic), wakuMessage, peer)
diff --git a/waku/waku_lightpush/common.nim b/waku/waku_lightpush/common.nim
index f2687834e..9c2ea7ced 100644
--- a/waku/waku_lightpush/common.nim
+++ b/waku/waku_lightpush/common.nim
@@ -35,7 +35,15 @@ func isSuccess*(response: LightPushResponse): bool =
func toPushResult*(response: LightPushResponse): WakuLightPushResult =
if isSuccess(response):
- return ok(response.relayPeerCount.get(0))
+ let relayPeerCount = response.relayPeerCount.get(0)
+ return (
+ if (relayPeerCount == 0):
+ # Consider publishing to zero peers an error even if the service node
+ # sent us a "successful" response with zero peers
+ err((LightPushErrorCode.NO_PEERS_TO_RELAY, response.statusDesc))
+ else:
+ ok(relayPeerCount)
+ )
else:
return err((response.statusCode, response.statusDesc))
@@ -51,11 +59,6 @@ func lightpushResultBadRequest*(msg: string): WakuLightPushResult =
func lightpushResultServiceUnavailable*(msg: string): WakuLightPushResult =
return err((LightPushErrorCode.SERVICE_NOT_AVAILABLE, some(msg)))
-func lighpushErrorResult*(
- statusCode: LightpushStatusCode, desc: Option[string]
-): WakuLightPushResult =
- return err((statusCode, desc))
-
func lighpushErrorResult*(
statusCode: LightpushStatusCode, desc: string
): WakuLightPushResult =
diff --git a/waku/waku_lightpush/protocol.nim b/waku/waku_lightpush/protocol.nim
index 2e8c9c2f1..95bfc003e 100644
--- a/waku/waku_lightpush/protocol.nim
+++ b/waku/waku_lightpush/protocol.nim
@@ -78,9 +78,9 @@ proc handleRequest(
proc handleRequest*(
wl: WakuLightPush, peerId: PeerId, buffer: seq[byte]
): Future[LightPushResponse] {.async.} =
- let pushRequest = LightPushRequest.decode(buffer).valueOr:
+ let request = LightPushRequest.decode(buffer).valueOr:
let desc = decodeRpcFailure & ": " & $error
- error "failed to push message", error = desc
+ error "failed to decode Lightpush request", error = desc
let errorCode = LightPushErrorCode.BAD_REQUEST
waku_lightpush_v3_errors.inc(labelValues = [$errorCode])
return LightPushResponse(
@@ -89,16 +89,16 @@ proc handleRequest*(
statusDesc: some(desc),
)
- let relayPeerCount = (await handleRequest(wl, peerId, pushRequest)).valueOr:
+ let relayPeerCount = (await wl.handleRequest(peerId, request)).valueOr:
let desc = error.desc
waku_lightpush_v3_errors.inc(labelValues = [$error.code])
error "failed to push message", error = desc
return LightPushResponse(
- requestId: pushRequest.requestId, statusCode: error.code, statusDesc: desc
+ requestId: request.requestId, statusCode: error.code, statusDesc: desc
)
return LightPushResponse(
- requestId: pushRequest.requestId,
+ requestId: request.requestId,
statusCode: LightPushSuccessCode.SUCCESS,
statusDesc: none[string](),
relayPeerCount: some(relayPeerCount),
@@ -123,7 +123,7 @@ proc initProtocolHandler(wl: WakuLightPush) =
)
try:
- rpc = await handleRequest(wl, conn.peerId, buffer)
+ rpc = await wl.handleRequest(conn.peerId, buffer)
except CatchableError:
error "lightpush failed handleRequest", error = getCurrentExceptionMsg()
do:
From c6cf34df067a1362207a815e2363d033367abac8 Mon Sep 17 00:00:00 2001
From: Fabiana Cecin
Date: Fri, 28 Nov 2025 14:20:36 -0300
Subject: [PATCH 10/70] feat(tests): robustify waku_rln_relay test utils
(#3650)
---
tests/waku_rln_relay/utils_onchain.nim | 25 +++++++++++++++++++------
1 file changed, 19 insertions(+), 6 deletions(-)
diff --git a/tests/waku_rln_relay/utils_onchain.nim b/tests/waku_rln_relay/utils_onchain.nim
index 85f627aa0..06e4fcdcf 100644
--- a/tests/waku_rln_relay/utils_onchain.nim
+++ b/tests/waku_rln_relay/utils_onchain.nim
@@ -82,6 +82,10 @@ proc getForgePath(): string =
forgePath = joinPath(forgePath, ".foundry/bin/forge")
return $forgePath
+template execForge(cmd: string): tuple[output: string, exitCode: int] =
+ # unset env vars that affect e.g. "forge script" before running forge
+ execCmdEx("unset ETH_FROM ETH_PASSWORD && " & cmd)
+
contract(ERC20Token):
proc allowance(owner: Address, spender: Address): UInt256 {.view.}
proc balanceOf(account: Address): UInt256 {.view.}
@@ -225,11 +229,14 @@ proc deployTestToken*(
# Deploy TestToken contract
let forgeCmdTestToken =
fmt"""cd {submodulePath} && {forgePath} script test/TestToken.sol --broadcast -vvv --rpc-url http://localhost:8540 --tc TestTokenFactory --private-key {pk} && rm -rf broadcast/*/*/run-1*.json && rm -rf cache/*/*/run-1*.json"""
- let (outputDeployTestToken, exitCodeDeployTestToken) = execCmdEx(forgeCmdTestToken)
+ let (outputDeployTestToken, exitCodeDeployTestToken) = execForge(forgeCmdTestToken)
trace "Executed forge command to deploy TestToken contract",
output = outputDeployTestToken
if exitCodeDeployTestToken != 0:
- return error("Forge command to deploy TestToken contract failed")
+ error "Forge command to deploy TestToken contract failed",
+ error = outputDeployTestToken
+ return
+ err("Forge command to deploy TestToken contract failed: " & outputDeployTestToken)
# Parse the command output to find contract address
let testTokenAddress = getContractAddressFromDeployScriptOutput(outputDeployTestToken).valueOr:
@@ -351,7 +358,7 @@ proc executeForgeContractDeployScripts*(
let forgeCmdPriceCalculator =
fmt"""cd {submodulePath} && {forgePath} script script/Deploy.s.sol --broadcast -vvvv --rpc-url http://localhost:8540 --tc DeployPriceCalculator --private-key {privateKey} && rm -rf broadcast/*/*/run-1*.json && rm -rf cache/*/*/run-1*.json"""
let (outputDeployPriceCalculator, exitCodeDeployPriceCalculator) =
- execCmdEx(forgeCmdPriceCalculator)
+ execForge(forgeCmdPriceCalculator)
trace "Executed forge command to deploy LinearPriceCalculator contract",
output = outputDeployPriceCalculator
if exitCodeDeployPriceCalculator != 0:
@@ -368,7 +375,7 @@ proc executeForgeContractDeployScripts*(
let forgeCmdWakuRln =
fmt"""cd {submodulePath} && {forgePath} script script/Deploy.s.sol --broadcast -vvvv --rpc-url http://localhost:8540 --tc DeployWakuRlnV2 --private-key {privateKey} && rm -rf broadcast/*/*/run-1*.json && rm -rf cache/*/*/run-1*.json"""
- let (outputDeployWakuRln, exitCodeDeployWakuRln) = execCmdEx(forgeCmdWakuRln)
+ let (outputDeployWakuRln, exitCodeDeployWakuRln) = execForge(forgeCmdWakuRln)
trace "Executed forge command to deploy WakuRlnV2 contract",
output = outputDeployWakuRln
if exitCodeDeployWakuRln != 0:
@@ -388,7 +395,7 @@ proc executeForgeContractDeployScripts*(
# Deploy Proxy contract
let forgeCmdProxy =
fmt"""cd {submodulePath} && {forgePath} script script/Deploy.s.sol --broadcast -vvvv --rpc-url http://localhost:8540 --tc DeployProxy --private-key {privateKey} && rm -rf broadcast/*/*/run-1*.json && rm -rf cache/*/*/run-1*.json"""
- let (outputDeployProxy, exitCodeDeployProxy) = execCmdEx(forgeCmdProxy)
+ let (outputDeployProxy, exitCodeDeployProxy) = execForge(forgeCmdProxy)
trace "Executed forge command to deploy proxy contract", output = outputDeployProxy
if exitCodeDeployProxy != 0:
error "Forge command to deploy Proxy failed", error = outputDeployProxy
@@ -503,7 +510,7 @@ proc runAnvil*(port: int = 8540, chainId: string = "1234"): Process =
"--chain-id",
$chainId,
],
- options = {poUsePath},
+ options = {poUsePath, poStdErrToStdOut},
)
let anvilPID = runAnvil.processID
@@ -516,7 +523,13 @@ proc runAnvil*(port: int = 8540, chainId: string = "1234"): Process =
anvilStartLog.add(cmdline)
if cmdline.contains("Listening on 127.0.0.1:" & $port):
break
+ else:
+ error "Anvil daemon exited (closed output)",
+ pid = anvilPID, startLog = anvilStartLog
+ return
except Exception, CatchableError:
+ warn "Anvil daemon stdout reading error; assuming it started OK",
+ pid = anvilPID, startLog = anvilStartLog, err = getCurrentExceptionMsg()
break
info "Anvil daemon is running and ready", pid = anvilPID, startLog = anvilStartLog
return runAnvil
From 7eb1fdb0ac3eed0b39c5d1456ba6d1b9881e7980 Mon Sep 17 00:00:00 2001
From: Darshan K <35736874+darshankabariya@users.noreply.github.com>
Date: Mon, 1 Dec 2025 19:03:59 +0530
Subject: [PATCH 11/70] chore: new release process ( beta and full ) (#3647)
---
.../ISSUE_TEMPLATE/prepare_beta_release.md | 56 ++++++++
.../ISSUE_TEMPLATE/prepare_full_release.md | 76 +++++++++++
.github/ISSUE_TEMPLATE/prepare_release.md | 72 ----------
docs/contributors/release-process.md | 124 ++++++++++++------
4 files changed, 213 insertions(+), 115 deletions(-)
create mode 100644 .github/ISSUE_TEMPLATE/prepare_beta_release.md
create mode 100644 .github/ISSUE_TEMPLATE/prepare_full_release.md
delete mode 100644 .github/ISSUE_TEMPLATE/prepare_release.md
diff --git a/.github/ISSUE_TEMPLATE/prepare_beta_release.md b/.github/ISSUE_TEMPLATE/prepare_beta_release.md
new file mode 100644
index 000000000..270f6a8e6
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/prepare_beta_release.md
@@ -0,0 +1,56 @@
+---
+name: Prepare Beta Release
+about: Execute tasks for the creation and publishing of a new beta release
+title: 'Prepare beta release 0.0.0'
+labels: beta-release
+assignees: ''
+
+---
+
+
+
+### Items to complete
+
+All items below are to be completed by the owner of the given release.
+
+- [ ] Create release branch with major and minor only ( e.g. release/v0.X ) if it doesn't exist.
+- [ ] Assign release candidate tag to the release branch HEAD (e.g. `v0.X.0-beta-rc.0`, `v0.X.0-beta-rc.1`, ... `v0.X.0-beta-rc.N`).
+- [ ] Generate and edit release notes in CHANGELOG.md.
+
+- [ ] **Waku test and fleets validation**
+ - [ ] Ensure all the unit tests (specifically js-waku tests) are green against the release candidate.
+ - [ ] Deploy the release candidate to `waku.test` only through [deploy-waku-test job](https://ci.infra.status.im/job/nim-waku/job/deploy-waku-test/) and wait for it to finish (Jenkins access required; ask the infra team if you don't have it).
+ - After completion, disable [deployment job](https://ci.infra.status.im/job/nim-waku/) so that its version is not updated on every merge to master.
+ - Verify the deployed version at https://fleets.waku.org/.
+ - Confirm the container image exists on [Harbor](https://harbor.status.im/harbor/projects/9/repositories/nwaku/artifacts-tab).
+ - [ ] Analyze Kibana logs from the previous month (since the last release was deployed) for possible crashes or errors in `waku.test`.
+ - Most relevant logs are `(fleet: "waku.test" AND message: "SIGSEGV")`.
+ - [ ] Enable again the `waku.test` fleet to resume auto-deployment of the latest `master` commit.
+
+- [ ] **Proceed with release**
+
+ - [ ] Assign a final release tag (`v0.X.0-beta`) to the same commit that contains the validated release-candidate tag (e.g. `v0.X.0-beta-rc.N`) and submit a PR from the release branch to `master`.
+ - [ ] Update [nwaku-compose](https://github.com/waku-org/nwaku-compose) and [waku-simulator](https://github.com/waku-org/waku-simulator) according to the new release.
+ - [ ] Bump nwaku dependency in [waku-rust-bindings](https://github.com/waku-org/waku-rust-bindings) and make sure all examples and tests work.
+ - [ ] Bump nwaku dependency in [waku-go-bindings](https://github.com/waku-org/waku-go-bindings) and make sure all tests work.
+ - [ ] Create GitHub release (https://github.com/waku-org/nwaku/releases).
+ - [ ] Submit a PR to merge the release branch back to `master`. Make sure you use the option "Merge pull request (Create a merge commit)" to perform the merge. Ping repo admin if this option is not available.
+
+- [ ] **Promote release to fleets**
+ - [ ] Ask the PM lead to announce the release.
+ - [ ] Update infra config with any deprecated arguments or changed options.
+ - [ ] Update waku.sandbox with [this deployment job](https://ci.infra.status.im/job/nim-waku/job/deploy-waku-sandbox/).
+
+### Links
+
+- [Release process](https://github.com/waku-org/nwaku/blob/master/docs/contributors/release-process.md)
+- [Release notes](https://github.com/waku-org/nwaku/blob/master/CHANGELOG.md)
+- [Fleet ownership](https://www.notion.so/Fleet-Ownership-7532aad8896d46599abac3c274189741?pvs=4#d2d2f0fe4b3c429fbd860a1d64f89a64)
+- [Infra-nim-waku](https://github.com/status-im/infra-nim-waku)
+- [Jenkins](https://ci.infra.status.im/job/nim-waku/)
+- [Fleets](https://fleets.waku.org/)
+- [Harbor](https://harbor.status.im/harbor/projects/9/repositories/nwaku/artifacts-tab)
diff --git a/.github/ISSUE_TEMPLATE/prepare_full_release.md b/.github/ISSUE_TEMPLATE/prepare_full_release.md
new file mode 100644
index 000000000..18c668d16
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/prepare_full_release.md
@@ -0,0 +1,76 @@
+---
+name: Prepare Full Release
+about: Execute tasks for the creation and publishing of a new full release
+title: 'Prepare full release 0.0.0'
+labels: full-release
+assignees: ''
+
+---
+
+
+
+### Items to complete
+
+All items below are to be completed by the owner of the given release.
+
+- [ ] Create release branch with major and minor only ( e.g. release/v0.X ) if it doesn't exist.
+- [ ] Assign release candidate tag to the release branch HEAD (e.g. `v0.X.0-rc.0`, `v0.X.0-rc.1`, ... `v0.X.0-rc.N`).
+- [ ] Generate and edit release notes in CHANGELOG.md.
+
+- [ ] **Validation of release candidate**
+
+ - [ ] **Automated testing**
+ - [ ] Ensure all the unit tests (specifically js-waku tests) are green against the release candidate.
+ - [ ] Ask Vac-QA and Vac-DST to perform the available tests against the release candidate.
+ - [ ] Vac-DST (an additional report is needed; see [this](https://www.notion.so/DST-Reports-1228f96fb65c80729cd1d98a7496fe6f))
+
+ - [ ] **Waku fleet testing**
+ - [ ] Deploy the release candidate to `waku.test` and `waku.sandbox` fleets.
+ - Start the [deployment job](https://ci.infra.status.im/job/nim-waku/) for both fleets and wait for it to finish (Jenkins access required; ask the infra team if you don't have it).
+ - After completion, disable [deployment job](https://ci.infra.status.im/job/nim-waku/) so that its version is not updated on every merge to `master`.
+ - Verify the deployed version at https://fleets.waku.org/.
+ - Confirm the container image exists on [Harbor](https://harbor.status.im/harbor/projects/9/repositories/nwaku/artifacts-tab).
+ - [ ] Search _Kibana_ logs from the previous month (since the last release was deployed) for possible crashes or errors in `waku.test` and `waku.sandbox`.
+ - Most relevant logs are `(fleet: "waku.test" AND message: "SIGSEGV")` OR `(fleet: "waku.sandbox" AND message: "SIGSEGV")`.
+ - [ ] Enable again the `waku.test` fleet to resume auto-deployment of the latest `master` commit.
+
+- [ ] **Status fleet testing**
+ - [ ] Deploy release candidate to `status.staging`
+ - [ ] Perform [sanity check](https://www.notion.so/How-to-test-Nwaku-on-Status-12c6e4b9bf06420ca868bd199129b425) and log results as comments in this issue.
+ - [ ] Connect 2 instances to `status.staging` fleet, one in relay mode, the other one in light client.
+ - 1:1 Chats with each other
+ - Send and receive messages in a community
+ - Close one instance, send messages with second instance, reopen first instance and confirm messages sent while offline are retrieved from store
+ - [ ] Perform checks based on _end user impact_
+ - [ ] Inform other (Waku and Status) CCs to point their instances to `status.staging` for a few days. Ping Status colleagues on their Discord server or in the [Status community](https://status.app/c/G3kAAMSQtb05kog3aGbr3kiaxN4tF5xy4BAGEkkLwILk2z3GcoYlm5hSJXGn7J3laft-tnTwDWmYJ18dP_3bgX96dqr_8E3qKAvxDf3NrrCMUBp4R9EYkQez9XSM4486mXoC3mIln2zc-TNdvjdfL9eHVZ-mGgs=#zQ3shZeEJqTC1xhGUjxuS4rtHSrhJ8vUYp64v6qWkLpvdy9L9) (this is not a blocking point.)
+ - [ ] Ask Status-QA to perform sanity checks (as described above) and checks based on _end user impact_; specify the version being tested
+ - [ ] Ask Status-QA or infra to run the automated Status e2e tests against `status.staging`
+ - [ ] Get other CCs' sign-off: they should comment on this PR, e.g., "Used the app for a week, no problem." If problems are reported, resolve them and create a new RC.
+ - [ ] **Get Status-QA sign-off**, ensuring that the `status.test` update will not disturb ongoing activities.
+
+- [ ] **Proceed with release**
+
+ - [ ] Assign a final release tag (`v0.X.0`) to the same commit that contains the validated release-candidate tag (e.g. `v0.X.0`).
+ - [ ] Update [nwaku-compose](https://github.com/waku-org/nwaku-compose) and [waku-simulator](https://github.com/waku-org/waku-simulator) according to the new release.
+ - [ ] Bump nwaku dependency in [waku-rust-bindings](https://github.com/waku-org/waku-rust-bindings) and make sure all examples and tests work.
+ - [ ] Bump nwaku dependency in [waku-go-bindings](https://github.com/waku-org/waku-go-bindings) and make sure all tests work.
+ - [ ] Create GitHub release (https://github.com/waku-org/nwaku/releases).
+ - [ ] Submit a PR to merge the release branch back to `master`. Make sure you use the option "Merge pull request (Create a merge commit)" to perform the merge. Ping repo admin if this option is not available.
+
+- [ ] **Promote release to fleets**
+ - [ ] Ask the PM lead to announce the release.
+ - [ ] Update infra config with any deprecated arguments or changed options.
+
+### Links
+
+- [Release process](https://github.com/waku-org/nwaku/blob/master/docs/contributors/release-process.md)
+- [Release notes](https://github.com/waku-org/nwaku/blob/master/CHANGELOG.md)
+- [Fleet ownership](https://www.notion.so/Fleet-Ownership-7532aad8896d46599abac3c274189741?pvs=4#d2d2f0fe4b3c429fbd860a1d64f89a64)
+- [Infra-nim-waku](https://github.com/status-im/infra-nim-waku)
+- [Jenkins](https://ci.infra.status.im/job/nim-waku/)
+- [Fleets](https://fleets.waku.org/)
+- [Harbor](https://harbor.status.im/harbor/projects/9/repositories/nwaku/artifacts-tab)
diff --git a/.github/ISSUE_TEMPLATE/prepare_release.md b/.github/ISSUE_TEMPLATE/prepare_release.md
deleted file mode 100644
index 9553d5685..000000000
--- a/.github/ISSUE_TEMPLATE/prepare_release.md
+++ /dev/null
@@ -1,72 +0,0 @@
----
-name: Prepare release
-about: Execute tasks for the creation and publishing of a new release
-title: 'Prepare release 0.0.0'
-labels: release
-assignees: ''
-
----
-
-
-
-### Items to complete
-
-All items below are to be completed by the owner of the given release.
-
-- [ ] Create release branch
-- [ ] Assign release candidate tag to the release branch HEAD. e.g. v0.30.0-rc.0
-- [ ] Generate and edit releases notes in CHANGELOG.md
-- [ ] Review possible update of [config-options](https://github.com/waku-org/docs.waku.org/blob/develop/docs/guides/nwaku/config-options.md)
-- [ ] _End user impact_: Summarize impact of changes on Status end users (can be a comment in this issue).
-- [ ] **Validate release candidate**
- - [ ] Bump nwaku dependency in [waku-rust-bindings](https://github.com/waku-org/waku-rust-bindings) and make sure all examples and tests work
-
-- [ ] Automated testing
- - [ ] Ensures js-waku tests are green against release candidate
- - [ ] Ask Vac-QA and Vac-DST to perform available tests against release candidate
- - [ ] Vac-QA
- - [ ] Vac-DST (we need additional report. see [this](https://www.notion.so/DST-Reports-1228f96fb65c80729cd1d98a7496fe6f))
-
- - [ ] **On Waku fleets**
- - [ ] Lock `waku.test` fleet to release candidate version
- - [ ] Continuously stress `waku.test` fleet for a week (e.g. from `wakudev`)
- - [ ] Search _Kibana_ logs from the previous month (since last release was deployed), for possible crashes or errors in `waku.test` and `waku.sandbox`.
- - Most relevant logs are `(fleet: "waku.test" OR fleet: "waku.sandbox") AND message: "SIGSEGV"`
- - [ ] Run release candidate with `waku-simulator`, ensure that nodes connected to each other
- - [ ] Unlock `waku.test` to resume auto-deployment of latest `master` commit
-
- - [ ] **On Status fleet**
- - [ ] Deploy release candidate to `status.staging`
- - [ ] Perform [sanity check](https://www.notion.so/How-to-test-Nwaku-on-Status-12c6e4b9bf06420ca868bd199129b425) and log results as comments in this issue.
- - [ ] Connect 2 instances to `status.staging` fleet, one in relay mode, the other one in light client.
- - [ ] 1:1 Chats with each other
- - [ ] Send and receive messages in a community
- - [ ] Close one instance, send messages with second instance, reopen first instance and confirm messages sent while offline are retrieved from store
- - [ ] Perform checks based _end user impact_
- - [ ] Inform other (Waku and Status) CCs to point their instance to `status.staging` for a few days. Ping Status colleagues from their Discord server or [Status community](https://status.app/c/G3kAAMSQtb05kog3aGbr3kiaxN4tF5xy4BAGEkkLwILk2z3GcoYlm5hSJXGn7J3laft-tnTwDWmYJ18dP_3bgX96dqr_8E3qKAvxDf3NrrCMUBp4R9EYkQez9XSM4486mXoC3mIln2zc-TNdvjdfL9eHVZ-mGgs=#zQ3shZeEJqTC1xhGUjxuS4rtHSrhJ8vUYp64v6qWkLpvdy9L9) (not blocking point.)
- - [ ] Ask Status-QA to perform sanity checks (as described above) + checks based on _end user impact_; do specify the version being tested
- - [ ] Ask Status-QA or infra to run the automated Status e2e tests against `status.staging`
- - [ ] Get other CCs sign-off: they comment on this PR "used app for a week, no problem", or problem reported, resolved and new RC
- - [ ] **Get Status-QA sign-off**. Ensuring that `status.test` update will not disturb ongoing activities.
-
-- [ ] **Proceed with release**
-
- - [ ] Assign a release tag to the same commit that contains the validated release-candidate tag
- - [ ] Create GitHub release
- - [ ] Deploy the release to DockerHub
- - [ ] Announce the release
-
-- [ ] **Promote release to fleets**.
- - [ ] Update infra config with any deprecated arguments or changed options
- - [ ] [Deploy final release to `waku.sandbox` fleet](https://ci.infra.status.im/job/nim-waku/job/deploy-waku-sandbox)
- - [ ] [Deploy final release to `status.staging` fleet](https://ci.infra.status.im/job/nim-waku/job/deploy-shards-staging/)
- - [ ] [Deploy final release to `status.prod` fleet](https://ci.infra.status.im/job/nim-waku/job/deploy-shards-test/)
-
-- [ ] **Post release**
- - [ ] Submit a PR from the release branch to master. Important to commit the PR with "create a merge commit" option.
- - [ ] Update waku-org/nwaku-compose with the new release version.
- - [ ] Update version in js-waku repo. [update only this](https://github.com/waku-org/js-waku/blob/7c0ce7b2eca31cab837da0251e1e4255151be2f7/.github/workflows/ci.yml#L135) by submitting a PR.
diff --git a/docs/contributors/release-process.md b/docs/contributors/release-process.md
index c0fb12d1c..bde63aa6f 100644
--- a/docs/contributors/release-process.md
+++ b/docs/contributors/release-process.md
@@ -6,44 +6,52 @@ For more context, see https://trunkbaseddevelopment.com/branch-for-release/
## How to do releases
-### Before release
+### Prerequisites
+
+- All issues under the corresponding release [milestone](https://github.com/waku-org/nwaku/milestones) have been closed or, after consultation, deferred to the next release.
+- All submodules are up to date.
+ > Updating submodules requires a PR (and very often several "fixes" to maintain compatibility with the changes in submodules). That PR process must be done and merged a couple of days before the release.
-Ensure all items in this list are ticked:
-- [ ] All issues under the corresponding release [milestone](https://github.com/waku-org/nwaku/milestones) has been closed or, after consultation, deferred to a next release.
-- [ ] All submodules are up to date.
- > **IMPORTANT:** Updating submodules requires a PR (and very often several "fixes" to maintain compatibility with the changes in submodules). That PR process must be done and merged a couple of days before the release.
> In case the submodules update has a low effort and/or risk for the release, follow the ["Update submodules"](./git-submodules.md) instructions.
- > If the effort or risk is too high, consider postponing the submodules upgrade for the subsequent release or delaying the current release until the submodules updates are included in the release candidate.
-- [ ] The [js-waku CI tests](https://github.com/waku-org/js-waku/actions/workflows/ci.yml) pass against the release candidate (i.e. nwaku latest `master`).
- > **NOTE:** This serves as a basic regression test against typical clients of nwaku.
- > The specific job that needs to pass is named `node_with_nwaku_master`.
-### Performing the release
+ > If the effort or risk is too high, consider postponing the submodules upgrade for the subsequent release or delaying the current release until the submodules updates are included in the release candidate.
+
+### Release types
+
+- **Full release**: follow the entire [Release process](#release-process--step-by-step).
+
+- **Beta release**: skip just `6a` and `6c` steps from [Release process](#release-process--step-by-step).
+
+- Choose the appropriate release process based on the release type:
+ - [Full Release](../../.github/ISSUE_TEMPLATE/prepare_full_release.md)
+ - [Beta Release](../../.github/ISSUE_TEMPLATE/prepare_beta_release.md)
+
+### Release process ( step by step )
1. Checkout a release branch from master
```
- git checkout -b release/v0.1.0
+ git checkout -b release/v0.X.0
```
-1. Update `CHANGELOG.md` and ensure it is up to date. Use the helper Make target to get PR based release-notes/changelog update.
+2. Update `CHANGELOG.md` and ensure it is up to date. Use the helper Make target to get PR based release-notes/changelog update.
```
make release-notes
```
-1. Create a release-candidate tag with the same name as release and `-rc.N` suffix a few days before the official release and push it
+3. Create a release-candidate tag with the same name as release and `-rc.N` suffix a few days before the official release and push it
```
- git tag -as v0.1.0-rc.0 -m "Initial release."
- git push origin v0.1.0-rc.0
+ git tag -as v0.X.0-rc.0 -m "Initial release."
+ git push origin v0.X.0-rc.0
```
- This will trigger a [workflow](../../.github/workflows/pre-release.yml) which will build RC artifacts and create and publish a Github release
+ This will trigger a [workflow](../../.github/workflows/pre-release.yml) which will build RC artifacts and create and publish a GitHub release
-1. Open a PR from the release branch for others to review the included changes and the release-notes
+4. Open a PR from the release branch for others to review the included changes and the release-notes
-1. In case additional changes are needed, create a new RC tag
+5. In case additional changes are needed, create a new RC tag
Make sure the new tag is associated
with CHANGELOG update.
@@ -52,25 +60,57 @@ Ensure all items in this list are ticked:
# Make changes, rebase and create new tag
# Squash to one commit and make a nice commit message
git rebase -i origin/master
- git tag -as v0.1.0-rc.1 -m "Initial release."
- git push origin v0.1.0-rc.1
+ git tag -as v0.X.0-rc.1 -m "Initial release."
+ git push origin v0.X.0-rc.1
```
-1. Validate the release. For the release validation process, please refer to the following [guide](https://www.notion.so/Release-Process-61234f335b904cd0943a5033ed8f42b4#47af557e7f9744c68fdbe5240bf93ca9)
+ Similarly use v0.X.0-rc.2, v0.X.0-rc.3 etc. for additional RC tags.
-1. Once the release-candidate has been validated, create a final release tag and push it.
-We also need to merge release branch back to master as a final step.
+6. **Validation of release candidate**
+
+ 6a. **Automated testing**
+ - Ensure all the unit tests (specifically js-waku tests) are green against the release candidate.
+ - Ask Vac-QA and Vac-DST to run their available tests against the release candidate; share all release candidates with both teams.
+
+ > We need an additional report like [this](https://www.notion.so/DST-Reports-1228f96fb65c80729cd1d98a7496fe6f) specifically from the DST team.
+
+ 6b. **Waku fleet testing**
+ - Start job on `waku.sandbox` and `waku.test` [Deployment job](https://ci.infra.status.im/job/nim-waku/), wait for completion of the job. If it fails, then debug it.
+ - After completion, disable [deployment job](https://ci.infra.status.im/job/nim-waku/) so that its version is not updated on every merge to `master`.
+ - Verify at https://fleets.waku.org/ that the fleet is locked to the release candidate version.
+ - Check if the image is created at [Harbor](https://harbor.status.im/harbor/projects/9/repositories/nwaku/artifacts-tab).
+ - Search _Kibana_ logs from the previous month (since the last release was deployed) for possible crashes or errors in `waku.test` and `waku.sandbox`.
+ - Most relevant logs are `(fleet: "waku.test" AND message: "SIGSEGV")` OR `(fleet: "waku.sandbox" AND message: "SIGSEGV")`.
+ - Enable the `waku.test` fleet again to resume auto-deployment of the latest `master` commit.
+
+ 6c. **Status fleet testing**
+ - Deploy release candidate to `status.staging`
+ - Perform [sanity check](https://www.notion.so/How-to-test-Nwaku-on-Status-12c6e4b9bf06420ca868bd199129b425) and log results as comments in this issue.
+ - Connect 2 instances to `status.staging` fleet, one in relay mode, the other one in light client.
+ - 1:1 Chats with each other
+ - Send and receive messages in a community
+ - Close one instance, send messages with second instance, reopen first instance and confirm messages sent while offline are retrieved from store
+ - Perform checks based on _end-user impact_.
+ - Inform other (Waku and Status) CCs to point their instances to `status.staging` for a few days. Ping Status colleagues from their Discord server or [Status community](https://status.app) (not a blocking point).
+ - Ask Status-QA to perform sanity checks (as described above) and checks based on _end user impact_; specify the version being tested.
+ - Ask Status-QA or infra to run the automated Status e2e tests against `status.staging`.
+ - Get other CCs' sign-off: they should comment on this PR, e.g., "Used the app for a week, no problem." If problems are reported, resolve them and create a new RC.
+ - **Get Status-QA sign-off**, ensuring that the `status.test` update will not disturb ongoing activities.
+
+7. Once the release-candidate has been validated, create a final release tag and push it.
+We also need to merge the release branch back into master as a final step.
```
- git checkout release/v0.1.0
- git tag -as v0.1.0 -m "Initial release."
- git push origin v0.1.0
+ git checkout release/v0.X.0
+ git tag -as v0.X.0 -m "final release." (use v0.X.0-beta as the tag if you are creating a beta release)
+ git push origin v0.X.0
git switch master
git pull
- git merge release/v0.1.0
+ git merge release/v0.X.0
```
+8. Update `waku-rust-bindings`, `waku-simulator` and `nwaku-compose` to use the new release.
-1. Create a [Github release](https://github.com/waku-org/nwaku/releases) from the release tag.
+9. Create a [GitHub release](https://github.com/waku-org/nwaku/releases) from the release tag.
* Add binaries produced by the ["Upload Release Asset"](https://github.com/waku-org/nwaku/actions/workflows/release-assets.yml) workflow. Where possible, test the binaries before uploading to the release.
@@ -80,22 +120,10 @@ We also need to merge release branch back to master as a final step.
2. Deploy the release image to [Dockerhub](https://hub.docker.com/r/wakuorg/nwaku) by triggering [the manual Jenkins deployment job](https://ci.infra.status.im/job/nim-waku/job/docker-manual/).
> Ensure the following build parameters are set:
> - `MAKE_TARGET`: `wakunode2`
- > - `IMAGE_TAG`: the release tag (e.g. `v0.16.0`)
+ > - `IMAGE_TAG`: the release tag (e.g. `v0.36.0`)
> - `IMAGE_NAME`: `wakuorg/nwaku`
> - `NIMFLAGS`: `--colors:off -d:disableMarchNative -d:chronicles_colors:none -d:postgres`
- > - `GIT_REF` the release tag (e.g. `v0.16.0`)
-3. Update the default nwaku image in [nwaku-compose](https://github.com/waku-org/nwaku-compose/blob/master/docker-compose.yml)
-4. Deploy the release to appropriate fleets:
- - Inform clients
- > **NOTE:** known clients are currently using some version of js-waku, go-waku, nwaku or waku-rs.
- > Clients are reachable via the corresponding channels on the Vac Discord server.
- > It should be enough to inform clients on the `#nwaku` and `#announce` channels on Discord.
- > Informal conversations with specific repo maintainers are often part of this process.
- - Check if nwaku configuration parameters changed. If so [update fleet configuration](https://www.notion.so/Fleet-Ownership-7532aad8896d46599abac3c274189741?pvs=4#d2d2f0fe4b3c429fbd860a1d64f89a64) in [infra-nim-waku](https://github.com/status-im/infra-nim-waku)
- - Deploy release to the `waku.sandbox` fleet from [Jenkins](https://ci.infra.status.im/job/nim-waku/job/deploy-waku-sandbox/).
- - Ensure that nodes successfully start up and monitor health using [Grafana](https://grafana.infra.status.im/d/qrp_ZCTGz/nim-waku-v2?orgId=1) and [Kibana](https://kibana.infra.status.im/goto/a7728e70-eb26-11ec-81d1-210eb3022c76).
- - If necessary, revert by deploying the previous release. Download logs and open a bug report issue.
-5. Submit a PR to merge the release branch back to `master`. Make sure you use the option `Merge pull request (Create a merge commit)` to perform such merge.
+ > - `GIT_REF` the release tag (e.g. `v0.36.0`)
### Performing a patch release
@@ -116,4 +144,14 @@ We also need to merge release branch back to master as a final step.
4. Once the release-candidate has been validated and changelog PR got merged, cherry-pick the changelog update from master to the release branch. Create a final release tag and push it.
-5. Create a [Github release](https://github.com/waku-org/nwaku/releases) from the release tag and follow the same post-release process as usual.
+5. Create a [GitHub release](https://github.com/waku-org/nwaku/releases) from the release tag and follow the same post-release process as usual.
+
+### Links
+
+- [Release process](https://github.com/waku-org/nwaku/blob/master/docs/contributors/release-process.md)
+- [Release notes](https://github.com/waku-org/nwaku/blob/master/CHANGELOG.md)
+- [Fleet ownership](https://www.notion.so/Fleet-Ownership-7532aad8896d46599abac3c274189741?pvs=4#d2d2f0fe4b3c429fbd860a1d64f89a64)
+- [Infra-nim-waku](https://github.com/status-im/infra-nim-waku)
+- [Jenkins](https://ci.infra.status.im/job/nim-waku/)
+- [Fleets](https://fleets.waku.org/)
+- [Harbor](https://harbor.status.im/harbor/projects/9/repositories/nwaku/artifacts-tab)
\ No newline at end of file
From ae74b9018a248ae4f641205d60e7122c024d47f6 Mon Sep 17 00:00:00 2001
From: NagyZoltanPeter <113987313+NagyZoltanPeter@users.noreply.github.com>
Date: Tue, 2 Dec 2025 00:24:46 +0100
Subject: [PATCH 12/70] chore: Introduce EventBroker, RequestBroker and
MultiRequestBroker (#3644)
* Introduce EventBroker and RequestBroker as decoupling helpers that represent reactive (event-driven) and proactive (request/response) patterns without tight coupling between modules
* Address copilot observation. error log if failed listener call exception, handling listener overuse - run out of IDs
* Address review observations: no exception to leak, listeners must raise no exception, adding listener now reports error with Result.
* Added MultiRequestBroker utility to collect results from many providers
* Support an arbitrary number of arguments for RequestBroker's request/provider signature
* MultiRequestBroker allows provider procs to throw exceptions, which will be handled during request processing.
* MultiRequestBroker supports one zero arg signature and/or multi arg signature
* test no exception leaks from RequestBroker and MultiRequestBroker
* Embed MultiRequestBroker tests into common
* EventBroker: removed all ...Broker typed public procs to simplify EventBroker interface, forger is renamed to dropListener
* Make Request's broker type private
* MultiRequestBroker: Use explicit returns in generated procs
* Updated descriptions of EventBroker and RequestBroker, updated RequestBroker.setProvider, returns error if already set.
* Better description for MultiRequestBroker and its usage
* Add EventBroker support for ref objects, fix emit variant with event object ctor
* Add RequestBroker support for ref objects
* Add MultiRequestBroker support for ref objects
* Mover brokers under waku/common
---
tests/common/test_all.nim | 5 +-
tests/common/test_event_broker.nim | 125 +++++
tests/common/test_multi_request_broker.nim | 234 ++++++++
tests/common/test_request_broker.nim | 198 +++++++
waku/common/broker/event_broker.nim | 308 +++++++++++
waku/common/broker/helper/broker_utils.nim | 43 ++
waku/common/broker/multi_request_broker.nim | 583 ++++++++++++++++++++
waku/common/broker/request_broker.nim | 438 +++++++++++++++
8 files changed, 1933 insertions(+), 1 deletion(-)
create mode 100644 tests/common/test_event_broker.nim
create mode 100644 tests/common/test_multi_request_broker.nim
create mode 100644 tests/common/test_request_broker.nim
create mode 100644 waku/common/broker/event_broker.nim
create mode 100644 waku/common/broker/helper/broker_utils.nim
create mode 100644 waku/common/broker/multi_request_broker.nim
create mode 100644 waku/common/broker/request_broker.nim
diff --git a/tests/common/test_all.nim b/tests/common/test_all.nim
index 5b4515093..7495c7c9e 100644
--- a/tests/common/test_all.nim
+++ b/tests/common/test_all.nim
@@ -9,4 +9,7 @@ import
./test_tokenbucket,
./test_requestratelimiter,
./test_ratelimit_setting,
- ./test_timed_map
+ ./test_timed_map,
+ ./test_event_broker,
+ ./test_request_broker,
+ ./test_multi_request_broker
diff --git a/tests/common/test_event_broker.nim b/tests/common/test_event_broker.nim
new file mode 100644
index 000000000..cead1277f
--- /dev/null
+++ b/tests/common/test_event_broker.nim
@@ -0,0 +1,125 @@
+import chronos
+import std/sequtils
+import testutils/unittests
+
+import waku/common/broker/event_broker
+
+EventBroker:
+ type SampleEvent = object
+ value*: int
+ label*: string
+
+EventBroker:
+ type BinaryEvent = object
+ flag*: bool
+
+EventBroker:
+ type RefEvent = ref object
+ payload*: seq[int]
+
+template waitForListeners() =
+ waitFor sleepAsync(1.milliseconds)
+
+suite "EventBroker":
+ test "delivers events to all listeners":
+ var seen: seq[(int, string)] = @[]
+
+ discard SampleEvent.listen(
+ proc(evt: SampleEvent): Future[void] {.async: (raises: []).} =
+ seen.add((evt.value, evt.label))
+ )
+
+ discard SampleEvent.listen(
+ proc(evt: SampleEvent): Future[void] {.async: (raises: []).} =
+ seen.add((evt.value * 2, evt.label & "!"))
+ )
+
+ let evt = SampleEvent(value: 5, label: "hi")
+ SampleEvent.emit(evt)
+ waitForListeners()
+
+ check seen.len == 2
+ check seen.anyIt(it == (5, "hi"))
+ check seen.anyIt(it == (10, "hi!"))
+
+ SampleEvent.dropAllListeners()
+
+ test "forget removes a single listener":
+ var counter = 0
+
+ let handleA = SampleEvent.listen(
+ proc(evt: SampleEvent): Future[void] {.async: (raises: []).} =
+ inc counter
+ )
+
+ let handleB = SampleEvent.listen(
+ proc(evt: SampleEvent): Future[void] {.async: (raises: []).} =
+ inc(counter, 2)
+ )
+
+ SampleEvent.dropListener(handleA.get())
+ let eventVal = SampleEvent(value: 1, label: "one")
+ SampleEvent.emit(eventVal)
+ waitForListeners()
+ check counter == 2
+
+ SampleEvent.dropAllListeners()
+
+ test "forgetAll clears every listener":
+ var triggered = false
+
+ let handle1 = SampleEvent.listen(
+ proc(evt: SampleEvent): Future[void] {.async: (raises: []).} =
+ triggered = true
+ )
+ let handle2 = SampleEvent.listen(
+ proc(evt: SampleEvent): Future[void] {.async: (raises: []).} =
+ discard
+ )
+
+ SampleEvent.dropAllListeners()
+ SampleEvent.emit(42, "noop")
+ SampleEvent.emit(label = "noop", value = 42)
+ waitForListeners()
+ check not triggered
+
+ let freshHandle = SampleEvent.listen(
+ proc(evt: SampleEvent): Future[void] {.async: (raises: []).} =
+ discard
+ )
+ check freshHandle.get().id > 0'u64
+ SampleEvent.dropListener(freshHandle.get())
+
+ test "broker helpers operate via typedesc":
+ var toggles: seq[bool] = @[]
+
+ let handle = BinaryEvent.listen(
+ proc(evt: BinaryEvent): Future[void] {.async: (raises: []).} =
+ toggles.add(evt.flag)
+ )
+
+ BinaryEvent(flag: true).emit()
+ waitForListeners()
+ let binaryEvent = BinaryEvent(flag: false)
+ BinaryEvent.emit(binaryEvent)
+ waitForListeners()
+
+ check toggles == @[true, false]
+ BinaryEvent.dropAllListeners()
+
+ test "ref typed event":
+ var counter: int = 0
+
+ let handle = RefEvent.listen(
+ proc(evt: RefEvent): Future[void] {.async: (raises: []).} =
+ for n in evt.payload:
+ counter += n
+ )
+
+ RefEvent(payload: @[1, 2, 3]).emit()
+ waitForListeners()
+ RefEvent.emit(payload = @[4, 5, 6])
+ waitForListeners()
+
+ check counter == 21 # 1+2+3 + 4+5+6
+ RefEvent.dropAllListeners()
diff --git a/tests/common/test_multi_request_broker.nim b/tests/common/test_multi_request_broker.nim
new file mode 100644
index 000000000..3bf10a54d
--- /dev/null
+++ b/tests/common/test_multi_request_broker.nim
@@ -0,0 +1,234 @@
+{.used.}
+
+import testutils/unittests
+import chronos
+import std/sequtils
+import std/strutils
+
+import waku/common/broker/multi_request_broker
+
+MultiRequestBroker:
+ type NoArgResponse = object
+ label*: string
+
+ proc signatureFetch*(): Future[Result[NoArgResponse, string]] {.async.}
+
+MultiRequestBroker:
+ type ArgResponse = object
+ id*: string
+
+ proc signatureFetch*(
+ suffix: string, numsuffix: int
+ ): Future[Result[ArgResponse, string]] {.async.}
+
+MultiRequestBroker:
+ type DualResponse = ref object
+ note*: string
+ suffix*: string
+
+ proc signatureBase*(): Future[Result[DualResponse, string]] {.async.}
+ proc signatureWithInput*(
+ suffix: string
+ ): Future[Result[DualResponse, string]] {.async.}
+
+suite "MultiRequestBroker":
+ test "aggregates zero-argument providers":
+ discard NoArgResponse.setProvider(
+ proc(): Future[Result[NoArgResponse, string]] {.async.} =
+ ok(NoArgResponse(label: "one"))
+ )
+
+ discard NoArgResponse.setProvider(
+ proc(): Future[Result[NoArgResponse, string]] {.async.} =
+ discard catch:
+ await sleepAsync(1.milliseconds)
+ ok(NoArgResponse(label: "two"))
+ )
+
+ let responses = waitFor NoArgResponse.request()
+ check responses.get().len == 2
+ check responses.get().anyIt(it.label == "one")
+ check responses.get().anyIt(it.label == "two")
+
+ NoArgResponse.clearProviders()
+
+ test "aggregates argument providers":
+ discard ArgResponse.setProvider(
+ proc(suffix: string, num: int): Future[Result[ArgResponse, string]] {.async.} =
+ ok(ArgResponse(id: suffix & "-a-" & $num))
+ )
+
+ discard ArgResponse.setProvider(
+ proc(suffix: string, num: int): Future[Result[ArgResponse, string]] {.async.} =
+ ok(ArgResponse(id: suffix & "-b-" & $num))
+ )
+
+ let keyed = waitFor ArgResponse.request("topic", 1)
+ check keyed.get().len == 2
+ check keyed.get().anyIt(it.id == "topic-a-1")
+ check keyed.get().anyIt(it.id == "topic-b-1")
+
+ ArgResponse.clearProviders()
+
+ test "clearProviders resets both provider lists":
+ discard DualResponse.setProvider(
+ proc(): Future[Result[DualResponse, string]] {.async.} =
+ ok(DualResponse(note: "base", suffix: ""))
+ )
+
+ discard DualResponse.setProvider(
+ proc(suffix: string): Future[Result[DualResponse, string]] {.async.} =
+ ok(DualResponse(note: "base" & suffix, suffix: suffix))
+ )
+
+ let noArgs = waitFor DualResponse.request()
+ check noArgs.get().len == 1
+
+ let param = waitFor DualResponse.request("-extra")
+ check param.get().len == 1
+ check param.get()[0].suffix == "-extra"
+
+ DualResponse.clearProviders()
+
+ let emptyNoArgs = waitFor DualResponse.request()
+ check emptyNoArgs.get().len == 0
+
+ let emptyWithArgs = waitFor DualResponse.request("-extra")
+ check emptyWithArgs.get().len == 0
+
+ test "request returns empty seq when no providers registered":
+ let empty = waitFor NoArgResponse.request()
+ check empty.get().len == 0
+
+ test "failed providers will fail the request":
+ NoArgResponse.clearProviders()
+ discard NoArgResponse.setProvider(
+ proc(): Future[Result[NoArgResponse, string]] {.async.} =
+ err("boom")
+ )
+
+ discard NoArgResponse.setProvider(
+ proc(): Future[Result[NoArgResponse, string]] {.async.} =
+ ok(NoArgResponse(label: "survivor"))
+ )
+
+ let filtered = waitFor NoArgResponse.request()
+ check filtered.isErr()
+
+ NoArgResponse.clearProviders()
+
+ test "deduplicates identical zero-argument providers":
+ NoArgResponse.clearProviders()
+ var invocations = 0
+ let sharedHandler = proc(): Future[Result[NoArgResponse, string]] {.async.} =
+ inc invocations
+ ok(NoArgResponse(label: "dup"))
+
+ let first = NoArgResponse.setProvider(sharedHandler)
+ let second = NoArgResponse.setProvider(sharedHandler)
+
+ check first.get().id == second.get().id
+ check first.get().kind == second.get().kind
+
+ let dupResponses = waitFor NoArgResponse.request()
+ check dupResponses.get().len == 1
+ check invocations == 1
+
+ NoArgResponse.clearProviders()
+
+ test "removeProvider deletes registered handlers":
+ var removedCalled = false
+ var keptCalled = false
+
+ let removable = NoArgResponse.setProvider(
+ proc(): Future[Result[NoArgResponse, string]] {.async.} =
+ removedCalled = true
+ ok(NoArgResponse(label: "removed"))
+ )
+
+ discard NoArgResponse.setProvider(
+ proc(): Future[Result[NoArgResponse, string]] {.async.} =
+ keptCalled = true
+ ok(NoArgResponse(label: "kept"))
+ )
+
+ NoArgResponse.removeProvider(removable.get())
+
+ let afterRemoval = (waitFor NoArgResponse.request()).valueOr:
+ assert false, "request failed"
+ @[]
+ check afterRemoval.len == 1
+ check afterRemoval[0].label == "kept"
+ check not removedCalled
+ check keptCalled
+
+ NoArgResponse.clearProviders()
+
+ test "removeProvider works for argument signatures":
+ var invoked: seq[string] = @[]
+
+ discard ArgResponse.setProvider(
+ proc(suffix: string, num: int): Future[Result[ArgResponse, string]] {.async.} =
+ invoked.add("first" & suffix)
+ ok(ArgResponse(id: suffix & "-one-" & $num))
+ )
+
+ let handle = ArgResponse.setProvider(
+ proc(suffix: string, num: int): Future[Result[ArgResponse, string]] {.async.} =
+ invoked.add("second" & suffix)
+ ok(ArgResponse(id: suffix & "-two-" & $num))
+ )
+
+ ArgResponse.removeProvider(handle.get())
+
+ let single = (waitFor ArgResponse.request("topic", 1)).valueOr:
+ assert false, "request failed"
+ @[]
+ check single.len == 1
+ check single[0].id == "topic-one-1"
+ check invoked == @["firsttopic"]
+
+ ArgResponse.clearProviders()
+
+ test "catches exception from providers and report error":
+ let firstHandler = NoArgResponse.setProvider(
+ proc(): Future[Result[NoArgResponse, string]] {.async.} =
+ raise newException(ValueError, "first handler raised")
+ ok(NoArgResponse(label: "any"))
+ )
+
+ discard NoArgResponse.setProvider(
+ proc(): Future[Result[NoArgResponse, string]] {.async.} =
+ ok(NoArgResponse(label: "just ok"))
+ )
+
+ let afterException = waitFor NoArgResponse.request()
+ check afterException.isErr()
+ check afterException.error().contains("first handler raised")
+
+ NoArgResponse.clearProviders()
+
+ test "ref providers returning nil fail request":
+ DualResponse.clearProviders()
+
+ discard DualResponse.setProvider(
+ proc(): Future[Result[DualResponse, string]] {.async.} =
+ let nilResponse: DualResponse = nil
+ ok(nilResponse)
+ )
+
+ let zeroArg = waitFor DualResponse.request()
+ check zeroArg.isErr()
+
+ DualResponse.clearProviders()
+
+ discard DualResponse.setProvider(
+ proc(suffix: string): Future[Result[DualResponse, string]] {.async.} =
+ let nilResponse: DualResponse = nil
+ ok(nilResponse)
+ )
+
+ let withInput = waitFor DualResponse.request("-extra")
+ check withInput.isErr()
+
+ DualResponse.clearProviders()
diff --git a/tests/common/test_request_broker.nim b/tests/common/test_request_broker.nim
new file mode 100644
index 000000000..2ffd9cbf8
--- /dev/null
+++ b/tests/common/test_request_broker.nim
@@ -0,0 +1,198 @@
+{.used.}
+
+import testutils/unittests
+import chronos
+import std/strutils
+
+import waku/common/broker/request_broker
+
+RequestBroker:
+ type SimpleResponse = object
+ value*: string
+
+ proc signatureFetch*(): Future[Result[SimpleResponse, string]] {.async.}
+
+RequestBroker:
+ type KeyedResponse = object
+ key*: string
+ payload*: string
+
+ proc signatureFetchWithKey*(
+ key: string, subKey: int
+ ): Future[Result[KeyedResponse, string]] {.async.}
+
+RequestBroker:
+ type DualResponse = object
+ note*: string
+ count*: int
+
+ proc signatureNoInput*(): Future[Result[DualResponse, string]] {.async.}
+ proc signatureWithInput*(
+ suffix: string
+ ): Future[Result[DualResponse, string]] {.async.}
+
+RequestBroker:
+ type ImplicitResponse = ref object
+ note*: string
+
+suite "RequestBroker macro":
+ test "serves zero-argument providers":
+ check SimpleResponse
+ .setProvider(
+ proc(): Future[Result[SimpleResponse, string]] {.async.} =
+ ok(SimpleResponse(value: "hi"))
+ )
+ .isOk()
+
+ let res = waitFor SimpleResponse.request()
+ check res.isOk()
+ check res.value.value == "hi"
+
+ SimpleResponse.clearProvider()
+
+ test "zero-argument request errors when unset":
+ let res = waitFor SimpleResponse.request()
+ check res.isErr
+ check res.error.contains("no zero-arg provider")
+
+ test "serves input-based providers":
+ var seen: seq[string] = @[]
+ check KeyedResponse
+ .setProvider(
+ proc(key: string, subKey: int): Future[Result[KeyedResponse, string]] {.async.} =
+ seen.add(key)
+ ok(KeyedResponse(key: key, payload: key & "-payload+" & $subKey))
+ )
+ .isOk()
+
+ let res = waitFor KeyedResponse.request("topic", 1)
+ check res.isOk()
+ check res.value.key == "topic"
+ check res.value.payload == "topic-payload+1"
+ check seen == @["topic"]
+
+ KeyedResponse.clearProvider()
+
+ test "catches provider exception":
+ check KeyedResponse
+ .setProvider(
+ proc(key: string, subKey: int): Future[Result[KeyedResponse, string]] {.async.} =
+ raise newException(ValueError, "simulated failure")
+ ok(KeyedResponse(key: key, payload: ""))
+ )
+ .isOk()
+
+ let res = waitFor KeyedResponse.request("neglected", 11)
+ check res.isErr()
+ check res.error.contains("simulated failure")
+
+ KeyedResponse.clearProvider()
+
+ test "input request errors when unset":
+ let res = waitFor KeyedResponse.request("foo", 2)
+ check res.isErr
+ check res.error.contains("input signature")
+
+ test "supports both provider types simultaneously":
+ check DualResponse
+ .setProvider(
+ proc(): Future[Result[DualResponse, string]] {.async.} =
+ ok(DualResponse(note: "base", count: 1))
+ )
+ .isOk()
+
+ check DualResponse
+ .setProvider(
+ proc(suffix: string): Future[Result[DualResponse, string]] {.async.} =
+ ok(DualResponse(note: "base" & suffix, count: suffix.len))
+ )
+ .isOk()
+
+ let noInput = waitFor DualResponse.request()
+ check noInput.isOk
+ check noInput.value.note == "base"
+
+ let withInput = waitFor DualResponse.request("-extra")
+ check withInput.isOk
+ check withInput.value.note == "base-extra"
+ check withInput.value.count == 6
+
+ DualResponse.clearProvider()
+
+ test "clearProvider resets both entries":
+ check DualResponse
+ .setProvider(
+ proc(): Future[Result[DualResponse, string]] {.async.} =
+ ok(DualResponse(note: "temp", count: 0))
+ )
+ .isOk()
+ DualResponse.clearProvider()
+
+ let res = waitFor DualResponse.request()
+ check res.isErr
+
+ test "implicit zero-argument provider works by default":
+ check ImplicitResponse
+ .setProvider(
+ proc(): Future[Result[ImplicitResponse, string]] {.async.} =
+ ok(ImplicitResponse(note: "auto"))
+ )
+ .isOk()
+
+ let res = waitFor ImplicitResponse.request()
+ check res.isOk
+
+ ImplicitResponse.clearProvider()
+ check res.value.note == "auto"
+
+ test "implicit zero-argument request errors when unset":
+ let res = waitFor ImplicitResponse.request()
+ check res.isErr
+ check res.error.contains("no zero-arg provider")
+
+ test "no provider override":
+ check DualResponse
+ .setProvider(
+ proc(): Future[Result[DualResponse, string]] {.async.} =
+ ok(DualResponse(note: "base", count: 1))
+ )
+ .isOk()
+
+ check DualResponse
+ .setProvider(
+ proc(suffix: string): Future[Result[DualResponse, string]] {.async.} =
+ ok(DualResponse(note: "base" & suffix, count: suffix.len))
+ )
+ .isOk()
+
+ let overrideProc = proc(): Future[Result[DualResponse, string]] {.async.} =
+ ok(DualResponse(note: "something else", count: 1))
+
+ check DualResponse.setProvider(overrideProc).isErr()
+
+ let noInput = waitFor DualResponse.request()
+ check noInput.isOk
+ check noInput.value.note == "base"
+
+ let stillResponse = waitFor DualResponse.request(" still works")
+ check stillResponse.isOk()
+ check stillResponse.value.note.contains("base still works")
+
+ DualResponse.clearProvider()
+
+ let noResponse = waitFor DualResponse.request()
+ check noResponse.isErr()
+ check noResponse.error.contains("no zero-arg provider")
+
+ let noResponseArg = waitFor DualResponse.request("Should not work")
+ check noResponseArg.isErr()
+ check noResponseArg.error.contains("no provider")
+
+ check DualResponse.setProvider(overrideProc).isOk()
+
+ let nowSuccWithOverride = waitFor DualResponse.request()
+ check nowSuccWithOverride.isOk
+ check nowSuccWithOverride.value.note == "something else"
+ check nowSuccWithOverride.value.count == 1
+
+ DualResponse.clearProvider()
diff --git a/waku/common/broker/event_broker.nim b/waku/common/broker/event_broker.nim
new file mode 100644
index 000000000..05d7b50ab
--- /dev/null
+++ b/waku/common/broker/event_broker.nim
@@ -0,0 +1,308 @@
+## EventBroker
+## -------------------
+## EventBroker represents a reactive decoupling pattern, that
+## allows event-driven development without
+## need for direct dependencies in between emitters and listeners.
+## Worth considering using it in a single or many emitters to many listeners scenario.
+##
+## Generates a standalone, type-safe event broker for the declared object type.
+## The macro exports the value type itself plus a broker companion that manages
+## listeners via thread-local storage.
+##
+## Usage:
+## Declare your desired event type inside an `EventBroker` macro, add any number of fields.:
+## ```nim
+## EventBroker:
+## type TypeName = object
+## field1*: FieldType
+## field2*: AnotherFieldType
+## ```
+##
+## After this, you can register async listeners anywhere in your code with
+## `TypeName.listen(...)`, which returns a handle to the registered listener.
+## Listeners are async procs or lambdas that take a single argument of the event type.
+## Any number of listeners can be registered in different modules.
+##
+## Events can be emitted from anywhere with no direct dependency on the listeners by
+## calling `TypeName.emit(...)` with an instance of the event type.
+## This will asynchronously notify all registered listeners with the emitted event.
+##
+## Whenever you no longer need a listener (or your object instance that listen to the event goes out of scope),
+## you can remove it from the broker with the handle returned by `listen`.
+## This is done by calling `TypeName.dropListener(handle)`.
+## Alternatively, you can remove all registered listeners through `TypeName.dropAllListeners()`.
+##
+##
+## Example:
+## ```nim
+## EventBroker:
+## type GreetingEvent = object
+## text*: string
+##
+## let handle = GreetingEvent.listen(
+## proc(evt: GreetingEvent): Future[void] {.async.} =
+## echo evt.text
+## )
+## GreetingEvent.emit(text= "hi")
+## GreetingEvent.dropListener(handle)
+## ```
+
+import std/[macros, tables]
+import chronos, chronicles, results
+import ./helper/broker_utils
+
+export chronicles, results, chronos
+
+macro EventBroker*(body: untyped): untyped =
+ when defined(eventBrokerDebug):
+ echo body.treeRepr
+ var typeIdent: NimNode = nil
+ var objectDef: NimNode = nil
+ var fieldNames: seq[NimNode] = @[]
+ var fieldTypes: seq[NimNode] = @[]
+ var isRefObject = false
+ for stmt in body:
+ if stmt.kind == nnkTypeSection:
+ for def in stmt:
+ if def.kind != nnkTypeDef:
+ continue
+ let rhs = def[2]
+ var objectType: NimNode
+ case rhs.kind
+ of nnkObjectTy:
+ objectType = rhs
+ of nnkRefTy:
+ isRefObject = true
+ if rhs.len != 1 or rhs[0].kind != nnkObjectTy:
+ error("EventBroker ref object must wrap a concrete object definition", rhs)
+ objectType = rhs[0]
+ else:
+ continue
+ if not typeIdent.isNil():
+ error("Only one object type may be declared inside EventBroker", def)
+ typeIdent = baseTypeIdent(def[0])
+ let recList = objectType[2]
+ if recList.kind != nnkRecList:
+ error("EventBroker object must declare a standard field list", objectType)
+ var exportedRecList = newTree(nnkRecList)
+ for field in recList:
+ case field.kind
+ of nnkIdentDefs:
+ ensureFieldDef(field)
+ let fieldTypeNode = field[field.len - 2]
+ for i in 0 ..< field.len - 2:
+ let baseFieldIdent = baseTypeIdent(field[i])
+ fieldNames.add(copyNimTree(baseFieldIdent))
+ fieldTypes.add(copyNimTree(fieldTypeNode))
+ var cloned = copyNimTree(field)
+ for i in 0 ..< cloned.len - 2:
+ cloned[i] = exportIdentNode(cloned[i])
+ exportedRecList.add(cloned)
+ of nnkEmpty:
+ discard
+ else:
+ error(
+ "EventBroker object definition only supports simple field declarations",
+ field,
+ )
+ let exportedObjectType = newTree(
+ nnkObjectTy,
+ copyNimTree(objectType[0]),
+ copyNimTree(objectType[1]),
+ exportedRecList,
+ )
+ if isRefObject:
+ objectDef = newTree(nnkRefTy, exportedObjectType)
+ else:
+ objectDef = exportedObjectType
+ if typeIdent.isNil():
+ error("EventBroker body must declare exactly one object type", body)
+
+ let exportedTypeIdent = postfix(copyNimTree(typeIdent), "*")
+ let sanitized = sanitizeIdentName(typeIdent)
+ let typeNameLit = newLit($typeIdent)
+ let isRefObjectLit = newLit(isRefObject)
+ let handlerProcIdent = ident(sanitized & "ListenerProc")
+ let listenerHandleIdent = ident(sanitized & "Listener")
+ let brokerTypeIdent = ident(sanitized & "Broker")
+ let exportedHandlerProcIdent = postfix(copyNimTree(handlerProcIdent), "*")
+ let exportedListenerHandleIdent = postfix(copyNimTree(listenerHandleIdent), "*")
+ let exportedBrokerTypeIdent = postfix(copyNimTree(brokerTypeIdent), "*")
+ let accessProcIdent = ident("access" & sanitized & "Broker")
+ let globalVarIdent = ident("g" & sanitized & "Broker")
+ let listenImplIdent = ident("register" & sanitized & "Listener")
+ let dropListenerImplIdent = ident("drop" & sanitized & "Listener")
+ let dropAllListenersImplIdent = ident("dropAll" & sanitized & "Listeners")
+ let emitImplIdent = ident("emit" & sanitized & "Value")
+ let listenerTaskIdent = ident("notify" & sanitized & "Listener")
+
+ result = newStmtList()
+
+ result.add(
+ quote do:
+ type
+ `exportedTypeIdent` = `objectDef`
+ `exportedListenerHandleIdent` = object
+ id*: uint64
+
+ `exportedHandlerProcIdent` =
+ proc(event: `typeIdent`): Future[void] {.async: (raises: []), gcsafe.}
+ `exportedBrokerTypeIdent` = ref object
+ listeners: Table[uint64, `handlerProcIdent`]
+ nextId: uint64
+
+ )
+
+ result.add(
+ quote do:
+ var `globalVarIdent` {.threadvar.}: `brokerTypeIdent`
+ )
+
+ result.add(
+ quote do:
+ proc `accessProcIdent`(): `brokerTypeIdent` =
+ if `globalVarIdent`.isNil():
+ new(`globalVarIdent`)
+ `globalVarIdent`.listeners = initTable[uint64, `handlerProcIdent`]()
+ `globalVarIdent`
+
+ )
+
+ result.add(
+ quote do:
+ proc `listenImplIdent`(
+ handler: `handlerProcIdent`
+ ): Result[`listenerHandleIdent`, string] =
+ if handler.isNil():
+ return err("Must provide a non-nil event handler")
+ var broker = `accessProcIdent`()
+ if broker.nextId == 0'u64:
+ broker.nextId = 1'u64
+ if broker.nextId == high(uint64):
+ error "Cannot add more listeners: ID space exhausted", nextId = $broker.nextId
+ return err("Cannot add more listeners, listener ID space exhausted")
+ let newId = broker.nextId
+ inc broker.nextId
+ broker.listeners[newId] = handler
+ return ok(`listenerHandleIdent`(id: newId))
+
+ )
+
+ result.add(
+ quote do:
+ proc `dropListenerImplIdent`(handle: `listenerHandleIdent`) =
+ if handle.id == 0'u64:
+ return
+ var broker = `accessProcIdent`()
+ if broker.listeners.len == 0:
+ return
+ broker.listeners.del(handle.id)
+
+ )
+
+ result.add(
+ quote do:
+ proc `dropAllListenersImplIdent`() =
+ var broker = `accessProcIdent`()
+ if broker.listeners.len > 0:
+ broker.listeners.clear()
+
+ )
+
+ result.add(
+ quote do:
+ proc listen*(
+ _: typedesc[`typeIdent`], handler: `handlerProcIdent`
+ ): Result[`listenerHandleIdent`, string] =
+ return `listenImplIdent`(handler)
+
+ )
+
+ result.add(
+ quote do:
+ proc dropListener*(_: typedesc[`typeIdent`], handle: `listenerHandleIdent`) =
+ `dropListenerImplIdent`(handle)
+
+ proc dropAllListeners*(_: typedesc[`typeIdent`]) =
+ `dropAllListenersImplIdent`()
+
+ )
+
+ result.add(
+ quote do:
+ proc `listenerTaskIdent`(
+ callback: `handlerProcIdent`, event: `typeIdent`
+ ) {.async: (raises: []), gcsafe.} =
+ if callback.isNil():
+ return
+ try:
+ await callback(event)
+ except Exception:
+ error "Failed to execute event listener", error = getCurrentExceptionMsg()
+
+ proc `emitImplIdent`(
+ event: `typeIdent`
+ ): Future[void] {.async: (raises: []), gcsafe.} =
+ when `isRefObjectLit`:
+ if event.isNil():
+ error "Cannot emit uninitialized event object", eventType = `typeNameLit`
+ return
+ let broker = `accessProcIdent`()
+ if broker.listeners.len == 0:
+ # nothing to do as nobody is listening
+ return
+ var callbacks: seq[`handlerProcIdent`] = @[]
+ for cb in broker.listeners.values:
+ callbacks.add(cb)
+ for cb in callbacks:
+ asyncSpawn `listenerTaskIdent`(cb, event)
+
+ proc emit*(event: `typeIdent`) =
+ asyncSpawn `emitImplIdent`(event)
+
+ proc emit*(_: typedesc[`typeIdent`], event: `typeIdent`) =
+ asyncSpawn `emitImplIdent`(event)
+
+ )
+
+ var emitCtorParams = newTree(nnkFormalParams, newEmptyNode())
+ let typedescParamType =
+ newTree(nnkBracketExpr, ident("typedesc"), copyNimTree(typeIdent))
+ emitCtorParams.add(
+ newTree(nnkIdentDefs, ident("_"), typedescParamType, newEmptyNode())
+ )
+ for i in 0 ..< fieldNames.len:
+ emitCtorParams.add(
+ newTree(
+ nnkIdentDefs,
+ copyNimTree(fieldNames[i]),
+ copyNimTree(fieldTypes[i]),
+ newEmptyNode(),
+ )
+ )
+
+ var emitCtorExpr = newTree(nnkObjConstr, copyNimTree(typeIdent))
+ for i in 0 ..< fieldNames.len:
+ emitCtorExpr.add(
+ newTree(nnkExprColonExpr, copyNimTree(fieldNames[i]), copyNimTree(fieldNames[i]))
+ )
+
+ let emitCtorCall = newCall(copyNimTree(emitImplIdent), emitCtorExpr)
+ let emitCtorBody = quote:
+ asyncSpawn `emitCtorCall`
+
+ let typedescEmitProc = newTree(
+ nnkProcDef,
+ postfix(ident("emit"), "*"),
+ newEmptyNode(),
+ newEmptyNode(),
+ emitCtorParams,
+ newEmptyNode(),
+ newEmptyNode(),
+ emitCtorBody,
+ )
+
+ result.add(typedescEmitProc)
+
+ when defined(eventBrokerDebug):
+ echo result.repr
diff --git a/waku/common/broker/helper/broker_utils.nim b/waku/common/broker/helper/broker_utils.nim
new file mode 100644
index 000000000..ea9f85750
--- /dev/null
+++ b/waku/common/broker/helper/broker_utils.nim
@@ -0,0 +1,43 @@
+import std/macros
+
+proc sanitizeIdentName*(node: NimNode): string =
+ var raw = $node
+ var sanitizedName = newStringOfCap(raw.len)
+ for ch in raw:
+ case ch
+ of 'A' .. 'Z', 'a' .. 'z', '0' .. '9', '_':
+ sanitizedName.add(ch)
+ else:
+ sanitizedName.add('_')
+ sanitizedName
+
+proc ensureFieldDef*(node: NimNode) =
+ if node.kind != nnkIdentDefs or node.len < 3:
+ error("Expected field definition of the form `name: Type`", node)
+ let typeSlot = node.len - 2
+ if node[typeSlot].kind == nnkEmpty:
+ error("Field `" & $node[0] & "` must declare a type", node)
+
+proc exportIdentNode*(node: NimNode): NimNode =
+ case node.kind
+ of nnkIdent:
+ postfix(copyNimTree(node), "*")
+ of nnkPostfix:
+ node
+ else:
+ error("Unsupported identifier form in field definition", node)
+
+proc baseTypeIdent*(defName: NimNode): NimNode =
+ case defName.kind
+ of nnkIdent:
+ defName
+ of nnkAccQuoted:
+ if defName.len != 1:
+ error("Unsupported quoted identifier", defName)
+ defName[0]
+ of nnkPostfix:
+ baseTypeIdent(defName[1])
+ of nnkPragmaExpr:
+ baseTypeIdent(defName[0])
+ else:
+ error("Unsupported type name in broker definition", defName)
diff --git a/waku/common/broker/multi_request_broker.nim b/waku/common/broker/multi_request_broker.nim
new file mode 100644
index 000000000..7f4161f5a
--- /dev/null
+++ b/waku/common/broker/multi_request_broker.nim
@@ -0,0 +1,583 @@
+## MultiRequestBroker
+## --------------------
+## MultiRequestBroker represents a proactive decoupling pattern, that
+## allows defining request-response style interactions between modules without
+## need for direct dependencies in between.
+## Worth considering using it for use cases where you need to collect data from multiple providers.
+##
+## Provides a declarative way to define an immutable value type together with a
+## thread-local broker that can register multiple asynchronous providers, dispatch
+## typed requests, and clear handlers. Unlike `RequestBroker`,
+## every call to `request` fan-outs to every registered provider and returns with
+## collected responses.
+## Request succeeds if all providers succeed, otherwise fails with an error.
+##
+## Usage:
+##
+## Declare collectable request data type inside a `MultiRequestBroker` macro, add any number of fields:
+## ```nim
+## MultiRequestBroker:
+## type TypeName = object
+## field1*: Type1
+## field2*: Type2
+##
+## ## Define the request and provider signature, that is enforced at compile time.
+## proc signature*(): Future[Result[TypeName, string]] {.async: (raises: []).}
+##
+## ## Also possible to define signature with arbitrary input arguments.
+## proc signature*(arg1: ArgType, arg2: AnotherArgType): Future[Result[TypeName, string]] {.async: (raises: []).}
+##
+## ```
+##
+## You regiser request processor (proveder) at any place of the code without the need to know of who ever may request.
+## Respectively to the defined signatures register provider functions with `TypeName.setProvider(...)`.
+## Providers are async procs or lambdas that return with a Future[Result[seq[TypeName], string]].
+## Notice MultiRequestBroker's `setProvider` return with a handler that can be used to remove the provider later (or error).
+
+## Requests can be made from anywhere with no direct dependency on the provider(s) by
+## calling `TypeName.request()` - with arguments respecting the signature(s).
+## This will asynchronously call the registered provider and return the collected data, in form of `Future[Result[seq[TypeName], string]]`.
+##
+## Whenever you don't want to process requests anymore (or your object instance that provides the request goes out of scope),
+## you can remove it from the broker with `TypeName.removeProvider(handle)`.
+## Alternatively, you can remove all registered providers through `TypeName.clearProviders()`.
+##
+## Example:
+## ```nim
+## MultiRequestBroker:
+## type Greeting = object
+## text*: string
+##
+## ## Define the request and provider signature, that is enforced at compile time.
+## proc signature*(): Future[Result[Greeting, string]] {.async: (raises: []).}
+##
+## ## Also possible to define signature with arbitrary input arguments.
+## proc signature*(lang: string): Future[Result[Greeting, string]] {.async: (raises: []).}
+##
+## ...
+## let handle = Greeting.setProvider(
+## proc(): Future[Result[Greeting, string]] {.async: (raises: []).} =
+## ok(Greeting(text: "hello"))
+## )
+##
+## let anotherHandle = Greeting.setProvider(
+## proc(): Future[Result[Greeting, string]] {.async: (raises: []).} =
+## ok(Greeting(text: "szia"))
+## )
+##
+## let responses = (await Greeting.request()).valueOr(@[Greeting(text: "default")])
+##
+## echo responses.len
+## Greeting.clearProviders()
+## ```
+## If no `signature` proc is declared, a zero-argument form is generated
+## automatically, so the caller only needs to provide the type definition.
+
+import std/[macros, strutils, tables, sugar]
+import chronos
+import results
+import ./helper/broker_utils
+
+export results, chronos
+
+proc isReturnTypeValid(returnType, typeIdent: NimNode): bool =
+ ## Accept Future[Result[TypeIdent, string]] as the contract.
+ if returnType.kind != nnkBracketExpr or returnType.len != 2:
+ return false
+ if returnType[0].kind != nnkIdent or not returnType[0].eqIdent("Future"):
+ return false
+ let inner = returnType[1]
+ if inner.kind != nnkBracketExpr or inner.len != 3:
+ return false
+ if inner[0].kind != nnkIdent or not inner[0].eqIdent("Result"):
+ return false
+ if inner[1].kind != nnkIdent or not inner[1].eqIdent($typeIdent):
+ return false
+ inner[2].kind == nnkIdent and inner[2].eqIdent("string")
+
+proc cloneParams(params: seq[NimNode]): seq[NimNode] =
+ ## Deep copy parameter definitions so they can be reused in generated nodes.
+ result = @[]
+ for param in params:
+ result.add(copyNimTree(param))
+
+proc collectParamNames(params: seq[NimNode]): seq[NimNode] =
+ ## Extract identifiers declared in parameter definitions.
+ result = @[]
+ for param in params:
+ assert param.kind == nnkIdentDefs
+ for i in 0 ..< param.len - 2:
+ let nameNode = param[i]
+ if nameNode.kind == nnkEmpty:
+ continue
+ result.add(ident($nameNode))
+
+proc makeProcType(returnType: NimNode, params: seq[NimNode]): NimNode =
+ var formal = newTree(nnkFormalParams)
+ formal.add(returnType)
+ for param in params:
+ formal.add(param)
+
+ let pragmas = quote:
+ {.async.}
+
+ newTree(nnkProcTy, formal, pragmas)
+
+macro MultiRequestBroker*(body: untyped): untyped =
+ when defined(requestBrokerDebug):
+ echo body.treeRepr
+ var typeIdent: NimNode = nil
+ var objectDef: NimNode = nil
+ var isRefObject = false
+ for stmt in body:
+ if stmt.kind == nnkTypeSection:
+ for def in stmt:
+ if def.kind != nnkTypeDef:
+ continue
+ let rhs = def[2]
+ var objectType: NimNode
+ case rhs.kind
+ of nnkObjectTy:
+ objectType = rhs
+ of nnkRefTy:
+ isRefObject = true
+ if rhs.len != 1 or rhs[0].kind != nnkObjectTy:
+ error(
+ "MultiRequestBroker ref object must wrap a concrete object definition",
+ rhs,
+ )
+ objectType = rhs[0]
+ else:
+ continue
+ if not typeIdent.isNil():
+ error("Only one object type may be declared inside MultiRequestBroker", def)
+ typeIdent = baseTypeIdent(def[0])
+ let recList = objectType[2]
+ if recList.kind != nnkRecList:
+ error(
+ "MultiRequestBroker object must declare a standard field list", objectType
+ )
+ var exportedRecList = newTree(nnkRecList)
+ for field in recList:
+ case field.kind
+ of nnkIdentDefs:
+ ensureFieldDef(field)
+ var cloned = copyNimTree(field)
+ for i in 0 ..< cloned.len - 2:
+ cloned[i] = exportIdentNode(cloned[i])
+ exportedRecList.add(cloned)
+ of nnkEmpty:
+ discard
+ else:
+ error(
+ "MultiRequestBroker object definition only supports simple field declarations",
+ field,
+ )
+ let exportedObjectType = newTree(
+ nnkObjectTy,
+ copyNimTree(objectType[0]),
+ copyNimTree(objectType[1]),
+ exportedRecList,
+ )
+ if isRefObject:
+ objectDef = newTree(nnkRefTy, exportedObjectType)
+ else:
+ objectDef = exportedObjectType
+ if typeIdent.isNil():
+ error("MultiRequestBroker body must declare exactly one object type", body)
+
+ when defined(requestBrokerDebug):
+ echo "MultiRequestBroker generating type: ", $typeIdent
+
+ let exportedTypeIdent = postfix(copyNimTree(typeIdent), "*")
+ let sanitized = sanitizeIdentName(typeIdent)
+ let typeNameLit = newLit($typeIdent)
+ let isRefObjectLit = newLit(isRefObject)
+ let tableSym = bindSym"Table"
+ let initTableSym = bindSym"initTable"
+ let uint64Ident = ident("uint64")
+ let providerKindIdent = ident(sanitized & "ProviderKind")
+ let providerHandleIdent = ident(sanitized & "ProviderHandle")
+ let exportedProviderHandleIdent = postfix(copyNimTree(providerHandleIdent), "*")
+ let zeroKindIdent = ident("pk" & sanitized & "NoArgs")
+ let argKindIdent = ident("pk" & sanitized & "WithArgs")
+ var zeroArgSig: NimNode = nil
+ var zeroArgProviderName: NimNode = nil
+ var zeroArgFieldName: NimNode = nil
+ var argSig: NimNode = nil
+ var argParams: seq[NimNode] = @[]
+ var argProviderName: NimNode = nil
+ var argFieldName: NimNode = nil
+
+ for stmt in body:
+ case stmt.kind
+ of nnkProcDef:
+ let procName = stmt[0]
+ let procNameIdent =
+ case procName.kind
+ of nnkIdent:
+ procName
+ of nnkPostfix:
+ procName[1]
+ else:
+ procName
+ let procNameStr = $procNameIdent
+ if not procNameStr.startsWith("signature"):
+ error("Signature proc names must start with `signature`", procName)
+ let params = stmt.params
+ if params.len == 0:
+ error("Signature must declare a return type", stmt)
+ let returnType = params[0]
+ if not isReturnTypeValid(returnType, typeIdent):
+ error(
+ "Signature must return Future[Result[`" & $typeIdent & "`, string]]", stmt
+ )
+ let paramCount = params.len - 1
+ if paramCount == 0:
+ if zeroArgSig != nil:
+ error("Only one zero-argument signature is allowed", stmt)
+ zeroArgSig = stmt
+ zeroArgProviderName = ident(sanitizeIdentName(typeIdent) & "ProviderNoArgs")
+ zeroArgFieldName = ident("providerNoArgs")
+ elif paramCount >= 1:
+ if argSig != nil:
+ error("Only one argument-based signature is allowed", stmt)
+ argSig = stmt
+ argParams = @[]
+ for idx in 1 ..< params.len:
+ let paramDef = params[idx]
+ if paramDef.kind != nnkIdentDefs:
+ error(
+ "Signature parameter must be a standard identifier declaration", paramDef
+ )
+ let paramTypeNode = paramDef[paramDef.len - 2]
+ if paramTypeNode.kind == nnkEmpty:
+ error("Signature parameter must declare a type", paramDef)
+ var hasName = false
+ for i in 0 ..< paramDef.len - 2:
+ if paramDef[i].kind != nnkEmpty:
+ hasName = true
+ if not hasName:
+ error("Signature parameter must declare a name", paramDef)
+ argParams.add(copyNimTree(paramDef))
+ argProviderName = ident(sanitizeIdentName(typeIdent) & "ProviderWithArgs")
+ argFieldName = ident("providerWithArgs")
+ of nnkTypeSection, nnkEmpty:
+ discard
+ else:
+ error("Unsupported statement inside MultiRequestBroker definition", stmt)
+
+ if zeroArgSig.isNil() and argSig.isNil():
+ zeroArgSig = newEmptyNode()
+ zeroArgProviderName = ident(sanitizeIdentName(typeIdent) & "ProviderNoArgs")
+ zeroArgFieldName = ident("providerNoArgs")
+
+ var typeSection = newTree(nnkTypeSection)
+ typeSection.add(newTree(nnkTypeDef, exportedTypeIdent, newEmptyNode(), objectDef))
+
+ var kindEnum = newTree(nnkEnumTy, newEmptyNode())
+ if not zeroArgSig.isNil():
+ kindEnum.add(zeroKindIdent)
+ if not argSig.isNil():
+ kindEnum.add(argKindIdent)
+ typeSection.add(newTree(nnkTypeDef, providerKindIdent, newEmptyNode(), kindEnum))
+
+ var handleRecList = newTree(nnkRecList)
+ handleRecList.add(newTree(nnkIdentDefs, ident("id"), uint64Ident, newEmptyNode()))
+ handleRecList.add(
+ newTree(nnkIdentDefs, ident("kind"), providerKindIdent, newEmptyNode())
+ )
+ typeSection.add(
+ newTree(
+ nnkTypeDef,
+ exportedProviderHandleIdent,
+ newEmptyNode(),
+ newTree(nnkObjectTy, newEmptyNode(), newEmptyNode(), handleRecList),
+ )
+ )
+
+ let returnType = quote:
+ Future[Result[`typeIdent`, string]]
+
+ if not zeroArgSig.isNil():
+ let procType = makeProcType(returnType, @[])
+ typeSection.add(newTree(nnkTypeDef, zeroArgProviderName, newEmptyNode(), procType))
+ if not argSig.isNil():
+ let procType = makeProcType(returnType, cloneParams(argParams))
+ typeSection.add(newTree(nnkTypeDef, argProviderName, newEmptyNode(), procType))
+
+ var brokerRecList = newTree(nnkRecList)
+ if not zeroArgSig.isNil():
+ brokerRecList.add(
+ newTree(
+ nnkIdentDefs,
+ zeroArgFieldName,
+ newTree(nnkBracketExpr, tableSym, uint64Ident, zeroArgProviderName),
+ newEmptyNode(),
+ )
+ )
+ if not argSig.isNil():
+ brokerRecList.add(
+ newTree(
+ nnkIdentDefs,
+ argFieldName,
+ newTree(nnkBracketExpr, tableSym, uint64Ident, argProviderName),
+ newEmptyNode(),
+ )
+ )
+ brokerRecList.add(newTree(nnkIdentDefs, ident("nextId"), uint64Ident, newEmptyNode()))
+ let brokerTypeIdent = ident(sanitizeIdentName(typeIdent) & "Broker")
+ let brokerTypeDef = newTree(
+ nnkTypeDef,
+ brokerTypeIdent,
+ newEmptyNode(),
+ newTree(
+ nnkRefTy, newTree(nnkObjectTy, newEmptyNode(), newEmptyNode(), brokerRecList)
+ ),
+ )
+ typeSection.add(brokerTypeDef)
+ result = newStmtList()
+ result.add(typeSection)
+
+ let globalVarIdent = ident("g" & sanitizeIdentName(typeIdent) & "Broker")
+ let accessProcIdent = ident("access" & sanitizeIdentName(typeIdent) & "Broker")
+ var initStatements = newStmtList()
+ if not zeroArgSig.isNil():
+ initStatements.add(
+ quote do:
+ `globalVarIdent`.`zeroArgFieldName` =
+ `initTableSym`[`uint64Ident`, `zeroArgProviderName`]()
+ )
+ if not argSig.isNil():
+ initStatements.add(
+ quote do:
+ `globalVarIdent`.`argFieldName` =
+ `initTableSym`[`uint64Ident`, `argProviderName`]()
+ )
+ result.add(
+ quote do:
+ var `globalVarIdent` {.threadvar.}: `brokerTypeIdent`
+
+ proc `accessProcIdent`(): `brokerTypeIdent` =
+ if `globalVarIdent`.isNil():
+ new(`globalVarIdent`)
+ `globalVarIdent`.nextId = 1'u64
+ `initStatements`
+ return `globalVarIdent`
+
+ )
+
+ var clearBody = newStmtList()
+ if not zeroArgSig.isNil():
+ result.add(
+ quote do:
+ proc setProvider*(
+ _: typedesc[`typeIdent`], handler: `zeroArgProviderName`
+ ): Result[`providerHandleIdent`, string] =
+ if handler.isNil():
+ return err("Provider handler must be provided")
+ let broker = `accessProcIdent`()
+ if broker.nextId == 0'u64:
+ broker.nextId = 1'u64
+ for existingId, existing in broker.`zeroArgFieldName`.pairs:
+ if existing == handler:
+ return ok(`providerHandleIdent`(id: existingId, kind: `zeroKindIdent`))
+ let newId = broker.nextId
+ inc broker.nextId
+ broker.`zeroArgFieldName`[newId] = handler
+ return ok(`providerHandleIdent`(id: newId, kind: `zeroKindIdent`))
+
+ )
+ clearBody.add(
+ quote do:
+ let broker = `accessProcIdent`()
+ if not broker.isNil() and broker.`zeroArgFieldName`.len > 0:
+ broker.`zeroArgFieldName`.clear()
+ )
+ result.add(
+ quote do:
+ proc request*(
+ _: typedesc[`typeIdent`]
+ ): Future[Result[seq[`typeIdent`], string]] {.async: (raises: []), gcsafe.} =
+ var aggregated: seq[`typeIdent`] = @[]
+ let providers = `accessProcIdent`().`zeroArgFieldName`
+ if providers.len == 0:
+ return ok(aggregated)
+ # var providersFut: seq[Future[Result[`typeIdent`, string]]] = collect:
+ var providersFut = collect(newSeq):
+ for provider in providers.values:
+ if provider.isNil():
+ continue
+ provider()
+
+ let catchable = catch:
+ await allFinished(providersFut)
+
+ catchable.isOkOr:
+ return err("Some provider(s) failed:" & error.msg)
+
+ for fut in catchable.get():
+ if fut.failed():
+ return err("Some provider(s) failed:" & fut.error.msg)
+ elif fut.finished():
+ let providerResult = fut.value()
+ if providerResult.isOk:
+ let providerValue = providerResult.get()
+ when `isRefObjectLit`:
+ if providerValue.isNil():
+ return err(
+ "MultiRequestBroker(" & `typeNameLit` &
+ "): provider returned nil result"
+ )
+ aggregated.add(providerValue)
+ else:
+ return err("Some provider(s) failed:" & providerResult.error)
+
+ return ok(aggregated)
+
+ )
+ if not argSig.isNil():
+ result.add(
+ quote do:
+ proc setProvider*(
+ _: typedesc[`typeIdent`], handler: `argProviderName`
+ ): Result[`providerHandleIdent`, string] =
+ if handler.isNil():
+ return err("Provider handler must be provided")
+ let broker = `accessProcIdent`()
+ if broker.nextId == 0'u64:
+ broker.nextId = 1'u64
+ for existingId, existing in broker.`argFieldName`.pairs:
+ if existing == handler:
+ return ok(`providerHandleIdent`(id: existingId, kind: `argKindIdent`))
+ let newId = broker.nextId
+ inc broker.nextId
+ broker.`argFieldName`[newId] = handler
+ return ok(`providerHandleIdent`(id: newId, kind: `argKindIdent`))
+
+ )
+ clearBody.add(
+ quote do:
+ let broker = `accessProcIdent`()
+ if not broker.isNil() and broker.`argFieldName`.len > 0:
+ broker.`argFieldName`.clear()
+ )
+ let requestParamDefs = cloneParams(argParams)
+ let argNameIdents = collectParamNames(requestParamDefs)
+ let providerSym = genSym(nskLet, "providerVal")
+ var providerCall = newCall(providerSym)
+ for argName in argNameIdents:
+ providerCall.add(argName)
+ var formalParams = newTree(nnkFormalParams)
+ formalParams.add(
+ quote do:
+ Future[Result[seq[`typeIdent`], string]]
+ )
+ formalParams.add(
+ newTree(
+ nnkIdentDefs,
+ ident("_"),
+ newTree(nnkBracketExpr, ident("typedesc"), copyNimTree(typeIdent)),
+ newEmptyNode(),
+ )
+ )
+ for paramDef in requestParamDefs:
+ formalParams.add(paramDef)
+ let requestPragmas = quote:
+ {.async: (raises: []), gcsafe.}
+ let requestBody = quote:
+ var aggregated: seq[`typeIdent`] = @[]
+ let providers = `accessProcIdent`().`argFieldName`
+ if providers.len == 0:
+ return ok(aggregated)
+ var providersFut = collect(newSeq):
+ for provider in providers.values:
+ if provider.isNil():
+ continue
+ let `providerSym` = provider
+ `providerCall`
+ let catchable = catch:
+ await allFinished(providersFut)
+ catchable.isOkOr:
+ return err("Some provider(s) failed:" & error.msg)
+ for fut in catchable.get():
+ if fut.failed():
+ return err("Some provider(s) failed:" & fut.error.msg)
+ elif fut.finished():
+ let providerResult = fut.value()
+ if providerResult.isOk:
+ let providerValue = providerResult.get()
+ when `isRefObjectLit`:
+ if providerValue.isNil():
+ return err(
+ "MultiRequestBroker(" & `typeNameLit` &
+ "): provider returned nil result"
+ )
+ aggregated.add(providerValue)
+ else:
+ return err("Some provider(s) failed:" & providerResult.error)
+ return ok(aggregated)
+
+ result.add(
+ newTree(
+ nnkProcDef,
+ postfix(ident("request"), "*"),
+ newEmptyNode(),
+ newEmptyNode(),
+ formalParams,
+ requestPragmas,
+ newEmptyNode(),
+ requestBody,
+ )
+ )
+
+ result.add(
+ quote do:
+ proc clearProviders*(_: typedesc[`typeIdent`]) =
+ `clearBody`
+ let broker = `accessProcIdent`()
+ if not broker.isNil():
+ broker.nextId = 1'u64
+
+ )
+
+ let removeHandleSym = genSym(nskParam, "handle")
+ let removeBrokerSym = genSym(nskLet, "broker")
+ var removeBody = newStmtList()
+ removeBody.add(
+ quote do:
+ if `removeHandleSym`.id == 0'u64:
+ return
+ let `removeBrokerSym` = `accessProcIdent`()
+ if `removeBrokerSym`.isNil():
+ return
+ )
+ if not zeroArgSig.isNil():
+ removeBody.add(
+ quote do:
+ if `removeHandleSym`.kind == `zeroKindIdent`:
+ `removeBrokerSym`.`zeroArgFieldName`.del(`removeHandleSym`.id)
+ return
+ )
+ if not argSig.isNil():
+ removeBody.add(
+ quote do:
+ if `removeHandleSym`.kind == `argKindIdent`:
+ `removeBrokerSym`.`argFieldName`.del(`removeHandleSym`.id)
+ return
+ )
+ removeBody.add(
+ quote do:
+ discard
+ )
+ result.add(
+ quote do:
+ proc removeProvider*(
+ _: typedesc[`typeIdent`], `removeHandleSym`: `providerHandleIdent`
+ ) =
+ `removeBody`
+
+ )
+
+ when defined(requestBrokerDebug):
+ echo result.repr
diff --git a/waku/common/broker/request_broker.nim b/waku/common/broker/request_broker.nim
new file mode 100644
index 000000000..a8a6651d7
--- /dev/null
+++ b/waku/common/broker/request_broker.nim
@@ -0,0 +1,438 @@
+## RequestBroker
+## --------------------
+## RequestBroker represents a proactive decoupling pattern, that
+## allows defining request-response style interactions between modules without
+## need for direct dependencies in between.
+## Worth considering using it in a single provider, many requester scenario.
+##
+## Provides a declarative way to define an immutable value type together with a
+## thread-local broker that can register an asynchronous provider, dispatch typed
+## requests and clear provider.
+##
+## Usage:
+## Declare your desired request type inside a `RequestBroker` macro, add any number of fields.
+## Define the provider signature, that is enforced at compile time.
+##
+## ```nim
+## RequestBroker:
+## type TypeName = object
+## field1*: FieldType
+## field2*: AnotherFieldType
+##
+## proc signature*(): Future[Result[TypeName, string]]
+## ## Also possible to define signature with arbitrary input arguments.
+## proc signature*(arg1: ArgType, arg2: AnotherArgType): Future[Result[TypeName, string]]
+##
+## ```
+## The 'TypeName' object defines the requestable data (but also can be seen as request for action with return value).
+## The 'signature' proc defines the provider(s) signature, that is enforced at compile time.
+## One signature can be with no arguments, another with any number of arguments - where the input arguments are
+## not related to the request type - but alternative inputs for the request to be processed.
+##
+## After this, you can register a provider anywhere in your code with
+## `TypeName.setProvider(...)`, which returns error if already having a provider.
+## Providers are async procs or lambdas that take no arguments and return a Future[Result[TypeName, string]].
+## Only one provider can be registered at a time per signature type (zero arg and/or multi arg).
+##
+## Requests can be made from anywhere with no direct dependency on the provider by
+## calling `TypeName.request()` - with arguments respecting the signature(s).
+## This will asynchronously call the registered provider and return a Future[Result[TypeName, string]].
+##
+## Whenever you no want to process requests (or your object instance that provides the request goes out of scope),
+## you can remove it from the broker with `TypeName.clearProvider()`.
+##
+##
+## Example:
+## ```nim
+## RequestBroker:
+## type Greeting = object
+## text*: string
+##
+## ## Define the request and provider signature, that is enforced at compile time.
+## proc signature*(): Future[Result[Greeting, string]]
+##
+## ## Also possible to define signature with arbitrary input arguments.
+## proc signature*(lang: string): Future[Result[Greeting, string]]
+##
+## ...
+## Greeting.setProvider(
+## proc(): Future[Result[Greeting, string]] {.async.} =
+## ok(Greeting(text: "hello"))
+## )
+## let res = await Greeting.request()
+## ```
+## If no `signature` proc is declared, a zero-argument form is generated
+## automatically, so the caller only needs to provide the type definition.
+
+import std/[macros, strutils]
+import chronos
+import results
+import ./helper/broker_utils
+
+export results, chronos
+
+proc errorFuture[T](message: string): Future[Result[T, string]] {.inline.} =
+ ## Build a future that is already completed with an error result.
+ let fut = newFuture[Result[T, string]]("request_broker.errorFuture")
+ fut.complete(err(Result[T, string], message))
+ fut
+
+proc isReturnTypeValid(returnType, typeIdent: NimNode): bool =
+ ## Accept Future[Result[TypeIdent, string]] as the contract.
+ if returnType.kind != nnkBracketExpr or returnType.len != 2:
+ return false
+ if returnType[0].kind != nnkIdent or not returnType[0].eqIdent("Future"):
+ return false
+ let inner = returnType[1]
+ if inner.kind != nnkBracketExpr or inner.len != 3:
+ return false
+ if inner[0].kind != nnkIdent or not inner[0].eqIdent("Result"):
+ return false
+ if inner[1].kind != nnkIdent or not inner[1].eqIdent($typeIdent):
+ return false
+ inner[2].kind == nnkIdent and inner[2].eqIdent("string")
+
+proc cloneParams(params: seq[NimNode]): seq[NimNode] =
+ ## Deep copy parameter definitions so they can be inserted in multiple places.
+ result = @[]
+ for param in params:
+ result.add(copyNimTree(param))
+
+proc collectParamNames(params: seq[NimNode]): seq[NimNode] =
+ ## Extract all identifier symbols declared across IdentDefs nodes.
+ result = @[]
+ for param in params:
+ assert param.kind == nnkIdentDefs
+ for i in 0 ..< param.len - 2:
+ let nameNode = param[i]
+ if nameNode.kind == nnkEmpty:
+ continue
+ result.add(ident($nameNode))
+
+proc makeProcType(returnType: NimNode, params: seq[NimNode]): NimNode =
+ var formal = newTree(nnkFormalParams)
+ formal.add(returnType)
+ for param in params:
+ formal.add(param)
+ let pragmas = newTree(nnkPragma, ident("async"))
+ newTree(nnkProcTy, formal, pragmas)
+
+macro RequestBroker*(body: untyped): untyped =
+ when defined(requestBrokerDebug):
+ echo body.treeRepr
+ var typeIdent: NimNode = nil
+ var objectDef: NimNode = nil
+ var isRefObject = false
+ for stmt in body:
+ if stmt.kind == nnkTypeSection:
+ for def in stmt:
+ if def.kind != nnkTypeDef:
+ continue
+ let rhs = def[2]
+ var objectType: NimNode
+ case rhs.kind
+ of nnkObjectTy:
+ objectType = rhs
+ of nnkRefTy:
+ isRefObject = true
+ if rhs.len != 1 or rhs[0].kind != nnkObjectTy:
+ error(
+ "RequestBroker ref object must wrap a concrete object definition", rhs
+ )
+ objectType = rhs[0]
+ else:
+ continue
+ if not typeIdent.isNil():
+ error("Only one object type may be declared inside RequestBroker", def)
+ typeIdent = baseTypeIdent(def[0])
+ let recList = objectType[2]
+ if recList.kind != nnkRecList:
+ error("RequestBroker object must declare a standard field list", objectType)
+ var exportedRecList = newTree(nnkRecList)
+ for field in recList:
+ case field.kind
+ of nnkIdentDefs:
+ ensureFieldDef(field)
+ var cloned = copyNimTree(field)
+ for i in 0 ..< cloned.len - 2:
+ cloned[i] = exportIdentNode(cloned[i])
+ exportedRecList.add(cloned)
+ of nnkEmpty:
+ discard
+ else:
+ error(
+ "RequestBroker object definition only supports simple field declarations",
+ field,
+ )
+ let exportedObjectType = newTree(
+ nnkObjectTy,
+ copyNimTree(objectType[0]),
+ copyNimTree(objectType[1]),
+ exportedRecList,
+ )
+ if isRefObject:
+ objectDef = newTree(nnkRefTy, exportedObjectType)
+ else:
+ objectDef = exportedObjectType
+ if typeIdent.isNil():
+ error("RequestBroker body must declare exactly one object type", body)
+
+ when defined(requestBrokerDebug):
+ echo "RequestBroker generating type: ", $typeIdent
+
+ let exportedTypeIdent = postfix(copyNimTree(typeIdent), "*")
+ let typeDisplayName = sanitizeIdentName(typeIdent)
+ let typeNameLit = newLit(typeDisplayName)
+ let isRefObjectLit = newLit(isRefObject)
+ var zeroArgSig: NimNode = nil
+ var zeroArgProviderName: NimNode = nil
+ var zeroArgFieldName: NimNode = nil
+ var argSig: NimNode = nil
+ var argParams: seq[NimNode] = @[]
+ var argProviderName: NimNode = nil
+ var argFieldName: NimNode = nil
+
+ for stmt in body:
+ case stmt.kind
+ of nnkProcDef:
+ let procName = stmt[0]
+ let procNameIdent =
+ case procName.kind
+ of nnkIdent:
+ procName
+ of nnkPostfix:
+ procName[1]
+ else:
+ procName
+ let procNameStr = $procNameIdent
+ if not procNameStr.startsWith("signature"):
+ error("Signature proc names must start with `signature`", procName)
+ let params = stmt.params
+ if params.len == 0:
+ error("Signature must declare a return type", stmt)
+ let returnType = params[0]
+ if not isReturnTypeValid(returnType, typeIdent):
+ error(
+ "Signature must return Future[Result[`" & $typeIdent & "`, string]]", stmt
+ )
+ let paramCount = params.len - 1
+ if paramCount == 0:
+ if zeroArgSig != nil:
+ error("Only one zero-argument signature is allowed", stmt)
+ zeroArgSig = stmt
+ zeroArgProviderName = ident(sanitizeIdentName(typeIdent) & "ProviderNoArgs")
+ zeroArgFieldName = ident("providerNoArgs")
+ elif paramCount >= 1:
+ if argSig != nil:
+ error("Only one argument-based signature is allowed", stmt)
+ argSig = stmt
+ argParams = @[]
+ for idx in 1 ..< params.len:
+ let paramDef = params[idx]
+ if paramDef.kind != nnkIdentDefs:
+ error(
+ "Signature parameter must be a standard identifier declaration", paramDef
+ )
+ let paramTypeNode = paramDef[paramDef.len - 2]
+ if paramTypeNode.kind == nnkEmpty:
+ error("Signature parameter must declare a type", paramDef)
+ var hasName = false
+ for i in 0 ..< paramDef.len - 2:
+ if paramDef[i].kind != nnkEmpty:
+ hasName = true
+ if not hasName:
+ error("Signature parameter must declare a name", paramDef)
+ argParams.add(copyNimTree(paramDef))
+ argProviderName = ident(sanitizeIdentName(typeIdent) & "ProviderWithArgs")
+ argFieldName = ident("providerWithArgs")
+ of nnkTypeSection, nnkEmpty:
+ discard
+ else:
+ error("Unsupported statement inside RequestBroker definition", stmt)
+
+ if zeroArgSig.isNil() and argSig.isNil():
+ zeroArgSig = newEmptyNode()
+ zeroArgProviderName = ident(sanitizeIdentName(typeIdent) & "ProviderNoArgs")
+ zeroArgFieldName = ident("providerNoArgs")
+
+ var typeSection = newTree(nnkTypeSection)
+ typeSection.add(newTree(nnkTypeDef, exportedTypeIdent, newEmptyNode(), objectDef))
+
+ let returnType = quote:
+ Future[Result[`typeIdent`, string]]
+
+ if not zeroArgSig.isNil():
+ let procType = makeProcType(returnType, @[])
+ typeSection.add(newTree(nnkTypeDef, zeroArgProviderName, newEmptyNode(), procType))
+ if not argSig.isNil():
+ let procType = makeProcType(returnType, cloneParams(argParams))
+ typeSection.add(newTree(nnkTypeDef, argProviderName, newEmptyNode(), procType))
+
+ var brokerRecList = newTree(nnkRecList)
+ if not zeroArgSig.isNil():
+ brokerRecList.add(
+ newTree(nnkIdentDefs, zeroArgFieldName, zeroArgProviderName, newEmptyNode())
+ )
+ if not argSig.isNil():
+ brokerRecList.add(
+ newTree(nnkIdentDefs, argFieldName, argProviderName, newEmptyNode())
+ )
+ let brokerTypeIdent = ident(sanitizeIdentName(typeIdent) & "Broker")
+ let brokerTypeDef = newTree(
+ nnkTypeDef,
+ brokerTypeIdent,
+ newEmptyNode(),
+ newTree(nnkObjectTy, newEmptyNode(), newEmptyNode(), brokerRecList),
+ )
+ typeSection.add(brokerTypeDef)
+ result = newStmtList()
+ result.add(typeSection)
+
+ let globalVarIdent = ident("g" & sanitizeIdentName(typeIdent) & "Broker")
+ let accessProcIdent = ident("access" & sanitizeIdentName(typeIdent) & "Broker")
+ result.add(
+ quote do:
+ var `globalVarIdent` {.threadvar.}: `brokerTypeIdent`
+
+ proc `accessProcIdent`(): var `brokerTypeIdent` =
+ `globalVarIdent`
+
+ )
+
+ var clearBody = newStmtList()
+ if not zeroArgSig.isNil():
+ result.add(
+ quote do:
+ proc setProvider*(
+ _: typedesc[`typeIdent`], handler: `zeroArgProviderName`
+ ): Result[void, string] =
+ if not `accessProcIdent`().`zeroArgFieldName`.isNil():
+ return err("Zero-arg provider already set")
+ `accessProcIdent`().`zeroArgFieldName` = handler
+ return ok()
+
+ )
+ clearBody.add(
+ quote do:
+ `accessProcIdent`().`zeroArgFieldName` = nil
+ )
+ result.add(
+ quote do:
+ proc request*(
+ _: typedesc[`typeIdent`]
+ ): Future[Result[`typeIdent`, string]] {.async: (raises: []).} =
+ let provider = `accessProcIdent`().`zeroArgFieldName`
+ if provider.isNil():
+ return err(
+ "RequestBroker(" & `typeNameLit` & "): no zero-arg provider registered"
+ )
+ let catchedRes = catch:
+ await provider()
+
+ if catchedRes.isErr():
+ return err("Request failed:" & catchedRes.error.msg)
+
+ let providerRes = catchedRes.get()
+ when `isRefObjectLit`:
+ if providerRes.isOk():
+ let resultValue = providerRes.get()
+ if resultValue.isNil():
+ return err(
+ "RequestBroker(" & `typeNameLit` & "): provider returned nil result"
+ )
+ return providerRes
+
+ )
+ if not argSig.isNil():
+ result.add(
+ quote do:
+ proc setProvider*(
+ _: typedesc[`typeIdent`], handler: `argProviderName`
+ ): Result[void, string] =
+ if not `accessProcIdent`().`argFieldName`.isNil():
+ return err("Provider already set")
+ `accessProcIdent`().`argFieldName` = handler
+ return ok()
+
+ )
+ clearBody.add(
+ quote do:
+ `accessProcIdent`().`argFieldName` = nil
+ )
+ let requestParamDefs = cloneParams(argParams)
+ let argNameIdents = collectParamNames(requestParamDefs)
+ let providerSym = genSym(nskLet, "provider")
+ var formalParams = newTree(nnkFormalParams)
+ formalParams.add(
+ quote do:
+ Future[Result[`typeIdent`, string]]
+ )
+ formalParams.add(
+ newTree(
+ nnkIdentDefs,
+ ident("_"),
+ newTree(nnkBracketExpr, ident("typedesc"), copyNimTree(typeIdent)),
+ newEmptyNode(),
+ )
+ )
+ for paramDef in requestParamDefs:
+ formalParams.add(paramDef)
+
+ let requestPragmas = quote:
+ {.async: (raises: []), gcsafe.}
+ var providerCall = newCall(providerSym)
+ for argName in argNameIdents:
+ providerCall.add(argName)
+ var requestBody = newStmtList()
+ requestBody.add(
+ quote do:
+ let `providerSym` = `accessProcIdent`().`argFieldName`
+ )
+ requestBody.add(
+ quote do:
+ if `providerSym`.isNil():
+ return err(
+ "RequestBroker(" & `typeNameLit` &
+ "): no provider registered for input signature"
+ )
+ )
+ requestBody.add(
+ quote do:
+ let catchedRes = catch:
+ await `providerCall`
+ if catchedRes.isErr():
+ return err("Request failed:" & catchedRes.error.msg)
+
+ let providerRes = catchedRes.get()
+ when `isRefObjectLit`:
+ if providerRes.isOk():
+ let resultValue = providerRes.get()
+ if resultValue.isNil():
+ return err(
+ "RequestBroker(" & `typeNameLit` & "): provider returned nil result"
+ )
+ return providerRes
+ )
+ # requestBody.add(providerCall)
+ result.add(
+ newTree(
+ nnkProcDef,
+ postfix(ident("request"), "*"),
+ newEmptyNode(),
+ newEmptyNode(),
+ formalParams,
+ requestPragmas,
+ newEmptyNode(),
+ requestBody,
+ )
+ )
+
+ result.add(
+ quote do:
+ proc clearProvider*(_: typedesc[`typeIdent`]) =
+ `clearBody`
+
+ )
+
+ when defined(requestBrokerDebug):
+ echo result.repr
From 54f4ad8fa2ed452df670e25213a7fa34e5cc5432 Mon Sep 17 00:00:00 2001
From: Fabiana Cecin
Date: Tue, 2 Dec 2025 11:00:26 -0300
Subject: [PATCH 13/70] fix: fix .github waku-org/ --> logos-messaging/ (#3653)
* fix: fix .github waku-org/ --> logos-messaging/
* bump CI tests timeout 45 --> 90 minutes
* fix .gitmodules waku-org --> logos-messaging
---
.github/ISSUE_TEMPLATE/prepare_beta_release.md | 14 +++++++-------
.github/ISSUE_TEMPLATE/prepare_full_release.md | 16 ++++++++--------
.github/workflows/ci.yml | 14 +++++++-------
.github/workflows/pre-release.yml | 10 +++++-----
.gitmodules | 2 +-
5 files changed, 28 insertions(+), 28 deletions(-)
diff --git a/.github/ISSUE_TEMPLATE/prepare_beta_release.md b/.github/ISSUE_TEMPLATE/prepare_beta_release.md
index 270f6a8e6..9afaefbd1 100644
--- a/.github/ISSUE_TEMPLATE/prepare_beta_release.md
+++ b/.github/ISSUE_TEMPLATE/prepare_beta_release.md
@@ -10,7 +10,7 @@ assignees: ''
### Items to complete
@@ -34,10 +34,10 @@ All items below are to be completed by the owner of the given release.
- [ ] **Proceed with release**
- [ ] Assign a final release tag (`v0.X.0-beta`) to the same commit that contains the validated release-candidate tag (e.g. `v0.X.0-beta-rc.N`) and submit a PR from the release branch to `master`.
- - [ ] Update [nwaku-compose](https://github.com/waku-org/nwaku-compose) and [waku-simulator](https://github.com/waku-org/waku-simulator) according to the new release.
- - [ ] Bump nwaku dependency in [waku-rust-bindings](https://github.com/waku-org/waku-rust-bindings) and make sure all examples and tests work.
- - [ ] Bump nwaku dependency in [waku-go-bindings](https://github.com/waku-org/waku-go-bindings) and make sure all tests work.
- - [ ] Create GitHub release (https://github.com/waku-org/nwaku/releases).
+ - [ ] Update [nwaku-compose](https://github.com/logos-messaging/nwaku-compose) and [waku-simulator](https://github.com/logos-messaging/waku-simulator) according to the new release.
+ - [ ] Bump nwaku dependency in [waku-rust-bindings](https://github.com/logos-messaging/waku-rust-bindings) and make sure all examples and tests work.
+ - [ ] Bump nwaku dependency in [waku-go-bindings](https://github.com/logos-messaging/waku-go-bindings) and make sure all tests work.
+ - [ ] Create GitHub release (https://github.com/logos-messaging/nwaku/releases).
- [ ] Submit a PR to merge the release branch back to `master`. Make sure you use the option "Merge pull request (Create a merge commit)" to perform the merge. Ping repo admin if this option is not available.
- [ ] **Promote release to fleets**
@@ -47,8 +47,8 @@ All items below are to be completed by the owner of the given release.
### Links
-- [Release process](https://github.com/waku-org/nwaku/blob/master/docs/contributors/release-process.md)
-- [Release notes](https://github.com/waku-org/nwaku/blob/master/CHANGELOG.md)
+- [Release process](https://github.com/logos-messaging/nwaku/blob/master/docs/contributors/release-process.md)
+- [Release notes](https://github.com/logos-messaging/nwaku/blob/master/CHANGELOG.md)
- [Fleet ownership](https://www.notion.so/Fleet-Ownership-7532aad8896d46599abac3c274189741?pvs=4#d2d2f0fe4b3c429fbd860a1d64f89a64)
- [Infra-nim-waku](https://github.com/status-im/infra-nim-waku)
- [Jenkins](https://ci.infra.status.im/job/nim-waku/)
diff --git a/.github/ISSUE_TEMPLATE/prepare_full_release.md b/.github/ISSUE_TEMPLATE/prepare_full_release.md
index 18c668d16..314146f60 100644
--- a/.github/ISSUE_TEMPLATE/prepare_full_release.md
+++ b/.github/ISSUE_TEMPLATE/prepare_full_release.md
@@ -10,7 +10,7 @@ assignees: ''
### Items to complete
@@ -54,11 +54,11 @@ All items below are to be completed by the owner of the given release.
- [ ] **Proceed with release**
- - [ ] Assign a final release tag (`v0.X.0`) to the same commit that contains the validated release-candidate tag (e.g. `v0.X.0`).
- - [ ] Update [nwaku-compose](https://github.com/waku-org/nwaku-compose) and [waku-simulator](https://github.com/waku-org/waku-simulator) according to the new release.
- - [ ] Bump nwaku dependency in [waku-rust-bindings](https://github.com/waku-org/waku-rust-bindings) and make sure all examples and tests work.
- - [ ] Bump nwaku dependency in [waku-go-bindings](https://github.com/waku-org/waku-go-bindings) and make sure all tests work.
- - [ ] Create GitHub release (https://github.com/waku-org/nwaku/releases).
+ - [ ] Assign a final release tag (`v0.X.0`) to the same commit that contains the validated release-candidate tag (e.g. `v0.X.0`).
+ - [ ] Update [nwaku-compose](https://github.com/logos-messaging/nwaku-compose) and [waku-simulator](https://github.com/logos-messaging/waku-simulator) according to the new release.
+ - [ ] Bump nwaku dependency in [waku-rust-bindings](https://github.com/logos-messaging/waku-rust-bindings) and make sure all examples and tests work.
+ - [ ] Bump nwaku dependency in [waku-go-bindings](https://github.com/logos-messaging/waku-go-bindings) and make sure all tests work.
+ - [ ] Create GitHub release (https://github.com/logos-messaging/nwaku/releases).
- [ ] Submit a PR to merge the release branch back to `master`. Make sure you use the option "Merge pull request (Create a merge commit)" to perform the merge. Ping repo admin if this option is not available.
- [ ] **Promote release to fleets**
@@ -67,8 +67,8 @@ All items below are to be completed by the owner of the given release.
### Links
-- [Release process](https://github.com/waku-org/nwaku/blob/master/docs/contributors/release-process.md)
-- [Release notes](https://github.com/waku-org/nwaku/blob/master/CHANGELOG.md)
+- [Release process](https://github.com/logos-messaging/nwaku/blob/master/docs/contributors/release-process.md)
+- [Release notes](https://github.com/logos-messaging/nwaku/blob/master/CHANGELOG.md)
- [Fleet ownership](https://www.notion.so/Fleet-Ownership-7532aad8896d46599abac3c274189741?pvs=4#d2d2f0fe4b3c429fbd860a1d64f89a64)
- [Infra-nim-waku](https://github.com/status-im/infra-nim-waku)
- [Jenkins](https://ci.infra.status.im/job/nim-waku/)
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index 5cf64b66a..12c1abd6d 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -78,7 +78,7 @@ jobs:
- name: Build binaries
run: make V=1 QUICK_AND_DIRTY_COMPILER=1 all tools
-
+
build-windows:
needs: changes
if: ${{ needs.changes.outputs.v2 == 'true' || needs.changes.outputs.common == 'true' }}
@@ -94,7 +94,7 @@ jobs:
matrix:
os: [ubuntu-22.04, macos-15]
runs-on: ${{ matrix.os }}
- timeout-minutes: 45
+ timeout-minutes: 90
name: test-${{ matrix.os }}
steps:
@@ -121,7 +121,7 @@ jobs:
sudo docker run --rm -d -e POSTGRES_PASSWORD=test123 -p 5432:5432 postgres:15.4-alpine3.18
postgres_enabled=1
fi
-
+
export MAKEFLAGS="-j1"
export NIMFLAGS="--colors:off -d:chronicles_colors:none"
export USE_LIBBACKTRACE=0
@@ -132,12 +132,12 @@ jobs:
build-docker-image:
needs: changes
if: ${{ needs.changes.outputs.v2 == 'true' || needs.changes.outputs.common == 'true' || needs.changes.outputs.docker == 'true' }}
- uses: waku-org/nwaku/.github/workflows/container-image.yml@master
+ uses: logos-messaging/nwaku/.github/workflows/container-image.yml@master
secrets: inherit
nwaku-nwaku-interop-tests:
needs: build-docker-image
- uses: waku-org/waku-interop-tests/.github/workflows/nim_waku_PR.yml@SMOKE_TEST_0.0.1
+ uses: logos-messaging/waku-interop-tests/.github/workflows/nim_waku_PR.yml@SMOKE_TEST_0.0.1
with:
node_nwaku: ${{ needs.build-docker-image.outputs.image }}
@@ -145,14 +145,14 @@ jobs:
js-waku-node:
needs: build-docker-image
- uses: waku-org/js-waku/.github/workflows/test-node.yml@master
+ uses: logos-messaging/js-waku/.github/workflows/test-node.yml@master
with:
nim_wakunode_image: ${{ needs.build-docker-image.outputs.image }}
test_type: node
js-waku-node-optional:
needs: build-docker-image
- uses: waku-org/js-waku/.github/workflows/test-node.yml@master
+ uses: logos-messaging/js-waku/.github/workflows/test-node.yml@master
with:
nim_wakunode_image: ${{ needs.build-docker-image.outputs.image }}
test_type: node-optional
diff --git a/.github/workflows/pre-release.yml b/.github/workflows/pre-release.yml
index fe108e616..380ec755f 100644
--- a/.github/workflows/pre-release.yml
+++ b/.github/workflows/pre-release.yml
@@ -47,7 +47,7 @@ jobs:
- name: prep variables
id: vars
run: |
- ARCH=${{matrix.arch}}
+ ARCH=${{matrix.arch}}
echo "arch=${ARCH}" >> $GITHUB_OUTPUT
@@ -91,14 +91,14 @@ jobs:
build-docker-image:
needs: tag-name
- uses: waku-org/nwaku/.github/workflows/container-image.yml@master
+ uses: logos-messaging/nwaku/.github/workflows/container-image.yml@master
with:
image_tag: ${{ needs.tag-name.outputs.tag }}
secrets: inherit
js-waku-node:
needs: build-docker-image
- uses: waku-org/js-waku/.github/workflows/test-node.yml@master
+ uses: logos-messaging/js-waku/.github/workflows/test-node.yml@master
with:
nim_wakunode_image: ${{ needs.build-docker-image.outputs.image }}
test_type: node
@@ -106,7 +106,7 @@ jobs:
js-waku-node-optional:
needs: build-docker-image
- uses: waku-org/js-waku/.github/workflows/test-node.yml@master
+ uses: logos-messaging/js-waku/.github/workflows/test-node.yml@master
with:
nim_wakunode_image: ${{ needs.build-docker-image.outputs.image }}
test_type: node-optional
@@ -150,7 +150,7 @@ jobs:
-u $(id -u) \
docker.io/wakuorg/sv4git:latest \
release-notes ${RELEASE_NOTES_TAG} --previous $(git tag -l --sort -creatordate | grep -e "^v[0-9]*\.[0-9]*\.[0-9]*$") |\
- sed -E 's@#([0-9]+)@[#\1](https://github.com/waku-org/nwaku/issues/\1)@g' > release_notes.md
+ sed -E 's@#([0-9]+)@[#\1](https://github.com/logos-messaging/nwaku/issues/\1)@g' > release_notes.md
sed -i "s/^## .*/Generated at $(date)/" release_notes.md
diff --git a/.gitmodules b/.gitmodules
index b7e52550a..93a3a006f 100644
--- a/.gitmodules
+++ b/.gitmodules
@@ -181,6 +181,6 @@
branch = master
[submodule "vendor/waku-rlnv2-contract"]
path = vendor/waku-rlnv2-contract
- url = https://github.com/waku-org/waku-rlnv2-contract.git
+ url = https://github.com/logos-messaging/waku-rlnv2-contract.git
ignore = untracked
branch = master
From 8c30a8e1bb7469e6184d1ac6289676aec27b719d Mon Sep 17 00:00:00 2001
From: Ivan FB <128452529+Ivansete-status@users.noreply.github.com>
Date: Wed, 3 Dec 2025 11:55:34 +0100
Subject: [PATCH 14/70] Rest store api constraints default page size to 20 and
max to 100 (#3602)
Co-authored-by: Vishwanath Martur <64204611+vishwamartur@users.noreply.github.com>
---
docs/api/rest-api.md | 3 +++
docs/operators/how-to/configure-rest-api.md | 3 ++-
waku/rest_api/endpoint/store/client.nim | 2 +-
waku/rest_api/endpoint/store/handlers.nim | 8 ++++++++
4 files changed, 14 insertions(+), 2 deletions(-)
diff --git a/docs/api/rest-api.md b/docs/api/rest-api.md
index eeb90abfb..cc8e51020 100644
--- a/docs/api/rest-api.md
+++ b/docs/api/rest-api.md
@@ -38,6 +38,9 @@ A particular OpenAPI spec can be easily imported into [Postman](https://www.post
curl http://localhost:8645/debug/v1/info -s | jq
```
+### Store API
+
+The `page_size` flag in the Store API has a default value of 20 and a max value of 100.
### Node configuration
Find details [here](https://github.com/waku-org/nwaku/tree/master/docs/operators/how-to/configure-rest-api.md)
diff --git a/docs/operators/how-to/configure-rest-api.md b/docs/operators/how-to/configure-rest-api.md
index 3fe070aab..7a58a798c 100644
--- a/docs/operators/how-to/configure-rest-api.md
+++ b/docs/operators/how-to/configure-rest-api.md
@@ -1,4 +1,3 @@
-
# Configure a REST API node
A subset of the node configuration can be used to modify the behaviour of the HTTP REST API.
@@ -21,3 +20,5 @@ Example:
```shell
wakunode2 --rest=true
```
+
+The `page_size` flag in the Store API has a default value of 20 and a max value of 100.
diff --git a/waku/rest_api/endpoint/store/client.nim b/waku/rest_api/endpoint/store/client.nim
index 80939ee25..71ba7610d 100644
--- a/waku/rest_api/endpoint/store/client.nim
+++ b/waku/rest_api/endpoint/store/client.nim
@@ -57,7 +57,7 @@ proc getStoreMessagesV3*(
# Optional cursor fields
cursor: string = "", # base64-encoded hash
ascending: string = "",
- pageSize: string = "",
+ pageSize: string = "20", # default value is 20
): RestResponse[StoreQueryResponseHex] {.
rest, endpoint: "/store/v3/messages", meth: HttpMethod.MethodGet
.}
diff --git a/waku/rest_api/endpoint/store/handlers.nim b/waku/rest_api/endpoint/store/handlers.nim
index 79724b9d7..7d37191fb 100644
--- a/waku/rest_api/endpoint/store/handlers.nim
+++ b/waku/rest_api/endpoint/store/handlers.nim
@@ -129,6 +129,14 @@ proc createStoreQuery(
except CatchableError:
return err("page size parsing error: " & getCurrentExceptionMsg())
+ # Enforce default value of page_size to 20
+ if parsedPagedSize.isNone():
+ parsedPagedSize = some(20.uint64)
+
+ # Enforce max value of page_size to 100
+ if parsedPagedSize.get() > 100:
+ parsedPagedSize = some(100.uint64)
+
return ok(
StoreQueryRequest(
includeData: parsedIncludeData,
From a8590a0a7dd53776bc2fef87149fdb084b58d317 Mon Sep 17 00:00:00 2001
From: Tanya S <120410716+stubbsta@users.noreply.github.com>
Date: Thu, 4 Dec 2025 10:26:18 +0200
Subject: [PATCH 15/70] chore: Add gasprice overflow check (#3636)
* Check for gasPrice overflow
* use trace for logging and update comments
* Update log level for gas price logs
---
.../group_manager/on_chain/group_manager.nim | 13 ++++++++++++-
1 file changed, 12 insertions(+), 1 deletion(-)
diff --git a/waku/waku_rln_relay/group_manager/on_chain/group_manager.nim b/waku/waku_rln_relay/group_manager/on_chain/group_manager.nim
index db68b2289..e8af61682 100644
--- a/waku/waku_rln_relay/group_manager/on_chain/group_manager.nim
+++ b/waku/waku_rln_relay/group_manager/on_chain/group_manager.nim
@@ -229,7 +229,18 @@ method register*(
var gasPrice: int
g.retryWrapper(gasPrice, "Failed to get gas price"):
- int(await ethRpc.provider.eth_gasPrice()) * 2
+ let fetchedGasPrice = uint64(await ethRpc.provider.eth_gasPrice())
+ ## Multiply by 2 to speed up the transaction
+ ## Check for overflow when casting to int
+ if fetchedGasPrice > uint64(high(int) div 2):
+ warn "Gas price overflow detected, capping at maximum int value",
+ fetchedGasPrice = fetchedGasPrice, maxInt = high(int)
+ high(int)
+ else:
+ let calculatedGasPrice = int(fetchedGasPrice) * 2
+ debug "Gas price calculated",
+ fetchedGasPrice = fetchedGasPrice, gasPrice = calculatedGasPrice
+ calculatedGasPrice
let idCommitmentHex = identityCredential.idCommitment.inHex()
info "identityCredential idCommitmentHex", idCommitment = idCommitmentHex
let idCommitment = identityCredential.idCommitment.toUInt256()
From 2cf4fe559a0a6a4511cc9da2b69c7935ebc7862f Mon Sep 17 00:00:00 2001
From: Tanya S <120410716+stubbsta@users.noreply.github.com>
Date: Mon, 8 Dec 2025 08:29:48 +0200
Subject: [PATCH 16/70] Chore: bump waku-rlnv2-contract-repo commit (#3651)
* Bump commit for vendor wakurlnv2contract
* Update RLN registration proc for contract updates
* add option to runAnvil for state dump or load with optional contract deployment on setup
* Code clean up
* Upodate rln relay tests to use cached anvil state
* Minor updates to utils and new test for anvil state dump
* stopAnvil needs to wait for graceful shutdown
* configure runAnvil to use load state in other tests
* reduce ci timeout
* Allow for RunAnvil load state file to be compressed
* Fix linting
* Change return type of sendMintCall to Futre[void]
* Update naming of ci path for interop tests
---
.github/workflows/ci.yml | 4 +-
tests/node/test_wakunode_legacy_lightpush.nim | 4 +-
tests/node/test_wakunode_lightpush.nim | 4 +-
...ployed-contracts-mint-and-approved.json.gz | Bin 0 -> 118346 bytes
.../test_rln_contract_deployment.nim | 29 ++
.../test_rln_group_manager_onchain.nim | 4 +-
tests/waku_rln_relay/test_waku_rln_relay.nim | 4 +-
.../test_wakunode_rln_relay.nim | 4 +-
tests/waku_rln_relay/utils_onchain.nim | 249 ++++++++++++++----
tests/wakunode_rest/test_rest_health.nim | 4 +-
vendor/waku-rlnv2-contract | 2 +-
.../group_manager/on_chain/group_manager.nim | 38 +--
12 files changed, 259 insertions(+), 87 deletions(-)
create mode 100644 tests/waku_rln_relay/anvil_state/state-deployed-contracts-mint-and-approved.json.gz
create mode 100644 tests/waku_rln_relay/test_rln_contract_deployment.nim
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index 12c1abd6d..e3186a007 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -94,7 +94,7 @@ jobs:
matrix:
os: [ubuntu-22.04, macos-15]
runs-on: ${{ matrix.os }}
- timeout-minutes: 90
+ timeout-minutes: 45
name: test-${{ matrix.os }}
steps:
@@ -137,7 +137,7 @@ jobs:
nwaku-nwaku-interop-tests:
needs: build-docker-image
- uses: logos-messaging/waku-interop-tests/.github/workflows/nim_waku_PR.yml@SMOKE_TEST_0.0.1
+ uses: logos-messaging/logos-messaging-interop-tests/.github/workflows/nim_waku_PR.yml@SMOKE_TEST_0.0.1
with:
node_nwaku: ${{ needs.build-docker-image.outputs.image }}
diff --git a/tests/node/test_wakunode_legacy_lightpush.nim b/tests/node/test_wakunode_legacy_lightpush.nim
index a51ba60b9..80e623ce4 100644
--- a/tests/node/test_wakunode_legacy_lightpush.nim
+++ b/tests/node/test_wakunode_legacy_lightpush.nim
@@ -135,8 +135,8 @@ suite "RLN Proofs as a Lightpush Service":
server = newTestWakuNode(serverKey, parseIpAddress("0.0.0.0"), Port(0))
client = newTestWakuNode(clientKey, parseIpAddress("0.0.0.0"), Port(0))
- anvilProc = runAnvil()
- manager = waitFor setupOnchainGroupManager()
+ anvilProc = runAnvil(stateFile = some(DEFAULT_ANVIL_STATE_PATH))
+ manager = waitFor setupOnchainGroupManager(deployContracts = false)
# mount rln-relay
let wakuRlnConfig = getWakuRlnConfig(manager = manager, index = MembershipIndex(1))
diff --git a/tests/node/test_wakunode_lightpush.nim b/tests/node/test_wakunode_lightpush.nim
index 12bfdddd8..29f72b2cc 100644
--- a/tests/node/test_wakunode_lightpush.nim
+++ b/tests/node/test_wakunode_lightpush.nim
@@ -135,8 +135,8 @@ suite "RLN Proofs as a Lightpush Service":
server = newTestWakuNode(serverKey, parseIpAddress("0.0.0.0"), Port(0))
client = newTestWakuNode(clientKey, parseIpAddress("0.0.0.0"), Port(0))
- anvilProc = runAnvil()
- manager = waitFor setupOnchainGroupManager()
+ anvilProc = runAnvil(stateFile = some(DEFAULT_ANVIL_STATE_PATH))
+ manager = waitFor setupOnchainGroupManager(deployContracts = false)
# mount rln-relay
let wakuRlnConfig = getWakuRlnConfig(manager = manager, index = MembershipIndex(1))
diff --git a/tests/waku_rln_relay/anvil_state/state-deployed-contracts-mint-and-approved.json.gz b/tests/waku_rln_relay/anvil_state/state-deployed-contracts-mint-and-approved.json.gz
new file mode 100644
index 0000000000000000000000000000000000000000..ceb081c77788d7b5a3a933b2d0510303247694a1
GIT binary patch
literal 118346
zcmV)1K+V4&iwFoy%`s^J19Nm?bY(4MWpHe7d1YiRV{dMBa$#e1b1iLYZgeeSZe%TC
zaBy;Oc4cHPYIARH0OXwAt{pdyh2O>3xsXJO67wai5qb;$e_{hJ|DMF+{wiZ
zGH73{CMvB
z_1=H_uh(bkPyXT3pWpv*KK|@K{QY&IS~)j$=fL0m<9FY`|Ka`5@4l5kUd4R=@!WGb
zVnwZ4&fmP-?=L3&^8L?mCNRX`e>(s9lmEE=!|S6t&#pCAleisHZ_;-K*>HRw4l()}c=Wy`dx9RNy
z-n^ZZ|M|~v-uYS|e);j|k8#ca!B^q-4?o5zFAse0uh)!FcFKN+Y@7P>>H4rg9pUxI
zpFjNMe+&C!>hx=_dv!Cd+sjI07Ev2hwyf2cOUcGK*4qC(oyaT)huob;l6A)CSpKi`
zwk_5Dwpz6B*>_)}IM(>AXHN-p)b)$c%lh&-BOkeK?b|V6$=1fJxsuP@X31yVFFvn3
zCwskfCM~7pCALnj$J$86uANyhL4G%H{^PuVn4!y`9Z*uPilyKIwKnmEH-Zvi5%znfQlR`=`wAsS
zGLq#amacpnvtLPy!M&U;guK`sjcl7bGS`l_%MdxEj!w39uC8+OZ6^1V%X7bFTACBM
z+~uhayPEsyd(C@BIf(!#^{F*2+)?}Nmfd9bdO(}#?l-5LdS*l^!aQnSn7gZDXlk-^
z9lM^K?6!-i+Zs;7w&v*$o7Wk^TrSvY+Ebag=05rK93c*2th314lcbLCZ|}se+uA)t
zFFRP}++1rb(r#h4)odshWVO5UTziZ@6Gm*ppkw1>(|d1C*7OXm;}zdVP{Sjfd9UEJ
zGklrhuwvnwovx2GP15RRbV;-O6a~NCt_(|O-A+;r(BN;QjW!5D!k!^x@Q*o@S!rR&
z>xiYd*Z(@2U!Umfx{i1B?3#)2oVL#JQt#e#&1Di4L^jQRj<>dTX>C>Zs+Qy=
zAYrktmK)AkcyA}TLy5R8iwT)kb%!4IV<7F_Z0bTS?#f$s|z3xN){o9y>9CaIo2){
zd!ZB-pe5bAy*g>r(^`q_x%jzb72YG#H+SW8Ot9t~0FB~3oy&4uFI3Fx`^n|B0nYo>
znH3)MxyCt#%7+(TRuz^&PFmRu;4}A@u|0Qyxbj*P*W4Ecw0lILz!HY-;*9`7gIE-h(4#CQ<_|1#JZGjiDYzvc`R9KtwDc$eZr
zO>v@Sb)LR*_Fby<0Xb|)rdgRj@YozZeD?C%7@6VyOh4|}?$UMN(fw9e!OOGHTe|NG
ztcs0u`;-x%4cKnKq0GW}pVs&#P!?+pL@@C=8?LO8$t-SlWkH6s0Nfh5E!WJd_dW#F
zYJxsan!ES>yEXRGA-~BLxH!p$Z6_3P^2)m+dXfkX1aU8EWiEndIAZU8ZOuMdV|%T!
ze~#n7i`n1eSS3+?7xV$8Qo44-aoVZ^M5y<0S+`T*$SJ*v6h*5Y&hR|5_us8i>RGkn
zmdOi)kY^MMq7&G8$yU+>hF$z@=uFgd^_5HceK7`fqtPZ7+)w0>TlkIomy%52B<-4XrrNJ0hrtQOMRF*aZO7u
z!oX`0WB4yhN#C^uLgXzA^b2Ld_(ECmd5vjvrf=PL>ZJ6xv#H}7{zN1!iuXxW(6RF*
zbXm&oiR?I3NosJuRL3{2>!0KJ?`FaHLRs*yII?hS_pXvN^43vZ2%^Ta3y
zT%~f|vy9|!2sN+$)D0N(8)MhV&^OHgzo`Woy__as?}%&P_ZY#1D$%odN%T#+9rTsf
zhcQ&{3z>@0Qro9BdqOP$$h!_WaRSQQX&G6~9tX%Ft8XnPw8bNZO4!L!i^J(G1~Ob}
zFZ2nuAaB#wE)`AUBQ%bkgh|r8q|oq073Z%(Tww*H?X7c9W=e}u+Mlcie_=kSX}gX7
z8Y27$GB8ekJ2NnYTbK1f|Ik+fm*tmQE09>
zAx_Jwq?P*WbXOTTB^}~u61+(;NM4e)OuYCNaI%n!v(t*~wsWWM7TcopB#4-dEUWsu
zi$p&c7vfx0Ias-~g7p~Xug}SxsRU@XlX0dVSr=?(@FD
zNqH!zndu&^mxDb7TcKsZNGYN$8NnXc;#or!->$Pgf{`0%R?=|p>H%XEF@tKaq$80>
zSPJtYII5pUQ#H~myRK59Fr>v37&%4QH=S;(Ws51mXd6m(Ar_ER+zCQ5BbyzM8g!k}
zBhVHkzO>EfGcqBN+4E(HOd207kyKtR!L%MyM|%ZpY7=
zy7qX|QhPiizH&&-HFK&0oN_xSRRwPGAm{m~=zxPeFOu+^r;C4TO1ukPumbEJw~}l^T~ko|DbHHT+G*
zMPZ;JEuP}G-EhWDwUXCobOtS8b#hEQHL6`1bE}>waB_i!%oBK>QjkrxIr&0U6kH4n
zS>Wn|j2<3O#bM$;LA?>myGyxG;N-%pXe%JzPBin&Ga-u28BgG3
zoVezpt`gTe0kJ7%XYO@J79cj1`I{k_BMLVt8Ua;g9>b~m5u6;)gi{-}Gnic3o4cF@
zTu|=4%}=kf{Q@Vg0vRQyF1pUeWwO1=SHQ`KrXATx6edCNc1h>tv#yFWZ&6na)4Jj7
z(&vaSsJAxTjz_F%J%E$X$SZD@SAk!SVg#}gcUdEpf;pwlddW}`l;w!KQv+F*V#`O0
z%~Vfd-*rC?&_#8cz`*U|dx!;^c8
zEp@c;dl8296)-Z5{GeF}CigNVnAkBPZP23a;T^m@QeCMNlinhu1Mx7qkn#5cj0}={
zM895|^^7C%#-7J_)3}39ZShKMC${P`zt$G;yu`cFCP8yg;N%oX&mu))2dRzYv0qb`
zBO3Fpl+Q|Jh;gP+DdC}b7^LgQXsY{G=iXbA||8kquZ@G=fpa4;nL
zB0EpuWa88Nk)dV7IoQEvgR)8o5B-8HSjcNh3-umw(1g^e2;D37SH|~tzqpX{u4NvzI8E&oP7-b9Ys+MJ8o2v
zzB?XHJHAmLG3jLu`~jKCikM*96F8aGTo6>Kp{<9TsWcY`(gGI&a^16_F=*GJrn;b}
zh8kJYPKw^ZpU=s8D;;g`rJXvmIs|rW6PgE#F9X@hQ}eOd4R#DY(GH6GH9)oPkJtxS
zQ2z-_dOYMiJ%mKr@jWOK(lS2)k7F$^VlF9lg@neLwP_2<`~Xf)z;oJOvcS^F9VrzX
z|75A~S&49jvS7HqN^4RtIG>$17-5N6{0cakO0zXP-N9JH%*oZP)Sp{JX8~UVYLy-c
zk0wPWYgW318a|k`P!Hhb*H>YBpD@uL6qVbX?HjjSuW))f?haTu1$bW1;sjA&4Po4M
ze8k=4q`FC1!Yw&&j&95usnxj@kl)xPmXL==n&#&S|YUeYi~cP)-9X$I>PI2mYCb~9Hm1pcnEtpqc3^}Y`7
zZl{;mvpl`JG48bHmu?4#Cdeimq2D8*6We19zbE2M_Udg7fUI)l
z3^gabZvJ>qKIdvUs7$J?u7L`s@#z7MxK-hJGQJ?(=;x~si2R
z4rOLYH0l~(s~WRtMqGH0Z^a&LNGo(C$5`fuiJC8$w&5!4Tb{tk$oocn8v0^)9i`Mp
zGoTG^$U4RmEX7R~M;XE@cB)o1qA~iJ5!bJPk(-_iWERqxHSN1yr1gdgQ0~BGrPADj
zqv?tHqQ+T%9?#Ma*QjD2uOq#jBLl^nk&A*U$1lCR#W
zyT!w6loSrg4Qj5{&PaL269Zc%Zs|OLlT-Ev8ENTscL=20BJ6Vu(zr+7h9XuJg;SLH
z(4^#bW?nVE_;~8qz{xXyqs5TAyvvY?OoO+&$JXRDD+;P$s8WcEZU>Mc9WT$mWWGAy
zzdk2ZR0sOd$itF0q?PVLOblI#URRJ3SN+EC1)(pvOxw?HS-lx3tdIBxU#gkqZ=6yG
zKgtLw*SL8eQon$=(xm06G_-|1!{G#G;a0}NL(k{r+^PdLR6;!Y(M*zFM-cRf
z7A`TdP1B3mDybIhd2dT+WctJ>aB`Z$0tTIp)9qaf?b$mHi@)}pkg%fhTx8raX?u~F
zNGPG{KVG-jM{qL9cBm$*IW3EO#m-7AItr?aXV!yuq344Hq0MFalpv$9rV$mmoab|L
zJkL_s*h~N4+?`pDCASVlx1@Pk4kc0hU&1?))gS&eVBn!uFl=}At(&QV3Pwm2xvZ9w
z0AEiDYK4(A^gwdsMULLhb+?;QMNF+*(0HdOqAtQ!{_4?0PS#A
zE4pyO9ph{)?bvs}H>c2HBX3~xZSD$B)Lmj2vhAu1@<N^
z$iMK#_#5KjmhMOA429BWT;0*KZ;&YOgQ^1|V}wpcD5b>zf_1fVQbST`Y@f)I5mW9B
zO<(4zD^x}pc~3J2el{}fil|{|6t65wafY;StEdFE;*H(p6iZ(+q^(l{#42y9Y4NT$
zrO$0DuUILqh*>CqOR9Y(Ez{ky|AM`Xa4{~W{!*(e;>OwrfT|nAX3SOTt}{S8v=T8v
ztN8Pn9l78b#S54$OU^bDXoW9PMg&Cs+Vs6+o2RUe5z1Q5TCStO0>F)mty-W>=><&Y
zDY~U-6|Z?mU3NM@q%a8ah5tc$BpV6xxkr5$9f6g_6z?lhh;_<`ZU!V>ff
zCyN@YdFzair_OCVpd!)>m>gudK5FjTXFTDXj|5}NG&c|Q0j{({4Hr}zQ_rh)Mo_UP
zgKqqS6TVPwz$)fcUNN)06tSw)OXj++mRk+VJlQMHqpk4f>r6{n%w@oCUcls}6r22w
zZi7e6;+7YNFHn$AA1`poc5UYVm72IFlnklDy(I5e6sCMT
z@9fo-L{2x^cJJ?Fas+#aSRw)k!%N#)=(Qi7(OKUaLe+gO>;{sRbN{ZQVmb5bqCtCt
zC)1t?UEm=M{G0=uvyRWTcvc0C&qmeX+yYuimtvB3*+-QK?AY}SXM9*G>{pQ^VPnZL
zd(L$YSYXo)Vns~Z95m^IN2%7K44l<(+e_y2J|auoE+yw-;4pzX`$62V7TXFJ`k+wl
z;4?Z7TK+3zvAHmvuKZi)g%dtsj6VdJIbsHr+dXY7D+OJONlx)Lgn4Rs1S
zqW|(%=Gk=;V$DznJJBCsOsypbb^qKV_}kH#76mJ})|%Tz>C7I&fG_L_8NPOU(+%>3
zZ_)M4qbA0H)Gf?Vu@Qa&Lr&9{!3I0_>P;09ZjQ=|W&x=KW!%aYhZa<(i}>9c`p%GC
z`L$^M19&Wm)mhFo4Rf#Gx7PZBpn(^5*iwweLI%o$<8YU?8gj#^V3hd)440GYS+zz<^ObwR{orh3;r}BtI}S^%
zlc&JAQo9PqRycA!8nX@UNX2e`;&cxiL&Hm+^4A-CP-tIgcsJ&Hx8I{ArMD(OQ&IN^
zONL(1-(&jp2~3V3+iRxia)wco{AN}oe%1#%FsmNaqJbgT$$wT3<=$-yU`5=%kI9UH
zsvIb8KDNUQIs?YLQ9WNE;B_VzSFA!OUUapb(YSR1PiE8Z3z)2w$cb4fJcvQ4Gna@3
zwXEVmSxM3QU7rXt#8K6eK{a&FN2YO7}P>
z2j4W-8y4$TrB)O-(>xx9OBuZzvuXn;1l3*PD@Ca=8eTV5wDKEyE+F(7A2V9hX*K;~
z?B~jUPy-PLy-#-B?aXtlf*O6Dxf`QI)9WL-hn6l)$9QKbOBq*HHH7JmyWv}U&!sk=
zqO4h}p|}+G=oK&ZlhFSc>|KPFPEU!BL#?9p?OEvF2<=KXlUvx8u@FO6&d!YmrO}cK
zC7KH7y@1K_;!sXe4&;qYFUqUCRRe6Nf+(0(X%0+T@syubk#M2K6M3T7mQHyBlcVx?
zAjo0-xE?pRiFRc)ugp}tG|JYQRR77Ejl<+J2Fm_`8qU8UGFjCJg6CE5slAqoy{+5m
z_A%XcTG+q>rtr=Q@UB4_4nxgQ$*6
zez2LmbHxC(W3H6Z7RM8N7l~&njbS|snu)6wqZiF)^pRr_i`*6KwV^cVGs&p^j#MU;
zYW;>x_PPghGacjeq4Ve2WM|3Ws`KlqQ0L5w>KD`yPszOjb
zsZ#e7n7np0<>17SR0ne_Uh0%mYxM&~uDbHokPGubrR&w+E3_#nfnz%LSKJn%Lv0Ne
z$H60I_`;V80lKU@9CAVuNvcVKp{Z69s$!pJV%MR*v7elqs?DvS@|S+CDe8F6aeRgz
zi^uLNu+odwgm1RJVrnY(t_qZV^9f9@46@-zkJ|x_l^__3w3j((RedQY!KzOcKwk)f
zv)9_H9e&4{Uj>!NF&Rj;+Inlutow8(uGMr-x_QN8Aww|%t8zOgt%&3cj&01v?^4|B
z6PRqY!b;XHm(k`(cP>{c*n)Az9`Z`wXb{XYmywGX8EmMoT%8`CxWUKbVBM8{9phsG
zX7IVe`1i`C(*A+KJ25652jpc+bl#f7os=U%5zOynGLRGpGoz&TuDhjlwWu+3V&)+&
z34&C0w_u$woC+m@r52tE?R)`~1LK)$W=NTr2I~(y=jztVaoGr*gZWQq1;scHno%9E
zoYqy=kMu;`MW|yhA2zLq)YmanflNHA38Y)<#$pgPt+F|bE>-1E
zUe(NWLq6kkupFzuVLw^ssPmxgzEgxUs(P90$Yd&Y8d@mdd#cBZK_LJ!N1Y$7Wf$V{
zLTvI4&3FB1;{bhFo;07SUpXeamba%}e0{k)Quy*_Blr9SR3WI`pU8Bf)zMMvx)q|J
z)S|Mrt(D=Ub>C29xK+3+LWc}kWioj|K?w(AKYGUdn0zo8L)0A@;#X2q7rhS6eZNMtLS3tVMUBb3G4Hr6UTLOS<+oSo?S8D
zVMW}Eao)W@v3C)^!d-PnrA$Kd`7K{OoZ)Ya&Ma*qd9%t?C*3NiuMQKjj{Ty3&ik00
zYD2p-FlPtl%TkJ-zL}SNaYLv+EV4!9&(W>6tr}USGL+|p+hnZ|U@}BEq>~2T#MV&+
z(NEwMh}=Rz%+}4L1GJxRo}>#iX|TjIVC}x1$aH~4AlZSNyAReS>f518yJu+Px+Ng=
zc!f>G?k$$1LRlAlGTpuVeE-IX_AZnjO}ptgpWafv*7??|Q^(O`GQKT26MvX5zp!I|
z>kh^@GyZR6=^Q-Wn7VS)0eViL>Dzf^Upbe4;_g-zZqpQoft}-)Pd8ENu<9FUd^5v_
zL-d6qvtU&pu{UK$a|Vx7Pngc9NKMn*Vg-O(Mz6#78PG0^xJ!H&}IY)#I^ZgI0!Acbp!U)&JKK^z*!
z{XQlKlg9;ob7oaDn7bE6CItM^;vWaG
z_i%K9A?x^(E?BIHQ@*OYSikfDi1~)ITDeH^etze#$7F4QUlq1mr&JwK&W;xiQh!&0
z*{NAU#@eysLlNi@5A4D7jZ0PBegP&ogltMEUhPDcz2u7#@JIvPCPtoxi}PsK9R
zie(#fK=|+e$bK^ON1p)R{#A^b6%l_*H@IZ(uU&
z6%_6ar3$b!p&^%QX)2B}4+imuZo|?lH0&$Gj>%0}W5AH=FW9?C8!@k{)WezOa!35B
z$EU28)}84exogv6S=~iGNmhYQ9y(O0Z`>K#9simn?FQy>O&90!!V?QBDRxy6g)?TR
zWiKRB^S-pRj)}K%`xBU)_L&-~TXl@daKjWGEA7_HH49iQ3wo?Fq0-uWE*+``vAC#&
z`{itT9FtSlp{=6bQ0s*$M$Vs^ppr^)Kc_)3Q?jiz{w8Fq&}e*DR26I5_yi_T@WvEF
z(@pmX_E%c5XrtmBtd4P0PMR2U)gwCVH8T1G_Y_KMZ`7+EP~KhBpfv~Lv=o7Wg)K&6
zO?;59*ETm$8h8e{tet}|cAc5D{0q+bzC&tkW41c!Hkf?dz_3b&JNI19vW{gpNM_DT
zd4ecDL;0sJ>%2b^cM(;2Ahwx-*bK{vP~Xi!gtRk`CSlr$+|nYfan?ioMw%5h#4q3T
z-KY5LF*#zVu%ZFdz!X)Etetr?6Wa5c3ODzui!(JU|5=(W(V_gtfK%_P$$l*5tqbPabynTy*ee#~
zP^$JuZPcYpBLi%T-L-!%BOW_VMcMmO@exzT)u^DjSad-ZlI3xzj#<4=+~eaZHOaIR
zqV*iL0(}61u%OLVM)CUH0_43bqGf
z@o&d-q=L@&6WR}^xo1kvMsP<%=`_tHpKJm0%xc3Lv@VLSwR&0Sei@wpdOSxA$Jo1L
zaVE;SOvTF&)`w~3)zU^w+^h=c!BkIms-$6S%@PvCiMU2$Q#mlhgUY3TZJz;OB-
z6Z2RS^XbPKC6KQv`#(+8>G;+r$-l(&@25YXwtsy3Gd@))@#oX}k59{A?+dOfnN;N*
z9I4Koe3g9@?T!mNGnZq^sBe@QR;NTrs#^bGcWjpsM^nWVA`eYwku9A3Yrzkzcb7HHsx-Py0qSE
z*L9rY#&>L48~5MF;Qdlx5UvO1s$jl~uJL;^B>=vBl_d-diVclkR8sMzY+i!Y(AMj+
z+j`<$GR1a*%D$HFxhQnHGE6GRHA=q4)3GX}{${h_=S!${_wqwtLUJEnT1;;9E%;ZmM|s|AQ}3HlzNh-~V+T@Ko&QzpsP(
zGk)QJ?7hj3B}bMe_%FVWh0H@P6Wv{1KrRvu)T&WP$QVI1Nsl5KRgp-m_a$O4&j3$-{W^}bMSC4m>7IrfkjQ&
z;$iM>>H5}MJ19bK5%f655xGnv!^-y=&`p&-KAD9-tW{pX*lAnX|4n9xZ>jWGz-z%M
zNYAbFA$3aIj;R2uMo8C2;eQ!KO8WjQPvCW8MOe*TJRl+Dt`mw91j1;1Kq4lV&on^R
z1h|fX3NI4D3JmAd(G!K8PINA)>gQGGF0L9}WxJMn71S@5oaa>)=hX`MC+N=esxHe_
z@FB3QHm{l!K{(BZpUafyQ@*jwm=N=76Z2{?w4J#*7JFEYtHY3*%^X3ofb{tdTGD{w
zmX+1zsqN|*%jM;&13R&7CCjURnGIecK*pCj0@=n@BZ_1@o_Q4{|Khy@tgo`<`1oAd
z`ILy{rFprkmf0}q4XR3=SIq)vuqXzhFIPbi{3OE*IpwI8YsS0XMqY7MrpQoi>@XGE
z^%F>%66a8?*Ojy(@+BUEjJ31b}ugaTp)M*nVdkqj>!&>5_wK
z?obF61<7`BO+nv`;sr4=$@1xid!s!_~
zW;f=QH#iOZ1aXcl=h>xi!je&t+8MwwGk*9fxj15E?o#zDWipm^lHV+7k1q;u?l9`u
zEjvZJA*fBUj+h(q7gg?ey$>o6=s+4`HuM+cuqQYKtRO?7n+A!vVcehy<~Bw6dtqGA
zs{$cdblWeq9Xbh{dq7UJGOu)I%oea3e_1Ln^Do9}SrB!I2!f?U9WVh>lfriiB5omC
zVr9@0i|ZbA$2B$LYAuL-k_g>@xhl5%g{2|#t5B^9VEiKA|mfwj9F7045vxu!u2
z{hFzt
zlLt-yXg5AIxRh9E`)DS{_002k{KT=)y5~QB9>e;1h|fq|K|XW$kfR-o&pwPt?Lj;O
zws<#ATqGXh3`XaHLDCz~JMAlYgn6+yG5_r+<6trnN6z^K71ENl7`o>ZbjAd6hssEg
zsgX`#t)wQ7zq^X{8pkRs8yy+c$KcsqN57twuI7^c|_%8_URFB+oeD4u)fAW6Rs`>*7zJ9-3&uN%@h
zJ%dAsc&{OA$arROvM@|lE6i4A(zDzplcjC?K*;qN*}Z6Jr%a@@wT$+sE$U6zUtb<-5BWX6v_KQcQ5WN
zwwshC>q9fu0!)u34RfdG&7009zslz*wKg?@D-RuHv9tLO>}VYrVadsrC_Yu355=Ehz;tIVmzQ4=9`pg!`v1`?m;Sd%`N{)D7V
zE$=ROu7f|DM`XfDi|=!1+7ZQo2JKG6c2PxHY`=?zYV3+7r+#wHFVhiHirIL??(*HY
zpb_?DqZ!;`taE5C{HcfCtCd}o+$>~4E*6~{-8ZrEvY6Gijkk$@vhmht9Egby>gqi7{<_?RiC)w%e%(hB)OlU=6@Fa)J;0;Z9bhF#odiuZh!X
z(Z`Oooz#G%kDs6#oz>LldF!MF%(Uigbeq3TpSKk&ZoTh|wl2GPJ)S%>m|tCd&uhYa
z96<>?JO`F7kY=DIE!0t+JtAQQsjLAgk{(t+e-6{(z)S8Ct|ac<>Z!SWPPX}+Y?sfu
zXY|i-=5R(EW7%f!VVl?S>qR@Nx?F+pa|M*T&nqZT=mM8K`neV0oq9ST6Rag
zpXO{qbB?oEy{>1Ut6JAN{QaVhE1V}i>~i`c84<8k6NXJaN5iJYN-73d?Qte&-oAv%
zF)Vcn0+i4oPhoz%k_KnQ=VM-GSl#HY$Bea&`hw<(&BsY;a~s#!%W>&DI*dzBiNEIf
zgx%pYX}5qr`ga#k;QW8XO?3)q1RA=_H;UoGSV!evzvsjVI?CO)ljEefIgja&!JB&F
zwGoJz_PwPoQw#};>l}A#%c{g_SMl`cUU5ZJUrxE-nG&Vj8o!m&&L(U9KR2k1vd0u
z_EN`kv6nhodf7G%aRYmxk&KnZ6ZY5zd&0mTV<&co6?@&Xa>mu2&W^7Bbaq^fkRcgY
ztMR*{JUQTN_Hm2Y&c#KP#f`IOguhsok>YgLh9rxtZN;j?XWJ<_oah;dTNnXBI}x9q
z)Y%WZJ!UlNkCH<^qvUJSM+WAqLBB5pa~C;N9eKvby;I%@2L8YmU5$Q<4P{v8`@YnS
z4Snis2Ct@CY-P6{F=B(?Jrg}<^1e_MsXk&RW|;~9y?GEfW};;AnFg>PXu{AY6dPl2
zSrw>|OuNAAvTwTB0zI&3+CrEN4RMPlf&BK
zI7+Z$#gQuXXSY*TS+&SVW{E}?1#jjog^t0_9xSar%JS5S%&
zdjNHMDSrB1Ff+x&8LAAjCG{4ViNE=sLcAmqT7pGq80axL%0rO_4d-6vB$HMQG4O@l
zJ*t{xr~po*5RA=YUQ~n{tP9;SRR@(byIejIN)R_Q)Do`d7PWLC&dc8h3ar^xR)%je
zdYzePi~6eZZ2cxALcC?`FTdmm989fWoJrTQv(@D2zRAjJrZksw2vAylEC4r46Fc_-
zGb!;f6FG?ljt(bblo5@YOv;YNr_6>AkjkBJl9BGZv5SW8P%u7%Se5j~-BCVN{%qB>
z4?O(f##>-{s4Z(?fO7c)>lY$h*b>;qqeOpKYlmoB|HlUf{xHgt5g7=}?O=2ntv
zP$l~)N?*DI+D`(`WHleXD3Hdbszs+!PPKx#veIFdz7`z0a6j2+BpG1|NjP?n1=Z{#
zYx7DL3=15w8!7px>2ysxcCm+GtQw8yvPBJI>OMNTDS8LyNvnUOEyS8i1+OQT^9S3i
zf)Ge4e)xN#TUZu;Wu@0rz%c=-00eM7YhQzmStL_GJeezr);#b*RRtuI;EC*8W>TQ3
zN3y*HL{pmc{5~nwwGQ=fmCSRlR$~^`T)u0}
zwVdy2dlpd+8?5Y>AJpBFJ)ztlVYcqKrJr|ZIMjHEKifTvv{KAFf>f&zex0FmzEkhM
zJ7U@r>BhK};16S*?5C%>R;5oP$9Xl^8&})3w$O{~?9tO12^DjMG0WmH<x`{?l*k?jL^#jq6&Fg3WXzQvCs-~1
zQ06h_aW+^}i1*MhmNy=-zHRY0FSbA0m=Ev2j2EPR{20&6%$g-`aQNO=-*X&ZCg$tg
z(4WhYI(&^c46iP*ASEV&8TJ}?N-0@%EDgsvLYGvm^}#B%Sx0j9<-H^J17hc}c~7fs
zkzw`itXLjKToYs)_HJ4I-prf3>-XM$-=hY3mvMNL)bJ(^3+h(jVA|&;4Oa`FDrWMz
z1HTx)Ya1M9=OQzf^o;I^OKB7CVb%xAyv7E96eY9ncS*^1N^nWPE_npwly-_1rnGA7
z6CUFWul-|CVen$)@7F82N7KUYQFSLeVjDSZc#V#Tv)m=b8Ut*nuXUxC9CF22w@`{P
z&ILD(6v;2H%-mBPv{&w2;OxwZ5#`KR*^^IC$}{8QmEEYCV-e;_)j~K^_G?-e=DJ^|
zXyrCVi%Uf0cSOrvEpMP@j@^_$kd}Fxcz4+%dIt}PU9EB8i@YF?&(HXx2VrAg(Gy1&DE_&ZFySHC
zh;^PfileO&bSdT$YmT2>_l#HGY*{n^75Irs~i>0+1pw6
zW?k80`{cY+&FK5gt&~l>m42=en2|1ajmgbr%=bca&1Q1ExJaIm7cMx*!;-8ukInIN
z2BA%-_Kg2J&R~&O-Zg{l=M1uc9ZEMeL&w^cpfMKnw#%uKr&CoSU!3<_ObWelu_C7g
z77jR4vRzJc5pIS3J**gSDWgJJI6F00#MSM0<^b_jX|!>TZs@13jO
z&Oq^X!s6cUUh64?s+TP0OkzG+93P+cHoHq0mJ()uM|n5y-JDII_=lg5;NK0|5W7Aw
z(2ZTrbuF?;oV=0{)fRue(9PKCPey6BG!Zcq!B
zr0mUYGSORYfcqD4?uM;V`Ym^C@g7Wl=QSDZE*GyYKf%SDNXyx8BM0D`i`ROVm4;1!
zm6cXI!CHT9#wV(@WwmV4%ZIy`C`MM_VeTe$xzKITk)4xT%DS{vbXOkFG|4tLme
z+dKQ7>l9d1KN#b%B=*$0^$s=P5!!r*WUM~)sZz64Y%sx=&B^s{gGs&>fQcbqIo9Gr
z?ZWwFyvHlR`Z^fx&39Bg~tJ2}-J7zV2#*DL(JL`L_K{Hd-XTfGY3U|_fpIDUAcDjbZ0a&>Yw8@r~SS8D{
zMsc(%-F%0gSx4lKV?Q7P0|#2bvC6vJ5}lSfe-=Q4V(pWQvDi=|a3EDv*^;t>Ca~=l
zZnrnz;pRK6TiyYgDe7XA!=bPduxV_itO}jEAPd-OkJA@H8lok>)zQC&EpJ4u{x+=q
zd`Ac?tk~YC*`xqs=;=YReV4@X(9uR<7s$A@DFpDpRD4e%nUr$Vg$xqU1NHD~(@XWn-+V`!xjb?`A3z%+Yw`;8
z6$q~&X!yhk3KpVwu}2%CqV>o#SX@`;xM1ZqVem9<3s>)0@`dbrK6(J1Rf;iQK->Vr
z4S|Er&+$@_+~k^TIPs3vfJ3&q<>J8k3aeJLz{ah2l=+UZoDT&o4T@dNB1ja3+z4SB
zQ_m@sURcx7sVvw&wE$02sH`-Xgz=IcChYC=QRh4Iay}%Ef{`Ww6AdIeR;aen$Pn4Bc?zKm{B7
zg{5wxF(k%WLN~_tfz!sDdoIO%hgr`@^2I|=a;0IiBD4HGkhFT0yW>4TFkFccC>t=i
zG3DOsszc5RTD`vc4msc9SN_2~4A%e+7Xt`U!L)lU(o{o(R56}`DJ8P$41i}rv23l*
z=&oIkch;fiJJNDKm}|`X1+v9tz@toL?se&SkR7*x46TENRaUKtKyf-2fz=hV5(X6g
z<~#I!N89*^#tu7>(++{0%eCP3T6Uc3plCPn^pPdJN$e{TF(a{KPsHEEJBsg
zO|fI9Du|yQ+ngL-YB<@g;|${HLu??`#|eT|tiw(IF%pjPj=G)?kXhNYN#I8;;@@I}
zEW{KL1v$3?YKf8rb{eEA%gVBNIGd~j1zE`4q$Q&)FY}Yu^8wM_(O@XLQ?WznknE*f
zJotmCIE*D@fiwIfXmB&gC6MP`1(8op-QJJMKeS%?hr-(eI|x*E0|kE-s)HyhkFSta
zV?-DPYaIGYdon}_tr$4P{8*?bH{UV&hxQx)P_nn|1zR+-PR
z$5B#XW~yS{RY7M6EUtd@9g}}RomgOHa*M1O2sWn~{8hlHurGjM3XZZTgBfW64G>hI
zkLN5CPEV5oytCe>C6j;XYF1i;ZH4TrKw>?hRV=`eYGce?H3h);t!qg074n+~Cx*=6
z4d|P$iGgM}-!b{e=qWPZ0a*-0B4Y*w&G8wG`xcumj!k>qW(&=t&PvQj`|PM6d|{Pg|EoDO
zs-d^7GHX?Yix|0U{9)Jh-!=XWi-W$l%1KwAsH~t~i8}+4x5LLYYm`mD!tlSa(&X?r
z9pQ1R?RLw@_)#n8I%`;BDmJ^|7H1(3=gDhESev7Lk)4MY562r~L+E2a+p{UV49vyP
zM{Kf^^8To*%A8#;|w^(bDY7j76ynhH|g~OQo&66jGqtTQj&*gV=PM#47z@UdpJr-KN6)h
zpvK}jGa}rd&R57~#&q)clrN*EhOgoJ9d9~|qgt~V++}%R(>J5E4iIMH$@%kv6E$Eg
z+D3EFD~)Q2ULA2}@A6bc@l1TptEbQ$Du@Nn`T`1(eU|3Wmrvxwr!FS(w9@$$ZM?+{$(!e
zH>_1m#_YsPv$_X^98P!PN*S??GDWj`U&hsbs3UPTk5?+gq*-fyZx6Sx?>ufaufQ#z
zyIgH>W3G)jRDW4#coT~2TekXatbM9x9k!(|+3e6TnGwxm7J0HqW1NE+nO2YvoY|HmV;pg+N*bfDr-Aq{)uBb
zxdk%Eteul5ag3zKNc#1W#!gL2p{E??Mn$n@zlxzGD(8NUQ@%9nJ5;Tidsfs^>uKmZ
zmpMh3urD@WP!f6Ets4+o<9C!CJb*tBtGEYCHP$~k+<*+vc^UO>#?K=}uVy`|XC6@)
z6M}`NjBv`Qqh7LpTEZN+gnir@!!bXvkdj6%SiUDm9Sr6$_DIYsnI*+_cduv!@v_j1
zGbNq{64L?$omgzu2v46(&4R10a#rz8A{zgu18ph>%GJn$7KF5p0qR5>Q>4Li~Zwz_9
zG33KM_cd{hw0OcxS~UARJ6f}xV`aIIg}u_3wFghph11(UV&55^NY6enC+%lpt?R~F
z4{fHlDL>=q8Mc!;?wKOrvZ3dk*9G->@zj0XeDtk4M%-gPPV?P4+{mbYII;iPQY&uH
zk=AQ1sbh|`^V&9HikwYwmkx+AvGJ^!SE(3|tIcVxebGxk^>S}ly*3^4l22_eu8tT&
zvvi&8kZY5!VP19X)!?hBOTWbwP8F|C?;RPOeaYi)sh3>i%-BwH$(L>!kfM)cT-EAw
zEINeQmv_!KFMS}lt7e{q`pAfbl0f)
zlw7V>!(!lJ_MeRQs#|7=ioF@b+?_R(JSyghB{#1wo#*ze&34RI
z*|zll?6P$gCd8Fk@Ya^c|
zSFO})yE?{_a_#MEV}a5>udZv*F5&hzamm_n_r0Sd-@1DmoJGl{FD`I)xr$X}77ZO&
zySy9=cmkPxT|-~ywOt)=@N1vgmUBu=CtAIB=>-c8*zAclI$z?4>K*7Y_ilJ!XB`Q=
zD=eo}n~N$CTOVO9!&#Q)H8r9@)t1q(1Uxv#Gjqhr!
z=%KS%ykhiqs8xsF`YW9(#?z-@hU~7F-}K1w=Won39=}6U)Q4TBT?cfIIdD@Wii%#$
zbqyHF49y7K`Wga3j&XzDfwJLJ+3$HJyza-Tzp_F#`2@yNq(%xrY4
zMmfor
zxN@~~j3QU3=dHYc-l`GHb2^LSp;Ks$xr6!E>U}nPt+-On84s)}=emxwt)>lSbOnkj0o#lN#S>4$SSL8Krvjo%m`Fi7d?gj2V(|>nG
z|Hqn#?C7p>PpW?2buaGmA1`n4AE{>rqy2ex{rsQ_!d~o=*Vp(pGwQv`H)hKI+y^dt
z)ocC||Gm3AzP~lTQQ`c2xOaYh%s2MT=<`nabocqZKfiQ_=JS{EDR-X7VlP(OF6Eaq
zw!gr^-iH0#n}fWT&*mC~s@IYeWZ`;#USB@H&OEGLZH|2ILdLt~g0J(K;N9i>w4PGO
z`8{(6=V#+JeOf9&Bz@y#xXX9v>*qrmwJ*y4JY@Fu`D71kJ<82hozHBz+W&24UEIL*
zAkLV|!*qKWDUz?xSMS#6%^5OaOgAXE9{UJI{hW=wTBxtHhG>a9@xfyblAgKB$KJ$h
z=}3HYr=!dF*5uQT-3sQ6nK4{GFG_n!@7SMA*ZR@ijhOwd-Kb}}6Uz<#D%B6Dn{zSG
zeobGJ7~a?;r9ER_IYTMkJ^$%&{%c>)|56)pfBx$HuY9efGma&DL%*7Da_R;(t{2oe
z`P=##?S}jF&8@pqOF2IuFP}e4m$xK@lnOQBbf`^;U0iBBzLg?}Ri>x^YK_0Tszahq
z`RIFOCr{erRWswECS?>$T&NH)*8^cm@dqOY=;zTaXd)Vcsv|f7bZnLazepcQ7t{D$B-={|`Qa$)m
zcy|uFmvXfjFr$`Hk(;kg9z|nq#yWb)!M7?VBt8dalmCp6ATN-xNr8U
zGjUc6(o5ulo>$jwc{jWJ%(#T3#X|wwZm}XvtHCYHhZ>d-yI2?WE$hN#7LZ|mSf3x(
zlri^(SFhHHQD>;?H2DeOHt_Z8T%6v2zYpu9&MzSN%=ew07axthEvLv^)^lu5d*dQh
zsdgP_Ok4fvr)}Nr<{3u6ckBF!NA5
z9y{LLdpWJ}Ek6@6{q6Qm&T$x7y;gEzO4nQWjTl*1D^M$}!hti9PIkme8;?B|m%fR#
zJ281iuV*QXh1RcDseGjKCEcQ{M~d-m^-zATkA8pja_=um8D*iEW}%pq9v-PBshHWR
zqe0lH)v*m+`v;FU`B=82=cO*ge;4cr;P#5gWyFr!MVn>D_$f+#i&on^jyo1Sn~~6FR`wRN^2?0cGjUq}
zxJh@sCX$xUSF}&5O}yX)>G@s-$FCKx$GV?UeLu3w?^3rjV&7vi{39mJ>OI3!L;uZ<
zuIaeX__NgU^4>p0*5=+{`U~!0z^ob-W~A|AE9aH6>5lBH&OnRw<{qzWR?gUcHFsZ~
zPWs5jHKmPNEWW9k+iT<#G)|s44Z|tL=mD)K1sYl4#%S=JihmK;XhLd!=9cpJCAXA?
zkxw)(dNJyomQmXb)Y8Xel~4alTIq|r(DeIGi~D|(=l<Q_u&+1dpZRayLE`HE6v1`A%{y=&Yzjsz;=F(o+J2li<}yD
zr{h@JE`i5z@`Fqd$^3m*l@_tfUSk62d`e(yI&>Vr-oZjuNFzEvgz8NZ)pTsWcBX(!
zXcpRupyGq}4FB=Sh)eR6o3fu-r{v+x^6w?vQ6)F7UC9e4*bL1=h?5Qqknx{4Vm=k%w>Vgk5f-AtCRj;&Z=ELWMbj0sWRiF4f&(x4i-|3;G?zVa~3$FlWy6VuZxmw1@z2V@tw
zZ2g9@^RBJF=-3&1_Cm_dU(V0ADgY78SP!bx`!ByC$Sn*95xv0-?oSE1
zjUHda!m>$;yZn2ynGIR^dPM6U>J9XQY&@vadvxKI_AGE4bYy|;@Z5jQ8^m%(xc>{S
z8u^LzQmeF7G~(YCe`l}PzfA^L+y3#hzMn5OsIZy@;O)MOBfU6#Kz1r4BYSx3>t^i6xnsanu^H=pMh5zw*o<&IJ-J_2G&t6J7+(K-ksFi_KgtR-J2%;t
z7L*u27Vq{wb2IKqQDX<}0yY?@Qg-Mk$pzJ!f@>9^9a$u`KqIax+Q@7>thZ+!4BG-5
zC~RVt>yDmQXhivjMzqHIEPYkK9lpFNqGy@ajy12;0IAY_Xbq5!=NjSV%ClBJD(l()
zbLRhpyE8iLi7sdAtowKGL6?uTouzC&YiEs5W*x0T-D$racJ#e=-UXd^qq4i#uUR{8
zf4%GvZli0_szI+(!&XIYR6$Ws*n&j4fWx$QjEZ4{ueICt=TzI`8RQ~d2rUztyktc4su#c;z}lKDP3R7<_S5im8tpR
z=UGm>jvzbB{(CmnklBYvd6&~UVjq=pPdf2#tCg~Af3R}aYI1oTCoaEER!)7(%DH>z
zuTJ`uIxD8s>JTQ&Dg4InhQ$9z|RTYn8cP
zHv9-{B%|82DLdY>jJ;R`-PwY2(znd22d%cjTlyAzc5ZoZhiszVCOvX?Mt%C`Trx`K
z)Ptck1SPM6d$7;
zYlWT{DgNe9-D&;m(_3l&&JA9m9AeZT0Y5ufA@t}Ub=X@{@|~km(~#hvJxSMFWhn@N
zt$7K_$Cu)2lA~$ds4E|haFr~8aFxTPwaNflG}A);
z*^7JP^3hd4D`YO7j^PQ3C%!(t@F%=j{lkyYkC$Q|-s`=c^=y$&2WiO==Eec97}VFj!<9%XC60@E(MPqrR2IMI#MIUZ13{3(N1
zkN&F9%G>KqACjpq|WELipw6Y=bY8mUK;hty45q+$f}X6N;v8oo>=8sdX4i;IeyXm8Yk^pD;Hy>
znzo{)I(He;xZWkNr&ehmT%}`w%wU%6VtN4N=*>RP-KcIi&Yj;XYnoBDa`&exqbBv|
zZ$}Af?*tZk3D1&u(N(1_Y3H$-3f*I6!*Xf$W+Ep^P2&Oa8o{1;H*h>vin-
z9QWY4648VRqWUh%aix`ys&DIGJ0wQV_C_zCqZ`XSU&_2WT6dIb_P%vTnb$iii_t-N
zW;adCE*Qm9w`>^&$6@RMe)79KD#R>4p+>({%p<6??7j6lTRp|2ipO(V{z|}YIhsdh*Q3bun~)t8#{4mr%PH!9_m|P{yLih+#@`8(W<>s!9U`mmkXPDK$#X_+FYnKQg;7U}xbxYP
zrkCoa__+)3?&^WQcirB(99W8r{fgNy$CPK3iC{f;d|!qf@Q%M2rbw4{*hyq
z(+|1Nm9_3>#KCd?w8Kw}@z|YxG&SGgj@R^i-w>`xGjAU)U5^&tK3cgRtz3+Dv4e*(
zulDvhayyP}Zo=?QBgdsaH;zyWUXQB3H#E~>hL0mZ^3poB`4vZ|!ZEsLqabQIrS=w;
zQmeOjT85U2-0!5gINgue0cS}6`d<2+Rmdf-a0W$a4^`q;p}xw$pQ4GO*J~?$7!eRE
z#`LY_C3TE_JV}m!H+d=g`hvU^fom_rTdHJFx!nS4dF%Fl*!3c$o`lFUpGW3wiX?C#Q7~H|)$qhkbv1
z@$AMsdgSWW`#7W@x!4SP$UqDqi^ZKbN+Y!~rOI9fXb7V>p&eUz=uh}%-B8Fuj5b7~pObW7v9<(E;}J(FLVKOk;m)$`AGx66@66S>FF
z&x_eBj7bHb*)rsBLgH~d^QVQxJsc>m{?1p9HTn#SxBX*BN?R^y#a%m><_L9kp?DNZ
z^}gNpA)EBs4t=svPb=9qbl(f553o@Go%1!gE9`KI-E>B7HV4Hr_JcN7HzHJNYdY51
zpbcZ%mi3EurLJR<50cAfDXOg0#7VxZOPP#O;d$-ROsA82Zx58tG7yzT6zKN49b_R
zb*sH$@}?9pYvAmlokz-IR;#9?ls@5MgxW1~BVWQU+K3)>&u_EZY-7hboB=~pKO5!L
z!apv4a;18Q_>f@_d+jZc;^2Hs82xLgun@b$wmWIVyv363yC=bd^iVtHgz8%N025C>
zbP*~tNrvbPjw!SorDKy`^ahKQG}GS{&W=7>1lHQdYu(#nA2`*%jfa@aV_fD-
z^JUq+2;xyw$dy?;KuQe~7IV^$;#`j|2_~LEyo$a-tjT!LrUsJZ*fW9i&E^B=E7lV*
z&f_`G>uy9H#IspbengUOR@ZU=M?}*OIc($yEs@Z8V{peg1-V$Q?G_)m#j$CnM@Jd{
zJjJouL(JXqBx;CPhv(%n#!f4%&arbJwZ1hD{!TXdx<^X{F@)b9B0HjWl?vwTJOiy-
zPO(!HFuGb%p+`AJ6@j#t=Ge;}!?d1;b^mq*@s^Lj#vq1~aW+og2+-hXghQR3LG?~M
z_xydWM&;k}^XMBL`re~i{4e?-X8*ZKmx*y&kIL`kCucNkJ1(?-(T0{t#PHsIn%PgB
z?VRM6nv-HtKA6HcT&i;GcozijeN(s!sF*RwSgtqNu4qkkKXyCc0e72EjXzi
zD4l~>_01WRQLMU}V*K+9x;*y&nfT~Wsms$+qxCsH`Zg@;6EVl15f*3fb~t;Thdp1L
ze(q;DkV>UX9
zS)z}At$hNnJn^K3;IT1`tR_1%EtjAEpuZ1!c2-=8)AsQ}HR294Gz+I?W~9Hi=V)ir
z$bDF%S?^Hd5x4AnF1|qI$BAr>Y?^(va>|;);T`M~B2vx8K)c0vG(qDEAO6p;Qm-?+^``nu0^RCndC#;wP}!vJhkcT9>CL%vyS7t
zWn{8*cCi&IXiI7IbMGFkV>V}E4WT`TnUyN=TbwnAroaA$PSuxgu6zG$#AAyQjeWF?@;7taHaep1v>R=L
zAIrL2zh1JPyJ^X|3E{BjoB=v(M{Pr2*p|I>^1NC4)}}#XNDV|%r4ZiVCYp-q1-
zWV*Wgb0_}bImPdD^rbU!8zXG<9dF1p+GR$(Xx~e4Bd(UxTbSM3Z+D(`OO)SQ(S#l*
z9aijiOMD%!PzzBLe`vSD(9^eiKCyOM(brEOjHEnU(d9Ag>KM&GV)y&xzrc=q+cJJX
zlG4t6D>Hi(EbE^3;jJP%V@-^ov0M!3eRCGt^(yX1h@K)s$9eBZd>=UsPgdo76yFD~
z-?H1;;5TfKO1+NlOd9EO)oL#=e(7NN4vYsKcmd<1$NR4^o(W`Extp{{&)tn{FW_O>
zA_ZK!r`_Fgu|aQzM>@w_`W)raj>l(b
z3g&>Fa1$yfE;dp(dWDIzM}PEn*N0J;9o82e)nD!nuCq|*S&V%iaIXITQ&wbu|AnRhM{jdx^v#tq$J570Hi*qxh<@~rOw{@;d%_fh1Ri{&3{24!(
z=|G#39o%GoVg@#jx=0*pKXtch!2AyW2|lw!HPy4$jq{-gKPq{63Dz?{&)BrDnPI7Z
zk!F+{FK9+-TcpdJ=gynSL%>{*7;3dT4i22@8Po>kWuRn
zsM$Yb&&?DwI@&Dp(aV~7<=78HSIf?%dh(7q_Je$3{9L1nahF-D&JG%RCBxE=%1&YT
zD9_xzF$WXe4vlmFpP*md5h#oXJVu=4B=DP?oa%gXS~_>|r5^MW
zZEQJS&_=t^Mth=-vkJiBzUhltN2z_#M*Q4q)DEKwvQw|tzWV5U~j
zx|7S;{oMbB8F3@3let=U!MCp18QItod%fNfmy4i!iCEJ7KHpUq?Eg@eYXJFz*<-6f0A3cml=g;x;
z^n?_benoNP&1*fxQP*$&JdSc>&96Km#9Ff?3?H5Yt^C0Kxv~3UzL6r9TPf*TpSYw2
zl(@x_jkq}fq${{u!&wGqF6XG_K)BW7p9iDf$-x($mDJl!|tu+CwNq=l#{^>uyh`+vdN7t_}|Mc!b
zdjImbzx@HjG~c;L&3kQ1g8&RV<9w4jv$$v!IfD;bsW|hWzy4gX1o?+AIsKT%@0<5ELAmkOfccP?Ig00r*-yMX)VJnpe%)ID^lnC!=j;js@fzPeC`t*-x{L65A5b*<_iD
z6w7-@0oQy||HWvn2$6bijVO%S!akK_r|55xzMxu$6-!l7HeOVfS=uw
z8E{h4sra`WVMivP3ZyUpuW-rx3?F~zELg$PN{0luP_&P4&cYTCnESuuqH|a0u`Xua
zLdLo6_aTAk8SIYqafbDc
z1b`8odMHo*6wZ8fLLOAqEgf$O@>6V@_W=oc@|cWAQ~YyuXfZMvb21;iW~>#n2#Ppx
zYctbdgpqX`U5-k@G&;Vd{O}ZA8A5J26~L9;*(`8bjPQEo)Gy~6-QYRPT*Gusshgj(RPDD_<9Cty?<(SU9eZVvaY|6-y6cc!UCInpSHMPq95Vy|`0|JM&qTgB
z6WepmjL~&I0KH3Q0JqSpM(A-y;eSw+l=Mf;M7>e$hoq`T4{OyX$FE<1`T!mFA77vS3kXqv=>3QC
zmmh!o_sy8FQU;z;{Q1Z9>%aW)(+?8`CG<>6OQVGR{P4g1+UocW0%+iI_~9o|ne@}2
zr$HiuRtT5zLHjFC%KwpmODl2u>4(2=^d&bfKvELU3=TkIl_||O?%HLo*wF$)P3bxn
zNGKroP1h=VYAs|aAvlzr_t(uNa=p%+er^9(YyaAQ`7deGADtuKHa`4cKm7Km`b+v>
z>Bs%BS=WNZ$(6YjYeCL%o{Vi+PZ3b>n$0G#;Ao@;q%sB2;e2P?K#a3dgdFH<{x1gr
zi2;Pte&rF&>pXaM65D@nseJwUpGl4PGyncA{-ynozhFmx-CzwdP!wYnfLdgcCMHlm
zQv#Mkwqu|vG$R|-v}MC_8SORX||{KLyJGDo%8-HO594E0~eD8kkp1Dzf2~QK%O2
zbTUlZRMkgoD&3}_=T)l~7{N>KGLH!exo-*rcWconT0${R44NB|70P33fFy+XmSl3w
zR&7!Rhu1hA>o_g{{;%nm9}cJTe{R41Y2C*F8N%QdI)l^)8$yU#U?XutP0LIvgzOPU
z`ThbX+aZOp@VI1)0LU0-$Ra=d^yl`=uU~%#Q>_2?Yx{Yy|DXTzEV6M($w+#+gPdI~Zh=qIF-B_+Etr
zV~A7Cm&1Hb3#~DkNhiSB10}}vO6pU
zx{=G?*Z_V`wY_8rQz>QzK?7o91TGbb9~j?4zmLGtTf#xiwH8PvUPsCSkTNXx*a;8W
zz$WJLL2uBG{kKhsjZp`XAR~kxXgYEnvFC(?>yYH|-~7bj>f-14GPmwnzT}N-Z~A&wIPlL12L?KjyCWU=^qO?g6p1j-cNH@F
zDj+B)W>+L{?~tH
zPWfx%fjx==E=TUhPwB7co$?`r=g2fagDCNpeDkiXM>&G*?I<7cdMX6{zx?p)Z)A5z
z@nH9+8T&%K3ZH;J=F_bFt;(7^>NzP1Uw~NmSdLhtlV^xn`lX^|h6U&~4bl
zgu77+24_E?O2G&_LM8BXCi~ETwT2<*gKdlB4M(z|Q~p0IB}o+bcuEok2f3#t4coB0
zVY9ng=155WOda`(q>jrFyrNfY_-xkk
zawz#Z&;^Io-VbyUD%TeRU9No)(7CQclkNxnYjH}6*g{@rQ5Ug4Y1S0`CD2M}W$go@
zl0xfv8T_+{C<#513C2&(J((i~KL*>cg>#?~$r*UhvXh(*!>86zd!hYox`Lnkcwwc)
zqxbpUfaovjCwd9^3Cn(@B@p;@wr&KUk02!IBJCW6w2tt65E2-u
zzZHbEj`&y*67PdXJvh9GBSvO?hho(ZQ8r8lnDI5ZD)kmug1_gR+`x0S@N#Dlu?K^y
zzMr~3=g*E}3o{UGhc_1~nM%<#sdO!UPtf3+@z#`)3$I=69V`M=;{-RFSsY)F7-?<$$d0Y6}VL
z!_0xoIZ&vQLQl5U)S8xsC8xZI;0Li<-@2>PmzIoEE)I7;&T?o8Aky)BH3xb|G%+}&
ziYj9BY3!b&8_pz(3W@=WAq%KX#)b}x2*p8zss#f+mhPDYD~NcitYx8;Q@T{>+rB|q
z(mFsbjJ*ix4l+d`4hs3x>s%B?STSxP&`I`-iXaA77`hSIvR;DRUq&&dGcB!1$UyPy*eHv4-V5LG>(X
z1Kohy#sJk?_X3GT*=Pzokh0ab!I1@Bh1TH;B%9~$feO+E2zLI5J@7x#9;goXKvx22
z{4Imva0$2cj6rZUNsv+-Foy_Wtoh}tE2(BQ7P_soGTUmiCczIQjAv`l#$f}p0t
zkZC>)YE<)>m2MIgh#80E
z*J%Z72a!2j<|ST+?3+5iZz1fM<7PUwhdLDJ&ONt6@u5^f-7pP!Ahk?FMV3V{_;6$o
z1`FP(q16CZKw8Kpl)PoPQ7_S%ko#1oC=MLyKolF89ORp?CHEFo6P4wBQg&p*SpjQ2
zIDBN1KF&1M>Ix|zs-cIjDYODgW!eWN%Z@+?gMbf-&;$s&lIaUQLp20Or$IhIGGgut
zBY-(~cC~jN+G{t`XIzCq6(C?^vI&bc9vk5SdnjC9GkOd{B&cGwO+e6+2Kx>vl>tHp
z^wD7kOm!+W+63T=z$7Y*8;1%Q<4|`97Lf$ajhZ>cHQM4B_6*Ti17CAl0}5kS3QNG5jH(va60))~J4kvUA~;0J08Jkx!1kuu
zutITSmCa_L<#y)ta8DsDhlnGXxBbGA^ZOn?$P0;nUOW3Ul4ZuUpfE;2pT~V!q$k?cIf-%!lvZ@D4I3JvOh6ZbM&Z3YtkEkE;+OFRKrD0zwap*_4T1xe
zF~uG>wET#oAsrOv!vGMq)*ee{l|`Bhu|~h`<9l&--ABWQUk$1l6r8TLfT|v$of$_j
zo~0sHeQXLe68zt44NVLT1a~BvC4_)|jo`76JpmSo86F4Io0M@96~qy20qaKR3U;Ew
zm_R2S=tYM9FELapPLI0(V~wl?yW%`C#f^8YxIO+_K6QsrCwwf=;_|6Id}@|c;6CUS
zgbz9eW`!Q8lVvAO0aOD?>mJgvDnOX-@gMj@mZO0ZLvJxK)cY7g|Hw*wWvd{$tU9b~
zeD^5`A9M<~HA2-0Jylm@Gtj`hZ54dHN{0Ew0_NQWIB2LcW9vp$WP#Jsz$L+hhsAiI
zb$;8&_nw0AL8oBf$IK!wy%!~A&!Yn*1R{%N4^Osl$utZRx&!CxtwbDd3qdUz-%JHE
z%7tPZp3nv7|F_`<67sUhKz6Sr^ugX@W1b2m3D=9pWWX5`u#Y*g5kpB|Af`gla1(fWd7hfF|a^;`$XYw7!N$8)*j5Q&B4eO@>lJ6$#Q}NU>!oAy9ezI0fH5FOW4l
zYdbg^4Q#+7h9Y4~nvoNf;jya#J`)j16=F%+y5HAM+3fEr7HDiA$H?)oX{x$_F>WqZJWj`l_}Yiu<%znXwe
z5X?m)+bRKDkyt9bKuymM|`FBi{L6S>OO5t4{`f%~|!vMgzu^JbR3C(E8T`6XUSj(VsTMIyQ
zmm@Us&p?w!4mkm!MA!lX0iR1{K>Rfa#hp9k@voypC+-VYSEV
zu-F>7l9Yk-C2I&$u`vqd6VT*lNAwUBM{GAVPEk7EACnQ#DgZMj17t_AAf{BP992~q
z8DNLXE&A_(A}dx-_f0EEQi+mNme3xeR}J%F@qdtIAR|~2*iyu1ht3exLgwpTwx5C`
zTij`I40AP!Xbg!MgF0_;9I^8(B#-w&;4rCKC{;leRZUTbk%O$o{QXm8!ELY5bcIn>
zM+d~P6(lt=UkJpBmLQ1C5StSq8bPil=97K1NAx*%tmNHZj60~sRFzU!lQ(1scon=-4W2S5YL)2Fav3p*l~da%&l
z1q2A-uE$o%rXYF5Tp6BOEHEqy5F`j$Kr+cQE1focyE;D??sB0Zmp|HPn`9DgfV2ieQ)u*oTFI<93E!3P2MIZeqob%KB9}
zwh8mVx)~b&*=e$5>Z1fQVDO%m2hD?_Oa`RKrQaxFcupgb$?u?UuC6_t`ZNi+l~rE`k_s{9l*nLc4*gYit0
zW1YNS5)NP){fKR9o>gfAfK(KS5vyM+R~n1T=$fql9njRLJn#vj6YuJew$e{o(#+I>?1NJ+cjuWai
zB+EeSRDf6|81liMte=7+PlK^!8iY3y$GEAUY6Dc8fIzHp4GJxgj@&5&4cLKJD9t}~
z`1}-EGrcB8h*zPqz@Evu(;!uCN&tn>kP;JUvIl`;AWvjOm;}(-<%b!9pMWCEq9I@O
zYArSe)JG`^o@1(sSTRlFB1vom7?N;48(;`^gJ`fXK(bUn14Whsij8OG7HH%Qcr?*6
zpe|*O@&oDB9hW3H~m)T1px
z&(3!5P?O3`PW;|!vf!t!;D|7SG&0pDYN1Oij1x9sp9VXFou_xNfbAC58`K4n7_ggu
z2bK%Pgx?G~qFDj$E<)px5H}ixLyTjMg8t(|XJ(cvOm+tON+jEk$Zf@EpvekrVO11X
z1ZYMIj|H&R
z$YKmwVFVRQMhToxNYW-j#t
z_+nY=sC3j?ehQk5)pTHxs;qlKFoV-{P#~ui6F9xASwY5tx(?E03P_WMG*Yx}g1SNa
z{4`ls2aVP<8=Acf69`y0R`*e(1_Q+=vy&|{8mzGfjct&q#{eeQ^eN)t6r_KFnXnWz
z;6gz{)sS`VEN*}wK%Ruz0z`P1R;Eyd1~6HafgG+kol#-};-PX0%&Eu}lu?kOwG)}fyWas#R>@$Y
zg=xE)zG@|z4XKEGKv1yoAD_eR3)Rl$Es&KLJf<+hSEEo-PpZt6^9P
zrYTMGr2*Wwc{O}_uDgoKH5RR6K|sl}?dDU^WXVcLR&~IIwbz`C*!miXIt-7AfV;px
zy_nQ)JQDr%F>%cTB4aSvd*eB6()THrCQ9lq2yOmRTdq`jn(?1+9v{>d!!t
zA>Lc4r<5=#5wMqe~`WXqo-=7KMGviQ)l1=FdmKt4>0;j1{F
z0&hvcFUVEKd8b&4nI#?!gYI+uB>p{Vp_Fa1Qwc4k-;a7#PTbEVgi1!9V76Z#&e4LDzlNhwvwC%YN3~);np#ZE;;gE5g>cBnWTyDWWb!XXGXzRVq7%0hU+?NKdf_;)7@9NSs#ag&DG=
zj1EUz`r>nV=a7ea&Ry?M~u@>;>r^y}2#nNA#we_r6S6C6eC4enquUP4{Ym+Kw
z31tGa!tWt^s0$59@fm0`F2fS;cx)7+$^
zg#HtuE+k!hHf%kpOa+a0ilvL8^G4N;#mU9`1E{cJr5w$~)lWf_ThGn73N@A*J+9jFs%cWT6dNUFhS(sIjCXphc+9K$8U#w*{*`?Tl4~+35iA#B_Cle&E=^
zPC?qh>TzFo9uQ=#Nx(9G2Od853W8J-BkPK#q%$K{>Al2Wvq^`uf|Vz|#dw%2}e;fDW#8}akgWS|O`7mBoW
z{2t>!9fi0rFPXj8nm5
zbQV9s2BptHlOcc8+mglIdk2Rs-1KFGE3SkQ<)0UoPhy3iUguL3mMeg>M1
zIapZ$RRc}cN3hgd6aBOfQ_&Erz+P1I$uLa0d&!0tiACg?$yU7o{4`mD_J+~#2&}gi
zRT>Vu^%Y}yoNo<*%D0?>HxRP4_9GP)m=ik_4cw=YlQAC&aRGw>@G%D9T=L+#N!DyZ
zjcb8c&&E#Bg_sn>Zet)#R02Kl`ZM_WfTfUr895>fFj?xRwao!ipkoFxBc@Uem=YUK
zD{BKQaN5>g$wZ&ePm!tHW)|lG;D7=#vQsryFI^TL;sZmqMT?SczRABdFjgCEXJh@X
z`WZZYEd&0eYYx;M8(FGEd7uN^SX2-oh!_eI2J{2K2uwO^Fr1FVE2=K}Q)G*Xq&ieR
zYC0`<=x{EwVtcb58Y@-+?ZyaJx=#k6Phmuc)y(wOLciaqr^mp#z}|gqhs1t=SSL_W
zLTu8pMJKvtfn}U#!xCx4uB0#%VL9*cDe7}d4`S?;$Sju5g36&lbP{yYkGhpQdU`^V
zOVA98!g^Z9)+Pm@mYGHHy;Eb%NF>v(wc2%PI?)ReATJaNVYsL29W%%kcni}rE2k(0
zR9%A|GHG=0`}FiUrko%Rdf;nw?1<2{WB`yrZ@*QvB%ta*WGt)|2VIbrF677=8a|}P
z`dXO%C!oh9vGnD{L@;|hp2~TWpa3r1AT3F0lF%S!qJiP&x^r
z7c+a9rD_@cWkOW7XOV5{Ev3pZf7NuHJ2*`UPSc?yUtl%r&9r6cF1F_Vs4NOs~aPWP}eIK1d7FHh`2
zseP5vm36B);iYkg$FF~{w404opWROiA!W?%hx5$Ev&Xql6
zo4Qupe7CYpM_C|Zn|___ZSOp^4Y{uw03rK%t{seSPaq2}7>_yd9It9L(j_8%qY~c
zne|D`mFQnm0Rh&wt38)==;?Y?rMtOLc6-v;U9i}lCAFfwnX>&-x|Gqo*0VNnoRjVf
zA4w{OQHZ)B!
z_R!F!Y41;WX{h3=R703fKMS#?)|hhPDXN+!4aK3fN2#IL$AbP(VDG|>uxbc&9BAdm
zZ`XkLdSF+u9=5re84Dp~)$E*DP-rDcDA6RGcL$&B4*_K*)j*!m^rX7FQyO41BuGKe
zDsy0}il_Rd%7k;pFV7RDal6tje6m;l4hT7jpU|^yTZg+cnnz};T^d#E4AOtHVr?{VcCumGD<>U~ZCWmaWVEx>?<)G4JaBm7`9amI`RXvbV7qs_Nl>|F$&r80(jDQU)!
zl8jyy>wdTBolxY=Sg$peLGM9Ey-y3N1F6PSsAR8uASco>-fud8?nQQ{iU34f$s;E$
zFBPnO4<(WXNh~|5HpU54yn|1MqZ|B37Zk&gd|>mb)fF!J;^qiS(7$qc`hpN(gbW2?
z8na2TzaRWfDF^jcOP>x4_GSmoU%V?8|aNJqFrA3J)!5C`=H>cNE^
z0=!M>*^;~}x~qtrp4(|lgGCIe^vggOs{&;giSorW%|Wl5{Yq@}*WvIp@8A$XQpu
z3Ur|_pmaXkdj&Q*6>tnIKZ)BSbf}CbaU3F21TS2r5P-|l;ZP6~Ns=Z7h9<2fSjAk$
zgsxq_$9{4wQkxr2@|XKqQPy$qZSC%=Putfmft8vp2V%3$;X{$wyA&w-;?Cx5|4cC&BXW5nAyGiX5vZ?
zYlRbsU*;kZ6K9o9#iW&yeDGrvbJ=Go@AVcw*=U8Os9P?r^cGGZTT-wI0Gb(Dob+?qRCN-va%-n?`LJ+d<7L0YJQ^6##)WkD^op}K7v3w10r31kvc
zO-{OmN_4@$mgDDTqsAogP}_YZz4iorGKhBri#r^4`=*Q;dd?_qO=!T#Mq*)(eI!LO
zu9Fh6{yF#55z-xevWtm+NlpTcUjWRkL>jLn0Y99i_lj34q}Fa46&sWWiE6d1u6&|9
z_++?1mBNpT(x_z8fyXm-5Z88~0#mX%gDz#&PafIKbVEK8bFduCPhme<=BV?axc3Ym
z$SC!)ts|4J(rIv^c+Se(XABAgh&k%~Xbd|5k2~ZhA6NFw7i?^JAC@Q0XX;1vfv&~5
z!%TZzwL5~l>Sjat_HwX7ymGxor3;=whgDc#KB{>*JymYwP4Pg)^#OGh@EZlCTxyJZrth-i5n_yK?s`nFQtA
zCtdk)M!Zcrv$O%_jgqMjx>ZhJH%P=P_6z%2_xH&m7q~kEv!+wMES2b~lX;1UFa+zv
zB8!LqEZu6G(#T4gpYPX_3^utFo6*jUOSdQ6hiN%R=Q158U}VwSYFixrQOK)IOFRPH0=By7%~f1`iQltIvRi6cqN9m
z6=0_3v(SpID_^P*VD#GG-zR%lQdtC|;vn~tFwBbG*9Me_+%rLN`U2P@95Fzc?l`%|
zqmR$(Z*gY?QaAE;SnLQ@I?WjX>{S&zXS`Po^kzy_(k%urLVK}J+#7%r;&6|OaH_ha
zJBq>829sl;i7|3JD!Vf^IS0EX%w{<$LKFDnINuiJ&@k@%`($T|xH#V!S=9{YtVx*(
zj(9Zq4@Sszk0Cm^n2fWE?t+!z(p9ea7CzZZ?I*8@hf>+^w&4W^t>Z(wU@<&F`ABs!
zU*!QH^MznFViM!M;?8I9leGbUBy2TS$~vIzl_=`O{*Dr}L$L&nwPk5HWuOB*u!kLw
zA5w990zSDwWJ7@QY9}hqp;!!ohazCuv~kZJb)U1%u3TnXF>GQE5dT?kvY*WS(I*^l
zy%b}5hQzN_4Q!k@Q`{q#fP*_em$ZQsT{Y7r9IDb<_wdQESG;g#C?&wogu0lrg|0lt
z*cim)sx=EE(XdN~9h2*zMu#EgC$M)BCS+c!)NM1%=`{bS$ET{6RyWh%V%4U_usoAu
zlB@!r+;pgr?{Q~jR^n?AwQHEeF!IwoG)skiXS
zVXm%`I$6h<3^zz|W2Mzd;o%Zm{*l
z6hr4%4?szkxbNKnm?79y8Gn;!%D`x1mzRn)ZM=m~?)V#14ox-PBbb-8V$w#%T38+9
zrkXU~#jHnE)~jdq8{x^NQ0}2u-GIC^hem4_z-cH00Sg<9#OTBzU9TzPm2YWUu;Xp|eDr>SKdKt~&ouz$e#UgdtQd!7df7L&q4@9=!CP
z`0v;PG-@-4WvdyNDiZY1tj}BEK@DVpyFDAxXCu*BK@hyx!w%vB&AQ$_tJ~0EqDE5pasQDBVNa+TdPux6EME
zMSP9+gJ=%RKe1-+5DUDtpHIWIQ`K!(f}WRaRwn<9Eb~)TyV>i~ddXGSand$EW5Y^2
zKQ{;OiN*qVwo|PN<}2wM{|=@Cz=w~rgh4^Rz|oT=6<3J1lM@@7`ntGn+~Qm^_;PTS
zbqw8eQR;MNm?X#5QaovgWmz=O`X0J3yqo21Q1k@)Tj3tLB1;v`W_Rwu({#8Tcj=M|
z(bkwB5syED&06CuLl+upJr_J48DWW^n6i0
zfAiCVPQM?Y4jrrXXD1dz6$<%9Ki~BwX*(uey-HWF)Z(j8Szhb0cW@fj+2ZGF!Tf&z
zZ~>3)etdUHjKxXt>~XBR{GL~)(e+u-xJC$@%bN4||CMK7JbV4@SI^ux^YnnJ5?f+r
zz1F0SO>KBDUIMf)^LjD*rJB!aYIZAANDj9f>~D$
zt&xHz>+NfMcw_VJ^H&dVKIL;?@426U_4boK^Tn$_zWMcwSFc`vl1cs7&%J*zi1qxO
z=kx0q@7$1HdieU~_-mTjSZ=b(>{%C?Y;zewfDusLZ=I`I^_5P3FK7YAcU@yPA
zUcoZ=aYepvf5S5QH+yT>8`s+X=2JSChgT1C|KP)TbJ&~x?|c7lzy6KA^WLMIs%7!!
zpP#?|a=o@c+lx=S(#DHd<2QdZI{TZs-)Q}f@7kePA3g1_x6M}%yf^>%eKS76xV+x~
z_cb%}=KWajINVGLGIpk)K6SfFb~d_lMh_`elP0~cPK_=}@6@G#JV59H51pTV`+bk6
z$nmqIh!qBOGn8RO1LE)%TdJM|c+8MuSO?T{;+EF*ZhNZaJ`jQiD;+U^u2E#c)@LsZ
zh`9ao6GlIRsvM;baE-7El|$VJ{M%Xzsx}h=_NfLVlyCQAQAEXOHWb76U6TgSE4{+D
zq?Xud56I#F+(D-~EBgL_4%*erL;i*hT
z15<#h0^qas5eGPa-6e{&kNflFfRi8bl%E2}KlH)$;V(b*ZU4Ye`bE$C6pi@FC=x#=
zig;%@@*j>Q)&Eo^sRdI`5@EU0M33tBWL5=yGeh#bcu1|ghMGp3+KmaNh7eV0(A)*@
zKQfZQ-ND*s|B57^Ad>v`!xt1ke!Kr@^Dp|>{L-F3{O98cFu~uODF0|fzkB`s-3tY}
z#TVM+>)*GlSC8{@#?rPAp`zK*rhL(j;ecJ9LVzgAH)kf({gb`;dcPmz=MP_f{Wzux
zRw#AI9~-lD=IjHK<_QAVwN34?NcL-33bvHs=!dHxHxsJei>?BC
z;M&(L)q<*L(uNWUeSVfAIkkkJ#|G2!%MlcHCTCT`kbTDY+%_w7X0sq#2+~`#tg^@!
zrSy{=G}Jlfm}e5zbXps=+oWRswWP#^{|&cw@42n}klPMlXV&J$uA8;0BA+!Dhmq*E
z(c(*3CpE?ZB2XEE3afUT$QNgGD||X`Yr~c+$|*2#Lyo5G&Fk`X-!XVvl9l#mj9qRR
z$kKLQIDSZ^4=nMyq7rQ24A)9&Yo!86&kBomGK&Md$YZtTG|8!K6e)OHc8&f|Xm3-2lpN~rX
zC&4E_xBWkarhf7E5~~F;
zi?k^VQxaSf@5+<_`D_^5c5BT5VTY=fivpMv2~3iXH3CVl^OiKs!D4{^+LbBk
z4bG4hSP#|64ks^SCP!1?Xi3axgTi%>SZ2l-LokiW<$x8$>N8e8rf@gaLchS-Rnt{7
z7;9w`ntKGWIT{-GaCC(BrMU`(2qR#n2Faezaung+n3AF$Fd^Ngl+e*!!H8lm28$X1
zpJXJaWXiA>wfkmZPz7KdZS5e~Aj#LiRi>l^uFEioq;v%dtO8dG^T@&Ll4Fv&RX|Dr
z`Dn0&W!G4p19(4^&2s05i^&4t%>0
zS*p}98+UgAzgJ92NC-Nz_t>4U8KBEzb!p)d!fFLp(WYvwHo>4Z2xcV$8gqeZ4b}So
zx1uWfc>PMR7nu_El&VAC$K{`o80306i0JwDv<1<;u0)H3HF)z4ZUeY
z0e1rbu(bU$V)UFqenRr9V4d11=(CEMy&TZDf`3g|Lr)!krC&heMh`HJ-ZOANuQ6I#
z;2zuog?<`zXO+~aJKjMfmgq$S%$eXyeGytkKb1CqgK;Ws3-3qI4=nYTX3G-kYZL6_
zBc?wJy!#HEnl8Gy2zaPtq%+1h6jQplkrK!t70=SgEI@23SSJrS7fkW3BdlkqF+tB(
zMe=Zo@E#Ses~gvGBw>8k0!PK45yD_SMVY(8^OL|cYTlbD=5FEqc&C)Wb%g(MZEy|>
zy-PH;L%WUh)wS~Pf}RS%e#!~mGN6ABe*)o-Kc#^8(+=@>@?se~FJlSjw6~b}4ERM5F?+tf
zUPoonbLd82N}c;6KcQvqB>O?xvC?i}A-VU^lDmy>?>7AbF)_gq6h|&$vR%ngM?eYleQ$&|AQQ?S?Rup*Sc(wV()B
z@!it%T0;A3Z39N^;S{2UNN&a(BEbzV6ptErX4wJ8qu4s??h$_Mdin;A)POZKV|^v4
zeZn_~eb*8Dx8#{etA?ZFJ;f*JGu?-!%m%)n{(uhQgwD`drNs--VSns3jsLdzA&3Qw
zQ-6_XvB04jo_E-q5{%`sf-9_F#+aV%Y2mgK{Vnu&hvAvB$U#3O=8d8REN})jW+#Ek
z(`+PsU+^)00}gckRxlUq`c1aYH>|F+`Ihwd8}PLFjeEt@u6uKn3z*!7#KU&vHDEmO
z!78#ybe*=`m4b_pwMS?LTTT|-Q)I!c6uk%_h%
z>00Ye&&n^a;KcdIE_aa#uFovI)$=L8Nt-4LC
zLr$J@-N22Mu^gpbjGcO0f2eE18VInPz&08Odjf|5OMzkZ1oDt8$43~!Tw{b^3*v&F
zkstysNq*pVkXR(}e88vKDa$Gz?cgl|`~dm#H%z!?0jUFvAg~6sLvcrY1%J`~#5#j|
z3|HV^_ked?1LAAp8s5Rzgjw2xc_m;ulzZh)z^X2zM0w>((jJ%ri!eHj1lr-5GY%S<
zBWT0&EUZ=WkFOO7|CeiJ1L~#OPV9UFDFh=$jRjhbt}B6F*lKs7zMcdqDvmnA3kA*v>=^n{!l`WXA
zYelKJi0-q3W}3}_ITD647mYC!adO@Z1xfmK(0}5yZpaa+pCfJ@_0A+ioB~Xreg)PS
zMAGst(VxJOJcEC3(6I&QXkcCNh4o;t#$xlAl>bFKM&pG2qkmiK{3g5;pP||J_#2OB
zN8)@Ps;1NfxMy?D_~gC*w7nzdNgVn7;EL#HR^&z8vt5xlVdD3~JTGZXHm4@FXE_;YWXxV8uC?$H!XTTFy1CzLokG~
zacw>8{Q=!dwpgG%=6kJJemGT`n<^n@U{zHXF7%>(z~l~?=?qg3=)&Gip7mN0tx3>xKhe^
zc$?@u9dB*s0Ua+s^;R7(uKxo%-gSlEM>9ET2iwsF+pNXW2SJQ}N$#(!ZWs2CRvq(c
zy)7(aj7;slWt5ty$B~1z7Ili!qKm$DT
zIMyf3#0CepMb!b%1_`oOA~+%#?!d_SF)r55Xqvy>&*-STWjQcJ=GOpfVA-g+!`^#o
zqeTk*&GI*f=``fAEp8`&G31T#9k52nvY33{I^qIdc{IB5C$@P{AGNniZK&(A!|L(m
znSt@uVS9EXOFsKAtm{coHdY!l=Anjq=VK&>ua23Sgd|#6J-?Ickl+&c2(BdDxoN36
zJ|`PLC)@Ek_l*1*_7u)&gP!8@ah=zm;@{Dus^biN=NTZ^y`MpOLKZmE=;vkt_Y{<>
zok#lp!VL6r2I#lI?}r&k`v(2fvola03Hf!K&v6k5@UmL%_v(DaFUy{`k9=pC
zUvOk|lORFv^0ncWM3hlU#(RdeZfLEC5o;Uu0q2Ru#);hK(yp(^cF}gUX%{Ia<_a;>
zM{V<)v`c0-wC@f}ApgJhblc>m12A;Q9tBx2W~;c@Z#gj-fJMG|YW9!z6&i;b-d?H~
zyha)2(z>^(%M`>x4PQJdHH>X{53L}=G128G_C83Kz}#X9!d5)Cf;>O=TgI=!(rKE!
z0A`e>46f5(@pQ&Oo&{bNJqby_N*<1+i6DNMeMRA}i8r8~60a>ECy3epr8Ns7EqkeB
zIqaoQ7OiXxggAm8jnUW&gX6Z)V+ZsEf*xZTI>UrsH)f80b-S~ptKXd+7bE4RLFfk#
z3HeD{U$eH02?55rIQc=J&YBVaFe@X)?yM0f3s>8Os?Bf9DcGFoqo*<^;K_IWlre*K
zde01tSANZ5@|kK&Gv2RHdEvMHjx##7zJ!wcqGOXaV`}goVJko&tOWy>T*@6_!w5j+
zt%W49bT*LKR$CMqxa$^Nt4k=UE9gLPOvSo-z!UkFDlh=PG;ek6sRJ{RFwO~1rdL?0
z+Pms8>#Xe&$kt<_q@kLErJoum`whNU-&E>4`d6&8*NA#AkKyk$~3YbVl-3leuvKq{o0ocL#
z(zBEmIcZGd0yw4FkaYkN*jSgUl2rXTcvK-sZ!r+$DwNcf+#1$@Q^kVN+Is<+3>r1S
z9s?A5Yyt4ML>!?oN3n@LptxfzU>NxkO8S=9ubgz_@cf$+X~>ID^m;Lr)IAeQYB4uf
zycJ3sUkoL!Hr67G(<)*WEfChE0_>a<;6PV`%b^4`8DWuZ-(tsVc_7(G4>$VqiUf|b
zQHH?!5lZ@>7)q))p`;3ks?1lRq#=7GqUniHQtYcCMKr&zeUlOPFCIF=~&RXAWhthpQaKF#<2LF9|q{
z5n@qB;6+KX6(IC{weG~>UB4WzG1?+w2Y8JUQld`*AxfFnEr+iFLpK9LOo&PIQ@~k_
zs|CHwh7m+`GXqhu)O(x3BWfQIg34qL3Cg=57*auE*)jNAR=515rt61nWrjkmZM0)p
z(b7iiYa4b6Jm^cPhF~LzTJK6TY-0rJ4b_)fMNoE3Tum=GgH|m4UBf<7ouMQcUbzWc
zIRug{K@64xN9-E*l17jWhDmI~W%#LKWW!42ZnHWVT711a(zmOz8MS{t+XHo)rtJ1rcBVWz+;%Z~@8O?Ie
zZdsU!t75imj0Gz(h74$h)G}eTGdiVPG%N)S;i?K4=LUoIK-fG$x6xQj2!-2iKHU5*r
zA3$%qYJhmjAN8qZVN;OiAl!%RSTCz-nKV2mse$p#ihEVL%+p98?-^`ae2=p~7?P
zpcyIU137|`F?AXfBbg1bl7pQ`Fq4$CDMK1?E<5eZmBIFvC8!D(J`<@$-2mw{TimO=NC|M?gr0jSes25wYjHgqTj9
zmW^i