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

docs: rewrite for clarity, update screenshots #2206

Merged
merged 5 commits into from
Nov 10, 2023
Merged

Conversation

jm-clius
Copy link
Contributor

@jm-clius jm-clius commented Nov 9, 2023

Some rewrites for clarity.
Updates screenshots where necessary (especially for the Infura workflow).


If you already have an Ethereum account with sufficient ethers on the Sepolia testnet then you can skip the first two sections.
## Creating Sepolia Ethereum Account and obtaining its private key
If you already have an Ethereum account with sufficient Sepolia ETH, you can skip 1 and 2.
Copy link
Contributor

Choose a reason for hiding this comment

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

Does the account also have to be in Metamask? Further instructions assume this.

Copy link
Contributor

Choose a reason for hiding this comment

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

Most way to create Eth account don't allow to extract private key (for obvious reasons).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I've removed these If...skip lines. This guide (3 guides, in fact) only makes sense within the context of other instructions and it should be clear in those instructions which of these steps are necessary or not.
For now, I'm only aiming to update what we have for clarity and accuracy, but the docs team should contextualize these within our docs site soon.

If you already have an Ethereum account with sufficient ethers on the Sepolia testnet then you can skip the first two sections.
## Creating Sepolia Ethereum Account and obtaining its private key
If you already have an Ethereum account with sufficient Sepolia ETH, you can skip 1 and 2.
If you already have an Ethereum node on the Sepolia testnet, you can skip 3.
Copy link
Contributor

Choose a reason for hiding this comment

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

If "skip 3" here means "follow 1 and 2, but skip 3", should we move this sentence to the beginning of step 3?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good point. I've opted to remove these conditionals altogether. See my previous comment.

14. Click on Export Private Key.

![](https://i.imgur.com/7g6SyuX.jpg)
You will be shown the private key. Copy it as needed.
Copy link
Contributor

Choose a reason for hiding this comment

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

What does "as needed" mean here? I'd add a note on a) where this key will be pasted and why; b) why this is not a security concern (I hope it's not).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Very good point. This is within the context of a convenience tool for RLN registration that uses this key only for a registration on the testnet. Preferably the context in which this guide is linked should explain the context and dangers. However, I've added some context and warning in 4d921d9.

Copy link
Contributor

@SionoiS SionoiS left a comment

Choose a reason for hiding this comment

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

Thank You!


5. You can find the endpoints for the hosted node using https and wss. The wss endpoint is the relevant one for connecting the waku node to the RLN contract on Sepolia network. Like follows:
Both Https and WebSockets endpoints are available. Waku requires the WebSockets endpoint.
Copy link
Contributor

Choose a reason for hiding this comment

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

I believe clicking websocket reset the network to mainnet. Might want to change the order

@jm-clius jm-clius merged commit a0ef3c2 into master Nov 10, 2023
8 checks passed
@jm-clius jm-clius deleted the docs/prerequisite-guide branch November 10, 2023 13:44
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.

3 participants