diff --git a/third-party/nwaku/.dockerignore b/third-party/nwaku/.dockerignore
new file mode 100644
index 0000000..247ac61
--- /dev/null
+++ b/third-party/nwaku/.dockerignore
@@ -0,0 +1,9 @@
+/README.md
+/Dockerfile
+/.*ignore
+/LICENSE*
+/tests
+/metrics
+/nimcache
+librln*
+**/vendor/*
diff --git a/third-party/nwaku/.editorconfig b/third-party/nwaku/.editorconfig
new file mode 100644
index 0000000..e7f569e
--- /dev/null
+++ b/third-party/nwaku/.editorconfig
@@ -0,0 +1,18 @@
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+end_of_line = lf
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+
+[{Makefile, *.sh}]
+indent_style = tab
+
+# Trailing spaces in markdown indicate word wrap
+[{*.markdown,*.md}]
+trim_trailing_spaces = false
+max_line_length = 80
diff --git a/third-party/nwaku/.github/ISSUE_TEMPLATE/bug_report.md b/third-party/nwaku/.github/ISSUE_TEMPLATE/bug_report.md
new file mode 100644
index 0000000..8e54bbf
--- /dev/null
+++ b/third-party/nwaku/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,34 @@
+---
+name: Bug report
+about: Report any bugs or unexpected behavior
+title: 'bug: '
+labels: bug, track:maintenance
+assignees: ''
+
+---
+
+### Problem
+A clear and concise description of what the bug is.
+
+### Impact
+Indicate how significant you believe the impact of the bug is. Bugs that lead to data loss or corruption would be considered `critical`. In such cases, please also add the `critical` label.
+
+### To reproduce
+If you can reproduce the behavior, steps to reproduce:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+### Expected behavior
+A clear and concise description of what you expected to happen.
+
+### Screenshots/logs
+If applicable, add screenshots or logs to help explain your problem.
+
+### nwaku version/commit hash
+State the version of `nwaku` where you've encountered the bug or, if built off a specific commit, the relevant commit hash. You can check the version by running `./wakunode2 --version`.
+- e.g. `v0.9` or `ed53bcd`
+
+### Additional context
+Add any other context about the problem here.
diff --git a/third-party/nwaku/.github/ISSUE_TEMPLATE/bump_dependencies.md b/third-party/nwaku/.github/ISSUE_TEMPLATE/bump_dependencies.md
new file mode 100644
index 0000000..0413cbf
--- /dev/null
+++ b/third-party/nwaku/.github/ISSUE_TEMPLATE/bump_dependencies.md
@@ -0,0 +1,48 @@
+---
+name: Bump dependencies
+about: Bump vendor dependencies for release
+title: 'Bump vendor dependencies for release 0.0.0'
+labels: dependencies
+assignees: ''
+
+---
+
+
+
+Update `nwaku` "vendor" dependencies.
+
+### Items to bump
+- [ ] dnsclient.nim ( update to the latest tag version )
+- [ ] nim-bearssl
+- [ ] nimbus-build-system
+- [ ] nim-chronicles
+- [ ] nim-chronos
+- [ ] nim-confutils
+- [ ] nimcrypto
+- [ ] nim-dnsdisc
+- [ ] nim-eth
+- [ ] nim-faststreams
+- [ ] nim-http-utils
+- [ ] nim-json-rpc
+- [ ] nim-json-serialization
+- [ ] nim-libbacktrace
+- [ ] nim-libp2p ( update to the latest tag version )
+- [ ] nim-metrics
+- [ ] nim-nat-traversal
+- [ ] nim-presto
+- [ ] nim-regex ( update to the latest tag version )
+- [ ] nim-results
+- [ ] nim-secp256k1
+- [ ] nim-serialization
+- [ ] nim-sqlite3-abi ( update to the latest tag version )
+- [ ] nim-stew
+- [ ] nim-stint
+- [ ] nim-taskpools ( update to the latest tag version )
+- [ ] nim-testutils ( update to the latest tag version )
+- [ ] nim-toml-serialization
+- [ ] nim-unicodedb
+- [ ] nim-unittest2 ( update to the latest tag version )
+- [ ] nim-web3 ( update to the latest tag version )
+- [ ] nim-websock ( update to the latest tag version )
+- [ ] nim-zlib
+- [ ] zerokit ( this should be kept in version `v0.7.0` )
diff --git a/third-party/nwaku/.github/ISSUE_TEMPLATE/feature_request.md b/third-party/nwaku/.github/ISSUE_TEMPLATE/feature_request.md
new file mode 100644
index 0000000..52e2164
--- /dev/null
+++ b/third-party/nwaku/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,26 @@
+---
+name: Feature request
+about: Suggest an idea for the nwaku implementation
+title: 'feat: '
+labels: track:production
+assignees: ''
+
+---
+
+### Problem
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+### Suggested solution
+A clear and concise description of what you want to happen.
+
+### Alternatives considered
+A clear and concise description of any alternative solutions or features you've considered.
+
+### Additional context
+Add any other context or screenshots about the feature request here.
+
+### Acceptance criteria
+A list of tasks that need to be done for the issue to be considered resolved.
+
+### Epic
+Epic title and link the feature refers to.
diff --git a/third-party/nwaku/.github/ISSUE_TEMPLATE/improvement.md b/third-party/nwaku/.github/ISSUE_TEMPLATE/improvement.md
new file mode 100644
index 0000000..5dee34f
--- /dev/null
+++ b/third-party/nwaku/.github/ISSUE_TEMPLATE/improvement.md
@@ -0,0 +1,17 @@
+---
+name: Improvement
+about: Suggest improvements to the codebase or processes. This includes refactoring,
+ docs and any other chores.
+title: 'chore:'
+labels: track:maintenance
+assignees: ''
+
+---
+### Background
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]; There is a spelling error in [...]; It's difficult to read the code in module [...]
+
+### Details
+A clear and concise description of what you want to happen.
+
+### Acceptance criteria
+A list of tasks that need to be done for the issue to be considered resolved.
diff --git a/third-party/nwaku/.github/ISSUE_TEMPLATE/milestone.md b/third-party/nwaku/.github/ISSUE_TEMPLATE/milestone.md
new file mode 100644
index 0000000..d167ce1
--- /dev/null
+++ b/third-party/nwaku/.github/ISSUE_TEMPLATE/milestone.md
@@ -0,0 +1,41 @@
+---
+name: Milestone Issue Template
+about: Track Milestones
+title: "[Milestone] "
+labels: milestone
+assignees: ''
+
+---
+
+
+
+
+**Planned start date**:
+**Due date**:
+
+# Summary
+
+# Acceptance Criteria
+
+
+
+## Tasks
+
+
+
+# RAID (Risks, Assumptions, Issues and Dependencies)
+
+
+
+
+
+
+
+
diff --git a/third-party/nwaku/.github/ISSUE_TEMPLATE/prepare_release.md b/third-party/nwaku/.github/ISSUE_TEMPLATE/prepare_release.md
new file mode 100644
index 0000000..9553d56
--- /dev/null
+++ b/third-party/nwaku/.github/ISSUE_TEMPLATE/prepare_release.md
@@ -0,0 +1,72 @@
+---
+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/third-party/nwaku/.github/ISSUE_TEMPLATE/research-related-issue.md b/third-party/nwaku/.github/ISSUE_TEMPLATE/research-related-issue.md
new file mode 100644
index 0000000..b90b7d8
--- /dev/null
+++ b/third-party/nwaku/.github/ISSUE_TEMPLATE/research-related-issue.md
@@ -0,0 +1,19 @@
+---
+name: Research-related issue
+about: Use this template if your issue is related to any Vac research tracks
+title: 'research:'
+labels: ''
+assignees: ''
+
+---
+
+### Problem
+
+### Acceptance criteria
+
+### Details
+
+### Possible Solutions
+
+### Research track
+Indicate the Vac research track that this issue relates to. Please also add the relevant track as a label.
diff --git a/third-party/nwaku/.github/pull_request_template.md b/third-party/nwaku/.github/pull_request_template.md
new file mode 100644
index 0000000..b5aba5c
--- /dev/null
+++ b/third-party/nwaku/.github/pull_request_template.md
@@ -0,0 +1,8 @@
+
+## Description
+
+## Changes
+
+## Issue
+
+closes #
diff --git a/third-party/nwaku/.github/workflows/auto_assign_pr.yml b/third-party/nwaku/.github/workflows/auto_assign_pr.yml
new file mode 100644
index 0000000..39847b0
--- /dev/null
+++ b/third-party/nwaku/.github/workflows/auto_assign_pr.yml
@@ -0,0 +1,12 @@
+name: Auto Assign PR to Creator
+
+on:
+ pull_request:
+ types:
+ - opened
+
+jobs:
+ assign_creator:
+ runs-on: ubuntu-22.04
+ steps:
+ - uses: toshimaru/auto-author-assign@v1.6.2
\ No newline at end of file
diff --git a/third-party/nwaku/.github/workflows/ci.yml b/third-party/nwaku/.github/workflows/ci.yml
new file mode 100644
index 0000000..5b32193
--- /dev/null
+++ b/third-party/nwaku/.github/workflows/ci.yml
@@ -0,0 +1,191 @@
+name: ci
+
+on:
+ pull_request:
+ push:
+ branches:
+ - master
+
+concurrency:
+ group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+ cancel-in-progress: true
+
+env:
+ NPROC: 2
+ MAKEFLAGS: "-j${NPROC}"
+ NIMFLAGS: "--parallelBuild:${NPROC} --colors:off -d:chronicles_colors:none"
+
+jobs:
+ changes: # changes detection
+ runs-on: ubuntu-22.04
+ permissions:
+ pull-requests: read
+ steps:
+ - uses: actions/checkout@v4
+ name: Checkout code
+ id: checkout
+ - uses: dorny/paths-filter@v2
+ id: filter
+ with:
+ filters: |
+ common:
+ - '.github/workflows/**'
+ - 'vendor/**'
+ - 'Makefile'
+ - 'waku.nimble'
+ - 'library/**'
+ v2:
+ - 'waku/**'
+ - 'apps/**'
+ - 'tools/**'
+ - 'tests/all_tests_v2.nim'
+ - 'tests/**'
+ docker:
+ - 'docker/**'
+
+ outputs:
+ common: ${{ steps.filter.outputs.common }}
+ v2: ${{ steps.filter.outputs.v2 }}
+ docker: ${{ steps.filter.outputs.docker }}
+
+ build:
+ needs: changes
+ if: ${{ needs.changes.outputs.v2 == 'true' || needs.changes.outputs.common == 'true' }}
+ strategy:
+ fail-fast: false
+ matrix:
+ os: [ubuntu-22.04, macos-13]
+ runs-on: ${{ matrix.os }}
+ timeout-minutes: 60
+
+ name: build-${{ matrix.os }}
+ steps:
+ - name: Checkout code
+ uses: actions/checkout@v4
+
+ - name: Get submodules hash
+ id: submodules
+ run: |
+ echo "hash=$(git submodule status | awk '{print $1}' | sort | shasum -a 256 | sed 's/[ -]*//g')" >> $GITHUB_OUTPUT
+
+ - name: Cache submodules
+ uses: actions/cache@v3
+ with:
+ path: |
+ vendor/
+ .git/modules
+ key: ${{ runner.os }}-vendor-modules-${{ steps.submodules.outputs.hash }}
+
+ - 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' }}
+ uses: ./.github/workflows/windows-build.yml
+ with:
+ branch: ${{ github.ref }}
+
+ test:
+ needs: changes
+ if: ${{ needs.changes.outputs.v2 == 'true' || needs.changes.outputs.common == 'true' }}
+ strategy:
+ fail-fast: false
+ matrix:
+ os: [ubuntu-22.04, macos-13]
+ runs-on: ${{ matrix.os }}
+ timeout-minutes: 60
+
+ name: test-${{ matrix.os }}
+ steps:
+ - name: Checkout code
+ uses: actions/checkout@v4
+
+ - name: Get submodules hash
+ id: submodules
+ run: |
+ echo "hash=$(git submodule status | awk '{print $1}' | sort | shasum -a 256 | sed 's/[ -]*//g')" >> $GITHUB_OUTPUT
+
+ - name: Cache submodules
+ uses: actions/cache@v3
+ with:
+ path: |
+ vendor/
+ .git/modules
+ key: ${{ runner.os }}-vendor-modules-${{ steps.submodules.outputs.hash }}
+
+ - name: Run tests
+ run: |
+ postgres_enabled=0
+ if [ ${{ runner.os }} == "Linux" ]; then
+ 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
+
+ make V=1 LOG_LEVEL=DEBUG QUICK_AND_DIRTY_COMPILER=1 POSTGRES=$postgres_enabled test
+ make V=1 LOG_LEVEL=DEBUG QUICK_AND_DIRTY_COMPILER=1 POSTGRES=$postgres_enabled testwakunode2
+
+ 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
+ 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
+ with:
+ node_nwaku: ${{ needs.build-docker-image.outputs.image }}
+
+ secrets: inherit
+
+ js-waku-node:
+ needs: build-docker-image
+ uses: waku-org/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
+ with:
+ nim_wakunode_image: ${{ needs.build-docker-image.outputs.image }}
+ test_type: node-optional
+
+ lint:
+ name: "Lint"
+ runs-on: ubuntu-22.04
+ needs: build
+ steps:
+ - name: Checkout code
+ uses: actions/checkout@v4
+
+ - name: Get submodules hash
+ id: submodules
+ run: |
+ echo "hash=$(git submodule status | awk '{print $1}' | sort | shasum -a 256 | sed 's/[ -]*//g')" >> $GITHUB_OUTPUT
+
+ - name: Cache submodules
+ uses: actions/cache@v3
+ with:
+ path: |
+ vendor/
+ .git/modules
+ key: ${{ runner.os }}-vendor-modules-${{ steps.submodules.outputs.hash }}
+
+ - name: Build nph
+ run: |
+ make build-nph
+
+ - name: Check nph formatting
+ run: |
+ shopt -s extglob # Enable extended globbing
+ NPH=$(make print-nph-path)
+ echo "using nph at ${NPH}"
+ "${NPH}" examples waku tests tools apps *.@(nim|nims|nimble)
+ git diff --exit-code
diff --git a/third-party/nwaku/.github/workflows/container-image.yml b/third-party/nwaku/.github/workflows/container-image.yml
new file mode 100644
index 0000000..cfa66d2
--- /dev/null
+++ b/third-party/nwaku/.github/workflows/container-image.yml
@@ -0,0 +1,99 @@
+name: container-image-build
+
+on:
+ workflow_call:
+ inputs:
+ image_tag:
+ type: string
+ default: ${{ github.event.number }}
+ outputs:
+ image:
+ description: The resulting image link
+ value: ${{ jobs.build-docker-image.outputs.image }}
+
+env:
+ NPROC: 2
+ MAKEFLAGS: "-j${NPROC}"
+ NIMFLAGS: "--parallelBuild:${NPROC}"
+
+# This workflow should not run for outside contributors
+# If org secrets are not available, we'll avoid building and publishing the docker image and we'll pass the workflow
+jobs:
+ build-docker-image:
+ strategy:
+ matrix:
+ os: [ubuntu-22.04]
+ runs-on: ${{ matrix.os }}
+ timeout-minutes: 60
+
+ name: docker-build-${{ matrix.os }}
+ outputs:
+ image: ${{ steps.build.outputs.image }}
+ steps:
+ - name: Check secrets
+ id: secrets
+ continue-on-error: true
+ run: |
+ if [[ -z "$QUAY_PASSWORD" || -z "$QUAY_USER" ]]; then
+ echo "User does not have access to secrets, skipping workflow"
+ exit 1
+ fi
+ env:
+ QUAY_PASSWORD: ${{ secrets.QUAY_PASSWORD }}
+ QUAY_USER: ${{ secrets.QUAY_USER }}
+
+ - name: Checkout code
+ if: ${{ steps.secrets.outcome == 'success' }}
+ uses: actions/checkout@v4
+
+ - name: Get submodules hash
+ id: submodules
+ if: ${{ steps.secrets.outcome == 'success' }}
+ run: |
+ echo "hash=$(git submodule status | awk '{print $1}' | sort | shasum -a 256 | sed 's/[ -]*//g')" >> $GITHUB_OUTPUT
+
+ - name: Cache submodules
+ if: ${{ steps.secrets.outcome == 'success' }}
+ uses: actions/cache@v3
+ with:
+ path: |
+ vendor/
+ .git/modules
+ key: ${{ runner.os }}-vendor-modules-${{ steps.submodules.outputs.hash }}
+
+ - name: Build binaries
+ id: build
+ if: ${{ steps.secrets.outcome == 'success' }}
+ run: |
+
+ make -j${NPROC} V=1 QUICK_AND_DIRTY_COMPILER=1 NIMFLAGS="-d:disableMarchNative -d:postgres -d:chronicles_colors:none" wakunode2
+
+ SHORT_REF=$(git rev-parse --short HEAD)
+
+ TAG=$([ "${PR_NUMBER}" == "" ] && echo "${SHORT_REF}" || echo "${PR_NUMBER}")
+ IMAGE=quay.io/wakuorg/nwaku-pr:${TAG}
+
+ echo "image=${IMAGE}" >> $GITHUB_OUTPUT
+ echo "commit_hash=$(git rev-parse HEAD)" >> $GITHUB_OUTPUT
+
+ docker login -u ${QUAY_USER} -p ${QUAY_PASSWORD} quay.io
+ docker build -t ${IMAGE} -f docker/binaries/Dockerfile.bn.amd64 --label quay.expires-after=30d .
+ docker push ${IMAGE}
+ env:
+ QUAY_PASSWORD: ${{ secrets.QUAY_PASSWORD }}
+ QUAY_USER: ${{ secrets.QUAY_USER }}
+ PR_NUMBER: ${{ inputs.image_tag}}
+
+ - name: Comment PR
+ uses: thollander/actions-comment-pull-request@v2
+ if: ${{ github.event_name == 'pull_request' && steps.secrets.outcome == 'success' }}
+ with:
+ message: |
+ You can find the image built from this PR at
+
+ ```
+ ${{steps.build.outputs.image}}
+ ```
+
+ Built from ${{ steps.build.outputs.commit_hash }}
+ comment_tag: execution-rln-v${{ matrix.rln_version }}
diff --git a/third-party/nwaku/.github/workflows/pr-lint.yml b/third-party/nwaku/.github/workflows/pr-lint.yml
new file mode 100644
index 0000000..d3ac05f
--- /dev/null
+++ b/third-party/nwaku/.github/workflows/pr-lint.yml
@@ -0,0 +1,54 @@
+name: "Lint PR"
+
+on:
+ pull_request_target:
+ types:
+ - opened
+ - edited
+ - synchronize
+
+jobs:
+ labels:
+ runs-on: ubuntu-22.04
+
+ steps:
+ - uses: actions/checkout@v4
+ name: Checkout code
+ id: checkout
+ - uses: dorny/paths-filter@v2
+ id: filter
+ with:
+ filters: |
+ config:
+ - 'apps/wakunode2/external_config.nim'
+ - 'apps/networkmonitor/networkmonitor_config.nim'
+ - 'apps/chat2/config_chat2.nim'
+ - 'apps/chat2bridge/config_chat2bridge.nim'
+
+ db_schema:
+ - 'waku/waku_archive/driver/postgres_driver/postgres_driver.nim'
+ - 'waku/waku_archive/driver/sqlite_driver/queries.nim'
+ - name: Comment config change
+ uses: thollander/actions-comment-pull-request@v2
+ if: ${{steps.filter.outputs.config == 'true'}}
+ with:
+ message: |
+ This PR may contain changes to **configuration options** of one of the apps.
+
+ If you are introducing a breaking change (i.e. the set of options in latest release would no longer be applicable) make sure the original option is preserved with a *deprecation* note for 2 following releases before it is actually removed.
+
+ Please also make sure the label `release-notes` is added to make sure any changes to the user interface are properly announced in changelog and release notes.
+ comment_tag: configs
+
+ - name: Comment DB schema change
+ uses: thollander/actions-comment-pull-request@v2
+ if: ${{steps.filter.outputs.db_schema == 'true'}}
+ with:
+ header: pr-title-lint-error
+ message: |
+ This PR may contain changes to **database schema** of one of the drivers.
+
+ If you are introducing any changes to the schema, make sure the upgrade from the latest release to this change passes without any errors/issues.
+
+ Please make sure the label `release-notes` is added to make sure upgrade instructions properly highlight this change.
+ comment_tag: db_schema
diff --git a/third-party/nwaku/.github/workflows/pre-release.yml b/third-party/nwaku/.github/workflows/pre-release.yml
new file mode 100644
index 0000000..b138a22
--- /dev/null
+++ b/third-party/nwaku/.github/workflows/pre-release.yml
@@ -0,0 +1,163 @@
+name: Pre-Release
+
+on:
+ push:
+ tags:
+ - 'v*-rc.*'
+ schedule:
+ - cron: 13 3 * * *
+ workflow_dispatch:
+
+env:
+ RELEASE_NAME: nightly
+
+ NPROC: 2
+ MAKEFLAGS: "-j${NPROC}"
+ NIMFLAGS: "--parallelBuild:${NPROC}"
+
+jobs:
+ tag-name:
+ runs-on: ubuntu-22.04
+ steps:
+ - name: Checkout code
+ uses: actions/checkout@v4
+
+ - name: Vars
+ id: vars
+ run: |
+ TAG=$([[ "${{github.ref}}" == "refs/heads/master" ]] && echo "${{env.RELEASE_NAME}}" || echo ${{github.ref}} | sed 's#refs/tags/##')
+ echo "tag=${TAG}" >> $GITHUB_OUTPUT
+ outputs:
+ tag: ${{steps.vars.outputs.tag}}
+
+ build-and-publish:
+ needs: tag-name
+ strategy:
+ matrix:
+ os: [ubuntu-22.04, macos-13]
+ arch: [amd64]
+ include:
+ - os: macos-13
+ arch: arm64
+ runs-on: ${{ matrix.os }}
+ steps:
+ - name: Checkout code
+ uses: actions/checkout@v4
+
+ - name: prep variables
+ id: vars
+ run: |
+ ARCH=${{matrix.arch}}
+
+ echo "arch=${ARCH}" >> $GITHUB_OUTPUT
+
+ NWAKU_ARTIFACT_NAME=$(echo "nwaku-${ARCH}-${{runner.os}}-${{ needs.tag-name.outputs.tag }}.tar.gz" | tr "[:upper:]" "[:lower:]")
+ NWAKU_TOOLS_ARTIFACT_NAME=$(echo "nwaku-tools-${ARCH}-${{runner.os}}-${{ needs.tag-name.outputs.tag }}.tar.gz" | tr "[:upper:]" "[:lower:]")
+
+ echo "nwaku=${NWAKU_ARTIFACT_NAME}" >> $GITHUB_OUTPUT
+ echo "nwakutools=${NWAKU_TOOLS_ARTIFACT_NAME}" >> $GITHUB_OUTPUT
+
+
+ - name: build artifacts
+ id: build
+ run: |
+ OS=$([[ "${{runner.os}}" == "macOS" ]] && echo "macosx" || echo "linux")
+
+ make QUICK_AND_DIRTY_COMPILER=1 V=1 CI=false NIMFLAGS="-d:disableMarchNative --os:${OS} --cpu:${{matrix.arch}}" \
+ update
+
+ make QUICK_AND_DIRTY_COMPILER=1 V=1 CI=false\
+ NIMFLAGS="-d:disableMarchNative --os:${OS} --cpu:${{matrix.arch}} -d:postgres" \
+ wakunode2\
+ chat2\
+ tools
+
+ tar -cvzf ${{steps.vars.outputs.nwaku}} ./build/wakunode2 ./build/chat2
+ tar -cvzf ${{steps.vars.outputs.nwakutools}} ./build/wakucanary ./build/networkmonitor
+
+ - name: upload artifacts
+ uses: actions/upload-artifact@v4
+ with:
+ name: wakunode2
+ path: ${{steps.vars.outputs.nwaku}}
+ retention-days: 2
+
+ - name: upload artifacts
+ uses: actions/upload-artifact@v4
+ with:
+ name: wakutools
+ path: ${{steps.vars.outputs.nwakutools}}
+ retention-days: 2
+
+ build-docker-image:
+ needs: tag-name
+ uses: waku-org/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
+ with:
+ nim_wakunode_image: ${{ needs.build-docker-image.outputs.image }}
+ test_type: node
+ debug: waku*
+
+ js-waku-node-optional:
+ needs: build-docker-image
+ uses: waku-org/js-waku/.github/workflows/test-node.yml@master
+ with:
+ nim_wakunode_image: ${{ needs.build-docker-image.outputs.image }}
+ test_type: node-optional
+ debug: waku*
+
+ create-release-candidate:
+ runs-on: ubuntu-22.04
+ needs: [ tag-name, build-and-publish ]
+ steps:
+ - name: Checkout code
+ uses: actions/checkout@v4
+ with:
+ fetch-depth: 0
+ ref: master
+
+ - name: download artifacts
+ uses: actions/download-artifact@v4
+
+ - name: prep variables
+ id: vars
+ run: |
+ REF=$(echo ${{github.ref}} | sed 's#.*/##')
+
+ echo "ref=${REF}" >> $GITHUB_OUTPUT
+
+ - name: generate release notes
+ env:
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+ run: |
+ set -x
+ gh release view ${{ needs.tag-name.outputs.tag }} &>/dev/null &&\
+ gh release delete -y ${{ needs.tag-name.outputs.tag }} &&\
+ [[ "${{ needs.tag-name.outputs.tag }}" == "nightly" ]] && git tag -d ${{ needs.tag-name.outputs.tag }}
+
+ RELEASE_NOTES_TAG=$([[ "${{ needs.tag-name.outputs.tag }}" != "nightly" ]] && echo "-t ${{steps.vars.outputs.ref}}" || echo "")
+
+ docker run \
+ -t \
+ --rm \
+ -v ${PWD}:/opt/sv4git/repo:z \
+ -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 -i "s/^## .*/Generated at $(date)/" release_notes.md
+
+ cat release_notes.md
+
+ TARGET=$([[ "${{ needs.tag-name.outputs.tag }}" == "nightly" ]] && echo "--target ${{steps.vars.outputs.ref}}" || echo "")
+
+ gh release create ${{ needs.tag-name.outputs.tag }} --prerelease ${TARGET} \
+ --title ${{ needs.tag-name.outputs.tag }} --notes-file release_notes.md \
+ wakunode2/* wakutools/*
diff --git a/third-party/nwaku/.github/workflows/release-assets.yml b/third-party/nwaku/.github/workflows/release-assets.yml
new file mode 100644
index 0000000..2c7c260
--- /dev/null
+++ b/third-party/nwaku/.github/workflows/release-assets.yml
@@ -0,0 +1,65 @@
+name: Upload Release Asset
+
+on:
+ push:
+ tags:
+ - 'v*' # "e.g. v0.4"
+
+ workflow_dispatch:
+
+env:
+ NPROC: 2
+
+jobs:
+ build-and-upload:
+ strategy:
+ matrix:
+ os: [ubuntu-22.04, macos-13]
+ arch: [amd64]
+ include:
+ - os: macos-13
+ arch: arm64
+ runs-on: ${{ matrix.os }}
+ timeout-minutes: 60
+
+ name: ${{ matrix.os }} - ${{ matrix.arch }}
+
+ steps:
+ - name: Checkout code
+ uses: actions/checkout@v2
+
+ - name: Get submodules hash
+ id: submodules
+ run: |
+ echo "hash=$(git submodule status | awk '{print $1}' | sort | shasum -a 256 | sed 's/[ -]*//g')" >> $GITHUB_OUTPUT
+
+ - name: Cache submodules
+ uses: actions/cache@v3
+ with:
+ path: |
+ vendor/
+ .git/modules
+ key: ${{ runner.os }}-${{matrix.arch}}-submodules-${{ steps.submodules.outputs.hash }}
+
+ - name: prep variables
+ id: vars
+ run: |
+ NWAKU_ARTIFACT_NAME=$(echo "nwaku-${{matrix.arch}}-${{runner.os}}.tar.gz" | tr "[:upper:]" "[:lower:]")
+
+ echo "nwaku=${NWAKU_ARTIFACT_NAME}" >> $GITHUB_OUTPUT
+
+ - name: Install dependencies
+ run: |
+ OS=$([[ "${{runner.os}}" == "macOS" ]] && echo "macosx" || echo "linux")
+
+ make -j${NPROC} NIMFLAGS="--parallelBuild:${NPROC} -d:disableMarchNative --os:${OS} --cpu:${{matrix.arch}}" V=1 update
+ make -j${NPROC} NIMFLAGS="--parallelBuild:${NPROC} -d:disableMarchNative --os:${OS} --cpu:${{matrix.arch}} -d:postgres" CI=false wakunode2
+ make -j${NPROC} NIMFLAGS="--parallelBuild:${NPROC} -d:disableMarchNative --os:${OS} --cpu:${{matrix.arch}}" CI=false chat2
+ tar -cvzf ${{steps.vars.outputs.nwaku}} ./build/
+
+ - name: Upload asset
+ uses: actions/upload-artifact@v4.4.0
+ with:
+ name: ${{steps.vars.outputs.nwaku}}
+ path: ${{steps.vars.outputs.nwaku}}
+ if-no-files-found: error
diff --git a/third-party/nwaku/.github/workflows/sync-labels.yml b/third-party/nwaku/.github/workflows/sync-labels.yml
new file mode 100644
index 0000000..e53797b
--- /dev/null
+++ b/third-party/nwaku/.github/workflows/sync-labels.yml
@@ -0,0 +1,17 @@
+name: Sync labels
+on:
+ push:
+ branches:
+ - master
+ paths:
+ - .github/labels.yml
+jobs:
+ build:
+ runs-on: ubuntu-22.04
+ steps:
+ - uses: actions/checkout@v2
+ - uses: micnncim/action-label-syncer@v1
+ env:
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+ with:
+ manifest: .github/labels.yml
diff --git a/third-party/nwaku/.github/workflows/windows-build.yml b/third-party/nwaku/.github/workflows/windows-build.yml
new file mode 100644
index 0000000..ed6d2cb
--- /dev/null
+++ b/third-party/nwaku/.github/workflows/windows-build.yml
@@ -0,0 +1,104 @@
+name: ci / build-windows
+
+on:
+ workflow_call:
+ inputs:
+ branch:
+ required: true
+ type: string
+
+jobs:
+ build:
+ runs-on: windows-latest
+
+ defaults:
+ run:
+ shell: msys2 {0}
+
+ env:
+ MSYSTEM: MINGW64
+
+ steps:
+ - name: Checkout code
+ uses: actions/checkout@v3
+
+ - name: Setup MSYS2
+ uses: msys2/setup-msys2@v2
+ with:
+ update: true
+ install: >-
+ git
+ base-devel
+ mingw-w64-x86_64-toolchain
+ make
+ cmake
+ upx
+ mingw-w64-x86_64-rust
+ mingw-w64-x86_64-postgresql
+ mingw-w64-x86_64-gcc
+ mingw-w64-x86_64-gcc-libs
+ mingw-w64-x86_64-libwinpthread-git
+ mingw-w64-x86_64-zlib
+ mingw-w64-x86_64-openssl
+ mingw-w64-x86_64-python
+ mingw-w64-x86_64-cmake
+ mingw-w64-x86_64-llvm
+ mingw-w64-x86_64-clang
+
+ - name: Add UPX to PATH
+ run: |
+ echo "/usr/bin:$PATH" >> $GITHUB_PATH
+ echo "/mingw64/bin:$PATH" >> $GITHUB_PATH
+ echo "/usr/lib:$PATH" >> $GITHUB_PATH
+ echo "/mingw64/lib:$PATH" >> $GITHUB_PATH
+
+ - name: Verify dependencies
+ run: |
+ which upx gcc g++ make cmake cargo rustc python
+
+ - name: Updating submodules
+ run: git submodule update --init --recursive
+
+ - name: Creating tmp directory
+ run: mkdir -p tmp
+
+ - name: Building Nim
+ run: |
+ cd vendor/nimbus-build-system/vendor/Nim
+ ./build_all.bat
+ cd ../../../..
+
+ - name: Building miniupnpc
+ run: |
+ cd vendor/nim-nat-traversal/vendor/miniupnp/miniupnpc
+ make -f Makefile.mingw CC=gcc CXX=g++ libminiupnpc.a V=1
+ cd ../../../../..
+
+ - name: Building libnatpmp
+ run: |
+ cd ./vendor/nim-nat-traversal/vendor/libnatpmp-upstream
+ make CC="gcc -fPIC -D_WIN32_WINNT=0x0600 -DNATPMP_STATICLIB" libnatpmp.a V=1
+ cd ../../../../
+
+ - name: Building wakunode2.exe
+ run: |
+ make wakunode2 LOG_LEVEL=DEBUG V=3 -j8
+
+ - name: Building libwaku.dll
+ run: |
+ make libwaku STATIC=0 LOG_LEVEL=DEBUG V=1 -j
+
+ - name: Check Executable
+ run: |
+ if [ -f "./build/wakunode2.exe" ]; then
+ echo "wakunode2.exe build successful"
+ else
+ echo "Build failed: wakunode2.exe not found"
+ exit 1
+ fi
+ if [ -f "./build/libwaku.dll" ]; then
+ echo "libwaku.dll build successful"
+ else
+ echo "Build failed: libwaku.dll not found"
+ exit 1
+ fi
diff --git a/third-party/nwaku/.gitignore b/third-party/nwaku/.gitignore
new file mode 100644
index 0000000..7430c3e
--- /dev/null
+++ b/third-party/nwaku/.gitignore
@@ -0,0 +1,81 @@
+/nimcache
+
+# Executables shall be put in an ignored build/ directory
+/build
+
+# Nimble packages
+/vendor/.nimble
+
+# Generated Files
+*.generated.nim
+
+# ntags/ctags output
+/tags
+
+# a symlink that can't be added to the repo because of Windows
+/waku.nims
+
+# Ignore dynamic, static libs and libtool archive files
+*.so
+*.dylib
+*.a
+*.la
+*.exe
+*.dll
+
+.DS_Store
+
+# Ignore simulation generated metrics files
+/metrics/prometheus
+/metrics/waku-sim-all-nodes-grafana-dashboard.json
+
+*.log
+/package-lock.json
+/package.json
+node_modules/
+/.update.timestamp
+
+# Ignore Jetbrains IDE files
+.idea/
+
+# ignore vscode files
+.vscode/
+
+# RLN / keystore
+rlnKeystore.json
+*.tar.gz
+
+# Nimbus Build System
+nimbus-build-system.paths
+
+# sqlite db
+*.db
+*.db-shm
+*.db-wal
+*.sqlite3
+*.sqlite3-shm
+*.sqlite3-wal
+
+/examples/nodejs/build/
+/examples/rust/target/
+
+
+# Coverage
+coverage_html_report/
+*.info
+
+# Wildcard
+*.ignore.*
+
+# Ignore all possible node runner directories
+**/keystore/
+**/rln_tree/
+**/certs/
+
+# simple qt example
+.qmake.stash
+main-qt
+waku_handler.moc.cpp
+
+# Nix build result
+result
diff --git a/third-party/nwaku/.gitmodules b/third-party/nwaku/.gitmodules
new file mode 100644
index 0000000..408def1
--- /dev/null
+++ b/third-party/nwaku/.gitmodules
@@ -0,0 +1,190 @@
+[submodule "vendor/nim-eth"]
+ path = vendor/nim-eth
+ url = https://github.com/status-im/nim-eth.git
+ ignore = dirty
+ branch = master
+[submodule "vendor/nim-secp256k1"]
+ path = vendor/nim-secp256k1
+ url = https://github.com/status-im/nim-secp256k1.git
+ ignore = dirty
+ branch = master
+[submodule "vendor/nim-libp2p"]
+ path = vendor/nim-libp2p
+ url = https://github.com/vacp2p/nim-libp2p.git
+ ignore = dirty
+ branch = master
+[submodule "vendor/nim-stew"]
+ path = vendor/nim-stew
+ url = https://github.com/status-im/nim-stew.git
+ ignore = dirty
+ branch = master
+[submodule "vendor/nimbus-build-system"]
+ path = vendor/nimbus-build-system
+ url = https://github.com/status-im/nimbus-build-system.git
+ ignore = dirty
+ branch = master
+[submodule "vendor/nim-nat-traversal"]
+ path = vendor/nim-nat-traversal
+ url = https://github.com/status-im/nim-nat-traversal.git
+ ignore = dirty
+ branch = master
+[submodule "vendor/nim-libbacktrace"]
+ path = vendor/nim-libbacktrace
+ url = https://github.com/status-im/nim-libbacktrace.git
+ ignore = dirty
+ branch = master
+[submodule "vendor/nim-confutils"]
+ path = vendor/nim-confutils
+ url = https://github.com/status-im/nim-confutils.git
+ ignore = dirty
+ branch = master
+[submodule "vendor/nim-chronicles"]
+ path = vendor/nim-chronicles
+ url = https://github.com/status-im/nim-chronicles.git
+ ignore = dirty
+ branch = master
+[submodule "vendor/nim-faststreams"]
+ path = vendor/nim-faststreams
+ url = https://github.com/status-im/nim-faststreams.git
+ ignore = dirty
+ branch = master
+[submodule "vendor/nim-chronos"]
+ path = vendor/nim-chronos
+ url = https://github.com/status-im/nim-chronos.git
+ ignore = dirty
+ branch = master
+[submodule "vendor/nim-json-serialization"]
+ path = vendor/nim-json-serialization
+ url = https://github.com/status-im/nim-json-serialization.git
+ ignore = dirty
+ branch = master
+[submodule "vendor/nim-serialization"]
+ path = vendor/nim-serialization
+ url = https://github.com/status-im/nim-serialization.git
+ ignore = dirty
+ branch = master
+[submodule "vendor/nimcrypto"]
+ path = vendor/nimcrypto
+ url = https://github.com/cheatfate/nimcrypto.git
+ ignore = dirty
+ branch = master
+[submodule "vendor/nim-metrics"]
+ path = vendor/nim-metrics
+ url = https://github.com/status-im/nim-metrics.git
+ ignore = dirty
+ branch = master
+[submodule "vendor/nim-stint"]
+ path = vendor/nim-stint
+ url = https://github.com/status-im/nim-stint.git
+ ignore = dirty
+ branch = master
+[submodule "vendor/nim-json-rpc"]
+ path = vendor/nim-json-rpc
+ url = https://github.com/status-im/nim-json-rpc.git
+ ignore = dirty
+ branch = master
+[submodule "vendor/nim-http-utils"]
+ path = vendor/nim-http-utils
+ url = https://github.com/status-im/nim-http-utils.git
+ ignore = dirty
+ branch = master
+[submodule "vendor/nim-bearssl"]
+ path = vendor/nim-bearssl
+ url = https://github.com/status-im/nim-bearssl.git
+ ignore = dirty
+ branch = master
+[submodule "vendor/nim-sqlite3-abi"]
+ path = vendor/nim-sqlite3-abi
+ url = https://github.com/arnetheduck/nim-sqlite3-abi.git
+ ignore = dirty
+ branch = master
+[submodule "vendor/nim-web3"]
+ path = vendor/nim-web3
+ url = https://github.com/status-im/nim-web3.git
+[submodule "vendor/nim-testutils"]
+ path = vendor/nim-testutils
+ url = https://github.com/status-im/nim-testutils.git
+ ignore = untracked
+ branch = master
+[submodule "vendor/nim-unittest2"]
+ path = vendor/nim-unittest2
+ url = https://github.com/status-im/nim-unittest2.git
+ ignore = untracked
+ branch = master
+[submodule "vendor/nim-websock"]
+ path = vendor/nim-websock
+ url = https://github.com/status-im/nim-websock.git
+ ignore = untracked
+ branch = main
+[submodule "vendor/nim-zlib"]
+ path = vendor/nim-zlib
+ url = https://github.com/status-im/nim-zlib.git
+ ignore = untracked
+ branch = master
+[submodule "vendor/nim-dnsdisc"]
+ path = vendor/nim-dnsdisc
+ url = https://github.com/status-im/nim-dnsdisc.git
+ ignore = untracked
+ branch = main
+[submodule "vendor/dnsclient.nim"]
+ path = vendor/dnsclient.nim
+ url = https://github.com/ba0f3/dnsclient.nim.git
+ ignore = untracked
+ branch = master
+[submodule "vendor/nim-toml-serialization"]
+ path = vendor/nim-toml-serialization
+ url = https://github.com/status-im/nim-toml-serialization.git
+[submodule "vendor/nim-presto"]
+ path = vendor/nim-presto
+ url = https://github.com/status-im/nim-presto.git
+ ignore = untracked
+ branch = master
+[submodule "vendor/zerokit"]
+ path = vendor/zerokit
+ url = https://github.com/vacp2p/zerokit.git
+ ignore = dirty
+ branch = v0.5.1
+[submodule "vendor/nim-regex"]
+ path = vendor/nim-regex
+ url = https://github.com/nitely/nim-regex.git
+ ignore = untracked
+ branch = master
+[submodule "vendor/nim-unicodedb"]
+ path = vendor/nim-unicodedb
+ url = https://github.com/nitely/nim-unicodedb.git
+ ignore = untracked
+ branch = master
+[submodule "vendor/nim-taskpools"]
+ path = vendor/nim-taskpools
+ url = https://github.com/status-im/nim-taskpools.git
+ ignore = untracked
+ branch = stable
+[submodule "vendor/nim-results"]
+ ignore = untracked
+ branch = master
+ path = vendor/nim-results
+ url = https://github.com/arnetheduck/nim-results.git
+[submodule "vendor/db_connector"]
+ path = vendor/db_connector
+ url = https://github.com/nim-lang/db_connector.git
+ ignore = untracked
+ branch = devel
+[submodule "vendor/nph"]
+ ignore = untracked
+ branch = master
+ path = vendor/nph
+ url = https://github.com/arnetheduck/nph.git
+[submodule "vendor/nim-minilru"]
+ path = vendor/nim-minilru
+ url = https://github.com/status-im/nim-minilru.git
+ ignore = untracked
+ branch = master
+[submodule "vendor/waku-rlnv2-contract"]
+ path = vendor/waku-rlnv2-contract
+ url = https://github.com/waku-org/waku-rlnv2-contract.git
+ ignore = untracked
+ branch = master
+[submodule "vendor/mix"]
+ path = vendor/mix
+ url = https://github.com/vacp2p/mix/
+ branch = main
diff --git a/third-party/nwaku/.sv4git.yml b/third-party/nwaku/.sv4git.yml
new file mode 100644
index 0000000..8975e69
--- /dev/null
+++ b/third-party/nwaku/.sv4git.yml
@@ -0,0 +1,22 @@
+version: "1.1" #config version
+
+tag:
+ pattern: "v%d.%d.%d"
+ filter: "v*"
+
+release-notes:
+ sections: # Array with each section of release note. Check template section for more information.
+ - name: Features # Name used on section.
+ section-type: commits # Type of the section, supported types: commits, breaking-changes.
+ commit-types: [feat] # Commit types for commit section-type, one commit type cannot be in more than one section.
+ - name: Bug Fixes
+ section-type: commits
+ commit-types: [fix, bug]
+ - name: Changes
+ section-type: commits
+ commit-types: [chore, docs, build, refactor, docker]
+
+commit-message:
+
+ issue:
+ regex: '#[0-9]+' # Regex for issue id.
\ No newline at end of file
diff --git a/third-party/nwaku/.sv4git/templates/releasenotes-md.tpl b/third-party/nwaku/.sv4git/templates/releasenotes-md.tpl
new file mode 100644
index 0000000..a513e69
--- /dev/null
+++ b/third-party/nwaku/.sv4git/templates/releasenotes-md.tpl
@@ -0,0 +1,8 @@
+## {{if .Release}}{{.Release}}{{end}}{{if and (not .Date.IsZero) .Release}} ({{end}}{{timefmt .Date "2006-01-02"}}{{if and (not .Date.IsZero) .Release}}){{end}}
+{{- range $section := .Sections }}
+{{- if (eq $section.SectionType "commits") }}
+{{- template "rn-md-section-commits.tpl" $section }}
+{{- else if (eq $section.SectionType "breaking-changes")}}
+{{- template "rn-md-section-breaking-changes.tpl" $section }}
+{{- end}}
+{{- end}}
diff --git a/third-party/nwaku/.sv4git/templates/rn-md-section-commits.tpl b/third-party/nwaku/.sv4git/templates/rn-md-section-commits.tpl
new file mode 100644
index 0000000..2732fcd
--- /dev/null
+++ b/third-party/nwaku/.sv4git/templates/rn-md-section-commits.tpl
@@ -0,0 +1,7 @@
+{{- if .}}{{- if ne .SectionName ""}}
+
+### {{.SectionName}}
+{{range $k,$v := .Items}}
+- {{if $v.Message.Scope}}**{{$v.Message.Scope}}:** {{end}}{{$v.Message.Description}} ([{{$v.Hash}}](https://github.com/waku-org/nwaku/commit/{{$v.Hash}})){{if $v.Message.Metadata.issue}} ([https://github.com/waku-org/nwaku/issues/{{$v.Message.Metadata.issue}}]({{$v.Message.Metadata.issue}})){{end}}
+{{- end}}
+{{- end}}{{- end}}
\ No newline at end of file
diff --git a/third-party/nwaku/CHANGELOG.md b/third-party/nwaku/CHANGELOG.md
new file mode 100644
index 0000000..dc07379
--- /dev/null
+++ b/third-party/nwaku/CHANGELOG.md
@@ -0,0 +1,2495 @@
+## v0.36.0 (2025-06-20)
+### Notes
+
+- Extended REST API for better debugging
+ - Extended `/health` report
+ - Very detailed access to peers and actual status through [`/admin/v1/peers/...` endpoints](https://waku-org.github.io/waku-rest-api/#get-/admin/v1/peers/stats)
+ - Dynamic log level change with[ `/admin/v1/log-level`](https://waku-org.github.io/waku-rest-api/#post-/admin/v1/log-level/-logLevel-)
+
+- The `rln-relay-eth-client-address` parameter, from now on, should be passed as an array of RPC addresses.
+- new `preset` parameter. `preset=twn` is the RLN-protected Waku Network (cluster 1). Overrides other values.
+- Removed `dns-addrs` parameter as it was duplicated and unused.
+- Removed `rln-relay-id-key`, `rln-relay-id-commitment-key`, `rln-relay-bandwidth-threshold` parameters.
+- Effectively removed `pubsub-topic`, which was deprecated in `v0.33.0`.
+- Removed `store-sync-max-payload-size` parameter.
+- Removed `dns-discovery-name-server` and `discv5-only` parameters.
+
+### Features
+
+- Update implementation for new contract abi ([#3390](https://github.com/waku-org/nwaku/issues/3390)) ([ee4058b2d](https://github.com/waku-org/nwaku/commit/ee4058b2d))
+- Lighptush v3 for lite-protocol-tester ([#3455](https://github.com/waku-org/nwaku/issues/3455)) ([3f3c59488](https://github.com/waku-org/nwaku/commit/3f3c59488))
+- Retrieve metrics from libwaku ([#3452](https://github.com/waku-org/nwaku/issues/3452)) ([f016ede60](https://github.com/waku-org/nwaku/commit/f016ede60))
+- Dynamic logging via REST API ([#3451](https://github.com/waku-org/nwaku/issues/3451)) ([9fe8ef8d2](https://github.com/waku-org/nwaku/commit/9fe8ef8d2))
+- Add waku_disconnect_all_peers to libwaku ([#3438](https://github.com/waku-org/nwaku/issues/3438)) ([7f51d103b](https://github.com/waku-org/nwaku/commit/7f51d103b))
+- Extend node /health REST endpoint with all protocol's state ([#3419](https://github.com/waku-org/nwaku/issues/3419)) ([1632496a2](https://github.com/waku-org/nwaku/commit/1632496a2))
+- Deprecate sync / local merkle tree ([#3312](https://github.com/waku-org/nwaku/issues/3312)) ([50fe7d727](https://github.com/waku-org/nwaku/commit/50fe7d727))
+- Refactor waku sync DOS protection ([#3391](https://github.com/waku-org/nwaku/issues/3391)) ([a81f9498c](https://github.com/waku-org/nwaku/commit/a81f9498c))
+- Waku Sync dashboard new panel & update ([#3379](https://github.com/waku-org/nwaku/issues/3379)) ([5ed6aae10](https://github.com/waku-org/nwaku/commit/5ed6aae10))
+- Enhance Waku Sync logs and metrics ([#3370](https://github.com/waku-org/nwaku/issues/3370)) ([f6c680a46](https://github.com/waku-org/nwaku/commit/f6c680a46))
+- Add waku_get_connected_peers_info to libwaku ([#3356](https://github.com/waku-org/nwaku/issues/3356)) ([0eb9c6200](https://github.com/waku-org/nwaku/commit/0eb9c6200))
+- Add waku_relay_get_peers_in_mesh to libwaku ([#3352](https://github.com/waku-org/nwaku/issues/3352)) ([ef9074443](https://github.com/waku-org/nwaku/commit/ef9074443))
+- Add waku_relay_get_connected_peers to libwaku ([#3353](https://github.com/waku-org/nwaku/issues/3353)) ([7250d7392](https://github.com/waku-org/nwaku/commit/7250d7392))
+- Introduce `preset` option ([#3346](https://github.com/waku-org/nwaku/issues/3346)) ([0eaf90465](https://github.com/waku-org/nwaku/commit/0eaf90465))
+- Add store sync dashboard panel ([#3307](https://github.com/waku-org/nwaku/issues/3307)) ([ef8ee233f](https://github.com/waku-org/nwaku/commit/ef8ee233f))
+
+### Bug Fixes
+
+- Fix typo from DIRVER to DRIVER ([#3442](https://github.com/waku-org/nwaku/issues/3442)) ([b9a4d7702](https://github.com/waku-org/nwaku/commit/b9a4d7702))
+- Fix discv5 protocol id in libwaku ([#3447](https://github.com/waku-org/nwaku/issues/3447)) ([f7be4c2f0](https://github.com/waku-org/nwaku/commit/f7be4c2f0))
+- Fix dnsresolver ([#3440](https://github.com/waku-org/nwaku/issues/3440)) ([e42e28cc6](https://github.com/waku-org/nwaku/commit/e42e28cc6))
+- Misc sync fixes, added debug logging ([#3411](https://github.com/waku-org/nwaku/issues/3411)) ([b9efa874d](https://github.com/waku-org/nwaku/commit/b9efa874d))
+- Relay unsubscribe ([#3422](https://github.com/waku-org/nwaku/issues/3422)) ([9fc631e10](https://github.com/waku-org/nwaku/commit/9fc631e10))
+- Fix build_rln.sh update version to download v0.7.0 ([#3425](https://github.com/waku-org/nwaku/issues/3425)) ([2678303bf](https://github.com/waku-org/nwaku/commit/2678303bf))
+- Timestamp based validation ([#3406](https://github.com/waku-org/nwaku/issues/3406)) ([1512bdaf0](https://github.com/waku-org/nwaku/commit/1512bdaf0))
+- Enable WebSocket connection also in case only websocket-secure-support enabled ([#3417](https://github.com/waku-org/nwaku/issues/3417)) ([698fe6525](https://github.com/waku-org/nwaku/commit/698fe6525))
+- Fix addPeer could unintentionally override metadata of previously stored peer with defaults and empty ([#3403](https://github.com/waku-org/nwaku/issues/3403)) ([5cccaaac6](https://github.com/waku-org/nwaku/commit/5cccaaac6))
+- Fix bad HttpCode conversion, add missing lightpush v3 rest api tests ([#3389](https://github.com/waku-org/nwaku/issues/3389)) ([7ff055e42](https://github.com/waku-org/nwaku/commit/7ff055e42))
+- Adjust mistaken comments and broken link ([#3381](https://github.com/waku-org/nwaku/issues/3381)) ([237f7abbb](https://github.com/waku-org/nwaku/commit/237f7abbb))
+- Avoid libwaku's redundant allocs ([#3380](https://github.com/waku-org/nwaku/issues/3380)) ([ac454a30b](https://github.com/waku-org/nwaku/commit/ac454a30b))
+- Avoid performing nil check for userData ([#3365](https://github.com/waku-org/nwaku/issues/3365)) ([b8707b6a5](https://github.com/waku-org/nwaku/commit/b8707b6a5))
+- Fix waku sync timing ([#3337](https://github.com/waku-org/nwaku/issues/3337)) ([b01b1837d](https://github.com/waku-org/nwaku/commit/b01b1837d))
+- Fix filter out ephemeral msg from waku sync ([#3332](https://github.com/waku-org/nwaku/issues/3332)) ([4b963d8f5](https://github.com/waku-org/nwaku/commit/4b963d8f5))
+- Apply latest nph formating ([#3334](https://github.com/waku-org/nwaku/issues/3334)) ([77105a6c2](https://github.com/waku-org/nwaku/commit/77105a6c2))
+- waku sync 2.0 codecs ENR support ([#3326](https://github.com/waku-org/nwaku/issues/3326)) ([bf735e777](https://github.com/waku-org/nwaku/commit/bf735e777))
+- waku sync mounting ([#3321](https://github.com/waku-org/nwaku/issues/3321)) ([380d2e338](https://github.com/waku-org/nwaku/commit/380d2e338))
+- Fix rest-relay-cache-capacity ([#3454](https://github.com/waku-org/nwaku/issues/3454)) ([fed4dc280](https://github.com/waku-org/nwaku/commit/fed4dc280))
+
+### Changes
+
+- Lower waku sync log lvl ([#3461](https://github.com/waku-org/nwaku/issues/3461)) ([4277a5349](https://github.com/waku-org/nwaku/commit/4277a5349))
+- Refactor to unify online and health monitors ([#3456](https://github.com/waku-org/nwaku/issues/3456)) ([2e40f2971](https://github.com/waku-org/nwaku/commit/2e40f2971))
+- Refactor rm discv5-only ([#3453](https://github.com/waku-org/nwaku/issues/3453)) ([b998430d5](https://github.com/waku-org/nwaku/commit/b998430d5))
+- Add extra debug REST helper via getting peer statistics ([#3443](https://github.com/waku-org/nwaku/issues/3443)) ([f4ad7a332](https://github.com/waku-org/nwaku/commit/f4ad7a332))
+- Expose online state in libwaku ([#3433](https://github.com/waku-org/nwaku/issues/3433)) ([e7f5c8cb2](https://github.com/waku-org/nwaku/commit/e7f5c8cb2))
+- Add heaptrack support build for Nim v2.0.12 builds ([#3424](https://github.com/waku-org/nwaku/issues/3424)) ([91885fb9e](https://github.com/waku-org/nwaku/commit/91885fb9e))
+- Remove debug for js-waku ([#3423](https://github.com/waku-org/nwaku/issues/3423)) ([5628dc6ad](https://github.com/waku-org/nwaku/commit/5628dc6ad))
+- Bump dependencies for v0.36 ([#3410](https://github.com/waku-org/nwaku/issues/3410)) ([005815746](https://github.com/waku-org/nwaku/commit/005815746))
+- Enhance feedback on error CLI ([#3405](https://github.com/waku-org/nwaku/issues/3405)) ([3464d81a6](https://github.com/waku-org/nwaku/commit/3464d81a6))
+- Allow multiple rln eth clients ([#3402](https://github.com/waku-org/nwaku/issues/3402)) ([861710bc7](https://github.com/waku-org/nwaku/commit/861710bc7))
+- Separate internal and CLI configurations ([#3357](https://github.com/waku-org/nwaku/issues/3357)) ([dd8d66431](https://github.com/waku-org/nwaku/commit/dd8d66431))
+- Avoid double relay subscription ([#3396](https://github.com/waku-org/nwaku/issues/3396)) ([7d5eb9374](https://github.com/waku-org/nwaku/commit/7d5eb9374) [#3429](https://github.com/waku-org/nwaku/issues/3429)) ([ee5932ebc](https://github.com/waku-org/nwaku/commit/ee5932ebc))
+- Improve disconnection handling ([#3385](https://github.com/waku-org/nwaku/issues/3385)) ([1ec9b8d96](https://github.com/waku-org/nwaku/commit/1ec9b8d96))
+- Return all peers from REST admin ([#3395](https://github.com/waku-org/nwaku/issues/3395)) ([f6fdd960f](https://github.com/waku-org/nwaku/commit/f6fdd960f))
+- Simplify rln_relay code a little ([#3392](https://github.com/waku-org/nwaku/issues/3392)) ([7a6c00bd0](https://github.com/waku-org/nwaku/commit/7a6c00bd0))
+- Extended /admin/v1 RESP API with different option to look at current connected/relay/mesh state of the node ([#3382](https://github.com/waku-org/nwaku/issues/3382)) ([3db00f39e](https://github.com/waku-org/nwaku/commit/3db00f39e))
+- Timestamp set to now in publish if not provided ([#3373](https://github.com/waku-org/nwaku/issues/3373)) ([f7b424451](https://github.com/waku-org/nwaku/commit/f7b424451))
+- Update lite-protocol-tester for handling shard argument ([#3371](https://github.com/waku-org/nwaku/issues/3371)) ([5ab69edd7](https://github.com/waku-org/nwaku/commit/5ab69edd7))
+- Fix unused and deprecated imports ([#3368](https://github.com/waku-org/nwaku/issues/3368)) ([6ebb49a14](https://github.com/waku-org/nwaku/commit/6ebb49a14))
+- Expect camelCase JSON for libwaku store queries ([#3366](https://github.com/waku-org/nwaku/issues/3366)) ([ccb4ed51d](https://github.com/waku-org/nwaku/commit/ccb4ed51d))
+- Maintenance to c and c++ simple examples ([#3367](https://github.com/waku-org/nwaku/issues/3367)) ([25d30d44d](https://github.com/waku-org/nwaku/commit/25d30d44d))
+- Skip two flaky tests ([#3364](https://github.com/waku-org/nwaku/issues/3364)) ([b672617b2](https://github.com/waku-org/nwaku/commit/b672617b2))
+- Retrieve protocols in new added peer from discv5 ([#3354](https://github.com/waku-org/nwaku/issues/3354)) ([df58643ea](https://github.com/waku-org/nwaku/commit/df58643ea))
+- Better keystore management ([#3358](https://github.com/waku-org/nwaku/issues/3358)) ([a914fdccc](https://github.com/waku-org/nwaku/commit/a914fdccc))
+- Remove pubsub topics arguments ([#3350](https://github.com/waku-org/nwaku/issues/3350)) ([9778b45c6](https://github.com/waku-org/nwaku/commit/9778b45c6))
+- New performance measurement metrics for non-relay protocols ([#3299](https://github.com/waku-org/nwaku/issues/3299)) ([68c50a09a](https://github.com/waku-org/nwaku/commit/68c50a09a))
+- Start triggering CI for windows build ([#3316](https://github.com/waku-org/nwaku/issues/3316)) ([55ac6ba9f](https://github.com/waku-org/nwaku/commit/55ac6ba9f))
+- Less logs for rendezvous ([#3319](https://github.com/waku-org/nwaku/issues/3319)) ([6df05bae2](https://github.com/waku-org/nwaku/commit/6df05bae2))
+- Add test reporting doc to benchmarks dir ([#3238](https://github.com/waku-org/nwaku/issues/3238)) ([94554a6e0](https://github.com/waku-org/nwaku/commit/94554a6e0))
+- Improve epoch monitoring ([#3197](https://github.com/waku-org/nwaku/issues/3197)) ([b0c025f81](https://github.com/waku-org/nwaku/commit/b0c025f81))
+
+### 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/feat--waku-sync/standards/core/sync.md) | `draft` | `/vac/waku/sync/1.0.0` |
+
+
+## v0.35.1 (2025-03-30)
+
+### Bug fixes
+
+* Update RLN references ([3287](https://github.com/waku-org/nwaku/pull/3287)) ([ea961fa](https://github.com/waku-org/nwaku/pull/3287/commits/ea961faf4ed4f8287a2043a6b5d84b660745072b))
+
+**Info:** before upgrading to this version, make sure you delete the previous rln_tree folder, i.e.,
+the one that is passed through this CLI: `--rln-relay-tree-path`.
+
+### Features
+* lightpush v3 ([#3279](https://github.com/waku-org/nwaku/pull/3279)) ([e0b563ff](https://github.com/waku-org/nwaku/commit/e0b563ffe5af20bd26d37cd9b4eb9ed9eb82ff80))
+ Upgrade for Waku Llightpush protocol with enhanced error handling. Read specification [here](https://github.com/waku-org/specs/blob/master/standards/core/lightpush.md)
+
+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/feat--waku-sync/standards/core/sync.md) | `draft` | `/vac/waku/sync/1.0.0` |
+
+## v0.35.0 (2025-03-03)
+
+### 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
+
+- more efficient metrics usage ([#3298](https://github.com/waku-org/nwaku/issues/3298)) ([6f004d5d4](https://github.com/waku-org/nwaku/commit/6f004d5d4))([c07e278d8](https://github.com/waku-org/nwaku/commit/c07e278d82c3aa771b9988e85bad7422890e4d74))
+- 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`
`/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` |
+| [`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:
+
+* The `--protected-topic` CLI configuration has been removed. Equivalent flag, `--protected-shard`, shall be used instead.
+
+### Features
+
+- change latency buckets ([#3153](https://github.com/waku-org/nwaku/issues/3153)) ([956fde6e](https://github.com/waku-org/nwaku/commit/956fde6e))
+- libwaku: ping peer ([#3144](https://github.com/waku-org/nwaku/issues/3144)) ([de11e576](https://github.com/waku-org/nwaku/commit/de11e576))
+- initial windows support ([#3107](https://github.com/waku-org/nwaku/issues/3107)) ([ff21c01e](https://github.com/waku-org/nwaku/commit/ff21c01e))
+- circuit relay support ([#3112](https://github.com/waku-org/nwaku/issues/3112)) ([cfde7eea](https://github.com/waku-org/nwaku/commit/cfde7eea))
+
+### Bug Fixes
+
+- peer exchange libwaku response handling ([#3141](https://github.com/waku-org/nwaku/issues/3141)) ([76606421](https://github.com/waku-org/nwaku/commit/76606421))
+- add more logs, stagger intervals & set prune offset to 10% for waku sync ([#3142](https://github.com/waku-org/nwaku/issues/3142)) ([a386880b](https://github.com/waku-org/nwaku/commit/a386880b))
+- add log and archive message ingress for sync ([#3133](https://github.com/waku-org/nwaku/issues/3133)) ([80c7581a](https://github.com/waku-org/nwaku/commit/80c7581a))
+- add a limit of max 10 content topics per query ([#3117](https://github.com/waku-org/nwaku/issues/3117)) ([c35dc549](https://github.com/waku-org/nwaku/commit/c35dc549))
+- avoid segfault by setting a default num peers requested in Peer eXchange ([#3122](https://github.com/waku-org/nwaku/issues/3122)) ([82fd5dde](https://github.com/waku-org/nwaku/commit/82fd5dde))
+- returning peerIds in base 64 ([#3105](https://github.com/waku-org/nwaku/issues/3105)) ([37edaf62](https://github.com/waku-org/nwaku/commit/37edaf62))
+- changing libwaku's error handling format ([#3093](https://github.com/waku-org/nwaku/issues/3093)) ([2e6c299d](https://github.com/waku-org/nwaku/commit/2e6c299d))
+- remove spammy log ([#3091](https://github.com/waku-org/nwaku/issues/3091)) ([1d2b910f](https://github.com/waku-org/nwaku/commit/1d2b910f))
+- avoid out connections leak ([#3077](https://github.com/waku-org/nwaku/issues/3077)) ([eb2bbae6](https://github.com/waku-org/nwaku/commit/eb2bbae6))
+- rejecting excess relay connections ([#3065](https://github.com/waku-org/nwaku/issues/3065)) ([8b0884c7](https://github.com/waku-org/nwaku/commit/8b0884c7))
+- static linking negentropy in ARM based mac ([#3046](https://github.com/waku-org/nwaku/issues/3046)) ([256b7853](https://github.com/waku-org/nwaku/commit/256b7853))
+
+### Changes
+
+- support ping with multiple multiaddresses and close stream ([#3154](https://github.com/waku-org/nwaku/issues/3154)) ([3665991a](https://github.com/waku-org/nwaku/commit/3665991a))
+- liteprotocoltester: easy setup fleets ([#3125](https://github.com/waku-org/nwaku/issues/3125)) ([268e7e66](https://github.com/waku-org/nwaku/commit/268e7e66))
+- saving peers enr capabilities ([#3127](https://github.com/waku-org/nwaku/issues/3127)) ([69d9524f](https://github.com/waku-org/nwaku/commit/69d9524f))
+- networkmonitor: add missing field on RlnRelay init, set default for num of shard ([#3136](https://github.com/waku-org/nwaku/issues/3136)) ([edcb0e15](https://github.com/waku-org/nwaku/commit/edcb0e15))
+- add to libwaku peer id retrieval proc ([#3124](https://github.com/waku-org/nwaku/issues/3124)) ([c5a825e2](https://github.com/waku-org/nwaku/commit/c5a825e2))
+- adding to libwaku dial and disconnect by peerIds ([#3111](https://github.com/waku-org/nwaku/issues/3111)) ([25da8102](https://github.com/waku-org/nwaku/commit/25da8102))
+- dbconn: add requestId info as a comment in the database logs ([#3110](https://github.com/waku-org/nwaku/issues/3110)) ([30c072a4](https://github.com/waku-org/nwaku/commit/30c072a4))
+- improving get_peer_ids_by_protocol by returning the available protocols of connected peers ([#3109](https://github.com/waku-org/nwaku/issues/3109)) ([ed0ee5be](https://github.com/waku-org/nwaku/commit/ed0ee5be))
+- remove warnings ([#3106](https://github.com/waku-org/nwaku/issues/3106)) ([c861fa9f](https://github.com/waku-org/nwaku/commit/c861fa9f))
+- better store logs ([#3103](https://github.com/waku-org/nwaku/issues/3103)) ([21b03551](https://github.com/waku-org/nwaku/commit/21b03551))
+- Improve binding for waku_sync ([#3102](https://github.com/waku-org/nwaku/issues/3102)) ([c3756e3a](https://github.com/waku-org/nwaku/commit/c3756e3a))
+- improving and temporarily skipping flaky rln test ([#3094](https://github.com/waku-org/nwaku/issues/3094)) ([a6ed80a5](https://github.com/waku-org/nwaku/commit/a6ed80a5))
+- update master after release v0.33.1 ([#3089](https://github.com/waku-org/nwaku/issues/3089)) ([54c3083d](https://github.com/waku-org/nwaku/commit/54c3083d))
+- re-arrange function based on responsibility of peer-manager ([#3086](https://github.com/waku-org/nwaku/issues/3086)) ([0f8e8740](https://github.com/waku-org/nwaku/commit/0f8e8740))
+- waku_keystore: give some more context in case of error ([#3064](https://github.com/waku-org/nwaku/issues/3064)) ([3ad613ca](https://github.com/waku-org/nwaku/commit/3ad613ca))
+- bump negentropy ([#3078](https://github.com/waku-org/nwaku/issues/3078)) ([643ab20f](https://github.com/waku-org/nwaku/commit/643ab20f))
+- Optimize store ([#3061](https://github.com/waku-org/nwaku/issues/3061)) ([5875ed63](https://github.com/waku-org/nwaku/commit/5875ed63))
+- wrap peer store ([#3051](https://github.com/waku-org/nwaku/issues/3051)) ([729e63f5](https://github.com/waku-org/nwaku/commit/729e63f5))
+- disabling metrics for libwaku ([#3058](https://github.com/waku-org/nwaku/issues/3058)) ([b358c90f](https://github.com/waku-org/nwaku/commit/b358c90f))
+- test peer connection management ([#3049](https://github.com/waku-org/nwaku/issues/3049)) ([711e7db1](https://github.com/waku-org/nwaku/commit/711e7db1))
+- updating upload and download artifact actions to v4 ([#3047](https://github.com/waku-org/nwaku/issues/3047)) ([7c4a9717](https://github.com/waku-org/nwaku/commit/7c4a9717))
+- Better database query logs and logarithmic scale in grafana store panels ([#3048](https://github.com/waku-org/nwaku/issues/3048)) ([d68b06f1](https://github.com/waku-org/nwaku/commit/d68b06f1))
+- extending store metrics ([#3042](https://github.com/waku-org/nwaku/issues/3042)) ([fd83b42f](https://github.com/waku-org/nwaku/commit/fd83b42f))
+
+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` |
+| [`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.33.1 (2024-10-03)
+
+### Bug fixes
+
+* Fix out connections leak ([3077](https://github.com/waku-org/nwaku/pull/3077)) ([eb2bbae6](https://github.com/waku-org/nwaku/commit/eb2bbae6))
+
+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` |
+| [`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/feat--waku-sync/standards/core/sync.md) | `draft` | `/vac/waku/sync/1.0.0` |
+
+## v0.33.0 (2024-09-30)
+
+#### Notes:
+
+* The `--pubsub-topic` CLI configuration has been deprecated and support for it will be removed on release v0.35.0. In order to migrate, please use the `--shard` configuration instead. For example, instead of `--pubsub-topic=/waku/2/rs//`, use `--cluster-id=` once and `--shard=` for each subscribed shard
+* The `--rest-private` CLI configuration has been removed. Please delete any reference to it when running your nodes
+* Introduced the `--reliability` CLI configuration, activating the new experimental StoreV3 message confirmation protocol
+* DOS protection configurations of non-relay, req/resp protocols are changed
+ * `--request-rate-limit` and `--request-rate-period` options are no longer supported.
+ * `--rate-limit` CLI configuration is now available.
+ - The new flag can describe various rate-limit requirements for each protocol supported. The setting can be repeated, each instance can define exactly one rate-limit option.
+ - Format is `:volume/period`
+ - If protocol is not given, settings will be taken as default for un-set protocols. Ex: 80/2s
+ - Supported protocols are: lightpush|filter|px|store|storev2|storev3
+ - `volume` must be an integer value, representing number of requests over the period of time allowed.
+ - `period ` must be an integer with defined unit as one of h|m|s|ms
+ - If not set, no rate limit will be applied to request/response protocols, except for the filter protocol.
+
+
+### Release highlights
+
+* a new experimental reliability protocol has been implemented, leveraging StoreV3 to confirm message delivery
+* Peer Exchange protocol can now be protected by rate-limit boundary checks.
+* Fine-grained configuration of DOS protection is available with this release. See, "Notes" above.
+
+### Bug Fixes
+
+- rejecting excess relay connections ([#3063](https://github.com/waku-org/nwaku/issues/3063)) ([8b0884c7](https://github.com/waku-org/nwaku/commit/8b0884c7))
+- make Peer Exchange's rpc status_code optional for backward compatibility ([#3059](https://github.com/waku-org/nwaku/pull/3059)) ([5afa9b13](https://github.com/waku-org/nwaku/commit/5afa9b13))
+- px protocol decode - do not treat missing response field as error ([#3054](https://github.com/waku-org/nwaku/issues/3054)) ([9b445ac4](https://github.com/waku-org/nwaku/commit/9b445ac4))
+- setting up node with modified config ([#3036](https://github.com/waku-org/nwaku/issues/3036)) ([8f289925](https://github.com/waku-org/nwaku/commit/8f289925))
+- get back health check for postgres legacy ([#3010](https://github.com/waku-org/nwaku/issues/3010)) ([5a0edff7](https://github.com/waku-org/nwaku/commit/5a0edff7))
+- libnegentropy integration ([#2996](https://github.com/waku-org/nwaku/issues/2996)) ([c3cb06ac](https://github.com/waku-org/nwaku/commit/c3cb06ac))
+- peer-exchange issue ([#2889](https://github.com/waku-org/nwaku/issues/2889)) ([43157102](https://github.com/waku-org/nwaku/commit/43157102))
+
+### Changes
+
+- append current version in agentString which is used by the identify protocol ([#3057](https://github.com/waku-org/nwaku/pull/3057)) ([368bb3c1](https://github.com/waku-org/nwaku/commit/368bb3c1))
+- rate limit peer exchange protocol, enhanced response status in RPC ([#3035](https://github.com/waku-org/nwaku/issues/3035)) ([0a7f16a3](https://github.com/waku-org/nwaku/commit/0a7f16a3))
+- Switch libnegentropy library build from shared to static linkage ([#3041](https://github.com/waku-org/nwaku/issues/3041)) ([83f25c3e](https://github.com/waku-org/nwaku/commit/83f25c3e))
+- libwaku reduce repetitive code by adding a template handling resp returns ([#3032](https://github.com/waku-org/nwaku/issues/3032)) ([1713f562](https://github.com/waku-org/nwaku/commit/1713f562))
+- libwaku - extending the library with peer_manager and peer_exchange features ([#3026](https://github.com/waku-org/nwaku/issues/3026)) ([5ea1cf0c](https://github.com/waku-org/nwaku/commit/5ea1cf0c))
+- use submodule nph in CI to check lint ([#3027](https://github.com/waku-org/nwaku/issues/3027)) ([ce9a8c46](https://github.com/waku-org/nwaku/commit/ce9a8c46))
+- deprecating pubsub topic ([#2997](https://github.com/waku-org/nwaku/issues/2997)) ([a3cd2a1a](https://github.com/waku-org/nwaku/commit/a3cd2a1a))
+- lightpush - error metric less variable by only setting a fixed string ([#3020](https://github.com/waku-org/nwaku/issues/3020)) ([d3e6717a](https://github.com/waku-org/nwaku/commit/d3e6717a))
+- enhance libpq management ([#3015](https://github.com/waku-org/nwaku/issues/3015)) ([45319f09](https://github.com/waku-org/nwaku/commit/45319f09))
+- per limit split of PostgreSQL queries ([#3008](https://github.com/waku-org/nwaku/issues/3008)) ([e1e05afb](https://github.com/waku-org/nwaku/commit/e1e05afb))
+- Added metrics to liteprotocoltester ([#3002](https://github.com/waku-org/nwaku/issues/3002)) ([8baf627f](https://github.com/waku-org/nwaku/commit/8baf627f))
+- extending store metrics ([#2995](https://github.com/waku-org/nwaku/issues/2995)) ([fd83b42f](https://github.com/waku-org/nwaku/commit/fd83b42f))
+- Better timing and requestId detail for slower store db queries ([#2994](https://github.com/waku-org/nwaku/issues/2994)) ([e8a49b76](https://github.com/waku-org/nwaku/commit/e8a49b76))
+- remove unused setting from external_config.nim ([#3004](https://github.com/waku-org/nwaku/issues/3004)) ([fd84363e](https://github.com/waku-org/nwaku/commit/fd84363e))
+- delivery monitor for store v3 reliability protocol ([#2977](https://github.com/waku-org/nwaku/issues/2977)) ([0f68274c](https://github.com/waku-org/nwaku/commit/0f68274c))
+
+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` |
+| [`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/feat--waku-sync/standards/core/sync.md) | `draft` | `/vac/waku/sync/1.0.0` |
+
+## v0.32.0 (2024-08-30)
+
+#### Notes:
+
+* A new `discv5-only` CLI flag was introduced, which if set to true will perform optimizations for nodes that only run the DiscV5 service
+* The `protected-topic` CLI config item has been deprecated in favor of the new `protected-shard` configuration. Protected topics are still supported and will be completely removed in two releases time for `v0.34.0`
+
+### Release highlights
+
+* Merged Nwaku Sync protocol for synchronizing store nodes
+* Added Store Resume mechanism to retrieve messages sent when the node was offline
+
+### Features
+
+- Nwaku Sync ([#2403](https://github.com/waku-org/nwaku/issues/2403)) ([2cc86c51](https://github.com/waku-org/nwaku/commit/2cc86c51))
+- misc. updates for discovery network analysis ([#2930](https://github.com/waku-org/nwaku/issues/2930)) ([4340eb75](https://github.com/waku-org/nwaku/commit/4340eb75))
+- store resume ([#2919](https://github.com/waku-org/nwaku/issues/2919)) ([aed2a113](https://github.com/waku-org/nwaku/commit/aed2a113))
+
+### Bug Fixes
+
+- return on insert error ([#2956](https://github.com/waku-org/nwaku/issues/2956)) ([5f0fbd78](https://github.com/waku-org/nwaku/commit/5f0fbd78))
+- network monitor improvements ([#2939](https://github.com/waku-org/nwaku/issues/2939)) ([80583237](https://github.com/waku-org/nwaku/commit/80583237))
+- add back waku discv5 metrics ([#2927](https://github.com/waku-org/nwaku/issues/2927)) ([e4e01fab](https://github.com/waku-org/nwaku/commit/e4e01fab))
+- update and shift unittest ([#2934](https://github.com/waku-org/nwaku/issues/2934)) ([08973add](https://github.com/waku-org/nwaku/commit/08973add))
+- handle rln-relay-message-limit ([#2867](https://github.com/waku-org/nwaku/issues/2867)) ([8d107b0d](https://github.com/waku-org/nwaku/commit/8d107b0d))
+
+### Changes
+
+- libwaku retrieve my enr and adapt golang example ([#2987](https://github.com/waku-org/nwaku/issues/2987)) ([1ff9f1dd](https://github.com/waku-org/nwaku/commit/1ff9f1dd))
+- run `ANALYZE messages` regularly for better db performance ([#2986](https://github.com/waku-org/nwaku/issues/2986)) ([32f2d85d](https://github.com/waku-org/nwaku/commit/32f2d85d))
+- liteprotocoltester for simulation and for fleets ([#2813](https://github.com/waku-org/nwaku/issues/2813)) ([f4fa73e9](https://github.com/waku-org/nwaku/commit/f4fa73e9))
+- lock in nph version and add pre-commit hook ([#2938](https://github.com/waku-org/nwaku/issues/2938)) ([d63e3430](https://github.com/waku-org/nwaku/commit/d63e3430))
+- logging received message info via onValidated observer ([#2973](https://github.com/waku-org/nwaku/issues/2973)) ([e8bce67d](https://github.com/waku-org/nwaku/commit/e8bce67d))
+- deprecating protected topics in favor of protected shards ([#2983](https://github.com/waku-org/nwaku/issues/2983)) ([e51ffe07](https://github.com/waku-org/nwaku/commit/e51ffe07))
+- rename NsPubsubTopic ([#2974](https://github.com/waku-org/nwaku/issues/2974)) ([67439057](https://github.com/waku-org/nwaku/commit/67439057))
+- install dig ([#2975](https://github.com/waku-org/nwaku/issues/2975)) ([d24b56b9](https://github.com/waku-org/nwaku/commit/d24b56b9))
+- print WakuMessageHash as hex strings ([#2969](https://github.com/waku-org/nwaku/issues/2969)) ([2fd4eb62](https://github.com/waku-org/nwaku/commit/2fd4eb62))
+- updating dependencies for release 0.32.0 ([#2971](https://github.com/waku-org/nwaku/issues/2971)) ([dfd42a7c](https://github.com/waku-org/nwaku/commit/dfd42a7c))
+- bump negentropy to latest master ([#2968](https://github.com/waku-org/nwaku/issues/2968)) ([b36cb075](https://github.com/waku-org/nwaku/commit/b36cb075))
+- keystore: verbose error message when credential is not found ([#2943](https://github.com/waku-org/nwaku/issues/2943)) ([0f11ee14](https://github.com/waku-org/nwaku/commit/0f11ee14))
+- upgrade peer exchange mounting ([#2953](https://github.com/waku-org/nwaku/issues/2953)) ([42f1bed0](https://github.com/waku-org/nwaku/commit/42f1bed0))
+- replace statusim.net instances with status.im ([#2941](https://github.com/waku-org/nwaku/issues/2941)) ([f534549a](https://github.com/waku-org/nwaku/commit/f534549a))
+- updating doc reference to https rpc ([#2937](https://github.com/waku-org/nwaku/issues/2937)) ([bb7bba35](https://github.com/waku-org/nwaku/commit/bb7bba35))
+- Simplification of store legacy code ([#2931](https://github.com/waku-org/nwaku/issues/2931)) ([d4e8a0da](https://github.com/waku-org/nwaku/commit/d4e8a0da))
+- add peer filtering by cluster for waku peer exchange ([#2932](https://github.com/waku-org/nwaku/issues/2932)) ([b4618f98](https://github.com/waku-org/nwaku/commit/b4618f98))
+- return all connected peers from REST API ([#2923](https://github.com/waku-org/nwaku/issues/2923)) ([a29eca77](https://github.com/waku-org/nwaku/commit/a29eca77))
+- adding lint job to the CI ([#2925](https://github.com/waku-org/nwaku/issues/2925)) ([086cc8ed](https://github.com/waku-org/nwaku/commit/086cc8ed))
+- improve sonda dashboard ([#2918](https://github.com/waku-org/nwaku/issues/2918)) ([6d385cef](https://github.com/waku-org/nwaku/commit/6d385cef))
+- Add new custom built and test target to make in order to enable easy build or test single nim modules ([#2913](https://github.com/waku-org/nwaku/issues/2913)) ([ad25f437](https://github.com/waku-org/nwaku/commit/ad25f437))
+
+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` |
+| [`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/feat--waku-sync/standards/core/sync.md) | `draft` | `/vac/waku/sync/1.0.0` |
+
+## v0.31.1 (2024-08-02)
+
+### Changes
+
+- Optimize hash queries with lookup table ([#2933](https://github.com/waku-org/nwaku/issues/2933)) ([6463885bf](https://github.com/waku-org/nwaku/commit/6463885bf))
+
+### Bug fixes
+
+* Use of detach finalize when needed [2966](https://github.com/waku-org/nwaku/pull/2966)
+* Prevent legacy store from creating new partitions as that approach blocked the database.
+[2931](https://github.com/waku-org/nwaku/pull/2931)
+
+* lightpush better feedback in case the lightpush service node does not have peers [2951](https://github.com/waku-org/nwaku/pull/2951)
+
+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` |
+| [`WAKU2-STORE`](https://github.com/waku-org/specs/blob/master/standards/core/store.md) | `draft` | `/vac/waku/store-query/3.0.0` |
+| [`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` |
+
+## v0.31.0 (2024-07-16)
+### Notes
+
+* Named sharding has been deprecated in favor of static sharding. Topics in formats other than `/waku/2/rs//` are no longer supported
+
+### Features
+
+- DOS protection of non relay protocols - rate limit phase3 (#2897) ([ba418ab5b](https://github.com/waku-org/nwaku/commit/ba418ab5b))
+- sonda tool (#2893) ([e269dca9c](https://github.com/waku-org/nwaku/commit/e269dca9c))
+- add proper per shard bandwidth metric calculation (#2851) ([8f14c0473](https://github.com/waku-org/nwaku/commit/8f14c0473))
+
+### Bug Fixes
+
+- bug(storev3): can't advance cursor [#2745](https://github.com/waku-org/nwaku/issues/2745)
+- chore(storev3): only select the messageHash column when using a store query with include_data: false [#2637](https://github.com/waku-org/nwaku/issues/2637)
+- rln_keystore_generator improve error handling for unrecoverable failure (#2881) ([1c9eb2741](https://github.com/waku-org/nwaku/commit/1c9eb2741))
+- duplicate message forwarding in filter service (#2842) ([99149ea9d](https://github.com/waku-org/nwaku/commit/99149ea9d))
+- only set disconnect time on left event (#2831) ([01050138c](https://github.com/waku-org/nwaku/commit/01050138c))
+- adding peer exchange peers to the peerStore (#2824) ([325e13169](https://github.com/waku-org/nwaku/commit/325e13169))
+- ci use --tags to match non-annotated tags (#2814) ([317c83dc1](https://github.com/waku-org/nwaku/commit/317c83dc1))
+- update peers ENRs in peer store in case they are updated (#2818) ([cda18f96c](https://github.com/waku-org/nwaku/commit/cda18f96c))
+- mount metadata in wakucanary (#2793) ([3b27aee82](https://github.com/waku-org/nwaku/commit/3b27aee82))
+
+### Changes
+
+- setting filter handling logs to trace (#2914) ([5c539fe13](https://github.com/waku-org/nwaku/commit/5c539fe13))
+- enhance postgres and retention policy logs (#2884) ([71ee42de5](https://github.com/waku-org/nwaku/commit/71ee42de5))
+- improving logging under debugDiscv5 flag (#2899) ([8578fb0c3](https://github.com/waku-org/nwaku/commit/8578fb0c3))
+- archive and drivers refactor (#2761) ([f54ba10bc](https://github.com/waku-org/nwaku/commit/f54ba10bc))
+- new release process to include Status fleets (#2825) ([4264666a3](https://github.com/waku-org/nwaku/commit/4264666a3))
+- sqlite make sure code is always run (#2891) ([4ac4ab2a4](https://github.com/waku-org/nwaku/commit/4ac4ab2a4))
+- deprecating named sharding (#2723) ([e1518cf9f](https://github.com/waku-org/nwaku/commit/e1518cf9f))
+- bump dependencies for v0.31.0 (#2885) ([fd6a71cdd](https://github.com/waku-org/nwaku/commit/fd6a71cdd))
+- refactor relative path to better absolute (#2861) ([8bfad3ab4](https://github.com/waku-org/nwaku/commit/8bfad3ab4))
+- saving agent and protoVersion in peerStore (#2860) ([cae0c7e37](https://github.com/waku-org/nwaku/commit/cae0c7e37))
+- unit test for duplicate message push (#2852) ([31c632e42](https://github.com/waku-org/nwaku/commit/31c632e42))
+- remove all pre-nim-1.6 deadcode from codebase (#2857) ([9bd8c33ae](https://github.com/waku-org/nwaku/commit/9bd8c33ae))
+- nim-chronos bump submodule (#2850) ([092add1ca](https://github.com/waku-org/nwaku/commit/092add1ca))
+- ignore arbitrary data stored in `multiaddrs` enr key (#2853) ([76d5b2642](https://github.com/waku-org/nwaku/commit/76d5b2642))
+- add origin to peers admin endpoint (#2848) ([7205f95cf](https://github.com/waku-org/nwaku/commit/7205f95cf))
+- add discv5 logs (#2811) ([974b8a39a](https://github.com/waku-org/nwaku/commit/974b8a39a))
+- archive.nim - increase the max limit of content topics per query to 100 (#2846) ([a05fa0691](https://github.com/waku-org/nwaku/commit/a05fa0691))
+- update content-topic parsing for filter (#2835) ([733edae43](https://github.com/waku-org/nwaku/commit/733edae43))
+- better descriptive log (#2826) ([94947a850](https://github.com/waku-org/nwaku/commit/94947a850))
+- zerokit: bump submodule (#2830) ([c483acee3](https://github.com/waku-org/nwaku/commit/c483acee3))
+
+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` |
+| [`WAKU2-STORE`](https://github.com/waku-org/specs/blob/master/standards/core/store.md) | `draft` | `/vac/waku/store-query/3.0.0` |
+| [`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` |
+
+
+## v0.30.2 (2024-07-12)
+
+### Release highlights
+
+* RLN message limit to 100 messages per epoch.
+* Avoid exclusive access when creating new partitions in the PostgreSQL messages table.
+
+### Changes
+
+- chore(rln): rln message limit to 100 ([#2883](https://github.com/waku-org/nwaku/pull/2883))
+- fix: postgres_driver better partition creation without exclusive access [28bdb70b](https://github.com/waku-org/nwaku/commit/28bdb70be46d3fb3a6f992b3f9f2de1defd85a30)
+
+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` |
+| [`66/WAKU2-METADATA`](https://github.com/waku-org/specs/blob/master/standards/core/metadata.md) | `raw` | `/vac/waku/metadata/1.0.0` |
+
+## v0.30.1 (2024-07-03)
+
+### Notes
+
+* Before upgrading to this version, if you are currently using RLN, make sure to remove your existing `keystore` folder and `rln_tree`
+and start your installation from scratch, as
+explained in [nwaku-compose](https://github.com/waku-org/nwaku-compose/blob/1b56575df9ddb904af0941a19ea1df3d36bfddfa/README.md).
+
+### Release highlights
+
+* RLN_v2 is used. The maximum rate can be set to `N` messages per epoch, instead of just one message per epoch. See [this](https://github.com/waku-org/nwaku/issues/2345) for more details. Notice that we established an epoch of 10 minutes.
+
+
+### Changes
+
+- rln-relay: add chain-id flag to wakunode and restrict usage if mismatches rpc provider ([#2858](https://github.com/waku-org/nwaku/pull/2858))
+- rln: fix nullifierlog vulnerability ([#2855](https://github.com/waku-org/nwaku/pull/2855))
+- chore: add TWN parameters for RLNv2 ([#2843](https://github.com/waku-org/nwaku/pull/2843))
+- fix(rln-relay): clear nullifier log only if length is over max epoch gap ([#2836](https://github.com/waku-org/nwaku/pull/2836))
+- rlnv2: clean fork of rlnv2 ([#2828](https://github.com/waku-org/nwaku/issues/2828)) ([a02832fe](https://github.com/waku-org/nwaku/commit/a02832fe))
+- zerokit: bump submodule ([#2830](https://github.com/waku-org/nwaku/issues/2830)) ([bd064882](https://github.com/waku-org/nwaku/commit/bd064882))
+
+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` |
+| [`66/WAKU2-METADATA`](https://github.com/waku-org/specs/blob/master/standards/core/metadata.md) | `raw` | `/vac/waku/metadata/1.0.0` |
+
+## v0.29.0 (2024-06-19)
+
+## What's Changed
+
+Notes:
+
+* Named sharding will be deprecated in favor of static sharding. Topics in formats other than `/waku/2/rs//` will stop being supported starting from `v0.31.0`
+
+Release highlights:
+
+* Android support in libwaku
+* Discovery is available in libwaku
+* New LiteProcotolTester tool
+* RLN proofs as a lightpush service
+
+### Features
+
+- RLN proofs as a lightpush service ([#2768](https://github.com/waku-org/nwaku/issues/2768)) ([0561e5bd](https://github.com/waku-org/nwaku/commit/0561e5bd))
+- Push newly released nwaku image with latest-release tag ([#2732](https://github.com/waku-org/nwaku/issues/2732)) ([736ce1cb](https://github.com/waku-org/nwaku/commit/736ce1cb))
+- Rln-relay: use arkzkey variant of zerokit ([#2681](https://github.com/waku-org/nwaku/issues/2681)) ([e7b0777d](https://github.com/waku-org/nwaku/commit/e7b0777d))
+
+### Bug Fixes
+
+- Better sync lock in partition creation ([#2783](https://github.com/waku-org/nwaku/issues/2783)) ([8d3bbb1b](https://github.com/waku-org/nwaku/pull/2809/commits/8d3bbb1b4e79b15c8cf18bb91d366e9ec1153301))
+- Multi nat initialization causing dead lock in waku tests + serialize test runs to avoid timing and port occupied issues ([#2799](https://github.com/waku-org/nwaku/issues/2799)) ([5989de88](https://github.com/waku-org/nwaku/commit/5989de88))
+- Increase on chain group manager starting balance ([#2795](https://github.com/waku-org/nwaku/issues/2795)) ([e72bb7e7](https://github.com/waku-org/nwaku/commit/e72bb7e7))
+- More detailed logs to differentiate shards with peers ([#2794](https://github.com/waku-org/nwaku/issues/2794)) ([55a87d21](https://github.com/waku-org/nwaku/commit/55a87d21))
+- waku_archive: only allow a single instance to execute migrations ([#2736](https://github.com/waku-org/nwaku/issues/2736)) ([88b8e186](https://github.com/waku-org/nwaku/commit/88b8e186))
+- Move postgres related tests under linux conditional ([57ecb3e0](https://github.com/waku-org/nwaku/commit/57ecb3e0))
+- Invalid cursor returning messages ([#2724](https://github.com/waku-org/nwaku/issues/2724)) ([a65b13fc](https://github.com/waku-org/nwaku/commit/a65b13fc))
+- Do not print the db url on error ([#2725](https://github.com/waku-org/nwaku/issues/2725)) ([40296f9d](https://github.com/waku-org/nwaku/commit/40296f9d))
+- Use `when` instead of `if` for adding soname on linux ([#2721](https://github.com/waku-org/nwaku/issues/2721)) ([cbaefeb3](https://github.com/waku-org/nwaku/commit/cbaefeb3))
+- Store v3 bug fixes ([#2718](https://github.com/waku-org/nwaku/issues/2718)) ([4a6ec468](https://github.com/waku-org/nwaku/commit/4a6ec468))
+
+
+### Changes
+
+- Set msg_hash logs to notice level ([#2737](https://github.com/waku-org/nwaku/issues/2737)) ([f5d87c5b](https://github.com/waku-org/nwaku/commit/f5d87c5b))
+- Minor enhancements ([#2789](https://github.com/waku-org/nwaku/issues/2789)) ([31bd6d71](https://github.com/waku-org/nwaku/commit/31bd6d71))
+- postgres_driver - acquire/release advisory lock when creating partitions ([#2784](https://github.com/waku-org/nwaku/issues/2784)) ([c5d19c44](https://github.com/waku-org/nwaku/commit/c5d19c44))
+- Setting fail-fast to false in matrixed github actions ([#2787](https://github.com/waku-org/nwaku/issues/2787)) ([005349cc](https://github.com/waku-org/nwaku/commit/005349cc))
+- Simple link refactor ([#2781](https://github.com/waku-org/nwaku/issues/2781)) ([77adfccd](https://github.com/waku-org/nwaku/commit/77adfccd))
+- Improving liteprotocolteseter stats ([#2750](https://github.com/waku-org/nwaku/issues/2750)) ([4c7c8a15](https://github.com/waku-org/nwaku/commit/4c7c8a15))
+- Extract common prefixes into a constant for multiple query ([#2747](https://github.com/waku-org/nwaku/issues/2747)) ([dfc979a8](https://github.com/waku-org/nwaku/commit/dfc979a8))
+- wakucanary: fix fitler protocol, add storev3 ([#2735](https://github.com/waku-org/nwaku/issues/2735)) ([e0079cd0](https://github.com/waku-org/nwaku/commit/e0079cd0))
+- Bump nim-libp2p version ([#2661](https://github.com/waku-org/nwaku/issues/2661)) ([6fbab633](https://github.com/waku-org/nwaku/commit/6fbab633))
+- Link validation process docs to the release process file ([#2714](https://github.com/waku-org/nwaku/issues/2714)) ([ebe69be8](https://github.com/waku-org/nwaku/commit/ebe69be8))
+- Android support ([#2554](https://github.com/waku-org/nwaku/issues/2554)) ([1e2aa57a](https://github.com/waku-org/nwaku/commit/1e2aa57a))
+- Discovery in libwaku ([#2711](https://github.com/waku-org/nwaku/issues/2711)) ([74646848](https://github.com/waku-org/nwaku/commit/74646848))
+- libwaku - allow to properly set the log level in libwaku and unify a little ([#2708](https://github.com/waku-org/nwaku/issues/2708)) ([3faffdbc](https://github.com/waku-org/nwaku/commit/3faffdbc))
+- waku_discv5, peer_manager - add more logs help debug discovery issues ([#2705](https://github.com/waku-org/nwaku/issues/2705)) ([401630ee](https://github.com/waku-org/nwaku/commit/401630ee))
+- Generic change to reduce the number of compilation warnings ([#2696](https://github.com/waku-org/nwaku/issues/2696)) ([78132dc1](https://github.com/waku-org/nwaku/commit/78132dc1))
+
+
+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` |
+| [`66/WAKU2-METADATA`](https://github.com/waku-org/specs/blob/master/standards/core/metadata.md) | `raw` | `/vac/waku/metadata/1.0.0` |
+
+## v0.28.1 (2024-05-29)
+
+This patch release fixes the following bug:
+- Store node does not retrieve messages because the meta field is missing in queries.
+
+### Bug Fix
+
+- Commit that fixes the bug [8b42f199](https://github.com/waku-org/nwaku/commit/8b42f199baf4e00794c4cec4d8601c3f6c330a20)
+
+This is a patch release that is fully backwards-compatible with release `v0.28.0`.
+
+It supports the same [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` |
+| [`66/WAKU2-METADATA`](https://github.com/waku-org/specs/blob/master/standards/core/metadata.md) | `raw` | `/vac/waku/metadata/1.0.0` |
+
+
+## v0.28.0 (2024-05-22)
+
+## What's Changed
+
+Release highlights:
+
+* Store V3 has been merged
+* Implemented an enhanced and more robust node health check mechanism
+* Introduced the Waku object to libwaku in order to setup a node and its protocols
+
+### Features
+
+- Added message size check before relay for lightpush ([#2695](https://github.com/waku-org/nwaku/issues/2695)) ([9dfdfa27](https://github.com/waku-org/nwaku/commit/9dfdfa27))
+- adding json string support to bindings config ([#2685](https://github.com/waku-org/nwaku/issues/2685)) ([be5471c6](https://github.com/waku-org/nwaku/commit/be5471c6))
+- Added flexible rate limit checks for store, legacy store and lightpush ([#2668](https://github.com/waku-org/nwaku/issues/2668)) ([026d804a](https://github.com/waku-org/nwaku/commit/026d804a))
+- store v3 return pubsub topics ([#2676](https://github.com/waku-org/nwaku/issues/2676)) ([d700006a](https://github.com/waku-org/nwaku/commit/d700006a))
+- supporting meta field in store ([#2609](https://github.com/waku-org/nwaku/issues/2609)) ([a46d4451](https://github.com/waku-org/nwaku/commit/a46d4451))
+- store v3 ([#2431](https://github.com/waku-org/nwaku/issues/2431)) ([0b0fbfad](https://github.com/waku-org/nwaku/commit/0b0fbfad))
+
+### Bug Fixes
+
+- use await instead of waitFor in async tests ([#2690](https://github.com/waku-org/nwaku/issues/2690)) ([a37c9ba9](https://github.com/waku-org/nwaku/commit/a37c9ba9))
+- message cache removal crash ([#2682](https://github.com/waku-org/nwaku/issues/2682)) ([fa26d05f](https://github.com/waku-org/nwaku/commit/fa26d05f))
+- add `meta` to sqlite migration scripts ([#2675](https://github.com/waku-org/nwaku/issues/2675)) ([82f95999](https://github.com/waku-org/nwaku/commit/82f95999))
+- content_script_version_4.nim: migration failed when dropping unexisting constraing ([#2672](https://github.com/waku-org/nwaku/issues/2672)) ([38f8b08c](https://github.com/waku-org/nwaku/commit/38f8b08c))
+- **filter:** log is too large ([#2665](https://github.com/waku-org/nwaku/issues/2665)) ([cee020f2](https://github.com/waku-org/nwaku/commit/cee020f2))
+- issue [#2644](https://github.com/waku-org/nwaku/issues/2644) properly ([#2663](https://github.com/waku-org/nwaku/issues/2663)) ([853ec186](https://github.com/waku-org/nwaku/commit/853ec186))
+- store v3 validate cursor & remove messages ([#2636](https://github.com/waku-org/nwaku/issues/2636)) ([e03d1165](https://github.com/waku-org/nwaku/commit/e03d1165))
+- **waku_keystore:** sigsegv on different appInfo ([#2654](https://github.com/waku-org/nwaku/issues/2654)) ([5dd645cf](https://github.com/waku-org/nwaku/commit/5dd645cf))
+- **rln-relay:** persist metadata every batch during initial sync ([#2649](https://github.com/waku-org/nwaku/issues/2649)) ([a9e19efd](https://github.com/waku-org/nwaku/commit/a9e19efd))
+- handle named sharding in enr ([#2647](https://github.com/waku-org/nwaku/issues/2647)) ([8d1b0834](https://github.com/waku-org/nwaku/commit/8d1b0834))
+- parse shards properly in enr config for non twn ([#2633](https://github.com/waku-org/nwaku/issues/2633)) ([6e6cb298](https://github.com/waku-org/nwaku/commit/6e6cb298))
+- proto field numbers & status desc ([#2632](https://github.com/waku-org/nwaku/issues/2632)) ([843fe217](https://github.com/waku-org/nwaku/commit/843fe217))
+- missing rate limit setting for legacy store protocol ([#2631](https://github.com/waku-org/nwaku/issues/2631)) ([5f65565c](https://github.com/waku-org/nwaku/commit/5f65565c))
+- **rln-relay:** enforce error callback to remove exception raised from retryWrapper ([#2622](https://github.com/waku-org/nwaku/issues/2622)) ([9c9883a6](https://github.com/waku-org/nwaku/commit/9c9883a6))
+- **rln-relay:** increase retries for 1 minute recovery time ([#2614](https://github.com/waku-org/nwaku/issues/2614)) ([1a23700d](https://github.com/waku-org/nwaku/commit/1a23700d))
+- **ci:** unique comment_tag to reference rln version ([#2613](https://github.com/waku-org/nwaku/issues/2613)) ([2c01fa0f](https://github.com/waku-org/nwaku/commit/2c01fa0f))
+- don't use WakuMessageSize in req/resp protocols ([#2601](https://github.com/waku-org/nwaku/issues/2601)) ([e61e4ff9](https://github.com/waku-org/nwaku/commit/e61e4ff9))
+- create options api for cors preflight request ([#2598](https://github.com/waku-org/nwaku/issues/2598)) ([768c61b1](https://github.com/waku-org/nwaku/commit/768c61b1))
+- node restart test issue ([#2576](https://github.com/waku-org/nwaku/issues/2576)) ([4a8e62ac](https://github.com/waku-org/nwaku/commit/4a8e62ac))
+- **doc:** update REST API docs ([#2581](https://github.com/waku-org/nwaku/issues/2581)) ([006d43ae](https://github.com/waku-org/nwaku/commit/006d43ae))
+
+### Changes
+
+- move code from wakunode2 to a more generic place, waku ([#2670](https://github.com/waku-org/nwaku/issues/2670)) ([840e0122](https://github.com/waku-org/nwaku/commit/840e0122))
+- closing ping streams ([#2692](https://github.com/waku-org/nwaku/issues/2692)) ([7d4857ea](https://github.com/waku-org/nwaku/commit/7d4857ea))
+- Postgres enhance get oldest timestamp ([#2687](https://github.com/waku-org/nwaku/issues/2687)) ([8451cf8e](https://github.com/waku-org/nwaku/commit/8451cf8e))
+- **rln-relay:** health check should account for window of roots ([#2664](https://github.com/waku-org/nwaku/issues/2664)) ([6a1af922](https://github.com/waku-org/nwaku/commit/6a1af922))
+- updating TWN bootstrap fleet to waku.sandbox ([#2638](https://github.com/waku-org/nwaku/issues/2638)) ([22f64bbd](https://github.com/waku-org/nwaku/commit/22f64bbd))
+- simplify migration script postgres version_4 ([#2674](https://github.com/waku-org/nwaku/issues/2674)) ([91c85738](https://github.com/waku-org/nwaku/commit/91c85738))
+- big refactor to add waku component in libwaku instead of only waku node ([#2658](https://github.com/waku-org/nwaku/issues/2658)) ([2463527b](https://github.com/waku-org/nwaku/commit/2463527b))
+- simplify app.nim and move discovery items to appropriate modules ([#2657](https://github.com/waku-org/nwaku/issues/2657)) ([404810aa](https://github.com/waku-org/nwaku/commit/404810aa))
+- log enhancement for message reliability analysis ([#2640](https://github.com/waku-org/nwaku/issues/2640)) ([d5e0e4a9](https://github.com/waku-org/nwaku/commit/d5e0e4a9))
+- metrics server. Simplify app.nim module ([#2650](https://github.com/waku-org/nwaku/issues/2650)) ([4a110f65](https://github.com/waku-org/nwaku/commit/4a110f65))
+- change nim-libp2p branch from unstable to master ([#2648](https://github.com/waku-org/nwaku/issues/2648)) ([d09c9c91](https://github.com/waku-org/nwaku/commit/d09c9c91))
+- Enabling to use a full node for lightpush via rest api without lightpush client configured ([#2626](https://github.com/waku-org/nwaku/issues/2626)) ([2a4c0f15](https://github.com/waku-org/nwaku/commit/2a4c0f15))
+- **rln-relay:** resultify rln-relay 1/n ([#2607](https://github.com/waku-org/nwaku/issues/2607)) ([1d7ff288](https://github.com/waku-org/nwaku/commit/1d7ff288))
+- ci.yml - avoid calling brew link libpq --force on macos ([#2627](https://github.com/waku-org/nwaku/issues/2627)) ([05f332ed](https://github.com/waku-org/nwaku/commit/05f332ed))
+- an enhanced version of convenient node health check script ([#2624](https://github.com/waku-org/nwaku/issues/2624)) ([7f8d8e80](https://github.com/waku-org/nwaku/commit/7f8d8e80))
+- **rln-db-inspector:** add more logging to find zero leaf indices ([#2617](https://github.com/waku-org/nwaku/issues/2617)) ([40752b1e](https://github.com/waku-org/nwaku/commit/40752b1e))
+- addition of waku_api/rest/builder.nim and reduce app.nim ([#2623](https://github.com/waku-org/nwaku/issues/2623)) ([b28207ab](https://github.com/waku-org/nwaku/commit/b28207ab))
+- Separation of node health and initialization state from rln_relay ([#2612](https://github.com/waku-org/nwaku/issues/2612)) ([6d135b0d](https://github.com/waku-org/nwaku/commit/6d135b0d))
+- enabling rest api as default ([#2600](https://github.com/waku-org/nwaku/issues/2600)) ([6bc79bc7](https://github.com/waku-org/nwaku/commit/6bc79bc7))
+- move app.nim and networks_config.nim to waku/factory ([#2608](https://github.com/waku-org/nwaku/issues/2608)) ([1ba9df4b](https://github.com/waku-org/nwaku/commit/1ba9df4b))
+- workflow to autoassign PR ([#2604](https://github.com/waku-org/nwaku/issues/2604)) ([10d36c39](https://github.com/waku-org/nwaku/commit/10d36c39))
+- start moving discovery modules to waku/discovery ([#2587](https://github.com/waku-org/nwaku/issues/2587)) ([828583ad](https://github.com/waku-org/nwaku/commit/828583ad))
+- don't create docker images for users without org's secrets ([#2585](https://github.com/waku-org/nwaku/issues/2585)) ([51ec12be](https://github.com/waku-org/nwaku/commit/51ec12be))
+
+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` |
+| [`66/WAKU2-METADATA`](https://github.com/waku-org/specs/blob/master/standards/core/metadata.md) | `raw` | `/vac/waku/metadata/1.0.0` |
+
+The Waku v1 implementation has been removed from this repository and can be found in a separate [Waku Legacy](https://github.com/waku-org/waku-legacy) repository.
+
+## v0.27.0 (2024-04-19)
+
+> **Note:**
+
+> - Filter v1 protocol and its REST-API access have been deprecated.
+> - A new field of the `WakuMetadataRequest` protobuf for shards was introduced. The old shards field (2) will be deprecated in 2 releases time
+> - CLI flags `--requestRateLimit` and `--requestRatePeriod` have been added for rate limiting configuration. Period is measured in seconds. Limits are measured per protocol per period of time. Over limit will result in TOO_MANY_REQUEST (429) response.
+
+## What's Changed
+
+Release highlights:
+
+* Introduced configurable rate limiting for lightpush and store requests
+* Sync time has been considerably reduced for node initialization
+* Significant refactors were made to node initialization and `WakuArchive` logic as work towards C-bindings and Store V3 features
+
+### Features
+
+- Added simple, configurable rate limit for lightpush and store-query ([#2390](https://github.com/waku-org/nwaku/issues/2390)) ([a00f350c](https://github.com/waku-org/nwaku/commit/a00f350c))
+- examples/golang/waku.go add new example ([#2559](https://github.com/waku-org/nwaku/issues/2559)) ([8d66a548](https://github.com/waku-org/nwaku/commit/8d66a548))
+- **c-bindings:** rln relay ([#2544](https://github.com/waku-org/nwaku/issues/2544)) ([2aa835e3](https://github.com/waku-org/nwaku/commit/2aa835e3))
+- **incentivization:** add codec for eligibility proof and status ([#2419](https://github.com/waku-org/nwaku/issues/2419)) ([65530264](https://github.com/waku-org/nwaku/commit/65530264))
+- **rest:** add support to ephemeral field ([#2525](https://github.com/waku-org/nwaku/issues/2525)) ([c734f60d](https://github.com/waku-org/nwaku/commit/c734f60d))
+- archive update for store v3 ([#2451](https://github.com/waku-org/nwaku/issues/2451)) ([505479b8](https://github.com/waku-org/nwaku/commit/505479b8))
+- **c-bindings:** add function to dealloc nodes ([#2499](https://github.com/waku-org/nwaku/issues/2499)) ([8341864d](https://github.com/waku-org/nwaku/commit/8341864d))
+
+### Bug Fixes
+
+- **rln-relay:** reduce sync time ([#2577](https://github.com/waku-org/nwaku/issues/2577)) ([480a62fa](https://github.com/waku-org/nwaku/commit/480a62fa))
+- rest store: content_topic -> contentTopic in the response ([#2584](https://github.com/waku-org/nwaku/issues/2584)) ([d2578553](https://github.com/waku-org/nwaku/commit/d2578553))
+- **c-bindings:** rln credential path key ([#2564](https://github.com/waku-org/nwaku/issues/2564)) ([3d752b11](https://github.com/waku-org/nwaku/commit/3d752b11))
+- cluster-id 0 disc5 issue ([#2562](https://github.com/waku-org/nwaku/issues/2562)) ([a76c9587](https://github.com/waku-org/nwaku/commit/a76c9587))
+- regex for rpc endpoint ([#2563](https://github.com/waku-org/nwaku/issues/2563)) ([c87545d5](https://github.com/waku-org/nwaku/commit/c87545d5))
+- **rln:** set a minimum epoch gap ([#2555](https://github.com/waku-org/nwaku/issues/2555)) ([b5e4795f](https://github.com/waku-org/nwaku/commit/b5e4795f))
+- fix regresion + remove deprecated flag ([#2556](https://github.com/waku-org/nwaku/issues/2556)) ([47ad0fb0](https://github.com/waku-org/nwaku/commit/47ad0fb0))
+- **networkmanager:** regularly disconnect from random peers ([#2553](https://github.com/waku-org/nwaku/issues/2553)) ([70c53fc0](https://github.com/waku-org/nwaku/commit/70c53fc0))
+- remove subscription queue limit ([#2551](https://github.com/waku-org/nwaku/issues/2551)) ([94ff5eab](https://github.com/waku-org/nwaku/commit/94ff5eab))
+- peer_manager - extend the number of connection requests to known peers ([#2534](https://github.com/waku-org/nwaku/issues/2534)) ([2173fe22](https://github.com/waku-org/nwaku/commit/2173fe22))
+- **2491:** Fix metadata protocol disconnecting light nodes ([#2533](https://github.com/waku-org/nwaku/issues/2533)) ([33774fad](https://github.com/waku-org/nwaku/commit/33774fad))
+- **rest:** filter/v2/subscriptions response ([#2529](https://github.com/waku-org/nwaku/issues/2529)) ([7aea2d4f](https://github.com/waku-org/nwaku/commit/7aea2d4f))
+- **store:** retention policy regex ([#2532](https://github.com/waku-org/nwaku/issues/2532)) ([23a291b3](https://github.com/waku-org/nwaku/commit/23a291b3))
+- enable autosharding in any cluster ([#2505](https://github.com/waku-org/nwaku/issues/2505)) ([5a225809](https://github.com/waku-org/nwaku/commit/5a225809))
+- introduce new field for shards in metadata protocol ([#2511](https://github.com/waku-org/nwaku/issues/2511)) ([f9f92b7d](https://github.com/waku-org/nwaku/commit/f9f92b7d))
+- **rln-relay:** handle empty metadata returned by getMetadata proc ([#2516](https://github.com/waku-org/nwaku/issues/2516)) ([1274b15d](https://github.com/waku-org/nwaku/commit/1274b15d))
+
+### Changes
+
+- adding migration script adding i_query index ([#2578](https://github.com/waku-org/nwaku/issues/2578)) ([4117fe65](https://github.com/waku-org/nwaku/commit/4117fe65))
+- bumping chronicles version ([#2583](https://github.com/waku-org/nwaku/issues/2583)) ([a04e0d99](https://github.com/waku-org/nwaku/commit/a04e0d99))
+- add ARM64 support for Linux/MacOS ([#2580](https://github.com/waku-org/nwaku/issues/2580)) ([269139cf](https://github.com/waku-org/nwaku/commit/269139cf))
+- **rln:** update submodule + rln patch version ([#2574](https://github.com/waku-org/nwaku/issues/2574)) ([24f6fed8](https://github.com/waku-org/nwaku/commit/24f6fed8))
+- bumping dependencies for 0.27.0 ([#2572](https://github.com/waku-org/nwaku/issues/2572)) ([f68ac792](https://github.com/waku-org/nwaku/commit/f68ac792))
+- **c-bindings:** node initialization ([#2547](https://github.com/waku-org/nwaku/issues/2547)) ([6d0f6d82](https://github.com/waku-org/nwaku/commit/6d0f6d82))
+- remove deprecated legacy filter protocol ([#2507](https://github.com/waku-org/nwaku/issues/2507)) ([e8613172](https://github.com/waku-org/nwaku/commit/e8613172))
+- switch wakuv2 to waku fleet ([#2519](https://github.com/waku-org/nwaku/issues/2519)) ([18a05359](https://github.com/waku-org/nwaku/commit/18a05359))
+- create nph.md ([#2536](https://github.com/waku-org/nwaku/issues/2536)) ([a576e624](https://github.com/waku-org/nwaku/commit/a576e624))
+- Better postgres duplicate insert ([#2535](https://github.com/waku-org/nwaku/issues/2535)) ([693a1778](https://github.com/waku-org/nwaku/commit/693a1778))
+- add 150 kB to msg size histogram metric ([#2430](https://github.com/waku-org/nwaku/issues/2430)) ([2c1391d3](https://github.com/waku-org/nwaku/commit/2c1391d3))
+- content_script_version_2: add simple protection and rename messages_backup if exists ([#2531](https://github.com/waku-org/nwaku/issues/2531)) ([c6c376b5](https://github.com/waku-org/nwaku/commit/c6c376b5))
+- **vendor:** update nim-libp2p path ([#2527](https://github.com/waku-org/nwaku/issues/2527)) ([3c823756](https://github.com/waku-org/nwaku/commit/3c823756))
+- adding node factory tests ([#2524](https://github.com/waku-org/nwaku/issues/2524)) ([a1b3e090](https://github.com/waku-org/nwaku/commit/a1b3e090))
+- factory cleanup ([#2523](https://github.com/waku-org/nwaku/issues/2523)) ([8d7eb3a6](https://github.com/waku-org/nwaku/commit/8d7eb3a6))
+- **rln-relay-v2:** wakunode testing + improvements ([#2501](https://github.com/waku-org/nwaku/issues/2501)) ([059cb975](https://github.com/waku-org/nwaku/commit/059cb975))
+- update CHANGELOG for v0.26.0 release ([#2518](https://github.com/waku-org/nwaku/issues/2518)) ([097cb362](https://github.com/waku-org/nwaku/commit/097cb362))
+- migrating logic from wakunode2.nim to node_factory.nim ([#2504](https://github.com/waku-org/nwaku/issues/2504)) ([dcc88ee0](https://github.com/waku-org/nwaku/commit/dcc88ee0))
+
+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` |
+| [`66/WAKU2-METADATA`](https://github.com/waku-org/specs/blob/master/standards/core/metadata.md) | `raw` | `/vac/waku/metadata/1.0.0` |
+
+The Waku v1 implementation has been removed from this repository and can be found in a separate [Waku Legacy](https://github.com/waku-org/waku-legacy) repository.
+
+## v0.26.0 (2024-03-07)
+
+> **Note:**
+> - JSON-RPC API has been removed completely. Instead we recommend you to utilize REST API endpoints that have same and extended functionality.
+> Please have a look at Waku's REST-API reference: https://waku-org.github.io/waku-rest-api
+> - Support for Cross-Origin-Resource-Sharing (CORS headers) is added for our REST-API services. This allows you to access our REST-API from a browser.
+> New repeatable CLI flag is added by this feature:
+> `--rest-allow-origin="example.com"` or `--rest-allow-origin="127.0.0.0:*"`
+> Flag allows using wildcards (`*` and `?`) in the origin string.
+> - Store protocol now has a better support for controlling DB size of Postgres store. This feature needs no user action.
+
+> **Announcement:**
+>
+> Please notice that from the next release (0.27.0) we will deprecate features.
+>
+> - We will decomission the Filter v1 protocol and its REST-API access.
+
+### Features
+
+- Postgres partition implementation ([#2506](https://github.com/waku-org/nwaku/issues/2506)) ([161a10ec](https://github.com/waku-org/nwaku/commit/161a10ec))
+- **waku-stealth-commitments:** waku stealth commitment protocol ([#2490](https://github.com/waku-org/nwaku/issues/2490)) ([0def4904](https://github.com/waku-org/nwaku/commit/0def4904))
+- **bindings:** generate a random private key ([#2446](https://github.com/waku-org/nwaku/issues/2446)) ([56ff30ca](https://github.com/waku-org/nwaku/commit/56ff30ca))
+- prioritise yamux above mplex ([#2417](https://github.com/waku-org/nwaku/issues/2417)) ([ce151efc](https://github.com/waku-org/nwaku/commit/ce151efc))
+- supporting meta field in WakuMessage ([#2384](https://github.com/waku-org/nwaku/issues/2384)) ([3903f130](https://github.com/waku-org/nwaku/commit/3903f130))
+- `eventCallback` per wakunode and `userData` ([#2418](https://github.com/waku-org/nwaku/issues/2418)) ([707f3e8b](https://github.com/waku-org/nwaku/commit/707f3e8b))
+- **rln-relay-v2:** nonce/messageId manager ([#2413](https://github.com/waku-org/nwaku/issues/2413)) ([50308eda](https://github.com/waku-org/nwaku/commit/50308eda))
+- **networkmonitor:** add support for rln ([#2401](https://github.com/waku-org/nwaku/issues/2401)) ([9c0e9431](https://github.com/waku-org/nwaku/commit/9c0e9431))
+- **rln-relay-v2:** rln-keystore-generator updates ([#2392](https://github.com/waku-org/nwaku/issues/2392)) ([2d46c351](https://github.com/waku-org/nwaku/commit/2d46c351))
+- add yamux support ([#2397](https://github.com/waku-org/nwaku/issues/2397)) ([1b402667](https://github.com/waku-org/nwaku/commit/1b402667))
+
+### Bug Fixes
+
+- **rln-relay:** make nullifier log abide by epoch ordering ([#2508](https://github.com/waku-org/nwaku/issues/2508)) ([beba14dc](https://github.com/waku-org/nwaku/commit/beba14dc))
+- **postgres:** import under feature flag ([#2500](https://github.com/waku-org/nwaku/issues/2500)) ([e692edf6](https://github.com/waku-org/nwaku/commit/e692edf6))
+- notify Waku Metadata when Waku Filter subscribe to a topic ([#2493](https://github.com/waku-org/nwaku/issues/2493)) ([91e3f8cd](https://github.com/waku-org/nwaku/commit/91e3f8cd))
+- time on 32 bits architecture ([#2492](https://github.com/waku-org/nwaku/issues/2492)) ([0a751228](https://github.com/waku-org/nwaku/commit/0a751228))
+- return message id on `waku_relay_publish` ([#2485](https://github.com/waku-org/nwaku/issues/2485)) ([045091a9](https://github.com/waku-org/nwaku/commit/045091a9))
+- **bindings:** base64 payload and key for content topic ([#2435](https://github.com/waku-org/nwaku/issues/2435)) ([d01585e9](https://github.com/waku-org/nwaku/commit/d01585e9))
+- **rln-relay:** regex pattern match for extended domains ([#2444](https://github.com/waku-org/nwaku/issues/2444)) ([29b0c0b8](https://github.com/waku-org/nwaku/commit/29b0c0b8))
+- checking for keystore file existence ([#2427](https://github.com/waku-org/nwaku/issues/2427)) ([8f487a21](https://github.com/waku-org/nwaku/commit/8f487a21))
+- **rln-relay:** graceful shutdown with non-zero exit code ([#2429](https://github.com/waku-org/nwaku/issues/2429)) ([22026b7e](https://github.com/waku-org/nwaku/commit/22026b7e))
+- check max message size in validator according to configured value ([#2424](https://github.com/waku-org/nwaku/issues/2424)) ([731dfcbd](https://github.com/waku-org/nwaku/commit/731dfcbd))
+- **wakunode2:** move node config inside app init branch ([#2423](https://github.com/waku-org/nwaku/issues/2423)) ([0dac9f9d](https://github.com/waku-org/nwaku/commit/0dac9f9d))
+
+### Changes
+
+- **rln_db_inspector:** include in wakunode2 binary ([#2292](https://github.com/waku-org/nwaku/issues/2292)) ([a9d0e481](https://github.com/waku-org/nwaku/commit/a9d0e481))
+- Update link to DNS discovery tutorial ([#2496](https://github.com/waku-org/nwaku/issues/2496)) ([9ef2eccb](https://github.com/waku-org/nwaku/commit/9ef2eccb))
+- **rln-relay-v2:** added tests for static rln-relay-v2 ([#2484](https://github.com/waku-org/nwaku/issues/2484)) ([5b174fb3](https://github.com/waku-org/nwaku/commit/5b174fb3))
+- moving node initialization code to node_factory.nim ([#2479](https://github.com/waku-org/nwaku/issues/2479)) ([361fe2cd](https://github.com/waku-org/nwaku/commit/361fe2cd))
+- Postgres migrations ([#2477](https://github.com/waku-org/nwaku/issues/2477)) ([560f949a](https://github.com/waku-org/nwaku/commit/560f949a))
+- **rln-relay-v2:** added tests for onchain rln-relay-v2 ([#2482](https://github.com/waku-org/nwaku/issues/2482)) ([88ff9282](https://github.com/waku-org/nwaku/commit/88ff9282))
+- remove json rpc ([#2416](https://github.com/waku-org/nwaku/issues/2416)) ([c994ee04](https://github.com/waku-org/nwaku/commit/c994ee04))
+- **ci:** use git describe for image version ([55ff6674](https://github.com/waku-org/nwaku/commit/55ff6674))
+- Implemented CORS handling for nwaku REST server ([#2470](https://github.com/waku-org/nwaku/issues/2470)) ([d832f92a](https://github.com/waku-org/nwaku/commit/d832f92a))
+- remove rln epoch hardcoding ([#2483](https://github.com/waku-org/nwaku/issues/2483)) ([3f4f6d7e](https://github.com/waku-org/nwaku/commit/3f4f6d7e))
+- **cbindings:** cbindings rust simple libwaku integration example ([#2089](https://github.com/waku-org/nwaku/issues/2089)) ([a4993005](https://github.com/waku-org/nwaku/commit/a4993005))
+- adding NIMFLAGS usage to readme ([#2469](https://github.com/waku-org/nwaku/issues/2469)) ([a1d5cbd9](https://github.com/waku-org/nwaku/commit/a1d5cbd9))
+- bumping nim-libp2p after yamux timeout fix ([#2468](https://github.com/waku-org/nwaku/issues/2468)) ([216531b0](https://github.com/waku-org/nwaku/commit/216531b0))
+- new proc to foster different size retention policy implementations ([#2463](https://github.com/waku-org/nwaku/issues/2463)) ([d5305282](https://github.com/waku-org/nwaku/commit/d5305282))
+- **rln-relay:** use anvil instead of ganache in onchain tests ([#2449](https://github.com/waku-org/nwaku/issues/2449)) ([f6332ac6](https://github.com/waku-org/nwaku/commit/f6332ac6))
+- bindings return multiaddress array ([#2461](https://github.com/waku-org/nwaku/issues/2461)) ([7aea145e](https://github.com/waku-org/nwaku/commit/7aea145e))
+- **ci:** fix IMAGE_NAME to use harbor.status.im ([b700d046](https://github.com/waku-org/nwaku/commit/b700d046))
+- **rln-relay:** remove wss support from node config ([#2442](https://github.com/waku-org/nwaku/issues/2442)) ([2060cfab](https://github.com/waku-org/nwaku/commit/2060cfab))
+- **ci:** reuse discord send function from library ([1151d50f](https://github.com/waku-org/nwaku/commit/1151d50f))
+- **rln-relay-v2:** add tests for serde ([#2421](https://github.com/waku-org/nwaku/issues/2421)) ([d0377056](https://github.com/waku-org/nwaku/commit/d0377056))
+- add stdef.h to libwaku.h ([#2409](https://github.com/waku-org/nwaku/issues/2409)) ([d58aca01](https://github.com/waku-org/nwaku/commit/d58aca01))
+- automatically generating certs if not provided (Waku Canary) ([#2408](https://github.com/waku-org/nwaku/issues/2408)) ([849d76d6](https://github.com/waku-org/nwaku/commit/849d76d6))
+- Simplify configuration for the waku network ([#2404](https://github.com/waku-org/nwaku/issues/2404)) ([985d092f](https://github.com/waku-org/nwaku/commit/985d092f))
+
+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` |
+| [`66/WAKU2-METADATA`](https://github.com/waku-org/specs/blob/master/standards/core/metadata.md) | `raw` | `/vac/waku/metadata/1.0.0` |
+
+The Waku v1 implementation has been removed from this repository and can be found in a separate [Waku Legacy](https://github.com/waku-org/waku-legacy) repository.
+
+## v0.25.0 (2024-02-06)
+
+> **Note:**
+> Waku Filter v2 now has three additional configuration options
+> `--filter-max-peers-to-serve=1000` drives how many peers can subscribe at once and
+> `--filter-max-criteria=1000` defines what is the maximum criterion stored per each peers
+>
+> This release introduces a major change in Filter v2 protocol subscription management.
+> From now each subscribed peer needs to refresh its living subscriptions by sending a SUBSCRIBER_PING message every 5 minutes by default, otherwise the peer's subscription will be removed.
+> `--filter-subscription-timeout=300` defines configurable timeout for the subscriptions (*in seconds*).
+>
+> New experimental feature, shard aware peer manager for relay protocol can be activated by the flag:
+> `--relay-shard-manager=true|false`
+> It is disabled by default.
+
+> **Announcement:**
+>
+> Please notice that from the next release (0.26.0) we will deprecate features.
+>
+> - JSON-RPC API will be removed completely. Instead we recommend you to utilize REST API endpoints that have same and extended functionality.
+> - We will retire websockets support for RLN on-chain group management. You are expected to use HTTP version of ETH_CLIENT_ADDRESS
+
+### Features
+
+- running validators in /relay/v1/auto/messages/{topic} ([#2394](https://github.com/waku-org/nwaku/issues/2394)) ([e4e147bc](https://github.com/waku-org/nwaku/commit/e4e147bc))
+- **rln-relay-v2:** update C FFI api's and serde ([#2385](https://github.com/waku-org/nwaku/issues/2385)) ([b88facd0](https://github.com/waku-org/nwaku/commit/b88facd0))
+- running validators in /relay/v1/messages/{pubsubTopic} ([#2373](https://github.com/waku-org/nwaku/issues/2373)) ([59d8b620](https://github.com/waku-org/nwaku/commit/59d8b620))
+- shard aware relay peer management ([#2332](https://github.com/waku-org/nwaku/issues/2332)) ([edca1df1](https://github.com/waku-org/nwaku/commit/edca1df1))
+
+### Bug Fixes
+
+- adding rln validator as default ([#2367](https://github.com/waku-org/nwaku/issues/2367)) ([bb58a63a](https://github.com/waku-org/nwaku/commit/bb58a63a))
+- Fix test for filter client receiving messages after restart ([#2360](https://github.com/waku-org/nwaku/issues/2360)) ([7de91d92](https://github.com/waku-org/nwaku/commit/7de91d92))
+- making filter admin data test order independent ([#2355](https://github.com/waku-org/nwaku/issues/2355)) ([8a9fad29](https://github.com/waku-org/nwaku/commit/8a9fad29))
+
+### Changes
+
+- **rln-relay-v2:** use rln-v2 contract code ([#2381](https://github.com/waku-org/nwaku/issues/2381)) ([c55ca067](https://github.com/waku-org/nwaku/commit/c55ca067))
+- v0.25 vendor bump and associated fixes ([#2352](https://github.com/waku-org/nwaku/issues/2352)) ([761ce7b1](https://github.com/waku-org/nwaku/commit/761ce7b1))
+- handle errors w.r.t. configured cluster-id and pubsub topics ([#2368](https://github.com/waku-org/nwaku/issues/2368)) ([e04e35e2](https://github.com/waku-org/nwaku/commit/e04e35e2))
+- add coverage target to Makefile ([#2382](https://github.com/waku-org/nwaku/issues/2382)) ([57378873](https://github.com/waku-org/nwaku/commit/57378873))
+- Add check spell allowed words ([#2383](https://github.com/waku-org/nwaku/issues/2383)) ([c1121dd1](https://github.com/waku-org/nwaku/commit/c1121dd1))
+- adding nwaku compose image update to release process ([#2370](https://github.com/waku-org/nwaku/issues/2370)) ([4f06dcff](https://github.com/waku-org/nwaku/commit/4f06dcff))
+- changing digest and hash log format from bytes to hex ([#2363](https://github.com/waku-org/nwaku/issues/2363)) ([025c6ec9](https://github.com/waku-org/nwaku/commit/025c6ec9))
+- log messageHash for lightpush request that helps in debugging ([#2366](https://github.com/waku-org/nwaku/issues/2366)) ([42204115](https://github.com/waku-org/nwaku/commit/42204115))
+- **rln-relay:** enabled http based polling in OnchainGroupManager ([#2364](https://github.com/waku-org/nwaku/issues/2364)) ([efdc5244](https://github.com/waku-org/nwaku/commit/efdc5244))
+- improve POST /relay/v1/auto/messages/{topic} error handling ([#2339](https://github.com/waku-org/nwaku/issues/2339)) ([f841454e](https://github.com/waku-org/nwaku/commit/f841454e))
+- Refactor of FilterV2 subscription management with Time-to-live maintenance ([#2341](https://github.com/waku-org/nwaku/issues/2341)) ([c3358409](https://github.com/waku-org/nwaku/commit/c3358409))
+- Bump `nim-dnsdisc` ([#2354](https://github.com/waku-org/nwaku/issues/2354)) ([3d816c08](https://github.com/waku-org/nwaku/commit/3d816c08))
+- postgres-adoption.md add metadata title, description, and better first-readable-title ([#2346](https://github.com/waku-org/nwaku/issues/2346)) ([2f8e8bcb](https://github.com/waku-org/nwaku/commit/2f8e8bcb))
+- fix typo ([#2348](https://github.com/waku-org/nwaku/issues/2348)) ([a4a8dee3](https://github.com/waku-org/nwaku/commit/a4a8dee3))
+
+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` |
+| [`66/WAKU2-METADATA`](https://github.com/waku-org/specs/blob/master/standards/core/metadata.md) | `raw` | `/vac/waku/metadata/1.0.0` |
+
+The Waku v1 implementation has been removed from this repository and can be found in a separate [Waku Legacy](https://github.com/waku-org/waku-legacy) repository.
+
+## v0.24.0 (2024-01-10)
+
+> Note: The Waku message size limit (150 KiB) is now enforced according to the specifications. To change this limit please use `--max-msg-size="1MiB"`
+
+> Note: `--ip-colocation-limit=2` is the new parameter for limiting connections from the same IP
+
+## What's Changed
+
+Release highlights:
+* IP colocation filter can now be changed via a configuration parameter.
+* New filter admin endpoint can now be used to access subscription data.
+* Waku message size limit can now be changed via a configuration parameter.
+
+### Features
+
+- feat: adding filter data admin endpoint (REST) [#2314](https://github.com/waku-org/nwaku/pull/2314)
+- ip colocation is parameterizable. if set to 0, it is disabled [#2323](https://github.com/waku-org/nwaku/pull/2323)
+
+### Bug Fixes
+- fix: revert "feat: shard aware peer management [#2151](https://github.com/waku-org/nwaku/pull/2151)" [#2312](https://github.com/waku-org/nwaku/pull/2312)
+- fix: setting connectivity loop interval to 15 seconds [#2307](https://github.com/waku-org/nwaku/pull/2307)
+- fix: set record to the Waku node builder in the examples as it is required [#2328](https://github.com/waku-org/nwaku/pull/2328)
+- fix(discv5): add bootnode filter exception [#2267](https://github.com/waku-org/nwaku/pull/2267)
+
+
+### Changes
+- update CHANGELOG.md for 0.23.0 [#2309](https://github.com/waku-org/nwaku/pull/2309)
+- test(store): Implement store tests [#2235](https://github.com/waku-org/nwaku/pull/2235), [#2240](https://github.com/waku-org/nwaku/commit/86353e22a871820c132deee077f65e7af4356671)
+- refactor(store): HistoryQuery.direction [#2263](https://github.com/waku-org/nwaku/pull/2263)
+- test_driver_postgres: enhance test coverage, multiple and single topic [#2301](https://github.com/waku-org/nwaku/pull/2301)
+- chore: examples/nodejs - adapt code to latest callback and ctx/userData definitions [#2281](https://github.com/waku-org/nwaku/pull/2281)
+- chore: update `CHANGELOG.md` to reflect bug fix for issue [#2317](https://github.com/waku-org/nwaku/issues/2317) [#2340](https://github.com/waku-org/nwaku/pull/2340) in v0.23.1
+- test(peer-connection-managenent): functional tests [#2321](https://github.com/waku-org/nwaku/pull/2321)
+- docs: update post-release steps [#2336](https://github.com/waku-org/nwaku/pull/2336)
+- docs: fix typos across various documentation files [#2310](https://github.com/waku-org/nwaku/pull/2310)
+- test(peer-connection-managenent): functional tests [#2321](https://github.com/waku-org/nwaku/pull/2321)
+- bump vendors for 0.24.0 [#2333](https://github.com/waku-org/nwaku/pull/2333)
+- test(autosharding): functional tests [#2318](https://github.com/waku-org/nwaku/pull/2318)
+- docs: add benchmark around postgres adoption [#2316](https://github.com/waku-org/nwaku/pull/2316)
+- chore: set max Waku message size to 150KiB according to spec [#2298](https://github.com/waku-org/nwaku/pull/2298)
+
+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` |
+| [`66/WAKU2-METADATA`](https://github.com/waku-org/specs/blob/master/standards/core/metadata.md) | `raw` | `/vac/waku/metadata/1.0.0` |
+
+The Waku v1 implementation has been removed from this repository and can be found in a separate [Waku Legacy](https://github.com/waku-org/waku-legacy) repository.
+
+## v0.23.1 (2023-01-09)
+
+This patch release fixes the following bug:
+- Sort order ignored in store nodes.
+
+### Bug Fix
+
+- Bug definition: [#2317](https://github.com/waku-org/nwaku/issues/2317)
+- Commit that fixes the bug [fae20bff](https://github.com/waku-org/nwaku/commit/fae20bff)
+
+This is a patch release that is fully backwards-compatible with release `v0.23.0`.
+
+It supports the same [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` |
+| [`66/WAKU2-METADATA`](https://github.com/waku-org/specs/blob/master/standards/core/metadata.md) | `raw` | `/vac/waku/metadata/1.0.0` |
+
+The Waku v1 implementation has been removed from this repository and can be found in a separate [Waku Legacy](https://github.com/waku-org/waku-legacy) repository.
+
+
+## v0.23.0 (2023-12-18)
+
+## What's Changed
+
+Release highlights:
+* Bug fix in Postgres when querying more than one content topic.
+* :warning: Add new DB column `messageHash`. This requires a manual database update in _Postgres_.
+* Updated deterministic message hash algorithm.
+* REST admin can inform whether a node supports lightpush and/or filter protocols.
+* Improvements to cluster id and shards setup.
+* Properly apply RLN when publishing from REST or jsonrpc API.
+* Remove trailing commas from the RLN keystore json generated during credentials registration.
+* General test cleanup, better relay tests and new filter unsubscribe tests.
+* Rewrite docs for clarity and update screenshots.
+
+### Features
+
+- setting image deployment to harbor registry ([93dd5ae5](https://github.com/waku-org/nwaku/commit/93dd5ae5))
+- Add new DB column `messageHash` ([#2202](https://github.com/waku-org/nwaku/issues/2202)) ([aeb77a3e](https://github.com/waku-org/nwaku/commit/aeb77a3e))
+
+### Bug Fixes
+
+- make rln rate limit spec compliant ([#2294](https://github.com/waku-org/nwaku/issues/2294)) ([5847f49d](https://github.com/waku-org/nwaku/commit/5847f49d))
+- update num-msgs archive metrics every minute and not only at the beginning ([#2287](https://github.com/waku-org/nwaku/issues/2287)) ([0fc617ff](https://github.com/waku-org/nwaku/commit/0fc617ff))
+- **rln-relay:** graceful retries on rpc calls ([#2250](https://github.com/waku-org/nwaku/issues/2250)) ([15c1f974](https://github.com/waku-org/nwaku/commit/15c1f974))
+- add protection in rest service to always publish with timestamp if user doesn't provide it ([#2261](https://github.com/waku-org/nwaku/issues/2261)) ([42f19579](https://github.com/waku-org/nwaku/commit/42f19579))
+- remove trailing commas from keystore json ([#2200](https://github.com/waku-org/nwaku/issues/2200)) ([103d3981](https://github.com/waku-org/nwaku/commit/103d3981))
+- **dockerfile:** update dockerignore and base image ([#2262](https://github.com/waku-org/nwaku/issues/2262)) ([c86dc442](https://github.com/waku-org/nwaku/commit/c86dc442))
+- waku_filter_v2/common: PEER_DIAL_FAILURE ret code change: 200 -> 504 ([#2236](https://github.com/waku-org/nwaku/issues/2236)) ([6301bec0](https://github.com/waku-org/nwaku/commit/6301bec0))
+- extended Postgres code to support retention policy + refactoring ([#2244](https://github.com/waku-org/nwaku/issues/2244)) ([a1ed517f](https://github.com/waku-org/nwaku/commit/a1ed517f))
+- admin REST API to be enabled only if config is set ([#2218](https://github.com/waku-org/nwaku/issues/2218)) ([110de90f](https://github.com/waku-org/nwaku/commit/110de90f))
+- **rln:** error in api when rate limit ([#2212](https://github.com/waku-org/nwaku/issues/2212)) ([51f36099](https://github.com/waku-org/nwaku/commit/51f36099))
+- **relay:** Failing protocol tests ([#2224](https://github.com/waku-org/nwaku/issues/2224)) ([c9e869fb](https://github.com/waku-org/nwaku/commit/c9e869fb))
+- **tests:** Compilation failure fix ([#2222](https://github.com/waku-org/nwaku/issues/2222)) ([a5da1fc4](https://github.com/waku-org/nwaku/commit/a5da1fc4))
+- **rest:** properly check if rln is used ([#2205](https://github.com/waku-org/nwaku/issues/2205)) ([2cb0989a](https://github.com/waku-org/nwaku/commit/2cb0989a))
+
+### Changes
+
+- archive - move error to trace level when insert row fails ([#2283](https://github.com/waku-org/nwaku/issues/2283)) ([574cdf55](https://github.com/waku-org/nwaku/commit/574cdf55))
+- including content topics on FilterSubscribeRequest logs ([#2295](https://github.com/waku-org/nwaku/issues/2295)) ([306c8a62](https://github.com/waku-org/nwaku/commit/306c8a62))
+- vendor bump for 0.23.0 ([#2274](https://github.com/waku-org/nwaku/issues/2274)) ([385daf16](https://github.com/waku-org/nwaku/commit/385daf16))
+- peer_manager.nim - reduce logs from debug to trace ([#2279](https://github.com/waku-org/nwaku/issues/2279)) ([0cc0c805](https://github.com/waku-org/nwaku/commit/0cc0c805))
+- Cbindings allow mounting the Store protocol from libwaku ([#2276](https://github.com/waku-org/nwaku/issues/2276)) ([28142f40](https://github.com/waku-org/nwaku/commit/28142f40))
+- Better feedback invalid content topic ([#2254](https://github.com/waku-org/nwaku/issues/2254)) ([72a1f8c7](https://github.com/waku-org/nwaku/commit/72a1f8c7))
+- fix typos ([#2239](https://github.com/waku-org/nwaku/issues/2239)) ([958b9bd7](https://github.com/waku-org/nwaku/commit/958b9bd7))
+- creating prepare_release template ([#2225](https://github.com/waku-org/nwaku/issues/2225)) ([5883dbeb](https://github.com/waku-org/nwaku/commit/5883dbeb))
+- **rest:** refactor message cache ([#2221](https://github.com/waku-org/nwaku/issues/2221)) ([bebaa59c](https://github.com/waku-org/nwaku/commit/bebaa59c))
+- updating nim-json-serialization dependency ([#2248](https://github.com/waku-org/nwaku/issues/2248)) ([9f4e6f45](https://github.com/waku-org/nwaku/commit/9f4e6f45))
+- **store-archive:** Remove duplicated code ([#2234](https://github.com/waku-org/nwaku/issues/2234)) ([38e100e9](https://github.com/waku-org/nwaku/commit/38e100e9))
+- refactoring peer storage ([#2243](https://github.com/waku-org/nwaku/issues/2243)) ([c301e880](https://github.com/waku-org/nwaku/commit/c301e880))
+- postres driver allow setting the max number of connection from a parameter ([#2246](https://github.com/waku-org/nwaku/issues/2246)) ([b31c1823](https://github.com/waku-org/nwaku/commit/b31c1823))
+- deterministic message hash algorithm updated ([#2233](https://github.com/waku-org/nwaku/issues/2233)) ([a22ee604](https://github.com/waku-org/nwaku/commit/a22ee604))
+- **REST:** returning lightpush support and updated filter protocol ([#2219](https://github.com/waku-org/nwaku/issues/2219)) ([59ee3c69](https://github.com/waku-org/nwaku/commit/59ee3c69))
+- mics. improvements to cluster id and shards setup ([#2187](https://github.com/waku-org/nwaku/issues/2187)) ([897f4879](https://github.com/waku-org/nwaku/commit/897f4879))
+- update docs for rln-keystore-generator ([#2210](https://github.com/waku-org/nwaku/issues/2210)) ([8c5666d2](https://github.com/waku-org/nwaku/commit/8c5666d2))
+- removing automatic vacuuming from retention policy code ([#2228](https://github.com/waku-org/nwaku/issues/2228)) ([9ff441ab](https://github.com/waku-org/nwaku/commit/9ff441ab))
+- decoupling announced and listen addresses ([#2203](https://github.com/waku-org/nwaku/issues/2203)) ([ef8ffbdb](https://github.com/waku-org/nwaku/commit/ef8ffbdb))
+- **release:** update changelog for v0.22.0 release ([#2216](https://github.com/waku-org/nwaku/issues/2216)) ([9c4fdac6](https://github.com/waku-org/nwaku/commit/9c4fdac6))
+- Allow text/plain content type descriptor for json formatted content body ([#2209](https://github.com/waku-org/nwaku/issues/2209)) ([6d81e384](https://github.com/waku-org/nwaku/commit/6d81e384))
+- rewrite for clarity, update screenshots ([#2206](https://github.com/waku-org/nwaku/issues/2206)) ([a0ef3c2f](https://github.com/waku-org/nwaku/commit/a0ef3c2f))
+- **release:** update changelog for v0.21.3 release ([#2208](https://github.com/waku-org/nwaku/issues/2208)) ([f74474b4](https://github.com/waku-org/nwaku/commit/f74474b4))
+
+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` |
+| [`66/WAKU2-METADATA`](https://github.com/waku-org/specs/blob/master/standards/core/metadata.md) | `raw` | `/vac/waku/metadata/1.0.0` |
+
+The Waku v1 implementation has been removed from this repository and can be found in a separate [Waku Legacy](https://github.com/waku-org/waku-legacy) repository.
+
+## v0.22.0 (2023-11-15)
+
+> Note: The `--topic` option is now deprecated in favor of a more specific options `--pubsub-topic` & `--content-topic`
+
+> Note: The `--ext-multiaddr-only` CLI flag was introduced for cases in which the user wants to manually set their announced addresses
+
+## What's Changed
+
+Release highlights:
+* simplified the process of generating RLN credentials through the new `generateRlnKeystore` subcommand
+* added support for configuration of port 0 in order to bind to kernel selected ports
+* shards are now automatically updated in metadata protocol when supported shards change on runtime
+* introduced `messageHash` attribute to SQLite which will later replace the `id` attribute
+
+### Features
+
+- rln-keystore-generator is now a subcommand ([#2189](https://github.com/waku-org/nwaku/issues/2189)) ([3498a846](https://github.com/waku-org/nwaku/commit/3498a846))
+- amending computeDigest func. + related test cases ([#2132](https://github.com/waku-org/nwaku/issues/2132))" ([#2180](https://github.com/waku-org/nwaku/issues/2180)) ([d7ef3ca1](https://github.com/waku-org/nwaku/commit/d7ef3ca1))
+- **discv5:** filter out peers without any listed capability ([#2186](https://github.com/waku-org/nwaku/issues/2186)) ([200a11da](https://github.com/waku-org/nwaku/commit/200a11da))
+- metadata protocol shard subscription ([#2149](https://github.com/waku-org/nwaku/issues/2149)) ([bcf8e963](https://github.com/waku-org/nwaku/commit/bcf8e963))
+- REST APIs discovery handlers ([#2109](https://github.com/waku-org/nwaku/issues/2109)) ([7ca516a5](https://github.com/waku-org/nwaku/commit/7ca516a5))
+- implementing port 0 support ([#2125](https://github.com/waku-org/nwaku/issues/2125)) ([f7b9afc2](https://github.com/waku-org/nwaku/commit/f7b9afc2))
+- messageHash attribute added in SQLite + testcase ([#2142](https://github.com/waku-org/nwaku/issues/2142))" ([#2154](https://github.com/waku-org/nwaku/issues/2154)) ([13aeebe4](https://github.com/waku-org/nwaku/commit/13aeebe4))
+- messageHash attribute added in SQLite + testcase ([#2142](https://github.com/waku-org/nwaku/issues/2142)) ([9cd8c73d](https://github.com/waku-org/nwaku/commit/9cd8c73d))
+- amending computeDigest func. + related test cases ([#2132](https://github.com/waku-org/nwaku/issues/2132)) ([1669f710](https://github.com/waku-org/nwaku/commit/1669f710))
+
+### Bug Fixes
+
+- typo ([6dd28063](https://github.com/waku-org/nwaku/commit/6dd28063))
+- lightpush rest ([#2176](https://github.com/waku-org/nwaku/issues/2176)) ([fa467e24](https://github.com/waku-org/nwaku/commit/fa467e24))
+- **ci:** fix Docker tag for latest and release jobs ([52759faa](https://github.com/waku-org/nwaku/commit/52759faa))
+- **rest:** fix bug in rest api when sending rln message ([#2169](https://github.com/waku-org/nwaku/issues/2169)) ([250e8b98](https://github.com/waku-org/nwaku/commit/250e8b98))
+- updating v0.21.1 release date in changelog ([#2160](https://github.com/waku-org/nwaku/issues/2160)) ([3be61636](https://github.com/waku-org/nwaku/commit/3be61636))
+
+### Changes
+
+- Optimize postgres - prepared statements in select ([#2182](https://github.com/waku-org/nwaku/issues/2182)) ([6da1aeec](https://github.com/waku-org/nwaku/commit/6da1aeec))
+- **release:** update changelog for v0.21.2 release ([#2188](https://github.com/waku-org/nwaku/issues/2188)) ([d0a93e7c](https://github.com/waku-org/nwaku/commit/d0a93e7c))
+- upgrade dependencies v0.22 ([#2185](https://github.com/waku-org/nwaku/issues/2185)) ([b9563ae0](https://github.com/waku-org/nwaku/commit/b9563ae0))
+- Optimize postgres - use of rowCallback approach ([#2171](https://github.com/waku-org/nwaku/issues/2171)) ([2b4ca4d0](https://github.com/waku-org/nwaku/commit/2b4ca4d0))
+- **networking:** lower dhigh to limit amplification factor ([#2168](https://github.com/waku-org/nwaku/issues/2168)) ([f0f69b32](https://github.com/waku-org/nwaku/commit/f0f69b32))
+- Minor Postgres optimizations ([#2166](https://github.com/waku-org/nwaku/issues/2166)) ([282c2e81](https://github.com/waku-org/nwaku/commit/282c2e81))
+- adding patch release instructions to release doc ([#2157](https://github.com/waku-org/nwaku/issues/2157)) ([cc01bb07](https://github.com/waku-org/nwaku/commit/cc01bb07))
+- **release:** update changelog for v0.21.1 release ([#2155](https://github.com/waku-org/nwaku/issues/2155)) ([b109a583](https://github.com/waku-org/nwaku/commit/b109a583))
+- adding ext-multiaddr-only CLI flag ([#2141](https://github.com/waku-org/nwaku/issues/2141)) ([944dfdaa](https://github.com/waku-org/nwaku/commit/944dfdaa))
+- bumping nim-libp2p to include WSS fix ([#2150](https://github.com/waku-org/nwaku/issues/2150)) ([817a7b2e](https://github.com/waku-org/nwaku/commit/817a7b2e))
+- **cbindings:** avoid using global var in libwaku.nim ([#2118](https://github.com/waku-org/nwaku/issues/2118)) ([1e8f5771](https://github.com/waku-org/nwaku/commit/1e8f5771))
+- adding postgres flag to manual docker job instructions ([#2139](https://github.com/waku-org/nwaku/issues/2139)) ([459331e3](https://github.com/waku-org/nwaku/commit/459331e3))
+
+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` |
+| [`66/WAKU2-METADATA`](https://github.com/waku-org/specs/blob/master/standards/core/metadata.md) | `raw` | `/vac/waku/metadata/1.0.0` |
+
+The Waku v1 implementation has been removed from this repository and can be found in a separate [Waku Legacy](https://github.com/waku-org/waku-legacy) repository.
+
+## Upgrade instructions
+
+* Note that the `--topic` CLI option is now deprecated in favor of a more specific options `--pubsub-topic` & `--content-topic`.
+
+## v0.21.3 (2023-11-09)
+
+This patch release adds the following feature:
+- Adding generateRlnKeystore subcommand for RLN membership generation
+
+### Features
+
+- rln-keystore-generator is now a subcommand ([#2189](https://github.com/waku-org/nwaku/issues/2189)) ([1e919177](https://github.com/waku-org/nwaku/commit/1e919177))
+
+This is a patch release that is fully backwards-compatible with release `v0.21.0`, `v0.21.1` and `v0.21.2`.
+
+It supports the same [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` |
+
+The Waku v1 implementation has been removed from this repository and can be found in a separate [Waku Legacy](https://github.com/waku-org/waku-legacy) repository.
+
+## v0.21.2 (2023-11-07)
+
+This patch release addresses the following issue:
+- Inability to send RLN messages through the REST API
+
+### Bug Fixes
+
+- **rest:** fix bug in rest api when sending rln message ([#2169](https://github.com/waku-org/nwaku/issues/2169)) ([33decd7a](https://github.com/waku-org/nwaku/commit/33decd7a))
+
+This is a patch release that is fully backwards-compatible with release `v0.21.0` and `v0.21.1`.
+
+It supports the same [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` |
+
+The Waku v1 implementation has been removed from this repository and can be found in a separate [Waku Legacy](https://github.com/waku-org/waku-legacy) repository.
+
+## v0.21.1 (2023-10-26)
+
+This patch release addresses the following issues:
+- WSS connections being suddenly terminated under rare conditions
+- Ability for the user to control announced multiaddresses
+
+### Changes
+
+- adding ext-multiaddr-only CLI flag ([#2141](https://github.com/waku-org/nwaku/issues/2141)) ([e2dfc2ed](https://github.com/waku-org/nwaku/commit/e2dfc2ed))
+- bumping nim-libp2p to include WSS fix ([#2150](https://github.com/waku-org/nwaku/issues/2150)) ([18b5149a](https://github.com/waku-org/nwaku/commit/18b5149a))
+
+This is a patch release that is fully backwards-compatible with release `v0.21.0`.
+
+It supports the same [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` |
+
+The Waku v1 implementation has been removed from this repository and can be found in a separate [Waku Legacy](https://github.com/waku-org/waku-legacy) repository.
+
+## v0.21.0 (2023-10-18)
+
+> Note: This is the last release supporting the `--topic` option. It is being deprecated in favor of a more specific options `--pubsub-topic` & `--content-topic`
+
+## What's Changed
+
+Release highlights:
+* Implemented a req/resp [protocol](https://github.com/waku-org/specs/blob/master/standards/core/metadata.md) that provides information about the node's medatadata
+* Added REST APIs for Filter v2 and Lightpush protocols' services
+* Ported /admin endpoint to REST
+* Added a size-based retention policy for the user to set a limit for SQLite storage used
+
+### Features
+
+- add new metadata protocol ([#2062](https://github.com/waku-org/nwaku/issues/2062)) ([d5c3ade5](https://github.com/waku-org/nwaku/commit/d5c3ade5))
+- /admin rest api endpoint ([#2094](https://github.com/waku-org/nwaku/issues/2094)) ([7b5c36b1](https://github.com/waku-org/nwaku/commit/7b5c36b1))
+- **coverage:** Add simple coverage ([#2067](https://github.com/waku-org/nwaku/issues/2067)) ([d864db3f](https://github.com/waku-org/nwaku/commit/d864db3f))
+- added RELAY openapi definitions ([#2081](https://github.com/waku-org/nwaku/issues/2081)) ([56dbe2a7](https://github.com/waku-org/nwaku/commit/56dbe2a7))
+- **wakucanary:** add latency measurement using ping protocol ([#2074](https://github.com/waku-org/nwaku/issues/2074)) ([6cb9a8da](https://github.com/waku-org/nwaku/commit/6cb9a8da))
+- Autosharding API for RELAY subscriptions ([#1983](https://github.com/waku-org/nwaku/issues/1983)) ([1763b1ef](https://github.com/waku-org/nwaku/commit/1763b1ef))
+- **networkmonitor:** add ping latencies, optimize reconnections ([#2068](https://github.com/waku-org/nwaku/issues/2068)) ([ed473545](https://github.com/waku-org/nwaku/commit/ed473545))
+- peer manager can filter peers by shard ([#2063](https://github.com/waku-org/nwaku/issues/2063)) ([0d9e9fbd](https://github.com/waku-org/nwaku/commit/0d9e9fbd))
+- lightpush rest api ([#2052](https://github.com/waku-org/nwaku/issues/2052)) ([02a814bd](https://github.com/waku-org/nwaku/commit/02a814bd))
+- HTTP REST API: Filter support v2 ([#1890](https://github.com/waku-org/nwaku/issues/1890)) ([dac072f8](https://github.com/waku-org/nwaku/commit/dac072f8))
+
+### Bug Fixes
+
+- fix wrong install of filter rest api ([#2133](https://github.com/waku-org/nwaku/issues/2133)) ([5277d122](https://github.com/waku-org/nwaku/commit/5277d122))
+- consider WS extMultiAddrs before publishing host address ([#2122](https://github.com/waku-org/nwaku/issues/2122)) ([a5b1cfd0](https://github.com/waku-org/nwaku/commit/a5b1cfd0))
+- return erring response if lightpush request is invalid ([#2083](https://github.com/waku-org/nwaku/issues/2083)) ([2c5eb427](https://github.com/waku-org/nwaku/commit/2c5eb427))
+- sqlite limited delete query bug ([#2111](https://github.com/waku-org/nwaku/issues/2111)) ([06bc433a](https://github.com/waku-org/nwaku/commit/06bc433a))
+- cluster id & sharding terminology ([#2104](https://github.com/waku-org/nwaku/issues/2104)) ([a47dc9e6](https://github.com/waku-org/nwaku/commit/a47dc9e6))
+- **ci:** update the dependency list in pre-release WF ([#2088](https://github.com/waku-org/nwaku/issues/2088)) ([e85f05b0](https://github.com/waku-org/nwaku/commit/e85f05b0))
+- **ci:** fix name of discord notify method ([aaf10e08](https://github.com/waku-org/nwaku/commit/aaf10e08))
+- update wakuv2 fleet DNS discovery enrtree ([89854a96](https://github.com/waku-org/nwaku/commit/89854a96))
+- libwaku.nim: unsubscribe -> unsubscribeAll to make it build properly ([#2082](https://github.com/waku-org/nwaku/issues/2082)) ([3264a4f5](https://github.com/waku-org/nwaku/commit/3264a4f5))
+- **archive:** dburl check ([#2071](https://github.com/waku-org/nwaku/issues/2071)) ([a27d005f](https://github.com/waku-org/nwaku/commit/a27d005f))
+- filter discv5 bootstrap nodes by shards ([#2073](https://github.com/waku-org/nwaku/issues/2073)) ([d178105d](https://github.com/waku-org/nwaku/commit/d178105d))
+- **rln-relay:** segfault when no params except rln-relay are passed in ([#2047](https://github.com/waku-org/nwaku/issues/2047)) ([45fe2d3b](https://github.com/waku-org/nwaku/commit/45fe2d3b))
+- **sqlite:** Properly set user_version to 7 so that the migration procedure is not started ([#2031](https://github.com/waku-org/nwaku/issues/2031)) ([aa3e1a66](https://github.com/waku-org/nwaku/commit/aa3e1a66))
+
+### Changes
+
+- remove js-node tests as release candidate dependencies ([#2123](https://github.com/waku-org/nwaku/issues/2123)) ([ce5fb340](https://github.com/waku-org/nwaku/commit/ce5fb340))
+- added size based retention policy ([#2098](https://github.com/waku-org/nwaku/issues/2098)) ([25d6e52e](https://github.com/waku-org/nwaku/commit/25d6e52e))
+- Clarify running instructions ([#2038](https://github.com/waku-org/nwaku/issues/2038)) ([12e8b122](https://github.com/waku-org/nwaku/commit/12e8b122))
+- **rln:** add more hardcoded memberhips to static group ([#2108](https://github.com/waku-org/nwaku/issues/2108)) ([1042cacd](https://github.com/waku-org/nwaku/commit/1042cacd))
+- Revert lightpush error handling to allow zero peer publish again succeed ([#2099](https://github.com/waku-org/nwaku/issues/2099)) ([f05528d4](https://github.com/waku-org/nwaku/commit/f05528d4))
+- adding NetConfig test suite ([#2091](https://github.com/waku-org/nwaku/issues/2091)) ([23b49ca5](https://github.com/waku-org/nwaku/commit/23b49ca5))
+- **cbindings:** Adding cpp example that integrates the 'libwaku' ([#2079](https://github.com/waku-org/nwaku/issues/2079)) ([8455b8dd](https://github.com/waku-org/nwaku/commit/8455b8dd))
+- **networkmonitor:** refactor setConnectedPeersMetrics, make it partially concurrent, add version ([#2080](https://github.com/waku-org/nwaku/issues/2080)) ([c5aa9704](https://github.com/waku-org/nwaku/commit/c5aa9704))
+- resolving DNS IP and publishing it when no extIp is provided ([#2030](https://github.com/waku-org/nwaku/issues/2030)) ([7797b2cd](https://github.com/waku-org/nwaku/commit/7797b2cd))
+- Adding -d:postgres flag when creating a Docker image for release and PRs ([#2076](https://github.com/waku-org/nwaku/issues/2076)) ([7a376f59](https://github.com/waku-org/nwaku/commit/7a376f59))
+- Moved external APIs out of node ([#2069](https://github.com/waku-org/nwaku/issues/2069)) ([3e72e830](https://github.com/waku-org/nwaku/commit/3e72e830))
+- bump nim-libp2p, nim-toml-serialization, nim-unicodedb, nim-unittest2, nim-websock, nim-zlib, & nimbus-build-system ([#2065](https://github.com/waku-org/nwaku/issues/2065)) ([dc25057a](https://github.com/waku-org/nwaku/commit/dc25057a))
+- **ci:** add js-waku as a dependency for pre-release createion ([#2022](https://github.com/waku-org/nwaku/issues/2022)) ([28b04000](https://github.com/waku-org/nwaku/commit/28b04000))
+- Updating nim-chronicles, nim-chronos, nim-presto, nimcrypto, nim-libp2p, and nim-nat-transversal ([#2043](https://github.com/waku-org/nwaku/issues/2043)) ([f617cd97](https://github.com/waku-org/nwaku/commit/f617cd97))
+- **cbindings:** Thread-safe communication between the main thread and the Waku Thread ([#1978](https://github.com/waku-org/nwaku/issues/1978)) ([72f90663](https://github.com/waku-org/nwaku/commit/72f90663))
+- **rln-relay:** logs, updated submodule, leaves_set metric ([#2024](https://github.com/waku-org/nwaku/issues/2024)) ([2e515a06](https://github.com/waku-org/nwaku/commit/2e515a06))
+- **release:** update changelog for v0.20.0 release ([#2026](https://github.com/waku-org/nwaku/issues/2026)) ([9085b1b3](https://github.com/waku-org/nwaku/commit/9085b1b3))
+- **postgres:** not loading the libpq library by default & better user feedback ([#2028](https://github.com/waku-org/nwaku/issues/2028)) ([e8602021](https://github.com/waku-org/nwaku/commit/e8602021))
+- move SubscriptionManager under waku_core ([#2025](https://github.com/waku-org/nwaku/issues/2025)) ([563b2b20](https://github.com/waku-org/nwaku/commit/563b2b20))
+- **README:** List possible WSL Issue ([#1995](https://github.com/waku-org/nwaku/issues/1995)) ([ebe715e9](https://github.com/waku-org/nwaku/commit/ebe715e9))
+- **ci:** add js-waku test to pre-release workflow ([#2017](https://github.com/waku-org/nwaku/issues/2017)) ([e8776fd6](https://github.com/waku-org/nwaku/commit/e8776fd6))
+
+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` |
+
+The Waku v1 implementation has been removed from this repository and can be found in a separate [Waku Legacy](https://github.com/waku-org/waku-legacy) repository.
+
+## Upgrade instructions
+
+* Note that the `--topic` CLI option is being deprecated in favor of a more specific options `--pubsub-topic` & `--content-topic`. This is the last release supporting the `--topic` option.
+* The size-based retention policy has been tested with SQLite storage and is still on validation phases for Postgres
+
+## 2023-09-14 v0.20.0
+
+> Note: IP address 0.0.0.0 is no longer advertised by a node
+
+> Note: Multiple CLI options have been removed in this release, please see _Upgrade instructions_ section for details.
+
+## What's Changed
+
+Release highlights:
+* RLN is now part of standard release (is no longer EXPERIMENTAL feature)
+* Interop tests between nwaku and js-waku are now gating PRs and releases
+* Libwaku has been made more threadsafe (1 out of 3 improvements applied.)
+* Added autosharding option on various protocol APIs
+
+
+
+### Features
+
+- **rln-relay:** removed rln from experimental 🚀 ([#2001](https://github.com/waku-org/nwaku/issues/2001)) ([645b0343](https://github.com/waku-org/nwaku/commit/645b0343))
+- Rest endoint /health for rln ([#2011](https://github.com/waku-org/nwaku/issues/2011)) ([fc6194bb](https://github.com/waku-org/nwaku/commit/fc6194bb))
+- **rln_db_inspector:** create rln_db_inspector tool ([#1999](https://github.com/waku-org/nwaku/issues/1999)) ([ec42e2c7](https://github.com/waku-org/nwaku/commit/ec42e2c7))
+- **relay:** ordered validator execution ([#1966](https://github.com/waku-org/nwaku/issues/1966)) ([debc5f19](https://github.com/waku-org/nwaku/commit/debc5f19))
+- **discv5:** topic subscriptions update discv5 filter predicate ([#1918](https://github.com/waku-org/nwaku/issues/1918)) ([4539dfc7](https://github.com/waku-org/nwaku/commit/4539dfc7))
+- topic subscriptions updates discv5 ENR ([#1875](https://github.com/waku-org/nwaku/issues/1875)) ([c369b329](https://github.com/waku-org/nwaku/commit/c369b329))
+- **rln_keystore_generator:** wired to onchain group manager ([#1931](https://github.com/waku-org/nwaku/issues/1931)) ([c9b48ea1](https://github.com/waku-org/nwaku/commit/c9b48ea1))
+- **rln:** init rln_keystore_generator ([#1925](https://github.com/waku-org/nwaku/issues/1925)) ([3d849541](https://github.com/waku-org/nwaku/commit/3d849541))
+- update various protocols to autoshard ([#1857](https://github.com/waku-org/nwaku/issues/1857)) ([cf301396](https://github.com/waku-org/nwaku/commit/cf301396))
+
+### Bug Fixes
+
+- **rln-relay:** waku_rln_number_registered_memberships metrics appropriately handled ([#2018](https://github.com/waku-org/nwaku/issues/2018)) ([a4e78330](https://github.com/waku-org/nwaku/commit/a4e78330))
+- prevent IP 0.0.0.0 from being published and update peers with empty ENR data ([#1982](https://github.com/waku-org/nwaku/issues/1982)) ([47ae19c1](https://github.com/waku-org/nwaku/commit/47ae19c1))
+- **rln-relay:** missed roots during sync ([#2015](https://github.com/waku-org/nwaku/issues/2015)) ([21604e6b](https://github.com/waku-org/nwaku/commit/21604e6b))
+- **p2p:** fix possible connectivity issue ([#1996](https://github.com/waku-org/nwaku/issues/1996)) ([7d9d8a3f](https://github.com/waku-org/nwaku/commit/7d9d8a3f))
+- **rln-db-inspector:** use valueOr pattern ([#2012](https://github.com/waku-org/nwaku/issues/2012)) ([a8095d87](https://github.com/waku-org/nwaku/commit/a8095d87))
+- **tests:** relay tests use random port to avoid conflict ([#1998](https://github.com/waku-org/nwaku/issues/1998)) ([b991682b](https://github.com/waku-org/nwaku/commit/b991682b))
+- **ci:** incorrect use of braces ([#1987](https://github.com/waku-org/nwaku/issues/1987)) ([4ed41457](https://github.com/waku-org/nwaku/commit/4ed41457))
+- **Makefile:** invalid path to crate build ([#1981](https://github.com/waku-org/nwaku/issues/1981)) ([1a318c29](https://github.com/waku-org/nwaku/commit/1a318c29))
+- --topic should be ignore when using --pubsub-topic or --content-topic ([#1977](https://github.com/waku-org/nwaku/issues/1977)) ([037b1662](https://github.com/waku-org/nwaku/commit/037b1662))
+- **tests:** fix flaky test ([#1972](https://github.com/waku-org/nwaku/issues/1972)) ([f262397d](https://github.com/waku-org/nwaku/commit/f262397d))
+- **rln-relay:** deserialization of valid merkle roots ([#1973](https://github.com/waku-org/nwaku/issues/1973)) ([d262837e](https://github.com/waku-org/nwaku/commit/d262837e))
+- **ci:** rename tools artifact to prevent conflict ([#1971](https://github.com/waku-org/nwaku/issues/1971)) ([26c06b27](https://github.com/waku-org/nwaku/commit/26c06b27))
+- **Makefile:** rln was enabled by default ([#1964](https://github.com/waku-org/nwaku/issues/1964)) ([9b1d2904](https://github.com/waku-org/nwaku/commit/9b1d2904))
+- **rln-relay:** modify keystore credentials logic ([#1956](https://github.com/waku-org/nwaku/issues/1956)) ([e7b2b88f](https://github.com/waku-org/nwaku/commit/e7b2b88f))
+- **Makefile:** error out if rln-keystore-generator not compiled with rln flag ([#1960](https://github.com/waku-org/nwaku/issues/1960)) ([ac258550](https://github.com/waku-org/nwaku/commit/ac258550))
+- **rln-relay:** sync from deployed block number ([#1955](https://github.com/waku-org/nwaku/issues/1955)) ([bd3be219](https://github.com/waku-org/nwaku/commit/bd3be219))
+- **rln-relay:** window of acceptable roots synced to rln metadata ([#1953](https://github.com/waku-org/nwaku/issues/1953)) ([01634f57](https://github.com/waku-org/nwaku/commit/01634f57))
+- **rln-relay:** bump zerokit to v0.3.2 ([#1951](https://github.com/waku-org/nwaku/issues/1951)) ([32aa1c5b](https://github.com/waku-org/nwaku/commit/32aa1c5b))
+- **rln-relay:** flush_interval incorrectly set ([#1933](https://github.com/waku-org/nwaku/issues/1933)) ([c07d63db](https://github.com/waku-org/nwaku/commit/c07d63db))
+- **rln-relay:** RLN DB should be aware of chain and contract address ([#1932](https://github.com/waku-org/nwaku/issues/1932)) ([1ae5b5a9](https://github.com/waku-org/nwaku/commit/1ae5b5a9))
+- **rln-relay:** waitFor startup, otherwise valid proofs will be marked invalid ([#1920](https://github.com/waku-org/nwaku/issues/1920)) ([6c6302f9](https://github.com/waku-org/nwaku/commit/6c6302f9))
+- **test:** fix flaky rln test ([#1923](https://github.com/waku-org/nwaku/issues/1923)) ([0ac8a7f0](https://github.com/waku-org/nwaku/commit/0ac8a7f0))
+- **rln-relay:** remove registration capability ([#1916](https://github.com/waku-org/nwaku/issues/1916)) ([f08315cd](https://github.com/waku-org/nwaku/commit/f08315cd))
+- **rln-relay:** invalid start index being set results in invalid proofs ([#1915](https://github.com/waku-org/nwaku/issues/1915)) ([b3bb7a11](https://github.com/waku-org/nwaku/commit/b3bb7a11))
+- **rln-relay:** should error out on rln-relay mount failure ([#1904](https://github.com/waku-org/nwaku/issues/1904)) ([8c568cab](https://github.com/waku-org/nwaku/commit/8c568cab))
+- **rln-relay:** timeout on macos runners, use fixed version of ganache ([#1913](https://github.com/waku-org/nwaku/issues/1913)) ([c9772af0](https://github.com/waku-org/nwaku/commit/c9772af0))
+- no enr record in chat2 ([#1907](https://github.com/waku-org/nwaku/issues/1907)) ([fc604ca5](https://github.com/waku-org/nwaku/commit/fc604ca5))
+
+### Changes
+
+- **ci:** add js-waku test to pre-release workflow ([#2017](https://github.com/waku-org/nwaku/issues/2017)) ([e8776fd6](https://github.com/waku-org/nwaku/commit/e8776fd6))
+- **rln-relay:** updated docs ([#1993](https://github.com/waku-org/nwaku/issues/1993)) ([76e34077](https://github.com/waku-org/nwaku/commit/76e34077))
+- **ci:** execute js-waku integration tests on image build ([#2006](https://github.com/waku-org/nwaku/issues/2006)) ([5d976df9](https://github.com/waku-org/nwaku/commit/5d976df9))
+- **rln-relay:** add isReady check ([#1989](https://github.com/waku-org/nwaku/issues/1989)) ([5638bd06](https://github.com/waku-org/nwaku/commit/5638bd06))
+- **rln-relay:** clean up nullifier table every MaxEpochGap ([#1994](https://github.com/waku-org/nwaku/issues/1994)) ([483f40c8](https://github.com/waku-org/nwaku/commit/483f40c8))
+- **ci:** use commit instead of master for docker image ([#1990](https://github.com/waku-org/nwaku/issues/1990)) ([98850192](https://github.com/waku-org/nwaku/commit/98850192))
+- **rln-relay:** log levels for certain logs ([#1986](https://github.com/waku-org/nwaku/issues/1986)) ([97a7c9d0](https://github.com/waku-org/nwaku/commit/97a7c9d0))
+- **rln-relay:** use the only key from keystore if only 1 exists ([#1984](https://github.com/waku-org/nwaku/issues/1984)) ([a14c3261](https://github.com/waku-org/nwaku/commit/a14c3261))
+- **ci:** enable experimental for the PR image builds ([#1976](https://github.com/waku-org/nwaku/issues/1976)) ([1b835b4e](https://github.com/waku-org/nwaku/commit/1b835b4e))
+- **rln-relay:** confirm that the provided credential is correct using onchain query ([#1980](https://github.com/waku-org/nwaku/issues/1980)) ([be48891f](https://github.com/waku-org/nwaku/commit/be48891f))
+- **api:** validate rln message before sending (rest + rpc) ([#1968](https://github.com/waku-org/nwaku/issues/1968)) ([05c98864](https://github.com/waku-org/nwaku/commit/05c98864))
+- **cbindings:** Thread-safe libwaku. WakuNode instance created directly from the Waku Thread ([#1957](https://github.com/waku-org/nwaku/issues/1957)) ([68e8d9a7](https://github.com/waku-org/nwaku/commit/68e8d9a7))
+- add debug log indicating succesful message pushes and also log the message hash ([#1965](https://github.com/waku-org/nwaku/issues/1965)) ([e272bec9](https://github.com/waku-org/nwaku/commit/e272bec9))
+- **rln-keystore-generator:** log out the membership index upon registration ([#1963](https://github.com/waku-org/nwaku/issues/1963)) ([7d53aec1](https://github.com/waku-org/nwaku/commit/7d53aec1))
+- **rln-relay:** integrate waku rln registry ([#1943](https://github.com/waku-org/nwaku/issues/1943)) ([cc9f8d42](https://github.com/waku-org/nwaku/commit/cc9f8d42))
+- **ci:** add a job checking config options and db schema ([#1927](https://github.com/waku-org/nwaku/issues/1927)) ([505d1967](https://github.com/waku-org/nwaku/commit/505d1967))
+- **rln_keystore_generator:** generate and persist credentials ([#1928](https://github.com/waku-org/nwaku/issues/1928)) ([07945a37](https://github.com/waku-org/nwaku/commit/07945a37))
+- **rln-relay:** rename keystore application to waku-rln-relay ([#1924](https://github.com/waku-org/nwaku/issues/1924)) ([8239b455](https://github.com/waku-org/nwaku/commit/8239b455))
+- **rln:** remove old and add new rln metric ([#1926](https://github.com/waku-org/nwaku/issues/1926)) ([56c228f8](https://github.com/waku-org/nwaku/commit/56c228f8))
+- **rln:** run rln in all relay pubsubtopics + remove cli flags ([#1917](https://github.com/waku-org/nwaku/issues/1917)) ([af95b571](https://github.com/waku-org/nwaku/commit/af95b571))
+- **release:** update changelog for delayed v0.19.0 release ([#1911](https://github.com/waku-org/nwaku/issues/1911)) ([78690787](https://github.com/waku-org/nwaku/commit/78690787))
+
+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` |
+
+The Waku v1 implementation has been removed from this repository and can be found in a separate [Waku Legacy](https://github.com/waku-org/waku-legacy) repository.
+
+## Upgrade instructions
+
+* Note that the `--topic` CLI option is being deprecated in favor of a more specific options `--pubsub-topic` & `--content-topic`. The `--topic` option will be available for next release with a deprecation note.
+* CLI option `--store-resume-peer` has been removed.
+* Following options related to RLN have been removed:
+ * `--rln-relay-membership-group-index`
+ * `--rln-relay-pubsub-topic`
+ * `--rln-relay-content-topic`
+
+
+## 2023-08-16 v0.19.0
+
+> Note that the `--topic` CLI option is being deprecated in favor a more specific option `--pubsub-topic`.
+
+> The Waku v1 implementation has been removed from this repository and can be found in a separate [Waku Legacy](https://github.com/waku-org/waku-legacy) repository.
+
+
+## What's Changed
+
+Release highlights:
+* Improved connection management, including management for non-relay peers and limiting the number of connections from a single IP
+* Postgres support has been added as a backend for archive module
+* RLN initialization optimizations
+* Update to the latest nim-libp2p
+* Removed Waku v1 and also references to `v2` from the current version
+* Basic implementation of Autosharding for the Waku Network
+* REST API implementation for Filter protocol
+
+### Features
+
+- **ci:** add docker image builds per PR ([#1881](https://github.com/waku-org/nwaku/issues/1881)) ([84f94d5d](https://github.com/waku-org/nwaku/commit/84f94d5d))
+- Rest API interface for legacy (v1) filter service. ([#1851](https://github.com/waku-org/nwaku/issues/1851)) ([08ff6672](https://github.com/waku-org/nwaku/commit/08ff6672))
+- autosharding content topics in config ([#1856](https://github.com/waku-org/nwaku/issues/1856)) ([afb93e29](https://github.com/waku-org/nwaku/commit/afb93e29))
+- autosharding core algorithm ([#1854](https://github.com/waku-org/nwaku/issues/1854)) ([bbff1ac1](https://github.com/waku-org/nwaku/commit/bbff1ac1))
+- **cbindings:** tiny waku relay example in Python ([#1793](https://github.com/waku-org/nwaku/issues/1793)) ([0b2cfae5](https://github.com/waku-org/nwaku/commit/0b2cfae5))
+- **rln-relay:** close db connection appropriately ([#1858](https://github.com/waku-org/nwaku/issues/1858)) ([76c73b62](https://github.com/waku-org/nwaku/commit/76c73b62))
+- enable TcpNoDelay ([#1470](https://github.com/waku-org/nwaku/issues/1470)) ([08f3bba3](https://github.com/waku-org/nwaku/commit/08f3bba3))
+- limit relay connections below max conns ([#1813](https://github.com/waku-org/nwaku/issues/1813)) ([17b24cde](https://github.com/waku-org/nwaku/commit/17b24cde))
+- **postgres:** integration of postgres in wakunode2 ([#1808](https://github.com/waku-org/nwaku/issues/1808)) ([88b7481f](https://github.com/waku-org/nwaku/commit/88b7481f))
+- discovery peer filtering for relay shard ([#1804](https://github.com/waku-org/nwaku/issues/1804)) ([a4da87bb](https://github.com/waku-org/nwaku/commit/a4da87bb))
+- **rln-relay:** resume onchain sync from persisted tree db ([#1805](https://github.com/waku-org/nwaku/issues/1805)) ([bbded9ee](https://github.com/waku-org/nwaku/commit/bbded9ee))
+- **rln-relay:** metadata ffi api ([#1803](https://github.com/waku-org/nwaku/issues/1803)) ([045f07c6](https://github.com/waku-org/nwaku/commit/045f07c6))
+
+### Bug Fixes
+
+- bring back default topic in config ([#1902](https://github.com/waku-org/nwaku/issues/1902)) ([d5d2243c](https://github.com/waku-org/nwaku/commit/d5d2243c))
+- **ci:** only add comment on PR and do not duplicate it ([#1908](https://github.com/waku-org/nwaku/issues/1908)) ([b785b6ba](https://github.com/waku-org/nwaku/commit/b785b6ba))
+- **ci:** add mising OS arch option to image build ([#1905](https://github.com/waku-org/nwaku/issues/1905)) ([2575f3c4](https://github.com/waku-org/nwaku/commit/2575f3c4))
+- **wakucanary:** add missing return on timeout ([#1901](https://github.com/waku-org/nwaku/issues/1901)) ([7dce0b9e](https://github.com/waku-org/nwaku/commit/7dce0b9e))
+- fixes out of bounds crash when waku2 is not set ([#1895](https://github.com/waku-org/nwaku/issues/1895)) ([03363f1b](https://github.com/waku-org/nwaku/commit/03363f1b))
+- **wakucanary:** add enr record to builder ([#1882](https://github.com/waku-org/nwaku/issues/1882)) ([831a093f](https://github.com/waku-org/nwaku/commit/831a093f))
+- check nil before calling clearTimer ([#1869](https://github.com/waku-org/nwaku/issues/1869)) ([2fc48842](https://github.com/waku-org/nwaku/commit/2fc48842))
+- **rln-relay:** mark duplicated messages as spam ([#1867](https://github.com/waku-org/nwaku/issues/1867)) ([4756ccc1](https://github.com/waku-org/nwaku/commit/4756ccc1))
+- **ci:** do not depend on number of procesors with job name ([#1863](https://github.com/waku-org/nwaku/issues/1863)) ([c560af11](https://github.com/waku-org/nwaku/commit/c560af11))
+- **libp2p:** Updating nim-libp2p to fix the `wss` connectivity issue ([#1848](https://github.com/waku-org/nwaku/issues/1848)) ([1d3410c7](https://github.com/waku-org/nwaku/commit/1d3410c7))
+- **rln-relay:** chunk event fetching ([#1830](https://github.com/waku-org/nwaku/issues/1830)) ([e4d9ee1f](https://github.com/waku-org/nwaku/commit/e4d9ee1f))
+- **discv5:** Fixing issue that prevented the wakunode2 from starting ([#1829](https://github.com/waku-org/nwaku/issues/1829)) ([3aefade6](https://github.com/waku-org/nwaku/commit/3aefade6))
+- sanity-check the docker image start ([ae05f0a8](https://github.com/waku-org/nwaku/commit/ae05f0a8))
+- **ci:** fix broken test with wrong import ([#1820](https://github.com/waku-org/nwaku/issues/1820)) ([4573e8c5](https://github.com/waku-org/nwaku/commit/4573e8c5))
+- temporary fix to disable default experimental builds on fleets ([#1810](https://github.com/waku-org/nwaku/issues/1810)) ([e9028618](https://github.com/waku-org/nwaku/commit/e9028618))
+- **rln-relay:** tree race condition upon initialization ([#1807](https://github.com/waku-org/nwaku/issues/1807)) ([f8e270fb](https://github.com/waku-org/nwaku/commit/f8e270fb))
+- fix mac docker build alpine version ([#1801](https://github.com/waku-org/nwaku/issues/1801)) ([fce845bb](https://github.com/waku-org/nwaku/commit/fce845bb))
+- **rln-relay:** flaky static group manager test ([#1798](https://github.com/waku-org/nwaku/issues/1798)) ([0e9ecbd6](https://github.com/waku-org/nwaku/commit/0e9ecbd6))
+
+### Changes
+
+- remove references to v2 ([#1898](https://github.com/waku-org/nwaku/issues/1898)) ([b9d5d28a](https://github.com/waku-org/nwaku/commit/b9d5d28a))
+- **submodules:** use zerokit v0.3.1 only ([#1886](https://github.com/waku-org/nwaku/issues/1886)) ([311f5ea0](https://github.com/waku-org/nwaku/commit/311f5ea0))
+- remove Waku v1 and wakubridge code ([#1874](https://github.com/waku-org/nwaku/issues/1874)) ([ab344a9d](https://github.com/waku-org/nwaku/commit/ab344a9d))
+- **cbindings:** libwaku - run waku node in a secondary working thread ([#1865](https://github.com/waku-org/nwaku/issues/1865)) ([069c1ad2](https://github.com/waku-org/nwaku/commit/069c1ad2))
+- update docs link ([#1850](https://github.com/waku-org/nwaku/issues/1850)) ([d2b6075b](https://github.com/waku-org/nwaku/commit/d2b6075b))
+- **changelog:** release notes for v0.19.0 ([#1861](https://github.com/waku-org/nwaku/issues/1861)) ([32c1276f](https://github.com/waku-org/nwaku/commit/32c1276f))
+- **rln-relay:** verify proofs based on bandwidth usage ([#1844](https://github.com/waku-org/nwaku/issues/1844)) ([3fe4522a](https://github.com/waku-org/nwaku/commit/3fe4522a))
+- **rln-relay:** bump zerokit ([#1838](https://github.com/waku-org/nwaku/issues/1838)) ([4f0bdf9a](https://github.com/waku-org/nwaku/commit/4f0bdf9a))
+- bump nim-libp2p to 224f92e ([661638da](https://github.com/waku-org/nwaku/commit/661638da))
+- **refactor:** Move record creation & fix libwaku compilation ([#1833](https://github.com/waku-org/nwaku/issues/1833)) ([97d3b9f7](https://github.com/waku-org/nwaku/commit/97d3b9f7))
+- discv5 re-org clean-up ([#1823](https://github.com/waku-org/nwaku/issues/1823)) ([cf46fb7c](https://github.com/waku-org/nwaku/commit/cf46fb7c))
+- **networking:** disconnect due to colocation ip in conn handler ([#1821](https://github.com/waku-org/nwaku/issues/1821)) ([e12c979c](https://github.com/waku-org/nwaku/commit/e12c979c))
+- **rln-relay:** bump zerokit for version fix ([#1822](https://github.com/waku-org/nwaku/issues/1822)) ([add294a9](https://github.com/waku-org/nwaku/commit/add294a9))
+- move discv5 out of node. ([#1818](https://github.com/waku-org/nwaku/issues/1818)) ([62d36530](https://github.com/waku-org/nwaku/commit/62d36530))
+- **archive:** Moving waku archive logic from app.nim to the archive module ([#1817](https://github.com/waku-org/nwaku/issues/1817)) ([52894a82](https://github.com/waku-org/nwaku/commit/52894a82))
+- add peer manager config to builder ([#1816](https://github.com/waku-org/nwaku/issues/1816)) ([71c4ac16](https://github.com/waku-org/nwaku/commit/71c4ac16))
+- discv5 re-org setup ([#1815](https://github.com/waku-org/nwaku/issues/1815)) ([44f9d8dc](https://github.com/waku-org/nwaku/commit/44f9d8dc))
+- **databases:** Creation of the databases folder to keep the logic for sqlite and postgres ([#1811](https://github.com/waku-org/nwaku/issues/1811)) ([a44d4bfb](https://github.com/waku-org/nwaku/commit/a44d4bfb))
+- **deps:** bump libp2p & websock ([#1800](https://github.com/waku-org/nwaku/issues/1800)) ([f6e89c31](https://github.com/waku-org/nwaku/commit/f6e89c31))
+
+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` |
+
+The Waku v1 implementation has been removed from this repository and can be found in a separate [Waku Legacy](https://github.com/waku-org/waku-legacy) repository.
+
+## Upgrade instructions
+
+* Note that the `--topic` CLI option is being deprecated in favor a more specific option `--pubsub-topic`. The `--topic` option will be available for next 2 releases with a deprecation note.
+
+## 2023-06-14 v0.18.0
+
+> Note that there is a new naming scheme for release artifacts.
+
+## What's Changed
+
+Release highlights:
+* Support for Gossipsub scoring
+* [Rendezvous discovery protocol](https://docs.libp2p.io/concepts/discovery-routing/rendezvous/) enabled by default with relay
+* Initial support for postgresql as Store backend
+* Atomic operations for insertions and deletions included in rln-relay
+
+### Features
+
+- **postgres:** complete implementation of driver and apply more tests ([#1785](https://github.com/waku-org/nwaku/issues/1785)) ([5fc5770d](https://github.com/waku-org/nwaku/commit/5fc5770d))
+- **postgres:** adding a postgres async pool to make the db interactions asynchronous ([#1779](https://github.com/waku-org/nwaku/issues/1779)) ([cb2e3d86](https://github.com/waku-org/nwaku/commit/cb2e3d86))
+- **rln-relay:** pass in index to keystore credentials ([#1777](https://github.com/waku-org/nwaku/issues/1777)) ([a00aa8cc](https://github.com/waku-org/nwaku/commit/a00aa8cc))
+- **networking:** integrate gossipsub scoring ([#1769](https://github.com/waku-org/nwaku/issues/1769)) ([34a92631](https://github.com/waku-org/nwaku/commit/34a92631))
+- **discv5:** added find random nodes with predicate ([#1762](https://github.com/waku-org/nwaku/issues/1762)) ([#1763](https://github.com/waku-org/nwaku/issues/1763)) ([21737c7c](https://github.com/waku-org/nwaku/commit/21737c7c))
+- **wakunode2:** enable libp2p rendezvous protocol by default ([#1770](https://github.com/waku-org/nwaku/issues/1770)) ([835a409d](https://github.com/waku-org/nwaku/commit/835a409d))
+- **postgresql:** align previous work's PR[#1590](https://github.com/waku-org/nwaku/issues/1590) changes into master ([#1764](https://github.com/waku-org/nwaku/issues/1764)) ([7df6f4c8](https://github.com/waku-org/nwaku/commit/7df6f4c8))
+- **networking:** prune peers from same ip beyond collocation limit ([#1765](https://github.com/waku-org/nwaku/issues/1765)) ([047d1cf0](https://github.com/waku-org/nwaku/commit/047d1cf0))
+- **ci:** add nightly builds ([#1758](https://github.com/waku-org/nwaku/issues/1758)) ([473af70a](https://github.com/waku-org/nwaku/commit/473af70a))
+- **postgresql:** 1st commit to async sql (waku_archive/driver...) ([#1755](https://github.com/waku-org/nwaku/issues/1755)) ([59ca03a8](https://github.com/waku-org/nwaku/commit/59ca03a8))
+- **ci:** add release-notes target ([#1734](https://github.com/waku-org/nwaku/issues/1734)) ([ceb54b18](https://github.com/waku-org/nwaku/commit/ceb54b18))
+- **rln-relay:** use new atomic_operation ffi api ([#1733](https://github.com/waku-org/nwaku/issues/1733)) ([611e9539](https://github.com/waku-org/nwaku/commit/611e9539))
+
+### Bug Fixes
+
+- **ci:** enforce basic CPU instruction set to prevent CI issues ([#1759](https://github.com/waku-org/nwaku/issues/1759)) ([35520bd0](https://github.com/waku-org/nwaku/commit/35520bd0))
+- **test:** wait more for gossip ([#1753](https://github.com/waku-org/nwaku/issues/1753)) ([0fce3d83](https://github.com/waku-org/nwaku/commit/0fce3d83))
+- **rln-relay:** keystore usage ([#1750](https://github.com/waku-org/nwaku/issues/1750)) ([36266b43](https://github.com/waku-org/nwaku/commit/36266b43))
+- **ci:** fix flaky test for dos topic ([#1747](https://github.com/waku-org/nwaku/issues/1747)) ([46e231d0](https://github.com/waku-org/nwaku/commit/46e231d0))
+- **rln-relay:** trace log ([#1743](https://github.com/waku-org/nwaku/issues/1743)) ([5eae60e8](https://github.com/waku-org/nwaku/commit/5eae60e8))
+- **ci:** make experimental default to true in fleet deployment ([#1742](https://github.com/waku-org/nwaku/issues/1742)) ([b148c305](https://github.com/waku-org/nwaku/commit/b148c305))
+
+### Changes
+
+- **rln:** bump zerokit ([#1787](https://github.com/waku-org/nwaku/issues/1787)) ([9c04b59b](https://github.com/waku-org/nwaku/commit/9c04b59b))
+- **ci:** extend and rename nightly workflow to support RC builds ([#1784](https://github.com/waku-org/nwaku/issues/1784)) ([96074071](https://github.com/waku-org/nwaku/commit/96074071))
+- **rln-relay:** pass in the path to the tree db ([#1782](https://github.com/waku-org/nwaku/issues/1782)) ([dba84248](https://github.com/waku-org/nwaku/commit/dba84248))
+- **rln-relay:** update tree_config ([#1781](https://github.com/waku-org/nwaku/issues/1781)) ([ba8ec704](https://github.com/waku-org/nwaku/commit/ba8ec704))
+- **ci:** properly set os and architecture for nightly and release ([#1780](https://github.com/waku-org/nwaku/issues/1780)) ([44bcf0f2](https://github.com/waku-org/nwaku/commit/44bcf0f2))
+- **ci:** remove add-to-project workflow ([#1778](https://github.com/waku-org/nwaku/issues/1778)) ([a9505892](https://github.com/waku-org/nwaku/commit/a9505892))
+- **ci:** add experimental builds to nightly ([#1761](https://github.com/waku-org/nwaku/issues/1761)) ([ffac7761](https://github.com/waku-org/nwaku/commit/ffac7761))
+- **px:** close px streams after resp is sent ([#1746](https://github.com/waku-org/nwaku/issues/1746)) ([3c2d2891](https://github.com/waku-org/nwaku/commit/3c2d2891))
+- **docs:** fix docs and mark some as deprecated ([#1754](https://github.com/waku-org/nwaku/issues/1754)) ([b51fb616](https://github.com/waku-org/nwaku/commit/b51fb616))
+- **makefile:** unify where chronicles_log_level is set ([#1748](https://github.com/waku-org/nwaku/issues/1748)) ([39902dc2](https://github.com/waku-org/nwaku/commit/39902dc2))
+- **rln-relay:** docs and config update for testnet 3 ([#1738](https://github.com/waku-org/nwaku/issues/1738)) ([bb9d231b](https://github.com/waku-org/nwaku/commit/bb9d231b))
+- **rln-relay:** update metrics dashboard ([#1745](https://github.com/waku-org/nwaku/issues/1745)) ([0ced2195](https://github.com/waku-org/nwaku/commit/0ced2195))
+- **rln-relay:** updated metrics for testnet 3 ([#1744](https://github.com/waku-org/nwaku/issues/1744)) ([62578746](https://github.com/waku-org/nwaku/commit/62578746))
+- **networking:** set and use target outbound connections + prune ([#1739](https://github.com/waku-org/nwaku/issues/1739)) ([87f694a8](https://github.com/waku-org/nwaku/commit/87f694a8))
+- proper use of setupNat ([#1740](https://github.com/waku-org/nwaku/issues/1740)) ([665484c1](https://github.com/waku-org/nwaku/commit/665484c1))
+
+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` |
+
+The Waku v1 implementation is stable but not under active development.
+
+## Upgrade instructions
+
+There is a new naming scheme for release artifacts - `nwaku-${ARCHITECTURE}-${OS}-${VERSION}.tar.gz`. If you use any automation to download latest release, you may need to update it.
+
+The `--topics` config option has been deprecated to unify the configuration style. It is still available in this release but will be removed in the next one. The new option `--topic` is introduced, which can be used repeatedly to achieve the same behavior.
+
+## 2023-05-17 v0.17.0
+
+> Note that the --topics config item has been deprecated and support will be dropped in future releases. To configure support for multiple pubsub topics, use the new --topic parameter repeatedly.
+
+## What's Changed
+
+Release highlights:
+* New REST API for Waku Store protocol.
+* New Filter protocol implentation. See [12/WAKU2-FILTER](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/12/filter.md).
+* Initial C bindings support.
+* Support for Heaptrack to investigate memory utilization ([tutorial](https://github.com/waku-org/nwaku/blob/master/docs/tutorial/heaptrack.md)).
+
+### Features
+
+- **cbindings:** first commit - waku relay ([#1632](https://github.com/waku-org/nwaku/issues/1632)) ([#1714](https://github.com/waku-org/nwaku/issues/1714)) ([2defbd23](https://github.com/waku-org/nwaku/commit/2defbd23))
+- example using filter and lightpush ([#1720](https://github.com/waku-org/nwaku/issues/1720)) ([8987d4a3](https://github.com/waku-org/nwaku/commit/8987d4a3))
+- configure protected topics via cli ([#1696](https://github.com/waku-org/nwaku/issues/1696)) ([16b44523](https://github.com/waku-org/nwaku/commit/16b44523))
+- **mem-analysis:** Adding Dockerfile_with_heaptrack ([#1681](https://github.com/waku-org/nwaku/issues/1681)) ([9b9172ab](https://github.com/waku-org/nwaku/commit/9b9172ab))
+- add metrics with msg size histogram ([#1697](https://github.com/waku-org/nwaku/issues/1697)) ([67e96ba8](https://github.com/waku-org/nwaku/commit/67e96ba8))
+- curate peers shared over px protocol ([#1671](https://github.com/waku-org/nwaku/issues/1671)) ([14305c61](https://github.com/waku-org/nwaku/commit/14305c61))
+- **enr:** added support for relay shards field ([96162536](https://github.com/waku-org/nwaku/commit/96162536))
+- add tools maket target and build tools in CI ([#1668](https://github.com/waku-org/nwaku/issues/1668)) ([d5979e94](https://github.com/waku-org/nwaku/commit/d5979e94))
+- integrate new filter protocol, other improvements ([#1637](https://github.com/waku-org/nwaku/issues/1637)) ([418efca2](https://github.com/waku-org/nwaku/commit/418efca2))
+- **rest-api-store:** new rest api to retrieve store waku messages ([#1611](https://github.com/waku-org/nwaku/issues/1611)) ([#1630](https://github.com/waku-org/nwaku/issues/1630)) ([b2acb54d](https://github.com/waku-org/nwaku/commit/b2acb54d))
+- **node:** added waku node builder type ([e931fa5d](https://github.com/waku-org/nwaku/commit/e931fa5d))
+- dos protected topic relay msgs based on meta field ([#1614](https://github.com/waku-org/nwaku/issues/1614)) ([c26dcb2b](https://github.com/waku-org/nwaku/commit/c26dcb2b))
+- further filter improvements ([#1617](https://github.com/waku-org/nwaku/issues/1617)) ([d920b973](https://github.com/waku-org/nwaku/commit/d920b973))
+- **common:** added extensible implementation of the enr typed record ([ac56e1dc](https://github.com/waku-org/nwaku/commit/ac56e1dc))
+- **rln-relay:** fetch release from zerokit ci, or build ([#1603](https://github.com/waku-org/nwaku/issues/1603)) ([179be681](https://github.com/waku-org/nwaku/commit/179be681))
+- **filter-v2:** new filter protocol increment - message handling and clients ([#1600](https://github.com/waku-org/nwaku/issues/1600)) ([be446b98](https://github.com/waku-org/nwaku/commit/be446b98))
+
+### Fixes
+
+- **ci:** remove target flag from docker command ([#1725](https://github.com/waku-org/nwaku/issues/1725)) ([d822cdc5](https://github.com/waku-org/nwaku/commit/d822cdc5))
+- wakunode2 config. adding new 'topic' config parameter. ([#1727](https://github.com/waku-org/nwaku/issues/1727)) ([2ec9809c](https://github.com/waku-org/nwaku/commit/2ec9809c))
+- streams was used instead of connections ([#1722](https://github.com/waku-org/nwaku/issues/1722)) ([b9e0763e](https://github.com/waku-org/nwaku/commit/b9e0763e))
+- change filter request default behaviour to ping ([#1721](https://github.com/waku-org/nwaku/issues/1721)) ([7c39be9a](https://github.com/waku-org/nwaku/commit/7c39be9a))
+- **rln-relay:** handle invalid deletes ([#1717](https://github.com/waku-org/nwaku/issues/1717)) ([81dffee8](https://github.com/waku-org/nwaku/commit/81dffee8))
+- fix filter v2 proto fields ([#1716](https://github.com/waku-org/nwaku/issues/1716)) ([68a39c65](https://github.com/waku-org/nwaku/commit/68a39c65))
+- unstable peers in mesh ([#1710](https://github.com/waku-org/nwaku/issues/1710)) ([703c3ab5](https://github.com/waku-org/nwaku/commit/703c3ab5))
+- **networkmonitor:** break import dependency with wakunode2 app ([043feacd](https://github.com/waku-org/nwaku/commit/043feacd))
+- import nimchronos instead heartbeat ([#1695](https://github.com/waku-org/nwaku/issues/1695)) ([7d12adf6](https://github.com/waku-org/nwaku/commit/7d12adf6))
+- **rest:** change rest server result error type to string ([d5ef9331](https://github.com/waku-org/nwaku/commit/d5ef9331))
+- **rln-relay:** scope of getEvents ([#1672](https://github.com/waku-org/nwaku/issues/1672)) ([b62193e5](https://github.com/waku-org/nwaku/commit/b62193e5))
+- **logs:** fix log reporting wrong ok connected peers ([#1675](https://github.com/waku-org/nwaku/issues/1675)) ([1a885b96](https://github.com/waku-org/nwaku/commit/1a885b96))
+- move canBeConnected to PeerManager and check for potential overflow ([#1670](https://github.com/waku-org/nwaku/issues/1670)) ([d5c2770c](https://github.com/waku-org/nwaku/commit/d5c2770c))
+- wrap untracked protocol handler exceptions ([9e1432c9](https://github.com/waku-org/nwaku/commit/9e1432c9))
+- **wakunode2:** made setup nat return errors ([1cfb251b](https://github.com/waku-org/nwaku/commit/1cfb251b))
+- fixed multiple bare except warnings ([caf78249](https://github.com/waku-org/nwaku/commit/caf78249))
+- bump libp2p with traffic metrics fix ([#1642](https://github.com/waku-org/nwaku/issues/1642)) ([0ef46673](https://github.com/waku-org/nwaku/commit/0ef46673))
+- **rln-relay:** buildscript bad cp ([#1636](https://github.com/waku-org/nwaku/issues/1636)) ([bd9857c1](https://github.com/waku-org/nwaku/commit/bd9857c1))
+- **wakunode2:** fix main warnings and drop swap support ([f95147f5](https://github.com/waku-org/nwaku/commit/f95147f5))
+- **rln-relay:** on chain registration ([#1627](https://github.com/waku-org/nwaku/issues/1627)) ([b1bafda2](https://github.com/waku-org/nwaku/commit/b1bafda2))
+- connect instead of dialing relay peers ([#1622](https://github.com/waku-org/nwaku/issues/1622)) ([85f33a8e](https://github.com/waku-org/nwaku/commit/85f33a8e))
+- fix hash size greater than 32 ([#1621](https://github.com/waku-org/nwaku/issues/1621)) ([c42ac16f](https://github.com/waku-org/nwaku/commit/c42ac16f))
+
+### Changes
+
+- **ci:** cache all of submodules/deps to speed up build time ([#1731](https://github.com/waku-org/nwaku/issues/1731)) ([4394c69d](https://github.com/waku-org/nwaku/commit/4394c69d))
+- **rln-relay:** update args to contract ([#1724](https://github.com/waku-org/nwaku/issues/1724)) ([b277ce10](https://github.com/waku-org/nwaku/commit/b277ce10))
+- **rln-relay:** use new config for ffi ([#1718](https://github.com/waku-org/nwaku/issues/1718)) ([44c54312](https://github.com/waku-org/nwaku/commit/44c54312))
+- adding new tutorial on how to handle heaptrack with nim waku ([#1719](https://github.com/waku-org/nwaku/issues/1719)) ([4b59e472](https://github.com/waku-org/nwaku/commit/4b59e472))
+- add timestamp and ephemeral for opt-in dos validator ([#1713](https://github.com/waku-org/nwaku/issues/1713)) ([3e0a693d](https://github.com/waku-org/nwaku/commit/3e0a693d))
+- add test vectors dos protection validator ([#1711](https://github.com/waku-org/nwaku/issues/1711)) ([eaa162ee](https://github.com/waku-org/nwaku/commit/eaa162ee))
+- add validator for dos protec metrics and move to app ([#1704](https://github.com/waku-org/nwaku/issues/1704)) ([3e146869](https://github.com/waku-org/nwaku/commit/3e146869))
+- use QUICK_AND_DIRTY_COMPILER flag for CI ([#1708](https://github.com/waku-org/nwaku/issues/1708)) ([21510425](https://github.com/waku-org/nwaku/commit/21510425))
+- move networkmonitor and wakucanary to apps directory ([209579b0](https://github.com/waku-org/nwaku/commit/209579b0))
+- **wakunode2:** flatten and simplify app setup ([#1705](https://github.com/waku-org/nwaku/issues/1705)) ([ce92fc1a](https://github.com/waku-org/nwaku/commit/ce92fc1a))
+- **wakunode2:** split setup logic into app module ([c8081c88](https://github.com/waku-org/nwaku/commit/c8081c88))
+- add payload bytes to trace log ([#1703](https://github.com/waku-org/nwaku/issues/1703)) ([c6d291d3](https://github.com/waku-org/nwaku/commit/c6d291d3))
+- refactor flaky test with while ([#1698](https://github.com/waku-org/nwaku/issues/1698)) ([dca0e9b2](https://github.com/waku-org/nwaku/commit/dca0e9b2))
+- **core:** move peers utils module to waku_core ([e041e043](https://github.com/waku-org/nwaku/commit/e041e043))
+- decouple test2 target from testcommon ([91baa232](https://github.com/waku-org/nwaku/commit/91baa232))
+- **core:** move utils time module to waku_core ([93b0c071](https://github.com/waku-org/nwaku/commit/93b0c071))
+- add deprecation notice to utils module. move heartbeat to common ([e8dceb2a](https://github.com/waku-org/nwaku/commit/e8dceb2a))
+- **core:** rename waku_message module to waku_core ([c9b6b230](https://github.com/waku-org/nwaku/commit/c9b6b230))
+- flatten waku v2 protocols folder ([d7b72ac7](https://github.com/waku-org/nwaku/commit/d7b72ac7))
+- fix test failing intermittently ([#1679](https://github.com/waku-org/nwaku/issues/1679)) ([8d213e85](https://github.com/waku-org/nwaku/commit/8d213e85))
+- **networking:** get relay number of connections from protocol conns/streams ([#1609](https://github.com/waku-org/nwaku/issues/1609)) ([73cbafa6](https://github.com/waku-org/nwaku/commit/73cbafa6))
+- allow to call store api endpoints without a storenode ([#1575](https://github.com/waku-org/nwaku/issues/1575)) ([#1647](https://github.com/waku-org/nwaku/issues/1647)) ([0b4a2e68](https://github.com/waku-org/nwaku/commit/0b4a2e68))
+- bump container image versions to v0.16.0 in quickstart ([#1640](https://github.com/waku-org/nwaku/issues/1640)) ([5c33d9d1](https://github.com/waku-org/nwaku/commit/5c33d9d1))
+- **node:** remove deprecated constructor and extend testlib with builder ([9dadc1f5](https://github.com/waku-org/nwaku/commit/9dadc1f5))
+- do not mount relay more than once ([#1650](https://github.com/waku-org/nwaku/issues/1650)) ([5d853b86](https://github.com/waku-org/nwaku/commit/5d853b86))
+- pointed all waku node imports to the barrel import ([e8448dfd](https://github.com/waku-org/nwaku/commit/e8448dfd))
+- **node:** added waku_node barrel import and split config module ([13942888](https://github.com/waku-org/nwaku/commit/13942888))
+- remove deprecated enr record init method ([0627b4f8](https://github.com/waku-org/nwaku/commit/0627b4f8))
+- **deps:** upgrade nim-chronos and nim-presto to latest version ([7c229ece](https://github.com/waku-org/nwaku/commit/7c229ece))
+- remove waku swap protocol ([2b5fd2a2](https://github.com/waku-org/nwaku/commit/2b5fd2a2))
+- **deps:** upgrade nim-confutils to latest version ([67fa736d](https://github.com/waku-org/nwaku/commit/67fa736d))
+- **rln-relay:** gracefully handle chain forks ([#1623](https://github.com/waku-org/nwaku/issues/1623)) ([00a3812b](https://github.com/waku-org/nwaku/commit/00a3812b))
+- bump nim-libp2p 53b060f ([#1633](https://github.com/waku-org/nwaku/issues/1633)) ([11ff93c2](https://github.com/waku-org/nwaku/commit/11ff93c2))
+- added testcommon target to makefile ([048ca45d](https://github.com/waku-org/nwaku/commit/048ca45d))
+- increase meta size to 64 bytes + tests ([#1629](https://github.com/waku-org/nwaku/issues/1629)) ([1f793756](https://github.com/waku-org/nwaku/commit/1f793756))
+- **enr:** move waku enr multiaddr to typedrecord and builder extensions ([2ffd2f80](https://github.com/waku-org/nwaku/commit/2ffd2f80))
+- **enr:** added waku2 capabilities accessor ([157724d9](https://github.com/waku-org/nwaku/commit/157724d9))
+- **rln-relay:** reduce exports ([#1615](https://github.com/waku-org/nwaku/issues/1615)) ([2f3ba3d6](https://github.com/waku-org/nwaku/commit/2f3ba3d6))
+- add dash between target and version ([#1613](https://github.com/waku-org/nwaku/issues/1613)) ([24d62791](https://github.com/waku-org/nwaku/commit/24d62791))
+- **release:** added regression checking and clarifications ([#1610](https://github.com/waku-org/nwaku/issues/1610)) ([b495dd7b](https://github.com/waku-org/nwaku/commit/b495dd7b))
+
+
+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` |
+
+The Waku v1 implementation is stable but not under active development.
+
+## Upgrade instructions
+
+* The `--topics` config option has been deprecated to unify the configuration style. It still available in this and will be in next release, but will be removed after that. The new option `--topic` is introduced, which can be use repeatedly to achieve the same behaviour.
+
+## 2023-03-15 v0.16.0
+
+## What's Changed
+
+Release highlights:
+- a fix for an issue that prevented the node from generating high-resolution (up to nanosecond) timestamps
+- introduction of an application-defined `meta` attribute to the Waku Message. This can be quite valuable for network-wide deduplication, deterministic hashing, validity checking and other planned improvements to the protocol
+- many optimizations in RLN implementation and its underlying dependencies
+
+### Features
+
+- Integrated a new group manager for RLN-protected relay [1496](https://github.com/waku-org/nwaku/pull/1496)
+- Added application-defined meta attribute to Waku Message according to RFC [14/WAKU2-MESSAGE](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/14/message.md#message-attributes) [1581](https://github.com/waku-org/nwaku/pull/1581)
+- Implemented deterministic hashing scheme for Waku Messages according to RFC [14/WAKU2-MESSAGE](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/14/message.md#deterministic-message-hashing) [1586](https://github.com/waku-org/nwaku/pull/1586)
+
+### Changes
+
+- Upgraded nim-sqlite3-abi to the latest version [1565](https://github.com/waku-org/nwaku/pull/1565)
+- Better validation of protocol buffers [1563](https://github.com/waku-org/nwaku/pull/1563)
+- Improved underlying Zerokit performance and FFI [1571](https://github.com/waku-org/nwaku/pull/1571)
+- Node peer ID now logged with relay trace logging [1574](https://github.com/waku-org/nwaku/pull/1574)
+- Continued refactoring of several protocol implementations to improve maintainability and readability
+- Refactored and cleaned up peer manager [1539](https://github.com/waku-org/nwaku/pull/1539)
+- Removed unused and legacy websocket submodule [1580](https://github.com/waku-org/nwaku/pull/1580) [1582](https://github.com/waku-org/nwaku/pull/1582)
+- Use base64 URL-safe encoding for noise [1569](https://github.com/waku-org/nwaku/pull/1569)
+- Various general improvements to RLN implementation [1585](https://github.com/waku-org/nwaku/pull/1585) [1587](https://github.com/waku-org/nwaku/pull/1587)
+- Started on implementation for new and improved filter protocol [1584](https://github.com/waku-org/nwaku/pull/1584)
+- Updated pubsub and content topic namespacing to reflect latest changes in RFC [23/WAKU2-TOPICS](https://github.com/vacp2p/rfc-index/blob/main/waku/informational/23/topics.md) [1589](https://github.com/waku-org/nwaku/pull/1589)
+- Unified internal peer data models [1597](https://github.com/waku-org/nwaku/pull/1597)
+- Improved internal implementation of Waku ENR encoding and decoding [1598](https://github.com/waku-org/nwaku/pull/1598) [1599](https://github.com/waku-org/nwaku/pull/1599)
+- Underlying dependency for RLN implementation now loaded as a static library [1578](https://github.com/waku-org/nwaku/pull/1578)
+
+### Fixes
+
+- Fixed internally generated timestamps to allow higher resolution than seconds [1570](https://github.com/waku-org/nwaku/pull/1570)
+- Fixed padded base64 usage for encoding and decoding payloads on the JSON RPC API [1572](https://github.com/waku-org/nwaku/pull/1572)
+- Fixed incorrect relative module imports [1591](https://github.com/waku-org/nwaku/pull/1591)
+- Fixed RLN relay erroneously storing messages from multiple apps [1594](https://github.com/waku-org/nwaku/pull/1594)
+
+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` |
+| [`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` |
+| [`18/WAKU2-SWAP`](https://github.com/vacp2p/rfc-index/blob/main/waku/deprecated/18/swap.md) | `draft` | `/vac/waku/swap/2.0.0-beta1` |
+| [`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` |
+
+The Waku v1 implementation is stable but not under active development.
+
+## 2023-02-15 v0.15.0
+
+Release highlights:
+- Relay connectivity is now maintained by a management loop that selects from the peerstore
+- Ability to manually specify `multiaddrs` for the nwaku node to advertise
+- Two important fixes related to historical message queries:
+ - fixed archive bug that resulted in duplicate messages in store query response
+ - fixed query page size limit not being respected
+
+### Features
+
+- New connectivity loop to maintain relay connectivity from peerstore [1482](https://github.com/waku-org/nwaku/pull/1482) [1462](https://github.com/waku-org/nwaku/pull/1462)
+- Support for manually specifying `multiaddrs` to advertise [1509](https://github.com/waku-org/nwaku/pull/1509) [1512](https://github.com/waku-org/nwaku/pull/1512)
+- Added dynamic keystore for membership credential storage and management [1466](https://github.com/waku-org/nwaku/pull/1466)
+
+### Changes
+
+- Abstracted RLN relay group management into its own API [1465](https://github.com/waku-org/nwaku/pull/1465)
+- Prune peers from peerstore when exceeding capacity [1513](https://github.com/waku-org/nwaku/pull/1513)
+- Removed Kilic submodule [1517](https://github.com/waku-org/nwaku/pull/1517)
+- Continued refactoring of several protocol implementations to improve maintainability and readability
+- Refactored and improved JSON RPC API
+- Added safe default values for peer-store-capacity [1525](https://github.com/waku-org/nwaku/pull/1525)
+- Improvements in regular CI test reliability and repeatability
+- Improved archive query performance [1510](https://github.com/waku-org/nwaku/pull/1510)
+- Added better e2e trace logging for relay messages [1526](https://github.com/waku-org/nwaku/pull/1526)
+- Relay RPC API now encodes message payloads in base64 [572](https://github.com/vacp2p/rfc/pull/572) [1555](https://github.com/waku-org/nwaku/pull/1555)
+
+### Fixes
+
+- Fixed Waku archive queries returning duplicate messages due to incorrect reordering [1511](https://github.com/waku-org/nwaku/pull/1511)
+- Fixed Admin RPC API crashing on returning peer with no multiaddresses [1507](https://github.com/waku-org/nwaku/pull/1507)
+- Fixed page size limit not being respected in store query responses [1520](https://github.com/waku-org/nwaku/pull/1520)
+- Fixed nwaku subscribing to default pubsub topic even if not configured [1548](https://github.com/waku-org/nwaku/pull/1548)
+- Fixed underlying issue causing node to incorrectly report it's unreachable [1518](https://github.com/waku-org/nwaku/pull/1518) [1546](https://github.com/waku-org/nwaku/pull/1546)
+- Fixed Relay RPC API not adhering to RFC [1139](https://github.com/waku-org/nwaku/issues/1139)
+- Fixed message IDs in nwaku diverging from those in go-waku [1556](https://github.com/waku-org/nwaku/pull/1556)
+
+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` |
+| [`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` |
+| [`18/WAKU2-SWAP`](https://github.com/vacp2p/rfc-index/blob/main/waku/deprecated/18/swap.md) | `draft` | `/vac/waku/swap/2.0.0-beta1` |
+| [`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` |
+
+The Waku v1 implementation is stable but not under active development.
+
+## 2023-01-16 v0.14.0
+
+Release highlights:
+- An important fix for the Waku message archive returning inconsistent responses to history queries.
+- Support for [AutoNAT](https://docs.libp2p.io/concepts/nat/autonat/) and [libp2p Circuit Relay](https://docs.libp2p.io/concepts/nat/circuit-relay/) that allows, among other things, for [NAT hole punching](https://docs.libp2p.io/concepts/nat/hole-punching/).
+- Support for structured logging in JSON format.
+- A fix for an underlying file descriptor leak that affected websocket connections.
+
+### Features
+
+- Support for [AutoNAT](https://docs.libp2p.io/concepts/nat/autonat/)
+- Support for [libp2p Circuit Relay](https://docs.libp2p.io/concepts/nat/circuit-relay/) (server only)
+- New Waku Archive implementation. This allows easy addition of drivers for different technologies to store historical messages.
+- Support for structured logging and specifying log format.
+- Node now keeps track of its external reachability.
+
+### Changes
+
+- Zerokit RLN library now statically linked.
+- Use extended key generation in Zerokit API to comply with [32/RLN](https://github.com/vacp2p/rfc-index/blob/main/vac/32/rln-v1.md).
+- Re-enable root validation in [`17/WAKU-RLN-RELAY`](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/17/rln-relay.md) implementation.
+- [Network monitoring tool](https://github.com/status-im/nwaku/tree/2336522d7f478337237a5a4ec8c5702fb4babc7d/tools#networkmonitor) now supports DNS discovery.
+- Added [dashboard](https://github.com/waku-org/nwaku/blob/3e0e1cb2398297fca761aa74f52d32fa837d556c/metrics/waku-network-monitor-dashboard.json) for network monitoring.
+- Continued refactoring of several protocol implementations to improve maintainability and readability.
+- Removed swap integration from store protocol.
+- Peerstore now consolidated with libp2p peerstore.
+- Peerstore now also tracks peer direction.
+- SIGSEGV signals are now handled and logged properly.
+- Waku v2 no longer imports libraries from Waku v1.
+- Improved build and CI processes:
+ - Added support for an `EXPERIMENTAL` compiler flag.
+ - Simplified project Makefile.
+ - Split Dockerfile into production and experimental stages.
+ - Removed obsolete simulation libraries from build.
+- Improved parallellisation (and therefore processing time) when dialing several peers simultaneously.
+- Waku Archive now responds with error to historical queries containing more than 10 content topics.
+
+### Fixes
+
+- Fixed support for optional fields in several protocol rpc codecs. [#1393](https://github.com/waku-org/nwaku/pull/1393) [#1395](https://github.com/waku-org/nwaku/pull/1395) [#1396](https://github.com/waku-org/nwaku/pull/1396)
+- Fixed clients with `--store=false` not installing Store Client JSON-RPC API handlers. [#1382](https://github.com/waku-org/nwaku/pull/1382)
+- Fixed SQLite driver returning inconsistent responses to store queries. [#1415](https://github.com/waku-org/nwaku/pull/1415)
+- Fixed peer exchange discv5 loop starting before discv5 has started. [#1407](https://github.com/waku-org/nwaku/pull/1407)
+- Fixed wakubridge test timing. [#1429](https://github.com/waku-org/nwaku/pull/1429)
+- Fixed bug in Noise module types equating `T_ss` incorrectly to `"se"` and not `"ss"`. [#1432](https://github.com/waku-org/nwaku/pull/1432)
+- Fixed Ctrl-C quitting resulting in unreleased resources and exit failures. [#1416](https://github.com/waku-org/nwaku/pull/1416)
+- Fixed CI workflows not cloning repo on startup. [#1454](https://github.com/waku-org/nwaku/pull/1454) [#1455](https://github.com/waku-org/nwaku/pull/1455)
+- Fixed Admin API peer connection not returning error response if peer can't be connected. [#1476](https://github.com/waku-org/nwaku/pull/1476)
+- Fixed underlying file descriptor leak. [#1483](https://github.com/waku-org/nwaku/pull/1483)
+
+### Docs
+
+- Added [instructions](https://github.com/waku-org/nwaku/blob/3e0e1cb2398297fca761aa74f52d32fa837d556c/docs/operators/quickstart.md) for running nwaku with docker compose.
+
+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` |
+| [`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` |
+| [`18/WAKU2-SWAP`](https://github.com/vacp2p/rfc-index/blob/main/waku/deprecated/18/swap.md) | `draft` | `/vac/waku/swap/2.0.0-beta1` |
+| [`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` |
+
+The Waku v1 implementation is stable but not under active development.
+
+## 2022-11-15 v0.13.0
+
+Release highlights:
+- A [Waku canary tool](https://github.com/status-im/nwaku/tree/2336522d7f478337237a5a4ec8c5702fb4babc7d/tools#waku-canary-tool) to check if nodes are reachable and what protocols they support.
+- Simplified configuration for store protocol. This [new guide](https://github.com/status-im/nwaku/blob/4e5318bfbb204bd1239c95472d7b84b6a326dd9d/docs/operators/how-to/configure-store.md) explains how to configure store from this release forward.
+- Support for environment variables to configure a nwaku node. See our [configuration guide](https://github.com/status-im/nwaku/blob/384abed614050bf3aa90c901d7f5e8bc383e8b22/docs/operators/how-to/configure.md) for more.
+- A Waku [network monitoring tool](https://github.com/status-im/nwaku/tree/2336522d7f478337237a5a4ec8c5702fb4babc7d/tools#networkmonitor) to report network metrics, including network size, discoverable peer capabilities and more.
+
+### Features
+
+- Added Waku canary tool to check if i) a given node is reachable and ii) it supports a set of protocols.
+- Simplified [Waku store configuration](https://github.com/status-im/nwaku/blob/4e5318bfbb204bd1239c95472d7b84b6a326dd9d/docs/operators/how-to/configure-store.md).
+- Decoupled Waku peer persistence configuration from message store configuration.
+- Added keyfile support for secure storage of RLN credentials.
+- Added configurable libp2p agent string to nwaku switch.
+- Support for [configuration with environment variables](https://github.com/status-im/nwaku/blob/384abed614050bf3aa90c901d7f5e8bc383e8b22/docs/operators/how-to/configure.md).
+- Added [example module](https://github.com/status-im/nwaku/tree/2336522d7f478337237a5a4ec8c5702fb4babc7d/examples/v2) to showcase basic nwaku relay usage.
+- Added a nwaku [network monitoring tool](https://github.com/status-im/nwaku/tree/2336522d7f478337237a5a4ec8c5702fb4babc7d/tools#networkmonitor) to provide metrics on peers, network size and more.
+
+### Changes
+
+- Removed support for Kilic's RLN library (obsolete).
+- Improved logging for [`17/WAKU-RLN-RELAY`](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/17/rln-relay.md) implementation.
+- Connection to eth node for RLN now more stable, maintains state and logs failures.
+- Waku apps and tools now moved to their own subdirectory.
+- Continued refactoring of several protocol implementations to improve maintainability and readability.
+- Periodically log metrics when running RLN spam protection.
+- Added metrics dashboard for RLN spam protection.
+- Github CI test workflows are now run selectively, based on the content of a PR.
+- Improved reliability of CI runs and added email notifications.
+- Discv5 discovery loop now triggered to fill a [34/WAKU2-PEER-EXCHANGE](https://github.com/waku-org/specs/blob/master/standards/core/peer-exchange.md) peer list cache asynchronously.
+- Upgraded to Nim v1.6.6.
+- Cleaned up compiler warnings on unused imports.
+- Improved exception handling and annotation.
+- [`13/WAKU2-STORE`](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/13/store.md) no longer enabled by default on nwaku nodes.
+- Merkle tree roots for RLN membership changes now on a per-block basis to allow poorly connected peers to operate within a window of acceptable roots.
+
+### Fixes
+
+- Fixed encoding of ID commitments for RLN from Big-Endian to Little-Endian. [#1256](https://github.com/status-im/nwaku/pull/1256)
+- Fixed maxEpochGap to be the maximum allowed epoch gap (RLN). [#1257](https://github.com/status-im/nwaku/pull/1257)
+- Fixed store cursors being retrieved incorrectly (truncated) from DB. [#1263](https://github.com/status-im/nwaku/pull/1263)
+- Fixed message indexed by store cursor being excluded from history query results. [#1263](https://github.com/status-im/nwaku/pull/1263)
+- Fixed log-level configuration being ignored by the nwaku node. [#1272](https://github.com/status-im/nwaku/pull/1272)
+- Fixed incorrect error message when failing to set [34/WAKU2-PEER-EXCHANGE](https://github.com/waku-org/specs/blob/master/standards/core/peer-exchange.md) peer. [#1298](https://github.com/status-im/nwaku/pull/1298)
+- Fixed and replaced deprecated `TaintedString` type. [#1326](https://github.com/status-im/nwaku/pull/1326)
+- Fixed and replaced unreliable regex library and usage. [#1327](https://github.com/status-im/nwaku/pull/1327) [#1328](https://github.com/status-im/nwaku/pull/1328)
+- Fixed and replaced deprecated `ganache-cli` node package with `ganache` for RLN onchain tests. Added graceful daemon termination. [#1347](https://github.com/status-im/nwaku/pull/1347)
+
+### Docs
+
+- Added cross client RLN testnet [tutorial](https://github.com/status-im/nwaku/blob/44d8a2026dc31a37e181043ceb67e2822376dc03/docs/tutorial/rln-chat-cross-client.md).
+- Fixed broken link to Kibana in [cluster documentation](https://github.com/status-im/nwaku/blob/5e90085242e9e4d6f3cf307e189efbf7e59da9f9/docs/contributors/cluster-logs.md).
+- Added an improved [quickstart guide](https://github.com/status-im/nwaku/blob/8f5363ea8f5e95fc1104307aa0d2fc59fda13698/docs/operators/quickstart.md) for operators.
+- Added a [Docker usage guide](https://github.com/status-im/nwaku/blob/8f5363ea8f5e95fc1104307aa0d2fc59fda13698/docs/operators/docker-quickstart.md#prerequisites) for operators.
+- Added operator [guide on running RLN spam prevention](https://github.com/status-im/nwaku/blob/bd516788cb39132ccbf0a4dcf0880e9694beb233/docs/operators/how-to/run-with-rln.md) on nwaku nodes.
+- Extended guidelines on nwaku [configuration methods](https://github.com/status-im/nwaku/blob/384abed614050bf3aa90c901d7f5e8bc383e8b22/docs/operators/how-to/configure.md) for operators.
+- Added new [store configuration guide](https://github.com/status-im/nwaku/blob/4e5318bfbb204bd1239c95472d7b84b6a326dd9d/docs/operators/how-to/configure-store.md) to reflect simplified options.
+
+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` |
+| [`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` |
+| [`18/WAKU2-SWAP`](https://github.com/vacp2p/rfc-index/blob/main/waku/deprecated/18/swap.md) | `draft` | `/vac/waku/swap/2.0.0-beta1` |
+| [`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` |
+
+The Waku v1 implementation is stable but not under active development.
+
+## 2022-10-06 v0.12.0
+
+Release highlights:
+- The performance and stability of the message `store` has improved dramatically. Query durations, even for long-term stores, have improved by more than a factor of 10.
+- Support for Waku Peer Exchange - a discovery method for resource-restricted nodes.
+- Messages can now be marked as "ephemeral" to prevent them from being stored.
+- [Zerokit](https://github.com/vacp2p/zerokit) is now the default implementation for spam-protected `relay` with RLN.
+
+The full list of changes is below.
+
+### Features
+
+- Default support for [Zerokit](https://github.com/vacp2p/zerokit) version of [`17/WAKU-RLN-RELAY`](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/17/rln-relay.md) implementation.
+- Added Filter REST API OpenAPI specification.
+- Added POC implementation for [43/WAKU2-DEVICE-PAIRING](https://github.com/waku-org/specs/blob/master/standards/application/device-pairing.md).
+- [14/WAKU2-MESSAGE](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/14/message.md) can now be marked as `ephemeral` to prevent them from being stored.
+- Support for [34/WAKU2-PEER-EXCHANGE](https://github.com/waku-org/specs/blob/master/standards/core/peer-exchange.md).
+
+### Changes
+
+- [`17/WAKU-RLN-RELAY`](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/17/rln-relay.md) implementation now handles on-chain transaction errors.
+- [`17/WAKU-RLN-RELAY`](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/17/rln-relay.md) implementation now validates the Merkle tree root against a window of acceptable roots.
+- Added metrics for [`17/WAKU-RLN-RELAY`](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/17/rln-relay.md) implementation.
+- Continued refactoring of several protocol implementations to improve maintainability and readability.
+- Cleaned up nwaku imports and dependencies.
+- Refactored and organised nwaku unit tests.
+- Nwaku now periodically logs node metrics by default.
+- Further improvements to the `store` implementation:
+ - Better logging and query traceability.
+ - More useful metrics to measure query and insertion time.
+ - Reworked indexing for faster inserts and queries.
+ - Reworked data model to use a simple, single timestamp for indexing, ordering and querying.
+ - Improved retention policy management with periodic execution.
+ - Run sqlite database vacuum at node start.
+ - Improved logging when migrating the database to a newer version.
+- `relay` no longer auto-mounted on all nwaku nodes.
+- The most complete node ENR now included in response to API requests for node `info()`.
+- Updated Grafana dashboards included with nwaku.
+- Github CI test execution now skipped for doc-only changes.
+
+### Fixes
+
+- Fixed nwaku unnecessary sleep when no dynamic bootstrap nodes retrieved.
+- Fixed [`12/WAKU2-FILTER`](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/12/filter.md) not working from browser-based clients due to nwaku peer manager failing to reuse existing connection.
+- Waku Message payload now correctly encoded as base64 in the Relay REST API.
+- Fixed handling of bindParam(uint32) in sqlite.
+- `chat2` application now correctly selects a random store node on startup.
+- Fixed macos builds failing due to an unsupported dependency.
+- Fixed nwaku not reconnecting to previously discovered nodes after losing connection.
+- Fixed nwaku failing to start switch transports with external IP configuration.
+- Fixed SIGSEGV crash when attempting to start nwaku store without `db-path` configuration.
+
+### Docs
+
+- Improved [RLN testnet tutorial](https://github.com/status-im/nwaku/blob/14abdef79677ddc828ff396ece321e05cedfca17/docs/tutorial/onchain-rln-relay-chat2.md)
+- Added [tutorial](https://github.com/status-im/nwaku/blob/14abdef79677ddc828ff396ece321e05cedfca17/docs/operators/droplet-quickstart.md) on running nwaku from a DigitalOcean droplet.
+- Added [guide](https://github.com/status-im/nwaku/blob/14abdef79677ddc828ff396ece321e05cedfca17/docs/operators/how-to/monitor.md) on how to monitor nwaku using Prometheus and Grafana.
+
+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` |
+| [`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` |
+| [`18/WAKU2-SWAP`](https://github.com/vacp2p/rfc-index/blob/main/waku/deprecated/18/swap.md) | `draft` | `/vac/waku/swap/2.0.0-beta1` |
+| [`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` |
+
+The Waku v1 implementation is stable but not under active development.
+
+## 2022-08-15 v0.11
+
+Release highlights:
+- Major improvements in the performance of historical message queries to longer-term, sqlite-only message stores.
+- Introduction of an HTTP REST API with basic functionality
+- On-chain RLN group management. This was also integrated into an [example spam-protected chat application](https://github.com/status-im/nwaku/blob/4f93510fc9a938954dd85593f8dc4135a1c367de/docs/tutorial/onchain-rln-relay-chat2.md).
+
+The full list of changes is below.
+
+### Features
+
+- Support for on-chain group membership management in the [`17/WAKU-RLN-RELAY`](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/17/rln-relay.md) implementation.
+- Integrated HTTP REST API for external access to some `wakunode2` functionality:
+ - Debug REST API exposes debug information about a `wakunode2`.
+ - Relay REST API allows basic pub/sub functionality according to [`11/WAKU2-RELAY`](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/11/relay.md).
+- [`35/WAKU2-NOISE`](https://github.com/waku-org/specs/blob/master/standards/application/noise.md) implementation now adds padding to ChaChaPoly encryptions to increase security and reduce metadata leakage.
+
+### Changes
+
+- Significantly improved the SQLite-only historical message `store` query performance.
+- Refactored several protocol implementations to improve maintainability and readability.
+- Major code reorganization for the [`13/WAKU2-STORE`](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/13/store.md) implementation to improve maintainability. This will also make the `store` extensible to support multiple implementations.
+- Disabled compiler log colors when running in a CI environment.
+- Refactored [`35/WAKU2-NOISE`](https://github.com/waku-org/specs/blob/master/standards/application/noise.md) implementation into smaller submodules.
+- [`11/WAKU2-RELAY`](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/11/relay.md) implementation can now optionally be compiled with [Zerokit RLN](https://github.com/vacp2p/zerokit/tree/64f508363946b15ac6c52f8b59d8a739a33313ec/rln). Previously only [Kilic's RLN](https://github.com/kilic/rln/tree/7ac74183f8b69b399e3bc96c1ae8ab61c026dc43) was supported.
+
+### Fixes
+
+- Fixed wire encoding of protocol buffers to use proto3.
+- Fixed Waku v1 <> Waku v2 bridge losing connection to statically configured v1 nodes.
+- Fixed underlying issue causing DNS discovery to fail for records containing multiple strings.
+
+### Docs
+
+- Updated [release process](https://github.com/status-im/nwaku/blob/4f93510fc9a938954dd85593f8dc4135a1c367de/docs/contributors/release-process.md) documentation.
+- Added [tutorial](https://github.com/status-im/nwaku/blob/4f93510fc9a938954dd85593f8dc4135a1c367de/docs/tutorial/onchain-rln-relay-chat2.md) on how to run a spam-protected chat2 application with on-chain group management.
+
+
+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` |
+| [`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` |
+| [`18/WAKU2-SWAP`](https://github.com/vacp2p/rfc-index/blob/main/waku/deprecated/18/swap.md) | `draft` | `/vac/waku/swap/2.0.0-beta1` |
+| [`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` |
+
+The Waku v1 implementation is stable but not under active development.
+
+## 2022-06-15 v0.10
+
+Release highlights:
+- Support for key exchange using Noise handshakes.
+- Support for a SQLite-only historical message `store`. This allows for cheaper, longer-term historical message storage on disk rather than in memory.
+- Several fixes for native WebSockets, including slow or hanging connections and connections dropping unexpectedly due to timeouts.
+- A fix for a memory leak in nodes running a local SQLite database.
+
+### Features
+
+- Support for [`35/WAKU2-NOISE`](https://github.com/waku-org/specs/blob/master/standards/application/noise.md) handshakes as key exchange protocols.
+- Support for TOML config files via `--config-file=`.
+- Support for `--version` command. This prints the current tagged version (or compiled commit hash, if not on a version).
+- Support for running `store` protocol from a `filter` client, storing only the filtered messages.
+- Start of an HTTP REST API implementation.
+- Support for a memory-efficient SQLite-only `store` configuration.
+
+### Changes
+
+- Added index on `receiverTimestamp` in the SQLite `store` to improve query performance.
+- 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.
+- Progress towards dynamic group management for the [`17/WAKU-RLN-RELAY`](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/17/rln-relay.md) implementation.
+- Nodes with `--keep-alive` enabled now sends more regular pings to keep connections more reliably alive.
+- Disabled `swap` protocol by default.
+- Reduced unnecessary and confusing logging, especially during startup.
+- Added discv5 UDP port to the node's main discoverable ENR.
+
+### Fixes
+
+- The in-memory `store` now checks the validity of message timestamps before storing.
+- Fixed underlying bug that caused connection leaks in the HTTP client.
+- Fixed Docker image compilation to use the correct external variable for compile-time flags (`NIMFLAGS` instead of `NIM_PARAMS`).
+- Fixed issue where `--dns4-domain-name` caused an unhandled exception if no external port was available.
+- 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.
+- Fixed underlying issues that caused WebSocket connections to hang.
+- Fixed underlying issue that caused WebSocket connections to time out after 10 mins.
+- Fixed memory leak in nodes that implements a SQLite database.
+
+### Docs
+
+- 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.
+- Added first [guide](https://github.com/status-im/nwaku/tree/16dd267bd9d25ff24c64fc5c92a20eb0d322217c/docs/operators) for nwaku operators.
+
+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` |
+| [`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` |
+| [`18/WAKU2-SWAP`](https://github.com/vacp2p/rfc-index/blob/main/waku/deprecated/18/swap.md) | `draft` | `/vac/waku/swap/2.0.0-beta1` |
+| [`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` |
+
+The Waku v1 implementation is stable but not under active development.
+
+## 2022-03-31 v0.9
+
+Release highlights:
+
+- Support for Peer Exchange (PX) when a peer prunes a [`11/WAKU2-RELAY`](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/11/relay.md) mesh due to oversubscription. This can significantly increase mesh stability.
+- Improved start-up times through managing the size of the underlying persistent message storage.
+- New websocket connections are no longer blocked due to parsing failures in other connections.
+
+The full list of changes is below.
+
+### Features
+
+- Support for bootstrapping [`33/WAKU-DISCV5`](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/33/discv5.md) via [DNS discovery](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/10/waku2.md#discovery-methods)
+- Support for GossipSub [Peer Exchange](https://github.com/libp2p/specs/blob/master/pubsub/gossipsub/gossipsub-v1.1.md#prune-backoff-and-peer-exchange)
+
+### Changes
+
+- Waku v1 <> v2 bridge now supports DNS `multiaddrs`
+- Waku v1 <> v2 bridge now validates content topics before attempting to bridge a message from Waku v2 to Waku v1
+- Persistent message storage now auto deletes messages once over specified `--store-capacity`. This can significantly improve node start-up times.
+- Renamed Waku v1 <> v2 bridge `make` target and binary to `wakubridge`
+- Increased `store` logging to assist with debugging
+- Increased `rln-relay` logging to assist with debugging
+- Message metrics no longer include the content topic as a dimension to keep Prometheus metric cardinality under control
+- Waku v2 `toy-chat` application now sets the sender timestamp when creating messages
+- The type of the `proof` field of the `WakuMessage` is changed to `RateLimitProof`
+- Added method to the JSON-RPC API that returns the git tag and commit hash of the binary
+- The node's ENR is now included in the JSON-RPC API response when requesting node info
+
+### Fixes
+
+- Fixed incorrect conversion of seconds to nanosecond timestamps
+- Fixed store queries blocking due to failure in resource clean up
+- Fixed underlying issue where new websocket connections are blocked due to parsing failures in other connections
+- Fixed failure to log the ENR necessary for a discv5 connection to the node
+
+### Docs
+
+- Added [RAM requirements](https://github.com/status-im/nim-waku/tree/ee96705c7fbe4063b780ac43b7edee2f6c4e351b/waku/v2#wakunode) to `wakunode2` build instructions
+- Added [tutorial](https://github.com/status-im/nim-waku/blob/ee96705c7fbe4063b780ac43b7edee2f6c4e351b/docs/tutorial/rln-chat2-live-testnet.md) on communicating with waku2 test fleets via the chat2 `toy-chat` application in spam-protected mode using [`17/WAKU-RLN-RELAY`](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/17/rln-relay.md).
+- Added a [section on bug reporting](https://github.com/status-im/nim-waku/blob/ee96705c7fbe4063b780ac43b7edee2f6c4e351b/README.md#bugs-questions--features) to `wakunode2` README
+- Fixed broken links in the [JSON-RPC API Tutorial](https://github.com/status-im/nim-waku/blob/5ceef37e15a15c52cbc589f0b366018e81a958ef/docs/tutorial/jsonrpc-api.md)
+
+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` |
+| [`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` |
+| [`18/WAKU2-SWAP`](https://github.com/vacp2p/rfc-index/blob/main/waku/deprecated/18/swap.md) | `draft` | `/vac/waku/swap/2.0.0-beta1` |
+| [`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` |
+
+The Waku v1 implementation is stable but not under active development.
+
+## 2022-03-03 v0.8
+
+Release highlights:
+
+- Working demonstration and integration of [`17/WAKU-RLN-RELAY`](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/17/rln-relay.md) in the Waku v2 `toy-chat` application
+- Beta support for ambient peer discovery using [a version of Discovery v5](https://github.com/vacp2p/rfc/pull/487)
+- A fix for the issue that caused a `store` node to run out of memory after serving a number of historical queries
+- Ability to configure a `dns4` domain name for a node and resolve other dns-based `multiaddrs`
+
+The full list of changes is below.
+
+### Features
+
+- [`17/WAKU-RLN-RELAY`](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/17/rln-relay.md) implementation now supports spam-protection for a specific combination of `pubsubTopic` and `contentTopic` (available under the `rln` compiler flag).
+- [`17/WAKU-RLN-RELAY`](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/17/rln-relay.md) integrated into chat2 `toy-chat` (available under the `rln` compiler flag)
+- Added support for resolving dns-based `multiaddrs`
+- A Waku v2 node can now be configured with a domain name and `dns4` `multiaddr`
+- Support for ambient peer discovery using [`33/WAKU-DISCV5`](https://github.com/vacp2p/rfc/pull/487)
+
+### Changes
+
+- Metrics: now monitoring content topics and the sources of new connections
+- Metrics: improved default fleet monitoring dashboard
+- Introduced a `Timestamp` type (currently an alias for int64).
+- All timestamps changed to nanosecond resolution.
+- `timestamp` field number in WakuMessage object changed from `4` to `10`
+- [`13/WAKU2-STORE`](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/13/store.md) identifier updated to `/vac/waku/store/2.0.0-beta4`
+- `toy-chat` application now uses DNS discovery to connect to existing fleets
+
+### Fixes
+
+- Fixed underlying bug that caused occasional failures when reading the certificate for secure websockets
+- Fixed `store` memory usage issues when responding to history queries
+
+### Docs
+
+- Documented [use of domain certificates](https://github.com/status-im/nim-waku/tree/2972a5003568848164033da3fe0d7f52a3d54824/waku/v2#enabling-websocket) for secure websockets
+- Documented [how to configure a `dns4` domain name](https://github.com/status-im/nim-waku/tree/2972a5003568848164033da3fe0d7f52a3d54824/waku/v2#using-dns-discovery-to-connect-to-existing-nodes) for a node
+- Clarified [use of DNS discovery](https://github.com/status-im/nim-waku/tree/2972a5003568848164033da3fe0d7f52a3d54824/waku/v2#using-dns-discovery-to-connect-to-existing-nodes) and provided current URLs for discoverable fleet nodes
+- Added [tutorial](https://github.com/status-im/nim-waku/blob/2972a5003568848164033da3fe0d7f52a3d54824/docs/tutorial/rln-chat2-local-test.md) on using [`17/WAKU-RLN-RELAY`](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/17/rln-relay.md) with the chat2 `toy-chat` application
+- Added [tutorial](https://github.com/status-im/nim-waku/blob/2972a5003568848164033da3fe0d7f52a3d54824/docs/tutorial/bridge.md) on how to configure and a use a [`15/WAKU-BRIDGE`](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/15/bridge.md)
+
+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` |
+| [`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` |
+| [`18/WAKU2-SWAP`](https://github.com/vacp2p/rfc-index/blob/main/waku/deprecated/18/swap.md) | `draft` | `/vac/waku/swap/2.0.0-beta1` |
+| [`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` |
+
+The Waku v1 implementation is stable but not under active development.
+
+## 2022-01-19 v0.7
+
+Release highlights:
+
+- Support for secure websockets.
+- Ability to remove unreachable clients in a `filter` node.
+- Several fixes to improve `store` performance and decrease query times. Query time for large stores decreased from longer than 8 min to under 100 ms.
+- Fix for a long-standing bug that prevented proper database migration in some deployed Docker containers.
+
+The full list of changes is below.
+
+### Features
+
+- Support for secure websocket transport
+
+### Changes
+
+- Filter nodes can now remove unreachable clients
+- The WakuInfo `listenStr` is deprecated and replaced with a sequence of `listenAddresses` to accommodate multiple transports
+- Removed cached `peerInfo` on local node. Rely on underlying libp2p switch instead
+- Metrics: added counters for protocol messages
+- Waku v2 node discovery now supports [`31/WAKU2-ENR`](https://github.com/waku-org/specs/blob/master/standards/core/enr.md)
+- resuming the history via `resume` now takes the answers of all peers in `peerList` into consideration and consolidates them into one deduplicated list
+
+### Fixes
+
+- Fixed database migration failure in the Docker image
+- All `HistoryResponse` messages are now auto-paginated to a maximum of 100 messages per response
+- Increased maximum length for reading from a libp2p input stream to allow largest possible protocol messages, including `HistoryResponse` messages at max size
+- Significantly improved `store` node query performance
+- Implemented a GossipSub `MessageIdProvider` for `11/WAKU2-RELAY` messages instead of relying on the unstable default
+- Receiver timestamps for message indexing in the `store` now have consistent millisecond resolution
+
+This release supports the following [libp2p protocols](https://docs.libp2p.io/concepts/protocols/):
+| Protocol | Spec status | Protocol id |
+| ---: | :---: | :--- |
+| [`17/WAKU-RLN-RELAY`](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/17/rln-relay.md) | `raw` | `/vac/waku/waku-rln-relay/2.0.0-alpha1` |
+| [`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` |
+| [`13/WAKU2-STORE`](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/13/store.md) | `draft` | `/vac/waku/store/2.0.0-beta3` |
+| [`18/WAKU2-SWAP`](https://github.com/vacp2p/rfc-index/blob/main/waku/deprecated/18/swap.md) | `draft` | `/vac/waku/swap/2.0.0-beta1` |
+| [`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` |
+
+The Waku v1 implementation is stable but not under active development.
+
+## 2021-11-05 v0.6
+
+Some useful features and fixes in this release, include:
+- two methods for Waku v2 node discovery
+- support for unsecure websockets, which paves the way for native browser usage
+- a fix for `nim-waku` store nodes running out of memory due to store size: the number of stored messages can now easily be configured
+- a fix for densely connected nodes refusing new connections: the maximum number of allowed connections can now easily be configured
+- support for larger message sizes (up from 64kb to 1Mb per message)
+
+The full list of changes is below.
+
+### Features
+
+- Waku v2 node discovery via DNS following [EIP-1459](https://eips.ethereum.org/EIPS/eip-1459)
+- Waku v2 node discovery via [Node Discovery v5](https://github.com/ethereum/devp2p/blob/master/discv5/discv5-theory.md)
+
+### Changes
+
+- Pagination of historical queries are now simplified
+- GossipSub [prune backoff period](https://github.com/libp2p/specs/blob/master/pubsub/gossipsub/gossipsub-v1.1.md#prune-backoff-and-peer-exchange) is now the recommended 1 minute
+- Bridge now uses content topic format according to [23/WAKU2-TOPICS](https://github.com/vacp2p/rfc-index/blob/main/waku/informational/23/topics.md)
+- Better internal differentiation between local and remote peer info
+- Maximum number of libp2p connections is now configurable
+- `udp-port` CLI option has been removed for binaries where it's not used
+- Waku v2 now supports unsecure WebSockets
+- Waku v2 now supports larger message sizes of up to 1 Mb by default
+- Further experimental development of [RLN for spam protection](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/17/rln-relay.md).
+These changes are disabled by default under a compiler flag. Changes include:
+ - Per-message rate limit proof defined
+ - RLN proof generation and verification integrated into Waku v2
+ - RLN tree depth changed from 32 to 20
+ - Support added for static membership group formation
+
+#### Docs
+
+- Added [contributor guidelines](https://github.com/status-im/nim-waku/blob/master/docs/contributors/waku-fleets.md) on Waku v2 fleet monitoring and management
+- Added [basic tutorial](https://github.com/status-im/nim-waku/blob/master/docs/tutorial/dns-disc.md) on using Waku v2 DNS-based discovery
+
+### Fixes
+
+- Bridge between `toy-chat` and matterbridge now shows correct announced addresses
+- Bridge no longer re-encodes already encoded payloads when publishing to V1
+- Bridge now populates WakuMessage timestamps when publishing to V2
+- Store now has a configurable maximum number of stored messages
+- Network simulations for Waku v1 and Waku v2 are runnable again
+
+This release supports the following [libp2p protocols](https://docs.libp2p.io/concepts/protocols/):
+| Protocol | Spec status | Protocol id |
+| ---: | :---: | :--- |
+| [`17/WAKU-RLN`](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/17/rln-relay.md) | `raw` | `/vac/waku/waku-rln-relay/2.0.0-alpha1` |
+| [`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` |
+| [`13/WAKU2-STORE`](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/13/store.md) | `draft` | `/vac/waku/store/2.0.0-beta3` |
+| [`18/WAKU2-SWAP`](https://github.com/vacp2p/rfc-index/blob/main/waku/deprecated/18/swap.md) | `draft` | `/vac/waku/swap/2.0.0-beta1` |
+| [`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` |
+
+The Waku v1 implementation is stable but not under active development.
+
+## 2021-07-26 v0.5.1
+
+This patch release contains the following fix:
+- Support for multiple protocol IDs when reconnecting to previously connected peers:
+A bug in `v0.5` caused clients using persistent peer storage to only support the mounted protocol ID.
+
+This is a patch release that is fully backwards-compatible with release `v0.5`.
+It supports the same [libp2p protocols](https://docs.libp2p.io/concepts/protocols/):
+| Protocol | Spec status | Protocol id |
+| ---: | :---: | :--- |
+| [`17/WAKU-RLN`](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/17/rln-relay.md) | `raw` | `/vac/waku/waku-rln-relay/2.0.0-alpha1` |
+| [`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` |
+| [`13/WAKU2-STORE`](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/13/store.md) | `draft` | `/vac/waku/store/2.0.0-beta3` |
+| [`18/WAKU2-SWAP`](https://github.com/vacp2p/rfc-index/blob/main/waku/deprecated/18/swap.md) | `draft` | `/vac/waku/swap/2.0.0-beta1` |
+| [`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` |
+
+The Waku v1 implementation is stable but not under active development.
+
+## 2021-07-23 v0.5
+
+This release contains the following:
+
+### Features
+- Support for keep-alives using [libp2p ping protocol](https://docs.libp2p.io/concepts/protocols/#ping).
+- DB migration for the message and peer stores.
+- Support for multiple protocol IDs. Mounted protocols now match versions of the same protocol that adds a postfix to the stable protocol ID.
+
+### Changes
+- Bridge topics are now configurable.
+- The `resume` Nim API now eliminates duplicates messages before storing them.
+- The `resume` Nim API now fetches historical messages in page sequence.
+- Added support for stable version of `relay` protocol, with protocol ID `/vac/waku/relay/2.0.0`.
+- Added optional `timestamp` to `WakuRelayMessage`.
+- Removed `PCRE` as a prerequisite for building Waku v1 and Waku v2.
+- Improved [`swap`](https://github.com/vacp2p/rfc-index/blob/main/waku/deprecated/18/swap.md) metrics.
+
+#### General refactoring
+- Refactored modules according to [Nim best practices](https://hackmd.io/1imOGULZRsed2HpgmzGleA).
+- Simplified the [way protocols get notified](https://github.com/status-im/nim-waku/issues/574) of new messages.
+- Refactored `wakunode2` setup into 6 distinct phases with improved logging and error handling.
+- Moved `Whisper` types and protocol from the `nim-eth` module to `nim-waku`.
+
+#### Docs
+- Added [database migration tutorial](https://github.com/status-im/nim-waku/blob/master/docs/tutorial/db-migration.md).
+- Added [tutorial to setup `websockify`](https://github.com/status-im/nim-waku/blob/master/docs/tutorial/websocket.md).
+
+#### Schema
+- Updated the `Message` table of the persistent message store:
+ - Added `senderTimestamp` column.
+ - Renamed the `timestamp` column to `receiverTimestamp` and changes its type to `REAL`.
+
+#### API
+- Added optional `timestamp` to [`WakuRelayMessage`](https://github.com/vacp2p/rfc-index/blob/main/waku/deprecated/16/rpc.md) on JSON-RPC API.
+
+### Fixes
+- Conversion between topics for the Waku v1 <-> v2 bridge now follows the [RFC recommendation](https://github.com/vacp2p/rfc-index/blob/main/waku/informational/23/topics.md).
+- Fixed field order of `HistoryResponse` protobuf message: the field numbers of the `HistoryResponse` are shifted up by one to match up the [13/WAKU2-STORE](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/13/store.md) specs.
+
+This release supports the following [libp2p protocols](https://docs.libp2p.io/concepts/protocols/):
+| Protocol | Spec status | Protocol id |
+| ---: | :---: | :--- |
+| [`17/WAKU-RLN`](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/17/rln-relay.md) | `raw` | `/vac/waku/waku-rln-relay/2.0.0-alpha1` |
+| [`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` |
+| [`13/WAKU2-STORE`](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/13/store.md) | `draft` | `/vac/waku/store/2.0.0-beta3` |
+| [`18/WAKU2-SWAP`](https://github.com/vacp2p/rfc-index/blob/main/waku/deprecated/18/swap.md) | `draft` | `/vac/waku/swap/2.0.0-beta1` |
+| [`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` |
+
+The Waku v1 implementation is stable but not under active development.
+
+## 2021-06-03 v0.4
+
+This release contains the following:
+
+### Features
+
+- Initial [`toy-chat` implementation](https://github.com/vacp2p/rfc-index/blob/main/waku/informational/22/toy-chat.md)
+
+### Changes
+
+- The [toy-chat application](https://github.com/status-im/nim-waku/blob/master/docs/tutorial/chat2.md) can now perform `lightpush` and request content-filtered messages from remote peers.
+- The [toy-chat application](https://github.com/status-im/nim-waku/blob/master/docs/tutorial/chat2.md) now uses default content topic `/toy-chat/2/huilong/proto`
+- Improve `toy-chat` [briding to matterbridge]((https://github.com/status-im/nim-waku/blob/master/docs/tutorial/chat2.md#bridge-messages-between-chat2-and-matterbridge))
+- Improve [`swap`](https://github.com/vacp2p/rfc-index/blob/main/waku/deprecated/18/swap.md) logging and enable soft mode by default
+- Content topics are no longer in a redundant nested structure
+- Improve error handling
+
+#### API
+
+- [JSON-RPC Store API](https://github.com/vacp2p/rfc-index/blob/main/waku/deprecated/16/rpc.md): Added an optional time-based query to filter historical messages.
+- [Nim API](https://github.com/status-im/nim-waku/blob/master/docs/api/v2/node.md): Added `resume` method.
+
+### Fixes
+
+- Connections between nodes no longer become unstable due to keep-alive errors if mesh grows large
+- Re-enable `lightpush` tests and fix Windows CI failure
+
+The [Waku v2 suite of protocols](https://github.com/waku-org/specs) are still in a raw/draft state.
+This release supports the following [libp2p protocols](https://docs.libp2p.io/concepts/protocols/):
+| Protocol | Spec status | Protocol id |
+| ---: | :---: | :--- |
+| [`17/WAKU-RLN`](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/17/rln-relay.md) | `raw` | `/vac/waku/waku-rln-relay/2.0.0-alpha1` |
+| [`11/WAKU2-RELAY`](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/11/relay.md) | `draft` | `/vac/waku/relay/2.0.0-beta2` |
+| [`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` |
+| [`13/WAKU2-STORE`](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/13/store.md) | `draft` | `/vac/waku/store/2.0.0-beta3` |
+| [`18/WAKU2-SWAP`](https://github.com/vacp2p/rfc-index/blob/main/waku/deprecated/18/swap.md) | `draft` | `/vac/waku/swap/2.0.0-beta1` |
+| [`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` |
+
+The Waku v1 implementation is stable but not under active development.
+
+## 2021-05-11 v0.3
+
+This release contains the following:
+
+### Features
+
+- Start of [`RLN relay` implementation](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/17/rln-relay.md)
+- Start of [`swap` implementation](https://github.com/vacp2p/rfc-index/blob/main/waku/deprecated/18/swap.md)
+- Start of [fault-tolerant `store` implementation](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/application/21/fault-tolerant-store.md)
+- Initial [`bridge` implementation](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/15/bridge.md) between Waku v1 and v2 protocols
+- Initial [`lightpush` implementation](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/19/lightpush.md)
+- A peer manager for `relay`, `filter`, `store` and `swap` peers
+- Persistent storage for peers: A node with this feature enabled will now attempt to reconnect to `relay` peers after a restart. It will respect the gossipsub [PRUNE backoff](https://github.com/libp2p/specs/blob/master/pubsub/gossipsub/gossipsub-v1.1.md#prune-backoff-and-peer-exchange) period before attempting to do so.
+- `--persist-peers` CLI option to persist peers in local storage
+- `--persist-messages` CLI option to store historical messages locally
+- `--keep-alive` CLI option to maintain a stable connection to `relay` peers on idle topics
+- A CLI chat application ([`chat2`](https://github.com/status-im/nim-waku/blob/master/docs/tutorial/chat2.md)) over Waku v2 with [bridging to matterbridge](https://github.com/status-im/nim-waku/blob/master/docs/tutorial/chat2.md#bridge-messages-between-chat2-and-matterbridge)
+
+### Changes
+- Enable `swap` protocol by default and improve logging
+#### General refactoring
+
+- Split out `waku_types` types into the right place; create `utils` folder.
+- Change type of `contentTopic` in [`ContentFilter`](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/12/filter.md#protobuf) to `string`.
+- Replace sequence of `contentTopics` in [`ContentFilter`](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/12/filter.md#protobuf) with a single `contentTopic`.
+- Add `timestamp` field to [`WakuMessage`](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/14/message.md#payloads).
+- Ensure CLI config parameters use a consistent naming scheme. Summary of changes [here](https://github.com/status-im/nim-waku/pull/543).
+
+#### Docs
+
+Several clarifications and additions aimed at contributors, including
+ - information on [how to query Status test fleet](https://github.com/status-im/nim-waku/blob/master/docs/faq.md) for node addresses,
+ - [how to view logs](https://github.com/status-im/nim-waku/blob/master/docs/contributors/cluster-logs.md), and
+ - [how to update submodules](https://github.com/status-im/nim-waku/blob/master/docs/contributors/git-submodules.md).
+
+#### Schema
+
+- Add `Message` table to the persistent message store. This table replaces the old `messages` table. It has two additional columns, namely
+ - `pubsubTopic`, and
+ - `version`.
+- Add `Peer` table for persistent peer storage.
+
+#### API
+
+- [JSON-RPC Admin API](https://github.com/vacp2p/rfc-index/blob/main/waku/deprecated/16/rpc.md): Added a [`post` method](https://github.com/vacp2p/rfc-index/blob/main/waku/deprecated/16/rpc.md#post_waku_v2_admin_v1_peers) to connect to peers on an ad-hoc basis.
+- [Nim API](https://github.com/status-im/nim-waku/blob/master/docs/api/v2/node.md): PubSub topic `subscribe` and `unsubscribe` no longer returns a future (removed `async` designation).
+- [`HistoryQuery`](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/13/store.md#historyquery): Added `pubsubTopic` field. Message history can now be filtered and queried based on the `pubsubTopic`.
+- [`HistoryQuery`](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/13/store.md#historyquery): Added support for querying a time window by specifying start and end times.
+
+### Fixes
+
+- Running nodes can now be shut down gracefully
+- Content filtering now works on any PubSub topic and not just the `waku` default.
+- Nodes can now mount protocols without supporting `relay` as a capability
+
+The [Waku v2 suite of protocols](https://github.com/waku-org/specs) are still in a raw/draft state.
+This release supports the following [libp2p protocols](https://docs.libp2p.io/concepts/protocols/):
+| Protocol | Spec status | Protocol id |
+| ---: | :---: | :--- |
+| [`17/WAKU-RLN`](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/17/rln-relay.md) | `raw` | `/vac/waku/waku-rln-relay/2.0.0-alpha1` |
+| [`18/WAKU2-SWAP`](https://github.com/vacp2p/rfc-index/blob/main/waku/deprecated/18/swap.md) | `raw` | `/vac/waku/swap/2.0.0-alpha1` |
+| [`19/WAKU2-LIGHTPUSH`](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/19/lightpush.md) | `raw` | `/vac/waku/lightpush/2.0.0-alpha1` |
+| [`11/WAKU2-RELAY`](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/11/relay.md) | `draft` | `/vac/waku/relay/2.0.0-beta2` |
+| [`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` |
+| [`13/WAKU2-STORE`](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/13/store.md) | `draft` | `/vac/waku/store/2.0.0-beta3` |
+
+The Waku v1 implementation is stable but not under active development.
+
+## 2021-01-05 v0.2
+
+This release contains the following changes:
+
+- Calls to `publish` a message on `wakunode2` now `await` instead of `discard` dispatched [`WakuRelay`](https://github.com/vacp2p/specs/blob/master/specs/waku/v2/waku-relay.md) procedures.
+- [`StrictNoSign`](https://github.com/libp2p/specs/tree/master/pubsub#message-signing) enabled.
+- Add JSON-RPC API for external access to `wakunode2` functionality:
+ - Admin API retrieves information about peers registered on the `wakunode2`.
+ - Debug API exposes debug information about a `wakunode2`.
+ - Filter API saves bandwidth by allowing light nodes to filter for specific content.
+ - Private API enables symmetric or asymmetric cryptography to encrypt/decrypt message payloads.
+ - Relay API allows basic pub/sub functionality.
+ - Store API retrieves historical messages.
+- Add tutorial on how to use JSON-RPC API.
+- Refactor: Move `waku_filter` protocol into its own module.
+
+The Waku v2 implementation, and [most protocols it consist of](https://specs.vac.dev/specs/waku/),
+are still in a draft/beta state. The Waku v1 implementation is stable but not under active development.
+
+## 2020-11-30 v0.1
+
+Initial beta release.
+
+This release contains:
+
+- A Nim implementation of the [Waku v1 protocol](https://specs.vac.dev/waku/waku.html).
+- A Nim implementation of the [Waku v2 protocol](https://specs.vac.dev/specs/waku/v2/waku-v2.html).
+- CLI applications `wakunode` and `wakunode2` that allows you to run a Waku v1 or v2 node.
+- Examples of Waku v1 and v2 usage.
+- Various tests of above.
+
+Currenty the Waku v2 implementation, and [most protocols it consist of](https://specs.vac.dev/specs/waku/),
+are in a draft/beta state. The Waku v1 implementation is stable but not under active development.
+
+Feedback welcome!
diff --git a/third-party/nwaku/Dockerfile b/third-party/nwaku/Dockerfile
new file mode 100644
index 0000000..6afb2bc
--- /dev/null
+++ b/third-party/nwaku/Dockerfile
@@ -0,0 +1,93 @@
+# BUILD NIM APP ----------------------------------------------------------------
+FROM rust:1.81.0-alpine3.19 AS nim-build
+
+ARG NIMFLAGS
+ARG MAKE_TARGET=wakunode2
+ARG NIM_COMMIT
+ARG LOG_LEVEL=TRACE
+ARG HEAPTRACK_BUILD=0
+
+# Get build tools and required header files
+RUN apk add --no-cache bash git build-base openssl-dev linux-headers curl jq
+
+WORKDIR /app
+COPY . .
+
+# workaround for alpine issue: https://github.com/alpinelinux/docker-alpine/issues/383
+RUN apk update && apk upgrade
+
+# Ran separately from 'make' to avoid re-doing
+RUN git submodule update --init --recursive
+
+RUN if [ "$HEAPTRACK_BUILD" = "1" ]; then \
+ git apply --directory=vendor/nimbus-build-system/vendor/Nim docs/tutorial/nim.2.2.4_heaptracker_addon.patch; \
+ fi
+
+# Slowest build step for the sake of caching layers
+RUN make -j$(nproc) deps QUICK_AND_DIRTY_COMPILER=1 ${NIM_COMMIT}
+
+# Build the final node binary
+RUN make -j$(nproc) ${NIM_COMMIT} $MAKE_TARGET LOG_LEVEL=${LOG_LEVEL} NIMFLAGS="${NIMFLAGS}"
+
+
+# PRODUCTION IMAGE -------------------------------------------------------------
+
+FROM alpine:3.18 AS prod
+
+ARG MAKE_TARGET=wakunode2
+
+LABEL maintainer="jakub@status.im"
+LABEL source="https://github.com/waku-org/nwaku"
+LABEL description="Wakunode: Waku client"
+LABEL commit="unknown"
+LABEL version="unknown"
+
+# DevP2P, LibP2P, and JSON RPC ports
+EXPOSE 30303 60000 8545
+
+# Referenced in the binary
+RUN apk add --no-cache libgcc libpq-dev bind-tools
+
+# Copy to separate location to accomodate different MAKE_TARGET values
+COPY --from=nim-build /app/build/$MAKE_TARGET /usr/local/bin/
+
+# Copy migration scripts for DB upgrades
+COPY --from=nim-build /app/migrations/ /app/migrations/
+
+# Symlink the correct wakunode binary
+RUN ln -sv /usr/local/bin/$MAKE_TARGET /usr/bin/wakunode
+
+ENTRYPOINT ["/usr/bin/wakunode"]
+
+# By default just show help if called without arguments
+CMD ["--help"]
+
+
+# DEBUG IMAGE ------------------------------------------------------------------
+
+# Build debug tools: heaptrack
+FROM alpine:3.18 AS heaptrack-build
+
+RUN apk update
+RUN apk add -- gdb git g++ make cmake zlib-dev boost-dev libunwind-dev
+RUN git clone https://github.com/KDE/heaptrack.git /heaptrack
+
+WORKDIR /heaptrack/build
+# going to a commit that builds properly. We will revisit this for new releases
+RUN git reset --hard f9cc35ebbdde92a292fe3870fe011ad2874da0ca
+RUN cmake -DCMAKE_BUILD_TYPE=Release ..
+RUN make -j$(nproc)
+
+
+# Debug image
+FROM prod AS debug-with-heaptrack
+
+RUN apk add --no-cache gdb libunwind
+
+# Add heaptrack
+COPY --from=heaptrack-build /heaptrack/build/ /heaptrack/build/
+
+ENV LD_LIBRARY_PATH=/heaptrack/build/lib/heaptrack/
+RUN ln -s /heaptrack/build/bin/heaptrack /usr/local/bin/heaptrack
+
+ENTRYPOINT ["/heaptrack/build/bin/heaptrack", "/usr/bin/wakunode"]
diff --git a/third-party/nwaku/Dockerfile.lightpushWithMix.compile b/third-party/nwaku/Dockerfile.lightpushWithMix.compile
new file mode 100644
index 0000000..e39b88d
--- /dev/null
+++ b/third-party/nwaku/Dockerfile.lightpushWithMix.compile
@@ -0,0 +1,58 @@
+# BUILD NIM APP ----------------------------------------------------------------
+FROM rust:1.81.0-alpine3.19 AS nim-build
+
+ARG NIMFLAGS
+ARG MAKE_TARGET=lightpushwithmix
+ARG NIM_COMMIT
+ARG LOG_LEVEL=TRACE
+
+# Get build tools and required header files
+RUN apk add --no-cache bash git build-base openssl-dev pcre-dev linux-headers curl jq
+
+WORKDIR /app
+COPY . .
+
+# workaround for alpine issue: https://github.com/alpinelinux/docker-alpine/issues/383
+RUN apk update && apk upgrade
+
+# Ran separately from 'make' to avoid re-doing
+RUN git submodule update --init --recursive
+
+# Slowest build step for the sake of caching layers
+RUN make -j$(nproc) deps QUICK_AND_DIRTY_COMPILER=1 ${NIM_COMMIT}
+
+# Build the final node binary
+RUN make -j$(nproc) ${NIM_COMMIT} $MAKE_TARGET LOG_LEVEL=${LOG_LEVEL} NIMFLAGS="${NIMFLAGS}"
+
+
+# REFERENCE IMAGE as BASE for specialized PRODUCTION IMAGES----------------------------------------
+FROM alpine:3.18 AS base_lpt
+
+ARG MAKE_TARGET=lightpushwithmix
+
+LABEL maintainer="prem@waku.org"
+LABEL source="https://github.com/waku-org/nwaku"
+LABEL description="Lite Push With Mix: Waku light-client"
+LABEL commit="unknown"
+LABEL version="unknown"
+
+# DevP2P, LibP2P, and JSON RPC ports
+EXPOSE 30303 60000 8545
+
+# Referenced in the binary
+RUN apk add --no-cache libgcc pcre-dev libpq-dev \
+ wget \
+ iproute2 \
+ python3 \
+ jq
+
+# Fix for 'Error loading shared library libpcre.so.3: No such file or directory'
+RUN ln -s /usr/lib/libpcre.so /usr/lib/libpcre.so.3
+
+COPY --from=nim-build /app/build/lightpush_publisher_mix /usr/bin/
+RUN chmod +x /usr/bin/lightpush_publisher_mix
+
+# Standalone image to be used manually and in lpt-runner -------------------------------------------
+FROM base_lpt AS standalone_lpt
+
+ENTRYPOINT ["/usr/bin/lightpush_publisher_mix"]
diff --git a/third-party/nwaku/LICENSE-APACHEv2 b/third-party/nwaku/LICENSE-APACHEv2
new file mode 100644
index 0000000..7b6a3cb
--- /dev/null
+++ b/third-party/nwaku/LICENSE-APACHEv2
@@ -0,0 +1,205 @@
+nim-waku is licensed under the Apache License version 2
+Copyright (c) 2018 Status Research & Development GmbH
+-----------------------------------------------------
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright 2018 Status Research & Development GmbH
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
diff --git a/third-party/nwaku/LICENSE-MIT b/third-party/nwaku/LICENSE-MIT
new file mode 100644
index 0000000..aab8020
--- /dev/null
+++ b/third-party/nwaku/LICENSE-MIT
@@ -0,0 +1,25 @@
+nim-waku is licensed under the MIT License
+Copyright (c) 2018 Status Research & Development GmbH
+-----------------------------------------------------
+
+The MIT License (MIT)
+
+Copyright (c) 2018 Status Research & Development GmbH
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/third-party/nwaku/Makefile b/third-party/nwaku/Makefile
new file mode 100644
index 0000000..d5cf088
--- /dev/null
+++ b/third-party/nwaku/Makefile
@@ -0,0 +1,546 @@
+# Copyright (c) 2022 Status Research & Development GmbH. Licensed under
+# either of:
+# - Apache License, version 2.0
+# - MIT license
+# at your option. This file may not be copied, modified, or distributed except
+# according to those terms.
+export BUILD_SYSTEM_DIR := vendor/nimbus-build-system
+export EXCLUDED_NIM_PACKAGES := vendor/nim-dnsdisc/vendor
+LINK_PCRE := 0
+FORMAT_MSG := "\\x1B[95mFormatting:\\x1B[39m"
+# we don't want an error here, so we can handle things later, in the ".DEFAULT" target
+-include $(BUILD_SYSTEM_DIR)/makefiles/variables.mk
+
+
+ifeq ($(NIM_PARAMS),)
+# "variables.mk" was not included, so we update the submodules.
+GIT_SUBMODULE_UPDATE := git submodule update --init --recursive
+.DEFAULT:
+ +@ echo -e "Git submodules not found. Running '$(GIT_SUBMODULE_UPDATE)'.\n"; \
+ $(GIT_SUBMODULE_UPDATE); \
+ echo
+# Now that the included *.mk files appeared, and are newer than this file, Make will restart itself:
+# https://www.gnu.org/software/make/manual/make.html#Remaking-Makefiles
+#
+# After restarting, it will execute its original goal, so we don't have to start a child Make here
+# with "$(MAKE) $(MAKECMDGOALS)". Isn't hidden control flow great?
+
+else # "variables.mk" was included. Business as usual until the end of this file.
+
+# Determine the OS
+detected_OS := $(shell uname -s)
+ifneq (,$(findstring MINGW,$(detected_OS)))
+ detected_OS := Windows
+endif
+
+ifeq ($(detected_OS),Windows)
+ # Update MINGW_PATH to standard MinGW location
+ MINGW_PATH = /mingw64
+ NIM_PARAMS += --passC:"-I$(MINGW_PATH)/include"
+ NIM_PARAMS += --passL:"-L$(MINGW_PATH)/lib"
+ NIM_PARAMS += --passL:"-Lvendor/nim-nat-traversal/vendor/miniupnp/miniupnpc"
+ NIM_PARAMS += --passL:"-Lvendor/nim-nat-traversal/vendor/libnatpmp-upstream"
+
+ LIBS = -lws2_32 -lbcrypt -liphlpapi -luserenv -lntdll -lminiupnpc -lnatpmp -lpq
+ NIM_PARAMS += $(foreach lib,$(LIBS),--passL:"$(lib)")
+endif
+
+##########
+## Main ##
+##########
+.PHONY: all test update clean
+
+# default target, because it's the first one that doesn't start with '.'
+all: | wakunode2 example2 chat2 chat2bridge libwaku
+
+test_file := $(word 2,$(MAKECMDGOALS))
+define test_name
+$(shell echo '$(MAKECMDGOALS)' | cut -d' ' -f3-)
+endef
+
+test:
+ifeq ($(strip $(test_file)),)
+ $(MAKE) testcommon
+ $(MAKE) testwaku
+else
+ $(MAKE) compile-test TEST_FILE="$(test_file)" TEST_NAME="$(call test_name)"
+endif
+# this prevents make from erroring on unknown targets like "Index"
+%:
+ @true
+
+waku.nims:
+ ln -s waku.nimble $@
+
+update: | update-common
+ rm -rf waku.nims && \
+ $(MAKE) waku.nims $(HANDLE_OUTPUT)
+ $(MAKE) build-nph
+
+clean:
+ rm -rf build
+
+# must be included after the default target
+-include $(BUILD_SYSTEM_DIR)/makefiles/targets.mk
+
+## Possible values: prod; debug
+TARGET ?= prod
+
+## Git version
+GIT_VERSION ?= $(shell git describe --abbrev=6 --always --tags)
+## Compilation parameters. If defined in the CLI the assignments won't be executed
+NIM_PARAMS := $(NIM_PARAMS) -d:git_version=\"$(GIT_VERSION)\"
+
+## Heaptracker options
+HEAPTRACKER ?= 0
+HEAPTRACKER_INJECT ?= 0
+ifeq ($(HEAPTRACKER), 1)
+# Assumes Nim's lib/system/alloc.nim is patched!
+TARGET := debug-with-heaptrack
+
+ifeq ($(HEAPTRACKER_INJECT), 1)
+# the Nim compiler will load 'libheaptrack_inject.so'
+HEAPTRACK_PARAMS := -d:heaptracker -d:heaptracker_inject
+NIM_PARAMS := $(NIM_PARAMS) -d:heaptracker -d:heaptracker_inject
+else
+# the Nim compiler will load 'libheaptrack_preload.so'
+HEAPTRACK_PARAMS := -d:heaptracker
+NIM_PARAMS := $(NIM_PARAMS) -d:heaptracker
+endif
+
+endif
+## end of Heaptracker options
+
+##################
+## Dependencies ##
+##################
+.PHONY: deps libbacktrace
+
+rustup:
+ifeq (, $(shell which cargo))
+# Install Rustup if it's not installed
+# -y: Assume "yes" for all prompts
+# --default-toolchain stable: Install the stable toolchain
+ curl https://sh.rustup.rs -sSf | sh -s -- -y --default-toolchain stable
+endif
+
+rln-deps: rustup
+ ./scripts/install_rln_tests_dependencies.sh
+
+deps: | deps-common nat-libs waku.nims
+
+
+### nim-libbacktrace
+
+# "-d:release" implies "--stacktrace:off" and it cannot be added to config.nims
+ifeq ($(DEBUG), 0)
+NIM_PARAMS := $(NIM_PARAMS) -d:release
+else
+NIM_PARAMS := $(NIM_PARAMS) -d:debug
+endif
+
+ifeq ($(USE_LIBBACKTRACE), 0)
+NIM_PARAMS := $(NIM_PARAMS) -d:disable_libbacktrace
+endif
+
+libbacktrace:
+ + $(MAKE) -C vendor/nim-libbacktrace --no-print-directory BUILD_CXX_LIB=0
+
+clean-libbacktrace:
+ + $(MAKE) -C vendor/nim-libbacktrace clean $(HANDLE_OUTPUT)
+
+# Extend deps and clean targets
+ifneq ($(USE_LIBBACKTRACE), 0)
+deps: | libbacktrace
+endif
+
+ifeq ($(POSTGRES), 1)
+NIM_PARAMS := $(NIM_PARAMS) -d:postgres -d:nimDebugDlOpen
+endif
+
+ifeq ($(DEBUG_DISCV5), 1)
+NIM_PARAMS := $(NIM_PARAMS) -d:debugDiscv5
+endif
+
+clean: | clean-libbacktrace
+
+### Create nimble links (used when building with Nix)
+
+nimbus-build-system-nimble-dir:
+ NIMBLE_DIR="$(CURDIR)/$(NIMBLE_DIR)" \
+ PWD_CMD="$(PWD)" \
+ $(CURDIR)/scripts/generate_nimble_links.sh
+
+##################
+## RLN ##
+##################
+.PHONY: librln
+
+LIBRLN_BUILDDIR := $(CURDIR)/vendor/zerokit
+LIBRLN_VERSION := v0.7.0
+
+ifeq ($(detected_OS),Windows)
+LIBRLN_FILE := rln.lib
+else
+LIBRLN_FILE := librln_$(LIBRLN_VERSION).a
+endif
+
+$(LIBRLN_FILE):
+ echo -e $(BUILD_MSG) "$@" && \
+ ./scripts/build_rln.sh $(LIBRLN_BUILDDIR) $(LIBRLN_VERSION) $(LIBRLN_FILE)
+
+librln: | $(LIBRLN_FILE)
+ $(eval NIM_PARAMS += --passL:$(LIBRLN_FILE) --passL:-lm)
+
+clean-librln:
+ cargo clean --manifest-path vendor/zerokit/rln/Cargo.toml
+ rm -f $(LIBRLN_FILE)
+
+# Extend clean target
+clean: | clean-librln
+
+#################
+## Waku Common ##
+#################
+.PHONY: testcommon
+
+testcommon: | build deps
+ echo -e $(BUILD_MSG) "build/$@" && \
+ $(ENV_SCRIPT) nim testcommon $(NIM_PARAMS) waku.nims
+
+
+##########
+## Waku ##
+##########
+.PHONY: testwaku wakunode2 testwakunode2 example2 chat2 chat2bridge liteprotocoltester
+
+# install rln-deps only for the testwaku target
+testwaku: | build deps rln-deps librln
+ echo -e $(BUILD_MSG) "build/$@" && \
+ $(ENV_SCRIPT) nim test -d:os=$(shell uname) $(NIM_PARAMS) waku.nims
+
+wakunode2: | build deps librln
+ echo -e $(BUILD_MSG) "build/$@" && \
+ \
+ $(ENV_SCRIPT) nim wakunode2 $(NIM_PARAMS) waku.nims
+
+benchmarks: | build deps librln
+ echo -e $(BUILD_MSG) "build/$@" && \
+ $(ENV_SCRIPT) nim benchmarks $(NIM_PARAMS) waku.nims
+
+testwakunode2: | build deps librln
+ echo -e $(BUILD_MSG) "build/$@" && \
+ $(ENV_SCRIPT) nim testwakunode2 $(NIM_PARAMS) waku.nims
+
+example2: | build deps librln
+ echo -e $(BUILD_MSG) "build/$@" && \
+ $(ENV_SCRIPT) nim example2 $(NIM_PARAMS) waku.nims
+
+chat2: | build deps librln
+ echo -e $(BUILD_MSG) "build/$@" && \
+ $(ENV_SCRIPT) nim chat2 $(NIM_PARAMS) waku.nims
+
+chat2mix: | build deps librln
+ echo -e $(BUILD_MSG) "build/$@" && \
+ $(ENV_SCRIPT) nim chat2mix $(NIM_PARAMS) waku.nims
+
+rln-db-inspector: | build deps librln
+ echo -e $(BUILD_MSG) "build/$@" && \
+ $(ENV_SCRIPT) nim rln_db_inspector $(NIM_PARAMS) waku.nims
+
+chat2bridge: | build deps librln
+ echo -e $(BUILD_MSG) "build/$@" && \
+ $(ENV_SCRIPT) nim chat2bridge $(NIM_PARAMS) waku.nims
+
+liteprotocoltester: | build deps librln
+ echo -e $(BUILD_MSG) "build/$@" && \
+ $(ENV_SCRIPT) nim liteprotocoltester $(NIM_PARAMS) waku.nims
+
+lightpushwithmix: | build deps librln
+ echo -e $(BUILD_MSG) "build/$@" && \
+ $(ENV_SCRIPT) nim lightpushwithmix $(NIM_PARAMS) waku.nims
+
+build/%: | build deps librln
+ echo -e $(BUILD_MSG) "build/$*" && \
+ $(ENV_SCRIPT) nim buildone $(NIM_PARAMS) waku.nims $*
+
+compile-test: | build deps librln
+ echo -e $(BUILD_MSG) "$(TEST_FILE)" "\"$(TEST_NAME)\"" && \
+ $(ENV_SCRIPT) nim buildTest $(NIM_PARAMS) waku.nims $(TEST_FILE) && \
+ $(ENV_SCRIPT) nim execTest $(NIM_PARAMS) waku.nims $(TEST_FILE) "\"$(TEST_NAME)\""; \
+
+################
+## Waku tools ##
+################
+.PHONY: tools wakucanary networkmonitor
+
+tools: networkmonitor wakucanary
+
+wakucanary: | build deps librln
+ echo -e $(BUILD_MSG) "build/$@" && \
+ $(ENV_SCRIPT) nim wakucanary $(NIM_PARAMS) waku.nims
+
+networkmonitor: | build deps librln
+ echo -e $(BUILD_MSG) "build/$@" && \
+ $(ENV_SCRIPT) nim networkmonitor $(NIM_PARAMS) waku.nims
+
+############
+## Format ##
+############
+.PHONY: build-nph install-nph clean-nph print-nph-path
+
+# Default location for nph binary shall be next to nim binary to make it available on the path.
+NPH:=$(shell dirname $(NIM_BINARY))/nph
+
+build-nph: | build deps
+ifeq ("$(wildcard $(NPH))","")
+ $(ENV_SCRIPT) nim c --skipParentCfg:on vendor/nph/src/nph.nim && \
+ mv vendor/nph/src/nph $(shell dirname $(NPH))
+ echo "nph utility is available at " $(NPH)
+else
+ echo "nph utility already exists at " $(NPH)
+endif
+
+GIT_PRE_COMMIT_HOOK := .git/hooks/pre-commit
+
+install-nph: build-nph
+ifeq ("$(wildcard $(GIT_PRE_COMMIT_HOOK))","")
+ cp ./scripts/git_pre_commit_format.sh $(GIT_PRE_COMMIT_HOOK)
+else
+ echo "$(GIT_PRE_COMMIT_HOOK) already present, will NOT override"
+ exit 1
+endif
+
+nph/%: | build-nph
+ echo -e $(FORMAT_MSG) "nph/$*" && \
+ $(NPH) $*
+
+clean-nph:
+ rm -f $(NPH)
+
+# To avoid hardcoding nph binary location in several places
+print-nph-path:
+ echo "$(NPH)"
+
+clean: | clean-nph
+
+###################
+## Documentation ##
+###################
+.PHONY: docs coverage
+
+# TODO: Remove unused target
+docs: | build deps
+ echo -e $(BUILD_MSG) "build/$@" && \
+ $(ENV_SCRIPT) nim doc --run --index:on --project --out:.gh-pages waku/waku.nim waku.nims
+
+coverage:
+ echo -e $(BUILD_MSG) "build/$@" && \
+ $(ENV_SCRIPT) ./scripts/run_cov.sh -y
+
+
+#####################
+## Container image ##
+#####################
+# -d:insecure - Necessary to enable Prometheus HTTP endpoint for metrics
+# -d:chronicles_colors:none - Necessary to disable colors in logs for Docker
+DOCKER_IMAGE_NIMFLAGS ?= -d:chronicles_colors:none -d:insecure -d:postgres
+DOCKER_IMAGE_NIMFLAGS := $(DOCKER_IMAGE_NIMFLAGS) $(HEAPTRACK_PARAMS)
+
+# build a docker image for the fleet
+docker-image: MAKE_TARGET ?= wakunode2
+docker-image: DOCKER_IMAGE_TAG ?= $(MAKE_TARGET)-$(GIT_VERSION)
+docker-image: DOCKER_IMAGE_NAME ?= wakuorg/nwaku:$(DOCKER_IMAGE_TAG)
+docker-image:
+ docker build \
+ --build-arg="MAKE_TARGET=$(MAKE_TARGET)" \
+ --build-arg="NIMFLAGS=$(DOCKER_IMAGE_NIMFLAGS)" \
+ --build-arg="NIM_COMMIT=$(DOCKER_NIM_COMMIT)" \
+ --build-arg="LOG_LEVEL=$(LOG_LEVEL)" \
+ --build-arg="HEAPTRACK_BUILD=$(HEAPTRACKER)" \
+ --label="commit=$(shell git rev-parse HEAD)" \
+ --label="version=$(GIT_VERSION)" \
+ --target $(TARGET) \
+ --tag $(DOCKER_IMAGE_NAME) .
+
+docker-quick-image: MAKE_TARGET ?= wakunode2
+docker-quick-image: DOCKER_IMAGE_TAG ?= $(MAKE_TARGET)-$(GIT_VERSION)
+docker-quick-image: DOCKER_IMAGE_NAME ?= wakuorg/nwaku:$(DOCKER_IMAGE_TAG)
+docker-quick-image: NIM_PARAMS := $(NIM_PARAMS) -d:chronicles_colors:none -d:insecure -d:postgres --passL:$(LIBRLN_FILE) --passL:-lm
+docker-quick-image: | build deps librln wakunode2
+ docker build \
+ --build-arg="MAKE_TARGET=$(MAKE_TARGET)" \
+ --tag $(DOCKER_IMAGE_NAME) \
+ --target $(TARGET) \
+ --file docker/binaries/Dockerfile.bn.local \
+ .
+
+docker-push:
+ docker push $(DOCKER_IMAGE_NAME)
+
+####################################
+## Container lite-protocol-tester ##
+####################################
+# -d:insecure - Necessary to enable Prometheus HTTP endpoint for metrics
+# -d:chronicles_colors:none - Necessary to disable colors in logs for Docker
+DOCKER_LPT_NIMFLAGS ?= -d:chronicles_colors:none -d:insecure
+
+# build a docker image for the fleet
+docker-liteprotocoltester: DOCKER_LPT_TAG ?= latest
+docker-liteprotocoltester: DOCKER_LPT_NAME ?= wakuorg/liteprotocoltester:$(DOCKER_LPT_TAG)
+# --no-cache
+docker-liteprotocoltester:
+ docker build \
+ --build-arg="MAKE_TARGET=liteprotocoltester" \
+ --build-arg="NIMFLAGS=$(DOCKER_LPT_NIMFLAGS)" \
+ --build-arg="NIM_COMMIT=$(DOCKER_NIM_COMMIT)" \
+ --build-arg="LOG_LEVEL=TRACE" \
+ --label="commit=$(shell git rev-parse HEAD)" \
+ --label="version=$(GIT_VERSION)" \
+ --target $(if $(filter deploy,$(DOCKER_LPT_TAG)),deployment_lpt,standalone_lpt) \
+ --tag $(DOCKER_LPT_NAME) \
+ --file apps/liteprotocoltester/Dockerfile.liteprotocoltester.compile \
+ .
+
+docker-quick-liteprotocoltester: DOCKER_LPT_TAG ?= latest
+docker-quick-liteprotocoltester: DOCKER_LPT_NAME ?= wakuorg/liteprotocoltester:$(DOCKER_LPT_TAG)
+docker-quick-liteprotocoltester: | liteprotocoltester
+ docker build \
+ --tag $(DOCKER_LPT_NAME) \
+ --file apps/liteprotocoltester/Dockerfile.liteprotocoltester \
+ .
+
+docker-liteprotocoltester-push:
+ docker push $(DOCKER_LPT_NAME)
+
+
+################
+## C Bindings ##
+################
+.PHONY: cbindings cwaku_example libwaku
+
+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)
+ 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
+endif
+
+#####################
+## Mobile Bindings ##
+#####################
+.PHONY: libwaku-android \
+ libwaku-android-precheck \
+ libwaku-android-arm64 \
+ libwaku-android-amd64 \
+ libwaku-android-x86 \
+ libwaku-android-arm \
+ rebuild-nat-libs \
+ build-libwaku-for-android-arch
+
+ANDROID_TARGET ?= 30
+ifeq ($(detected_OS),Darwin)
+ ANDROID_TOOLCHAIN_DIR := $(ANDROID_NDK_HOME)/toolchains/llvm/prebuilt/darwin-x86_64
+else
+ ANDROID_TOOLCHAIN_DIR := $(ANDROID_NDK_HOME)/toolchains/llvm/prebuilt/linux-x86_64
+endif
+
+rebuild-nat-libs: | clean-cross nat-libs
+
+libwaku-android-precheck:
+ifndef ANDROID_NDK_HOME
+ $(error ANDROID_NDK_HOME is not set)
+endif
+
+build-libwaku-for-android-arch:
+ $(MAKE) rebuild-nat-libs CC=$(ANDROID_TOOLCHAIN_DIR)/bin/$(ANDROID_COMPILER) && \
+ ./scripts/build_rln_android.sh $(CURDIR)/build $(LIBRLN_BUILDDIR) $(LIBRLN_VERSION) $(CROSS_TARGET) $(ABIDIR) && \
+ CPU=$(CPU) ABIDIR=$(ABIDIR) ANDROID_ARCH=$(ANDROID_ARCH) ANDROID_COMPILER=$(ANDROID_COMPILER) ANDROID_TOOLCHAIN_DIR=$(ANDROID_TOOLCHAIN_DIR) $(ENV_SCRIPT) nim libWakuAndroid $(NIM_PARAMS) waku.nims
+
+libwaku-android-arm64: ANDROID_ARCH=aarch64-linux-android
+libwaku-android-arm64: CPU=arm64
+libwaku-android-arm64: ABIDIR=arm64-v8a
+libwaku-android-arm64: | libwaku-android-precheck build deps
+ $(MAKE) build-libwaku-for-android-arch ANDROID_ARCH=$(ANDROID_ARCH) CROSS_TARGET=$(ANDROID_ARCH) CPU=$(CPU) ABIDIR=$(ABIDIR) ANDROID_COMPILER=$(ANDROID_ARCH)$(ANDROID_TARGET)-clang
+
+libwaku-android-amd64: ANDROID_ARCH=x86_64-linux-android
+libwaku-android-amd64: CPU=amd64
+libwaku-android-amd64: ABIDIR=x86_64
+libwaku-android-amd64: | libwaku-android-precheck build deps
+ $(MAKE) build-libwaku-for-android-arch ANDROID_ARCH=$(ANDROID_ARCH) CROSS_TARGET=$(ANDROID_ARCH) CPU=$(CPU) ABIDIR=$(ABIDIR) ANDROID_COMPILER=$(ANDROID_ARCH)$(ANDROID_TARGET)-clang
+
+libwaku-android-x86: ANDROID_ARCH=i686-linux-android
+libwaku-android-x86: CPU=i386
+libwaku-android-x86: ABIDIR=x86
+libwaku-android-x86: | libwaku-android-precheck build deps
+ $(MAKE) build-libwaku-for-android-arch ANDROID_ARCH=$(ANDROID_ARCH) CROSS_TARGET=$(ANDROID_ARCH) CPU=$(CPU) ABIDIR=$(ABIDIR) ANDROID_COMPILER=$(ANDROID_ARCH)$(ANDROID_TARGET)-clang
+
+libwaku-android-arm: ANDROID_ARCH=armv7a-linux-androideabi
+libwaku-android-arm: CPU=arm
+libwaku-android-arm: ABIDIR=armeabi-v7a
+libwaku-android-arm: | libwaku-android-precheck build deps
+# cross-rs target architecture name does not match the one used in android
+ $(MAKE) build-libwaku-for-android-arch ANDROID_ARCH=$(ANDROID_ARCH) CROSS_TARGET=armv7-linux-androideabi CPU=$(CPU) ABIDIR=$(ABIDIR) ANDROID_COMPILER=$(ANDROID_ARCH)$(ANDROID_TARGET)-clang
+
+libwaku-android:
+ $(MAKE) libwaku-android-amd64
+ $(MAKE) libwaku-android-arm64
+ $(MAKE) libwaku-android-x86
+# This target is disabled because on recent versions of cross-rs complain with the following error
+# relocation R_ARM_THM_ALU_PREL_11_0 cannot be used against symbol 'stack_init_trampoline_return'; recompile with -fPIC
+# It's likely this architecture is not used so we might just not support it.
+# $(MAKE) libwaku-android-arm
+
+cwaku_example: | build libwaku
+ echo -e $(BUILD_MSG) "build/$@" && \
+ cc -o "build/$@" \
+ ./examples/cbindings/waku_example.c \
+ ./examples/cbindings/base64.c \
+ -lwaku -Lbuild/ \
+ -pthread -ldl -lm \
+ -lminiupnpc -Lvendor/nim-nat-traversal/vendor/miniupnp/miniupnpc/build/ \
+ -lnatpmp -Lvendor/nim-nat-traversal/vendor/libnatpmp-upstream/ \
+ vendor/nim-libbacktrace/libbacktrace_wrapper.o \
+ vendor/nim-libbacktrace/install/usr/lib/libbacktrace.a
+
+cppwaku_example: | build libwaku
+ echo -e $(BUILD_MSG) "build/$@" && \
+ g++ -o "build/$@" \
+ ./examples/cpp/waku.cpp \
+ ./examples/cpp/base64.cpp \
+ -lwaku -Lbuild/ \
+ -pthread -ldl -lm \
+ -lminiupnpc -Lvendor/nim-nat-traversal/vendor/miniupnp/miniupnpc/build/ \
+ -lnatpmp -Lvendor/nim-nat-traversal/vendor/libnatpmp-upstream/ \
+ vendor/nim-libbacktrace/libbacktrace_wrapper.o \
+ vendor/nim-libbacktrace/install/usr/lib/libbacktrace.a
+
+nodejswaku: | build deps
+ echo -e $(BUILD_MSG) "build/$@" && \
+ node-gyp build --directory=examples/nodejs/
+
+endif # "variables.mk" was not included
+
+###################
+# Release Targets #
+###################
+
+release-notes:
+ docker run \
+ -it \
+ --rm \
+ -v $${PWD}:/opt/sv4git/repo:z \
+ -u $(shell id -u) \
+ docker.io/wakuorg/sv4git:latest \
+ 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/third-party/nwaku/README.md b/third-party/nwaku/README.md
new file mode 100644
index 0000000..ce352d6
--- /dev/null
+++ b/third-party/nwaku/README.md
@@ -0,0 +1,186 @@
+# Nwaku
+
+## Introduction
+
+The nwaku repository implements Waku, and provides tools related to it.
+
+- A Nim implementation of the [Waku (v2) protocol](https://specs.vac.dev/specs/waku/v2/waku-v2.html).
+- CLI application `wakunode2` that allows you to run a Waku node.
+- Examples of Waku usage.
+- Various tests of above.
+
+For more details see the [source code](waku/README.md)
+
+## How to Build & Run ( Linux, MacOS & WSL )
+
+These instructions are generic. For more detailed instructions, see the Waku source code above.
+
+### Prerequisites
+
+The standard developer tools, including a C compiler, GNU Make, Bash, and Git. More information on these installations can be found [here](https://docs.waku.org/guides/nwaku/build-source#install-dependencies).
+
+> In some distributions (Fedora linux for example), you may need to install `which` utility separately. Nimbus build system is relying on it.
+
+You'll also need an installation of Rust and its toolchain (specifically `rustc` and `cargo`).
+The easiest way to install these, is using `rustup`:
+
+```bash
+curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
+```
+
+### Wakunode
+
+```bash
+# The first `make` invocation will update all Git submodules.
+# You'll run `make update` after each `git pull` in the future to keep those submodules updated.
+make wakunode2
+
+# Build with custom compilation flags. Do not use NIM_PARAMS unless you know what you are doing.
+# Replace with your own flags
+make wakunode2 NIMFLAGS="-d:chronicles_colors:none -d:disableMarchNative"
+
+# Run with DNS bootstrapping
+./build/wakunode2 --dns-discovery --dns-discovery-url=DNS_BOOTSTRAP_NODE_URL
+
+# See available command line options
+./build/wakunode2 --help
+```
+To join the network, you need to know the address of at least one bootstrap node.
+Please refer to the [Waku README](https://github.com/waku-org/nwaku/blob/master/waku/README.md) for more information.
+
+For more on how to run `wakunode2`, refer to:
+- [Run using binaries](https://docs.waku.org/guides/nwaku/build-source)
+- [Run using docker](https://docs.waku.org/guides/nwaku/run-docker)
+- [Run using docker-compose](https://docs.waku.org/guides/nwaku/run-docker-compose)
+
+#### Issues
+##### WSL
+If you encounter difficulties building the project on WSL, consider placing the project within WSL's filesystem, avoiding the `/mnt/` directory.
+
+### How to Build & Run ( Windows )
+
+### Windows Build Instructions
+
+#### 1. Install Required Tools
+- **Git Bash Terminal**: Download and install from https://git-scm.com/download/win
+- **MSYS2**:
+ a. Download installer from https://www.msys2.org
+ b. Install at "C:\" (default location). Remove/rename the msys folder in case of previous installation.
+ c. Use the mingw64 terminal from msys64 directory for package installation.
+
+#### 2. Install Dependencies
+Open MSYS2 mingw64 terminal and run the following one-by-one :
+```bash
+pacman -Syu --noconfirm
+pacman -S --noconfirm --needed mingw-w64-x86_64-toolchain
+pacman -S --noconfirm --needed base-devel make cmake upx
+pacman -S --noconfirm --needed mingw-w64-x86_64-rust
+pacman -S --noconfirm --needed mingw-w64-x86_64-postgresql
+pacman -S --noconfirm --needed mingw-w64-x86_64-gcc
+pacman -S --noconfirm --needed mingw-w64-x86_64-gcc-libs
+pacman -S --noconfirm --needed mingw-w64-x86_64-libwinpthread-git
+pacman -S --noconfirm --needed mingw-w64-x86_64-zlib
+pacman -S --noconfirm --needed mingw-w64-x86_64-openssl
+pacman -S --noconfirm --needed mingw-w64-x86_64-python
+```
+
+#### 3. Build Wakunode
+- Open Git Bash as administrator
+- clone nwaku and cd nwaku
+- Execute: `./scripts/build_windows.sh`
+
+#### 4. Troubleshooting
+If `wakunode2.exe` isn't generated:
+- **Missing Dependencies**: Verify with:
+ `which make cmake gcc g++ rustc cargo python3 upx`
+ If missing, revisit Step 2 or ensure MSYS2 is at `C:\`
+- **Installation Conflicts**: Remove existing MinGW/MSYS2/Git Bash installations and perform fresh install
+
+### Developing
+
+#### Nim Runtime
+This repository is bundled with a Nim runtime that includes the necessary dependencies for the project.
+
+Before you can utilize the runtime you'll need to build the project, as detailed in a previous section.
+This will generate a `vendor` directory containing various dependencies, including the `nimbus-build-system` which has the bundled nim runtime.
+
+After successfully building the project, you may bring the bundled runtime into scope by running:
+```bash
+source env.sh
+```
+If everything went well, you should see your prompt suffixed with `[Nimbus env]$`. Now you can run `nim` commands as usual.
+
+### Test Suite
+
+```bash
+# Run all the Waku tests
+make test
+
+# Run a specific test file
+make test
+# e.g. : make test tests/wakunode2/test_all.nim
+
+# Run a specific test name from a specific test file
+make test
+# e.g. : make test tests/wakunode2/test_all.nim "node setup is successful with default configuration"
+```
+
+### Building single test files
+
+During development it is helpful to build and run a single test file.
+To support this make has a specific target:
+
+targets:
+- `build/`
+- `test/`
+
+Binary will be created as `.bin` under the `build` directory .
+
+```bash
+# Build and run your test file separately
+make test/tests/common/test_enr_builder.nim
+```
+
+### Testing against `js-waku`
+Refer to [js-waku repo](https://github.com/waku-org/js-waku/tree/master/packages/tests) for instructions.
+
+## Formatting
+
+Nim files are expected to be formatted using the [`nph`](https://github.com/arnetheduck/nph) version present in `vendor/nph`.
+
+You can easily format file with the `make nph/ file` command.
+For example:
+
+```
+make nph/waku/waku_core.nim
+```
+
+A convenient git hook is provided to automatically format file at commit time.
+Run the following command to install it:
+
+```shell
+make install-nph
+```
+
+### Examples
+
+Examples can be found in the examples folder.
+This includes a fully featured chat example.
+
+### Tools
+
+Different tools and their corresponding how-to guides can be found in the `tools` folder.
+
+### Bugs, Questions & Features
+
+For an inquiry, or if you would like to propose new features, feel free to [open a general issue](https://github.com/waku-org/nwaku/issues/new).
+
+For bug reports, please [tag your issue with the `bug` label](https://github.com/waku-org/nwaku/issues/new).
+
+If you believe the reported issue requires critical attention, please [use the `critical` label](https://github.com/waku-org/nwaku/issues/new?labels=critical,bug) to assist with triaging.
+
+To get help, or participate in the conversation, join the [Waku Discord](https://discord.waku.org/) server.
+
+### Docs
+
+* [REST API Documentation](https://waku-org.github.io/waku-rest-api/)
diff --git a/third-party/nwaku/apps/benchmarks/benchmarks.nim b/third-party/nwaku/apps/benchmarks/benchmarks.nim
new file mode 100644
index 0000000..75686c8
--- /dev/null
+++ b/third-party/nwaku/apps/benchmarks/benchmarks.nim
@@ -0,0 +1,74 @@
+import
+ std/[strutils, times, sequtils, osproc], math, results, options, testutils/unittests
+
+import
+ waku/[
+ waku_rln_relay/protocol_types,
+ waku_rln_relay/rln,
+ waku_rln_relay,
+ waku_rln_relay/conversion_utils,
+ waku_rln_relay/group_manager/on_chain/group_manager,
+ ],
+ tests/waku_rln_relay/utils_onchain
+
+proc benchmark(
+ manager: OnChainGroupManager, registerCount: int, messageLimit: int
+): Future[string] {.async, gcsafe.} =
+ # Register a new member so that we can later generate proofs
+ let idCredentials = generateCredentials(manager.rlnInstance, registerCount)
+
+ var start_time = getTime()
+ for i in 0 .. registerCount - 1:
+ try:
+ await manager.register(idCredentials[i], UserMessageLimit(messageLimit + 1))
+ except Exception, CatchableError:
+ assert false, "exception raised: " & getCurrentExceptionMsg()
+
+ debug "registration finished",
+ iter = i, elapsed_ms = (getTime() - start_time).inMilliseconds
+
+ discard await manager.updateRoots()
+ let proofResult = await manager.fetchMerkleProofElements()
+ if proofResult.isErr():
+ error "Failed to fetch Merkle proof", error = proofResult.error
+ manager.merkleProofCache = proofResult.get()
+
+ let epoch = default(Epoch)
+ debug "epoch in bytes", epochHex = epoch.inHex()
+ let data: seq[byte] = newSeq[byte](1024)
+
+ var proofGenTimes: seq[times.Duration] = @[]
+ var proofVerTimes: seq[times.Duration] = @[]
+
+ start_time = getTime()
+ for i in 1 .. messageLimit:
+ var generate_time = getTime()
+ let proof = manager.generateProof(data, epoch, MessageId(i.uint8)).valueOr:
+ raiseAssert $error
+ proofGenTimes.add(getTime() - generate_time)
+
+ let verify_time = getTime()
+ let ok = manager.verifyProof(data, proof).valueOr:
+ raiseAssert $error
+ proofVerTimes.add(getTime() - verify_time)
+ debug "iteration finished",
+ iter = i, elapsed_ms = (getTime() - start_time).inMilliseconds
+
+ echo "Proof generation times: ", sum(proofGenTimes) div len(proofGenTimes)
+ echo "Proof verification times: ", sum(proofVerTimes) div len(proofVerTimes)
+
+proc main() =
+ # Start a local Ethereum JSON-RPC (Anvil) so that the group-manager setup can connect.
+ let anvilProc = runAnvil()
+ defer:
+ stopAnvil(anvilProc)
+
+ # Set up an On-chain group manager (includes contract deployment)
+ let manager = waitFor setupOnchainGroupManager()
+ (waitFor manager.init()).isOkOr:
+ raiseAssert $error
+
+ discard waitFor benchmark(manager, 200, 20)
+
+when isMainModule:
+ main()
diff --git a/third-party/nwaku/apps/chat2/chat2.nim b/third-party/nwaku/apps/chat2/chat2.nim
new file mode 100644
index 0000000..1531a46
--- /dev/null
+++ b/third-party/nwaku/apps/chat2/chat2.nim
@@ -0,0 +1,626 @@
+## chat2 is an example of usage of Waku v2. For suggested usage options, please
+## see dingpu tutorial in docs folder.
+
+when not (compileOption("threads")):
+ {.fatal: "Please, compile this program with the --threads:on option!".}
+
+{.push raises: [].}
+
+import std/[strformat, strutils, times, options, random, sequtils]
+import
+ confutils,
+ chronicles,
+ chronos,
+ eth/keys,
+ bearssl,
+ stew/[byteutils, results],
+ metrics,
+ metrics/chronos_httpserver
+import
+ libp2p/[
+ switch, # manage transports, a single entry point for dialing and listening
+ crypto/crypto, # cryptographic functions
+ stream/connection, # create and close stream read / write connections
+ multiaddress,
+ # encode different addressing schemes. For example, /ip4/7.7.7.7/tcp/6543 means it is using IPv4 protocol and TCP
+ peerinfo,
+ # manage the information of a peer, such as peer ID and public / private key
+ peerid, # Implement how peers interact
+ protobuf/minprotobuf, # message serialisation/deserialisation from and to protobufs
+ nameresolving/dnsresolver,
+ ] # define DNS resolution
+import
+ waku/[
+ waku_core,
+ waku_lightpush_legacy/common,
+ waku_lightpush_legacy/rpc,
+ waku_enr,
+ discovery/waku_dnsdisc,
+ waku_store_legacy,
+ waku_node,
+ node/waku_metrics,
+ node/peer_manager,
+ factory/builder,
+ common/utils/nat,
+ waku_relay,
+ waku_store/common,
+ ],
+ ./config_chat2
+
+import libp2p/protocols/pubsub/rpc/messages, libp2p/protocols/pubsub/pubsub
+import ../../waku/waku_rln_relay
+
+const Help =
+ """
+ Commands: /[?|help|connect|nick|exit]
+ help: Prints this help
+ connect: dials a remote peer
+ nick: change nickname for current chat session
+ exit: exits chat session
+"""
+
+# XXX Connected is a bit annoying, because incoming connections don't trigger state change
+# Could poll connection pool or something here, I suppose
+# TODO Ensure connected turns true on incoming connections, or get rid of it
+type Chat = ref object
+ node: WakuNode # waku node for publishing, subscribing, etc
+ transp: StreamTransport # transport streams between read & write file descriptor
+ subscribed: bool # indicates if a node is subscribed or not to a topic
+ connected: bool # if the node is connected to another peer
+ started: bool # if the node has started
+ nick: string # nickname for this chat session
+ prompt: bool # chat prompt is showing
+ contentTopic: string # default content topic for chat messages
+
+type
+ PrivateKey* = crypto.PrivateKey
+ Topic* = waku_core.PubsubTopic
+
+#####################
+## chat2 protobufs ##
+#####################
+
+type
+ SelectResult*[T] = Result[T, string]
+
+ Chat2Message* = object
+ timestamp*: int64
+ nick*: string
+ payload*: seq[byte]
+
+proc init*(T: type Chat2Message, buffer: seq[byte]): ProtoResult[T] =
+ var msg = Chat2Message()
+ let pb = initProtoBuffer(buffer)
+
+ var timestamp: uint64
+ discard ?pb.getField(1, timestamp)
+ msg.timestamp = int64(timestamp)
+
+ discard ?pb.getField(2, msg.nick)
+ discard ?pb.getField(3, msg.payload)
+
+ ok(msg)
+
+proc encode*(message: Chat2Message): ProtoBuffer =
+ var serialised = initProtoBuffer()
+
+ serialised.write(1, uint64(message.timestamp))
+ serialised.write(2, message.nick)
+ serialised.write(3, message.payload)
+
+ return serialised
+
+proc toString*(message: Chat2Message): string =
+ # Get message date and timestamp in local time
+ let time = message.timestamp.fromUnix().local().format("'<'MMM' 'dd,' 'HH:mm'>'")
+
+ return time & " " & message.nick & ": " & string.fromBytes(message.payload)
+
+#####################
+
+proc connectToNodes(c: Chat, nodes: seq[string]) {.async.} =
+ echo "Connecting to nodes"
+ await c.node.connectToNodes(nodes)
+ c.connected = true
+
+proc showChatPrompt(c: Chat) =
+ if not c.prompt:
+ try:
+ stdout.write(">> ")
+ stdout.flushFile()
+ c.prompt = true
+ except IOError:
+ discard
+
+proc getChatLine(c: Chat, msg: WakuMessage): Result[string, string] =
+ # No payload encoding/encryption from Waku
+ let
+ pb = Chat2Message.init(msg.payload)
+ chatLine =
+ if pb.isOk:
+ pb[].toString()
+ else:
+ string.fromBytes(msg.payload)
+ return ok(chatline)
+
+proc printReceivedMessage(c: Chat, msg: WakuMessage) =
+ let
+ pb = Chat2Message.init(msg.payload)
+ chatLine =
+ if pb.isOk:
+ pb[].toString()
+ else:
+ string.fromBytes(msg.payload)
+ try:
+ echo &"{chatLine}"
+ except ValueError:
+ # Formatting fail. Print chat line in any case.
+ echo chatLine
+
+ c.prompt = false
+ showChatPrompt(c)
+ trace "Printing message",
+ topic = DefaultPubsubTopic, chatLine, contentTopic = msg.contentTopic
+
+proc readNick(transp: StreamTransport): Future[string] {.async.} =
+ # Chat prompt
+ stdout.write("Choose a nickname >> ")
+ stdout.flushFile()
+ return await transp.readLine()
+
+proc startMetricsServer(
+ serverIp: IpAddress, serverPort: Port
+): Result[MetricsHttpServerRef, string] =
+ info "Starting metrics HTTP server", serverIp = $serverIp, serverPort = $serverPort
+
+ let metricsServerRes = MetricsHttpServerRef.new($serverIp, serverPort)
+ if metricsServerRes.isErr():
+ return err("metrics HTTP server start failed: " & $metricsServerRes.error)
+
+ let server = metricsServerRes.value
+ try:
+ waitFor server.start()
+ except CatchableError:
+ return err("metrics HTTP server start failed: " & getCurrentExceptionMsg())
+
+ info "Metrics HTTP server started", serverIp = $serverIp, serverPort = $serverPort
+ ok(metricsServerRes.value)
+
+proc publish(c: Chat, line: string) =
+ # First create a Chat2Message protobuf with this line of text
+ let time = getTime().toUnix()
+ let chat2pb =
+ Chat2Message(timestamp: time, nick: c.nick, payload: line.toBytes()).encode()
+
+ ## @TODO: error handling on failure
+ proc handler(response: PushResponse) {.gcsafe, closure.} =
+ trace "lightpush response received", response = response
+
+ var message = WakuMessage(
+ payload: chat2pb.buffer,
+ contentTopic: c.contentTopic,
+ version: 0,
+ timestamp: getNanosecondTime(time),
+ )
+ if not isNil(c.node.wakuRlnRelay):
+ # for future version when we support more than one rln protected content topic,
+ # we should check the message content topic as well
+ let appendRes = c.node.wakuRlnRelay.appendRLNProof(message, float64(time))
+ if appendRes.isErr():
+ debug "could not append rate limit proof to the message"
+ else:
+ debug "rate limit proof is appended to the message"
+ let decodeRes = RateLimitProof.init(message.proof)
+ if decodeRes.isErr():
+ error "could not decode the RLN proof"
+
+ let proof = decodeRes.get()
+ # TODO move it to log after dogfooding
+ let msgEpoch = fromEpoch(proof.epoch)
+ if fromEpoch(c.node.wakuRlnRelay.lastEpoch) == msgEpoch:
+ echo "--rln epoch: ",
+ msgEpoch, " ⚠️ message rate violation! you are spamming the network!"
+ else:
+ echo "--rln epoch: ", msgEpoch
+ # update the last epoch
+ c.node.wakuRlnRelay.lastEpoch = proof.epoch
+
+ try:
+ if not c.node.wakuLegacyLightPush.isNil():
+ # Attempt lightpush
+ (waitFor c.node.legacyLightpushPublish(some(DefaultPubsubTopic), message)).isOkOr:
+ error "failed to publish lightpush message", error = error
+ else:
+ (waitFor c.node.publish(some(DefaultPubsubTopic), message)).isOkOr:
+ error "failed to publish message", error = error
+ except CatchableError:
+ error "caught error publishing message: ", error = getCurrentExceptionMsg()
+
+# TODO This should read or be subscribe handler subscribe
+proc readAndPrint(c: Chat) {.async.} =
+ while true:
+ # while p.connected:
+ # # TODO: echo &"{p.id} -> "
+ #
+ # echo cast[string](await p.conn.readLp(1024))
+ #echo "readAndPrint subscribe NYI"
+ await sleepAsync(100.millis)
+
+# TODO Implement
+proc writeAndPrint(c: Chat) {.async.} =
+ while true:
+ # Connect state not updated on incoming WakuRelay connections
+ # if not c.connected:
+ # echo "type an address or wait for a connection:"
+ # echo "type /[help|?] for help"
+
+ # Chat prompt
+ showChatPrompt(c)
+
+ let line = await c.transp.readLine()
+ if line.startsWith("/help") or line.startsWith("/?") or not c.started:
+ echo Help
+ continue
+
+ # if line.startsWith("/disconnect"):
+ # echo "Ending current session"
+ # if p.connected and p.conn.closed.not:
+ # await p.conn.close()
+ # p.connected = false
+ elif line.startsWith("/connect"):
+ # TODO Should be able to connect to multiple peers for Waku chat
+ if c.connected:
+ echo "already connected to at least one peer"
+ continue
+
+ echo "enter address of remote peer"
+ let address = await c.transp.readLine()
+ if address.len > 0:
+ await c.connectToNodes(@[address])
+ elif line.startsWith("/nick"):
+ # Set a new nickname
+ c.nick = await readNick(c.transp)
+ echo "You are now known as " & c.nick
+ elif line.startsWith("/exit"):
+ echo "quitting..."
+
+ try:
+ await c.node.stop()
+ except:
+ echo "exception happened when stopping: " & getCurrentExceptionMsg()
+
+ quit(QuitSuccess)
+ else:
+ # XXX connected state problematic
+ if c.started:
+ c.publish(line)
+ # TODO Connect to peer logic?
+ else:
+ try:
+ if line.startsWith("/") and "p2p" in line:
+ await c.connectToNodes(@[line])
+ except:
+ echo &"unable to dial remote peer {line}"
+ echo getCurrentExceptionMsg()
+
+proc readWriteLoop(c: Chat) {.async.} =
+ asyncSpawn c.writeAndPrint() # execute the async function but does not block
+ asyncSpawn c.readAndPrint()
+
+proc readInput(wfd: AsyncFD) {.thread, raises: [Defect, CatchableError].} =
+ ## This procedure performs reading from `stdin` and sends data over
+ ## pipe to main thread.
+ let transp = fromPipe(wfd)
+
+ while true:
+ let line = stdin.readLine()
+ discard waitFor transp.write(line & "\r\n")
+
+{.pop.}
+ # @TODO confutils.nim(775, 17) Error: can raise an unlisted exception: ref IOError
+proc processInput(rfd: AsyncFD, rng: ref HmacDrbgContext) {.async.} =
+ let
+ transp = fromPipe(rfd)
+ conf = Chat2Conf.load()
+ nodekey =
+ if conf.nodekey.isSome():
+ conf.nodekey.get()
+ else:
+ PrivateKey.random(Secp256k1, rng[]).tryGet()
+
+ # set log level
+ if conf.logLevel != LogLevel.NONE:
+ setLogLevel(conf.logLevel)
+
+ let natRes = setupNat(
+ conf.nat,
+ clientId,
+ Port(uint16(conf.tcpPort) + conf.portsShift),
+ Port(uint16(conf.udpPort) + conf.portsShift),
+ )
+
+ if natRes.isErr():
+ raise newException(ValueError, "setupNat error " & natRes.error)
+
+ let (extIp, extTcpPort, extUdpPort) = natRes.get()
+
+ var enrBuilder = EnrBuilder.init(nodeKey)
+
+ let recordRes = enrBuilder.build()
+ let record =
+ if recordRes.isErr():
+ error "failed to create enr record", error = recordRes.error
+ quit(QuitFailure)
+ else:
+ recordRes.get()
+
+ let node = block:
+ var builder = WakuNodeBuilder.init()
+ builder.withNodeKey(nodeKey)
+ builder.withRecord(record)
+
+ builder
+ .withNetworkConfigurationDetails(
+ conf.listenAddress,
+ Port(uint16(conf.tcpPort) + conf.portsShift),
+ extIp,
+ extTcpPort,
+ wsBindPort = Port(uint16(conf.websocketPort) + conf.portsShift),
+ wsEnabled = conf.websocketSupport,
+ wssEnabled = conf.websocketSecureSupport,
+ )
+ .tryGet()
+ builder.build().tryGet()
+
+ await node.start()
+
+ if conf.rlnRelayCredPath == "":
+ raise newException(ConfigurationError, "rln-relay-cred-path MUST be passed")
+
+ if conf.relay:
+ let shards =
+ conf.shards.mapIt(RelayShard(clusterId: conf.clusterId, shardId: uint16(it)))
+ (await node.mountRelay()).isOkOr:
+ echo "failed to mount relay: " & error
+ return
+
+ await node.mountLibp2pPing()
+
+ let nick = await readNick(transp)
+ echo "Welcome, " & nick & "!"
+
+ var chat = Chat(
+ node: node,
+ transp: transp,
+ subscribed: true,
+ connected: false,
+ started: true,
+ nick: nick,
+ prompt: false,
+ contentTopic: conf.contentTopic,
+ )
+
+ if conf.staticnodes.len > 0:
+ echo "Connecting to static peers..."
+ await connectToNodes(chat, conf.staticnodes)
+
+ var dnsDiscoveryUrl = none(string)
+
+ if conf.fleet != Fleet.none:
+ # Use DNS discovery to connect to selected fleet
+ echo "Connecting to " & $conf.fleet & " fleet using DNS discovery..."
+
+ if conf.fleet == Fleet.test:
+ dnsDiscoveryUrl = some(
+ "enrtree://AOGYWMBYOUIMOENHXCHILPKY3ZRFEULMFI4DOM442QSZ73TT2A7VI@test.waku.nodes.status.im"
+ )
+ else:
+ # Connect to sandbox by default
+ dnsDiscoveryUrl = some(
+ "enrtree://AIRVQ5DDA4FFWLRBCHJWUWOO6X6S4ZTZ5B667LQ6AJU6PEYDLRD5O@sandbox.waku.nodes.status.im"
+ )
+ elif conf.dnsDiscoveryUrl != "":
+ # No pre-selected fleet. Discover nodes via DNS using user config
+ debug "Discovering nodes using Waku DNS discovery", url = conf.dnsDiscoveryUrl
+ dnsDiscoveryUrl = some(conf.dnsDiscoveryUrl)
+
+ var discoveredNodes: seq[RemotePeerInfo]
+
+ if dnsDiscoveryUrl.isSome:
+ var nameServers: seq[TransportAddress]
+ for ip in conf.dnsAddrsNameServers:
+ nameServers.add(initTAddress(ip, Port(53))) # Assume all servers use port 53
+
+ let dnsResolver = DnsResolver.new(nameServers)
+
+ proc resolver(domain: string): Future[string] {.async, gcsafe.} =
+ trace "resolving", domain = domain
+ let resolved = await dnsResolver.resolveTxt(domain)
+ return resolved[0] # Use only first answer
+
+ var wakuDnsDiscovery = WakuDnsDiscovery.init(dnsDiscoveryUrl.get(), resolver)
+ if wakuDnsDiscovery.isOk:
+ let discoveredPeers = await wakuDnsDiscovery.get().findPeers()
+ if discoveredPeers.isOk:
+ info "Connecting to discovered peers"
+ discoveredNodes = discoveredPeers.get()
+ echo "Discovered and connecting to " & $discoveredNodes
+ waitFor chat.node.connectToNodes(discoveredNodes)
+ else:
+ warn "Failed to init Waku DNS discovery"
+
+ let peerInfo = node.switch.peerInfo
+ let listenStr = $peerInfo.addrs[0] & "/p2p/" & $peerInfo.peerId
+ echo &"Listening on\n {listenStr}"
+
+ if (conf.storenode != "") or (conf.store == true):
+ await node.mountStore()
+
+ var storenode: Option[RemotePeerInfo]
+
+ if conf.storenode != "":
+ let peerInfo = parsePeerInfo(conf.storenode)
+ if peerInfo.isOk():
+ storenode = some(peerInfo.value)
+ else:
+ error "Incorrect conf.storenode", error = peerInfo.error
+ elif discoveredNodes.len > 0:
+ echo "Store enabled, but no store nodes configured. Choosing one at random from discovered peers"
+ storenode = some(discoveredNodes[rand(0 .. len(discoveredNodes) - 1)])
+
+ if storenode.isSome():
+ # We have a viable storenode. Let's query it for historical messages.
+ echo "Connecting to storenode: " & $(storenode.get())
+
+ node.mountStoreClient()
+ node.peerManager.addServicePeer(storenode.get(), WakuStoreCodec)
+
+ proc storeHandler(response: StoreQueryResponse) {.gcsafe.} =
+ for msg in response.messages:
+ let payload =
+ if msg.message.isSome():
+ msg.message.get().payload
+ else:
+ newSeq[byte](0)
+
+ let
+ pb = Chat2Message.init(payload)
+ chatLine =
+ if pb.isOk:
+ pb[].toString()
+ else:
+ string.fromBytes(payload)
+ echo &"{chatLine}"
+ info "Hit store handler"
+
+ let queryRes = await node.query(
+ StoreQueryRequest(contentTopics: @[chat.contentTopic]), storenode.get()
+ )
+ if queryRes.isOk():
+ storeHandler(queryRes.value)
+
+ # NOTE Must be mounted after relay
+ if conf.lightpushnode != "":
+ let peerInfo = parsePeerInfo(conf.lightpushnode)
+ if peerInfo.isOk():
+ await mountLegacyLightPush(node)
+ node.mountLegacyLightPushClient()
+ node.peerManager.addServicePeer(peerInfo.value, WakuLightpushCodec)
+ else:
+ error "LightPush not mounted. Couldn't parse conf.lightpushnode",
+ error = peerInfo.error
+
+ if conf.filternode != "":
+ let peerInfo = parsePeerInfo(conf.filternode)
+ if peerInfo.isOk():
+ await node.mountFilter()
+ await node.mountFilterClient()
+
+ proc filterHandler(
+ pubsubTopic: PubsubTopic, msg: WakuMessage
+ ) {.async, gcsafe, closure.} =
+ trace "Hit filter handler", contentTopic = msg.contentTopic
+ chat.printReceivedMessage(msg)
+
+ # TODO: Here to support FilterV2 relevant subscription.
+ else:
+ error "Filter not mounted. Couldn't parse conf.filternode", error = peerInfo.error
+
+ # Subscribe to a topic, if relay is mounted
+ if conf.relay:
+ proc handler(topic: PubsubTopic, msg: WakuMessage): Future[void] {.async, gcsafe.} =
+ trace "Hit subscribe handler", topic
+
+ if msg.contentTopic == chat.contentTopic:
+ chat.printReceivedMessage(msg)
+
+ node.subscribe(
+ (kind: PubsubSub, topic: DefaultPubsubTopic), WakuRelayHandler(handler)
+ ).isOkOr:
+ error "failed to subscribe to pubsub topic",
+ topic = DefaultPubsubTopic, error = error
+
+ if conf.rlnRelay:
+ info "WakuRLNRelay is enabled"
+
+ proc spamHandler(wakuMessage: WakuMessage) {.gcsafe, closure.} =
+ debug "spam handler is called"
+ let chatLineResult = chat.getChatLine(wakuMessage)
+ if chatLineResult.isOk():
+ echo "A spam message is found and discarded : ", chatLineResult.value
+ else:
+ echo "A spam message is found and discarded"
+ chat.prompt = false
+ showChatPrompt(chat)
+
+ echo "rln-relay preparation is in progress..."
+
+ let rlnConf = WakuRlnConfig(
+ dynamic: conf.rlnRelayDynamic,
+ credIndex: conf.rlnRelayCredIndex,
+ chainId: UInt256.fromBytesBE(conf.rlnRelayChainId.toBytesBE()),
+ ethClientUrls: conf.ethClientUrls.mapIt(string(it)),
+ creds: some(
+ RlnRelayCreds(
+ path: conf.rlnRelayCredPath, password: conf.rlnRelayCredPassword
+ )
+ ),
+ userMessageLimit: conf.rlnRelayUserMessageLimit,
+ epochSizeSec: conf.rlnEpochSizeSec,
+ )
+
+ waitFor node.mountRlnRelay(rlnConf, spamHandler = some(spamHandler))
+
+ let membershipIndex = node.wakuRlnRelay.groupManager.membershipIndex.get()
+ let identityCredential = node.wakuRlnRelay.groupManager.idCredentials.get()
+ echo "your membership index is: ", membershipIndex
+ echo "your rln identity commitment key is: ",
+ identityCredential.idCommitment.inHex()
+ else:
+ info "WakuRLNRelay is disabled"
+ echo "WakuRLNRelay is disabled, please enable it by passing in the --rln-relay flag"
+ if conf.metricsLogging:
+ startMetricsLog()
+
+ if conf.metricsServer:
+ let metricsServer = startMetricsServer(
+ conf.metricsServerAddress, Port(conf.metricsServerPort + conf.portsShift)
+ )
+
+ await chat.readWriteLoop()
+
+ runForever()
+
+proc main(rng: ref HmacDrbgContext) {.async.} =
+ let (rfd, wfd) = createAsyncPipe()
+ if rfd == asyncInvalidPipe or wfd == asyncInvalidPipe:
+ raise newException(ValueError, "Could not initialize pipe!")
+
+ var thread: Thread[AsyncFD]
+ thread.createThread(readInput, wfd)
+ try:
+ await processInput(rfd, rng)
+ # Handle only ConfigurationError for now
+ # TODO: Throw other errors from the mounting procedure
+ except ConfigurationError as e:
+ raise e
+
+when isMainModule: # isMainModule = true when the module is compiled as the main file
+ let rng = crypto.newRng()
+ try:
+ waitFor(main(rng))
+ except CatchableError as e:
+ raise e
+
+## Dump of things that can be improved:
+##
+## - Incoming dialed peer does not change connected state (not relying on it for now)
+## - Unclear if staticnode argument works (can enter manually)
+## - Don't trigger self / double publish own messages
+## - Integrate store protocol (fetch messages in beginning)
+## - Integrate filter protocol (default/option to be light node, connect to filter node)
+## - Test/default to cluster node connection (diff protocol version)
+## - Redirect logs to separate file
+## - Expose basic publish/subscribe etc commands with /syntax
+## - Show part of peerid to know who sent message
+## - Deal with protobuf messages (e.g. other chat protocol, or encrypted)
diff --git a/third-party/nwaku/apps/chat2/config_chat2.nim b/third-party/nwaku/apps/chat2/config_chat2.nim
new file mode 100644
index 0000000..fe7865c
--- /dev/null
+++ b/third-party/nwaku/apps/chat2/config_chat2.nim
@@ -0,0 +1,351 @@
+import
+ chronicles,
+ chronos,
+ confutils,
+ confutils/defs,
+ confutils/std/net,
+ eth/keys,
+ libp2p/crypto/crypto,
+ libp2p/crypto/secp,
+ nimcrypto/utils,
+ std/strutils,
+ regex
+import waku/waku_core
+
+type
+ Fleet* = enum
+ none
+ prod
+ test
+
+ EthRpcUrl* = distinct string
+
+ Chat2Conf* = object ## General node config
+ logLevel* {.
+ desc: "Sets the log level.", defaultValue: LogLevel.INFO, name: "log-level"
+ .}: LogLevel
+
+ nodekey* {.desc: "P2P node private key as 64 char hex string.", name: "nodekey".}:
+ Option[crypto.PrivateKey]
+
+ listenAddress* {.
+ defaultValue: defaultListenAddress(config),
+ desc: "Listening address for the LibP2P traffic.",
+ name: "listen-address"
+ .}: IpAddress
+
+ tcpPort* {.desc: "TCP listening port.", defaultValue: 60000, name: "tcp-port".}:
+ Port
+
+ udpPort* {.desc: "UDP listening port.", defaultValue: 60000, name: "udp-port".}:
+ Port
+
+ portsShift* {.
+ desc: "Add a shift to all port numbers.", defaultValue: 0, name: "ports-shift"
+ .}: uint16
+
+ nat* {.
+ desc:
+ "Specify method to use for determining public address. " &
+ "Must be one of: any, none, upnp, pmp, extip:.",
+ defaultValue: "any"
+ .}: string
+
+ ## Persistence config
+ dbPath* {.
+ desc: "The database path for peristent storage", defaultValue: "", name: "db-path"
+ .}: string
+
+ persistPeers* {.
+ desc: "Enable peer persistence: true|false",
+ defaultValue: false,
+ name: "persist-peers"
+ .}: bool
+
+ persistMessages* {.
+ desc: "Enable message persistence: true|false",
+ defaultValue: false,
+ name: "persist-messages"
+ .}: bool
+
+ ## Relay config
+ relay* {.
+ desc: "Enable relay protocol: true|false", defaultValue: true, name: "relay"
+ .}: bool
+
+ staticnodes* {.
+ desc: "Peer multiaddr to directly connect with. Argument may be repeated.",
+ name: "staticnode"
+ .}: seq[string]
+
+ keepAlive* {.
+ desc: "Enable keep-alive for idle connections: true|false",
+ defaultValue: false,
+ name: "keep-alive"
+ .}: bool
+
+ clusterId* {.
+ desc:
+ "Cluster id that the node is running in. Node in a different cluster id is disconnected.",
+ defaultValue: 0,
+ name: "cluster-id"
+ .}: uint16
+
+ shards* {.
+ desc:
+ "Shards index to subscribe to [0..NUM_SHARDS_IN_NETWORK-1]. Argument may be repeated.",
+ defaultValue: @[uint16(0)],
+ name: "shard"
+ .}: seq[uint16]
+
+ ## Store config
+ store* {.
+ desc: "Enable store protocol: true|false", defaultValue: true, name: "store"
+ .}: bool
+
+ storenode* {.
+ desc: "Peer multiaddr to query for storage.", defaultValue: "", name: "storenode"
+ .}: string
+
+ ## Filter config
+ filter* {.
+ desc: "Enable filter protocol: true|false", defaultValue: false, name: "filter"
+ .}: bool
+
+ filternode* {.
+ desc: "Peer multiaddr to request content filtering of messages.",
+ defaultValue: "",
+ name: "filternode"
+ .}: string
+
+ ## Lightpush config
+ lightpush* {.
+ desc: "Enable lightpush protocol: true|false",
+ defaultValue: false,
+ name: "lightpush"
+ .}: bool
+
+ lightpushnode* {.
+ desc: "Peer multiaddr to request lightpush of published messages.",
+ defaultValue: "",
+ name: "lightpushnode"
+ .}: string
+
+ ## Metrics config
+ metricsServer* {.
+ desc: "Enable the metrics server: true|false",
+ defaultValue: false,
+ name: "metrics-server"
+ .}: bool
+
+ metricsServerAddress* {.
+ desc: "Listening address of the metrics server.",
+ defaultValue: parseIpAddress("127.0.0.1"),
+ name: "metrics-server-address"
+ .}: IpAddress
+
+ metricsServerPort* {.
+ desc: "Listening HTTP port of the metrics server.",
+ defaultValue: 8008,
+ name: "metrics-server-port"
+ .}: uint16
+
+ metricsLogging* {.
+ desc: "Enable metrics logging: true|false",
+ defaultValue: true,
+ name: "metrics-logging"
+ .}: bool
+
+ ## DNS discovery config
+ dnsDiscovery* {.
+ desc:
+ "Deprecated, please set dns-discovery-url instead. Enable discovering nodes via DNS",
+ defaultValue: false,
+ name: "dns-discovery"
+ .}: bool
+
+ dnsDiscoveryUrl* {.
+ desc: "URL for DNS node list in format 'enrtree://@'",
+ defaultValue: "",
+ name: "dns-discovery-url"
+ .}: string
+
+ dnsAddrsNameServers* {.
+ desc:
+ "DNS name server IPs to query for DNS multiaddrs resolution. Argument may be repeated.",
+ defaultValue: @[parseIpAddress("1.1.1.1"), parseIpAddress("1.0.0.1")],
+ name: "dns-addrs-name-server"
+ .}: seq[IpAddress]
+
+ ## Chat2 configuration
+ fleet* {.
+ desc:
+ "Select the fleet to connect to. This sets the DNS discovery URL to the selected fleet.",
+ defaultValue: Fleet.prod,
+ name: "fleet"
+ .}: Fleet
+
+ contentTopic* {.
+ desc: "Content topic for chat messages.",
+ defaultValue: "/toy-chat/2/huilong/proto",
+ name: "content-topic"
+ .}: string
+
+ ## Websocket Configuration
+ websocketSupport* {.
+ desc: "Enable websocket: true|false",
+ defaultValue: false,
+ name: "websocket-support"
+ .}: bool
+
+ websocketPort* {.
+ desc: "WebSocket listening port.", defaultValue: 8000, name: "websocket-port"
+ .}: Port
+
+ websocketSecureSupport* {.
+ desc: "WebSocket Secure Support.",
+ defaultValue: false,
+ name: "websocket-secure-support"
+ .}: bool
+
+ ## rln-relay configuration
+ rlnRelay* {.
+ desc: "Enable spam protection through rln-relay: true|false",
+ defaultValue: false,
+ name: "rln-relay"
+ .}: bool
+
+ rlnRelayChainId* {.
+ desc:
+ "Chain ID of the provided contract (optional, will fetch from RPC provider if not used)",
+ defaultValue: 0,
+ name: "rln-relay-chain-id"
+ .}: uint
+
+ rlnRelayCredPath* {.
+ desc: "The path for peristing rln-relay credential",
+ defaultValue: "",
+ name: "rln-relay-cred-path"
+ .}: string
+
+ rlnRelayCredIndex* {.
+ desc: "the index of the onchain commitment to use", name: "rln-relay-cred-index"
+ .}: Option[uint]
+
+ rlnRelayDynamic* {.
+ desc: "Enable waku-rln-relay with on-chain dynamic group management: true|false",
+ defaultValue: false,
+ name: "rln-relay-dynamic"
+ .}: bool
+
+ rlnRelayIdKey* {.
+ desc: "Rln relay identity secret key as a Hex string",
+ defaultValue: "",
+ name: "rln-relay-id-key"
+ .}: string
+
+ rlnRelayIdCommitmentKey* {.
+ desc: "Rln relay identity commitment key as a Hex string",
+ defaultValue: "",
+ name: "rln-relay-id-commitment-key"
+ .}: string
+
+ ethClientUrls* {.
+ desc:
+ "HTTP address of an Ethereum testnet client e.g., http://localhost:8540/. Argument may be repeated.",
+ defaultValue: newSeq[EthRpcUrl](0),
+ name: "rln-relay-eth-client-address"
+ .}: seq[EthRpcUrl]
+
+ rlnRelayEthContractAddress* {.
+ desc: "Address of membership contract on an Ethereum testnet",
+ defaultValue: "",
+ name: "rln-relay-eth-contract-address"
+ .}: string
+
+ rlnRelayCredPassword* {.
+ desc: "Password for encrypting RLN credentials",
+ defaultValue: "",
+ name: "rln-relay-cred-password"
+ .}: string
+
+ rlnRelayUserMessageLimit* {.
+ desc:
+ "Set a user message limit for the rln membership registration. Must be a positive integer. Default is 1.",
+ defaultValue: 1,
+ name: "rln-relay-user-message-limit"
+ .}: uint64
+
+ rlnEpochSizeSec* {.
+ desc:
+ "Epoch size in seconds used to rate limit RLN memberships. Default is 1 second.",
+ defaultValue: 1,
+ name: "rln-relay-epoch-sec"
+ .}: uint64
+
+# NOTE: Keys are different in nim-libp2p
+proc parseCmdArg*(T: type crypto.PrivateKey, p: string): T =
+ try:
+ let key = SkPrivateKey.init(utils.fromHex(p)).tryGet()
+ # XXX: Here at the moment
+ result = crypto.PrivateKey(scheme: Secp256k1, skkey: key)
+ except CatchableError as e:
+ raise newException(ValueError, "Invalid private key")
+
+proc completeCmdArg*(T: type crypto.PrivateKey, val: string): seq[string] =
+ return @[]
+
+proc parseCmdArg*(T: type IpAddress, p: string): T =
+ try:
+ result = parseIpAddress(p)
+ except CatchableError as e:
+ raise newException(ValueError, "Invalid IP address")
+
+proc completeCmdArg*(T: type IpAddress, val: string): seq[string] =
+ return @[]
+
+proc parseCmdArg*(T: type Port, p: string): T =
+ try:
+ result = Port(parseInt(p))
+ except CatchableError as e:
+ raise newException(ValueError, "Invalid Port number")
+
+proc completeCmdArg*(T: type Port, val: string): seq[string] =
+ return @[]
+
+proc parseCmdArg*(T: type Option[uint], p: string): T =
+ try:
+ some(parseUint(p))
+ except CatchableError:
+ raise newException(ValueError, "Invalid unsigned integer")
+
+proc completeCmdArg*(T: type EthRpcUrl, val: string): seq[string] =
+ return @[]
+
+proc parseCmdArg*(T: type EthRpcUrl, s: string): T =
+ ## allowed patterns:
+ ## http://url:port
+ ## https://url:port
+ ## http://url:port/path
+ ## https://url:port/path
+ ## http://url/with/path
+ ## http://url:port/path?query
+ ## https://url:port/path?query
+ ## disallowed patterns:
+ ## any valid/invalid ws or wss url
+ var httpPattern =
+ re2"^(https?):\/\/((localhost)|([\w_-]+(?:(?:\.[\w_-]+)+)))(:[0-9]{1,5})?([\w.,@?^=%&:\/~+#-]*[\w@?^=%&\/~+#-])*"
+ var wsPattern =
+ re2"^(wss?):\/\/((localhost)|([\w_-]+(?:(?:\.[\w_-]+)+)))(:[0-9]{1,5})?([\w.,@?^=%&:\/~+#-]*[\w@?^=%&\/~+#-])*"
+ if regex.match(s, wsPattern):
+ raise newException(
+ ValueError, "Websocket RPC URL is not supported, Please use an HTTP URL"
+ )
+ if not regex.match(s, httpPattern):
+ raise newException(ValueError, "Invalid HTTP RPC URL")
+ return EthRpcUrl(s)
+
+func defaultListenAddress*(conf: Chat2Conf): IpAddress =
+ # TODO: How should we select between IPv4 and IPv6
+ # Maybe there should be a config option for this.
+ (static parseIpAddress("0.0.0.0"))
diff --git a/third-party/nwaku/apps/chat2/nim.cfg b/third-party/nwaku/apps/chat2/nim.cfg
new file mode 100644
index 0000000..2231f2e
--- /dev/null
+++ b/third-party/nwaku/apps/chat2/nim.cfg
@@ -0,0 +1,4 @@
+-d:chronicles_line_numbers
+-d:chronicles_runtime_filtering:on
+-d:discv5_protocol_id:d5waku
+path = "../.."
diff --git a/third-party/nwaku/apps/chat2bridge/chat2bridge.nim b/third-party/nwaku/apps/chat2bridge/chat2bridge.nim
new file mode 100644
index 0000000..c2bf9c0
--- /dev/null
+++ b/third-party/nwaku/apps/chat2bridge/chat2bridge.nim
@@ -0,0 +1,328 @@
+{.push raises: [].}
+
+import
+ std/[tables, times, strutils, hashes, sequtils, json],
+ chronos,
+ confutils,
+ chronicles,
+ chronicles/topics_registry,
+ chronos/streams/tlsstream,
+ metrics,
+ metrics/chronos_httpserver,
+ stew/byteutils,
+ eth/net/nat,
+ # Matterbridge client imports
+ # Waku v2 imports
+ libp2p/crypto/crypto,
+ libp2p/errors,
+ waku/[
+ waku_core,
+ waku_node,
+ node/peer_manager,
+ waku_filter_v2,
+ waku_store,
+ factory/builder,
+ common/utils/matterbridge_client,
+ common/rate_limit/setting,
+ ],
+ # Chat 2 imports
+ ../chat2/chat2,
+ # Common cli config
+ ./config_chat2bridge
+
+declarePublicCounter chat2_mb_transfers,
+ "Number of messages transferred between chat2 and Matterbridge", ["type"]
+declarePublicCounter chat2_mb_dropped, "Number of messages dropped", ["reason"]
+
+logScope:
+ topics = "chat2bridge"
+
+##################
+# Default values #
+##################
+
+const DeduplQSize = 20 # Maximum number of seen messages to keep in deduplication queue
+
+#########
+# Types #
+#########
+
+type
+ Chat2MatterBridge* = ref object of RootObj
+ mbClient*: MatterbridgeClient
+ nodev2*: WakuNode
+ running: bool
+ pollPeriod: chronos.Duration
+ seen: seq[Hash] #FIFO queue
+ contentTopic: string
+
+ MbMessageHandler = proc(jsonNode: JsonNode) {.async.}
+
+###################
+# Helper functions #
+###################S
+
+proc containsOrAdd(sequence: var seq[Hash], hash: Hash): bool =
+ if sequence.contains(hash):
+ return true
+
+ if sequence.len >= DeduplQSize:
+ trace "Deduplication queue full. Removing oldest item."
+ sequence.delete 0, 0 # Remove first item in queue
+
+ sequence.add(hash)
+
+ return false
+
+proc toWakuMessage(
+ cmb: Chat2MatterBridge, jsonNode: JsonNode
+): WakuMessage {.raises: [Defect, KeyError].} =
+ # Translates a Matterbridge API JSON response to a Waku v2 message
+ let msgFields = jsonNode.getFields()
+
+ # @TODO error handling here - verify expected fields
+
+ let chat2pb = Chat2Message(
+ timestamp: getTime().toUnix(), # @TODO use provided timestamp
+ nick: msgFields["username"].getStr(),
+ payload: msgFields["text"].getStr().toBytes(),
+ ).encode()
+
+ WakuMessage(payload: chat2pb.buffer, contentTopic: cmb.contentTopic, version: 0)
+
+proc toChat2(cmb: Chat2MatterBridge, jsonNode: JsonNode) {.async.} =
+ let msg = cmb.toWakuMessage(jsonNode)
+
+ if cmb.seen.containsOrAdd(msg.payload.hash()):
+ # This is a duplicate message. Return.
+ chat2_mb_dropped.inc(labelValues = ["duplicate"])
+ return
+
+ trace "Post Matterbridge message to chat2"
+
+ chat2_mb_transfers.inc(labelValues = ["mb_to_chat2"])
+
+ (await cmb.nodev2.publish(some(DefaultPubsubTopic), msg)).isOkOr:
+ error "failed to publish message", error = error
+
+proc toMatterbridge(
+ cmb: Chat2MatterBridge, msg: WakuMessage
+) {.gcsafe, raises: [Exception].} =
+ if cmb.seen.containsOrAdd(msg.payload.hash()):
+ # This is a duplicate message. Return.
+ chat2_mb_dropped.inc(labelValues = ["duplicate"])
+ return
+
+ if msg.contentTopic != cmb.contentTopic:
+ # Only bridge messages on the configured content topic
+ chat2_mb_dropped.inc(labelValues = ["filtered"])
+ return
+
+ trace "Post chat2 message to Matterbridge"
+
+ chat2_mb_transfers.inc(labelValues = ["chat2_to_mb"])
+
+ let chat2Msg = Chat2Message.init(msg.payload)
+
+ assert chat2Msg.isOk
+
+ let postRes = cmb.mbClient.postMessage(
+ text = string.fromBytes(chat2Msg[].payload), username = chat2Msg[].nick
+ )
+
+ if postRes.isErr() or (postRes[] == false):
+ chat2_mb_dropped.inc(labelValues = ["duplicate"])
+ error "Matterbridge host unreachable. Dropping message."
+
+proc pollMatterbridge(cmb: Chat2MatterBridge, handler: MbMessageHandler) {.async.} =
+ while cmb.running:
+ let getRes = cmb.mbClient.getMessages()
+
+ if getRes.isOk():
+ for jsonNode in getRes[]:
+ await handler(jsonNode)
+ else:
+ error "Matterbridge host unreachable. Sleeping before retrying."
+ await sleepAsync(chronos.seconds(10))
+
+ await sleepAsync(cmb.pollPeriod)
+
+##############
+# Public API #
+##############
+proc new*(
+ T: type Chat2MatterBridge,
+ # Matterbridge initialisation
+ mbHostUri: string,
+ mbGateway: string,
+ # NodeV2 initialisation
+ nodev2Key: crypto.PrivateKey,
+ nodev2BindIp: IpAddress,
+ nodev2BindPort: Port,
+ nodev2ExtIp = none[IpAddress](),
+ nodev2ExtPort = none[Port](),
+ contentTopic: string,
+): T {.
+ raises: [Defect, ValueError, KeyError, TLSStreamProtocolError, IOError, LPError]
+.} =
+ # Setup Matterbridge
+ let mbClient = MatterbridgeClient.new(mbHostUri, mbGateway)
+
+ # Let's verify the Matterbridge configuration before continuing
+ let clientHealth = mbClient.isHealthy()
+
+ if clientHealth.isOk() and clientHealth[]:
+ info "Reached Matterbridge host", host = mbClient.host
+ else:
+ raise newException(ValueError, "Matterbridge client not reachable/healthy")
+
+ # Setup Waku v2 node
+ let nodev2 = block:
+ var builder = WakuNodeBuilder.init()
+ builder.withNodeKey(nodev2Key)
+
+ builder
+ .withNetworkConfigurationDetails(
+ nodev2BindIp, nodev2BindPort, nodev2ExtIp, nodev2ExtPort
+ )
+ .tryGet()
+ builder.build().tryGet()
+
+ return Chat2MatterBridge(
+ mbClient: mbClient,
+ nodev2: nodev2,
+ running: false,
+ pollPeriod: chronos.seconds(1),
+ contentTopic: contentTopic,
+ )
+
+proc start*(cmb: Chat2MatterBridge) {.async.} =
+ info "Starting Chat2MatterBridge"
+
+ cmb.running = true
+
+ debug "Start polling Matterbridge"
+
+ # Start Matterbridge polling (@TODO: use streaming interface)
+ proc mbHandler(jsonNode: JsonNode) {.async.} =
+ trace "Bridging message from Matterbridge to chat2", jsonNode = jsonNode
+ waitFor cmb.toChat2(jsonNode)
+
+ asyncSpawn cmb.pollMatterbridge(mbHandler)
+
+ # Start Waku v2 node
+ debug "Start listening on Waku v2"
+ await cmb.nodev2.start()
+
+ # Always mount relay for bridge
+ # `triggerSelf` is false on a `bridge` to avoid duplicates
+ (await cmb.nodev2.mountRelay()).isOkOr:
+ error "failed to mount relay", error = error
+ return
+
+ cmb.nodev2.wakuRelay.triggerSelf = false
+
+ # Bridging
+ # Handle messages on Waku v2 and bridge to Matterbridge
+ proc relayHandler(
+ pubsubTopic: PubsubTopic, msg: WakuMessage
+ ): Future[void] {.async.} =
+ trace "Bridging message from Chat2 to Matterbridge", msg = msg
+ try:
+ cmb.toMatterbridge(msg)
+ except:
+ error "exception in relayHandler: " & getCurrentExceptionMsg()
+
+ cmb.nodev2.subscribe((kind: PubsubSub, topic: DefaultPubsubTopic), relayHandler).isOkOr:
+ error "failed to subscribe to relay", topic = DefaultPubsubTopic, error = error
+ return
+
+proc stop*(cmb: Chat2MatterBridge) {.async: (raises: [Exception]).} =
+ info "Stopping Chat2MatterBridge"
+
+ cmb.running = false
+
+ await cmb.nodev2.stop()
+
+{.pop.}
+ # @TODO confutils.nim(775, 17) Error: can raise an unlisted exception: ref IOError
+when isMainModule:
+ import waku/common/utils/nat, waku/waku_api/message_cache
+
+ let
+ rng = newRng()
+ conf = Chat2MatterbridgeConf.load()
+
+ if conf.logLevel != LogLevel.NONE:
+ setLogLevel(conf.logLevel)
+
+ let natRes = setupNat(
+ conf.nat,
+ clientId,
+ Port(uint16(conf.libp2pTcpPort) + conf.portsShift),
+ Port(uint16(conf.udpPort) + conf.portsShift),
+ )
+ if natRes.isErr():
+ error "Error in setupNat", error = natRes.error
+
+ # Load address configuration
+ let
+ (nodev2ExtIp, nodev2ExtPort, _) = natRes.get()
+ ## The following heuristic assumes that, in absence of manual
+ ## config, the external port is the same as the bind port.
+ extPort =
+ if nodev2ExtIp.isSome() and nodev2ExtPort.isNone():
+ some(Port(uint16(conf.libp2pTcpPort) + conf.portsShift))
+ else:
+ nodev2ExtPort
+
+ let bridge = Chat2Matterbridge.new(
+ mbHostUri = "http://" & $initTAddress(conf.mbHostAddress, Port(conf.mbHostPort)),
+ mbGateway = conf.mbGateway,
+ nodev2Key = conf.nodekey,
+ nodev2BindIp = conf.listenAddress,
+ nodev2BindPort = Port(uint16(conf.libp2pTcpPort) + conf.portsShift),
+ nodev2ExtIp = nodev2ExtIp,
+ nodev2ExtPort = extPort,
+ contentTopic = conf.contentTopic,
+ )
+
+ waitFor bridge.start()
+
+ # Now load rest of config
+ # Mount configured Waku v2 protocols
+ waitFor mountLibp2pPing(bridge.nodev2)
+
+ if conf.store:
+ waitFor mountStore(bridge.nodev2)
+
+ if conf.filter:
+ waitFor mountFilter(bridge.nodev2)
+
+ if conf.staticnodes.len > 0:
+ waitFor connectToNodes(bridge.nodev2, conf.staticnodes)
+
+ if conf.storenode != "":
+ let storePeer = parsePeerInfo(conf.storenode)
+ if storePeer.isOk():
+ bridge.nodev2.peerManager.addServicePeer(storePeer.value, WakuStoreCodec)
+ else:
+ error "Error parsing conf.storenode", error = storePeer.error
+
+ if conf.filternode != "":
+ let filterPeer = parsePeerInfo(conf.filternode)
+ if filterPeer.isOk():
+ bridge.nodev2.peerManager.addServicePeer(
+ filterPeer.value, WakuFilterSubscribeCodec
+ )
+ else:
+ error "Error parsing conf.filternode", error = filterPeer.error
+
+ if conf.metricsServer:
+ let
+ address = conf.metricsServerAddress
+ port = conf.metricsServerPort + conf.portsShift
+ info "Starting metrics HTTP server", address, port
+ startMetricsHttpServer($address, Port(port))
+
+ runForever()
diff --git a/third-party/nwaku/apps/chat2bridge/config_chat2bridge.nim b/third-party/nwaku/apps/chat2bridge/config_chat2bridge.nim
new file mode 100644
index 0000000..c7d8bb5
--- /dev/null
+++ b/third-party/nwaku/apps/chat2bridge/config_chat2bridge.nim
@@ -0,0 +1,148 @@
+import
+ confutils,
+ confutils/defs,
+ confutils/std/net,
+ chronicles,
+ chronos,
+ libp2p/crypto/[crypto, secp],
+ eth/keys
+
+type Chat2MatterbridgeConf* = object
+ logLevel* {.
+ desc: "Sets the log level", defaultValue: LogLevel.INFO, name: "log-level"
+ .}: LogLevel
+
+ listenAddress* {.
+ defaultValue: defaultListenAddress(config),
+ desc: "Listening address for the LibP2P traffic",
+ name: "listen-address"
+ .}: IpAddress
+
+ libp2pTcpPort* {.
+ desc: "Libp2p TCP listening port (for Waku v2)",
+ defaultValue: 9000,
+ name: "libp2p-tcp-port"
+ .}: uint16
+
+ udpPort* {.desc: "UDP listening port", defaultValue: 9000, name: "udp-port".}: uint16
+
+ portsShift* {.
+ desc: "Add a shift to all default port numbers",
+ defaultValue: 0,
+ name: "ports-shift"
+ .}: uint16
+
+ nat* {.
+ desc:
+ "Specify method to use for determining public address. " &
+ "Must be one of: any, none, upnp, pmp, extip:",
+ defaultValue: "any"
+ .}: string
+
+ metricsServer* {.
+ desc: "Enable the metrics server", defaultValue: false, name: "metrics-server"
+ .}: bool
+
+ metricsServerAddress* {.
+ desc: "Listening address of the metrics server",
+ defaultValue: parseIpAddress("127.0.0.1"),
+ name: "metrics-server-address"
+ .}: IpAddress
+
+ metricsServerPort* {.
+ desc: "Listening HTTP port of the metrics server",
+ defaultValue: 8008,
+ name: "metrics-server-port"
+ .}: uint16
+
+ ### Waku v2 options
+ staticnodes* {.
+ desc: "Multiaddr of peer to directly connect with. Argument may be repeated",
+ name: "staticnode"
+ .}: seq[string]
+
+ nodekey* {.
+ desc: "P2P node private key as hex",
+ defaultValue: crypto.PrivateKey.random(Secp256k1, newRng()[]).tryGet(),
+ name: "nodekey"
+ .}: crypto.PrivateKey
+
+ store* {.
+ desc: "Flag whether to start store protocol", defaultValue: true, name: "store"
+ .}: bool
+
+ filter* {.
+ desc: "Flag whether to start filter protocol", defaultValue: false, name: "filter"
+ .}: bool
+
+ relay* {.
+ desc: "Flag whether to start relay protocol", defaultValue: true, name: "relay"
+ .}: bool
+
+ storenode* {.
+ desc: "Multiaddr of peer to connect with for waku store protocol",
+ defaultValue: "",
+ name: "storenode"
+ .}: string
+
+ filternode* {.
+ desc: "Multiaddr of peer to connect with for waku filter protocol",
+ defaultValue: "",
+ name: "filternode"
+ .}: string
+
+ # Matterbridge options
+ mbHostAddress* {.
+ desc: "Listening address of the Matterbridge host",
+ defaultValue: parseIpAddress("127.0.0.1"),
+ name: "mb-host-address"
+ .}: IpAddress
+
+ mbHostPort* {.
+ desc: "Listening port of the Matterbridge host",
+ defaultValue: 4242,
+ name: "mb-host-port"
+ .}: uint16
+
+ mbGateway* {.
+ desc: "Matterbridge gateway", defaultValue: "gateway1", name: "mb-gateway"
+ .}: string
+
+ ## Chat2 options
+ contentTopic* {.
+ desc: "Content topic to bridge chat messages to.",
+ defaultValue: "/toy-chat/2/huilong/proto",
+ name: "content-topic"
+ .}: string
+
+proc parseCmdArg*(T: type keys.KeyPair, p: string): T =
+ try:
+ let privkey = keys.PrivateKey.fromHex(string(p)).tryGet()
+ result = privkey.toKeyPair()
+ except CatchableError:
+ raise newException(ValueError, "Invalid private key")
+
+proc completeCmdArg*(T: type keys.KeyPair, val: string): seq[string] =
+ return @[]
+
+proc parseCmdArg*(T: type crypto.PrivateKey, p: string): T =
+ let key = SkPrivateKey.init(p)
+ if key.isOk():
+ crypto.PrivateKey(scheme: Secp256k1, skkey: key.get())
+ else:
+ raise newException(ValueError, "Invalid private key")
+
+proc completeCmdArg*(T: type crypto.PrivateKey, val: string): seq[string] =
+ return @[]
+
+proc parseCmdArg*(T: type IpAddress, p: string): T =
+ try:
+ result = parseIpAddress(p)
+ except CatchableError:
+ raise newException(ValueError, "Invalid IP address")
+
+proc completeCmdArg*(T: type IpAddress, val: string): seq[string] =
+ return @[]
+
+func defaultListenAddress*(conf: Chat2MatterbridgeConf): IpAddress =
+ (parseIpAddress("0.0.0.0"))
diff --git a/third-party/nwaku/apps/chat2bridge/nim.cfg b/third-party/nwaku/apps/chat2bridge/nim.cfg
new file mode 100644
index 0000000..2231f2e
--- /dev/null
+++ b/third-party/nwaku/apps/chat2bridge/nim.cfg
@@ -0,0 +1,4 @@
+-d:chronicles_line_numbers
+-d:chronicles_runtime_filtering:on
+-d:discv5_protocol_id:d5waku
+path = "../.."
diff --git a/third-party/nwaku/apps/chat2mix/chat2mix.nim b/third-party/nwaku/apps/chat2mix/chat2mix.nim
new file mode 100644
index 0000000..e75ca75
--- /dev/null
+++ b/third-party/nwaku/apps/chat2mix/chat2mix.nim
@@ -0,0 +1,703 @@
+## chat2 is an example of usage of Waku v2. For suggested usage options, please
+## see dingpu tutorial in docs folder.
+
+when not (compileOption("threads")):
+ {.fatal: "Please, compile this program with the --threads:on option!".}
+
+{.push raises: [].}
+
+import std/[strformat, strutils, times, options, random, sequtils]
+import
+ confutils,
+ chronicles,
+ chronos,
+ eth/keys,
+ bearssl,
+ results,
+ stew/[byteutils],
+ metrics,
+ metrics/chronos_httpserver
+import
+ libp2p/[
+ switch, # manage transports, a single entry point for dialing and listening
+ crypto/crypto, # cryptographic functions
+ stream/connection, # create and close stream read / write connections
+ multiaddress,
+ # encode different addressing schemes. For example, /ip4/7.7.7.7/tcp/6543 means it is using IPv4 protocol and TCP
+ peerinfo,
+ # manage the information of a peer, such as peer ID and public / private key
+ peerid, # Implement how peers interact
+ protobuf/minprotobuf, # message serialisation/deserialisation from and to protobufs
+ nameresolving/dnsresolver,
+ ] # define DNS resolution
+import mix/curve25519
+import
+ waku/[
+ waku_core,
+ waku_lightpush/common,
+ waku_lightpush/rpc,
+ waku_enr,
+ discovery/waku_dnsdisc,
+ waku_node,
+ node/waku_metrics,
+ node/peer_manager,
+ factory/builder,
+ common/utils/nat,
+ waku_store/common,
+ waku_filter_v2/client,
+ common/logging,
+ ],
+ ./config_chat2mix
+
+import libp2p/protocols/pubsub/rpc/messages, libp2p/protocols/pubsub/pubsub
+import ../../waku/waku_rln_relay
+
+logScope:
+ topics = "chat2 mix"
+
+const Help =
+ """
+ Commands: /[?|help|connect|nick|exit]
+ help: Prints this help
+ connect: dials a remote peer
+ nick: change nickname for current chat session
+ exit: exits chat session
+"""
+
+# XXX Connected is a bit annoying, because incoming connections don't trigger state change
+# Could poll connection pool or something here, I suppose
+# TODO Ensure connected turns true on incoming connections, or get rid of it
+type Chat = ref object
+ node: WakuNode # waku node for publishing, subscribing, etc
+ transp: StreamTransport # transport streams between read & write file descriptor
+ subscribed: bool # indicates if a node is subscribed or not to a topic
+ connected: bool # if the node is connected to another peer
+ started: bool # if the node has started
+ nick: string # nickname for this chat session
+ prompt: bool # chat prompt is showing
+ contentTopic: string # default content topic for chat messages
+ conf: Chat2Conf # configuration for chat2
+
+type
+ PrivateKey* = crypto.PrivateKey
+ Topic* = waku_core.PubsubTopic
+
+#####################
+## chat2 protobufs ##
+#####################
+
+type
+ SelectResult*[T] = Result[T, string]
+
+ Chat2Message* = object
+ timestamp*: int64
+ nick*: string
+ payload*: seq[byte]
+
+proc getPubsubTopic*(
+ conf: Chat2Conf, node: WakuNode, contentTopic: string
+): PubsubTopic =
+ let shard = node.wakuAutoSharding.get().getShard(contentTopic).valueOr:
+ echo "Could not parse content topic: " & error
+ return "" #TODO: fix this.
+ return $RelayShard(clusterId: conf.clusterId, shardId: shard.shardId)
+
+proc init*(T: type Chat2Message, buffer: seq[byte]): ProtoResult[T] =
+ var msg = Chat2Message()
+ let pb = initProtoBuffer(buffer)
+
+ var timestamp: uint64
+ discard ?pb.getField(1, timestamp)
+ msg.timestamp = int64(timestamp)
+
+ discard ?pb.getField(2, msg.nick)
+ discard ?pb.getField(3, msg.payload)
+
+ ok(msg)
+
+proc encode*(message: Chat2Message): ProtoBuffer =
+ var serialised = initProtoBuffer()
+
+ serialised.write(1, uint64(message.timestamp))
+ serialised.write(2, message.nick)
+ serialised.write(3, message.payload)
+
+ return serialised
+
+proc toString*(message: Chat2Message): string =
+ # Get message date and timestamp in local time
+ let time = message.timestamp.fromUnix().local().format("'<'MMM' 'dd,' 'HH:mm'>'")
+
+ return time & " " & message.nick & ": " & string.fromBytes(message.payload)
+
+#####################
+
+proc connectToNodes(c: Chat, nodes: seq[string]) {.async.} =
+ echo "Connecting to nodes"
+ await c.node.connectToNodes(nodes)
+ c.connected = true
+
+proc showChatPrompt(c: Chat) =
+ if not c.prompt:
+ try:
+ stdout.write(">> ")
+ stdout.flushFile()
+ c.prompt = true
+ except IOError:
+ discard
+
+proc getChatLine(c: Chat, msg: WakuMessage): Result[string, string] =
+ # No payload encoding/encryption from Waku
+ let
+ pb = Chat2Message.init(msg.payload)
+ chatLine =
+ if pb.isOk:
+ pb[].toString()
+ else:
+ string.fromBytes(msg.payload)
+ return ok(chatline)
+
+proc printReceivedMessage(c: Chat, msg: WakuMessage) =
+ let
+ pb = Chat2Message.init(msg.payload)
+ chatLine =
+ if pb.isOk:
+ pb[].toString()
+ else:
+ string.fromBytes(msg.payload)
+ try:
+ echo &"{chatLine}"
+ except ValueError:
+ # Formatting fail. Print chat line in any case.
+ echo chatLine
+
+ c.prompt = false
+ showChatPrompt(c)
+ trace "Printing message", chatLine, contentTopic = msg.contentTopic
+
+proc readNick(transp: StreamTransport): Future[string] {.async.} =
+ # Chat prompt
+ stdout.write("Choose a nickname >> ")
+ stdout.flushFile()
+ return await transp.readLine()
+
+proc startMetricsServer(
+ serverIp: IpAddress, serverPort: Port
+): Result[MetricsHttpServerRef, string] =
+ info "Starting metrics HTTP server", serverIp = $serverIp, serverPort = $serverPort
+
+ let metricsServerRes = MetricsHttpServerRef.new($serverIp, serverPort)
+ if metricsServerRes.isErr():
+ return err("metrics HTTP server start failed: " & $metricsServerRes.error)
+
+ let server = metricsServerRes.value
+ try:
+ waitFor server.start()
+ except CatchableError:
+ return err("metrics HTTP server start failed: " & getCurrentExceptionMsg())
+
+ info "Metrics HTTP server started", serverIp = $serverIp, serverPort = $serverPort
+ ok(metricsServerRes.value)
+
+proc publish(c: Chat, line: string) {.async.} =
+ # First create a Chat2Message protobuf with this line of text
+ let time = getTime().toUnix()
+ let chat2pb =
+ Chat2Message(timestamp: time, nick: c.nick, payload: line.toBytes()).encode()
+
+ ## @TODO: error handling on failure
+ proc handler(response: LightPushResponse) {.gcsafe, closure.} =
+ trace "lightpush response received", response = response
+
+ var message = WakuMessage(
+ payload: chat2pb.buffer,
+ contentTopic: c.contentTopic,
+ version: 0,
+ timestamp: getNanosecondTime(time),
+ )
+
+ try:
+ if not c.node.wakuLightpushClient.isNil():
+ # Attempt lightpush with mix
+
+ (
+ waitFor c.node.lightpushPublish(
+ some(c.conf.getPubsubTopic(c.node, c.contentTopic)),
+ message,
+ none(RemotePeerInfo),
+ true,
+ )
+ ).isOkOr:
+ error "failed to publish lightpush message", error = error
+ else:
+ error "failed to publish message as lightpush client is not initialized"
+ except CatchableError:
+ error "caught error publishing message: ", error = getCurrentExceptionMsg()
+
+# TODO This should read or be subscribe handler subscribe
+proc readAndPrint(c: Chat) {.async.} =
+ while true:
+ # while p.connected:
+ # # TODO: echo &"{p.id} -> "
+ #
+ # echo cast[string](await p.conn.readLp(1024))
+ #echo "readAndPrint subscribe NYI"
+ await sleepAsync(100)
+
+# TODO Implement
+proc writeAndPrint(c: Chat) {.async.} =
+ while true:
+ # Connect state not updated on incoming WakuRelay connections
+ # if not c.connected:
+ # echo "type an address or wait for a connection:"
+ # echo "type /[help|?] for help"
+
+ # Chat prompt
+ showChatPrompt(c)
+
+ let line = await c.transp.readLine()
+ if line.startsWith("/help") or line.startsWith("/?") or not c.started:
+ echo Help
+ continue
+
+ # if line.startsWith("/disconnect"):
+ # echo "Ending current session"
+ # if p.connected and p.conn.closed.not:
+ # await p.conn.close()
+ # p.connected = false
+ elif line.startsWith("/connect"):
+ # TODO Should be able to connect to multiple peers for Waku chat
+ if c.connected:
+ echo "already connected to at least one peer"
+ continue
+
+ echo "enter address of remote peer"
+ let address = await c.transp.readLine()
+ if address.len > 0:
+ await c.connectToNodes(@[address])
+ elif line.startsWith("/nick"):
+ # Set a new nickname
+ c.nick = await readNick(c.transp)
+ echo "You are now known as " & c.nick
+ elif line.startsWith("/exit"):
+ echo "quitting..."
+
+ try:
+ await c.node.stop()
+ except:
+ echo "exception happened when stopping: " & getCurrentExceptionMsg()
+
+ quit(QuitSuccess)
+ else:
+ # XXX connected state problematic
+ if c.started:
+ echo "publishing message: " & line
+ await c.publish(line)
+ # TODO Connect to peer logic?
+ else:
+ try:
+ if line.startsWith("/") and "p2p" in line:
+ await c.connectToNodes(@[line])
+ except:
+ echo &"unable to dial remote peer {line}"
+ echo getCurrentExceptionMsg()
+
+proc readWriteLoop(c: Chat) {.async.} =
+ asyncSpawn c.writeAndPrint() # execute the async function but does not block
+ asyncSpawn c.readAndPrint()
+
+proc readInput(wfd: AsyncFD) {.thread, raises: [Defect, CatchableError].} =
+ ## This procedure performs reading from `stdin` and sends data over
+ ## pipe to main thread.
+ let transp = fromPipe(wfd)
+
+ while true:
+ let line = stdin.readLine()
+ discard waitFor transp.write(line & "\r\n")
+
+var alreadyUsedServicePeers {.threadvar.}: seq[RemotePeerInfo]
+
+proc selectRandomServicePeer*(
+ pm: PeerManager, actualPeer: Option[RemotePeerInfo], codec: string
+): Result[RemotePeerInfo, void] =
+ if actualPeer.isSome():
+ alreadyUsedServicePeers.add(actualPeer.get())
+
+ let supportivePeers = pm.switch.peerStore.getPeersByProtocol(codec).filterIt(
+ it notin alreadyUsedServicePeers
+ )
+ if supportivePeers.len == 0:
+ return err()
+
+ let rndPeerIndex = rand(0 .. supportivePeers.len - 1)
+ return ok(supportivePeers[rndPeerIndex])
+
+proc maintainSubscription(
+ wakuNode: WakuNode,
+ filterPubsubTopic: PubsubTopic,
+ filterContentTopic: ContentTopic,
+ filterPeer: RemotePeerInfo,
+ preventPeerSwitch: bool,
+) {.async.} =
+ var actualFilterPeer = filterPeer
+ const maxFailedSubscribes = 3
+ const maxFailedServiceNodeSwitches = 10
+ var noFailedSubscribes = 0
+ var noFailedServiceNodeSwitches = 0
+ while true:
+ info "maintaining subscription at", peer = constructMultiaddrStr(actualFilterPeer)
+ # First use filter-ping to check if we have an active subscription
+ let pingRes = await wakuNode.wakuFilterClient.ping(actualFilterPeer)
+ if pingRes.isErr():
+ # No subscription found. Let's subscribe.
+ error "ping failed.", err = pingRes.error
+ trace "no subscription found. Sending subscribe request"
+
+ let subscribeRes = await wakuNode.filterSubscribe(
+ some(filterPubsubTopic), filterContentTopic, actualFilterPeer
+ )
+
+ if subscribeRes.isErr():
+ noFailedSubscribes += 1
+ error "Subscribe request failed.",
+ err = subscribeRes.error,
+ peer = actualFilterPeer,
+ failCount = noFailedSubscribes
+
+ # TODO: disconnet from failed actualFilterPeer
+ # asyncSpawn(wakuNode.peerManager.switch.disconnect(p))
+ # wakunode.peerManager.peerStore.delete(actualFilterPeer)
+
+ if noFailedSubscribes < maxFailedSubscribes:
+ await sleepAsync(2000) # Wait a bit before retrying
+ continue
+ elif not preventPeerSwitch:
+ let peerOpt = selectRandomServicePeer(
+ wakuNode.peerManager, some(actualFilterPeer), WakuFilterSubscribeCodec
+ )
+ if peerOpt.isOk():
+ actualFilterPeer = peerOpt.get()
+
+ info "Found new peer for codec",
+ codec = filterPubsubTopic, peer = constructMultiaddrStr(actualFilterPeer)
+
+ noFailedSubscribes = 0
+ continue # try again with new peer without delay
+ else:
+ error "Failed to find new service peer. Exiting."
+ noFailedServiceNodeSwitches += 1
+ break
+ else:
+ if noFailedSubscribes > 0:
+ noFailedSubscribes -= 1
+
+ notice "subscribe request successful."
+ else:
+ info "subscription is live."
+
+ await sleepAsync(30000) # Subscription maintenance interval
+
+proc processMixNodes(localnode: WakuNode, nodes: seq[string]) {.async.} =
+ if nodes.len == 0:
+ return
+
+ info "Processing mix nodes: ", nodes = $nodes
+ for node in nodes:
+ var enrRec: enr.Record
+ if enrRec.fromURI(node):
+ let peerInfo = enrRec.toRemotePeerInfo().valueOr:
+ error "Failed to parse mix node", error = error
+ continue
+ localnode.peermanager.addPeer(peerInfo, Discv5)
+ info "Added mix node", peer = peerInfo
+ else:
+ error "Failed to parse mix node ENR", node = node
+
+{.pop.}
+ # @TODO confutils.nim(775, 17) Error: can raise an unlisted exception: ref IOError
+proc processInput(rfd: AsyncFD, rng: ref HmacDrbgContext) {.async.} =
+ let
+ transp = fromPipe(rfd)
+ conf = Chat2Conf.load()
+ nodekey =
+ if conf.nodekey.isSome():
+ conf.nodekey.get()
+ else:
+ PrivateKey.random(Secp256k1, rng[]).tryGet()
+
+ # set log level
+ if conf.logLevel != LogLevel.NONE:
+ setLogLevel(conf.logLevel)
+
+ let natRes = setupNat(
+ conf.nat,
+ clientId,
+ Port(uint16(conf.tcpPort) + conf.portsShift),
+ Port(uint16(conf.udpPort) + conf.portsShift),
+ )
+
+ if natRes.isErr():
+ raise newException(ValueError, "setupNat error " & natRes.error)
+
+ let (extIp, extTcpPort, extUdpPort) = natRes.get()
+
+ var enrBuilder = EnrBuilder.init(nodeKey)
+
+ enrBuilder.withWakuRelaySharding(
+ RelayShards(clusterId: conf.clusterId, shardIds: conf.shards)
+ ).isOkOr:
+ error "failed to add sharded topics to ENR", error = error
+ quit(QuitFailure)
+
+ let recordRes = enrBuilder.build()
+ let record =
+ if recordRes.isErr():
+ error "failed to create enr record", error = recordRes.error
+ quit(QuitFailure)
+ else:
+ recordRes.get()
+
+ let node = block:
+ var builder = WakuNodeBuilder.init()
+ builder.withNodeKey(nodeKey)
+ builder.withRecord(record)
+
+ builder
+ .withNetworkConfigurationDetails(
+ conf.listenAddress,
+ Port(uint16(conf.tcpPort) + conf.portsShift),
+ extIp,
+ extTcpPort,
+ wsBindPort = Port(uint16(conf.websocketPort) + conf.portsShift),
+ wsEnabled = conf.websocketSupport,
+ wssEnabled = conf.websocketSecureSupport,
+ )
+ .tryGet()
+ builder.build().tryGet()
+
+ node.mountAutoSharding(conf.clusterId, conf.numShardsInNetwork).isOkOr:
+ error "failed to mount waku sharding: ", error = error
+ quit(QuitFailure)
+ node.mountMetadata(conf.clusterId, conf.shards).isOkOr:
+ error "failed to mount waku metadata protocol: ", err = error
+ quit(QuitFailure)
+
+ let (mixPrivKey, mixPubKey) = generateKeyPair().valueOr:
+ error "failed to generate mix key pair", error = error
+ return
+
+ (await node.mountMix(conf.clusterId, mixPrivKey)).isOkOr:
+ error "failed to mount waku mix protocol: ", error = $error
+ quit(QuitFailure)
+ if conf.mixnodes.len > 0:
+ await processMixNodes(node, conf.mixnodes)
+ await node.start()
+
+ node.peerManager.start()
+
+ await node.mountLibp2pPing()
+ await node.mountPeerExchangeClient()
+ let pubsubTopic = conf.getPubsubTopic(node, conf.contentTopic)
+ echo "pubsub topic is: " & pubsubTopic
+ let nick = await readNick(transp)
+ echo "Welcome, " & nick & "!"
+
+ var chat = Chat(
+ node: node,
+ transp: transp,
+ subscribed: true,
+ connected: false,
+ started: true,
+ nick: nick,
+ prompt: false,
+ contentTopic: conf.contentTopic,
+ conf: conf,
+ )
+
+ var dnsDiscoveryUrl = none(string)
+
+ if conf.fleet != Fleet.none:
+ # Use DNS discovery to connect to selected fleet
+ echo "Connecting to " & $conf.fleet & " fleet using DNS discovery..."
+
+ if conf.fleet == Fleet.test:
+ dnsDiscoveryUrl = some(
+ "enrtree://AOGYWMBYOUIMOENHXCHILPKY3ZRFEULMFI4DOM442QSZ73TT2A7VI@test.waku.nodes.status.im"
+ )
+ else:
+ # Connect to sandbox by default
+ dnsDiscoveryUrl = some(
+ "enrtree://AIRVQ5DDA4FFWLRBCHJWUWOO6X6S4ZTZ5B667LQ6AJU6PEYDLRD5O@sandbox.waku.nodes.status.im"
+ )
+ elif conf.dnsDiscoveryUrl != "":
+ # No pre-selected fleet. Discover nodes via DNS using user config
+ debug "Discovering nodes using Waku DNS discovery", url = conf.dnsDiscoveryUrl
+ dnsDiscoveryUrl = some(conf.dnsDiscoveryUrl)
+
+ var discoveredNodes: seq[RemotePeerInfo]
+
+ if dnsDiscoveryUrl.isSome:
+ var nameServers: seq[TransportAddress]
+ for ip in conf.dnsDiscoveryNameServers:
+ nameServers.add(initTAddress(ip, Port(53))) # Assume all servers use port 53
+
+ let dnsResolver = DnsResolver.new(nameServers)
+
+ proc resolver(domain: string): Future[string] {.async, gcsafe.} =
+ trace "resolving", domain = domain
+ let resolved = await dnsResolver.resolveTxt(domain)
+ return resolved[0] # Use only first answer
+
+ var wakuDnsDiscovery = WakuDnsDiscovery.init(dnsDiscoveryUrl.get(), resolver)
+ if wakuDnsDiscovery.isOk:
+ let discoveredPeers = await wakuDnsDiscovery.get().findPeers()
+ if discoveredPeers.isOk:
+ info "Connecting to discovered peers"
+ discoveredNodes = discoveredPeers.get()
+ echo "Discovered and connecting to " & $discoveredNodes
+ waitFor chat.node.connectToNodes(discoveredNodes)
+ else:
+ warn "Failed to init Waku DNS discovery"
+
+ let peerInfo = node.switch.peerInfo
+ let listenStr = $peerInfo.addrs[0] & "/p2p/" & $peerInfo.peerId
+ echo &"Listening on\n {listenStr}"
+
+ if (conf.storenode != "") or (conf.store == true):
+ await node.mountStore()
+
+ var storenode: Option[RemotePeerInfo]
+
+ if conf.storenode != "":
+ let peerInfo = parsePeerInfo(conf.storenode)
+ if peerInfo.isOk():
+ storenode = some(peerInfo.value)
+ else:
+ error "Incorrect conf.storenode", error = peerInfo.error
+ elif discoveredNodes.len > 0:
+ echo "Store enabled, but no store nodes configured. Choosing one at random from discovered peers"
+ storenode = some(discoveredNodes[rand(0 .. len(discoveredNodes) - 1)])
+
+ if storenode.isSome():
+ # We have a viable storenode. Let's query it for historical messages.
+ echo "Connecting to storenode: " & $(storenode.get())
+
+ node.mountStoreClient()
+ node.peerManager.addServicePeer(storenode.get(), WakuStoreCodec)
+
+ proc storeHandler(response: StoreQueryResponse) {.gcsafe.} =
+ for msg in response.messages:
+ let payload =
+ if msg.message.isSome():
+ msg.message.get().payload
+ else:
+ newSeq[byte](0)
+
+ let
+ pb = Chat2Message.init(payload)
+ chatLine =
+ if pb.isOk:
+ pb[].toString()
+ else:
+ string.fromBytes(payload)
+ echo &"{chatLine}"
+ info "Hit store handler"
+
+ let queryRes = await node.query(
+ StoreQueryRequest(contentTopics: @[chat.contentTopic]), storenode.get()
+ )
+ if queryRes.isOk():
+ storeHandler(queryRes.value)
+
+ if conf.edgemode: #Mount light protocol clients
+ node.mountLightPushClient()
+ await node.mountFilterClient()
+ let filterHandler = proc(
+ pubsubTopic: PubsubTopic, msg: WakuMessage
+ ): Future[void] {.async, closure.} =
+ trace "Hit filter handler", contentTopic = msg.contentTopic
+ chat.printReceivedMessage(msg)
+
+ node.wakuFilterClient.registerPushHandler(filterHandler)
+ var servicePeerInfo: RemotePeerInfo
+ if conf.serviceNode != "":
+ servicePeerInfo = parsePeerInfo(conf.serviceNode).valueOr:
+ error "Couldn't parse conf.serviceNode", error = error
+ RemotePeerInfo()
+ if $servicePeerInfo.peerId == "":
+ # Assuming that service node supports all services
+ servicePeerInfo = selectRandomServicePeer(
+ node.peerManager, none(RemotePeerInfo), WakuLightpushCodec
+ ).valueOr:
+ error "Couldn't find any service peer"
+ quit(QuitFailure)
+
+ #await mountLegacyLightPush(node)
+ node.peerManager.addServicePeer(servicePeerInfo, WakuLightpushCodec)
+ node.peerManager.addServicePeer(servicePeerInfo, WakuPeerExchangeCodec)
+
+ # Start maintaining subscription
+ asyncSpawn maintainSubscription(
+ node, pubsubTopic, conf.contentTopic, servicePeerInfo, false
+ )
+ echo "waiting for mix nodes to be discovered..."
+ while true:
+ if node.getMixNodePoolSize() >= 3:
+ break
+ discard await node.fetchPeerExchangePeers()
+ await sleepAsync(1000)
+
+ while node.getMixNodePoolSize() < 3:
+ info "waiting for mix nodes to be discovered",
+ currentpoolSize = node.getMixNodePoolSize()
+ await sleepAsync(1000)
+ notice "ready to publish with mix node pool size ",
+ currentpoolSize = node.getMixNodePoolSize()
+ echo "ready to publish messages now"
+
+ # Once min mixnodes are discovered loop as per default setting
+ node.startPeerExchangeLoop()
+
+ if conf.metricsLogging:
+ startMetricsLog()
+
+ if conf.metricsServer:
+ let metricsServer = startMetricsServer(
+ conf.metricsServerAddress, Port(conf.metricsServerPort + conf.portsShift)
+ )
+
+ await chat.readWriteLoop()
+
+ runForever()
+
+proc main(rng: ref HmacDrbgContext) {.async.} =
+ let (rfd, wfd) = createAsyncPipe()
+ if rfd == asyncInvalidPipe or wfd == asyncInvalidPipe:
+ raise newException(ValueError, "Could not initialize pipe!")
+
+ var thread: Thread[AsyncFD]
+ thread.createThread(readInput, wfd)
+ try:
+ await processInput(rfd, rng)
+ # Handle only ConfigurationError for now
+ # TODO: Throw other errors from the mounting procedure
+ except ConfigurationError as e:
+ raise e
+
+when isMainModule: # isMainModule = true when the module is compiled as the main file
+ let rng = crypto.newRng()
+ try:
+ waitFor(main(rng))
+ except CatchableError as e:
+ raise e
+
+## Dump of things that can be improved:
+##
+## - Incoming dialed peer does not change connected state (not relying on it for now)
+## - Unclear if staticnode argument works (can enter manually)
+## - Don't trigger self / double publish own messages
+## - Test/default to cluster node connection (diff protocol version)
+## - Redirect logs to separate file
+## - Expose basic publish/subscribe etc commands with /syntax
+## - Show part of peerid to know who sent message
+## - Deal with protobuf messages (e.g. other chat protocol, or encrypted)
diff --git a/third-party/nwaku/apps/chat2mix/config_chat2mix.nim b/third-party/nwaku/apps/chat2mix/config_chat2mix.nim
new file mode 100644
index 0000000..1d28149
--- /dev/null
+++ b/third-party/nwaku/apps/chat2mix/config_chat2mix.nim
@@ -0,0 +1,293 @@
+import chronicles, chronos, std/strutils, regex
+
+import
+ eth/keys,
+ libp2p/crypto/crypto,
+ libp2p/crypto/secp,
+ nimcrypto/utils,
+ confutils,
+ confutils/defs,
+ confutils/std/net
+
+import waku/waku_core
+
+type
+ Fleet* = enum
+ none
+ sandbox
+ test
+
+ EthRpcUrl* = distinct string
+
+ Chat2Conf* = object ## General node config
+ edgemode* {.
+ defaultValue: true, desc: "Run the app in edge mode", name: "edge-mode"
+ .}: bool
+
+ logLevel* {.
+ desc: "Sets the log level.", defaultValue: LogLevel.INFO, name: "log-level"
+ .}: LogLevel
+
+ nodekey* {.desc: "P2P node private key as 64 char hex string.", name: "nodekey".}:
+ Option[crypto.PrivateKey]
+
+ listenAddress* {.
+ defaultValue: defaultListenAddress(config),
+ desc: "Listening address for the LibP2P traffic.",
+ name: "listen-address"
+ .}: IpAddress
+
+ tcpPort* {.desc: "TCP listening port.", defaultValue: 60000, name: "tcp-port".}:
+ Port
+
+ udpPort* {.desc: "UDP listening port.", defaultValue: 60000, name: "udp-port".}:
+ Port
+
+ portsShift* {.
+ desc: "Add a shift to all port numbers.", defaultValue: 0, name: "ports-shift"
+ .}: uint16
+
+ nat* {.
+ desc:
+ "Specify method to use for determining public address. " &
+ "Must be one of: any, none, upnp, pmp, extip:.",
+ defaultValue: "any"
+ .}: string
+
+ ## Persistence config
+ dbPath* {.
+ desc: "The database path for peristent storage", defaultValue: "", name: "db-path"
+ .}: string
+
+ persistPeers* {.
+ desc: "Enable peer persistence: true|false",
+ defaultValue: false,
+ name: "persist-peers"
+ .}: bool
+
+ persistMessages* {.
+ desc: "Enable message persistence: true|false",
+ defaultValue: false,
+ name: "persist-messages"
+ .}: bool
+
+ ## Relay config
+ relay* {.
+ desc: "Enable relay protocol: true|false", defaultValue: true, name: "relay"
+ .}: bool
+
+ staticnodes* {.
+ desc: "Peer multiaddr to directly connect with. Argument may be repeated.",
+ name: "staticnode",
+ defaultValue: @[]
+ .}: seq[string]
+
+ mixnodes* {.
+ desc: "Peer ENR to add as a mixnode. Argument may be repeated.", name: "mixnode"
+ .}: seq[string]
+
+ keepAlive* {.
+ desc: "Enable keep-alive for idle connections: true|false",
+ defaultValue: false,
+ name: "keep-alive"
+ .}: bool
+
+ clusterId* {.
+ desc:
+ "Cluster id that the node is running in. Node in a different cluster id is disconnected.",
+ defaultValue: 1,
+ name: "cluster-id"
+ .}: uint16
+
+ numShardsInNetwork* {.
+ desc: "Number of shards in the network",
+ defaultValue: 8,
+ name: "num-shards-in-network"
+ .}: uint32
+
+ shards* {.
+ desc:
+ "Shards index to subscribe to [0..NUM_SHARDS_IN_NETWORK-1]. Argument may be repeated.",
+ defaultValue:
+ @[
+ uint16(0),
+ uint16(1),
+ uint16(2),
+ uint16(3),
+ uint16(4),
+ uint16(5),
+ uint16(6),
+ uint16(7),
+ ],
+ name: "shard"
+ .}: seq[uint16]
+
+ ## Store config
+ store* {.
+ desc: "Enable store protocol: true|false", defaultValue: false, name: "store"
+ .}: bool
+
+ storenode* {.
+ desc: "Peer multiaddr to query for storage.", defaultValue: "", name: "storenode"
+ .}: string
+
+ ## Filter config
+ filter* {.
+ desc: "Enable filter protocol: true|false", defaultValue: false, name: "filter"
+ .}: bool
+
+ ## Lightpush config
+ lightpush* {.
+ desc: "Enable lightpush protocol: true|false",
+ defaultValue: false,
+ name: "lightpush"
+ .}: bool
+
+ servicenode* {.
+ desc: "Peer multiaddr to request lightpush and filter services",
+ defaultValue: "",
+ name: "servicenode"
+ .}: string
+
+ ## Metrics config
+ metricsServer* {.
+ desc: "Enable the metrics server: true|false",
+ defaultValue: false,
+ name: "metrics-server"
+ .}: bool
+
+ metricsServerAddress* {.
+ desc: "Listening address of the metrics server.",
+ defaultValue: parseIpAddress("127.0.0.1"),
+ name: "metrics-server-address"
+ .}: IpAddress
+
+ metricsServerPort* {.
+ desc: "Listening HTTP port of the metrics server.",
+ defaultValue: 8008,
+ name: "metrics-server-port"
+ .}: uint16
+
+ metricsLogging* {.
+ desc: "Enable metrics logging: true|false",
+ defaultValue: true,
+ name: "metrics-logging"
+ .}: bool
+
+ ## DNS discovery config
+ dnsDiscovery* {.
+ desc:
+ "Deprecated, please set dns-discovery-url instead. Enable discovering nodes via DNS",
+ defaultValue: false,
+ name: "dns-discovery"
+ .}: bool
+
+ dnsDiscoveryUrl* {.
+ desc: "URL for DNS node list in format 'enrtree://@'",
+ defaultValue: "",
+ name: "dns-discovery-url"
+ .}: string
+
+ dnsDiscoveryNameServers* {.
+ desc: "DNS name server IPs to query. Argument may be repeated.",
+ defaultValue: @[parseIpAddress("1.1.1.1"), parseIpAddress("1.0.0.1")],
+ name: "dns-discovery-name-server"
+ .}: seq[IpAddress]
+
+ ## Chat2 configuration
+ fleet* {.
+ desc:
+ "Select the fleet to connect to. This sets the DNS discovery URL to the selected fleet.",
+ defaultValue: Fleet.test,
+ name: "fleet"
+ .}: Fleet
+
+ contentTopic* {.
+ desc: "Content topic for chat messages.",
+ defaultValue: "/toy-chat-mix/2/huilong/proto",
+ name: "content-topic"
+ .}: string
+
+ ## Websocket Configuration
+ websocketSupport* {.
+ desc: "Enable websocket: true|false",
+ defaultValue: false,
+ name: "websocket-support"
+ .}: bool
+
+ websocketPort* {.
+ desc: "WebSocket listening port.", defaultValue: 8000, name: "websocket-port"
+ .}: Port
+
+ websocketSecureSupport* {.
+ desc: "WebSocket Secure Support.",
+ defaultValue: false,
+ name: "websocket-secure-support"
+ .}: bool ## rln-relay configuration
+
+# NOTE: Keys are different in nim-libp2p
+proc parseCmdArg*(T: type crypto.PrivateKey, p: string): T =
+ try:
+ let key = SkPrivateKey.init(utils.fromHex(p)).tryGet()
+ # XXX: Here at the moment
+ result = crypto.PrivateKey(scheme: Secp256k1, skkey: key)
+ except CatchableError as e:
+ raise newException(ValueError, "Invalid private key")
+
+proc completeCmdArg*(T: type crypto.PrivateKey, val: string): seq[string] =
+ return @[]
+
+proc parseCmdArg*(T: type IpAddress, p: string): T =
+ try:
+ result = parseIpAddress(p)
+ except CatchableError as e:
+ raise newException(ValueError, "Invalid IP address")
+
+proc completeCmdArg*(T: type IpAddress, val: string): seq[string] =
+ return @[]
+
+proc parseCmdArg*(T: type Port, p: string): T =
+ try:
+ result = Port(parseInt(p))
+ except CatchableError as e:
+ raise newException(ValueError, "Invalid Port number")
+
+proc completeCmdArg*(T: type Port, val: string): seq[string] =
+ return @[]
+
+proc parseCmdArg*(T: type Option[uint], p: string): T =
+ try:
+ some(parseUint(p))
+ except CatchableError:
+ raise newException(ValueError, "Invalid unsigned integer")
+
+proc completeCmdArg*(T: type EthRpcUrl, val: string): seq[string] =
+ return @[]
+
+proc parseCmdArg*(T: type EthRpcUrl, s: string): T =
+ ## allowed patterns:
+ ## http://url:port
+ ## https://url:port
+ ## http://url:port/path
+ ## https://url:port/path
+ ## http://url/with/path
+ ## http://url:port/path?query
+ ## https://url:port/path?query
+ ## disallowed patterns:
+ ## any valid/invalid ws or wss url
+ var httpPattern =
+ re2"^(https?):\/\/((localhost)|([\w_-]+(?:(?:\.[\w_-]+)+)))(:[0-9]{1,5})?([\w.,@?^=%&:\/~+#-]*[\w@?^=%&\/~+#-])*"
+ var wsPattern =
+ re2"^(wss?):\/\/((localhost)|([\w_-]+(?:(?:\.[\w_-]+)+)))(:[0-9]{1,5})?([\w.,@?^=%&:\/~+#-]*[\w@?^=%&\/~+#-])*"
+ if regex.match(s, wsPattern):
+ raise newException(
+ ValueError, "Websocket RPC URL is not supported, Please use an HTTP URL"
+ )
+ if not regex.match(s, httpPattern):
+ raise newException(ValueError, "Invalid HTTP RPC URL")
+ return EthRpcUrl(s)
+
+func defaultListenAddress*(conf: Chat2Conf): IpAddress =
+ # TODO: How should we select between IPv4 and IPv6
+ # Maybe there should be a config option for this.
+ (static parseIpAddress("0.0.0.0"))
diff --git a/third-party/nwaku/apps/chat2mix/nim.cfg b/third-party/nwaku/apps/chat2mix/nim.cfg
new file mode 100644
index 0000000..2231f2e
--- /dev/null
+++ b/third-party/nwaku/apps/chat2mix/nim.cfg
@@ -0,0 +1,4 @@
+-d:chronicles_line_numbers
+-d:chronicles_runtime_filtering:on
+-d:discv5_protocol_id:d5waku
+path = "../.."
diff --git a/third-party/nwaku/apps/liteprotocoltester/.env b/third-party/nwaku/apps/liteprotocoltester/.env
new file mode 100644
index 0000000..0330284
--- /dev/null
+++ b/third-party/nwaku/apps/liteprotocoltester/.env
@@ -0,0 +1,27 @@
+START_PUBLISHING_AFTER_SECS=45
+# can add some seconds delay before SENDER starts publishing
+
+NUM_MESSAGES=0
+# 0 for infinite number of messages
+
+MESSAGE_INTERVAL_MILLIS=8000
+# ms delay between messages
+
+
+MIN_MESSAGE_SIZE=15Kb
+MAX_MESSAGE_SIZE=145Kb
+
+## for wakusim
+#SHARD=0
+#CONTENT_TOPIC=/tester/2/light-pubsub-test/wakusim
+#CLUSTER_ID=66
+
+## for status.prod
+#SHARDS=32
+CONTENT_TOPIC=/tester/2/light-pubsub-test/fleet
+CLUSTER_ID=16
+
+## for TWN
+#SHARD=4
+#CONTENT_TOPIC=/tester/2/light-pubsub-test/twn
+#CLUSTER_ID=1
diff --git a/third-party/nwaku/apps/liteprotocoltester/Dockerfile.liteprotocoltester b/third-party/nwaku/apps/liteprotocoltester/Dockerfile.liteprotocoltester
new file mode 100644
index 0000000..1948300
--- /dev/null
+++ b/third-party/nwaku/apps/liteprotocoltester/Dockerfile.liteprotocoltester
@@ -0,0 +1,37 @@
+ # TESTING IMAGE --------------------------------------------------------------
+
+ ## NOTICE: This is a short cut build file for ubuntu users who compiles nwaku in ubuntu distro.
+ ## This is used for faster turnaround time for testing the compiled binary.
+ ## Prerequisites: compiled liteprotocoltester binary in build/ directory
+
+ FROM ubuntu:noble AS prod
+
+ LABEL maintainer="zoltan@status.im"
+ LABEL source="https://github.com/waku-org/nwaku"
+ LABEL description="Lite Protocol Tester: Waku light-client"
+ LABEL commit="unknown"
+ LABEL version="unknown"
+
+ # DevP2P, LibP2P, and JSON RPC ports
+ EXPOSE 30303 60000 8545
+
+ # Referenced in the binary
+ RUN apt-get update && apt-get install -y --no-install-recommends \
+ libgcc1 \
+ libpcre3 \
+ libpq-dev \
+ wget \
+ iproute2 \
+ && rm -rf /var/lib/apt/lists/*
+
+ # Fix for 'Error loading shared library libpcre.so.3: No such file or directory'
+ RUN ln -s /usr/lib/libpcre.so /usr/lib/libpcre.so.3
+
+ COPY build/liteprotocoltester /usr/bin/
+ COPY apps/liteprotocoltester/run_tester_node.sh /usr/bin/
+ COPY apps/liteprotocoltester/run_tester_node_on_fleet.sh /usr/bin/
+
+ ENTRYPOINT ["/usr/bin/run_tester_node.sh", "/usr/bin/liteprotocoltester"]
+
+ # # By default just show help if called without arguments
+ CMD ["--help"]
diff --git a/third-party/nwaku/apps/liteprotocoltester/Dockerfile.liteprotocoltester.compile b/third-party/nwaku/apps/liteprotocoltester/Dockerfile.liteprotocoltester.compile
new file mode 100644
index 0000000..497570c
--- /dev/null
+++ b/third-party/nwaku/apps/liteprotocoltester/Dockerfile.liteprotocoltester.compile
@@ -0,0 +1,76 @@
+# BUILD NIM APP ----------------------------------------------------------------
+FROM rust:1.77.1-alpine3.18 AS nim-build
+
+ARG NIMFLAGS
+ARG MAKE_TARGET=liteprotocoltester
+ARG NIM_COMMIT
+ARG LOG_LEVEL=TRACE
+
+# Get build tools and required header files
+RUN apk add --no-cache bash git build-base openssl-dev linux-headers curl jq
+
+WORKDIR /app
+COPY . .
+
+# workaround for alpine issue: https://github.com/alpinelinux/docker-alpine/issues/383
+RUN apk update && apk upgrade
+
+# Ran separately from 'make' to avoid re-doing
+RUN git submodule update --init --recursive
+
+# Slowest build step for the sake of caching layers
+RUN make -j$(nproc) deps QUICK_AND_DIRTY_COMPILER=1 ${NIM_COMMIT}
+
+# Build the final node binary
+RUN make -j$(nproc) ${NIM_COMMIT} $MAKE_TARGET LOG_LEVEL=${LOG_LEVEL} NIMFLAGS="${NIMFLAGS}"
+
+
+# REFERENCE IMAGE as BASE for specialized PRODUCTION IMAGES----------------------------------------
+FROM alpine:3.18 AS base_lpt
+
+ARG MAKE_TARGET=liteprotocoltester
+
+LABEL maintainer="zoltan@status.im"
+LABEL source="https://github.com/waku-org/nwaku"
+LABEL description="Lite Protocol Tester: Waku light-client"
+LABEL commit="unknown"
+LABEL version="unknown"
+
+# DevP2P, LibP2P, and JSON RPC ports
+EXPOSE 30303 60000 8545
+
+# Referenced in the binary
+RUN apk add --no-cache libgcc libpq-dev \
+ wget \
+ iproute2 \
+ python3
+
+# Fix for 'Error loading shared library libpcre.so.3: No such file or directory'
+RUN ln -s /usr/lib/libpcre.so /usr/lib/libpcre.so.3
+
+COPY --from=nim-build /app/build/liteprotocoltester /usr/bin/
+RUN chmod +x /usr/bin/liteprotocoltester
+
+# Standalone image to be used manually and in lpt-runner -------------------------------------------
+FROM base_lpt AS standalone_lpt
+
+COPY --from=nim-build /app/apps/liteprotocoltester/run_tester_node.sh /usr/bin/
+COPY --from=nim-build /app/apps/liteprotocoltester/run_tester_node_on_fleet.sh /usr/bin/
+
+RUN chmod +x /usr/bin/run_tester_node.sh
+
+ENTRYPOINT ["/usr/bin/run_tester_node.sh", "/usr/bin/liteprotocoltester"]
+
+# Image for infra deployment -------------------------------------------
+FROM base_lpt AS deployment_lpt
+
+# let supervisor python script flush logs immediately
+ENV PYTHONUNBUFFERED="1"
+
+COPY --from=nim-build /app/apps/liteprotocoltester/run_tester_node_at_infra.sh /usr/bin/
+COPY --from=nim-build /app/apps/liteprotocoltester/infra.env /usr/bin/
+COPY --from=nim-build /app/apps/liteprotocoltester/lpt_supervisor.py /usr/bin/
+RUN chmod +x /usr/bin/run_tester_node_at_infra.sh
+RUN chmod +x /usr/bin/lpt_supervisor.py
+
+ENTRYPOINT ["/usr/bin/lpt_supervisor.py"]
diff --git a/third-party/nwaku/apps/liteprotocoltester/README.md b/third-party/nwaku/apps/liteprotocoltester/README.md
new file mode 100644
index 0000000..ea02ec1
--- /dev/null
+++ b/third-party/nwaku/apps/liteprotocoltester/README.md
@@ -0,0 +1,329 @@
+# Waku - Lite Protocol Tester
+
+## Aim
+
+Testing reliability of light client protocols in different scale.
+Measure message delivery reliability and latency between light push client(s) and a filter client(s) node(s).
+
+## Concept of testing
+
+A tester node is configured either 'publisher' or 'receiver' and connects to a certain service node.
+All service protocols are disabled except for lightpush client or filter client. This way we would like to simulate
+a light client application.
+Each publisher pumps messages to the network in a preconfigured way (number of messages, frequency) while on the receiver side
+we would like to track and measure message losses, mis-ordered receives, late arrived messages and latencies.
+Ideally the tester nodes will connect to different edge of the network where we can gather more result from mulitple publishers
+and multiple receivers.
+
+Publishers are fill all message payloads with information about the test message and sender, helping the receiver side to calculate results.
+
+## Usage
+
+### Using lpt-runner
+
+For ease of use, you can clone lpt-runner repository. That will utilize previously pushed liteprotocoltester docker image.
+It is recommended to use this method for fleet testing.
+
+```bash
+git clone https://github.com/waku-org/lpt-runner.git
+cd lpt-runner
+
+# check Reame.md for more information
+# edit .env file to your needs
+
+docker compose up -d
+
+# navigate localhost:3033 to see the lite-protocol-tester dashboard
+```
+
+> See more detailed examples below.
+
+### Integration with waku-simulator!
+
+- For convenience, integration is done in cooperation with waku-simulator repository, but nothing is tightly coupled.
+- waku-simulator must be started separately with its own configuration.
+- To enable waku-simulator working without RLN currently a separate branch is to be used.
+- When waku-simulator is configured and up and running, lite-protocol-tester composite docker setup can be started.
+
+```bash
+
+# Start waku-simulator
+
+git clone https://github.com/waku-org/waku-simulator.git ../waku-simulator
+cd ../waku-simulator
+git checkout chore-integrate-liteprotocoltester
+
+# optionally edit .env file
+
+docker compose -f docker-compose-norln.yml up -d
+
+# navigate localhost:30001 to see the waku-simulator dashboard
+
+cd ../{your-repository}
+
+make LOG_LEVEL=DEBUG liteprotocoltester
+
+cd apps/liteprotocoltester
+
+# optionally edit .env file
+
+docker compose -f docker-compose-on-simularor.yml build
+docker compose -f docker-compose-on-simularor.yml up -d
+docker compose -f docker-compose-on-simularor.yml logs -f receivernode
+```
+#### Current setup
+
+- waku-simulator is configured to run with 25 full node
+- liteprotocoltester is configured to run with 3 publisher and 1 receiver
+- liteprotocoltester is configured to run 1 lightpush service and a filter service node
+ - light clients are connected accordingly
+- publishers will send 250 messages in every 200ms with size between 1KiB and 120KiB
+- Notice there is a configurable wait before start publishing messages as it is noticed time is needed for the service nodes to get connected to full nodes from simulator
+- light clients will print report on their and the connected service node's connectivity to the network in every 20 secs.
+
+#### Test monitoring
+
+Navigate to http://localhost:3033 to see the lite-protocol-tester dashboard.
+
+### Run independently on a chosen waku fleet
+
+This option is simple as is just to run the built liteprotocoltester binary with run_tester_node.sh script.
+
+Syntax:
+`./run_tester_node.sh `
+
+How to run from you nwaku repository:
+```bash
+cd ../{your-repository}
+
+make LOG_LEVEL=DEBUG liteprotocoltester
+
+cd apps/liteprotocoltester
+
+# optionally edit .env file
+
+# run publisher side
+./run_tester_node.sh ../../build/liteprotocoltester SENDER [chosen service node address that support lightpush]
+
+# or run receiver side
+./run_tester_node.sh ../../build/liteprotocoltester RECEIVER [chosen service node address that support filter service]
+```
+
+#### Recommendations
+
+In order to run on any kind of network, it is recommended to deploy the built `liteprotocoltester` binary with the `.env` file and the `run_tester_node.sh` script to the desired machine.
+
+Select a lightpush service node and a filter service node from the targeted network, or you can run your own. Note down the selected peers peer_id.
+
+Run a SENDER role liteprotocoltester and a RECEIVER role one on different terminals. Depending on the test aim, you may want to redirect the output to a file.
+
+> RECEIVER side will periodically print statistics to standard output.
+
+## Configuration
+
+### Environment variables for docker compose runs
+
+| Variable | Description | Default |
+| ---: | :--- | :--- |
+| NUM_MESSAGES | Number of message to publish, 0 means infinite | 120 |
+| MESSAGE_INTERVAL_MILLIS | Frequency of messages in milliseconds | 1000 |
+| SHARD | Used shard for testing | 0 |
+| CONTENT_TOPIC | content_topic for testing | /tester/1/light-pubsub-example/proto |
+| CLUSTER_ID | cluster_id of the network | 16 |
+| START_PUBLISHING_AFTER_SECS | Delay in seconds before starting to publish to let service node connected | 5 |
+| MIN_MESSAGE_SIZE | Minimum message size in bytes | 1KiB |
+| MAX_MESSAGE_SIZE | Maximum message size in bytes | 120KiB |
+
+
+### Lite Protocol Tester application cli options
+
+| Option | Description | Default |
+| :--- | :--- | :--- |
+| --test_func | separation of PUBLISHER or RECEIVER mode | RECEIVER |
+| --service-node| Address of the service node to use for lightpush and/or filter service | - |
+| --bootstrap-node| Address of the fleet's bootstrap node to use to determine service peer randomly choosen from the network. `--service-node` switch has precedence over this | - |
+| --num-messages | Number of message to publish | 120 |
+| --message-interval | Frequency of messages in milliseconds | 1000 |
+| --min-message-size | Minimum message size in bytes | 1KiB |
+| --max-message-size | Maximum message size in bytes | 120KiB |
+| --start-publishing-after | Delay in seconds before starting to publish to let service node connected in seconds | 5 |
+| --pubsub-topic | Used pubsub_topic for testing | /waku/2/default-waku/proto |
+| --content_topic | content_topic for testing | /tester/1/light-pubsub-example/proto |
+| --cluster-id | Cluster id for the test | 0 |
+| --config-file | TOML configuration file to fine tune the light waku node
Note that some configurations (full node services) are not taken into account | - |
+| --nat |Same as wakunode "nat" configuration, appear here to ease test setup | any |
+| --rest-address | For convenience rest configuration can be done here | 127.0.0.1 |
+| --rest-port | For convenience rest configuration can be done here | 8654 |
+| --rest-allow-origin | For convenience rest configuration can be done here | * |
+| --log-level | Log level for the application | DEBUG |
+| --log-format | Logging output format (TEXT or JSON) | TEXT |
+| --metrics-port | Metrics scarpe port | 8003 |
+
+### Specifying peer addresses
+
+Service node or bootstrap addresses can be specified in multiadress or ENR form.
+
+### Using bootstrap nodes
+
+There are multiple benefits of using bootstrap nodes. By using them liteprotocoltester will use Peer Exchange protocol to get possible peers from the network that are capable to serve as service peers for testing. Additionally it will test dial them to verify their connectivity - this will be reported in the logs and on dashboard metrics.
+Also by using bootstrap node and peer exchange discovery, litprotocoltester will be able to simulate service peer switch in case of failures. There are built in tresholds count for service peer failures (3) after service peer will be switched during the test. Also there will be max 10 trials of switching peer before test declared failed and quit.
+These service peer failures are reported, thus extending network reliability measures.
+
+### Building docker image
+
+Easiest way to build the docker image is to use the provided Makefile target.
+
+```bash
+cd
+make docker-liteprotocoltester
+```
+This will build liteprotocoltester from the ground up and create a docker image with the binary copied to it under image name and tag `wakuorg/liteprotocoltester:latest`.
+
+#### Building public image
+
+If you want to push the image to a public registry, you can use the jenkins job to do so.
+The job is available at https://ci.status.im/job/waku/job/liteprotocoltester/job/build-liteprotocoltester-image
+
+#### Building and deployment for infra testing
+
+For specific and continuous testing purposes we have a deployment of `liteprotocoltester` test suite to our infra appliances.
+This has its own configuration, constraints and requirements. To ease this job, image shall be built and pushed with `deploy` tag.
+This can be done by the jenkins job mentioned above.
+
+or manually by:
+```bash
+cd
+make DOCKER_LPT_TAG=deploy docker-liteprotocoltester
+```
+
+The image created with this method will be different from under any other tag. It prepared to run a preconfigured test suite continuously.
+It will also miss prometheus metrics scraping endpoint and grafana, thus it is not recommended to use it for general testing.
+
+#### Manually building for docker compose runs on simulator or standalone
+Please note that currently to ease testing and development tester application docker image is based on ubuntu and uses the externally pre-built binary of 'liteprotocoltester'.
+This speeds up image creation. Another dokcer build file is provided for proper build of boundle image.
+
+> `Dockerfile.liteprotocoltester` will create an ubuntu based image with the binary copied from the build directory.
+
+> `Dockerfile.liteprotocoltester.compile` will create an ubuntu based image completely compiled from source. This can be slow.
+
+#### Creating standalone runner docker image
+
+To ease the work with lite-protocol-tester, a docker image is possible to build.
+With that image it is easy to run the application in a container.
+
+> `Dockerfile.liteprotocoltester` will create an ubuntu image with the binary copied from the build directory. You need to pre-build the application.
+
+Here is how to build and run:
+```bash
+cd
+make liteprotocoltester
+
+cd apps/liteprotocoltester
+docker build -t liteprotocoltester:latest -f Dockerfile.liteprotocoltester ../..
+
+# alternatively you can push it to a registry
+
+# edit and adjust .env file to your needs and for the network configuration
+
+docker run --env-file .env liteprotocoltester:latest RECEIVER
+
+docker run --env-file .env liteprotocoltester:latest SENDER
+```
+
+#### Run test with auto service peer selection from a fleet using bootstrap node
+
+```bash
+
+docker run --env-file .env liteprotocoltester:latest RECEIVER BOOTSTRAP
+
+docker run --env-file .env liteprotocoltester:latest SENDER BOOTSTRAP
+```
+
+> Notice that official image is also available at harbor.status.im/wakuorg/liteprotocoltester:latest
+
+## Examples
+
+### Bootstrap or Service node selection
+
+The easiest way to get the proper bootstrap nodes for the tests from https://fleets.status.im page.
+Adjust on which fleets you would like to run the tests.
+
+> Please note that not all of them configured to support Peer Exchange protocol, those ones cannot be for bootstrap nodes for `liteprotocoltester`.
+
+### Environment variables
+You need not necessary to use .env file, although it can be more convenient.
+Anytime you can override all or part of the environment variables defined in the .env file.
+
+### Run standalone
+
+Example of running the liteprotocoltester in standalone mode on status.stagin network.
+Testing includes using bootstrap nodes to gather service peers from the network via Peer Exchange protocol.
+Both parties will test-dial all the peers retrieved with the corresponding protocol.
+Sender will start publishing messages after 60 seconds, sending 200 messages with 1 second delay between them.
+Message size will be between 15KiB and 145KiB.
+Cluster id and Pubsub-topic must be accurately set according to the network configuration.
+
+The example shows that either multiaddress or ENR form accepted.
+
+```bash
+export START_PUBLISHING_AFTER_SECS=60
+export NUM_MESSAGES=200
+export MESSAGE_INTERVAL_MILLIS=1000
+export MIN_MESSAGE_SIZE=15Kb
+export MAX_MESSAGE_SIZE=145Kb
+export SHARD=32
+export CONTENT_TOPIC=/tester/2/light-pubsub-test/fleet
+export CLUSTER_ID=16
+
+docker run harbor.status.im/wakuorg/liteprotocoltester:latest RECEIVER /dns4/boot-01.do-ams3.status.staging.status.im/tcp/30303/p2p/16Uiu2HAmQE7FXQc6iZHdBzYfw3qCSDa9dLc1wsBJKoP4aZvztq2d BOOTSTRAP
+
+# in different terminal session, repeat the exports and run the other party of the test.
+docker run harbor.status.im/wakuorg/liteprotocoltester:latest SENDER enr:-QEiuECJPv2vL00Jp5sTEMAFyW7qXkK2cFgphlU_G8-FJuJqoW_D5aWIy3ylGdv2K8DkiG7PWgng4Ql_VI7Qc2RhBdwfAYJpZIJ2NIJpcIQvTKi6im11bHRpYWRkcnO4cgA2NjFib290LTAxLmFjLWNuLWhvbmdrb25nLWMuc3RhdHVzLnN0YWdpbmcuc3RhdHVzLmltBnZfADg2MWJvb3QtMDEuYWMtY24taG9uZ2tvbmctYy5zdGF0dXMuc3RhZ2luZy5zdGF0dXMuaW0GAbveA4Jyc40AEAUAAQAgAEAAgAEAiXNlY3AyNTZrMaEDkbgV7oqPNmFtX5FzSPi9WH8kkmrPB1R3n9xRXge91M-DdGNwgnZfg3VkcIIjKIV3YWt1Mg0 BOOTSTRAP
+
+```
+
+### Use of lpt-runner
+
+Another method is to use [lpt-runner repository](https://github.com/waku-org/lpt-runner/tree/master).
+This extends testing with grafana dashboard and ease the test setup.
+Please read the corresponding [README](https://github.com/waku-org/lpt-runner/blob/master/README.md) there as well.
+
+In this example we will run similar test as above but there will be 3 instances of publisher nodes and 1 receiver node.
+This test uses waku.sandbox fleet which is connected to TWN. This implies lower message rates due to the RLN rate limation.
+Also leave a gap of 120 seconds before starting to publish messages to let receiver side fully finish peer test-dialing.
+For TWN network it is always wise to use bootstrap nodes with Peer Exchange support.
+
+> Theoritically we can use the same bootstrap nodes for both parties, but it is recommended to use different ones to simulate different network edges, thus getting more meaningful results.
+
+```bash
+git clone https://github.com/waku-org/lpt-runner.git
+cd lpt-runner
+
+export NUM_PUBLISHER_NODES=3
+export NUM_RECEIVER_NODES=1
+export START_PUBLISHING_AFTER_SECS=120
+export NUM_MESSAGES=300
+export MESSAGE_INTERVAL_MILLIS=7000
+export MIN_MESSAGE_SIZE=15Kb
+export MAX_MESSAGE_SIZE=145Kb
+export SHARD=4
+export CONTENT_TOPIC=/tester/2/light-pubsub-test/twn
+export CLUSTER_ID=1
+
+export FILTER_BOOTSTRAP=/dns4/node-01.ac-cn-hongkong-c.waku.sandbox.status.im/tcp/30303/p2p/16Uiu2HAmQYiojgZ8APsh9wqbWNyCstVhnp9gbeNrxSEQnLJchC92
+export LIGHTPUSH_BOOTSTRAP=/dns4/node-01.do-ams3.waku.sandbox.status.im/tcp/30303/p2p/16Uiu2HAmNaeL4p3WEYzC9mgXBmBWSgWjPHRvatZTXnp8Jgv3iKsb
+
+docker compose up -d
+
+# we can check logs from one or all SENDER
+docker compose logs -f --index 1 publishernode
+
+# for checking receiver side performance
+docker compose logs -f receivernode
+
+# when test completed
+docker compose down
+```
+
+For dashboard navigate to http://localhost:3033
diff --git a/third-party/nwaku/apps/liteprotocoltester/diagnose_connections.nim b/third-party/nwaku/apps/liteprotocoltester/diagnose_connections.nim
new file mode 100644
index 0000000..f595b4e
--- /dev/null
+++ b/third-party/nwaku/apps/liteprotocoltester/diagnose_connections.nim
@@ -0,0 +1,65 @@
+when (NimMajor, NimMinor) < (1, 4):
+ {.push raises: [Defect].}
+else:
+ {.push raises: [].}
+
+import
+ std/[options, net, strformat],
+ chronicles,
+ chronos,
+ metrics,
+ libbacktrace,
+ libp2p/crypto/crypto,
+ confutils,
+ libp2p/wire
+
+import
+ ../../tools/confutils/cli_args,
+ waku/[
+ node/peer_manager,
+ waku_lightpush/common,
+ waku_relay,
+ waku_filter_v2,
+ waku_peer_exchange/protocol,
+ waku_core/multiaddrstr,
+ waku_enr/capabilities,
+ ]
+logScope:
+ topics = "diagnose connections"
+
+proc allPeers(pm: PeerManager): string =
+ var allStr: string = ""
+ for idx, peer in pm.switch.peerStore.peers():
+ allStr.add(
+ " " & $idx & ". | " & constructMultiaddrStr(peer) & " | agent: " &
+ peer.getAgent() & " | protos: " & $peer.protocols & " | caps: " &
+ $peer.enr.map(getCapabilities) & "\n"
+ )
+ return allStr
+
+proc logSelfPeers*(pm: PeerManager) =
+ let selfLighpushPeers = pm.switch.peerStore.getPeersByProtocol(WakuLightPushCodec)
+ let selfRelayPeers = pm.switch.peerStore.getPeersByProtocol(WakuRelayCodec)
+ let selfFilterPeers = pm.switch.peerStore.getPeersByProtocol(WakuFilterSubscribeCodec)
+ let selfPxPeers = pm.switch.peerStore.getPeersByProtocol(WakuPeerExchangeCodec)
+
+ let printable = catch:
+ """*------------------------------------------------------------------------------------------*
+| Self ({constructMultiaddrStr(pm.switch.peerInfo)}) peers:
+*------------------------------------------------------------------------------------------*
+| Lightpush peers({selfLighpushPeers.len()}): ${selfLighpushPeers}
+*------------------------------------------------------------------------------------------*
+| Filter peers({selfFilterPeers.len()}): ${selfFilterPeers}
+*------------------------------------------------------------------------------------------*
+| Relay peers({selfRelayPeers.len()}): ${selfRelayPeers}
+*------------------------------------------------------------------------------------------*
+| PX peers({selfPxPeers.len()}): ${selfPxPeers}
+*------------------------------------------------------------------------------------------*
+| All peers with protocol support:
+{allPeers(pm)}
+*------------------------------------------------------------------------------------------*""".fmt()
+
+ if printable.isErr():
+ echo "Error while printing statistics: " & printable.error().msg
+ else:
+ echo printable.get()
diff --git a/third-party/nwaku/apps/liteprotocoltester/docker-compose-on-simularor.yml b/third-party/nwaku/apps/liteprotocoltester/docker-compose-on-simularor.yml
new file mode 100644
index 0000000..9e899f7
--- /dev/null
+++ b/third-party/nwaku/apps/liteprotocoltester/docker-compose-on-simularor.yml
@@ -0,0 +1,227 @@
+version: "3.7"
+x-logging: &logging
+ logging:
+ driver: json-file
+ options:
+ max-size: 1000m
+
+# Environment variable definitions
+x-eth-client-address: ð_client_address ${ETH_CLIENT_ADDRESS:-} # Add your ETH_CLIENT_ADDRESS after the "-"
+
+x-rln-environment: &rln_env
+ RLN_RELAY_CONTRACT_ADDRESS: ${RLN_RELAY_CONTRACT_ADDRESS:-0xF471d71E9b1455bBF4b85d475afb9BB0954A29c4}
+ RLN_RELAY_CRED_PATH: ${RLN_RELAY_CRED_PATH:-} # Optional: Add your RLN_RELAY_CRED_PATH after the "-"
+ RLN_RELAY_CRED_PASSWORD: ${RLN_RELAY_CRED_PASSWORD:-} # Optional: Add your RLN_RELAY_CRED_PASSWORD after the "-"
+
+x-test-running-conditions: &test_running_conditions
+ NUM_MESSAGES: ${NUM_MESSAGES:-120}
+ MESSAGE_INTERVAL_MILLIS: "${MESSAGE_INTERVAL_MILLIS:-1000}"
+ SHARD: ${SHARD:-0}
+ CONTENT_TOPIC: ${CONTENT_TOPIC:-/tester/2/light-pubsub-test/wakusim}
+ CLUSTER_ID: ${CLUSTER_ID:-66}
+ MIN_MESSAGE_SIZE: ${MIN_MESSAGE_SIZE:-1Kb}
+ MAX_MESSAGE_SIZE: ${MAX_MESSAGE_SIZE:-150Kb}
+ START_PUBLISHING_AFTER_SECS: ${START_PUBLISHING_AFTER_SECS:-5} # seconds
+
+
+# Services definitions
+services:
+ lightpush-service:
+ image: ${NWAKU_IMAGE:-harbor.status.im/wakuorg/nwaku:latest-release}
+ # ports:
+ # - 30304:30304/tcp
+ # - 30304:30304/udp
+ # - 9005:9005/udp
+ # - 127.0.0.1:8003:8003
+ # - 80:80 #Let's Encrypt
+ # - 8000:8000/tcp #WSS
+ # - 127.0.0.1:8645:8645
+ <<:
+ - *logging
+ environment:
+ DOMAIN: ${DOMAIN}
+ RLN_RELAY_CRED_PASSWORD: "${RLN_RELAY_CRED_PASSWORD}"
+ ETH_CLIENT_ADDRESS: *eth_client_address
+ EXTRA_ARGS: ${EXTRA_ARGS}
+ <<:
+ - *rln_env
+ - *test_running_conditions
+ volumes:
+ - ./run_service_node.sh:/opt/run_service_node.sh:Z
+ - ${CERTS_DIR:-./certs}:/etc/letsencrypt/:Z
+ - ./rln_tree:/etc/rln_tree/:Z
+ - ./keystore:/keystore:Z
+ entrypoint: sh
+ command:
+ - /opt/run_service_node.sh
+ - LIGHTPUSH
+ networks:
+ - waku-simulator_simulation
+
+ publishernode:
+ image: waku.liteprotocoltester:latest
+ build:
+ context: ../..
+ dockerfile: ./apps/liteprotocoltester/Dockerfile.liteprotocoltester
+ deploy:
+ replicas: ${NUM_PUBLISHER_NODES:-3}
+ # ports:
+ # - 30304:30304/tcp
+ # - 30304:30304/udp
+ # - 9005:9005/udp
+ # - 127.0.0.1:8003:8003
+ # - 80:80 #Let's Encrypt
+ # - 8000:8000/tcp #WSS
+ # - 127.0.0.1:8646:8646
+ <<:
+ - *logging
+ environment:
+ DOMAIN: ${DOMAIN}
+ RLN_RELAY_CRED_PASSWORD: "${RLN_RELAY_CRED_PASSWORD}"
+ ETH_CLIENT_ADDRESS: *eth_client_address
+ EXTRA_ARGS: ${EXTRA_ARGS}
+ <<:
+ - *rln_env
+ - *test_running_conditions
+ volumes:
+ - ${CERTS_DIR:-./certs}:/etc/letsencrypt/:Z
+ - ./rln_tree:/etc/rln_tree/:Z
+ - ./keystore:/keystore:Z
+ entrypoint: sh
+ command:
+ - /usr/bin/run_tester_node.sh
+ - /usr/bin/liteprotocoltester
+ - SENDER
+ - waku-sim
+ depends_on:
+ - lightpush-service
+ configs:
+ - source: cfg_tester_node.toml
+ target: config.toml
+ networks:
+ - waku-simulator_simulation
+
+ filter-service:
+ image: ${NWAKU_IMAGE:-harbor.status.im/wakuorg/nwaku:latest-release}
+ # ports:
+ # - 30304:30305/tcp
+ # - 30304:30305/udp
+ # - 9005:9005/udp
+ # - 127.0.0.1:8003:8003
+ # - 80:80 #Let's Encrypt
+ # - 8000:8000/tcp #WSS
+ # - 127.0.0.1:8645:8645
+ <<:
+ - *logging
+ environment:
+ DOMAIN: ${DOMAIN}
+ RLN_RELAY_CRED_PASSWORD: "${RLN_RELAY_CRED_PASSWORD}"
+ ETH_CLIENT_ADDRESS: *eth_client_address
+ EXTRA_ARGS: ${EXTRA_ARGS}
+ <<:
+ - *rln_env
+ - *test_running_conditions
+ volumes:
+ - ./run_service_node.sh:/opt/run_service_node.sh:Z
+ - ${CERTS_DIR:-./certs}:/etc/letsencrypt/:Z
+ - ./rln_tree:/etc/rln_tree/:Z
+ - ./keystore:/keystore:Z
+ entrypoint: sh
+ command:
+ - /opt/run_service_node.sh
+ - FILTER
+ networks:
+ - waku-simulator_simulation
+
+
+ receivernode:
+ image: waku.liteprotocoltester:latest
+ build:
+ context: ../..
+ dockerfile: ./apps/liteprotocoltester/Dockerfile.liteprotocoltester
+ deploy:
+ replicas: ${NUM_RECEIVER_NODES:-1}
+ # ports:
+ # - 30304:30304/tcp
+ # - 30304:30304/udp
+ # - 9005:9005/udp
+ # - 127.0.0.1:8003:8003
+ # - 80:80 #Let's Encrypt
+ # - 8000:8000/tcp #WSS
+ # - 127.0.0.1:8647:8647
+ <<:
+ - *logging
+ environment:
+ DOMAIN: ${DOMAIN}
+ RLN_RELAY_CRED_PASSWORD: "${RLN_RELAY_CRED_PASSWORD}"
+ ETH_CLIENT_ADDRESS: *eth_client_address
+ EXTRA_ARGS: ${EXTRA_ARGS}
+ <<:
+ - *rln_env
+ - *test_running_conditions
+ volumes:
+ - ${CERTS_DIR:-./certs}:/etc/letsencrypt/:Z
+ - ./rln_tree:/etc/rln_tree/:Z
+ - ./keystore:/keystore:Z
+ entrypoint: sh
+ command:
+ - /usr/bin/run_tester_node.sh
+ - /usr/bin/liteprotocoltester
+ - RECEIVER
+ - waku-sim
+ depends_on:
+ - filter-service
+ - publishernode
+ configs:
+ - source: cfg_tester_node.toml
+ target: config.toml
+ networks:
+ - waku-simulator_simulation
+
+ # We have prometheus and grafana defined in waku-simulator already
+ prometheus:
+ image: docker.io/prom/prometheus:latest
+ volumes:
+ - ./monitoring/prometheus-config.yml:/etc/prometheus/prometheus.yml:Z
+ command:
+ - --config.file=/etc/prometheus/prometheus.yml
+ - --web.listen-address=:9099
+ # ports:
+ # - 127.0.0.1:9090:9090
+ restart: on-failure:5
+ depends_on:
+ - filter-service
+ - lightpush-service
+ - publishernode
+ - receivernode
+ networks:
+ - waku-simulator_simulation
+
+ grafana:
+ image: docker.io/grafana/grafana:latest
+ env_file:
+ - ./monitoring/configuration/grafana-plugins.env
+ volumes:
+ - ./monitoring/configuration/grafana.ini:/etc/grafana/grafana.ini:Z
+ - ./monitoring/configuration/dashboards.yaml:/etc/grafana/provisioning/dashboards/dashboards.yaml:Z
+ - ./monitoring/configuration/datasources.yaml:/etc/grafana/provisioning/datasources/datasources.yaml:Z
+ - ./monitoring/configuration/dashboards:/var/lib/grafana/dashboards/:Z
+ - ./monitoring/configuration/customizations/custom-logo.svg:/usr/share/grafana/public/img/grafana_icon.svg:Z
+ - ./monitoring/configuration/customizations/custom-logo.svg:/usr/share/grafana/public/img/grafana_typelogo.svg:Z
+ - ./monitoring/configuration/customizations/custom-logo.png:/usr/share/grafana/public/img/fav32.png:Z
+ ports:
+ - 0.0.0.0:3033:3033
+ restart: on-failure:5
+ depends_on:
+ - prometheus
+ networks:
+ - waku-simulator_simulation
+
+configs:
+ cfg_tester_node.toml:
+ content: |
+ max-connections = 100
+
+networks:
+ waku-simulator_simulation:
+ external: true
diff --git a/third-party/nwaku/apps/liteprotocoltester/docker-compose.yml b/third-party/nwaku/apps/liteprotocoltester/docker-compose.yml
new file mode 100644
index 0000000..16b5446
--- /dev/null
+++ b/third-party/nwaku/apps/liteprotocoltester/docker-compose.yml
@@ -0,0 +1,172 @@
+version: "3.7"
+x-logging: &logging
+ logging:
+ driver: json-file
+ options:
+ max-size: 1000m
+
+# Environment variable definitions
+x-eth-client-address: ð_client_address ${ETH_CLIENT_ADDRESS:-} # Add your ETH_CLIENT_ADDRESS after the "-"
+
+x-rln-environment: &rln_env
+ RLN_RELAY_CONTRACT_ADDRESS: ${RLN_RELAY_CONTRACT_ADDRESS:-0xB9cd878C90E49F797B4431fBF4fb333108CB90e6}
+ RLN_RELAY_CRED_PATH: ${RLN_RELAY_CRED_PATH:-} # Optional: Add your RLN_RELAY_CRED_PATH after the "-"
+ RLN_RELAY_CRED_PASSWORD: ${RLN_RELAY_CRED_PASSWORD:-} # Optional: Add your RLN_RELAY_CRED_PASSWORD after the "-"
+
+x-test-running-conditions: &test_running_conditions
+ NUM_MESSAGES: ${NUM_MESSAGES:-120}
+ MESSAGE_INTERVAL_MILLIS: "${MESSAGE_INTERVAL_MILLIS:-1000}"
+ SHARD: ${SHARD:-0}
+ CONTENT_TOPIC: ${CONTENT_TOPIC:-/tester/2/light-pubsub-test/wakusim}
+ CLUSTER_ID: ${CLUSTER_ID:-66}
+ MIN_MESSAGE_SIZE: ${MIN_MESSAGE_SIZE:-1Kb}
+ MAX_MESSAGE_SIZE: ${MAX_MESSAGE_SIZE:-150Kb}
+ START_PUBLISHING_AFTER_SECS: ${START_PUBLISHING_AFTER_SECS:-5} # seconds
+ STANDALONE: ${STANDALONE:-1}
+ RECEIVER_METRICS_PORT: 8003
+ PUBLISHER_METRICS_PORT: 8003
+
+
+# Services definitions
+services:
+ servicenode:
+ image: ${NWAKU_IMAGE:-harbor.status.im/wakuorg/nwaku:latest-release}
+ ports:
+ - 30304:30304/tcp
+ - 30304:30304/udp
+ - 9005:9005/udp
+ - 127.0.0.1:8003:8003
+ - 80:80 #Let's Encrypt
+ - 8000:8000/tcp #WSS
+ - 127.0.0.1:8645:8645
+ <<:
+ - *logging
+ environment:
+ DOMAIN: ${DOMAIN}
+ RLN_RELAY_CRED_PASSWORD: "${RLN_RELAY_CRED_PASSWORD}"
+ ETH_CLIENT_ADDRESS: *eth_client_address
+ EXTRA_ARGS: ${EXTRA_ARGS}
+ <<:
+ - *rln_env
+ - *test_running_conditions
+ volumes:
+ - ./run_service_node.sh:/opt/run_service_node.sh:Z
+ - ${CERTS_DIR:-./certs}:/etc/letsencrypt/:Z
+ - ./rln_tree:/etc/rln_tree/:Z
+ - ./keystore:/keystore:Z
+ entrypoint: sh
+ command:
+ - /opt/run_service_node.sh
+
+ publishernode:
+ image: waku.liteprotocoltester:latest
+ build:
+ context: ../..
+ dockerfile: ./apps/liteprotocoltester/Dockerfile.liteprotocoltester
+ ports:
+ # - 30304:30304/tcp
+ # - 30304:30304/udp
+ # - 9005:9005/udp
+ # - 127.0.0.1:8003:8003
+ # - 80:80 #Let's Encrypt
+ # - 8000:8000/tcp #WSS
+ - 127.0.0.1:8646:8646
+ <<:
+ - *logging
+ environment:
+ DOMAIN: ${DOMAIN}
+ RLN_RELAY_CRED_PASSWORD: "${RLN_RELAY_CRED_PASSWORD}"
+ ETH_CLIENT_ADDRESS: *eth_client_address
+ EXTRA_ARGS: ${EXTRA_ARGS}
+ <<:
+ - *rln_env
+ - *test_running_conditions
+ volumes:
+ - ${CERTS_DIR:-./certs}:/etc/letsencrypt/:Z
+ - ./rln_tree:/etc/rln_tree/:Z
+ - ./keystore:/keystore:Z
+ entrypoint: sh
+ command:
+ - /usr/bin/run_tester_node.sh
+ - /usr/bin/liteprotocoltester
+ - SENDER
+ - servicenode
+ depends_on:
+ - servicenode
+ configs:
+ - source: cfg_tester_node.toml
+ target: config.toml
+
+ receivernode:
+ image: waku.liteprotocoltester:latest
+ build:
+ context: ../..
+ dockerfile: ./apps/liteprotocoltester/Dockerfile.liteprotocoltester
+ ports:
+ # - 30304:30304/tcp
+ # - 30304:30304/udp
+ # - 9005:9005/udp
+ # - 127.0.0.1:8003:8003
+ # - 80:80 #Let's Encrypt
+ # - 8000:8000/tcp #WSS
+ - 127.0.0.1:8647:8647
+ <<:
+ - *logging
+ environment:
+ DOMAIN: ${DOMAIN}
+ RLN_RELAY_CRED_PASSWORD: "${RLN_RELAY_CRED_PASSWORD}"
+ ETH_CLIENT_ADDRESS: *eth_client_address
+ EXTRA_ARGS: ${EXTRA_ARGS}
+ <<:
+ - *rln_env
+ - *test_running_conditions
+ volumes:
+ - ./run_tester_node.sh:/opt/run_tester_node.sh:Z
+ - ${CERTS_DIR:-./certs}:/etc/letsencrypt/:Z
+ - ./rln_tree:/etc/rln_tree/:Z
+ - ./keystore:/keystore:Z
+ entrypoint: sh
+ command:
+ - /usr/bin/run_tester_node.sh
+ - /usr/bin/liteprotocoltester
+ - RECEIVER
+ - servicenode
+ depends_on:
+ - servicenode
+ - publishernode
+ configs:
+ - source: cfg_tester_node.toml
+ target: config.toml
+
+ prometheus:
+ image: docker.io/prom/prometheus:latest
+ volumes:
+ - ./monitoring/prometheus-config.yml:/etc/prometheus/prometheus.yml:Z
+ command:
+ - --config.file=/etc/prometheus/prometheus.yml
+ ports:
+ - 127.0.0.1:9090:9090
+ depends_on:
+ - servicenode
+
+ grafana:
+ image: docker.io/grafana/grafana:latest
+ env_file:
+ - ./monitoring/configuration/grafana-plugins.env
+ volumes:
+ - ./monitoring/configuration/grafana.ini:/etc/grafana/grafana.ini:Z
+ - ./monitoring/configuration/dashboards.yaml:/etc/grafana/provisioning/dashboards/dashboards.yaml:Z
+ - ./monitoring/configuration/datasources.yaml:/etc/grafana/provisioning/datasources/datasources.yaml:Z
+ - ./monitoring/configuration/dashboards:/var/lib/grafana/dashboards/:Z
+ - ./monitoring/configuration/customizations/custom-logo.svg:/usr/share/grafana/public/img/grafana_icon.svg:Z
+ - ./monitoring/configuration/customizations/custom-logo.svg:/usr/share/grafana/public/img/grafana_typelogo.svg:Z
+ - ./monitoring/configuration/customizations/custom-logo.png:/usr/share/grafana/public/img/fav32.png:Z
+ ports:
+ - 0.0.0.0:3000:3000
+ depends_on:
+ - prometheus
+
+configs:
+ cfg_tester_node.toml:
+ content: |
+ max-connections = 100
diff --git a/third-party/nwaku/apps/liteprotocoltester/infra.env b/third-party/nwaku/apps/liteprotocoltester/infra.env
new file mode 100644
index 0000000..ebf6147
--- /dev/null
+++ b/third-party/nwaku/apps/liteprotocoltester/infra.env
@@ -0,0 +1,11 @@
+TEST_INTERVAL_MINUTES=180
+START_PUBLISHING_AFTER_SECS=120
+NUM_MESSAGES=300
+MESSAGE_INTERVAL_MILLIS=1000
+MIN_MESSAGE_SIZE=15Kb
+MAX_MESSAGE_SIZE=145Kb
+SHARD=32
+CONTENT_TOPIC=/tester/2/light-pubsub-test-at-infra/status-prod
+CLUSTER_ID=16
+LIGHTPUSH_BOOTSTRAP=enr:-QEKuED9AJm2HGgrRpVaJY2nj68ao_QiPeUT43sK-aRM7sMJ6R4G11OSDOwnvVacgN1sTw-K7soC5dzHDFZgZkHU0u-XAYJpZIJ2NIJpcISnYxMvim11bHRpYWRkcnO4WgAqNiVib290LTAxLmRvLWFtczMuc3RhdHVzLnByb2Quc3RhdHVzLmltBnZfACw2JWJvb3QtMDEuZG8tYW1zMy5zdGF0dXMucHJvZC5zdGF0dXMuaW0GAbveA4Jyc40AEAUAAQAgAEAAgAEAiXNlY3AyNTZrMaEC3rRtFQSgc24uWewzXaxTY8hDAHB8sgnxr9k8Rjb5GeSDdGNwgnZfg3VkcIIjKIV3YWt1Mg0
+FILTER_BOOTSTRAP=enr:-QEcuED7ww5vo2rKc1pyBp7fubBUH-8STHEZHo7InjVjLblEVyDGkjdTI9VdqmYQOn95vuQH-Htku17WSTzEufx-Wg4mAYJpZIJ2NIJpcIQihw1Xim11bHRpYWRkcnO4bAAzNi5ib290LTAxLmdjLXVzLWNlbnRyYWwxLWEuc3RhdHVzLnByb2Quc3RhdHVzLmltBnZfADU2LmJvb3QtMDEuZ2MtdXMtY2VudHJhbDEtYS5zdGF0dXMucHJvZC5zdGF0dXMuaW0GAbveA4Jyc40AEAUAAQAgAEAAgAEAiXNlY3AyNTZrMaECxjqgDQ0WyRSOilYU32DA5k_XNlDis3m1VdXkK9xM6kODdGNwgnZfg3VkcIIjKIV3YWt1Mg0
diff --git a/third-party/nwaku/apps/liteprotocoltester/legacy_publisher.nim b/third-party/nwaku/apps/liteprotocoltester/legacy_publisher.nim
new file mode 100644
index 0000000..12733ad
--- /dev/null
+++ b/third-party/nwaku/apps/liteprotocoltester/legacy_publisher.nim
@@ -0,0 +1,24 @@
+import chronos, results, options
+import waku/[waku_node, waku_core]
+import publisher_base
+
+type LegacyPublisher* = ref object of PublisherBase
+
+proc new*(T: type LegacyPublisher, wakuNode: WakuNode): T =
+ if isNil(wakuNode.wakuLegacyLightpushClient):
+ wakuNode.mountLegacyLightPushClient()
+
+ return LegacyPublisher(wakuNode: wakuNode)
+
+method send*(
+ self: LegacyPublisher,
+ topic: PubsubTopic,
+ message: WakuMessage,
+ servicePeer: RemotePeerInfo,
+): Future[Result[void, string]] {.async.} =
+ # when error it must return original error desc due the text is used for distinction between error types in metrics.
+ discard (
+ await self.wakuNode.legacyLightpushPublish(some(topic), message, servicePeer)
+ ).valueOr:
+ return err(error)
+ return ok()
diff --git a/third-party/nwaku/apps/liteprotocoltester/liteprotocoltester.nim b/third-party/nwaku/apps/liteprotocoltester/liteprotocoltester.nim
new file mode 100644
index 0000000..2db9bf5
--- /dev/null
+++ b/third-party/nwaku/apps/liteprotocoltester/liteprotocoltester.nim
@@ -0,0 +1,217 @@
+{.push raises: [].}
+
+import
+ std/[options, strutils, os, sequtils, net],
+ chronicles,
+ chronos,
+ metrics,
+ libbacktrace,
+ system/ansi_c,
+ libp2p/crypto/crypto,
+ confutils
+
+import
+ ../../tools/confutils/cli_args,
+ waku/[
+ common/enr,
+ common/logging,
+ factory/waku as waku_factory,
+ waku_node,
+ node/waku_metrics,
+ node/peer_manager,
+ waku_lightpush/common,
+ waku_filter_v2,
+ waku_peer_exchange/protocol,
+ waku_core/peers,
+ waku_core/multiaddrstr,
+ ],
+ ./tester_config,
+ ./publisher,
+ ./receiver,
+ ./diagnose_connections,
+ ./service_peer_management
+
+logScope:
+ topics = "liteprotocoltester main"
+
+proc logConfig(conf: LiteProtocolTesterConf) =
+ info "Configuration: Lite protocol tester", conf = $conf
+
+{.pop.}
+when isMainModule:
+ ## Node setup happens in 6 phases:
+ ## 1. Set up storage
+ ## 2. Initialize node
+ ## 3. Mount and initialize configured protocols
+ ## 4. Start node and mounted protocols
+ ## 5. Start monitoring tools and external interfaces
+ ## 6. Setup graceful shutdown hooks
+
+ const versionString = "version / git commit hash: " & waku_factory.git_version
+
+ let confRes = LiteProtocolTesterConf.load(version = versionString)
+ if confRes.isErr():
+ error "failure while loading the configuration", error = confRes.error
+ quit(QuitFailure)
+
+ var conf = confRes.get()
+
+ ## Logging setup
+ logging.setupLog(conf.logLevel, conf.logFormat)
+
+ info "Running Lite Protocol Tester node", version = waku_factory.git_version
+ logConfig(conf)
+
+ ##Prepare Waku configuration
+ ## - load from config file
+ ## - override according to tester functionality
+ ##
+
+ var wakuNodeConf: WakuNodeConf
+
+ if conf.configFile.isSome():
+ try:
+ var configFile {.threadvar.}: InputFile
+ configFile = conf.configFile.get()
+ wakuNodeConf = WakuNodeConf.load(
+ version = versionString,
+ printUsage = false,
+ secondarySources = proc(
+ wnconf: WakuNodeConf, sources: auto
+ ) {.gcsafe, raises: [ConfigurationError].} =
+ echo "Loading secondary configuration file into WakuNodeConf"
+ sources.addConfigFile(Toml, configFile),
+ )
+ except CatchableError:
+ error "Loading Waku configuration failed", error = getCurrentExceptionMsg()
+ quit(QuitFailure)
+
+ wakuNodeConf.logLevel = conf.logLevel
+ wakuNodeConf.logFormat = conf.logFormat
+ wakuNodeConf.nat = conf.nat
+ wakuNodeConf.maxConnections = 500
+ wakuNodeConf.restAddress = conf.restAddress
+ wakuNodeConf.restPort = conf.restPort
+ wakuNodeConf.restAllowOrigin = conf.restAllowOrigin
+
+ wakuNodeConf.dnsAddrsNameServers =
+ @[parseIpAddress("8.8.8.8"), parseIpAddress("1.1.1.1")]
+
+ wakuNodeConf.shards = @[conf.shard]
+ wakuNodeConf.contentTopics = conf.contentTopics
+ wakuNodeConf.clusterId = conf.clusterId
+ ## TODO: Depending on the tester needs we might extend here with shards, clusterId, etc...
+
+ wakuNodeConf.metricsServer = true
+ wakuNodeConf.metricsServerAddress = parseIpAddress("0.0.0.0")
+ wakuNodeConf.metricsServerPort = conf.metricsPort
+
+ # If bootstrap option is chosen we expect our clients will not mounted
+ # so we will mount PeerExchange manually to gather possible service peers,
+ # if got some we will mount the client protocols afterward.
+ wakuNodeConf.peerExchange = false
+ wakuNodeConf.relay = false
+ wakuNodeConf.filter = false
+ wakuNodeConf.lightpush = false
+ wakuNodeConf.store = false
+
+ wakuNodeConf.rest = false
+ wakuNodeConf.relayServiceRatio = "40:60"
+
+ let wakuConf = wakuNodeConf.toWakuConf().valueOr:
+ error "Issue converting toWakuConf", error = $error
+ quit(QuitFailure)
+
+ var waku = (waitFor Waku.new(wakuConf)).valueOr:
+ error "Waku initialization failed", error = error
+ quit(QuitFailure)
+
+ (waitFor startWaku(addr waku)).isOkOr:
+ error "Starting waku failed", error = error
+ quit(QuitFailure)
+
+ debug "Setting up shutdown hooks"
+
+ proc asyncStopper(waku: Waku) {.async: (raises: [Exception]).} =
+ await waku.stop()
+ quit(QuitSuccess)
+
+ # Handle Ctrl-C SIGINT
+ proc handleCtrlC() {.noconv.} =
+ when defined(windows):
+ # workaround for https://github.com/nim-lang/Nim/issues/4057
+ setupForeignThreadGc()
+ notice "Shutting down after receiving SIGINT"
+ asyncSpawn asyncStopper(waku)
+
+ setControlCHook(handleCtrlC)
+
+ # Handle SIGTERM
+ when defined(posix):
+ proc handleSigterm(signal: cint) {.noconv.} =
+ notice "Shutting down after receiving SIGTERM"
+ asyncSpawn asyncStopper(waku)
+
+ c_signal(ansi_c.SIGTERM, handleSigterm)
+
+ # Handle SIGSEGV
+ when defined(posix):
+ proc handleSigsegv(signal: cint) {.noconv.} =
+ # Require --debugger:native
+ fatal "Shutting down after receiving SIGSEGV", stacktrace = getBacktrace()
+
+ # Not available in -d:release mode
+ writeStackTrace()
+
+ waitFor waku.stop()
+ quit(QuitFailure)
+
+ c_signal(ansi_c.SIGSEGV, handleSigsegv)
+
+ info "Node setup complete"
+
+ var codec = WakuLightPushCodec
+ # mounting relevant client, for PX filter client must be mounted ahead
+ if conf.testFunc == TesterFunctionality.SENDER:
+ codec = WakuLightPushCodec
+ else:
+ codec = WakuFilterSubscribeCodec
+
+ var lookForServiceNode = false
+ var serviceNodePeerInfo: RemotePeerInfo
+ if conf.serviceNode.len == 0:
+ if conf.bootstrapNode.len > 0:
+ info "Bootstrapping with PeerExchange to gather random service node"
+ let futForServiceNode = pxLookupServiceNode(waku.node, conf)
+ if not (waitFor futForServiceNode.withTimeout(20.minutes)):
+ error "Service node not found in time via PX"
+ quit(QuitFailure)
+
+ if futForServiceNode.read().isErr():
+ error "Service node for test not found via PX"
+ quit(QuitFailure)
+
+ serviceNodePeerInfo = selectRandomServicePeer(
+ waku.node.peerManager, none(RemotePeerInfo), codec
+ ).valueOr:
+ error "Service node selection failed"
+ quit(QuitFailure)
+ else:
+ error "No service or bootstrap node provided"
+ quit(QuitFailure)
+ else:
+ # support for both ENR and URI formatted service node addresses
+ serviceNodePeerInfo = translateToRemotePeerInfo(conf.serviceNode).valueOr:
+ error "failed to parse service-node", node = conf.serviceNode
+ quit(QuitFailure)
+
+ info "Service node to be used", serviceNode = $serviceNodePeerInfo
+
+ logSelfPeers(waku.node.peerManager)
+
+ if conf.testFunc == TesterFunctionality.SENDER:
+ setupAndPublish(waku.node, conf, serviceNodePeerInfo)
+ else:
+ setupAndListen(waku.node, conf, serviceNodePeerInfo)
+
+ runForever()
diff --git a/third-party/nwaku/apps/liteprotocoltester/lpt_metrics.nim b/third-party/nwaku/apps/liteprotocoltester/lpt_metrics.nim
new file mode 100644
index 0000000..8b30619
--- /dev/null
+++ b/third-party/nwaku/apps/liteprotocoltester/lpt_metrics.nim
@@ -0,0 +1,56 @@
+## Example showing how a resource restricted client may
+## subscribe to messages without relay
+
+import metrics
+
+export metrics
+
+declarePublicGauge lpt_receiver_sender_peer_count, "count of sender peers"
+
+declarePublicCounter lpt_receiver_received_messages_count,
+ "number of messages received per peer", ["peer"]
+
+declarePublicCounter lpt_receiver_received_bytes,
+ "number of received bytes per peer", ["peer"]
+
+declarePublicGauge lpt_receiver_missing_messages_count,
+ "number of missing messages per peer", ["peer"]
+
+declarePublicCounter lpt_receiver_duplicate_messages_count,
+ "number of duplicate messages per peer", ["peer"]
+
+declarePublicGauge lpt_receiver_distinct_duplicate_messages_count,
+ "number of distinct duplicate messages per peer", ["peer"]
+
+declarePublicGauge lpt_receiver_latencies,
+ "Message delivery latency per peer (min-avg-max)", ["peer", "latency"]
+
+declarePublicCounter lpt_receiver_lost_subscription_count,
+ "number of filter service peer failed PING requests - lost subscription"
+
+declarePublicCounter lpt_publisher_sent_messages_count, "number of messages published"
+
+declarePublicCounter lpt_publisher_failed_messages_count,
+ "number of messages failed to publish per failure cause", ["cause"]
+
+declarePublicCounter lpt_publisher_sent_bytes, "number of total bytes sent"
+
+declarePublicCounter lpt_service_peer_failure_count,
+ "number of failure during using service peer [publisher/receiever]", ["role", "agent"]
+
+declarePublicCounter lpt_change_service_peer_count,
+ "number of times [publisher/receiver] had to change service peer", ["role"]
+
+declarePublicGauge lpt_px_peers,
+ "Number of peers PeerExchange discovered and can be dialed"
+
+declarePublicGauge lpt_dialed_peers, "Number of peers successfully dialed", ["agent"]
+
+declarePublicGauge lpt_dial_failures, "Number of dial failures by cause", ["agent"]
+
+declarePublicHistogram lpt_publish_duration_seconds,
+ "duration to lightpush messages",
+ buckets = [
+ 0.005, 0.01, 0.025, 0.05, 0.075, 0.1, 0.25, 0.5, 0.75, 1.0, 2.5, 5.0, 7.5, 10.0,
+ 15.0, 20.0, 30.0, Inf,
+ ]
diff --git a/third-party/nwaku/apps/liteprotocoltester/lpt_supervisor.py b/third-party/nwaku/apps/liteprotocoltester/lpt_supervisor.py
new file mode 100755
index 0000000..7d882af
--- /dev/null
+++ b/third-party/nwaku/apps/liteprotocoltester/lpt_supervisor.py
@@ -0,0 +1,54 @@
+#!/usr/bin/env python3
+
+import os
+import time
+from subprocess import Popen
+import sys
+
+def load_env(file_path):
+ predefined_test_env = {}
+ with open(file_path) as f:
+ for line in f:
+ if line.strip() and not line.startswith('#'):
+ key, value = line.strip().split('=', 1)
+ predefined_test_env[key] = value
+ return predefined_test_env
+
+def run_tester_node(predefined_test_env):
+ role = sys.argv[1]
+ # override incoming environment variables with the ones from the file to prefer predefined testing environment.
+ for key, value in predefined_test_env.items():
+ os.environ[key] = value
+
+ script_cmd = "/usr/bin/run_tester_node_at_infra.sh /usr/bin/liteprotocoltester {role}".format(role=role)
+ return os.system(script_cmd)
+
+if __name__ == "__main__":
+ if len(sys.argv) < 2 or sys.argv[1] not in ["RECEIVER", "SENDER", "SENDERV3"]:
+ print("Error: First argument must be either 'RECEIVER' or 'SENDER' or 'SENDERV3'")
+ sys.exit(1)
+
+ predefined_test_env_file = '/usr/bin/infra.env'
+ predefined_test_env = load_env(predefined_test_env_file)
+
+ test_interval_minutes = int(predefined_test_env.get('TEST_INTERVAL_MINUTES', 60)) # Default to 60 minutes if not set
+ print(f"supervisor: Start testing loop. Interval is {test_interval_minutes} minutes")
+ counter = 0
+
+ while True:
+ counter += 1
+ start_time = time.time()
+ print(f"supervisor: Run #{counter} started at {time.strftime('%Y-%m-%d %H:%M:%S', time.localtime(start_time))}")
+ print(f"supervisor: with arguments: {predefined_test_env}")
+
+ exit_code = run_tester_node(predefined_test_env)
+
+ end_time = time.time()
+ run_time = end_time - start_time
+ sleep_time = max(5 * 60, (test_interval_minutes * 60) - run_time)
+
+ print(f"supervisor: Tester node finished at {time.strftime('%Y-%m-%d %H:%M:%S', time.localtime(end_time))}")
+ print(f"supervisor: Runtime was {run_time:.2f} seconds")
+ print(f"supervisor: Next run scheduled in {sleep_time // 60:.2f} minutes")
+
+ time.sleep(sleep_time)
diff --git a/third-party/nwaku/apps/liteprotocoltester/monitoring/configuration/customizations/custom-logo.png b/third-party/nwaku/apps/liteprotocoltester/monitoring/configuration/customizations/custom-logo.png
new file mode 100644
index 0000000..dcf13b9
Binary files /dev/null and b/third-party/nwaku/apps/liteprotocoltester/monitoring/configuration/customizations/custom-logo.png differ
diff --git a/third-party/nwaku/apps/liteprotocoltester/monitoring/configuration/customizations/custom-logo.svg b/third-party/nwaku/apps/liteprotocoltester/monitoring/configuration/customizations/custom-logo.svg
new file mode 100644
index 0000000..3c9a6da
--- /dev/null
+++ b/third-party/nwaku/apps/liteprotocoltester/monitoring/configuration/customizations/custom-logo.svg
@@ -0,0 +1,3 @@
+
diff --git a/third-party/nwaku/apps/liteprotocoltester/monitoring/configuration/dashboards.yaml b/third-party/nwaku/apps/liteprotocoltester/monitoring/configuration/dashboards.yaml
new file mode 100644
index 0000000..e59ac96
--- /dev/null
+++ b/third-party/nwaku/apps/liteprotocoltester/monitoring/configuration/dashboards.yaml
@@ -0,0 +1,9 @@
+apiVersion: 1
+
+providers:
+- name: 'Prometheus'
+ orgId: 1
+ folder: ''
+ type: file
+ options:
+ path: /var/lib/grafana/dashboards
\ No newline at end of file
diff --git a/third-party/nwaku/apps/liteprotocoltester/monitoring/configuration/dashboards/liter-protocol-test-monitoring.json b/third-party/nwaku/apps/liteprotocoltester/monitoring/configuration/dashboards/liter-protocol-test-monitoring.json
new file mode 100644
index 0000000..22770e2
--- /dev/null
+++ b/third-party/nwaku/apps/liteprotocoltester/monitoring/configuration/dashboards/liter-protocol-test-monitoring.json
@@ -0,0 +1,1949 @@
+{
+ "annotations": {
+ "list": [
+ {
+ "builtIn": 1,
+ "datasource": {
+ "type": "grafana",
+ "uid": "-- Grafana --"
+ },
+ "enable": true,
+ "hide": true,
+ "iconColor": "rgba(0, 211, 255, 1)",
+ "name": "Annotations & Alerts",
+ "type": "dashboard"
+ }
+ ]
+ },
+ "description": "Monitoring of lite-protocol-tester's send/receiver performance and failure counters.",
+ "editable": true,
+ "fiscalYearStartMonth": 0,
+ "graphTooltip": 0,
+ "links": [],
+ "panels": [
+ {
+ "gridPos": {
+ "h": 1,
+ "w": 24,
+ "x": 0,
+ "y": 0
+ },
+ "id": 13,
+ "panels": [],
+ "title": "Peer statistics",
+ "type": "row"
+ },
+ {
+ "datasource": {
+ "default": true,
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "fieldConfig": {
+ "defaults": {
+ "color": {
+ "mode": "continuous-GrYlRd"
+ },
+ "fieldMinMax": false,
+ "mappings": [],
+ "max": 100,
+ "min": 0,
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "green",
+ "value": null
+ },
+ {
+ "color": "red",
+ "value": 80
+ }
+ ]
+ },
+ "unit": "none"
+ },
+ "overrides": []
+ },
+ "gridPos": {
+ "h": 15,
+ "w": 5,
+ "x": 0,
+ "y": 1
+ },
+ "id": 15,
+ "options": {
+ "displayMode": "lcd",
+ "maxVizHeight": 300,
+ "minVizHeight": 16,
+ "minVizWidth": 8,
+ "namePlacement": "auto",
+ "orientation": "horizontal",
+ "reduceOptions": {
+ "calcs": [
+ "lastNotNull"
+ ],
+ "fields": "",
+ "values": false
+ },
+ "showUnfilled": true,
+ "sizing": "auto",
+ "valueMode": "color"
+ },
+ "pluginVersion": "11.2.0",
+ "targets": [
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "disableTextWrap": false,
+ "editorMode": "code",
+ "expr": "lpt_px_peers{instance=~\".*publisher.*\"}",
+ "fullMetaSearch": false,
+ "includeNullMetadata": true,
+ "instant": false,
+ "legendFormat": "{{instance}}",
+ "range": true,
+ "refId": "A",
+ "useBackend": false
+ }
+ ],
+ "title": "Lightpush capable peers found via PX",
+ "type": "bargauge"
+ },
+ {
+ "datasource": {
+ "default": true,
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "fieldConfig": {
+ "defaults": {
+ "color": {
+ "mode": "palette-classic"
+ },
+ "custom": {
+ "axisBorderShow": false,
+ "axisCenteredZero": false,
+ "axisColorMode": "text",
+ "axisLabel": "",
+ "axisPlacement": "auto",
+ "barAlignment": 0,
+ "barWidthFactor": 0.6,
+ "drawStyle": "line",
+ "fillOpacity": 0,
+ "gradientMode": "none",
+ "hideFrom": {
+ "legend": false,
+ "tooltip": false,
+ "viz": false
+ },
+ "insertNulls": false,
+ "lineInterpolation": "linear",
+ "lineWidth": 1,
+ "pointSize": 5,
+ "scaleDistribution": {
+ "type": "linear"
+ },
+ "showPoints": "auto",
+ "spanNulls": false,
+ "stacking": {
+ "group": "A",
+ "mode": "none"
+ },
+ "thresholdsStyle": {
+ "mode": "off"
+ }
+ },
+ "mappings": [],
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "green",
+ "value": null
+ },
+ {
+ "color": "red",
+ "value": 80
+ }
+ ]
+ },
+ "unit": "none"
+ },
+ "overrides": []
+ },
+ "gridPos": {
+ "h": 15,
+ "w": 7,
+ "x": 5,
+ "y": 1
+ },
+ "id": 22,
+ "options": {
+ "legend": {
+ "calcs": [
+ "lastNotNull"
+ ],
+ "displayMode": "table",
+ "placement": "bottom",
+ "showLegend": true
+ },
+ "tooltip": {
+ "mode": "single",
+ "sort": "none"
+ }
+ },
+ "pluginVersion": "11.2.0",
+ "targets": [
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "disableTextWrap": false,
+ "editorMode": "code",
+ "expr": "lpt_dialed_peers{instance=~\".*publisher.*\"}",
+ "fullMetaSearch": false,
+ "hide": false,
+ "includeNullMetadata": true,
+ "instant": false,
+ "legendFormat": "Working filter peers {{instance}}",
+ "range": true,
+ "refId": "B",
+ "useBackend": false
+ },
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "disableTextWrap": false,
+ "editorMode": "code",
+ "expr": "lpt_dial_failures{instance=~\".*publisher.*\"}",
+ "fullMetaSearch": false,
+ "hide": false,
+ "includeNullMetadata": true,
+ "instant": false,
+ "legendFormat": "Failed to dial {{instance}}",
+ "range": true,
+ "refId": "C",
+ "useBackend": false
+ }
+ ],
+ "title": "Tested lightpush peers",
+ "type": "timeseries"
+ },
+ {
+ "datasource": {
+ "default": true,
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "fieldConfig": {
+ "defaults": {
+ "color": {
+ "mode": "continuous-GrYlRd"
+ },
+ "fieldMinMax": false,
+ "mappings": [],
+ "max": 100,
+ "min": 0,
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "green",
+ "value": null
+ },
+ {
+ "color": "red",
+ "value": 80
+ }
+ ]
+ },
+ "unit": "none"
+ },
+ "overrides": []
+ },
+ "gridPos": {
+ "h": 15,
+ "w": 5,
+ "x": 12,
+ "y": 1
+ },
+ "id": 21,
+ "options": {
+ "displayMode": "lcd",
+ "maxVizHeight": 300,
+ "minVizHeight": 16,
+ "minVizWidth": 8,
+ "namePlacement": "auto",
+ "orientation": "horizontal",
+ "reduceOptions": {
+ "calcs": [
+ "lastNotNull"
+ ],
+ "fields": "",
+ "values": false
+ },
+ "showUnfilled": true,
+ "sizing": "auto",
+ "valueMode": "color"
+ },
+ "pluginVersion": "11.2.0",
+ "targets": [
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "disableTextWrap": false,
+ "editorMode": "code",
+ "expr": "lpt_px_peers{instance=~\".*receiver.*\"}",
+ "fullMetaSearch": false,
+ "includeNullMetadata": true,
+ "instant": false,
+ "legendFormat": "{{instance}}",
+ "range": true,
+ "refId": "A",
+ "useBackend": false
+ }
+ ],
+ "title": "Filter capable peers found via PX",
+ "type": "bargauge"
+ },
+ {
+ "datasource": {
+ "default": true,
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "fieldConfig": {
+ "defaults": {
+ "color": {
+ "mode": "palette-classic"
+ },
+ "custom": {
+ "axisBorderShow": false,
+ "axisCenteredZero": false,
+ "axisColorMode": "text",
+ "axisLabel": "",
+ "axisPlacement": "auto",
+ "barAlignment": 0,
+ "barWidthFactor": 0.6,
+ "drawStyle": "line",
+ "fillOpacity": 0,
+ "gradientMode": "none",
+ "hideFrom": {
+ "legend": false,
+ "tooltip": false,
+ "viz": false
+ },
+ "insertNulls": false,
+ "lineInterpolation": "linear",
+ "lineWidth": 1,
+ "pointSize": 5,
+ "scaleDistribution": {
+ "type": "linear"
+ },
+ "showPoints": "auto",
+ "spanNulls": false,
+ "stacking": {
+ "group": "A",
+ "mode": "none"
+ },
+ "thresholdsStyle": {
+ "mode": "off"
+ }
+ },
+ "mappings": [],
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "green",
+ "value": null
+ },
+ {
+ "color": "red",
+ "value": 80
+ }
+ ]
+ },
+ "unit": "none"
+ },
+ "overrides": []
+ },
+ "gridPos": {
+ "h": 15,
+ "w": 7,
+ "x": 17,
+ "y": 1
+ },
+ "id": 14,
+ "options": {
+ "legend": {
+ "calcs": [
+ "lastNotNull"
+ ],
+ "displayMode": "table",
+ "placement": "bottom",
+ "showLegend": true
+ },
+ "tooltip": {
+ "mode": "single",
+ "sort": "none"
+ }
+ },
+ "pluginVersion": "11.2.0",
+ "targets": [
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "disableTextWrap": false,
+ "editorMode": "code",
+ "expr": "lpt_dialed_peers{instance=~\".*receivernode.*\"}",
+ "fullMetaSearch": false,
+ "hide": false,
+ "includeNullMetadata": true,
+ "instant": false,
+ "legendFormat": "Working filter peers {{instance}}",
+ "range": true,
+ "refId": "B",
+ "useBackend": false
+ },
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "disableTextWrap": false,
+ "editorMode": "code",
+ "expr": "lpt_dial_failures{instance=~\".*receivernode.*\"}",
+ "fullMetaSearch": false,
+ "hide": false,
+ "includeNullMetadata": true,
+ "instant": false,
+ "legendFormat": "Failed to dial {{instance}}",
+ "range": true,
+ "refId": "C",
+ "useBackend": false
+ }
+ ],
+ "title": "Tested filter peers",
+ "type": "timeseries"
+ },
+ {
+ "gridPos": {
+ "h": 1,
+ "w": 24,
+ "x": 0,
+ "y": 16
+ },
+ "id": 12,
+ "title": "Test publisher monitor",
+ "type": "row"
+ },
+ {
+ "datasource": {
+ "default": true,
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "fieldConfig": {
+ "defaults": {
+ "color": {
+ "mode": "palette-classic"
+ },
+ "custom": {
+ "axisBorderShow": false,
+ "axisCenteredZero": false,
+ "axisColorMode": "text",
+ "axisLabel": "",
+ "axisPlacement": "auto",
+ "barAlignment": 0,
+ "barWidthFactor": 0.6,
+ "drawStyle": "line",
+ "fillOpacity": 23,
+ "gradientMode": "hue",
+ "hideFrom": {
+ "legend": false,
+ "tooltip": false,
+ "viz": false
+ },
+ "insertNulls": false,
+ "lineInterpolation": "linear",
+ "lineWidth": 1,
+ "pointSize": 5,
+ "scaleDistribution": {
+ "type": "linear"
+ },
+ "showPoints": "auto",
+ "spanNulls": false,
+ "stacking": {
+ "group": "A",
+ "mode": "normal"
+ },
+ "thresholdsStyle": {
+ "mode": "off"
+ }
+ },
+ "mappings": [],
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "green",
+ "value": null
+ },
+ {
+ "color": "red",
+ "value": 80
+ }
+ ]
+ },
+ "unit": "none"
+ },
+ "overrides": []
+ },
+ "gridPos": {
+ "h": 8,
+ "w": 12,
+ "x": 0,
+ "y": 17
+ },
+ "id": 16,
+ "options": {
+ "legend": {
+ "calcs": [
+ "last"
+ ],
+ "displayMode": "table",
+ "placement": "bottom",
+ "showLegend": true
+ },
+ "tooltip": {
+ "mode": "single",
+ "sort": "none"
+ }
+ },
+ "targets": [
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "disableTextWrap": false,
+ "editorMode": "code",
+ "exemplar": false,
+ "expr": "sum by(instace) (lpt_service_peer_failure_count_total{instance=~\".*publishernode.*\", role=\"publisher\"})",
+ "format": "time_series",
+ "fullMetaSearch": false,
+ "includeNullMetadata": true,
+ "instant": false,
+ "legendFormat": "Push failed",
+ "range": true,
+ "refId": "A",
+ "useBackend": false
+ },
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "editorMode": "code",
+ "expr": "sum by(instace) (lpt_change_service_peer_count_total{instance=~\".*publishernode.*\", role=\"publisher\"})",
+ "hide": false,
+ "instant": false,
+ "legendFormat": "Peer switch",
+ "range": true,
+ "refId": "B"
+ }
+ ],
+ "title": "Lightpush service peer failures and switches",
+ "type": "timeseries"
+ },
+ {
+ "datasource": {
+ "default": true,
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "fieldConfig": {
+ "defaults": {
+ "color": {
+ "mode": "palette-classic"
+ },
+ "custom": {
+ "axisBorderShow": false,
+ "axisCenteredZero": false,
+ "axisColorMode": "text",
+ "axisLabel": "",
+ "axisPlacement": "auto",
+ "barAlignment": 0,
+ "barWidthFactor": 0.6,
+ "drawStyle": "line",
+ "fillOpacity": 23,
+ "gradientMode": "hue",
+ "hideFrom": {
+ "legend": false,
+ "tooltip": false,
+ "viz": false
+ },
+ "insertNulls": false,
+ "lineInterpolation": "linear",
+ "lineWidth": 1,
+ "pointSize": 5,
+ "scaleDistribution": {
+ "type": "linear"
+ },
+ "showPoints": "auto",
+ "spanNulls": false,
+ "stacking": {
+ "group": "A",
+ "mode": "normal"
+ },
+ "thresholdsStyle": {
+ "mode": "off"
+ }
+ },
+ "mappings": [],
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "green",
+ "value": null
+ },
+ {
+ "color": "red",
+ "value": 80
+ }
+ ]
+ },
+ "unit": "none"
+ },
+ "overrides": []
+ },
+ "gridPos": {
+ "h": 8,
+ "w": 12,
+ "x": 12,
+ "y": 17
+ },
+ "id": 17,
+ "options": {
+ "legend": {
+ "calcs": [
+ "last"
+ ],
+ "displayMode": "table",
+ "placement": "bottom",
+ "showLegend": true
+ },
+ "tooltip": {
+ "mode": "single",
+ "sort": "none"
+ }
+ },
+ "targets": [
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "disableTextWrap": false,
+ "editorMode": "code",
+ "exemplar": false,
+ "expr": "sum by(instace) (lpt_service_peer_failure_count_total{instance=~\".*receivernode.*\", role=\"receiver\"})",
+ "format": "time_series",
+ "fullMetaSearch": false,
+ "includeNullMetadata": true,
+ "instant": false,
+ "legendFormat": "Subscribe failed",
+ "range": true,
+ "refId": "A",
+ "useBackend": false
+ },
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "editorMode": "code",
+ "expr": "sum by(instace) (lpt_change_service_peer_count_total{instance=~\".*receivernode.*\", role=\"receiver\"})",
+ "hide": false,
+ "instant": false,
+ "legendFormat": "Peer switch",
+ "range": true,
+ "refId": "B"
+ },
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "editorMode": "code",
+ "expr": "sum by(instace) (lpt_receiver_lost_subscription_count_total{instance=~\".*receivernode.*\"})",
+ "hide": false,
+ "instant": false,
+ "legendFormat": "Subscription loss - ping fail",
+ "range": true,
+ "refId": "C"
+ }
+ ],
+ "title": "Filter service peer failures and switches",
+ "type": "timeseries"
+ },
+ {
+ "datasource": {
+ "default": true,
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "fieldConfig": {
+ "defaults": {
+ "mappings": [],
+ "thresholds": {
+ "mode": "percentage",
+ "steps": [
+ {
+ "color": "green",
+ "value": null
+ },
+ {
+ "color": "orange",
+ "value": 70
+ },
+ {
+ "color": "red",
+ "value": 85
+ }
+ ]
+ }
+ },
+ "overrides": []
+ },
+ "gridPos": {
+ "h": 12,
+ "w": 12,
+ "x": 0,
+ "y": 25
+ },
+ "id": 18,
+ "options": {
+ "minVizHeight": 75,
+ "minVizWidth": 75,
+ "orientation": "auto",
+ "reduceOptions": {
+ "calcs": [
+ "lastNotNull"
+ ],
+ "fields": "",
+ "values": false
+ },
+ "showThresholdLabels": false,
+ "showThresholdMarkers": false,
+ "sizing": "auto"
+ },
+ "pluginVersion": "11.2.0",
+ "targets": [
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "disableTextWrap": false,
+ "editorMode": "code",
+ "expr": "count(\n group(\n last_over_time(lpt_px_peers{instance=~\".*publishernode.*\"}[24h])\n ) by (instance)\n)",
+ "fullMetaSearch": false,
+ "includeNullMetadata": true,
+ "instant": false,
+ "legendFormat": "Number or publishers",
+ "range": true,
+ "refId": "A",
+ "useBackend": false
+ },
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "disableTextWrap": false,
+ "editorMode": "code",
+ "expr": "count(\n group(\n last_over_time(lpt_px_peers{instance=~\".*receivernode.*\"}[24h])\n ) by (instance)\n)",
+ "fullMetaSearch": false,
+ "hide": false,
+ "includeNullMetadata": true,
+ "instant": false,
+ "legendFormat": "Number or receivers",
+ "range": true,
+ "refId": "B",
+ "useBackend": false
+ }
+ ],
+ "title": "Number of tester nodes",
+ "type": "gauge"
+ },
+ {
+ "datasource": {
+ "default": true,
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "fieldConfig": {
+ "defaults": {
+ "color": {
+ "mode": "thresholds"
+ },
+ "mappings": [],
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "green",
+ "value": null
+ },
+ {
+ "color": "red",
+ "value": 80
+ }
+ ]
+ },
+ "unit": "none"
+ },
+ "overrides": []
+ },
+ "gridPos": {
+ "h": 12,
+ "w": 12,
+ "x": 12,
+ "y": 25
+ },
+ "id": 8,
+ "options": {
+ "displayMode": "lcd",
+ "maxVizHeight": 300,
+ "minVizHeight": 16,
+ "minVizWidth": 8,
+ "namePlacement": "top",
+ "orientation": "horizontal",
+ "reduceOptions": {
+ "calcs": [
+ "last"
+ ],
+ "fields": "",
+ "values": false
+ },
+ "showUnfilled": true,
+ "sizing": "auto",
+ "valueMode": "color"
+ },
+ "pluginVersion": "11.2.0",
+ "targets": [
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "disableTextWrap": false,
+ "editorMode": "code",
+ "expr": "lpt_receiver_sender_peer_count{instance=~\".*receivernode.*\"}",
+ "fullMetaSearch": false,
+ "includeNullMetadata": true,
+ "instant": false,
+ "legendFormat": "{{instance}}",
+ "range": true,
+ "refId": "A",
+ "useBackend": false
+ }
+ ],
+ "title": "Receiver detected message from number of publisher peers",
+ "type": "bargauge"
+ },
+ {
+ "collapsed": true,
+ "gridPos": {
+ "h": 1,
+ "w": 24,
+ "x": 0,
+ "y": 37
+ },
+ "id": 11,
+ "panels": [],
+ "title": "Test performance",
+ "type": "row"
+ },
+ {
+ "datasource": {
+ "default": true,
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "fieldConfig": {
+ "defaults": {
+ "color": {
+ "mode": "palette-classic"
+ },
+ "custom": {
+ "axisBorderShow": false,
+ "axisCenteredZero": false,
+ "axisColorMode": "text",
+ "axisLabel": "",
+ "axisPlacement": "auto",
+ "barAlignment": 0,
+ "barWidthFactor": 0.6,
+ "drawStyle": "line",
+ "fillOpacity": 0,
+ "gradientMode": "none",
+ "hideFrom": {
+ "legend": false,
+ "tooltip": false,
+ "viz": false
+ },
+ "insertNulls": false,
+ "lineInterpolation": "linear",
+ "lineWidth": 1,
+ "pointSize": 5,
+ "scaleDistribution": {
+ "type": "linear"
+ },
+ "showPoints": "auto",
+ "spanNulls": false,
+ "stacking": {
+ "group": "A",
+ "mode": "normal"
+ },
+ "thresholdsStyle": {
+ "mode": "off"
+ }
+ },
+ "mappings": [],
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "green",
+ "value": null
+ },
+ {
+ "color": "red",
+ "value": 80
+ }
+ ]
+ },
+ "unit": "none"
+ },
+ "overrides": [
+ {
+ "matcher": {
+ "id": "byName",
+ "options": "Publishing rate"
+ },
+ "properties": [
+ {
+ "id": "custom.axisPlacement",
+ "value": "right"
+ },
+ {
+ "id": "custom.gradientMode",
+ "value": "hue"
+ },
+ {
+ "id": "custom.fillOpacity",
+ "value": 15
+ },
+ {
+ "id": "custom.stacking",
+ "value": {
+ "group": "A",
+ "mode": "normal"
+ }
+ },
+ {
+ "id": "unit",
+ "value": "reqps"
+ }
+ ]
+ }
+ ]
+ },
+ "gridPos": {
+ "h": 8,
+ "w": 12,
+ "x": 0,
+ "y": 38
+ },
+ "id": 1,
+ "options": {
+ "legend": {
+ "calcs": [
+ "last"
+ ],
+ "displayMode": "table",
+ "placement": "bottom",
+ "showLegend": true
+ },
+ "tooltip": {
+ "mode": "single",
+ "sort": "none"
+ }
+ },
+ "targets": [
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "disableTextWrap": false,
+ "editorMode": "code",
+ "exemplar": false,
+ "expr": "sum by(instace) (lpt_publisher_sent_messages_count_total{instance=~\".*publishernode.*\"})",
+ "format": "time_series",
+ "fullMetaSearch": false,
+ "includeNullMetadata": true,
+ "instant": false,
+ "legendFormat": "Total published count",
+ "range": true,
+ "refId": "A",
+ "useBackend": false
+ },
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "disableTextWrap": false,
+ "editorMode": "code",
+ "exemplar": false,
+ "expr": "sum by(instance) (rate(lpt_publisher_sent_messages_count_total{instance=~\".*publishernode.*\"}[$__rate_interval]))",
+ "format": "time_series",
+ "fullMetaSearch": false,
+ "hide": false,
+ "includeNullMetadata": true,
+ "instant": false,
+ "legendFormat": "Publishing rate",
+ "range": true,
+ "refId": "B",
+ "useBackend": false
+ }
+ ],
+ "title": "Published test messages",
+ "type": "timeseries"
+ },
+ {
+ "datasource": {
+ "default": true,
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "fieldConfig": {
+ "defaults": {
+ "color": {
+ "mode": "palette-classic"
+ },
+ "custom": {
+ "axisBorderShow": false,
+ "axisCenteredZero": false,
+ "axisColorMode": "series",
+ "axisLabel": "",
+ "axisPlacement": "auto",
+ "barAlignment": 0,
+ "barWidthFactor": 0.6,
+ "drawStyle": "line",
+ "fillOpacity": 0,
+ "gradientMode": "none",
+ "hideFrom": {
+ "legend": false,
+ "tooltip": false,
+ "viz": false
+ },
+ "insertNulls": false,
+ "lineInterpolation": "linear",
+ "lineWidth": 1,
+ "pointSize": 5,
+ "scaleDistribution": {
+ "type": "linear"
+ },
+ "showPoints": "auto",
+ "spanNulls": false,
+ "stacking": {
+ "group": "A",
+ "mode": "none"
+ },
+ "thresholdsStyle": {
+ "mode": "off"
+ }
+ },
+ "mappings": [],
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "green",
+ "value": null
+ },
+ {
+ "color": "red",
+ "value": 80
+ }
+ ]
+ },
+ "unit": "none"
+ },
+ "overrides": [
+ {
+ "matcher": {
+ "id": "byName",
+ "options": "Received message rate"
+ },
+ "properties": [
+ {
+ "id": "custom.axisPlacement",
+ "value": "right"
+ },
+ {
+ "id": "custom.scaleDistribution",
+ "value": {
+ "type": "linear"
+ }
+ },
+ {
+ "id": "custom.fillOpacity",
+ "value": 9
+ },
+ {
+ "id": "custom.gradientMode",
+ "value": "hue"
+ },
+ {
+ "id": "unit",
+ "value": "reqps"
+ }
+ ]
+ }
+ ]
+ },
+ "gridPos": {
+ "h": 8,
+ "w": 12,
+ "x": 12,
+ "y": 38
+ },
+ "id": 2,
+ "options": {
+ "legend": {
+ "calcs": [
+ "max"
+ ],
+ "displayMode": "table",
+ "placement": "bottom",
+ "showLegend": true
+ },
+ "tooltip": {
+ "mode": "single",
+ "sort": "none"
+ }
+ },
+ "targets": [
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "disableTextWrap": false,
+ "editorMode": "code",
+ "expr": "sum by(instance) (lpt_receiver_received_messages_count_total{instance=~\".*receivernode.*\"})",
+ "fullMetaSearch": false,
+ "includeNullMetadata": true,
+ "instant": false,
+ "legendFormat": "Total message received",
+ "range": true,
+ "refId": "A",
+ "useBackend": false
+ },
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "disableTextWrap": false,
+ "editorMode": "code",
+ "expr": "sum by(instance) (rate(lpt_receiver_received_messages_count_total{instance=~\".*receivernode.*\"}[$__rate_interval]))",
+ "fullMetaSearch": false,
+ "hide": false,
+ "includeNullMetadata": true,
+ "instant": false,
+ "legendFormat": "Received message rate",
+ "range": true,
+ "refId": "B",
+ "useBackend": false
+ }
+ ],
+ "title": "Received test messages",
+ "type": "timeseries"
+ },
+ {
+ "datasource": {
+ "default": true,
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "description": "",
+ "fieldConfig": {
+ "defaults": {
+ "color": {
+ "mode": "palette-classic"
+ },
+ "custom": {
+ "axisBorderShow": false,
+ "axisCenteredZero": false,
+ "axisColorMode": "series",
+ "axisLabel": "",
+ "axisPlacement": "left",
+ "barAlignment": 0,
+ "barWidthFactor": 0.6,
+ "drawStyle": "line",
+ "fillOpacity": 0,
+ "gradientMode": "none",
+ "hideFrom": {
+ "legend": false,
+ "tooltip": false,
+ "viz": false
+ },
+ "insertNulls": false,
+ "lineInterpolation": "linear",
+ "lineWidth": 1,
+ "pointSize": 5,
+ "scaleDistribution": {
+ "type": "linear"
+ },
+ "showPoints": "auto",
+ "spanNulls": false,
+ "stacking": {
+ "group": "A",
+ "mode": "none"
+ },
+ "thresholdsStyle": {
+ "mode": "off"
+ }
+ },
+ "mappings": [],
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "green",
+ "value": null
+ },
+ {
+ "color": "red",
+ "value": 80
+ }
+ ]
+ },
+ "unit": "kbytes"
+ },
+ "overrides": [
+ {
+ "matcher": {
+ "id": "byName",
+ "options": "Send message transfer rate"
+ },
+ "properties": [
+ {
+ "id": "custom.axisPlacement",
+ "value": "right"
+ },
+ {
+ "id": "custom.drawStyle",
+ "value": "line"
+ },
+ {
+ "id": "custom.fillOpacity",
+ "value": 22
+ },
+ {
+ "id": "custom.scaleDistribution",
+ "value": {
+ "type": "linear"
+ }
+ },
+ {
+ "id": "custom.stacking",
+ "value": {
+ "group": "A",
+ "mode": "normal"
+ }
+ },
+ {
+ "id": "unit",
+ "value": "KiBs"
+ }
+ ]
+ }
+ ]
+ },
+ "gridPos": {
+ "h": 8,
+ "w": 12,
+ "x": 0,
+ "y": 46
+ },
+ "id": 5,
+ "options": {
+ "legend": {
+ "calcs": [
+ "last"
+ ],
+ "displayMode": "table",
+ "placement": "bottom",
+ "showLegend": true
+ },
+ "tooltip": {
+ "mode": "single",
+ "sort": "none"
+ }
+ },
+ "targets": [
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "disableTextWrap": false,
+ "editorMode": "code",
+ "exemplar": false,
+ "expr": "sum by(instance) (lpt_publisher_sent_bytes_total{instance=~\".*publishernode.*\"})",
+ "fullMetaSearch": false,
+ "includeNullMetadata": true,
+ "instant": false,
+ "legendFormat": "Total sent bytes",
+ "range": true,
+ "refId": "A",
+ "useBackend": false
+ },
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "disableTextWrap": false,
+ "editorMode": "code",
+ "exemplar": false,
+ "expr": "sum by(instance) (rate(lpt_publisher_sent_bytes_total{instance=~\".*publishernode.*\"}[$__rate_interval]))",
+ "format": "time_series",
+ "fullMetaSearch": false,
+ "hide": false,
+ "includeNullMetadata": true,
+ "instant": false,
+ "legendFormat": "Send message transfer rate",
+ "range": true,
+ "refId": "B",
+ "useBackend": false
+ }
+ ],
+ "title": "Sent bytes",
+ "type": "timeseries"
+ },
+ {
+ "datasource": {
+ "default": true,
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "description": "",
+ "fieldConfig": {
+ "defaults": {
+ "color": {
+ "mode": "palette-classic"
+ },
+ "custom": {
+ "axisBorderShow": false,
+ "axisCenteredZero": false,
+ "axisColorMode": "series",
+ "axisLabel": "",
+ "axisPlacement": "left",
+ "barAlignment": 0,
+ "barWidthFactor": 0.6,
+ "drawStyle": "line",
+ "fillOpacity": 0,
+ "gradientMode": "none",
+ "hideFrom": {
+ "legend": false,
+ "tooltip": false,
+ "viz": false
+ },
+ "insertNulls": false,
+ "lineInterpolation": "linear",
+ "lineWidth": 1,
+ "pointSize": 5,
+ "scaleDistribution": {
+ "type": "linear"
+ },
+ "showPoints": "auto",
+ "spanNulls": false,
+ "stacking": {
+ "group": "A",
+ "mode": "none"
+ },
+ "thresholdsStyle": {
+ "mode": "off"
+ }
+ },
+ "mappings": [],
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "green",
+ "value": null
+ },
+ {
+ "color": "red",
+ "value": 80
+ }
+ ]
+ },
+ "unit": "kbytes"
+ },
+ "overrides": [
+ {
+ "matcher": {
+ "id": "byName",
+ "options": "Test message transfer rate"
+ },
+ "properties": [
+ {
+ "id": "custom.axisPlacement",
+ "value": "right"
+ },
+ {
+ "id": "custom.drawStyle",
+ "value": "line"
+ },
+ {
+ "id": "custom.fillOpacity",
+ "value": 22
+ },
+ {
+ "id": "custom.scaleDistribution",
+ "value": {
+ "type": "linear"
+ }
+ },
+ {
+ "id": "custom.stacking",
+ "value": {
+ "group": "A",
+ "mode": "normal"
+ }
+ },
+ {
+ "id": "unit",
+ "value": "KiBs"
+ }
+ ]
+ }
+ ]
+ },
+ "gridPos": {
+ "h": 8,
+ "w": 12,
+ "x": 12,
+ "y": 46
+ },
+ "id": 4,
+ "options": {
+ "legend": {
+ "calcs": [
+ "last"
+ ],
+ "displayMode": "table",
+ "placement": "bottom",
+ "showLegend": true
+ },
+ "tooltip": {
+ "mode": "single",
+ "sort": "none"
+ }
+ },
+ "targets": [
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "disableTextWrap": false,
+ "editorMode": "code",
+ "exemplar": false,
+ "expr": "sum by(instance) (lpt_receiver_received_bytes_total{instance=~\".*receivernode.*\"})",
+ "fullMetaSearch": false,
+ "includeNullMetadata": true,
+ "instant": false,
+ "legendFormat": "Total received bytes",
+ "range": true,
+ "refId": "A",
+ "useBackend": false
+ },
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "disableTextWrap": false,
+ "editorMode": "code",
+ "exemplar": false,
+ "expr": "sum by(instance) (rate(lpt_receiver_received_bytes_total{instance=~\".*receivernode.*\"}[$__rate_interval]))",
+ "format": "time_series",
+ "fullMetaSearch": false,
+ "hide": false,
+ "includeNullMetadata": true,
+ "instant": false,
+ "legendFormat": "Test message transfer rate",
+ "range": true,
+ "refId": "B",
+ "useBackend": false
+ }
+ ],
+ "title": "Received bytes",
+ "type": "timeseries"
+ },
+ {
+ "collapsed": false,
+ "gridPos": {
+ "h": 1,
+ "w": 24,
+ "x": 0,
+ "y": 54
+ },
+ "id": 10,
+ "panels": [],
+ "title": "Failure statistics",
+ "type": "row"
+ },
+ {
+ "datasource": {
+ "default": true,
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "fieldConfig": {
+ "defaults": {
+ "color": {
+ "mode": "palette-classic"
+ },
+ "custom": {
+ "axisBorderShow": false,
+ "axisCenteredZero": false,
+ "axisColorMode": "text",
+ "axisLabel": "",
+ "axisPlacement": "auto",
+ "barAlignment": 0,
+ "barWidthFactor": 0.6,
+ "drawStyle": "line",
+ "fillOpacity": 23,
+ "gradientMode": "hue",
+ "hideFrom": {
+ "legend": false,
+ "tooltip": false,
+ "viz": false
+ },
+ "insertNulls": false,
+ "lineInterpolation": "linear",
+ "lineWidth": 1,
+ "pointSize": 5,
+ "scaleDistribution": {
+ "type": "linear"
+ },
+ "showPoints": "auto",
+ "spanNulls": false,
+ "stacking": {
+ "group": "A",
+ "mode": "normal"
+ },
+ "thresholdsStyle": {
+ "mode": "off"
+ }
+ },
+ "mappings": [],
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "green",
+ "value": null
+ },
+ {
+ "color": "red",
+ "value": 80
+ }
+ ]
+ },
+ "unit": "none"
+ },
+ "overrides": [
+ {
+ "matcher": {
+ "id": "byName",
+ "options": "Published message rate"
+ },
+ "properties": [
+ {
+ "id": "custom.axisPlacement",
+ "value": "right"
+ },
+ {
+ "id": "custom.gradientMode",
+ "value": "hue"
+ },
+ {
+ "id": "custom.fillOpacity",
+ "value": 15
+ }
+ ]
+ }
+ ]
+ },
+ "gridPos": {
+ "h": 8,
+ "w": 12,
+ "x": 0,
+ "y": 55
+ },
+ "id": 6,
+ "options": {
+ "legend": {
+ "calcs": [
+ "last"
+ ],
+ "displayMode": "table",
+ "placement": "bottom",
+ "showLegend": true
+ },
+ "tooltip": {
+ "mode": "single",
+ "sort": "none"
+ }
+ },
+ "targets": [
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "disableTextWrap": false,
+ "editorMode": "code",
+ "exemplar": false,
+ "expr": "lpt_publisher_failed_messages_count_total{instance=~\".*publishernode.*\"}",
+ "format": "time_series",
+ "fullMetaSearch": false,
+ "includeNullMetadata": true,
+ "instant": false,
+ "legendFormat": "{{instance}} - {{cause}}",
+ "range": true,
+ "refId": "A",
+ "useBackend": false
+ }
+ ],
+ "title": "Failed publish count per cause",
+ "type": "timeseries"
+ },
+ {
+ "datasource": {
+ "default": true,
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "description": "",
+ "fieldConfig": {
+ "defaults": {
+ "color": {
+ "mode": "palette-classic"
+ },
+ "custom": {
+ "axisBorderShow": false,
+ "axisCenteredZero": false,
+ "axisColorMode": "series",
+ "axisLabel": "",
+ "axisPlacement": "auto",
+ "barAlignment": 0,
+ "barWidthFactor": 0.6,
+ "drawStyle": "line",
+ "fillOpacity": 0,
+ "gradientMode": "none",
+ "hideFrom": {
+ "legend": false,
+ "tooltip": false,
+ "viz": false
+ },
+ "insertNulls": false,
+ "lineInterpolation": "linear",
+ "lineWidth": 1,
+ "pointSize": 5,
+ "scaleDistribution": {
+ "type": "linear"
+ },
+ "showPoints": "auto",
+ "spanNulls": false,
+ "stacking": {
+ "group": "A",
+ "mode": "none"
+ },
+ "thresholdsStyle": {
+ "mode": "off"
+ }
+ },
+ "mappings": [],
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "green",
+ "value": null
+ },
+ {
+ "color": "red",
+ "value": 80
+ }
+ ]
+ },
+ "unit": "none"
+ },
+ "overrides": []
+ },
+ "gridPos": {
+ "h": 8,
+ "w": 12,
+ "x": 12,
+ "y": 55
+ },
+ "id": 7,
+ "options": {
+ "legend": {
+ "calcs": [
+ "last"
+ ],
+ "displayMode": "table",
+ "placement": "bottom",
+ "showLegend": true
+ },
+ "tooltip": {
+ "mode": "single",
+ "sort": "none"
+ }
+ },
+ "targets": [
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "disableTextWrap": false,
+ "editorMode": "code",
+ "expr": "lpt_receiver_duplicate_messages_count_total{instance=~\".*receivernode.*\"}",
+ "fullMetaSearch": false,
+ "includeNullMetadata": true,
+ "instant": false,
+ "legendFormat": "Total duplicates at {{instance}}",
+ "range": true,
+ "refId": "A",
+ "useBackend": false
+ },
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "disableTextWrap": false,
+ "editorMode": "code",
+ "expr": "lpt_receiver_distinct_duplicate_messages_count{instance=~\".*receivernode.*\"}",
+ "fullMetaSearch": false,
+ "hide": false,
+ "includeNullMetadata": true,
+ "instant": false,
+ "legendFormat": "Distinct duplicates at {{instance}}",
+ "range": true,
+ "refId": "B",
+ "useBackend": false
+ }
+ ],
+ "title": "Received duplicated messages",
+ "type": "timeseries"
+ },
+ {
+ "datasource": {
+ "default": true,
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "description": "",
+ "fieldConfig": {
+ "defaults": {
+ "color": {
+ "mode": "palette-classic"
+ },
+ "custom": {
+ "axisBorderShow": false,
+ "axisCenteredZero": false,
+ "axisColorMode": "series",
+ "axisLabel": "",
+ "axisPlacement": "auto",
+ "barAlignment": 0,
+ "barWidthFactor": 0.6,
+ "drawStyle": "line",
+ "fillOpacity": 21,
+ "gradientMode": "none",
+ "hideFrom": {
+ "legend": false,
+ "tooltip": false,
+ "viz": false
+ },
+ "insertNulls": false,
+ "lineInterpolation": "linear",
+ "lineWidth": 1,
+ "pointSize": 5,
+ "scaleDistribution": {
+ "type": "linear"
+ },
+ "showPoints": "auto",
+ "spanNulls": false,
+ "stacking": {
+ "group": "A",
+ "mode": "normal"
+ },
+ "thresholdsStyle": {
+ "mode": "off"
+ }
+ },
+ "mappings": [],
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "green",
+ "value": null
+ },
+ {
+ "color": "red",
+ "value": 80
+ }
+ ]
+ },
+ "unit": "none"
+ },
+ "overrides": []
+ },
+ "gridPos": {
+ "h": 8,
+ "w": 12,
+ "x": 12,
+ "y": 63
+ },
+ "id": 9,
+ "options": {
+ "legend": {
+ "calcs": [
+ "lastNotNull"
+ ],
+ "displayMode": "table",
+ "placement": "bottom",
+ "showLegend": true
+ },
+ "tooltip": {
+ "mode": "single",
+ "sort": "none"
+ }
+ },
+ "targets": [
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "disableTextWrap": false,
+ "editorMode": "code",
+ "expr": "lpt_receiver_missing_messages_count{instance=~\".*receivernode.*\"}",
+ "format": "time_series",
+ "fullMetaSearch": false,
+ "hide": false,
+ "includeNullMetadata": true,
+ "instant": false,
+ "legendFormat": "Receiver {{instance}}:Publisher {{peer}}",
+ "range": true,
+ "refId": "B",
+ "useBackend": false
+ }
+ ],
+ "title": "Not arrived messages",
+ "type": "timeseries"
+ }
+ ],
+ "refresh": "",
+ "schemaVersion": 39,
+ "tags": [],
+ "templating": {
+ "list": [
+ {
+ "current": {
+ "selected": true,
+ "text": "lpt-runner-publishernode-1:8003",
+ "value": "lpt-runner-publishernode-1:8003"
+ },
+ "definition": "label_values({instance=~\".*publishernode.*\"},instance)",
+ "hide": 0,
+ "includeAll": false,
+ "multi": false,
+ "name": "publisher",
+ "options": [],
+ "query": {
+ "qryType": 1,
+ "query": "label_values({instance=~\".*publishernode.*\"},instance)",
+ "refId": "PrometheusVariableQueryEditor-VariableQuery"
+ },
+ "refresh": 1,
+ "regex": "",
+ "skipUrlSync": false,
+ "sort": 0,
+ "type": "query"
+ },
+ {
+ "current": {
+ "selected": true,
+ "text": "lpt-runner-receivernode-1:8003",
+ "value": "lpt-runner-receivernode-1:8003"
+ },
+ "definition": "label_values({instance=~\".*receivernode.*\"},instance)",
+ "hide": 0,
+ "includeAll": false,
+ "multi": false,
+ "name": "receiver",
+ "options": [],
+ "query": {
+ "qryType": 1,
+ "query": "label_values({instance=~\".*receivernode.*\"},instance)",
+ "refId": "PrometheusVariableQueryEditor-VariableQuery"
+ },
+ "refresh": 1,
+ "regex": "",
+ "skipUrlSync": false,
+ "sort": 0,
+ "type": "query"
+ }
+ ]
+ },
+ "time": {
+ "from": "2024-10-02T22:07:37.000Z",
+ "to": "2024-10-02T22:23:21.000Z"
+ },
+ "timepicker": {},
+ "timezone": "browser",
+ "title": "Liteprotocoltester monitoring",
+ "uid": "fdw6pgh9odszkd",
+ "version": 1,
+ "weekStart": ""
+}
diff --git a/third-party/nwaku/apps/liteprotocoltester/monitoring/configuration/datasources.yaml b/third-party/nwaku/apps/liteprotocoltester/monitoring/configuration/datasources.yaml
new file mode 100644
index 0000000..2cc211f
--- /dev/null
+++ b/third-party/nwaku/apps/liteprotocoltester/monitoring/configuration/datasources.yaml
@@ -0,0 +1,11 @@
+apiVersion: 1
+
+datasources:
+ - name: Prometheus
+ type: prometheus
+ access: proxy
+ org_id: 1
+ url: http://prometheus:9099
+ is_default: true
+ version: 1
+ editable: true
diff --git a/third-party/nwaku/apps/liteprotocoltester/monitoring/configuration/grafana-plugins.env b/third-party/nwaku/apps/liteprotocoltester/monitoring/configuration/grafana-plugins.env
new file mode 100644
index 0000000..2780809
--- /dev/null
+++ b/third-party/nwaku/apps/liteprotocoltester/monitoring/configuration/grafana-plugins.env
@@ -0,0 +1,2 @@
+#GF_INSTALL_PLUGINS=grafana-worldmap-panel,grafana-piechart-panel,digrich-bubblechart-panel,yesoreyeram-boomtheme-panel,briangann-gauge-panel,jdbranham-diagram-panel,agenty-flowcharting-panel,citilogics-geoloop-panel,savantly-heatmap-panel,mtanda-histogram-panel,pierosavi-imageit-panel,michaeldmoore-multistat-panel,zuburqan-parity-report-panel,natel-plotly-panel,bessler-pictureit-panel,grafana-polystat-panel,corpglory-progresslist-panel,snuids-radar-panel,fzakaria-simple-config.config.annotations-datasource,vonage-status-panel,snuids-trafficlights-panel,pr0ps-trackmap-panel,alexandra-trackmap-panel,btplc-trend-box-panel
+GF_INSTALL_PLUGINS=grafana-worldmap-panel,grafana-piechart-panel,yesoreyeram-boomtheme-panel,briangann-gauge-panel,pierosavi-imageit-panel,bessler-pictureit-panel,vonage-status-panel
diff --git a/third-party/nwaku/apps/liteprotocoltester/monitoring/configuration/grafana.ini b/third-party/nwaku/apps/liteprotocoltester/monitoring/configuration/grafana.ini
new file mode 100644
index 0000000..631fbb7
--- /dev/null
+++ b/third-party/nwaku/apps/liteprotocoltester/monitoring/configuration/grafana.ini
@@ -0,0 +1,53 @@
+instance_name = liteprotocoltester dashboard
+
+;[dashboards.json]
+;enabled = true
+;path = /home/git/grafana/grafana-dashboards/dashboards
+
+[server]
+http_port = 3033
+
+#################################### Auth ##########################
+[auth]
+disable_login_form = false
+
+#################################### Anonymous Auth ##########################
+[auth.anonymous]
+# enable anonymous access
+enabled = true
+
+# specify organization name that should be used for unauthenticated users
+;org_name = Public
+
+# specify role for unauthenticated users
+org_role = Admin
+; org_role = Viewer
+
+;[security]
+;admin_user = ocr
+;admin_password = ocr
+
+;[users]
+# disable user signup / registration
+;allow_sign_up = false
+
+# Set to true to automatically assign new users to the default organization (id 1)
+;auto_assign_org = true
+
+# Default role new users will be automatically assigned (if disabled above is set to true)
+;auto_assign_org_role = Viewer
+
+#################################### SMTP / Emailing ##########################
+;[smtp]
+;enabled = false
+;host = localhost:25
+;user =
+;password =
+;cert_file =
+;key_file =
+;skip_verify = false
+;from_address = admin@grafana.localhost
+
+;[emails]
+;welcome_email_on_sign_up = false
+
diff --git a/third-party/nwaku/apps/liteprotocoltester/monitoring/prometheus-config.yml b/third-party/nwaku/apps/liteprotocoltester/monitoring/prometheus-config.yml
new file mode 100644
index 0000000..d04eaf0
--- /dev/null
+++ b/third-party/nwaku/apps/liteprotocoltester/monitoring/prometheus-config.yml
@@ -0,0 +1,35 @@
+global:
+ scrape_interval: 15s
+ evaluation_interval: 15s
+ external_labels:
+ monitor: "Monitoring"
+
+scrape_configs:
+ - job_name: "liteprotocoltester"
+ static_configs:
+ - targets: ["liteprotocoltester-publishernode-1:8003",
+ "liteprotocoltester-publishernode-2:8003",
+ "liteprotocoltester-publishernode-3:8003",
+ "liteprotocoltester-publishernode-4:8003",
+ "liteprotocoltester-publishernode-5:8003",
+ "liteprotocoltester-publishernode-6:8003",
+ "liteprotocoltester-receivernode-1:8003",
+ "liteprotocoltester-receivernode-2:8003",
+ "liteprotocoltester-receivernode-3:8003",
+ "liteprotocoltester-receivernode-4:8003",
+ "liteprotocoltester-receivernode-5:8003",
+ "liteprotocoltester-receivernode-6:8003",
+ "publishernode:8003",
+ "publishernode-1:8003",
+ "publishernode-2:8003",
+ "publishernode-3:8003",
+ "publishernode-4:8003",
+ "publishernode-5:8003",
+ "publishernode-6:8003",
+ "receivernode:8003",
+ "receivernode-1:8003",
+ "receivernode-2:8003",
+ "receivernode-3:8003",
+ "receivernode-4:8003",
+ "receivernode-5:8003",
+ "receivernode-6:8003",]
diff --git a/third-party/nwaku/apps/liteprotocoltester/nim.cfg b/third-party/nwaku/apps/liteprotocoltester/nim.cfg
new file mode 100644
index 0000000..2231f2e
--- /dev/null
+++ b/third-party/nwaku/apps/liteprotocoltester/nim.cfg
@@ -0,0 +1,4 @@
+-d:chronicles_line_numbers
+-d:chronicles_runtime_filtering:on
+-d:discv5_protocol_id:d5waku
+path = "../.."
diff --git a/third-party/nwaku/apps/liteprotocoltester/publisher.nim b/third-party/nwaku/apps/liteprotocoltester/publisher.nim
new file mode 100644
index 0000000..d803147
--- /dev/null
+++ b/third-party/nwaku/apps/liteprotocoltester/publisher.nim
@@ -0,0 +1,272 @@
+import
+ std/[strformat, sysrand, random, strutils, sequtils],
+ system/ansi_c,
+ chronicles,
+ chronos,
+ chronos/timer as chtimer,
+ stew/byteutils,
+ results,
+ json_serialization as js
+import
+ waku/[
+ common/logging,
+ waku_node,
+ node/peer_manager,
+ waku_core,
+ waku_lightpush/client,
+ waku_lightpush/common,
+ common/utils/parse_size_units,
+ ],
+ ./tester_config,
+ ./tester_message,
+ ./lpt_metrics,
+ ./diagnose_connections,
+ ./service_peer_management,
+ ./publisher_base,
+ ./legacy_publisher,
+ ./v3_publisher
+
+randomize()
+
+type SizeRange* = tuple[min: uint64, max: uint64]
+
+var RANDOM_PAYLOAD {.threadvar.}: seq[byte]
+RANDOM_PAYLOAD = urandom(1024 * 1024)
+ # 1MiB of random payload to be used to extend message
+
+proc prepareMessage(
+ sender: string,
+ messageIndex, numMessages: uint32,
+ startedAt: TimeStamp,
+ prevMessageAt: var Timestamp,
+ contentTopic: ContentTopic,
+ size: SizeRange,
+): (WakuMessage, uint64) =
+ var renderSize = rand(size.min .. size.max)
+ let current = getNowInNanosecondTime()
+ let payload = ProtocolTesterMessage(
+ sender: sender,
+ index: messageIndex,
+ count: numMessages,
+ startedAt: startedAt,
+ sinceStart: current - startedAt,
+ sincePrev: current - prevMessageAt,
+ size: renderSize,
+ )
+
+ prevMessageAt = current
+
+ let text = js.Json.encode(payload)
+ let contentPayload = toBytes(text & " \0")
+
+ if renderSize < len(contentPayload).uint64:
+ renderSize = len(contentPayload).uint64
+
+ let finalPayload =
+ concat(contentPayload, RANDOM_PAYLOAD[0 .. renderSize - len(contentPayload).uint64])
+ let message = WakuMessage(
+ payload: finalPayload, # content of the message
+ contentTopic: contentTopic, # content topic to publish to
+ ephemeral: true, # tell store nodes to not store it
+ timestamp: current, # current timestamp
+ )
+
+ return (message, renderSize)
+
+var sentMessages {.threadvar.}: OrderedTable[uint32, tuple[hash: string, relayed: bool]]
+var failedToSendCause {.threadvar.}: Table[string, uint32]
+var failedToSendCount {.threadvar.}: uint32
+var numMessagesToSend {.threadvar.}: uint32
+var messagesSent {.threadvar.}: uint32
+var noOfServicePeerSwitches {.threadvar.}: uint32
+
+proc reportSentMessages() =
+ let report = catch:
+ """*----------------------------------------*
+| Service Peer Switches: {noOfServicePeerSwitches:>15} |
+*----------------------------------------*
+| Expected | Sent | Failed |
+|{numMessagesToSend+failedToSendCount:>11} |{messagesSent:>11} |{failedToSendCount:>11} |
+*----------------------------------------*""".fmt()
+
+ if report.isErr:
+ echo "Error while printing statistics"
+ else:
+ echo report.get()
+
+ echo "*--------------------------------------------------------------------------------------------------*"
+ echo "| Failure cause | count |"
+ for (cause, count) in failedToSendCause.pairs:
+ echo fmt"|{cause:<87}|{count:>10}|"
+ echo "*--------------------------------------------------------------------------------------------------*"
+
+ echo "*--------------------------------------------------------------------------------------------------*"
+ echo "| Index | Relayed | Hash |"
+ for (index, info) in sentMessages.pairs:
+ echo fmt"|{index+1:>10}|{info.relayed:<9}| {info.hash:<76}|"
+ echo "*--------------------------------------------------------------------------------------------------*"
+ # evere sent message hash should logged once
+ sentMessages.clear()
+
+proc publishMessages(
+ wakuNode: WakuNode,
+ publisher: PublisherBase,
+ servicePeer: RemotePeerInfo,
+ lightpushPubsubTopic: PubsubTopic,
+ lightpushContentTopic: ContentTopic,
+ numMessages: uint32,
+ messageSizeRange: SizeRange,
+ messageInterval: Duration,
+ preventPeerSwitch: bool,
+) {.async.} =
+ var actualServicePeer = servicePeer
+ let startedAt = getNowInNanosecondTime()
+ var prevMessageAt = startedAt
+ var renderMsgSize = messageSizeRange
+ # sets some default of min max message size to avoid conflict with meaningful payload size
+ renderMsgSize.min = max(1024.uint64, renderMsgSize.min) # do not use less than 1KB
+ renderMsgSize.max = max(2048.uint64, renderMsgSize.max) # minimum of max is 2KB
+ renderMsgSize.min = min(renderMsgSize.min, renderMsgSize.max)
+ renderMsgSize.max = max(renderMsgSize.min, renderMsgSize.max)
+
+ const maxFailedPush = 3
+ var noFailedPush = 0
+ var noFailedServiceNodeSwitches = 0
+
+ let selfPeerId = $wakuNode.switch.peerInfo.peerId
+ failedToSendCount = 0
+ numMessagesToSend = if numMessages == 0: uint32.high else: numMessages
+ messagesSent = 0
+
+ while messagesSent < numMessagesToSend:
+ let (message, msgSize) = prepareMessage(
+ selfPeerId,
+ messagesSent + 1,
+ numMessagesToSend,
+ startedAt,
+ prevMessageAt,
+ lightpushContentTopic,
+ renderMsgSize,
+ )
+
+ let publishStartTime = Moment.now()
+
+ let wlpRes = await publisher.send(lightpushPubsubTopic, message, actualServicePeer)
+
+ let publishDuration = Moment.now() - publishStartTime
+
+ let msgHash = computeMessageHash(lightpushPubsubTopic, message).to0xHex
+
+ if wlpRes.isOk():
+ lpt_publish_duration_seconds.observe(publishDuration.milliseconds.float / 1000)
+
+ sentMessages[messagesSent] = (hash: msgHash, relayed: true)
+ notice "published message using lightpush",
+ index = messagesSent + 1,
+ count = numMessagesToSend,
+ size = msgSize,
+ pubsubTopic = lightpushPubsubTopic,
+ hash = msgHash
+ inc(messagesSent)
+ lpt_publisher_sent_messages_count.inc()
+ lpt_publisher_sent_bytes.inc(amount = msgSize.int64)
+ if noFailedPush > 0:
+ noFailedPush -= 1
+ else:
+ sentMessages[messagesSent] = (hash: msgHash, relayed: false)
+ failedToSendCause.mgetOrPut(wlpRes.error, 1).inc()
+ error "failed to publish message using lightpush",
+ err = wlpRes.error, hash = msgHash
+ inc(failedToSendCount)
+ lpt_publisher_failed_messages_count.inc(labelValues = [wlpRes.error])
+ if not wlpRes.error.toLower().contains("dial"):
+ # retry sending after shorter wait
+ await sleepAsync(2.seconds)
+ continue
+ else:
+ noFailedPush += 1
+ lpt_service_peer_failure_count.inc(
+ labelValues = ["publisher", actualServicePeer.getAgent()]
+ )
+ if not preventPeerSwitch and noFailedPush > maxFailedPush:
+ info "Max push failure limit reached, Try switching peer."
+ let peerOpt = selectRandomServicePeer(
+ wakuNode.peerManager, some(actualServicePeer), WakuLightPushCodec
+ )
+ if peerOpt.isOk():
+ actualServicePeer = peerOpt.get()
+
+ info "New service peer in use",
+ codec = lightpushPubsubTopic,
+ peer = constructMultiaddrStr(actualServicePeer)
+
+ noFailedPush = 0
+ noOfServicePeerSwitches += 1
+ lpt_change_service_peer_count.inc(labelValues = ["publisher"])
+ continue # try again with new peer without delay
+ else:
+ error "Failed to find new service peer. Exiting."
+ noFailedServiceNodeSwitches += 1
+ break
+
+ await sleepAsync(messageInterval)
+
+proc setupAndPublish*(
+ wakuNode: WakuNode, conf: LiteProtocolTesterConf, servicePeer: RemotePeerInfo
+) =
+ var publisher: PublisherBase
+ if conf.lightpushVersion == LightpushVersion.LEGACY:
+ info "Using legacy lightpush protocol for publishing messages"
+ publisher = LegacyPublisher.new(wakuNode)
+ else:
+ info "Using lightpush v3 protocol for publishing messages"
+ publisher = V3Publisher.new(wakuNode)
+
+ # give some time to receiver side to set up
+ let waitTillStartTesting = conf.startPublishingAfter.seconds
+
+ let parsedMinMsgSize = parseMsgSize(conf.minTestMessageSize).valueOr:
+ error "failed to parse 'min-test-msg-size' param: ", error = error
+ return
+
+ let parsedMaxMsgSize = parseMsgSize(conf.maxTestMessageSize).valueOr:
+ error "failed to parse 'max-test-msg-size' param: ", error = error
+ return
+
+ info "Sending test messages in", wait = waitTillStartTesting
+ waitFor sleepAsync(waitTillStartTesting)
+
+ info "Start sending messages to service node using lightpush"
+
+ sentMessages.sort(system.cmp)
+
+ let interval = secs(60)
+ var printStats: CallbackFunc
+
+ printStats = CallbackFunc(
+ proc(udata: pointer) {.gcsafe.} =
+ reportSentMessages()
+
+ if messagesSent >= numMessagesToSend:
+ info "All messages are sent. Exiting."
+
+ ## for gracefull shutdown through signal hooks
+ discard c_raise(ansi_c.SIGTERM)
+ else:
+ discard setTimer(Moment.fromNow(interval), printStats)
+ )
+
+ discard setTimer(Moment.fromNow(interval), printStats)
+
+ # Start maintaining subscription
+ asyncSpawn publishMessages(
+ wakuNode,
+ publisher,
+ servicePeer,
+ conf.getPubsubTopic(),
+ conf.contentTopics[0],
+ conf.numMessages,
+ (min: parsedMinMsgSize, max: parsedMaxMsgSize),
+ conf.messageInterval.milliseconds,
+ conf.fixedServicePeer,
+ )
diff --git a/third-party/nwaku/apps/liteprotocoltester/publisher_base.nim b/third-party/nwaku/apps/liteprotocoltester/publisher_base.nim
new file mode 100644
index 0000000..de88d82
--- /dev/null
+++ b/third-party/nwaku/apps/liteprotocoltester/publisher_base.nim
@@ -0,0 +1,14 @@
+import chronos, results
+import waku/[waku_node, waku_core]
+
+type PublisherBase* = ref object of RootObj
+ wakuNode*: WakuNode
+
+method send*(
+ self: PublisherBase,
+ topic: PubsubTopic,
+ message: WakuMessage,
+ servicePeer: RemotePeerInfo,
+): Future[Result[void, string]] {.base, async.} =
+ discard
+ # when error it must return original error desc due the text is used for distinction between error types in metrics.
diff --git a/third-party/nwaku/apps/liteprotocoltester/receiver.nim b/third-party/nwaku/apps/liteprotocoltester/receiver.nim
new file mode 100644
index 0000000..f0f41b1
--- /dev/null
+++ b/third-party/nwaku/apps/liteprotocoltester/receiver.nim
@@ -0,0 +1,182 @@
+## Example showing how a resource restricted client may
+## subscribe to messages without relay
+
+import
+ std/options,
+ system/ansi_c,
+ chronicles,
+ chronos,
+ chronos/timer as chtimer,
+ stew/byteutils,
+ results,
+ serialization,
+ json_serialization as js
+
+import
+ waku/[
+ common/logging,
+ node/peer_manager,
+ waku_node,
+ waku_core,
+ waku_filter_v2/client,
+ waku_filter_v2/common,
+ waku_core/multiaddrstr,
+ ],
+ ./tester_config,
+ ./tester_message,
+ ./statistics,
+ ./diagnose_connections,
+ ./service_peer_management,
+ ./lpt_metrics
+
+var actualFilterPeer {.threadvar.}: RemotePeerInfo
+
+proc unsubscribe(
+ wakuNode: WakuNode, filterPubsubTopic: PubsubTopic, filterContentTopic: ContentTopic
+) {.async.} =
+ notice "unsubscribing from filter"
+ let unsubscribeRes = await wakuNode.wakuFilterClient.unsubscribe(
+ actualFilterPeer, filterPubsubTopic, @[filterContentTopic]
+ )
+ if unsubscribeRes.isErr:
+ notice "unsubscribe request failed", err = unsubscribeRes.error
+ else:
+ notice "unsubscribe request successful"
+
+proc maintainSubscription(
+ wakuNode: WakuNode,
+ filterPubsubTopic: PubsubTopic,
+ filterContentTopic: ContentTopic,
+ preventPeerSwitch: bool,
+) {.async.} =
+ const maxFailedSubscribes = 3
+ const maxFailedServiceNodeSwitches = 10
+ var noFailedSubscribes = 0
+ var noFailedServiceNodeSwitches = 0
+ var isFirstPingOnNewPeer = true
+ while true:
+ info "maintaining subscription at", peer = constructMultiaddrStr(actualFilterPeer)
+ # First use filter-ping to check if we have an active subscription
+ let pingRes = await wakuNode.wakuFilterClient.ping(actualFilterPeer)
+ if pingRes.isErr():
+ if isFirstPingOnNewPeer == false:
+ # Very first ping expected to fail as we have not yet subscribed at all
+ lpt_receiver_lost_subscription_count.inc()
+ isFirstPingOnNewPeer = false
+ # No subscription found. Let's subscribe.
+ error "ping failed.", err = pingRes.error
+ trace "no subscription found. Sending subscribe request"
+
+ let subscribeRes = await wakuNode.filterSubscribe(
+ some(filterPubsubTopic), filterContentTopic, actualFilterPeer
+ )
+
+ if subscribeRes.isErr():
+ noFailedSubscribes += 1
+ lpt_service_peer_failure_count.inc(
+ labelValues = ["receiver", actualFilterPeer.getAgent()]
+ )
+ error "Subscribe request failed.",
+ err = subscribeRes.error,
+ peer = actualFilterPeer,
+ failCount = noFailedSubscribes
+
+ # TODO: disconnet from failed actualFilterPeer
+ # asyncSpawn(wakuNode.peerManager.switch.disconnect(p))
+ # wakunode.peerManager.peerStore.delete(actualFilterPeer)
+
+ if noFailedSubscribes < maxFailedSubscribes:
+ await sleepAsync(2.seconds) # Wait a bit before retrying
+ continue
+ elif not preventPeerSwitch:
+ let peerOpt = selectRandomServicePeer(
+ wakuNode.peerManager, some(actualFilterPeer), WakuFilterSubscribeCodec
+ )
+ if peerOpt.isOk():
+ actualFilterPeer = peerOpt.get()
+
+ info "Found new peer for codec",
+ codec = filterPubsubTopic, peer = constructMultiaddrStr(actualFilterPeer)
+
+ noFailedSubscribes = 0
+ lpt_change_service_peer_count.inc(labelValues = ["receiver"])
+ isFirstPingOnNewPeer = true
+ continue # try again with new peer without delay
+ else:
+ error "Failed to find new service peer. Exiting."
+ noFailedServiceNodeSwitches += 1
+ break
+ else:
+ if noFailedSubscribes > 0:
+ noFailedSubscribes -= 1
+
+ notice "subscribe request successful."
+ else:
+ info "subscription is live."
+
+ await sleepAsync(30.seconds) # Subscription maintenance interval
+
+proc setupAndListen*(
+ wakuNode: WakuNode, conf: LiteProtocolTesterConf, servicePeer: RemotePeerInfo
+) =
+ if isNil(wakuNode.wakuFilterClient):
+ # if we have not yet initialized lightpush client, then do it as the only way we can get here is
+ # by having a service peer discovered.
+ waitFor wakuNode.mountFilterClient()
+
+ info "Start receiving messages to service node using filter",
+ servicePeer = servicePeer
+
+ var stats: PerPeerStatistics
+ actualFilterPeer = servicePeer
+
+ let pushHandler = proc(
+ pubsubTopic: PubsubTopic, message: WakuMessage
+ ): Future[void] {.async, closure.} =
+ let payloadStr = string.fromBytes(message.payload)
+ let testerMessage = js.Json.decode(payloadStr, ProtocolTesterMessage)
+ let msgHash = computeMessageHash(pubsubTopic, message).to0xHex
+
+ stats.addMessage(testerMessage.sender, testerMessage, msgHash)
+
+ notice "message received",
+ index = testerMessage.index,
+ count = testerMessage.count,
+ startedAt = $testerMessage.startedAt,
+ sinceStart = $testerMessage.sinceStart,
+ sincePrev = $testerMessage.sincePrev,
+ size = $testerMessage.size,
+ pubsubTopic = pubsubTopic,
+ hash = msgHash
+
+ wakuNode.wakuFilterClient.registerPushHandler(pushHandler)
+
+ let interval = millis(20000)
+ var printStats: CallbackFunc
+
+ # calculate max wait after the last known message arrived before exiting
+ # 20% of expected messages times the expected interval but capped to 10min
+ let maxWaitForLastMessage: Duration =
+ min(conf.messageInterval.milliseconds * (conf.numMessages div 5), 10.minutes)
+
+ printStats = CallbackFunc(
+ proc(udata: pointer) {.gcsafe.} =
+ stats.echoStats()
+
+ if conf.numMessages > 0 and
+ waitFor stats.checkIfAllMessagesReceived(maxWaitForLastMessage):
+ waitFor unsubscribe(wakuNode, conf.getPubsubTopic(), conf.contentTopics[0])
+ info "All messages received. Exiting."
+
+ ## for gracefull shutdown through signal hooks
+ discard c_raise(ansi_c.SIGTERM)
+ else:
+ discard setTimer(Moment.fromNow(interval), printStats)
+ )
+
+ discard setTimer(Moment.fromNow(interval), printStats)
+
+ # Start maintaining subscription
+ asyncSpawn maintainSubscription(
+ wakuNode, conf.getPubsubTopic(), conf.contentTopics[0], conf.fixedServicePeer
+ )
diff --git a/third-party/nwaku/apps/liteprotocoltester/run_service_node.sh b/third-party/nwaku/apps/liteprotocoltester/run_service_node.sh
new file mode 100755
index 0000000..07fdbe9
--- /dev/null
+++ b/third-party/nwaku/apps/liteprotocoltester/run_service_node.sh
@@ -0,0 +1,63 @@
+#!/bin/sh
+
+echo "I am a service node"
+IP=$(ip a | grep "inet " | grep -Fv 127.0.0.1 | sed 's/.*inet \([^/]*\).*/\1/')
+
+echo "Service node IP: ${IP}"
+
+if [ -n "${SHARD}" ]; then
+ SHARD=--shard="${SHARD}"
+else
+ SHARD=--shard="0"
+fi
+
+if [ -n "${CLUSTER_ID}" ]; then
+ CLUSTER_ID=--cluster-id="${CLUSTER_ID}"
+fi
+
+echo "STANDALONE: ${STANDALONE}"
+
+if [ -z "${STANDALONE}" ]; then
+
+ RETRIES=${RETRIES:=20}
+
+ while [ -z "${BOOTSTRAP_ENR}" ] && [ ${RETRIES} -ge 0 ]; do
+ BOOTSTRAP_ENR=$(wget -qO- http://bootstrap:8645/debug/v1/info --header='Content-Type:application/json' 2> /dev/null | sed 's/.*"enrUri":"\([^"]*\)".*/\1/');
+ echo "Bootstrap node not ready, retrying (retries left: ${RETRIES})"
+ sleep 3
+ RETRIES=$(( $RETRIES - 1 ))
+ done
+
+ if [ -z "${BOOTSTRAP_ENR}" ]; then
+ echo "Could not get BOOTSTRAP_ENR and none provided. Failing"
+ exit 1
+ fi
+
+ echo "Using bootstrap node: ${BOOTSTRAP_ENR}"
+
+fi
+
+
+exec /usr/bin/wakunode\
+ --relay=true\
+ --filter=true\
+ --lightpush=true\
+ --store=false\
+ --rest=true\
+ --rest-admin=true\
+ --rest-private=true\
+ --rest-address=0.0.0.0\
+ --rest-allow-origin="*"\
+ --keep-alive=true\
+ --max-connections=300\
+ --dns-discovery=true\
+ --discv5-discovery=true\
+ --discv5-enr-auto-update=True\
+ --discv5-bootstrap-node=${BOOTSTRAP_ENR}\
+ --log-level=INFO\
+ --metrics-server=True\
+ --metrics-server-port=8003\
+ --metrics-server-address=0.0.0.0\
+ --nat=extip:${IP}\
+ ${SHARD}\
+ ${CLUSTER_ID}
diff --git a/third-party/nwaku/apps/liteprotocoltester/run_tester_node.sh b/third-party/nwaku/apps/liteprotocoltester/run_tester_node.sh
new file mode 100755
index 0000000..3c2d60e
--- /dev/null
+++ b/third-party/nwaku/apps/liteprotocoltester/run_tester_node.sh
@@ -0,0 +1,161 @@
+#!/bin/sh
+
+#set -x
+
+if test -f .env; then
+ echo "Using .env file"
+ . $(pwd)/.env
+fi
+
+
+echo "I am a lite-protocol-tester node"
+
+BINARY_PATH=$1
+
+if [ ! -x "${BINARY_PATH}" ]; then
+ echo "Invalid binary path '${BINARY_PATH}'. Failing"
+ exit 1
+fi
+
+if [ "${2}" = "--help" ]; then
+ echo "You might want to check nwaku/apps/liteprotocoltester/README.md"
+ exec "${BINARY_PATH}" --help
+ exit 0
+fi
+
+FUNCTION=$2
+if [ "${FUNCTION}" = "SENDER" ]; then
+ FUNCTION="--test-func=SENDER --lightpush-version=LEGACY"
+ SERVICENAME=lightpush-service
+fi
+
+if [ "${FUNCTION}" = "SENDERV3" ]; then
+ FUNCTION="--test-func=SENDER --lightpush-version=V3"
+ SERVICENAME=lightpush-service
+fi
+
+if [ "${FUNCTION}" = "RECEIVER" ]; then
+ FUNCTION=--test-func=RECEIVER
+ SERVICENAME=filter-service
+fi
+
+SERIVCE_NODE_ADDR=$3
+if [ -z "${SERIVCE_NODE_ADDR}" ]; then
+ echo "Service node peer_id provided. Failing"
+ exit 1
+fi
+
+SELECTOR=$4
+if [ -z "${SELECTOR}" ] || [ "${SELECTOR}" = "SERVICE" ]; then
+ SERVICE_NODE_DIRECT=true
+elif [ "${SELECTOR}" = "BOOTSTRAP" ]; then
+ SERVICE_NODE_DIRECT=false
+else
+ echo "Invalid selector '${SELECTOR}'. Failing"
+ exit 1
+fi
+
+DO_DETECT_SERVICENODE=0
+
+if [ "${SERIVCE_NODE_ADDR}" = "servicenode" ]; then
+ DO_DETECT_SERVICENODE=1
+ SERIVCE_NODE_ADDR=""
+ SERVICENAME=servicenode
+fi
+
+if [ "${SERIVCE_NODE_ADDR}" = "waku-sim" ]; then
+ DO_DETECT_SERVICENODE=1
+ SERIVCE_NODE_ADDR=""
+ MY_EXT_IP=$(ip a | grep "inet " | grep -Fv 127.0.0.1 | sed 's/.*inet \([^/]*\).*/\1/')
+else
+ MY_EXT_IP=$(wget -qO- --no-check-certificate https://api4.ipify.org)
+fi
+
+
+if [ $DO_DETECT_SERVICENODE -eq 1 ]; then
+ RETRIES=${RETRIES:=20}
+
+ while [ -z "${SERIVCE_NODE_ADDR}" ] && [ ${RETRIES} -ge 0 ]; do
+ SERVICE_DEBUG_INFO=$(wget -qO- http://${SERVICENAME}:8645/debug/v1/info --header='Content-Type:application/json' 2> /dev/null);
+ echo "SERVICE_DEBUG_INFO: ${SERVICE_DEBUG_INFO}"
+
+ SERIVCE_NODE_ADDR=$(wget -qO- http://${SERVICENAME}:8645/debug/v1/info --header='Content-Type:application/json' 2> /dev/null | sed 's/.*"listenAddresses":\["\([^"]*\)".*/\1/');
+ echo "Service node not ready, retrying (retries left: ${RETRIES})"
+ sleep 3
+ RETRIES=$(( $RETRIES - 1 ))
+ done
+
+fi
+
+if [ -z "${SERIVCE_NODE_ADDR}" ]; then
+ echo "Could not get SERIVCE_NODE_ADDR and none provided. Failing"
+ exit 1
+fi
+
+if $SERVICE_NODE_DIRECT; then
+ FULL_NODE=--service-node="${SERIVCE_NODE_ADDR} --fixed-service-peer"
+else
+ FULL_NODE=--bootstrap-node="${SERIVCE_NODE_ADDR}"
+fi
+
+if [ -n "${SHARD}" ]; then
+ SHARD=--shard="${SHARD}"
+else
+ SHARD=--shard="0"
+fi
+
+if [ -n "${CONTENT_TOPIC}" ]; then
+ CONTENT_TOPIC=--content-topic="${CONTENT_TOPIC}"
+fi
+
+if [ -n "${CLUSTER_ID}" ]; then
+ CLUSTER_ID=--cluster-id="${CLUSTER_ID}"
+fi
+
+if [ -n "${START_PUBLISHING_AFTER_SECS}" ]; then
+ START_PUBLISHING_AFTER_SECS=--start-publishing-after="${START_PUBLISHING_AFTER_SECS}"
+fi
+
+if [ -n "${MIN_MESSAGE_SIZE}" ]; then
+ MIN_MESSAGE_SIZE=--min-test-msg-size="${MIN_MESSAGE_SIZE}"
+fi
+
+if [ -n "${MAX_MESSAGE_SIZE}" ]; then
+ MAX_MESSAGE_SIZE=--max-test-msg-size="${MAX_MESSAGE_SIZE}"
+fi
+
+
+if [ -n "${NUM_MESSAGES}" ]; then
+ NUM_MESSAGES=--num-messages="${NUM_MESSAGES}"
+fi
+
+if [ -n "${MESSAGE_INTERVAL_MILLIS}" ]; then
+ MESSAGE_INTERVAL_MILLIS=--message-interval="${MESSAGE_INTERVAL_MILLIS}"
+fi
+
+if [ -n "${LOG_LEVEL}" ]; then
+ LOG_LEVEL=--log-level=${LOG_LEVEL}
+else
+ LOG_LEVEL=--log-level=INFO
+fi
+
+echo "Running binary: ${BINARY_PATH}"
+echo "Tester node: ${FUNCTION}"
+echo "Using service node: ${SERIVCE_NODE_ADDR}"
+echo "My external IP: ${MY_EXT_IP}"
+
+exec "${BINARY_PATH}"\
+ --nat=extip:${MY_EXT_IP}\
+ --test-peers\
+ ${LOG_LEVEL}\
+ ${FULL_NODE}\
+ ${MESSAGE_INTERVAL_MILLIS}\
+ ${NUM_MESSAGES}\
+ ${SHARD}\
+ ${CONTENT_TOPIC}\
+ ${CLUSTER_ID}\
+ ${FUNCTION}\
+ ${START_PUBLISHING_AFTER_SECS}\
+ ${MIN_MESSAGE_SIZE}\
+ ${MAX_MESSAGE_SIZE}
+ # --config-file=config.toml\
diff --git a/third-party/nwaku/apps/liteprotocoltester/run_tester_node_at_infra.sh b/third-party/nwaku/apps/liteprotocoltester/run_tester_node_at_infra.sh
new file mode 100644
index 0000000..db26eb0
--- /dev/null
+++ b/third-party/nwaku/apps/liteprotocoltester/run_tester_node_at_infra.sh
@@ -0,0 +1,119 @@
+#!/bin/sh
+
+#set -x
+#echo "$@"
+
+if test -f .env; then
+ echo "Using .env file"
+ . $(pwd)/.env
+fi
+
+
+echo "I am a lite-protocol-tester node"
+
+BINARY_PATH=$1
+
+if [ ! -x "${BINARY_PATH}" ]; then
+ echo "Invalid binary path '${BINARY_PATH}'. Failing"
+ exit 1
+fi
+
+if [ "${2}" = "--help" ]; then
+ echo "You might want to check nwaku/apps/liteprotocoltester/README.md"
+ exec "${BINARY_PATH}" --help
+ exit 0
+fi
+
+FUNCTION=$2
+if [ "${FUNCTION}" = "SENDER" ]; then
+ FUNCTION="--test-func=SENDER --lightpush-version=LEGACY"
+ SERIVCE_NODE_ADDR=${LIGHTPUSH_SERVICE_PEER:-${LIGHTPUSH_BOOTSTRAP:-}}
+ NODE_ARG=${LIGHTPUSH_SERVICE_PEER:+--service-node="${LIGHTPUSH_SERVICE_PEER}"}
+ NODE_ARG=${NODE_ARG:---bootstrap-node="${LIGHTPUSH_BOOTSTRAP}"}
+ METRICS_PORT=--metrics-port="${PUBLISHER_METRICS_PORT:-8003}"
+fi
+
+if [ "${FUNCTION}" = "SENDERV3" ]; then
+ FUNCTION="--test-func=SENDER --lightpush-version=V3"
+ SERIVCE_NODE_ADDR=${LIGHTPUSH_SERVICE_PEER:-${LIGHTPUSH_BOOTSTRAP:-}}
+ NODE_ARG=${LIGHTPUSH_SERVICE_PEER:+--service-node="${LIGHTPUSH_SERVICE_PEER}"}
+ NODE_ARG=${NODE_ARG:---bootstrap-node="${LIGHTPUSH_BOOTSTRAP}"}
+ METRICS_PORT=--metrics-port="${PUBLISHER_METRICS_PORT:-8003}"
+fi
+
+if [ "${FUNCTION}" = "RECEIVER" ]; then
+ FUNCTION=--test-func=RECEIVER
+ SERIVCE_NODE_ADDR=${FILTER_SERVICE_PEER:-${FILTER_BOOTSTRAP:-}}
+ NODE_ARG=${FILTER_SERVICE_PEER:+--service-node="${FILTER_SERVICE_PEER}"}
+ NODE_ARG=${NODE_ARG:---bootstrap-node="${FILTER_BOOTSTRAP}"}
+ METRICS_PORT=--metrics-port="${RECEIVER_METRICS_PORT:-8003}"
+fi
+
+if [ -z "${SERIVCE_NODE_ADDR}" ]; then
+ echo "Service/Bootsrap node peer_id or enr is not provided. Failing"
+ exit 1
+fi
+
+MY_EXT_IP=$(wget -qO- --no-check-certificate https://api4.ipify.org)
+
+if [ -n "${SHARD}" ]; then
+ SHARD=--shard="${SHARD}"
+else
+ SHARD=--shard="0"
+fi
+
+if [ -n "${CONTENT_TOPIC}" ]; then
+ CONTENT_TOPIC=--content-topic="${CONTENT_TOPIC}"
+fi
+
+if [ -n "${CLUSTER_ID}" ]; then
+ CLUSTER_ID=--cluster-id="${CLUSTER_ID}"
+fi
+
+if [ -n "${START_PUBLISHING_AFTER_SECS}" ]; then
+ START_PUBLISHING_AFTER_SECS=--start-publishing-after="${START_PUBLISHING_AFTER_SECS}"
+fi
+
+if [ -n "${MIN_MESSAGE_SIZE}" ]; then
+ MIN_MESSAGE_SIZE=--min-test-msg-size="${MIN_MESSAGE_SIZE}"
+fi
+
+if [ -n "${MAX_MESSAGE_SIZE}" ]; then
+ MAX_MESSAGE_SIZE=--max-test-msg-size="${MAX_MESSAGE_SIZE}"
+fi
+
+
+if [ -n "${NUM_MESSAGES}" ]; then
+ NUM_MESSAGES=--num-messages="${NUM_MESSAGES}"
+fi
+
+if [ -n "${MESSAGE_INTERVAL_MILLIS}" ]; then
+ MESSAGE_INTERVAL_MILLIS=--message-interval="${MESSAGE_INTERVAL_MILLIS}"
+fi
+
+if [ -n "${LOG_LEVEL}" ]; then
+ LOG_LEVEL=--log-level=${LOG_LEVEL}
+else
+ LOG_LEVEL=--log-level=INFO
+fi
+
+echo "Running binary: ${BINARY_PATH}"
+echo "Node function is: ${FUNCTION}"
+echo "Using service/bootstrap node as: ${NODE_ARG}"
+echo "My external IP: ${MY_EXT_IP}"
+
+exec "${BINARY_PATH}"\
+ --nat=extip:${MY_EXT_IP}\
+ --test-peers\
+ ${LOG_LEVEL}\
+ ${NODE_ARG}\
+ ${MESSAGE_INTERVAL_MILLIS}\
+ ${NUM_MESSAGES}\
+ ${SHARD}\
+ ${CONTENT_TOPIC}\
+ ${CLUSTER_ID}\
+ ${FUNCTION}\
+ ${START_PUBLISHING_AFTER_SECS}\
+ ${MIN_MESSAGE_SIZE}\
+ ${MAX_MESSAGE_SIZE}\
+ ${METRICS_PORT}
diff --git a/third-party/nwaku/apps/liteprotocoltester/run_tester_node_on_fleet.sh b/third-party/nwaku/apps/liteprotocoltester/run_tester_node_on_fleet.sh
new file mode 100644
index 0000000..533f5b1
--- /dev/null
+++ b/third-party/nwaku/apps/liteprotocoltester/run_tester_node_on_fleet.sh
@@ -0,0 +1,118 @@
+#!/bin/sh
+
+#set -x
+#echo "$@"
+
+if test -f .env; then
+ echo "Using .env file"
+ . $(pwd)/.env
+fi
+
+
+echo "I am a lite-protocol-tester node"
+
+BINARY_PATH=$1
+
+if [ ! -x "${BINARY_PATH}" ]; then
+ echo "Invalid binary path '${BINARY_PATH}'. Failing"
+ exit 1
+fi
+
+if [ "${2}" = "--help" ]; then
+ echo "You might want to check nwaku/apps/liteprotocoltester/README.md"
+ exec "${BINARY_PATH}" --help
+ exit 0
+fi
+
+FUNCTION=$2
+if [ "${FUNCTION}" = "SENDER" ]; then
+ FUNCTION="--test-func=SENDER --lightpush-version=LEGACY"
+ SERIVCE_NODE_ADDR=${LIGHTPUSH_SERVICE_PEER:-${LIGHTPUSH_BOOTSTRAP:-}}
+ NODE_ARG=${LIGHTPUSH_SERVICE_PEER:+--service-node="${LIGHTPUSH_SERVICE_PEER}"}
+ NODE_ARG=${NODE_ARG:---bootstrap-node="${LIGHTPUSH_BOOTSTRAP}"}
+ METRICS_PORT=--metrics-port="${PUBLISHER_METRICS_PORT:-8003}"
+fi
+
+if [ "${FUNCTION}" = "SENDERV3" ]; then
+ FUNCTION="--test-func=SENDER --lightpush-version=V3"
+ SERIVCE_NODE_ADDR=${LIGHTPUSH_SERVICE_PEER:-${LIGHTPUSH_BOOTSTRAP:-}}
+ NODE_ARG=${LIGHTPUSH_SERVICE_PEER:+--service-node="${LIGHTPUSH_SERVICE_PEER}"}
+ NODE_ARG=${NODE_ARG:---bootstrap-node="${LIGHTPUSH_BOOTSTRAP}"}
+ METRICS_PORT=--metrics-port="${PUBLISHER_METRICS_PORT:-8003}"
+fi
+
+if [ "${FUNCTION}" = "RECEIVER" ]; then
+ FUNCTION=--test-func=RECEIVER
+ SERIVCE_NODE_ADDR=${FILTER_SERVICE_PEER:-${FILTER_BOOTSTRAP:-}}
+ NODE_ARG=${FILTER_SERVICE_PEER:+--service-node="${FILTER_SERVICE_PEER}"}
+ NODE_ARG=${NODE_ARG:---bootstrap-node="${FILTER_BOOTSTRAP}"}
+ METRICS_PORT=--metrics-port="${RECEIVER_METRICS_PORT:-8003}"
+fi
+
+if [ -z "${SERIVCE_NODE_ADDR}" ]; then
+ echo "Service/Bootsrap node peer_id or enr is not provided. Failing"
+ exit 1
+fi
+
+MY_EXT_IP=$(wget -qO- --no-check-certificate https://api4.ipify.org)
+
+if [ -n "${SHARD}" ]; then
+ SHARD=--shard=${SHARD}
+else
+ SHARD=--shard=0
+fi
+
+if [ -n "${CONTENT_TOPIC}" ]; then
+ CONTENT_TOPIC=--content-topic="${CONTENT_TOPIC}"
+fi
+
+if [ -n "${CLUSTER_ID}" ]; then
+ CLUSTER_ID=--cluster-id="${CLUSTER_ID}"
+fi
+
+if [ -n "${START_PUBLISHING_AFTER}" ]; then
+ START_PUBLISHING_AFTER=--start-publishing-after="${START_PUBLISHING_AFTER}"
+fi
+
+if [ -n "${MIN_MESSAGE_SIZE}" ]; then
+ MIN_MESSAGE_SIZE=--min-test-msg-size="${MIN_MESSAGE_SIZE}"
+fi
+
+if [ -n "${MAX_MESSAGE_SIZE}" ]; then
+ MAX_MESSAGE_SIZE=--max-test-msg-size="${MAX_MESSAGE_SIZE}"
+fi
+
+
+if [ -n "${NUM_MESSAGES}" ]; then
+ NUM_MESSAGES=--num-messages="${NUM_MESSAGES}"
+fi
+
+if [ -n "${MESSAGE_INTERVAL_MILLIS}" ]; then
+ MESSAGE_INTERVAL_MILLIS=--message-interval="${MESSAGE_INTERVAL_MILLIS}"
+fi
+
+if [ -n "${LOG_LEVEL}" ]; then
+ LOG_LEVEL=--log-level=${LOG_LEVEL}
+else
+ LOG_LEVEL=--log-level=INFO
+fi
+
+echo "Running binary: ${BINARY_PATH}"
+echo "Node function is: ${FUNCTION}"
+echo "Using service/bootstrap node as: ${NODE_ARG}"
+echo "My external IP: ${MY_EXT_IP}"
+
+exec "${BINARY_PATH}"\
+ --nat=extip:${MY_EXT_IP}\
+ ${LOG_LEVEL}\
+ ${NODE_ARG}\
+ ${MESSAGE_INTERVAL_MILLIS}\
+ ${NUM_MESSAGES}\
+ ${SHARD}\
+ ${CONTENT_TOPIC}\
+ ${CLUSTER_ID}\
+ ${FUNCTION}\
+ ${START_PUBLISHING_AFTER}\
+ ${MIN_MESSAGE_SIZE}\
+ ${MAX_MESSAGE_SIZE}\
+ ${METRICS_PORT}
diff --git a/third-party/nwaku/apps/liteprotocoltester/service_peer_management.nim b/third-party/nwaku/apps/liteprotocoltester/service_peer_management.nim
new file mode 100644
index 0000000..a72daa2
--- /dev/null
+++ b/third-party/nwaku/apps/liteprotocoltester/service_peer_management.nim
@@ -0,0 +1,223 @@
+{.push raises: [].}
+
+import
+ std/[options, net, sysrand, random, strformat, strutils, sequtils],
+ chronicles,
+ chronos,
+ metrics,
+ libbacktrace,
+ libp2p/crypto/crypto,
+ confutils,
+ libp2p/wire
+
+import
+ ../wakunode2/cli_args,
+ waku/[
+ common/enr,
+ waku_node,
+ node/peer_manager,
+ waku_lightpush/common,
+ waku_relay,
+ waku_filter_v2,
+ waku_peer_exchange/protocol,
+ waku_core/multiaddrstr,
+ waku_core/topics/pubsub_topic,
+ waku_enr/capabilities,
+ waku_enr/sharding,
+ ],
+ ./tester_config,
+ ./diagnose_connections,
+ ./lpt_metrics
+
+logScope:
+ topics = "service peer mgmt"
+
+randomize()
+
+proc translateToRemotePeerInfo*(peerAddress: string): Result[RemotePeerInfo, void] =
+ var peerInfo: RemotePeerInfo
+ var enrRec: enr.Record
+ if enrRec.fromURI(peerAddress):
+ trace "Parsed ENR", enrRec = $enrRec
+ peerInfo = enrRec.toRemotePeerInfo().valueOr:
+ error "failed to convert ENR to RemotePeerInfo", error = error
+ return err()
+ else:
+ peerInfo = parsePeerInfo(peerAddress).valueOr:
+ error "failed to parse node waku peer-exchange peerId", error = error
+ return err()
+
+ return ok(peerInfo)
+
+## To retrieve peers from PeerExchange partner and return one randomly selected one
+## among the ones successfully dialed
+## Note: This is kept for future use.
+proc selectRandomCapablePeer*(
+ pm: PeerManager, codec: string, pubsubTopic: PubsubTopic
+): Future[Option[RemotePeerInfo]] {.async.} =
+ var cap = Capabilities.Filter
+ if codec.contains("lightpush"):
+ cap = Capabilities.Lightpush
+ elif codec.contains("filter"):
+ cap = Capabilities.Filter
+
+ var supportivePeers = pm.switch.peerStore.getPeersByCapability(cap)
+
+ trace "Found supportive peers count", count = supportivePeers.len()
+ trace "Found supportive peers", supportivePeers = $supportivePeers
+ if supportivePeers.len == 0:
+ return none(RemotePeerInfo)
+
+ var found = none(RemotePeerInfo)
+ while found.isNone() and supportivePeers.len > 0:
+ let rndPeerIndex = rand(0 .. supportivePeers.len - 1)
+ let randomPeer = supportivePeers[rndPeerIndex]
+
+ debug "Dialing random peer",
+ idx = $rndPeerIndex, peer = constructMultiaddrStr(randomPeer)
+
+ supportivePeers.delete(rndPeerIndex .. rndPeerIndex)
+
+ let connOpt = pm.dialPeer(randomPeer, codec)
+ if (await connOpt.withTimeout(10.seconds)):
+ if connOpt.value().isSome():
+ found = some(randomPeer)
+ debug "Dialing successful",
+ peer = constructMultiaddrStr(randomPeer), codec = codec
+ else:
+ debug "Dialing failed", peer = constructMultiaddrStr(randomPeer), codec = codec
+ else:
+ debug "Timeout dialing service peer",
+ peer = constructMultiaddrStr(randomPeer), codec = codec
+
+ return found
+
+# Debugging PX gathered peers connectivity
+proc tryCallAllPxPeers*(
+ pm: PeerManager, codec: string, pubsubTopic: PubsubTopic
+): Future[Option[seq[RemotePeerInfo]]] {.async.} =
+ var capability = Capabilities.Filter
+ if codec.contains("lightpush"):
+ capability = Capabilities.Lightpush
+ elif codec.contains("filter"):
+ capability = Capabilities.Filter
+
+ var supportivePeers = pm.switch.peerStore.getPeersByCapability(capability)
+
+ lpt_px_peers.set(supportivePeers.len)
+ debug "Found supportive peers count", count = supportivePeers.len()
+ debug "Found supportive peers", supportivePeers = $supportivePeers
+ if supportivePeers.len == 0:
+ return none(seq[RemotePeerInfo])
+
+ var okPeers: seq[RemotePeerInfo] = @[]
+
+ while supportivePeers.len > 0:
+ let rndPeerIndex = rand(0 .. supportivePeers.len - 1)
+ let randomPeer = supportivePeers[rndPeerIndex]
+
+ debug "Dialing random peer",
+ idx = $rndPeerIndex, peer = constructMultiaddrStr(randomPeer)
+
+ supportivePeers.delete(rndPeerIndex, rndPeerIndex)
+
+ let connOpt = pm.dialPeer(randomPeer, codec)
+ if (await connOpt.withTimeout(10.seconds)):
+ if connOpt.value().isSome():
+ okPeers.add(randomPeer)
+ info "Dialing successful",
+ peer = constructMultiaddrStr(randomPeer),
+ agent = randomPeer.getAgent(),
+ codec = codec
+ lpt_dialed_peers.inc(labelValues = [randomPeer.getAgent()])
+ else:
+ lpt_dial_failures.inc(labelValues = [randomPeer.getAgent()])
+ error "Dialing failed",
+ peer = constructMultiaddrStr(randomPeer),
+ agent = randomPeer.getAgent(),
+ codec = codec
+ else:
+ lpt_dial_failures.inc(labelValues = [randomPeer.getAgent()])
+ error "Timeout dialing service peer",
+ peer = constructMultiaddrStr(randomPeer),
+ agent = randomPeer.getAgent(),
+ codec = codec
+
+ var okPeersStr: string = ""
+ for idx, peer in okPeers:
+ okPeersStr.add(
+ " " & $idx & ". | " & constructMultiaddrStr(peer) & " | agent: " &
+ peer.getAgent() & " | protos: " & $peer.protocols & " | caps: " &
+ $peer.enr.map(getCapabilities) & "\n"
+ )
+ echo "PX returned peers found callable for " & codec & " / " & $capability & ":\n"
+ echo okPeersStr
+
+ return some(okPeers)
+
+proc pxLookupServiceNode*(
+ node: WakuNode, conf: LiteProtocolTesterConf
+): Future[Result[bool, void]] {.async.} =
+ let codec: string = conf.getCodec()
+
+ if node.wakuPeerExchange.isNil():
+ let peerExchangeNode = translateToRemotePeerInfo(conf.bootstrapNode).valueOr:
+ error "Failed to parse bootstrap node - cannot use PeerExchange.",
+ node = conf.bootstrapNode
+ return err()
+ info "PeerExchange node", peer = constructMultiaddrStr(peerExchangeNode)
+ node.peerManager.addServicePeer(peerExchangeNode, WakuPeerExchangeCodec)
+
+ try:
+ await node.mountPeerExchange(some(conf.clusterId))
+ except CatchableError:
+ error "failed to mount waku peer-exchange protocol",
+ error = getCurrentExceptionMsg()
+ return err()
+
+ var trialCount = 5
+ while trialCount > 0:
+ let futPeers = node.fetchPeerExchangePeers(conf.reqPxPeers)
+ if not await futPeers.withTimeout(30.seconds):
+ notice "Cannot get peers from PX", round = 5 - trialCount
+ else:
+ if futPeers.value().isErr():
+ info "PeerExchange reported error", error = futPeers.read().error
+ return err()
+
+ if conf.testPeers:
+ let peersOpt =
+ await tryCallAllPxPeers(node.peerManager, codec, conf.getPubsubTopic())
+ if peersOpt.isSome():
+ info "Found service peers for codec",
+ codec = codec, peer_count = peersOpt.get().len()
+ return ok(peersOpt.get().len > 0)
+ else:
+ let peerOpt =
+ await selectRandomCapablePeer(node.peerManager, codec, conf.getPubsubTopic())
+ if peerOpt.isSome():
+ info "Found service peer for codec", codec = codec, peer = peerOpt.get()
+ return ok(true)
+
+ await sleepAsync(5.seconds)
+ trialCount -= 1
+
+ return err()
+
+var alreadyUsedServicePeers {.threadvar.}: seq[RemotePeerInfo]
+
+## Select service peers by codec from peer store randomly.
+proc selectRandomServicePeer*(
+ pm: PeerManager, actualPeer: Option[RemotePeerInfo], codec: string
+): Result[RemotePeerInfo, void] =
+ if actualPeer.isSome():
+ alreadyUsedServicePeers.add(actualPeer.get())
+
+ let supportivePeers = pm.switch.peerStore.getPeersByProtocol(codec).filterIt(
+ it notin alreadyUsedServicePeers
+ )
+ if supportivePeers.len == 0:
+ return err()
+
+ let rndPeerIndex = rand(0 .. supportivePeers.len - 1)
+ return ok(supportivePeers[rndPeerIndex])
diff --git a/third-party/nwaku/apps/liteprotocoltester/statistics.nim b/third-party/nwaku/apps/liteprotocoltester/statistics.nim
new file mode 100644
index 0000000..8322edd
--- /dev/null
+++ b/third-party/nwaku/apps/liteprotocoltester/statistics.nim
@@ -0,0 +1,336 @@
+{.push raises: [].}
+
+import
+ std/[sets, tables, sequtils, options, strformat],
+ chronos/timer as chtimer,
+ chronicles,
+ chronos,
+ results,
+ libp2p/peerid
+
+import ./tester_message, ./lpt_metrics
+
+type
+ ArrivalInfo = object
+ arrivedAt: Moment
+ prevArrivedAt: Moment
+ prevIndex: uint32
+
+ MessageInfo = tuple[msg: ProtocolTesterMessage, info: ArrivalInfo]
+ DupStat = tuple[hash: string, dupCount: int, size: uint64]
+
+ StatHelper = object
+ prevIndex: uint32
+ prevArrivedAt: Moment
+ lostIndices: HashSet[uint32]
+ seenIndices: HashSet[uint32]
+ maxIndex: uint32
+ duplicates: OrderedTable[uint32, DupStat]
+
+ Statistics* = object
+ received: Table[uint32, MessageInfo]
+ firstReceivedIdx*: uint32
+ allMessageCount*: uint32
+ receivedMessages*: uint32
+ misorderCount*: uint32
+ lateCount*: uint32
+ duplicateCount*: uint32
+ helper: StatHelper
+
+ PerPeerStatistics* = Table[string, Statistics]
+
+func `$`*(a: Duration): string {.inline.} =
+ ## Original stringify implementation from chronos/timer.nim is not capable of printing 0ns
+ ## Returns string representation of Duration ``a`` as nanoseconds value.
+
+ if a.isZero:
+ return "0ns"
+
+ return chtimer.`$`(a)
+
+proc init*(T: type Statistics, expectedMessageCount: int = 1000): T =
+ result.helper.prevIndex = 0
+ result.helper.maxIndex = 0
+ result.helper.seenIndices.init(expectedMessageCount)
+ result.received = initTable[uint32, MessageInfo](expectedMessageCount)
+ return result
+
+proc addMessage*(
+ self: var Statistics, sender: string, msg: ProtocolTesterMessage, msgHash: string
+) =
+ if self.allMessageCount == 0:
+ self.allMessageCount = msg.count
+ self.firstReceivedIdx = msg.index
+ elif self.allMessageCount != msg.count:
+ error "Message count mismatch at message",
+ index = msg.index, expected = self.allMessageCount, got = msg.count
+
+ let currentArrived: MessageInfo = (
+ msg: msg,
+ info: ArrivalInfo(
+ arrivedAt: Moment.now(),
+ prevArrivedAt: self.helper.prevArrivedAt,
+ prevIndex: self.helper.prevIndex,
+ ),
+ )
+ lpt_receiver_received_bytes.inc(labelValues = [sender], amount = msg.size.int64)
+ if self.received.hasKeyOrPut(msg.index, currentArrived):
+ inc(self.duplicateCount)
+ self.helper.duplicates.mgetOrPut(msg.index, (msgHash, 0, msg.size)).dupCount.inc()
+ warn "Duplicate message",
+ index = msg.index,
+ hash = msgHash,
+ times_duplicated = self.helper.duplicates[msg.index].dupCount
+ lpt_receiver_duplicate_messages_count.inc(labelValues = [sender])
+ lpt_receiver_distinct_duplicate_messages_count.set(
+ labelValues = [sender], value = self.helper.duplicates.len()
+ )
+ return
+
+ ## detect misorder arrival and possible lost messages
+ if self.helper.prevIndex + 1 < msg.index:
+ inc(self.misorderCount)
+ warn "Misordered message arrival",
+ index = msg.index, expected = self.helper.prevIndex + 1
+ elif self.helper.prevIndex > msg.index:
+ inc(self.lateCount)
+ warn "Late message arrival", index = msg.index, expected = self.helper.prevIndex + 1
+
+ self.helper.maxIndex = max(self.helper.maxIndex, msg.index)
+ self.helper.prevIndex = msg.index
+ self.helper.prevArrivedAt = currentArrived.info.arrivedAt
+ inc(self.receivedMessages)
+ lpt_receiver_received_messages_count.inc(labelValues = [sender])
+ lpt_receiver_missing_messages_count.set(
+ labelValues = [sender], value = (self.helper.maxIndex - self.receivedMessages).int64
+ )
+
+proc addMessage*(
+ self: var PerPeerStatistics,
+ peerId: string,
+ msg: ProtocolTesterMessage,
+ msgHash: string,
+) =
+ if not self.contains(peerId):
+ self[peerId] = Statistics.init()
+
+ let shortSenderId = block:
+ let senderPeer = PeerId.init(msg.sender)
+ if senderPeer.isErr():
+ msg.sender
+ else:
+ senderPeer.get().shortLog()
+
+ discard catch:
+ self[peerId].addMessage(shortSenderId, msg, msgHash)
+
+ lpt_receiver_sender_peer_count.set(value = self.len)
+
+proc lastMessageArrivedAt*(self: Statistics): Option[Moment] =
+ if self.receivedMessages > 0:
+ return some(self.helper.prevArrivedAt)
+ return none(Moment)
+
+proc lossCount*(self: Statistics): uint32 =
+ self.helper.maxIndex - self.receivedMessages
+
+proc calcLatency*(self: Statistics): tuple[min, max, avg: Duration] =
+ var
+ minLatency = nanos(0)
+ maxLatency = nanos(0)
+ avgLatency = nanos(0)
+
+ if self.receivedMessages > 2:
+ try:
+ var prevArrivedAt = self.received[self.firstReceivedIdx].info.arrivedAt
+
+ for idx, (msg, arrival) in self.received.pairs:
+ if idx <= 1:
+ continue
+ let expectedDelay = nanos(msg.sincePrev)
+
+ ## latency will be 0 if arrived in shorter time than expected
+ var latency = arrival.arrivedAt - arrival.prevArrivedAt - expectedDelay
+
+ ## will not measure zero latency, it is unlikely to happen but in case happens could
+ ## ditort the min latency calulculation as we want to calculate the feasible minimum.
+ if latency > nanos(0):
+ if minLatency == nanos(0):
+ minLatency = latency
+ else:
+ minLatency = min(minLatency, latency)
+
+ maxLatency = max(maxLatency, latency)
+ avgLatency += latency
+
+ avgLatency = avgLatency div (self.receivedMessages - 1)
+ except KeyError:
+ error "Error while calculating latency: " & getCurrentExceptionMsg()
+
+ return (minLatency, maxLatency, avgLatency)
+
+proc missingIndices*(self: Statistics): seq[uint32] =
+ var missing: seq[uint32] = @[]
+ for idx in 1 .. self.helper.maxIndex:
+ if not self.received.hasKey(idx):
+ missing.add(idx)
+ return missing
+
+proc distinctDupCount(self: Statistics): int {.inline.} =
+ return self.helper.duplicates.len()
+
+proc allDuplicates(self: Statistics): int {.inline.} =
+ var total = 0
+ for _, (_, dupCount, _) in self.helper.duplicates.pairs:
+ total += dupCount
+ return total
+
+proc dupMsgs(self: Statistics): string =
+ var dupMsgs: string = ""
+ for idx, (hash, dupCount, size) in self.helper.duplicates.pairs:
+ dupMsgs.add(
+ " index: " & $idx & " | hash: " & hash & " | count: " & $dupCount & " | size: " &
+ $size & "\n"
+ )
+ return dupMsgs
+
+proc echoStat*(self: Statistics, peerId: string) =
+ let (minL, maxL, avgL) = self.calcLatency()
+ lpt_receiver_latencies.set(labelValues = [peerId, "min"], value = minL.nanos())
+ lpt_receiver_latencies.set(labelValues = [peerId, "avg"], value = avgL.nanos())
+ lpt_receiver_latencies.set(labelValues = [peerId, "max"], value = maxL.nanos())
+
+ let printable = catch:
+ """*------------------------------------------------------------------------------------------*
+| Expected | Received | Target | Loss | Misorder | Late | |
+|{self.helper.maxIndex:>11} |{self.receivedMessages:>11} |{self.allMessageCount:>11} |{self.lossCount():>11} |{self.misorderCount:>11} |{self.lateCount:>11} | |
+*------------------------------------------------------------------------------------------*
+| Latency stat: |
+| min latency: {$minL:<73}|
+| avg latency: {$avgL:<73}|
+| max latency: {$maxL:<73}|
+*------------------------------------------------------------------------------------------*
+| Duplicate stat: |
+| distinct duplicate messages: {$self.distinctDupCount():<57}|
+| sum duplicates : {$self.allDuplicates():<57}|
+ Duplicated messages:
+ {self.dupMsgs()}
+*------------------------------------------------------------------------------------------*
+| Lost indices: |
+| {self.missingIndices()} |
+*------------------------------------------------------------------------------------------*""".fmt()
+
+ if printable.isErr():
+ echo "Error while printing statistics: " & printable.error().msg
+ else:
+ echo printable.get()
+
+proc jsonStat*(self: Statistics): string =
+ let minL, maxL, avgL = self.calcLatency()
+
+ let json = catch:
+ """{{"expected":{self.helper.maxIndex},
+ "received": {self.receivedMessages},
+ "target": {self.allMessageCount},
+ "loss": {self.lossCount()},
+ "misorder": {self.misorderCount},
+ "late": {self.lateCount},
+ "duplicate": {self.duplicateCount},
+ "latency":
+ {{"avg": "{avgL}",
+ "min": "{minL}",
+ "max": "{maxL}"
+ }},
+ "lostIndices": {self.missingIndices()}
+ }}""".fmt()
+ if json.isErr:
+ return "{\"result:\": \"" & json.error.msg & "\"}"
+
+ return json.get()
+
+proc echoStats*(self: var PerPeerStatistics) =
+ for peerId, stats in self.pairs:
+ let peerLine = catch:
+ "Receiver statistics from peer {peerId}".fmt()
+ if peerLine.isErr:
+ echo "Error while printing statistics"
+ else:
+ echo peerLine.get()
+ stats.echoStat(peerId)
+
+proc jsonStats*(self: PerPeerStatistics): string =
+ try:
+ #!fmt: off
+ var json = "{\"statistics\": ["
+ var first = true
+ for peerId, stats in self.pairs:
+ if first:
+ first = false
+ else:
+ json.add(", ")
+ json.add("{{\"sender\": \"{peerId}\", \"stat\":".fmt())
+ json.add(stats.jsonStat())
+ json.add("}")
+ json.add("]}")
+ return json
+ #!fmt: on
+ except CatchableError:
+ return
+ "{\"result:\": \"Error while generating json stats: " & getCurrentExceptionMsg() &
+ "\"}"
+
+proc lastMessageArrivedAt*(self: PerPeerStatistics): Option[Moment] =
+ var lastArrivedAt = Moment.init(0, Millisecond)
+ for stat in self.values:
+ let lastMsgFromPeerAt = stat.lastMessageArrivedAt().valueOr:
+ continue
+
+ if lastMsgFromPeerAt > lastArrivedAt:
+ lastArrivedAt = lastMsgFromPeerAt
+
+ if lastArrivedAt == Moment.init(0, Millisecond):
+ return none(Moment)
+
+ return some(lastArrivedAt)
+
+proc checkIfAllMessagesReceived*(
+ self: PerPeerStatistics, maxWaitForLastMessage: Duration
+): Future[bool] {.async.} =
+ # if there are no peers have sent messages, assume we just have started.
+ if self.len == 0:
+ return false
+
+ # check if numerically all messages are received.
+ # this suggest we received at least one message already from one peer
+ var isAlllMessageReceived = true
+ for stat in self.values:
+ if (stat.allMessageCount == 0 and stat.receivedMessages == 0) or
+ stat.helper.maxIndex < stat.allMessageCount:
+ isAlllMessageReceived = false
+ break
+
+ if not isAlllMessageReceived:
+ # if not all message received we still need to check if last message arrived within a time frame
+ # to avoid endless waiting while publishers are already quit.
+ let lastMessageAt = self.lastMessageArrivedAt()
+ if lastMessageAt.isNone():
+ return false
+
+ # last message shall arrived within time limit
+ if Moment.now() - lastMessageAt.get() < maxWaitForLastMessage:
+ return false
+ else:
+ info "No message since max wait time", maxWait = $maxWaitForLastMessage
+
+ ## Ok, we see last message arrived from all peers,
+ ## lets check if all messages are received
+ ## and if not let's wait another 20 secs to give chance the system will send them.
+ var shallWait = false
+ for stat in self.values:
+ if stat.receivedMessages < stat.allMessageCount:
+ shallWait = true
+
+ if shallWait:
+ await sleepAsync(20.seconds)
+
+ return true
diff --git a/third-party/nwaku/apps/liteprotocoltester/tester_config.nim b/third-party/nwaku/apps/liteprotocoltester/tester_config.nim
new file mode 100644
index 0000000..dee918b
--- /dev/null
+++ b/third-party/nwaku/apps/liteprotocoltester/tester_config.nim
@@ -0,0 +1,208 @@
+import
+ results,
+ chronos,
+ confutils,
+ confutils/defs,
+ confutils/std/net,
+ confutils/toml/defs as confTomlDefs,
+ confutils/toml/std/net as confTomlNet,
+ libp2p/crypto/crypto,
+ libp2p/crypto/secp,
+ libp2p/multiaddress,
+ secp256k1
+
+import
+ ../../tools/confutils/
+ [cli_args, envvar as confEnvvarDefs, envvar_net as confEnvvarNet],
+ waku/[common/logging, waku_core, waku_core/topics/pubsub_topic]
+
+export confTomlDefs, confTomlNet, confEnvvarDefs, confEnvvarNet
+
+const
+ LitePubsubTopic* = PubsubTopic("/waku/2/rs/66/0")
+ LiteContentTopic* = ContentTopic("/tester/1/light-pubsub-example/proto")
+ DefaultMinTestMessageSizeStr* = "1KiB"
+ DefaultMaxTestMessageSizeStr* = "150KiB"
+
+type TesterFunctionality* = enum
+ SENDER # pumps messages to the network
+ RECEIVER # gather and analyze messages from the network
+
+type LightpushVersion* = enum
+ LEGACY # legacy lightpush protocol
+ V3 # lightpush v3 protocol
+
+type LiteProtocolTesterConf* = object
+ configFile* {.
+ desc:
+ "Loads configuration from a TOML file (cmd-line parameters take precedence) for the light waku node",
+ name: "config-file"
+ .}: Option[InputFile]
+
+ ## Log configuration
+ logLevel* {.
+ desc:
+ "Sets the log level for process. Supported levels: TRACE, DEBUG, INFO, NOTICE, WARN, ERROR or FATAL",
+ defaultValue: logging.LogLevel.DEBUG,
+ name: "log-level"
+ .}: logging.LogLevel
+
+ logFormat* {.
+ desc:
+ "Specifies what kind of logs should be written to stdout. Supported formats: TEXT, JSON",
+ defaultValue: logging.LogFormat.TEXT,
+ name: "log-format"
+ .}: logging.LogFormat
+
+ ## Test configuration
+ serviceNode* {.
+ desc: "Peer multiaddr of the service node.", defaultValue: "", name: "service-node"
+ .}: string
+
+ bootstrapNode* {.
+ desc:
+ "Peer multiaddr of the bootstrap node. If `service-node` not set, it is used to retrieve potential service nodes of the network.",
+ defaultValue: "",
+ name: "bootstrap-node"
+ .}: string
+
+ nat* {.
+ desc:
+ "Specify method to use for determining public address. " &
+ "Must be one of: any, none, upnp, pmp, extip:.",
+ defaultValue: "any"
+ .}: string
+
+ testFunc* {.
+ desc: "Specifies the lite protocol tester side. Supported values: sender, receiver.",
+ defaultValue: TesterFunctionality.RECEIVER,
+ name: "test-func"
+ .}: TesterFunctionality
+
+ lightpushVersion* {.
+ desc: "Version of the sender to use. Supported values: legacy, v3.",
+ defaultValue: LightpushVersion.LEGACY,
+ name: "lightpush-version"
+ .}: LightpushVersion
+
+ numMessages* {.
+ desc: "Number of messages to send.", defaultValue: 120, name: "num-messages"
+ .}: uint32
+
+ startPublishingAfter* {.
+ desc: "Wait number of seconds before start publishing messages.",
+ defaultValue: 5,
+ name: "start-publishing-after"
+ .}: uint32
+
+ messageInterval* {.
+ desc: "Delay between messages in milliseconds.",
+ defaultValue: 1000,
+ name: "message-interval"
+ .}: uint32
+
+ shard* {.desc: "Shards index to subscribe to. ", defaultValue: 0, name: "shard".}:
+ uint16
+
+ contentTopics* {.
+ desc: "Default content topic to subscribe to. Argument may be repeated.",
+ defaultValue: @[LiteContentTopic],
+ name: "content-topic"
+ .}: seq[ContentTopic]
+
+ clusterId* {.
+ desc:
+ "Cluster id that the node is running in. Node in a different cluster id is disconnected.",
+ defaultValue: 0,
+ name: "cluster-id"
+ .}: uint16
+
+ minTestMessageSize* {.
+ desc:
+ "Minimum message size. Accepted units: KiB, KB, and B. e.g. 1024KiB; 1500 B; etc.",
+ defaultValue: DefaultMinTestMessageSizeStr,
+ name: "min-test-msg-size"
+ .}: string
+
+ maxTestMessageSize* {.
+ desc:
+ "Maximum message size. Accepted units: KiB, KB, and B. e.g. 1024KiB; 1500 B; etc.",
+ defaultValue: DefaultMaxTestMessageSizeStr,
+ name: "max-test-msg-size"
+ .}: string
+ ## Tester REST service configuration
+ restAddress* {.
+ desc: "Listening address of the REST HTTP server.",
+ defaultValue: parseIpAddress("127.0.0.1"),
+ name: "rest-address"
+ .}: IpAddress
+
+ testPeers* {.
+ desc: "Run dial test on gathered PeerExchange peers.",
+ defaultValue: false,
+ name: "test-peers"
+ .}: bool
+
+ reqPxPeers* {.
+ desc: "Number of peers to request on PeerExchange.",
+ defaultValue: 100,
+ name: "req-px-peers"
+ .}: uint16
+
+ restPort* {.
+ desc: "Listening port of the REST HTTP server.",
+ defaultValue: 8654,
+ name: "rest-port"
+ .}: uint16
+
+ fixedServicePeer* {.
+ desc:
+ "Prevent changing the service peer in case of failures, the full test will stict to the first service peer in use.",
+ defaultValue: false,
+ name: "fixed-service-peer"
+ .}: bool
+
+ restAllowOrigin* {.
+ desc:
+ "Allow cross-origin requests from the specified origin." &
+ "Argument may be repeated." & "Wildcards: * or ? allowed." &
+ "Ex.: \"localhost:*\" or \"127.0.0.1:8080\"",
+ defaultValue: @["*"],
+ name: "rest-allow-origin"
+ .}: seq[string]
+
+ metricsPort* {.
+ desc: "Listening port of the Metrics HTTP server.",
+ defaultValue: 8003,
+ name: "metrics-port"
+ .}: uint16
+
+{.push warning[ProveInit]: off.}
+
+proc load*(T: type LiteProtocolTesterConf, version = ""): ConfResult[T] =
+ try:
+ let conf = LiteProtocolTesterConf.load(
+ version = version,
+ secondarySources = proc(
+ conf: LiteProtocolTesterConf, sources: auto
+ ) {.gcsafe, raises: [ConfigurationError].} =
+ sources.addConfigFile(Envvar, InputFile("liteprotocoltester")),
+ )
+ ok(conf)
+ except CatchableError:
+ err(getCurrentExceptionMsg())
+
+proc getPubsubTopic*(conf: LiteProtocolTesterConf): PubsubTopic =
+ return $RelayShard(clusterId: conf.clusterId, shardId: conf.shard)
+
+proc getCodec*(conf: LiteProtocolTesterConf): string =
+ return
+ if conf.testFunc == TesterFunctionality.RECEIVER:
+ WakuFilterSubscribeCodec
+ else:
+ if conf.lightpushVersion == LightpushVersion.LEGACY:
+ WakuLegacyLightPushCodec
+ else:
+ WakuLightPushCodec
+
+{.pop.}
diff --git a/third-party/nwaku/apps/liteprotocoltester/tester_message.nim b/third-party/nwaku/apps/liteprotocoltester/tester_message.nim
new file mode 100644
index 0000000..eeff7b5
--- /dev/null
+++ b/third-party/nwaku/apps/liteprotocoltester/tester_message.nim
@@ -0,0 +1,121 @@
+{.push raises: [].}
+
+import
+ chronicles,
+ json_serialization,
+ json_serialization/std/options,
+ json_serialization/lexer
+
+import ../../waku/waku_api/rest/serdes
+
+type ProtocolTesterMessage* = object
+ sender*: string
+ index*: uint32
+ count*: uint32
+ startedAt*: int64
+ sinceStart*: int64
+ sincePrev*: int64
+ size*: uint64
+
+proc writeValue*(
+ writer: var JsonWriter[RestJson], value: ProtocolTesterMessage
+) {.raises: [IOError].} =
+ writer.beginRecord()
+ writer.writeField("sender", value.sender)
+ writer.writeField("index", value.index)
+ writer.writeField("count", value.count)
+ writer.writeField("startedAt", value.startedAt)
+ writer.writeField("sinceStart", value.sinceStart)
+ writer.writeField("sincePrev", value.sincePrev)
+ writer.writeField("size", value.size)
+ writer.endRecord()
+
+proc readValue*(
+ reader: var JsonReader[RestJson], value: var ProtocolTesterMessage
+) {.gcsafe, raises: [SerializationError, IOError].} =
+ var
+ sender: Option[string]
+ index: Option[uint32]
+ count: Option[uint32]
+ startedAt: Option[int64]
+ sinceStart: Option[int64]
+ sincePrev: Option[int64]
+ size: Option[uint64]
+
+ for fieldName in readObjectFields(reader):
+ case fieldName
+ of "sender":
+ if sender.isSome():
+ reader.raiseUnexpectedField(
+ "Multiple `sender` fields found", "ProtocolTesterMessage"
+ )
+ sender = some(reader.readValue(string))
+ of "index":
+ if index.isSome():
+ reader.raiseUnexpectedField(
+ "Multiple `index` fields found", "ProtocolTesterMessage"
+ )
+ index = some(reader.readValue(uint32))
+ of "count":
+ if count.isSome():
+ reader.raiseUnexpectedField(
+ "Multiple `count` fields found", "ProtocolTesterMessage"
+ )
+ count = some(reader.readValue(uint32))
+ of "startedAt":
+ if startedAt.isSome():
+ reader.raiseUnexpectedField(
+ "Multiple `startedAt` fields found", "ProtocolTesterMessage"
+ )
+ startedAt = some(reader.readValue(int64))
+ of "sinceStart":
+ if sinceStart.isSome():
+ reader.raiseUnexpectedField(
+ "Multiple `sinceStart` fields found", "ProtocolTesterMessage"
+ )
+ sinceStart = some(reader.readValue(int64))
+ of "sincePrev":
+ if sincePrev.isSome():
+ reader.raiseUnexpectedField(
+ "Multiple `sincePrev` fields found", "ProtocolTesterMessage"
+ )
+ sincePrev = some(reader.readValue(int64))
+ of "size":
+ if size.isSome():
+ reader.raiseUnexpectedField(
+ "Multiple `size` fields found", "ProtocolTesterMessage"
+ )
+ size = some(reader.readValue(uint64))
+ else:
+ unrecognizedFieldWarning(value)
+
+ if sender.isNone():
+ reader.raiseUnexpectedValue("Field `sender` is missing")
+
+ if index.isNone():
+ reader.raiseUnexpectedValue("Field `index` is missing")
+
+ if count.isNone():
+ reader.raiseUnexpectedValue("Field `count` is missing")
+
+ if startedAt.isNone():
+ reader.raiseUnexpectedValue("Field `startedAt` is missing")
+
+ if sinceStart.isNone():
+ reader.raiseUnexpectedValue("Field `sinceStart` is missing")
+
+ if sincePrev.isNone():
+ reader.raiseUnexpectedValue("Field `sincePrev` is missing")
+
+ if size.isNone():
+ reader.raiseUnexpectedValue("Field `size` is missing")
+
+ value = ProtocolTesterMessage(
+ sender: sender.get(),
+ index: index.get(),
+ count: count.get(),
+ startedAt: startedAt.get(),
+ sinceStart: sinceStart.get(),
+ sincePrev: sincePrev.get(),
+ size: size.get(),
+ )
diff --git a/third-party/nwaku/apps/liteprotocoltester/v3_publisher.nim b/third-party/nwaku/apps/liteprotocoltester/v3_publisher.nim
new file mode 100644
index 0000000..c8353b5
--- /dev/null
+++ b/third-party/nwaku/apps/liteprotocoltester/v3_publisher.nim
@@ -0,0 +1,29 @@
+import results, options, chronos
+import waku/[waku_node, waku_core, waku_lightpush, waku_lightpush/common]
+import publisher_base
+
+type V3Publisher* = ref object of PublisherBase
+
+proc new*(T: type V3Publisher, wakuNode: WakuNode): T =
+ if isNil(wakuNode.wakuLightpushClient):
+ wakuNode.mountLightPushClient()
+
+ return V3Publisher(wakuNode: wakuNode)
+
+method send*(
+ self: V3Publisher,
+ topic: PubsubTopic,
+ message: WakuMessage,
+ servicePeer: RemotePeerInfo,
+): Future[Result[void, string]] {.async.} =
+ # when error it must return original error desc due the text is used for distinction between error types in metrics.
+ discard (
+ await self.wakuNode.lightpushPublish(some(topic), message, some(servicePeer))
+ ).valueOr:
+ if error.code == LightPushErrorCode.NO_PEERS_TO_RELAY and
+ error.desc != some("No peers for topic, skipping publish"):
+ # TODO: We need better separation of errors happening on the client side or the server side.-
+ return err("dial_failure")
+ else:
+ return err($error.code)
+ return ok()
diff --git a/third-party/nwaku/apps/networkmonitor/README.md b/third-party/nwaku/apps/networkmonitor/README.md
new file mode 100644
index 0000000..3e10367
--- /dev/null
+++ b/third-party/nwaku/apps/networkmonitor/README.md
@@ -0,0 +1,84 @@
+# networkmonitor
+
+Monitoring tool to run in an existing `waku` network with the following features:
+
+* Keeps discovering new peers using `discv5`
+* Tracks advertised capabilities of each node as per stored in the ENR `waku` field
+* Attempts to connect to all nodes, tracking which protocols each node supports
+* Presents grafana-ready metrics showing the state of the network in terms of locations, ips, number discovered peers, number of peers we could connect to, user-agent that each peer contains, content topics and the amount of rx messages in each one.
+* Metrics are exposed through prometheus metrics but also with a custom rest api, presenting detailed information about each peer. These metrics are exposed via a rest api.
+
+## Usage
+
+```console
+./build/networkmonitor --help
+Usage:
+
+networkmonitor [OPTIONS]...
+
+The following options are available:
+
+ -l, --log-level Sets the log level [=LogLevel.INFO].
+ -t, --timeout Timeout to consider that the connection failed [=chronos.seconds(10)].
+ -b, --bootstrap-node Bootstrap ENR node. Argument may be repeated. [=@[""]].
+ --dns-discovery-url URL for DNS node list in format 'enrtree://@'.
+ --pubsub-topic Default pubsub topic to subscribe to. Argument may be repeated..
+ -r, --refresh-interval How often new peers are discovered and connected to (in seconds) [=5].
+ --cluster-id Cluster id that the node is running in. Node in a different cluster id is
+ disconnected. [=1].
+ --rln-relay Enable spam protection through rln-relay: true|false [=true].
+ --rln-relay-dynamic Enable waku-rln-relay with on-chain dynamic group management: true|false
+ [=true].
+ --rln-relay-eth-client-address HTTP address of an Ethereum testnet client e.g., http://localhost:8540/
+ [=http://localhost:8540/].
+ --rln-relay-eth-contract-address Address of membership contract on an Ethereum testnet.
+ --rln-relay-epoch-sec Epoch size in seconds used to rate limit RLN memberships. Default is 1 second.
+ [=1].
+ --rln-relay-user-message-limit Set a user message limit for the rln membership registration. Must be a positive
+ integer. Default is 1. [=1].
+ --metrics-server Enable the metrics server: true|false [=true].
+ --metrics-server-address Listening address of the metrics server. [=parseIpAddress("127.0.0.1")].
+ --metrics-server-port Listening HTTP port of the metrics server. [=8008].
+ --metrics-rest-address Listening address of the metrics rest server. [=127.0.0.1].
+ --metrics-rest-port Listening HTTP port of the metrics rest server. [=8009].
+```
+
+## Example
+
+Connect to the network through a given bootstrap node, with default parameters. See metrics section for the data that it exposes.
+
+```console
+./build/networkmonitor --log-level=INFO --b="enr:-QEkuEB3WHNS-xA3RDpfu9A2Qycr3bN3u7VoArMEiDIFZJ66F1EB3d4wxZN1hcdcOX-RfuXB-MQauhJGQbpz3qUofOtLAYJpZIJ2NIJpcIQI2SVcim11bHRpYWRkcnO4bgA0Ni9ub2RlLTAxLmFjLWNuLWhvbmdrb25nLWMud2FrdS5zYW5kYm94LnN0YXR1cy5pbQZ2XwA2Ni9ub2RlLTAxLmFjLWNuLWhvbmdrb25nLWMud2FrdS5zYW5kYm94LnN0YXR1cy5pbQYfQN4DgnJzkwABCAAAAAEAAgADAAQABQAGAAeJc2VjcDI1NmsxoQPK35Nnz0cWUtSAhBp7zvHEhyU_AqeQUlqzLiLxfP2L4oN0Y3CCdl-DdWRwgiMohXdha3UyDw"
+```
+
+```console
+./build/networkmonitor --log-level=INFO --dns-discovery-url=enrtree://AL65EKLJAUXKKPG43HVTML5EFFWEZ7L4LOKTLZCLJASG4DSESQZEC@prod.status.nodes.status.im
+```
+
+## Metrics
+
+Metrics are divided into two categories:
+
+* Prometheus metrics, exposed as i.e. gauges.
+* Custom metrics, used for unconstrained labels such as peer information or content topics.
+ - These metrics are not exposed through prometheus because since they are unconstrained, they can end up breaking the backend, as a new datapoint is generated for each one and it can reach up a point where is too much to handle.
+
+### Prometheus Metrics
+
+The following metrics are available. See `http://localhost:8008/metrics`
+
+* `peer_type_as_per_enr`: Number of peers supporting each capability according to the ENR (Relay, Store, Lightpush, Filter)
+* `peer_type_as_per_protocol`: Number of peers supporting each protocol, after a successful connection)
+* `peer_user_agents`: List of useragents found in the network and their count
+
+Other relevant metrics reused from `nim-eth`:
+
+* `routing_table_nodes`: Inherited from nim-eth, number of nodes in the routing table
+* `discovery_message_requests_outgoing_total`: Inherited from nim-eth, number of outgoing discovery requests, useful to know if the node is actively looking for new peers
+
+### Custom Metrics
+
+The following endpoints are available:
+
+* `http://localhost:8009/allpeersinfo`: json list of all peers with extra information such as ip, location, supported protocols and last connection time.
+* `http://localhost:8009/contenttopics`: content topic messages and its message count.
diff --git a/third-party/nwaku/apps/networkmonitor/docker-compose.yml b/third-party/nwaku/apps/networkmonitor/docker-compose.yml
new file mode 100644
index 0000000..d7bf661
--- /dev/null
+++ b/third-party/nwaku/apps/networkmonitor/docker-compose.yml
@@ -0,0 +1,34 @@
+version: '3.8'
+networks:
+ monitoring:
+ driver: bridge
+
+volumes:
+ prometheus-data:
+ driver: local
+ grafana-data:
+ driver: local
+
+# Services definitions
+services:
+
+ prometheus:
+ image: docker.io/prom/prometheus:latest
+ container_name: prometheus
+ ports:
+ - 9090:9090
+ command:
+ - '--config.file=/etc/prometheus/prometheus.yaml'
+ volumes:
+ - ./prometheus.yaml:/etc/prometheus/prometheus.yaml:ro
+ - ./data:/prometheus
+ restart: unless-stopped
+
+ grafana:
+ image: grafana/grafana-oss:latest
+ container_name: grafana
+ ports:
+ - '3000:3000'
+ volumes:
+ - grafana-data:/var/lib/grafana
+ restart: unless-stopped
diff --git a/third-party/nwaku/apps/networkmonitor/networkmonitor.nim b/third-party/nwaku/apps/networkmonitor/networkmonitor.nim
new file mode 100644
index 0000000..a9144ae
--- /dev/null
+++ b/third-party/nwaku/apps/networkmonitor/networkmonitor.nim
@@ -0,0 +1,668 @@
+{.push raises: [].}
+
+import
+ std/[net, tables, strutils, times, sequtils, random],
+ results,
+ chronicles,
+ chronicles/topics_registry,
+ chronos,
+ chronos/timer as ctime,
+ confutils,
+ eth/keys,
+ eth/p2p/discoveryv5/enr,
+ libp2p/crypto/crypto,
+ libp2p/nameresolving/dnsresolver,
+ libp2p/protocols/ping,
+ metrics,
+ metrics/chronos_httpserver,
+ presto/[route, server, client]
+import
+ waku/[
+ waku_core,
+ node/peer_manager,
+ waku_node,
+ waku_enr,
+ discovery/waku_discv5,
+ discovery/waku_dnsdisc,
+ waku_relay,
+ waku_rln_relay,
+ factory/builder,
+ factory/networks_config,
+ ],
+ ./networkmonitor_metrics,
+ ./networkmonitor_config,
+ ./networkmonitor_utils
+
+logScope:
+ topics = "networkmonitor"
+
+const ReconnectTime = 60
+const MaxConnectionRetries = 5
+const ResetRetriesAfter = 1200
+const PingSmoothing = 0.3
+const MaxConnectedPeers = 150
+
+const git_version* {.strdefine.} = "n/a"
+
+proc setDiscoveredPeersCapabilities(routingTableNodes: seq[waku_enr.Record]) =
+ for capability in @[Relay, Store, Filter, Lightpush]:
+ let nOfNodesWithCapability =
+ routingTableNodes.countIt(it.supportsCapability(capability))
+ info "capabilities as per ENR waku flag",
+ capability = capability, amount = nOfNodesWithCapability
+ networkmonitor_peer_type_as_per_enr.set(
+ int64(nOfNodesWithCapability), labelValues = [$capability]
+ )
+
+proc setDiscoveredPeersCluster(routingTableNodes: seq[Node]) =
+ var clusters: CountTable[uint16]
+
+ for node in routingTableNodes:
+ let typedRec = node.record.toTyped().valueOr:
+ clusters.inc(0)
+ continue
+
+ let relayShard = typedRec.relaySharding().valueOr:
+ clusters.inc(0)
+ continue
+
+ clusters.inc(relayShard.clusterId)
+
+ for (key, value) in clusters.pairs:
+ networkmonitor_peer_cluster_as_per_enr.set(int64(value), labelValues = [$key])
+
+proc analyzePeer(
+ customPeerInfo: CustomPeerInfoRef,
+ peerInfo: RemotePeerInfo,
+ node: WakuNode,
+ timeout: chronos.Duration,
+): Future[Result[string, string]] {.async.} =
+ var pingDelay: chronos.Duration
+
+ proc ping(): Future[Result[void, string]] {.async, gcsafe.} =
+ try:
+ let conn = await node.switch.dial(peerInfo.peerId, peerInfo.addrs, PingCodec)
+ pingDelay = await node.libp2pPing.ping(conn)
+ return ok()
+ except CatchableError:
+ var msg = getCurrentExceptionMsg()
+ if msg == "Future operation cancelled!":
+ msg = "timedout"
+ warn "failed to ping the peer", peer = peerInfo, err = msg
+
+ customPeerInfo.connError = msg
+ return err("could not ping peer: " & msg)
+
+ let timedOut = not await ping().withTimeout(timeout)
+ # need this check for pingDelat == 0 because there may be a conn error before timeout
+ if timedOut or pingDelay == 0.millis:
+ customPeerInfo.retries += 1
+ return err(customPeerInfo.connError)
+
+ customPeerInfo.connError = ""
+ info "successfully pinged peer", peer = peerInfo, duration = pingDelay.millis
+ networkmonitor_peer_ping.observe(pingDelay.millis)
+
+ # We are using a smoothed moving average
+ customPeerInfo.avgPingDuration =
+ if customPeerInfo.avgPingDuration.millis == 0:
+ pingDelay
+ else:
+ let newAvg =
+ (float64(pingDelay.millis) * PingSmoothing) +
+ float64(customPeerInfo.avgPingDuration.millis) * (1.0 - PingSmoothing)
+
+ int64(newAvg).millis
+
+ customPeerInfo.lastPingDuration = pingDelay
+
+ return ok(customPeerInfo.peerId)
+
+proc shouldReconnect(customPeerInfo: CustomPeerInfoRef): bool =
+ let reconnetIntervalCheck =
+ getTime().toUnix() >= customPeerInfo.lastTimeConnected + ReconnectTime
+ var retriesCheck = customPeerInfo.retries < MaxConnectionRetries
+
+ if not retriesCheck and
+ getTime().toUnix() >= customPeerInfo.lastTimeConnected + ResetRetriesAfter:
+ customPeerInfo.retries = 0
+ retriesCheck = true
+ info "resetting retries counter", peerId = customPeerInfo.peerId
+
+ return reconnetIntervalCheck and retriesCheck
+
+# TODO: Split in discover, connect
+proc setConnectedPeersMetrics(
+ discoveredNodes: seq[waku_enr.Record],
+ node: WakuNode,
+ timeout: chronos.Duration,
+ restClient: RestClientRef,
+ allPeers: CustomPeersTableRef,
+) {.async.} =
+ let currentTime = getTime().toUnix()
+
+ var newPeers = 0
+ var successfulConnections = 0
+
+ var analyzeFuts: seq[Future[Result[string, string]]]
+
+ var (inConns, outConns) = node.peer_manager.connectedPeers(WakuRelayCodec)
+ info "connected peers", inConns = inConns.len, outConns = outConns.len
+
+ shuffle(outConns)
+
+ if outConns.len >= toInt(MaxConnectedPeers / 2):
+ for p in outConns[0 ..< toInt(outConns.len / 2)]:
+ trace "Pruning Peer", Peer = $p
+ asyncSpawn(node.switch.disconnect(p))
+
+ # iterate all newly discovered nodes
+ for discNode in discoveredNodes:
+ let peerRes = toRemotePeerInfo(discNode)
+
+ let peerInfo = peerRes.valueOr:
+ warn "error converting record to remote peer info", record = discNode
+ continue
+
+ # create new entry if new peerId found
+ let peerId = $peerInfo.peerId
+
+ if not allPeers.hasKey(peerId):
+ allPeers[peerId] = CustomPeerInfoRef(peerId: peerId)
+ newPeers += 1
+ else:
+ info "already seen", peerId = peerId
+
+ let customPeerInfo = allPeers[peerId]
+
+ customPeerInfo.lastTimeDiscovered = currentTime
+ customPeerInfo.enr = discNode.toURI()
+ customPeerInfo.enrCapabilities = discNode.getCapabilities().mapIt($it)
+ customPeerInfo.discovered += 1
+
+ for maddr in peerInfo.addrs:
+ if $maddr notin customPeerInfo.maddrs:
+ customPeerInfo.maddrs.add $maddr
+ let typedRecord = discNode.toTypedRecord()
+ if not typedRecord.isOk():
+ warn "could not convert record to typed record", record = discNode
+ continue
+ if not typedRecord.get().ip.isSome():
+ warn "ip field is not set", record = typedRecord.get()
+ continue
+
+ let ip = $typedRecord.get().ip.get().join(".")
+ customPeerInfo.ip = ip
+
+ # try to ping the peer
+ if shouldReconnect(customPeerInfo):
+ if customPeerInfo.retries > 0:
+ warn "trying to dial failed peer again",
+ peerId = peerId, retry = customPeerInfo.retries
+ analyzeFuts.add(analyzePeer(customPeerInfo, peerInfo, node, timeout))
+
+ # Wait for all connection attempts to finish
+ let analyzedPeers = await allFinished(analyzeFuts)
+
+ for peerIdFut in analyzedPeers:
+ let peerIdRes = await peerIdFut
+ let peerIdStr = peerIdRes.valueOr:
+ continue
+
+ successfulConnections += 1
+ let peerId = PeerId.init(peerIdStr).valueOr:
+ warn "failed to parse peerId", peerId = peerIdStr
+ continue
+ var customPeerInfo = allPeers[peerIdStr]
+
+ debug "connected to peer", peer = customPeerInfo[]
+
+ # after connection, get supported protocols
+ let lp2pPeerStore = node.switch.peerStore
+ let nodeProtocols = lp2pPeerStore[ProtoBook][peerId]
+ customPeerInfo.supportedProtocols = nodeProtocols
+ customPeerInfo.lastTimeConnected = currentTime
+
+ # after connection, get user-agent
+ let nodeUserAgent = lp2pPeerStore[AgentBook][peerId]
+ customPeerInfo.userAgent = nodeUserAgent
+
+ info "number of newly discovered peers", amount = newPeers
+ # inform the total connections that we did in this round
+ info "number of successful connections", amount = successfulConnections
+
+proc updateMetrics(allPeersRef: CustomPeersTableRef) {.gcsafe.} =
+ var allProtocols: Table[string, int]
+ var allAgentStrings: Table[string, int]
+ var countries: Table[string, int]
+ var connectedPeers = 0
+ var failedPeers = 0
+
+ for peerInfo in allPeersRef.values:
+ if peerInfo.connError == "":
+ for protocol in peerInfo.supportedProtocols:
+ allProtocols[protocol] = allProtocols.mgetOrPut(protocol, 0) + 1
+
+ # store available user-agents in the network
+ allAgentStrings[peerInfo.userAgent] =
+ allAgentStrings.mgetOrPut(peerInfo.userAgent, 0) + 1
+
+ if peerInfo.country != "":
+ countries[peerInfo.country] = countries.mgetOrPut(peerInfo.country, 0) + 1
+
+ connectedPeers += 1
+ else:
+ failedPeers += 1
+
+ networkmonitor_peer_count.set(int64(connectedPeers), labelValues = ["true"])
+ networkmonitor_peer_count.set(int64(failedPeers), labelValues = ["false"])
+ # update count on each protocol
+ for protocol in allProtocols.keys():
+ let countOfProtocols = allProtocols.mgetOrPut(protocol, 0)
+ networkmonitor_peer_type_as_per_protocol.set(
+ int64(countOfProtocols), labelValues = [protocol]
+ )
+ info "supported protocols in the network",
+ protocol = protocol, count = countOfProtocols
+
+ # update count on each user-agent
+ for userAgent in allAgentStrings.keys():
+ let countOfUserAgent = allAgentStrings.mgetOrPut(userAgent, 0)
+ networkmonitor_peer_user_agents.set(
+ int64(countOfUserAgent), labelValues = [userAgent]
+ )
+ info "user agents participating in the network",
+ userAgent = userAgent, count = countOfUserAgent
+
+ for country in countries.keys():
+ let peerCount = countries.mgetOrPut(country, 0)
+ networkmonitor_peer_country_count.set(int64(peerCount), labelValues = [country])
+ info "number of peers per country", country = country, count = peerCount
+
+proc populateInfoFromIp(
+ allPeersRef: CustomPeersTableRef, restClient: RestClientRef
+) {.async.} =
+ for peer in allPeersRef.keys():
+ if allPeersRef[peer].country != "" and allPeersRef[peer].city != "":
+ continue
+ # TODO: Update also if last update > x
+ if allPeersRef[peer].ip == "":
+ continue
+ # get more info the peers from its ip address
+ var location: NodeLocation
+ try:
+ # IP-API endpoints are now limited to 45 HTTP requests per minute
+ await sleepAsync(1400.millis)
+ let response = await restClient.ipToLocation(allPeersRef[peer].ip)
+ location = response.data
+ except CatchableError:
+ warn "could not get location", ip = allPeersRef[peer].ip
+ continue
+ allPeersRef[peer].country = location.country
+ allPeersRef[peer].city = location.city
+
+# TODO: Split in discovery, connections, and ip2location
+# crawls the network discovering peers and trying to connect to them
+# metrics are processed and exposed
+proc crawlNetwork(
+ node: WakuNode,
+ wakuDiscv5: WakuDiscoveryV5,
+ restClient: RestClientRef,
+ conf: NetworkMonitorConf,
+ allPeersRef: CustomPeersTableRef,
+) {.async.} =
+ let crawlInterval = conf.refreshInterval * 1000
+ while true:
+ let startTime = Moment.now()
+ # discover new random nodes
+ let discoveredNodes = await wakuDiscv5.findRandomPeers()
+
+ # nodes are nested into bucket, flat it
+ let flatNodes = wakuDiscv5.protocol.routingTable.buckets.mapIt(it.nodes).flatten()
+
+ # populate metrics related to capabilities as advertised by the ENR (see waku field)
+ setDiscoveredPeersCapabilities(discoveredNodes)
+
+ # populate cluster metrics as advertised by the ENR
+ setDiscoveredPeersCluster(flatNodes)
+
+ # tries to connect to all newly discovered nodes
+ # and populates metrics related to peers we could connect
+ # note random discovered nodes can be already known
+ await setConnectedPeersMetrics(
+ discoveredNodes, node, conf.timeout, restClient, allPeersRef
+ )
+
+ updateMetrics(allPeersRef)
+
+ # populate info from ip addresses
+ await populateInfoFromIp(allPeersRef, restClient)
+
+ let totalNodes = discoveredNodes.len
+ #let seenNodes = totalNodes
+
+ info "discovered nodes: ", total = totalNodes #, seen = seenNodes
+
+ # Notes:
+ # we dont run ipMajorityLoop
+ # we dont run revalidateLoop
+ let endTime = Moment.now()
+ let elapsed = (endTime - startTime).nanos
+
+ info "crawl duration", time = elapsed.millis
+
+ await sleepAsync(crawlInterval.millis - elapsed.millis)
+
+proc retrieveDynamicBootstrapNodes(
+ dnsDiscoveryUrl: string, dnsAddrsNameServers: seq[IpAddress]
+): Future[Result[seq[RemotePeerInfo], string]] {.async.} =
+ ## Retrieve dynamic bootstrap nodes (DNS discovery)
+
+ if dnsDiscoveryUrl != "":
+ # DNS discovery
+ debug "Discovering nodes using Waku DNS discovery", url = dnsDiscoveryUrl
+
+ var nameServers: seq[TransportAddress]
+ for ip in dnsAddrsNameServers:
+ nameServers.add(initTAddress(ip, Port(53))) # Assume all servers use port 53
+
+ let dnsResolver = DnsResolver.new(nameServers)
+
+ proc resolver(domain: string): Future[string] {.async, gcsafe.} =
+ trace "resolving", domain = domain
+ let resolved = await dnsResolver.resolveTxt(domain)
+ if resolved.len > 0:
+ return resolved[0] # Use only first answer
+
+ var wakuDnsDiscovery = WakuDnsDiscovery.init(dnsDiscoveryUrl, resolver)
+ if wakuDnsDiscovery.isOk():
+ return (await wakuDnsDiscovery.get().findPeers()).mapErr(
+ proc(e: cstring): string =
+ $e
+ )
+ else:
+ warn "Failed to init Waku DNS discovery"
+
+ debug "No method for retrieving dynamic bootstrap nodes specified."
+ ok(newSeq[RemotePeerInfo]()) # Return an empty seq by default
+
+proc getBootstrapFromDiscDns(
+ conf: NetworkMonitorConf
+): Future[Result[seq[enr.Record], string]] {.async.} =
+ try:
+ let dnsNameServers = @[parseIpAddress("1.1.1.1"), parseIpAddress("1.0.0.1")]
+ let dynamicBootstrapNodesRes =
+ await retrieveDynamicBootstrapNodes(conf.dnsDiscoveryUrl, dnsNameServers)
+ if not dynamicBootstrapNodesRes.isOk():
+ error("failed discovering peers from DNS")
+ let dynamicBootstrapNodes = dynamicBootstrapNodesRes.get()
+
+ # select dynamic bootstrap nodes that have an ENR containing a udp port.
+ # Discv5 only supports UDP https://github.com/ethereum/devp2p/blob/master/discv5/discv5-theory.md)
+ var discv5BootstrapEnrs: seq[enr.Record]
+ for n in dynamicBootstrapNodes:
+ if n.enr.isSome():
+ let
+ enr = n.enr.get()
+ tenrRes = enr.toTypedRecord()
+ if tenrRes.isOk() and (
+ tenrRes.get().udp.isSome() or tenrRes.get().udp6.isSome()
+ ):
+ discv5BootstrapEnrs.add(enr)
+ return ok(discv5BootstrapEnrs)
+ except CatchableError:
+ error("failed discovering peers from DNS")
+
+proc initAndStartApp(
+ conf: NetworkMonitorConf
+): Future[Result[(WakuNode, WakuDiscoveryV5), string]] {.async.} =
+ let bindIp =
+ try:
+ parseIpAddress("0.0.0.0")
+ except CatchableError:
+ return err("could not start node: " & getCurrentExceptionMsg())
+
+ let extIp =
+ try:
+ parseIpAddress("127.0.0.1")
+ except CatchableError:
+ return err("could not start node: " & getCurrentExceptionMsg())
+
+ let
+ # some hardcoded parameters
+ rng = keys.newRng()
+ key = crypto.PrivateKey.random(Secp256k1, rng[])[]
+ nodeTcpPort = Port(60000)
+ nodeUdpPort = Port(9000)
+ flags = CapabilitiesBitfield.init(
+ lightpush = false, filter = false, store = false, relay = true
+ )
+
+ var builder = EnrBuilder.init(key)
+
+ builder.withIpAddressAndPorts(
+ ipAddr = some(extIp), tcpPort = some(nodeTcpPort), udpPort = some(nodeUdpPort)
+ )
+ builder.withWakuCapabilities(flags)
+
+ builder.withWakuRelaySharding(
+ RelayShards(clusterId: conf.clusterId, shardIds: conf.shards)
+ ).isOkOr:
+ error "failed to add sharded topics to ENR", error = error
+ return err("failed to add sharded topics to ENR: " & $error)
+
+ let recordRes = builder.build()
+ let record =
+ if recordRes.isErr():
+ return err("cannot build record: " & $recordRes.error)
+ else:
+ recordRes.get()
+
+ var nodeBuilder = WakuNodeBuilder.init()
+
+ nodeBuilder.withNodeKey(key)
+ nodeBuilder.withRecord(record)
+ nodeBuilder.withSwitchConfiguration(maxConnections = some(MaxConnectedPeers))
+
+ nodeBuilder.withPeerManagerConfig(
+ maxConnections = MaxConnectedPeers,
+ relayServiceRatio = "13.33:86.67",
+ shardAware = true,
+ )
+ let res = nodeBuilder.withNetworkConfigurationDetails(bindIp, nodeTcpPort)
+ if res.isErr():
+ return err("node building error" & $res.error)
+
+ let nodeRes = nodeBuilder.build()
+ let node =
+ if nodeRes.isErr():
+ return err("node building error" & $res.error)
+ else:
+ nodeRes.get()
+
+ var discv5BootstrapEnrsRes = await getBootstrapFromDiscDns(conf)
+ if discv5BootstrapEnrsRes.isErr():
+ error("failed discovering peers from DNS")
+ var discv5BootstrapEnrs = discv5BootstrapEnrsRes.get()
+
+ # parse enrURIs from the configuration and add the resulting ENRs to the discv5BootstrapEnrs seq
+ for enrUri in conf.bootstrapNodes:
+ addBootstrapNode(enrUri, discv5BootstrapEnrs)
+
+ # discv5
+ let discv5Conf = WakuDiscoveryV5Config(
+ discv5Config: none(DiscoveryConfig),
+ address: bindIp,
+ port: nodeUdpPort,
+ privateKey: keys.PrivateKey(key.skkey),
+ bootstrapRecords: discv5BootstrapEnrs,
+ autoupdateRecord: false,
+ )
+
+ let wakuDiscv5 = WakuDiscoveryV5.new(node.rng, discv5Conf, some(record))
+
+ try:
+ wakuDiscv5.protocol.open()
+ except CatchableError:
+ return err("could not start node: " & getCurrentExceptionMsg())
+
+ ok((node, wakuDiscv5))
+
+proc startRestApiServer(
+ conf: NetworkMonitorConf,
+ allPeersInfo: CustomPeersTableRef,
+ numMessagesPerContentTopic: ContentTopicMessageTableRef,
+): Result[void, string] =
+ try:
+ let serverAddress =
+ initTAddress(conf.metricsRestAddress & ":" & $conf.metricsRestPort)
+ proc validate(pattern: string, value: string): int =
+ if pattern.startsWith("{") and pattern.endsWith("}"): 0 else: 1
+
+ var router = RestRouter.init(validate)
+ router.installHandler(allPeersInfo, numMessagesPerContentTopic)
+ var sres = RestServerRef.new(router, serverAddress)
+ let restServer = sres.get()
+ restServer.start()
+ except CatchableError:
+ error("could not start rest api server")
+ ok()
+
+# handles rx of messages over a topic (see subscribe)
+# counts the number of messages per content topic
+proc subscribeAndHandleMessages(
+ node: WakuNode,
+ pubsubTopic: PubsubTopic,
+ msgPerContentTopic: ContentTopicMessageTableRef,
+) =
+ # handle function
+ proc handler(
+ pubsubTopic: PubsubTopic, msg: WakuMessage
+ ): Future[void] {.async, gcsafe.} =
+ trace "rx message", pubsubTopic = pubsubTopic, contentTopic = msg.contentTopic
+
+ # If we reach a table limit size, remove c topics with the least messages.
+ let tableSize = 100
+ if msgPerContentTopic.len > (tableSize - 1):
+ let minIndex = toSeq(msgPerContentTopic.values()).minIndex()
+ msgPerContentTopic.del(toSeq(msgPerContentTopic.keys())[minIndex])
+
+ # TODO: Will overflow at some point
+ # +1 if content topic existed, init to 1 otherwise
+ if msgPerContentTopic.hasKey(msg.contentTopic):
+ msgPerContentTopic[msg.contentTopic] += 1
+ else:
+ msgPerContentTopic[msg.contentTopic] = 1
+
+ node.subscribe((kind: PubsubSub, topic: pubsubTopic), WakuRelayHandler(handler)).isOkOr:
+ error "failed to subscribe to pubsub topic", pubsubTopic, error
+ quit(1)
+
+when isMainModule:
+ # known issue: confutils.nim(775, 17) Error: can raise an unlisted exception: ref IOError
+ {.pop.}
+ let confRes = NetworkMonitorConf.loadConfig()
+ if confRes.isErr():
+ error "could not load cli variables", err = confRes.error
+ quit(1)
+
+ var conf = confRes.get()
+ info "cli flags", conf = conf
+
+ if conf.clusterId == 1:
+ let twnNetworkConf = NetworkConf.TheWakuNetworkConf()
+
+ conf.bootstrapNodes = twnNetworkConf.discv5BootstrapNodes
+ conf.rlnRelayDynamic = twnNetworkConf.rlnRelayDynamic
+ conf.rlnRelayEthContractAddress = twnNetworkConf.rlnRelayEthContractAddress
+ conf.rlnEpochSizeSec = twnNetworkConf.rlnEpochSizeSec
+ conf.rlnRelayUserMessageLimit = twnNetworkConf.rlnRelayUserMessageLimit
+ conf.numShardsInNetwork = twnNetworkConf.shardingConf.numShardsInCluster
+
+ if conf.shards.len == 0:
+ conf.shards =
+ toSeq(uint16(0) .. uint16(twnNetworkConf.shardingConf.numShardsInCluster - 1))
+
+ if conf.logLevel != LogLevel.NONE:
+ setLogLevel(conf.logLevel)
+
+ # list of peers that we have discovered/connected
+ var allPeersInfo = CustomPeersTableRef()
+
+ # content topic and the number of messages that were received
+ var msgPerContentTopic = ContentTopicMessageTableRef()
+
+ # start metrics server
+ if conf.metricsServer:
+ let res =
+ startMetricsServer(conf.metricsServerAddress, Port(conf.metricsServerPort))
+ if res.isErr():
+ error "could not start metrics server", err = res.error
+ quit(1)
+
+ # start rest server for custom metrics
+ let res = startRestApiServer(conf, allPeersInfo, msgPerContentTopic)
+ if res.isErr():
+ error "could not start rest api server", err = res.error
+ quit(1)
+
+ # create a rest client
+ let clientRest =
+ RestClientRef.new(url = "http://ip-api.com", connectTimeout = ctime.seconds(2))
+ if clientRest.isErr():
+ error "could not start rest api client", err = res.error
+ quit(1)
+ let restClient = clientRest.get()
+
+ # start waku node
+ let nodeRes = waitFor initAndStartApp(conf)
+ if nodeRes.isErr():
+ error "could not start node"
+ quit 1
+
+ let (node, discv5) = nodeRes.get()
+
+ (waitFor node.mountRelay()).isOkOr:
+ error "failed to mount waku relay protocol: ", err = error
+ quit 1
+
+ waitFor node.mountLibp2pPing()
+
+ var onFatalErrorAction = proc(msg: string) {.gcsafe, closure.} =
+ ## Action to be taken when an internal error occurs during the node run.
+ ## e.g. the connection with the database is lost and not recovered.
+ error "Unrecoverable error occurred", error = msg
+ quit(QuitFailure)
+
+ if conf.rlnRelay and conf.rlnRelayEthContractAddress != "":
+ let rlnConf = WakuRlnConfig(
+ dynamic: conf.rlnRelayDynamic,
+ credIndex: some(uint(0)),
+ ethContractAddress: conf.rlnRelayEthContractAddress,
+ ethClientUrls: conf.ethClientUrls.mapIt(string(it)),
+ epochSizeSec: conf.rlnEpochSizeSec,
+ creds: none(RlnRelayCreds),
+ onFatalErrorAction: onFatalErrorAction,
+ )
+
+ try:
+ waitFor node.mountRlnRelay(rlnConf)
+ except CatchableError:
+ error "failed to setup RLN", err = getCurrentExceptionMsg()
+ quit 1
+
+ node.mountMetadata(conf.clusterId, conf.shards).isOkOr:
+ error "failed to mount waku metadata protocol: ", err = error
+ quit 1
+
+ for shard in conf.shards:
+ # Subscribe the node to the shards, to count messages
+ subscribeAndHandleMessages(
+ node, $RelayShard(shardId: shard, clusterId: conf.clusterId), msgPerContentTopic
+ )
+
+ # spawn the routine that crawls the network
+ # TODO: split into 3 routines (discovery, connections, ip2location)
+ asyncSpawn crawlNetwork(node, discv5, restClient, conf, allPeersInfo)
+
+ runForever()
diff --git a/third-party/nwaku/apps/networkmonitor/networkmonitor_config.nim b/third-party/nwaku/apps/networkmonitor/networkmonitor_config.nim
new file mode 100644
index 0000000..f67fb09
--- /dev/null
+++ b/third-party/nwaku/apps/networkmonitor/networkmonitor_config.nim
@@ -0,0 +1,190 @@
+import
+ chronicles,
+ chronicles/topics_registry,
+ confutils,
+ chronos,
+ std/strutils,
+ results,
+ regex
+
+const git_version* {.strdefine.} = "n/a"
+
+type EthRpcUrl* = distinct string
+
+proc `$`*(u: EthRpcUrl): string =
+ string(u)
+
+type NetworkMonitorConf* = object
+ logLevel* {.
+ desc: "Sets the log level",
+ defaultValue: LogLevel.INFO,
+ name: "log-level",
+ abbr: "l"
+ .}: LogLevel
+
+ timeout* {.
+ desc: "Timeout to consider that the connection failed",
+ defaultValue: chronos.seconds(10),
+ name: "timeout",
+ abbr: "t"
+ .}: chronos.Duration
+
+ bootstrapNodes* {.
+ desc: "Bootstrap ENR node. Argument may be repeated.",
+ defaultValue: @[""],
+ name: "bootstrap-node",
+ abbr: "b"
+ .}: seq[string]
+
+ dnsDiscoveryUrl* {.
+ desc: "URL for DNS node list in format 'enrtree://@'",
+ defaultValue: "",
+ name: "dns-discovery-url"
+ .}: string
+
+ shards* {.
+ desc:
+ "Shards index to subscribe to [0..NUM_SHARDS_IN_NETWORK-1]. Argument may be repeated.",
+ name: "shard"
+ .}: seq[uint16]
+
+ numShardsInNetwork* {.
+ desc: "Number of shards in the network",
+ name: "num-shards-in-network",
+ defaultValue: 8
+ .}: uint32
+
+ refreshInterval* {.
+ desc: "How often new peers are discovered and connected to (in seconds)",
+ defaultValue: 5,
+ name: "refresh-interval",
+ abbr: "r"
+ .}: int
+
+ clusterId* {.
+ desc:
+ "Cluster id that the node is running in. Node in a different cluster id is disconnected.",
+ defaultValue: 1,
+ name: "cluster-id"
+ .}: uint16
+
+ rlnRelay* {.
+ desc: "Enable spam protection through rln-relay: true|false",
+ defaultValue: true,
+ name: "rln-relay"
+ .}: bool
+
+ rlnRelayDynamic* {.
+ desc: "Enable waku-rln-relay with on-chain dynamic group management: true|false",
+ defaultValue: true,
+ name: "rln-relay-dynamic"
+ .}: bool
+
+ ethClientUrls* {.
+ desc:
+ "HTTP address of an Ethereum testnet client e.g., http://localhost:8540/. Argument may be repeated.",
+ defaultValue: newSeq[EthRpcUrl](0),
+ name: "rln-relay-eth-client-address"
+ .}: seq[EthRpcUrl]
+
+ rlnRelayEthContractAddress* {.
+ desc: "Address of membership contract on an Ethereum testnet",
+ defaultValue: "",
+ name: "rln-relay-eth-contract-address"
+ .}: string
+
+ rlnEpochSizeSec* {.
+ desc:
+ "Epoch size in seconds used to rate limit RLN memberships. Default is 1 second.",
+ defaultValue: 1,
+ name: "rln-relay-epoch-sec"
+ .}: uint64
+
+ rlnRelayUserMessageLimit* {.
+ desc:
+ "Set a user message limit for the rln membership registration. Must be a positive integer. Default is 1.",
+ defaultValue: 1,
+ name: "rln-relay-user-message-limit"
+ .}: uint64
+
+ ## Prometheus metrics config
+ metricsServer* {.
+ desc: "Enable the metrics server: true|false",
+ defaultValue: true,
+ name: "metrics-server"
+ .}: bool
+
+ metricsServerAddress* {.
+ desc: "Listening address of the metrics server.",
+ defaultValue: parseIpAddress("127.0.0.1"),
+ name: "metrics-server-address"
+ .}: IpAddress
+
+ metricsServerPort* {.
+ desc: "Listening HTTP port of the metrics server.",
+ defaultValue: 8008,
+ name: "metrics-server-port"
+ .}: uint16
+
+ ## Custom metrics rest server
+ metricsRestAddress* {.
+ desc: "Listening address of the metrics rest server.",
+ defaultValue: "127.0.0.1",
+ name: "metrics-rest-address"
+ .}: string
+ metricsRestPort* {.
+ desc: "Listening HTTP port of the metrics rest server.",
+ defaultValue: 8009,
+ name: "metrics-rest-port"
+ .}: uint16
+
+proc parseCmdArg*(T: type IpAddress, p: string): T =
+ try:
+ result = parseIpAddress(p)
+ except CatchableError as e:
+ raise newException(ValueError, "Invalid IP address")
+
+proc completeCmdArg*(T: type IpAddress, val: string): seq[string] =
+ return @[]
+
+proc parseCmdArg*(T: type chronos.Duration, p: string): T =
+ try:
+ result = chronos.seconds(parseInt(p))
+ except CatchableError as e:
+ raise newException(ValueError, "Invalid duration value")
+
+proc completeCmdArg*(T: type chronos.Duration, val: string): seq[string] =
+ return @[]
+
+proc completeCmdArg*(T: type EthRpcUrl, val: string): seq[string] =
+ return @[]
+
+proc parseCmdArg*(T: type EthRpcUrl, s: string): T =
+ ## allowed patterns:
+ ## http://url:port
+ ## https://url:port
+ ## http://url:port/path
+ ## https://url:port/path
+ ## http://url/with/path
+ ## http://url:port/path?query
+ ## https://url:port/path?query
+ ## disallowed patterns:
+ ## any valid/invalid ws or wss url
+ var httpPattern =
+ re2"^(https?):\/\/((localhost)|([\w_-]+(?:(?:\.[\w_-]+)+)))(:[0-9]{1,5})?([\w.,@?^=%&:\/~+#-]*[\w@?^=%&\/~+#-])*"
+ var wsPattern =
+ re2"^(wss?):\/\/((localhost)|([\w_-]+(?:(?:\.[\w_-]+)+)))(:[0-9]{1,5})?([\w.,@?^=%&:\/~+#-]*[\w@?^=%&\/~+#-])*"
+ if regex.match(s, wsPattern):
+ raise newException(
+ ValueError, "Websocket RPC URL is not supported, Please use an HTTP URL"
+ )
+ if not regex.match(s, httpPattern):
+ raise newException(ValueError, "Invalid HTTP RPC URL")
+ return EthRpcUrl(s)
+
+proc loadConfig*(T: type NetworkMonitorConf): Result[T, string] =
+ try:
+ let conf = NetworkMonitorConf.load(version = git_version)
+ ok(conf)
+ except CatchableError:
+ err(getCurrentExceptionMsg())
diff --git a/third-party/nwaku/apps/networkmonitor/networkmonitor_metrics.nim b/third-party/nwaku/apps/networkmonitor/networkmonitor_metrics.nim
new file mode 100644
index 0000000..dda3e57
--- /dev/null
+++ b/third-party/nwaku/apps/networkmonitor/networkmonitor_metrics.nim
@@ -0,0 +1,107 @@
+{.push raises: [].}
+
+import
+ std/[net, json, tables, sequtils],
+ chronicles,
+ chronicles/topics_registry,
+ chronos,
+ json_serialization,
+ metrics,
+ metrics/chronos_httpserver,
+ presto/route,
+ presto/server,
+ results
+
+logScope:
+ topics = "networkmonitor_metrics"
+
+# On top of our custom metrics, the following are reused from nim-eth
+#routing_table_nodes{state=""}
+#routing_table_nodes{state="seen"}
+#discovery_message_requests_outgoing_total{response=""}
+#discovery_message_requests_outgoing_total{response="no_response"}
+
+declarePublicGauge networkmonitor_peer_type_as_per_enr,
+ "Number of peers supporting each capability according to the ENR",
+ labels = ["capability"]
+
+declarePublicGauge networkmonitor_peer_cluster_as_per_enr,
+ "Number of peers on each cluster according to the ENR", labels = ["cluster"]
+
+declarePublicGauge networkmonitor_peer_type_as_per_protocol,
+ "Number of peers supporting each protocol, after a successful connection) ",
+ labels = ["protocols"]
+
+declarePublicGauge networkmonitor_peer_user_agents,
+ "Number of peers with each user agent", labels = ["user_agent"]
+
+declarePublicHistogram networkmonitor_peer_ping,
+ "Histogram tracking ping durations for discovered peers",
+ buckets = [10.0, 20.0, 50.0, 100.0, 200.0, 300.0, 500.0, 800.0, 1000.0, 2000.0, Inf]
+
+declarePublicGauge networkmonitor_peer_count,
+ "Number of discovered peers", labels = ["connected"]
+
+declarePublicGauge networkmonitor_peer_country_count,
+ "Number of peers per country", labels = ["country"]
+
+type
+ CustomPeerInfo* = object # populated after discovery
+ lastTimeDiscovered*: int64
+ discovered*: int64
+ peerId*: string
+ enr*: string
+ ip*: string
+ enrCapabilities*: seq[string]
+ country*: string
+ city*: string
+ maddrs*: seq[string]
+
+ # only after ok connection
+ lastTimeConnected*: int64
+ retries*: int64
+ supportedProtocols*: seq[string]
+ userAgent*: string
+ lastPingDuration*: Duration
+ avgPingDuration*: Duration
+
+ # only after a ok/nok connection
+ connError*: string
+
+ CustomPeerInfoRef* = ref CustomPeerInfo
+
+ # Stores information about all discovered/connected peers
+ CustomPeersTableRef* = TableRef[string, CustomPeerInfoRef]
+
+ # stores the content topic and the count of rx messages
+ ContentTopicMessageTableRef* = TableRef[string, int]
+
+proc installHandler*(
+ router: var RestRouter,
+ allPeers: CustomPeersTableRef,
+ numMessagesPerContentTopic: ContentTopicMessageTableRef,
+) =
+ router.api(MethodGet, "/allpeersinfo") do() -> RestApiResponse:
+ let values = toSeq(allPeers.values())
+ return RestApiResponse.response(values.toJson(), contentType = "application/json")
+ router.api(MethodGet, "/contenttopics") do() -> RestApiResponse:
+ # TODO: toJson() includes the hash
+ return RestApiResponse.response(
+ $(%numMessagesPerContentTopic), contentType = "application/json"
+ )
+
+proc startMetricsServer*(serverIp: IpAddress, serverPort: Port): Result[void, string] =
+ info "Starting metrics HTTP server", serverIp, serverPort
+
+ try:
+ startMetricsHttpServer($serverIp, serverPort)
+ except Exception as e:
+ error(
+ "Failed to start metrics HTTP server",
+ serverIp = serverIp,
+ serverPort = serverPort,
+ msg = e.msg,
+ )
+
+ info "Metrics HTTP server started", serverIp, serverPort
+ ok()
diff --git a/third-party/nwaku/apps/networkmonitor/networkmonitor_utils.nim b/third-party/nwaku/apps/networkmonitor/networkmonitor_utils.nim
new file mode 100644
index 0000000..0e89c4a
--- /dev/null
+++ b/third-party/nwaku/apps/networkmonitor/networkmonitor_utils.nim
@@ -0,0 +1,53 @@
+{.push raises: [].}
+
+import
+ std/json,
+ results,
+ chronicles,
+ chronicles/topics_registry,
+ chronos,
+ presto/[client, common]
+
+type NodeLocation* = object
+ country*: string
+ city*: string
+ lat*: string
+ long*: string
+ isp*: string
+
+proc flatten*[T](a: seq[seq[T]]): seq[T] =
+ var aFlat = newSeq[T](0)
+ for subseq in a:
+ aFlat &= subseq
+ return aFlat
+
+proc decodeBytes*(
+ t: typedesc[NodeLocation], value: openArray[byte], contentType: Opt[ContentTypeData]
+): RestResult[NodeLocation] =
+ var res: string
+ if len(value) > 0:
+ res = newString(len(value))
+ copyMem(addr res[0], unsafeAddr value[0], len(value))
+ try:
+ let jsonContent = parseJson(res)
+ if $jsonContent["status"].getStr() != "success":
+ error "query failed", result = $jsonContent
+ return err("query failed")
+ return ok(
+ NodeLocation(
+ country: jsonContent["country"].getStr(),
+ city: jsonContent["city"].getStr(),
+ lat: $jsonContent["lat"].getFloat(),
+ long: $jsonContent["lon"].getFloat(),
+ isp: jsonContent["isp"].getStr(),
+ )
+ )
+ except Exception:
+ return err("failed to get the location: " & getCurrentExceptionMsg())
+
+proc encodeString*(value: string): RestResult[string] =
+ ok(value)
+
+proc ipToLocation*(
+ ip: string
+): RestResponse[NodeLocation] {.rest, endpoint: "json/{ip}", meth: MethodGet.}
diff --git a/third-party/nwaku/apps/networkmonitor/nim.cfg b/third-party/nwaku/apps/networkmonitor/nim.cfg
new file mode 100644
index 0000000..2231f2e
--- /dev/null
+++ b/third-party/nwaku/apps/networkmonitor/nim.cfg
@@ -0,0 +1,4 @@
+-d:chronicles_line_numbers
+-d:chronicles_runtime_filtering:on
+-d:discv5_protocol_id:d5waku
+path = "../.."
diff --git a/third-party/nwaku/apps/networkmonitor/prometheus.yaml b/third-party/nwaku/apps/networkmonitor/prometheus.yaml
new file mode 100644
index 0000000..c7af03f
--- /dev/null
+++ b/third-party/nwaku/apps/networkmonitor/prometheus.yaml
@@ -0,0 +1,9 @@
+global:
+ scrape_interval: 15s
+
+scrape_configs:
+ - job_name: 'prometheus'
+ scrape_interval: 5s
+ static_configs:
+ - targets: ['host.docker.internal:8008']
+ metrics_path: '/metrics'
\ No newline at end of file
diff --git a/third-party/nwaku/apps/sonda/.env.example b/third-party/nwaku/apps/sonda/.env.example
new file mode 100644
index 0000000..ea769b3
--- /dev/null
+++ b/third-party/nwaku/apps/sonda/.env.example
@@ -0,0 +1,44 @@
+# RPC URL for accessing testnet via HTTP.
+# e.g. https://linea-sepolia.infura.io/v3/123aa110320f4aec179150fba1e1b1b1
+RLN_RELAY_ETH_CLIENT_ADDRESS=
+
+# Account of testnet where you have Linea Sepolia ETH that would be staked into RLN contract.
+ETH_TESTNET_ACCOUNT=
+
+# Private key of testnet where you have Linea Sepolia ETH that would be staked into RLN contract.
+# Note: make sure you don't use the '0x' prefix.
+# e.g. 0116196e9a8abed42dd1a22eb63fa2a5a17b0c27d716b87ded2c54f1bf192a0b
+ETH_TESTNET_KEY=
+
+# Address of the RLN contract on Linea Sepolia.
+RLN_CONTRACT_ADDRESS=0xB9cd878C90E49F797B4431fBF4fb333108CB90e6
+# Address of the RLN Membership Token contract on Linea Sepolia used to pay for membership.
+TOKEN_CONTRACT_ADDRESS=0x185A0015aC462a0aECb81beCc0497b649a64B9ea
+
+# Password you would like to use to protect your RLN membership.
+RLN_RELAY_CRED_PASSWORD=
+
+# Advanced. Can be left empty in normal use cases.
+NWAKU_IMAGE=
+NODEKEY=
+DOMAIN=
+EXTRA_ARGS=
+STORAGE_SIZE=
+
+
+# -------------------- SONDA CONFIG ------------------
+METRICS_PORT=8004
+NODE_REST_ADDRESS="http://nwaku:8645"
+CLUSTER_ID=16
+SHARD=32
+# Comma separated list of store nodes to poll
+STORE_NODES="/dns4/store-01.do-ams3.shards.test.status.im/tcp/30303/p2p/16Uiu2HAmAUdrQ3uwzuE4Gy4D56hX6uLKEeerJAnhKEHZ3DxF1EfT,
+/dns4/store-02.do-ams3.shards.test.status.im/tcp/30303/p2p/16Uiu2HAm9aDJPkhGxc2SFcEACTFdZ91Q5TJjp76qZEhq9iF59x7R,
+/dns4/store-01.gc-us-central1-a.shards.test.status.im/tcp/30303/p2p/16Uiu2HAmMELCo218hncCtTvC2Dwbej3rbyHQcR8erXNnKGei7WPZ,
+/dns4/store-02.gc-us-central1-a.shards.test.status.im/tcp/30303/p2p/16Uiu2HAmJnVR7ZzFaYvciPVafUXuYGLHPzSUigqAmeNw9nJUVGeM,
+/dns4/store-01.ac-cn-hongkong-c.shards.test.status.im/tcp/30303/p2p/16Uiu2HAm2M7xs7cLPc3jamawkEqbr7cUJX11uvY7LxQ6WFUdUKUT,
+/dns4/store-02.ac-cn-hongkong-c.shards.test.status.im/tcp/30303/p2p/16Uiu2HAm9CQhsuwPR54q27kNj9iaQVfyRzTGKrhFmr94oD8ujU6P"
+# Wait time in seconds between two consecutive queries
+QUERY_DELAY=60
+# Consecutive successful store requests to consider a store node healthy
+HEALTH_THRESHOLD=5
\ No newline at end of file
diff --git a/third-party/nwaku/apps/sonda/.gitignore b/third-party/nwaku/apps/sonda/.gitignore
new file mode 100644
index 0000000..f366b94
--- /dev/null
+++ b/third-party/nwaku/apps/sonda/.gitignore
@@ -0,0 +1,4 @@
+.env
+keystore
+rln_tree
+.env
diff --git a/third-party/nwaku/apps/sonda/Dockerfile.sonda b/third-party/nwaku/apps/sonda/Dockerfile.sonda
new file mode 100644
index 0000000..0e5a606
--- /dev/null
+++ b/third-party/nwaku/apps/sonda/Dockerfile.sonda
@@ -0,0 +1,23 @@
+FROM python:3.9.18-alpine3.18
+
+ENV METRICS_PORT=8004
+ENV NODE_REST_ADDRESS="http://nwaku:8645"
+ENV QUERY_DELAY=60
+ENV STORE_NODES=""
+ENV CLUSTER_ID=1
+ENV SHARD=1
+ENV HEALTH_THRESHOLD=5
+
+WORKDIR /opt
+
+COPY sonda.py /opt/sonda.py
+
+RUN pip install requests argparse prometheus_client
+
+CMD python -u /opt/sonda.py \
+ --metrics-port=$METRICS_PORT \
+ --node-rest-address="${NODE_REST_ADDRESS}" \
+ --delay-seconds=$QUERY_DELAY \
+ --pubsub-topic="/waku/2/rs/${CLUSTER_ID}/${SHARD}" \
+ --store-nodes="${STORE_NODES}" \
+ --health-threshold=$HEALTH_THRESHOLD
diff --git a/third-party/nwaku/apps/sonda/README.md b/third-party/nwaku/apps/sonda/README.md
new file mode 100644
index 0000000..459f6fe
--- /dev/null
+++ b/third-party/nwaku/apps/sonda/README.md
@@ -0,0 +1,52 @@
+# Sonda
+
+Sonda is a tool to monitor store nodes and measure their performance.
+
+It works by running a `nwaku` node, publishing a message from it every fixed interval and performing a store query to all the store nodes we want to monitor to check they respond with the last message we published.
+
+## Instructions
+
+1. Create an `.env` file which will contain the configuration parameters.
+ You can start by copying `.env.example` and adapting it for your use case
+
+ ```
+ cp .env.example .env
+ ${EDITOR} .env
+ ```
+
+ The variables that have to be filled for Sonda are
+
+ ```
+ CLUSTER_ID=
+ SHARD=
+ # Comma separated list of store nodes to poll
+ STORE_NODES=
+ # Wait time in seconds between two consecutive queries
+ QUERY_DELAY=
+ # Consecutive successful store requests to consider a store node healthy
+ HEALTH_THRESHOLD=
+ ```
+
+2. If you want to query nodes in `cluster-id` 1, then you have to follow the steps of registering an RLN membership. Otherwise, you can skip this step.
+
+ For it, you need:
+ * Ethereum Linea Sepolia WebSocket endpoint. Get one free from [Infura](https://linea-sepolia.infura.io/).
+ * Ethereum Linea Sepolia account with minimum 0.01ETH. Get some [here](https://docs.metamask.io/developer-tools/faucet/).
+ * A password to protect your rln membership.
+
+ Fill the `RLN_RELAY_ETH_CLIENT_ADDRESS`, `ETH_TESTNET_KEY` and `RLN_RELAY_CRED_PASSWORD` env variables and run
+
+ ```
+ ./register_rln.sh
+ ```
+
+3. Start Sonda by running
+
+ ```
+ docker-compose up -d
+ ```
+
+4. Browse to http://localhost:3000/dashboards and monitor the performance
+
+ There's two Grafana dashboards: `nwaku-monitoring` to track the stats of your node that is publishing messages and performing queries, and `sonda-monitoring` to monitor the responses of the store nodes.
+
diff --git a/third-party/nwaku/apps/sonda/docker-compose.yml b/third-party/nwaku/apps/sonda/docker-compose.yml
new file mode 100644
index 0000000..d659442
--- /dev/null
+++ b/third-party/nwaku/apps/sonda/docker-compose.yml
@@ -0,0 +1,114 @@
+
+x-logging: &logging
+ logging:
+ driver: json-file
+ options:
+ max-size: 1000m
+
+# Environment variable definitions
+x-rln-relay-eth-client-address: &rln_relay_eth_client_address ${RLN_RELAY_ETH_CLIENT_ADDRESS:-} # Add your RLN_RELAY_ETH_CLIENT_ADDRESS after the "-"
+
+x-rln-environment: &rln_env
+ RLN_RELAY_CONTRACT_ADDRESS: ${RLN_RELAY_CONTRACT_ADDRESS:-0xB9cd878C90E49F797B4431fBF4fb333108CB90e6}
+ RLN_RELAY_CRED_PATH: ${RLN_RELAY_CRED_PATH:-} # Optional: Add your RLN_RELAY_CRED_PATH after the "-"
+ RLN_RELAY_CRED_PASSWORD: ${RLN_RELAY_CRED_PASSWORD:-} # Optional: Add your RLN_RELAY_CRED_PASSWORD after the "-"
+
+x-sonda-env: &sonda_env
+ METRICS_PORT: ${METRICS_PORT:-8004}
+ NODE_REST_ADDRESS: ${NODE_REST_ADDRESS:-"http://nwaku:8645"}
+ CLUSTER_ID: ${CLUSTER_ID:-1}
+ SHARD: ${SHARD:-0}
+ STORE_NODES: ${STORE_NODES:-}
+ QUERY_DELAY: ${QUERY_DELAY-60}
+ HEALTH_THRESHOLD: ${HEALTH_THRESHOLD-5}
+
+# Services definitions
+services:
+ nwaku:
+ image: ${NWAKU_IMAGE:-harbor.status.im/wakuorg/nwaku:deploy-status-prod}
+ container_name: nwaku
+ restart: on-failure
+ ports:
+ - 30304:30304/tcp
+ - 30304:30304/udp
+ - 9005:9005/udp
+ - 127.0.0.1:8003:8003
+ - 80:80 #Let's Encrypt
+ - 8000:8000/tcp #WSS
+ - 127.0.0.1:8645:8645
+ <<:
+ - *logging
+ environment:
+ DOMAIN: ${DOMAIN}
+ NODEKEY: ${NODEKEY}
+ RLN_RELAY_CRED_PASSWORD: "${RLN_RELAY_CRED_PASSWORD}"
+ RLN_RELAY_ETH_CLIENT_ADDRESS: *rln_relay_eth_client_address
+ EXTRA_ARGS: ${EXTRA_ARGS}
+ STORAGE_SIZE: ${STORAGE_SIZE}
+ <<:
+ - *rln_env
+ - *sonda_env
+ volumes:
+ - ./run_node.sh:/opt/run_node.sh:Z
+ - ${CERTS_DIR:-./certs}:/etc/letsencrypt/:Z
+ - ./rln_tree:/etc/rln_tree/:Z
+ - ./keystore:/keystore:Z
+ entrypoint: sh
+ command:
+ - /opt/run_node.sh
+ networks:
+ - nwaku-sonda
+
+ sonda:
+ build:
+ context: .
+ dockerfile: Dockerfile.sonda
+ container_name: sonda
+ ports:
+ - 127.0.0.1:${METRICS_PORT}:${METRICS_PORT}
+ environment:
+ <<:
+ - *sonda_env
+ depends_on:
+ - nwaku
+ networks:
+ - nwaku-sonda
+
+ prometheus:
+ image: docker.io/prom/prometheus:latest
+ container_name: prometheus
+ volumes:
+ - ./monitoring/prometheus-config.yml:/etc/prometheus/prometheus.yml:Z
+ command:
+ - --config.file=/etc/prometheus/prometheus.yml
+ # ports:
+ # - 127.0.0.1:9090:9090
+ restart: on-failure:5
+ depends_on:
+ - nwaku
+ networks:
+ - nwaku-sonda
+
+ grafana:
+ image: docker.io/grafana/grafana:latest
+ container_name: grafana
+ env_file:
+ - ./monitoring/configuration/grafana-plugins.env
+ volumes:
+ - ./monitoring/configuration/grafana.ini:/etc/grafana/grafana.ini:Z
+ - ./monitoring/configuration/dashboards.yaml:/etc/grafana/provisioning/dashboards/dashboards.yaml:Z
+ - ./monitoring/configuration/datasources.yaml:/etc/grafana/provisioning/datasources/datasources.yaml:Z
+ - ./monitoring/configuration/dashboards:/var/lib/grafana/dashboards/:Z
+ - ./monitoring/configuration/customizations/custom-logo.svg:/usr/share/grafana/public/img/grafana_icon.svg:Z
+ - ./monitoring/configuration/customizations/custom-logo.svg:/usr/share/grafana/public/img/grafana_typelogo.svg:Z
+ - ./monitoring/configuration/customizations/custom-logo.png:/usr/share/grafana/public/img/fav32.png:Z
+ ports:
+ - 0.0.0.0:3000:3000
+ restart: on-failure:5
+ depends_on:
+ - prometheus
+ networks:
+ - nwaku-sonda
+
+networks:
+ nwaku-sonda:
\ No newline at end of file
diff --git a/third-party/nwaku/apps/sonda/monitoring/configuration/customizations/custom-logo.png b/third-party/nwaku/apps/sonda/monitoring/configuration/customizations/custom-logo.png
new file mode 100644
index 0000000..dcf13b9
Binary files /dev/null and b/third-party/nwaku/apps/sonda/monitoring/configuration/customizations/custom-logo.png differ
diff --git a/third-party/nwaku/apps/sonda/monitoring/configuration/customizations/custom-logo.svg b/third-party/nwaku/apps/sonda/monitoring/configuration/customizations/custom-logo.svg
new file mode 100644
index 0000000..3c9a6da
--- /dev/null
+++ b/third-party/nwaku/apps/sonda/monitoring/configuration/customizations/custom-logo.svg
@@ -0,0 +1,3 @@
+
diff --git a/third-party/nwaku/apps/sonda/monitoring/configuration/dashboards.yaml b/third-party/nwaku/apps/sonda/monitoring/configuration/dashboards.yaml
new file mode 100644
index 0000000..e59ac96
--- /dev/null
+++ b/third-party/nwaku/apps/sonda/monitoring/configuration/dashboards.yaml
@@ -0,0 +1,9 @@
+apiVersion: 1
+
+providers:
+- name: 'Prometheus'
+ orgId: 1
+ folder: ''
+ type: file
+ options:
+ path: /var/lib/grafana/dashboards
\ No newline at end of file
diff --git a/third-party/nwaku/apps/sonda/monitoring/configuration/dashboards/nwaku-monitoring.json b/third-party/nwaku/apps/sonda/monitoring/configuration/dashboards/nwaku-monitoring.json
new file mode 100644
index 0000000..2b024e3
--- /dev/null
+++ b/third-party/nwaku/apps/sonda/monitoring/configuration/dashboards/nwaku-monitoring.json
@@ -0,0 +1,5303 @@
+{
+ "annotations": {
+ "list": [
+ {
+ "builtIn": 1,
+ "datasource": {
+ "type": "grafana",
+ "uid": "-- Grafana --"
+ },
+ "enable": true,
+ "hide": true,
+ "iconColor": "rgba(0, 211, 255, 1)",
+ "name": "Annotations & Alerts",
+ "target": {
+ "limit": 100,
+ "matchAny": false,
+ "tags": [],
+ "type": "dashboard"
+ },
+ "type": "dashboard"
+ }
+ ]
+ },
+ "editable": true,
+ "fiscalYearStartMonth": 0,
+ "gnetId": 12485,
+ "graphTooltip": 0,
+ "links": [],
+ "liveNow": false,
+ "panels": [
+ {
+ "collapsed": false,
+ "gridPos": {
+ "h": 1,
+ "w": 24,
+ "x": 0,
+ "y": 0
+ },
+ "id": 45,
+ "panels": [],
+ "title": "Waku Node",
+ "type": "row"
+ },
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "fieldConfig": {
+ "defaults": {
+ "color": {
+ "mode": "thresholds"
+ },
+ "mappings": [],
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "green",
+ "value": null
+ }
+ ]
+ },
+ "unit": "none"
+ },
+ "overrides": []
+ },
+ "gridPos": {
+ "h": 8,
+ "w": 9,
+ "x": 0,
+ "y": 1
+ },
+ "id": 41,
+ "options": {
+ "displayMode": "gradient",
+ "maxVizHeight": 300,
+ "minVizHeight": 10,
+ "minVizWidth": 0,
+ "namePlacement": "auto",
+ "orientation": "auto",
+ "reduceOptions": {
+ "calcs": [],
+ "fields": "",
+ "values": false
+ },
+ "showUnfilled": true,
+ "sizing": "auto",
+ "valueMode": "color"
+ },
+ "pluginVersion": "10.2.3",
+ "targets": [
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "editorMode": "code",
+ "exemplar": false,
+ "expr": "rate(waku_histogram_message_size_bucket[1h])/scalar(rate(waku_histogram_message_size_count[1h]))*100",
+ "format": "heatmap",
+ "instant": true,
+ "legendFormat": "__auto",
+ "range": false,
+ "refId": "A"
+ }
+ ],
+ "title": "Message distrubution %/kBytes (Last Hour)",
+ "type": "bargauge"
+ },
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "fieldConfig": {
+ "defaults": {
+ "color": {
+ "mode": "thresholds"
+ },
+ "mappings": [],
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "green",
+ "value": null
+ },
+ {
+ "color": "red",
+ "value": 80
+ }
+ ]
+ },
+ "unit": "deckbytes"
+ },
+ "overrides": []
+ },
+ "gridPos": {
+ "h": 4,
+ "w": 9,
+ "x": 9,
+ "y": 1
+ },
+ "id": 38,
+ "options": {
+ "colorMode": "none",
+ "graphMode": "none",
+ "justifyMode": "auto",
+ "orientation": "auto",
+ "reduceOptions": {
+ "calcs": [
+ "lastNotNull"
+ ],
+ "fields": "",
+ "values": false
+ },
+ "textMode": "auto",
+ "wideLayout": true
+ },
+ "pluginVersion": "10.2.3",
+ "targets": [
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "editorMode": "code",
+ "expr": "rate(waku_histogram_message_size_sum[1h])/rate(waku_histogram_message_size_count[1h])",
+ "legendFormat": "__auto",
+ "range": true,
+ "refId": "A"
+ }
+ ],
+ "title": "Average Msg Size (Last Hour)",
+ "type": "stat"
+ },
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "fieldConfig": {
+ "defaults": {
+ "color": {
+ "mode": "thresholds"
+ },
+ "mappings": [],
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "green",
+ "value": null
+ }
+ ]
+ },
+ "unit": "deckbytes"
+ },
+ "overrides": []
+ },
+ "gridPos": {
+ "h": 4,
+ "w": 5,
+ "x": 9,
+ "y": 5
+ },
+ "id": 42,
+ "options": {
+ "colorMode": "none",
+ "graphMode": "none",
+ "justifyMode": "auto",
+ "orientation": "auto",
+ "reduceOptions": {
+ "calcs": [
+ "lastNotNull"
+ ],
+ "fields": "",
+ "values": false
+ },
+ "textMode": "auto",
+ "wideLayout": true
+ },
+ "pluginVersion": "10.2.3",
+ "targets": [
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "editorMode": "code",
+ "expr": "histogram_quantile(0.75, rate(waku_histogram_message_size_bucket[1h]))",
+ "legendFormat": "__auto",
+ "range": true,
+ "refId": "A"
+ }
+ ],
+ "title": "75% Percentile (Last hour)",
+ "type": "stat"
+ },
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "fieldConfig": {
+ "defaults": {
+ "color": {
+ "mode": "thresholds"
+ },
+ "mappings": [],
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "green",
+ "value": null
+ },
+ {
+ "color": "red",
+ "value": 80
+ }
+ ]
+ },
+ "unit": "deckbytes"
+ },
+ "overrides": []
+ },
+ "gridPos": {
+ "h": 4,
+ "w": 4,
+ "x": 14,
+ "y": 5
+ },
+ "id": 39,
+ "options": {
+ "colorMode": "none",
+ "graphMode": "none",
+ "justifyMode": "auto",
+ "orientation": "auto",
+ "reduceOptions": {
+ "calcs": [
+ "lastNotNull"
+ ],
+ "fields": "",
+ "values": false
+ },
+ "textMode": "auto",
+ "wideLayout": true
+ },
+ "pluginVersion": "10.2.3",
+ "targets": [
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "editorMode": "code",
+ "expr": "histogram_quantile(0.99, rate(waku_histogram_message_size_bucket[1h]))",
+ "legendFormat": "__auto",
+ "range": true,
+ "refId": "A"
+ }
+ ],
+ "title": "99% Percentile (Last Hour)",
+ "type": "stat"
+ },
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "fieldConfig": {
+ "defaults": {
+ "color": {
+ "mode": "palette-classic"
+ },
+ "custom": {
+ "axisBorderShow": false,
+ "axisCenteredZero": false,
+ "axisColorMode": "text",
+ "axisLabel": "",
+ "axisPlacement": "auto",
+ "barAlignment": 0,
+ "drawStyle": "line",
+ "fillOpacity": 0,
+ "gradientMode": "none",
+ "hideFrom": {
+ "legend": false,
+ "tooltip": false,
+ "viz": false
+ },
+ "insertNulls": false,
+ "lineInterpolation": "linear",
+ "lineWidth": 1,
+ "pointSize": 5,
+ "scaleDistribution": {
+ "type": "linear"
+ },
+ "showPoints": "auto",
+ "spanNulls": false,
+ "stacking": {
+ "group": "A",
+ "mode": "none"
+ },
+ "thresholdsStyle": {
+ "mode": "off"
+ }
+ },
+ "mappings": [],
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "green",
+ "value": null
+ },
+ {
+ "color": "red",
+ "value": 80
+ }
+ ]
+ }
+ },
+ "overrides": []
+ },
+ "gridPos": {
+ "h": 7,
+ "w": 9,
+ "x": 0,
+ "y": 9
+ },
+ "id": 12,
+ "options": {
+ "legend": {
+ "calcs": [],
+ "displayMode": "list",
+ "placement": "bottom",
+ "showLegend": true
+ },
+ "tooltip": {
+ "mode": "single",
+ "sort": "none"
+ }
+ },
+ "targets": [
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "editorMode": "code",
+ "expr": "(increase(waku_node_messages_total[1m]))/60",
+ "legendFormat": "{{instance}}",
+ "range": true,
+ "refId": "A"
+ }
+ ],
+ "title": "Messages/second",
+ "type": "timeseries"
+ },
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "fieldConfig": {
+ "defaults": {
+ "color": {
+ "mode": "palette-classic"
+ },
+ "custom": {
+ "axisBorderShow": false,
+ "axisCenteredZero": false,
+ "axisColorMode": "text",
+ "axisLabel": "",
+ "axisPlacement": "auto",
+ "barAlignment": 0,
+ "drawStyle": "line",
+ "fillOpacity": 0,
+ "gradientMode": "none",
+ "hideFrom": {
+ "legend": false,
+ "tooltip": false,
+ "viz": false
+ },
+ "insertNulls": false,
+ "lineInterpolation": "linear",
+ "lineWidth": 1,
+ "pointSize": 5,
+ "scaleDistribution": {
+ "type": "linear"
+ },
+ "showPoints": "auto",
+ "spanNulls": false,
+ "stacking": {
+ "group": "A",
+ "mode": "none"
+ },
+ "thresholdsStyle": {
+ "mode": "off"
+ }
+ },
+ "mappings": [],
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "green",
+ "value": null
+ }
+ ]
+ },
+ "unit": "deckbytes"
+ },
+ "overrides": []
+ },
+ "gridPos": {
+ "h": 7,
+ "w": 9,
+ "x": 9,
+ "y": 9
+ },
+ "id": 43,
+ "options": {
+ "legend": {
+ "calcs": [],
+ "displayMode": "list",
+ "placement": "bottom",
+ "showLegend": true
+ },
+ "tooltip": {
+ "mode": "single",
+ "sort": "none"
+ }
+ },
+ "pluginVersion": "9.4.7",
+ "targets": [
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "editorMode": "code",
+ "exemplar": false,
+ "expr": "waku_histogram_message_size_sum/waku_histogram_message_size_count",
+ "format": "heatmap",
+ "instant": false,
+ "legendFormat": "{{instance}}",
+ "range": true,
+ "refId": "A"
+ }
+ ],
+ "title": "Average msg size (kBytes)",
+ "type": "timeseries"
+ },
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "fieldConfig": {
+ "defaults": {
+ "color": {
+ "mode": "thresholds"
+ },
+ "custom": {
+ "align": "auto",
+ "cellOptions": {
+ "type": "auto"
+ },
+ "inspect": false
+ },
+ "mappings": [],
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "green",
+ "value": null
+ },
+ {
+ "color": "red",
+ "value": 80
+ }
+ ]
+ }
+ },
+ "overrides": []
+ },
+ "gridPos": {
+ "h": 5,
+ "w": 3,
+ "x": 0,
+ "y": 16
+ },
+ "id": 2,
+ "options": {
+ "cellHeight": "sm",
+ "footer": {
+ "countRows": false,
+ "fields": "",
+ "reducer": [
+ "sum"
+ ],
+ "show": false
+ },
+ "showHeader": true
+ },
+ "pluginVersion": "10.2.3",
+ "targets": [
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "editorMode": "builder",
+ "exemplar": false,
+ "expr": "waku_version{instance=\"nwaku:8003\"}",
+ "format": "table",
+ "instant": true,
+ "legendFormat": "__auto",
+ "range": false,
+ "refId": "A"
+ }
+ ],
+ "title": "Version",
+ "transformations": [
+ {
+ "id": "filterFieldsByName",
+ "options": {
+ "include": {
+ "names": [
+ "version"
+ ]
+ }
+ }
+ }
+ ],
+ "type": "table"
+ },
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "fieldConfig": {
+ "defaults": {
+ "color": {
+ "mode": "thresholds"
+ },
+ "mappings": [],
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "green",
+ "value": null
+ },
+ {
+ "color": "red",
+ "value": 80
+ }
+ ]
+ }
+ },
+ "overrides": []
+ },
+ "gridPos": {
+ "h": 5,
+ "w": 3,
+ "x": 3,
+ "y": 16
+ },
+ "id": 22,
+ "options": {
+ "colorMode": "value",
+ "graphMode": "area",
+ "justifyMode": "auto",
+ "orientation": "auto",
+ "reduceOptions": {
+ "calcs": [
+ "lastNotNull"
+ ],
+ "fields": "",
+ "values": false
+ },
+ "textMode": "auto",
+ "wideLayout": true
+ },
+ "pluginVersion": "10.2.3",
+ "targets": [
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "editorMode": "code",
+ "expr": "libp2p_autonat_reachability_confidence",
+ "legendFormat": "{{reachability}}",
+ "range": true,
+ "refId": "A"
+ }
+ ],
+ "title": "Reachability",
+ "transformations": [
+ {
+ "id": "reduce",
+ "options": {
+ "includeTimeField": false,
+ "mode": "reduceFields",
+ "reducers": [
+ "max"
+ ]
+ }
+ }
+ ],
+ "type": "stat"
+ },
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "fieldConfig": {
+ "defaults": {
+ "color": {
+ "mode": "thresholds"
+ },
+ "mappings": [],
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "green",
+ "value": null
+ },
+ {
+ "color": "red",
+ "value": 80
+ }
+ ]
+ }
+ },
+ "overrides": []
+ },
+ "gridPos": {
+ "h": 5,
+ "w": 3,
+ "x": 6,
+ "y": 16
+ },
+ "id": 32,
+ "options": {
+ "colorMode": "value",
+ "graphMode": "none",
+ "justifyMode": "auto",
+ "orientation": "auto",
+ "reduceOptions": {
+ "calcs": [
+ "lastNotNull"
+ ],
+ "fields": "",
+ "values": false
+ },
+ "textMode": "auto",
+ "wideLayout": true
+ },
+ "pluginVersion": "10.2.3",
+ "targets": [
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "editorMode": "code",
+ "expr": "routing_table_nodes{state=\"seen\"}",
+ "legendFormat": "__auto",
+ "range": true,
+ "refId": "A"
+ }
+ ],
+ "title": "Discv5 (Seen Nodes)",
+ "type": "stat"
+ },
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "fieldConfig": {
+ "defaults": {
+ "color": {
+ "mode": "thresholds"
+ },
+ "mappings": [],
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "green",
+ "value": null
+ },
+ {
+ "color": "red",
+ "value": 80
+ }
+ ]
+ }
+ },
+ "overrides": []
+ },
+ "gridPos": {
+ "h": 5,
+ "w": 3,
+ "x": 9,
+ "y": 16
+ },
+ "id": 33,
+ "options": {
+ "colorMode": "value",
+ "graphMode": "none",
+ "justifyMode": "auto",
+ "orientation": "auto",
+ "reduceOptions": {
+ "calcs": [
+ "lastNotNull"
+ ],
+ "fields": "",
+ "values": false
+ },
+ "textMode": "auto",
+ "wideLayout": true
+ },
+ "pluginVersion": "10.2.3",
+ "targets": [
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "editorMode": "code",
+ "expr": "routing_table_nodes",
+ "legendFormat": "{{label_name}}",
+ "range": true,
+ "refId": "A"
+ }
+ ],
+ "title": "Discv5 (Nodes)",
+ "transformations": [
+ {
+ "id": "filterFieldsByName",
+ "options": {
+ "include": {
+ "names": [
+ "Time",
+ "{__name__=\"routing_table_nodes\", instance=\"nwaku:8003\", job=\"nwaku\"}"
+ ]
+ }
+ }
+ }
+ ],
+ "type": "stat"
+ },
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "fieldConfig": {
+ "defaults": {
+ "color": {
+ "mode": "thresholds"
+ },
+ "mappings": [],
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "green",
+ "value": null
+ },
+ {
+ "color": "red",
+ "value": 80
+ }
+ ]
+ }
+ },
+ "overrides": []
+ },
+ "gridPos": {
+ "h": 5,
+ "w": 3,
+ "x": 12,
+ "y": 16
+ },
+ "id": 25,
+ "options": {
+ "colorMode": "value",
+ "graphMode": "none",
+ "justifyMode": "auto",
+ "orientation": "auto",
+ "reduceOptions": {
+ "calcs": [
+ "lastNotNull"
+ ],
+ "fields": "",
+ "values": false
+ },
+ "textMode": "auto",
+ "wideLayout": true
+ },
+ "pluginVersion": "10.2.3",
+ "targets": [
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "editorMode": "builder",
+ "expr": "libp2p_peers",
+ "legendFormat": "__auto",
+ "range": true,
+ "refId": "A"
+ }
+ ],
+ "title": "Connected Peers",
+ "type": "stat"
+ },
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "fieldConfig": {
+ "defaults": {
+ "color": {
+ "mode": "thresholds"
+ },
+ "mappings": [],
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "green",
+ "value": null
+ },
+ {
+ "color": "red",
+ "value": 80
+ }
+ ]
+ }
+ },
+ "overrides": []
+ },
+ "gridPos": {
+ "h": 5,
+ "w": 3,
+ "x": 15,
+ "y": 16
+ },
+ "id": 28,
+ "options": {
+ "colorMode": "value",
+ "graphMode": "none",
+ "justifyMode": "auto",
+ "orientation": "auto",
+ "reduceOptions": {
+ "calcs": [
+ "lastNotNull"
+ ],
+ "fields": "",
+ "values": false
+ },
+ "textMode": "auto",
+ "wideLayout": true
+ },
+ "pluginVersion": "10.2.3",
+ "targets": [
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "editorMode": "code",
+ "expr": "libp2p_pubsub_topics",
+ "legendFormat": "__auto",
+ "range": true,
+ "refId": "A"
+ }
+ ],
+ "title": "Number Pubsub Topics",
+ "type": "stat"
+ },
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "fieldConfig": {
+ "defaults": {
+ "color": {
+ "mode": "thresholds"
+ },
+ "mappings": [],
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "green",
+ "value": null
+ }
+ ]
+ },
+ "unit": "dateTimeAsIso"
+ },
+ "overrides": []
+ },
+ "gridPos": {
+ "h": 5,
+ "w": 3,
+ "x": 0,
+ "y": 21
+ },
+ "id": 10,
+ "options": {
+ "colorMode": "value",
+ "graphMode": "none",
+ "justifyMode": "auto",
+ "orientation": "auto",
+ "reduceOptions": {
+ "calcs": [
+ "lastNotNull"
+ ],
+ "fields": "",
+ "values": false
+ },
+ "textMode": "auto",
+ "wideLayout": true
+ },
+ "pluginVersion": "10.2.3",
+ "targets": [
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "editorMode": "code",
+ "expr": "process_start_time_seconds{job=\"nwaku\"}*1000",
+ "legendFormat": "__auto",
+ "range": true,
+ "refId": "A"
+ }
+ ],
+ "title": "Start Times (UTC)",
+ "type": "stat"
+ },
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "fieldConfig": {
+ "defaults": {
+ "color": {
+ "mode": "thresholds"
+ },
+ "mappings": [],
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "green",
+ "value": null
+ },
+ {
+ "color": "red",
+ "value": 80
+ }
+ ]
+ }
+ },
+ "overrides": []
+ },
+ "gridPos": {
+ "h": 10,
+ "w": 15,
+ "x": 3,
+ "y": 21
+ },
+ "id": 44,
+ "options": {
+ "colorMode": "value",
+ "graphMode": "none",
+ "justifyMode": "auto",
+ "orientation": "auto",
+ "reduceOptions": {
+ "calcs": [
+ "lastNotNull"
+ ],
+ "fields": "",
+ "values": false
+ },
+ "textMode": "auto",
+ "wideLayout": true
+ },
+ "pluginVersion": "10.2.3",
+ "targets": [
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "editorMode": "code",
+ "expr": "waku_connected_peers",
+ "legendFormat": "{{direction}}_{{protocol}}",
+ "range": true,
+ "refId": "A"
+ }
+ ],
+ "title": "Connected Peers (Direction/Protocol)",
+ "transformations": [],
+ "type": "stat"
+ },
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "fieldConfig": {
+ "defaults": {
+ "color": {
+ "mode": "thresholds"
+ },
+ "mappings": [],
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "green",
+ "value": null
+ }
+ ]
+ }
+ },
+ "overrides": []
+ },
+ "gridPos": {
+ "h": 5,
+ "w": 3,
+ "x": 0,
+ "y": 26
+ },
+ "id": 36,
+ "options": {
+ "colorMode": "value",
+ "graphMode": "none",
+ "justifyMode": "auto",
+ "orientation": "auto",
+ "reduceOptions": {
+ "calcs": [
+ "lastNotNull"
+ ],
+ "fields": "",
+ "values": false
+ },
+ "textMode": "auto",
+ "wideLayout": true
+ },
+ "pluginVersion": "10.2.3",
+ "targets": [
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "editorMode": "code",
+ "expr": "waku_peer_store_size",
+ "legendFormat": "__auto",
+ "range": true,
+ "refId": "A"
+ }
+ ],
+ "title": "Peer Store Size",
+ "type": "stat"
+ },
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "fieldConfig": {
+ "defaults": {
+ "color": {
+ "mode": "palette-classic"
+ },
+ "custom": {
+ "axisBorderShow": false,
+ "axisCenteredZero": false,
+ "axisColorMode": "text",
+ "axisLabel": "",
+ "axisPlacement": "auto",
+ "barAlignment": 0,
+ "drawStyle": "line",
+ "fillOpacity": 0,
+ "gradientMode": "none",
+ "hideFrom": {
+ "legend": false,
+ "tooltip": false,
+ "viz": false
+ },
+ "insertNulls": false,
+ "lineInterpolation": "linear",
+ "lineWidth": 1,
+ "pointSize": 5,
+ "scaleDistribution": {
+ "type": "linear"
+ },
+ "showPoints": "auto",
+ "spanNulls": false,
+ "stacking": {
+ "group": "A",
+ "mode": "none"
+ },
+ "thresholdsStyle": {
+ "mode": "off"
+ }
+ },
+ "mappings": [],
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "green",
+ "value": null
+ },
+ {
+ "color": "red",
+ "value": 80
+ }
+ ]
+ }
+ },
+ "overrides": []
+ },
+ "gridPos": {
+ "h": 9,
+ "w": 6,
+ "x": 0,
+ "y": 31
+ },
+ "id": 4,
+ "options": {
+ "legend": {
+ "calcs": [],
+ "displayMode": "list",
+ "placement": "bottom",
+ "showLegend": true
+ },
+ "tooltip": {
+ "mode": "single",
+ "sort": "none"
+ }
+ },
+ "pluginVersion": "9.3.2",
+ "targets": [
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "editorMode": "builder",
+ "expr": "libp2p_peers",
+ "legendFormat": "{{__name__}}",
+ "range": true,
+ "refId": "A"
+ }
+ ],
+ "title": "Connected Peers",
+ "type": "timeseries"
+ },
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "fieldConfig": {
+ "defaults": {
+ "color": {
+ "mode": "palette-classic"
+ },
+ "custom": {
+ "axisBorderShow": false,
+ "axisCenteredZero": false,
+ "axisColorMode": "text",
+ "axisLabel": "",
+ "axisPlacement": "auto",
+ "barAlignment": 0,
+ "drawStyle": "line",
+ "fillOpacity": 0,
+ "gradientMode": "none",
+ "hideFrom": {
+ "legend": false,
+ "tooltip": false,
+ "viz": false
+ },
+ "insertNulls": false,
+ "lineInterpolation": "linear",
+ "lineWidth": 1,
+ "pointSize": 5,
+ "scaleDistribution": {
+ "type": "linear"
+ },
+ "showPoints": "auto",
+ "spanNulls": false,
+ "stacking": {
+ "group": "A",
+ "mode": "none"
+ },
+ "thresholdsStyle": {
+ "mode": "off"
+ }
+ },
+ "mappings": [],
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "green",
+ "value": null
+ },
+ {
+ "color": "red",
+ "value": 80
+ }
+ ]
+ },
+ "unit": "binBps"
+ },
+ "overrides": []
+ },
+ "gridPos": {
+ "h": 9,
+ "w": 6,
+ "x": 6,
+ "y": 31
+ },
+ "id": 8,
+ "options": {
+ "legend": {
+ "calcs": [],
+ "displayMode": "list",
+ "placement": "bottom",
+ "showLegend": true
+ },
+ "tooltip": {
+ "mode": "single",
+ "sort": "none"
+ }
+ },
+ "targets": [
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "editorMode": "code",
+ "expr": "rate(libp2p_network_bytes_total{direction=\"in\"}[$__rate_interval])",
+ "legendFormat": "traffic_{{direction}}",
+ "range": true,
+ "refId": "A"
+ }
+ ],
+ "title": "libp2p traffic (in)",
+ "type": "timeseries"
+ },
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "fieldConfig": {
+ "defaults": {
+ "color": {
+ "mode": "palette-classic"
+ },
+ "custom": {
+ "axisBorderShow": false,
+ "axisCenteredZero": false,
+ "axisColorMode": "text",
+ "axisLabel": "",
+ "axisPlacement": "auto",
+ "barAlignment": 0,
+ "drawStyle": "line",
+ "fillOpacity": 0,
+ "gradientMode": "none",
+ "hideFrom": {
+ "legend": false,
+ "tooltip": false,
+ "viz": false
+ },
+ "insertNulls": false,
+ "lineInterpolation": "linear",
+ "lineWidth": 1,
+ "pointSize": 5,
+ "scaleDistribution": {
+ "type": "linear"
+ },
+ "showPoints": "auto",
+ "spanNulls": false,
+ "stacking": {
+ "group": "A",
+ "mode": "none"
+ },
+ "thresholdsStyle": {
+ "mode": "off"
+ }
+ },
+ "mappings": [],
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "green",
+ "value": null
+ },
+ {
+ "color": "red",
+ "value": 80
+ }
+ ]
+ },
+ "unit": "binBps"
+ },
+ "overrides": []
+ },
+ "gridPos": {
+ "h": 9,
+ "w": 6,
+ "x": 12,
+ "y": 31
+ },
+ "id": 29,
+ "options": {
+ "legend": {
+ "calcs": [],
+ "displayMode": "list",
+ "placement": "bottom",
+ "showLegend": true
+ },
+ "tooltip": {
+ "mode": "single",
+ "sort": "none"
+ }
+ },
+ "targets": [
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "editorMode": "code",
+ "expr": "rate(libp2p_network_bytes_total{direction=\"out\"}[$__rate_interval])",
+ "legendFormat": "traffic_{{direction}}",
+ "range": true,
+ "refId": "A"
+ }
+ ],
+ "title": "libp2p traffic (out)",
+ "type": "timeseries"
+ },
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "fieldConfig": {
+ "defaults": {
+ "color": {
+ "mode": "palette-classic"
+ },
+ "custom": {
+ "axisBorderShow": false,
+ "axisCenteredZero": false,
+ "axisColorMode": "text",
+ "axisLabel": "",
+ "axisPlacement": "auto",
+ "barAlignment": 0,
+ "drawStyle": "line",
+ "fillOpacity": 0,
+ "gradientMode": "none",
+ "hideFrom": {
+ "legend": false,
+ "tooltip": false,
+ "viz": false
+ },
+ "insertNulls": false,
+ "lineInterpolation": "linear",
+ "lineWidth": 1,
+ "pointSize": 5,
+ "scaleDistribution": {
+ "type": "linear"
+ },
+ "showPoints": "auto",
+ "spanNulls": false,
+ "stacking": {
+ "group": "A",
+ "mode": "none"
+ },
+ "thresholdsStyle": {
+ "mode": "off"
+ }
+ },
+ "mappings": [],
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "green",
+ "value": null
+ },
+ {
+ "color": "red",
+ "value": 80
+ }
+ ]
+ },
+ "unit": "decbytes"
+ },
+ "overrides": []
+ },
+ "gridPos": {
+ "h": 8,
+ "w": 6,
+ "x": 0,
+ "y": 40
+ },
+ "id": 20,
+ "options": {
+ "legend": {
+ "calcs": [],
+ "displayMode": "list",
+ "placement": "bottom",
+ "showLegend": true
+ },
+ "tooltip": {
+ "mode": "single",
+ "sort": "none"
+ }
+ },
+ "targets": [
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "editorMode": "code",
+ "expr": "nim_gc_heap_instance_occupied_bytes{}",
+ "legendFormat": "{{__name__}}",
+ "range": true,
+ "refId": "A"
+ }
+ ],
+ "title": "Heap allocation",
+ "type": "timeseries"
+ },
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "fieldConfig": {
+ "defaults": {
+ "color": {
+ "mode": "palette-classic"
+ },
+ "custom": {
+ "axisBorderShow": false,
+ "axisCenteredZero": false,
+ "axisColorMode": "text",
+ "axisLabel": "",
+ "axisPlacement": "auto",
+ "barAlignment": 0,
+ "drawStyle": "line",
+ "fillOpacity": 0,
+ "gradientMode": "none",
+ "hideFrom": {
+ "legend": false,
+ "tooltip": false,
+ "viz": false
+ },
+ "insertNulls": false,
+ "lineInterpolation": "linear",
+ "lineWidth": 1,
+ "pointSize": 5,
+ "scaleDistribution": {
+ "type": "linear"
+ },
+ "showPoints": "auto",
+ "spanNulls": false,
+ "stacking": {
+ "group": "A",
+ "mode": "none"
+ },
+ "thresholdsStyle": {
+ "mode": "off"
+ }
+ },
+ "mappings": [],
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "green",
+ "value": null
+ },
+ {
+ "color": "red",
+ "value": 80
+ }
+ ]
+ },
+ "unit": "decbytes"
+ },
+ "overrides": []
+ },
+ "gridPos": {
+ "h": 8,
+ "w": 6,
+ "x": 6,
+ "y": 40
+ },
+ "id": 18,
+ "options": {
+ "legend": {
+ "calcs": [],
+ "displayMode": "list",
+ "placement": "bottom",
+ "showLegend": true
+ },
+ "tooltip": {
+ "mode": "single",
+ "sort": "none"
+ }
+ },
+ "targets": [
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "editorMode": "code",
+ "expr": "nim_gc_mem_bytes{}",
+ "hide": false,
+ "legendFormat": "{{__name__}}",
+ "range": true,
+ "refId": "A"
+ }
+ ],
+ "title": "Nim Memory Usage",
+ "type": "timeseries"
+ },
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "fieldConfig": {
+ "defaults": {
+ "color": {
+ "mode": "palette-classic"
+ },
+ "custom": {
+ "axisBorderShow": false,
+ "axisCenteredZero": false,
+ "axisColorMode": "text",
+ "axisLabel": "",
+ "axisPlacement": "auto",
+ "barAlignment": 0,
+ "drawStyle": "line",
+ "fillOpacity": 0,
+ "gradientMode": "none",
+ "hideFrom": {
+ "legend": false,
+ "tooltip": false,
+ "viz": false
+ },
+ "insertNulls": false,
+ "lineInterpolation": "linear",
+ "lineWidth": 1,
+ "pointSize": 5,
+ "scaleDistribution": {
+ "type": "linear"
+ },
+ "showPoints": "auto",
+ "spanNulls": false,
+ "stacking": {
+ "group": "A",
+ "mode": "none"
+ },
+ "thresholdsStyle": {
+ "mode": "off"
+ }
+ },
+ "mappings": [],
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "green",
+ "value": null
+ },
+ {
+ "color": "red",
+ "value": 80
+ }
+ ]
+ }
+ },
+ "overrides": []
+ },
+ "gridPos": {
+ "h": 8,
+ "w": 6,
+ "x": 12,
+ "y": 40
+ },
+ "id": 128,
+ "options": {
+ "legend": {
+ "calcs": [],
+ "displayMode": "list",
+ "placement": "bottom",
+ "showLegend": true
+ },
+ "tooltip": {
+ "mode": "single",
+ "sort": "none"
+ }
+ },
+ "targets": [
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "disableTextWrap": false,
+ "editorMode": "builder",
+ "expr": "waku_rln_number_registered_memberships",
+ "fullMetaSearch": false,
+ "includeNullMetadata": true,
+ "instant": false,
+ "legendFormat": "{{__name__}}",
+ "range": true,
+ "refId": "A",
+ "useBackend": false
+ }
+ ],
+ "title": "RLN Registered Memberships",
+ "type": "timeseries"
+ },
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "fieldConfig": {
+ "defaults": {
+ "color": {
+ "mode": "palette-classic"
+ },
+ "custom": {
+ "axisBorderShow": false,
+ "axisCenteredZero": false,
+ "axisColorMode": "text",
+ "axisLabel": "",
+ "axisPlacement": "auto",
+ "barAlignment": 0,
+ "drawStyle": "line",
+ "fillOpacity": 0,
+ "gradientMode": "none",
+ "hideFrom": {
+ "legend": false,
+ "tooltip": false,
+ "viz": false
+ },
+ "insertNulls": false,
+ "lineInterpolation": "linear",
+ "lineWidth": 1,
+ "pointSize": 5,
+ "scaleDistribution": {
+ "type": "linear"
+ },
+ "showPoints": "auto",
+ "spanNulls": false,
+ "stacking": {
+ "group": "A",
+ "mode": "none"
+ },
+ "thresholdsStyle": {
+ "mode": "off"
+ }
+ },
+ "mappings": [],
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "green",
+ "value": null
+ },
+ {
+ "color": "red",
+ "value": 80
+ }
+ ]
+ }
+ },
+ "overrides": []
+ },
+ "gridPos": {
+ "h": 6,
+ "w": 6,
+ "x": 0,
+ "y": 48
+ },
+ "id": 127,
+ "options": {
+ "legend": {
+ "calcs": [],
+ "displayMode": "list",
+ "placement": "bottom",
+ "showLegend": true
+ },
+ "tooltip": {
+ "mode": "single",
+ "sort": "none"
+ }
+ },
+ "targets": [
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "disableTextWrap": false,
+ "editorMode": "builder",
+ "expr": "waku_rln_proof_generation_duration_seconds",
+ "fullMetaSearch": false,
+ "includeNullMetadata": true,
+ "instant": false,
+ "legendFormat": "{{__name__}}",
+ "range": true,
+ "refId": "A",
+ "useBackend": false
+ }
+ ],
+ "title": "RLN Proof Generation (seconds)",
+ "type": "timeseries"
+ },
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "fieldConfig": {
+ "defaults": {
+ "color": {
+ "mode": "palette-classic"
+ },
+ "custom": {
+ "axisBorderShow": false,
+ "axisCenteredZero": false,
+ "axisColorMode": "text",
+ "axisLabel": "",
+ "axisPlacement": "auto",
+ "barAlignment": 0,
+ "drawStyle": "line",
+ "fillOpacity": 0,
+ "gradientMode": "none",
+ "hideFrom": {
+ "legend": false,
+ "tooltip": false,
+ "viz": false
+ },
+ "insertNulls": false,
+ "lineInterpolation": "linear",
+ "lineWidth": 1,
+ "pointSize": 5,
+ "scaleDistribution": {
+ "type": "linear"
+ },
+ "showPoints": "auto",
+ "spanNulls": false,
+ "stacking": {
+ "group": "A",
+ "mode": "none"
+ },
+ "thresholdsStyle": {
+ "mode": "off"
+ }
+ },
+ "mappings": [],
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "green",
+ "value": null
+ },
+ {
+ "color": "red",
+ "value": 80
+ }
+ ]
+ }
+ },
+ "overrides": []
+ },
+ "gridPos": {
+ "h": 6,
+ "w": 6,
+ "x": 6,
+ "y": 48
+ },
+ "id": 126,
+ "options": {
+ "legend": {
+ "calcs": [],
+ "displayMode": "list",
+ "placement": "bottom",
+ "showLegend": true
+ },
+ "tooltip": {
+ "mode": "single",
+ "sort": "none"
+ }
+ },
+ "targets": [
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "disableTextWrap": false,
+ "editorMode": "builder",
+ "expr": "waku_rln_proof_verification_duration_seconds",
+ "fullMetaSearch": false,
+ "includeNullMetadata": true,
+ "instant": false,
+ "legendFormat": "{{__name__}}",
+ "range": true,
+ "refId": "A",
+ "useBackend": false
+ }
+ ],
+ "title": "RLN Proof Verification (seconds)",
+ "type": "timeseries"
+ },
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "fieldConfig": {
+ "defaults": {
+ "color": {
+ "mode": "palette-classic"
+ },
+ "custom": {
+ "axisBorderShow": false,
+ "axisCenteredZero": false,
+ "axisColorMode": "text",
+ "axisLabel": "",
+ "axisPlacement": "auto",
+ "barAlignment": 0,
+ "drawStyle": "line",
+ "fillOpacity": 0,
+ "gradientMode": "none",
+ "hideFrom": {
+ "legend": false,
+ "tooltip": false,
+ "viz": false
+ },
+ "insertNulls": false,
+ "lineInterpolation": "linear",
+ "lineWidth": 1,
+ "pointSize": 5,
+ "scaleDistribution": {
+ "type": "linear"
+ },
+ "showPoints": "auto",
+ "spanNulls": false,
+ "stacking": {
+ "group": "A",
+ "mode": "none"
+ },
+ "thresholdsStyle": {
+ "mode": "off"
+ }
+ },
+ "mappings": [],
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "green",
+ "value": null
+ },
+ {
+ "color": "red",
+ "value": 80
+ }
+ ]
+ }
+ },
+ "overrides": []
+ },
+ "gridPos": {
+ "h": 6,
+ "w": 6,
+ "x": 12,
+ "y": 48
+ },
+ "id": 135,
+ "options": {
+ "legend": {
+ "calcs": [],
+ "displayMode": "list",
+ "placement": "bottom",
+ "showLegend": true
+ },
+ "tooltip": {
+ "mode": "single",
+ "sort": "none"
+ }
+ },
+ "targets": [
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "disableTextWrap": false,
+ "editorMode": "builder",
+ "expr": "waku_rln_membership_insertion_duration_seconds",
+ "fullMetaSearch": false,
+ "includeNullMetadata": true,
+ "instant": false,
+ "legendFormat": "{{__name__}}",
+ "range": true,
+ "refId": "A",
+ "useBackend": false
+ }
+ ],
+ "title": "RLN Membership Insertion (seconds)",
+ "type": "timeseries"
+ },
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "fieldConfig": {
+ "defaults": {
+ "color": {
+ "mode": "palette-classic"
+ },
+ "custom": {
+ "axisBorderShow": false,
+ "axisCenteredZero": false,
+ "axisColorMode": "text",
+ "axisLabel": "",
+ "axisPlacement": "auto",
+ "barAlignment": 0,
+ "drawStyle": "line",
+ "fillOpacity": 0,
+ "gradientMode": "none",
+ "hideFrom": {
+ "legend": false,
+ "tooltip": false,
+ "viz": false
+ },
+ "insertNulls": false,
+ "lineInterpolation": "linear",
+ "lineWidth": 1,
+ "pointSize": 5,
+ "scaleDistribution": {
+ "type": "linear"
+ },
+ "showPoints": "auto",
+ "spanNulls": false,
+ "stacking": {
+ "group": "A",
+ "mode": "none"
+ },
+ "thresholdsStyle": {
+ "mode": "off"
+ }
+ },
+ "mappings": [],
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "green",
+ "value": null
+ },
+ {
+ "color": "red",
+ "value": 80
+ }
+ ]
+ }
+ },
+ "overrides": []
+ },
+ "gridPos": {
+ "h": 6,
+ "w": 6,
+ "x": 0,
+ "y": 54
+ },
+ "id": 134,
+ "options": {
+ "legend": {
+ "calcs": [],
+ "displayMode": "list",
+ "placement": "bottom",
+ "showLegend": true
+ },
+ "tooltip": {
+ "mode": "single",
+ "sort": "none"
+ }
+ },
+ "targets": [
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "disableTextWrap": false,
+ "editorMode": "builder",
+ "expr": "waku_rln_membership_credentials_import_duration_seconds",
+ "fullMetaSearch": false,
+ "includeNullMetadata": true,
+ "instant": false,
+ "legendFormat": "{{__name__}}",
+ "range": true,
+ "refId": "A",
+ "useBackend": false
+ }
+ ],
+ "title": "RLN Credentials Import (seconds)",
+ "type": "timeseries"
+ },
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "fieldConfig": {
+ "defaults": {
+ "color": {
+ "mode": "palette-classic"
+ },
+ "custom": {
+ "axisBorderShow": false,
+ "axisCenteredZero": false,
+ "axisColorMode": "text",
+ "axisLabel": "",
+ "axisPlacement": "auto",
+ "barAlignment": 0,
+ "drawStyle": "line",
+ "fillOpacity": 0,
+ "gradientMode": "none",
+ "hideFrom": {
+ "legend": false,
+ "tooltip": false,
+ "viz": false
+ },
+ "insertNulls": false,
+ "lineInterpolation": "linear",
+ "lineWidth": 1,
+ "pointSize": 5,
+ "scaleDistribution": {
+ "type": "linear"
+ },
+ "showPoints": "auto",
+ "spanNulls": false,
+ "stacking": {
+ "group": "A",
+ "mode": "none"
+ },
+ "thresholdsStyle": {
+ "mode": "off"
+ }
+ },
+ "mappings": [],
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "green",
+ "value": null
+ },
+ {
+ "color": "red",
+ "value": 80
+ }
+ ]
+ }
+ },
+ "overrides": []
+ },
+ "gridPos": {
+ "h": 6,
+ "w": 6,
+ "x": 6,
+ "y": 54
+ },
+ "id": 137,
+ "options": {
+ "legend": {
+ "calcs": [],
+ "displayMode": "list",
+ "placement": "bottom",
+ "showLegend": true
+ },
+ "tooltip": {
+ "mode": "single",
+ "sort": "none"
+ }
+ },
+ "targets": [
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "disableTextWrap": false,
+ "editorMode": "builder",
+ "expr": "waku_rln_messages_total_total",
+ "fullMetaSearch": false,
+ "includeNullMetadata": true,
+ "instant": false,
+ "legendFormat": "{{__name__}}",
+ "range": true,
+ "refId": "A",
+ "useBackend": false
+ }
+ ],
+ "title": "RLN Messages Total",
+ "type": "timeseries"
+ },
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "fieldConfig": {
+ "defaults": {
+ "color": {
+ "mode": "palette-classic"
+ },
+ "custom": {
+ "axisBorderShow": false,
+ "axisCenteredZero": false,
+ "axisColorMode": "text",
+ "axisLabel": "",
+ "axisPlacement": "auto",
+ "barAlignment": 0,
+ "drawStyle": "line",
+ "fillOpacity": 0,
+ "gradientMode": "none",
+ "hideFrom": {
+ "legend": false,
+ "tooltip": false,
+ "viz": false
+ },
+ "insertNulls": false,
+ "lineInterpolation": "linear",
+ "lineWidth": 1,
+ "pointSize": 5,
+ "scaleDistribution": {
+ "type": "linear"
+ },
+ "showPoints": "auto",
+ "spanNulls": false,
+ "stacking": {
+ "group": "A",
+ "mode": "none"
+ },
+ "thresholdsStyle": {
+ "mode": "off"
+ }
+ },
+ "mappings": [],
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "green",
+ "value": null
+ },
+ {
+ "color": "red",
+ "value": 80
+ }
+ ]
+ }
+ },
+ "overrides": []
+ },
+ "gridPos": {
+ "h": 6,
+ "w": 6,
+ "x": 12,
+ "y": 54
+ },
+ "id": 136,
+ "options": {
+ "legend": {
+ "calcs": [],
+ "displayMode": "list",
+ "placement": "bottom",
+ "showLegend": true
+ },
+ "tooltip": {
+ "mode": "single",
+ "sort": "none"
+ }
+ },
+ "targets": [
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "disableTextWrap": false,
+ "editorMode": "builder",
+ "expr": "waku_rln_proof_verification_total_total",
+ "fullMetaSearch": false,
+ "includeNullMetadata": true,
+ "instant": false,
+ "legendFormat": "{{__name__}}",
+ "range": true,
+ "refId": "A",
+ "useBackend": false
+ }
+ ],
+ "title": "RLN Proof Verification Total",
+ "type": "timeseries"
+ },
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "fieldConfig": {
+ "defaults": {
+ "color": {
+ "mode": "palette-classic"
+ },
+ "custom": {
+ "axisBorderShow": false,
+ "axisCenteredZero": false,
+ "axisColorMode": "text",
+ "axisLabel": "",
+ "axisPlacement": "auto",
+ "barAlignment": 0,
+ "drawStyle": "line",
+ "fillOpacity": 0,
+ "gradientMode": "none",
+ "hideFrom": {
+ "legend": false,
+ "tooltip": false,
+ "viz": false
+ },
+ "insertNulls": false,
+ "lineInterpolation": "linear",
+ "lineWidth": 1,
+ "pointSize": 5,
+ "scaleDistribution": {
+ "type": "linear"
+ },
+ "showPoints": "auto",
+ "spanNulls": false,
+ "stacking": {
+ "group": "A",
+ "mode": "none"
+ },
+ "thresholdsStyle": {
+ "mode": "off"
+ }
+ },
+ "mappings": [],
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "green",
+ "value": null
+ },
+ {
+ "color": "red",
+ "value": 80
+ }
+ ]
+ }
+ },
+ "overrides": []
+ },
+ "gridPos": {
+ "h": 6,
+ "w": 6,
+ "x": 0,
+ "y": 60
+ },
+ "id": 133,
+ "options": {
+ "legend": {
+ "calcs": [],
+ "displayMode": "list",
+ "placement": "bottom",
+ "showLegend": true
+ },
+ "tooltip": {
+ "mode": "single",
+ "sort": "none"
+ }
+ },
+ "targets": [
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "disableTextWrap": false,
+ "editorMode": "builder",
+ "expr": "waku_rln_invalid_messages_total_total",
+ "fullMetaSearch": false,
+ "includeNullMetadata": true,
+ "instant": false,
+ "legendFormat": "{{__name__}}",
+ "range": true,
+ "refId": "A",
+ "useBackend": false
+ }
+ ],
+ "title": "RLN Invalid Messages Total",
+ "type": "timeseries"
+ },
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "fieldConfig": {
+ "defaults": {
+ "color": {
+ "mode": "palette-classic"
+ },
+ "custom": {
+ "axisBorderShow": false,
+ "axisCenteredZero": false,
+ "axisColorMode": "text",
+ "axisLabel": "",
+ "axisPlacement": "auto",
+ "barAlignment": 0,
+ "drawStyle": "line",
+ "fillOpacity": 0,
+ "gradientMode": "none",
+ "hideFrom": {
+ "legend": false,
+ "tooltip": false,
+ "viz": false
+ },
+ "insertNulls": false,
+ "lineInterpolation": "linear",
+ "lineWidth": 1,
+ "pointSize": 5,
+ "scaleDistribution": {
+ "type": "linear"
+ },
+ "showPoints": "auto",
+ "spanNulls": false,
+ "stacking": {
+ "group": "A",
+ "mode": "none"
+ },
+ "thresholdsStyle": {
+ "mode": "off"
+ }
+ },
+ "mappings": [],
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "green",
+ "value": null
+ },
+ {
+ "color": "red",
+ "value": 80
+ }
+ ]
+ }
+ },
+ "overrides": []
+ },
+ "gridPos": {
+ "h": 6,
+ "w": 6,
+ "x": 6,
+ "y": 60
+ },
+ "id": 130,
+ "options": {
+ "legend": {
+ "calcs": [],
+ "displayMode": "list",
+ "placement": "bottom",
+ "showLegend": true
+ },
+ "tooltip": {
+ "mode": "single",
+ "sort": "none"
+ }
+ },
+ "targets": [
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "disableTextWrap": false,
+ "editorMode": "builder",
+ "expr": "waku_rln_spam_messages_total_total",
+ "fullMetaSearch": false,
+ "includeNullMetadata": true,
+ "instant": false,
+ "legendFormat": "{{__name__}}",
+ "range": true,
+ "refId": "A",
+ "useBackend": false
+ }
+ ],
+ "title": "RLN Spam Messages Total",
+ "type": "timeseries"
+ },
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "fieldConfig": {
+ "defaults": {
+ "color": {
+ "mode": "palette-classic"
+ },
+ "custom": {
+ "axisBorderShow": false,
+ "axisCenteredZero": false,
+ "axisColorMode": "text",
+ "axisLabel": "",
+ "axisPlacement": "auto",
+ "barAlignment": 0,
+ "drawStyle": "line",
+ "fillOpacity": 0,
+ "gradientMode": "none",
+ "hideFrom": {
+ "legend": false,
+ "tooltip": false,
+ "viz": false
+ },
+ "insertNulls": false,
+ "lineInterpolation": "linear",
+ "lineWidth": 1,
+ "pointSize": 5,
+ "scaleDistribution": {
+ "type": "linear"
+ },
+ "showPoints": "auto",
+ "spanNulls": false,
+ "stacking": {
+ "group": "A",
+ "mode": "none"
+ },
+ "thresholdsStyle": {
+ "mode": "off"
+ }
+ },
+ "mappings": [],
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "green",
+ "value": null
+ },
+ {
+ "color": "red",
+ "value": 80
+ }
+ ]
+ }
+ },
+ "overrides": []
+ },
+ "gridPos": {
+ "h": 6,
+ "w": 6,
+ "x": 12,
+ "y": 60
+ },
+ "id": 138,
+ "options": {
+ "legend": {
+ "calcs": [],
+ "displayMode": "list",
+ "placement": "bottom",
+ "showLegend": true
+ },
+ "tooltip": {
+ "mode": "single",
+ "sort": "none"
+ }
+ },
+ "targets": [
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "disableTextWrap": false,
+ "editorMode": "builder",
+ "expr": "waku_rln_invalid_messages_total_total",
+ "fullMetaSearch": false,
+ "includeNullMetadata": true,
+ "instant": false,
+ "legendFormat": "{{type}}",
+ "range": true,
+ "refId": "A",
+ "useBackend": false
+ }
+ ],
+ "title": "RLN Invalid Messages",
+ "type": "timeseries"
+ },
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "description": "Number of messages currently stored in the database",
+ "fieldConfig": {
+ "defaults": {
+ "color": {
+ "mode": "palette-classic"
+ },
+ "custom": {
+ "axisBorderShow": false,
+ "axisCenteredZero": false,
+ "axisColorMode": "text",
+ "axisLabel": "",
+ "axisPlacement": "auto",
+ "barAlignment": 0,
+ "drawStyle": "line",
+ "fillOpacity": 0,
+ "gradientMode": "none",
+ "hideFrom": {
+ "legend": false,
+ "tooltip": false,
+ "viz": false
+ },
+ "insertNulls": false,
+ "lineInterpolation": "linear",
+ "lineWidth": 1,
+ "pointSize": 5,
+ "scaleDistribution": {
+ "type": "linear"
+ },
+ "showPoints": "auto",
+ "spanNulls": false,
+ "stacking": {
+ "group": "A",
+ "mode": "none"
+ },
+ "thresholdsStyle": {
+ "mode": "off"
+ }
+ },
+ "mappings": [],
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "green",
+ "value": null
+ },
+ {
+ "color": "red",
+ "value": 80
+ }
+ ]
+ },
+ "unit": "none"
+ },
+ "overrides": []
+ },
+ "gridPos": {
+ "h": 11,
+ "w": 9,
+ "x": 0,
+ "y": 66
+ },
+ "id": 141,
+ "options": {
+ "legend": {
+ "calcs": [
+ "last"
+ ],
+ "displayMode": "list",
+ "placement": "bottom",
+ "showLegend": true
+ },
+ "tooltip": {
+ "mode": "single",
+ "sort": "none"
+ }
+ },
+ "targets": [
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "editorMode": "code",
+ "expr": "pg_tb_stats_messages{}",
+ "instant": false,
+ "legendFormat": "{{ pubsubtopic }}",
+ "range": true,
+ "refId": "A"
+ }
+ ],
+ "title": "# messages per shard",
+ "type": "timeseries"
+ },
+ {
+ "datasource": {
+ "type": "postgres",
+ "uid": "e5d2e0c2-371d-4178-ac71-edc122fb459c"
+ },
+ "description": "Messages in local database per app name, as extracted from the content topic.",
+ "fieldConfig": {
+ "defaults": {
+ "color": {
+ "mode": "thresholds"
+ },
+ "custom": {
+ "align": "auto",
+ "cellOptions": {
+ "type": "auto"
+ },
+ "inspect": false
+ },
+ "mappings": [
+ {
+ "options": {
+ "/waku/2/rs/1/0": {
+ "index": 0,
+ "text": "0"
+ },
+ "/waku/2/rs/1/1": {
+ "index": 1,
+ "text": "1"
+ },
+ "/waku/2/rs/1/2": {
+ "index": 2,
+ "text": "2"
+ },
+ "/waku/2/rs/1/3": {
+ "index": 3,
+ "text": "3"
+ },
+ "/waku/2/rs/1/4": {
+ "index": 4,
+ "text": "4"
+ },
+ "/waku/2/rs/1/5": {
+ "index": 5,
+ "text": "5"
+ },
+ "/waku/2/rs/1/6": {
+ "index": 6,
+ "text": "6"
+ },
+ "/waku/2/rs/1/7": {
+ "index": 7,
+ "text": "7"
+ }
+ },
+ "type": "value"
+ }
+ ],
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "green",
+ "value": null
+ },
+ {
+ "color": "red",
+ "value": 80
+ }
+ ]
+ },
+ "unit": "string"
+ },
+ "overrides": [
+ {
+ "matcher": {
+ "id": "byName",
+ "options": "Number of Messages (sum)"
+ },
+ "properties": [
+ {
+ "id": "unit",
+ "value": "none"
+ }
+ ]
+ },
+ {
+ "matcher": {
+ "id": "byName",
+ "options": "Total Payload Size (sum)"
+ },
+ "properties": [
+ {
+ "id": "unit",
+ "value": "decbytes"
+ }
+ ]
+ }
+ ]
+ },
+ "gridPos": {
+ "h": 11,
+ "w": 9,
+ "x": 9,
+ "y": 66
+ },
+ "id": 144,
+ "options": {
+ "cellHeight": "sm",
+ "footer": {
+ "countRows": false,
+ "enablePagination": false,
+ "fields": "",
+ "reducer": [
+ "sum"
+ ],
+ "show": false
+ },
+ "frameIndex": 1,
+ "showHeader": true,
+ "sortBy": []
+ },
+ "pluginVersion": "10.2.3",
+ "targets": [
+ {
+ "datasource": {
+ "type": "postgres",
+ "uid": "e5d2e0c2-371d-4178-ac71-edc122fb459c"
+ },
+ "editorMode": "code",
+ "format": "table",
+ "hide": false,
+ "rawQuery": true,
+ "rawSql": "SELECT REGEXP_REPLACE(contenttopic,'^\\/(.+)\\/(\\d+)\\/(.+)\\/(.+)$','\\1') as \"App name\", COUNT(id), pg_column_size(payload)\nFROM messages\nGROUP BY contenttopic, payload",
+ "refId": "A",
+ "sql": {
+ "columns": [
+ {
+ "parameters": [
+ {
+ "name": "pubsubtopic",
+ "type": "functionParameter"
+ }
+ ],
+ "type": "function"
+ }
+ ],
+ "groupBy": [
+ {
+ "property": {
+ "name": "pubsubtopic",
+ "type": "string"
+ },
+ "type": "groupBy"
+ }
+ ],
+ "limit": 50
+ },
+ "table": "messages"
+ }
+ ],
+ "title": "Stored Message by Content Topic App Name",
+ "transformations": [
+ {
+ "id": "organize",
+ "options": {
+ "excludeByName": {},
+ "indexByName": {},
+ "renameByName": {
+ "contenttopic": "App name",
+ "count": "Number of Messages",
+ "pg_column_size": "Total Payload Size"
+ }
+ }
+ },
+ {
+ "id": "groupBy",
+ "options": {
+ "fields": {
+ "App name": {
+ "aggregations": [
+ "uniqueValues"
+ ],
+ "operation": "groupby"
+ },
+ "Number of Messages": {
+ "aggregations": [
+ "sum"
+ ],
+ "operation": "aggregate"
+ },
+ "Total Payload Size": {
+ "aggregations": [
+ "sum"
+ ],
+ "operation": "aggregate"
+ },
+ "pg_column_size": {
+ "aggregations": [
+ "sum"
+ ],
+ "operation": "aggregate"
+ }
+ }
+ }
+ },
+ {
+ "id": "sortBy",
+ "options": {
+ "fields": {},
+ "sort": [
+ {
+ "desc": true,
+ "field": "Number of Messages (sum)"
+ }
+ ]
+ }
+ }
+ ],
+ "type": "table"
+ },
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "description": "Number of messages currently stored in the database",
+ "fieldConfig": {
+ "defaults": {
+ "color": {
+ "mode": "palette-classic"
+ },
+ "custom": {
+ "axisBorderShow": false,
+ "axisCenteredZero": false,
+ "axisColorMode": "text",
+ "axisLabel": "",
+ "axisPlacement": "auto",
+ "barAlignment": 0,
+ "drawStyle": "line",
+ "fillOpacity": 0,
+ "gradientMode": "none",
+ "hideFrom": {
+ "legend": false,
+ "tooltip": false,
+ "viz": false
+ },
+ "insertNulls": false,
+ "lineInterpolation": "linear",
+ "lineWidth": 1,
+ "pointSize": 5,
+ "scaleDistribution": {
+ "type": "linear"
+ },
+ "showPoints": "auto",
+ "spanNulls": false,
+ "stacking": {
+ "group": "A",
+ "mode": "none"
+ },
+ "thresholdsStyle": {
+ "mode": "off"
+ }
+ },
+ "mappings": [],
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "green",
+ "value": null
+ }
+ ]
+ },
+ "unit": "none"
+ },
+ "overrides": []
+ },
+ "gridPos": {
+ "h": 7,
+ "w": 9,
+ "x": 0,
+ "y": 77
+ },
+ "id": 146,
+ "options": {
+ "legend": {
+ "calcs": [
+ "last"
+ ],
+ "displayMode": "list",
+ "placement": "bottom",
+ "showLegend": true
+ },
+ "tooltip": {
+ "mode": "single",
+ "sort": "none"
+ }
+ },
+ "targets": [
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "editorMode": "code",
+ "exemplar": false,
+ "expr": "pg_tb_messages_count{}",
+ "instant": false,
+ "interval": "",
+ "legendFormat": "messages",
+ "range": true,
+ "refId": "A"
+ }
+ ],
+ "title": "Unique stored messages (Postgres)",
+ "type": "timeseries"
+ },
+ {
+ "collapsed": false,
+ "gridPos": {
+ "h": 1,
+ "w": 24,
+ "x": 0,
+ "y": 84
+ },
+ "id": 46,
+ "panels": [],
+ "title": "Postgres",
+ "type": "row"
+ },
+ {
+ "colorBackground": false,
+ "colorValue": false,
+ "datasource": "Prometheus",
+ "description": "Source: server_version_num",
+ "fieldConfig": {
+ "defaults": {
+ "mappings": [],
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "green",
+ "value": null
+ }
+ ]
+ }
+ },
+ "overrides": []
+ },
+ "format": "none",
+ "gauge": {
+ "maxValue": 100,
+ "minValue": 0,
+ "show": false,
+ "thresholdLabels": false,
+ "thresholdMarkers": true
+ },
+ "gridPos": {
+ "h": 3,
+ "w": 4,
+ "x": 0,
+ "y": 85
+ },
+ "id": 11,
+ "links": [],
+ "mappingType": 1,
+ "mappingTypes": [
+ {
+ "name": "value to text",
+ "value": 1
+ },
+ {
+ "name": "range to text",
+ "value": 2
+ }
+ ],
+ "maxDataPoints": 100,
+ "nullPointMode": "connected",
+ "options": {
+ "colorMode": "value",
+ "graphMode": "area",
+ "justifyMode": "auto",
+ "orientation": "auto",
+ "reduceOptions": {
+ "calcs": [
+ "lastNotNull"
+ ],
+ "fields": "",
+ "values": false
+ },
+ "textMode": "auto",
+ "wideLayout": true
+ },
+ "pluginVersion": "10.2.3",
+ "postfix": "",
+ "postfixFontSize": "50%",
+ "prefix": "",
+ "prefixFontSize": "50%",
+ "rangeMaps": [
+ {
+ "from": "null",
+ "text": "N/A",
+ "to": "null"
+ }
+ ],
+ "sparkline": {
+ "fillColor": "rgba(31, 118, 189, 0.18)",
+ "full": false,
+ "lineColor": "rgb(50, 168, 82)",
+ "show": false
+ },
+ "tableColumn": "",
+ "targets": [
+ {
+ "expr": "max(pg_settings_server_version_num)",
+ "legendFormat": "",
+ "refId": "A"
+ }
+ ],
+ "thresholds": "",
+ "title": "PostgreSQL Version",
+ "type": "stat",
+ "valueFontSize": "80%",
+ "valueMaps": [
+ {
+ "op": "=",
+ "text": "N/A",
+ "value": "null"
+ }
+ ],
+ "valueName": "current"
+ },
+ {
+ "colorBackground": false,
+ "colorValue": false,
+ "colors": [
+ "#299c46",
+ "rgba(237, 129, 40, 0.89)",
+ "#d44a3a"
+ ],
+ "datasource": "Prometheus",
+ "description": "Transactions committed + roolback per minute\n\nSource: pg_stat_database,xact_commit + xact_rollback",
+ "fieldConfig": {
+ "defaults": {
+ "mappings": [],
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "green",
+ "value": null
+ },
+ {
+ "color": "red",
+ "value": 80
+ }
+ ]
+ }
+ },
+ "overrides": []
+ },
+ "format": "none",
+ "gauge": {
+ "maxValue": 100,
+ "minValue": 0,
+ "show": false,
+ "thresholdLabels": false,
+ "thresholdMarkers": true
+ },
+ "gridPos": {
+ "h": 3,
+ "w": 4,
+ "x": 4,
+ "y": 85
+ },
+ "id": 14,
+ "interval": "",
+ "links": [],
+ "mappingType": 1,
+ "mappingTypes": [
+ {
+ "name": "value to text",
+ "value": 1
+ },
+ {
+ "name": "range to text",
+ "value": 2
+ }
+ ],
+ "maxDataPoints": 100,
+ "nullPointMode": "connected",
+ "options": {
+ "colorMode": "value",
+ "graphMode": "area",
+ "justifyMode": "auto",
+ "orientation": "auto",
+ "reduceOptions": {
+ "calcs": [
+ "lastNotNull"
+ ],
+ "fields": "",
+ "values": false
+ },
+ "textMode": "auto",
+ "wideLayout": true
+ },
+ "pluginVersion": "10.2.3",
+ "postfix": "",
+ "postfixFontSize": "50%",
+ "prefix": "",
+ "prefixFontSize": "50%",
+ "rangeMaps": [
+ {
+ "from": "null",
+ "text": "N/A",
+ "to": "null"
+ }
+ ],
+ "sparkline": {
+ "fillColor": "rgba(31, 118, 189, 0.18)",
+ "full": false,
+ "lineColor": "rgb(31, 120, 193)",
+ "show": true
+ },
+ "tableColumn": "",
+ "targets": [
+ {
+ "expr": "sum((rate(pg_stat_database_xact_commit{instance=\"$Instance\"}[$Interval])))+sum((rate(pg_stat_database_xact_rollback{instance=\"$Instance\"}[$Interval])))",
+ "interval": "",
+ "legendFormat": "",
+ "refId": "A"
+ }
+ ],
+ "thresholds": "",
+ "title": "Transaction rate (Postgres)",
+ "type": "stat",
+ "valueFontSize": "80%",
+ "valueMaps": [
+ {
+ "op": "=",
+ "text": "N/A",
+ "value": "null"
+ }
+ ],
+ "valueName": "current"
+ },
+ {
+ "colorBackground": false,
+ "colorValue": false,
+ "colors": [
+ "#299c46",
+ "rgba(237, 129, 40, 0.89)",
+ "#d44a3a"
+ ],
+ "datasource": "Prometheus",
+ "description": "Statements executed per Minute.\n\nSource: pg_stat_statements.calls",
+ "fieldConfig": {
+ "defaults": {
+ "mappings": [],
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "green",
+ "value": null
+ },
+ {
+ "color": "red",
+ "value": 80
+ }
+ ]
+ }
+ },
+ "overrides": []
+ },
+ "format": "none",
+ "gauge": {
+ "maxValue": 100,
+ "minValue": 0,
+ "show": false,
+ "thresholdLabels": false,
+ "thresholdMarkers": true
+ },
+ "gridPos": {
+ "h": 3,
+ "w": 4,
+ "x": 8,
+ "y": 85
+ },
+ "id": 93,
+ "links": [],
+ "mappingType": 1,
+ "mappingTypes": [
+ {
+ "name": "value to text",
+ "value": 1
+ },
+ {
+ "name": "range to text",
+ "value": 2
+ }
+ ],
+ "maxDataPoints": 100,
+ "nullPointMode": "connected",
+ "options": {
+ "colorMode": "value",
+ "graphMode": "area",
+ "justifyMode": "auto",
+ "orientation": "auto",
+ "reduceOptions": {
+ "calcs": [
+ "lastNotNull"
+ ],
+ "fields": "",
+ "values": false
+ },
+ "textMode": "auto",
+ "wideLayout": true
+ },
+ "pluginVersion": "10.2.3",
+ "postfix": "",
+ "postfixFontSize": "50%",
+ "prefix": "",
+ "prefixFontSize": "50%",
+ "rangeMaps": [
+ {
+ "from": "null",
+ "text": "N/A",
+ "to": "null"
+ }
+ ],
+ "sparkline": {
+ "fillColor": "rgba(31, 118, 189, 0.18)",
+ "full": false,
+ "lineColor": "rgb(31, 120, 193)",
+ "show": true
+ },
+ "tableColumn": "",
+ "targets": [
+ {
+ "expr": "sum((rate(pg_stat_statements_calls{instance=\"$Instance\"}[$Interval])))",
+ "interval": "",
+ "legendFormat": "",
+ "refId": "A"
+ }
+ ],
+ "thresholds": "",
+ "title": "Query rate (Postgres)",
+ "type": "stat",
+ "valueFontSize": "80%",
+ "valueMaps": [
+ {
+ "op": "=",
+ "text": "N/A",
+ "value": "null"
+ }
+ ],
+ "valueName": "current"
+ },
+ {
+ "colorBackground": false,
+ "colorValue": false,
+ "colors": [
+ "#299c46",
+ "rgba(237, 129, 40, 0.89)",
+ "#d44a3a"
+ ],
+ "datasource": "Prometheus",
+ "description": "Source: pg_stat_statements.total_time / pg_stat_statements.calls",
+ "fieldConfig": {
+ "defaults": {
+ "mappings": [],
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "green",
+ "value": null
+ },
+ {
+ "color": "red",
+ "value": 80
+ }
+ ]
+ }
+ },
+ "overrides": []
+ },
+ "format": "s",
+ "gauge": {
+ "maxValue": 100,
+ "minValue": 0,
+ "show": false,
+ "thresholdLabels": false,
+ "thresholdMarkers": true
+ },
+ "gridPos": {
+ "h": 3,
+ "w": 4,
+ "x": 12,
+ "y": 85
+ },
+ "id": 102,
+ "links": [],
+ "mappingType": 1,
+ "mappingTypes": [
+ {
+ "name": "value to text",
+ "value": 1
+ },
+ {
+ "name": "range to text",
+ "value": 2
+ }
+ ],
+ "maxDataPoints": 100,
+ "nullPointMode": "connected",
+ "options": {
+ "colorMode": "value",
+ "graphMode": "area",
+ "justifyMode": "auto",
+ "orientation": "auto",
+ "reduceOptions": {
+ "calcs": [
+ "lastNotNull"
+ ],
+ "fields": "",
+ "values": false
+ },
+ "textMode": "auto",
+ "wideLayout": true
+ },
+ "pluginVersion": "10.2.3",
+ "postfix": "",
+ "postfixFontSize": "50%",
+ "prefix": "",
+ "prefixFontSize": "50%",
+ "rangeMaps": [
+ {
+ "from": "null",
+ "text": "N/A",
+ "to": "null"
+ }
+ ],
+ "sparkline": {
+ "fillColor": "rgba(31, 118, 189, 0.18)",
+ "full": false,
+ "lineColor": "rgb(31, 120, 193)",
+ "show": true
+ },
+ "tableColumn": "",
+ "targets": [
+ {
+ "expr": "sum((delta(pg_stat_statements_total_time_seconds{instance=\"$Instance\"}[$Interval])))/sum((delta(pg_stat_statements_calls{instance=\"$Instance\"}[$Interval])))",
+ "interval": "",
+ "legendFormat": "",
+ "refId": "A"
+ }
+ ],
+ "thresholds": "",
+ "title": "Average query runtime (Postgres)",
+ "type": "stat",
+ "valueFontSize": "80%",
+ "valueMaps": [
+ {
+ "op": "=",
+ "text": "N/A",
+ "value": "null"
+ }
+ ],
+ "valueName": "current"
+ },
+ {
+ "colorBackground": false,
+ "colorValue": false,
+ "colors": [
+ "#299c46",
+ "rgba(237, 129, 40, 0.89)",
+ "#d44a3a"
+ ],
+ "datasource": "Prometheus",
+ "decimals": 2,
+ "description": "Size of all databases in $Instance.\n\nSource: pg_database_size()",
+ "fieldConfig": {
+ "defaults": {
+ "mappings": [],
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "green",
+ "value": null
+ }
+ ]
+ },
+ "unit": "decbytes"
+ },
+ "overrides": []
+ },
+ "format": "bytes",
+ "gauge": {
+ "maxValue": 100,
+ "minValue": 0,
+ "show": false,
+ "thresholdLabels": false,
+ "thresholdMarkers": true
+ },
+ "gridPos": {
+ "h": 3,
+ "w": 4,
+ "x": 16,
+ "y": 85
+ },
+ "id": 37,
+ "links": [],
+ "mappingType": 1,
+ "mappingTypes": [
+ {
+ "name": "value to text",
+ "value": 1
+ },
+ {
+ "name": "range to text",
+ "value": 2
+ }
+ ],
+ "maxDataPoints": 100,
+ "nullPointMode": "connected",
+ "options": {
+ "colorMode": "value",
+ "graphMode": "area",
+ "justifyMode": "auto",
+ "orientation": "auto",
+ "reduceOptions": {
+ "calcs": [
+ "lastNotNull"
+ ],
+ "fields": "",
+ "values": false
+ },
+ "textMode": "auto",
+ "wideLayout": true
+ },
+ "pluginVersion": "10.2.3",
+ "postfix": "",
+ "postfixFontSize": "50%",
+ "prefix": "",
+ "prefixFontSize": "50%",
+ "rangeMaps": [
+ {
+ "from": "null",
+ "text": "N/A",
+ "to": "null"
+ }
+ ],
+ "sparkline": {
+ "fillColor": "rgba(31, 118, 189, 0.18)",
+ "full": false,
+ "lineColor": "rgb(31, 120, 193)",
+ "show": true
+ },
+ "tableColumn": "",
+ "targets": [
+ {
+ "expr": "sum(pg_database_size_bytes{instance=\"$Instance\"})",
+ "refId": "A"
+ }
+ ],
+ "thresholds": "",
+ "title": "Total database size (Postgres)",
+ "type": "stat",
+ "valueFontSize": "80%",
+ "valueMaps": [
+ {
+ "op": "=",
+ "text": "N/A",
+ "value": "null"
+ }
+ ],
+ "valueName": "current"
+ },
+ {
+ "colorBackground": false,
+ "colorValue": false,
+ "colors": [
+ "#299c46",
+ "rgba(237, 129, 40, 0.89)",
+ "#d44a3a"
+ ],
+ "datasource": "Prometheus",
+ "description": "Max Replication lag behind master in seconds\n\nOnly available on a standby system.\n\nSource: pg_last_xact_replay_timestamp\n\nUse: pg_stat_replication for Details.",
+ "fieldConfig": {
+ "defaults": {
+ "mappings": [],
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "green",
+ "value": null
+ },
+ {
+ "color": "red",
+ "value": 80
+ }
+ ]
+ }
+ },
+ "overrides": []
+ },
+ "format": "s",
+ "gauge": {
+ "maxValue": 100,
+ "minValue": 0,
+ "show": false,
+ "thresholdLabels": false,
+ "thresholdMarkers": true
+ },
+ "gridPos": {
+ "h": 3,
+ "w": 4,
+ "x": 20,
+ "y": 85
+ },
+ "id": 84,
+ "links": [],
+ "mappingType": 1,
+ "mappingTypes": [
+ {
+ "name": "value to text",
+ "value": 1
+ },
+ {
+ "name": "range to text",
+ "value": 2
+ }
+ ],
+ "maxDataPoints": 100,
+ "nullPointMode": "connected",
+ "options": {
+ "colorMode": "value",
+ "graphMode": "area",
+ "justifyMode": "auto",
+ "orientation": "auto",
+ "reduceOptions": {
+ "calcs": [
+ "lastNotNull"
+ ],
+ "fields": "",
+ "values": false
+ },
+ "textMode": "auto",
+ "wideLayout": true
+ },
+ "pluginVersion": "10.2.3",
+ "postfix": "",
+ "postfixFontSize": "50%",
+ "prefix": "",
+ "prefixFontSize": "50%",
+ "rangeMaps": [
+ {
+ "from": "null",
+ "text": "N/A",
+ "to": "null"
+ }
+ ],
+ "sparkline": {
+ "fillColor": "rgba(31, 118, 189, 0.18)",
+ "full": false,
+ "lineColor": "rgb(31, 120, 193)",
+ "show": true
+ },
+ "tableColumn": "",
+ "targets": [
+ {
+ "expr": "max(pg_replication_lag{instance=\"$Instance\"})",
+ "interval": "",
+ "legendFormat": "",
+ "refId": "A"
+ }
+ ],
+ "thresholds": "",
+ "title": "Max Replication Lag (Postgres)",
+ "type": "stat",
+ "valueFontSize": "80%",
+ "valueMaps": [
+ {
+ "op": "=",
+ "text": "N/A",
+ "value": "null"
+ }
+ ],
+ "valueName": "max"
+ },
+ {
+ "datasource": "Prometheus",
+ "description": "Shared buffer hits vs reads from disc",
+ "fieldConfig": {
+ "defaults": {
+ "decimals": 2,
+ "mappings": [
+ {
+ "id": 0,
+ "op": "=",
+ "text": "N/A",
+ "type": 1,
+ "value": "null"
+ }
+ ],
+ "max": 100,
+ "min": 0,
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "semi-dark-red"
+ },
+ {
+ "color": "semi-dark-yellow",
+ "value": 80
+ },
+ {
+ "color": "semi-dark-green",
+ "value": 90
+ }
+ ]
+ },
+ "unit": "percent"
+ },
+ "overrides": []
+ },
+ "gridPos": {
+ "h": 7,
+ "w": 3,
+ "x": 0,
+ "y": 88
+ },
+ "id": 16,
+ "links": [],
+ "options": {
+ "minVizHeight": 75,
+ "minVizWidth": 75,
+ "orientation": "horizontal",
+ "reduceOptions": {
+ "calcs": [
+ "lastNotNull"
+ ],
+ "fields": "",
+ "values": false
+ },
+ "showThresholdLabels": false,
+ "showThresholdMarkers": true,
+ "sizing": "auto"
+ },
+ "pluginVersion": "10.2.3",
+ "targets": [
+ {
+ "expr": "sum(pg_stat_database_blks_hit{instance=~\"$Instance\"})/(sum(pg_stat_database_blks_hit{instance=~\"$Instance\"})+sum(pg_stat_database_blks_read{instance=~\"$Instance\"}))*100",
+ "refId": "A"
+ }
+ ],
+ "title": "Shared Buffer Hits (Postgres)",
+ "type": "gauge"
+ },
+ {
+ "datasource": "Prometheus",
+ "description": "Percentage of max_connections used",
+ "fieldConfig": {
+ "defaults": {
+ "decimals": 0,
+ "mappings": [
+ {
+ "id": 0,
+ "op": "=",
+ "text": "N/A",
+ "type": 1,
+ "value": "null"
+ }
+ ],
+ "max": 1,
+ "min": 0,
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "semi-dark-green",
+ "value": null
+ },
+ {
+ "color": "semi-dark-yellow",
+ "value": 0.75
+ },
+ {
+ "color": "semi-dark-red",
+ "value": 0.9
+ }
+ ]
+ },
+ "unit": "percentunit"
+ },
+ "overrides": []
+ },
+ "gridPos": {
+ "h": 7,
+ "w": 3,
+ "x": 3,
+ "y": 88
+ },
+ "id": 9,
+ "links": [],
+ "options": {
+ "minVizHeight": 75,
+ "minVizWidth": 75,
+ "orientation": "horizontal",
+ "reduceOptions": {
+ "calcs": [
+ "last"
+ ],
+ "fields": "",
+ "values": false
+ },
+ "showThresholdLabels": false,
+ "showThresholdMarkers": true,
+ "sizing": "auto"
+ },
+ "pluginVersion": "10.2.3",
+ "targets": [
+ {
+ "expr": "sum(pg_stat_database_numbackends)/max(pg_settings_max_connections)",
+ "refId": "A"
+ }
+ ],
+ "title": "Connections used (Postgres)",
+ "type": "gauge"
+ },
+ {
+ "datasource": "Prometheus",
+ "description": "Transaction committed vs rollbacked",
+ "fieldConfig": {
+ "defaults": {
+ "decimals": 2,
+ "mappings": [
+ {
+ "id": 0,
+ "op": "=",
+ "text": "N/A",
+ "type": 1,
+ "value": "null"
+ }
+ ],
+ "max": 1,
+ "min": 0,
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "semi-dark-red",
+ "value": null
+ },
+ {
+ "color": "#EAB839",
+ "value": 0.75
+ },
+ {
+ "color": "semi-dark-green",
+ "value": 0.9
+ }
+ ]
+ },
+ "unit": "percentunit"
+ },
+ "overrides": []
+ },
+ "gridPos": {
+ "h": 7,
+ "w": 3,
+ "x": 6,
+ "y": 88
+ },
+ "id": 15,
+ "links": [],
+ "options": {
+ "minVizHeight": 75,
+ "minVizWidth": 75,
+ "orientation": "horizontal",
+ "reduceOptions": {
+ "calcs": [
+ "lastNotNull"
+ ],
+ "fields": "",
+ "values": false
+ },
+ "showThresholdLabels": false,
+ "showThresholdMarkers": true,
+ "sizing": "auto"
+ },
+ "pluginVersion": "10.2.3",
+ "targets": [
+ {
+ "expr": "sum(pg_stat_database_xact_commit{instance=\"$Instance\"})/(sum(pg_stat_database_xact_commit{instance=\"$Instance\"}) + sum(pg_stat_database_xact_rollback{instance=\"$Instance\"}))",
+ "refId": "A"
+ }
+ ],
+ "title": "Commit Ratio (Postgres)",
+ "type": "gauge"
+ },
+ {
+ "colorBackground": false,
+ "colorValue": false,
+ "colors": [
+ "#299c46",
+ "rgba(237, 129, 40, 0.89)",
+ "#d44a3a"
+ ],
+ "datasource": "Prometheus",
+ "description": "Clients executing Statements.\n\nSource: pg_stat_activity",
+ "fieldConfig": {
+ "defaults": {
+ "mappings": [],
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "green",
+ "value": null
+ },
+ {
+ "color": "red",
+ "value": 80
+ }
+ ]
+ }
+ },
+ "overrides": []
+ },
+ "format": "none",
+ "gauge": {
+ "maxValue": 100,
+ "minValue": 0,
+ "show": false,
+ "thresholdLabels": false,
+ "thresholdMarkers": true
+ },
+ "gridPos": {
+ "h": 3,
+ "w": 4,
+ "x": 12,
+ "y": 88
+ },
+ "id": 23,
+ "links": [],
+ "mappingType": 1,
+ "mappingTypes": [
+ {
+ "name": "value to text",
+ "value": 1
+ },
+ {
+ "name": "range to text",
+ "value": 2
+ }
+ ],
+ "maxDataPoints": 100,
+ "nullPointMode": "connected",
+ "options": {
+ "colorMode": "value",
+ "graphMode": "area",
+ "justifyMode": "auto",
+ "orientation": "auto",
+ "reduceOptions": {
+ "calcs": [
+ "lastNotNull"
+ ],
+ "fields": "",
+ "values": false
+ },
+ "textMode": "auto",
+ "wideLayout": true
+ },
+ "pluginVersion": "10.2.3",
+ "postfix": "",
+ "postfixFontSize": "50%",
+ "prefix": "",
+ "prefixFontSize": "50%",
+ "rangeMaps": [
+ {
+ "from": "null",
+ "text": "N/A",
+ "to": "null"
+ }
+ ],
+ "sparkline": {
+ "fillColor": "rgba(31, 118, 189, 0.18)",
+ "full": false,
+ "lineColor": "rgb(31, 120, 193)",
+ "show": true
+ },
+ "tableColumn": "",
+ "targets": [
+ {
+ "expr": "sum(pg_stat_activity_count{state=\"active\",instance=\"$Instance\"})",
+ "refId": "A"
+ }
+ ],
+ "thresholds": "",
+ "title": "Active clients (Postgres)",
+ "type": "stat",
+ "valueFontSize": "80%",
+ "valueMaps": [
+ {
+ "op": "=",
+ "text": "N/A",
+ "value": "null"
+ }
+ ],
+ "valueName": "current"
+ },
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "fieldConfig": {
+ "defaults": {
+ "color": {
+ "mode": "thresholds"
+ },
+ "mappings": [],
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "green",
+ "value": null
+ }
+ ]
+ },
+ "unit": "dateTimeAsIso"
+ },
+ "overrides": []
+ },
+ "gridPos": {
+ "h": 3,
+ "w": 4,
+ "x": 16,
+ "y": 88
+ },
+ "id": 125,
+ "options": {
+ "colorMode": "value",
+ "graphMode": "none",
+ "justifyMode": "auto",
+ "orientation": "auto",
+ "reduceOptions": {
+ "calcs": [
+ "lastNotNull"
+ ],
+ "fields": "",
+ "values": false
+ },
+ "textMode": "auto",
+ "wideLayout": true
+ },
+ "pluginVersion": "10.2.3",
+ "targets": [
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "editorMode": "code",
+ "expr": "pg_postmaster_start_time_seconds*1000",
+ "legendFormat": "__auto",
+ "range": true,
+ "refId": "A"
+ }
+ ],
+ "title": "Postgres start time",
+ "type": "stat"
+ },
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "description": "",
+ "fieldConfig": {
+ "defaults": {
+ "color": {
+ "mode": "palette-classic"
+ },
+ "custom": {
+ "axisBorderShow": false,
+ "axisCenteredZero": false,
+ "axisColorMode": "text",
+ "axisLabel": "",
+ "axisPlacement": "auto",
+ "barAlignment": 0,
+ "drawStyle": "bars",
+ "fillOpacity": 51,
+ "gradientMode": "none",
+ "hideFrom": {
+ "legend": false,
+ "tooltip": false,
+ "viz": false
+ },
+ "insertNulls": false,
+ "lineInterpolation": "linear",
+ "lineWidth": 6,
+ "pointSize": 5,
+ "scaleDistribution": {
+ "type": "linear"
+ },
+ "showPoints": "auto",
+ "spanNulls": false,
+ "stacking": {
+ "group": "A",
+ "mode": "normal"
+ },
+ "thresholdsStyle": {
+ "mode": "off"
+ }
+ },
+ "mappings": [],
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "green",
+ "value": null
+ },
+ {
+ "color": "red",
+ "value": 80
+ }
+ ]
+ },
+ "unit": "short"
+ },
+ "overrides": []
+ },
+ "gridPos": {
+ "h": 8,
+ "w": 12,
+ "x": 12,
+ "y": 91
+ },
+ "id": 142,
+ "options": {
+ "legend": {
+ "calcs": [
+ "last",
+ "max"
+ ],
+ "displayMode": "list",
+ "placement": "bottom",
+ "showLegend": true
+ },
+ "tooltip": {
+ "mode": "single",
+ "sort": "none"
+ }
+ },
+ "targets": [
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "disableTextWrap": false,
+ "editorMode": "builder",
+ "expr": "pg_stat_user_tables_n_live_tup{datname=\"postgres\"}",
+ "fullMetaSearch": false,
+ "includeNullMetadata": true,
+ "instant": false,
+ "legendFormat": "Live",
+ "range": true,
+ "refId": "A",
+ "useBackend": false
+ },
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "disableTextWrap": false,
+ "editorMode": "builder",
+ "expr": "pg_stat_user_tables_n_dead_tup",
+ "fullMetaSearch": false,
+ "hide": false,
+ "includeNullMetadata": true,
+ "instant": false,
+ "legendFormat": "Dead",
+ "range": true,
+ "refId": "B",
+ "useBackend": false
+ }
+ ],
+ "title": "Estimated number of rows (Postgres)",
+ "type": "timeseries"
+ },
+ {
+ "aliasColors": {},
+ "bars": true,
+ "dashLength": 10,
+ "dashes": false,
+ "datasource": "Prometheus",
+ "decimals": 0,
+ "description": "View: pg_stat_activity",
+ "fieldConfig": {
+ "defaults": {
+ "links": []
+ },
+ "overrides": []
+ },
+ "fill": 1,
+ "fillGradient": 0,
+ "gridPos": {
+ "h": 9,
+ "w": 12,
+ "x": 0,
+ "y": 95
+ },
+ "hiddenSeries": false,
+ "id": 24,
+ "interval": "$Interval",
+ "legend": {
+ "alignAsTable": true,
+ "avg": true,
+ "current": true,
+ "hideEmpty": true,
+ "hideZero": true,
+ "max": true,
+ "min": false,
+ "rightSide": false,
+ "show": true,
+ "total": false,
+ "values": true
+ },
+ "lines": false,
+ "linewidth": 1,
+ "links": [
+ {
+ "targetBlank": true,
+ "title": "PostgreSQL Documentation",
+ "url": "https://www.postgresql.org/docs/current/monitoring-stats.html"
+ }
+ ],
+ "nullPointMode": "null as zero",
+ "options": {
+ "alertThreshold": true
+ },
+ "percentage": false,
+ "pluginVersion": "10.2.3",
+ "pointradius": 2,
+ "points": false,
+ "renderer": "flot",
+ "seriesOverrides": [],
+ "spaceLength": 10,
+ "stack": true,
+ "steppedLine": false,
+ "targets": [
+ {
+ "expr": "sum by (state) (pg_stat_activity_count{instance=\"$Instance\"})",
+ "legendFormat": "{{state}}",
+ "refId": "A"
+ }
+ ],
+ "thresholds": [],
+ "timeRegions": [],
+ "title": "Connections by state (stacked) (Postgres)",
+ "tooltip": {
+ "shared": true,
+ "sort": 0,
+ "value_type": "individual"
+ },
+ "type": "graph",
+ "xaxis": {
+ "mode": "time",
+ "show": true,
+ "values": []
+ },
+ "yaxes": [
+ {
+ "decimals": 0,
+ "format": "short",
+ "logBase": 1,
+ "show": true
+ },
+ {
+ "decimals": 0,
+ "format": "short",
+ "logBase": 1,
+ "show": true
+ }
+ ],
+ "yaxis": {
+ "align": false
+ }
+ },
+ {
+ "aliasColors": {},
+ "bars": true,
+ "dashLength": 10,
+ "dashes": false,
+ "datasource": "Prometheus",
+ "decimals": 0,
+ "description": "View: pg_stat_activity",
+ "fieldConfig": {
+ "defaults": {
+ "links": []
+ },
+ "overrides": []
+ },
+ "fill": 1,
+ "fillGradient": 0,
+ "gridPos": {
+ "h": 9,
+ "w": 12,
+ "x": 12,
+ "y": 99
+ },
+ "hiddenSeries": false,
+ "id": 121,
+ "interval": "$Interval",
+ "legend": {
+ "alignAsTable": true,
+ "avg": true,
+ "current": true,
+ "hideEmpty": true,
+ "hideZero": true,
+ "max": true,
+ "min": false,
+ "rightSide": false,
+ "show": true,
+ "total": false,
+ "values": true
+ },
+ "lines": false,
+ "linewidth": 1,
+ "links": [
+ {
+ "targetBlank": true,
+ "title": "PostgreSQL Documentation",
+ "url": "https://www.postgresql.org/docs/current/monitoring-stats.html"
+ }
+ ],
+ "nullPointMode": "null as zero",
+ "options": {
+ "alertThreshold": true
+ },
+ "percentage": false,
+ "pluginVersion": "10.2.3",
+ "pointradius": 2,
+ "points": false,
+ "renderer": "flot",
+ "seriesOverrides": [],
+ "spaceLength": 10,
+ "stack": true,
+ "steppedLine": false,
+ "targets": [
+ {
+ "expr": "sum by (datname) (pg_stat_activity_count{instance=\"$Instance\"})",
+ "legendFormat": "{{datname}}",
+ "refId": "A"
+ }
+ ],
+ "thresholds": [],
+ "timeRegions": [],
+ "title": "Connections by database (stacked) (Postgres)",
+ "tooltip": {
+ "shared": true,
+ "sort": 0,
+ "value_type": "individual"
+ },
+ "type": "graph",
+ "xaxis": {
+ "mode": "time",
+ "show": true,
+ "values": []
+ },
+ "yaxes": [
+ {
+ "decimals": 0,
+ "format": "short",
+ "logBase": 1,
+ "show": true
+ },
+ {
+ "decimals": 0,
+ "format": "short",
+ "logBase": 1,
+ "show": true
+ }
+ ],
+ "yaxis": {
+ "align": false
+ }
+ },
+ {
+ "aliasColors": {},
+ "bars": false,
+ "dashLength": 10,
+ "dashes": false,
+ "datasource": "Prometheus",
+ "decimals": 2,
+ "description": "1 Minute rate of transactions committed or rollback.",
+ "fieldConfig": {
+ "defaults": {
+ "links": []
+ },
+ "overrides": []
+ },
+ "fill": 1,
+ "fillGradient": 0,
+ "gridPos": {
+ "h": 9,
+ "w": 12,
+ "x": 0,
+ "y": 104
+ },
+ "hiddenSeries": false,
+ "id": 122,
+ "interval": "",
+ "legend": {
+ "alignAsTable": true,
+ "avg": true,
+ "current": true,
+ "hideEmpty": false,
+ "hideZero": false,
+ "max": true,
+ "min": false,
+ "rightSide": false,
+ "show": true,
+ "total": false,
+ "values": true
+ },
+ "lines": true,
+ "linewidth": 1,
+ "nullPointMode": "null",
+ "options": {
+ "alertThreshold": true
+ },
+ "percentage": false,
+ "pluginVersion": "10.2.3",
+ "pointradius": 2,
+ "points": false,
+ "renderer": "flot",
+ "seriesOverrides": [],
+ "spaceLength": 10,
+ "stack": false,
+ "steppedLine": false,
+ "targets": [
+ {
+ "expr": "sum ((rate(pg_stat_database_xact_commit[$Interval])))",
+ "interval": "",
+ "legendFormat": "committed",
+ "refId": "A"
+ },
+ {
+ "expr": "sum ((rate(pg_stat_database_xact_rollback[$Interval])))",
+ "hide": false,
+ "interval": "",
+ "legendFormat": "rollback",
+ "refId": "B"
+ }
+ ],
+ "thresholds": [],
+ "timeRegions": [],
+ "title": "Transactions (Postgres)",
+ "tooltip": {
+ "shared": true,
+ "sort": 0,
+ "value_type": "individual"
+ },
+ "type": "graph",
+ "xaxis": {
+ "mode": "time",
+ "show": true,
+ "values": []
+ },
+ "yaxes": [
+ {
+ "format": "short",
+ "logBase": 1,
+ "show": true
+ },
+ {
+ "format": "short",
+ "logBase": 1,
+ "show": true
+ }
+ ],
+ "yaxis": {
+ "align": false
+ }
+ },
+ {
+ "aliasColors": {},
+ "bars": false,
+ "dashLength": 10,
+ "dashes": false,
+ "datasource": "Prometheus",
+ "description": "Source: pg_stat_database",
+ "fieldConfig": {
+ "defaults": {
+ "links": []
+ },
+ "overrides": []
+ },
+ "fill": 1,
+ "fillGradient": 0,
+ "gridPos": {
+ "h": 9,
+ "w": 12,
+ "x": 12,
+ "y": 108
+ },
+ "hiddenSeries": false,
+ "id": 27,
+ "legend": {
+ "alignAsTable": true,
+ "avg": true,
+ "current": true,
+ "hideZero": false,
+ "max": true,
+ "min": false,
+ "show": true,
+ "total": false,
+ "values": true
+ },
+ "lines": true,
+ "linewidth": 1,
+ "nullPointMode": "null",
+ "options": {
+ "alertThreshold": true
+ },
+ "percentage": false,
+ "pluginVersion": "10.2.3",
+ "pointradius": 2,
+ "points": false,
+ "renderer": "flot",
+ "seriesOverrides": [],
+ "spaceLength": 10,
+ "stack": false,
+ "steppedLine": false,
+ "targets": [
+ {
+ "expr": "sum((rate(pg_stat_database_tup_inserted{instance=\"$Instance\"}[$Interval])))",
+ "interval": "",
+ "legendFormat": "Inserts",
+ "refId": "A"
+ },
+ {
+ "expr": "sum((rate(pg_stat_database_tup_updated{instance=\"$Instance\"}[$Interval])))",
+ "interval": "",
+ "legendFormat": "Updates",
+ "refId": "B"
+ },
+ {
+ "expr": "sum((rate(pg_stat_database_tup_deleted{instance=\"$Instance\"}[$Interval])))",
+ "interval": "",
+ "legendFormat": "Deletes",
+ "refId": "C"
+ }
+ ],
+ "thresholds": [],
+ "timeRegions": [],
+ "title": "Tuples inserts/updates/deletes (Postgres)",
+ "tooltip": {
+ "shared": true,
+ "sort": 0,
+ "value_type": "individual"
+ },
+ "type": "graph",
+ "xaxis": {
+ "mode": "time",
+ "show": true,
+ "values": []
+ },
+ "yaxes": [
+ {
+ "format": "none",
+ "logBase": 1,
+ "min": "0",
+ "show": true
+ },
+ {
+ "format": "short",
+ "logBase": 1,
+ "min": "0",
+ "show": true
+ }
+ ],
+ "yaxis": {
+ "align": false
+ }
+ },
+ {
+ "aliasColors": {},
+ "bars": false,
+ "dashLength": 10,
+ "dashes": false,
+ "datasource": "Prometheus",
+ "description": "* blk_read_time: Time spent reading data file blocks by backends in this database, in milliseconds\n* blk_write_time: Time spent writing data file blocks by backends in this database, in milliseconds\n\ntrack_io_timings needs to be activated",
+ "fieldConfig": {
+ "defaults": {
+ "links": []
+ },
+ "overrides": []
+ },
+ "fill": 1,
+ "fillGradient": 0,
+ "gridPos": {
+ "h": 9,
+ "w": 12,
+ "x": 0,
+ "y": 113
+ },
+ "hiddenSeries": false,
+ "id": 26,
+ "legend": {
+ "alignAsTable": true,
+ "avg": true,
+ "current": true,
+ "max": true,
+ "min": false,
+ "show": true,
+ "total": false,
+ "values": true
+ },
+ "lines": true,
+ "linewidth": 1,
+ "nullPointMode": "null",
+ "options": {
+ "alertThreshold": true
+ },
+ "percentage": false,
+ "pluginVersion": "10.2.3",
+ "pointradius": 2,
+ "points": false,
+ "renderer": "flot",
+ "seriesOverrides": [],
+ "spaceLength": 10,
+ "stack": false,
+ "steppedLine": false,
+ "targets": [
+ {
+ "expr": "sum ((rate(pg_stat_database_blk_read_time{instance=\"$Instance\"}[$Interval])))",
+ "interval": "",
+ "legendFormat": "blk_read_time",
+ "refId": "A"
+ },
+ {
+ "expr": "sum ((rate(pg_stat_database_blk_write_time{instance=\"$Instance\"}[$Interval])))",
+ "interval": "",
+ "legendFormat": "blk_read_time",
+ "refId": "B"
+ }
+ ],
+ "thresholds": [],
+ "timeRegions": [],
+ "title": "I/O Read/Write time (Postgres)",
+ "tooltip": {
+ "shared": true,
+ "sort": 0,
+ "value_type": "individual"
+ },
+ "type": "graph",
+ "xaxis": {
+ "mode": "time",
+ "show": true,
+ "values": []
+ },
+ "yaxes": [
+ {
+ "format": "ms",
+ "logBase": 1,
+ "min": "0",
+ "show": true
+ },
+ {
+ "format": "short",
+ "logBase": 1,
+ "min": "0",
+ "show": true
+ }
+ ],
+ "yaxis": {
+ "align": false
+ }
+ },
+ {
+ "aliasColors": {},
+ "bars": false,
+ "dashLength": 10,
+ "dashes": false,
+ "datasource": "Prometheus",
+ "description": "Source: pg_stat_database\n\n* tup_fetched: rows needed to satisfy queries\n* tup_returned: rows read/scanned",
+ "fieldConfig": {
+ "defaults": {
+ "links": []
+ },
+ "overrides": []
+ },
+ "fill": 1,
+ "fillGradient": 0,
+ "gridPos": {
+ "h": 9,
+ "w": 12,
+ "x": 12,
+ "y": 117
+ },
+ "hiddenSeries": false,
+ "id": 111,
+ "legend": {
+ "alignAsTable": true,
+ "avg": true,
+ "current": true,
+ "hideZero": false,
+ "max": true,
+ "min": false,
+ "show": true,
+ "total": false,
+ "values": true
+ },
+ "lines": true,
+ "linewidth": 1,
+ "nullPointMode": "null",
+ "options": {
+ "alertThreshold": true
+ },
+ "percentage": false,
+ "pluginVersion": "10.2.3",
+ "pointradius": 2,
+ "points": false,
+ "renderer": "flot",
+ "seriesOverrides": [],
+ "spaceLength": 10,
+ "stack": false,
+ "steppedLine": false,
+ "targets": [
+ {
+ "expr": "sum((rate(pg_stat_database_tup_fetched{instance=\"$Instance\"}[$Interval])))",
+ "interval": "",
+ "legendFormat": "Fetched",
+ "refId": "A"
+ },
+ {
+ "expr": "sum((rate(pg_stat_database_tup_returned{instance=\"$Instance\"}[$Interval])))",
+ "interval": "",
+ "legendFormat": "Returned",
+ "refId": "B"
+ }
+ ],
+ "thresholds": [],
+ "timeRegions": [],
+ "title": "Tuples fetched/returned (Postgres)",
+ "tooltip": {
+ "shared": true,
+ "sort": 0,
+ "value_type": "individual"
+ },
+ "type": "graph",
+ "xaxis": {
+ "mode": "time",
+ "show": true,
+ "values": []
+ },
+ "yaxes": [
+ {
+ "format": "short",
+ "logBase": 1,
+ "min": "0",
+ "show": true
+ },
+ {
+ "format": "short",
+ "logBase": 1,
+ "min": "0",
+ "show": false
+ }
+ ],
+ "yaxis": {
+ "align": false
+ }
+ },
+ {
+ "aliasColors": {},
+ "bars": false,
+ "dashLength": 10,
+ "dashes": false,
+ "datasource": "Prometheus",
+ "description": "Source: pg_locks",
+ "fieldConfig": {
+ "defaults": {
+ "links": []
+ },
+ "overrides": []
+ },
+ "fill": 1,
+ "fillGradient": 0,
+ "gridPos": {
+ "h": 10,
+ "w": 12,
+ "x": 0,
+ "y": 122
+ },
+ "hiddenSeries": false,
+ "id": 123,
+ "legend": {
+ "alignAsTable": true,
+ "avg": true,
+ "current": true,
+ "max": true,
+ "min": false,
+ "show": true,
+ "total": false,
+ "values": true
+ },
+ "lines": true,
+ "linewidth": 1,
+ "links": [
+ {
+ "title": "PostgreSQL Lock Modes",
+ "url": "https://www.postgresql.org/docs/12/explicit-locking.html#LOCKING-TABLES"
+ }
+ ],
+ "nullPointMode": "null",
+ "options": {
+ "alertThreshold": true
+ },
+ "percentage": false,
+ "pluginVersion": "10.2.3",
+ "pointradius": 2,
+ "points": false,
+ "renderer": "flot",
+ "seriesOverrides": [],
+ "spaceLength": 10,
+ "stack": false,
+ "steppedLine": false,
+ "targets": [
+ {
+ "expr": "sum by (mode) (pg_locks_count{instance=\"$Instance\"})",
+ "legendFormat": "{{mode}}",
+ "refId": "A"
+ }
+ ],
+ "thresholds": [],
+ "timeRegions": [],
+ "title": "Locks by state (Postgres)",
+ "tooltip": {
+ "shared": true,
+ "sort": 0,
+ "value_type": "individual"
+ },
+ "type": "graph",
+ "xaxis": {
+ "mode": "time",
+ "show": true,
+ "values": []
+ },
+ "yaxes": [
+ {
+ "format": "none",
+ "logBase": 1,
+ "show": true
+ },
+ {
+ "format": "short",
+ "logBase": 1,
+ "show": true
+ }
+ ],
+ "yaxis": {
+ "align": false
+ }
+ },
+ {
+ "aliasColors": {},
+ "bars": false,
+ "dashLength": 10,
+ "dashes": false,
+ "datasource": "Prometheus",
+ "description": "Should be 0 \n\nSource: pg_stat_database\n\nWith log_lock_waits turned on, deadlocks will be logged to the PostgreSQL Logfiles.",
+ "fieldConfig": {
+ "defaults": {
+ "links": []
+ },
+ "overrides": []
+ },
+ "fill": 1,
+ "fillGradient": 0,
+ "gridPos": {
+ "h": 5,
+ "w": 12,
+ "x": 12,
+ "y": 126
+ },
+ "hiddenSeries": false,
+ "id": 30,
+ "legend": {
+ "alignAsTable": true,
+ "avg": true,
+ "current": true,
+ "hideEmpty": true,
+ "hideZero": true,
+ "max": true,
+ "min": false,
+ "show": true,
+ "total": false,
+ "values": true
+ },
+ "lines": true,
+ "linewidth": 1,
+ "links": [
+ {
+ "title": "PostgreSQL Locking",
+ "url": "https://www.postgresql.org/docs/12/explicit-locking.html"
+ }
+ ],
+ "nullPointMode": "null",
+ "options": {
+ "alertThreshold": true
+ },
+ "percentage": false,
+ "pluginVersion": "10.2.3",
+ "pointradius": 2,
+ "points": false,
+ "renderer": "flot",
+ "seriesOverrides": [],
+ "spaceLength": 10,
+ "stack": false,
+ "steppedLine": false,
+ "targets": [
+ {
+ "expr": "sum by (datname) ((rate(pg_stat_database_deadlocks{instance=\"$Instance\"}[$Interval])))",
+ "interval": "",
+ "legendFormat": "{{datname}}",
+ "refId": "A"
+ }
+ ],
+ "thresholds": [],
+ "timeRegions": [],
+ "title": "Deadlocks by database (Postgres)",
+ "tooltip": {
+ "shared": true,
+ "sort": 0,
+ "value_type": "individual"
+ },
+ "type": "graph",
+ "xaxis": {
+ "mode": "time",
+ "show": true,
+ "values": []
+ },
+ "yaxes": [
+ {
+ "format": "none",
+ "logBase": 1,
+ "min": "0",
+ "show": true
+ },
+ {
+ "format": "short",
+ "logBase": 1,
+ "min": "0",
+ "show": true
+ }
+ ],
+ "yaxis": {
+ "align": false
+ }
+ },
+ {
+ "aliasColors": {},
+ "bars": false,
+ "dashLength": 10,
+ "dashes": false,
+ "datasource": "Prometheus",
+ "description": "Should be 0. If temporary files are created, it can indicate insufficient work_mem. With log_temp_files the creation of temporary files are logged to the PostgreSQL Logfiles.",
+ "fieldConfig": {
+ "defaults": {
+ "links": []
+ },
+ "overrides": []
+ },
+ "fill": 1,
+ "fillGradient": 0,
+ "gridPos": {
+ "h": 5,
+ "w": 12,
+ "x": 12,
+ "y": 131
+ },
+ "hiddenSeries": false,
+ "id": 31,
+ "legend": {
+ "alignAsTable": true,
+ "avg": true,
+ "current": true,
+ "hideEmpty": true,
+ "hideZero": true,
+ "max": true,
+ "min": false,
+ "show": true,
+ "total": false,
+ "values": true
+ },
+ "lines": true,
+ "linewidth": 1,
+ "links": [
+ {
+ "title": "PostgreSQL Ressources",
+ "url": "https://www.postgresql.org/docs/current/runtime-config-resource.html"
+ }
+ ],
+ "nullPointMode": "null",
+ "options": {
+ "alertThreshold": true
+ },
+ "percentage": false,
+ "pluginVersion": "10.2.3",
+ "pointradius": 2,
+ "points": false,
+ "renderer": "flot",
+ "seriesOverrides": [],
+ "spaceLength": 10,
+ "stack": false,
+ "steppedLine": false,
+ "targets": [
+ {
+ "expr": "sum by (datname) ((rate(pg_stat_database_temp_files{instance=\"$Instance\"}[$Interval])))",
+ "interval": "",
+ "legendFormat": "{{datname}}",
+ "refId": "A"
+ }
+ ],
+ "thresholds": [],
+ "timeRegions": [],
+ "title": "Temporary files by database (Postgres)",
+ "tooltip": {
+ "shared": true,
+ "sort": 0,
+ "value_type": "individual"
+ },
+ "type": "graph",
+ "xaxis": {
+ "mode": "time",
+ "show": true,
+ "values": []
+ },
+ "yaxes": [
+ {
+ "format": "none",
+ "logBase": 1,
+ "min": "0",
+ "show": true
+ },
+ {
+ "format": "short",
+ "logBase": 1,
+ "min": "0",
+ "show": true
+ }
+ ],
+ "yaxis": {
+ "align": false
+ }
+ },
+ {
+ "aliasColors": {},
+ "bars": false,
+ "dashLength": 10,
+ "dashes": false,
+ "datasource": "Prometheus",
+ "description": "Lag behind master in seconds.\n\nOnly available on a standby System.",
+ "fieldConfig": {
+ "defaults": {
+ "links": []
+ },
+ "overrides": []
+ },
+ "fill": 1,
+ "fillGradient": 0,
+ "gridPos": {
+ "h": 10,
+ "w": 12,
+ "x": 0,
+ "y": 132
+ },
+ "hiddenSeries": false,
+ "id": 120,
+ "interval": "1m",
+ "legend": {
+ "alignAsTable": true,
+ "avg": true,
+ "current": true,
+ "max": true,
+ "min": false,
+ "show": true,
+ "total": false,
+ "values": true
+ },
+ "lines": true,
+ "linewidth": 1,
+ "links": [],
+ "nullPointMode": "null",
+ "options": {
+ "alertThreshold": true
+ },
+ "percentage": false,
+ "pluginVersion": "10.2.3",
+ "pointradius": 2,
+ "points": false,
+ "renderer": "flot",
+ "seriesOverrides": [],
+ "spaceLength": 10,
+ "stack": false,
+ "steppedLine": false,
+ "targets": [
+ {
+ "expr": "max(pg_replication_lag{instance=\"$Instance\"})",
+ "instant": false,
+ "intervalFactor": 1,
+ "legendFormat": "lag ",
+ "refId": "A"
+ }
+ ],
+ "thresholds": [],
+ "timeRegions": [],
+ "title": "Replication lag (Postgres)",
+ "tooltip": {
+ "shared": true,
+ "sort": 0,
+ "value_type": "individual"
+ },
+ "type": "graph",
+ "xaxis": {
+ "mode": "time",
+ "show": true,
+ "values": []
+ },
+ "yaxes": [
+ {
+ "format": "s",
+ "logBase": 1,
+ "min": "0",
+ "show": true
+ },
+ {
+ "format": "short",
+ "logBase": 1,
+ "min": "0",
+ "show": true
+ }
+ ],
+ "yaxis": {
+ "align": false
+ }
+ }
+ ],
+ "refresh": "1m",
+ "revision": 1,
+ "schemaVersion": 39,
+ "tags": [],
+ "templating": {
+ "list": [
+ {
+ "current": {
+ "selected": false,
+ "text": "postgres-exporter:9187",
+ "value": "postgres-exporter:9187"
+ },
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "definition": "label_values({job=\"postgres-exporter\"}, instance)",
+ "hide": 0,
+ "includeAll": false,
+ "multi": false,
+ "name": "Instance",
+ "options": [],
+ "query": "label_values({job=\"postgres-exporter\"}, instance)",
+ "refresh": 1,
+ "regex": "",
+ "skipUrlSync": false,
+ "sort": 0,
+ "tagValuesQuery": "",
+ "tags": [],
+ "tagsQuery": "",
+ "type": "query",
+ "useTags": false
+ },
+ {
+ "current": {
+ "selected": false,
+ "text": "All",
+ "value": "$__all"
+ },
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "definition": "label_values(datname)",
+ "hide": 0,
+ "includeAll": true,
+ "multi": true,
+ "name": "Database",
+ "options": [],
+ "query": "label_values(datname)",
+ "refresh": 1,
+ "regex": "/^(?!template*|postgres).*$/",
+ "skipUrlSync": false,
+ "sort": 1,
+ "tagValuesQuery": "",
+ "tags": [],
+ "tagsQuery": "",
+ "type": "query",
+ "useTags": false
+ },
+ {
+ "auto": true,
+ "auto_count": 30,
+ "auto_min": "10s",
+ "current": {
+ "selected": false,
+ "text": "10m",
+ "value": "10m"
+ },
+ "hide": 0,
+ "name": "Interval",
+ "options": [
+ {
+ "selected": false,
+ "text": "auto",
+ "value": "$__auto_interval_Interval"
+ },
+ {
+ "selected": false,
+ "text": "30sec",
+ "value": "30sec"
+ },
+ {
+ "selected": false,
+ "text": "1m",
+ "value": "1m"
+ },
+ {
+ "selected": true,
+ "text": "10m",
+ "value": "10m"
+ },
+ {
+ "selected": false,
+ "text": "30m",
+ "value": "30m"
+ },
+ {
+ "selected": false,
+ "text": "1h",
+ "value": "1h"
+ },
+ {
+ "selected": false,
+ "text": "6h",
+ "value": "6h"
+ },
+ {
+ "selected": false,
+ "text": "12h",
+ "value": "12h"
+ },
+ {
+ "selected": false,
+ "text": "1d",
+ "value": "1d"
+ }
+ ],
+ "query": "30sec,1m,10m,30m,1h,6h,12h,1d",
+ "queryValue": "",
+ "refresh": 2,
+ "skipUrlSync": false,
+ "type": "interval"
+ }
+ ]
+ },
+ "time": {
+ "from": "now-15m",
+ "to": "now"
+ },
+ "timepicker": {
+ "refresh_intervals": [
+ "1m",
+ "5m",
+ "15m",
+ "30m",
+ "1h",
+ "2h",
+ "1d"
+ ]
+ },
+ "timezone": "browser",
+ "title": "nwaku-monitoring",
+ "uid": "yns_4vFVk",
+ "version": 1,
+ "weekStart": ""
+}
\ No newline at end of file
diff --git a/third-party/nwaku/apps/sonda/monitoring/configuration/dashboards/sonda-monitoring.json b/third-party/nwaku/apps/sonda/monitoring/configuration/dashboards/sonda-monitoring.json
new file mode 100644
index 0000000..1d87f2b
--- /dev/null
+++ b/third-party/nwaku/apps/sonda/monitoring/configuration/dashboards/sonda-monitoring.json
@@ -0,0 +1,1571 @@
+{
+ "annotations": {
+ "list": [
+ {
+ "builtIn": 1,
+ "datasource": {
+ "type": "grafana",
+ "uid": "-- Grafana --"
+ },
+ "enable": true,
+ "hide": true,
+ "iconColor": "rgba(0, 211, 255, 1)",
+ "name": "Annotations & Alerts",
+ "type": "dashboard"
+ }
+ ]
+ },
+ "editable": true,
+ "fiscalYearStartMonth": 0,
+ "graphTooltip": 0,
+ "links": [],
+ "liveNow": false,
+ "panels": [
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "description": "Sonda messages successfully sent to the network",
+ "fieldConfig": {
+ "defaults": {
+ "color": {
+ "mode": "palette-classic"
+ },
+ "custom": {
+ "axisBorderShow": false,
+ "axisCenteredZero": false,
+ "axisColorMode": "text",
+ "axisLabel": "",
+ "axisPlacement": "auto",
+ "barAlignment": 0,
+ "drawStyle": "line",
+ "fillOpacity": 0,
+ "gradientMode": "none",
+ "hideFrom": {
+ "legend": false,
+ "tooltip": false,
+ "viz": false
+ },
+ "insertNulls": false,
+ "lineInterpolation": "linear",
+ "lineWidth": 1,
+ "pointSize": 5,
+ "scaleDistribution": {
+ "type": "linear"
+ },
+ "showPoints": "auto",
+ "spanNulls": false,
+ "stacking": {
+ "group": "A",
+ "mode": "none"
+ },
+ "thresholdsStyle": {
+ "mode": "off"
+ }
+ },
+ "mappings": [],
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "green",
+ "value": null
+ },
+ {
+ "color": "red",
+ "value": 80
+ }
+ ]
+ }
+ },
+ "overrides": []
+ },
+ "gridPos": {
+ "h": 8,
+ "w": 12,
+ "x": 0,
+ "y": 0
+ },
+ "id": 9,
+ "options": {
+ "legend": {
+ "calcs": [],
+ "displayMode": "list",
+ "placement": "bottom",
+ "showLegend": true
+ },
+ "tooltip": {
+ "mode": "single",
+ "sort": "none"
+ }
+ },
+ "targets": [
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "disableTextWrap": false,
+ "editorMode": "builder",
+ "expr": "successful_sonda_msgs_total",
+ "fullMetaSearch": false,
+ "includeNullMetadata": true,
+ "instant": false,
+ "legendFormat": "__auto",
+ "range": true,
+ "refId": "A",
+ "useBackend": false
+ }
+ ],
+ "title": "Sent Sonda Messages",
+ "type": "timeseries"
+ },
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "description": "Sonda messages that failed to be sent to the network",
+ "fieldConfig": {
+ "defaults": {
+ "color": {
+ "mode": "palette-classic"
+ },
+ "custom": {
+ "axisBorderShow": false,
+ "axisCenteredZero": false,
+ "axisColorMode": "text",
+ "axisLabel": "",
+ "axisPlacement": "auto",
+ "barAlignment": 0,
+ "drawStyle": "line",
+ "fillOpacity": 0,
+ "gradientMode": "none",
+ "hideFrom": {
+ "legend": false,
+ "tooltip": false,
+ "viz": false
+ },
+ "insertNulls": false,
+ "lineInterpolation": "linear",
+ "lineWidth": 1,
+ "pointSize": 5,
+ "scaleDistribution": {
+ "type": "linear"
+ },
+ "showPoints": "auto",
+ "spanNulls": false,
+ "stacking": {
+ "group": "A",
+ "mode": "none"
+ },
+ "thresholdsStyle": {
+ "mode": "off"
+ }
+ },
+ "mappings": [],
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "green",
+ "value": null
+ },
+ {
+ "color": "red",
+ "value": 80
+ }
+ ]
+ }
+ },
+ "overrides": [
+ {
+ "__systemRef": "hideSeriesFrom",
+ "matcher": {
+ "id": "byNames",
+ "options": {
+ "mode": "exclude",
+ "names": [
+ "{__name__=\"failed_sonda_msgs_total\", instance=\"sonda:8004\", job=\"nwaku\"}"
+ ],
+ "prefix": "All except:",
+ "readOnly": true
+ }
+ },
+ "properties": [
+ {
+ "id": "custom.hideFrom",
+ "value": {
+ "legend": false,
+ "tooltip": false,
+ "viz": true
+ }
+ }
+ ]
+ }
+ ]
+ },
+ "gridPos": {
+ "h": 8,
+ "w": 12,
+ "x": 12,
+ "y": 0
+ },
+ "id": 2,
+ "options": {
+ "legend": {
+ "calcs": [],
+ "displayMode": "list",
+ "placement": "bottom",
+ "showLegend": true
+ },
+ "tooltip": {
+ "mode": "single",
+ "sort": "none"
+ }
+ },
+ "targets": [
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "disableTextWrap": false,
+ "editorMode": "builder",
+ "expr": "failed_sonda_msgs_total",
+ "fullMetaSearch": false,
+ "includeNullMetadata": true,
+ "instant": false,
+ "legendFormat": "__auto",
+ "range": true,
+ "refId": "A",
+ "useBackend": false
+ }
+ ],
+ "title": "Failed Sonda Messages",
+ "type": "timeseries"
+ },
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "description": "Sonda messages successfully sent to the network",
+ "fieldConfig": {
+ "defaults": {
+ "color": {
+ "mode": "palette-classic"
+ },
+ "custom": {
+ "axisBorderShow": false,
+ "axisCenteredZero": false,
+ "axisColorMode": "text",
+ "axisLabel": "",
+ "axisPlacement": "auto",
+ "barAlignment": 0,
+ "drawStyle": "line",
+ "fillOpacity": 0,
+ "gradientMode": "none",
+ "hideFrom": {
+ "legend": false,
+ "tooltip": false,
+ "viz": false
+ },
+ "insertNulls": false,
+ "lineInterpolation": "linear",
+ "lineWidth": 1,
+ "pointSize": 5,
+ "scaleDistribution": {
+ "type": "linear"
+ },
+ "showPoints": "auto",
+ "spanNulls": false,
+ "stacking": {
+ "group": "A",
+ "mode": "none"
+ },
+ "thresholdsStyle": {
+ "mode": "off"
+ }
+ },
+ "mappings": [],
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "green",
+ "value": null
+ },
+ {
+ "color": "red",
+ "value": 80
+ }
+ ]
+ }
+ },
+ "overrides": []
+ },
+ "gridPos": {
+ "h": 8,
+ "w": 12,
+ "x": 0,
+ "y": 8
+ },
+ "id": 1,
+ "options": {
+ "legend": {
+ "calcs": [],
+ "displayMode": "list",
+ "placement": "bottom",
+ "showLegend": true
+ },
+ "tooltip": {
+ "mode": "single",
+ "sort": "none"
+ }
+ },
+ "targets": [
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "disableTextWrap": false,
+ "editorMode": "code",
+ "expr": "increase(successful_sonda_msgs_total[5m])/5",
+ "fullMetaSearch": false,
+ "includeNullMetadata": true,
+ "instant": false,
+ "interval": "",
+ "legendFormat": "__auto",
+ "range": true,
+ "refId": "A",
+ "useBackend": false
+ }
+ ],
+ "title": "Sent Sonda Messages Rate per Minute",
+ "type": "timeseries"
+ },
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "description": "Sonda messages that failed to be sent to the network",
+ "fieldConfig": {
+ "defaults": {
+ "color": {
+ "mode": "palette-classic"
+ },
+ "custom": {
+ "axisBorderShow": false,
+ "axisCenteredZero": false,
+ "axisColorMode": "text",
+ "axisLabel": "",
+ "axisPlacement": "auto",
+ "barAlignment": 0,
+ "drawStyle": "line",
+ "fillOpacity": 0,
+ "gradientMode": "none",
+ "hideFrom": {
+ "legend": false,
+ "tooltip": false,
+ "viz": false
+ },
+ "insertNulls": false,
+ "lineInterpolation": "linear",
+ "lineWidth": 1,
+ "pointSize": 5,
+ "scaleDistribution": {
+ "type": "linear"
+ },
+ "showPoints": "auto",
+ "spanNulls": false,
+ "stacking": {
+ "group": "A",
+ "mode": "none"
+ },
+ "thresholdsStyle": {
+ "mode": "off"
+ }
+ },
+ "mappings": [],
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "green",
+ "value": null
+ },
+ {
+ "color": "red",
+ "value": 80
+ }
+ ]
+ }
+ },
+ "overrides": [
+ {
+ "__systemRef": "hideSeriesFrom",
+ "matcher": {
+ "id": "byNames",
+ "options": {
+ "mode": "exclude",
+ "names": [
+ "{instance=\"sonda:8004\", job=\"nwaku\"}"
+ ],
+ "prefix": "All except:",
+ "readOnly": true
+ }
+ },
+ "properties": [
+ {
+ "id": "custom.hideFrom",
+ "value": {
+ "legend": false,
+ "tooltip": false,
+ "viz": true
+ }
+ }
+ ]
+ }
+ ]
+ },
+ "gridPos": {
+ "h": 8,
+ "w": 12,
+ "x": 12,
+ "y": 8
+ },
+ "id": 10,
+ "options": {
+ "legend": {
+ "calcs": [],
+ "displayMode": "list",
+ "placement": "bottom",
+ "showLegend": true
+ },
+ "tooltip": {
+ "mode": "single",
+ "sort": "none"
+ }
+ },
+ "targets": [
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "disableTextWrap": false,
+ "editorMode": "code",
+ "expr": "increase(failed_sonda_msgs_total[5m]) / 5",
+ "fullMetaSearch": false,
+ "includeNullMetadata": true,
+ "instant": false,
+ "legendFormat": "__auto",
+ "range": true,
+ "refId": "A",
+ "useBackend": false
+ }
+ ],
+ "title": "Failed Sonda Messages per Minute",
+ "type": "timeseries"
+ },
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "description": "Store responses including the latest Sonda message ",
+ "fieldConfig": {
+ "defaults": {
+ "color": {
+ "mode": "palette-classic"
+ },
+ "custom": {
+ "axisBorderShow": false,
+ "axisCenteredZero": false,
+ "axisColorMode": "text",
+ "axisLabel": "",
+ "axisPlacement": "auto",
+ "barAlignment": 0,
+ "drawStyle": "line",
+ "fillOpacity": 0,
+ "gradientMode": "none",
+ "hideFrom": {
+ "legend": false,
+ "tooltip": false,
+ "viz": false
+ },
+ "insertNulls": false,
+ "lineInterpolation": "linear",
+ "lineWidth": 1,
+ "pointSize": 5,
+ "scaleDistribution": {
+ "type": "linear"
+ },
+ "showPoints": "auto",
+ "spanNulls": false,
+ "stacking": {
+ "group": "A",
+ "mode": "none"
+ },
+ "thresholdsStyle": {
+ "mode": "off"
+ }
+ },
+ "mappings": [],
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "green",
+ "value": null
+ },
+ {
+ "color": "red",
+ "value": 80
+ }
+ ]
+ }
+ },
+ "overrides": []
+ },
+ "gridPos": {
+ "h": 8,
+ "w": 12,
+ "x": 0,
+ "y": 16
+ },
+ "id": 3,
+ "options": {
+ "legend": {
+ "calcs": [],
+ "displayMode": "list",
+ "placement": "bottom",
+ "showLegend": true
+ },
+ "tooltip": {
+ "mode": "single",
+ "sort": "none"
+ }
+ },
+ "targets": [
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "disableTextWrap": false,
+ "editorMode": "code",
+ "expr": "successful_store_queries_total{node=~\"^$node$\"}",
+ "fullMetaSearch": false,
+ "includeNullMetadata": true,
+ "instant": false,
+ "legendFormat": "{__name__=\"{{__name__}}\" , node=\"{{node}}\"}",
+ "range": true,
+ "refId": "A",
+ "useBackend": false
+ }
+ ],
+ "title": "Successful Store Responses",
+ "type": "timeseries"
+ },
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "description": "Store queries with a non-200 response",
+ "fieldConfig": {
+ "defaults": {
+ "color": {
+ "mode": "palette-classic"
+ },
+ "custom": {
+ "axisBorderShow": false,
+ "axisCenteredZero": false,
+ "axisColorMode": "text",
+ "axisLabel": "",
+ "axisPlacement": "auto",
+ "barAlignment": 0,
+ "drawStyle": "line",
+ "fillOpacity": 0,
+ "gradientMode": "none",
+ "hideFrom": {
+ "legend": false,
+ "tooltip": false,
+ "viz": false
+ },
+ "insertNulls": false,
+ "lineInterpolation": "linear",
+ "lineWidth": 1,
+ "pointSize": 5,
+ "scaleDistribution": {
+ "type": "linear"
+ },
+ "showPoints": "auto",
+ "spanNulls": false,
+ "stacking": {
+ "group": "A",
+ "mode": "none"
+ },
+ "thresholdsStyle": {
+ "mode": "off"
+ }
+ },
+ "mappings": [],
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "green",
+ "value": null
+ },
+ {
+ "color": "red",
+ "value": 80
+ }
+ ]
+ }
+ },
+ "overrides": [
+ {
+ "__systemRef": "hideSeriesFrom",
+ "matcher": {
+ "id": "byNames",
+ "options": {
+ "mode": "exclude",
+ "names": [
+ "{__name__=\"failed_store_queries_total\" , error=\"504 PEER_DIAL_FAILURE: 16Uiu2HAmAUdrQ3uwzuE4Gy4D56hX6uLKEeerJAnhKEHZ3DxF1EfT\", node=\"/dns4/store-01.do-ams3.shards.test.status.im/tcp/30303/p2p/16Uiu2HAmAUdrQ3uwzuE4Gy4D56hX6uLKEeerJAnhKEHZ3DxF1EfT\"}"
+ ],
+ "prefix": "All except:",
+ "readOnly": true
+ }
+ },
+ "properties": [
+ {
+ "id": "custom.hideFrom",
+ "value": {
+ "legend": false,
+ "tooltip": false,
+ "viz": true
+ }
+ }
+ ]
+ }
+ ]
+ },
+ "gridPos": {
+ "h": 8,
+ "w": 12,
+ "x": 12,
+ "y": 16
+ },
+ "id": 4,
+ "options": {
+ "legend": {
+ "calcs": [],
+ "displayMode": "list",
+ "placement": "bottom",
+ "showLegend": true
+ },
+ "tooltip": {
+ "mode": "single",
+ "sort": "none"
+ }
+ },
+ "targets": [
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "disableTextWrap": false,
+ "editorMode": "code",
+ "expr": "failed_store_queries_total{node=~\"^$node$\"}",
+ "fullMetaSearch": false,
+ "includeNullMetadata": true,
+ "instant": false,
+ "legendFormat": "{__name__=\"{{__name__}}\" , error=\"{{error}}\", node=\"{{node}}\"}",
+ "range": true,
+ "refId": "A",
+ "useBackend": false
+ }
+ ],
+ "title": "Failed Store Queries",
+ "type": "timeseries"
+ },
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "description": "Store responses including the latest Sonda message ",
+ "fieldConfig": {
+ "defaults": {
+ "color": {
+ "mode": "palette-classic"
+ },
+ "custom": {
+ "axisBorderShow": false,
+ "axisCenteredZero": false,
+ "axisColorMode": "text",
+ "axisLabel": "",
+ "axisPlacement": "auto",
+ "barAlignment": 0,
+ "drawStyle": "line",
+ "fillOpacity": 0,
+ "gradientMode": "none",
+ "hideFrom": {
+ "legend": false,
+ "tooltip": false,
+ "viz": false
+ },
+ "insertNulls": false,
+ "lineInterpolation": "linear",
+ "lineWidth": 1,
+ "pointSize": 5,
+ "scaleDistribution": {
+ "type": "linear"
+ },
+ "showPoints": "auto",
+ "spanNulls": false,
+ "stacking": {
+ "group": "A",
+ "mode": "none"
+ },
+ "thresholdsStyle": {
+ "mode": "off"
+ }
+ },
+ "mappings": [],
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "green",
+ "value": null
+ },
+ {
+ "color": "red",
+ "value": 80
+ }
+ ]
+ }
+ },
+ "overrides": [
+ {
+ "__systemRef": "hideSeriesFrom",
+ "matcher": {
+ "id": "byNames",
+ "options": {
+ "mode": "exclude",
+ "names": [
+ "{__name__=\"\" , node=\"/dns4/store-01.do-ams3.shards.test.status.im/tcp/30303/p2p/16Uiu2HAmAUdrQ3uwzuE4Gy4D56hX6uLKEeerJAnhKEHZ3DxF1EfT\"}"
+ ],
+ "prefix": "All except:",
+ "readOnly": true
+ }
+ },
+ "properties": [
+ {
+ "id": "custom.hideFrom",
+ "value": {
+ "legend": false,
+ "tooltip": false,
+ "viz": true
+ }
+ }
+ ]
+ }
+ ]
+ },
+ "gridPos": {
+ "h": 8,
+ "w": 12,
+ "x": 0,
+ "y": 24
+ },
+ "id": 11,
+ "options": {
+ "legend": {
+ "calcs": [],
+ "displayMode": "list",
+ "placement": "bottom",
+ "showLegend": true
+ },
+ "tooltip": {
+ "mode": "single",
+ "sort": "none"
+ }
+ },
+ "targets": [
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "disableTextWrap": false,
+ "editorMode": "code",
+ "expr": "increase(successful_store_queries_total{node=~\"^$node$\"}[5m]) / 5",
+ "fullMetaSearch": false,
+ "includeNullMetadata": true,
+ "instant": false,
+ "legendFormat": "{__name__=\"{{__name__}}\" , node=\"{{node}}\"}",
+ "range": true,
+ "refId": "A",
+ "useBackend": false
+ }
+ ],
+ "title": "Successful Store Responses per Minute",
+ "type": "timeseries"
+ },
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "description": "Store queries with a non-200 response",
+ "fieldConfig": {
+ "defaults": {
+ "color": {
+ "mode": "palette-classic"
+ },
+ "custom": {
+ "axisBorderShow": false,
+ "axisCenteredZero": false,
+ "axisColorMode": "text",
+ "axisLabel": "",
+ "axisPlacement": "auto",
+ "barAlignment": 0,
+ "drawStyle": "line",
+ "fillOpacity": 0,
+ "gradientMode": "none",
+ "hideFrom": {
+ "legend": false,
+ "tooltip": false,
+ "viz": false
+ },
+ "insertNulls": false,
+ "lineInterpolation": "linear",
+ "lineWidth": 1,
+ "pointSize": 5,
+ "scaleDistribution": {
+ "type": "linear"
+ },
+ "showPoints": "auto",
+ "spanNulls": false,
+ "stacking": {
+ "group": "A",
+ "mode": "none"
+ },
+ "thresholdsStyle": {
+ "mode": "off"
+ }
+ },
+ "mappings": [],
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "green",
+ "value": null
+ },
+ {
+ "color": "red",
+ "value": 80
+ }
+ ]
+ }
+ },
+ "overrides": []
+ },
+ "gridPos": {
+ "h": 8,
+ "w": 12,
+ "x": 12,
+ "y": 24
+ },
+ "id": 12,
+ "options": {
+ "legend": {
+ "calcs": [],
+ "displayMode": "list",
+ "placement": "bottom",
+ "showLegend": true
+ },
+ "tooltip": {
+ "mode": "single",
+ "sort": "none"
+ }
+ },
+ "targets": [
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "disableTextWrap": false,
+ "editorMode": "code",
+ "expr": "increase(failed_store_queries_total{node=~\"^$node$\"}[5m]) / 5",
+ "fullMetaSearch": false,
+ "includeNullMetadata": true,
+ "instant": false,
+ "legendFormat": "{__name__=\"{{__name__}}\" , error=\"{{error}}\", node=\"{{node}}\"}",
+ "range": true,
+ "refId": "A",
+ "useBackend": false
+ }
+ ],
+ "title": "Failed Store Queries per Minute",
+ "type": "timeseries"
+ },
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "description": "Store responses that didn't include our latest Sonda message",
+ "fieldConfig": {
+ "defaults": {
+ "color": {
+ "mode": "palette-classic"
+ },
+ "custom": {
+ "axisBorderShow": false,
+ "axisCenteredZero": false,
+ "axisColorMode": "text",
+ "axisLabel": "",
+ "axisPlacement": "auto",
+ "barAlignment": 0,
+ "drawStyle": "line",
+ "fillOpacity": 0,
+ "gradientMode": "none",
+ "hideFrom": {
+ "legend": false,
+ "tooltip": false,
+ "viz": false
+ },
+ "insertNulls": false,
+ "lineInterpolation": "linear",
+ "lineWidth": 1,
+ "pointSize": 5,
+ "scaleDistribution": {
+ "type": "linear"
+ },
+ "showPoints": "auto",
+ "spanNulls": false,
+ "stacking": {
+ "group": "A",
+ "mode": "none"
+ },
+ "thresholdsStyle": {
+ "mode": "off"
+ }
+ },
+ "mappings": [],
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "green",
+ "value": null
+ },
+ {
+ "color": "red",
+ "value": 80
+ }
+ ]
+ }
+ },
+ "overrides": [
+ {
+ "__systemRef": "hideSeriesFrom",
+ "matcher": {
+ "id": "byNames",
+ "options": {
+ "mode": "exclude",
+ "names": [
+ "{__name__=\"empty_store_responses_total\" , node=\"/dns4/store-01.do-ams3.shards.test.status.im/tcp/30303/p2p/16Uiu2HAmAUdrQ3uwzuE4Gy4D56hX6uLKEeerJAnhKEHZ3DxF1EfT\"}"
+ ],
+ "prefix": "All except:",
+ "readOnly": true
+ }
+ },
+ "properties": [
+ {
+ "id": "custom.hideFrom",
+ "value": {
+ "legend": false,
+ "tooltip": false,
+ "viz": true
+ }
+ }
+ ]
+ }
+ ]
+ },
+ "gridPos": {
+ "h": 8,
+ "w": 12,
+ "x": 0,
+ "y": 32
+ },
+ "id": 5,
+ "options": {
+ "legend": {
+ "calcs": [],
+ "displayMode": "list",
+ "placement": "bottom",
+ "showLegend": true
+ },
+ "tooltip": {
+ "mode": "single",
+ "sort": "none"
+ }
+ },
+ "targets": [
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "disableTextWrap": false,
+ "editorMode": "code",
+ "expr": "empty_store_responses_total{node=~\"^$node$\"}",
+ "fullMetaSearch": false,
+ "includeNullMetadata": true,
+ "instant": false,
+ "legendFormat": "{__name__=\"{{__name__}}\" , node=\"{{node}}\"}",
+ "range": true,
+ "refId": "A",
+ "useBackend": false
+ }
+ ],
+ "title": "Empty Store Responses",
+ "type": "timeseries"
+ },
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "description": "Store responses that didn't include our latest Sonda message",
+ "fieldConfig": {
+ "defaults": {
+ "color": {
+ "mode": "palette-classic"
+ },
+ "custom": {
+ "axisBorderShow": false,
+ "axisCenteredZero": false,
+ "axisColorMode": "text",
+ "axisLabel": "",
+ "axisPlacement": "auto",
+ "barAlignment": 0,
+ "drawStyle": "line",
+ "fillOpacity": 0,
+ "gradientMode": "none",
+ "hideFrom": {
+ "legend": false,
+ "tooltip": false,
+ "viz": false
+ },
+ "insertNulls": false,
+ "lineInterpolation": "linear",
+ "lineWidth": 1,
+ "pointSize": 5,
+ "scaleDistribution": {
+ "type": "linear"
+ },
+ "showPoints": "auto",
+ "spanNulls": false,
+ "stacking": {
+ "group": "A",
+ "mode": "none"
+ },
+ "thresholdsStyle": {
+ "mode": "off"
+ }
+ },
+ "mappings": [],
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "green",
+ "value": null
+ },
+ {
+ "color": "red",
+ "value": 80
+ }
+ ]
+ }
+ },
+ "overrides": [
+ {
+ "__systemRef": "hideSeriesFrom",
+ "matcher": {
+ "id": "byNames",
+ "options": {
+ "mode": "exclude",
+ "names": [
+ "{__name__=\"\" , node=\"/dns4/store-01.do-ams3.shards.test.status.im/tcp/30303/p2p/16Uiu2HAmAUdrQ3uwzuE4Gy4D56hX6uLKEeerJAnhKEHZ3DxF1EfT\"}"
+ ],
+ "prefix": "All except:",
+ "readOnly": true
+ }
+ },
+ "properties": [
+ {
+ "id": "custom.hideFrom",
+ "value": {
+ "legend": false,
+ "tooltip": false,
+ "viz": true
+ }
+ }
+ ]
+ }
+ ]
+ },
+ "gridPos": {
+ "h": 8,
+ "w": 12,
+ "x": 12,
+ "y": 32
+ },
+ "id": 13,
+ "options": {
+ "legend": {
+ "calcs": [],
+ "displayMode": "list",
+ "placement": "bottom",
+ "showLegend": true
+ },
+ "tooltip": {
+ "mode": "single",
+ "sort": "none"
+ }
+ },
+ "targets": [
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "disableTextWrap": false,
+ "editorMode": "code",
+ "expr": "increase(empty_store_responses_total{node=~\"^$node$\"}[5m]) / 5",
+ "fullMetaSearch": false,
+ "includeNullMetadata": true,
+ "instant": false,
+ "legendFormat": "{__name__=\"{{__name__}}\" , node=\"{{node}}\"}",
+ "range": true,
+ "refId": "A",
+ "useBackend": false
+ }
+ ],
+ "title": "Empty Store Responses per Minute",
+ "type": "timeseries"
+ },
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "description": "Latency of store queries",
+ "fieldConfig": {
+ "defaults": {
+ "color": {
+ "mode": "thresholds"
+ },
+ "custom": {
+ "fillOpacity": 80,
+ "gradientMode": "none",
+ "hideFrom": {
+ "legend": false,
+ "tooltip": false,
+ "viz": false
+ },
+ "lineWidth": 1
+ },
+ "mappings": [],
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "green",
+ "value": null
+ },
+ {
+ "color": "red",
+ "value": 80
+ }
+ ]
+ }
+ },
+ "overrides": [
+ {
+ "__systemRef": "hideSeriesFrom",
+ "matcher": {
+ "id": "byNames",
+ "options": {
+ "mode": "exclude",
+ "names": [
+ "{__name__=\"store_query_latency\" , node=\"/dns4/store-01.do-ams3.shards.test.status.im/tcp/30303/p2p/16Uiu2HAmAUdrQ3uwzuE4Gy4D56hX6uLKEeerJAnhKEHZ3DxF1EfT\"}"
+ ],
+ "prefix": "All except:",
+ "readOnly": true
+ }
+ },
+ "properties": [
+ {
+ "id": "custom.hideFrom",
+ "value": {
+ "legend": false,
+ "tooltip": false,
+ "viz": true
+ }
+ }
+ ]
+ }
+ ]
+ },
+ "gridPos": {
+ "h": 8,
+ "w": 12,
+ "x": 0,
+ "y": 40
+ },
+ "id": 7,
+ "options": {
+ "bucketOffset": 0,
+ "legend": {
+ "calcs": [],
+ "displayMode": "list",
+ "placement": "bottom",
+ "showLegend": true
+ }
+ },
+ "targets": [
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "disableTextWrap": false,
+ "editorMode": "code",
+ "expr": "store_query_latency{node=~\"^$node$\"}",
+ "fullMetaSearch": false,
+ "includeNullMetadata": true,
+ "instant": false,
+ "legendFormat": "{__name__=\"{{__name__}}\" , node=\"{{node}}\"}",
+ "range": true,
+ "refId": "A",
+ "useBackend": false
+ }
+ ],
+ "title": "Store Query Latency (seconds)",
+ "type": "histogram"
+ },
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "description": "Latency of each store query",
+ "fieldConfig": {
+ "defaults": {
+ "color": {
+ "mode": "palette-classic"
+ },
+ "custom": {
+ "axisBorderShow": false,
+ "axisCenteredZero": false,
+ "axisColorMode": "text",
+ "axisLabel": "",
+ "axisPlacement": "auto",
+ "barAlignment": 0,
+ "drawStyle": "line",
+ "fillOpacity": 0,
+ "gradientMode": "none",
+ "hideFrom": {
+ "legend": false,
+ "tooltip": false,
+ "viz": false
+ },
+ "insertNulls": false,
+ "lineInterpolation": "linear",
+ "lineWidth": 1,
+ "pointSize": 5,
+ "scaleDistribution": {
+ "type": "linear"
+ },
+ "showPoints": "auto",
+ "spanNulls": false,
+ "stacking": {
+ "group": "A",
+ "mode": "none"
+ },
+ "thresholdsStyle": {
+ "mode": "off"
+ }
+ },
+ "mappings": [],
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "green",
+ "value": null
+ },
+ {
+ "color": "red",
+ "value": 80
+ }
+ ]
+ }
+ },
+ "overrides": [
+ {
+ "__systemRef": "hideSeriesFrom",
+ "matcher": {
+ "id": "byNames",
+ "options": {
+ "mode": "exclude",
+ "names": [
+ "{__name__=\"store_query_latency\" , node=\"/dns4/store-01.do-ams3.shards.test.status.im/tcp/30303/p2p/16Uiu2HAmAUdrQ3uwzuE4Gy4D56hX6uLKEeerJAnhKEHZ3DxF1EfT\"}"
+ ],
+ "prefix": "All except:",
+ "readOnly": true
+ }
+ },
+ "properties": [
+ {
+ "id": "custom.hideFrom",
+ "value": {
+ "legend": false,
+ "tooltip": false,
+ "viz": true
+ }
+ }
+ ]
+ }
+ ]
+ },
+ "gridPos": {
+ "h": 8,
+ "w": 12,
+ "x": 12,
+ "y": 40
+ },
+ "id": 6,
+ "options": {
+ "legend": {
+ "calcs": [],
+ "displayMode": "list",
+ "placement": "bottom",
+ "showLegend": true
+ },
+ "tooltip": {
+ "mode": "single",
+ "sort": "none"
+ }
+ },
+ "targets": [
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "disableTextWrap": false,
+ "editorMode": "code",
+ "expr": "store_query_latency{node=~\"^$node$\"}",
+ "fullMetaSearch": false,
+ "includeNullMetadata": true,
+ "instant": false,
+ "legendFormat": "{__name__=\"{{__name__}}\" , node=\"{{node}}\"}",
+ "range": true,
+ "refId": "A",
+ "useBackend": false
+ }
+ ],
+ "title": "Store Query Latency (seconds)",
+ "type": "timeseries"
+ },
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "description": "Node health according to the configured health threshold. 1 means healthy, 0 not.",
+ "fieldConfig": {
+ "defaults": {
+ "color": {
+ "mode": "palette-classic"
+ },
+ "custom": {
+ "axisBorderShow": false,
+ "axisCenteredZero": false,
+ "axisColorMode": "text",
+ "axisLabel": "",
+ "axisPlacement": "auto",
+ "barAlignment": 0,
+ "drawStyle": "line",
+ "fillOpacity": 0,
+ "gradientMode": "none",
+ "hideFrom": {
+ "legend": false,
+ "tooltip": false,
+ "viz": false
+ },
+ "insertNulls": false,
+ "lineInterpolation": "stepAfter",
+ "lineWidth": 1,
+ "pointSize": 5,
+ "scaleDistribution": {
+ "type": "linear"
+ },
+ "showPoints": "auto",
+ "spanNulls": false,
+ "stacking": {
+ "group": "A",
+ "mode": "none"
+ },
+ "thresholdsStyle": {
+ "mode": "off"
+ }
+ },
+ "mappings": [],
+ "thresholds": {
+ "mode": "absolute",
+ "steps": [
+ {
+ "color": "green",
+ "value": null
+ },
+ {
+ "color": "red",
+ "value": 80
+ }
+ ]
+ }
+ },
+ "overrides": [
+ {
+ "__systemRef": "hideSeriesFrom",
+ "matcher": {
+ "id": "byNames",
+ "options": {
+ "mode": "exclude",
+ "names": [
+ "{__name__=\"node_health\" , node=\"/dns4/store-01.do-ams3.shards.test.status.im/tcp/30303/p2p/16Uiu2HAmAUdrQ3uwzuE4Gy4D56hX6uLKEeerJAnhKEHZ3DxF1EfT\"}"
+ ],
+ "prefix": "All except:",
+ "readOnly": true
+ }
+ },
+ "properties": [
+ {
+ "id": "custom.hideFrom",
+ "value": {
+ "legend": false,
+ "tooltip": false,
+ "viz": true
+ }
+ }
+ ]
+ }
+ ]
+ },
+ "gridPos": {
+ "h": 8,
+ "w": 12,
+ "x": 0,
+ "y": 48
+ },
+ "id": 8,
+ "options": {
+ "legend": {
+ "calcs": [],
+ "displayMode": "list",
+ "placement": "bottom",
+ "showLegend": true
+ },
+ "tooltip": {
+ "mode": "single",
+ "sort": "none"
+ }
+ },
+ "targets": [
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "disableTextWrap": false,
+ "editorMode": "code",
+ "expr": "node_health{node=~\"^$node$\"}",
+ "fullMetaSearch": false,
+ "includeNullMetadata": true,
+ "instant": false,
+ "legendFormat": "{__name__=\"{{__name__}}\" , node=\"{{node}}\"}",
+ "range": true,
+ "refId": "A",
+ "useBackend": false
+ }
+ ],
+ "title": "Node health",
+ "type": "timeseries"
+ }
+ ],
+ "refresh": "",
+ "schemaVersion": 39,
+ "tags": [],
+ "templating": {
+ "list": [
+ {
+ "current": {
+ "selected": true,
+ "text": "All",
+ "value": "$__all"
+ },
+ "datasource": {
+ "type": "prometheus",
+ "uid": "PBFA97CFB590B2093"
+ },
+ "definition": "label_values(node)",
+ "hide": 0,
+ "includeAll": true,
+ "label": "node",
+ "multi": false,
+ "name": "node",
+ "options": [],
+ "query": {
+ "qryType": 1,
+ "query": "label_values(node)",
+ "refId": "PrometheusVariableQueryEditor-VariableQuery"
+ },
+ "refresh": 2,
+ "regex": "",
+ "skipUrlSync": false,
+ "sort": 0,
+ "type": "query"
+ }
+ ]
+ },
+ "time": {
+ "from": "now-1h",
+ "to": "now"
+ },
+ "timepicker": {},
+ "timezone": "",
+ "title": "sonda-monitoring",
+ "uid": "cbd1b6c8-63d2-41f3-b57b-a776ec8fa23e",
+ "version": 1,
+ "weekStart": ""
+}
\ No newline at end of file
diff --git a/third-party/nwaku/apps/sonda/monitoring/configuration/datasources.yaml b/third-party/nwaku/apps/sonda/monitoring/configuration/datasources.yaml
new file mode 100644
index 0000000..9f4f51f
--- /dev/null
+++ b/third-party/nwaku/apps/sonda/monitoring/configuration/datasources.yaml
@@ -0,0 +1,11 @@
+apiVersion: 1
+
+datasources:
+ - name: Prometheus
+ type: prometheus
+ access: proxy
+ org_id: 1
+ url: http://prometheus:9090
+ is_default: true
+ version: 1
+ editable: true
\ No newline at end of file
diff --git a/third-party/nwaku/apps/sonda/monitoring/configuration/grafana-plugins.env b/third-party/nwaku/apps/sonda/monitoring/configuration/grafana-plugins.env
new file mode 100644
index 0000000..2780809
--- /dev/null
+++ b/third-party/nwaku/apps/sonda/monitoring/configuration/grafana-plugins.env
@@ -0,0 +1,2 @@
+#GF_INSTALL_PLUGINS=grafana-worldmap-panel,grafana-piechart-panel,digrich-bubblechart-panel,yesoreyeram-boomtheme-panel,briangann-gauge-panel,jdbranham-diagram-panel,agenty-flowcharting-panel,citilogics-geoloop-panel,savantly-heatmap-panel,mtanda-histogram-panel,pierosavi-imageit-panel,michaeldmoore-multistat-panel,zuburqan-parity-report-panel,natel-plotly-panel,bessler-pictureit-panel,grafana-polystat-panel,corpglory-progresslist-panel,snuids-radar-panel,fzakaria-simple-config.config.annotations-datasource,vonage-status-panel,snuids-trafficlights-panel,pr0ps-trackmap-panel,alexandra-trackmap-panel,btplc-trend-box-panel
+GF_INSTALL_PLUGINS=grafana-worldmap-panel,grafana-piechart-panel,yesoreyeram-boomtheme-panel,briangann-gauge-panel,pierosavi-imageit-panel,bessler-pictureit-panel,vonage-status-panel
diff --git a/third-party/nwaku/apps/sonda/monitoring/configuration/grafana.ini b/third-party/nwaku/apps/sonda/monitoring/configuration/grafana.ini
new file mode 100644
index 0000000..f237726
--- /dev/null
+++ b/third-party/nwaku/apps/sonda/monitoring/configuration/grafana.ini
@@ -0,0 +1,51 @@
+instance_name = nwaku dashboard
+
+;[dashboards.json]
+;enabled = true
+;path = /home/git/grafana/grafana-dashboards/dashboards
+
+
+#################################### Auth ##########################
+[auth]
+disable_login_form = false
+
+#################################### Anonymous Auth ##########################
+[auth.anonymous]
+# enable anonymous access
+enabled = true
+
+# specify organization name that should be used for unauthenticated users
+;org_name = Public
+
+# specify role for unauthenticated users
+org_role = Admin
+; org_role = Viewer
+
+;[security]
+;admin_user = ocr
+;admin_password = ocr
+
+;[users]
+# disable user signup / registration
+;allow_sign_up = false
+
+# Set to true to automatically assign new users to the default organization (id 1)
+;auto_assign_org = true
+
+# Default role new users will be automatically assigned (if disabled above is set to true)
+;auto_assign_org_role = Viewer
+
+#################################### SMTP / Emailing ##########################
+;[smtp]
+;enabled = false
+;host = localhost:25
+;user =
+;password =
+;cert_file =
+;key_file =
+;skip_verify = false
+;from_address = admin@grafana.localhost
+
+;[emails]
+;welcome_email_on_sign_up = false
+
diff --git a/third-party/nwaku/apps/sonda/monitoring/prometheus-config.yml b/third-party/nwaku/apps/sonda/monitoring/prometheus-config.yml
new file mode 100644
index 0000000..51e2b50
--- /dev/null
+++ b/third-party/nwaku/apps/sonda/monitoring/prometheus-config.yml
@@ -0,0 +1,10 @@
+global:
+ scrape_interval: 15s
+ evaluation_interval: 15s
+ external_labels:
+ monitor: "Monitoring"
+
+scrape_configs:
+ - job_name: "nwaku"
+ static_configs:
+ - targets: ["nwaku:8003", "sonda:8004"]
diff --git a/third-party/nwaku/apps/sonda/register_rln.sh b/third-party/nwaku/apps/sonda/register_rln.sh
new file mode 100755
index 0000000..4fb373b
--- /dev/null
+++ b/third-party/nwaku/apps/sonda/register_rln.sh
@@ -0,0 +1,31 @@
+#!/bin/sh
+
+
+if test -f ./keystore/keystore.json; then
+ echo "keystore/keystore.json already exists. Use it instead of creating a new one."
+ echo "Exiting"
+ exit 1
+fi
+
+
+if test -f .env; then
+ echo "Using .env file"
+ . $(pwd)/.env
+fi
+
+# TODO: Set nwaku release when ready instead of quay
+
+if test -n "${ETH_CLIENT_ADDRESS}"; then
+ echo "ETH_CLIENT_ADDRESS variable was renamed to RLN_RELAY_ETH_CLIENT_ADDRESS"
+ echo "Please update your .env file"
+ exit 1
+fi
+
+docker run -v $(pwd)/keystore:/keystore/:Z harbor.status.im/wakuorg/nwaku:v0.30.1 generateRlnKeystore \
+--rln-relay-eth-client-address=${RLN_RELAY_ETH_CLIENT_ADDRESS} \
+--rln-relay-eth-private-key=${ETH_TESTNET_KEY} \
+--rln-relay-eth-contract-address=0xB9cd878C90E49F797B4431fBF4fb333108CB90e6 \
+--rln-relay-cred-path=/keystore/keystore.json \
+--rln-relay-cred-password="${RLN_RELAY_CRED_PASSWORD}" \
+--rln-relay-user-message-limit=20 \
+--execute
diff --git a/third-party/nwaku/apps/sonda/run_node.sh b/third-party/nwaku/apps/sonda/run_node.sh
new file mode 100644
index 0000000..e130019
--- /dev/null
+++ b/third-party/nwaku/apps/sonda/run_node.sh
@@ -0,0 +1,110 @@
+#!/bin/sh
+
+echo "I am a nwaku node"
+
+if test -n "${ETH_CLIENT_ADDRESS}" -o ; then
+ echo "ETH_CLIENT_ADDRESS variable was renamed to RLN_RELAY_ETH_CLIENT_ADDRESS"
+ echo "Please update your .env file"
+ exit 1
+fi
+
+if [ -z "${RLN_RELAY_ETH_CLIENT_ADDRESS}" ] && [ "${CLUSTER_ID}" -eq 1 ]; then
+ echo "Missing Eth client address, please refer to README.md for detailed instructions"
+ exit 1
+fi
+
+if [ "${CLUSTER_ID}" -ne 1 ]; then
+ echo "CLUSTER_ID is not equal to 1, clearing RLN configurations"
+ RLN_RELAY_CRED_PATH=""
+ RLN_RELAY_ETH_CLIENT_ADDRESS=""
+ RLN_RELAY_CRED_PASSWORD=""
+fi
+
+MY_EXT_IP=$(wget -qO- https://api4.ipify.org)
+DNS_WSS_CMD=
+
+if [ -n "${DOMAIN}" ]; then
+
+ LETSENCRYPT_PATH=/etc/letsencrypt/live/${DOMAIN}
+
+ if ! [ -d "${LETSENCRYPT_PATH}" ]; then
+ apk add --no-cache certbot
+
+ certbot certonly\
+ --non-interactive\
+ --agree-tos\
+ --no-eff-email\
+ --no-redirect\
+ --email admin@${DOMAIN}\
+ -d ${DOMAIN}\
+ --standalone
+ fi
+
+ if ! [ -e "${LETSENCRYPT_PATH}/privkey.pem" ]; then
+ echo "The certificate does not exist"
+ sleep 60
+ exit 1
+ fi
+
+ WS_SUPPORT="--websocket-support=true"
+ WSS_SUPPORT="--websocket-secure-support=true"
+ WSS_KEY="--websocket-secure-key-path=${LETSENCRYPT_PATH}/privkey.pem"
+ WSS_CERT="--websocket-secure-cert-path=${LETSENCRYPT_PATH}/cert.pem"
+ DNS4_DOMAIN="--dns4-domain-name=${DOMAIN}"
+
+ DNS_WSS_CMD="${WS_SUPPORT} ${WSS_SUPPORT} ${WSS_CERT} ${WSS_KEY} ${DNS4_DOMAIN}"
+fi
+
+if [ -n "${NODEKEY}" ]; then
+ NODEKEY=--nodekey=${NODEKEY}
+fi
+
+if [ "${CLUSTER_ID}" -eq 1 ]; then
+ RLN_RELAY_CRED_PATH=--rln-relay-cred-path=${RLN_RELAY_CRED_PATH:-/keystore/keystore.json}
+fi
+
+if [ -n "${RLN_RELAY_CRED_PASSWORD}" ]; then
+ RLN_RELAY_CRED_PASSWORD=--rln-relay-cred-password="${RLN_RELAY_CRED_PASSWORD}"
+fi
+
+if [ -n "${RLN_RELAY_ETH_CLIENT_ADDRESS}" ]; then
+ RLN_RELAY_ETH_CLIENT_ADDRESS=--rln-relay-eth-client-address="${RLN_RELAY_ETH_CLIENT_ADDRESS}"
+fi
+
+# TO DO: configure bootstrap nodes in env
+
+exec /usr/bin/wakunode\
+ --relay=true\
+ --filter=false\
+ --lightpush=false\
+ --keep-alive=true\
+ --max-connections=150\
+ --cluster-id="${CLUSTER_ID}"\
+ --discv5-discovery=true\
+ --discv5-udp-port=9005\
+ --discv5-enr-auto-update=True\
+ --log-level=DEBUG\
+ --tcp-port=30304\
+ --metrics-server=True\
+ --metrics-server-port=8003\
+ --metrics-server-address=0.0.0.0\
+ --rest=true\
+ --rest-admin=true\
+ --rest-address=0.0.0.0\
+ --rest-port=8645\
+ --rest-allow-origin="waku-org.github.io"\
+ --rest-allow-origin="localhost:*"\
+ --nat=extip:"${MY_EXT_IP}"\
+ --store=false\
+ --pubsub-topic="/waku/2/rs/${CLUSTER_ID}/${SHARD}"\
+ --discv5-bootstrap-node="enr:-QEKuECA0zhRJej2eaOoOPddNcYr7-5NdRwuoLCe2EE4wfEYkAZhFotg6Kkr8K15pMAGyUyt0smHkZCjLeld0BUzogNtAYJpZIJ2NIJpcISnYxMvim11bHRpYWRkcnO4WgAqNiVib290LTAxLmRvLWFtczMuc2hhcmRzLnRlc3Quc3RhdHVzLmltBnZfACw2JWJvb3QtMDEuZG8tYW1zMy5zaGFyZHMudGVzdC5zdGF0dXMuaW0GAbveA4Jyc40AEAUAAQAgAEAAgAEAiXNlY3AyNTZrMaEC3rRtFQSgc24uWewzXaxTY8hDAHB8sgnxr9k8Rjb5GeSDdGNwgnZfg3VkcIIjKIV3YWt1Mg0"\
+ --discv5-bootstrap-node="enr:-QEcuEAgXDqrYd_TrpUWtn3zmxZ9XPm7O3GS6lV7aMJJOTsbOAAeQwSd_eoHcCXqVzTUtwTyB4855qtbd8DARnExyqHPAYJpZIJ2NIJpcIQihw1Xim11bHRpYWRkcnO4bAAzNi5ib290LTAxLmdjLXVzLWNlbnRyYWwxLWEuc2hhcmRzLnRlc3Quc3RhdHVzLmltBnZfADU2LmJvb3QtMDEuZ2MtdXMtY2VudHJhbDEtYS5zaGFyZHMudGVzdC5zdGF0dXMuaW0GAbveA4Jyc40AEAUAAQAgAEAAgAEAiXNlY3AyNTZrMaECxjqgDQ0WyRSOilYU32DA5k_XNlDis3m1VdXkK9xM6kODdGNwgnZfg3VkcIIjKIV3YWt1Mg0"\
+ --discv5-bootstrap-node="enr:-QEcuEAX6Qk-vVAoJLxR4A_4UVogGhvQrqKW4DFKlf8MA1PmCjgowL-LBtSC9BLjXbb8gf42FdDHGtSjEvvWKD10erxqAYJpZIJ2NIJpcIQI2hdMim11bHRpYWRkcnO4bAAzNi5ib290LTAxLmFjLWNuLWhvbmdrb25nLWMuc2hhcmRzLnRlc3Quc3RhdHVzLmltBnZfADU2LmJvb3QtMDEuYWMtY24taG9uZ2tvbmctYy5zaGFyZHMudGVzdC5zdGF0dXMuaW0GAbveA4Jyc40AEAUAAQAgAEAAgAEAiXNlY3AyNTZrMaEDP7CbRk-YKJwOFFM4Z9ney0GPc7WPJaCwGkpNRyla7mCDdGNwgnZfg3VkcIIjKIV3YWt1Mg0"\
+ ${RLN_RELAY_CRED_PATH}\
+ ${RLN_RELAY_CRED_PASSWORD}\
+ ${RLN_RELAY_TREE_PATH}\
+ ${RLN_RELAY_ETH_CLIENT_ADDRESS}\
+ ${DNS_WSS_CMD}\
+ ${NODEKEY}\
+ ${EXTRA_ARGS}
+
diff --git a/third-party/nwaku/apps/sonda/sonda.py b/third-party/nwaku/apps/sonda/sonda.py
new file mode 100644
index 0000000..8b74bd0
--- /dev/null
+++ b/third-party/nwaku/apps/sonda/sonda.py
@@ -0,0 +1,207 @@
+import requests
+import time
+import json
+import os
+import base64
+import sys
+import urllib.parse
+import requests
+import argparse
+from datetime import datetime
+from prometheus_client import Counter, Gauge, start_http_server
+
+# Content topic where Sona messages are going to be sent
+SONDA_CONTENT_TOPIC = '/sonda/2/polls/proto'
+
+# Prometheus metrics
+successful_sonda_msgs = Counter('successful_sonda_msgs', 'Number of successful Sonda messages sent')
+failed_sonda_msgs = Counter('failed_sonda_msgs', 'Number of failed Sonda messages attempts')
+successful_store_queries = Counter('successful_store_queries', 'Number of successful store queries', ['node'])
+failed_store_queries = Counter('failed_store_queries', 'Number of failed store queries', ['node', 'error'])
+empty_store_responses = Counter('empty_store_responses', "Number of store responses without the latest Sonda message", ['node'])
+store_query_latency = Gauge('store_query_latency', 'Latency of the last store query in seconds', ['node'])
+consecutive_successful_responses = Gauge('consecutive_successful_responses', 'Consecutive successful store responses', ['node'])
+node_health = Gauge('node_health', "Binary indicator of a node's health. 1 is healthy, 0 is not", ['node'])
+
+
+# Argparser configuration
+parser = argparse.ArgumentParser(description='')
+parser.add_argument('-m', '--metrics-port', type=int, default=8004, help='Port to expose prometheus metrics.')
+parser.add_argument('-a', '--node-rest-address', type=str, default="http://nwaku:8645", help='Address of the waku node to send messages to.')
+parser.add_argument('-p', '--pubsub-topic', type=str, default='/waku/2/rs/1/0', help='PubSub topic.')
+parser.add_argument('-d', '--delay-seconds', type=int, default=60, help='Delay in seconds between messages.')
+parser.add_argument('-n', '--store-nodes', type=str, required=True, help='Comma separated list of store nodes to query.')
+parser.add_argument('-t', '--health-threshold', type=int, default=5, help='Consecutive successful store requests to consider a store node healthy.')
+args = parser.parse_args()
+
+
+# Logs message including current UTC time
+def log_with_utc(message):
+ utc_time = datetime.utcnow().strftime("%Y-%m-%d %H:%M:%S")
+ print(f"[{utc_time} UTC] {message}")
+
+
+# Sends Sonda message. Returns True if successful, False otherwise
+def send_sonda_msg(rest_address, pubsub_topic, content_topic, timestamp):
+ message = "Hi, I'm Sonda"
+ base64_message = base64.b64encode(message.encode('utf-8')).decode('ascii')
+ body = {
+ 'payload': base64_message,
+ 'contentTopic': content_topic,
+ 'version': 1,
+ 'timestamp': timestamp
+ }
+
+ encoded_pubsub_topic = urllib.parse.quote(pubsub_topic, safe='')
+ url = f'{rest_address}/relay/v1/messages/{encoded_pubsub_topic}'
+ headers = {'content-type': 'application/json'}
+
+ log_with_utc(f'Sending Sonda message via REST: {url} PubSubTopic: {pubsub_topic}, ContentTopic: {content_topic}, timestamp: {timestamp}')
+
+ try:
+ start_time = time.time()
+ response = requests.post(url, json=body, headers=headers, timeout=10)
+ elapsed_seconds = time.time() - start_time
+
+ log_with_utc(f'Response from {rest_address}: status:{response.status_code} content:{response.text} [{elapsed_seconds:.4f} s.]')
+
+ if response.status_code == 200:
+ successful_sonda_msgs.inc()
+ return True
+ else:
+ response.raise_for_status()
+ except requests.RequestException as e:
+ log_with_utc(f'Error sending request: {e}')
+
+ failed_sonda_msgs.inc()
+ return False
+
+
+# We return true if both our node and the queried Store node returned a 200
+# If our message isn't found but we did get a store 200 response, this function still returns true
+def check_store_response(json_response, store_node, timestamp):
+ # Check for the store node status code
+ if json_response.get('statusCode') != 200:
+ error = f"{json_response.get('statusCode')} {json_response.get('statusDesc')}"
+ log_with_utc(f'Failed performing store query {error}')
+ failed_store_queries.labels(node=store_node, error=error).inc()
+ consecutive_successful_responses.labels(node=store_node).set(0)
+
+ return False
+
+ messages = json_response.get('messages')
+ # If there's no message in the response, increase counters and return
+ if not messages:
+ log_with_utc("No messages in store response")
+ empty_store_responses.labels(node=store_node).inc()
+ consecutive_successful_responses.labels(node=store_node).set(0)
+ return True
+
+ # Search for the Sonda message in the returned messages
+ for message in messages:
+ # If message field is missing in current message, continue
+ if not message.get("message"):
+ log_with_utc("Could not retrieve message")
+ continue
+
+ # If a message is found with the same timestamp as sonda message, increase counters and return
+ if timestamp == message.get('message').get('timestamp'):
+ log_with_utc(f'Found Sonda message in store response node={store_node}')
+ successful_store_queries.labels(node=store_node).inc()
+ consecutive_successful_responses.labels(node=store_node).inc()
+ return True
+
+ # If our message wasn't found in the returned messages, increase counter and return
+ empty_store_responses.labels(node=store_node).inc()
+ consecutive_successful_responses.labels(node=store_node).set(0)
+ return True
+
+
+def send_store_query(rest_address, store_node, encoded_pubsub_topic, encoded_content_topic, timestamp):
+ url = f'{rest_address}/store/v3/messages'
+ params = {
+ 'peerAddr': urllib.parse.quote(store_node, safe=''),
+ 'pubsubTopic': encoded_pubsub_topic,
+ 'contentTopics': encoded_content_topic,
+ 'includeData': 'true',
+ 'startTime': timestamp
+ }
+
+ s_time = time.time()
+
+ try:
+ log_with_utc(f'Sending store request to {store_node}')
+ response = requests.get(url, params=params)
+ except Exception as e:
+ log_with_utc(f'Error sending request: {e}')
+ failed_store_queries.labels(node=store_node, error=str(e)).inc()
+ consecutive_successful_responses.labels(node=store_node).set(0)
+ return False
+
+ elapsed_seconds = time.time() - s_time
+ log_with_utc(f'Response from {rest_address}: status:{response.status_code} [{elapsed_seconds:.4f} s.]')
+
+ if response.status_code != 200:
+ failed_store_queries.labels(node=store_node, error=f'{response.status_code} {response.content}').inc()
+ consecutive_successful_responses.labels(node=store_node).set(0)
+ return False
+
+ # Parse REST response into JSON
+ try:
+ json_response = response.json()
+ except Exception as e:
+ log_with_utc(f'Error parsing response JSON: {e}')
+ failed_store_queries.labels(node=store_node, error="JSON parse error").inc()
+ consecutive_successful_responses.labels(node=store_node).set(0)
+ return False
+
+ # Analyze Store response. Return false if response is incorrect or has an error status
+ if not check_store_response(json_response, store_node, timestamp):
+ return False
+
+ store_query_latency.labels(node=store_node).set(elapsed_seconds)
+ return True
+
+
+def send_store_queries(rest_address, store_nodes, pubsub_topic, content_topic, timestamp):
+ log_with_utc(f'Sending store queries. nodes = {store_nodes} timestamp = {timestamp}')
+ encoded_pubsub_topic = urllib.parse.quote(pubsub_topic, safe='')
+ encoded_content_topic = urllib.parse.quote(content_topic, safe='')
+
+ for node in store_nodes:
+ send_store_query(rest_address, node, encoded_pubsub_topic, encoded_content_topic, timestamp)
+
+
+def main():
+ log_with_utc(f'Running Sonda with args={args}')
+
+ store_nodes = []
+ if args.store_nodes is not None:
+ store_nodes = [s.strip() for s in args.store_nodes.split(",")]
+ log_with_utc(f'Store nodes to query: {store_nodes}')
+
+ # Start Prometheus HTTP server at port set by the CLI(default 8004)
+ start_http_server(args.metrics_port)
+
+ while True:
+ timestamp = time.time_ns()
+
+ # Send Sonda message
+ res = send_sonda_msg(args.node_rest_address, args.pubsub_topic, SONDA_CONTENT_TOPIC, timestamp)
+
+ log_with_utc(f'sleeping: {args.delay_seconds} seconds')
+ time.sleep(args.delay_seconds)
+
+ # Only send store query if message was successfully published
+ if(res):
+ send_store_queries(args.node_rest_address, store_nodes, args.pubsub_topic, SONDA_CONTENT_TOPIC, timestamp)
+
+ # Update node health metrics
+ for store_node in store_nodes:
+ if consecutive_successful_responses.labels(node=store_node)._value.get() >= args.health_threshold:
+ node_health.labels(node=store_node).set(1)
+ else:
+ node_health.labels(node=store_node).set(0)
+
+
+main()
diff --git a/third-party/nwaku/apps/wakucanary/README.md b/third-party/nwaku/apps/wakucanary/README.md
new file mode 100644
index 0000000..1140823
--- /dev/null
+++ b/third-party/nwaku/apps/wakucanary/README.md
@@ -0,0 +1,58 @@
+# waku canary tool
+
+Attempts to dial a peer and asserts it supports a given set of protocols.
+
+```console
+./build/wakucanary --help
+Usage:
+
+wakucanary [OPTIONS]...
+
+The following options are available:
+
+ -a, --address Multiaddress of the peer node to attempt to dial.
+ -t, --timeout Timeout to consider that the connection failed [=chronos.seconds(10)].
+ -p, --protocol Protocol required to be supported: store,relay,lightpush,filter (can be used
+ multiple times).
+ -l, --log-level Sets the log level [=LogLevel.DEBUG].
+ -np, --node-port Listening port for waku node [=60000].
+ --websocket-secure-key-path Secure websocket key path: '/path/to/key.txt' .
+ --websocket-secure-cert-path Secure websocket Certificate path: '/path/to/cert.txt' .
+ -c, --cluster-id Cluster ID of the fleet node to check status [Default=1]
+ -s, --shard Shards index to subscribe to topics [ Argument may be repeated ]
+
+```
+
+The tool can be built as:
+
+```console
+$ make wakucanary
+```
+
+And used as follows. A reachable node that supports both `store` and `filter` protocols.
+
+```console
+$ ./build/wakucanary --address=/dns4/node-01.ac-cn-hongkong-c.waku.sandbox.status.im/tcp/30303/p2p/16Uiu2HAmSJvSJphxRdbnigUV5bjRRZFBhTtWFTSyiKaQByCjwmpV --protocol=store --protocol=filter
+$ echo $?
+0
+```
+
+A node that can't be reached.
+```console
+$ ./build/wakucanary --address=/dns4/node-01.ac-cn-hongkong-c.waku.sandbox.status.im/tcp/1000/p2p/16Uiu2HAmSJvSJphxRdbnigUV5bjRRZFBhTtWFTSyiKaQByCjwmpV --protocol=store --protocol=filter
+$ echo $?
+1
+```
+
+Note that a domain name can also be used.
+```console
+$ ./build/wakucanary --address=/dns4/node-01.do-ams3.status.test.status.im/tcp/30303/p2p/16Uiu2HAkukebeXjTQ9QDBeNDWuGfbaSg79wkkhK4vPocLgR6QFDf --protocol=store --protocol=filter
+$ echo $?
+0
+```
+
+Websockets are also supported. The websocket port openned by waku canary is calculated as `$(--node-port) + 1000` (e.g. when you set `-np 60000`, the WS port will be `61000`)
+```console
+$ ./build/wakucanary --address=/ip4/127.0.0.1/tcp/7777/ws/p2p/16Uiu2HAm4ng2DaLPniRoZtMQbLdjYYWnXjrrJkGoXWCoBWAdn1tu --protocol=store --protocol=filter
+$ ./build/wakucanary --address=/ip4/127.0.0.1/tcp/7777/wss/p2p/16Uiu2HAmB6JQpewXScGoQ2syqmimbe4GviLxRwfsR8dCpwaGBPSE --protocol=store --websocket-secure-key-path=MyKey.key --websocket-secure-cert-path=MyCertificate.crt
+```
diff --git a/third-party/nwaku/apps/wakucanary/certsgenerator.nim b/third-party/nwaku/apps/wakucanary/certsgenerator.nim
new file mode 100644
index 0000000..b8a9e9d
--- /dev/null
+++ b/third-party/nwaku/apps/wakucanary/certsgenerator.nim
@@ -0,0 +1,37 @@
+import osproc, os, httpclient, strutils
+
+proc getPublicIP(): string =
+ let client = newHttpClient()
+ try:
+ let response = client.get("http://api.ipify.org")
+ return response.body
+ except Exception as e:
+ echo "Could not fetch public IP: " & e.msg
+ return "127.0.0.1"
+
+# Function to generate a self-signed certificate
+proc generateSelfSignedCertificate*(certPath: string, keyPath: string): int =
+ # Ensure the OpenSSL is installed
+ if findExe("openssl") == "":
+ echo "OpenSSL is not installed or not in the PATH."
+ return 1
+
+ let publicIP = getPublicIP()
+
+ if publicIP != "127.0.0.1":
+ echo "Your public IP address is: ", publicIP
+
+ # Command to generate private key and cert
+ let
+ cmd =
+ "openssl req -x509 -newkey rsa:4096 -keyout " & keyPath & " -out " & certPath &
+ " -sha256 -days 3650 -nodes -subj '/C=XX/ST=StateName/L=CityName/O=CompanyName/OU=CompanySectionName/CN=" &
+ publicIP & "'"
+ res = execCmd(cmd)
+
+ if res == 0:
+ echo "Successfully generated self-signed certificate and key."
+ else:
+ echo "Failed to generate certificate and key."
+
+ return res
diff --git a/third-party/nwaku/apps/wakucanary/nim.cfg b/third-party/nwaku/apps/wakucanary/nim.cfg
new file mode 100644
index 0000000..2231f2e
--- /dev/null
+++ b/third-party/nwaku/apps/wakucanary/nim.cfg
@@ -0,0 +1,4 @@
+-d:chronicles_line_numbers
+-d:chronicles_runtime_filtering:on
+-d:discv5_protocol_id:d5waku
+path = "../.."
diff --git a/third-party/nwaku/apps/wakucanary/wakucanary.nim b/third-party/nwaku/apps/wakucanary/wakucanary.nim
new file mode 100644
index 0000000..e770028
--- /dev/null
+++ b/third-party/nwaku/apps/wakucanary/wakucanary.nim
@@ -0,0 +1,300 @@
+import
+ std/[strutils, sequtils, tables, strformat],
+ confutils,
+ chronos,
+ chronicles/topics_registry,
+ os
+import
+ libp2p/protocols/ping,
+ libp2p/crypto/[crypto, secp],
+ libp2p/nameresolving/dnsresolver,
+ libp2p/multicodec
+import
+ ./certsgenerator,
+ waku/[waku_enr, node/peer_manager, waku_core, waku_node, factory/builder]
+
+# protocols and their tag
+const ProtocolsTable = {
+ "store": "/vac/waku/store/",
+ "storev3": "/vac/waku/store-query/3",
+ "relay": "/vac/waku/relay/",
+ "lightpush": "/vac/waku/lightpush/",
+ "filter": "/vac/waku/filter-subscribe/2",
+ "filter-push": "/vac/waku/filter-push/",
+ "ipfs-id": "/ipfs/id/",
+ "autonat": "/libp2p/autonat/",
+ "circuit-relay": "/libp2p/circuit/relay/",
+ "metadata": "/vac/waku/metadata/",
+ "rendezvous": "/rendezvous/",
+ "ipfs-ping": "/ipfs/ping/",
+ "peer-exchange": "/vac/waku/peer-exchange/",
+ "mix": "mix/1.0.0",
+}.toTable
+
+const WebSocketPortOffset = 1000
+const CertsDirectory = "./certs"
+
+# cli flags
+type WakuCanaryConf* = object
+ address* {.
+ desc: "Multiaddress of the peer node to attempt to dial",
+ defaultValue: "",
+ name: "address",
+ abbr: "a"
+ .}: string
+
+ timeout* {.
+ desc: "Timeout to consider that the connection failed",
+ defaultValue: chronos.seconds(10),
+ name: "timeout",
+ abbr: "t"
+ .}: chronos.Duration
+
+ protocols* {.
+ desc:
+ "Protocol required to be supported: store,relay,lightpush,filter (can be used multiple times)",
+ name: "protocol",
+ abbr: "p"
+ .}: seq[string]
+
+ logLevel* {.
+ desc: "Sets the log level",
+ defaultValue: LogLevel.INFO,
+ name: "log-level",
+ abbr: "l"
+ .}: LogLevel
+
+ nodePort* {.
+ desc: "Listening port for waku node",
+ defaultValue: 60000,
+ name: "node-port",
+ abbr: "np"
+ .}: uint16
+
+ ## websocket secure config
+ websocketSecureKeyPath* {.
+ desc: "Secure websocket key path: '/path/to/key.txt' ",
+ defaultValue: "",
+ name: "websocket-secure-key-path"
+ .}: string
+
+ websocketSecureCertPath* {.
+ desc: "Secure websocket Certificate path: '/path/to/cert.txt' ",
+ defaultValue: "",
+ name: "websocket-secure-cert-path"
+ .}: string
+
+ ping* {.
+ desc: "Ping the peer node to measure latency", defaultValue: true, name: "ping"
+ .}: bool
+
+ shards* {.
+ desc:
+ "Shards index to subscribe to [0..NUM_SHARDS_IN_NETWORK-1]. Argument may be repeated.",
+ defaultValue: @[],
+ name: "shard",
+ abbr: "s"
+ .}: seq[uint16]
+
+ clusterId* {.
+ desc:
+ "Cluster id that the node is running in. Node in a different cluster id is disconnected.",
+ defaultValue: 1,
+ name: "cluster-id",
+ abbr: "c"
+ .}: uint16
+
+proc parseCmdArg*(T: type chronos.Duration, p: string): T =
+ try:
+ result = chronos.seconds(parseInt(p))
+ except CatchableError:
+ raise newException(ValueError, "Invalid timeout value")
+
+proc completeCmdArg*(T: type chronos.Duration, val: string): seq[string] =
+ return @[]
+
+proc areProtocolsSupported(
+ toValidateProtocols: seq[string], nodeProtocols: seq[string]
+): bool =
+ ## Checks if all toValidateProtocols are contained in nodeProtocols.
+ ## nodeProtocols contains the full list of protocols currently informed by the node under analysis.
+ ## toValidateProtocols contains the protocols, without version number, that we want to check if they are supported by the node.
+ var numOfSupportedProt: int = 0
+
+ for rawProtocol in toValidateProtocols:
+ let protocolTag = ProtocolsTable[rawProtocol]
+ debug "Checking if protocol is supported", expected_protocol_tag = protocolTag
+
+ var protocolSupported = false
+ for nodeProtocol in nodeProtocols:
+ if nodeProtocol.startsWith(protocolTag):
+ info "The node supports the protocol", supported_protocol = nodeProtocol
+ numOfSupportedProt += 1
+ protocolSupported = true
+ break
+
+ if not protocolSupported:
+ error "The node does not support the protocol", expected_protocol = protocolTag
+
+ if numOfSupportedProt == toValidateProtocols.len:
+ return true
+
+ return false
+
+proc pingNode(
+ node: WakuNode, peerInfo: RemotePeerInfo
+): Future[void] {.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
+ except CatchableError:
+ var msg = getCurrentExceptionMsg()
+ if msg == "Future operation cancelled!":
+ msg = "timedout"
+ error "Failed to ping the peer", peer = peerInfo, err = msg
+
+proc main(rng: ref HmacDrbgContext): Future[int] {.async.} =
+ let conf: WakuCanaryConf = WakuCanaryConf.load()
+
+ # create dns resolver
+ let
+ nameServers =
+ @[
+ initTAddress(parseIpAddress("1.1.1.1"), Port(53)),
+ initTAddress(parseIpAddress("1.0.0.1"), Port(53)),
+ ]
+ resolver: DnsResolver = DnsResolver.new(nameServers)
+
+ if conf.logLevel != LogLevel.NONE:
+ setLogLevel(conf.logLevel)
+
+ # ensure input protocols are valid
+ for p in conf.protocols:
+ if p notin ProtocolsTable:
+ error "invalid protocol", protocol = p, valid = ProtocolsTable
+ raise newException(ConfigurationError, "Invalid cli flag values" & p)
+
+ info "Cli flags",
+ address = conf.address,
+ timeout = conf.timeout,
+ protocols = conf.protocols,
+ logLevel = conf.logLevel
+
+ let peerRes = parsePeerInfo(conf.address)
+ if peerRes.isErr():
+ error "Couldn't parse 'conf.address'", error = peerRes.error
+ quit(QuitFailure)
+
+ let peer = peerRes.value
+
+ let
+ nodeKey = crypto.PrivateKey.random(Secp256k1, rng[])[]
+ bindIp = parseIpAddress("0.0.0.0")
+ wsBindPort = Port(conf.nodePort + WebSocketPortOffset)
+ nodeTcpPort = Port(conf.nodePort)
+ isWs = peer.addrs[0].contains(multiCodec("ws")).get()
+ isWss = peer.addrs[0].contains(multiCodec("wss")).get()
+ keyPath =
+ if conf.websocketSecureKeyPath.len > 0:
+ conf.websocketSecureKeyPath
+ else:
+ CertsDirectory & "/key.pem"
+ certPath =
+ if conf.websocketSecureCertPath.len > 0:
+ conf.websocketSecureCertPath
+ else:
+ CertsDirectory & "/cert.pem"
+
+ var builder = WakuNodeBuilder.init()
+ builder.withNodeKey(nodeKey)
+
+ let netConfig = NetConfig.init(
+ bindIp = bindIp,
+ bindPort = nodeTcpPort,
+ wsBindPort = some(wsBindPort),
+ wsEnabled = isWs,
+ wssEnabled = isWss,
+ )
+
+ var enrBuilder = EnrBuilder.init(nodeKey)
+
+ enrBuilder.withWakuRelaySharding(
+ RelayShards(clusterId: conf.clusterId, shardIds: conf.shards)
+ ).isOkOr:
+ error "could not initialize ENR with shards", error
+ quit(QuitFailure)
+
+ let recordRes = enrBuilder.build()
+ let record =
+ if recordRes.isErr():
+ error "failed to create enr record", error = recordRes.error
+ quit(QuitFailure)
+ else:
+ recordRes.get()
+
+ if isWss and
+ (conf.websocketSecureKeyPath.len == 0 or conf.websocketSecureCertPath.len == 0):
+ info "WebSocket Secure requires key and certificate. Generating them"
+ if not dirExists(CertsDirectory):
+ createDir(CertsDirectory)
+ if generateSelfSignedCertificate(certPath, keyPath) != 0:
+ error "Error generating key and certificate"
+ quit(QuitFailure)
+
+ builder.withRecord(record)
+ builder.withNetworkConfiguration(netConfig.tryGet())
+ builder.withSwitchConfiguration(
+ secureKey = some(keyPath), secureCert = some(certPath), nameResolver = resolver
+ )
+
+ let node = builder.build().tryGet()
+
+ if conf.ping:
+ try:
+ await mountLibp2pPing(node)
+ except CatchableError:
+ error "failed to mount libp2p ping protocol: " & getCurrentExceptionMsg()
+ quit(QuitFailure)
+
+ node.mountMetadata(conf.clusterId, conf.shards).isOkOr:
+ error "failed to mount metadata protocol", error
+ quit(QuitFailure)
+
+ await node.start()
+
+ var pingFut: Future[bool]
+ if conf.ping:
+ pingFut = pingNode(node, peer).withTimeout(conf.timeout)
+
+ let timedOut = not await node.connectToNodes(@[peer]).withTimeout(conf.timeout)
+ if timedOut:
+ error "Timedout after", timeout = conf.timeout
+ quit(QuitFailure)
+
+ let lp2pPeerStore = node.switch.peerStore
+ let conStatus = node.peerManager.switch.peerStore[ConnectionBook][peer.peerId]
+
+ if conf.ping:
+ discard await pingFut
+
+ if conStatus in [Connected, CanConnect]:
+ let nodeProtocols = lp2pPeerStore[ProtoBook][peer.peerId]
+
+ if not areProtocolsSupported(conf.protocols, nodeProtocols):
+ error "Not all protocols are supported",
+ expected = conf.protocols, supported = nodeProtocols
+ quit(QuitFailure)
+ elif conStatus == CannotConnect:
+ error "Could not connect", peerId = peer.peerId
+ quit(QuitFailure)
+ return 0
+
+when isMainModule:
+ let rng = crypto.newRng()
+ let status = waitFor main(rng)
+ if status == 0:
+ info "The node is reachable and supports all specified protocols"
+ else:
+ error "The node has some problems (see logs)"
+ quit status
diff --git a/third-party/nwaku/apps/wakunode2/nim.cfg b/third-party/nwaku/apps/wakunode2/nim.cfg
new file mode 100644
index 0000000..a6fab9c
--- /dev/null
+++ b/third-party/nwaku/apps/wakunode2/nim.cfg
@@ -0,0 +1,10 @@
+-d:chronicles_line_numbers
+-d:discv5_protocol_id="d5waku"
+-d:chronicles_runtime_filtering=on
+-d:chronicles_sinks="textlines,json"
+-d:chronicles_default_output_device=dynamic
+# Disabling the following topics from nim-eth and nim-dnsdisc since some types cannot be serialized
+-d:chronicles_disabled_topics="eth,dnsdisc.client"
+# Results in empty output for some reason
+#-d:"chronicles_enabled_topics=GossipSub:TRACE,WakuRelay:TRACE"
+path = "../.."
diff --git a/third-party/nwaku/apps/wakunode2/wakunode2.nim b/third-party/nwaku/apps/wakunode2/wakunode2.nim
new file mode 100644
index 0000000..ac6b38a
--- /dev/null
+++ b/third-party/nwaku/apps/wakunode2/wakunode2.nim
@@ -0,0 +1,102 @@
+{.push raises: [].}
+
+import
+ std/[options, strutils, sequtils, net],
+ chronicles,
+ chronos,
+ metrics,
+ libbacktrace,
+ system/ansi_c,
+ libp2p/crypto/crypto
+import
+ ../../tools/[rln_keystore_generator/rln_keystore_generator, confutils/cli_args],
+ waku/[
+ common/logging,
+ factory/waku,
+ node/health_monitor,
+ waku_api/rest/builder as rest_server_builder,
+ waku_core/message/default_values,
+ ]
+
+logScope:
+ topics = "wakunode main"
+
+const git_version* {.strdefine.} = "n/a"
+
+{.pop.}
+ # @TODO confutils.nim(775, 17) Error: can raise an unlisted exception: ref IOError
+when isMainModule:
+ ## Node setup happens in 6 phases:
+ ## 1. Set up storage
+ ## 2. Initialize node
+ ## 3. Mount and initialize configured protocols
+ ## 4. Start node and mounted protocols
+ ## 5. Start monitoring tools and external interfaces
+ ## 6. Setup graceful shutdown hooks
+
+ const versionString = "version / git commit hash: " & waku.git_version
+
+ var wakuNodeConf = WakuNodeConf.load(version = versionString).valueOr:
+ error "failure while loading the configuration", error = error
+ quit(QuitFailure)
+
+ ## Also called within Waku.new. The call to startRestServerEssentials needs the following line
+ logging.setupLog(wakuNodeConf.logLevel, wakuNodeConf.logFormat)
+
+ case wakuNodeConf.cmd
+ of generateRlnKeystore:
+ let conf = wakuNodeConf.toKeystoreGeneratorConf()
+ doRlnKeystoreGenerator(conf)
+ of noCommand:
+ let conf = wakuNodeConf.toWakuConf().valueOr:
+ error "Waku configuration failed", error = error
+ quit(QuitFailure)
+
+ var waku = (waitFor Waku.new(conf)).valueOr:
+ error "Waku initialization failed", error = error
+ quit(QuitFailure)
+
+ (waitFor startWaku(addr waku)).isOkOr:
+ error "Starting waku failed", error = error
+ quit(QuitFailure)
+
+ debug "Setting up shutdown hooks"
+ proc asyncStopper(waku: Waku) {.async: (raises: [Exception]).} =
+ await waku.stop()
+ quit(QuitSuccess)
+
+ # Handle Ctrl-C SIGINT
+ proc handleCtrlC() {.noconv.} =
+ when defined(windows):
+ # workaround for https://github.com/nim-lang/Nim/issues/4057
+ setupForeignThreadGc()
+ notice "Shutting down after receiving SIGINT"
+ asyncSpawn asyncStopper(waku)
+
+ setControlCHook(handleCtrlC)
+
+ # Handle SIGTERM
+ when defined(posix):
+ proc handleSigterm(signal: cint) {.noconv.} =
+ notice "Shutting down after receiving SIGTERM"
+ asyncSpawn asyncStopper(waku)
+
+ c_signal(ansi_c.SIGTERM, handleSigterm)
+
+ # Handle SIGSEGV
+ when defined(posix):
+ proc handleSigsegv(signal: cint) {.noconv.} =
+ # Require --debugger:native
+ fatal "Shutting down after receiving SIGSEGV", stacktrace = getBacktrace()
+
+ # Not available in -d:release mode
+ writeStackTrace()
+
+ waitFor waku.stop()
+ quit(QuitFailure)
+
+ c_signal(ansi_c.SIGSEGV, handleSigsegv)
+
+ info "Node setup complete"
+
+ runForever()
diff --git a/third-party/nwaku/ci/Jenkinsfile.lpt b/third-party/nwaku/ci/Jenkinsfile.lpt
new file mode 100644
index 0000000..c81a21b
--- /dev/null
+++ b/third-party/nwaku/ci/Jenkinsfile.lpt
@@ -0,0 +1,95 @@
+#!/usr/bin/env groovy
+library 'status-jenkins-lib@v1.8.17'
+
+pipeline {
+ agent { label 'linux' }
+
+ options {
+ timestamps()
+ timeout(time: 20, unit: 'MINUTES')
+ disableRestartFromStage()
+ buildDiscarder(logRotator(
+ numToKeepStr: '10',
+ daysToKeepStr: '30',
+ ))
+ }
+
+ parameters {
+ string(
+ name: 'IMAGE_TAG',
+ description: 'Name of Docker tag to push. Optional Parameter.',
+ defaultValue: 'latest'
+ )
+ string(
+ name: 'IMAGE_NAME',
+ description: 'Name of Docker image to push.',
+ defaultValue: params.IMAGE_NAME ?: 'wakuorg/liteprotocoltester',
+ )
+ string(
+ name: 'DOCKER_CRED',
+ description: 'Name of Docker Registry credential.',
+ defaultValue: params.DOCKER_CRED ?: 'harbor-telemetry-robot',
+ )
+ string(
+ name: 'DOCKER_REGISTRY',
+ description: 'URL of the Docker Registry',
+ defaultValue: params.DOCKER_REGISTRY ?: 'harbor.status.im'
+ )
+ string(
+ name: 'NIMFLAGS',
+ description: 'Flags for Nim compilation.',
+ defaultValue: params.NIMFLAGS ?: [
+ '--colors:off',
+ '-d:disableMarchNative',
+ '-d:chronicles_colors:none',
+ '-d:insecure',
+ ].join(' ')
+ )
+ choice(
+ name: "LOWEST_LOG_LEVEL_ALLOWED",
+ choices: ['TRACE', 'DEGUG', 'INFO', 'NOTICE', 'WARN', 'ERROR', 'FATAL'],
+ description: "Defines the log level, which will be available at runtime (Chronicles log level)"
+ )
+ }
+
+ stages {
+ stage('Build') {
+ steps { script {
+ image = docker.build(
+ "${DOCKER_REGISTRY}/${params.IMAGE_NAME}:${params.IMAGE_TAG ?: env.GIT_COMMIT.take(8)}",
+ "--label=commit='${git.commit()}' " +
+ "--label=version='${git.describe('--tags')}' " +
+ "--build-arg=MAKE_TARGET='liteprotocoltester' " +
+ "--build-arg=NIMFLAGS='${params.NIMFLAGS}' " +
+ "--build-arg=LOG_LEVEL='${params.LOWEST_LOG_LEVEL_ALLOWED}' " +
+ "--target ${params.IMAGE_TAG == 'deploy' ? 'deployment_lpt' : 'standalone_lpt'} " +
+ "--file=apps/liteprotocoltester/Dockerfile.liteprotocoltester.compile " +
+ " ."
+ )
+ } }
+ }
+
+ stage('Check') {
+ steps { script {
+ image.inside('--entrypoint=""') { c ->
+ sh '/usr/bin/liteprotocoltester --version'
+ }
+ } }
+ }
+
+ stage('Push') {
+ when { expression { params.IMAGE_TAG != '' } }
+ steps { script {
+ withDockerRegistry([
+ credentialsId: params.DOCKER_CRED, url: "https://${DOCKER_REGISTRY}"
+ ]) {
+ image.push(params.IMAGE_TAG)
+ }
+ } }
+ }
+ } // stages
+
+ post {
+ cleanup { cleanWs() }
+ } // post
+} // pipeline
diff --git a/third-party/nwaku/ci/Jenkinsfile.prs b/third-party/nwaku/ci/Jenkinsfile.prs
new file mode 100644
index 0000000..2aa5654
--- /dev/null
+++ b/third-party/nwaku/ci/Jenkinsfile.prs
@@ -0,0 +1,137 @@
+#!/usr/bin/env groovy
+
+library 'status-jenkins-lib@v1.6.0'
+
+pipeline {
+ agent { label "${getAgentLabel()} && x86_64" }
+
+ parameters {
+ string(
+ name: 'NIMFLAGS',
+ description: 'Flags for Nim compilation.',
+ defaultValue: params.NIMFLAGS ?: [
+ '--colors:off',
+ '-d:insecure',
+ '-d:disableMarchNative',
+ '--parallelBuild:6',
+ '-d:postgres',
+ ].join(' ')
+ )
+ string(
+ name: 'LOG_LEVEL',
+ description: 'Build logging level. (DEBUG, TRACE)',
+ defaultValue: params.LOG_LEVEL ?: 'DEBUG'
+ )
+ string(
+ name: 'VERBOSITY',
+ description: 'Makefile verbosity level.(0-2)',
+ defaultValue: params.VERBOSITY ?: '1'
+ )
+ string(
+ name: 'MAKEFLAGS',
+ description: 'Makefile flags.',
+ defaultValue: params.MAKEFLAGS ?: '-j6'
+ )
+ }
+
+ options {
+ timestamps()
+ disableRestartFromStage()
+ /* Prevent Jenkins jobs from running forever */
+ timeout(time: 30, unit: 'MINUTES')
+ /* Limit builds retained. */
+ buildDiscarder(logRotator(
+ numToKeepStr: '3',
+ daysToKeepStr: '30',
+ artifactNumToKeepStr: '1',
+ ))
+ }
+
+ environment {
+ TARGET = getAgentLabel()
+ }
+
+ stages {
+ stage('Deps') { steps { script {
+ /* Avoid checking multiple times. */
+ v2changed = versionWasChanged('v2')
+ /* TODO: Re-add caching of Nim compiler. */
+ nix.shell("make ${params.MAKEFLAGS} V=${params.VERBOSITY} update", pure: false)
+ nix.shell("make ${params.MAKEFLAGS} V=${params.VERBOSITY} deps", pure: false)
+ } } }
+
+ stage('Binaries') {
+ parallel {
+ stage('V2') {
+ when { expression { v2changed } }
+ steps { script {
+ nix.shell("make ${params.MAKEFLAGS} NIMFLAGS=\"${params.NIMFLAGS}\" V=${params.VERBOSITY} all")
+ } }
+ }
+ }
+ }
+
+ stage('Run Tests') {
+ parallel {
+ stage('V2') {
+ when { expression { v2changed } }
+ steps { script {
+ nix.shell("make ${params.MAKEFLAGS} NIMFLAGS=\"${params.NIMFLAGS}\" V=${params.VERBOSITY} test")
+ } }
+ }
+ }
+ }
+
+ stage('Upload') {
+ when { expression { v2changed } }
+ steps { script {
+ def out = genOutputFilename()
+ sh "mv build/wakunode2 ${out}"
+ env.PKG_URL = s3.uploadArtifact(out)
+ jenkins.setBuildDesc(Waku: env.PKG_URL)
+ } }
+ }
+ } // stages
+ post {
+ success { script { github.notifyPR(true) } }
+ failure { script { github.notifyPR(false) } }
+ always { cleanWs() }
+ } // post
+} // pipeline
+
+
+/* This allows us to use one Jenkinsfile and run
+ * jobs on different platforms based on job name. */
+def getAgentLabel() {
+ if (params.AGENT_LABEL) {
+ return params.AGENT_LABEL
+ }
+ def tokens = env.JOB_NAME.split('/')
+ for (platform in ['linux', 'macos', 'windows']) {
+ if (tokens.contains(platform)) { return platform }
+ }
+ throw new Exception('No agent provided or found in job path!')
+}
+
+def genOutputFilename() {
+ return [
+ "wakunode2", utils.timestamp(), utils.gitCommit(), getAgentLabel()
+ ].join('-') + (env.NODE_NAME.startsWith('windows') ? '.exe' : '.bin')
+}
+
+def versionWasChanged(version) {
+ def changes = sh(
+ script: "git diff --name-only origin/${env.CHANGE_TARGET}",
+ returnStdout: true
+ )
+ if (changes =~ "(?m)^(Makefile|waku.nimble|config.nims|vendor|ci|shell.nix).*") {
+ return true
+ }
+ if (version == 'v2' && changes =~ "(?m)^(apps|tools)/.*") {
+ return true
+ }
+ if (changes =~ "(?m)^(waku|tests|examples)/(${version}|common)/.*") {
+ return true
+ }
+ return false
+}
diff --git a/third-party/nwaku/ci/Jenkinsfile.release b/third-party/nwaku/ci/Jenkinsfile.release
new file mode 100644
index 0000000..4a0cd0d
--- /dev/null
+++ b/third-party/nwaku/ci/Jenkinsfile.release
@@ -0,0 +1,146 @@
+#!/usr/bin/env groovy
+library 'status-jenkins-lib@v1.8.17'
+
+pipeline {
+ agent { label 'linux' }
+
+ options {
+ timestamps()
+ disableRestartFromStage()
+ timeout(time: 20, unit: 'MINUTES')
+ buildDiscarder(logRotator(
+ numToKeepStr: '10',
+ daysToKeepStr: '30',
+ ))
+ }
+
+ parameters {
+ string(
+ name: 'MAKE_TARGET',
+ description: 'Makefile target to build. Optional Parameter.',
+ defaultValue: params.MAKE_TARGET ?: 'wakunode2',
+ )
+ string(
+ name: 'IMAGE_TAG',
+ description: 'Name of Docker tag to push. Optional Parameter.',
+ defaultValue: getDefaultImageTag()
+ )
+ string(
+ name: 'IMAGE_NAME',
+ description: 'Name of Docker image to push.',
+ defaultValue: params.IMAGE_NAME ?: 'harbor.status.im/wakuorg/nwaku',
+ )
+ string(
+ name: 'DOCKER_CRED',
+ description: 'Name of Docker Registry credential.',
+ defaultValue: params.DOCKER_CRED ?: 'harbor-wakuorg-robot',
+ )
+ string(
+ name: 'DOCKER_REGISTRY_URL',
+ description: 'URL of the Docker Registry',
+ defaultValue: params.DOCKER_REGISTRY_URL ?: 'https://harbor.status.im'
+ )
+ string(
+ name: 'NIMFLAGS',
+ description: 'Flags for Nim compilation.',
+ defaultValue: params.NIMFLAGS ?: [
+ '--colors:off',
+ '-d:disableMarchNative',
+ '-d:chronicles_colors:none',
+ '-d:insecure',
+ ].join(' ')
+ )
+ choice(
+ name: "LOWEST_LOG_LEVEL_ALLOWED",
+ choices: ['TRACE', 'DEGUG', 'INFO', 'NOTICE', 'WARN', 'ERROR', 'FATAL'],
+ description: "Defines the log level, which will be available at runtime (Chronicles log level)",
+ )
+ booleanParam(
+ name: 'DEBUG',
+ description: 'Enable debug features',
+ defaultValue: false
+ )
+ booleanParam(
+ name: 'HEAPTRACK',
+ description: 'Enable heaptrack build',
+ defaultValue: false
+ )
+ }
+
+ stages {
+ stage('Build') {
+ steps { script {
+ if (params.HEAPTRACK) {
+ echo 'Building with heaptrack support'
+ image = docker.build(
+ "${params.IMAGE_NAME}:${params.IMAGE_TAG ?: env.GIT_COMMIT.take(8)}",
+ "--label=build='${env.BUILD_URL}' " +
+ "--label=commit='${git.commit()}' " +
+ "--label=version='${git.describe('--tags')}' " +
+ "--build-arg=MAKE_TARGET='${params.MAKE_TARGET}' " +
+ "--build-arg=NIMFLAGS='${params.NIMFLAGS} -d:postgres -d:heaptracker ' " +
+ "--build-arg=LOG_LEVEL='${params.LOWEST_LOG_LEVEL_ALLOWED}' " +
+ "--build-arg=DEBUG='${params.DEBUG ? "1" : "0"} ' " +
+ "--build-arg=NIM_COMMIT='NIM_COMMIT=heaptrack_support_v2.0.12' " +
+ "--target='debug-with-heaptrack' ."
+ )
+ } else {
+ image = docker.build(
+ "${params.IMAGE_NAME}:${params.IMAGE_TAG ?: env.GIT_COMMIT.take(8)}",
+ "--label=build='${env.BUILD_URL}' " +
+ "--label=commit='${git.commit()}' " +
+ "--label=version='${git.describe('--tags')}' " +
+ "--build-arg=MAKE_TARGET='${params.MAKE_TARGET}' " +
+ "--build-arg=NIMFLAGS='${params.NIMFLAGS} -d:postgres ' " +
+ "--build-arg=LOG_LEVEL='${params.LOWEST_LOG_LEVEL_ALLOWED}' " +
+ "--build-arg=DEBUG='${params.DEBUG ? "1" : "0"} ' " +
+ "--target='prod' ."
+ )
+ }
+ } }
+ }
+
+ stage('Check') {
+ steps { script {
+ image.inside('--entrypoint=""') { c ->
+ sh '/usr/bin/wakunode --version'
+ }
+ } }
+ }
+
+ stage('Push') {
+ when { expression { params.IMAGE_TAG != '' } }
+ steps { script {
+ withDockerRegistry([
+ credentialsId: params.DOCKER_CRED, url: params.DOCKER_REGISTRY_URL
+ ]) {
+ image.push()
+ /* If Git ref is a tag push it as Docker tag too. */
+ if (params.GIT_REF ==~ /v\d+\.\d+\.\d+.*/) {
+ image.push(params.GIT_REF)
+ image.push('latest-release')
+ }
+ }
+ } }
+ }
+ } // stages
+
+ post {
+ success { script {
+ discord.send(
+ header: '**Nim-Waku deployment successful!**',
+ cred: 'discord-waku-deployments-webhook',
+ descPrefix: "Image: [`${IMAGE_NAME}:${IMAGE_TAG}`](https://hub.docker.com/r/${IMAGE_NAME}/tags?name=${IMAGE_TAG})"
+ )
+ } }
+ always { sh 'docker image prune -f' }
+ } // post
+} // pipeline
+
+def getDefaultImageTag() {
+ switch (env.JOB_BASE_NAME) {
+ case 'docker-latest': return 'latest'
+ case 'docker-release': return 'stable'
+ default: return env.JOB_BASE_NAME
+ }
+}
diff --git a/third-party/nwaku/config.nims b/third-party/nwaku/config.nims
new file mode 100644
index 0000000..f74fe18
--- /dev/null
+++ b/third-party/nwaku/config.nims
@@ -0,0 +1,127 @@
+import os
+
+if defined(release):
+ switch("nimcache", "nimcache/release/$projectName")
+else:
+ switch("nimcache", "nimcache/debug/$projectName")
+
+if defined(windows):
+ switch("passL", "rln.lib")
+ switch("define", "postgres=false")
+
+ # Automatically add all vendor subdirectories
+ for dir in walkDir("./vendor"):
+ if dir.kind == pcDir:
+ switch("path", dir.path)
+ switch("path", dir.path / "src")
+
+ # disable timestamps in Windows PE headers - https://wiki.debian.org/ReproducibleBuilds/TimestampsInPEBinaries
+ switch("passL", "-Wl,--no-insert-timestamp")
+ # increase stack size
+ switch("passL", "-Wl,--stack,8388608")
+ # https://github.com/nim-lang/Nim/issues/4057
+ --tlsEmulation:
+ off
+ if defined(i386):
+ # set the IMAGE_FILE_LARGE_ADDRESS_AWARE flag so we can use PAE, if enabled, and access more than 2 GiB of RAM
+ switch("passL", "-Wl,--large-address-aware")
+
+ # The dynamic Chronicles output currently prevents us from using colors on Windows
+ # because these require direct manipulations of the stdout File object.
+ switch("define", "chronicles_colors=off")
+
+# https://github.com/status-im/nimbus-eth2/blob/stable/docs/cpu_features.md#ssse3-supplemental-sse3
+# suggests that SHA256 hashing with SSSE3 is 20% faster than without SSSE3, so
+# given its near-ubiquity in the x86 installed base, it renders a distribution
+# build more viable on an overall broader range of hardware.
+#
+if defined(disableMarchNative):
+ if defined(i386) or defined(amd64):
+ if defined(macosx):
+ # macOS Catalina is EOL as of 2022-09
+ # https://support.apple.com/kb/sp833
+ # "macOS Big Sur - Technical Specifications" lists current oldest
+ # supported models: MacBook (2015 or later), MacBook Air (2013 or later),
+ # MacBook Pro (Late 2013 or later), Mac mini (2014 or later), iMac (2014
+ # or later), iMac Pro (2017 or later), Mac Pro (2013 or later).
+ #
+ # These all have Haswell or newer CPUs.
+ #
+ # This ensures AVX2, AES-NI, PCLMUL, BMI1, and BMI2 instruction set support.
+ switch("passC", "-march=haswell -mtune=generic")
+ switch("passL", "-march=haswell -mtune=generic")
+ else:
+ if defined(marchOptimized):
+ # https://github.com/status-im/nimbus-eth2/blob/stable/docs/cpu_features.md#bmi2--adx
+ switch("passC", "-march=broadwell -mtune=generic")
+ switch("passL", "-march=broadwell -mtune=generic")
+ else:
+ switch("passC", "-mssse3")
+ switch("passL", "-mssse3")
+elif defined(macosx) and defined(arm64):
+ # Apple's Clang can't handle "-march=native" on M1: https://github.com/status-im/nimbus-eth2/issues/2758
+ switch("passC", "-mcpu=apple-m1")
+ switch("passL", "-mcpu=apple-m1")
+else:
+ if not defined(android):
+ switch("passC", "-march=native")
+ switch("passL", "-march=native")
+ if defined(windows):
+ # https://gcc.gnu.org/bugzilla/show_bug.cgi?id=65782
+ # ("-fno-asynchronous-unwind-tables" breaks Nim's exception raising, sometimes)
+ switch("passC", "-mno-avx512f")
+ switch("passL", "-mno-avx512f")
+
+--threads:
+ on
+--opt:
+ speed
+--excessiveStackTrace:
+ on
+# enable metric collection
+--define:
+ metrics
+# for heap-usage-by-instance-type metrics and object base-type strings
+--define:
+ nimTypeNames
+
+switch("define", "withoutPCRE")
+
+# the default open files limit is too low on macOS (512), breaking the
+# "--debugger:native" build. It can be increased with `ulimit -n 1024`.
+if not defined(macosx) and not defined(android):
+ # add debugging symbols and original files and line numbers
+ --debugger:
+ native
+ if not (defined(windows) and defined(i386)) and not defined(disable_libbacktrace):
+ # light-weight stack traces using libbacktrace and libunwind
+ --define:
+ nimStackTraceOverride
+ switch("import", "libbacktrace")
+
+--define:
+ nimOldCaseObjects
+ # https://github.com/status-im/nim-confutils/issues/9
+
+# `switch("warning[CaseTransition]", "off")` fails with "Error: invalid command line option: '--warning[CaseTransition]'"
+switch("warning", "CaseTransition:off")
+
+# The compiler doth protest too much, methinks, about all these cases where it can't
+# do its (N)RVO pass: https://github.com/nim-lang/RFCs/issues/230
+switch("warning", "ObservableStores:off")
+
+# Too many false positives for "Warning: method has lock level , but another method has 0 [LockLevel]"
+switch("warning", "LockLevel:off")
+
+if defined(android):
+ var clang = getEnv("ANDROID_COMPILER")
+ var ndk_home = getEnv("ANDROID_TOOLCHAIN_DIR")
+ var sysroot = ndk_home & "/sysroot"
+ var cincludes = sysroot & "/usr/include/" & getEnv("ANDROID_ARCH")
+
+ switch("clang.path", ndk_home & "/bin")
+ switch("clang.exe", clang)
+ switch("clang.linkerexe", clang)
+ switch("passC", "--sysroot=" & sysRoot)
+ switch("passL", "--sysroot=" & sysRoot)
+ switch("cincludes", sysRoot & "/usr/include/")
diff --git a/third-party/nwaku/docker/binaries/Dockerfile.bn.amd64 b/third-party/nwaku/docker/binaries/Dockerfile.bn.amd64
new file mode 100644
index 0000000..7fba7ce
--- /dev/null
+++ b/third-party/nwaku/docker/binaries/Dockerfile.bn.amd64
@@ -0,0 +1,31 @@
+# Dockerfile to build a distributable container image from pre-existing binaries
+FROM debian:bookworm-slim AS prod
+
+ARG MAKE_TARGET=wakunode2
+
+LABEL maintainer="vaclav@status.im"
+LABEL source="https://github.com/waku-org/nwaku"
+LABEL description="Wakunode: Waku client"
+LABEL commit="unknown"
+
+# DevP2P, LibP2P, and JSON RPC ports
+EXPOSE 30303 60000 8545
+
+# Referenced in the binary
+RUN apt-get update &&\
+ apt-get install -y libpq-dev curl iproute2 wget dnsutils &&\
+ apt-get clean && rm -rf /var/lib/apt/lists/*
+
+# Copy to separate location to accomodate different MAKE_TARGET values
+ADD ./build/$MAKE_TARGET /usr/local/bin/
+
+# Copy migration scripts for DB upgrades
+ADD ./migrations/ /app/migrations/
+
+# Symlink the correct wakunode binary
+RUN ln -sv /usr/local/bin/$MAKE_TARGET /usr/bin/wakunode
+
+ENTRYPOINT ["/usr/bin/wakunode"]
+
+# By default just show help if called without arguments
+CMD ["--help"]
diff --git a/third-party/nwaku/docker/binaries/Dockerfile.bn.local b/third-party/nwaku/docker/binaries/Dockerfile.bn.local
new file mode 100644
index 0000000..79445d1
--- /dev/null
+++ b/third-party/nwaku/docker/binaries/Dockerfile.bn.local
@@ -0,0 +1,63 @@
+# Dockerfile to build a distributable container image from pre-existing binaries
+# FROM debian:stable-slim AS prod
+FROM ubuntu:24.04 AS prod
+
+ARG MAKE_TARGET=wakunode2
+
+LABEL maintainer="vaclav@status.im"
+LABEL source="https://github.com/waku-org/nwaku"
+LABEL description="Wakunode: Waku client"
+LABEL commit="unknown"
+
+# DevP2P, LibP2P, and JSON RPC ports
+EXPOSE 30303 60000 8545
+
+# Referenced in the binary
+RUN apt-get update &&\
+ apt-get install -y libpcre3 libpq-dev curl iproute2 wget jq dnsutils &&\
+ apt-get clean && rm -rf /var/lib/apt/lists/*
+
+# Fix for 'Error loading shared library libpcre.so.3: No such file or directory'
+RUN ln -s /usr/lib/libpcre.so /usr/lib/libpcre.so.3
+
+# Copy to separate location to accomodate different MAKE_TARGET values
+ADD ./build/$MAKE_TARGET /usr/local/bin/
+
+# Copy migration scripts for DB upgrades
+ADD ./migrations/ /app/migrations/
+
+# Symlink the correct wakunode binary
+RUN ln -sv /usr/local/bin/$MAKE_TARGET /usr/bin/wakunode
+
+ENTRYPOINT ["/usr/bin/wakunode"]
+
+# By default just show help if called without arguments
+CMD ["--help"]
+
+# Build debug tools: heaptrack
+FROM ubuntu:24.04 AS heaptrack-build
+
+RUN apt update
+RUN apt install -y gdb git g++ make cmake zlib1g-dev libboost-all-dev libunwind-dev
+RUN git clone https://github.com/KDE/heaptrack.git /heaptrack
+
+WORKDIR /heaptrack/build
+# going to a commit that builds properly. We will revisit this for new releases
+RUN git reset --hard f9cc35ebbdde92a292fe3870fe011ad2874da0ca
+RUN cmake -DCMAKE_BUILD_TYPE=Release ..
+RUN make -j$(nproc)
+
+
+# Debug image
+FROM prod AS debug-with-heaptrack
+
+RUN apt update
+RUN apt install -y gdb libunwind8
+
+# Add heaptrack
+COPY --from=heaptrack-build /heaptrack/build/ /heaptrack/build/
+
+ENV LD_LIBRARY_PATH=/heaptrack/build/lib/heaptrack/
+RUN ln -s /heaptrack/build/bin/heaptrack /usr/local/bin/heaptrack
+
+ENTRYPOINT ["/heaptrack/build/bin/heaptrack", "/usr/bin/wakunode"]
diff --git a/third-party/nwaku/docs/api/node.md b/third-party/nwaku/docs/api/node.md
new file mode 100644
index 0000000..ab1580f
--- /dev/null
+++ b/third-party/nwaku/docs/api/node.md
@@ -0,0 +1,94 @@
+# Waku APIs
+
+## Nim API
+
+The Nim Waku API consist of a set of methods operating on the Waku Node object.
+Some of them have different arity depending on what privacy/bandwidth trade-off
+the consumer wants to make. These methods are:
+
+1. **Init** - create a node.
+2. **Start** - start a created node.
+3. **Subscribe** - to a topic or a specific content filter.
+4. **Unsubscribe** - to a topic or a specific content filter.
+5. **Publish** - to a topic, or a topic and a specific content filter.
+6. **Query** - for historical messages.
+7. **Info** - to get information about the node.
+8. **Resume** - to retrieve and persist the message history since the node's last online time.
+
+```Nim
+proc init*(T: type WakuNode, nodeKey: crypto.PrivateKey,
+ bindIp: ValidIpAddress, bindPort: Port,
+ extIp = none[ValidIpAddress](), extPort = none[Port]()): T =
+ ## Creates a Waku Node.
+ ##
+ ## Status: Implemented.
+
+proc start*(node: WakuNode) {.async.} =
+ ## Starts a created Waku Node.
+ ##
+ ## Status: Implemented.
+
+proc subscribe*(node: WakuNode, topic: Topic, handler: TopicHandler) =
+ ## Subscribes to a PubSub topic. Triggers handler when receiving messages on
+ ## this topic. TopicHandler is a method that takes a topic and some data.
+ ##
+ ## NOTE The data field SHOULD be decoded as a WakuMessage.
+ ## Status: Implemented.
+
+proc subscribe*(node: WakuNode, request: FilterRequest, handler: ContentFilterHandler) {.async, gcsafe.} =
+ ## Registers for messages that match a specific filter. Triggers the handler whenever a message is received.
+ ## FilterHandler is a method that takes a MessagePush.
+ ##
+ ## Status: Implemented.
+
+proc unsubscribe*(node: WakuNode, topic: Topic, handler: TopicHandler) =
+ ## Unsubscribes a handler from a PubSub topic.
+ ##
+ ## Status: Implemented.
+
+proc unsubscribeAll*(node: WakuNode, topic: Topic) =
+ ## Unsubscribes all handlers registered on a specific PubSub topic.
+ ##
+ ## Status: Implemented.
+
+proc unsubscribe*(w: WakuNode, contentFilter: ContentFilter) =
+ ## Unsubscribe from a content filter.
+ ##
+ ## Status: Not yet implemented.
+ ## TODO Implement.
+
+proc publish*(node: WakuNode, topic: Topic, message: WakuMessage) =
+ ## Publish a `WakuMessage` to a PubSub topic. `WakuMessage` should contain a
+ ## `contentTopic` field for light node functionality. This field may be also
+ ## be omitted.
+ ##
+ ## Status: Implemented.
+
+proc query*(w: WakuNode, query: HistoryQuery, handler: QueryHandlerFunc) {.async, gcsafe.} =
+ ## Queries known nodes for historical messages. Triggers the handler whenever a response is received.
+ ## QueryHandlerFunc is a method that takes a HistoryResponse.
+ ##
+ ## Status: Implemented.
+
+proc info*(node: WakuNode): WakuInfo =
+ ## Returns information about the Node, such as what multiaddress it can be reached at.
+ ##
+ ## Status: Implemented.
+ ##
+
+proc resume*(node: WakuNode, peerList: Option[seq[PeerInfo]]) =
+ ## Retrieves and persists the history of waku messages published on the default waku pubsub topic since the last time the waku node has been online.
+ ## It requires the waku node to have the store protocol mounted in the full mode (i.e., persisting messages).
+ ## `peerList` indicates the list of peers to query from.
+ ## The history is fetched from all available peers in this list and then consolidated into one deduplicated list.
+ ## If no peerList is passed, the history is fetched from one of the known peers.
+ ## It retrieves the history successfully given that the dialed peer has been online during the queried time window.
+ ##
+ ## Status: Implemented.
+ ##
+```
+
+
+## REST API
+
+[Here](./rest-api.md) you can find more details on the Node HTTP REST API.
diff --git a/third-party/nwaku/docs/api/rest-api.md b/third-party/nwaku/docs/api/rest-api.md
new file mode 100644
index 0000000..eeb90ab
--- /dev/null
+++ b/third-party/nwaku/docs/api/rest-api.md
@@ -0,0 +1,43 @@
+## HTTP REST API
+
+The HTTP REST API consists of a set of methods operating on the Waku Node remotely over HTTP.
+
+This API is divided in different _namespaces_ which group a set of resources:
+
+| Namespace | Description |
+------------|--------------
+| `/debug` | Information about a Waku v2 node. |
+| `/relay` | Control of the relaying of messages. See [11/WAKU2-RELAY](https://rfc.vac.dev/spec/11/) RFC |
+| `/store` | Retrieve the message history. See [13/WAKU2-STORE](https://rfc.vac.dev/spec/13/) RFC |
+| `/filter` | Control of the content filtering. See [12/WAKU2-FILTER](https://rfc.vac.dev/spec/12/) RFC |
+| `/admin` | Privileged access to the internal operations of the node. |
+| `/private` | Provides functionality to encrypt/decrypt `WakuMessage` payloads using either symmetric or asymmetric cryptography. This allows backwards compatibility with Waku v1 nodes. |
+
+
+### API Specification
+
+The HTTP REST API has been designed following the OpenAPI 3.0.3 standard specification format.
+The OpenAPI specification files can be found in the [Waku Node REST API Reference](https://waku-org.github.io/waku-rest-api/) repository.
+
+You can also use [hosted OpenAPI UI](https://waku-org.github.io/waku-rest-api/) to explore and execute the calls locally.
+
+Check the [OpenAPI Tools](https://openapi.tools/) site for the right tool for you (e.g. REST API client generator)
+
+A particular OpenAPI spec can be easily imported into [Postman](https://www.postman.com/downloads/)
+ 1. Open Postman.
+ 2. Click on File -> Import...
+ 2. Load the openapi.yaml of interest, stored in your computer.
+ 3. Then, requests can be made from within the 'Collections' section.
+
+
+### Usage example
+
+#### [`get_waku_v2_debug_v1_info`](https://rfc.vac.dev/spec/16/#get_waku_v2_debug_v1_info)
+
+```bash
+curl http://localhost:8645/debug/v1/info -s | jq
+```
+
+
+### Node configuration
+Find details [here](https://github.com/waku-org/nwaku/tree/master/docs/operators/how-to/configure-rest-api.md)
diff --git a/third-party/nwaku/docs/benchmarks/cspell.json b/third-party/nwaku/docs/benchmarks/cspell.json
new file mode 100644
index 0000000..8227630
--- /dev/null
+++ b/third-party/nwaku/docs/benchmarks/cspell.json
@@ -0,0 +1,20 @@
+{ "words":
+ [
+ "pubsubtopic",
+ "jmeter",
+ "analyzed",
+ "queryc",
+ "wakudev",
+ "statusim",
+ "queryc",
+ "wakudev",
+ "statusim",
+ "chronos",
+ "libpqis",
+ "Conn",
+ "messageindex",
+ "storedat",
+ "pubsubtopic",
+ "wakudev"
+ ]
+}
diff --git a/third-party/nwaku/docs/benchmarks/imgs/digram_multiple_nodes_one_database.png b/third-party/nwaku/docs/benchmarks/imgs/digram_multiple_nodes_one_database.png
new file mode 100644
index 0000000..e26f392
Binary files /dev/null and b/third-party/nwaku/docs/benchmarks/imgs/digram_multiple_nodes_one_database.png differ
diff --git a/third-party/nwaku/docs/benchmarks/imgs/insert-time-dist-2.png b/third-party/nwaku/docs/benchmarks/imgs/insert-time-dist-2.png
new file mode 100644
index 0000000..a5af6a3
Binary files /dev/null and b/third-party/nwaku/docs/benchmarks/imgs/insert-time-dist-2.png differ
diff --git a/third-party/nwaku/docs/benchmarks/imgs/insert-time-dist-3.png b/third-party/nwaku/docs/benchmarks/imgs/insert-time-dist-3.png
new file mode 100644
index 0000000..34980c7
Binary files /dev/null and b/third-party/nwaku/docs/benchmarks/imgs/insert-time-dist-3.png differ
diff --git a/third-party/nwaku/docs/benchmarks/imgs/insert-time-dist-4.png b/third-party/nwaku/docs/benchmarks/imgs/insert-time-dist-4.png
new file mode 100644
index 0000000..7287c82
Binary files /dev/null and b/third-party/nwaku/docs/benchmarks/imgs/insert-time-dist-4.png differ
diff --git a/third-party/nwaku/docs/benchmarks/imgs/insert-time-dist-5.png b/third-party/nwaku/docs/benchmarks/imgs/insert-time-dist-5.png
new file mode 100644
index 0000000..8e97630
Binary files /dev/null and b/third-party/nwaku/docs/benchmarks/imgs/insert-time-dist-5.png differ
diff --git a/third-party/nwaku/docs/benchmarks/imgs/insert-time-dist-6.png b/third-party/nwaku/docs/benchmarks/imgs/insert-time-dist-6.png
new file mode 100644
index 0000000..de86a96
Binary files /dev/null and b/third-party/nwaku/docs/benchmarks/imgs/insert-time-dist-6.png differ
diff --git a/third-party/nwaku/docs/benchmarks/imgs/insert-time-dist-postgres-2.png b/third-party/nwaku/docs/benchmarks/imgs/insert-time-dist-postgres-2.png
new file mode 100644
index 0000000..b515c5b
Binary files /dev/null and b/third-party/nwaku/docs/benchmarks/imgs/insert-time-dist-postgres-2.png differ
diff --git a/third-party/nwaku/docs/benchmarks/imgs/insert-time-dist-postgres-3.png b/third-party/nwaku/docs/benchmarks/imgs/insert-time-dist-postgres-3.png
new file mode 100644
index 0000000..5531572
Binary files /dev/null and b/third-party/nwaku/docs/benchmarks/imgs/insert-time-dist-postgres-3.png differ
diff --git a/third-party/nwaku/docs/benchmarks/imgs/insert-time-dist-postgres.png b/third-party/nwaku/docs/benchmarks/imgs/insert-time-dist-postgres.png
new file mode 100644
index 0000000..dad6707
Binary files /dev/null and b/third-party/nwaku/docs/benchmarks/imgs/insert-time-dist-postgres.png differ
diff --git a/third-party/nwaku/docs/benchmarks/imgs/insert-time-dist.png b/third-party/nwaku/docs/benchmarks/imgs/insert-time-dist.png
new file mode 100644
index 0000000..9247b8e
Binary files /dev/null and b/third-party/nwaku/docs/benchmarks/imgs/insert-time-dist.png differ
diff --git a/third-party/nwaku/docs/benchmarks/imgs/jmeter-results.png b/third-party/nwaku/docs/benchmarks/imgs/jmeter-results.png
new file mode 100644
index 0000000..451c662
Binary files /dev/null and b/third-party/nwaku/docs/benchmarks/imgs/jmeter-results.png differ
diff --git a/third-party/nwaku/docs/benchmarks/imgs/num-queries-per-minute.png b/third-party/nwaku/docs/benchmarks/imgs/num-queries-per-minute.png
new file mode 100644
index 0000000..f63c197
Binary files /dev/null and b/third-party/nwaku/docs/benchmarks/imgs/num-queries-per-minute.png differ
diff --git a/third-party/nwaku/docs/benchmarks/imgs/query-time-dist-2.png b/third-party/nwaku/docs/benchmarks/imgs/query-time-dist-2.png
new file mode 100644
index 0000000..c101c81
Binary files /dev/null and b/third-party/nwaku/docs/benchmarks/imgs/query-time-dist-2.png differ
diff --git a/third-party/nwaku/docs/benchmarks/imgs/query-time-dist-3.png b/third-party/nwaku/docs/benchmarks/imgs/query-time-dist-3.png
new file mode 100644
index 0000000..078e3ee
Binary files /dev/null and b/third-party/nwaku/docs/benchmarks/imgs/query-time-dist-3.png differ
diff --git a/third-party/nwaku/docs/benchmarks/imgs/query-time-dist-4.png b/third-party/nwaku/docs/benchmarks/imgs/query-time-dist-4.png
new file mode 100644
index 0000000..a6ea99e
Binary files /dev/null and b/third-party/nwaku/docs/benchmarks/imgs/query-time-dist-4.png differ
diff --git a/third-party/nwaku/docs/benchmarks/imgs/query-time-dist-5.png b/third-party/nwaku/docs/benchmarks/imgs/query-time-dist-5.png
new file mode 100644
index 0000000..484545e
Binary files /dev/null and b/third-party/nwaku/docs/benchmarks/imgs/query-time-dist-5.png differ
diff --git a/third-party/nwaku/docs/benchmarks/imgs/query-time-dist-6.png b/third-party/nwaku/docs/benchmarks/imgs/query-time-dist-6.png
new file mode 100644
index 0000000..4bc5ea9
Binary files /dev/null and b/third-party/nwaku/docs/benchmarks/imgs/query-time-dist-6.png differ
diff --git a/third-party/nwaku/docs/benchmarks/imgs/query-time-dist-postgres-2.png b/third-party/nwaku/docs/benchmarks/imgs/query-time-dist-postgres-2.png
new file mode 100644
index 0000000..3f7033f
Binary files /dev/null and b/third-party/nwaku/docs/benchmarks/imgs/query-time-dist-postgres-2.png differ
diff --git a/third-party/nwaku/docs/benchmarks/imgs/query-time-dist-postgres-3.png b/third-party/nwaku/docs/benchmarks/imgs/query-time-dist-postgres-3.png
new file mode 100644
index 0000000..2816a8d
Binary files /dev/null and b/third-party/nwaku/docs/benchmarks/imgs/query-time-dist-postgres-3.png differ
diff --git a/third-party/nwaku/docs/benchmarks/imgs/query-time-dist-postgres.png b/third-party/nwaku/docs/benchmarks/imgs/query-time-dist-postgres.png
new file mode 100644
index 0000000..034ca24
Binary files /dev/null and b/third-party/nwaku/docs/benchmarks/imgs/query-time-dist-postgres.png differ
diff --git a/third-party/nwaku/docs/benchmarks/imgs/query-time-dist.png b/third-party/nwaku/docs/benchmarks/imgs/query-time-dist.png
new file mode 100644
index 0000000..ff7eca4
Binary files /dev/null and b/third-party/nwaku/docs/benchmarks/imgs/query-time-dist.png differ
diff --git a/third-party/nwaku/docs/benchmarks/imgs/topology-only-store-protocol.png b/third-party/nwaku/docs/benchmarks/imgs/topology-only-store-protocol.png
new file mode 100644
index 0000000..7ef28c1
Binary files /dev/null and b/third-party/nwaku/docs/benchmarks/imgs/topology-only-store-protocol.png differ
diff --git a/third-party/nwaku/docs/benchmarks/imgs/using-jmeter.png b/third-party/nwaku/docs/benchmarks/imgs/using-jmeter.png
new file mode 100644
index 0000000..73918de
Binary files /dev/null and b/third-party/nwaku/docs/benchmarks/imgs/using-jmeter.png differ
diff --git a/third-party/nwaku/docs/benchmarks/postgres-adoption.md b/third-party/nwaku/docs/benchmarks/postgres-adoption.md
new file mode 100644
index 0000000..89fba19
--- /dev/null
+++ b/third-party/nwaku/docs/benchmarks/postgres-adoption.md
@@ -0,0 +1,239 @@
+---
+title: PostgreSQL
+description: Document that describes why Nim-Waku started to use Postgres and shows some benchmark and comparison results.
+---
+
+## Introduction
+
+The *Nim Waku Node*, *nwaku*, has the capability of archiving messages until a certain limit (e.g. 30 days) so that other nodes can synchronize their message history throughout the *Store* protocol.
+
+The *nwaku* originally used *SQLite* to archive messages but this has an impact on the node. *Nwaku* is single-threaded and therefore, any *SQLite* operation impacts the performance of other protocols, like *Relay.*
+
+Therefore, the *Postgres* adoption is needed to enhance that.
+
+[https://github.com/waku-org/nwaku/issues/1888](https://github.com/waku-org/nwaku/issues/1888)
+
+## How to connect the *nwaku* to *Postgres*
+
+Simply pass the next parameter to *nwaku*
+
+```bash
+--store-message-db-url="postgres://${POSTGRES_USER}:${POSTGRES_PASSWORD}@${POSTGRES_HOST}:${POSTGRES_PORT}/postgres
+```
+
+Notice that this only makes sense if the _nwaku_ has the _Store_ protocol mounted
+```bash
+--store=true
+```
+
+(start the _nwaku_ node with `--help` parameter for more _Store_ options)
+
+## Examples of *nwaku* using *Postgres*
+
+[https://github.com/waku-org/nwaku-compose](https://github.com/waku-org/nwaku-compose)
+
+[https://github.com/waku-org/test-waku-query](https://github.com/waku-org/test-waku-query)
+
+## Stress tests
+
+The following repository was created as a tool to stress and compare performance between *nwaku*+*Postgres* and *nwaku*+*SQLite*:
+
+[https://github.com/waku-org/test-waku-query](https://github.com/waku-org/test-waku-query)
+
+### Insert test results
+
+#### Maximum insert throughput
+
+**Scenario**
+
+- 1 node subscribed to pubsubtopic ‘x’ and the *Store* protocol mounted.
+- ‘n’ nodes connected to the “store” node, and publishing messages simultaneously to pubsubtopic ‘x’.
+- All nodes running locally in a *Dell Latitude 7640*.
+- Each published message is fixed, 1.4 KB: [publish_one_client.sh](https://github.com/waku-org/test-waku-query/blob/master/sh/publish_one_client.sh)
+- The next script is used to simulate multiple nodes publishing messages: [publish_multiple_clients.sh](https://github.com/waku-org/test-waku-query/blob/fe7061a21eb14395e723402face755c826077aec/sh/publish_multiple_clients.sh)
+
+**Sought goal**
+
+Find out the maximum number of concurrent inserts that both *SQLite* and *Postgres* could support, and check whether _Postgres_ behaves better than _SQLite_ or not.
+
+**Conclusion**
+
+Messages are lost after a certain threshold, and this message loss is due to limitations in the *Relay* protocol (GossipSub - libp2p.)
+
+For example, if we set 30 nodes publishing 300 messages simultaneously, then 8997 rows were stored and not the expected 9000, in both *SQLite* and *Postgres* databases.
+
+The reason why few messages were lost is because the message rate was higher than the *relay* protocol can support, and therefore a few messages were not stored. In this example, the test took 38.8’’, and therefore, the node was receiving 232 msgs/sec, which is much more than the normal rate a node will work with, which is ~10 msgs/sec (rate extracted from Grafana’s stats for the *status.prod* fleet.)
+
+As a conclusion, the bottleneck is within the *Relay* protocol itself and not the underlying databases. Or, in other words, both *SQLite* and *Postgres* can support the maximum insert rate a Waku node will operate within normal conditions.
+
+### Query test results (jmeter)
+
+In this case, we are comparing *Store* performance by means of Rest service.
+
+**Scenario**
+
+- node_a: one _nwaku_ node with *Store* and connected to *Postgres.*
+- node_b: one _nwaku_ node with *Store* and using *SQLite*.
+- Both *Postgres* and *SQLite* contain +1 million rows.
+- node_c: one _nwaku_ node with *REST* enabled and acting as a *Store client* for node_a.
+- node_d: one _nwaku_ node with *REST* enabled and acting as a *Store client* for node_b.
+- With _jmeter_, 10 users make *REST* *Store* requests concurrently to each of the “rest” nodes (node_c and node_d.)
+- All _nwaku_ nodes running statusteam/nim-waku:v0.19.0
+
+[This](https://github.com/waku-org/test-waku-query/blob/master/docker/jmeter/http_store_requests.jmx) is the _jmeter_ project used.
+
+
+
+*Results*
+
+With this, the *node_b* brings a higher throughput than the *node_a* and that indicates that the node that uses SQLite performs better. The following shows the measures taken by _jmeter_ with regard to the REST requests.
+
+
+
+### Query test results (only Store protocol)
+
+In this test suite, only the Store protocol is being analyzed, i.e. without REST. For that, a go-waku node is used, which acts as *Store* client. On the other hand, we have another go-waku app that publishes random *Relay* messages periodically. Therefore, this can be considered a more realistic approach.
+
+The following diagram shows the topology used:
+
+
+
+For that, the next apps were used:
+
+1. [Waku-publisher.](https://github.com/alrevuelta/waku-publisher/tree/9fb206c14a17dd37d20a9120022e86475ce0503f) This app can publish Relay messages with different numbers of clients
+2. [Waku-store-query-generator](https://github.com/Ivansete-status/waku-store-query-generator/tree/19e6455537b6d44199cf0c8558480af5c6788b0d). This app is based on the Waku-publisher but in this case, it can spawn concurrent go-waku Store clients.
+
+That topology is defined in [this](https://github.com/waku-org/test-waku-query/blob/7090cd125e739306357575730d0e54665c279670/docker/docker-compose-manual-binaries.yml) docker-compose file.
+
+Notice that the two `nwaku` nodes run the very same version, which is compiled locally.
+
+#### Comparing archive SQLite & Postgres performance in [nwaku-b6dd6899](https://github.com/waku-org/nwaku/tree/b6dd6899030ee628813dfd60ad1ad024345e7b41)
+
+The next results were obtained by running the docker-compose-manual-binaries.yml from [test-waku-query-c078075](https://github.com/waku-org/test-waku-query/tree/c07807597faa781ae6c8c32eefdf48ecac03a7ba) in the sandbox machine (metal-01.he-eu-hel1.misc.wakudev.status.im.)
+
+**Scenario 1**
+
+**Store rate:** 1 user generating 1 store-req/sec.
+
+**Relay rate:** 1 user generating 10msg/sec, 10KB each.
+
+In this case, we can see that the SQLite performance is better regarding the store requests.
+
+
+
+
+
+The following graph shows how the *SQLite* node has blocking periods whereas the *Postgres* always gives a steady rate.
+
+
+
+**Scenario 2**
+
+**Store rate:** 10 users generating 1 store-req/sec.
+
+**Relay rate:** 1 user generating 10msg/sec, 10KB each.
+
+In this case, is more evident that the *SQLite* performs better.
+
+
+
+
+
+**Scenario 3**
+
+**Store rate:** 25 users generating 1 store-req/sec.
+
+**Relay rate:** 1 user generating 10msg/sec, 10KB each.
+
+In this case, the performance is similar regarding the timings. The store rate is bigger in *SQLite* and *Postgres* keeps the same level as in scenario 2.
+
+
+
+
+
+#### Comparing archive SQLite & Postgres performance in [nwaku-b452ed8](https://github.com/waku-org/nwaku/tree/b452ed865466a33b7f5b87fa937a8471b28e466e)
+
+This nwaku commit is after a few **Postgres** optimizations were applied.
+
+The next results were obtained by running the docker-compose-manual-binaries.yml from [test-waku-query-c078075](https://github.com/waku-org/test-waku-query/tree/c07807597faa781ae6c8c32eefdf48ecac03a7ba) in the sandbox machine (metal-01.he-eu-hel1.misc.wakudev.status.im.)
+
+**Scenario 1**
+
+**Store rate** 1 user generating 1 store-req/sec. Notice that the current Store query used generates pagination which provokes more subsequent queries than the 1 req/sec that would be expected without pagination.
+
+**Relay rate:** 1 user generating 10msg/sec, 10KB each.
+
+
+
+
+
+It cannot be appreciated but the average *****Store***** time was 11ms.
+
+**Scenario 2**
+
+**Store rate:** 10 users generating 1 store-req/sec. Notice that the current Store query used generates pagination which provokes more subsequent queries than the 10 req/sec that would be expected without pagination.
+
+**Relay rate:** 1 user generating 10msg/sec, 10KB each.
+
+
+
+
+
+**Scenario 3**
+
+**Store rate:** 25 users generating 1 store-req/sec. Notice that the current Store query used generates pagination which provokes more subsequent queries than the 25 req/sec that would be expected without pagination.
+
+**Relay rate:** 1 user generating 10msg/sec, 10KB each.
+
+
+
+
+
+#### Conclusions
+
+After comparing both systems, *SQLite* performs much better than *Postgres* However, a benefit of using *Postgres* is that it performs asynchronous operations, and therefore doesn’t consume CPU time that would be better invested in *Relay* for example.
+
+Remember that _nwaku_ is single-threaded and *chronos* performs orchestration among a bunch of async tasks, and therefore it is not a good practice to block the whole _nwaku_ process in a query, as happens with *SQLite*
+
+After applying a few *Postgres* enhancements, it can be noticed that the use of concurrent *Store* queries doesn’t go below the 250ms barrier. The reason for that is that most of the time is being consumed in [this point](https://github.com/waku-org/nwaku/blob/6da1aeec5370bb1c116509e770178cca2662b69c/waku/common/databases/db_postgres/dbconn.nim#L124). The `libpqisBusy()` function indicates that the connection is still busy even the queries finished.
+
+Notice that we usually have a rate below 1100 req/minute in _status.prod_ fleet (checked November 7, 2023.)
+
+-----------------------------
+
+### Multiple nodes & one single database
+
+This study aims to look for possible issues when having only one single database while several Waku nodes insert or retrieve data from it.
+The following diagram shows the scenery used for such analysis.
+
+
+
+There are three nim-waku nodes that are connected to the same database and all of them are trying to write messages to the same _PostgreSQL_ instance. With that, it is very common to see errors like:
+```
+ERR 2023-11-27 13:18:07.575+00:00 failed to insert message topics="waku archive" tid=2921 file=archive.nim:111 err="error in runStmt: error in dbConnQueryPrepared calling waitQueryToFinish: error in query: ERROR: duplicate key value violates unique constraint \"messageindex\"\nDETAIL: Key (storedat, id, pubsubtopic)=(1701091087417938405, 479c95bbf74222417abf76c7f9c480a6790e454374dc4f59bbb15ca183ce1abd, /waku/2/default-waku/proto) already exists.\n
+```
+
+The `db-postgres-hammer` is aimed to stress the database from the `select` point of view. It performs `N` concurrent `select` queries with a certain rate.
+
+#### Results
+
+The following results were obtained by using the sandbox machine (metal-01.he-eu-hel1.misc.wakudev) and running nim-waku nodes from https://github.com/waku-org/nwaku/tree/b452ed865466a33b7f5b87fa937a8471b28e466e and using the `test-waku-query` project from https://github.com/waku-org/test-waku-query/tree/fef29cea182cc744c7940abc6c96d38a68739356
+
+The following shows the results
+
+1. Two `nwaku-postgres-additional` inserting messages plus 50 `db-postgres-hammer` making 10 `selects` per second.
+
+
+
+
+
+2. Five `nwaku-postgres-additional` inserting messages plus 50 `db-postgres-hammer` making 10 `selects` per second.
+
+
+
+In this case, the insert time gets more spread because the insert operations are shared amongst five more nodes. The _Store_ query time remains the same on average.
+
+3. Five `nwaku-postgres-additional` inserting messages plus 100 `db-postgres-hammer` making 10 `selects` per second.
+This case is similar to 2. but stressing more the database.
+
+
diff --git a/third-party/nwaku/docs/benchmarks/test-results-summary.md b/third-party/nwaku/docs/benchmarks/test-results-summary.md
new file mode 100644
index 0000000..b5786bf
--- /dev/null
+++ b/third-party/nwaku/docs/benchmarks/test-results-summary.md
@@ -0,0 +1,90 @@
+---
+title: Performance Benchmarks and Test Reports
+---
+
+
+## Introduction
+This page summarises key performance metrics for nwaku and provides links to detailed test reports.
+
+> ## TL;DR
+>
+> - Average Waku bandwidth usage: ~**10 KB/s** (minus discv5 Discovery) for 1KB message size and message injection rate of 1msg/s.
+Confirmed for topologies of up to 2000 Relay nodes.
+> - Average time for a message to propagate to 100% of nodes: **0.4s** for topologies of up to 2000 Relay nodes.
+> - Average per-node bandwidth usage of the discv5 protocol: **8 KB/s** for incoming traffic and **7.4 KB/s** for outgoing traffic,
+ in a network with 100 continuously online nodes.
+> - Future improvements: A messaging API is currently in development to streamline interactions with the Waku protocol suite.
+Once completed, it will enable benchmarking at the messaging API level, allowing applications to more easily compare their
+own performance results.
+
+
+## Insights
+
+### Relay Bandwidth Usage: nwaku v0.34.0
+The average per-node `libp2p` bandwidth usage in a 1000-node Relay network with 1KB messages at varying injection rates.
+
+
+| Message Injection Rate | Average libp2p incoming bandwidth (KB/s) | Average libp2p outgoing bandwidth (KB/s) |
+|------------------------|------------------------------------------|------------------------------------------|
+| 1 msg/s | ~10.1 | ~10.3 |
+| 1 msg/10s | ~1.8 | ~1.9 |
+
+### Message Propagation Latency: nwaku v0.34.0-rc1
+The message propagation latency is measured as the total time for a message to reach all nodes.
+We compare the latency in different network configurations for the following simulation parameters:
+- Total messages published: 600
+- Message size: 1KB
+- Message injection rate: 1msg/s
+
+The different network configurations tested are:
+- Relay Config: 1000 nodes with relay enabled
+- Mixed Config: 210 nodes, consisting of bootstrap nodes, filter clients and servers, lightpush clients and servers, store nodes
+- Non-persistent Relay Config: 500 persistent relay nodes, 10 store nodes and 100 non-persistent relay nodes
+
+Click on a specific config to see the detailed test report.
+
+| Config | Average Message Propagation Latency (s) | Max Message Propagation Latency (s)|
+|------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------|------------------------------------|
+| [Relay](https://www.notion.so/Waku-regression-testing-v0-34-1618f96fb65c803bb7bad6ecd6bafff9) (1000 nodes) | 0.05 | 1.6 |
+| [Mixed](https://www.notion.so/Mixed-environment-analysis-1688f96fb65c809eb235c59b97d6e15b) (210 nodes) | 0.0125 | 0.007 |
+| [Non-persistent Relay](https://www.notion.so/High-Churn-Relay-Store-Reliability-16c8f96fb65c8008bacaf5e86881160c) (510 nodes)| 0.0125 | 0.25 |
+
+### Discv5 Bandwidth Usage: nwaku v0.34.0
+The average bandwidth usage of discv5 for a network of 100 nodes and message injection rate of 0 or 1msg/s.
+The measurements are based on a stable network where all nodes have already connected to peers to form a healthy mesh.
+
+|Message size |Average discv5 incoming bandwidth (KB/s)|Average discv5 outgoing bandwidth (KB/s)|
+|-------------------- |----------------------------------------|----------------------------------------|
+| no message injection| 7.88 | 6.70 |
+| 1KB | 8.04 | 7.40 |
+| 10KB | 8.03 | 7.45 |
+
+## Testing
+### DST
+The VAC DST team performs regression testing on all new **nwaku** releases, comparing performance with previous versions.
+They simulate large Waku networks with a variety of network and protocol configurations that are representative of real-world usage.
+
+**Test Reports**: [DST Reports](https://www.notion.so/DST-Reports-1228f96fb65c80729cd1d98a7496fe6f)
+
+
+### QA
+The VAC QA team performs interoperability tests for **nwaku** and **go-waku** using the latest main branch builds.
+These tests run daily and verify protocol functionality by targeting specific features of each protocol.
+
+**Test Reports**: [QA Reports](https://discord.com/channels/1110799176264056863/1196933819614363678)
+
+### nwaku
+The **nwaku** team follows a structured release procedure for all release candidates.
+This involves deploying RCs to `status.staging` fleet for validation and performing sanity checks.
+
+**Release Process**: [nwaku Release Procedure](https://github.com/waku-org/nwaku/blob/master/.github/ISSUE_TEMPLATE/prepare_release.md)
+
+
+### Research
+The Waku Research team conducts a variety of benchmarking, performance testing, proof-of-concept validations and debugging efforts.
+They also maintain a Waku simulator designed for small-scale, single-purpose, on-demand testing.
+
+
+**Test Reports**: [Waku Research Reports](https://www.notion.so/Miscellaneous-2c02516248db4a28ba8cb2797a40d1bb)
+
+**Waku Simulator**: [Waku Simulator Book](https://waku-org.github.io/waku-simulator/)
diff --git a/third-party/nwaku/docs/contributors/README.md b/third-party/nwaku/docs/contributors/README.md
new file mode 100644
index 0000000..9f76cd7
--- /dev/null
+++ b/third-party/nwaku/docs/contributors/README.md
@@ -0,0 +1,11 @@
+# Contributors
+
+This folder contains documentation that is primarily useful for contributors. Some links and
+resources here might require privileged access.
+
+Example resources:
+
+- How to do releases
+- Viewing and modifying metrics dashboard
+- Continuous integration process
+- How to view Status cluster logs
diff --git a/third-party/nwaku/docs/contributors/cluster-logs.md b/third-party/nwaku/docs/contributors/cluster-logs.md
new file mode 100644
index 0000000..3e21c83
--- /dev/null
+++ b/third-party/nwaku/docs/contributors/cluster-logs.md
@@ -0,0 +1,11 @@
+# Cluster node logs
+
+These can be found in [Kibana](https://kibana.infra.status.im/goto/a3793b50-489d-11ed-a791-f14ad382fa11).
+
+Login with Github. For access issues, contact devops.
+
+Modify search field and time window as appropriate.
+
+Notice that there are two clusters, test and production. There is also a Waku v1 cluster.
+
+
diff --git a/third-party/nwaku/docs/contributors/continuous-integration.md b/third-party/nwaku/docs/contributors/continuous-integration.md
new file mode 100644
index 0000000..1c5fa56
--- /dev/null
+++ b/third-party/nwaku/docs/contributors/continuous-integration.md
@@ -0,0 +1,32 @@
+# Description
+
+This document describes the continuous integration setup for `nim-waku`.
+
+# Details
+
+The CI setup exists on the Status.im Jenkins instance:
+
+https://ci.infra.status.im/job/nim-waku/
+
+It currently consists of four jobs:
+
+* [manual](https://ci.infra.status.im/job/nim-waku/job/manual/) - For manually executing builds using parameters.
+* [deploy-waku-test](https://ci.infra.status.im/job/nim-waku/job/deploy-waku-test/) - Builds every new commit in `master` and deploys to `waku.test` fleet.
+* [deploy-waku-sandbox](https://ci.infra.status.im/job/nim-waku/job/deploy-waku-sandbox/) - Currently has no automatic trigger, and deploys to `waku.sandbox` fleet.
+
+# Configuration
+
+The main configuration file is [`Jenkinsfile.release`](../../ci/Jenkinsfile.release) in the `ci` folder.
+
+Key part is the definition of five `parameters`:
+
+* `MAKE_TARGET` - Which `Makefile` target is built.
+* `IMAGE_TAG` - Tag of the Docker image to push.
+* `IMAGE_NAME` - Name of the Docker image to push.
+* `NIMFLAGS` - Nim compilation parameters.
+* `GIT_REF` - Git reference to build from (branch, tag, commit...)
+
+The use of `?:` [Elvis operator](http://groovy-lang.org/operators.html#_elvis_operator) plays a key role in allowing parameters to be changed for each defined job in Jenkins without it being overridden by the `Jenkinsfile` defaults after every job run.
+```groovy
+defaultValue: params.IMAGE_TAG ?: 'deploy-waku-test',
+```
diff --git a/third-party/nwaku/docs/contributors/git-submodules.md b/third-party/nwaku/docs/contributors/git-submodules.md
new file mode 100644
index 0000000..52336e2
--- /dev/null
+++ b/third-party/nwaku/docs/contributors/git-submodules.md
@@ -0,0 +1,10 @@
+# Submodules
+
+We use Git submodules in the `vendor` directory to track internal Nim
+dependencies. We want to update submodules all at once to avoid issues.
+
+```
+git submodule foreach --recursive git submodule update --init
+git submodule update --remote
+```
+
diff --git a/third-party/nwaku/docs/contributors/nph.md b/third-party/nwaku/docs/contributors/nph.md
new file mode 100644
index 0000000..91f4149
--- /dev/null
+++ b/third-party/nwaku/docs/contributors/nph.md
@@ -0,0 +1,34 @@
+
+## nph - An opinionated Nim formatter
+This prettifier tool is used to format the nwaku code base.
+
+### VSCode Extension
+https://marketplace.visualstudio.com/items?itemName=arnetheduck.vscode-nph
+
+### GitHub
+https://github.com/arnetheduck/nph
+
+Make sure you use a binary from the following release:
+https://github.com/arnetheduck/nph/releases/tag/v0.5.1
+
+```bash
+$ nph --version
+v0.5.1-0-gde5cd48
+```
+
+### Installation and configuration
+1. Ask the [nwaku team](https://discord.com/channels/1110799176264056863/1111541184490393691) about the required `nph` version.
+2. Download the desired release from _GitHub_ and place the binary in the PATH env var.
+3. Add the following content into `~/.config/Code/User/settings.json`:
+
+```
+{
+ "[nim]": {
+ "editor.formatOnSave": true,
+ "editor.defaultFormatter": "arnetheduck.vscode-nph"
+ },
+}
+```
+
+With that, every time a Nim file is saved, it will be formatted automatically.
+
diff --git a/third-party/nwaku/docs/contributors/release-process.md b/third-party/nwaku/docs/contributors/release-process.md
new file mode 100644
index 0000000..c0fb12d
--- /dev/null
+++ b/third-party/nwaku/docs/contributors/release-process.md
@@ -0,0 +1,119 @@
+# Release Process
+
+How to do releases.
+
+For more context, see https://trunkbaseddevelopment.com/branch-for-release/
+
+## How to do releases
+
+### Before 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
+
+1. Checkout a release branch from master
+
+ ```
+ git checkout -b release/v0.1.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.
+
+ ```
+ 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
+
+ ```
+ git tag -as v0.1.0-rc.0 -m "Initial release."
+ git push origin v0.1.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
+
+1. 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
+
+ Make sure the new tag is associated
+ with CHANGELOG update.
+
+ ```
+ # 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
+ ```
+
+1. Validate the release. For the release validation process, please refer to the following [guide](https://www.notion.so/Release-Process-61234f335b904cd0943a5033ed8f42b4#47af557e7f9744c68fdbe5240bf93ca9)
+
+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.
+
+ ```
+ git checkout release/v0.1.0
+ git tag -as v0.1.0 -m "Initial release."
+ git push origin v0.1.0
+ git switch master
+ git pull
+ git merge release/v0.1.0
+ ```
+
+1. 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.
+
+### After the release
+
+1. Announce the release on Twitter, Discord and other channels.
+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_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.
+
+### Performing a patch release
+
+1. Cherry-pick the relevant commits from master to the release branch
+
+ ```
+ git cherry-pick
+ ```
+
+2. Create a release-candidate tag with the same name as release and `-rc.N` suffix
+
+3. Update `CHANGELOG.md`. From the release branch, use the helper Make target after having cherry-picked the commits.
+
+ ```
+ make release-notes
+ ```
+ Create a new branch and raise a PR with the changelog updates to master.
+
+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.
diff --git a/third-party/nwaku/docs/contributors/waku-fleets.md b/third-party/nwaku/docs/contributors/waku-fleets.md
new file mode 100644
index 0000000..659d855
--- /dev/null
+++ b/third-party/nwaku/docs/contributors/waku-fleets.md
@@ -0,0 +1,107 @@
+# Waku fleet: management & monitoring
+
+## Background
+
+Status currently maintains two fleets for `nwaku` nodes,
+the `waku.test` fleet and the `waku.sandbox` (sandbox) fleet.
+They'll be referred to as `test` and `sandbox` in this document.
+Status fleet nodes and addresses can be viewed [here](https://fleets.status.im/).
+
+### Fleet overview
+
+At the time of writing this, each fleet consists of three waku nodes,
+with a [websockify](https://github.com/novnc/websockify) WebSocket-to-TCP bridge for each node.
+Waku peers can choose to connect either directly to a node's TCP endpoint
+or the bridged WebSocket depending on their own supported transports.
+The `sandbox` fleet also has a deployed [`chat2bridge`](https://github.com/waku-org/nwaku/blob/master/docs/tutorial/chat2.md#bridge-messages-between-chat2-and-matterbridge),
+which serves as a bridge between the [Waku toy-chat](https://rfc.vac.dev/spec/22/) and Matterbridge.
+The `chat2bridge` is currently deployed to the `node-01.do-ams3` datacentre
+and configured to bridge toy-chat messages to the `#waku channel` on the Vac Discord Server.
+
+### Fleet deployment rationale
+
+The `test` fleet is automatically updated after every commit to the `nwaku` repository `master` branch and is therefore the most up to date representation of Waku development.
+It is suitable for testing new features before they're rolled out to the (more) stable `sandbox` fleet.
+
+In general only the latest release of `nwaku` is deployed to the `sandbox` fleet.
+It requires manual updating and should therefore be more stable than `test`.
+See the [section on Jenkins](#jenkins-for-deployment) below for more on the deployment process.
+
+### Related repos
+
+The [`infra-docs` repo](https://github.com/status-im/infra-docs) contains the most comprehensive overview of Status infrastructure.
+This is a private repository.
+Feel free to contact someone in the team to request access.
+
+The [`infra-nim-waku` repo](https://github.com/status-im/infra-nim-waku) contains the infrastructure definitions for Waku nodes implemented in Nim.
+
+## Monitoring and management
+
+The rest of this document highlights some infra services of specific interest to Waku fleet monitoring and management:
+
+1. [Consul](https://consul.infra.status.im/ui/do-ams3/services?filter=nim-waku) to view the health status of Waku nodes.
+2. [Kibana](https://kibana.infra.status.im/app/discover#/) to view and filter logs.
+3. [Grafana](https://grafana.infra.status.im/d/qrp_ZCTGz/nim-waku-v2) to view and filter metrics.
+4. [Jenkins](https://ci.infra.status.im/job/nim-waku/) to configure and deploy new builds to the fleets.
+
+### 1. [Consul](https://consul.infra.status.im/ui/do-ams3/services?filter=nim-waku) for health checks
+
+Consul provides a useful high-level view of the health of the `nwaku` fleets.
+It aggregates the result of various monitoring checks
+and shows the health status for the node itself, the RPC API, exposed WebSocket and metrics.
+The datacentre can be changed in the upper left-hand corner.
+
+### 2. [Kibana](https://kibana.infra.status.im/app/discover#/) for logs
+
+Kibana is a powerful visualisation tool for Elasticsearch data.
+For Waku fleets it can be used to retrieve, filter and view the logs for all deployed services.
+For example, to view the latest logs for `sandbox`,
+Kibana can be opened in "Discover" mode with an [active filter for `fleet: waku.sandbox`](https://kibana.infra.status.im/goto/c0434f60-ca82-11ee-aaa4-85391103106b).
+
+### 3. [Grafana](https://grafana.infra.status.im/d/qrp_ZCTGz/nim-waku-v2?orgId=1&refresh=5m) for metrics
+
+The `Nim-Waku` Grafana dashboard displays live and historical metrics for Waku nodes.
+The default view includes metrics from both fleets,
+though it's possible to filter by `Hostname`, `Fleet name` or `Data Center`.
+The time range can also be configured -
+by default the latest metrics will be shown.
+
+The dashboard itself includes an _"At a glance"_ summary
+with an overview of the latest connected peers, total messages, CPU usage, reported errors, etc.
+The _"General"_ collection contains a more in-depth look at node, libp2p and performance-related metrics.
+This is followed by separate panel collections showing _per-protocol_ metrics.
+
+A copy of the `Nim-Waku` fleets dashboard is maintained in the [`nwaku` repo](https://github.com/waku-org/nwaku/blob/master/metrics/waku-fleet-dashboard.json).
+From time to time certain Prometheus queries may fail,
+often when the underlying metrics are renamed.
+Please report any broken panels via our Discord channels or by [creating an issue in `nwaku`](https://github.com/waku-org/nwaku/issues/new).
+
+### 4. [Jenkins](https://ci.status.im/job/nim-waku/) for deployment
+
+The [`nim-waku` jobs](https://ci.infra.status.im/job/nim-waku/) on Jenkins are configured to deploy `nwaku` builds to the fleets.
+1. [`deploy-waku-test`](https://ci.infra.status.im/job/nim-waku/job/deploy-waku-test/) is triggered automatically after every commit to the `nwaku` `master` branch.
+2. [`deploy-waku-sandbox`](https://ci.infra.status.im/job/nim-waku/job/deploy-waku-sandbox/) must be triggered manually. Usually this job is only built after a tagged release in `nwaku`.
+
+Each job can be manually triggered using the _"Build with Parameters"_ option.
+Options under _"Configure"_ include the build triggers, build target and branches to build.
+These should only be changed with care.
+
+See [Continuous Integration docs](https://github.com/waku-org/nwaku/blob/master/docs/contributors/continuous-integration.md) for more.
+
+## Quick links
+
+ 1. [`chat2bridge`](https://github.com/waku-org/nwaku/blob/master/docs/tutorial/chat2.md#bridge-messages-between-chat2-and-matterbridge)
+ 2. [Consul for do-ams3](https://consul.infra.status.im/ui/do-ams3/services?filter=nim-waku)
+ 3. [Consul for ac-cn-hongkong-c](https://consul.infra.status.im/ui/ac-cn-hongkong-c/services?filter=nim-waku)
+ 4. [Consul for gc-us-central1-a](https://consul.infra.status.im/ui/gc-us-central1-a/services?filter=nim-waku)
+ 5. [Grafana Nim-Waku dashboard](https://grafana.infra.status.im/d/qrp_ZCTGz/nim-waku-v2?orgId=1&refresh=5m)
+ 6. [`infra-docs` repo](https://github.com/status-im/infra-docs)
+ 7. [`infra-waku` repo](https://github.com/status-im/infra-waku)
+ 8. [Jenkins jobs for `nim-waku`](https://ci.infra.status.im/job/nim-waku/)
+ 9. [Jenkins deploy-waku-sandbox manual trigger](https://ci.infra.status.im/job/nim-waku/job/deploy-waku-sandbox/build)
+ 10. [Jenkins deploy-waku-test manual trigger](https://ci.infra.status.im/job/nim-waku/job/deploy-waku-test/build)
+ 11. [Kibana logs for `sandbox`](https://kibana.infra.status.im/goto/c0434f60-ca82-11ee-aaa4-85391103106b)
+ 12. [Kibana logs for `test`](https://kibana.infra.status.im/goto/7cd22f20-ca83-11ee-aaa4-85391103106b)
+ 13. [Status fleets](https://fleets.status.im/)
+ 14. [Status fleets - Table](https://fleets.waku.org)
+ 15. [Websockify](https://github.com/novnc/websockify)
diff --git a/third-party/nwaku/docs/faq.md b/third-party/nwaku/docs/faq.md
new file mode 100644
index 0000000..40a189c
--- /dev/null
+++ b/third-party/nwaku/docs/faq.md
@@ -0,0 +1,34 @@
+# FAQ
+
+## How do I see what address a node is listening for?
+
+Grep for "Listening on". It should be printed at INFO level at the beginning. E.g. from Kibana:
+
+`Oct 7, 2020 @ 23:17:00.383INF 2020-10-07 23:17:00.375+00:00 Listening on topics="wakunode" tid=1 file=wakunode2.nim:140 full=/ip4/0.0.0.0/tcp/60000/p2p/16Uiu2HAkzHaTP5JsUwfR9NR8Rj9HC24puS6ocaU8wze4QrXr9iXp`
+
+## How do I find out node addresses at the test cluster?
+
+The easiest way is to use `jq` and query the fleets registry that Status operates:
+
+```
+curl -s https://fleets.status.im | jq '.fleets["waku.test"]'
+
+# Output
+{
+ "tcp/p2p/waku": {
+ "node-01.do-ams3.waku.test": "/dns4/node-01.do-ams3.waku.test.status.im/tcp/30303/p2p/16Uiu2HAkykgaECHswi3YKJ5dMLbq2kPVCo89fcyTd38UcQD6ej5W",
+ "node-01.gc-us-central1-a.waku.test": "/dns4/node-01.gc-us-central1-a.waku.test.status.im/tcp/30303/p2p/16Uiu2HAmDCp8XJ9z1ev18zuv8NHekAsjNyezAvmMfFEJkiharitG",
+ "node-01.ac-cn-hongkong-c.waku.test": "/dns4/node-01.ac-cn-hongkong-c.waku.test.status.im/tcp/30303/p2p/16Uiu2HAkzHaTP5JsUwfR9NR8Rj9HC24puS6ocaU8wze4QrXr9iXp"
+ },
+ "enr/p2p/waku": {
+ "node-01.do-ams3.waku.test": "enr:-QESuEC1p_s3xJzAC_XlOuuNrhVUETmfhbm1wxRGis0f7DlqGSw2FM-p2Ugl_r25UHQJ3f1rIRrpzxJXSMaJe4yk1XFSAYJpZIJ2NIJpcISygI2rim11bHRpYWRkcnO4XAArNiZub2RlLTAxLmRvLWFtczMud2FrdS50ZXN0LnN0YXR1c2ltLm5ldAZ2XwAtNiZub2RlLTAxLmRvLWFtczMud2FrdS50ZXN0LnN0YXR1c2ltLm5ldAYfQN4DgnJzkwABCAAAAAEAAgADAAQABQAGAAeJc2VjcDI1NmsxoQJATXRSRSUyTw_QLB6H_U3oziVQgNRgrXpK7wp2AMyNxYN0Y3CCdl-DdWRwgiMohXdha3UyDw",
+ "node-01.gc-us-central1-a.waku.test": "enr:-QEkuECnZ3IbVAgkOzv-QLnKC4dRKAPRY80m1-R7G8jZ7yfT3ipEfBrhKN7ARcQgQ-vg-h40AQzyvAkPYlHPaFKk6u9uAYJpZIJ2NIJpcIQiEAFDim11bHRpYWRkcnO4bgA0Ni9ub2RlLTAxLmdjLXVzLWNlbnRyYWwxLWEud2FrdS50ZXN0LnN0YXR1c2ltLm5ldAZ2XwA2Ni9ub2RlLTAxLmdjLXVzLWNlbnRyYWwxLWEud2FrdS50ZXN0LnN0YXR1c2ltLm5ldAYfQN4DgnJzkwABCAAAAAEAAgADAAQABQAGAAeJc2VjcDI1NmsxoQMIJwesBVgUiBCi8yiXGx7RWylBQkYm1U9dvEy-neLG2YN0Y3CCdl-DdWRwgiMohXdha3UyDw",
+ "node-01.ac-cn-hongkong-c.waku.test": "enr:-QEkuEDzQyIAhs-CgBHIrJqtBv3EY1uP1Psrc-y8yJKsmxW7dh3DNcq2ergMUWSFVcJNlfcgBeVsFPkgd_QopRIiCV2pAYJpZIJ2NIJpcIQI2ttrim11bHRpYWRkcnO4bgA0Ni9ub2RlLTAxLmFjLWNuLWhvbmdrb25nLWMud2FrdS50ZXN0LnN0YXR1c2ltLm5ldAZ2XwA2Ni9ub2RlLTAxLmFjLWNuLWhvbmdrb25nLWMud2FrdS50ZXN0LnN0YXR1c2ltLm5ldAYfQN4DgnJzkwABCAAAAAEAAgADAAQABQAGAAeJc2VjcDI1NmsxoQJIN4qwz3v4r2Q8Bv8zZD0eqBcKw6bdLvdkV7-JLjqIj4N0Y3CCdl-DdWRwgiMohXdha3UyDw"
+ },
+ "wss/p2p/waku": {
+ "node-01.do-ams3.waku.test": "/dns4/node-01.do-ams3.waku.test.status.im/tcp/8000/wss/p2p/16Uiu2HAkykgaECHswi3YKJ5dMLbq2kPVCo89fcyTd38UcQD6ej5W",
+ "node-01.gc-us-central1-a.waku.test": "/dns4/node-01.gc-us-central1-a.waku.test.status.im/tcp/8000/wss/p2p/16Uiu2HAmDCp8XJ9z1ev18zuv8NHekAsjNyezAvmMfFEJkiharitG",
+ "node-01.ac-cn-hongkong-c.waku.test": "/dns4/node-01.ac-cn-hongkong-c.waku.test.status.im/tcp/8000/wss/p2p/16Uiu2HAkzHaTP5JsUwfR9NR8Rj9HC24puS6ocaU8wze4QrXr9iXp"
+ }
+}
+```
diff --git a/third-party/nwaku/docs/operators/README.md b/third-party/nwaku/docs/operators/README.md
new file mode 100644
index 0000000..5850977
--- /dev/null
+++ b/third-party/nwaku/docs/operators/README.md
@@ -0,0 +1,35 @@
+# The nwaku guide for operators
+
+*If you're eager to get started, check out our [quickstart guide](./quickstart.md) for typical configurations or [step-by-step overview](./overview.md) for newcomers.*
+
+Nwaku is a client implementation in Nim of the [Waku v2 family of protocols](https://rfc.vac.dev/spec/10/) for peer-to-peer communication.
+The protocols are designed to be secure, privacy-preserving, censorship-resistant and able to run in resource restricted environments.
+Moreover, we've taken a modular approach so that node operators can choose which protocols they want to support
+based on their own motivations and availability of resources.
+We call this concept ["adaptive nodes"](https://rfc.vac.dev/spec/30/),
+implying that a Waku v2 network can consist of heterogeneous nodes contributing at different levels to the network.
+
+Nwaku (formerly `nim-waku`) aims to be a lightweight and robust Waku v2 client.
+It serves as the reference implementation for researchers,
+who extend the client in parallel to spec development.
+As such, it is first in line to support innovative and new Waku v2 protocols,
+but configurable enough to serve the adaptive needs of various operators.
+We are also developing a set of operator-focused tools to monitor and maintain a running nwaku node.
+
+This guide provides step-by-step tutorials covering how to build and configure your own nwaku node,
+connect to an existing Waku v2 network
+and use existing tools for monitoring and maintaining a running node.
+
+## Helpful resources
+
+
+
+## Getting in touch or reporting an issue
+
+For an inquiry, or if you would like to propose new features, feel free to [open a general issue](https://github.com/waku-org/nwaku/issues/new/).
+
+For bug reports, please [tag your issue with the `bug` label](https://github.com/waku-org/nwaku/issues/new/).
+
+If you believe the reported issue requires critical attention, please [use the `critical` label](https://github.com/waku-org/nwaku/issues/new?labels=critical,bug) to assist with triaging.
+
+To get help, or participate in the conversation, join the [Vac Discord](https://discord.gg/KNj3ctuZvZ) server.
diff --git a/third-party/nwaku/docs/operators/docker-quickstart.md b/third-party/nwaku/docs/operators/docker-quickstart.md
new file mode 100644
index 0000000..0907772
--- /dev/null
+++ b/third-party/nwaku/docs/operators/docker-quickstart.md
@@ -0,0 +1,79 @@
+# Quickstart: running nwaku in a Docker container
+
+This guide explains how to run a nwaku node in a Docker container.
+
+## Prerequisites
+
+Make sure you have Docker installed.
+Installation instructions for different platforms can be found in the [Docker docs](https://docs.docker.com/engine/install/).
+
+For example, to use Docker's convenience script for installation:
+
+```bash
+curl -fsSL https://get.docker.com -o get-docker.sh
+sudo sh get-docker.sh
+```
+
+## Step 1: Get Docker image
+
+Nwaku Docker images are published to the Docker Hub public registry under [`wakuorg/nwaku`](https://hub.docker.com/r/wakuorg/nwaku).
+For specific releases the published images are tagged with the release version, e.g. [`wakuorg/nwaku:v0.20.0`](https://hub.docker.com/layers/wakuorg/nwaku/v0.20.0/images/sha256-9976ac2dc536fae49b21f7b77618aa6f0efb59c694e7b3181e54c08be0c4f089?context=explore).
+Images are also published for each commit to the `master` branch in the [nwaku repo](https://github.com/status-im/nwaku/commits/master)
+and tagged with the corresponding commit hash.
+See [`wakuorg/nwaku`](https://hub.docker.com/r/wakuorg/nwaku/tags) on Docker Hub for a full list of available tags.
+
+To pull the image of your choice, use
+
+```bash
+docker pull wakuorg/nwaku:v0.20.0 # or, whichever tag you prefer in the format wakuorg/nwaku:[tag]
+```
+
+You can also build the Docker image locally using
+
+```bash
+git clone --recurse-submodules https://github.com/waku-org/nwaku
+cd nwaku
+docker build -t wakuorg/nwaku:latest .
+```
+
+## Step 2: Run
+
+To run nwaku in a new Docker container,
+use the following command:
+
+```bash
+docker run [OPTIONS] IMAGE [ARG...]
+```
+
+where `OPTIONS` are your selected Docker options,
+`IMAGE` the image and tag you pulled from the registry or built in Step 1
+and `ARG...` the list of nwaku arguments for your [chosen nwaku configuration](./how-to/configure.md).
+
+For Docker options we recommend explicit port mappings (`-p`) at least
+for your exposed libp2p listening ports
+and any discovery ports (e.g. the Waku discv5 port) that must be reachable from outside the host.
+
+As an example, consider the following command to run nwaku in a Docker container with the most typical configuration:
+
+```bash
+docker run -i -t -p 60000:60000 -p 9000:9000/udp wakuorg/nwaku:v0.20.0 \
+ --dns-discovery:true \
+ --dns-discovery-url:enrtree://AIRVQ5DDA4FFWLRBCHJWUWOO6X6S4ZTZ5B667LQ6AJU6PEYDLRD5O@sandbox.waku.nodes.status.im \
+ --discv5-discovery \
+ --nat:extip:[yourpublicip] # or, if you are behind a nat: --nat=any
+```
+
+This runs nwaku in a new container from the `wakuorg/nwaku:v0.20.0` image,
+connects to `wakuv.sandbox` as bootstrap fleet and
+enables [Waku Discovery v5](https://rfc.vac.dev/spec/33/) for ambient peer discovery,
+while mapping the default libp2p listening port (`60000`)
+and default discv5 UDP port (`9000`) to the host.
+
+> **Tip:** The `docker run` command will pull the specified image from Docker Hub if it's not yet available locally,
+so it's possible to skip Step 1 and pull the image from your configured registry automatically when running.
+
+If you've used the `-i` and `-t` Docker options when running the new container,
+the `run` command would have allocated an interactive terminal
+where you'll see the `stdout` logs from the running nwaku process.
+To detach gracefully from the running container,
+use `Ctrl-P` followed by `Ctrl-Q`.
diff --git a/third-party/nwaku/docs/operators/droplet-quickstart.md b/third-party/nwaku/docs/operators/droplet-quickstart.md
new file mode 100644
index 0000000..070cf6d
--- /dev/null
+++ b/third-party/nwaku/docs/operators/droplet-quickstart.md
@@ -0,0 +1,305 @@
+# Quickstart for running nwaku on a DigitalOcean Droplet
+
+This guide explains how to run a nwaku node on a
+DigitalOcean Droplet. We enable the following protocols -
+
+1. Relay
+2. Store
+3. DNS Discovery
+4. Discv5
+
+A Droplet is a simple virtual machine that runs in DigitalOcean's datacenters.
+
+Note that Droplets do cost money, the size described in the guide costs approximately $12 a month.
+
+The guide makes heavy use of the `doctl` cli to make it as UI agnostic as possible.
+There are similar steps to accomplish the same through DigitalOcean's cloud console, accessible [here](https://cloud.digitalocean.com/)
+
+## Prerequisites
+
+1. A DigitalOcean account. Upon signing up, you have $100 worth of credits to use.
+
+
+
+## 1. Get the `doctl` binary
+
+Follow this [guide](https://docs.digitalocean.com/reference/doctl/how-to/install/) to install,
+and configure the `doctl` cli, which will help with setting up the Droplet.
+
+> Note: It is not required to set up the droplet that is mentioned in the `doctl` cli guide
+
+## 2. Set up SSH credentials
+
+Run the following command -
+```bash
+export DROPLET_SSH_KEY_PATH=~/.ssh/id_nwaku_droplet
+ssh-keygen -f $DROPLET_SSH_KEY_PATH
+```
+
+Press `enter` twice, i.e do NOT set a passphrase.
+
+Run the following command -
+```bash
+export DROPLET_SSH_PUBLIC_KEY=$(cat "$DROPLET_SSH_KEY_PATH".pub)
+```
+
+*Alternatively*, if you would like to supply your own credentials, make sure that the public key is in the `DROPLET_SSH_PUBLIC_KEY` env variable.
+
+
+Lastly, add the ssh key to your DigitalOcean account -
+```bash
+doctl compute ssh-key create nwaku-key --public-key="$DROPLET_SSH_PUBLIC_KEY"
+```
+
+## 3. Select the region closest to you
+
+Run the following command to get the list of available
+regions -
+
+```bash
+doctl compute region list | grep true
+```
+
+You should get an output similar to this -
+
+```bash
+nyc1 New York 1 true
+sgp1 Singapore 1 true
+lon1 London 1 true
+nyc3 New York 3 true
+ams3 Amsterdam 3 true
+fra1 Frankfurt 1 true
+tor1 Toronto 1 true
+blr1 Bangalore 1 true
+sfo3 San Francisco 3 true
+```
+Choose the region closest to you, and run the following command -
+
+```bash
+export DROPLET_REGION=
+```
+
+For example, if you live in NYC -
+```bash
+export DROPLET_REGION=nyc1
+```
+
+Note that it is *optional* to choose the datacenter closest to you. This is merely done for operational efficiency.
+
+## 4. Select the OS distribution
+
+Run the following command to get the list of distributions -
+
+```bash
+doctl compute image list-distribution
+```
+
+You should get an output similar to this -
+
+```bash
+ID Name Type Distribution Slug Public Min Disk
+78547182 1.5.8 x64 snapshot RancherOS rancheros true 15
+106433672 7 x64 snapshot CentOS centos-7-x64 true 9
+106434098 9 Stream x64 snapshot CentOS centos-stream-9-x64 true 10
+106434191 8 Stream x64 snapshot CentOS centos-stream-8-x64 true 10
+...
+```
+
+Choose the distribution you are most comfortable with, and then run the following command
+
+```bash
+export DROPLET_IMAGE=
+```
+
+For example, if you chose Debian 11 x64 -
+
+```bash
+export DROPLET_IMAGE=debian-11-x64
+```
+
+## 5. Select the size of the Droplet
+
+Run the following command to get the list of Droplet sizes for the previously selected region -
+
+```bash
+doctl compute size list
+```
+
+You should get an output similar to this -
+```bash
+Slug Description Memory VCPUs Disk Price Monthly Price Hourly
+s-1vcpu-512mb-10gb Basic 512 1 10 4.00 0.005950
+s-1vcpu-1gb Basic 1024 1 25 6.00 0.008930
+s-1vcpu-1gb-amd Basic AMD 1024 1 25 7.00 0.010420
+s-1vcpu-1gb-intel Basic Intel 1024 1 25 7.00 0.010420
+s-1vcpu-2gb Basic 2048 1 50 12.00 0.017860
+s-1vcpu-2gb-amd Basic AMD 2048 1 50 14.00 0.020830
+s-1vcpu-2gb-intel Basic Intel 2048 1 50 14.00 0.020830
+s-2vcpu-2gb Legacy Basic 2048 2 60 18.00 0.026790
+...
+```
+
+> Note: To compile the nwaku binary, a minimum of 2GB of RAM is required. You may choose a smaller Droplet, however, you would have to supply the binary in an alternate manner, i.e via the official release on Github, or compiling it on another machine and copying it over. Currently, we only supply binaries for macOS and Ubuntu.
+
+Choose the Droplet size that you are most comfortable with, and then run the following command -
+
+```bash
+export DROPLET_SIZE=
+```
+
+For example, `s-1vcpu-2gb` is more than capable to handle the protocols we mentioned above -
+
+```bash
+export DROPLET_SIZE=s-1vcpu-2gb
+```
+
+## 6. Create the Droplet
+
+Run the following command to create the droplet -
+
+> Note: Droplet names must be valid hostnames, i.e they must only contain alphanumeric characters and hyphens (-)
+
+```bash
+export DROPLET_NAME=
+export DROPLET_ID=$(doctl compute droplet create --region=$DROPLET_REGION --image=$DROPLET_IMAGE --size=$DROPLET_SIZE --enable-monitoring --format=ID --wait $DROPLET_NAME | sed -n '2 p')
+```
+
+For example, to create a droplet named `nwaku` -
+
+```bash
+export DROPLET_NAME=nwaku
+export DROPLET_ID=$(doctl compute droplet create --region=$DROPLET_REGION --image=$DROPLET_IMAGE --size=$DROPLET_SIZE --enable-monitoring --format=ID --wait $DROPLET_NAME | sed -n '2 p')
+```
+
+## 7. Create a Domain and attach it to the droplet (OPTIONAL)
+
+Follow this [guide](https://docs.digitalocean.com/products/networking/dns/how-to/add-domains/) to create a domain, and add it to the droplet appropriately.
+
+## 8. SSH into the Droplet
+
+You can get the following details in the email that DigitalOcean sends upon successful creation of the Droplet -
+
+1. username
+2. password
+3. public ipv4 address
+
+Since the public key we previously generated was automatically added to the authorized_keys list, we can run the following command to ssh into the Droplet -
+
+```bash
+export DROPLET_USERNAME=
+export DROPLET_IP=
+ssh -i $DROPLET_SSH_KEY_PATH $DROPLET_USERNAME@$DROPLET_IP
+```
+
+For example, if the username was `root`, and the ipv4 address was `0.0.0.0`,
+
+```bash
+export USERNAME=root
+export IP=0.0.0.0
+ssh -i $DROPLET_SSH_KEY_PATH $DROPLET_USERNAME@$DROPLET_IP
+```
+
+Enter the password received in the email.
+
+## 9. Build nwaku
+
+To build `nwaku`, follow this [guide](./how-to/build.md)
+
+OR
+
+To fetch the latest release from Github, navigate to https://github.com/status-im/nwaku/releases and download the latest tarball for your distribution.
+
+This [guide](https://www.itprotoday.com/development-techniques-and-management/how-install-targz-file-ubuntu-linux) describes how to install a tarball for your distribution.
+
+OR
+
+Run the following script to copy over the wakunode2 binary (from the host machine) -
+
+```bash
+scp -i $DROPLET_SSH_KEY_PATH ./build/wakunode2 $DROPLET_USERNAME@$DROPLET_IP:~/wakunode2
+```
+
+## 10. Set up a terminal multiplexer of choice
+
+You may decide to use either `screen` or `tmux` to be able to reattach to the process
+after closing the ssh connection.
+
+Installation instructions for -
+1. [screen](https://linuxhint.com/screen-linux/)
+2. [tmux](https://linuxhint.com/install-tmux-ubuntu/)
+
+## 10. Run nwaku
+
+First, start the `screen` or `tmux` session by following the instructions of the terminal multiplexer chosen previously -
+1. [screen](https://linuxize.com/post/how-to-use-linux-screen/#starting-linux-screen)
+2. [tmux](https://linuxize.com/post/getting-started-with-tmux/#starting-your-first-tmux-session)
+
+Run the following command to run `nwaku` -
+
+*Note the path to the wakunode2 binary*
+
+a. Add the parent directory of the wakunode2 binary to your environment:
+
+ If you built it locally and copied it via scp -
+
+ ```bash
+ export WAKUNODE_DIR="$pwd"
+ ```
+
+ OR
+
+ If you compiled it on the Droplet -
+
+ ```bash
+ export WAKUNODE_DIR="$pwd"/build
+ ```
+
+b. Choose the fleet you wish to connect your node to:
+ - waku sandbox: enrtree://AIRVQ5DDA4FFWLRBCHJWUWOO6X6S4ZTZ5B667LQ6AJU6PEYDLRD5O@sandbox.waku.nodes.status.im
+ - waku test: enrtree://AOGYWMBYOUIMOENHXCHILPKY3ZRFEULMFI4DOM442QSZ73TT2A7VI@test.waku.nodes.status.im
+
+ ```bash
+ export WAKU_FLEET=
+ ```
+
+
+c. Run `nwaku`:
+
+ If you set up a domain previously -
+
+ ```bash
+ export DOMAIN_NAME=
+ $WAKUNODE_DIR/wakunode2 \
+ --store:true \
+ --persist-messages \
+ --dns-discovery \
+ --dns-discovery-url:"$WAKU_FLEET" \
+ --dns4-domain-name:"$DOMAIN_NAME" \
+ --discv5-discovery:true
+ ```
+
+ OR
+
+ If you did not set up a domain -
+
+ ```bash
+ $WAKUNODE_DIR/wakunode2 \
+ --store:true \
+ --persist-messages \
+ --dns-discovery \
+ --dns-discovery-url:"$WAKU_FLEET" \
+ --discv5-discovery:true
+ ```
+
+You now have nwaku running! You can verify this by observing the logs. The logs should show that the node completed 7 steps of setup, and is actively discovering other nodes.
+
+You may now detach from stdout, by following instructions according to the terminal multiplexer chosen previously -
+1. [screen](https://linuxize.com/post/how-to-use-linux-screen/#detach-from-linux-screen-session)
+2. [tmux](https://linuxize.com/post/getting-started-with-tmux/#starting-your-first-tmux-session)
+
+To re-attach and observe the logs at a later date, follow these instructions -
+1. [screen](https://linuxize.com/post/how-to-use-linux-screen/#reattach-to-a-linux-screen)
+2. [tmux](https://linuxize.com/post/getting-started-with-tmux/#re-attaching-to-tmux-session)
+
+For alternative configurations, refer to this [guide](./how-to/configure.md)
+
diff --git a/third-party/nwaku/docs/operators/how-to/build.md b/third-party/nwaku/docs/operators/how-to/build.md
new file mode 100644
index 0000000..473547c
--- /dev/null
+++ b/third-party/nwaku/docs/operators/how-to/build.md
@@ -0,0 +1,59 @@
+# Build nwaku
+
+Nwaku can be built on Linux and macOS.
+Windows support is experimental.
+
+## Installing dependencies
+
+Cloning and building nwaku requires the usual developer tools,
+such as a C compiler, Make, Bash and Git.
+
+### Linux
+
+On common Linux distributions the dependencies can be installed with
+
+```sh
+# Debian and Ubuntu
+sudo apt-get install build-essential git
+
+# Fedora
+dnf install @development-tools
+
+# Archlinux, using an AUR manager
+yourAURmanager -S base-devel
+```
+
+### macOS
+
+Assuming you use [Homebrew](https://brew.sh/) to manage packages
+
+```sh
+brew install cmake
+```
+
+## Building nwaku
+
+### 1. Clone the nwaku repository
+
+```sh
+git clone https://github.com/status-im/nwaku
+cd nwaku
+```
+
+### 2. Make the `wakunode2` target
+
+```sh
+# The first `make` invocation will update all Git submodules.
+# You'll run `make update` after each `git pull`, in the future, to keep those submodules up to date.
+make wakunode2
+```
+
+This will create a `wakunode2` binary in the `./build/` directory.
+
+> **Note:** Building `wakunode2` requires 2GB of RAM.
+The build will fail on systems not fulfilling this requirement.
+
+> Setting up a `wakunode2` on the smallest [digital ocean](https://docs.digitalocean.com/products/droplets/how-to/) droplet, you can either
+> * compile on a stronger droplet featuring the same CPU architecture and downgrade after compiling, or
+> * activate swap on the smallest droplet, or
+> * use Docker.
diff --git a/third-party/nwaku/docs/operators/how-to/configure-dns-disc.md b/third-party/nwaku/docs/operators/how-to/configure-dns-disc.md
new file mode 100644
index 0000000..f003c61
--- /dev/null
+++ b/third-party/nwaku/docs/operators/how-to/configure-dns-disc.md
@@ -0,0 +1,27 @@
+# Use DNS discovery to connect to existing nodes
+
+> **Note:** This page describes using DNS to discover other peers
+and is unrelated to the [domain name configuration](./configure-domain.md) for your nwaku node.
+
+A node can discover other nodes to connect to using [DNS-based discovery](../../tutorial/dns-disc.md).
+The following command line options are available:
+
+```
+--dns-discovery Enable DNS Discovery
+--dns-discovery-url URL for DNS node list in format 'enrtree://@'
+```
+
+- `--dns-discovery` is used to enable DNS discovery on the node.
+Waku DNS discovery is disabled by default.
+- `--dns-discovery-url` is mandatory if DNS discovery is enabled.
+It contains the URL for the node list.
+The URL must be in the format `enrtree://@` where `` is the fully qualified domain name and `` is the base32 encoding of the compressed 32-byte public key that signed the list at that location.
+
+A node will attempt connection to all discovered nodes.
+
+This can be used, for example, to connect to one of the existing fleets.
+Current URLs for the published fleet lists:
+- production fleet: `enrtree://AIRVQ5DDA4FFWLRBCHJWUWOO6X6S4ZTZ5B667LQ6AJU6PEYDLRD5O@sandbox.waku.nodes.status.im`
+- test fleet: `enrtree://AOGYWMBYOUIMOENHXCHILPKY3ZRFEULMFI4DOM442QSZ73TT2A7VI@test.waku.nodes.status.im`
+
+See the [separate tutorial](../../tutorial/dns-disc.md) for a complete guide to DNS discovery.
diff --git a/third-party/nwaku/docs/operators/how-to/configure-domain.md b/third-party/nwaku/docs/operators/how-to/configure-domain.md
new file mode 100644
index 0000000..226da4b
--- /dev/null
+++ b/third-party/nwaku/docs/operators/how-to/configure-domain.md
@@ -0,0 +1,16 @@
+# Configure a domain name
+
+> **Note:** This page describes configuring a domain name that resolves to your node's IP
+and is unrelated to [DNS discovery](./configure-dns-disc.md),
+by which a node may discover the listening addresses of other peers using DNS.
+
+It is possible to configure an IPv4 DNS domain name that resolves to the node's public IPv4 address.
+
+```shell
+wakunode2 --dns4-domain-name=mynode.example.com
+```
+
+This allows for the node's publicly announced `multiaddrs` to use the `/dns4` scheme.
+In addition, nodes with domain name and [secure websocket configured](./configure-websocket.md),
+will generate a discoverable ENR containing the `/wss` multiaddr with `/dns4` domain name.
+This is necessary to verify domain certificates when connecting to this node over secure websocket.
\ No newline at end of file
diff --git a/third-party/nwaku/docs/operators/how-to/configure-key.md b/third-party/nwaku/docs/operators/how-to/configure-key.md
new file mode 100644
index 0000000..8da84f9
--- /dev/null
+++ b/third-party/nwaku/docs/operators/how-to/configure-key.md
@@ -0,0 +1,54 @@
+# Generate and configure a node key
+
+By default a node will generate a new, random key pair each time it boots,
+resulting in a different public libp2p `multiaddrs` after each restart.
+
+To maintain consistent addressing across restarts,
+it is possible to configure the node with a previously generated private key using the `--nodekey` option.
+
+```shell
+wakunode2 --nodekey=<64_char_hex>
+```
+
+This option takes a [Secp256k1](https://en.bitcoin.it/wiki/Secp256k1) private key in 64 char hexstring format.
+
+To generate such a key on Linux systems,
+use the openssl `rand` command to generate a pseudo-random 32 byte hexstring.
+
+```sh
+openssl rand -hex 32
+```
+
+Example output:
+
+```sh
+$ openssl rand -hex 32
+6a29e767c96a2a380bb66b9a6ffcd6eb54049e14d796a1d866307b8beb7aee58
+```
+
+where the key `6a29e767c96a2a380bb66b9a6ffcd6eb54049e14d796a1d866307b8beb7aee58` can be used as `nodekey`.
+
+To create a reusable keyfile on Linux using `openssl`,
+use the `ecparam` command coupled with some standard utilities
+whenever you want to extract the 32 byte private key in hex format.
+
+```sh
+# Generate keyfile
+openssl ecparam -genkey -name secp256k1 -out my_private_key.pem
+# Extract 32 byte private key
+openssl ec -in my_private_key.pem -outform DER | tail -c +8 | head -c 32| xxd -p -c 32
+```
+
+Example output:
+
+```sh
+read EC key
+writing EC key
+0c687bb8a7984c770b566eae08520c67f53d302f24b8d4e5e47cc479a1e1ce23
+```
+
+where the key `0c687bb8a7984c770b566eae08520c67f53d302f24b8d4e5e47cc479a1e1ce23` can be used as `nodekey`.
+
+```sh
+wakunode2 --nodekey=0c687bb8a7984c770b566eae08520c67f53d302f24b8d4e5e47cc479a1e1ce23
+```
diff --git a/third-party/nwaku/docs/operators/how-to/configure-rest-api.md b/third-party/nwaku/docs/operators/how-to/configure-rest-api.md
new file mode 100644
index 0000000..3fe070a
--- /dev/null
+++ b/third-party/nwaku/docs/operators/how-to/configure-rest-api.md
@@ -0,0 +1,23 @@
+
+# Configure a REST API node
+
+A subset of the node configuration can be used to modify the behaviour of the HTTP REST API.
+
+These are the relevant command line options:
+
+| CLI option | Description | Default value |
+|------------|-------------|---------------|
+|`--rest` | Enable Waku REST HTTP server. | `false` |
+|`--rest-address` | Listening address of the REST HTTP server. | `127.0.0.1` |
+|`--rest-port` | Listening port of the REST HTTP server. | `8645` |
+|`--rest-relay-cache-capacity` | Capacity of the Relay REST API message cache. | `30` |
+|`--rest-admin` | Enable access to REST HTTP Admin API. | `false` |
+|`--rest-private` | Enable access to REST HTTP Private API. | `false` |
+
+Note that these command line options have their counterpart option in the node configuration file.
+
+Example:
+
+```shell
+wakunode2 --rest=true
+```
diff --git a/third-party/nwaku/docs/operators/how-to/configure-store-v0.12.0.md b/third-party/nwaku/docs/operators/how-to/configure-store-v0.12.0.md
new file mode 100644
index 0000000..237c7fc
--- /dev/null
+++ b/third-party/nwaku/docs/operators/how-to/configure-store-v0.12.0.md
@@ -0,0 +1,56 @@
+# Configure store protocol (versions prior to v0.13.0)
+
+Store protocol is enabled by default on a nwaku node.
+This is controlled by the `--store` CLI option.
+
+```sh
+# Disable store protocol on startup
+./build/wakunode2 --store:false
+```
+
+Note that this only mounts the `store` protocol,
+meaning your node will indicate to other peers that it supports `store`.
+It does not yet allow your node to either retrieve historical messages as a client
+or store and serve historical messages itself.
+
+## Configuring a store client
+
+Ensure that `store` is enabled (this is `true` by default) and provide at least one store service node address with the `--storenode` CLI option.
+
+See the following example, using the peer at `/dns4/node-01.ac-cn-hongkong-c.waku.test.status.im/tcp/30303/p2p/16Uiu2HAkzHaTP5JsUwfR9NR8Rj9HC24puS6ocaU8wze4QrXr9iXp` as store service node.
+
+```sh
+./build/wakunode2 \
+ --store:true \
+ --storenode:/dns4/node-01.ac-cn-hongkong-c.waku.test.status.im/tcp/30303/p2p/16Uiu2HAkzHaTP5JsUwfR9NR8Rj9HC24puS6ocaU8wze4QrXr9iXp
+```
+
+Your node can now send queries to retrieve historical messages
+from the configured store service node.
+One way to trigger such queries is asking your node for historical messages using the [Waku v2 JSON RPC API](https://rfc.vac.dev/spec/16/).
+
+## Configuring a store service node
+
+To store historical messages on your node which can be served to store clients the `--persist-messages` CLI option must be enabled.
+By default a node would store up to the latest `50 000` messages.
+This is configurable using the `--store-capacity` option.
+A node that has a `--db-path` set will backup historical messages to a local database at the DB path
+and persist these messages even after a restart.
+
+```sh
+./build/wakunode2 \
+ --store:true \
+ --persist-messages:true \
+ --db-path:/mnt/nwaku/data/db1/ \
+ --store-capacity:150000
+```
+
+### How much resources should I allocate?
+
+Currently store service nodes use an in-memory key-value store as primary storage with the disk-based database only used for backups.
+Most Waku messages average a size of 1KB - 2KB,
+implying a minimum memory requirement of at least ~250MB
+for a medium capacity store of 100k messages.
+Note, however, that the allowable maximum size for Waku messages is up to 1MB.
+We are working on a disk-only and hybrid store to lower the memory requirement.
+It will soon also be possible to configure store capacity on maximum store size or number of days' history to keep.
diff --git a/third-party/nwaku/docs/operators/how-to/configure-store.md b/third-party/nwaku/docs/operators/how-to/configure-store.md
new file mode 100644
index 0000000..ffa39cf
--- /dev/null
+++ b/third-party/nwaku/docs/operators/how-to/configure-store.md
@@ -0,0 +1,58 @@
+# Configure store protocol
+
+> :information_source: This instructions apply to nwaku version v0.13.0+. For versions prior to v0.13.0, check [this page](./configure-store-v0.12.0.md).
+
+The waku store protocol is disabled by default the nwaku node.
+This is controlled by the `--store` option. To enable waku store protocol on startup, specify explicitly the `--store` option set to `true`:
+
+```shell
+wakunode2 --store=true
+```
+
+This option controls the mounting of the Waku Store protocol, meaning that your node will indicate to other peers that it supports the Waku store protocol.
+
+## Configuring the node as a waku store client
+
+Provide at least one store service node address with the `--storenode` option. This option is independent of the `--store` option i.e., one node can act as a waku store client without mounting the Waku Store protocol.
+
+For example, to use the peer at `/dns4/node-01.ac-cn-hongkong-c.waku.test.status.im/tcp/30303/p2p/16Uiu2HAkzHaTP5JsUwfR9NR8Rj9HC24puS6ocaU8wze4QrXr9iXp` as the waku store service node:
+
+```shell
+wakunode2 \
+ --storenode=/dns4/node-01.ac-cn-hongkong-c.waku.test.status.im/tcp/30303/p2p/16Uiu2HAkzHaTP5JsUwfR9NR8Rj9HC24puS6ocaU8wze4QrXr9iXp
+```
+
+Your node can now send queries to retrieve historical messages
+from the configured store service node. One way to trigger such queries is asking your node for historical messages using the [Waku v2 JSON RPC API](https://rfc.vac.dev/spec/16/).
+
+## Configuring the node as a store service node
+
+If the waku store node is enabled (the `--store` option is set to `true`) the node will store historical messages and will be able to serve those messages to the waku store clients.
+
+There is a set of configuration options to customize the waku store protocol's message store. These are the most relevant:
+
+* `--store-message-retention-policy`: This option controls the retention policy i.e., how long certain messages will be persisted. Three different retention policies are supported:
+ + The time retention policy,`time:` (e.g., `time:14400`)
+ + The capacity retention policy,`capacity:` (e.g, `capacity:25000`)
+ + The size retention policy,`size:` (e.g, `size:25Gb`)
+ + To disable the retention policy, explicitly, set this option to `""`, an empty string.
+* `--store-message-db-url`: The message store database url option controls the message storage engine. This option follows the [_SQLAlchemy_ database URL format](https://docs.sqlalchemy.org/en/14/core/engines.html#database-urls).
+
+ + SQLite engine: The only database engine supported by the nwaku node. The database URL has this shape: `sqlite://`. If the `` is not an absolute path (preceded by a `/` character), the file will be created in the current working directory. The SQLite engine also supports to select a non-persistent in-memory database by setting the `` to `:memory:`.
+ + In the case you don't want to use a persistent message store; set the `--store-message-db-url` to an empty string, `""`. This will instruct the node to use the fallback in-memory message store.
+
+By default the node message store will be configured with a time retention policy set to `14400` seconds (4 hours). Additionally, by default, the node message store will use the SQLite database engine to store historical messages in order to persist these between restarts.
+
+> :warning: Note the 3 slashes, `///`, after the SQLite database URL schema. The third slash indicates that it is an absolute path: `/mnt/nwaku/data/db1/store.sqlite3`
+
+```shell
+wakunode2 \
+ --store=true \
+ --store-message-db-url=sqlite:///mnt/nwaku/data/db1/store.sqlite3 \
+ --store-message-retention-policy=capacity:150000
+```
+
+### How much resources should I allocate?
+
+Currently store service nodes use, by default, a message store backed by an in-disk SQLite database. Most Waku messages average a size of 1KB - 2KB, implying a minimum memory requirement of at least ~250MB
+for a typical store capacity of 100k messages. Note, however, that the allowable maximum size for Waku messages is up to 1MB.
diff --git a/third-party/nwaku/docs/operators/how-to/configure-websocket.md b/third-party/nwaku/docs/operators/how-to/configure-websocket.md
new file mode 100644
index 0000000..4f1c461
--- /dev/null
+++ b/third-party/nwaku/docs/operators/how-to/configure-websocket.md
@@ -0,0 +1,35 @@
+# Configure websocket transport
+
+Websocket is currently the only Waku transport supported by browser nodes using [js-waku](https://github.com/status-im/js-waku).
+Setting up websocket enables your node to directly serve browser peers.
+
+A valid certificate is necessary to serve browser nodes,
+you can use [`letsencrypt`](https://letsencrypt.org/):
+
+```shell
+sudo letsencrypt -d
+```
+
+You will need the `privkey.pem` and `fullchain.pem` files.
+
+To enable secure websocket, pass the generated files to `wakunode2`:
+Note, the default port for websocket is 8000.
+
+```shell
+wakunode2 --websocket-secure-support=true --websocket-secure-key-path="/privkey.pem" --websocket-secure-cert-path="/fullchain.pem"
+```
+
+## Self-signed certificates
+
+Self-signed certificates are not recommended for production setups because:
+
+- Browsers do not accept self-signed certificates
+- Browsers do not display an error when rejecting a certificate for websocket.
+
+However, they can be used for local testing purposes:
+
+```shell
+mkdir -p ./ssl_dir/
+openssl req -x509 -newkey rsa:4096 -keyout ./ssl_dir/key.pem -out ./ssl_dir/cert.pem -sha256 -nodes
+wakunode2 --websocket-secure-support=true --websocket-secure-key-path="./ssl_dir/key.pem" --websocket-secure-cert-path="./ssl_dir/cert.pem"
+```
\ No newline at end of file
diff --git a/third-party/nwaku/docs/operators/how-to/configure.md b/third-party/nwaku/docs/operators/how-to/configure.md
new file mode 100644
index 0000000..f052b22
--- /dev/null
+++ b/third-party/nwaku/docs/operators/how-to/configure.md
@@ -0,0 +1,136 @@
+# Configure a nwaku node
+
+Nwaku can be configured to serve the adaptive needs of different operators.
+
+> :bulb: **Tip:** The recommended configuration method is through environment variables.
+
+## Node configuration methods
+
+One node can be configured using a combination of the following methods:
+
+1. Command line options and flags
+2. Environment variables
+3. Configuration file (currently, only TOML format is supported)
+4. Default value
+
+Note the precedence order, each configuration mechanism overrides the configuration set by one below (e.g., _command line options_ override the configuration set by the _environment variables_ and by the _configuration file_).
+
+### Command line options/flags
+
+The main mechanism to configure the node is via command line options. Any configuration option provided via the command line will override any other configuration mechanism.
+
+> :warning: nwaku is under heavy development. It is likely that configuration will change from one version to another.
+>
+> If after an upgrade, the node refuses to start, check if any of the command line configuration options provided to the node have been changed or removed.
+>
+> To overcome this issue, we recommend to configure the node via environment variables.
+
+The configuration options should be provided after the binary name as follows:
+
+```shell
+wakunode2 --tcp-port=65000
+```
+
+In the case of using docker to run you node you should provide the commandline options after the image name as follows:
+
+```shell
+docker run wakuorg/nwaku --tcp-port=65000
+```
+
+Run `wakunode2 --help` to get a comprehensive list of configuration options (and its default values):
+
+```shell
+$ wakunode2 --help
+Usage:
+
+wakunode2 [OPTIONS]...
+
+The following options are available:
+
+ --config-file Loads configuration from a TOML file (cmd-line parameters take precedence).
+ --log-level Sets the log level. [=LogLevel.INFO].
+ --version prints the version [=false].
+
+<...>
+```
+
+Check the configuration tutorials for specific configuration use cases.
+
+### Environment variables
+
+The node can also be configured via environment variables.
+
+> :information_source: Support for configuring the node via environment variables was added in v0.13.0
+
+The environment variable name should be prefixed by the app's name, in this case `WAKUNODE2_` followed by the commandline option in [screaming snake case](https://en.wiktionary.org/wiki/screaming_snake_case).
+
+For example, to set the `--tcp-port` configuration we should call `wakunode2` binary as follows:
+
+```shell
+WAKUNODE2_TCP_PORT=65000 wakunode2
+```
+
+In the case of using docker to run you node you should start the node using the `-e` command options:
+
+```shell
+docker run -e "WAKUNODE2_TCP_PORT=65000" wakuorg/nwaku
+```
+
+This is the second configuration method in order of precedence. Any command line configuration option will override the configuration
+provided via environment variables.
+
+### Configuration file
+
+The third configuration mechanism in order of precedence is the configuration via a TOML file. The previous mechanisms take precedence over this mechanism as explained above.
+
+The configuration file follows the [TOML](https://toml.io/en/) format:
+
+```toml
+log-level = "DEBUG"
+tcp-port = 65000
+```
+
+The path to the TOML file can be specified using one of the previous configuration mechanisms:
+
+* By passing the `--config-file` command line option:
+ ```shell
+ wakunode2 --config-file=
+ ```
+* By passing the path via environment variables:
+ ```shell
+ WAKUNODE2_CONFIG_FILE= wakunode2
+ ```
+
+### Configuration default values
+
+As usual, if no configuration option is specified by any of the previous mechanisms, the default configuration will be used.
+
+The default configuration value is listed in the `wakunode2 --help` output:
+
+```shell
+$ wakunode2 --help
+Usage:
+
+wakunode2 [OPTIONS]...
+
+The following options are available:
+
+ --config-file Loads configuration from a TOML file (cmd-line parameters take precedence).
+ --log-level Sets the log level. [=LogLevel.INFO].
+ --version prints the version [=false].--tcp-port TCP listening port. [=60000].
+ --websocket-port WebSocket listening port. [=8000].
+<...>
+```
+
+## Configuration use cases
+
+This is an index of tutorials explaining how to configure your nwaku node for different use cases.
+
+1. [Connect to other peers](./connect.md)
+2. [Configure a domain name](./configure-domain.md)
+3. [Use DNS discovery to connect to existing nodes](./configure-dns-disc.md)
+4. [Configure store protocol and message store](./configure-store.md)
+5. [Generate and configure a node key](./configure-key.md)
+6. [Configure websocket transport](./configure-websocket.md)
+7. [Run nwaku with rate limiting enabled](./run-with-rln.md)
+8. [Configure a REST API node](./configure-rest-api.md)
diff --git a/third-party/nwaku/docs/operators/how-to/connect.md b/third-party/nwaku/docs/operators/how-to/connect.md
new file mode 100644
index 0000000..b375401
--- /dev/null
+++ b/third-party/nwaku/docs/operators/how-to/connect.md
@@ -0,0 +1,60 @@
+# Connect to other peers
+
+*Note that this tutorial describes how to **configure** a node to connect to other peers before running the node.
+For connecting a running node to existing peers,
+see the [WAKU REST API reference](https://waku-org.github.io/waku-rest-api/#post-/admin/v1/peers).*
+
+There are currently three options.
+Note that each of these options can be used in combination with any of the other two.
+In other words, it is possible to configure a node to connect
+to a static list of peers and
+to discover such peer lists using DNS discovery and
+discover and connect to random peers using discovery v5 with a bootstrap node.
+
+## Option 1: Configure peers statically
+
+Static peers can be provided to a nwaku node on startup using the `--staticnode` CLI parameter.
+The `--staticnode` option can be repeated for each peer you want to connect to on startup.
+
+```sh
+./build/wakunode2 \
+ --staticnode: \
+ --staticnode:
+```
+
+As an example, consider a nwaku node that connects to two known peers
+on the same local host (with IP `0.0.0.0`)
+with TCP ports `60002` and `60003`,
+and peer IDs `16Uiu2HAkzjwwgEAXfeGNMKFPSpc6vGBRqCdTLG5q3Gmk2v4pQw7H` and `16Uiu2HAmFBA7LGtwY5WVVikdmXVo3cKLqkmvVtuDu63fe8safeQJ` respectively.
+
+```sh
+./build/wakunode2 \
+ --staticnode:/ip4/0.0.0.0/tcp/60002/p2p/16Uiu2HAkzjwwgEAXfeGNMKFPSpc6vGBRqCdTLG5q3Gmk2v4pQw7H \
+ --staticnode:/ip4/0.0.0.0/tcp/60003/p2p/16Uiu2HAmFBA7LGtwY5WVVikdmXVo3cKLqkmvVtuDu63fe8safeQJ
+```
+
+## Option 2: Discover peers using DNS discovery
+
+A node can discover other nodes to connect to using DNS-based discovery.
+For a quickstart guide on how to configure DNS discovery,
+see [this tutorial](./configure-dns-disc.md).
+There is also a [more comprehensive tutorial](../../tutorial/dns-disc.md) for advanced users.
+
+## Option 3: Discover peers using Waku Discovery v5
+
+
+
+Enable Discovery v5 using the `--discv5-discovery` option.
+
+It is possible to configure bootstrap entries for the Discovery v5 routing table
+using the `--discv5-bootstrap-node` option repeatedly.
+
+```sh
+./build/wakunode2 \
+ --discv5-discovery:true \
+ --discv5-bootstrap-node: \
+ --discv5-bootstrap-node:
+```
+
+Note that if Discovery v5 is enabled and used in conjunction with DNS-based discovery,
+the nwaku node will attempt to bootstrap the Discovery v5 routing table with ENRs extracted from the peers discovered via DNS.
diff --git a/third-party/nwaku/docs/operators/how-to/monitor.md b/third-party/nwaku/docs/operators/how-to/monitor.md
new file mode 100644
index 0000000..8ef3f06
--- /dev/null
+++ b/third-party/nwaku/docs/operators/how-to/monitor.md
@@ -0,0 +1,111 @@
+# Monitor nwaku using Prometheus and Grafana
+
+## Prerequisites
+
+1. A running nwaku instance with HTTP metrics server enabled (i.e. with `--metrics-server:true`)
+2. [Prometheus](https://prometheus.io/) and [Grafana](https://grafana.com/) installed
+
+### Installing Prometheus
+
+Prometheus can be installed by downloading and extracting
+the latest release for your system distribution from the [Prometheus download page](https://prometheus.io/download/).
+
+For example, on a DebianOS distribution you could run
+
+```bash
+wget https://github.com/prometheus/prometheus/releases/download/v2.38.0/prometheus-2.38.0.linux-amd64.tar.gz
+tar xvfz prometheus-2.38.0.linux-amd64.tar.gz
+```
+
+For more advanced installations,
+Prometheus has a handy [Getting Started](https://prometheus.io/docs/prometheus/latest/getting_started/) page to guide you through the process.
+There are also many third party guides on installing Prometheus for specific distributions,
+such as [this old but still relevant one](https://www.digitalocean.com/community/tutorials/how-to-install-prometheus-on-ubuntu-16-04) from DigitalOcean.
+We also suggest running Prometheus as a service,
+as explained by [this guide](https://www.devopsschool.com/blog/how-to-run-prometheus-server-as-a-service/).
+Bear in mind that we'll be creating our own `prometheus.yml` configuration file later on when you encounter this in any of the guides.
+
+### Installing Grafana
+
+Follow the [installation instructions](https://grafana.com/docs/grafana/latest/setup-grafana/installation/) appropriate to your distribution to install Grafana.
+The stable version of the Grafana Enterprise Edition is the free, recommended edition to install.
+
+## Configure Prometheus
+
+1. Create a file called `prometheus.yml` with the following content:
+
+```yml
+global:
+ scrape_interval: 15s
+
+scrape_configs:
+ - job_name: 'prometheus'
+ scrape_interval: 5s
+ static_configs:
+ - targets: ['localhost:9090']
+ - job_name: 'nwaku'
+ scrape_interval: 1s
+ static_configs:
+ - targets: ['localhost:']
+```
+
+Replace `` with the metrics HTTP server port of your running nwaku instance.
+For default configurations metrics are reported on port `8008` of the `localhost`.
+If you've used `--ports-shift`, or explicitly set the metrics port using `--metrics-server-port`, this port will be different from the default.
+It's possible to extract the metrics server port from the startup logs of the nwaku node.
+Look for a log with the format below and substitute `nwaku_port` with the value reported after `serverPort=`:
+
+```
+INF 2022-09-16 12:14:12.739+01:00 Metrics HTTP server started topics="wakunode.setup.metrics" tid=6243 file=wakunode2_setup_metrics.nim:29 serverIp=127.0.0.1 serverPort=8009
+```
+
+2. Start Prometheus using the config file you created above:
+
+```bash
+./path/to/prometheus --config.file=/path/to/prometheus.yml &
+```
+
+3. Verify that Prometheus is running correctly.
+
+Once Prometheus is running, it exposes by default a management console on port `9090`.
+If you are running Prometheus locally, for example,
+you can visit http://localhost:9090/ in a browser to view basic info about the running instance.
+http://localhost:9090/targets shows the state of the different metrics server endpoints that we configured in `prometheus.yml`.
+In our case we'd expect Prometheus to successfully scrape metrics off two endpoints,
+the running nwaku instance and Prometheus itself.
+
+## Configure Grafana
+
+1. Start the Grafana server, if it's not running already after installation.
+
+```bash
+sudo systemctl start grafana-server
+```
+
+2. Open Grafana in your browser.
+
+Grafana exposes its interface by default on port `3000`.
+For example, if you are running Grafana locally,
+you can find it by navigating to http://localhost:3000/.
+If you are prompted for a username and password,
+the default is `admin` in both cases.
+
+3. Set Prometheus as your data source.
+
+[These instructions](https://grafana.com/docs/grafana/latest/datasources/add-a-data-source/) describe how to add a new data source.
+The default values for setting up a Prometheus data source should be sufficient.
+
+4. Create a new dashboard or import an existing one.
+
+You can now visualize metrics off your running nwaku instance by [creating a new dashboard and adding panels](https://grafana.com/docs/grafana/latest/dashboards/add-organize-panels/) for the metric(s) of your choice.
+To get you started,
+we have published a [basic monitoring dashboard for a single nwaku node](https://github.com/status-im/nwaku/blob/d4e899fba77389d20ca19c73a9443501039cdef2/metrics/waku-single-node-dashboard.json)
+which you can [import to your Grafana instance](https://grafana.com/docs/grafana/latest/dashboards/manage-dashboards/#import-a-dashboard).
+
+5. Happy monitoring!
+
+Some of the most important metrics to keep an eye on include:
+- `libp2p_peers` as an indication of how many peers your node is connected to,
+- `waku_node_messages_total` to view the total amount of network traffic relayed by your node and
+- `waku_node_errors` as a rough indication of basic operating errors logged by the node.
+
diff --git a/third-party/nwaku/docs/operators/how-to/run-with-rln.md b/third-party/nwaku/docs/operators/how-to/run-with-rln.md
new file mode 100644
index 0000000..ef1a6c2
--- /dev/null
+++ b/third-party/nwaku/docs/operators/how-to/run-with-rln.md
@@ -0,0 +1,89 @@
+# How to run spam prevention on your nwaku node (RLN)
+
+This guide explains how to run a nwaku node with RLN (Rate Limiting Nullifier) enabled.
+
+[RLN](https://rfc.vac.dev/spec/32/) is a protocol integrated into waku v2,
+which prevents spam-based attacks on the network.
+
+For further background on the research for RLN tailored to waku, refer
+to [this](https://rfc.vac.dev/spec/17/) RFC.
+
+Registering to the membership group has been left out for brevity.
+If you would like to register to the membership group and send messages with RLN,
+refer to the [on-chain chat2 tutorial](../../tutorial/onchain-rln-relay-chat2.md).
+
+This guide specifically allows a node to participate in RLN testnet 2.
+You may alter the rln-specific arguments as required.
+
+## Prerequisites
+
+1. Follow the [droplet quickstart](../droplet-quickstart.md) or the [build guide](./build.md) till the `make` command for the wakunode2 binary.
+
+> Note: If you would like to run a nwaku node with RLN enabled within a docker container, skip ahead to step 2.
+
+## 1. Build wakunode2
+
+Run -
+```bash
+make wakunode2
+```
+
+## 2. Update the runtime arguments
+
+Follow [Step 10](../droplet-quickstart.md#10-run-nwaku) of the [droplet quickstart](../droplet-quickstart.md) guide, while replacing the run command with -
+
+```bash
+export LINEA_SEPOLIA_HTTP_NODE_ADDRESS=
+export RLN_RELAY_CONTRACT_ADDRESS="0xB9cd878C90E49F797B4431fBF4fb333108CB90e6" # Replace this with any compatible implementation
+$WAKUNODE_DIR/wakunode2 \
+--store:true \
+--persist-messages \
+--dns-discovery \
+--dns-discovery-url:"$WAKU_FLEET" \
+--discv5-discovery:true \
+--rln-relay:true \
+--rln-relay-dynamic:true \
+--rln-relay-eth-contract-address:"$RLN_RELAY_CONTRACT_ADDRESS" \
+--rln-relay-eth-client-address:"$LINEA_SEPOLIA_HTTP_NODE_ADDRESS"
+```
+
+OR
+
+If you are running the nwaku node within docker, follow [Step 2](../docker-quickstart.md#step-2-run) while replacing the run command with -
+
+```bash
+export WAKU_FLEET=
+export LINEA_SEPOLIA_HTTP_NODE_ADDRESS=
+export RLN_RELAY_CONTRACT_ADDRESS="0xB9cd878C90E49F797B4431fBF4fb333108CB90e6" # Replace this with any compatible implementation
+docker run -i -t -p 60000:60000 -p 9000:9000/udp wakuorg/nwaku:v0.36.0 \
+ --dns-discovery:true \
+ --dns-discovery-url:"$WAKU_FLEET" \
+ --discv5-discovery \
+ --nat:extip:[yourpublicip] \ # or, if you are behind a nat: --nat=any
+ --rln-relay:true \
+ --rln-relay-dynamic:true \
+ --rln-relay-eth-contract-address:"$RLN_RELAY_CONTRACT_ADDRESS" \
+ --rln-relay-eth-client-address:"$LINEA_SEPOLIA_HTTP_NODE_ADDRESS"
+```
+
+> Note: You can choose to keep connections to other nodes alive by adding the `--keep-alive` flag.
+
+Following is the list of additional fields that have been added to the
+runtime arguments -
+
+1. `--rln-relay`: Allows waku-rln-relay to be mounted into the setup of the nwaku node
+2. `--rln-relay-dynamic`: Enables waku-rln-relay to connect to an ethereum node to fetch the membership group
+3. `--rln-relay-eth-contract-address`: The contract address of an RLN membership group
+4. `--rln-relay-eth-client-address`: The HTTP url to a Linea Sepolia ethereum node
+
+You should now have nwaku running, with RLN enabled!
+
+To see metrics related to the functioning of RLN, refer to this [guide](./todo).
+You can also refer to the periodic logging, for a few metrics like -
+
+- number of spam messages
+- number of valid messages
+- number of invalid messages
+
+
+> Note: This guide will be updated in the future to include features like slashing.
diff --git a/third-party/nwaku/docs/operators/how-to/run.md b/third-party/nwaku/docs/operators/how-to/run.md
new file mode 100644
index 0000000..bc90394
--- /dev/null
+++ b/third-party/nwaku/docs/operators/how-to/run.md
@@ -0,0 +1,196 @@
+# Running nwaku
+
+Nwaku binaries can be [built](./build.md) and run on Linux and macOS.
+Windows support is experimental.
+
+```sh
+# Run with default configuration
+./build/wakunode2
+
+# See available command line options
+./build/wakunode2 --help
+```
+
+## Default configuration
+
+By default a nwaku node will:
+- generate a new private key and libp2p identities after every restart.
+See [this tutorial](./configure-key.md) if you want to generate and configure a persistent private key.
+- listen for incoming libp2p connections on the default TCP port (`60000`)
+- enable `relay` protocol
+- subscribe to the default clusterId (0) and shard (0)
+- enable `store` protocol, but only as a client.
+This implies that the nwaku node will not persist any historical messages itself,
+but can query `store` service peers who do so.
+To configure `store` as a service node,
+see [this tutorial](./configure-store.md).
+
+> **Note:** The `filter` and `lightpush` protocols are _not_ enabled by default.
+Consult the [configuration guide](./configure.md) on how to configure your nwaku node to run these protocols.
+
+Some typical non-default configurations are explained below.
+For more advanced configuration, see the [configuration guide](./configure.md).
+Different ways to connect to other nodes are expanded upon in our [connection guide](./connect.md).
+
+## Finding your listening address(es)
+
+Find the log entry beginning with `Listening on`.
+It should be printed at INFO level when you start your node
+and contains a list of all publicly announced listening addresses for the nwaku node.
+
+For example
+
+```
+INF 2022-05-11 16:42:30.591+02:00 Listening on topics="wakunode" tid=6661 file=wakunode2.nim:941 full=[/ip4/0.0.0.0/tcp/60000/p2p/16Uiu2HAkzjwwgEAXfeGNMKFPSpc6vGBRqCdTLG5q3Gmk2v4pQw7H][/ip4/0.0.0.0/tcp/8000/ws/p2p/16Uiu2HAkzjwwgEAXfeGNMKFPSpc6vGBRqCdTLG5q3Gmk2v4pQw7H]
+```
+
+indicates that your node is listening on the TCP transport address
+
+```
+/ip4/0.0.0.0/tcp/60000/p2p/16Uiu2HAkzjwwgEAXfeGNMKFPSpc6vGBRqCdTLG5q3Gmk2v4pQw7H
+```
+
+and websocket address
+
+```
+/ip4/0.0.0.0/tcp/8000/ws/p2p/16Uiu2HAkzjwwgEAXfeGNMKFPSpc6vGBRqCdTLG5q3Gmk2v4pQw7H
+```
+
+You can also query a running node for its listening addresses
+using the REST API.
+
+```bash
+curl http://localhost:8645/debug/v1/info -s | jq
+```
+
+## Finding your discoverable ENR address(es)
+
+A nwaku node can encode its addressing information in an [Ethereum Node Record (ENR)](https://eips.ethereum.org/EIPS/eip-778) according to [`31/WAKU2-ENR`](https://rfc.vac.dev/spec/31/).
+These ENR are most often used for discovery purposes.
+
+### ENR for DNS discovery
+
+Find the log entry beginning with `DNS: discoverable ENR`.
+It should be printed at INFO level when you start your node with [DNS discovery enabled](./configure-dns-disc.md)
+and contains an ENR that can be added to node lists discoverable via DNS.
+
+For example
+
+```
+INF 2022-05-20 11:52:48.772+02:00 DNS: discoverable ENR topics="wakunode" tid=5182 file=wakunode2.nim:941 enr=enr:-Iu4QBZs5huNuEAjI9WA0HOAjzpmp39vKJAtYRG3HXH86-i3HGcxMgupIkyDBmBq9qJ2wFfgMiW8AUzUxTFMAzfJM5MBgmlkgnY0gmlwhAAAAACJc2VjcDI1NmsxoQN0EcrUbHrL_O_kNXDlBvcO1I4yZUdNk7VZI5GsXaWgvYN0Y3CC6mCFd2FrdTID
+```
+
+indicates that your node addresses are encoded in the ENR
+
+```
+enr=enr:-Iu4QBZs5huNuEAjI9WA0HOAjzpmp39vKJAtYRG3HXH86-i3HGcxMgupIkyDBmBq9qJ2wFfgMiW8AUzUxTFMAzfJM5MBgmlkgnY0gmlwhAAAAACJc2VjcDI1NmsxoQN0EcrUbHrL_O_kNXDlBvcO1I4yZUdNk7VZI5GsXaWgvYN0Y3CC6mCFd2FrdTID
+```
+
+### ENR for Discovery v5
+
+Find the log entry beginning with `Discv5: discoverable ENR`.
+It should be printed at INFO level when you start your node with [Waku Discovery v5 enabled](https://rfc.vac.dev/spec/33/)
+and contains the ENR that will be discoverable by other peers.
+
+For example
+
+```
+INF 2022-05-20 11:52:48.775+02:00 Discv5: discoverable ENR topics="wakunode" tid=5182 file=wakunode2.nim:905 enr=enr:-IO4QDxToTg86pPCK2KvMeVCXC2ADVZWrxXSvNZeaoa0JhShbM5qed69RQz1s1mWEEqJ3aoklo_7EU9iIBcPMVeKlCQBgmlkgnY0iXNlY3AyNTZrMaEDdBHK1Gx6y_zv5DVw5Qb3DtSOMmVHTZO1WSORrF2loL2DdWRwgiMohXdha3UyAw
+```
+
+indicates that your node addresses are encoded in the ENR
+
+```
+enr=enr:-IO4QDxToTg86pPCK2KvMeVCXC2ADVZWrxXSvNZeaoa0JhShbM5qed69RQz1s1mWEEqJ3aoklo_7EU9iIBcPMVeKlCQBgmlkgnY0iXNlY3AyNTZrMaEDdBHK1Gx6y_zv5DVw5Qb3DtSOMmVHTZO1WSORrF2loL2DdWRwgiMohXdha3UyAw
+```
+
+## Typical configuration (relay node)
+
+The typical configuration for a nwaku node is to run the `relay` protocol,
+subscribed to the default pubsub topic `/waku/2/rs/0/0`,
+and connecting to one or more existing peers.
+We assume below that running nodes also participate in Discovery v5
+to continually discover and connect to random peers for a more robust mesh.
+
+### Connecting to known peer(s)
+
+A typical run configuration for a nwaku node is to connect to existing peers with known listening addresses using the `--staticnode` option.
+The `--staticnode` option can be repeated for each peer you want to connect to on startup.
+This is also useful if you want to run several nwaku instances locally
+and therefore know the listening addresses of all peers.
+
+As an example, consider a nwaku node that connects to two known peers
+on the same local host (with IP `0.0.0.0`)
+with TCP ports `60002` and `60003`,
+and peer IDs `16Uiu2HAkzjwwgEAXfeGNMKFPSpc6vGBRqCdTLG5q3Gmk2v4pQw7H` and `16Uiu2HAmFBA7LGtwY5WVVikdmXVo3cKLqkmvVtuDu63fe8safeQJ` respectively.
+The Discovery v5 routing table can similarly be bootstrapped using a static ENR.
+We include an example below.
+
+```sh
+./build/wakunode2 \
+ --ports-shift:1 \
+ --staticnode:/ip4/0.0.0.0/tcp/60002/p2p/16Uiu2HAkzjwwgEAXfeGNMKFPSpc6vGBRqCdTLG5q3Gmk2v4pQw7H \
+ --staticnode:/ip4/0.0.0.0/tcp/60003/p2p/16Uiu2HAmFBA7LGtwY5WVVikdmXVo3cKLqkmvVtuDu63fe8safeQJ \
+ --discv5-discovery:true \
+ --discv5-bootstrap-node:enr:-JK4QM2ylZVUhVPqXrqhWWi38V46bF2XZXPSHh_D7f2PmUHbIw-4DidCBnBnm-IbxtjXOFbdMMgpHUv4dYVH6TgnkucBgmlkgnY0gmowhCJ6_HaJc2VjcDI1NmsxoQM06FsT6EJ57mzR_wiLu2Bz1dER2nUFSCpaFzCccQtnhYN0Y3CCdl-DdWRwgiMohXdha3UyDw
+```
+
+> **Tip:** `--ports-shift` shifts all configured ports forward by the configured amount.
+This is another useful option when running several nwaku instances on a single machine
+and would like to avoid port clashes without manually configuring each port.
+
+### Connecting to the `waku.sandbox` network
+
+*See [this explainer](https://github.com/status-im/nwaku/blob/6ebe26ad0587d56a87a879d89b7328f67f048911/docs/contributors/waku-fleets.md) on the different networks and Waku v2 fleets.*
+
+You can use DNS discovery to bootstrap connection to the existing production network.
+Discovery v5 will attempt to extract the ENRs of the discovered nodes as bootstrap entries to the routing table.
+
+```sh
+./build/wakunode2 \
+ --ports-shift:1 \
+ --dns-discovery:true \
+ --dns-discovery-url:enrtree://AIRVQ5DDA4FFWLRBCHJWUWOO6X6S4ZTZ5B667LQ6AJU6PEYDLRD5O@sandbox.waku.nodes.status.im \
+ --discv5-discovery:true
+```
+
+### Connecting to the `waku.test` network
+
+*See [this explainer](https://github.com/status-im/nwaku/blob/6ebe26ad0587d56a87a879d89b7328f67f048911/docs/contributors/waku-fleets.md) on the different networks and Waku v2 fleets.*
+
+You can use DNS discovery to bootstrap connection to the existing test network.
+Discovery v5 will attempt to extract the ENRs of the discovered nodes as bootstrap entries to the routing table.
+
+```sh
+./build/wakunode2 \
+ --ports-shift:1 \
+ --dns-discovery:true \
+ --dns-discovery-url:enrtree://AOGYWMBYOUIMOENHXCHILPKY3ZRFEULMFI4DOM442QSZ73TT2A7VI@test.waku.nodes.status.im \
+ --discv5-discovery:true
+```
+
+## Typical configuration (relay and store service node)
+
+Often nwaku nodes choose to also store historical messages
+from where it can be queried by other peers who may have been temporarily offline.
+For example, a typical configuration for such a store service node,
+[connecting to the `waku.test`](#connecting-to-the-wakutest-network) fleet on startup,
+appears below.
+
+```sh
+./build/wakunode2 \
+ --ports-shift:1 \
+ --store:true \
+ --persist-messages:true \
+ --db-path:/mnt/nwaku/data/db1/ \
+ --store-capacity:150000 \
+ --dns-discovery:true \
+ --dns-discovery-url:enrtree://AOGYWMBYOUIMOENHXCHILPKY3ZRFEULMFI4DOM442QSZ73TT2A7VI@test.waku.nodes.status.im \
+ --discv5-discovery:true
+```
+
+See our [store configuration tutorial](./configure-store.md) for more.
+
+## Interact with a running nwaku node
+
+A running nwaku node can be interacted with using the [REST API](https://github.com/waku-org/nwaku/blob/master/docs/api/rest-api.md).
diff --git a/third-party/nwaku/docs/operators/overview.md b/third-party/nwaku/docs/operators/overview.md
new file mode 100644
index 0000000..f43652a
--- /dev/null
+++ b/third-party/nwaku/docs/operators/overview.md
@@ -0,0 +1,39 @@
+# Overview: running a nwaku node
+
+This guide provides on overview for newcomers
+on how to build and run a nwaku node
+for the most common use cases.
+For a more advanced configuration see our [configuration guides](./how-to/configure.md)
+
+To set up a nwaku node on a DigitalOcean droplet,
+refer to our [quickstart guide for droplets](./droplet-quickstart.md).
+If you prefer running nwaku in Docker container,
+see our [Docker guide](./docker-quickstart.md).
+
+## 1. Build
+
+[Build the nwaku node](./how-to/build.md)
+or download a precompiled binary from our [releases page](https://github.com/waku-org/nwaku/releases).
+
+If you'd like to test latest changes without building the binaries yourself, you can refer to [nightly release](https://github.com/waku-org/nwaku/releases/tag/nightly).
+
+Docker images are published to [wakuorg/nwaku](https://hub.docker.com/r/wakuorg/nwaku/tags) on Docker Hub.
+See our [Docker quickstart guide](./docker-quickstart.md) to run nwaku in a Docker container.
+
+## 2. Run
+
+[Run the nwaku node](./how-to/run.md) using a default or common configuration
+or [configure](./how-to/configure.md) the node for more advanced use cases.
+
+[Connect](./how-to/connect.md) the nwaku node to other peers to start communicating.
+
+## 3. Interact
+
+A running nwaku node can be interacted with using the [REST API](../api/v2/rest-api.md).
+
+> **Note:** REST API functionality is in ALPHA and therefore it is disabled by default. To configure a nwaku node with this enabled, use the `--rest:true` CLI option.
+
+
+```bash
+curl http://localhost:8546/debug/v1/info -s | jq
+```
diff --git a/third-party/nwaku/docs/operators/quickstart.md b/third-party/nwaku/docs/operators/quickstart.md
new file mode 100644
index 0000000..47c6195
--- /dev/null
+++ b/third-party/nwaku/docs/operators/quickstart.md
@@ -0,0 +1,61 @@
+# Quickstart: running a nwaku node
+
+This guide helps you run a nwaku node with typical configuration.
+It connects your node to the `waku.sandbox` fleet for bootstrapping
+and enables discovery v5 for continuous peer discovery.
+Only [`relay`](https://rfc.vac.dev/spec/11/) protocol is enabled.
+For a more comprehensive overview,
+see our [step-by-step guide](./overview.md).
+
+## Option 1: run nwaku binary
+
+*Prerequisites are the usual developer tools,
+such as a C compiler, Make, Bash and Git.*
+
+```bash
+git clone --recurse-submodules https://github.com/waku-org/nwaku
+cd nwaku
+make wakunode2
+./build/wakunode2 \
+ --dns-discovery:true \
+ --dns-discovery-url:enrtree://AIRVQ5DDA4FFWLRBCHJWUWOO6X6S4ZTZ5B667LQ6AJU6PEYDLRD5O@sandbox.waku.nodes.status.im \
+ --discv5-discovery \
+ --nat=extip:[yourpublicip] # or, if you are behind a nat: --nat=any
+```
+
+## Option 2: run nwaku in a Docker container
+
+*Prerequisite is a [Docker installation](./docker-quickstart.md#prerequisites).*
+
+```bash
+docker run -i -t -p 60000:60000 -p 9000:9000/udp \
+ wakuorg/nwaku:v0.20.0 \ # or, the image:tag of your choice
+ --dns-discovery:true \
+ --dns-discovery-url:enrtree://AIRVQ5DDA4FFWLRBCHJWUWOO6X6S4ZTZ5B667LQ6AJU6PEYDLRD5O@sandbox.waku.nodes.status.im \
+ --discv5-discovery \
+ --nat:extip:[yourpublicip] # or, if you are behind a nat: --nat=any
+```
+
+## Option 3: run nwaku with docker compose
+
+*Prerequisites: `docker` and `docker-compose`*.
+Allows to run `nwaku` with `prometheus` and `grafana`, with an already provisioned dashboard, in a few simple steps.
+See [nwaku-compose](https://github.com/waku-org/nwaku-compose).
+
+```bash
+git clone https://github.com/waku-org/nwaku-compose
+cd nwaku-compose
+docker-compose up -d
+```
+
+Go to [http://localhost:3000/d/yns_4vFVk/nwaku-monitoring?orgId=1](http://localhost:3000/d/yns_4vFVk/nwaku-monitoring?orgId=1) and after some seconds, your node metrics will be live there.
+As simple as that.
+
+## Tips and tricks
+
+To find the public IP of your host,
+you can use
+
+```bash
+dig TXT +short o-o.myaddr.l.google.com @ns1.google.com | awk -F'"' '{ print $2}'
+```
diff --git a/third-party/nwaku/docs/tutorial/chat2.md b/third-party/nwaku/docs/tutorial/chat2.md
new file mode 100644
index 0000000..f6489f9
--- /dev/null
+++ b/third-party/nwaku/docs/tutorial/chat2.md
@@ -0,0 +1,212 @@
+# Using the `chat2` application
+
+## Background
+
+The `chat2` application is a basic command-line chat app using the [Waku v2 suite of protocols](https://rfc.vac.dev/).
+It optionally connects to a [fleet of nodes](fleets.status.im) to provide end-to-end p2p chat capabilities.
+Each fleet is a publicly accessible network of Waku v2 peers, providing a bootstrap connection point for new peers, historical message storage, etc.
+The Waku team is currently using this application on the _sandbox_ fleet for internal testing.
+For more information on the available fleets, see [`Connecting to a Waku v2 fleet`](#connecting-to-a-waku-v2-fleet).
+If you want to try our protocols, or join the dogfooding fun, follow the instructions below.
+
+## Preparation
+
+Ensure you have cloned the `nim-waku` repository and installed all prerequisites as per [these instructions](https://github.com/status-im/nim-waku).
+
+Make the `chat2` target.
+
+```
+make chat2
+```
+
+## Basic application usage
+
+To start the `chat2` application in its most basic form, run the following from the project directory
+
+```
+./build/chat2
+```
+
+You should be prompted to provide a nickname for the chat session.
+
+```
+Choose a nickname >>
+```
+
+After entering a nickname, the app will randomly select and connect to a peer from the `sandbox` fleet.
+
+```
+No static peers configured. Choosing one at random from sandbox fleet...
+```
+
+It will then attempt to download historical messages from a random peer in the `sandbox` fleet.
+
+```
+Store enabled, but no store nodes configured. Choosing one at random from sandbox fleet...
+```
+
+Wait for the chat prompt (`>>`) and chat away!
+
+To gracefully exit the `chat2` application, use the `/exit` [in-chat option](#in-chat-options)
+
+```
+>> /exit
+quitting...
+```
+
+## Retrieving historical messages
+
+The `chat2` application can retrieve historical chat messages from a node supporting and running the [Waku v2 store protocol](https://rfc.vac.dev/spec/13/), and will attempt to do so by default.
+It's possible to query a *specific* store node by configuring its `multiaddr` as `storenode` when starting the app:
+
+```
+./build/chat2 --storenode:/dns4/node-01.do-ams3.waku.test.status.im/tcp/30303/p2p/16Uiu2HAkykgaECHswi3YKJ5dMLbq2kPVCo89fcyTd38UcQD6ej5W
+```
+
+Alternatively, the `chat2` application will select a random `storenode` for you from the configured fleet (`sandbox` by default) if `storenode` is left unspecified.
+
+```
+./build/chat2
+```
+
+To disable historical message retrieval, use the `--store:false` option:
+
+```
+./build/chat2 --store:false
+```
+
+## Specifying a static peer
+
+In order to connect to a *specific* node as [`relay`](https://rfc.vac.dev/spec/11/) peer, define that node's `multiaddr` as a `staticnode` when starting the app:
+
+```
+./build/chat2 --staticnode:/dns4/node-01.do-ams3.waku.test.status.im/tcp/30303/p2p/16Uiu2HAkykgaECHswi3YKJ5dMLbq2kPVCo89fcyTd38UcQD6ej5W
+```
+
+This will bypass the random peer selection process and connect to the specified node.
+
+## Connecting to a Waku v2 fleet
+
+It is possible to specify a specific Waku v2 fleet to connect to when starting the app by using the `--fleet` option:
+
+```
+./build/chat2 --fleet:test
+```
+
+There are currently two fleets to select from, namely _sandbox_ (`waku.sandbox`) and _test_ (`waku.test`).
+The `test` fleet is updated with each incremental change to the `nim-waku` codebase.
+As a result it may have more advanced and experimental features, but will be less stable than `sandbox`.
+The `sandbox` fleet is a deployed network of the latest released Waku v2 nodes.
+If no `fleet` is specified, `chat2` will connect to the `sandbox` fleet by default.
+To start `chat2` without connecting to a fleet, use the `--fleet:none` option _or_ [specify a static peer](#specifying-a-static-peer).
+
+## Specifying a content topic
+
+To publish chat messages on a specific [content topic](https://rfc.vac.dev/spec/14/#wakumessage), use the `--content-topic` option:
+
+```
+./build/chat2 --content-topic:/waku/2/my-content-topic/proto
+```
+
+> **NOTE:** Currently (2021/05/26) the content topic defaults to `/waku/2/huilong/proto` if left unspecified, where `huilong` is the name of our latest testnet.
+
+## In-chat options
+
+| Command | Effect |
+| --- | --- |
+| `/help` | displays available in-chat commands |
+| `/connect` | interactively connect to a new peer |
+| `/nick` | change nickname for current chat session |
+| `/exit` | exits the current chat session |
+
+## `chat2` message protobuf format
+
+Each `chat2` message is encoded as follows
+
+```protobuf
+message Chat2Message {
+ uint64 timestamp = 1;
+ string nick = 2;
+ bytes payload = 3;
+}
+```
+
+where `timestamp` is the Unix timestamp of the message, `nick` is the relevant `chat2` user's selected nickname and `payload` is the actual chat message being sent.
+The `payload` is the byte array representation of a UTF8 encoded string.
+
+# Bridge messages between `chat2` and matterbridge
+
+To facilitate `chat2` use in a variety of contexts, a `chat2bridge` can be deployed to bridge messages between `chat2` and any protocol supported by matterbridge.
+
+## Configure and run matterbridge
+
+1. Download and install [matterbridge](https://github.com/42wim/matterbridge) and configure an instance for the protocol(s) you want to bridge to.
+Basic configuration instructions [here](https://github.com/42wim/matterbridge/wiki/How-to-create-your-config)
+2. Configure the matterbridge API.
+This is used by the `chat2bridge` to relay `chat2` messages to and from matterbridge.
+Configuration instructions for the matterbridge API can be found [here](https://github.com/42wim/matterbridge/wiki/Api).
+The full matterbridge API specification can be found [here](https://app.swaggerhub.com/apis-docs/matterbridge/matterbridge-api/0.1.0-oas3).
+The template below shows an example of a `matterbridge.toml` configuration file for bridging `chat2` to Discord.
+Follow the matterbridge [Discord instructions](https://github.com/42wim/matterbridge/wiki/Section-Discord-%28basic%29) to configure your own `Token` and `Server`.
+```toml
+[discord.mydiscord]
+
+# You can get your token by following the instructions on
+# https://github.com/42wim/matterbridge/wiki/Discord-bot-setup.
+# If you want roles/groups mentions to be shown with names instead of ID,
+# you'll need to give your bot the "Manage Roles" permission.
+Token="MTk4NjIyNDgzNDcdOTI1MjQ4.Cl2FMZ.ZnCjm1XVW7vRze4b7Cq4se7kKWs-abD"
+
+Server="myserver" # picked from guilds the bot is connected to
+
+RemoteNickFormat="{NICK}@chat2: "
+
+[api.myapi]
+BindAddress="127.0.0.1:4242"
+Buffer=1000
+RemoteNickFormat="{NICK}@{PROTOCOL}"
+
+[[gateway]]
+name="gateway1"
+enable=true
+
+[[gateway.inout]]
+account="discord.mydiscord"
+channel="general"
+
+[[gateway.inout]]
+account="api.myapi"
+channel="api"
+```
+3. Run matterbridge using the configuration file created in the previous step.
+Note the API listening address and port in the matterbridge logs (configured as the `BindAddress` in the previous step).
+```
+./matterbridge -conf matterbridge.toml
+```
+```
+[0000] INFO api: Listening on 127.0.0.1:4242
+```
+## Configure and run `chat2bridge`
+1. From the `nim-waku` project directory, make the `chat2bridge` target
+```
+make chat2bridge
+```
+2. Run `chat2bridge` with the following configuration options:
+```
+--mb-host-address Listening address of the Matterbridge host
+--mb-host-port Listening port of the Matterbridge host
+--mb-gateway Matterbridge gateway
+```
+```
+./build/chat2bridge --mb-host-address=127.0.0.1 --mb-host-port=4242 --mb-gateway="gateway1"
+```
+Note that `chat2bridge` encompasses a full `wakunode2` which can be configured with the normal configuration parameters.
+For a full list of configuration options, run `--help`.
+```
+./build/chat2bridge --help
+```
+## Connect `chat2bridge` to a `chat2` network
+1. To bridge messages on an existing `chat2` network, connect to any relay peer(s) in that network from `chat2bridge`.
+This can be done by either specifying the peer(s) as a `--staticnode` when starting the `chat2bridge` or calling the [`post_waku_v2_admin_v1_peers`](https://rfc.vac.dev/spec/16/#post_waku_v2_admin_v1_peers) method on the JSON-RPC API.
+Note that the latter requires the `chat2bridge` to be run with `--rpc=true` and `--rpc-admin=true`.
+1. To bridge from a new `chat2` instance, simply specify the `chat2bridge` listening address as a `chat2` [static peer](#Specifying-a-static-peer).
diff --git a/third-party/nwaku/docs/tutorial/db-migration.md b/third-party/nwaku/docs/tutorial/db-migration.md
new file mode 100644
index 0000000..905d5d1
--- /dev/null
+++ b/third-party/nwaku/docs/tutorial/db-migration.md
@@ -0,0 +1,61 @@
+# Database Migration
+This tutorial explains the database migration process in nim-waku.
+
+# Contributors Guide
+## Database Migration Flow
+Nim-waku utilizes the built-in `user_version` variable that Sqlite provides for tracking the database versions.
+The [user_version](https://github.com/waku-org/nwaku/blob/master/waku/waku_archive/driver/sqlite_driver/migrations.nim) MUST be bumped up for every update on the database e.g, table schema/title change.
+Each update should be accompanied by a migration script to move the content of the old version of the database to the new version.
+The script MUST be added to the respective folder as explained in [Migration Folder Structure](#migration-folder-structure) with the proper naming as given in [ Migration Script Naming](#migration-file-naming).
+
+The migration is invoked whenever the database `user_version` is behind the target [user_version](https://github.com/waku-org/nwaku/blob/master/waku/waku_archive/driver/sqlite_driver/migrations.nim) indicated in the nim-waku application.
+The respective migration scripts located in the [migrations folder](https://github.com/waku-org/nwaku/tree/master/migrations) will be executed to upgrade the database from its old version to the target version.
+
+## Migration Folder Structure
+The [migrations folder](https://github.com/waku-org/nwaku/tree/master/migrations) is structured as below.
+
+```
+migrations/
+├── message_store
+│ ├── 00001_addMessageTable.up.sql
+│ ├── 00002_addSenderTimeStamp.up.sql
+│ ├── ...
+└── peer_store
+ └── 00001_addPeerTable.up.sql
+```
+
+
+
+The migration scripts are managed in two separate folders `message_store` and `peer_store`.
+The `message_store` folder contains the migration scripts related to the message store tables. Similarly, the `peer_store` folder contains the scripts relevant to the peer store tables.
+
+
+## Migration File Naming
+The files in [migrations folder](https://github.com/waku-org/nwaku/tree/master/migrations) MUST follow the following naming style in order to be properly included in the migration process.
+Files with invalid naming will be eliminated from the migration process.
+
+`_..sql`
+
+- `version number`: This number should match the target value of `user_version`.
+- `migration script description`: A short description of what the migration script does.
+- `up|down`: One of the keywords of `up` or `down` should be selected.
+ `up` stands for upgrade and `down` means downgrade.
+
+### Example
+A migration file with the name `00002_addTableX.up.sql` should be interpreted as:
+- `00002`: The targeted `user_version` number.
+- `addTableX`: What the script does.
+- `up`: This script `upgrade`s the database from `user_version = 00001` to the `user_version = 00002`.
+
+A downgrade migration file corresponding to the `00002_addTableX.up.sql` can be e.g., `00001_removeTableX.down.sql` and should be interpreted as:
+- `00001`: The targeted `user_version` number.
+- `removeTableX`: What the script does.
+- `down`: This script `downgrade`s the database from `user_version = 00002` to the `user_version = 00001`.
+
+There can be more than one migration file for the same `user_version`.
+The migration process will consider all such files while upgrading/downgrading the database.
+Note that currently we **DO NOT** support **down migration**.
+
+# User Guide
+Migrations work out of the box.
+However, if you want to be extra sure, please take a backup of the SQLite database prior to upgrading your nim-waku version since we currently don't support downgrades of DB.
diff --git a/third-party/nwaku/docs/tutorial/dingpu.md b/third-party/nwaku/docs/tutorial/dingpu.md
new file mode 100644
index 0000000..0d21978
--- /dev/null
+++ b/third-party/nwaku/docs/tutorial/dingpu.md
@@ -0,0 +1,44 @@
+# Dingpu testnet
+
+> TODO (2023-05-24): Deprecate or fix
+
+*NOTE: Some of these addresses might change. To get the latest, please see `curl -s https://fleets.status.im | jq '.fleets["waku.test"]'`*
+
+## Basic chat usage
+
+> If historical messaging is desired, the chat app requires that the remote peer specified in `storenode` option supports the WakuStore protocol. For the current cluster node deployed as part of Dingpu this is already the case.
+
+Start two chat apps:
+
+```
+./build/chat2 --ports-shift:0 --storenode:/ip4/178.128.141.171/tcp/60000/p2p/16Uiu2HAkykgaECHswi3YKJ5dMLbq2kPVCo89fcyTd38UcQD6ej5W --staticnode:/ip4/178.128.141.171/tcp/60000/p2p/16Uiu2HAkykgaECHswi3YKJ5dMLbq2kPVCo89fcyTd38UcQD6ej5W
+./build/chat2 --ports-shift:1 --storenode:/ip4/178.128.141.171/tcp/60000/p2p/16Uiu2HAkykgaECHswi3YKJ5dMLbq2kPVCo89fcyTd38UcQD6ej5W --staticnode:/ip4/178.128.141.171/tcp/60000/p2p/16Uiu2HAkykgaECHswi3YKJ5dMLbq2kPVCo89fcyTd38UcQD6ej5W
+```
+
+By specifying `staticnode` it connects to that node subscribes to the `waku` topic. This ensures messages are relayed properly.
+
+Then type messages to publish.
+
+## Interactively add a node
+
+There is also an interactive mode. Type `/connect` then paste address of other node. However, this currently has some timing issues with mesh not being updated, so it is advised not to use this until this has been addressed. See https://github.com/waku-org/nwaku/issues/231
+
+## Dingpu cluster node
+
+> TODO (2024-03-11): Fix node multiaddr
+
+## Run a node
+
+To just run a node and not interact on the chat it is enough to run `wakunode2`:
+```
+./build/wakunode2 --staticnode:
+```
+
+You can also run the `wakubridge` process, which runs both a Waku v1 and Waku v2
+node. Currently, it has the same effect as running a `wakunode` and `wakunode2`
+process separately, but bridging functionality will be added later to this
+application.
+
+```
+./build/wakubridge --staticnodev2: --fleetv1:test
+```
diff --git a/third-party/nwaku/docs/tutorial/dns-disc.md b/third-party/nwaku/docs/tutorial/dns-disc.md
new file mode 100644
index 0000000..c9cc24e
--- /dev/null
+++ b/third-party/nwaku/docs/tutorial/dns-disc.md
@@ -0,0 +1,69 @@
+# Waku v2 DNS-based Discovery Basic Tutorial
+
+## Background
+
+Waku v2 DNS discovery is a method by which a node may find other peers by retrieving an encoded node list via DNS.
+To achieve this, Waku v2 uses a Nim implementation of [EIP-1459](https://eips.ethereum.org/EIPS/eip-1459).
+According to EIP-1459, the peer list is encoded as a [Merkle tree](https://www.wikiwand.com/en/Merkle_tree) of TXT records.
+Connectivity information for each peer, including [wire address](https://docs.libp2p.io/concepts/addressing/) and [peer ID](https://docs.libp2p.io/concepts/peer-id/), are encapsulated in signed [Ethereum Node Records (ENR)](https://eips.ethereum.org/EIPS/eip-778).
+
+## Mapping ENR to `multiaddr`
+
+EIP-1459 DNS discovery is a scheme for retrieving an ENR list via DNS.
+Waku v2 addressing is based on [libp2p addressing](https://docs.libp2p.io/concepts/addressing/), which uses a `multiaddr` scheme.
+
+The ENR is constructed according to [EIP-778](https://eips.ethereum.org/EIPS/eip-778).
+It maps to the equivalent `libp2p` `multiaddr` for the Waku v2 node as follows:
+
+| ENR Key | ENR Value |
+|-------------|------------------------------------------------------------------------|
+| `id` | name of identity scheme. For Waku v2 generally `v4` |
+| `secp256k1` | the compressed `secp256k1` public key belong to the libp2p peer ID as per [specification](https://github.com/libp2p/specs/blob/master/peer-ids/peer-ids.md#keys). This is used to construct the `/p2p/` portion of the node's `multiaddr` |
+| ip | IPv4 address. Corresponds to `/ip4/` portion of the node's `multiaddr` |
+| tcp | TCP port. Corresponds to `/tcp/` portion of the node's `multiaddr` |
+
+The `nim-waku` implementation with integrated DNS discovery already takes care of the ENR to `multiaddr` conversion.
+
+## Usage
+
+Ensure you have built [`wakunode2`](https://github.com/status-im/nim-waku) or [`chat2`](./chat2.md) as per the linked instructions.
+
+The following command line options are available for both `wakunode2` or `chat2`.
+
+```
+--dns-discovery Enable DNS Discovery
+--dns-discovery-url URL for DNS node list in format 'enrtree://@'
+```
+
+- `--dns-discovery` is used to enable DNS discovery on the node. Waku DNS discovery is disabled by default.
+- `--dns-discovery-url` is mandatory if DNS discovery is enabled. It contains the URL for the node list. The URL must be in the format `enrtree://@` where `` is the fully qualified domain name and `` is the base32 encoding of the compressed 32-byte public key that signed the list at that location. See [EIP-1459](https://eips.ethereum.org/EIPS/eip-1459#specification) or the example below to illustrate.
+
+A node will attempt connection to all discovered nodes.
+
+## Example for `waku.test` fleet
+
+To illustrate the above and prove the concept,
+a list of `waku.test` fleet nodes was encoded according to EIP-1459 and deployed to `test.waku.nodes.status.im`.
+The list was signed by the public key `AOGYWMBYOUIMOENHXCHILPKY3ZRFEULMFI4DOM442QSZ73TT2A7VI`.
+The complete URL for DNS discovery is therefore: `enrtree://AOGYWMBYOUIMOENHXCHILPKY3ZRFEULMFI4DOM442QSZ73TT2A7VI@test.waku.nodes.status.im`.
+
+To run a `wakunode2` with DNS-based discovery of `waku.test` nodes:
+
+```
+./build/wakunode2 --dns-discovery:true --dns-discovery-url:enrtree://AOGYWMBYOUIMOENHXCHILPKY3ZRFEULMFI4DOM442QSZ73TT2A7VI@test.waku.nodes.status.im
+```
+
+Similarly, for `chat2`:
+
+```
+./build/chat2 --dns-discovery:true --dns-discovery-url:enrtree://AOGYWMBYOUIMOENHXCHILPKY3ZRFEULMFI4DOM442QSZ73TT2A7VI@test.waku.nodes.status.im
+```
+
+The node will discover and attempt connection to all `waku.test` nodes during setup procedures.
+
+To use specific DNS name servers, one or more `--dns-addrs-name-server` arguments can be added:
+
+```
+./build/wakunode2 --dns-discovery:true --dns-discovery-url:enrtree://AOGYWMBYOUIMOENHXCHILPKY3ZRFEULMFI4DOM442QSZ73TT2A7VI@test.waku.nodes.status.im --dns-dis
+covery-name-server:8.8.8.8 --dns-addrs-name-server:8.8.4.4
+```
diff --git a/third-party/nwaku/docs/tutorial/filter.md b/third-party/nwaku/docs/tutorial/filter.md
new file mode 100644
index 0000000..2f1a423
--- /dev/null
+++ b/third-party/nwaku/docs/tutorial/filter.md
@@ -0,0 +1,35 @@
+# Running Filter Protocol
+
+> TODO (2023-05-24): Deprecate or fix
+
+## How to
+
+Build:
+
+```
+# make wakunode2 is run as part of scripts2 target
+make scripts2
+```
+
+Run two nodes and connect them:
+
+```
+# Starts listening on 60000 with RPC server on 8545.
+# Note the "listening on address" in logs.
+./build/wakunode2 --ports-shift:0
+
+# Run another node with staticnode argument
+./build/wakunode2 --ports-shift:1 --staticnode:/ip4/0.0.0.0/tcp/60000/p2p/16Uiu2HAmF4tuht6fmna6uDqoSMgFqhUrdaVR6VQRyGr6sCpfS2jp --filternode:/ip4/0.0.0.0/tcp/60000/p2p/16Uiu2HAmF4tuht6fmna6uDqoSMgFqhUrdaVR6VQRyGr6sCpfS2jp
+```
+
+You should see your nodes connecting.
+
+Do basic RPC calls:
+
+```
+./build/rpc_subscribe 8545
+./build/rpc_subscribe_filter 8546 # enter your content topic; default is "1"
+./build/rpc_publish 8545 # enter your message in STDIN
+```
+
+You should see other node receive something.
diff --git a/third-party/nwaku/docs/tutorial/heaptrack.md b/third-party/nwaku/docs/tutorial/heaptrack.md
new file mode 100644
index 0000000..d651489
--- /dev/null
+++ b/third-party/nwaku/docs/tutorial/heaptrack.md
@@ -0,0 +1,114 @@
+# Heaptrack in Nim Waku
+
+## Background
+Given that RAM is a limited resource, it is crucial to have a good insight on what is going on with the memory used by a particular process.
+
+## Heaptrack
+Heaptrack is a tool that allows to generate memory usage reports.
+It operates in two modes:
+- preload: the tracking is made from the beginning.
+- inject: the tracking starts at a certain time by attaching to a running process.
+
+### Building Heaptrack (tried on Ubuntu)
+- `git clone git@github.com:KDE/heaptrack.git`
+- `mkdir build; cd build`
+- `cmake ..`
+ At this point, make sure the cmake doesn't complain about any missing dependency.
+ Among others, the most tricky deps are obtained by the next commands:
+ - `sudo apt install libkf5i18n-dev`
+ - `sudo apt install libkf5itemmodels-dev`
+ - `sudo apt install libkf5threadweaver-dev`
+ - `sudo apt install libkf5service-dev`
+ - `sudo apt install libkf5completion-dev`
+ - `sudo apt install libkf5itemviews-dev`
+ - `sudo apt install libkf5jobwidgets-dev`
+ - `sudo apt install libkf5solid-dev`
+ - `sudo apt install libkf5coreaddons-dev`
+ - `sudo apt install libkf5auth-dev`
+ - `sudo apt install libkf5codecs-dev`
+ - `sudo apt install libkf5configwidgets-dev`
+ - `sudo apt install libkf5xmlgui-dev`
+ - `sudo apt install libkf5widgetsaddons-dev`
+ - `sudo apt install libqt5gui5`
+ - `sudo apt install libkf5kio-dev`
+ - `sudo apt install libkf5iconthemes-dev`
+- `make`
+- On completion, the `bin/heaptrack_gui` and `bin/heaptrack` binaries will be generated.
+ - heaptrack: needed to generate the report.
+ - heaptrack_gui: needed to analyse the report.
+
+## Heaptrack & Nwaku
+nwaku supports heaptrack, but it needs a special compilation setting.
+
+### Patch Nim compiler to register allocations on Heaptrack
+
+Currently, we rely on the official Nim repository. So we need to patch the Nim compiler to register allocations and deallocations on Heaptrack.
+For Nim 2.2.4 version, we created a patch that can be applied as:
+```bash
+git apply --directory=vendor/nimbus-build-system/vendor/Nim docs/tutorial/nim.2.2.4_heaptracker_addon.patch
+git add .
+git commit -m "Add heaptrack support to Nim compiler - temporary patch"
+```
+
+> Until heaptrack support is not available in official Nim, so it is important to keep it in the `nimbus-build-system` repository.
+> Commit ensures that `make update` will not override the patch unintentionally.
+
+> We are planning to make it available through an official PR for Nim.
+
+When the patch is applied, we can build wakunode2 with heaptrack support.
+
+### Build nwaku with heaptrack support
+
+`make -j HEAPTRACKER=1 wakunode2`
+
+### Create nwaku memory report with heaptrack
+
+nwaku only works correctly with heaptrack operating in 'preload' mode, i.e. the memory is tracked from the beginning.
+To achieve this, the `heaptrack` binary should be prepended to the usual `wakunode`:
+
+e.g.:
+`/build/bin/heaptrack /build/wakunode2 ...`
+
+While the above is running, a file with the next format is being populated with allocs/deallocs stats in the current folder:
+
+ ```
+ heaptrack...gz
+e.g.:
+ heaptrack.wakunode2.23125.gz
+ ```
+
+### Build a Docker image with Heaptrack + Nim Waku
+Having Docker properly installed in your machine, do the next:
+
+- cd to the `nwaku` root folder.
+- ```sudo make docker-image DOCKER_IMAGE_NAME=docker_repo:docker_tag HEAPTRACKER=1```
+- alternatively you can use the `docker-quick-image` target, this is faster but creates an ubuntu based image, so your local build environment must match.
+
+That will create a Docker image with both nwaku and heaptrack. The container's entry point is `ENTRYPOINT ["/heaptrack/build/bin/heaptrack", "/usr/bin/wakunode"]`, so the memory report starts being generated from the beginning.
+
+#### Notice for using heaptrack supporting image with `docker compose`
+
+Take care that wakunode2 should be started as
+```
+exec /heaptrack/build/bin/heaptrack /usr/bin/wakunode\
+... all the arguments you want to pass to wakunode ...
+```
+
+### Extract report file from a running Docker container
+Bear in mind that if you restart the container, the previous report will get lost. Therefore, before restarting, it is important to extract it from the container once you consider it has enough information.
+
+While the Docker container is running, run the next command:
+```
+sudo docker cp 768e7de52d3c:/heaptrack.wakunode.1.gz .
+```
+(replace the 768.. with your docker container id.).
+
+### Analyse a heaptrack report
+```
+/bin/heaptrack_gui heaptrack.wakunode.1.gz
+```
+
+You should be able to see memory allocations. It is important
+to see a legend like shown below:
+
+
diff --git a/third-party/nwaku/docs/tutorial/imgs/good_heaptrack_report_example.png b/third-party/nwaku/docs/tutorial/imgs/good_heaptrack_report_example.png
new file mode 100644
index 0000000..088ef51
Binary files /dev/null and b/third-party/nwaku/docs/tutorial/imgs/good_heaptrack_report_example.png differ
diff --git a/third-party/nwaku/docs/tutorial/imgs/infura-dashboard-mainnet.png b/third-party/nwaku/docs/tutorial/imgs/infura-dashboard-mainnet.png
new file mode 100644
index 0000000..c5cf2df
Binary files /dev/null and b/third-party/nwaku/docs/tutorial/imgs/infura-dashboard-mainnet.png differ
diff --git a/third-party/nwaku/docs/tutorial/imgs/infura-dashboard.png b/third-party/nwaku/docs/tutorial/imgs/infura-dashboard.png
new file mode 100644
index 0000000..5b2a846
Binary files /dev/null and b/third-party/nwaku/docs/tutorial/imgs/infura-dashboard.png differ
diff --git a/third-party/nwaku/docs/tutorial/imgs/infura-endpoints.png b/third-party/nwaku/docs/tutorial/imgs/infura-endpoints.png
new file mode 100644
index 0000000..86ce254
Binary files /dev/null and b/third-party/nwaku/docs/tutorial/imgs/infura-endpoints.png differ
diff --git a/third-party/nwaku/docs/tutorial/imgs/infura-key.png b/third-party/nwaku/docs/tutorial/imgs/infura-key.png
new file mode 100644
index 0000000..020ca0c
Binary files /dev/null and b/third-party/nwaku/docs/tutorial/imgs/infura-key.png differ
diff --git a/third-party/nwaku/docs/tutorial/imgs/rln-relay-chat2-overview.png b/third-party/nwaku/docs/tutorial/imgs/rln-relay-chat2-overview.png
new file mode 100644
index 0000000..5208963
Binary files /dev/null and b/third-party/nwaku/docs/tutorial/imgs/rln-relay-chat2-overview.png differ
diff --git a/third-party/nwaku/docs/tutorial/nangang.md b/third-party/nwaku/docs/tutorial/nangang.md
new file mode 100644
index 0000000..1c40701
--- /dev/null
+++ b/third-party/nwaku/docs/tutorial/nangang.md
@@ -0,0 +1,42 @@
+# Nangang Test
+
+> TODO (2023-05-24): Deprecate or fix
+
+Nangang is the first internal testnet. See
+https://github.com/vacp2p/research/issues/43 for more.
+
+## How to
+
+Build:
+
+```
+# make wakunode2 is run as part of scripts2 target
+make scripts2
+```
+
+Run two nodes and connect them:
+
+```
+# Starts listening on 60000 with RPC server on 8545.
+# Note the "listening on address" in logs.
+./build/wakunode2 --ports-shift:0
+
+# Run another node with staticnode argument
+./build/wakunode2 --ports-shift:1 --staticnode:/ip4/0.0.0.0/tcp/60000/p2p/16Uiu2HAmF4tuht6fmna6uDqoSMgFqhUrdaVR6VQRyGr6sCpfS2jp
+```
+
+You should see your nodes connecting.
+
+Do basic RPC calls:
+
+```
+./build/rpc_subscribe 8545
+./build/rpc_subscribe 8546
+./build/rpc_publish 8545 # enter your message in STDIN
+```
+
+You should see other node receive something.
+
+## Nangang cluster node
+
+> TODO (2024-03-11): Fix node multiaddr
diff --git a/third-party/nwaku/docs/tutorial/nim.2.2.4_heaptracker_addon.patch b/third-party/nwaku/docs/tutorial/nim.2.2.4_heaptracker_addon.patch
new file mode 100644
index 0000000..3cd3384
--- /dev/null
+++ b/third-party/nwaku/docs/tutorial/nim.2.2.4_heaptracker_addon.patch
@@ -0,0 +1,44 @@
+diff --git a/lib/system/alloc.nim b/lib/system/alloc.nim
+index e2dd43075..7f8c8e04e 100644
+--- a/lib/system/alloc.nim
++++ b/lib/system/alloc.nim
+@@ -1,4 +1,4 @@
+-#
++#!fmt: off
+ #
+ # Nim's Runtime Library
+ # (c) Copyright 2012 Andreas Rumpf
+@@ -862,6 +862,15 @@ when defined(gcDestructors):
+ dec maxIters
+ if it == nil: break
+
++when defined(heaptracker):
++ const heaptrackLib =
++ when defined(heaptracker_inject):
++ "libheaptrack_inject.so"
++ else:
++ "libheaptrack_preload.so"
++ proc heaptrack_malloc(a: pointer, size: int) {.cdecl, importc, dynlib: heaptrackLib.}
++ proc heaptrack_free(a: pointer) {.cdecl, importc, dynlib: heaptrackLib.}
++
+ proc rawAlloc(a: var MemRegion, requestedSize: int): pointer =
+ when defined(nimTypeNames):
+ inc(a.allocCounter)
+@@ -984,6 +993,8 @@ proc rawAlloc(a: var MemRegion, requestedSize: int): pointer =
+ sysAssert(isAccessible(a, result), "rawAlloc 14")
+ sysAssert(allocInv(a), "rawAlloc: end")
+ when logAlloc: cprintf("var pointer_%p = alloc(%ld) # %p\n", result, requestedSize, addr a)
++ when defined(heaptracker):
++ heaptrack_malloc(result, requestedSize)
+
+ proc rawAlloc0(a: var MemRegion, requestedSize: int): pointer =
+ result = rawAlloc(a, requestedSize)
+@@ -992,6 +1003,8 @@ proc rawAlloc0(a: var MemRegion, requestedSize: int): pointer =
+ proc rawDealloc(a: var MemRegion, p: pointer) =
+ when defined(nimTypeNames):
+ inc(a.deallocCounter)
++ when defined(heaptracker):
++ heaptrack_free(p)
+ #sysAssert(isAllocatedPtr(a, p), "rawDealloc: no allocated pointer")
+ sysAssert(allocInv(a), "rawDealloc: begin")
+ var c = pageAddr(p)
diff --git a/third-party/nwaku/docs/tutorial/onchain-rln-relay-chat2.md b/third-party/nwaku/docs/tutorial/onchain-rln-relay-chat2.md
new file mode 100644
index 0000000..ac2bdc3
--- /dev/null
+++ b/third-party/nwaku/docs/tutorial/onchain-rln-relay-chat2.md
@@ -0,0 +1,232 @@
+# Spam-protected chat2 application with on-chain group management
+
+This document is a tutorial on how to run the chat2 application in the spam-protected mode using the Waku-RLN-Relay protocol and with dynamic/on-chain group management.
+In the on-chain/dynamic group management, the state of the group members i.e., their identity commitment keys is moderated via a membership smart contract deployed on the Linea Sepolia network which is one of the test-nets.
+Members can be dynamically added to the group and the group size can grow up to 2^20 members.
+This differs from the prior test scenarios in which the RLN group was static and the set of members' keys was hardcoded and fixed.
+
+
+## Prerequisites
+To complete this tutorial, you will need
+
+1. An rln keystore file with credentials to the rln membership smart contract you wish to use. You may obtain this by registering to the smart contract and generating a keystore, or by using the [rln-keystore-generator](./rln-keystore-generator.md) which does that for you.
+
+
+## Overview
+Figure 1 provides an overview of the interaction of the chat2 clients with the test fleets and the membership contract.
+At a high level, when a chat2 client is run with Waku-RLN-Relay mounted in on-chain mode.
+
+Under the hood, the chat2 client constantly listens to the membership contract and keeps itself updated with the latest state of the group.
+
+In the following test setting, the chat2 clients are to be connected to the Waku test fleets as their first hop.
+The test fleets will act as routers and are also set to run Waku-RLN-Relay over the same pubsub topic and content topic as chat2 clients i.e., the default pubsub topic of `/waku/2/rs/0/0` and the content topic of `/toy-chat/3/mingde/proto`.
+Spam messages published on the said combination of topics will be caught by the test fleet nodes and will not be routed.
+Note that spam protection does not rely on the presence of the test fleets.
+In fact, all the chat2 clients are also capable of catching and dropping spam messages if they receive any.
+You can test it by connecting two chat2 clients (running Waku-RLN-Relay) directly to each other and see if they can spot each other's spam activities.
+
+ 
+ Figure 1.
+
+# Set up
+## Build chat2
+First, build chat2
+
+```bash
+make chat2
+```
+
+## Set up a chat2 client
+
+Run the following command to set up your chat2 client.
+
+```bash
+./build/chat2 --fleet:test \
+--content-topic:/toy-chat/3/mingde/proto \
+--rln-relay:true \
+--rln-relay-dynamic:true \
+--rln-relay-eth-contract-address:0xB9cd878C90E49F797B4431fBF4fb333108CB90e6 \
+--rln-relay-cred-path:xxx/xx/rlnKeystore.json \
+--rln-relay-cred-password:xxxx \
+--rln-relay-eth-client-address:xxxx \
+--ports-shift:1
+```
+
+In this command
+- the `--fleet:test` indicates that the chat2 app gets connected to the test fleets.
+- the `toy-chat/3/mingde/proto` passed to the `content-topic` option indicates the content topic on which the chat2 application is going to run.
+- the `rln-relay` flag is set to `true` to enable the Waku-RLN-Relay protocol for spam protection.
+- the `--rln-relay-dynamic` flag is set to `true` to enable the on-chain mode of Waku-RLN-Relay protocol with dynamic group management.
+- the `--rln-relay-eth-contract-address` option gets the address of the membership contract.
+ The current address of the contract is `0xB9cd878C90E49F797B4431fBF4fb333108CB90e6`.
+ You may check the state of the contract on the [Linea Sepolia testnet](https://sepolia.lineascan.build/address/0xB9cd878C90E49F797B4431fBF4fb333108CB90e6).
+- the `--rln-relay-cred-path` option denotes the path to the keystore file described above
+- the `--rln-relay-cred-password` option denotes the password to the keystore
+- the `rln-relay-eth-client-address` is the WebSocket address of the hosted node on the Linea Sepolia testnet.
+ You need to replace the `xxxx` with the actual node's address.
+
+For `rln-relay-eth-client-address`, if you do not know how to obtain it, you may use the following tutorial on the [prerequisites of running on-chain spam-protected chat2](./pre-requisites-of-running-on-chain-spam-protected-chat2.md).
+
+You may set up more than one chat client,
+just make sure that you increment the `--ports-shift` value for each new client you set up e.g., `--ports-shift=2`.
+
+Once you run the command, you are asked to choose your nickname:
+```
+Choose a nickname >> Alice
+```
+
+then you will see a couple of other messages related to setting up the connections of your chat app,
+the content may differ on your screen though:
+```
+Connecting to test fleet using DNS discovery...
+Discovered and connecting to @[16Uiu2HAkzHaTP5JsUwfR9NR8Rj9HC24puS6ocaU8wze4QrXr9iXp, 16Uiu2HAkykgaECHswi3YKJ5dMLbq2kPVCo89fcyTd38UcQD6ej5W, 16Uiu2HAmDCp8XJ9z1ev18zuv8NHekAsjNyezAvmMfFEJkiharitG]
+Listening on
+ /ip4/75.157.120.249/tcp/60001/p2p/16Uiu2HAmQXuZmbjFWGagthwVsPFrc5ZrZ9c53qdUA45TWoZaokQn
+Store enabled, but no store nodes configured. Choosing one at random from discovered peers
+Connecting to storenode: 16Uiu2HAkzHaTP5JsUwfR9NR8Rj9HC24puS6ocaU8wze4QrXr9iXp
+```
+You will also see some historical messages being fetched, again the content may be different on your end:
+
+```
+ Bob: hi
+ Bob: hi
+ Alice: spam1
+ Alice: hiiii
+ Alice: hello
+ Bob: hi
+ Bob: hi
+ Alice: hi
+ b: hi
+ h: hi
+...
+```
+
+Next, you see the following message:
+```
+rln-relay preparation is in progress ...
+```
+Also, the registered RLN identity key, the RLN identity commitment key, and the index of the registered credential will be displayed as given below.
+Note that in the figure, the RLN identity key is not shown for security reasons (replaced by a string of `x`s).
+But, you will see your RLN identity key.
+
+```
+your membership index is: xx
+your RLN identity key is: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+your RLN identity commitment key is: 6c6598126ba10d1b70100893b76d7f8d7343eeb8f5ecfd48371b421c5aa6f012
+```
+
+Finally, the chat prompt `>>` will appear which means your chat2 client is ready.
+Once you type a chat line and hit enter, you will see a message that indicates the epoch at which the message is sent e.g.,
+
+```
+>> Hi
+--rln epoch: 165886530
+ Alice: Hi
+```
+The numerical value `165886530` indicates the epoch of the message `Hi`.
+You will see a different value than `165886530` on your screen.
+If two messages sent by the same chat2 client happen to have the same RLN epoch value, then one of them will be detected as spam and won't be routed (by test fleets in this test setting).
+At the time of this tutorial, the epoch duration is set to `10` seconds.
+You can inspect the current epoch value by checking the following [constant variable](https://github.com/waku-org/nwaku/blob/44c543129ee4149255a00a05f1e7d21f8fa28626/waku/v2/waku_rln_relay/constants.nim#L51) in the nim-waku codebase.
+Thus, if you send two messages less than `10` seconds apart, they are likely to get the same `rln epoch` values.
+
+After sending a chat message, you may experience some delay before the next chat prompt appears.
+The reason is that under the hood a zero-knowledge proof is being generated and attached to your message.
+
+
+Try to spam the network by violating the message rate limit i.e.,
+sending more than one message per epoch.
+Your messages will be routed via test fleets that are running in spam-protected mode over the same content topic i.e., `/toy-chat/3/mingde/proto` as your chat client.
+Your spam activity will be detected by them and your message will not reach the rest of the chat clients.
+You can check this by running a second chat user and verifying that spam messages are not displayed as they are filtered by the test fleets.
+Furthermore, the chat client will prompt you with the following warning message indicating that the message rate is being violated:
+```
+⚠️ message rate violation! you are spamming the network!
+```
+A sample test scenario is illustrated in the [Sample test output section](#sample-test-output).
+
+Once you are done with the test, make sure you close all the chat2 clients by typing the `/exit` command.
+```
+>> /exit
+quitting...
+```
+
+
+# Sample test output
+In this section, a sample test of running two chat clients is provided.
+Note that the value used for `rln-relay-eth-client-address` in the following code snippets is junk and not valid.
+
+The two chat clients namely `Alice` and `Bob` are connected to the test fleets.
+`Alice` sends 4 messages i.e., `message1`, `message2`, `message3`, and `message4`.
+However, only three of them reach `Bob`.
+This is because the two messages `message2` and `message3` have identical RLN epoch values, so, one of them gets discarded by the test fleets as a spam message.
+The test fleets do not relay `message3` further, hence `Bob` never receives it.
+You can check this fact by looking at `Bob`'s console, where `message3` is missing.
+
+
+**Alice**
+```bash
+./build/chat2 --fleet:test --content-topic:/toy-chat/3/mingde/proto --rln-relay:true --rln-relay-dynamic:true --rln-relay-eth-contract-address:0xB9cd878C90E49F797B4431fBF4fb333108CB90e6 --rln-relay-cred-path:rlnKeystore.json --rln-relay-cred-password:password --rln-relay-eth-client-address:https://sepolia.infura.io/v3/12345678901234567890123456789012 --ports-shift=1
+```
+
+```
+Choose a nickname >> Alice
+Welcome, Alice!
+Connecting to test fleet using DNS discovery...
+Discovered and connecting to @[16Uiu2HAkzHaTP5JsUwfR9NR8Rj9HC24puS6ocaU8wze4QrXr9iXp, 16Uiu2HAkykgaECHswi3YKJ5dMLbq2kPVCo89fcyTd38UcQD6ej5W, 16Uiu2HAmDCp8XJ9z1ev18zuv8NHekAsjNyezAvmMfFEJkiharitG]
+Listening on
+ /ip4/75.157.120.249/tcp/60001/p2p/16Uiu2HAmH7XbkcdbA1CCs91r93HuwZHSdXppCNvJTDVvgGhuxyuG
+Store enabled, but no store nodes configured. Choosing one at random from discovered peers
+Connecting to storenode: 16Uiu2HAkzHaTP5JsUwfR9NR8Rj9HC24puS6ocaU8wze4QrXr9iXp
+ Bob: hi
+ Bob: hi
+ Alice: spam1
+ Alice: hiiii
+ Alice: hello
+ Bob: hi
+ Bob: hi
+ Alice: hi
+ b: hi
+ h: hi
+rln-relay preparation is in progress ...
+your membership index is: xx
+your rln identity key is: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+your rln identity commitment key is: bd093cbf14fb933d53f596c33f98b3df83b7e9f7a1906cf4355fac712077cb28
+>> message1
+--rln epoch: 165886591
+ Alice: message1
+>> message2
+--rln epoch: 165886592
+ Alice: message2
+>> message3
+--rln epoch: 165886592 ⚠️ message rate violation! you are spamming the network!
+ Alice: message3
+>> message4
+--rln epoch: 165886593
+ Alice: message4
+>>
+```
+
+**Bob**
+```bash
+./build/chat2 --fleet:test --content-topic:/toy-chat/3/mingde/proto --rln-relay:true --rln-relay-dynamic:true --rln-relay-eth-contract-address:0xB9cd878C90E49F797B4431fBF4fb333108CB90e6 --rln-relay-cred-path:rlnKeystore.json --rln-relay-cred-index:1 --rln-relay-cred-password:password --rln-relay-eth-client-address:https://sepolia.infura.io/v3/12345678901234567890123456789012 --ports-shift=2
+```
+
+```
+Choose a nickname >> Bob
+Welcome, Bob!
+Connecting to test fleet using DNS discovery...
+Discovered and connecting to @[16Uiu2HAkzHaTP5JsUwfR9NR8Rj9HC24puS6ocaU8wze4QrXr9iXp, 16Uiu2HAkykgaECHswi3YKJ5dMLbq2kPVCo89fcyTd38UcQD6ej5W, 16Uiu2HAmDCp8XJ9z1ev18zuv8NHekAsjNyezAvmMfFEJkiharitG]
+Listening on
+ /ip4/75.157.120.249/tcp/60002/p2p/16Uiu2HAmE7fPUWGJ7UFJ3p2a3RNiEtEvAWhpfUStcCDmVGhm4h4Z
+Store enabled, but no store nodes configured. Choosing one at random from discovered peers
+Connecting to storenode: 16Uiu2HAkzHaTP5JsUwfR9NR8Rj9HC24puS6ocaU8wze4QrXr9iXp
+rln-relay preparation is in progress ...
+your membership index is: xx
+your rln identity key is: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+your rln identity commitment key is: d4961a7681521730bc7f9ade185c632b94b70624b2e87e21a97c07b83353f306
+>> Alice: message1
+>> Alice: message2
+>> Alice: message4
+>>
+```
diff --git a/third-party/nwaku/docs/tutorial/pre-requisites-of-running-on-chain-spam-protected-chat2.md b/third-party/nwaku/docs/tutorial/pre-requisites-of-running-on-chain-spam-protected-chat2.md
new file mode 100644
index 0000000..f1757ad
--- /dev/null
+++ b/third-party/nwaku/docs/tutorial/pre-requisites-of-running-on-chain-spam-protected-chat2.md
@@ -0,0 +1,104 @@
+In this tutorial you will learn how to:
+1. Create a Sepolia Ethereum account and obtain its private key.
+2. Obtain Sepolia ETH from faucet.
+3. Access a node on the Sepolia testnet using Infura.
+
+## 1. Create a Sepolia Ethereum account and obtain its private key
+
+> _**WARNING:**_ The private key is used elsewhere by Waku RLN registration tools to assist with membership registration in the Sepolia test network.
+> We strongly recommend that you create an account only for this purpose.
+> NEVER expose a private key that controls any valuable assets or funds.
+
+1. Download and install Metamask. [https://metamask.io/download/](https://metamask.io/download/)
+ If you already have Metamask installed, go to step 3.
+ If you encounter any issues during the Metamask setup process, please refer to the [official Metamask support page](https://support.metamask.io/hc/en-us).
+2. Create a new wallet and save your secret recovery phrase.
+
+ 
+
+3. Login to Metamask.
+
+ 
+
+4. By default, Metamask connects to the Ethereum Mainnet (dropdown menu in the top right corner).
+
+ 
+
+ To publish messages to the Waku Network, you need to connect to the Sepolia test network.
+5. Switch to the Sepolia test network by selecting it from the dropdown menu. Ensure "Show test networks" is enabled.
+
+ 
+
+ The same account can be used with different networks. Note that the ETH balance is different for each network (each has its own native token).
+
+ 
+
+6. To view the private key for this account, click on the three dots next to the account name and select "Account Details".
+
+ 
+
+ Select "Show Private Key".
+
+ 
+
+ Enter your Metamask password and click "Confirm"
+
+ 
+
+ You will be shown the private key.
+
+## 2. Obtain Sepolia ETH from faucet
+
+Sepolia ETH can be obtained from different faucets.
+Three popular examples include:
+
+ 1. [sepoliafaucet.com](https://sepoliafaucet.com/) (requires an Alchemy account)
+ 2. [Infura Sepolia faucet](https://www.infura.io/faucet/sepolia) (requires an Infura account)
+ 3. [Sepolia POW faucet](https://sepolia-faucet.pk910.de/)
+
+> _**NOTE:**_ This list is provided for convenience. We do not necessarily recommend or guarantee the security of any of these options.
+
+Many faucets limit the amount of Sepolia ETH you can obtain per day.
+We include instructions for [sepolia-faucet.pk910.de](https://sepolia-faucet.pk910.de/) as an example:
+
+1. Enter your Sepolia Ethereum account public address, solve the Captcha and start mining.
+
+ 
+
+2. Keep the browser tab open for a while. You can see the estimated Sepolia ETH mined per hour.
+
+ 
+
+ Each session is limited to a few hours.
+3. When you've mined enough Sepolia ETH (minimum of 0.05 Sepolia ETH), click on "Stop Mining" and claim your reward.
+
+ 
+
+## 3. Access a node on the Sepolia testnet using Infura
+
+> _**NOTE:**_ Infura provides a simple way of setting up endpoints for interaction with the Ethereum chain and the Waku RLN smart contract without having to run a dedicated Ethereum node.
+> Setting up Infura is not mandatory. Operators concerned with the centralized aspect introduced by Infura should use their own node.
+
+1. Sign up for Infura if you do not have an account already. [https://infura.io/register](https://infura.io/register)
+
+ 
+
+ Follow the instructions to register and verify the account.
+
+2. An API Key named "My First Key" should be auto-generated. Click on it, otherwise click on the "Create New API Key" button.
+
+ 
+
+
+3. You will be presented with a dashboard for your new key. Make sure to have Ethereum Sepolia's checkbox selected in the Networks section.
+
+ 
+
+
+4. Select the "Sepolia" endpoint in the Ethereum menu.
+
+ 
+
+ Both Https and WebSockets endpoints are available. Waku requires the Https endpoint.
+
+5. Copy the address (starting with `https://sepolia.infura`) as needed when setting up your Waku node.
diff --git a/third-party/nwaku/docs/tutorial/rln-chat-cross-client.md b/third-party/nwaku/docs/tutorial/rln-chat-cross-client.md
new file mode 100644
index 0000000..837bf89
--- /dev/null
+++ b/third-party/nwaku/docs/tutorial/rln-chat-cross-client.md
@@ -0,0 +1,33 @@
+# Waku-RLN-Relay Testnet2: Cross-Client
+
+In this tutorial, the aim is to test the interoperability of the 3 available Waku v2 clients namely, Nim, Go, and JS over the Waku network in the spam-protected mode.
+Spam protection is done by rate-limiting each message publisher.
+At the time of this tutorial, the messaging rate is set to `1` per Epoch where Epoch duration is set to `10` seconds.
+You will find more about the details of spam protection in the chat clients tutorial provided below.
+Messaging rate/spam protection is enabled through [Waku-RLN-Relay protocol](https://rfc.vac.dev/spec/17/) that is mounted on the routing hops.
+For ease of demonstration, we make use of Nim-chat, Go-chat, and JS-chat applications that are developed on top of their respective Waku v2 clients.
+
+You need to set up a chat application in spam-protected mode and then start messaging with it.
+As for the setup, please follow the tutorials below:
+- [Nim-chat](./onchain-rln-relay-chat2.md)
+- [Go-chat](https://github.com/waku-org/go-waku/blob/master/docs/tutorials/rln.md)
+- [JS-chat](https://examples.waku.org/rln-js/)
+
+Once you set up your chat client, it will be connected to the Waku v2 test fleets as its first hop.
+Messages generated by the chat client are set to be published on a specific combination of pubsub and content topic i.e., the default pubsub topic of `/waku/2/rs/0/0` and the content topic of `/toy-chat/3/mingde/proto`.
+The test fleets also run Waku-RLN-Relay over the same pubsub topic and content topic.
+Test fleets act as routers and enforce the message rate limit.
+As such, any spam messages published by a chat client on the said combination of topics will be caught by the Waku v2 test fleet nodes and will not be routed.
+You may also run multiple chat instances from the same or different client implementations to better observe the spam protection done by the Waku v2 test fleets.
+Note that spam protection does not rely on the presence of the test fleets.
+In fact, all the chat clients (except js-chat as it is in progress) are also capable of catching and dropping spam messages if they receive any.
+You can test it by connecting two chat clients (running Waku-RLN-Relay) directly to each other and see if they can spot each other's spam activities.
+
+Note: JS-chat will use the [WAKU2-LIGHTPUSH protocol](https://rfc.vac.dev/spec/19/) to push its messages to the Waku v2 test fleets.
+Waku v2 test fleets will act according to the WAKU2-LIGHTPUSH specifications and push that message to the network without any further verification.
+That is, they do not enforce spam protection in that specific protocol but rather act merely as a message publisher (this behavior may change in the future though).
+As such, you can expect to receive spam messages published by the JS-chat clients from other connecting chat clients i.e., Go-chat and Nim-chat.
+However, you will see that such messages will be immediately identified as spam on those clients and a proper message will be displayed on the console.
+
+
+You can also find a recorded demo of this testnet in the following [video](https://drive.proton.me/urls/EC4G8SY2J8#ie92Wtje1f4O).
\ No newline at end of file
diff --git a/third-party/nwaku/docs/tutorial/rln-chat2-live-testnet.md b/third-party/nwaku/docs/tutorial/rln-chat2-live-testnet.md
new file mode 100644
index 0000000..c874294
--- /dev/null
+++ b/third-party/nwaku/docs/tutorial/rln-chat2-live-testnet.md
@@ -0,0 +1,125 @@
+# Communicating with waku2 test fleets using chat2 application in spam-protected mode
+
+This document is a tutorial on how to run chat2 in spam-protected/rate-limited mode using the waku-RLN-Relay protocol on a designated content topic `/toy-chat/3/mingde/proto`.
+You will connect your chat2 client to waku2 test fleets.
+Note that test fleets will not filter spam messages, they merely route messages.
+Spam detection takes place at the chat2 users end.
+In this setting, you should try to spam the network by violating the message rate limit i.e.,
+sending more than one message per epoch.
+At the time of this tutorial, the epoch duration is set to `10` seconds.
+You can inspect the current epoch value by checking the following [constant variable](https://github.com/status-im/nim-waku/blob/21cac6d491a6d995a7a8ba84c85fecc7817b3d8b/waku/v2/protocol/waku_rln_relay/constants.nim#L245) in the nim-waku codebase.
+Your messages will be routed via test fleets and will arrive at other live chat2 clients that are running in rate-limited mode over the same content topic i.e., `/toy-chat/3/mingde/proto`.
+Your spam activity will be detected by them and a proper message will be shown on their console.
+
+# Set up
+## Build chat2
+First, build chat2
+
+```
+make chat2
+```
+
+## Setup a chat2 node in rate-limited mode
+Run the following command to set up your chat2 client.
+
+```
+./build/chat2 --content-topic:/toy-chat/3/mingde/proto --ports-shift=1 --fleet:test --rln-relay:true --rln-relay-membership-index:your_index
+
+```
+In this command
+- the `rln-relay` flag is set to true to enable RLN-Relay protocol for spam protection.
+- the `rln-relay-membership-index` is used to pick one RLN key out of the 100 available hardcoded RLN keys.
+You can pass your index using this command `--rln-relay-membership-index: your_index` e.g., `--rln-relay-membership-index:19` .
+Please use the index assigned to you in the dogfooding coordination phase.
+If you pick an index at random you may end up using the same key-pair as someone else, hence your messaging rate will be shared with that person(s).
+
+
+Next, choose your nickname:
+```
+Choose a nickname >> your_nick_name
+```
+Wait for the chat prompt `>>` to appear.
+Now your chat2 client is ready.
+
+You may set up more than one chat client,
+just make sure that you increment the `--ports-shift` value for each new client you set up e.g., `--ports-shift=2`.
+
+# Run the test
+Now that you have set up your client, start chatting.
+Once you type a chat line and hit enter, you will see a message that indicates the epoch at which the message is sent e.g.,
+```
+>> Hi!
+--rln epoch: 164495684
+ Bob: Hi!
+```
+The numerical value `164495684` indicates the epoch of the message `Hi!`.
+You will see a different value than `164495684` on your screen.
+If two messages sent by the same chat2 client happen to have the same RLN epoch value, then one of them will be detected as spam by the receiving chat2 clients.
+At the time of this tutorial, the epoch duration is set to `10` seconds.
+Thus, if you send two messages less than `10` seconds apart, they are likely to get the same `rln epoch` values.
+
+After sending a chat message, you may experience some delay before the next chat prompt appears.
+The reason is that under the hood a zero-knowledge proof is being generated and attached to your message.
+
+Once you are done with the test, make sure you close all the chat2 clients by typing `/exit` command.
+```
+>> /exit
+quitting...
+```
+
+# Sample test output
+
+In the following sample test, two chat2 clients are set up, namely `Alice` and `Bob`.
+`Bob` sends three messages i.e., `message1`, `message2`, and `message3` to the test fleets.
+Test fleets will route the messages to their connections including `Alice`.
+The two messages `message2` and `message3` have an identical RLN epoch value of `164504930`, so, one of them will be detected as a spam message by `Alice`.
+You can check this fact by looking at the `Alice` console, where `A spam message is found and discarded : Bob: message3` is presented.
+
+
+Bob
+```
+./build/chat2 --content-topic:/toy-chat/3/mingde/proto --ports-shift=2 --fleet:test --rln-relay:true --rln-relay-membership-index:2
+Choose a nickname >> Bob
+Welcome, Bob!
+Connecting to test fleet using DNS discovery...
+Discovered and connecting to @[16Uiu2HAkykgaECHswi3YKJ5dMLbq2kPVCo89fcyTd38UcQD6ej5W, 16Uiu2HAkzHaTP5JsUwfR9NR8Rj9HC24puS6ocaU8wze4QrXr9iXp, 16Uiu2HAmDCp8XJ9z1ev18zuv8NHekAsjNyezAvmMfFEJkiharitG]
+Listening on
+ /ip4/75.157.120.249/tcp/60002/p2p/16Uiu2HAmKdCdP89q6CwLc6PeFDJnVR1EmM7fTgtphHiacSNBnuAz
+Store enabled, but no store nodes configured. Choosing one at random from discovered peers
+Connecting to storenode: 16Uiu2HAkykgaECHswi3YKJ5dMLbq2kPVCo89fcyTd38UcQD6ej5W
+>> message1
+--rln epoch: 164504929
+ Bob: message1
+>> message2
+--rln epoch: 164504930
+ Bob: message2
+>> message3
+--rln epoch: 164504930
+ Bob: message3
+>> message4
+--rln epoch: 164504973
+ Bob: message4
+>> /exit
+quitting...
+```
+
+
+Alice
+```
+./build/chat2 --content-topic:/toy-chat/3/mingde/proto --ports-shift=1 --fleet:test --rln-relay:true --rln-relay-membership-index:1
+
+Choose a nickname >> Alice
+Welcome, Alice!
+Connecting to test fleet using DNS discovery...
+Discovered and connecting to @[16Uiu2HAkykgaECHswi3YKJ5dMLbq2kPVCo89fcyTd38UcQD6ej5W, 16Uiu2HAkzHaTP5JsUwfR9NR8Rj9HC24puS6ocaU8wze4QrXr9iXp, 16Uiu2HAmDCp8XJ9z1ev18zuv8NHekAsjNyezAvmMfFEJkiharitG]
+Listening on
+ /ip4/75.157.120.249/tcp/60001/p2p/16Uiu2HAkyTos6LeGrj1YJyA3WYzp9qKQGCsxbtvyoBRHSu9PCrQZ
+Store enabled, but no store nodes configured. Choosing one at random from discovered peers
+Connecting to storenode: 16Uiu2HAkykgaECHswi3YKJ5dMLbq2kPVCo89fcyTd38UcQD6ej5W
+>> Bob: message1
+>> Bob: message2
+>> A spam message is found and discarded : Bob: message3
+ Bob: message4
+>> /exit
+quitting...
+```
diff --git a/third-party/nwaku/docs/tutorial/rln-chat2-local-test.md b/third-party/nwaku/docs/tutorial/rln-chat2-local-test.md
new file mode 100644
index 0000000..f5d4bdb
--- /dev/null
+++ b/third-party/nwaku/docs/tutorial/rln-chat2-local-test.md
@@ -0,0 +1,147 @@
+# Building a local network of spam-protected chat2 clients
+
+This document is a tutorial on how to locally set up a small network of chat2 clients in a spam-protected mode using the waku-RLN-Relay protocol.
+In the provided test scenario, you will set up three chat2 clients.
+For ease of explanation, we will refer to them as `Alice`, `Bob`, and `Carol`.
+`Bob` and `Carol` are directly connected to `Alice` so that their message will be routed via `Alice`.
+In this setting, if `Bob` or `Carol` attempts to spam the network by violating the message rate limit then `Alice` will detect their spamming activity, and does not relay the spam messages.
+The message rate is one per epoch.
+At the time of this tutorial, the epoch duration is set to `10` seconds.
+You can inspect its current value by checking the following [constant variable](https://github.com/waku-org/nwaku/blob/44c543129ee4149255a00a05f1e7d21f8fa28626/waku/v2/waku_rln_relay/constants.nim#L51) in the nim-waku codebase.
+
+
+# Set up
+## Build chat2
+First, build chat2
+
+```
+make chat2
+```
+
+## Create a local network of chat2 clients
+Next, set up the following three chat2 clients in order.
+As `Alice` is going to be the only connection point between `Bob` and `Carol`, you need to set it up first before `Bob` and `Carol`.
+
+**Alice setup**:
+Run the following command to set up the first chat2 client. In this command, the `rln-relay` flag is set to true to enable RLN-Relay protocol for the spam protection.
+The `rln-relay-membership-index` is used to pick one RLN key out of the 100 available hardcoded RLN keys.
+We use the first RLN key of the list for `Alice` i.e., `--rln-relay-membership-index:1`.
+
+```
+./build/chat2 --staticnode:/ip4/127.0.0.1/tcp/60010/p2p/16Uiu2HAmKdCdP89q6CwLc6PeFDJnVR1EmM7fTgtphHiacSNBnuAz --content-topic:/toy-chat/3/mingde/proto --ports-shift=1 --fleet:none --nodekey=f157b19b13e9ee818acfc9d3d7eec6b81f70c0a978dec19def261172acbe26e6 --rln-relay:true --rln-relay-membership-index:1
+
+```
+
+Next, you will be prompted with a message to choose a nickname, set it to `Alice`:
+```
+Choose a nickname >> Alice
+```
+Wait for the chat prompt `>>` to appear.
+Now your first chat2 client is ready.
+
+
+
+
+**Bob setup**:
+Set up the second chat2 client using the command below. Choose `Bob` as the nickname.
+```
+./build/chat2 --staticnode:/ip4/127.0.0.1/tcp/60001/p2p/16Uiu2HAkyTos6LeGrj1YJyA3WYzp9qKQGCsxbtvyoBRHSu9PCrQZ --content-topic:/toy-chat/3/mingde/proto --ports-shift=2 --fleet:none --nodekey=9ab635854ffe8fed32b17d7ef38e0b2f354ca1f3283b7f78fb77227004d2cbe6 --rln-relay:true --rln-relay-membership-index:2
+
+Choose a nickname >> Bob
+```
+
+**Carol setup**:
+Run the following command to set up the third chat2 client, and choose `Carol` as the nickname.
+```
+./build/chat2 --staticnode:/ip4/127.0.0.1/tcp/60001/p2p/16Uiu2HAkyTos6LeGrj1YJyA3WYzp9qKQGCsxbtvyoBRHSu9PCrQZ --content-topic:/toy-chat/3/mingde/proto --ports-shift=3 --fleet:none --nodekey=0aa89d7f27300c9fb4e119acc225c8873a3bf96bbb4c82045c94934bcc6a6af8 --rln-relay:true --rln-relay-membership-index:3
+
+Choose a nickname >> Carol
+
+```
+
+# Run the test
+Now that the network is formed, you can start chatting.
+For a better illustration of spam protection, use `Bob` and `Carol` clients for chatting and let `Alice` act only as a router.
+Once you type a chat line and hit enter, you will see a message that indicates the epoch at which the message is sent e.g.,
+```
+>> Hi!
+--rln epoch: 164495684
+ Bob: Hi!
+```
+The numerical value `164495684` indicates the epoch of the message `Hi!`.
+You will see a different value than `164495684` on your screen.
+If two messages sent by the same chat2 client happen to have the same RLN epoch value, then one of them will be detected as spam and won't be routed (by Alice in this test setting).
+At the time of this tutorial, the epoch duration is set to `10` seconds.
+Thus, if you send two messages less than `10` seconds apart, they are likely to get the same `rln epoch` values.
+
+After sending a chat message, you may experience some delay before the next chat prompt appears.
+The reason is that under the hood a zero-knowledge proof is being generated and attached to your message.
+
+Once you are done with the test, make sure you close all the chat2 clients by typing `/exit` command.
+```
+>> /exit
+quitting...
+```
+
+# Sample test output
+
+In the following sample test, `Bob` sends three messages namely, `message1`, `message2`, and `message3`.
+The two messages `message2` and `message3` have identical RLN epoch value of `164504930`, so, one of them will be discarded by `Alice` as a spam message.
+You can check this fact by looking at the `Alice` console, where `A spam message is found and discarded : Bob: message3` is presented.
+`Alice` does not relay `message3` further, hence `Carol` never receives it.
+
+Bob
+```
+./build/chat2 --staticnode:/ip4/127.0.0.1/tcp/60001/p2p/16Uiu2HAkyTos6LeGrj1YJyA3WYzp9qKQGCsxbtvyoBRHSu9PCrQZ --content-topic:/toy-chat/3/mingde/proto --ports-shift=2 --fleet:none --nodekey=9ab635854ffe8fed32b17d7ef38e0b2f354ca1f3283b7f78fb77227004d2cbe6 --rln-relay:true --rln-relay-membership-index:2
+Choose a nickname >> Bob
+Welcome, Bob!
+Connecting to nodes
+Listening on
+ /ip4/75.157.120.249/tcp/60002/p2p/16Uiu2HAmKdCdP89q6CwLc6PeFDJnVR1EmM7fTgtphHiacSNBnuAz
+>> message1
+--rln epoch: 164504929
+ Bob: message1
+>> message2
+--rln epoch: 164504930
+ Bob: message2
+>> message3
+--rln epoch: 164504930
+ Bob: message3
+>> message4
+--rln epoch: 164504973
+ Bob: message4
+>> /exit
+quitting...
+```
+
+Alice
+```
+./build/chat2 --staticnode:/ip4/127.0.0.1/tcp/60010/p2p/16Uiu2HAmKdCdP89q6CwLc6PeFDJnVR1EmM7fTgtphHiacSNBnuAz --content-topic:/toy-chat/3/mingde/proto --ports-shift=1 --fleet:none --nodekey=f157b19b13e9ee818acfc9d3d7eec6b81f70c0a978dec19def261172acbe26e6 --rln-relay:true --rln-relay-membership-index:1
+
+Choose a nickname >> Alice
+Welcome, Alice!
+Connecting to nodes
+Listening on
+ /ip4/75.157.120.249/tcp/60001/p2p/16Uiu2HAkyTos6LeGrj1YJyA3WYzp9qKQGCsxbtvyoBRHSu9PCrQZ
+>> Bob: message1
+>> Bob: message2
+>> A spam message is found and discarded : Bob: message3
+ Bob: message4
+>> /exit
+quitting...
+```
+
+Carol
+```
+./build/chat2 --staticnode:/ip4/127.0.0.1/tcp/60001/p2p/16Uiu2HAkyTos6LeGrj1YJyA3WYzp9qKQGCsxbtvyoBRHSu9PCrQZ --content-topic:/toy-chat/3/mingde/proto --ports-shift=3 --fleet:none --nodekey=0aa89d7f27300c9fb4e119acc225c8873a3bf96bbb4c82045c94934bcc6a6af8 --rln-relay:true --rln-relay-membership-index:3
+Choose a nickname >> Carol
+Welcome, Carol!
+Connecting to nodes
+Listening on
+ /ip4/75.157.120.249/tcp/60003/p2p/16Uiu2HAm1bEDWZqjxfYRvGo1UpjaejkenJVmMFMPMDmgWWGkREJu
+>> Bob: message1
+>> Bob: message2
+>> Bob: message4
+>> /exit
+quitting...
+```
\ No newline at end of file
diff --git a/third-party/nwaku/docs/tutorial/rln-keystore-generator.md b/third-party/nwaku/docs/tutorial/rln-keystore-generator.md
new file mode 100644
index 0000000..4ce7008
--- /dev/null
+++ b/third-party/nwaku/docs/tutorial/rln-keystore-generator.md
@@ -0,0 +1,73 @@
+# rln-keystore-generator
+
+This document describes how to run and use the `rln-keystore-generator` tool.
+It is meant to be used to generate and persist a set of valid RLN credentials to be used with rln-relay.
+
+## Pre-requisites
+
+1. An EOA with some ETH to pay for the registration transaction ($PRIVATE_KEY)
+2. An RPC endpoint to connect to an Ethereum node ($RPC_URL)
+
+## Usage
+
+1. First, we compile the binary
+
+ ```bash
+ make -j16 wakunode2
+ ```
+ This command will fetch the rln static library and link it automatically.
+
+
+2. Define the arguments you wish to use
+
+ ```bash
+ export RPC_URL="https://linea-sepolia.infura.io/v3/..."
+ export PRIVATE_KEY="0x..."
+ export RLN_CONTRACT_ADDRESS="0xB9cd878C90E49F797B4431fBF4fb333108CB90e6"
+ export RLN_CREDENTIAL_PATH="rlnKeystore.json"
+ export RLN_CREDENTIAL_PASSWORD="xxx"
+ ```
+
+3. Dry run the command to ensure better degree of execution
+
+ ```bash
+ ./build/wakunode2 generateRlnKeystore \
+ --rln-relay-eth-client-address:$RPC_URL \
+ --rln-relay-eth-private-key:$PRIVATE_KEY \
+ --rln-relay-eth-contract-address:$RLN_CONTRACT_ADDRESS \
+ --rln-relay-cred-path:$RLN_CREDENTIAL_PATH \
+ --rln-relay-cred-password:$RLN_CREDENTIAL_PASSWORD
+ ```
+ By default, the tool will not execute a transaction. It will execute only if `--execute` is passed in.
+
+4. Run the keystore generator with the onchain registration
+
+ ```bash
+ ./build/wakunode2 generateRlnKeystore \
+ --rln-relay-eth-client-address:$RPC_URL \
+ --rln-relay-eth-private-key:$PRIVATE_KEY \
+ --rln-relay-eth-contract-address:$RLN_CONTRACT_ADDRESS \
+ --rln-relay-cred-path:$RLN_CREDENTIAL_PATH \
+ --rln-relay-cred-password:$RLN_CREDENTIAL_PASSWORD \
+ --execute
+ ```
+
+ What this does is -
+ a. generate a set of valid rln credentials
+ b. registers it to the contract address provided
+ c. persists the credentials to the path provided
+
+5. You may now use this keystore with wakunode2 or chat2.
+
+## Troubleshooting
+
+1. `KeystoreCredentialNotFoundError`
+
+ ```
+ KeystoreCredentialNotFoundError: Credential not found in keystore
+ ```
+ This is most likely due to multiple credentials present in the same keystore.
+ To navigate around this, both chat2 and wakunode2 have provided an option to specify the credential index to use (`--rln-relay-membership-index`).
+ Please use this option with the appropriate tree index of the credential you wish to use.
+
+
diff --git a/third-party/nwaku/docs/tutorial/store.md b/third-party/nwaku/docs/tutorial/store.md
new file mode 100644
index 0000000..0d3aee7
--- /dev/null
+++ b/third-party/nwaku/docs/tutorial/store.md
@@ -0,0 +1,42 @@
+# Running Store Protocol
+
+> TODO (2023-05-24): Deprecate or fix
+
+## How to
+
+Build:
+
+```
+# make wakunode2 is run as part of scripts2 target
+make scripts2
+```
+
+Run two nodes and connect them:
+
+```
+# Starts listening on 60000 with RPC server on 8545.
+# Note the "listening on address" in logs.
+./build/wakunode2 --ports-shift:0
+
+# Run another node with staticnode argument
+./build/wakunode2 --ports-shift:1 --staticnode:/ip4/0.0.0.0/tcp/60000/p2p/16Uiu2HAmF4tuht6fmna6uDqoSMgFqhUrdaVR6VQRyGr6sCpfS2jp --storenode:/ip4/0.0.0.0/tcp/60000/p2p/16Uiu2HAmF4tuht6fmna6uDqoSMgFqhUrdaVR6VQRyGr6sCpfS2jp
+```
+
+When flag `persist-messages` is passed messages are going to be persisted in-memory.
+If additionally flag `dbpath` is passed with a path, messages are persisted and stored in a database called `store` under the specified path.
+If flag `persist-messages` is not passed, messages are not persisted and stored at all.
+
+
+
+You should see your nodes connecting.
+
+Do basic RPC calls:
+
+```
+./build/rpc_subscribe 8545
+./build/rpc_subscribe 8546
+./build/rpc_publish 8545 # enter your message in STDIN
+./build/rpc_query 8546 # enter your content topic; default is "1"
+```
+
+You should see other node receive something.
diff --git a/third-party/nwaku/docs/tutorial/websocket.md b/third-party/nwaku/docs/tutorial/websocket.md
new file mode 100644
index 0000000..bc07744
--- /dev/null
+++ b/third-party/nwaku/docs/tutorial/websocket.md
@@ -0,0 +1,69 @@
+# Listening on Websocket to Enable Connections With Waku v2 Browser Peers
+
+> TODO (2023-05-24): Deprecate or fix
+
+Currently, nim-waku only supports TCP transport.
+This means it is not possible to directly connect from a browser using [js-waku](https://github.com/waku-org/js-waku/)
+to a nim-waku based node such as wakunode2.
+
+To remediate to this, utilities such as [websockify](https://github.com/novnc/websockify) can be used.
+This tutorial explains how one can setup websockify alongside wakunode2 to accept connections from peer browsers.
+
+Note that popular browsers only accept secure websocket connections (`wss`) in a secure page (`https`),
+hence we will also cover the creation of SSL certificates.
+
+## Creating certificate using cerbot
+
+Feel free to skip this step if you already own SSL certificate for your domain.
+
+To do so, simply follow the instructions at https://certbot.eff.org/.
+
+Note that you do not need to have a web server (e.g. apache, nginx) running to setup wakunode2 with websockify.
+
+## Setting up websockify
+
+You can install [Websockify](https://github.com/novnc/websockify) via your preferred package manager
+or [using Python](https://github.com/novnc/websockify#installing-websockify).
+
+To start websockify, use the following command:
+
+```shell
+sudo websockify \
+--cert /etc/letsencrypt/live//fullchain.pem \
+--key /etc/letsencrypt/live//privkey.pem 0.0.0.0:443 \
+127.0.0.1:
+```
+
+With:
+- `your.domain` being your domain name (.e.g `www.example.org`).
+- `tcp_port` being the port on which wakunode2 is listening, by default `60000`.
+
+Notes:
+- This assumes you used `certbot` to generate certificate, `/etc/letsencrypt/live` is where `certbot store certificates,
+ if you have your own certificates, changes the path and be sure to pass the full certificate chain including
+ the CA certificate to the `--cert` argument.
+- `sudo` is needed because websockify listens on port `443`;
+ You can avoid using `sudo` by using a custom port, just be sure it is open to the internet by checking your firewall.
+
+## Getting your wakunode2's multiaddr
+
+Start `wakunode2` as you usually do,
+be sure to take in account the listening port to reflect it in the websockify command line.
+
+`wakunode2` prints the multiaddr it is listening too at the start of the logs:
+
+```
+INF 2021-06-23 10:37:25.274+10:00 Listening on topics="wakunode" tid=2271871 file=wakunode2.nim:170 full=/ip4/1.2.3.4/tcp/60000/p2p/16Uiu2HAmPRmVHjZSP3U1T9ez4EQBBUsji5RyvAyDGVNgTQajtEQJ
+```
+
+To get the websocket multiaddr, simply change the port and insert `wss` after said port:
+
+```
+/ip4/1.2.3.4/tcp/443/wss/p2p/16Uiu2HAmPRmVHjZSP3U1T9ez4EQBBUsji5RyvAyDGVNgTQajtEQJ
+```
+
+You can also use your domain name instead of ip address:
+
+```
+/dns4/your.domain/tcp/443/wss/p2p/16Uiu2HAmPRmVHjZSP3U1T9ez4EQBBUsji5RyvAyDGVNgTQajtEQJ
+```
diff --git a/third-party/nwaku/env.sh b/third-party/nwaku/env.sh
new file mode 100755
index 0000000..f90ba9a
--- /dev/null
+++ b/third-party/nwaku/env.sh
@@ -0,0 +1,8 @@
+#!/bin/bash
+
+# We use ${BASH_SOURCE[0]} instead of $0 to allow sourcing this file
+# and we fall back to a Zsh-specific special var to also support Zsh.
+REL_PATH="$(dirname ${BASH_SOURCE[0]:-${(%):-%x}})"
+ABS_PATH="$(cd ${REL_PATH}; pwd)"
+source ${ABS_PATH}/vendor/nimbus-build-system/scripts/env.sh
+
diff --git a/third-party/nwaku/examples/README.md b/third-party/nwaku/examples/README.md
new file mode 100644
index 0000000..7055cf6
--- /dev/null
+++ b/third-party/nwaku/examples/README.md
@@ -0,0 +1,75 @@
+# Examples
+
+## Compile
+
+Make all examples.
+```console
+make example2
+```
+
+## Waku API
+
+Uses the simplified Waku API to create and start a node,
+you need an RPC endpoint for Linea Sepolia for RLN:
+
+```console
+./build/waku_api --ethRpcEndpoint=https://linea-sepolia.infura.io/v3/
+```
+
+If you can't be bothered but still want to see some action,
+just run the binary and it will use a non-RLN network:
+
+```console
+./build/waku_api
+```
+
+## publisher/subscriber
+
+Within `examples/` you can find a `publisher` and a `subscriber`. The first one publishes messages to the default pubsub topic on a given content topic, and the second one runs forever listening to that pubsub topic and printing the content it receives.
+
+**Some notes:**
+* These examples are meant to work even if you are behind a firewall and you can't be discovered by discv5.
+* You only need to provide a reachable bootstrap peer (see our [fleets](https://fleets.status.im/))
+* The examples are meant to work out of the box.
+* Note that both services wait for some time until a given minimum amount of connections are reached. This is to ensure messages are gossiped.
+
+**Run:**
+
+Wait until the subscriber is ready.
+```console
+./build/subscriber
+```
+
+And run a publisher
+```console
+./build/publisher
+```
+
+See how the subscriber received the messages published by the publisher. Feel free to experiment from different machines in different locations.
+
+## resource-restricted publisher/subscriber (lightpush/filter)
+
+To illustrate publishing and receiving messages on a resource-restricted client,
+`examples/v2` also provides a `lightpush_publisher` and a `filter_subscriber`.
+The `lightpush_publisher` continually publishes messages via a lightpush service node
+to the default pubsub topic on a given content topic.
+The `filter_subscriber` subscribes via a filter service node
+to the same pubsub and content topic.
+It runs forever, maintaining this subscription
+and printing the content it receives.
+
+**Run**
+Start the filter subscriber.
+```console
+./build/filter_subscriber
+```
+
+And run a lightpush publisher
+```console
+./build/lightpush_publisher
+```
+
+See how the filter subscriber receives messages published by the lightpush publisher.
+Neither the publisher nor the subscriber participates in `relay`,
+but instead make use of service nodes to save resources.
+Feel free to experiment from different machines in different locations.
diff --git a/third-party/nwaku/examples/cbindings/README.md b/third-party/nwaku/examples/cbindings/README.md
new file mode 100644
index 0000000..5465cf5
--- /dev/null
+++ b/third-party/nwaku/examples/cbindings/README.md
@@ -0,0 +1,18 @@
+## App description
+This is a very simple example that shows how to invoke libwaku functions from a C program.
+
+## Build
+1. Open terminal
+2. cd to nwaku root folder
+3. make cwaku_example -j8
+
+This will create libwaku.so and cwaku_example binary within the build folder.
+
+## Run
+1. Open terminal
+2. cd to nwaku root folder
+3. export LD_LIBRARY_PATH=build
+4. `./build/cwaku_example --host=0.0.0.0 --port=60001`
+
+Use `./build/cwaku_example --help` to see some other options.
+
diff --git a/third-party/nwaku/examples/cbindings/base64.c b/third-party/nwaku/examples/cbindings/base64.c
new file mode 100644
index 0000000..0f9acdf
--- /dev/null
+++ b/third-party/nwaku/examples/cbindings/base64.c
@@ -0,0 +1,58 @@
+
+#include "base64.h"
+
+// Base64 encoding
+// source: https://nachtimwald.com/2017/11/18/base64-encode-and-decode-in-c/
+size_t b64_encoded_size(size_t inlen)
+{
+ size_t ret;
+
+ ret = inlen;
+ if (inlen % 3 != 0)
+ ret += 3 - (inlen % 3);
+ ret /= 3;
+ ret *= 4;
+
+ return ret;
+}
+
+const char b64chars[] = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
+
+char *b64_encode(const unsigned char *in, size_t len)
+{
+ char *out;
+ size_t elen;
+ size_t i;
+ size_t j;
+ size_t v;
+
+ if (in == NULL || len == 0)
+ return NULL;
+
+ elen = b64_encoded_size(len);
+ out = malloc(elen+1);
+ out[elen] = '\0';
+
+ for (i=0, j=0; i> 18) & 0x3F];
+ out[j+1] = b64chars[(v >> 12) & 0x3F];
+ if (i+1 < len) {
+ out[j+2] = b64chars[(v >> 6) & 0x3F];
+ } else {
+ out[j+2] = '=';
+ }
+ if (i+2 < len) {
+ out[j+3] = b64chars[v & 0x3F];
+ } else {
+ out[j+3] = '=';
+ }
+ }
+
+ return out;
+}
+
+// End of Base64 encoding
diff --git a/third-party/nwaku/examples/cbindings/base64.h b/third-party/nwaku/examples/cbindings/base64.h
new file mode 100644
index 0000000..37ca50f
--- /dev/null
+++ b/third-party/nwaku/examples/cbindings/base64.h
@@ -0,0 +1,11 @@
+
+#ifndef _BASE64_H_
+#define _BASE64_H_
+
+#include
+
+size_t b64_encoded_size(size_t inlen);
+
+char *b64_encode(const unsigned char *in, size_t len);
+
+#endif
diff --git a/third-party/nwaku/examples/cbindings/waku_example.c b/third-party/nwaku/examples/cbindings/waku_example.c
new file mode 100644
index 0000000..35ac8a2
--- /dev/null
+++ b/third-party/nwaku/examples/cbindings/waku_example.c
@@ -0,0 +1,366 @@
+#include
+#include
+#include
+#include
+#include
+#include
+#include
+#include
+
+#include
+#include
+#include
+
+#include "base64.h"
+#include "../../library/libwaku.h"
+
+// Shared synchronization variables
+pthread_mutex_t mutex = PTHREAD_MUTEX_INITIALIZER;
+pthread_cond_t cond = PTHREAD_COND_INITIALIZER;
+int callback_executed = 0;
+
+void waitForCallback() {
+ pthread_mutex_lock(&mutex);
+ while (!callback_executed) {
+ pthread_cond_wait(&cond, &mutex);
+ }
+ callback_executed = 0;
+ pthread_mutex_unlock(&mutex);
+}
+
+#define WAKU_CALL(call) \
+do { \
+ int ret = call; \
+ if (ret != 0) { \
+ printf("Failed the call to: %s. Returned code: %d\n", #call, ret); \
+ exit(1); \
+ } \
+ waitForCallback(); \
+} while (0)
+
+struct ConfigNode {
+ char host[128];
+ int port;
+ char key[128];
+ int relay;
+ char peers[2048];
+ int store;
+ char storeNode[2048];
+ char storeRetentionPolicy[64];
+ char storeDbUrl[256];
+ int storeVacuum;
+ int storeDbMigration;
+ int storeMaxNumDbConnections;
+};
+
+// libwaku Context
+void* ctx;
+
+// For the case of C language we don't need to store a particular userData
+void* userData = NULL;
+
+// Arguments parsing
+static char doc[] = "\nC example that shows how to use the waku library.";
+static char args_doc[] = "";
+
+static struct argp_option options[] = {
+ { "host", 'h', "HOST", 0, "IP to listen for for LibP2P traffic. (default: \"0.0.0.0\")"},
+ { "port", 'p', "PORT", 0, "TCP listening port. (default: \"60000\")"},
+ { "key", 'k', "KEY", 0, "P2P node private key as 64 char hex string."},
+ { "relay", 'r', "RELAY", 0, "Enable relay protocol: 1 or 0. (default: 1)"},
+ { "peers", 'a', "PEERS", 0, "Comma-separated list of peer-multiaddress to connect\
+ to. (default: \"\") e.g. \"/ip4/127.0.0.1/tcp/60001/p2p/16Uiu2HAmVFXtAfSj4EiR7mL2KvL4EE2wztuQgUSBoj2Jx2KeXFLN\""},
+ { 0 }
+};
+
+static error_t parse_opt(int key, char *arg, struct argp_state *state) {
+
+ struct ConfigNode *cfgNode = state->input;
+ switch (key) {
+ case 'h':
+ snprintf(cfgNode->host, 128, "%s", arg);
+ break;
+ case 'p':
+ cfgNode->port = atoi(arg);
+ break;
+ case 'k':
+ snprintf(cfgNode->key, 128, "%s", arg);
+ break;
+ case 'r':
+ cfgNode->relay = atoi(arg);
+ break;
+ case 'a':
+ snprintf(cfgNode->peers, 2048, "%s", arg);
+ break;
+ case ARGP_KEY_ARG:
+ if (state->arg_num >= 1) /* Too many arguments. */
+ argp_usage(state);
+ break;
+ case ARGP_KEY_END:
+ break;
+ default:
+ return ARGP_ERR_UNKNOWN;
+ }
+
+ return 0;
+}
+
+void signal_cond() {
+ pthread_mutex_lock(&mutex);
+ callback_executed = 1;
+ pthread_cond_signal(&cond);
+ pthread_mutex_unlock(&mutex);
+}
+
+static struct argp argp = { options, parse_opt, args_doc, doc, 0, 0, 0 };
+
+void event_handler(int callerRet, const char* msg, size_t len, void* userData) {
+ if (callerRet == RET_ERR) {
+ printf("Error: %s\n", msg);
+ exit(1);
+ }
+ else if (callerRet == RET_OK) {
+ printf("Receiving event: %s\n", msg);
+ }
+
+ signal_cond();
+}
+
+void on_event_received(int callerRet, const char* msg, size_t len, void* userData) {
+ if (callerRet == RET_ERR) {
+ printf("Error: %s\n", msg);
+ exit(1);
+ }
+ else if (callerRet == RET_OK) {
+ printf("Receiving event: %s\n", msg);
+ }
+}
+
+char* contentTopic = NULL;
+void handle_content_topic(int callerRet, const char* msg, size_t len, void* userData) {
+ if (contentTopic != NULL) {
+ free(contentTopic);
+ }
+
+ contentTopic = malloc(len * sizeof(char) + 1);
+ strcpy(contentTopic, msg);
+ signal_cond();
+}
+
+char* publishResponse = NULL;
+void handle_publish_ok(int callerRet, const char* msg, size_t len, void* userData) {
+ printf("Publish Ok: %s %lu\n", msg, len);
+
+ if (publishResponse != NULL) {
+ free(publishResponse);
+ }
+
+ publishResponse = malloc(len * sizeof(char) + 1);
+ strcpy(publishResponse, msg);
+}
+
+#define MAX_MSG_SIZE 65535
+
+void publish_message(const char* msg) {
+ char jsonWakuMsg[MAX_MSG_SIZE];
+ char *msgPayload = b64_encode(msg, strlen(msg));
+
+ WAKU_CALL( waku_content_topic(ctx,
+ "appName",
+ 1,
+ "contentTopicName",
+ "encoding",
+ handle_content_topic,
+ userData) );
+ snprintf(jsonWakuMsg,
+ MAX_MSG_SIZE,
+ "{\"payload\":\"%s\",\"contentTopic\":\"%s\"}",
+ msgPayload, contentTopic);
+
+ free(msgPayload);
+
+ WAKU_CALL( waku_relay_publish(ctx,
+ "/waku/2/rs/16/32",
+ jsonWakuMsg,
+ 10000 /*timeout ms*/,
+ event_handler,
+ userData) );
+}
+
+void show_help_and_exit() {
+ printf("Wrong parameters\n");
+ exit(1);
+}
+
+void print_default_pubsub_topic(int callerRet, const char* msg, size_t len, void* userData) {
+ printf("Default pubsub topic: %s\n", msg);
+ signal_cond();
+}
+
+void print_waku_version(int callerRet, const char* msg, size_t len, void* userData) {
+ printf("Git Version: %s\n", msg);
+ signal_cond();
+}
+
+// Beginning of UI program logic
+
+enum PROGRAM_STATE {
+ MAIN_MENU,
+ SUBSCRIBE_TOPIC_MENU,
+ CONNECT_TO_OTHER_NODE_MENU,
+ PUBLISH_MESSAGE_MENU
+};
+
+enum PROGRAM_STATE current_state = MAIN_MENU;
+
+void show_main_menu() {
+ printf("\nPlease, select an option:\n");
+ printf("\t1.) Subscribe to topic\n");
+ printf("\t2.) Connect to other node\n");
+ printf("\t3.) Publish a message\n");
+}
+
+void handle_user_input() {
+ char cmd[1024];
+ memset(cmd, 0, 1024);
+ int numRead = read(0, cmd, 1024);
+ if (numRead <= 0) {
+ return;
+ }
+
+ switch (atoi(cmd))
+ {
+ case SUBSCRIBE_TOPIC_MENU:
+ {
+ printf("Indicate the Pubsubtopic to subscribe:\n");
+ char pubsubTopic[128];
+ scanf("%127s", pubsubTopic);
+
+ WAKU_CALL( waku_relay_subscribe(ctx,
+ pubsubTopic,
+ event_handler,
+ userData) );
+ printf("The subscription went well\n");
+
+ show_main_menu();
+ }
+ break;
+
+ case CONNECT_TO_OTHER_NODE_MENU:
+ printf("Connecting to a node. Please indicate the peer Multiaddress:\n");
+ printf("e.g.: /ip4/127.0.0.1/tcp/60001/p2p/16Uiu2HAmVFXtAfSj4EiR7mL2KvL4EE2wztuQgUSBoj2Jx2KeXFLN\n");
+ char peerAddr[512];
+ scanf("%511s", peerAddr);
+ WAKU_CALL(waku_connect(ctx, peerAddr, 10000 /* timeoutMs */, event_handler, userData));
+ show_main_menu();
+ break;
+
+ case PUBLISH_MESSAGE_MENU:
+ {
+ printf("Type the message to publish:\n");
+ char msg[1024];
+ scanf("%1023s", msg);
+
+ publish_message(msg);
+
+ show_main_menu();
+ }
+ break;
+
+ case MAIN_MENU:
+ break;
+ }
+}
+
+// End of UI program logic
+
+int main(int argc, char** argv) {
+ struct ConfigNode cfgNode;
+ // default values
+ snprintf(cfgNode.host, 128, "0.0.0.0");
+ cfgNode.port = 60000;
+ cfgNode.relay = 1;
+
+ cfgNode.store = 0;
+ snprintf(cfgNode.storeNode, 2048, "");
+ snprintf(cfgNode.storeRetentionPolicy, 64, "time:6000000");
+ snprintf(cfgNode.storeDbUrl, 256, "postgres://postgres:test123@localhost:5432/postgres");
+ cfgNode.storeVacuum = 0;
+ cfgNode.storeDbMigration = 0;
+ cfgNode.storeMaxNumDbConnections = 30;
+
+ if (argp_parse(&argp, argc, argv, 0, 0, &cfgNode)
+ == ARGP_ERR_UNKNOWN) {
+ show_help_and_exit();
+ }
+
+ char jsonConfig[5000];
+ snprintf(jsonConfig, 5000, "{ \
+ \"clusterId\": 16, \
+ \"shards\": [ 1, 32, 64, 128, 256 ], \
+ \"numShardsInNetwork\": 257, \
+ \"listenAddress\": \"%s\", \
+ \"tcpPort\": %d, \
+ \"relay\": %s, \
+ \"store\": %s, \
+ \"storeMessageDbUrl\": \"%s\", \
+ \"storeMessageRetentionPolicy\": \"%s\", \
+ \"storeMaxNumDbConnections\": %d , \
+ \"logLevel\": \"DEBUG\", \
+ \"discv5Discovery\": true, \
+ \"discv5BootstrapNodes\": \
+ [\"enr:-QEKuED9AJm2HGgrRpVaJY2nj68ao_QiPeUT43sK-aRM7sMJ6R4G11OSDOwnvVacgN1sTw-K7soC5dzHDFZgZkHU0u-XAYJpZIJ2NIJpcISnYxMvim11bHRpYWRkcnO4WgAqNiVib290LTAxLmRvLWFtczMuc3RhdHVzLnByb2Quc3RhdHVzLmltBnZfACw2JWJvb3QtMDEuZG8tYW1zMy5zdGF0dXMucHJvZC5zdGF0dXMuaW0GAbveA4Jyc40AEAUAAQAgAEAAgAEAiXNlY3AyNTZrMaEC3rRtFQSgc24uWewzXaxTY8hDAHB8sgnxr9k8Rjb5GeSDdGNwgnZfg3VkcIIjKIV3YWt1Mg0\", \"enr:-QEcuED7ww5vo2rKc1pyBp7fubBUH-8STHEZHo7InjVjLblEVyDGkjdTI9VdqmYQOn95vuQH-Htku17WSTzEufx-Wg4mAYJpZIJ2NIJpcIQihw1Xim11bHRpYWRkcnO4bAAzNi5ib290LTAxLmdjLXVzLWNlbnRyYWwxLWEuc3RhdHVzLnByb2Quc3RhdHVzLmltBnZfADU2LmJvb3QtMDEuZ2MtdXMtY2VudHJhbDEtYS5zdGF0dXMucHJvZC5zdGF0dXMuaW0GAbveA4Jyc40AEAUAAQAgAEAAgAEAiXNlY3AyNTZrMaECxjqgDQ0WyRSOilYU32DA5k_XNlDis3m1VdXkK9xM6kODdGNwgnZfg3VkcIIjKIV3YWt1Mg0\", \"enr:-QEcuEAoShWGyN66wwusE3Ri8hXBaIkoHZHybUB8cCPv5v3ypEf9OCg4cfslJxZFANl90s-jmMOugLUyBx4EfOBNJ6_VAYJpZIJ2NIJpcIQI2hdMim11bHRpYWRkcnO4bAAzNi5ib290LTAxLmFjLWNuLWhvbmdrb25nLWMuc3RhdHVzLnByb2Quc3RhdHVzLmltBnZfADU2LmJvb3QtMDEuYWMtY24taG9uZ2tvbmctYy5zdGF0dXMucHJvZC5zdGF0dXMuaW0GAbveA4Jyc40AEAUAAQAgAEAAgAEAiXNlY3AyNTZrMaEDP7CbRk-YKJwOFFM4Z9ney0GPc7WPJaCwGkpNRyla7mCDdGNwgnZfg3VkcIIjKIV3YWt1Mg0\"], \
+ \"discv5UdpPort\": 9999, \
+ \"dnsDiscoveryUrl\": \"enrtree://AMOJVZX4V6EXP7NTJPMAYJYST2QP6AJXYW76IU6VGJS7UVSNDYZG4@boot.prod.status.nodes.status.im\", \
+ \"dnsDiscoveryNameServers\": [\"8.8.8.8\", \"1.0.0.1\"] \
+ }", cfgNode.host,
+ cfgNode.port,
+ cfgNode.relay ? "true":"false",
+ cfgNode.store ? "true":"false",
+ cfgNode.storeDbUrl,
+ cfgNode.storeRetentionPolicy,
+ cfgNode.storeMaxNumDbConnections);
+
+ ctx = waku_new(jsonConfig, event_handler, userData);
+ waitForCallback();
+
+ WAKU_CALL( waku_default_pubsub_topic(ctx, print_default_pubsub_topic, userData) );
+ WAKU_CALL( waku_version(ctx, print_waku_version, userData) );
+
+ printf("Bind addr: %s:%u\n", cfgNode.host, cfgNode.port);
+ printf("Waku Relay enabled: %s\n", cfgNode.relay == 1 ? "YES": "NO");
+
+ waku_set_event_callback(ctx, on_event_received, userData);
+
+ waku_start(ctx, event_handler, userData);
+ waitForCallback();
+
+ WAKU_CALL( waku_listen_addresses(ctx, event_handler, userData) );
+
+ WAKU_CALL( waku_relay_subscribe(ctx,
+ "/waku/2/rs/0/0",
+ event_handler,
+ userData) );
+
+ WAKU_CALL( waku_discv5_update_bootnodes(ctx,
+ "[\"enr:-QEkuEBIkb8q8_mrorHndoXH9t5N6ZfD-jehQCrYeoJDPHqT0l0wyaONa2-piRQsi3oVKAzDShDVeoQhy0uwN1xbZfPZAYJpZIJ2NIJpcIQiQlleim11bHRpYWRkcnO4bgA0Ni9ub2RlLTAxLmdjLXVzLWNlbnRyYWwxLWEud2FrdS5zYW5kYm94LnN0YXR1cy5pbQZ2XwA2Ni9ub2RlLTAxLmdjLXVzLWNlbnRyYWwxLWEud2FrdS5zYW5kYm94LnN0YXR1cy5pbQYfQN4DgnJzkwABCAAAAAEAAgADAAQABQAGAAeJc2VjcDI1NmsxoQKnGt-GSgqPSf3IAPM7bFgTlpczpMZZLF3geeoNNsxzSoN0Y3CCdl-DdWRwgiMohXdha3UyDw\",\"enr:-QEkuEB3WHNS-xA3RDpfu9A2Qycr3bN3u7VoArMEiDIFZJ66F1EB3d4wxZN1hcdcOX-RfuXB-MQauhJGQbpz3qUofOtLAYJpZIJ2NIJpcIQI2SVcim11bHRpYWRkcnO4bgA0Ni9ub2RlLTAxLmFjLWNuLWhvbmdrb25nLWMud2FrdS5zYW5kYm94LnN0YXR1cy5pbQZ2XwA2Ni9ub2RlLTAxLmFjLWNuLWhvbmdrb25nLWMud2FrdS5zYW5kYm94LnN0YXR1cy5pbQYfQN4DgnJzkwABCAAAAAEAAgADAAQABQAGAAeJc2VjcDI1NmsxoQPK35Nnz0cWUtSAhBp7zvHEhyU_AqeQUlqzLiLxfP2L4oN0Y3CCdl-DdWRwgiMohXdha3UyDw\"]",
+ event_handler,
+ userData) );
+
+ WAKU_CALL( waku_get_peerids_from_peerstore(ctx,
+ event_handler,
+ userData) );
+
+ show_main_menu();
+ while(1) {
+ handle_user_input();
+
+ // Uncomment the following if need to test the metrics retrieval
+ // WAKU_CALL( waku_get_metrics(ctx,
+ // event_handler,
+ // userData) );
+ }
+
+ pthread_mutex_destroy(&mutex);
+ pthread_cond_destroy(&cond);
+}
diff --git a/third-party/nwaku/examples/cpp/README.md b/third-party/nwaku/examples/cpp/README.md
new file mode 100644
index 0000000..fa8d246
--- /dev/null
+++ b/third-party/nwaku/examples/cpp/README.md
@@ -0,0 +1,18 @@
+## App description
+This is a very simple example that shows how to invoke libwaku functions from a C++ program.
+
+## Build
+1. Open terminal
+2. cd to nwaku root folder
+3. make cppwaku_example -j8
+
+This will create libwaku.so and cppwaku_example binary within the build folder.
+
+## Run
+1. Open terminal
+2. cd to nwaku root folder
+3. export LD_LIBRARY_PATH=build
+4. `./build/cppwaku_example --host=0.0.0.0 --port=60001`
+
+Use `./build/cppwaku_example --help` to see some other options.
+
diff --git a/third-party/nwaku/examples/cpp/base64.cpp b/third-party/nwaku/examples/cpp/base64.cpp
new file mode 100644
index 0000000..517e4b2
--- /dev/null
+++ b/third-party/nwaku/examples/cpp/base64.cpp
@@ -0,0 +1,53 @@
+
+#include
+#include "base64.h"
+
+// Base64 encoding
+// source: https://nachtimwald.com/2017/11/18/base64-encode-and-decode-in-c/
+size_t b64_encoded_size(size_t inlen)
+{
+ size_t ret;
+
+ ret = inlen;
+ if (inlen % 3 != 0)
+ ret += 3 - (inlen % 3);
+ ret /= 3;
+ ret *= 4;
+
+ return ret;
+}
+
+const char b64chars[] = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
+
+void b64_encode(char* in, size_t len, std::vector& out)
+{
+ size_t elen;
+ size_t i;
+ size_t j;
+ size_t v;
+
+ if (in == NULL || len == 0)
+ return;
+
+ elen = b64_encoded_size(len);
+ out.reserve(elen+1);
+
+ for (i=0, j=0; i> 18) & 0x3F];
+ out[j+1] = b64chars[(v >> 12) & 0x3F];
+ if (i+1 < len) {
+ out[j+2] = b64chars[(v >> 6) & 0x3F];
+ } else {
+ out[j+2] = '=';
+ }
+ if (i+2 < len) {
+ out[j+3] = b64chars[v & 0x3F];
+ } else {
+ out[j+3] = '=';
+ }
+ }
+}
diff --git a/third-party/nwaku/examples/cpp/base64.h b/third-party/nwaku/examples/cpp/base64.h
new file mode 100644
index 0000000..0994a0b
--- /dev/null
+++ b/third-party/nwaku/examples/cpp/base64.h
@@ -0,0 +1,11 @@
+
+#ifndef _BASE64_H_
+#define _BASE64_H_
+
+#include
+
+size_t b64_encoded_size(size_t inlen);
+
+void b64_encode(char* in, size_t len, std::vector& out);
+
+#endif
diff --git a/third-party/nwaku/examples/cpp/waku.cpp b/third-party/nwaku/examples/cpp/waku.cpp
new file mode 100644
index 0000000..c47877d
--- /dev/null
+++ b/third-party/nwaku/examples/cpp/waku.cpp
@@ -0,0 +1,331 @@
+#include
+#include
+#include
+#include
+#include
+#include
+#include
+#include
+#include
+#include
+
+#include
+#include
+#include
+
+#include "base64.h"
+#include "../../library/libwaku.h"
+
+// Shared synchronization variables
+pthread_mutex_t mutex = PTHREAD_MUTEX_INITIALIZER;
+pthread_cond_t cond = PTHREAD_COND_INITIALIZER;
+int callback_executed = 0;
+
+void waitForCallback() {
+ pthread_mutex_lock(&mutex);
+ while (!callback_executed) {
+ pthread_cond_wait(&cond, &mutex);
+ }
+ callback_executed = 0;
+ pthread_mutex_unlock(&mutex);
+}
+
+void signal_cond() {
+ pthread_mutex_lock(&mutex);
+ callback_executed = 1;
+ pthread_cond_signal(&cond);
+ pthread_mutex_unlock(&mutex);
+}
+
+#define WAKU_CALL(call) \
+do { \
+ int ret = call; \
+ if (ret != 0) { \
+ std::cout << "Failed the call to: " << #call << ". Code: " << ret << "\n"; \
+ } \
+ waitForCallback(); \
+} while (0)
+
+struct ConfigNode {
+ char host[128];
+ int port;
+ char key[128];
+ int relay;
+ char peers[2048];
+};
+
+// Arguments parsing
+static char doc[] = "\nC example that shows how to use the waku library.";
+static char args_doc[] = "";
+
+static struct argp_option options[] = {
+ { "host", 'h', "HOST", 0, "IP to listen for for LibP2P traffic. (default: \"0.0.0.0\")"},
+ { "port", 'p', "PORT", 0, "TCP listening port. (default: \"60000\")"},
+ { "key", 'k', "KEY", 0, "P2P node private key as 64 char hex string."},
+ { "relay", 'r', "RELAY", 0, "Enable relay protocol: 1 or 0. (default: 1)"},
+ { "peers", 'a', "PEERS", 0, "Comma-separated list of peer-multiaddress to connect\
+ to. (default: \"\") e.g. \"/ip4/127.0.0.1/tcp/60001/p2p/16Uiu2HAmVFXtAfSj4EiR7mL2KvL4EE2wztuQgUSBoj2Jx2KeXFLN\""},
+ { 0 }
+};
+
+static error_t parse_opt(int key, char *arg, struct argp_state *state) {
+
+ struct ConfigNode *cfgNode = (ConfigNode *) state->input;
+ switch (key) {
+ case 'h':
+ snprintf(cfgNode->host, 128, "%s", arg);
+ break;
+ case 'p':
+ cfgNode->port = atoi(arg);
+ break;
+ case 'k':
+ snprintf(cfgNode->key, 128, "%s", arg);
+ break;
+ case 'r':
+ cfgNode->relay = atoi(arg);
+ break;
+ case 'a':
+ snprintf(cfgNode->peers, 2048, "%s", arg);
+ break;
+ case ARGP_KEY_ARG:
+ if (state->arg_num >= 1) /* Too many arguments. */
+ argp_usage(state);
+ break;
+ case ARGP_KEY_END:
+ break;
+ default:
+ return ARGP_ERR_UNKNOWN;
+ }
+
+ return 0;
+}
+
+void event_handler(const char* msg, size_t len) {
+ printf("Receiving event: %s\n", msg);
+}
+
+void handle_error(const char* msg, size_t len) {
+ printf("handle_error: %s\n", msg);
+ exit(1);
+}
+
+template
+auto cify(F&& f) {
+ static F fn = std::forward(f);
+ return [](int callerRet, const char* msg, size_t len, void* userData) {
+ signal_cond();
+ return fn(msg, len);
+ };
+}
+
+static struct argp argp = { options, parse_opt, args_doc, doc, 0, 0, 0 };
+
+// Beginning of UI program logic
+
+enum PROGRAM_STATE {
+ MAIN_MENU,
+ SUBSCRIBE_TOPIC_MENU,
+ CONNECT_TO_OTHER_NODE_MENU,
+ PUBLISH_MESSAGE_MENU
+};
+
+enum PROGRAM_STATE current_state = MAIN_MENU;
+
+void show_main_menu() {
+ printf("\nPlease, select an option:\n");
+ printf("\t1.) Subscribe to topic\n");
+ printf("\t2.) Connect to other node\n");
+ printf("\t3.) Publish a message\n");
+}
+
+void handle_user_input(void* ctx) {
+ char cmd[1024];
+ memset(cmd, 0, 1024);
+ int numRead = read(0, cmd, 1024);
+ if (numRead <= 0) {
+ return;
+ }
+
+ switch (atoi(cmd))
+ {
+ case SUBSCRIBE_TOPIC_MENU:
+ {
+ printf("Indicate the Pubsubtopic to subscribe:\n");
+ char pubsubTopic[128];
+ scanf("%127s", pubsubTopic);
+
+ WAKU_CALL( waku_relay_subscribe(ctx,
+ pubsubTopic,
+ cify([&](const char* msg, size_t len) {
+ event_handler(msg, len);
+ }),
+ nullptr) );
+ printf("The subscription went well\n");
+
+ show_main_menu();
+ }
+ break;
+
+ case CONNECT_TO_OTHER_NODE_MENU:
+ printf("Connecting to a node. Please indicate the peer Multiaddress:\n");
+ printf("e.g.: /ip4/127.0.0.1/tcp/60001/p2p/16Uiu2HAmVFXtAfSj4EiR7mL2KvL4EE2wztuQgUSBoj2Jx2KeXFLN\n");
+ char peerAddr[512];
+ scanf("%511s", peerAddr);
+ WAKU_CALL( waku_connect(ctx,
+ peerAddr,
+ 10000 /* timeoutMs */,
+ cify([&](const char* msg, size_t len) {
+ event_handler(msg, len);
+ }),
+ nullptr));
+ show_main_menu();
+ break;
+
+ case PUBLISH_MESSAGE_MENU:
+ {
+ printf("Type the message to publish:\n");
+ char msg[1024];
+ scanf("%1023s", msg);
+
+ char jsonWakuMsg[2048];
+ std::vector msgPayload;
+ b64_encode(msg, strlen(msg), msgPayload);
+
+ std::string contentTopic;
+ waku_content_topic(ctx,
+ "appName",
+ 1,
+ "contentTopicName",
+ "encoding",
+ cify([&contentTopic](const char* msg, size_t len) {
+ contentTopic = msg;
+ }),
+ nullptr);
+
+ snprintf(jsonWakuMsg,
+ 2048,
+ "{\"payload\":\"%s\",\"contentTopic\":\"%s\"}",
+ msgPayload.data(), contentTopic.c_str());
+
+ WAKU_CALL( waku_relay_publish(ctx,
+ "/waku/2/rs/16/32",
+ jsonWakuMsg,
+ 10000 /*timeout ms*/,
+ cify([&](const char* msg, size_t len) {
+ event_handler(msg, len);
+ }),
+ nullptr) );
+
+ show_main_menu();
+ }
+ break;
+
+ case MAIN_MENU:
+ break;
+ }
+}
+
+// End of UI program logic
+
+void show_help_and_exit() {
+ printf("Wrong parameters\n");
+ exit(1);
+}
+
+int main(int argc, char** argv) {
+ struct ConfigNode cfgNode;
+ // default values
+ snprintf(cfgNode.host, 128, "0.0.0.0");
+ snprintf(cfgNode.key, 128,
+ "364d111d729a6eb6d2e6113e163f017b5ef03a6f94c9b5b7bb1bb36fa5cb07a9");
+ cfgNode.port = 60000;
+ cfgNode.relay = 1;
+
+ if (argp_parse(&argp, argc, argv, 0, 0, &cfgNode)
+ == ARGP_ERR_UNKNOWN) {
+ show_help_and_exit();
+ }
+
+ char jsonConfig[2048];
+ snprintf(jsonConfig, 2048, "{ \
+ \"host\": \"%s\", \
+ \"port\": %d, \
+ \"relay\": true, \
+ \"clusterId\": 16, \
+ \"shards\": [ 1, 32, 64, 128, 256 ], \
+ \"logLevel\": \"FATAL\", \
+ \"discv5Discovery\": true, \
+ \"discv5BootstrapNodes\": \
+ [\"enr:-QESuEB4Dchgjn7gfAvwB00CxTA-nGiyk-aALI-H4dYSZD3rUk7bZHmP8d2U6xDiQ2vZffpo45Jp7zKNdnwDUx6g4o6XAYJpZIJ2NIJpcIRA4VDAim11bHRpYWRkcnO4XAArNiZub2RlLTAxLmRvLWFtczMud2FrdS5zYW5kYm94LnN0YXR1cy5pbQZ2XwAtNiZub2RlLTAxLmRvLWFtczMud2FrdS5zYW5kYm94LnN0YXR1cy5pbQYfQN4DgnJzkwABCAAAAAEAAgADAAQABQAGAAeJc2VjcDI1NmsxoQOvD3S3jUNICsrOILlmhENiWAMmMVlAl6-Q8wRB7hidY4N0Y3CCdl-DdWRwgiMohXdha3UyDw\", \"enr:-QEkuEBIkb8q8_mrorHndoXH9t5N6ZfD-jehQCrYeoJDPHqT0l0wyaONa2-piRQsi3oVKAzDShDVeoQhy0uwN1xbZfPZAYJpZIJ2NIJpcIQiQlleim11bHRpYWRkcnO4bgA0Ni9ub2RlLTAxLmdjLXVzLWNlbnRyYWwxLWEud2FrdS5zYW5kYm94LnN0YXR1cy5pbQZ2XwA2Ni9ub2RlLTAxLmdjLXVzLWNlbnRyYWwxLWEud2FrdS5zYW5kYm94LnN0YXR1cy5pbQYfQN4DgnJzkwABCAAAAAEAAgADAAQABQAGAAeJc2VjcDI1NmsxoQKnGt-GSgqPSf3IAPM7bFgTlpczpMZZLF3geeoNNsxzSoN0Y3CCdl-DdWRwgiMohXdha3UyDw\"], \
+ \"discv5UdpPort\": 9999, \
+ \"dnsDiscoveryUrl\": \"enrtree://AMOJVZX4V6EXP7NTJPMAYJYST2QP6AJXYW76IU6VGJS7UVSNDYZG4@boot.prod.status.nodes.status.im\", \
+ \"dnsDiscoveryNameServers\": [\"8.8.8.8\", \"1.0.0.1\"] \
+ }", cfgNode.host,
+ cfgNode.port);
+
+ void* ctx =
+ waku_new(jsonConfig,
+ cify([](const char* msg, size_t len) {
+ std::cout << "waku_new feedback: " << msg << std::endl;
+ }
+ ),
+ nullptr
+ );
+ waitForCallback();
+
+ // example on how to retrieve a value from the `libwaku` callback.
+ std::string defaultPubsubTopic;
+ WAKU_CALL(
+ waku_default_pubsub_topic(
+ ctx,
+ cify([&defaultPubsubTopic](const char* msg, size_t len) {
+ defaultPubsubTopic = msg;
+ }
+ ),
+ nullptr));
+
+ std::cout << "Default pubsub topic: " << defaultPubsubTopic << std::endl;
+
+ WAKU_CALL(waku_version(ctx,
+ cify([&](const char* msg, size_t len) {
+ std::cout << "Git Version: " << msg << std::endl;
+ }),
+ nullptr));
+
+ printf("Bind addr: %s:%u\n", cfgNode.host, cfgNode.port);
+ printf("Waku Relay enabled: %s\n", cfgNode.relay == 1 ? "YES": "NO");
+
+ std::string pubsubTopic;
+ WAKU_CALL(waku_pubsub_topic(ctx,
+ "example",
+ cify([&](const char* msg, size_t len) {
+ pubsubTopic = msg;
+ }),
+ nullptr));
+
+ std::cout << "Custom pubsub topic: " << pubsubTopic << std::endl;
+
+ waku_set_event_callback(ctx,
+ cify([&](const char* msg, size_t len) {
+ event_handler(msg, len);
+ }),
+ nullptr);
+
+ WAKU_CALL( waku_start(ctx,
+ cify([&](const char* msg, size_t len) {
+ event_handler(msg, len);
+ }),
+ nullptr));
+
+ WAKU_CALL( waku_relay_subscribe(ctx,
+ defaultPubsubTopic.c_str(),
+ cify([&](const char* msg, size_t len) {
+ event_handler(msg, len);
+ }),
+ nullptr) );
+
+ show_main_menu();
+ while(1) {
+ handle_user_input(ctx);
+ }
+}
diff --git a/third-party/nwaku/examples/filter_subscriber.nim b/third-party/nwaku/examples/filter_subscriber.nim
new file mode 100644
index 0000000..e4e26bd
--- /dev/null
+++ b/third-party/nwaku/examples/filter_subscriber.nim
@@ -0,0 +1,117 @@
+import
+ std/[tables, sequtils],
+ stew/byteutils,
+ chronicles,
+ chronos,
+ confutils,
+ libp2p/crypto/crypto,
+ eth/keys,
+ eth/p2p/discoveryv5/enr
+
+import
+ waku/[
+ common/logging,
+ node/peer_manager,
+ waku_core,
+ waku_node,
+ waku_enr,
+ discovery/waku_discv5,
+ factory/builder,
+ waku_relay,
+ waku_filter_v2/client,
+ ]
+
+# careful if running pub and sub in the same machine
+const wakuPort = 50000
+
+const clusterId = 1
+const shardId = @[0'u16]
+
+const
+ FilterPeer =
+ "/ip4/64.225.80.192/tcp/30303/p2p/16Uiu2HAmNaeL4p3WEYzC9mgXBmBWSgWjPHRvatZTXnp8Jgv3iKsb"
+ FilterPubsubTopic = PubsubTopic("/waku/2/rs/1/0")
+ FilterContentTopic = ContentTopic("/examples/1/light-pubsub-example/proto")
+
+proc messagePushHandler(
+ pubsubTopic: PubsubTopic, message: WakuMessage
+) {.async, gcsafe.} =
+ let payloadStr = string.fromBytes(message.payload)
+ notice "message received",
+ payload = payloadStr,
+ pubsubTopic = pubsubTopic,
+ contentTopic = message.contentTopic,
+ timestamp = message.timestamp
+
+proc setupAndSubscribe(rng: ref HmacDrbgContext) {.async.} =
+ # use notice to filter all waku messaging
+ setupLog(logging.LogLevel.NOTICE, logging.LogFormat.TEXT)
+
+ notice "starting subscriber", wakuPort = wakuPort
+ let
+ nodeKey = crypto.PrivateKey.random(Secp256k1, rng[])[]
+ ip = parseIpAddress("0.0.0.0")
+ flags = CapabilitiesBitfield.init(relay = true)
+
+ let relayShards = RelayShards.init(clusterId, shardId).valueOr:
+ error "Relay shards initialization failed", error = error
+ quit(QuitFailure)
+
+ var enrBuilder = EnrBuilder.init(nodeKey)
+ enrBuilder.withWakuRelaySharding(relayShards).expect(
+ "Building ENR with relay sharding failed"
+ )
+
+ let recordRes = enrBuilder.build()
+ let record =
+ if recordRes.isErr():
+ error "failed to create enr record", error = recordRes.error
+ quit(QuitFailure)
+ else:
+ recordRes.get()
+
+ var builder = WakuNodeBuilder.init()
+ builder.withNodeKey(nodeKey)
+ builder.withRecord(record)
+ builder.withNetworkConfigurationDetails(ip, Port(wakuPort)).tryGet()
+ let node = builder.build().tryGet()
+
+ node.mountMetadata(clusterId, shardId).expect(
+ "failed to mount waku metadata protocol"
+ )
+ await node.mountFilterClient()
+
+ await node.start()
+
+ node.peerManager.start()
+
+ node.wakuFilterClient.registerPushHandler(messagePushHandler)
+
+ let filterPeer = parsePeerInfo(FilterPeer).get()
+
+ while true:
+ notice "maintaining subscription"
+ # First use filter-ping to check if we have an active subscription
+ let pingRes = await node.wakuFilterClient.ping(filterPeer)
+ if pingRes.isErr():
+ # No subscription found. Let's subscribe.
+ notice "no subscription found. Sending subscribe request"
+
+ let subscribeRes = await node.wakuFilterClient.subscribe(
+ filterPeer, FilterPubsubTopic, @[FilterContentTopic]
+ )
+
+ if subscribeRes.isErr():
+ notice "subscribe request failed. Quitting.", err = subscribeRes.error
+ break
+ else:
+ notice "subscribe request successful."
+ else:
+ notice "subscription found."
+
+ await sleepAsync(60.seconds) # Subscription maintenance interval
+
+when isMainModule:
+ let rng = crypto.newRng()
+ asyncSpawn setupAndSubscribe(rng)
+ runForever()
diff --git a/third-party/nwaku/examples/golang/README.md b/third-party/nwaku/examples/golang/README.md
new file mode 100644
index 0000000..39d4882
--- /dev/null
+++ b/third-party/nwaku/examples/golang/README.md
@@ -0,0 +1,44 @@
+
+## Pre-requisite
+libwaku.so is needed to be compiled and present in build folder. To create it:
+
+- Run only the first time and after changing the current commit
+```code
+make update
+```
+- Run the next every time you want to compile libwaku
+```code
+make POSTGRES=1 libwaku -j4
+```
+
+Also needed:
+
+- Install libpq (needed by Postgres client)
+ - On Linux:
+```code
+sudo apt install libpq5
+```
+ - On MacOS (not tested)
+```code
+brew install libpq
+```
+
+## Compilation
+
+From the nwaku root folder:
+
+```code
+go build -o waku-go examples/golang/waku.go
+```
+
+## Run
+From the nwaku root folder:
+
+
+```code
+export LD_LIBRARY_PATH=build
+```
+
+```code
+./waku-go
+```
diff --git a/third-party/nwaku/examples/golang/waku.go b/third-party/nwaku/examples/golang/waku.go
new file mode 100644
index 0000000..846362d
--- /dev/null
+++ b/third-party/nwaku/examples/golang/waku.go
@@ -0,0 +1,652 @@
+package main
+
+/*
+ #cgo LDFLAGS: -L../../build/ -lwaku
+ #cgo LDFLAGS: -L../../ -Wl,-rpath,../../
+
+ #include "../../library/libwaku.h"
+ #include
+ #include
+
+ extern void globalEventCallback(int ret, char* msg, size_t len, void* userData);
+
+ typedef struct {
+ int ret;
+ char* msg;
+ size_t len;
+ } Resp;
+
+ static void* allocResp() {
+ return calloc(1, sizeof(Resp));
+ }
+
+ static void freeResp(void* resp) {
+ if (resp != NULL) {
+ free(resp);
+ }
+ }
+
+ static char* getMyCharPtr(void* resp) {
+ if (resp == NULL) {
+ return NULL;
+ }
+ Resp* m = (Resp*) resp;
+ return m->msg;
+ }
+
+ static size_t getMyCharLen(void* resp) {
+ if (resp == NULL) {
+ return 0;
+ }
+ Resp* m = (Resp*) resp;
+ return m->len;
+ }
+
+ static int getRet(void* resp) {
+ if (resp == NULL) {
+ return 0;
+ }
+ Resp* m = (Resp*) resp;
+ return m->ret;
+ }
+
+ // resp must be set != NULL in case interest on retrieving data from the callback
+ static void callback(int ret, char* msg, size_t len, void* resp) {
+ if (resp != NULL) {
+ Resp* m = (Resp*) resp;
+ m->ret = ret;
+ m->msg = msg;
+ m->len = len;
+ }
+ }
+
+ #define WAKU_CALL(call) \
+ do { \
+ int ret = call; \
+ if (ret != 0) { \
+ printf("Failed the call to: %s. Returned code: %d\n", #call, ret); \
+ exit(1); \
+ } \
+ } while (0)
+
+ static void* cGoWakuNew(const char* configJson, void* resp) {
+ // We pass NULL because we are not interested in retrieving data from this callback
+ void* ret = waku_new(configJson, (WakuCallBack) callback, resp);
+ return ret;
+ }
+
+ static void cGoWakuStart(void* wakuCtx, void* resp) {
+ WAKU_CALL(waku_start(wakuCtx, (WakuCallBack) callback, resp));
+ }
+
+ static void cGoWakuStop(void* wakuCtx, void* resp) {
+ WAKU_CALL(waku_stop(wakuCtx, (WakuCallBack) callback, resp));
+ }
+
+ static void cGoWakuDestroy(void* wakuCtx, void* resp) {
+ WAKU_CALL(waku_destroy(wakuCtx, (WakuCallBack) callback, resp));
+ }
+
+ static void cGoWakuStartDiscV5(void* wakuCtx, void* resp) {
+ WAKU_CALL(waku_start_discv5(wakuCtx, (WakuCallBack) callback, resp));
+ }
+
+ static void cGoWakuStopDiscV5(void* wakuCtx, void* resp) {
+ WAKU_CALL(waku_stop_discv5(wakuCtx, (WakuCallBack) callback, resp));
+ }
+
+ static void cGoWakuVersion(void* wakuCtx, void* resp) {
+ WAKU_CALL(waku_version(wakuCtx, (WakuCallBack) callback, resp));
+ }
+
+ static void cGoWakuSetEventCallback(void* wakuCtx) {
+ // The 'globalEventCallback' Go function is shared amongst all possible Waku instances.
+
+ // Given that the 'globalEventCallback' is shared, we pass again the
+ // wakuCtx instance but in this case is needed to pick up the correct method
+ // that will handle the event.
+
+ // In other words, for every call the libwaku makes to globalEventCallback,
+ // the 'userData' parameter will bring the context of the node that registered
+ // that globalEventCallback.
+
+ // This technique is needed because cgo only allows to export Go functions and not methods.
+
+ waku_set_event_callback(wakuCtx, (WakuCallBack) globalEventCallback, wakuCtx);
+ }
+
+ static void cGoWakuContentTopic(void* wakuCtx,
+ char* appName,
+ int appVersion,
+ char* contentTopicName,
+ char* encoding,
+ void* resp) {
+
+ WAKU_CALL( waku_content_topic(wakuCtx,
+ appName,
+ appVersion,
+ contentTopicName,
+ encoding,
+ (WakuCallBack) callback,
+ resp) );
+ }
+
+ static void cGoWakuPubsubTopic(void* wakuCtx, char* topicName, void* resp) {
+ WAKU_CALL( waku_pubsub_topic(wakuCtx, topicName, (WakuCallBack) callback, resp) );
+ }
+
+ static void cGoWakuDefaultPubsubTopic(void* wakuCtx, void* resp) {
+ WAKU_CALL (waku_default_pubsub_topic(wakuCtx, (WakuCallBack) callback, resp));
+ }
+
+ static void cGoWakuRelayPublish(void* wakuCtx,
+ const char* pubSubTopic,
+ const char* jsonWakuMessage,
+ int timeoutMs,
+ void* resp) {
+
+ WAKU_CALL (waku_relay_publish(wakuCtx,
+ pubSubTopic,
+ jsonWakuMessage,
+ timeoutMs,
+ (WakuCallBack) callback,
+ resp));
+ }
+
+ static void cGoWakuRelaySubscribe(void* wakuCtx, char* pubSubTopic, void* resp) {
+ WAKU_CALL ( waku_relay_subscribe(wakuCtx,
+ pubSubTopic,
+ (WakuCallBack) callback,
+ resp) );
+ }
+
+ static void cGoWakuRelayUnsubscribe(void* wakuCtx, char* pubSubTopic, void* resp) {
+
+ WAKU_CALL ( waku_relay_unsubscribe(wakuCtx,
+ pubSubTopic,
+ (WakuCallBack) callback,
+ resp) );
+ }
+
+ static void cGoWakuConnect(void* wakuCtx, char* peerMultiAddr, int timeoutMs, void* resp) {
+ WAKU_CALL( waku_connect(wakuCtx,
+ peerMultiAddr,
+ timeoutMs,
+ (WakuCallBack) callback,
+ resp) );
+ }
+
+ static void cGoWakuDialPeerById(void* wakuCtx,
+ char* peerId,
+ char* protocol,
+ int timeoutMs,
+ void* resp) {
+
+ WAKU_CALL( waku_dial_peer_by_id(wakuCtx,
+ peerId,
+ protocol,
+ timeoutMs,
+ (WakuCallBack) callback,
+ resp) );
+ }
+
+ static void cGoWakuDisconnectPeerById(void* wakuCtx, char* peerId, void* resp) {
+ WAKU_CALL( waku_disconnect_peer_by_id(wakuCtx,
+ peerId,
+ (WakuCallBack) callback,
+ resp) );
+ }
+
+ static void cGoWakuListenAddresses(void* wakuCtx, void* resp) {
+ WAKU_CALL (waku_listen_addresses(wakuCtx, (WakuCallBack) callback, resp) );
+ }
+
+ static void cGoWakuGetMyENR(void* ctx, void* resp) {
+ WAKU_CALL (waku_get_my_enr(ctx, (WakuCallBack) callback, resp) );
+ }
+
+ static void cGoWakuGetMyPeerId(void* ctx, void* resp) {
+ WAKU_CALL (waku_get_my_peerid(ctx, (WakuCallBack) callback, resp) );
+ }
+
+ static void cGoWakuListPeersInMesh(void* ctx, char* pubSubTopic, void* resp) {
+ WAKU_CALL (waku_relay_get_num_peers_in_mesh(ctx, pubSubTopic, (WakuCallBack) callback, resp) );
+ }
+
+ static void cGoWakuGetNumConnectedPeers(void* ctx, char* pubSubTopic, void* resp) {
+ WAKU_CALL (waku_relay_get_num_connected_peers(ctx, pubSubTopic, (WakuCallBack) callback, resp) );
+ }
+
+ static void cGoWakuGetPeerIdsFromPeerStore(void* wakuCtx, void* resp) {
+ WAKU_CALL (waku_get_peerids_from_peerstore(wakuCtx, (WakuCallBack) callback, resp) );
+ }
+
+ static void cGoWakuLightpushPublish(void* wakuCtx,
+ const char* pubSubTopic,
+ const char* jsonWakuMessage,
+ void* resp) {
+
+ WAKU_CALL (waku_lightpush_publish(wakuCtx,
+ pubSubTopic,
+ jsonWakuMessage,
+ (WakuCallBack) callback,
+ resp));
+ }
+
+ static void cGoWakuStoreQuery(void* wakuCtx,
+ const char* jsonQuery,
+ const char* peerAddr,
+ int timeoutMs,
+ void* resp) {
+
+ WAKU_CALL (waku_store_query(wakuCtx,
+ jsonQuery,
+ peerAddr,
+ timeoutMs,
+ (WakuCallBack) callback,
+ resp));
+ }
+
+ static void cGoWakuPeerExchangeQuery(void* wakuCtx,
+ uint64_t numPeers,
+ void* resp) {
+
+ WAKU_CALL (waku_peer_exchange_request(wakuCtx,
+ numPeers,
+ (WakuCallBack) callback,
+ resp));
+ }
+
+ static void cGoWakuGetPeerIdsByProtocol(void* wakuCtx,
+ const char* protocol,
+ void* resp) {
+
+ WAKU_CALL (waku_get_peerids_by_protocol(wakuCtx,
+ protocol,
+ (WakuCallBack) callback,
+ resp));
+ }
+
+*/
+import "C"
+
+import (
+ "encoding/json"
+ "errors"
+ "fmt"
+ "os"
+ "os/signal"
+ "syscall"
+ "unsafe"
+)
+
+type WakuMessageHash = string
+type WakuPubsubTopic = string
+type WakuContentTopic = string
+
+type WakuConfig struct {
+ Host string `json:"host,omitempty"`
+ Port int `json:"port,omitempty"`
+ NodeKey string `json:"key,omitempty"`
+ EnableRelay bool `json:"relay"`
+ LogLevel string `json:"logLevel"`
+}
+
+type WakuNode struct {
+ ctx unsafe.Pointer
+}
+
+func WakuNew(config WakuConfig) (*WakuNode, error) {
+ jsonConfig, err := json.Marshal(config)
+ if err != nil {
+ return nil, err
+ }
+
+ var cJsonConfig = C.CString(string(jsonConfig))
+ var resp = C.allocResp()
+
+ defer C.free(unsafe.Pointer(cJsonConfig))
+ defer C.freeResp(resp)
+
+ ctx := C.cGoWakuNew(cJsonConfig, resp)
+ if C.getRet(resp) == C.RET_OK {
+ return &WakuNode{ctx: ctx}, nil
+ }
+
+ errMsg := "error WakuNew: " + C.GoStringN(C.getMyCharPtr(resp), C.int(C.getMyCharLen(resp)))
+ return nil, errors.New(errMsg)
+}
+
+func (self *WakuNode) WakuStart() error {
+ var resp = C.allocResp()
+ defer C.freeResp(resp)
+ C.cGoWakuStart(self.ctx, resp)
+
+ if C.getRet(resp) == C.RET_OK {
+ return nil
+ }
+ errMsg := "error WakuStart: " + C.GoStringN(C.getMyCharPtr(resp), C.int(C.getMyCharLen(resp)))
+ return errors.New(errMsg)
+}
+
+func (self *WakuNode) WakuStop() error {
+ var resp = C.allocResp()
+ defer C.freeResp(resp)
+ C.cGoWakuStop(self.ctx, resp)
+
+ if C.getRet(resp) == C.RET_OK {
+ return nil
+ }
+ errMsg := "error WakuStop: " + C.GoStringN(C.getMyCharPtr(resp), C.int(C.getMyCharLen(resp)))
+ return errors.New(errMsg)
+}
+
+func (self *WakuNode) WakuDestroy() error {
+ var resp = C.allocResp()
+ defer C.freeResp(resp)
+ C.cGoWakuDestroy(self.ctx, resp)
+
+ if C.getRet(resp) == C.RET_OK {
+ return nil
+ }
+ errMsg := "error WakuDestroy: " + C.GoStringN(C.getMyCharPtr(resp), C.int(C.getMyCharLen(resp)))
+ return errors.New(errMsg)
+}
+
+func (self *WakuNode) WakuVersion() (string, error) {
+ var resp = C.allocResp()
+ defer C.freeResp(resp)
+
+ C.cGoWakuVersion(self.ctx, resp)
+
+ if C.getRet(resp) == C.RET_OK {
+ var version = C.GoStringN(C.getMyCharPtr(resp), C.int(C.getMyCharLen(resp)))
+ return version, nil
+ }
+
+ errMsg := "error WakuVersion: " +
+ C.GoStringN(C.getMyCharPtr(resp), C.int(C.getMyCharLen(resp)))
+ return "", errors.New(errMsg)
+}
+
+//export globalEventCallback
+func globalEventCallback(callerRet C.int, msg *C.char, len C.size_t, userData unsafe.Pointer) {
+ // This is shared among all Golang instances
+
+ self := WakuNode{ctx: userData}
+ self.MyEventCallback(callerRet, msg, len)
+}
+
+func (self *WakuNode) MyEventCallback(callerRet C.int, msg *C.char, len C.size_t) {
+ fmt.Println("Event received:", C.GoStringN(msg, C.int(len)))
+}
+
+func (self *WakuNode) WakuSetEventCallback() {
+ // Notice that the events for self node are handled by the 'MyEventCallback' method
+ C.cGoWakuSetEventCallback(self.ctx)
+}
+
+func (self *WakuNode) FormatContentTopic(
+ appName string,
+ appVersion int,
+ contentTopicName string,
+ encoding string) (WakuContentTopic, error) {
+
+ var cAppName = C.CString(appName)
+ var cContentTopicName = C.CString(contentTopicName)
+ var cEncoding = C.CString(encoding)
+ var resp = C.allocResp()
+
+ defer C.free(unsafe.Pointer(cAppName))
+ defer C.free(unsafe.Pointer(cContentTopicName))
+ defer C.free(unsafe.Pointer(cEncoding))
+ defer C.freeResp(resp)
+
+ C.cGoWakuContentTopic(self.ctx,
+ cAppName,
+ C.int(appVersion),
+ cContentTopicName,
+ cEncoding,
+ resp)
+
+ if C.getRet(resp) == C.RET_OK {
+ var contentTopic = C.GoStringN(C.getMyCharPtr(resp), C.int(C.getMyCharLen(resp)))
+ return contentTopic, nil
+ }
+
+ errMsg := "error FormatContentTopic: " +
+ C.GoStringN(C.getMyCharPtr(resp), C.int(C.getMyCharLen(resp)))
+
+ return "", errors.New(errMsg)
+}
+
+func (self *WakuNode) FormatPubsubTopic(topicName string) (WakuPubsubTopic, error) {
+ var cTopicName = C.CString(topicName)
+ var resp = C.allocResp()
+
+ defer C.free(unsafe.Pointer(cTopicName))
+ defer C.freeResp(resp)
+
+ C.cGoWakuPubsubTopic(self.ctx, cTopicName, resp)
+ if C.getRet(resp) == C.RET_OK {
+ var pubsubTopic = C.GoStringN(C.getMyCharPtr(resp), C.int(C.getMyCharLen(resp)))
+ return pubsubTopic, nil
+ }
+
+ errMsg := "error FormatPubsubTopic: " +
+ C.GoStringN(C.getMyCharPtr(resp), C.int(C.getMyCharLen(resp)))
+
+ return "", errors.New(errMsg)
+}
+
+func (self *WakuNode) WakuDefaultPubsubTopic() (WakuPubsubTopic, error) {
+ var resp = C.allocResp()
+ defer C.freeResp(resp)
+ C.cGoWakuDefaultPubsubTopic(self.ctx, resp)
+ if C.getRet(resp) == C.RET_OK {
+ var defaultPubsubTopic = C.GoStringN(C.getMyCharPtr(resp), C.int(C.getMyCharLen(resp)))
+ return defaultPubsubTopic, nil
+ }
+
+ errMsg := "error WakuDefaultPubsubTopic: " +
+ C.GoStringN(C.getMyCharPtr(resp), C.int(C.getMyCharLen(resp)))
+
+ return "", errors.New(errMsg)
+}
+
+func (self *WakuNode) WakuRelayPublish(
+ pubsubTopic string,
+ message string,
+ timeoutMs int) (WakuMessageHash, error) {
+
+ var cPubsubTopic = C.CString(pubsubTopic)
+ var msg = C.CString(message)
+ var resp = C.allocResp()
+
+ defer C.freeResp(resp)
+ defer C.free(unsafe.Pointer(cPubsubTopic))
+ defer C.free(unsafe.Pointer(msg))
+
+ C.cGoWakuRelayPublish(self.ctx, cPubsubTopic, msg, C.int(timeoutMs), resp)
+ if C.getRet(resp) == C.RET_OK {
+ msgHash := C.GoStringN(C.getMyCharPtr(resp), C.int(C.getMyCharLen(resp)))
+ return msgHash, nil
+ }
+ errMsg := "error WakuRelayPublish: " +
+ C.GoStringN(C.getMyCharPtr(resp), C.int(C.getMyCharLen(resp)))
+ return "", errors.New(errMsg)
+}
+
+func (self *WakuNode) WakuRelaySubscribe(pubsubTopic string) error {
+ var resp = C.allocResp()
+ var cPubsubTopic = C.CString(pubsubTopic)
+
+ defer C.freeResp(resp)
+ defer C.free(unsafe.Pointer(cPubsubTopic))
+ C.cGoWakuRelaySubscribe(self.ctx, cPubsubTopic, resp)
+
+ if C.getRet(resp) == C.RET_OK {
+ return nil
+ }
+ errMsg := "error WakuRelaySubscribe: " +
+ C.GoStringN(C.getMyCharPtr(resp), C.int(C.getMyCharLen(resp)))
+ return errors.New(errMsg)
+}
+
+func (self *WakuNode) WakuRelayUnsubscribe(pubsubTopic string) error {
+ var resp = C.allocResp()
+ var cPubsubTopic = C.CString(pubsubTopic)
+ defer C.freeResp(resp)
+ defer C.free(unsafe.Pointer(cPubsubTopic))
+ C.cGoWakuRelayUnsubscribe(self.ctx, cPubsubTopic, resp)
+
+ if C.getRet(resp) == C.RET_OK {
+ return nil
+ }
+ errMsg := "error WakuRelayUnsubscribe: " +
+ C.GoStringN(C.getMyCharPtr(resp), C.int(C.getMyCharLen(resp)))
+ return errors.New(errMsg)
+}
+
+func (self *WakuNode) WakuConnect(peerMultiAddr string, timeoutMs int) error {
+ var resp = C.allocResp()
+ var cPeerMultiAddr = C.CString(peerMultiAddr)
+ defer C.freeResp(resp)
+ defer C.free(unsafe.Pointer(cPeerMultiAddr))
+
+ C.cGoWakuConnect(self.ctx, cPeerMultiAddr, C.int(timeoutMs), resp)
+
+ if C.getRet(resp) == C.RET_OK {
+ return nil
+ }
+ errMsg := "error WakuConnect: " +
+ C.GoStringN(C.getMyCharPtr(resp), C.int(C.getMyCharLen(resp)))
+ return errors.New(errMsg)
+}
+
+func (self *WakuNode) WakuListenAddresses() (string, error) {
+ var resp = C.allocResp()
+ defer C.freeResp(resp)
+ C.cGoWakuListenAddresses(self.ctx, resp)
+
+ if C.getRet(resp) == C.RET_OK {
+ var listenAddresses = C.GoStringN(C.getMyCharPtr(resp), C.int(C.getMyCharLen(resp)))
+ return listenAddresses, nil
+ }
+ errMsg := "error WakuListenAddresses: " +
+ C.GoStringN(C.getMyCharPtr(resp), C.int(C.getMyCharLen(resp)))
+ return "", errors.New(errMsg)
+}
+
+func (self *WakuNode) WakuGetMyENR() (string, error) {
+ var resp = C.allocResp()
+ defer C.freeResp(resp)
+ C.cGoWakuGetMyENR(self.ctx, resp)
+
+ if C.getRet(resp) == C.RET_OK {
+ var myENR = C.GoStringN(C.getMyCharPtr(resp), C.int(C.getMyCharLen(resp)))
+ return myENR, nil
+ }
+ errMsg := "error WakuGetMyENR: " +
+ C.GoStringN(C.getMyCharPtr(resp), C.int(C.getMyCharLen(resp)))
+ return "", errors.New(errMsg)
+}
+
+func main() {
+ config := WakuConfig{
+ Host: "0.0.0.0",
+ Port: 30304,
+ NodeKey: "11d0dcea28e86f81937a3bd1163473c7fbc0a0db54fd72914849bc47bdf78710",
+ EnableRelay: true,
+ LogLevel: "DEBUG",
+ }
+
+ node, err := WakuNew(config)
+ if err != nil {
+ fmt.Println("Error happened:", err.Error())
+ return
+ }
+
+ node.WakuSetEventCallback()
+
+ defaultPubsubTopic, err := node.WakuDefaultPubsubTopic()
+ if err != nil {
+ fmt.Println("Error happened:", err.Error())
+ return
+ }
+
+ err = node.WakuRelaySubscribe(defaultPubsubTopic)
+ if err != nil {
+ fmt.Println("Error happened:", err.Error())
+ return
+ }
+
+ err = node.WakuConnect(
+ // tries to connect to a localhost node with key: 0d714a1fada214dead6dc9c7274585eca0ff292451866e7d6d677dc818e8ccd2
+ "/ip4/0.0.0.0/tcp/60000/p2p/16Uiu2HAmVFXtAfSj4EiR7mL2KvL4EE2wztuQgUSBoj2Jx2KeXFLN",
+ 10000)
+ if err != nil {
+ fmt.Println("Error happened:", err.Error())
+ return
+ }
+
+ err = node.WakuStart()
+ if err != nil {
+ fmt.Println("Error happened:", err.Error())
+ return
+ }
+
+ version, err := node.WakuVersion()
+ if err != nil {
+ fmt.Println("Error happened:", err.Error())
+ return
+ }
+
+ formattedContentTopic, err := node.FormatContentTopic("appName", 1, "cTopicName", "enc")
+ if err != nil {
+ fmt.Println("Error happened:", err.Error())
+ return
+ }
+
+ formattedPubsubTopic, err := node.FormatPubsubTopic("my-ctopic")
+ if err != nil {
+ fmt.Println("Error happened:", err.Error())
+ return
+ }
+
+ listenAddresses, err := node.WakuListenAddresses()
+ if err != nil {
+ fmt.Println("Error happened:", err.Error())
+ return
+ }
+
+ myENR, err := node.WakuGetMyENR()
+ if err != nil {
+ fmt.Println("Error happened:", err.Error())
+ return
+ }
+
+ fmt.Println("Version:", version)
+ fmt.Println("Custom content topic:", formattedContentTopic)
+ fmt.Println("Custom pubsub topic:", formattedPubsubTopic)
+ fmt.Println("Default pubsub topic:", defaultPubsubTopic)
+ fmt.Println("Listen addresses:", listenAddresses)
+ fmt.Println("My ENR:", myENR)
+
+ // Wait for a SIGINT or SIGTERM signal
+ ch := make(chan os.Signal, 1)
+ signal.Notify(ch, syscall.SIGINT, syscall.SIGTERM)
+ <-ch
+
+ err = node.WakuStop()
+ if err != nil {
+ fmt.Println("Error happened:", err.Error())
+ return
+ }
+
+ err = node.WakuDestroy()
+ if err != nil {
+ fmt.Println("Error happened:", err.Error())
+ return
+ }
+}
diff --git a/third-party/nwaku/examples/lightpush_mix/lightpush_publisher_mix.nim b/third-party/nwaku/examples/lightpush_mix/lightpush_publisher_mix.nim
new file mode 100644
index 0000000..26c0a06
--- /dev/null
+++ b/third-party/nwaku/examples/lightpush_mix/lightpush_publisher_mix.nim
@@ -0,0 +1,196 @@
+import
+ std/[tables, times, sequtils, strutils],
+ stew/byteutils,
+ chronicles,
+ results,
+ chronos,
+ confutils,
+ libp2p/crypto/crypto,
+ libp2p/crypto/curve25519,
+ libp2p/multiaddress,
+ eth/keys,
+ eth/p2p/discoveryv5/enr,
+ metrics,
+ metrics/chronos_httpserver
+
+import mix, mix/mix_protocol, mix/curve25519
+
+import
+ waku/[
+ common/logging,
+ node/peer_manager,
+ waku_core,
+ waku_core/codecs,
+ waku_node,
+ waku_enr,
+ discovery/waku_discv5,
+ factory/builder,
+ waku_lightpush/client,
+ ],
+ ./lightpush_publisher_mix_config,
+ ./lightpush_publisher_mix_metrics
+
+const clusterId = 66
+const shardId = @[0'u16]
+
+const
+ LightpushPubsubTopic = PubsubTopic("/waku/2/rs/66/0")
+ LightpushContentTopic = ContentTopic("/examples/1/light-pubsub-mix-example/proto")
+
+proc splitPeerIdAndAddr(maddr: string): (string, string) =
+ let parts = maddr.split("/p2p/")
+ if parts.len != 2:
+ error "Invalid multiaddress format", parts = parts
+ return
+
+ let
+ address = parts[0]
+ peerId = parts[1]
+ return (address, peerId)
+
+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
+ nodeKey = crypto.PrivateKey.random(Secp256k1, rng[]).get()
+ ip = parseIpAddress("0.0.0.0")
+ flags = CapabilitiesBitfield.init(relay = true)
+
+ let relayShards = RelayShards.init(clusterId, shardId).valueOr:
+ error "Relay shards initialization failed", error = error
+ quit(QuitFailure)
+
+ var enrBuilder = EnrBuilder.init(nodeKey)
+ enrBuilder.withWakuRelaySharding(relayShards).expect(
+ "Building ENR with relay sharding failed"
+ )
+
+ let record = enrBuilder.build().valueOr:
+ error "failed to create enr record", error = error
+ quit(QuitFailure)
+
+ setLogLevel(logging.LogLevel.TRACE)
+ var builder = WakuNodeBuilder.init()
+ builder.withNodeKey(nodeKey)
+ builder.withRecord(record)
+ builder.withNetworkConfigurationDetails(ip, Port(conf.port)).tryGet()
+
+ let node = builder.build().tryGet()
+
+ node.mountMetadata(clusterId, shardId).expect(
+ "failed to mount waku metadata protocol"
+ )
+ node.mountLightPushClient()
+ try:
+ await node.mountPeerExchange(some(uint16(clusterId)))
+ except CatchableError:
+ error "failed to mount waku peer-exchange protocol",
+ error = getCurrentExceptionMsg()
+ return
+
+ let (destPeerAddr, destPeerId) = splitPeerIdAndAddr(conf.destPeerAddr)
+ let (pxPeerAddr, pxPeerId) = splitPeerIdAndAddr(conf.pxAddr)
+ info "dest peer address", destPeerAddr = destPeerAddr, destPeerId = destPeerId
+ info "peer exchange address", pxPeerAddr = pxPeerAddr, pxPeerId = pxPeerId
+ let pxPeerInfo =
+ RemotePeerInfo.init(destPeerId, @[MultiAddress.init(destPeerAddr).get()])
+ node.peerManager.addServicePeer(pxPeerInfo, WakuPeerExchangeCodec)
+
+ let pxPeerInfo1 =
+ RemotePeerInfo.init(pxPeerId, @[MultiAddress.init(pxPeerAddr).get()])
+ node.peerManager.addServicePeer(pxPeerInfo1, WakuPeerExchangeCodec)
+
+ if not conf.mixDisabled:
+ let (mixPrivKey, mixPubKey) = generateKeyPair().valueOr:
+ error "failed to generate mix key pair", error = error
+ return
+ (await node.mountMix(clusterId, mixPrivKey)).isOkOr:
+ error "failed to mount waku mix protocol: ", error = $error
+ return
+
+ 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
+ Opt.some(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.start()
+ node.peerManager.start()
+ node.startPeerExchangeLoop()
+ try:
+ startMetricsHttpServer("0.0.0.0", Port(8008))
+ except Exception:
+ error "failed to start metrics server: ", error = getCurrentExceptionMsg()
+ (await node.fetchPeerExchangePeers()).isOkOr:
+ warn "Cannot fetch peers from peer exchange", cause = error
+
+ if not conf.mixDisabled:
+ while node.getMixNodePoolSize() < conf.minMixPoolSize:
+ info "waiting for mix nodes to be discovered",
+ currentpoolSize = node.getMixNodePoolSize()
+ await sleepAsync(1000)
+ notice "publisher service started with mix node pool size ",
+ currentpoolSize = node.getMixNodePoolSize()
+
+ var i = 0
+ while i < conf.numMsgs:
+ 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()
+ 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.
+ This is message #""" &
+ $i & """ sent from a publisher using mix. End of transmission."""
+ let message = WakuMessage(
+ payload: toBytes(text), # content of the message
+ contentTopic: LightpushContentTopic, # content topic to publish to
+ ephemeral: true, # tell store nodes to not store it
+ timestamp: getNowInNanosecondTime(),
+ ) # current timestamp
+
+ let res = await node.wakuLightpushClient.publishWithConn(
+ LightpushPubsubTopic, message, conn, dPeerId
+ )
+
+ 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
+ lp_mix_failed.inc(labelValues = ["publish_error"])
+
+ if conf.mixDisabled:
+ await conn.close()
+ await sleepAsync(conf.msgIntervalMilliseconds)
+ info "###########Sent all messages via mix"
+ quit(0)
+
+when isMainModule:
+ let conf = LightPushMixConf.load()
+ let rng = crypto.newRng()
+ asyncSpawn setupAndPublish(rng, conf)
+ runForever()
diff --git a/third-party/nwaku/examples/lightpush_mix/lightpush_publisher_mix_config.nim b/third-party/nwaku/examples/lightpush_mix/lightpush_publisher_mix_config.nim
new file mode 100644
index 0000000..7a135e3
--- /dev/null
+++ b/third-party/nwaku/examples/lightpush_mix/lightpush_publisher_mix_config.nim
@@ -0,0 +1,28 @@
+import confutils/defs
+
+type LightPushMixConf* = object
+ destPeerAddr* {.desc: "Destination peer address with peerId.", name: "dp-addr".}:
+ string
+
+ pxAddr* {.desc: "Peer exchange address with peerId.", name: "px-addr".}: string
+
+ port* {.desc: "Port to listen on.", defaultValue: 50000, name: "port".}: int
+
+ numMsgs* {.desc: "Number of messages to send.", defaultValue: 1, name: "num-msgs".}:
+ int
+
+ msgIntervalMilliseconds* {.
+ desc: "Interval between messages in milliseconds.",
+ defaultValue: 1000,
+ name: "msg-interval"
+ .}: int
+
+ minMixPoolSize* {.
+ desc: "Number of mix nodes to be discovered before sending lightpush messages.",
+ defaultValue: 3,
+ name: "min-mix-pool-size"
+ .}: int
+
+ mixDisabled* {.
+ desc: "Do not use mix for publishing.", defaultValue: false, name: "without-mix"
+ .}: bool
diff --git a/third-party/nwaku/examples/lightpush_mix/lightpush_publisher_mix_metrics.nim b/third-party/nwaku/examples/lightpush_mix/lightpush_publisher_mix_metrics.nim
new file mode 100644
index 0000000..cd06b3e
--- /dev/null
+++ b/third-party/nwaku/examples/lightpush_mix/lightpush_publisher_mix_metrics.nim
@@ -0,0 +1,8 @@
+{.push raises: [].}
+
+import metrics
+
+declarePublicCounter lp_mix_success, "number of lightpush messages sent via mix"
+
+declarePublicCounter lp_mix_failed,
+ "number of lightpush messages failed via mix", labels = ["error"]
diff --git a/third-party/nwaku/examples/lightpush_publisher.nim b/third-party/nwaku/examples/lightpush_publisher.nim
new file mode 100644
index 0000000..e9fa217
--- /dev/null
+++ b/third-party/nwaku/examples/lightpush_publisher.nim
@@ -0,0 +1,109 @@
+import
+ std/[tables, times, sequtils],
+ stew/byteutils,
+ chronicles,
+ results,
+ chronos,
+ confutils,
+ libp2p/crypto/crypto,
+ eth/keys,
+ eth/p2p/discoveryv5/enr
+
+import
+ waku/[
+ common/logging,
+ node/peer_manager,
+ waku_core,
+ waku_node,
+ waku_enr,
+ discovery/waku_discv5,
+ factory/builder,
+ ]
+
+proc now*(): Timestamp =
+ getNanosecondTime(getTime().toUnixFloat())
+
+# careful if running pub and sub in the same machine
+const wakuPort = 60000
+
+const clusterId = 1
+const shardId = @[0'u16]
+
+const
+ LightpushPeer =
+ "/ip4/64.225.80.192/tcp/30303/p2p/16Uiu2HAmNaeL4p3WEYzC9mgXBmBWSgWjPHRvatZTXnp8Jgv3iKsb"
+ LightpushPubsubTopic = PubsubTopic("/waku/2/rs/1/0")
+ LightpushContentTopic = ContentTopic("/examples/1/light-pubsub-example/proto")
+
+proc setupAndPublish(rng: ref HmacDrbgContext) {.async.} =
+ # use notice to filter all waku messaging
+ setupLog(logging.LogLevel.NOTICE, logging.LogFormat.TEXT)
+
+ notice "starting publisher", wakuPort = wakuPort
+ let
+ nodeKey = crypto.PrivateKey.random(Secp256k1, rng[]).get()
+ ip = parseIpAddress("0.0.0.0")
+ flags = CapabilitiesBitfield.init(relay = true)
+
+ let relayShards = RelayShards.init(clusterId, shardId).valueOr:
+ error "Relay shards initialization failed", error = error
+ quit(QuitFailure)
+
+ var enrBuilder = EnrBuilder.init(nodeKey)
+ enrBuilder.withWakuRelaySharding(relayShards).expect(
+ "Building ENR with relay sharding failed"
+ )
+
+ let recordRes = enrBuilder.build()
+ let record =
+ if recordRes.isErr():
+ error "failed to create enr record", error = recordRes.error
+ quit(QuitFailure)
+ else:
+ recordRes.get()
+
+ var builder = WakuNodeBuilder.init()
+ builder.withNodeKey(nodeKey)
+ builder.withRecord(record)
+ builder.withNetworkConfigurationDetails(ip, Port(wakuPort)).tryGet()
+ let node = builder.build().tryGet()
+
+ node.mountMetadata(clusterId, shardId).expect(
+ "failed to mount waku metadata protocol"
+ )
+ node.mountLegacyLightPushClient()
+
+ await node.start()
+ node.peerManager.start()
+
+ notice "publisher service started"
+ while true:
+ let text = "hi there i'm a publisher"
+ let message = WakuMessage(
+ payload: toBytes(text), # content of the message
+ contentTopic: LightpushContentTopic, # content topic to publish to
+ ephemeral: true, # tell store nodes to not store it
+ timestamp: now(),
+ ) # current timestamp
+
+ let lightpushPeer = parsePeerInfo(LightpushPeer).get()
+
+ let res = await node.legacyLightpushPublish(
+ some(LightpushPubsubTopic), message, lightpushPeer
+ )
+
+ if res.isOk:
+ notice "published message",
+ text = text,
+ timestamp = message.timestamp,
+ psTopic = LightpushPubsubTopic,
+ contentTopic = LightpushContentTopic
+ else:
+ error "failed to publish message", error = res.error
+
+ await sleepAsync(5000)
+
+when isMainModule:
+ let rng = crypto.newRng()
+ asyncSpawn setupAndPublish(rng)
+ runForever()
diff --git a/third-party/nwaku/examples/mobile/.bundle/config b/third-party/nwaku/examples/mobile/.bundle/config
new file mode 100644
index 0000000..848943b
--- /dev/null
+++ b/third-party/nwaku/examples/mobile/.bundle/config
@@ -0,0 +1,2 @@
+BUNDLE_PATH: "vendor/bundle"
+BUNDLE_FORCE_RUBY_PLATFORM: 1
diff --git a/third-party/nwaku/examples/mobile/.eslintrc.js b/third-party/nwaku/examples/mobile/.eslintrc.js
new file mode 100644
index 0000000..187894b
--- /dev/null
+++ b/third-party/nwaku/examples/mobile/.eslintrc.js
@@ -0,0 +1,4 @@
+module.exports = {
+ root: true,
+ extends: '@react-native',
+};
diff --git a/third-party/nwaku/examples/mobile/.gitignore b/third-party/nwaku/examples/mobile/.gitignore
new file mode 100644
index 0000000..d5ae456
--- /dev/null
+++ b/third-party/nwaku/examples/mobile/.gitignore
@@ -0,0 +1,74 @@
+# OSX
+#
+.DS_Store
+
+# Xcode
+#
+build/
+*.pbxuser
+!default.pbxuser
+*.mode1v3
+!default.mode1v3
+*.mode2v3
+!default.mode2v3
+*.perspectivev3
+!default.perspectivev3
+xcuserdata
+*.xccheckout
+*.moved-aside
+DerivedData
+*.hmap
+*.ipa
+*.xcuserstate
+**/.xcode.env.local
+
+# Android/IntelliJ
+#
+build/
+.idea
+.gradle
+local.properties
+*.iml
+*.hprof
+.cxx/
+*.keystore
+!debug.keystore
+
+# node.js
+#
+node_modules/
+npm-debug.log
+yarn-error.log
+
+# fastlane
+#
+# It is recommended to not store the screenshots in the git repo. Instead, use fastlane to re-generate the
+# screenshots whenever they are needed.
+# For more information about the recommended setup visit:
+# https://docs.fastlane.tools/best-practices/source-control/
+
+**/fastlane/report.xml
+**/fastlane/Preview.html
+**/fastlane/screenshots
+**/fastlane/test_output
+
+# Bundle artifact
+*.jsbundle
+
+# Ruby / CocoaPods
+**/Pods/
+/vendor/bundle/
+
+# Temporary files created by Metro to check the health of the file watcher
+.metro-health-check*
+
+# testing
+/coverage
+
+# Yarn
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions
diff --git a/third-party/nwaku/examples/mobile/.prettierrc.js b/third-party/nwaku/examples/mobile/.prettierrc.js
new file mode 100644
index 0000000..2b54074
--- /dev/null
+++ b/third-party/nwaku/examples/mobile/.prettierrc.js
@@ -0,0 +1,7 @@
+module.exports = {
+ arrowParens: 'avoid',
+ bracketSameLine: true,
+ bracketSpacing: false,
+ singleQuote: true,
+ trailingComma: 'all',
+};
diff --git a/third-party/nwaku/examples/mobile/.watchmanconfig b/third-party/nwaku/examples/mobile/.watchmanconfig
new file mode 100644
index 0000000..0967ef4
--- /dev/null
+++ b/third-party/nwaku/examples/mobile/.watchmanconfig
@@ -0,0 +1 @@
+{}
diff --git a/third-party/nwaku/examples/mobile/.yarnrc b/third-party/nwaku/examples/mobile/.yarnrc
new file mode 100644
index 0000000..85b738b
--- /dev/null
+++ b/third-party/nwaku/examples/mobile/.yarnrc
@@ -0,0 +1,5 @@
+# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+# yarn lockfile v1
+
+
+yarn-path ".yarn/releases/yarn-1.22.22.cjs"
diff --git a/third-party/nwaku/examples/mobile/App.tsx b/third-party/nwaku/examples/mobile/App.tsx
new file mode 100644
index 0000000..bf01de3
--- /dev/null
+++ b/third-party/nwaku/examples/mobile/App.tsx
@@ -0,0 +1,327 @@
+/* eslint-disable no-alert */
+/**
+ * Sample React Native App
+ * https://github.com/facebook/react-native
+ *
+ * @format
+ */
+
+import React from 'react';
+import type {PropsWithChildren} from 'react';
+import {
+ SafeAreaView,
+ ScrollView,
+ StatusBar,
+ StyleSheet,
+ Text,
+ useColorScheme,
+ View,
+} from 'react-native';
+
+import {Colors} from 'react-native/Libraries/NewAppScreen';
+import {
+ NativeEventEmitter,
+ NativeModules,
+ EmitterSubscription,
+ Button,
+} from 'react-native';
+
+type SectionProps = PropsWithChildren<{
+ title: string;
+}>;
+
+function Section({children, title}: SectionProps): React.JSX.Element {
+ const isDarkMode = useColorScheme() === 'dark';
+ return (
+
+
+ {title}
+
+
+ {children}
+
+
+ );
+}
+
+const WakuFactory = (() => {
+ let isSetup = false;
+
+ const eventEmitter = new NativeEventEmitter(NativeModules.WakuModule);
+ class Waku {
+ wakuPtr: Number;
+
+ constructor(wakuPtr: Number) {
+ this.wakuPtr = wakuPtr;
+ }
+
+ async destroy(): Promise {
+ await NativeModules.WakuModule.destroy(this.wakuPtr);
+ }
+
+ async start(): Promise {
+ return NativeModules.WakuModule.start(this.wakuPtr);
+ }
+
+ async stop(): Promise {
+ return NativeModules.WakuModule.stop(this.wakuPtr);
+ }
+
+ async version(): Promise {
+ return NativeModules.WakuModule.version(this.wakuPtr);
+ }
+
+ async listenAddresses(): Promise> {
+ let addresses = await NativeModules.WakuModule.listenAddresses(
+ this.wakuPtr,
+ );
+ return addresses;
+ }
+
+ async connect(peerMultiaddr: String, timeoutMs: Number): Promise {
+ return NativeModules.WakuModule.connect(
+ this.wakuPtr,
+ peerMultiaddr,
+ timeoutMs,
+ );
+ }
+
+ async relaySubscribe(pubsubTopic: String): Promise {
+ return NativeModules.WakuModule.relaySubscribe(this.wakuPtr, pubsubTopic);
+ }
+
+ async relayUnsubscribe(pubsubTopic: String): Promise {
+ return NativeModules.WakuModule.relayUnsubscribe(
+ this.wakuPtr,
+ pubsubTopic,
+ );
+ }
+
+ // TODO: Use a type instead of `any`
+ async relayPublish(
+ pubsubTopic: string,
+ msg: any,
+ timeoutMs: Number,
+ ): Promise {
+ return NativeModules.WakuModule.relayPublish(
+ this.wakuPtr,
+ pubsubTopic,
+ msg,
+ timeoutMs,
+ );
+ }
+
+ onEvent(cb: (event: any) => void): EmitterSubscription {
+ return eventEmitter.addListener('wakuEvent', evt => {
+ if (evt.wakuPtr === this.wakuPtr) {
+ cb(JSON.parse(evt.event));
+ }
+ });
+ }
+ }
+
+ async function createInstance(config: any) {
+ if (!isSetup) {
+ console.debug('initializing waku library');
+ await NativeModules.WakuModule.setup();
+ isSetup = true;
+ alert('waku instance created!');
+ }
+
+ let wakuPtr = await NativeModules.WakuModule.new(config);
+ return new Waku(wakuPtr);
+ }
+
+ // Expose the factory method
+ return {
+ createInstance,
+ Waku,
+ };
+})();
+
+function App(): React.JSX.Element {
+ const isDarkMode = useColorScheme() === 'dark';
+
+ const backgroundStyle = {
+ backgroundColor: isDarkMode ? Colors.darker : Colors.lighter,
+ };
+
+ var waku: Waku;
+
+ const onClickNew = async () => {
+ const config = {
+ host: '0.0.0.0',
+ port: 42342,
+ key: '1122334455667788990011223344556677889900112233445566778899000022',
+ relay: true,
+ };
+ waku = await WakuFactory.createInstance(config);
+ };
+
+ const onClickStart = async () => {
+ await waku.start();
+ alert('start executed succesfully');
+ };
+
+ const onClickVersion = async () => {
+ let version = await waku.version();
+ alert(version);
+ };
+
+ const onClickListenAddresses = async () => {
+ let addresses = await waku.listenAddresses();
+ alert(addresses[0]);
+ };
+
+ const onClickStop = async () => {
+ await waku.stop();
+ alert('stopped!');
+ };
+
+ const onClickDestroy = async () => {
+ await waku.destroy();
+ alert('destroyed!');
+ };
+
+ const onClickConnect = async () => {
+ let result = await waku.connect(
+ '/ip4/127.0.0.1/tcp/48117/p2p/16Uiu2HAmVrsyU3y3pQYuSEyaqrBgevQeshp7YZsL8rY3nWb2yWD5',
+ 0,
+ );
+ alert(
+ 'connected? (TODO: bindings function do not return connection attempt status)',
+ );
+ };
+
+ const onClickSubscribe = async () => {
+ await waku.relaySubscribe('test');
+ alert('subscribed to test');
+ };
+
+ const onClickUnsubscribe = async () => {
+ await waku.relayUnsubscribe('test');
+ alert('unsubscribed from test');
+ };
+
+ const onClickSetEventCallback = async () => {
+ const eventSubs = waku.onEvent((event: any) => {
+ console.log(event);
+ alert('received a message');
+ });
+ // TODO: eventSubs.remove() should be used to avoid a mem leak.
+
+ alert("event callback set");
+ };
+
+ const onClickPublish = async () => {
+ const pubsubTopic = 'test';
+ const msg = {
+ payload: 'aGVsbG8',
+ contentTopic: 'test',
+ timestamp: 0,
+ version: 0,
+ };
+ let hash = await waku.relayPublish(pubsubTopic, msg, 0);
+ alert('published - msgHash: ' + hash);
+ };
+
+ return (
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ );
+}
+
+const styles = StyleSheet.create({
+ sectionContainer: {
+ marginTop: 32,
+ paddingHorizontal: 24,
+ },
+ sectionTitle: {
+ fontSize: 24,
+ fontWeight: '600',
+ },
+ sectionDescription: {
+ marginTop: 8,
+ fontSize: 18,
+ fontWeight: '400',
+ },
+ highlight: {
+ fontWeight: '700',
+ },
+});
+
+export default App;
diff --git a/third-party/nwaku/examples/mobile/Gemfile b/third-party/nwaku/examples/mobile/Gemfile
new file mode 100644
index 0000000..8d72c37
--- /dev/null
+++ b/third-party/nwaku/examples/mobile/Gemfile
@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# You may use http://rbenv.org/ or https://rvm.io/ to install and use this version
+ruby ">= 2.6.10"
+
+# Cocoapods 1.15 introduced a bug which break the build. We will remove the upper
+# bound in the template on Cocoapods with next React Native release.
+gem 'cocoapods', '>= 1.13', '< 1.15'
+gem 'activesupport', '>= 6.1.7.5', '< 7.1.0'
diff --git a/third-party/nwaku/examples/mobile/README.md b/third-party/nwaku/examples/mobile/README.md
new file mode 100644
index 0000000..12470c3
--- /dev/null
+++ b/third-party/nwaku/examples/mobile/README.md
@@ -0,0 +1,79 @@
+This is a new [**React Native**](https://reactnative.dev) project, bootstrapped using [`@react-native-community/cli`](https://github.com/react-native-community/cli).
+
+# Getting Started
+
+>**Note**: Make sure you have completed the [React Native - Environment Setup](https://reactnative.dev/docs/environment-setup) instructions till "Creating a new application" step, before proceeding.
+
+## Step 1: Start the Metro Server
+
+First, you will need to start **Metro**, the JavaScript _bundler_ that ships _with_ React Native.
+
+To start Metro, run the following command from the _root_ of your React Native project:
+
+```bash
+# using npm
+npm start
+
+# OR using Yarn
+yarn start
+```
+
+## Step 2: Start your Application
+
+Let Metro Bundler run in its _own_ terminal. Open a _new_ terminal from the _root_ of your React Native project. Run the following command to start your _Android_ or _iOS_ app:
+
+### For Android
+
+```bash
+# using npm
+npm run android
+
+# OR using Yarn
+yarn android
+```
+
+### For iOS
+
+```bash
+# using npm
+npm run ios
+
+# OR using Yarn
+yarn ios
+```
+
+If everything is set up _correctly_, you should see your new app running in your _Android Emulator_ or _iOS Simulator_ shortly provided you have set up your emulator/simulator correctly.
+
+This is one way to run your app — you can also run it directly from within Android Studio and Xcode respectively.
+
+## Step 3: Modifying your App
+
+Now that you have successfully run the app, let's modify it.
+
+1. Open `App.tsx` in your text editor of choice and edit some lines.
+2. For **Android**: Press the R key twice or select **"Reload"** from the **Developer Menu** (Ctrl + M (on Window and Linux) or Cmd ⌘ + M (on macOS)) to see your changes!
+
+ For **iOS**: Hit Cmd ⌘ + R in your iOS Simulator to reload the app and see your changes!
+
+## Congratulations! :tada:
+
+You've successfully run and modified your React Native App. :partying_face:
+
+### Now what?
+
+- If you want to add this new React Native code to an existing application, check out the [Integration guide](https://reactnative.dev/docs/integration-with-existing-apps).
+- If you're curious to learn more about React Native, check out the [Introduction to React Native](https://reactnative.dev/docs/getting-started).
+
+# Troubleshooting
+
+If you can't get this to work, see the [Troubleshooting](https://reactnative.dev/docs/troubleshooting) page.
+
+# Learn More
+
+To learn more about React Native, take a look at the following resources:
+
+- [React Native Website](https://reactnative.dev) - learn more about React Native.
+- [Getting Started](https://reactnative.dev/docs/environment-setup) - an **overview** of React Native and how setup your environment.
+- [Learn the Basics](https://reactnative.dev/docs/getting-started) - a **guided tour** of the React Native **basics**.
+- [Blog](https://reactnative.dev/blog) - read the latest official React Native **Blog** posts.
+- [`@facebook/react-native`](https://github.com/facebook/react-native) - the Open Source; GitHub **repository** for React Native.
diff --git a/third-party/nwaku/examples/mobile/__tests__/App.test.tsx b/third-party/nwaku/examples/mobile/__tests__/App.test.tsx
new file mode 100644
index 0000000..9eac6fb
--- /dev/null
+++ b/third-party/nwaku/examples/mobile/__tests__/App.test.tsx
@@ -0,0 +1,17 @@
+/**
+ * @format
+ */
+
+import 'react-native';
+import React from 'react';
+import App from '../App';
+
+// Note: import explicitly to use the types shipped with jest.
+import {it} from '@jest/globals';
+
+// Note: test renderer must be required after react-native.
+import renderer from 'react-test-renderer';
+
+it('renders correctly', () => {
+ renderer.create();
+});
diff --git a/third-party/nwaku/examples/mobile/android/app/build.gradle b/third-party/nwaku/examples/mobile/android/app/build.gradle
new file mode 100644
index 0000000..46cf8da
--- /dev/null
+++ b/third-party/nwaku/examples/mobile/android/app/build.gradle
@@ -0,0 +1,141 @@
+apply plugin: "com.android.application"
+apply plugin: "org.jetbrains.kotlin.android"
+apply plugin: "com.facebook.react"
+
+/**
+ * This is the configuration block to customize your React Native Android app.
+ * By default you don't need to apply any configuration, just uncomment the lines you need.
+ */
+react {
+ /* Folders */
+ // The root of your project, i.e. where "package.json" lives. Default is '..'
+ // root = file("../")
+ // The folder where the react-native NPM package is. Default is ../node_modules/react-native
+ // reactNativeDir = file("../node_modules/react-native")
+ // The folder where the react-native Codegen package is. Default is ../node_modules/@react-native/codegen
+ // codegenDir = file("../node_modules/@react-native/codegen")
+ // The cli.js file which is the React Native CLI entrypoint. Default is ../node_modules/react-native/cli.js
+ // cliFile = file("../node_modules/react-native/cli.js")
+
+ /* Variants */
+ // The list of variants to that are debuggable. For those we're going to
+ // skip the bundling of the JS bundle and the assets. By default is just 'debug'.
+ // If you add flavors like lite, prod, etc. you'll have to list your debuggableVariants.
+ // debuggableVariants = ["liteDebug", "prodDebug"]
+
+ /* Bundling */
+ // A list containing the node command and its flags. Default is just 'node'.
+ // nodeExecutableAndArgs = ["node"]
+ //
+ // The command to run when bundling. By default is 'bundle'
+ // bundleCommand = "ram-bundle"
+ //
+ // The path to the CLI configuration file. Default is empty.
+ // bundleConfig = file(../rn-cli.config.js)
+ //
+ // The name of the generated asset file containing your JS bundle
+ // bundleAssetName = "MyApplication.android.bundle"
+ //
+ // The entry file for bundle generation. Default is 'index.android.js' or 'index.js'
+ // entryFile = file("../js/MyApplication.android.js")
+ //
+ // A list of extra flags to pass to the 'bundle' commands.
+ // See https://github.com/react-native-community/cli/blob/main/docs/commands.md#bundle
+ // extraPackagerArgs = []
+
+ /* Hermes Commands */
+ // The hermes compiler command to run. By default it is 'hermesc'
+ // hermesCommand = "$rootDir/my-custom-hermesc/bin/hermesc"
+ //
+ // The list of flags to pass to the Hermes compiler. By default is "-O", "-output-source-map"
+ // hermesFlags = ["-O", "-output-source-map"]
+}
+
+/**
+ * Set this to true to Run Proguard on Release builds to minify the Java bytecode.
+ */
+def enableProguardInReleaseBuilds = false
+
+/**
+ * The preferred build flavor of JavaScriptCore (JSC)
+ *
+ * For example, to use the international variant, you can use:
+ * `def jscFlavor = 'org.webkit:android-jsc-intl:+'`
+ *
+ * The international variant includes ICU i18n library and necessary data
+ * allowing to use e.g. `Date.toLocaleString` and `String.localeCompare` that
+ * give correct results when using with locales other than en-US. Note that
+ * this variant is about 6MiB larger per architecture than default.
+ */
+def jscFlavor = 'org.webkit:android-jsc:+'
+
+android {
+ ndkVersion rootProject.ext.ndkVersion
+ buildToolsVersion rootProject.ext.buildToolsVersion
+ compileSdk rootProject.ext.compileSdkVersion
+
+ namespace "com.mobile"
+ defaultConfig {
+ applicationId "com.mobile"
+ minSdkVersion rootProject.ext.minSdkVersion
+ targetSdkVersion rootProject.ext.targetSdkVersion
+ versionCode 1
+ versionName "1.0"
+ ndk {
+ abiFilters "x86_64", "arm64-v8a", "x86" /* "armeabi-v7a", */
+ moduleName "waku_jni"
+ ldLibs "log"
+ cFlags "-std=c99"
+ }
+ }
+ externalNativeBuild {
+ ndkBuild {
+ path file('src/main/jni/Android.mk')
+ }
+ }
+ signingConfigs {
+ debug {
+ storeFile file('debug.keystore')
+ storePassword 'android'
+ keyAlias 'androiddebugkey'
+ keyPassword 'android'
+ }
+ }
+ buildTypes {
+ debug {
+ signingConfig signingConfigs.debug
+ }
+ release {
+ // Caution! In production, you need to generate your own keystore file.
+ // see https://reactnative.dev/docs/signed-apk-android.
+ signingConfig signingConfigs.debug
+ minifyEnabled enableProguardInReleaseBuilds
+ proguardFiles getDefaultProguardFile("proguard-android.txt"), "proguard-rules.pro"
+ }
+ }
+
+ sourceSets {
+ main {
+ jniLibs {
+ srcDirs 'src/main/jniLibs'
+ }
+ }
+ }
+}
+
+dependencies {
+ implementation fileTree(dir: "libs", include: ["*.aar"])
+
+ // The version of react-native is set by the React Native Gradle Plugin
+ implementation("com.facebook.react:react-android")
+
+ implementation 'com.google.code.gson:gson:2.8.8'
+
+ if (hermesEnabled.toBoolean()) {
+ implementation("com.facebook.react:hermes-android")
+ } else {
+ implementation jscFlavor
+ }
+}
+
+apply from: file("../../node_modules/@react-native-community/cli-platform-android/native_modules.gradle"); applyNativeModulesAppBuildGradle(project)
diff --git a/third-party/nwaku/examples/mobile/android/app/debug.keystore b/third-party/nwaku/examples/mobile/android/app/debug.keystore
new file mode 100644
index 0000000..364e105
Binary files /dev/null and b/third-party/nwaku/examples/mobile/android/app/debug.keystore differ
diff --git a/third-party/nwaku/examples/mobile/android/app/proguard-rules.pro b/third-party/nwaku/examples/mobile/android/app/proguard-rules.pro
new file mode 100644
index 0000000..11b0257
--- /dev/null
+++ b/third-party/nwaku/examples/mobile/android/app/proguard-rules.pro
@@ -0,0 +1,10 @@
+# Add project specific ProGuard rules here.
+# By default, the flags in this file are appended to flags specified
+# in /usr/local/Cellar/android-sdk/24.3.3/tools/proguard/proguard-android.txt
+# You can edit the include path and order by changing the proguardFiles
+# directive in build.gradle.
+#
+# For more details, see
+# http://developer.android.com/guide/developing/tools/proguard.html
+
+# Add any project specific keep options here:
diff --git a/third-party/nwaku/examples/mobile/android/app/src/debug/AndroidManifest.xml b/third-party/nwaku/examples/mobile/android/app/src/debug/AndroidManifest.xml
new file mode 100644
index 0000000..fbf78ef
--- /dev/null
+++ b/third-party/nwaku/examples/mobile/android/app/src/debug/AndroidManifest.xml
@@ -0,0 +1,9 @@
+
+
+
+
+
diff --git a/third-party/nwaku/examples/mobile/android/app/src/main/AndroidManifest.xml b/third-party/nwaku/examples/mobile/android/app/src/main/AndroidManifest.xml
new file mode 100644
index 0000000..4122f36
--- /dev/null
+++ b/third-party/nwaku/examples/mobile/android/app/src/main/AndroidManifest.xml
@@ -0,0 +1,25 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/third-party/nwaku/examples/mobile/android/app/src/main/java/com/mobile/MainActivity.kt b/third-party/nwaku/examples/mobile/android/app/src/main/java/com/mobile/MainActivity.kt
new file mode 100644
index 0000000..8b315da
--- /dev/null
+++ b/third-party/nwaku/examples/mobile/android/app/src/main/java/com/mobile/MainActivity.kt
@@ -0,0 +1,29 @@
+package com.mobile
+
+import com.facebook.react.ReactActivity
+import com.facebook.react.ReactActivityDelegate
+import com.facebook.react.defaults.DefaultNewArchitectureEntryPoint.fabricEnabled
+import com.facebook.react.defaults.DefaultReactActivityDelegate
+
+class MainActivity : ReactActivity() {
+
+ companion object {
+ init {
+ System.loadLibrary("rln")
+ System.loadLibrary("waku")
+ System.loadLibrary("waku_jni");
+ }
+ }
+ /**
+ * Returns the name of the main component registered from JavaScript. This is used to schedule
+ * rendering of the component.
+ */
+ override fun getMainComponentName(): String = "mobile"
+
+ /**
+ * Returns the instance of the [ReactActivityDelegate]. We use [DefaultReactActivityDelegate]
+ * which allows you to enable New Architecture with a single boolean flags [fabricEnabled]
+ */
+ override fun createReactActivityDelegate(): ReactActivityDelegate =
+ DefaultReactActivityDelegate(this, mainComponentName, fabricEnabled)
+}
diff --git a/third-party/nwaku/examples/mobile/android/app/src/main/java/com/mobile/MainApplication.kt b/third-party/nwaku/examples/mobile/android/app/src/main/java/com/mobile/MainApplication.kt
new file mode 100644
index 0000000..79121f1
--- /dev/null
+++ b/third-party/nwaku/examples/mobile/android/app/src/main/java/com/mobile/MainApplication.kt
@@ -0,0 +1,43 @@
+package com.mobile
+
+import android.app.Application
+import com.facebook.react.PackageList
+import com.facebook.react.ReactApplication
+import com.facebook.react.ReactHost
+import com.facebook.react.ReactNativeHost
+import com.facebook.react.ReactPackage
+import com.facebook.react.defaults.DefaultNewArchitectureEntryPoint.load
+import com.facebook.react.defaults.DefaultReactHost.getDefaultReactHost
+import com.facebook.react.defaults.DefaultReactNativeHost
+import com.facebook.soloader.SoLoader
+
+class MainApplication : Application(), ReactApplication {
+
+ override val reactNativeHost: ReactNativeHost =
+ object : DefaultReactNativeHost(this) {
+ override fun getPackages(): List =
+ PackageList(this).packages.apply {
+ // Packages that cannot be autolinked yet can be added manually here, for example:
+ add(MyAppPackage())
+ }
+
+ override fun getJSMainModuleName(): String = "index"
+
+ override fun getUseDeveloperSupport(): Boolean = BuildConfig.DEBUG
+
+ override val isNewArchEnabled: Boolean = BuildConfig.IS_NEW_ARCHITECTURE_ENABLED
+ override val isHermesEnabled: Boolean = BuildConfig.IS_HERMES_ENABLED
+ }
+
+ override val reactHost: ReactHost
+ get() = getDefaultReactHost(applicationContext, reactNativeHost)
+
+ override fun onCreate() {
+ super.onCreate()
+ SoLoader.init(this, false)
+ if (BuildConfig.IS_NEW_ARCHITECTURE_ENABLED) {
+ // If you opted-in for the New Architecture, we load the native entry point for this app.
+ load()
+ }
+ }
+}
diff --git a/third-party/nwaku/examples/mobile/android/app/src/main/java/com/mobile/ReactNativePackage.kt b/third-party/nwaku/examples/mobile/android/app/src/main/java/com/mobile/ReactNativePackage.kt
new file mode 100644
index 0000000..5e03685
--- /dev/null
+++ b/third-party/nwaku/examples/mobile/android/app/src/main/java/com/mobile/ReactNativePackage.kt
@@ -0,0 +1,19 @@
+package com.mobile
+
+import android.view.View
+import com.facebook.react.ReactPackage
+import com.facebook.react.bridge.NativeModule
+import com.facebook.react.bridge.ReactApplicationContext
+import com.facebook.react.uimanager.ReactShadowNode
+import com.facebook.react.uimanager.ViewManager
+
+class MyAppPackage : ReactPackage {
+
+ override fun createViewManagers(
+ reactContext: ReactApplicationContext
+ ): MutableList>> = mutableListOf()
+
+ override fun createNativeModules(
+ reactContext: ReactApplicationContext
+ ): MutableList = listOf(WakuModule(reactContext)).toMutableList()
+}
diff --git a/third-party/nwaku/examples/mobile/android/app/src/main/java/com/mobile/WakuModule.kt b/third-party/nwaku/examples/mobile/android/app/src/main/java/com/mobile/WakuModule.kt
new file mode 100644
index 0000000..4c1c020
--- /dev/null
+++ b/third-party/nwaku/examples/mobile/android/app/src/main/java/com/mobile/WakuModule.kt
@@ -0,0 +1,247 @@
+package com.mobile
+
+import com.facebook.react.bridge.Arguments
+import com.facebook.react.bridge.Promise
+import com.facebook.react.bridge.ReactApplicationContext
+import com.facebook.react.bridge.ReactContext
+import com.facebook.react.bridge.ReactContextBaseJavaModule
+import com.facebook.react.bridge.ReactMethod
+import com.facebook.react.bridge.ReadableArray
+import com.facebook.react.bridge.ReadableMap
+import com.facebook.react.bridge.ReadableType
+import com.facebook.react.bridge.WritableNativeArray
+import com.facebook.react.modules.core.DeviceEventManagerModule
+import com.google.gson.Gson
+import java.math.BigInteger
+import org.json.JSONArray
+
+class EventCallbackManager {
+ companion object {
+
+ lateinit var reactContext: ReactContext
+
+ @JvmStatic
+ fun execEventCallback(wakuPtr: Long, evt: String) {
+ val params =
+ Arguments.createMap().apply {
+ putString("wakuPtr", wakuPtr.toString())
+ putString("event", evt)
+ }
+
+ reactContext
+ .getJSModule(DeviceEventManagerModule.RCTDeviceEventEmitter::class.java)
+ .emit("wakuEvent", params)
+ }
+ }
+}
+
+fun convertStringToArray(stringArray: String): WritableNativeArray {
+ val writableArray = WritableNativeArray()
+ val jsonArray = JSONArray(stringArray)
+ for (i in 0 until jsonArray.length()) {
+ writableArray.pushString(jsonArray.getString(i))
+ }
+ return writableArray
+}
+
+fun stringifyReadableMap(map: ReadableMap): String {
+ val gson = Gson()
+ return gson.toJson(readableMapToMap(map))
+}
+
+fun readableMapToMap(readableMap: ReadableMap): Map {
+ val map = mutableMapOf()
+ val iterator = readableMap.keySetIterator()
+ while (iterator.hasNextKey()) {
+ val key = iterator.nextKey()
+ when (readableMap.getType(key)) {
+ ReadableType.Null -> map[key] = null
+ ReadableType.Boolean -> map[key] = readableMap.getBoolean(key)
+ ReadableType.Number -> map[key] = readableMap.getInt(key)
+ ReadableType.String -> map[key] = readableMap.getString(key)
+ ReadableType.Map -> map[key] = readableMapToMap(readableMap.getMap(key)!!)
+ ReadableType.Array -> map[key] = readableArrayToList(readableMap.getArray(key)!!)
+ }
+ }
+ return map
+}
+
+fun readableArrayToList(readableArray: ReadableArray): List {
+ val list = mutableListOf()
+ for (i in 0 until readableArray.size()) {
+ when (readableArray.getType(i)) {
+ ReadableType.Null -> list.add(null)
+ ReadableType.Boolean -> list.add(readableArray.getBoolean(i))
+ ReadableType.Number -> list.add(readableArray.getInt(i))
+ ReadableType.String -> list.add(readableArray.getString(i))
+ ReadableType.Map -> list.add(readableMapToMap(readableArray.getMap(i)))
+ ReadableType.Array -> list.add(readableArrayToList(readableArray.getArray(i)))
+ }
+ }
+ return list
+}
+
+class WakuPtr(val error: Boolean, val errorMessage: String, val ptr: Long)
+
+class WakuResult(val error: Boolean, val message: String)
+
+class WakuModule(reactContext: ReactApplicationContext) : ReactContextBaseJavaModule(reactContext) {
+ var reactContext = reactContext
+
+ override fun getName() = "WakuModule"
+
+ external fun wakuSetup()
+ external fun wakuNew(configJson: String): WakuPtr
+ external fun wakuStart(ctx: Long): WakuResult
+ external fun wakuVersion(ctx: Long): WakuResult
+ external fun wakuStop(ctx: Long): WakuResult
+ external fun wakuDestroy(ctx: Long): WakuResult
+ external fun wakuConnect(ctx: Long, peerMultiAddr: String, timeoutMs: Int): WakuResult
+ external fun wakuListenAddresses(ctx: Long): WakuResult
+ external fun wakuRelayPublish(
+ ctx: Long,
+ topic: String,
+ wakuMsg: String,
+ timeoutMs: Int
+ ): WakuResult
+ external fun wakuRelaySubscribe(ctx: Long, topic: String): WakuResult
+ external fun wakuRelayUnsubscribe(ctx: Long, topic: String): WakuResult
+ external fun wakuSetEventCallback(ctx: Long)
+
+ init {
+ EventCallbackManager.reactContext = reactContext
+ }
+
+ @ReactMethod
+ fun setup(promise: Promise) {
+ wakuSetup()
+ promise.resolve(null)
+ }
+
+ @ReactMethod
+ fun new(config: ReadableMap, promise: Promise) {
+ val configStr = stringifyReadableMap(config)
+ val response = wakuNew(configStr)
+ if (response.error) {
+ promise.reject("waku_new", response.errorMessage)
+ } else {
+ // With this we just indicate to waku_ffi that we have registered a
+ // closure, for this wakuPtr. Later once a message is received the
+ // callback manager will receive both the wakuPtr and the message,
+ // and it will use these values to emit a JS event
+ wakuSetEventCallback(response.ptr)
+
+ promise.resolve(BigInteger.valueOf(response.ptr).toString())
+ }
+ }
+
+ @ReactMethod
+ fun start(ctx: String, promise: Promise) {
+ val wakuPtr = BigInteger(ctx).toLong()
+ val response = wakuStart(wakuPtr)
+ if (response.error) {
+ promise.reject("waku_start", response.message)
+ } else {
+ promise.resolve(null)
+ }
+ }
+
+ @ReactMethod
+ fun version(ctx: String, promise: Promise) {
+ val wakuPtr = BigInteger(ctx).toLong()
+ val response = wakuVersion(wakuPtr)
+ if (response.error) {
+ promise.reject("waku_version", response.message)
+ } else {
+ promise.resolve(response.message)
+ }
+ }
+
+ @ReactMethod
+ fun stop(ctx: String, promise: Promise) {
+ val wakuPtr = BigInteger(ctx).toLong()
+ val response = wakuStop(wakuPtr)
+ if (response.error) {
+ promise.reject("waku_stop", response.message)
+ } else {
+ promise.resolve(null)
+ }
+ }
+
+ @ReactMethod
+ fun destroy(ctx: String, promise: Promise) {
+ val wakuPtr = BigInteger(ctx).toLong()
+ val response = wakuDestroy(wakuPtr)
+ if (response.error) {
+ promise.reject("waku_destroy", response.message)
+ } else {
+ promise.resolve(null)
+ }
+ }
+
+ @ReactMethod
+ fun listenAddresses(ctx: String, promise: Promise) {
+ val wakuPtr = BigInteger(ctx).toLong()
+ val response = wakuListenAddresses(wakuPtr)
+ if (response.error) {
+ promise.reject("waku_listen_addresses", response.message)
+ } else {
+ promise.resolve(convertStringToArray(response.message))
+ }
+ }
+
+ @ReactMethod
+ fun connect(ctx: String, peerMultiAddr: String, timeoutMs: Int, promise: Promise) {
+ val wakuPtr = BigInteger(ctx).toLong()
+ val response = wakuConnect(wakuPtr, peerMultiAddr, timeoutMs)
+ if (response.error) {
+ promise.reject("waku_connect", response.message)
+ } else {
+ promise.resolve(null)
+ }
+ }
+
+ @ReactMethod
+ fun relaySubscribe(ctx: String, topic: String, promise: Promise) {
+ val wakuPtr = BigInteger(ctx).toLong()
+ val response = wakuRelaySubscribe(wakuPtr, topic)
+ if (response.error) {
+ promise.reject("waku_relay_subscribe", response.message)
+ } else {
+ promise.resolve(null)
+ }
+ }
+
+ @ReactMethod
+ fun relayUnsubscribe(ctx: String, topic: String, promise: Promise) {
+ val wakuPtr = BigInteger(ctx).toLong()
+ val response = wakuRelayUnsubscribe(wakuPtr, topic)
+ if (response.error) {
+ promise.reject("waku_relay_unsubscribe", response.message)
+ } else {
+ promise.resolve(null)
+ }
+ }
+
+ @ReactMethod
+ fun relayPublish(ctx: String, topic: String, msg: ReadableMap, timeoutMs: Int, promise: Promise) {
+ val wakuPtr = BigInteger(ctx).toLong()
+ val msgStr = stringifyReadableMap(msg)
+ val response = wakuRelayPublish(wakuPtr, topic, msgStr, timeoutMs)
+ if (response.error) {
+ promise.reject("waku_relay_publish", response.message)
+ } else {
+ promise.resolve(null)
+ }
+ }
+
+ @ReactMethod
+ fun addListener(eventName: String) {
+ // No impl required
+ }
+
+ @ReactMethod
+ fun removeListeners(count: Int) {
+ // No impl required
+ }
+}
diff --git a/third-party/nwaku/examples/mobile/android/app/src/main/jni/.gitignore b/third-party/nwaku/examples/mobile/android/app/src/main/jni/.gitignore
new file mode 100644
index 0000000..dcb1665
--- /dev/null
+++ b/third-party/nwaku/examples/mobile/android/app/src/main/jni/.gitignore
@@ -0,0 +1 @@
+libwaku.h
diff --git a/third-party/nwaku/examples/mobile/android/app/src/main/jni/Android.mk b/third-party/nwaku/examples/mobile/android/app/src/main/jni/Android.mk
new file mode 100644
index 0000000..f7ec7ff
--- /dev/null
+++ b/third-party/nwaku/examples/mobile/android/app/src/main/jni/Android.mk
@@ -0,0 +1,17 @@
+LOCAL_PATH := $(call my-dir)
+
+include $(CLEAR_VARS)
+
+LOCAL_MODULE := waku
+LOCAL_SRC_FILES := ../jniLibs/$(TARGET_ARCH_ABI)/libwaku.so
+
+include $(PREBUILT_SHARED_LIBRARY)
+
+include $(CLEAR_VARS)
+
+LOCAL_SRC_FILES := waku_ffi.c
+LOCAL_MODULE := waku_jni
+LOCAL_LDLIBS := -llog
+LOCAL_SHARED_LIBRARIES := waku
+
+include $(BUILD_SHARED_LIBRARY)
\ No newline at end of file
diff --git a/third-party/nwaku/examples/mobile/android/app/src/main/jni/Application.mk b/third-party/nwaku/examples/mobile/android/app/src/main/jni/Application.mk
new file mode 100644
index 0000000..e619d92
--- /dev/null
+++ b/third-party/nwaku/examples/mobile/android/app/src/main/jni/Application.mk
@@ -0,0 +1 @@
+APP_ABI := all
\ No newline at end of file
diff --git a/third-party/nwaku/examples/mobile/android/app/src/main/jni/waku_ffi.c b/third-party/nwaku/examples/mobile/android/app/src/main/jni/waku_ffi.c
new file mode 100644
index 0000000..477e2da
--- /dev/null
+++ b/third-party/nwaku/examples/mobile/android/app/src/main/jni/waku_ffi.c
@@ -0,0 +1,325 @@
+#include "libwaku.h"
+#include
+#include
+#include
+#include
+#include
+#include
+#include
+
+#define APPNAME "waku-jni"
+#define LOGD(TAG) __android_log_print(ANDROID_LOG_DEBUG , APPNAME,TAG);
+
+// cb_result represents a response received when executing a callback.
+// If `error` is true, `message` will contain the error message description
+// otherwise, it will contain the result of the callback execution
+typedef struct {
+ bool error;
+ char *message;
+} cb_result;
+
+// cb_env is a struct passed as userdata when setting up the event callback.
+// This is so we can pass the pointer back to kotlin to indicate which instance
+// of waku received the message, and also so we can have access to `env` from
+// within the event callback
+typedef struct {
+ jlong wakuPtr;
+ JNIEnv *env;
+} cb_env;
+
+// frees the results associated to the allocation of a cb_result
+void free_cb_result(cb_result *result) {
+ if (result != NULL) {
+ if (result->message != NULL) {
+ free(result->message);
+ result->message = NULL;
+ }
+ free(result);
+ result = NULL;
+ }
+}
+
+// callback executed by libwaku functions. It expects user_data to be a
+// cb_result*.
+void on_response(int ret, const char *msg, size_t len, void *user_data) {
+ if (ret != RET_OK) {
+ char errMsg[300];
+ snprintf(errMsg, 300, "function execution failed. Returned code: %d, %s\n", ret, msg);
+ if (user_data != NULL) {
+ cb_result **data_ref = (cb_result **)user_data;
+ (*data_ref) = malloc(sizeof(cb_result));
+ (*data_ref)->error = true;
+ (*data_ref)->message = malloc(len * sizeof(char) + 1);
+ (*data_ref)->message[0] = '\0';
+ strncat((*data_ref)->message, msg, len);
+ }
+ return;
+ }
+
+ if (user_data == NULL)
+ return;
+
+ if (len == 0) {
+ len = 14;
+ msg = "on_response-ok";
+ }
+
+ cb_result **data_ref = (cb_result **)user_data;
+ (*data_ref) = malloc(sizeof(cb_result));
+ (*data_ref)->error = false;
+ (*data_ref)->message = malloc(len * sizeof(char) + 1);
+ (*data_ref)->message[0] = '\0';
+ strncat((*data_ref)->message, msg, len);
+}
+
+// converts a cb_result into an instance of the kotlin WakuResult class
+jobject to_jni_result(JNIEnv *env, cb_result *result) {
+ jclass myStructClass = (*env)->FindClass(env, "com/mobile/WakuResult");
+ jmethodID constructor = (*env)->GetMethodID(env, myStructClass, "",
+ "(ZLjava/lang/String;)V");
+
+ jboolean error;
+ jstring message;
+ if (result != NULL) {
+ error = result->error;
+ message = (*env)->NewStringUTF(env, result->message);
+ } else {
+ error = false;
+ message = (*env)->NewStringUTF(env, "ok");
+ }
+
+ jobject response =
+ (*env)->NewObject(env, myStructClass, constructor, error, message);
+
+ // Free the intermediate message var
+ (*env)->DeleteLocalRef(env, message);
+
+ return response;
+}
+
+// converts a cb_result into an instance of the kotlin WakuPtr class
+jobject to_jni_ptr(JNIEnv *env, cb_result *result, void *ptr) {
+ jclass myStructClass = (*env)->FindClass(env, "com/mobile/WakuPtr");
+ jmethodID constructor = (*env)->GetMethodID(env, myStructClass, "",
+ "(ZLjava/lang/String;J)V");
+
+ jboolean error;
+ jstring message;
+ jlong wakuPtr;
+ if (result != NULL) {
+ error = result->error;
+ message = (*env)->NewStringUTF(env, result->message);
+ wakuPtr = -1;
+ } else {
+ error = false;
+ message = (*env)->NewStringUTF(env, "ok");
+ wakuPtr = (jlong)ptr;
+ }
+
+ jobject response = (*env)->NewObject(env, myStructClass, constructor, error,
+ message, wakuPtr);
+
+ // Free the intermediate message var
+ (*env)->DeleteLocalRef(env, message);
+
+ return response;
+}
+
+// libwaku functions
+// ============================================================================
+
+// JVM, required for executing JNI functions in a third party thread.
+JavaVM *jvm;
+static jobject jClassLoader;
+static jmethodID jLoadClass;
+
+JNIEnv *getEnv() {
+ JNIEnv *env;
+ int status = (*jvm)->GetEnv(jvm, (void **)&env, JNI_VERSION_1_6);
+ if (status < 0) {
+ status = (*jvm)->AttachCurrentThread(jvm, &env, NULL);
+ assert(status == JNI_OK && "could not obtain env");
+ }
+ return env;
+}
+
+JNIEXPORT jint JNICALL JNI_OnLoad(JavaVM *pjvm, void *reserved) {
+ jvm = pjvm; // cache the JavaVM pointer
+ JNIEnv *env = getEnv();
+
+ jclass jLibraryClass =
+ (*env)->FindClass(env, "com/mobile/EventCallbackManager");
+ jclass jClassRef = (*env)->GetObjectClass(env, jLibraryClass);
+ jclass jClassLoaderClass = (*env)->FindClass(env, "java/lang/ClassLoader");
+ jmethodID getClassLoader = (*env)->GetMethodID(
+ env, jClassRef, "getClassLoader", "()Ljava/lang/ClassLoader;");
+
+ jobject jClassLoaderLocal =
+ (*env)->CallObjectMethod(env, jLibraryClass, getClassLoader);
+ jLoadClass = (*env)->GetMethodID(env, jClassLoaderClass, "loadClass",
+ "(Ljava/lang/String;)Ljava/lang/Class;");
+ jClassLoader = (*env)->NewGlobalRef(env, jClassLoaderLocal);
+
+ (*env)->DeleteLocalRef(env, jClassLoaderLocal);
+ (*env)->DeleteLocalRef(env, jClassLoaderClass);
+ (*env)->DeleteLocalRef(env, jClassRef);
+ (*env)->DeleteLocalRef(env, jLibraryClass);
+
+ return JNI_VERSION_1_6;
+}
+
+jclass loadClass(JNIEnv *env, const char *className) {
+ jstring jName = (*env)->NewStringUTF(env, className);
+ jclass jClass = (*env)->CallObjectMethod(env, jClassLoader, jLoadClass, jName);
+ assert((*env)->ExceptionCheck(env) == JNI_FALSE && "class could not be loaded");
+ (*env)->DeleteLocalRef(env, jName);
+ return jClass;
+}
+
+void Java_com_mobile_WakuModule_wakuSetup(JNIEnv *env, jobject thiz) {
+ LOGD("log example for debugging purposes...")
+}
+
+jobject Java_com_mobile_WakuModule_wakuNew(JNIEnv *env, jobject thiz,
+ jstring configJson) {
+ const char *config = (*env)->GetStringUTFChars(env, configJson, 0);
+ cb_result *result = NULL;
+ void *wakuPtr = waku_new(config, on_response, (void *)&result);
+ jobject response = to_jni_ptr(env, result, wakuPtr);
+ (*env)->ReleaseStringUTFChars(env, configJson, config);
+ free_cb_result(result);
+ return response;
+}
+
+jobject Java_com_mobile_WakuModule_wakuStart(JNIEnv *env, jobject thiz,
+ jlong wakuPtr) {
+ cb_result *result = NULL;
+ waku_start((void *)wakuPtr, on_response, &result);
+ jobject response = to_jni_result(env, result);
+ free_cb_result(result);
+ return response;
+}
+
+jobject Java_com_mobile_WakuModule_wakuVersion(JNIEnv *env, jobject thiz,
+ jlong wakuPtr) {
+ cb_result *result = NULL;
+ waku_version((void *)wakuPtr, on_response, (void *)&result);
+ jobject response = to_jni_result(env, result);
+ free_cb_result(result);
+ return response;
+}
+
+jobject Java_com_mobile_WakuModule_wakuStop(JNIEnv *env, jobject thiz,
+ jlong wakuPtr) {
+ cb_result *result = NULL;
+ waku_stop((void *)wakuPtr, on_response, &result);
+ jobject response = to_jni_result(env, result);
+ free_cb_result(result);
+ return response;
+}
+
+jobject Java_com_mobile_WakuModule_wakuDestroy(JNIEnv *env, jobject thiz,
+ jlong wakuPtr) {
+ cb_result *result = NULL;
+ waku_destroy((void *)wakuPtr, on_response, &result);
+ jobject response = to_jni_result(env, result);
+ free_cb_result(result);
+ return response;
+}
+
+jobject Java_com_mobile_WakuModule_wakuConnect(JNIEnv *env, jobject thiz,
+ jlong wakuPtr,
+ jstring peerMultiAddr,
+ jint timeoutMs) {
+ cb_result *result = NULL;
+ const char *peer = (*env)->GetStringUTFChars(env, peerMultiAddr, 0);
+ waku_connect((void *)wakuPtr, peer, timeoutMs, on_response, &result);
+ jobject response = to_jni_result(env, result);
+ free_cb_result(result);
+ (*env)->ReleaseStringUTFChars(env, peerMultiAddr, peer);
+ return response;
+}
+
+jobject Java_com_mobile_WakuModule_wakuListenAddresses(JNIEnv *env,
+ jobject thiz,
+ jlong wakuPtr) {
+ cb_result *result = NULL;
+ waku_listen_addresses((void *)wakuPtr, on_response, (void *)&result);
+ jobject response = to_jni_result(env, result);
+ free_cb_result(result);
+ return response;
+}
+
+jobject Java_com_mobile_WakuModule_wakuRelayPublish(JNIEnv *env, jobject thiz,
+ jlong wakuPtr,
+ jstring pubsubTopic,
+ jstring jsonWakuMessage,
+ jint timeoutMs) {
+ cb_result *result = NULL;
+ const char *topic = (*env)->GetStringUTFChars(env, pubsubTopic, 0);
+ const char *msg = (*env)->GetStringUTFChars(env, jsonWakuMessage, 0);
+ waku_relay_publish((void *)wakuPtr, topic, msg, timeoutMs, on_response,
+ (void *)&result);
+ jobject response = to_jni_result(env, result);
+ free_cb_result(result);
+ (*env)->ReleaseStringUTFChars(env, pubsubTopic, topic);
+ (*env)->ReleaseStringUTFChars(env, jsonWakuMessage, msg);
+ return response;
+}
+
+jobject Java_com_mobile_WakuModule_wakuRelaySubscribe(JNIEnv *env, jobject thiz,
+ jlong wakuPtr,
+ jstring pubsubTopic) {
+ cb_result *result = NULL;
+ const char *topic = (*env)->GetStringUTFChars(env, pubsubTopic, 0);
+ waku_relay_subscribe((void *)wakuPtr, topic, on_response, (void *)&result);
+ jobject response = to_jni_result(env, result);
+ free_cb_result(result);
+ (*env)->ReleaseStringUTFChars(env, pubsubTopic, topic);
+ return response;
+}
+
+jobject Java_com_mobile_WakuModule_wakuRelayUnsubscribe(JNIEnv *env,
+ jobject thiz,
+ jlong wakuPtr,
+ jstring pubsubTopic) {
+ cb_result *result = NULL;
+ const char *topic = (*env)->GetStringUTFChars(env, pubsubTopic, 0);
+ waku_relay_unsubscribe((void *)wakuPtr, topic, on_response, (void *)&result);
+ jobject response = to_jni_result(env, result);
+ free_cb_result(result);
+ (*env)->ReleaseStringUTFChars(env, pubsubTopic, topic);
+ return response;
+}
+
+void wk_callback(int callerRet, const char *msg, size_t len, void *userData) {
+ cb_env *c = (cb_env *)userData;
+
+ // TODO: might be too much overhead to attach/detach per call?
+ JNIEnv *env = c->env;
+ JNIEnv *attachedEnv = NULL;
+ assert((*jvm)->AttachCurrentThread(jvm, &attachedEnv, NULL) == JNI_OK && "could not attach to current thread");
+
+ jclass clazz = loadClass(attachedEnv, "com/mobile/EventCallbackManager");
+
+ jmethodID methodID =
+ (*attachedEnv)
+ ->GetStaticMethodID(attachedEnv, clazz, "execEventCallback", "(JLjava/lang/String;)V");
+
+ jstring message = (*attachedEnv)->NewStringUTF(attachedEnv, msg);
+ (*attachedEnv)->CallStaticVoidMethod(attachedEnv, clazz, methodID, c->wakuPtr, message);
+
+ (*attachedEnv)->DeleteLocalRef(attachedEnv, clazz);
+
+ (*attachedEnv)->DeleteLocalRef(attachedEnv, message);
+
+ (*jvm)->DetachCurrentThread(jvm);
+}
+
+void Java_com_mobile_WakuModule_wakuSetEventCallback(JNIEnv *env, jobject thiz,
+ jlong wakuPtr) {
+ cb_env *c = (cb_env *)malloc(sizeof(cb_env));
+ c->wakuPtr = wakuPtr;
+ c->env = env;
+ waku_set_event_callback((void *)wakuPtr, wk_callback, (void *)c);
+}
diff --git a/third-party/nwaku/examples/mobile/android/app/src/main/jniLibs/arm64-v8a/.gitkeep b/third-party/nwaku/examples/mobile/android/app/src/main/jniLibs/arm64-v8a/.gitkeep
new file mode 100644
index 0000000..e69de29
diff --git a/third-party/nwaku/examples/mobile/android/app/src/main/jniLibs/armeabi-v7a/.gitkeep b/third-party/nwaku/examples/mobile/android/app/src/main/jniLibs/armeabi-v7a/.gitkeep
new file mode 100644
index 0000000..e69de29
diff --git a/third-party/nwaku/examples/mobile/android/app/src/main/jniLibs/x86/.gitkeep b/third-party/nwaku/examples/mobile/android/app/src/main/jniLibs/x86/.gitkeep
new file mode 100644
index 0000000..e69de29
diff --git a/third-party/nwaku/examples/mobile/android/app/src/main/jniLibs/x86_64/.gitkeep b/third-party/nwaku/examples/mobile/android/app/src/main/jniLibs/x86_64/.gitkeep
new file mode 100644
index 0000000..e69de29
diff --git a/third-party/nwaku/examples/mobile/android/app/src/main/res/drawable/rn_edit_text_material.xml b/third-party/nwaku/examples/mobile/android/app/src/main/res/drawable/rn_edit_text_material.xml
new file mode 100644
index 0000000..5c25e72
--- /dev/null
+++ b/third-party/nwaku/examples/mobile/android/app/src/main/res/drawable/rn_edit_text_material.xml
@@ -0,0 +1,37 @@
+
+
+
+
+
+
+