Skip to content
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.

Sign up for GitHub

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

Update restricted text #202

Merged
merged 4 commits into from
Mar 22, 2024
Merged

Update restricted text #202

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
cd2d610
update restricted text
joaniefromtheblock Mar 20, 2024
4e2b5f3
update restricted text
joaniefromtheblock Mar 20, 2024
688e735
Apply suggestions
joaniefromtheblock Mar 21, 2024
d4cd403
Apply suggestions from code review
joaniefromtheblock Mar 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 15 additions & 9 deletions openrpc.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ info:
MetaMask, and may or may not be supported by other wallets.

- **Restricted** - These methods are restricted and require requesting
permission using
[`wallet_requestPermissions`](/wallet/reference/wallet_requestpermissions)
permission using either [`wallet_requestPermissions`](/wallet/reference/wallet_requestpermissions)
or [`wallet_requestSnaps`](/wallet/reference/wallet_requestSnaps)
joaniefromtheblock marked this conversation as resolved.
Show resolved Hide resolved

- **Mobile** - These methods are only available on MetaMask Mobile.

Expand Down Expand Up @@ -252,9 +252,10 @@ methods:
Presents a plain text signature challenge to the user and returns the
signed response. Equivalent to `eth_sign` on some other wallets, and
prepends a safe prefix to the signed message to prevent the challenge
tricking users into signing a financial transaction. This method requires
that the user has granted permission to interact with their account first,
so make sure to call `eth_requestAccounts` first.
tricking users into signing a financial transaction.
This method requires that the user has granted permission to interact
with their account first, make sure to call `eth_requestAccounts` (recommended)
joaniefromtheblock marked this conversation as resolved.
Show resolved Hide resolved
or `wallet_requestPermissions` first.
deprecated: false
params:
- name: Challenge
Expand Down Expand Up @@ -285,7 +286,9 @@ methods:
description: >-
Presents a data message for the user to sign in a structured and readable
format and returns the signed response. Introduced by
[EIP-712](https://eips.ethereum.org/EIPS/eip-712).
[EIP-712](https://eips.ethereum.org/EIPS/eip-712).
This method requires that the user has granted permission to interact with their account first,
make sure to call `eth_requestAccounts` (recommended) or `wallet_requestPermissions` first.
joaniefromtheblock marked this conversation as resolved.
Show resolved Hide resolved
params:
- name: Address
required: true
Expand Down Expand Up @@ -719,7 +722,10 @@ methods:
tags:
- $ref: '#/components/tags/MetaMask'
- $ref: '#/components/tags/Restricted'
description: Returns a list of addresses for the accounts owned by the user.
description: >-
Returns a list of addresses for the accounts owned by the user.
This method requires calling `wallet_requestPermissions` for permission.
We recommend using `eth_requestAccounts`, which internally calls `wallet_requestPermission`.
summary: Gets a list of addresses for the user's accounts.
params: []
result:
Expand All @@ -735,8 +741,8 @@ methods:
description: >-
Creates a new wallet confirmation to make an Ethereum transaction from the
user's account. This method requires that the user has granted permission
to interact with their account first, so make sure to call
`eth_requestAccounts` or `wallet_requestPermissions` first.
to interact with their account first, make sure to call `eth_requestAccounts` (recommended)
joaniefromtheblock marked this conversation as resolved.
Show resolved Hide resolved
or `wallet_requestPermissions` first.
summary: Initiates a new transaction.
params:
- name: Transaction
Expand Down
Loading