matter-labs / matter-labs/zksync-docs
Update warning of using private keys in `.env` file
Nobody has claimed this yet.
- Dominant language
- Vue
- Stars
- 14
- Forks
- 93
- Avg merge
- 1d 8h
- Merged PRs (30d)
- 3
Description
**Problem**
Currently, the information section for use of Private Keys in an `.env` file for local development states:
> The private key of your wallet will be included in the `.env` file of the project and won't be pushed to GitHub.
We teach to always avoid [private keys in .env files](https://www.youtube.com/watch?v=VQe7cIpaE54) 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](https://github.com/smartcontractkit/full-blockchain-solidity-course-js/discussions/5) and [pledge 2](https://github.com/Cyfrin/foundry-full-course-f23/discussions/5#discussioncomment-8839188)
**Proposed Update**
> The private key of your wallet will be included in the `.env` file of the project and won't be pushed to GitHub. However, as this means the private key is in plain text, it's recommended to use a private key that isn't associated with any real funds.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Search the documentation for the warning about using private keys in an `.env` file and review its surrounding local-development guidance. Replace the current warning with the proposed wording, then verify that it clearly recommends using a key with no real funds; no source file or test is named in the issue.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github
- Domain
- documentation, security
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100