Commit Graph

88 Commits

Author SHA1 Message Date
Vaclav Pavlin b51fb61669
chore(docs): fix docs and mark some as deprecated (#1754)
* chore(docs): fix docs and mark some as deprecated

* Update docs/contributors/continuous-integration.md

Co-authored-by: Ivan Folgueira Bande <128452529+Ivansete-status@users.noreply.github.com>

* Update examples/v2/README.md

Co-authored-by: Ivan Folgueira Bande <128452529+Ivansete-status@users.noreply.github.com>

* mark TODO with date

* replace nim-waku with nwaku in docs

---------

Co-authored-by: Ivan Folgueira Bande <128452529+Ivansete-status@users.noreply.github.com>
2023-05-25 13:37:49 +02:00
Aaryamann Challani 36266b43cf
fix(rln-relay): keystore usage (#1750)
* fix(rln-relay): keystore usage

* docs(rln-relay): explicit keystore usage
2023-05-22 22:06:55 +05:30
Aaryamann Challani bb9d231bdc
chore(rln-relay): docs and config update for testnet 3 (#1738)
* chore(rln-relay): docs and config update for testnet 3

* chore(rln-relay): update more docs
2023-05-19 18:22:01 +05:30
Ivan Folgueira Bande 4b59e472aa
docs: adding new tutorial on how to handle heaptrack with nim waku (#1719)
* doc: adding new tutorial on how to handle heaptrack with nim waku

* Update docs/tutorial/heaptrack.md

Co-authored-by: Hanno Cornelius <68783915+jm-clius@users.noreply.github.com>

* Update docs/tutorial/heaptrack.md

Co-authored-by: Hanno Cornelius <68783915+jm-clius@users.noreply.github.com>

* Update docs/tutorial/heaptrack.md

Co-authored-by: Hanno Cornelius <68783915+jm-clius@users.noreply.github.com>

---------

Co-authored-by: Hanno Cornelius <68783915+jm-clius@users.noreply.github.com>
2023-05-09 15:37:47 +02:00
Vaclav Pavlin 5c33d9d1f3
chore: Bump container image versions to v0.16.0 in quickstart (#1640)
closes #1667
2023-04-11 17:04:27 +02:00
Ivansete-status b2acb54d6a
feat(rest-api-store): new rest api to retrieve store waku messages (#1611) (#1630)
* feat: new rest api based on the current store json-rpc api and
following the same structure as the current relay rest api.

* feat: the store api attend GET requests to retrieve historical messages

* feat: unit tests.

* feat: allow return message to rest-client in case error (4XX or 5XX)

* chore: always allow to call the store api endpoints (only rest) without explicit storenode (#1575)

* feat: always mounting the current node as storenode client
2023-04-06 11:43:19 +02:00
Hanno Cornelius b495dd7bf3
docs(release): added regression checking and clarifications (#1610)
* docs(release): added regression checking and clarifications

Regression check against js-waku.
Clarified Docker image publishing.

* fix: grammar check

* fix: broken link
2023-03-17 12:43:34 +02:00
Alvaro Revuelta b56c4340f7
chore(docs): add docker-compose instructions (#1444)
* chore(docs): add docker-compose instructions

* Update docs/operators/quickstart.md

Co-authored-by: Hanno Cornelius <68783915+jm-clius@users.noreply.github.com>

* Update docs/operators/quickstart.md

Co-authored-by: Hanno Cornelius <68783915+jm-clius@users.noreply.github.com>

Co-authored-by: Hanno Cornelius <68783915+jm-clius@users.noreply.github.com>
2022-12-05 16:25:37 +01:00
Aaryamann Challani 853995e17f
chore(rln-relay): barrel imports (#1386)
Co-authored-by: s1fr0 <28568419+s1fr0@users.noreply.github.com>
Co-authored-by: Lorenzo Delgado <lorenzo@status.im>
2022-11-21 15:15:03 +01:00
Hanno Cornelius 97eaa6919b
chore: disable store protocol by default (#1374) 2022-11-14 13:09:37 +02:00
Lorenzo Delgado 4e5318bfbb
docs: extend waku store config tutorial of the operator docs 2022-11-10 15:37:25 +01:00
Lorenzo Delgado 384abed614
docs: extend docs with the different node configuration mechanisms 2022-11-08 18:29:40 +01:00
Aaryamann Challani bd516788cb
docs(operator-trial): add rln instructions (#1311)
* docs(operator-trial): add rln instructions

* fix(operator-trial): rln instructions

* fix(operator-trial): add docker instructions for rln

* fix(operator-trial): add doc in how-to index
2022-10-31 21:07:15 +05:30
Sanaz Taheri 697c122972
chore(docs): removes the eth account address from the onchain-rln-relay tutorial (#1280)
Co-authored-by: Lorenzo Delgado <lorenzo@status.im>
Co-authored-by: Aaryamann Challani <43716372+rymnc@users.noreply.github.com>
2022-10-28 13:05:30 +05:30
Hanno Cornelius 8f5363ea8f
docs: add docker and quickstart guides (#1289) 2022-10-24 11:31:33 +03:00
Sanaz Taheri 46d4e95637
chore(rln-relay): Changes the test scenario of testnet2 tutorial to one chat user (#1261)
* changes the test scenario to one chat user

* minor rewording

* deletes a  surplus newline
2022-10-20 09:37:09 -07:00
Aaryamann Challani 04154ab90f
chore(rln-relay): make account address optional (#1258)
* chore(rln-relay): make account address optional

* fix(rln-relay): onchain test

* chore(chat2): update docs, and handle error case in chat2

* fix(rln-relay): handle registration better
2022-10-12 07:48:11 +05:30
Hanno Cornelius 5e90085242
docs: fix broken Kibana link (#1255) 2022-10-10 16:24:05 +03:00
Sanaz Taheri Boshrooyeh 44d8a2026d
chore(rln-relay): adds Rln-relay testnet2 tutorial (#1232)
* first version

* proof read

* adds a new line
2022-10-07 02:14:30 +08:00
Aaryamann Challani 787464487b
chore(rln-relay): namespaced flags (#1204)
* chore(rln-relay): namespaced flags

* chore(rln-relay): shorten flag size

* fix(rln-relay): consistent config naming

* chore(rln-relay): consistency with address configs

* fix(rln-relay): config
2022-10-03 13:25:56 -07:00
Jakub Sokołowski 3b7d6f4a1b
ci: use docker tag names closer to fleet names
To avoid naming confiusion.

Signed-off-by: Jakub Sokołowski <jakub@status.im>
2022-09-28 17:12:33 +02:00
Hanno Cornelius ca1718c504
fix: signing key for wakuv2 DNS lists has changed (#1174) 2022-09-22 14:51:17 +02:00
Hanno Cornelius 269bb4944b
docs: add monitoring guide for prometheus and grafana (#1168)
* docs: add monitoring guide for prometheus and grafana

* docs: address comments
2022-09-20 10:09:36 +01:00
Aaryamann Challani 48cfaa3320
docs(operator-outreach): nwaku on droplets (#1133)
* docs(operator-outreach): add droplet config

* docs(operator-outreach): add link to droplet setup

* fix(operator-outreach): numbering

* fix(operator-outreach): typos

* docs(operator-outreach): add some prerequisite info

* Update docs/operators/droplet-quickstart.md

Co-authored-by: Hanno Cornelius <68783915+jm-clius@users.noreply.github.com>

* Update docs/operators/droplet-quickstart.md

Co-authored-by: Hanno Cornelius <68783915+jm-clius@users.noreply.github.com>

* fix(operator-outreach): typos and additional info, address review

Co-authored-by: Hanno Cornelius <68783915+jm-clius@users.noreply.github.com>
2022-09-13 16:11:36 +05:30
Sanaz Taheri Boshrooyeh 45f6216aaa
chore (rln-relay): updates rln-caht2 tutorial to match the implementation (#1089)
* updates rln-caht2 tutorial to match the implementation

* minor proofreading

* addresses comments
2022-08-25 11:34:48 -07:00
Sanaz Taheri Boshrooyeh 8a6b1cfba6
feat(Rln-Relay): Consolidates the input paths of rln credential, chat2 reads rln credential from file only (#1080)
* Consolidates the input paths of rln credential, accepts credential file only

* fixes a typo
2022-08-18 10:35:02 -07:00
Sanaz Taheri Boshrooyeh f373f8bc56
chore(RLN-Relay): onchain rln-relay chat2 testnet editorial feadbacks
Signed-off-by: sanaz <staheri14@ku.edu.tr>

adds a newline


fixe a minor spacing issue
2022-08-17 16:55:49 -07:00
Sanaz Taheri Boshrooyeh eebaffdfce
chore(Rln-relay): Tutorial on how to run rln-chat2 in on-chain mode (#1044)
* initial draft of the tutorial

* WIP: explaining test scenarios

* revises the intro

* sample text output and further instructions and refinement

* renames the prerequisite file

* adds a link to the prerequisite tutorial

* explains how to reuse rln credentials

* adds more revisions on the variable names

* fixes the file name

* revises the intro

* minor rewording

* adds a section header

* makes the waku-rln-relay name consistent in case

* fixes the contract address

* revises the description

* renames client in the sample test

* proof read and spell check

* disambiguates ethereum and goerli accounts

* reorganizes the text

* adds image folder

* adds fig caption and some description

* fixes a wrong case

* removes commented parts

* revises the overview

* more clarification on the spam protection

* addresses editorial comments

* fixes the contract address

* fixes a typo
2022-08-04 16:35:16 -07:00
Hanno Cornelius 8baff19f27
docs: update release process docs for contributors (#1001)
* docs: update release process docs for contributors

* Update docs/contributors/release-process.md

Co-authored-by: Lorenzo Delgado <lorenzo@status.im>

* Address comments

Co-authored-by: Lorenzo Delgado <lorenzo@status.im>
2022-07-20 16:27:02 +02:00
Lorenzo Delgado 732f853f55 feat(rest): Add HTTP REST API (#727). Integrate REST API with the Waku V2 node 2022-07-19 11:02:43 +02:00
Keshav Gupta 2ca27ea898
Prerequistes for RLN integration tutorial (#1031)
* Prerequistes for RLN integration tutorial

* Update docs/tutorial/Pre-requisites of running a Waku node.md

Co-authored-by: Sanaz Taheri Boshrooyeh <35961250+staheri14@users.noreply.github.com>

* Update docs/tutorial/Pre-requisites of running a Waku node.md

Co-authored-by: Sanaz Taheri Boshrooyeh <35961250+staheri14@users.noreply.github.com>

* Skip section if existing gorli acc

* Faucet warning

* Wss endpoint note

* More image truncation

* Goerli testnet selection note

* Update docs/tutorial/Pre-requisites of running a Waku node.md

Co-authored-by: Daniel Kaiser <git@kais3r.de>

* Censor Infura Endpoint

* Period added after all statements

* Explanantion Summaries

* Update docs/tutorial/Pre-requisites of running a Waku node.md

Co-authored-by: Sanaz Taheri Boshrooyeh <35961250+staheri14@users.noreply.github.com>

* Update docs/tutorial/Pre-requisites of running a Waku node.md

Co-authored-by: Sanaz Taheri Boshrooyeh <35961250+staheri14@users.noreply.github.com>

* Update docs/tutorial/Pre-requisites of running a Waku node.md

Co-authored-by: Sanaz Taheri Boshrooyeh <35961250+staheri14@users.noreply.github.com>

Co-authored-by: Sanaz Taheri Boshrooyeh <35961250+staheri14@users.noreply.github.com>
Co-authored-by: Daniel Kaiser <git@kais3r.de>
2022-07-07 21:22:22 +02:00
Hanno Cornelius 35045d9d97
docs: add operator guide docs (#963) 2022-05-20 14:48:34 +02:00
Daniel Kaiser 42f48a6892
chore(docker): use NIMFLAGS instead of NIM_PARAMS (#961)
NIM_PARAMS is and internal variable.
NIMFLAGS should be used outside of nimbus build system.

includes:

* fix(docker): copy RLN parameters.key into the container
* chore(makefile): NIMFLAGS in docker img rule
2022-05-17 21:11:07 +02:00
Hanno Cornelius 5ceef37e15
docs(rpc-api-tutorial): fix broken links in JSON-RPC API tutorial (#920) 2022-03-29 15:40:11 +02:00
Daniel Kaiser 0131d1437e
chore(rln): add cleanrln make rule + docu (#910)
* chore(rln): add cleanrln to make rule

- add `cargo clean` to  `make clean`
- add new `cleanrln` make rule that `cargo clean`s the rln vendor repo

* docs(rln): add trouble shooting section

- list `make cleanrln` as a solution to force rebuilding the rln crate
2022-03-25 16:08:13 +01:00
Sanaz Taheri Boshrooyeh bfd427baf0
Tutorial for rln-relay live testnet (#898)
* first edition

* adds the full test scenario

* fixes typos

* fixes a bug in the supplied command

* further edits the description

* displays the chat prompt after spam detection

* updates changelog

* minor wording fix

* Update rln-chat2-live-testnet.md
2022-03-18 15:51:26 -07:00
Jakub Sokołowski 0d2a8b6ddf ci: rename bridge to wakubridge
This makes the current `Dockerfile` usable with `wakubridge`.

Signed-off-by: Jakub Sokołowski <jakub@status.im>
2022-03-10 10:06:53 +01:00
Hanno Cornelius 6be0fb233a
Add bridge docs and minor improvements (#867)
* Add bridge docs and minor improvements

* Clarify that bridging is bidirectional
2022-02-28 18:16:50 +01:00
Sanaz Taheri Boshrooyeh 9ba2cfc8dd
RLN-chat2 tutorial (local testnet) (#853)
* adds tutorial

* updates epoch duration

* minor update

* fixes a minor formatting mismatch

* minor updates

* updates the dates

* reverts the date

* revises the title of a subsection

* updates the case of make command
2022-02-18 16:23:23 -08:00
Daniel Kaiser b3a7722297
result aggregation in resume API (#816) 2022-01-18 23:05:41 +01:00
Hanno Cornelius d74ef67087
Add basic tutorial for Waku v2 DNS-based discovery (#711)
* Added basic tutorial for Waku v2 DNS-based discovery
2021-08-30 11:08:00 +02:00
Hanno Cornelius 6ebe26ad05
Added Waku v2 fleet monitoring and management guide (#707) 2021-08-23 09:34:45 +02:00
Sanaz Taheri Boshrooyeh 71a532a414
Adds timestamp to waku relay message (#681)
* adds timestamp to WakuRelayMessage

* converts float to float64

* generates timestamp using epochTime()

* tides up imports and generates timestamps using epochTime()

* updates changelog

* adds timestamp to the post_waku_v2_relay_v1_message query parameters
2021-07-21 11:05:10 -07:00
Sanaz Taheri Boshrooyeh 05cb073a0f
DB Migration tutorial (#646)
* adds timestamp to waku message store impl

* stores timestamp as int64

* adds untitest

* stores timestamp as seq of bytes

* minor

* re-orders unittest

* changes receiver timestamp to float64

* unit test for receiver timestamps

* adds comments

* reorder a few lines

* updates changelog

* more updates on changelog

* WIP

* WIP

* adds migration

* more debug messages

* passes the path to the migration scripts from message store module

* adds migration result type

* replaces migrationScripts with migrationScriptsResult

* adds path calculation to the message store

* removes some tests binary file

* removes redundant imports

* comments out user_version assignment in sqlite  init

* more descriptive err messages

* clean up test file

* more info logs

* minor code format

* removes a todo

* minor updates

* remove a binary file

* unit tests for migration utils

* adds split script

* integrates split query to handle scripts with multiple commands

* updates migration script for v1

* updates the v1 migration script

* update user version

* updates script

* fixes a few bugs on the splitScript

* more debug logs

* adds float64 parameter support to sqlite3

* change in timestamp type in the script

* deletes float64 toBytes utils

* enables storage of timestamp as a real number in the sqlite db

* bump up script index

* comment edits

* removes migrate unit test

* adds todo and docstring

* updates changelog

* removes an unused item in .gitignore

* minor

* updates changelog

* organizes imports

* cleans up imports

* WIP

* updates script


fixes a few bugs on the splitScript


more debug logs


adds float64 parameter support to sqlite3


change in timestamp type in the script


deletes float64 toBytes utils

* edits migration util test

* remove an empty test file

* includes migration utils tests in

* deletes unused codes

* tides up imports

* adds range based filter to the filterMigrationScripts

* renames procs: removes Migration

* tides up imports

* edits docstring

* edits docstring

* edits docstring

* removes unused imports

* more clean up

* groups std imports

* updates changelog

* adds docstring for setUserVersion

* adds unittest for the migrate

* Update waku/v2/node/storage/message/waku_message_store.nim

Co-authored-by: RichΛrd <info@richardramos.me>

* Update waku/v2/node/storage/sqlite.nim

Co-authored-by: RichΛrd <info@richardramos.me>

* Update waku/v2/node/storage/sqlite.nim

Co-authored-by: RichΛrd <info@richardramos.me>

* removes split scripts

* fixes a naming issue

* fixes a bug

* fixes a typo

* adds a log re updated user_version

* fixes a proc naming mismatch

* fixes naming mismatch

* more descriptive var names

* adds migration script of the first user version

* moves migration to after persistMessages flag is checked

* deletes unused comment

* fixes a bug

* brings back split script

* adds unit tests for split scripts

* runs scripts one command at a time

* deletes a commented line

* relocates the migrate proc to sqlite.nim

* initial writeup

* adds migration tutorial

* adds User guides to db migration tutorial

* minor

* proofread

* replaces a broken link

* user-version to user_version

* some clarification

* some edits

* minor

* a quick wording fix

* minor

* final edits

* updates the changelog

* slight change

Co-authored-by: RichΛrd <info@richardramos.me>
2021-06-25 11:35:46 -07:00
Franck Royer d4974049d9
Add tutorial to setup websockify (#641) 2021-06-23 15:50:26 +10:00
Ebube Sered Ud 6079ae8525
Fix issues with Peer reference in Cheque Functions (#635)
* Add function for getting peer Id

* Modify Handle Cheque and Send Cheque function

* Include PeerInfo in debit and credit functions

* Minor changes to queryWithAccounting function
2021-06-22 21:55:01 +01:00
Ebube Sered Ud 82bad26e02
Add Swap Docs (#638) 2021-06-22 06:15:49 +01:00
Sanaz Taheri Boshrooyeh f75f7c4751
Add resume to waku node api (#564)
* activates resume

* adds unit test

* add store condition

* mode debug info

* updates wakunode resume api and its unittest

* adds todo

* adds documentation

* edits resume documentation

* further edits on the docs

* removes a todo

* fixes a bug

* add resume to waku node api

* further updates on the node.md

* updates the changelog

* minor

* removes return type

* adds a brief desc of the resume to node.md
2021-05-26 12:33:22 -07:00
Hanno Cornelius 131ce6c43b
chat2 improvements (#575)
* chat2 improvements

* Further improvements, content topic config option

* Add content-topic config for chat2bridge
2021-05-26 15:48:09 +02:00
Hanno Cornelius 01d6396385
General chat2bridge improvements (#536) 2021-05-07 10:05:11 +02:00