Skip to content
This repository has been archived by the owner on Oct 3, 2024. It is now read-only.

updated getting-started with mitigated pitfalls #984

Merged
merged 5 commits into from
Mar 29, 2024

Conversation

PatrickAlphaC
Copy link
Contributor

@PatrickAlphaC PatrickAlphaC commented Mar 22, 2024

What πŸ’»

  1. Updated the recommended faucet -> Chainstack
  2. Added a comment about private key use in a .env file
  3. Removed broken atlas link

Why βœ‹

  1. The learnweb3 faucet asks for very invasive GitHub authentication. See attached image below. I have informed the learnweb3 team to fix this.
  2. We teach to always avoid private keys in .env files as it's one of the most common ways new web3 developers (experienced or not) lose funds. We even have students pledge to never put private keys with funds in them, and it's an anti-pattern that has been propagated across web3 hurting new people. pledge one and pledge 2
  3. It's not a good idea to have students go to a potentially unmaintained example, see it not work, and then go "ah, f this. This chain just doesn't work." and move to another L2, or worse, out of web3 because of it. I left a comment about how this could be pretty easily fixed with a github actions that points to your templates folder. If you give me access to one I can make it for you and have atlas always paired with an up-to-date example.

Images

Screenshot 2024-03-21 at 9 34 11β€―PM vidence πŸ“·

Notes πŸ“

@PatrickAlphaC PatrickAlphaC requested review from a team as code owners March 22, 2024 02:33
@MexicanAce
Copy link
Collaborator

For awareness, I've tried to validate the new repo would work with Atlas, but I'm getting Unable to Create Project: unhashable type: 'slice' error:

I can follow-up with Atlas to troubleshoot and resolve

Copy link
Collaborator

@MexicanAce MexicanAce left a comment

Choose a reason for hiding this comment

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

LGTM, created open issue to close conversation and will follow-up in separate PR when received a fix from Atlas for new repo

@MexicanAce MexicanAce merged commit 830fd6c into matter-labs:main Mar 29, 2024
6 checks passed
Copy link

πŸŽ‰ This PR is included in version 1.42.1 πŸŽ‰

The release is available on GitHub release

Your semantic-release bot πŸ“¦πŸš€

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants