Launch a Token guide uses raw PRIVATE_KEY env variable, contradicting Deploy Smart Contracts guide's safer keystore approach
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- Half a day
- Newbie friendliness
- 55/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Quiet
- Domain
- documentation
Research direction
Open the Launch a Token and Deploy Smart Contracts guides and compare their private-key instructions, especially the vm.envUint("PRIVATE_KEY") and cast wallet import examples. Decide on a consistent safe explanation, then update the affected guide(s) so the local-versus-CI guidance, warning, and link to the safer approach are clear.
Written by the indexing model from the issue text.
Description
Description
The "Launch a Token" guide uses vm.envUint("PRIVATE_KEY") to load a
private key directly from a .env file in the deployment script.
However, the "Deploy Smart Contracts" guide on the same site explicitly
teaches cast wallet import deployer --interactive as the secure approach,
with a warning: "Never share or commit your private key."
These two pages give contradictory advice on a security-critical topic
with no explanation of the difference.
Pages affected
- https://docs.base.org/get-started/launch-token (uses raw env var)
- https://docs.base.org/get-started/deploy-smart-contracts (uses keystore)
Suggested fix
Either align both guides to use the keystore method, or add a note on the
Launch a Token page explaining when a raw PRIVATE_KEY env var is acceptable
(e.g. only in CI/CD pipelines, never locally) and link to the safer approach.
- Dominant language
- JavaScript
- Stars
- 337
- Forks
- 798
- Avg merge
- 13h 7m
- Merged PRs (30d)
- 57
Contributor guide
No contributing guide indexed for this repository
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.
More from base/docs
-
Difficulty 1/5 Under an hour Newbie friendliness 92/100
-
Difficulty 1/5 Under an hour Newbie friendliness 92/100
-
Difficulty 1/5 Under an hour Newbie friendliness 95/100
-
Difficulty 1/5 Under an hour Newbie friendliness 95/100
-
Difficulty 1/5 Under an hour Newbie friendliness 95/100
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
area-deployment area-integrations triage:bot-seen
Difficulty 2/5 Half a day Newbie friendliness 86/100
-
Issue-Bug
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
sugarlabs/musicblocks#8924 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
ArduPilot/ardupilot_wiki#8088 ·
-
[BUG] createTool tools cannot be registered with Mastra when exactOptionalPropertyTypes is enabled Opencustomer-eng status: needs triage
Difficulty 2/5 1-3 hours Newbie friendliness 84/100