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

Prerequistes for RLN integration tutorial #1031

Merged
merged 15 commits into from
Jul 7, 2022

Conversation

kgrgpg
Copy link
Contributor

@kgrgpg kgrgpg commented Jun 30, 2022

These are the tutorials on the pre-requisites needed to integrate the RLN contract with nWaku.

  • Creating Goerli Ethereum Account and obtaining its private key
  • Obtain Goerli Ethers from faucet
  • Setting up a hosted node on Goerli Testnet using Infura

@kgrgpg kgrgpg requested a review from staheri14 June 30, 2022 19:02
@status-im-auto
Copy link
Collaborator

status-im-auto commented Jun 30, 2022

Jenkins Builds

Click to see older builds (2)
Commit #️⃣ Finished (UTC) Duration Platform Result
c8d7125 #1 2022-06-30 22:19:12 ~35 min windows 📄log
✔️ c8d7125 #1 2022-07-01 04:06:23 ~19 min macos 📦bin
Commit #️⃣ Finished (UTC) Duration Platform Result
b297524 #2 2022-07-04 22:14:45 ~30 min windows 📄log
✔️ b297524 #2 2022-07-05 04:07:42 ~20 min macos 📦bin
✔️ e1f563e #3 2022-07-07 04:04:34 ~17 min macos 📦bin

@staheri14
Copy link
Contributor

Thank you @kgrgpg for the PR, it looks good in general, a few comments before getting it merged:

  • These figures can enjoy more trimming: Section figures 8 and 12 under "Creating Goerli Ethereum Account and obtaining its private key" and figures 6, 10 from section "Obtain Goerli Ethers from faucet"

@kgrgpg
Copy link
Contributor Author

kgrgpg commented Jul 3, 2022

@staheri14 All the recommendations are now incorporated in the branch.

Copy link
Contributor

@staheri14 staheri14 left a comment

Choose a reason for hiding this comment

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

Thanks for resolving the comments! though, in general, it is conventional to let the reviewer mark his/her comments as resolved and not the other way around :)
The PR looks good to me, some nitpick:

  • please add a period . to the end of all the lines for consistency
  • Also, please remove your Infura node addresses from the pictures (keep the wss part but cover the rest).

Your branch is out of date with the master branch, please also update it.


![](https://i.imgur.com/UFsoRHR.jpg)

9. Close the settings and now you should see the test networks in the drop down on the top right
Copy link
Contributor

Choose a reason for hiding this comment

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

please change the picture so that the Goerli network is check-marked instead of the ethereum mainnet.

Copy link
Contributor

@staheri14 staheri14 Jul 5, 2022

Choose a reason for hiding this comment

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

Please add a period . to the end of all the lines (including here) for consistency.

Copy link
Contributor

@kaiserd kaiserd left a comment

Choose a reason for hiding this comment

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

LGTM. I followed the tutorial 👍 and it worked.

Imo, it would be nice to have short section at beginning listing the main steps:

  • setup metamask
  • setup infura node

This allows operators/users to know right from the start what to expect.

Also, it would be helpful to provide a link to a tutorial explaining how setup the interaction between Waku node and infura.

Further, it might be helpful to provide a short intro to what the purpose of the infura node is,
and why operators should setup an infura account.
Maybe mention something like: Infura provides a simple straight-forward way of setting up endpoints for interaction with the Ethereum chain and the Waku RLN smart contract without having to run a dedicated Ethereum node. Setting up infura is not mandatory. Operators concerned with the centralized aspect introduced by infura can setup their own node.

docs/tutorial/Pre-requisites of running a Waku node.md Outdated Show resolved Hide resolved
@kgrgpg
Copy link
Contributor Author

kgrgpg commented Jul 5, 2022

Bump. New recommendations incorporated.


![](https://i.imgur.com/PfGmq4i.jpg)

ß4. Select Gorli network in Endpoints.
Copy link
Contributor

Choose a reason for hiding this comment

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

The picture is not rendered properly.

Suggested change
ß4. Select Gorli network in Endpoints.
4. Select Gorli network in Endpoints.


3. After creating the project, you will be presented with a dashboard like follows. Note that your Project Id and secret will be different.

![](https://i.imgur.com/PfGmq4i.jpg)
Copy link
Contributor

Choose a reason for hiding this comment

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

Your main-net node addresses is still visible in this pic :)

@staheri14
Copy link
Contributor

I checked your PR, and it looks good, I added a few more editorial comments, once you addressed those, feel free to squash and merge your PR.

@staheri14
Copy link
Contributor

Also, it would be helpful to provide a link to a tutorial explaining how setup the interaction between Waku node and infura.

@kaiserd thanks for your comment! this part will be covered in the extended version of the current tutorial for which I am going to create a PR.

@staheri14
Copy link
Contributor

Further, it might be helpful to provide a short intro to what the purpose of the infura node is,
and why operators should setup an infura account.
Maybe mention something like: Infura provides a simple straight-forward way of setting up endpoints for interaction with the Ethereum chain and the Waku RLN smart contract without having to run a dedicated Ethereum node. Setting up infura is not mandatory. Operators concerned with the centralized aspect introduced by infura can setup their own node.

@kaiserd Thanks for this suggestion as well, noted for the follow-up PR.

@oskarth oskarth removed the request for review from s1fr0 July 6, 2022 07:15
Copy link
Contributor

@oskarth oskarth left a comment

Choose a reason for hiding this comment

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

LGTM

One idea would be to in-line the images instead of relying on external provider (imgur). These are likely to disappear at some point.

@kgrgpg kgrgpg merged commit 2ca27ea into master Jul 7, 2022
@kgrgpg kgrgpg deleted the RLN-contract-integration-prerequisites branch July 7, 2022 19:22
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.

5 participants