Commit Graph

57 Commits

Author SHA1 Message Date
omahs 958b9bd712
chore: fix typos (#2239) 2023-11-30 11:08:08 +01:00
Aaryamann Challani 8c5666d200
chore: update docs for rln-keystore-generator (#2210) 2023-11-21 16:43:15 +03:00
Hanno Cornelius a0ef3c2fbf
docs: rewrite for clarity, update screenshots (#2206)
* docs: rewrite for clarity, update screenshots

* docs: be less cavalier about private key, other improvements

* docs: missed some spots

* docs: move private key warning to beginning
2023-11-10 13:43:59 +00:00
Aaryamann Challani 645b034367
feat(rln-relay): removed rln from experimental 🚀 (#2001)
* feat(rln-relay): removed rln from experimental 🚀

* fix(waku_node): if rln-relay is nil, return true

* chore(tests): mark rest health as skipped
2023-09-11 12:02:31 +05:30
Aaryamann Challani 76e34077b2
chore(rln-relay): updated docs (#1993) 2023-09-11 11:10:41 +05:30
Ivan Folgueira Bande 04df6d1fa7
Removing bridge.md tutorial as v1 doc was removed (#1954) 2023-08-28 10:09:42 +02:00
Aaryamann Challani f08315cdde
fix(rln-relay): remove registration capability (#1916) 2023-08-22 11:49:18 +05:30
Hanno Cornelius b9d5d28af5
chore: remove references to v2 (#1898)
* chore: remove references to v2

* fix: lingering rln-relay import path
2023-08-09 18:11:50 +01:00
Aaryamann Challani a00aa8cc59
feat(rln-relay): pass in index to keystore credentials (#1777)
* feat(rln-relay): pass in index to keystore credentials

* fix(rln-relay): s/MembershipIndex/uint
2023-06-06 23:13:05 +05:30
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
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
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
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
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
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
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 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
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
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
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
Sanaz Taheri Boshrooyeh c0d858af1d
Enables perssist-message flag in the store protocol for wakunode2 (#519)
* enables perssistmessage flag

* disables in memory storage when persist-messages is false

* adds the persistMessages input to the mountStore

* defaults the store flag to true

* adds the missing argument

* persists messages in memory conditioned to the persistMessages flag

* adds persistmessages flag to the config_bridge

* defaults persistmessages to true

* defaults the store flag to true and persist-messages to false

* updates store.md

* updates chat2 instructions about --store flag

* removes --store flag from chat2 command execution

Co-authored-by: Oskar Thorén <ot@oskarthoren.com>
2021-05-03 14:30:52 -07:00
Hanno Cornelius 900d53f9df
Implement graceful shutdown for `wakunode2` and `chat2` (#490)
* Implement graceful shutdown

* Consistent use of QuitSuccess
2021-04-15 10:18:14 +02:00
Hanno Cornelius 27844c9a20
Specify chat2 message format (#440)
* Specify chat2 message format

* Clarify payload is UTF8 encoded
2021-03-31 17:06:20 +02:00
Hanno Cornelius cc962f2dd5
Further chat2 improvements (#405) 2021-03-04 09:19:21 +02:00
Hanno Cornelius 9faff49e5b
Remove stale rpc code & repair scripts (#365)
* Remove stale rpc code & repair scripts
2021-02-04 10:39:55 +02:00
Oskar Thorén 39d08ce930
Add basic docs for cluster fleet (#340)
* Add basic docs for cluster fleet

* Add more cluster notes for viewing logs

* Add note on submodules
2021-01-07 18:10:38 +08:00
Hanno Cornelius 8203f30099
Integrate API and add tutorial (#330) 2020-12-24 10:02:30 +02:00
Dean Eigenmann 1568fa6e6f
feature/persistence-simple (#268)
* implements

* add

* fix

* eol

* rebase

* added tests

* minor cleanup

* errors

* Update store.md

* fix
2020-11-16 09:38:52 +01:00
Kim De Mey aab93912ef
Cleanup the wakunode2 config (#242) 2020-10-22 17:04:17 +02:00
Kim De Mey dcbefbf4d6
Wakuv1v2 process (#238)
* Add start of wakubridge with only waku v1 node for now

* Add waku v2 node to wakubridge

* Add bridge target to makefile

* Keep waku v1 PoW configurable

* Fix for latest WakuNode API

* Fix Makefile target all

* Rename to config_bridge and at brief docs on bridge

Co-authored-by: Oskar Thorén <ot@oskarthoren.com>
2020-10-21 17:54:29 +08:00
Dean Eigenmann 5c25ed131a
enhancement/integrate-store-chat (#230)
* added store protocol

* setting peer

* fix

* line

* Update dingpu.md

* Update chat2.nim

* Update dingpu.md

* Update dingpu.md

* playing around

* fix

* fix

* fixes

* tested

* tested and finalized

* fix

* Update docs/tutorial/dingpu.md

Co-authored-by: Oskar Thorén <ot@oskarthoren.com>

* Update chat2.nim

* fix

Co-authored-by: Oskar Thorén <ot@oskarthoren.com>
2020-10-15 13:56:53 +02:00
Oskar Thorén e67301f1f6
Update dingpu.md 2020-10-15 17:30:56 +08:00