Skip to content

Commit a7b9709

Browse files
authored
docs: Release v0.10 (#1000)
1 parent 736b315 commit a7b9709

File tree

1 file changed

+57
-5
lines changed

1 file changed

+57
-5
lines changed

CHANGELOG.md

Lines changed: 57 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,58 @@
1-
## 2021-03-31 v0.9
1+
## 2022-06-15 v0.10
2+
3+
Release highlights:
4+
- Support for key exchange using Noise handshakes.
5+
- Support for a SQLite-only historical message `store`. This allows for cheaper, longer-term historical message storage on disk rather than in memory.
6+
- Several fixes for native WebSockets, including slow or hanging connections and connections dropping unexpectedly due to timeouts.
7+
- A fix for a memory leak in nodes running a local SQLite database.
8+
9+
### Features
10+
11+
- Support for [`35/WAKU2-NOISE`](https://rfc.vac.dev/spec/35/) handshakes as key exchange protocols.
12+
- Support for TOML config files via `--config-file=<path/to/config.toml>`.
13+
- Support for `--version` command. This prints the current tagged version (or compiled commit hash, if not on a version).
14+
- Support for running `store` protocol from a `filter` client, storing only the filtered messages.
15+
- Start of an HTTP REST API implementation.
16+
- Support for a memory-efficient SQLite-only `store` configuration.
17+
18+
### Changes
19+
20+
- Added index on `receiverTimestamp` in the SQLite `store` to improve query performance.
21+
- GossipSub [Peer Exchange](https://github.com/libp2p/specs/blob/master/pubsub/gossipsub/gossipsub-v1.1.md#prune-backoff-and-peer-exchange) is now disabled by default. This is a more secure option.
22+
- Progress towards dynamic group management for the [`17/WAKU-RLN-RELAY`](https://rfc.vac.dev/spec/17/) implementation.
23+
- Nodes with `--keep-alive` enabled now sends more regular pings to keep connections more reliably alive.
24+
- Disabled `swap` protocol by default.
25+
- Reduced unnecessary and confusing logging, especially during startup.
26+
- Added discv5 UDP port to the node's main discoverable ENR.
27+
28+
### Fixes
29+
30+
- The in-memory `store` now checks the validity of message timestamps before storing.
31+
- Fixed underlying bug that caused connection leaks in the HTTP client.
32+
- Fixed Docker image compilation to use the correct external variable for compile-time flags (`NIMFLAGS` instead of `NIM_PARAMS`).
33+
- Fixed issue where `--dns4-domain-name` caused an unhandled exception if no external port was available.
34+
- Avoids unnecessarily calling DB migration if a `--db-path` is set but nothing is persisted in the DB. This led to a misleading warning log.
35+
- Fixed underlying issues that caused WebSocket connections to hang.
36+
- Fixed underlying issue that caused WebSocket connections to time out after 10 mins.
37+
- Fixed memory leak in nodes that implements a SQLite database.
38+
39+
### Docs
40+
41+
- Added [tutorial](https://github.com/status-im/nwaku/blob/16dd267bd9d25ff24c64fc5c92a20eb0d322217c/docs/operators/how-to/configure-key.md) on how to generate and configure a node key.
42+
- Added first [guide](https://github.com/status-im/nwaku/tree/16dd267bd9d25ff24c64fc5c92a20eb0d322217c/docs/operators) for nwaku operators.
43+
44+
This release supports the following [libp2p protocols](https://docs.libp2p.io/concepts/protocols/):
45+
| Protocol | Spec status | Protocol id |
46+
| ---: | :---: | :--- |
47+
| [`11/WAKU2-RELAY`](https://rfc.vac.dev/spec/11/) | `stable` | `/vac/waku/relay/2.0.0` |
48+
| [`12/WAKU2-FILTER`](https://rfc.vac.dev/spec/12/) | `draft` | `/vac/waku/filter/2.0.0-beta1` |
49+
| [`13/WAKU2-STORE`](https://rfc.vac.dev/spec/13/) | `draft` | `/vac/waku/store/2.0.0-beta4` |
50+
| [`18/WAKU2-SWAP`](https://rfc.vac.dev/spec/18/) | `draft` | `/vac/waku/swap/2.0.0-beta1` |
51+
| [`19/WAKU2-LIGHTPUSH`](https://rfc.vac.dev/spec/19/) | `draft` | `/vac/waku/lightpush/2.0.0-beta1` |
52+
53+
The Waku v1 implementation is stable but not under active development.
54+
55+
## 2022-03-31 v0.9
256

357
Release highlights:
458

@@ -12,8 +66,6 @@ The full list of changes is below.
1266

1367
- Support for bootstrapping [`33/WAKU-DISCV5`](https://rfc.vac.dev/spec/33) via [DNS discovery](https://rfc.vac.dev/spec/10/#discovery-methods)
1468
- Support for GossipSub [Peer Exchange](https://github.com/libp2p/specs/blob/master/pubsub/gossipsub/gossipsub-v1.1.md#prune-backoff-and-peer-exchange)
15-
- Support for TOML config files via `--config-file=<path/to/config.toml>`
16-
1769

1870
### Changes
1971

@@ -54,7 +106,7 @@ This release supports the following [libp2p protocols](https://docs.libp2p.io/co
54106

55107
The Waku v1 implementation is stable but not under active development.
56108

57-
## 2021-03-03 v0.8
109+
## 2022-03-03 v0.8
58110

59111
Release highlights:
60112

@@ -107,7 +159,7 @@ This release supports the following [libp2p protocols](https://docs.libp2p.io/co
107159

108160
The Waku v1 implementation is stable but not under active development.
109161

110-
## 2021-01-19 v0.7
162+
## 2022-01-19 v0.7
111163

112164
Release highlights:
113165

0 commit comments

Comments
 (0)