-
Notifications
You must be signed in to change notification settings - Fork 20
Add wallet_openDeepLink rpc method
#51
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
hmalik88
wants to merge
3
commits into
main
Choose a base branch
from
hm/open-deep-link
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| --- | ||
| mip: 4 | ||
| title: Implement `wallet_openDeepLink` for deep linking within MetaMask | ||
| status: Draft | ||
| stability: Experimental | ||
| discussions-to: https://github.com/MetaMask/metamask-improvement-proposals/discussions/52 | ||
| author(s): Hassan Malik (@hmalik88) | ||
| type: Community | ||
| created: 2024-09-18 | ||
| --- | ||
|
|
||
| ## Summary | ||
| This proposal aims to add a new JSON-RPC method, `wallet_openDeepLink`, to MetaMask. This method is designed to offer programmatic navigation within MetaMask to the API consumer, in particular, to dapps and Snaps. | ||
|
|
||
| ## Motivation | ||
| Currently, there isn't a way for developers to navigate to specific portions of MetaMask. With the introduction of [MetaMask schemed URLs](https://github.com/MetaMask/SIPs/pull/134) and the ability to navigate to them through Snaps link components, we wanted to utilize the full power of the new scheme through allowing a RPC method that would allow consumers to navigate to selected portions of MetaMask. | ||
|
|
||
| # Proposal | ||
| The `wallet_openDeepLink` method is proposed as a new JSON-RPC feature for MetaMask, aimed at giving users navigation ability to exposed routes within the client or a Snap. For a list of the routes currently exposed, please see [SIP-22](https://github.com/MetaMask/SIPs/pull/134). In the future, MetaMask URLs will also accept fragments to navigate to a specific portion of a page. This API can also be extended to accept params that can pre-populate fields on a certain page. The authority would be responsible for choosing to accept certain params. In the case of the "client" authority, MetaMask is responsible for keeping a record of the params for each exposed route. In the case of the "snap" authority, the Snap itself is responsible for params handling and communication of route parameters. | ||
|
|
||
| # Usage Example | ||
| ```js | ||
| await window.ethereum.request({ | ||
| "method": "wallet_openDeepLink", | ||
| "params": { | ||
| "link": "metamask://client/" | ||
| } | ||
| }); | ||
| ``` | ||
|
|
||
| ```js | ||
| await window.ethereum.request({ | ||
| "method": "wallet_openDeepLink", | ||
| "params": { | ||
| "link": "metamask://snap/@metamask/examplesnap/home" | ||
| } | ||
| }); | ||
| ``` | ||
|
|
||
| ## Implementation | ||
| The Snaps team will be responsible for implementing the `wallet_openDeepLink` method and for future improvements to it. | ||
|
|
||
| ## Feedback | ||
| Please provide feedback on this proposal by opening an issue in the MetaMask MIPs repository. | ||
|
|
||
| ## Committed Developers | ||
| Hassan Malik (@hmalik88) | ||
|
|
||
| ## Copyright | ||
| Copyright and related rights waived via [CC0](../LICENSE). | ||
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.
Uh oh!
There was an error while loading. Please reload this page.