Feat/service incentivization poc

README.md

@@ -9,7 +9,9 @@ The nwaku repository implements Waku, and provides tools related to it.
 - Examples of Waku usage.
 - Various tests of above.
 
-For more details see the [source code](waku/README.md)
+For more details see the [source code](waku/README.md).
+
+For information on Service Incentivization (i13n) PoC, see [README-I13N-POC.md](README-I13N-POC.md).
 
 ## How to Build & Run ( Linux, MacOS & WSL )
 

i13n-poc-configs/envvars.env

@@ -0,0 +1,4 @@
+export ELIGIBILITY_ETH_CLIENT_ADDRESS="https://rpc.sepolia.linea.build/"
+export RLN_RELAY_ETH_CLIENT_ADDRESS="https://rpc.sepolia.linea.build/"
+export RLN_RELAY_CRED_PATH="../nwaku-compose/keystore/keystore.json"
+export RLN_RELAY_CRED_PASSWORD="<INSERT_YOUR_RLN_RELAY_CRED_PASSWORD>"

i13n-poc-configs/run_alice.sh

@@ -0,0 +1,8 @@
+#!/bin/bash
+
+# Load env vars
+source ./i13n-poc-configs/envvars.env
+
+# Run nwaku
+./build/wakunode2 \
+  --config-file=./i13n-poc-configs/toml/alice.toml

i13n-poc-configs/run_bob.sh

@@ -0,0 +1,12 @@
+#!/bin/bash
+
+# Load env vars
+source ./i13n-poc-configs/envvars.env
+
+# Run nwaku
+./build/wakunode2 \
+  --config-file=./i13n-poc-configs/toml/bob.toml \
+  --rln-relay-eth-client-address=$RLN_RELAY_ETH_CLIENT_ADDRESS \
+  --rln-relay-cred-path=$RLN_RELAY_CRED_PATH \
+  --rln-relay-cred-password=$RLN_RELAY_CRED_PASSWORD \
+  --eligibility-eth-client-address=$ELIGIBILITY_ETH_CLIENT_ADDRESS

i13n-poc-configs/run_charlie.sh

@@ -0,0 +1,12 @@
+#!/bin/bash
+
+# Load env vars
+source ./i13n-poc-configs/envvars.env
+
+# Run nwaku
+./build/wakunode2 \
+  --config-file=./i13n-poc-configs/toml/charlie.toml \
+  --rln-relay-eth-client-address=$RLN_RELAY_ETH_CLIENT_ADDRESS \
+  --rln-relay-cred-path=$RLN_RELAY_CRED_PATH \
+  --rln-relay-cred-password=$RLN_RELAY_CRED_PASSWORD \
+  --eligibility-eth-client-address=$ELIGIBILITY_ETH_CLIENT_ADDRESS

i13n-poc-configs/run_dave.sh

@@ -0,0 +1,9 @@
+#!/bin/bash
+
+# Load env vars
+source ./i13n-poc-configs/envvars.env
+
+# Run nwaku
+./build/wakunode2 \
+  --config-file=./i13n-poc-configs/toml/dave.toml \
+  --rln-relay-eth-client-address=$RLN_RELAY_ETH_CLIENT_ADDRESS 

i13n-poc-configs/toml/alice.toml

@@ -0,0 +1,41 @@
+# Incentivization PoC: Alice
+
+# Alice is a client node that wants to publish messages
+# without being connected to Relay.
+
+# Disable Lightpush
+lightpush = false
+
+# Use a pre-generated static node key for reproducibility
+nodekey = "17950ef7510db19197ec0e3d34b41c0ed60bb7a0a619aa504eb6689c85ca9925"
+
+# Connect to Charlie only on launch
+# (Alice will connect to Bob via REST API later)
+staticnode = [ "/ip4/127.0.0.1/tcp/60003/p2p/16Uiu2HAkyxHKziUQghTarGhBSFn8GcVapDgkJjMFTUVCCfEuyzSd" ]
+
+# Connect to The Waku Network (TWN)
+# (must come before we override relay and discovery to false)
+preset = "twn"
+
+# Disable Relay and RLN-Relay
+relay = false
+rln-relay = false
+
+# Disable discovery methods to ensure node isolation
+discv5-discovery = false
+dns-discovery = false
+
+# Reputation-related parameters
+reputation-enabled = true
+
+# Shift ports to avoid conflicts in local setups
+ports-shift = 1
+
+# Enable REST API including admin functions
+rest = true
+rest-admin = true
+rest-address = "127.0.0.1"
+rest-allow-origin = [ "127.0.0.1:*" ]
+
+# Log level
+log-level = "DEBUG"

i13n-poc-configs/toml/bob.toml

@@ -0,0 +1,43 @@
+# Incentivization PoC: Bob
+
+# Bob is a service node with Lightpush and Relay enabled
+# that successfully fulfils Alice's eligible requests.
+# Bob also checks for double-spend attempts - 
+# when Alice submits duplicate txid as proof of payment.
+
+# Enable Lightpush
+lightpush = true
+
+# Use a pre-generated static node key for reproducibility
+nodekey = "2bd3bbef1afa198fc614a254367de5ae285d799d7b1ba6d9d8543ba41038bbed"
+
+# Connect to Dave
+staticnode = [ "/ip4/127.0.0.1/tcp/60002/p2p/16Uiu2HAmSCUwvwDnXm7PyVbtKiQ5xzXb36wNw8YbGQxcBuxWTuU8" ]
+
+# Enable Relay (required for eligibility module)
+relay = true
+
+# Connect to The Waku Network (TWN)
+preset = "twn"
+
+# Optional: Bob only connecting to Dave is OK for testing scenario
+discv5-discovery = false
+dns-discovery = false
+nat = "upnp"
+
+# Eligibility-related parameters
+eligibility-enabled = true
+eligibility-receiver-address = "0x6298cc1831B6E5eDEDA5cC73bc75a040108358Bb"
+eligibility-payment-amount-wei = 1000000000
+
+# RLN-related parameters
+rln-relay-tree-path = "~/.waku/rln-tree-db"
+
+# Enable REST API including admin functions
+rest = true
+rest-admin = true
+rest-address = "127.0.0.1"
+rest-allow-origin = [ "127.0.0.1:*" ]
+
+# Log level
+log-level = "DEBUG"

i13n-poc-configs/toml/charlie.toml

@@ -0,0 +1,43 @@
+# Incentivization PoC: Charlie
+
+# Charlie is an isolated node with Relay and Lightpush enabled.
+# Charlie fails to fulfill Alice's request due to lack of peers.
+# However, Charlie implements eligibility-related checks,
+# and rejects Alice's ineligible requests before trying to fulfil them.
+
+# Enable Lightpush
+lightpush = true
+
+# Use a pre-generated static node key for reproducibility
+nodekey = "fbfa8c3e38e7594500e9718b8c800e2d1a3ef5bc65ce041adf788d276035230f"
+
+# Enable Relay (required for eligibility module)
+relay = true
+
+# Connect to The Waku Network (TWN)
+preset = "twn"
+
+# Disable discovery methods to ensure node isolation
+discv5-discovery = false
+dns-discovery = false
+nat = "upnp"
+
+# Eligibility-related parameters
+eligibility-enabled = true
+eligibility-receiver-address = "0x6298cc1831B6E5eDEDA5cC73bc75a040108358Bb"
+eligibility-payment-amount-wei = 1000000000
+
+# Shift ports to avoid conflicts in local setups
+ports-shift = 3
+
+# RLN-related parameters
+rln-relay-tree-path = "~/.waku/rln-tree-db-3"
+
+# Enable REST API including admin functions
+rest = true
+rest-admin = true
+rest-address = "127.0.0.1"
+rest-allow-origin = [ "127.0.0.1:*" ]
+
+# Log level
+log-level = "DEBUG"

i13n-poc-configs/toml/dave.toml

@@ -0,0 +1,32 @@
+# Incentivization PoC: Dave
+
+# Dave is a Relay node that Bob uses to publishing Alice's message.
+# Dave is unaware of any elibibiligy- or reputation-related features.
+
+# Enable Lightpush
+lightpush = true
+
+# Use a pre-generated static node key for reproducibility
+nodekey = "166aee32c415fe796378ca0336671f4ec1fa26648857a86a237e509aaaeb1980"
+
+# Enable Relay (required for eligibility module)
+relay = true
+
+# Connect to The Waku Network (TWN)
+preset = "twn"
+nat = "upnp"
+
+# Shift ports to avoid conflicts in local setups
+ports-shift = 2
+
+# RLN-related parameters
+rln-relay-tree-path = "~/.waku/rln-tree-db-2"
+
+# Enable REST API including admin functions
+rest = true
+rest-admin = true
+rest-address = "127.0.0.1"
+rest-allow-origin = [ "127.0.0.1:*" ]
+
+# Log level
+log-level = "DEBUG"

tests/incentivization/test_poc_eligibility.nim

@@ -130,7 +130,8 @@ suite "Waku Incentivization PoC Eligibility Proofs":
   var manager {.threadvar.}: EligibilityManager
 
   asyncSetup:
-    manager = await EligibilityManager.init(EthClient)
+    # Setup manager with expected receiver and amount
+    manager = await EligibilityManager.init(EthClient, Address.fromHex(receiverExpected.toHex()), TxValueExpectedWei)
 
     (
       txHashWrongReceiverRightAmount, txHashRightReceiverWrongAmount,
@@ -147,7 +148,7 @@ suite "Waku Incentivization PoC Eligibility Proofs":
     let eligibilityProof =
       EligibilityProof(proofOfPayment: some(@(TxHashNonExisting.bytes())))
     let isEligible = await manager.isEligibleTxId(
-      eligibilityProof, receiverExpected, TxValueExpectedWei
+      eligibilityProof
     )
     check:
       isEligible.isErr()
@@ -158,7 +159,7 @@ suite "Waku Incentivization PoC Eligibility Proofs":
     let eligibilityProof =
       EligibilityProof(proofOfPayment: some(@(txHashContractCreation.bytes())))
     let isEligible = await manager.isEligibleTxId(
-      eligibilityProof, receiverExpected, TxValueExpectedWei
+      eligibilityProof
     )
     check:
       isEligible.isErr()
@@ -170,7 +171,7 @@ suite "Waku Incentivization PoC Eligibility Proofs":
     let eligibilityProof =
       EligibilityProof(proofOfPayment: some(@(txHashContractCall.bytes())))
     let isEligible = await manager.isEligibleTxId(
-      eligibilityProof, receiverExpected, TxValueExpectedWei
+      eligibilityProof
     )
     check:
       isEligible.isErr()
@@ -181,7 +182,7 @@ suite "Waku Incentivization PoC Eligibility Proofs":
     let eligibilityProof =
       EligibilityProof(proofOfPayment: some(@(txHashRightReceiverRightAmount.bytes())))
     let isEligible = await manager.isEligibleTxId(
-      eligibilityProof, receiverExpected, TxValueExpectedWei
+      eligibilityProof
     )
 
     assert isEligible.isOk(), isEligible.error
@@ -193,11 +194,11 @@ suite "Waku Incentivization PoC Eligibility Proofs":
       EligibilityProof(proofOfPayment: some(@(txHashRightReceiverRightAmount.bytes())))
 
     let isEligibleOnce = await manager.isEligibleTxId(
-      eligibilityProof, receiverExpected, TxValueExpectedWei
+      eligibilityProof
     )
 
     let isEligibleTwice = await manager.isEligibleTxId(
-      eligibilityProof, receiverExpected, TxValueExpectedWei
+      eligibilityProof
     )
 
     assert isEligibleOnce.isOk()