[WIP] MWA Specification - WebSocket Data Encoding Disambiguation #1094
Conversation
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
Funkatronics
commented
Feb 4, 2025
spec/spec.md
Outdated
| 1. The `com.solana.mobilewalletadapter.v1.base64` subprotocol indicates that the server supports UTF-8 text WebSocket data frames. When This protocol is in use, endpoints can send and receive paylaods as Base64 encoded text using a UTF-8 text data frame. | ||
| 1. The `com.solana.mobilewalletadapter.v1.reflector` subprotocol is used by WebSocket reflectors when connecting to a [Remote URI](#remote-uri). | ||
|
|
||
| When connecting to a [Local URI](#local-uri), the dapp endpoint must request both the `com.solana.mobilewalletadapter.v1` and `com.solana.mobilewalletadapter.v1.base64` WebSocket subprotocols. The wallet endpoint must respond with one or both of the `com.solana.mobilewalletadapter.v1` and `com.solana.mobilewalletadapter.v1.base64` WebSocket subprotocols to indicate to the dapp endpoint whether it supports either the binary or base64 encoded data frames, or both. When connecting to a [Remote URI](#remote-uri), the both the dapp and wallet endpoints must request, and the reflector server must respond with, the `com.solana.mobilewalletadapter.v1.reflector` WebSocket subprotocol in addition to one or both of the `com.solana.mobilewalletadapter.v1` and `com.solana.mobilewalletadapter.v1.base64` subprotocols. |
There was a problem hiding this comment.
@sdlaver I have initially wrote this to allow servers to support both binary and text frames simultaneously, if they choose. Do you think we should make this so that servers should define just one of these, not both?
There was a problem hiding this comment.
I can't think of a good reason to support intermixing binary and text frames, no. At best, it's functionality-neutral with picking one or the other, and at worst, it adds complexity and an opportunity for implementation bugs. I'd lean on the protocol negotiation capabilities of websockets, and have the server select one or the other, but not both.
sdlaver
approved these changes
Feb 4, 2025
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.
This spec change fixes an existing bug in the Mobile Wallet Adapter WebSocket transport specification.
The WebSocket protocol defines support for both binary data frames and text data frames. Binary data frames allow endpoints to exchange raw binary payloads while text data frames contain UTF-8 encoded data. Currently the MWA spec does not specify which data frames are supported or how payloads should be encoded for either data frame.
Currently, our MWA implementations use raw, unencoded binary data frames to exchange the encrypted payloads. Since not all binary payloads are valid UTF-8, the use of text data frames is not valid behavior. This update to the specification disambiguates this behavior for the existing
com.solana.mobilewalletadapter.v1WebSocket subprotocol and defines a newcom.solana.mobilewalletadapter.v1.base64subprotocol to allow payloads to be sent as UFT-8 encoded text frames with a shared understanding of how those payloads will be encoded/decoded by the endpoints.