generated from MetaMask/metamask-module-template
-
-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: document supported Solana methods (#191)
<!-- Thanks for your contribution! Take a moment to answer these questions so that reviewers have the information they need to properly understand your changes: * What is the current state of things and why does it need to change? * What is the solution your changes offer and how does it work? Are there any issues or other links reviewers should consult to understand this pull request better? For instance: * Fixes #12345 * See: #67890 --> Adds Solana methods definition ## Examples <!-- Are there any examples of this change being used in another repository? When considering changes to the MetaMask module template, it's strongly preferred that the change be experimented with in another repository first. This gives reviewers a better sense of how the change works, making it less likely the change will need to be reverted or adjusted later. --> --------- Co-authored-by: Daniel Rocha <[email protected]>
- Loading branch information
Showing
2 changed files
with
307 additions
and
1 deletion.
There are no files selected for viewing
This file contains 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,298 @@ | ||
| # SOL Methods | ||
|
|
||
| Here we document the Solana methods that an account Snap may implement to | ||
| support requests originated from dapps. | ||
|
|
||
| ## [signAndSendTransaction](https://github.com/anza-xyz/wallet-standard/blob/master/packages/core/features/src/signAndSendTransaction.ts#L10) | ||
|
|
||
| Signs and sends a transaction to the Solana blockchain. | ||
|
|
||
| ### [Parameters](https://github.com/anza-xyz/wallet-standard/blob/master/packages/core/features/src/signAndSendTransaction.ts#L42) | ||
|
|
||
| - **Transaction intent (required)** | ||
| - Type: `object` | ||
| - Properties: | ||
| - `account` (required) | ||
| - Description: The account to sign the transaction. | ||
| - Type: `object` | ||
| - Properties: | ||
| - `address` (required) | ||
| - Description: The address of the account. | ||
| - Type: `string` | ||
| - `transaction` (required) | ||
| - Description: The base64 encoded transaction to sign and send. | ||
| - Type: `string` | ||
| - `scope` (required) | ||
| - Description: The scope of the transaction. | ||
| - Type: `Caip2String` | ||
| - Example: `solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp` | ||
| - `options` (optional) | ||
| - Description: Transaction options. | ||
| - Type: `object` | ||
| - Properties: | ||
| - `commitment?: 'processed' | 'confirmed' | 'finalized'`: Desired commitment level. If provided, confirm the transaction after sending. | ||
| - `skipPreflight: string`: Disable transaction verification at the RPC. | ||
| - `maxRetries?: number`: Maximum number of times for the RPC node to retry sending the transaction to the leader. | ||
|
|
||
| ### Returns | ||
|
|
||
| - **Transaction signature** | ||
| - Type: `object` | ||
| - Properties: | ||
| - `signature` | ||
| - Description: The transaction signature. | ||
| - Type: `string` | ||
|
|
||
| ### Examples | ||
|
|
||
| **Request:** | ||
|
|
||
| ```json | ||
| { | ||
| "method": "signAndSendTransaction", | ||
| "params": { | ||
| "account": { | ||
| "address": "GM4iccdbdSF1qN3Bqmdksfk7iuxYhWzC8T3XbizStAdE" | ||
| }, | ||
| "transaction": "MTIzNDU2Nzg5MDIzMzQzNDM1NDM=", | ||
| "scope": "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp", | ||
| "options": { | ||
| "commitment": "confirmed", | ||
| "skipPreflight": "true", | ||
| "maxRetries": 3 | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| **Response:** | ||
|
|
||
| ```json | ||
| { | ||
| "signature": "53de51e2fa75c3cfa51132865f7d430138b1cd92a8f5267ec836ec565b422969" | ||
| } | ||
| ``` | ||
|
|
||
| ## [signTransaction](https://github.com/anza-xyz/wallet-standard/blob/master/packages/core/features/src/signTransaction.ts#L4) | ||
|
|
||
| Signs a transaction to the Solana blockchain. | ||
|
|
||
| ### [Parameters](https://github.com/anza-xyz/wallet-standard/blob/master/packages/core/features/src/signTransaction.ts#L39) | ||
|
|
||
| - **Transaction intent (required)** | ||
| - Type: `object` | ||
| - Properties: | ||
| - `account` (required) | ||
| - Description: The account to sign the transaction. | ||
| - Type: `object` | ||
| - Properties: | ||
| - `address` (required) | ||
| - Description: The address of the account. | ||
| - Type: `string` | ||
| - `transaction` (required) | ||
| - Description: The base64 encoded transaction to sign. | ||
| - Type: `string` | ||
| - `scope` (required) | ||
| - Description: The scope of the transaction. | ||
| - Type: `Caip2String` | ||
| - Example: `solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp` | ||
| - `options` (optional) | ||
| - Description: Transaction options. | ||
| - Type: `object` | ||
| - Properties: | ||
| - `preflightCommitment?: 'processed' | 'confirmed' | 'finalized'`: Preflight commitment level. | ||
| - `minContextSlot: number`: The minimum slot that the request can be evaluated at. | ||
|
|
||
| ### Returns | ||
|
|
||
| - **Transaction signature** | ||
| - Type: `object` | ||
| - Properties: | ||
| - `signedTransaction` | ||
| - Description: The base64 encoded signed transaction. | ||
| - Type: `string` | ||
|
|
||
| ### Examples | ||
|
|
||
| **Request:** | ||
|
|
||
| ```json | ||
| { | ||
| "method": "signTransaction", | ||
| "params": { | ||
| "account": { | ||
| "address": "GM4iccdbdSF1qN3Bqmdksfk7iuxYhWzC8T3XbizStAdE" | ||
| }, | ||
| "transaction": "MTIzNDU2Nzg5MDIzMzQzNDM1NDM=", | ||
| "scope": "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp", | ||
| "options": { | ||
| "preflightCommitment": "confirmed", | ||
| "minContextSlot": 100 | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| **Response:** | ||
|
|
||
| ```json | ||
| { | ||
| "signedTransaction": "MTIzNDU2Nzg5MDIzMzQzNDM1NDM2NDU2NTM0" | ||
| } | ||
| ``` | ||
|
|
||
| ## [signMessage](https://github.com/anza-xyz/wallet-standard/blob/master/packages/core/features/src/signMessage.ts#L4) | ||
|
|
||
| Signs a message to the Solana blockchain. | ||
|
|
||
| ### [Parameters](https://github.com/anza-xyz/wallet-standard/blob/master/packages/core/features/src/signMessage.ts#L27) | ||
|
|
||
| - **Message intent (required)** | ||
| - Type: `object` | ||
| - Properties: | ||
| - `account` (required) | ||
| - Description: The account to sign the message. | ||
| - Type: `object` | ||
| - Properties: | ||
| - `address` (required) | ||
| - Description: The address of the account. | ||
| - Type: `string` | ||
| - `message` (required) | ||
| - Description: The base64 encoded message to sign. | ||
| - Type: `string` | ||
|
|
||
| ### Returns | ||
|
|
||
| - **Message signature** | ||
| - Type: `object` | ||
| - Properties: | ||
| - `signature` (required) | ||
| - Description: The base64 encoded message signature. | ||
| - Type: `string` | ||
| - `signedMessage` (required) | ||
| - Description: The base64 encoded signed message. | ||
| - Type: `string` | ||
| - `signatureType` (optional) | ||
| - Description: The type of signature. | ||
| - Type: `string` | ||
|
|
||
| ### Examples | ||
|
|
||
| **Request:** | ||
|
|
||
| ```json | ||
| { | ||
| "method": "signMessage", | ||
| "params": { | ||
| "account": { | ||
| "address": "GM4iccdbdSF1qN3Bqmdksfk7iuxYhWzC8T3XbizStAdE" | ||
| }, | ||
| "message": "1234567890" | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| **Response:** | ||
|
|
||
| ```json | ||
| { | ||
| "signature": "1234567890", | ||
| "signedMessage": "MTIzNDU2Nzg5MA==", | ||
| "signatureType": "ed25519" | ||
| } | ||
| ``` | ||
|
|
||
| ## [signIn](https://github.com/anza-xyz/wallet-standard/blob/master/packages/core/features/src/signIn.ts#L4) | ||
|
|
||
| Signs in to the Solana blockchain. | ||
|
|
||
| ### [Parameters](https://github.com/anza-xyz/wallet-standard/blob/master/packages/core/features/src/signIn.ts#L27) | ||
|
|
||
| - **Sign in intent (required)** | ||
| - Type: `object` | ||
| - Properties: | ||
| - `domain` (optional) | ||
| - Description: Optional EIP-4361 Domain. If not provided, the wallet must determine the Domain to include in the message. | ||
| - Type: `string` | ||
| - `address` (optional) | ||
| - Description: Optional EIP-4361 Address. If not provided, the wallet must determine the Address to include in the message. | ||
| - `statement` (optional) | ||
| - Description: Optional EIP-4361 Statement. If not provided, the wallet must not include Statement in the message. | ||
| - Type: `string` | ||
| - `uri` (optional) | ||
| - Description: Optional EIP-4361 URI. If not provided, the wallet must not include URI in the message. | ||
| - Type: `string` | ||
| - `version` (optional) | ||
| - Description: Optional EIP-4361 Version. If not provided, the wallet must not include Version in the message. | ||
| - Type: `string` | ||
| - `chainId` (optional) | ||
| - Description: Optional EIP-4361 Chain ID. If not provided, the wallet must not include Chain ID in the message. | ||
| - Type: `string` | ||
| - `nonce` (optional) | ||
| - Description: Optional EIP-4361 Nonce. If not provided, the wallet must not include Nonce in the message. | ||
| - Type: `string` | ||
| - `issuedAt` (optional) | ||
| - Description: Optional EIP-4361 Issued At. If not provided, the wallet must not include Issued At in the message. | ||
| - Type: `string` | ||
| - `expirationTime` (optional) | ||
| - Description: Optional EIP-4361 Expiration Time. If not provided, the wallet must not include Expiration Time in the message. | ||
| - Type: `string` | ||
| - `notBefore` (optional) | ||
| - Description: Optional EIP-4361 Not Before. If not provided, the wallet must not include Not Before in the message. | ||
| - Type: `string` | ||
| - `requestId` (optional) | ||
| - Description: Optional EIP-4361 Nonce. If not provided, the wallet must not include Request ID in the message. | ||
| - Type: `string` | ||
| - `resources` (optional) | ||
| - Description: Optional EIP-4361 Resources. If not provided, the wallet must not include Resources in the message. | ||
| - Type: `array` | ||
| - Items: | ||
| - Type: `string` | ||
|
|
||
| ### Returns | ||
|
|
||
| - **Message signature** | ||
| - Type: `object` | ||
| - Properties: | ||
| - `account` (required) | ||
| - Description: The account that signed the message. | ||
| - Type: `object` | ||
| - Properties: | ||
| - `address` (required) | ||
| - Description: The address of the account. | ||
| - Type: `string` | ||
| - `signedMessage` (required) | ||
| - Description: Message bytes that were signed. The wallet may prefix or otherwise modify the message before signing it. | ||
| - Type: `string` | ||
| - `signature` (required) | ||
| - Description: The base64 encoded message signature. If the signature type is provided, the signature must be Ed25519. | ||
| - Type: `string` | ||
| - `signatureType` (optional) | ||
| - Description: The type of signature. If not provided, the signature must be Ed25519. | ||
| - Type: `ed25519` | ||
|
|
||
| ### Examples | ||
|
|
||
| **Request:** | ||
|
|
||
| ```json | ||
| { | ||
| "method": "signIn", | ||
| "params": { | ||
| "domain": "example.com" | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| **Response:** | ||
|
|
||
| ```json | ||
| { | ||
| "account": { | ||
| "address": "GM4iccdbdSF1qN3Bqmdksfk7iuxYhWzC8T3XbizStAdE" | ||
| }, | ||
| "signedMessage": "MTIzNDU2Nzg5MA==", | ||
| "signature": "1234567890", | ||
| "signatureType": "ed25519" | ||
| } | ||
| ``` |
This file contains 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