Skip to content
This repository has been archived by the owner on Aug 16, 2024. It is now read-only.

Commit

Permalink
Make doc more precise
Browse files Browse the repository at this point in the history
  • Loading branch information
bisgardo authored and DOBEN committed Apr 23, 2024
1 parent a36abf5 commit 002dfbf
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions packages/wallet-connectors/src/WalletConnect.ts
Original file line number Diff line number Diff line change
Expand Up @@ -344,8 +344,10 @@ function serializePayloadParameters(

/**
* Convert {@link SignableMessage} into the object format expected by the Mobile Wallets.
* As of this writing, the Android wallet only supports the {@link StringMessage} variant.
* @param msg The message to be signed.
* As of this writing, the Android and iOS wallets only support the {@link StringMessage} variant.
* So if used with these application (which ignore the {@code schema} field), they will present (and sign)
* the hex string of the message rather than the actual bytes in the message.
* @param msg The binary or string message to be signed.
*/
function convertSignableMessageFormat(msg: SignableMessage) {
switch (msg.type) {
Expand Down

0 comments on commit 002dfbf

Please sign in to comment.