Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(rln-relay): readPersistentRlnCredentials returns a result #1310

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion tests/v2/test_waku_rln_relay.nim
Original file line number Diff line number Diff line change
Expand Up @@ -1008,7 +1008,12 @@ suite "Waku rln relay":
# Write RLN credentials
writeFile(path, pretty(%rlnMembershipCredentials))

var credentials = readPersistentRlnCredentials(path)
let credentialsRes = readPersistentRlnCredentials(path)

require:
credentialsRes.isOk()

let credentials = credentialsRes.get()

check:
credentials.membershipKeyPair == k
Expand Down
37 changes: 26 additions & 11 deletions waku/v2/protocol/waku_rln_relay/waku_rln_relay_utils.nim
Original file line number Diff line number Diff line change
Expand Up @@ -1145,27 +1145,38 @@ proc mountRlnRelayDynamic*(node: WakuNode,
node.wakuRlnRelay = rlnPeer
return ok(true)

proc readPersistentRlnCredentials*(path: string) : RlnMembershipCredentials {.raises: [Defect, OSError, IOError, Exception].} =
proc readPersistentRlnCredentials*(path: string) : RlnRelayResult[RlnMembershipCredentials] =
info "Rln credentials exist in file"
# With regards to printing the keys, it is purely for debugging purposes so that the user becomes explicitly aware of the current keys in use when nwaku is started.
# Note that this is only until the RLN contract being used is the one deployed on Goerli testnet.
# These prints need to omitted once RLN contract is deployed on Ethereum mainnet and using valuable funds for staking.
waku_rln_membership_credentials_import_duration_seconds.nanosecondTime:
let entireRlnCredentialsFile = readFile(path)

let jsonObject = parseJson(entireRlnCredentialsFile)
let deserializedRlnCredentials = to(jsonObject, RlnMembershipCredentials)
var entireRlnCredentialsFile: string
try:
entireRlnCredentialsFile = readFile(path)
except Exception as err:
return err("Error while reading the rln credentials file: " & err.msg)
var jsonObject: JsonNode
try:
let jsonObject = parseJson(entireRlnCredentialsFile)
except Exception as err:
return err("Error while parsing the rln credentials file: " & err.msg)
var rlnCredentials: RlnMembershipCredentials
try:
rlnCredentials = jsonObject.to(RlnMembershipCredentials)
except Exception as err:
return err("Error while converting the rln credentials file to RlnMembershipCredentials object: " & err.msg)

debug "Deserialized Rln credentials", rlnCredentials=deserializedRlnCredentials
return deserializedRlnCredentials
debug "Deserialized Rln credentials", rlnCredentials=rlnCredentials
return ok(rlnCredentials)

proc mount(node: WakuNode,
conf: WakuNodeConf|Chat2Conf,
spamHandler: Option[SpamHandler] = none(SpamHandler),
registrationHandler: Option[RegistrationHandler] = none(RegistrationHandler)
): RlnRelayResult[bool] {.raises: [Defect, ValueError, IOError, CatchableError, Exception].} =
): RlnRelayResult[bool] {.raises: [Defect, ValueError, IOError, CatchableError].} =
if not conf.rlnRelayDynamic:
info " setting up waku-rln-relay in off-chain mode... "
info "setting up waku-rln-relay in off-chain mode... "
# set up rln relay inputs
let (groupOpt, memKeyPairOpt, memIndexOpt) = rlnRelayStaticSetUp(MembershipIndex(conf.rlnRelayMembershipIndex))
if memIndexOpt.isNone:
Expand Down Expand Up @@ -1220,9 +1231,13 @@ proc mount(node: WakuNode,
let rlnRelayCredPath = joinPath(conf.rlnRelayCredPath, RlnCredentialsFilename)
debug "rln-relay credential path", rlnRelayCredPath
# check if there is an rln-relay credential file in the supplied path
if fileExists(rlnRelayCredPath):
if fileExists(rlnRelayCredPath):
# retrieve rln-relay credential
credentials = some(readPersistentRlnCredentials(rlnRelayCredPath))
let credentialsRes = readPersistentRlnCredentials(rlnRelayCredPath)
if credentialsRes.isErr():
error "failed to read rln-relay credentials", err=credentialsRes.error()
return err(credentialsRes.error())
credentials = some(credentialsRes.get())

else: # there is no credential file available in the supplied path
# mount the rln-relay protocol leaving rln-relay credentials arguments unassigned
Expand Down