nwaku/examples
Ivan FB cfde7eea82
chore: Circuit relay (#3112)
* undo apt install libpcre (not circuit-relay related.)
* nat.nim: protect against possible exceptions when calling getExternalIP
* new external CLI argument, isRelayClient
* waku factory change to mount circuit hop proto by default
* waku_node: move autonat_service to a separate module
2024-10-28 09:17:46 +01:00
..
cbindings chore: libwaku - extending the library with peer_manager and peer_exchange features (#3026) 2024-09-11 10:13:54 +02:00
cpp chore: android support (#2554) 2024-05-21 21:00:22 -04:00
golang updating available procs in golang example (#3137) 2024-10-24 10:33:53 +03:00
mobile chore: android support (#2554) 2024-05-21 21:00:22 -04:00
nodejs chore: libwaku - allow to properly set the log level in libwaku and unify a little (#2708) 2024-05-17 16:28:54 +02:00
python chore: libwaku - allow to properly set the log level in libwaku and unify a little (#2708) 2024-05-17 16:28:54 +02:00
rust chore: android support (#2554) 2024-05-21 21:00:22 -04:00
wakustealthcommitments chore: Circuit relay (#3112) 2024-10-28 09:17:46 +01:00
README.md chore: remove references to v2 (#1898) 2023-08-09 18:11:50 +01:00
filter_subscriber.nim chore: replace statusim.net instances with status.im (#2941) 2024-08-05 12:57:43 +02:00
lightpush_publisher.nim chore: replace statusim.net instances with status.im (#2941) 2024-08-05 12:57:43 +02:00
nim.cfg chore: refactor relative path to better absolute (#2861) 2024-07-06 00:03:38 +02:00
publisher.nim refactor: wrap peer store (#3051) 2024-09-27 18:16:46 +05:30
subscriber.nim refactor: wrap peer store (#3051) 2024-09-27 18:16:46 +05:30

README.md

Examples

Compile

Make all examples.

make example2

## basic2

TODO

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