go-waku/examples/rln
Prem Chaitanya Prathi 2a2e8dcc13
fix: use updated zerokit-rln with epoch as 1 sec as per TWN spec (#976)
2024-01-02 11:15:26 -04:00
..
build fix: RLN 2023-08-01 09:19:38 -04:00
Makefile feat: make RLN available by default 2023-09-14 09:03:18 -04:00
README.md feat: remove named topic (#844) 2023-10-30 21:56:26 +07:00
go.mod fix: use updated zerokit-rln with epoch as 1 sec as per TWN spec (#976) 2024-01-02 11:15:26 -04:00
go.sum fix: use updated zerokit-rln with epoch as 1 sec as per TWN spec (#976) 2024-01-02 11:15:26 -04:00
main.go fix: content topic validation as per rfc 51 (#874) 2023-11-08 18:24:24 +05:30

README.md

Using the rln example application

Background

The rln application is a basic example app that demonstrates how to subscribe to and publish messages using Waku Relay with RLN

Preparation

Edit main.go and set proper values to these constants and variables:

const ethClientAddress = "wss://sepolia.infura.io/ws/v3/API_KEY_GOES_HERE"
const ethPrivateKey = "PRIVATE_KEY_GOES_HERE"
const contractAddress = "0xF471d71E9b1455bBF4b85d475afb9BB0954A29c4"
const credentialsPath = ""
const credentialsPassword = ""

var contentTopic = protocol.NewContentTopic("rln", 1, "test", "proto").String()
var pubsubTopic = protocol.DefaultPubsubTopic{}

The private key used here should contain enough Sepolia ETH to register on the contract (0.001 ETH). An ethereum client address is required as well. After updating these values, execute make

Basic application usage

To start the rln application run the following from the project directory

./build/rln

The app will send a "Hello world!" through the waku relay protocol every 2 seconds and display it on the terminal as soon as it receives the message. Only a single message per epoch is allowed, so 4 out of 5 messages will be considered spam.