chore: Debug stream reset

.github/workflows/ci.yml

@@ -21,7 +21,7 @@ jobs:
     permissions:
       pull-requests: read
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
       name: Checkout code
       id: checkout
     - uses: dorny/paths-filter@v2
@@ -61,7 +61,7 @@ jobs:
     name: build-${{ matrix.os }}
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Get submodules hash
         id: submodules
@@ -92,7 +92,7 @@ jobs:
     name: test-${{ matrix.os }}
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Get submodules hash
         id: submodules
@@ -158,7 +158,7 @@ jobs:
     needs: build
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Get submodules hash
         id: submodules

.github/workflows/container-image.yml

@@ -44,7 +44,7 @@ jobs:
 
       - name: Checkout code
         if: ${{ steps.secrets.outcome == 'success' }}
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Get submodules hash
         id: submodules

.github/workflows/pr-lint.yml

@@ -53,7 +53,7 @@ jobs:
     runs-on: ubuntu-22.04
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
       name: Checkout code
       id: checkout
     - uses: dorny/paths-filter@v2

.github/workflows/pre-release.yml

@@ -20,7 +20,7 @@ jobs:
     runs-on: ubuntu-22.04
     steps:
     - name: Checkout code
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
 
     - name: Vars
       id: vars
@@ -42,7 +42,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: prep variables
         id: vars
@@ -117,7 +117,7 @@ jobs:
     needs: [ tag-name, build-and-publish ]
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
           ref: master

CHANGELOG.md

@@ -1,3 +1,89 @@
+## v0.35.0 (2025-02-06)
+
+### Notes
+
+- Deprecated parameter
+  - max-relay-peers
+
+- New parameters
+  - relay-service-ratio
+
+    String value with peers distribution within max-connections parameter.
+    This percentage ratio represents the relay peers to service peers.
+    For example, 60:40, tells that 60% of the max-connections will be used for relay protocol
+    and the other 40% of max-connections will be reserved for other service protocols (e.g.,
+    filter, lightpush, store, metadata, etc.)
+
+  - rendezvous
+
+    boolean attribute that optionally activates waku rendezvous discovery server.
+    True by default.
+
+### Release highlights
+
+- New filter approach to keep push stream opened within subscription period.
+- Waku sync protocol.
+- Libwaku async
+- Lite-protocol-tester enhancements.
+- New panels and metrics in RLN to control outstanding request quota.
+
+### Features
+
+- waku sync shard matching check ([#3259](https://github.com/waku-org/nwaku/issues/3259)) ([42fd6b827](https://github.com/waku-org/nwaku/commit/42fd6b827))
+- waku store sync 2.0 config & setup ([#3217](https://github.com/waku-org/nwaku/issues/3217)) ([7f64dc03a](https://github.com/waku-org/nwaku/commit/7f64dc03a))
+- waku store sync 2.0 protocols & tests ([#3216](https://github.com/waku-org/nwaku/issues/3216)) ([6ee494d90](https://github.com/waku-org/nwaku/commit/6ee494d90))
+- waku store sync 2.0 storage & tests ([#3215](https://github.com/waku-org/nwaku/issues/3215)) ([54a7a6875](https://github.com/waku-org/nwaku/commit/54a7a6875))
+- waku store sync 2.0 common types & codec ([#3213](https://github.com/waku-org/nwaku/issues/3213)) ([29fda2dab](https://github.com/waku-org/nwaku/commit/29fda2dab))
+- add txhash-based eligibility checks for incentivization PoC ([#3166](https://github.com/waku-org/nwaku/issues/3166)) ([505ec84ce](https://github.com/waku-org/nwaku/commit/505ec84ce))
+- connection change event ([#3225](https://github.com/waku-org/nwaku/issues/3225)) ([e81a5517b](https://github.com/waku-org/nwaku/commit/e81a5517b))
+- libwaku add protected topic ([#3211](https://github.com/waku-org/nwaku/issues/3211)) ([d932dd10c](https://github.com/waku-org/nwaku/commit/d932dd10c))
+- topic health tracking ([#3212](https://github.com/waku-org/nwaku/issues/3212)) ([6020a673b](https://github.com/waku-org/nwaku/commit/6020a673b))
+- allowing configuration of application level callbacks ([#3206](https://github.com/waku-org/nwaku/issues/3206)) ([049fbeabb](https://github.com/waku-org/nwaku/commit/049fbeabb))
+- waku rendezvous wrapper ([#2962](https://github.com/waku-org/nwaku/issues/2962)) ([650a9487e](https://github.com/waku-org/nwaku/commit/650a9487e))
+- making dns discovery async ([#3175](https://github.com/waku-org/nwaku/issues/3175)) ([d7d00bfd7](https://github.com/waku-org/nwaku/commit/d7d00bfd7))
+- remove Waku Sync 1.0 & Negentropy ([#3185](https://github.com/waku-org/nwaku/issues/3185)) ([2ab9c3d36](https://github.com/waku-org/nwaku/commit/2ab9c3d36))
+- add waku_dial_peer and get_connected_peers to libwaku ([#3149](https://github.com/waku-org/nwaku/issues/3149)) ([507b1fc4d](https://github.com/waku-org/nwaku/commit/507b1fc4d))
+- running periodicaly peer exchange if discv5 is disabled ([#3150](https://github.com/waku-org/nwaku/issues/3150)) ([400d7a54f](https://github.com/waku-org/nwaku/commit/400d7a54f))
+
+### Bug Fixes
+
+- avoid double db migration for sqlite ([#3244](https://github.com/waku-org/nwaku/issues/3244)) ([2ce245354](https://github.com/waku-org/nwaku/commit/2ce245354))
+- libwaku waku_relay_unsubscribe ([#3207](https://github.com/waku-org/nwaku/issues/3207)) ([ab0c1d4aa](https://github.com/waku-org/nwaku/commit/ab0c1d4aa))
+- libwaku support string and int64 for timestamps ([#3205](https://github.com/waku-org/nwaku/issues/3205)) ([2022f54f5](https://github.com/waku-org/nwaku/commit/2022f54f5))
+- lite-protocol-tester receiver exit check ([#3187](https://github.com/waku-org/nwaku/issues/3187)) ([beb21c78f](https://github.com/waku-org/nwaku/commit/beb21c78f))
+- linting error ([#3156](https://github.com/waku-org/nwaku/issues/3156)) ([99ac68447](https://github.com/waku-org/nwaku/commit/99ac68447))
+
+### Changes
+
+- filter refactor subscription management and react when the remote peer closes the stream. See the following commits in chronological order:
+  - issue: [#3281](https://github.com/waku-org/nwaku/issues/3281) commit: [5392b8ea4](https://github.com/waku-org/nwaku/commit/5392b8ea4)
+  - issue: [#3198](https://github.com/waku-org/nwaku/issues/3198) commit: [287e9b12c](https://github.com/waku-org/nwaku/commit/287e9b12c)
+  - issue: [#3267](https://github.com/waku-org/nwaku/issues/3267) commit: [46747fd49](https://github.com/waku-org/nwaku/commit/46747fd49)
+- send msg hash as string on libwaku message event ([#3234](https://github.com/waku-org/nwaku/issues/3234)) ([9c209b4c3](https://github.com/waku-org/nwaku/commit/9c209b4c3))
+- separate heaptrack from debug build ([#3249](https://github.com/waku-org/nwaku/issues/3249)) ([81f24cc25](https://github.com/waku-org/nwaku/commit/81f24cc25))
+- capping mechanism for relay and service connections ([#3184](https://github.com/waku-org/nwaku/issues/3184)) ([2942782f9](https://github.com/waku-org/nwaku/commit/2942782f9))
+- add extra migration to sqlite and improving error message ([#3240](https://github.com/waku-org/nwaku/issues/3240)) ([bfd60ceab](https://github.com/waku-org/nwaku/commit/bfd60ceab))
+- optimize libwaku size ([#3242](https://github.com/waku-org/nwaku/issues/3242)) ([9c0ad8517](https://github.com/waku-org/nwaku/commit/9c0ad8517))
+- golang example end using negentropy dependency plus simple readme.md ([#3235](https://github.com/waku-org/nwaku/issues/3235)) ([0e0fcfb1a](https://github.com/waku-org/nwaku/commit/0e0fcfb1a))
+- enhance libwaku store protocol and more ([#3223](https://github.com/waku-org/nwaku/issues/3223)) ([22ce9ee87](https://github.com/waku-org/nwaku/commit/22ce9ee87))
+- add two RLN metrics and panel ([#3181](https://github.com/waku-org/nwaku/issues/3181)) ([1b532e8ab](https://github.com/waku-org/nwaku/commit/1b532e8ab))
+- libwaku async ([#3180](https://github.com/waku-org/nwaku/issues/3180)) ([47a623541](https://github.com/waku-org/nwaku/commit/47a623541))
+- filter protocol in libwaku ([#3177](https://github.com/waku-org/nwaku/issues/3177)) ([f856298ca](https://github.com/waku-org/nwaku/commit/f856298ca))
+- add supervisor for lite-protocol-tester infra ([#3176](https://github.com/waku-org/nwaku/issues/3176)) ([a7264d68c](https://github.com/waku-org/nwaku/commit/a7264d68c))
+- libwaku better error handling and better waku thread destroy handling ([#3167](https://github.com/waku-org/nwaku/issues/3167)) ([294dd03c4](https://github.com/waku-org/nwaku/commit/294dd03c4))
+- libwaku allow several multiaddresses for a single peer in store queries ([#3171](https://github.com/waku-org/nwaku/issues/3171)) ([3cb8ebdd8](https://github.com/waku-org/nwaku/commit/3cb8ebdd8))
+- naming connectPeer procedure ([#3157](https://github.com/waku-org/nwaku/issues/3157)) ([b3656d6ee](https://github.com/waku-org/nwaku/commit/b3656d6ee))
+
+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` <br />`/vac/waku/filter-subscribe/2.0.0-beta1` <br />`/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` |
+| [`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/reconciliation/1.0.0` & `/vac/waku/transfer/1.0.0` |
+
 ## v0.34.0 (2024-10-29)
 
 ### Notes:

tests/node/test_wakunode_legacy_store.nim

@@ -46,16 +46,16 @@ suite "Waku Store - End to End - Sorted Archive":
     let timeOrigin = now()
     archiveMessages =
       @[
-        fakeWakuMessage(@[byte 00], ts = ts(-90, timeOrigin)),
-        fakeWakuMessage(@[byte 01], ts = ts(-80, timeOrigin)),
-        fakeWakuMessage(@[byte 02], ts = ts(-70, timeOrigin)),
-        fakeWakuMessage(@[byte 03], ts = ts(-60, timeOrigin)),
-        fakeWakuMessage(@[byte 04], ts = ts(-50, timeOrigin)),
-        fakeWakuMessage(@[byte 05], ts = ts(-40, timeOrigin)),
-        fakeWakuMessage(@[byte 06], ts = ts(-30, timeOrigin)),
-        fakeWakuMessage(@[byte 07], ts = ts(-20, timeOrigin)),
-        fakeWakuMessage(@[byte 08], ts = ts(-10, timeOrigin)),
-        fakeWakuMessage(@[byte 09], ts = ts(00, timeOrigin)),
+        fakeWakuMessage(@[byte 00], ts = ts(00, timeOrigin)),
+        fakeWakuMessage(@[byte 01], ts = ts(10, timeOrigin)),
+        fakeWakuMessage(@[byte 02], ts = ts(20, timeOrigin)),
+        fakeWakuMessage(@[byte 03], ts = ts(30, timeOrigin)),
+        fakeWakuMessage(@[byte 04], ts = ts(40, timeOrigin)),
+        fakeWakuMessage(@[byte 05], ts = ts(50, timeOrigin)),
+        fakeWakuMessage(@[byte 06], ts = ts(60, timeOrigin)),
+        fakeWakuMessage(@[byte 07], ts = ts(70, timeOrigin)),
+        fakeWakuMessage(@[byte 08], ts = ts(80, timeOrigin)),
+        fakeWakuMessage(@[byte 09], ts = ts(90, timeOrigin)),
       ]
 
     historyQuery = HistoryQuery(
@@ -657,23 +657,23 @@ suite "Waku Store - End to End - Archive with Multiple Topics":
       pageSize: 5,
     )
 
-    let timeOrigin = now() - 90
+    let timeOrigin = now()
     originTs = proc(offset = 0): Timestamp {.gcsafe, raises: [].} =
       ts(offset, timeOrigin)
 
     archiveMessages =
       @[
-        fakeWakuMessage(@[byte 00], ts = originTs(-90), contentTopic = contentTopic),
-        fakeWakuMessage(@[byte 01], ts = originTs(-80), contentTopic = contentTopicB),
-        fakeWakuMessage(@[byte 02], ts = originTs(-70), contentTopic = contentTopicC),
-        fakeWakuMessage(@[byte 03], ts = originTs(-60), contentTopic = contentTopic),
-        fakeWakuMessage(@[byte 04], ts = originTs(-50), contentTopic = contentTopicB),
-        fakeWakuMessage(@[byte 05], ts = originTs(-40), contentTopic = contentTopicC),
-        fakeWakuMessage(@[byte 06], ts = originTs(-30), contentTopic = contentTopic),
-        fakeWakuMessage(@[byte 07], ts = originTs(-20), contentTopic = contentTopicB),
-        fakeWakuMessage(@[byte 08], ts = originTs(-10), contentTopic = contentTopicC),
+        fakeWakuMessage(@[byte 00], ts = originTs(00), contentTopic = contentTopic),
+        fakeWakuMessage(@[byte 01], ts = originTs(10), contentTopic = contentTopicB),
+        fakeWakuMessage(@[byte 02], ts = originTs(20), contentTopic = contentTopicC),
+        fakeWakuMessage(@[byte 03], ts = originTs(30), contentTopic = contentTopic),
+        fakeWakuMessage(@[byte 04], ts = originTs(40), contentTopic = contentTopicB),
+        fakeWakuMessage(@[byte 05], ts = originTs(50), contentTopic = contentTopicC),
+        fakeWakuMessage(@[byte 06], ts = originTs(60), contentTopic = contentTopic),
+        fakeWakuMessage(@[byte 07], ts = originTs(70), contentTopic = contentTopicB),
+        fakeWakuMessage(@[byte 08], ts = originTs(80), contentTopic = contentTopicC),
         fakeWakuMessage(
-          @[byte 09], ts = originTs(00), contentTopic = contentTopicSpecials
+          @[byte 09], ts = originTs(90), contentTopic = contentTopicSpecials
         ),
       ]
 
@@ -827,31 +827,34 @@ suite "Waku Store - End to End - Archive with Multiple Topics":
   suite "Validation of Time-based Filtering":
     asyncTest "Basic Time Filtering":
       # Given a history query with start and end time
-
-      historyQuery.startTime = some(originTs(-90))
-      historyQuery.endTime = some(originTs(-70))
+      historyQuery.startTime = some(originTs(20))
+      historyQuery.endTime = some(originTs(40))
 
       # When making a history query
       let queryResponse = await client.query(historyQuery, serverRemotePeerInfo)
 
       # Then the response contains the messages
       check:
         queryResponse.get().messages ==
-          @[archiveMessages[0], archiveMessages[1], archiveMessages[2]]
+          @[archiveMessages[2], archiveMessages[3], archiveMessages[4]]
 
     asyncTest "Only Start Time Specified":
       # Given a history query with only start time
-      historyQuery.startTime = some(originTs(-20))
+      historyQuery.startTime = some(originTs(20))
       historyQuery.endTime = none(Timestamp)
-      historyQuery.pubsubTopic = none(string)
 
       # When making a history query
       let queryResponse = await client.query(historyQuery, serverRemotePeerInfo)
 
       # Then the response contains the messages
       check:
         queryResponse.get().messages ==
-          @[archiveMessages[7], archiveMessages[8], archiveMessages[9]]
+          @[
+            archiveMessages[2],
+            archiveMessages[3],
+            archiveMessages[4],
+            archiveMessages[5],
+          ]
 
     asyncTest "Only End Time Specified":
       # Given a history query with only end time
@@ -886,16 +889,16 @@ suite "Waku Store - End to End - Archive with Multiple Topics":
 
     asyncTest "Time Filtering with Content Filtering":
       # Given a history query with time and content filtering
-      historyQuery.startTime = some(originTs(-90))
-      historyQuery.endTime = some(originTs(-60))
+      historyQuery.startTime = some(originTs(20))
+      historyQuery.endTime = some(originTs(60))
       historyQuery.contentTopics = @[contentTopicC]
 
       # When making a history query
       let queryResponse = await client.query(historyQuery, serverRemotePeerInfo)
 
       # Then the response contains the messages
       check:
-        queryResponse.get().messages == @[archiveMessages[2]]
+        queryResponse.get().messages == @[archiveMessages[2], archiveMessages[5]]
 
     asyncTest "Messages Outside of Time Range":
       # Given a history query with a valid time range which does not contain any messages