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): keystore usage #1750

Merged
merged 2 commits into from
May 22, 2023
Merged

fix(rln-relay): keystore usage #1750

merged 2 commits into from
May 22, 2023

Conversation

rymnc
Copy link
Contributor

@rymnc rymnc commented May 22, 2023

Description

Update operator docs to include keystore change for rln-relay

Changes

  • Used updated arguments to the credential fetching mechanism in the docs

Issue

Part of #1624

@rymnc rymnc self-assigned this May 22, 2023
@rymnc rymnc requested review from alrevuelta and jm-clius May 22, 2023 06:34
Otherwise, the chat client does not generate a new credential and will use, instead, the persisted RLN credential.

```bash
./build/chat2 --fleet:test --content-topic:/toy-chat/3/mingde/proto --rln-relay:true --rln-relay-dynamic:true --rln-relay-eth-contract-address:0x9C09146844C1326c2dBC41c451766C7138F88155 --rln-relay-eth-account-private-key:your_eth_private_key --rln-relay-eth-client-address:your_sepolia_node --ports-shift=1 --rln-relay-cred-path:./
./build/chat2 --fleet:test --content-topic:/toy-chat/3/mingde/proto --rln-relay:true --rln-relay-dynamic:true --rln-relay-eth-contract-address:0x9C09146844C1326c2dBC41c451766C7138F88155 --rln-relay-eth-account-private-key:your_private_key --rln-relay-eth-client-address:your_sepolia_node --ports-shift=1 --rln-relay-cred-path:./rlnKeystore.json --rln-relay-cred-password:your_password
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I understood from the description above that the --rln-relay-cred-path is supposed to be a path to folder - since it explicitly states that is would persist the cred into rlnKeystore.json file under the given path, but the example specifies full path including the file

So it seems either the doc or the example is not fully correct.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, the given command works. Probably the doc doesn't explicitly mention that you have to pass a filename in. I'll make the change.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this better? f0c7fcb

Copy link
Collaborator

@Ivansete-status Ivansete-status left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Although not being requested but it lgtm :)
The tutorial is super well explained!
Maybe it worth adding a reference about how to get eth into the sepolia account? i.e. https://sepoliafaucet.com/ or at least mentioning that you can get eth from there.

@rymnc
Copy link
Contributor Author

rymnc commented May 22, 2023

@rymnc rymnc merged commit 36266b4 into master May 22, 2023
@rymnc rymnc deleted the fix-keystore-instructions branch May 22, 2023 16:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants