docs: improve Infura setup instructions in README and .js.env.example #21651
+30
−16
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…dated instructions
|
CLA Signature Action: All authors have signed the CLA. You may need to manually re-run the blocking PR check if it doesn't pass in a few minutes. |
metamaskbot
added
the
team-design-system
georgewrmarshall
added
No QA Needed
Comment on lines
-1
to
-12
| # Sign up and generate your own keys at pubnub.com | ||
| # Then rename this file to ".js.env" and rebuild the app | ||
| # | ||
| # In order for this feature to work properly, you need to | ||
| # build metamask-extension from source (https://github.com/MetaMask/metamask-extension) | ||
| # and set your the same values there. | ||
| # | ||
| # For more info take a look at https://github.com/MetaMask/metamask-extension/pull/5955 | ||
|
|
||
| export MM_PUBNUB_SUB_KEY="" | ||
| export MM_PUBNUB_PUB_KEY="" | ||
| export MM_FOX_CODE="EXAMPLE_FOX_CODE" |
There was a problem hiding this comment.
Removing out dated pubnub.com references and moving MM_FOX_CODE to a new section
env vars not used in the codebase
| [!CAUTION] | ||
|
|
||
| > Without an Infura project ID, the app cannot connect to blockchain networks. | ||
There was a problem hiding this comment.
Adding section about Infura setup
georgewrmarshall
force-pushed
the
update-js-env
branch
from
f957d79 to
d1d09fd
Compare
.js.env.example
Outdated
Comment on lines
7
to
14
| # MetaMask Swaps Origin Code | ||
| # This identifier is used to distinguish MetaMask's internal swap transactions | ||
| # from external dApp transactions. Used for: | ||
| # - Transaction origin tracking in swaps | ||
| # - Internal permissions system | ||
| # - Smart transaction logic | ||
| # - Security: differentiates trusted internal vs external transactions | ||
| export MM_FOX_CODE="EXAMPLE_FOX_CODE" |
There was a problem hiding this comment.
@MetaMask/swaps-engineers can you review this does it make sense?
|
metamaskbot
added
the
release-7.59.0
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Improved the Infura project setup instructions to make it clearer for external contributors how to obtain and configure an Infura API key. The previous instructions referenced an outdated GitHub issue from 2018 and were buried deep in the Firebase setup section.
Changes made:
.js.env.examplewith concise, step-by-step Infura setup instructionsChangelog
CHANGELOG entry: null
Related issues
Fixes: N/A (proactive documentation improvement)
Manual testing steps
Screenshots/Recordings
Before
After
Pre-merge author checklist
Pre-merge reviewer checklist
Note
Adds a dedicated Infura setup section to README and updates .js.env.example with Infura guidance, removing outdated notes.
.js.env.example: Replaces outdated guidance with concise Infura setup instructions; setsMM_INFURA_PROJECT_ID="null"; documentsMM_FOX_CODEpurpose; retains existing env variables.Written by Cursor Bugbot for commit 6dad9a6. This will update automatically on new commits. Configure here.