feat: stateless RLN ( bump v0.9.0 ) (#3621)

Author: darshankabariya

Makefile

@@ -177,7 +177,7 @@ nimbus-build-system-nimble-dir:
 .PHONY: librln
 
 LIBRLN_BUILDDIR := $(CURDIR)/vendor/zerokit
-LIBRLN_VERSION := v0.8.0
+LIBRLN_VERSION := v0.9.0
 
 ifeq ($(detected_OS),Windows)
 LIBRLN_FILE := rln.lib

apps/benchmarks/benchmarks.nim

@@ -15,7 +15,7 @@ proc benchmark(
     manager: OnChainGroupManager, registerCount: int, messageLimit: int
 ): Future[string] {.async, gcsafe.} =
   # Register a new member so that we can later generate proofs
-  let idCredentials = generateCredentials(manager.rlnInstance, registerCount)
+  let idCredentials = generateCredentials(registerCount)
 
   var start_time = getTime()
   for i in 0 .. registerCount - 1:

scripts/build_rln.sh

@@ -49,6 +49,6 @@ else
         exit 1
     fi
     # if submodule version = version in Makefile, build rln
-    cargo build --release -p rln --manifest-path "${build_dir}/rln/Cargo.toml" --features arkzkey
+    cargo build --release -p rln --manifest-path "${build_dir}/rln/Cargo.toml" 
     cp "${build_dir}/target/release/librln.a" "${output_filename}"
 fi

tests/node/test_wakunode_legacy_lightpush.nim

@@ -151,7 +151,7 @@ suite "RLN Proofs as a Lightpush Service":
     client.mountLegacyLightPushClient()
 
     let manager1 = cast[OnchainGroupManager](server.wakuRlnRelay.groupManager)
-    let idCredentials1 = generateCredentials(manager1.rlnInstance)
+    let idCredentials1 = generateCredentials()
 
     try:
       waitFor manager1.register(idCredentials1, UserMessageLimit(20))

tests/node/test_wakunode_lightpush.nim

@@ -151,7 +151,7 @@ suite "RLN Proofs as a Lightpush Service":
     client.mountLightPushClient()
 
     let manager1 = cast[OnchainGroupManager](server.wakuRlnRelay.groupManager)
-    let idCredentials1 = generateCredentials(manager1.rlnInstance)
+    let idCredentials1 = generateCredentials()
 
     try:
       waitFor manager1.register(idCredentials1, UserMessageLimit(20))

tests/waku_rln_relay/rln/test_wrappers.nim

@@ -34,14 +34,9 @@ proc valid(x: seq[byte]): bool =
   return true
 
 suite "membershipKeyGen":
-  var rlnRes {.threadvar.}: RLNResult
-
-  setup:
-    rlnRes = createRLNInstanceWrapper()
-
   test "ok":
     # Given we generate valid membership keys
-    let identityCredentialsRes = membershipKeyGen(rlnRes.get())
+    let identityCredentialsRes = membershipKeyGen()
 
     # Then it contains valid identity credentials
     let identityCredentials = identityCredentialsRes.get()
@@ -62,7 +57,7 @@ suite "membershipKeyGen":
       keyGenMock
 
     # When we generate the membership keys
-    let identityCredentialsRes = membershipKeyGen(rlnRes.get())
+    let identityCredentialsRes = membershipKeyGen()
 
     # Then it fails
     check:
@@ -85,7 +80,7 @@ suite "membershipKeyGen":
       keyGenMock
 
     # When we generate the membership keys
-    let identityCredentialsRes = membershipKeyGen(rlnRes.get())
+    let identityCredentialsRes = membershipKeyGen()
 
     # Then it fails
     check:

tests/waku_rln_relay/test_rln_group_manager_onchain.nim

@@ -60,44 +60,6 @@ suite "Onchain group manager":
     (waitFor manager.init()).isOkOr:
       raiseAssert $error
 
-  test "should error on initialization when loaded metadata does not match":
-    (waitFor manager.init()).isOkOr:
-      assert false, $error
-    let metadataSetRes = manager.setMetadata()
-    assert metadataSetRes.isOk(), metadataSetRes.error
-    let metadataOpt = manager.rlnInstance.getMetadata().valueOr:
-      assert false, $error
-      return
-    assert metadataOpt.isSome(), "metadata is not set"
-    let metadata = metadataOpt.get()
-    assert metadata.chainId == 1234, "chainId is not equal to 1234"
-    assert metadata.contractAddress == manager.ethContractAddress,
-      "contractAddress is not equal to " & manager.ethContractAddress
-    let web3 = manager.ethRpc.get()
-    let accounts = waitFor web3.provider.eth_accounts()
-    web3.defaultAccount = accounts[2]
-    let (privateKey, acc) = createEthAccount(web3)
-    let tokenAddress = (waitFor deployTestToken(privateKey, acc, web3)).valueOr:
-      assert false, "Failed to deploy test token contract: " & $error
-      return
-    let differentContractAddress = (
-      waitFor executeForgeContractDeployScripts(privateKey, acc, web3)
-    ).valueOr:
-      assert false, "Failed to deploy RLN contract: " & $error
-      return
-    # simulating a change in the contractAddress
-    let manager2 = OnchainGroupManager(
-      ethClientUrls: @[EthClient],
-      ethContractAddress: $differentContractAddress,
-      rlnInstance: manager.rlnInstance,
-      onFatalErrorAction: proc(errStr: string) =
-        assert false, errStr
-      ,
-    )
-    let e = waitFor manager2.init()
-    (e).isErrOr:
-      assert false, "Expected error when contract address doesn't match"
-
   test "should error if contract does not exist":
     manager.ethContractAddress = "0x0000000000000000000000000000000000000000"
 
@@ -118,7 +80,7 @@ suite "Onchain group manager":
       check getCurrentExceptionMsg().len == 38
 
   test "trackRootChanges: should sync to the state of the group":
-    let credentials = generateCredentials(manager.rlnInstance)
+    let credentials = generateCredentials()
     (waitFor manager.init()).isOkOr:
       raiseAssert $error
 
@@ -133,17 +95,7 @@ suite "Onchain group manager":
 
     let merkleRootAfter = waitFor manager.fetchMerkleRoot()
 
-    let metadataSetRes = manager.setMetadata()
-    assert metadataSetRes.isOk(), metadataSetRes.error
-
-    let metadataOpt = getMetadata(manager.rlnInstance).valueOr:
-      raiseAssert $error
-
-    assert metadataOpt.isSome(), "metadata is not set"
-    let metadata = metadataOpt.get()
-
     check:
-      metadata.validRoots == manager.validRoots.toSeq()
       merkleRootBefore != merkleRootAfter
 
   test "trackRootChanges: should fetch history correctly":
@@ -152,7 +104,7 @@ suite "Onchain group manager":
     #       so we can't use it in this test. 
 
     const credentialCount = 6
-    let credentials = generateCredentials(manager.rlnInstance, credentialCount)
+    let credentials = generateCredentials(credentialCount)
     (waitFor manager.init()).isOkOr:
       raiseAssert $error
 
@@ -191,7 +143,7 @@ suite "Onchain group manager":
     (waitFor manager.init()).isOkOr:
       raiseAssert $error
 
-    let idCredentials = generateCredentials(manager.rlnInstance)
+    let idCredentials = generateCredentials()
     let merkleRootBefore = waitFor manager.fetchMerkleRoot()
 
     try:
@@ -207,7 +159,7 @@ suite "Onchain group manager":
       manager.latestIndex == 1
 
   test "register: callback is called":
-    let idCredentials = generateCredentials(manager.rlnInstance)
+    let idCredentials = generateCredentials()
     let idCommitment = idCredentials.idCommitment
 
     let fut = newFuture[void]()
@@ -237,7 +189,7 @@ suite "Onchain group manager":
     waitFor fut
 
   test "withdraw: should guard against uninitialized state":
-    let idSecretHash = generateCredentials(manager.rlnInstance).idSecretHash
+    let idSecretHash = generateCredentials().idSecretHash
 
     try:
       waitFor manager.withdraw(idSecretHash)
@@ -247,7 +199,7 @@ suite "Onchain group manager":
       assert false, "exception raised: " & getCurrentExceptionMsg()
 
   test "validateRoot: should validate good root":
-    let idCredentials = generateCredentials(manager.rlnInstance)
+    let idCredentials = generateCredentials()
     let idCommitment = idCredentials.idCommitment
 
     let fut = newFuture[void]()
@@ -298,7 +250,7 @@ suite "Onchain group manager":
       validated
 
   test "validateRoot: should reject bad root":
-    let idCredentials = generateCredentials(manager.rlnInstance)
+    let idCredentials = generateCredentials()
     let idCommitment = idCredentials.idCommitment
 
     (waitFor manager.init()).isOkOr:
@@ -331,7 +283,7 @@ suite "Onchain group manager":
       validated == false
 
   test "verifyProof: should verify valid proof":
-    let credentials = generateCredentials(manager.rlnInstance)
+    let credentials = generateCredentials()
     (waitFor manager.init()).isOkOr:
       raiseAssert $error
 
@@ -383,7 +335,7 @@ suite "Onchain group manager":
     (waitFor manager.init()).isOkOr:
       raiseAssert $error
 
-    let idCredential = generateCredentials(manager.rlnInstance)
+    let idCredential = generateCredentials()
 
     try:
       waitFor manager.register(idCredential, UserMessageLimit(20))
@@ -420,7 +372,7 @@ suite "Onchain group manager":
 
   test "root queue should be updated correctly":
     const credentialCount = 12
-    let credentials = generateCredentials(manager.rlnInstance, credentialCount)
+    let credentials = generateCredentials(credentialCount)
     (waitFor manager.init()).isOkOr:
       raiseAssert $error
 

tests/waku_rln_relay/test_waku_rln_relay.nim

@@ -36,15 +36,11 @@ suite "Waku rln relay":
   test "key_gen Nim Wrappers":
     let merkleDepth: csize_t = 20
 
-    let rlnInstance = createRLNInstanceWrapper()
-    require:
-      rlnInstance.isOk()
-
     # keysBufferPtr will hold the generated identity credential i.e., id trapdoor, nullifier, secret hash and commitment
     var keysBuffer: Buffer
     let
       keysBufferPtr = addr(keysBuffer)
-      done = key_gen(rlnInstance.get(), keysBufferPtr)
+      done = key_gen(keysBufferPtr, true)
     require:
       # check whether the keys are generated successfully
       done
@@ -56,12 +52,7 @@ suite "Waku rln relay":
     info "generated keys: ", generatedKeys
 
   test "membership Key Generation":
-    # create an RLN instance
-    let rlnInstance = createRLNInstanceWrapper()
-    require:
-      rlnInstance.isOk()
-
-    let idCredentialsRes = membershipKeyGen(rlnInstance.get())
+    let idCredentialsRes = membershipKeyGen()
     require:
       idCredentialsRes.isOk()
 
@@ -79,61 +70,6 @@ suite "Waku rln relay":
 
     info "the generated identity credential: ", idCredential
 
-  test "setMetadata rln utils":
-    # create an RLN instance which also includes an empty Merkle tree
-    let rlnInstance = createRLNInstanceWrapper()
-    require:
-      rlnInstance.isOk()
-    let rln = rlnInstance.get()
-    check:
-      rln
-      .setMetadata(
-        RlnMetadata(
-          lastProcessedBlock: 128,
-          chainId: 1155511'u256,
-          contractAddress: "0x9c09146844c1326c2dbc41c451766c7138f88155",
-        )
-      )
-      .isOk()
-
-  test "getMetadata rln utils":
-    # create an RLN instance which also includes an empty Merkle tree
-    let rlnInstance = createRLNInstanceWrapper()
-    require:
-      rlnInstance.isOk()
-    let rln = rlnInstance.get()
-
-    require:
-      rln
-      .setMetadata(
-        RlnMetadata(
-          lastProcessedBlock: 128,
-          chainId: 1155511'u256,
-          contractAddress: "0x9c09146844c1326c2dbc41c451766c7138f88155",
-        )
-      )
-      .isOk()
-
-    let metadataOpt = rln.getMetadata().valueOr:
-      raiseAssert $error
-
-    assert metadataOpt.isSome(), "metadata is not set"
-    let metadata = metadataOpt.get()
-    check:
-      metadata.lastProcessedBlock == 128
-      metadata.chainId == 1155511'u256
-      metadata.contractAddress == "0x9c09146844c1326c2dbc41c451766c7138f88155"
-
-  test "getMetadata: empty rln metadata":
-    # create an RLN instance which also includes an empty Merkle tree
-    let rln = createRLNInstanceWrapper().valueOr:
-      raiseAssert $error
-    let metadata = rln.getMetadata().valueOr:
-      raiseAssert $error
-
-    check:
-      metadata.isNone()
-
   test "hash Nim Wrappers":
     # create an RLN instance
     let rlnInstance = createRLNInstanceWrapper()
@@ -149,7 +85,7 @@ suite "Waku rln relay":
     # prepare other inputs to the hash function
     let outputBuffer = default(Buffer)
 
-    let hashSuccess = sha256(unsafeAddr hashInputBuffer, unsafeAddr outputBuffer)
+    let hashSuccess = sha256(unsafeAddr hashInputBuffer, unsafeAddr outputBuffer, true)
     require:
       hashSuccess
     let outputArr = cast[ptr array[32, byte]](outputBuffer.`ptr`)[]
@@ -348,7 +284,7 @@ suite "Waku rln relay":
       raiseAssert $error
 
     let manager = cast[OnchainGroupManager](wakuRlnRelay.groupManager)
-    let idCredentials = generateCredentials(manager.rlnInstance)
+    let idCredentials = generateCredentials()
 
     try:
       waitFor manager.register(idCredentials, UserMessageLimit(20))
@@ -405,7 +341,7 @@ suite "Waku rln relay":
       raiseAssert $error
 
     let manager = cast[OnchainGroupManager](wakuRlnRelay.groupManager)
-    let idCredentials = generateCredentials(manager.rlnInstance)
+    let idCredentials = generateCredentials()
 
     try:
       waitFor manager.register(idCredentials, UserMessageLimit(20))
@@ -455,7 +391,7 @@ suite "Waku rln relay":
       raiseAssert "failed to create waku rln relay: " & $error
 
     let manager1 = cast[OnchainGroupManager](wakuRlnRelay1.groupManager)
-    let idCredentials1 = generateCredentials(manager1.rlnInstance)
+    let idCredentials1 = generateCredentials()
 
     try:
       waitFor manager1.register(idCredentials1, UserMessageLimit(20))
@@ -469,7 +405,7 @@ suite "Waku rln relay":
       raiseAssert "failed to create waku rln relay: " & $error
 
     let manager2 = cast[OnchainGroupManager](wakuRlnRelay2.groupManager)
-    let idCredentials2 = generateCredentials(manager2.rlnInstance)
+    let idCredentials2 = generateCredentials()
 
     try:
       waitFor manager2.register(idCredentials2, UserMessageLimit(20))
@@ -502,15 +438,7 @@ suite "Waku rln relay":
       msgValidate2 == MessageValidationResult.Valid
 
   test "toIDCommitment and toUInt256":
-    # create an instance of rln
-    let rlnInstance = createRLNInstanceWrapper()
-    require:
-      rlnInstance.isOk()
-
-    let rln = rlnInstance.get()
-
-    # create an idendity credential
-    let idCredentialRes = rln.membershipKeyGen()
+    let idCredentialRes = membershipKeyGen()
     require:
       idCredentialRes.isOk()
 
@@ -526,12 +454,7 @@ suite "Waku rln relay":
       idCredential.idCommitment == idCommitment
 
   test "Read/Write RLN credentials":
-    # create an RLN instance
-    let rlnInstance = createRLNInstanceWrapper()
-    require:
-      rlnInstance.isOk()
-
-    let idCredentialRes = membershipKeyGen(rlnInstance.get())
+    let idCredentialRes = membershipKeyGen()
     require:
       idCredentialRes.isOk()