docs(services): update Infura introduction with MetaMask context and architecture overview#2935
Open
rohan911438 wants to merge 1 commit into
Open
docs(services): update Infura introduction with MetaMask context and architecture overview#2935rohan911438 wants to merge 1 commit into
rohan911438 wants to merge 1 commit into
Conversation
|
@rohan911438 is attempting to deploy a commit to the Consensys Team on Vercel. A member of the Team first needs to authorize it. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
Fixes #1387
This PR updates the Services introduction to better explain the relationship between MetaMask and Infura, providing additional context for developers using Infura as an RPC provider.
Changes
Reworked the introductory content to be more MetaMask-focused.
Added clarification on the distinct responsibilities of MetaMask and Infura.
Explained the transaction lifecycle, including:
Added guidance on accessing blockchain data through Infura.
Added context around network switching and endpoint selection.
Added a simplified architecture diagram illustrating:
Why
The previous introduction primarily described Infura services but did not clearly explain how those services fit into a typical MetaMask developer workflow.
These updates provide a clearer mental model for developers by explaining:
Files Updated
services/index.mddeveloper-tools/dashboard/index.mdx(if applicable)Testing
Note
Low Risk
Documentation-only edits with no runtime, auth, or data-path changes.
Overview
Services introduction is reframed around MetaMask + Infura: wallet signing and key custody vs hosted JSON-RPC/REST for reads and broadcasting, plus what these docs cover (local signing, provider broadcast, endpoint choice).
A new How it works section adds a Mermaid flow (user → MetaMask → local sign → Infura → chain), narrative on
eth_sendRawTransactionand read methods, an important admonition on signing vs broadcasting and never sharing keys, and network switching guidance (chainIdand matching Infura endpoints).Infura dashboard intro gains one sentence clarifying that API keys are created in Infura and that MetaMask documents usage but does not manage Infura accounts or keys.
Reviewed by Cursor Bugbot for commit 71e3aee. Bugbot is set up for automated code reviews on this repo. Configure here.