nwaku/examples/v2
Ivan Folgueira Bande 3aefade647
fix(discv5): Fixing issue that prevented the wakunode2 from starting (#1829)
* Fixing issue that prevented the wakunode2 from starting

The issue was introduced in PR#1818.

Before this commit, the `wakunode2` app crashed with the next error:

ERR 2023-06-27 15:57:27.268+00:00 5/7 Starting node and protocols failed
topics="wakunode main" tid=1 file=wakunode2.nim:92 error="failed to
start waku discovery v5: "

* fix tests accordingly

* publisher.nim, subscriber.nim: fix
2023-06-27 15:16:59 -04:00
..
README.md chore(docs): fix docs and mark some as deprecated (#1754) 2023-05-25 13:37:49 +02:00
filter_subscriber.nim feat: example using filter and lightpush (#1720) 2023-05-12 12:35:26 +02:00
lightpush_publisher.nim feat: example using filter and lightpush (#1720) 2023-05-12 12:35:26 +02:00
nim.cfg feat(wakunode2): support log format format selection 2022-12-07 12:30:32 +01:00
publisher.nim fix(discv5): Fixing issue that prevented the wakunode2 from starting (#1829) 2023-06-27 15:16:59 -04:00
subscriber.nim fix(discv5): Fixing issue that prevented the wakunode2 from starting (#1829) 2023-06-27 15:16:59 -04:00

README.md

Examples

Compile

Make all examples.

make example2

## basic2

TODO

## publisher/subscriber

Within examples/v2 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 in 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)
  • 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.

./build/subscriber

And run a publisher

./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.

./build/filter_subscriber

And run a lightpush publisher

./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.