SignMessage

Once it's connected to Broearn Wallet, an app can request that the user signs a given message. Applications are free to write their own messages which will be displayed to users from within Broearn Wallet's signature prompt. Message signatures do not involve network fees and are a convenient way for apps to verify ownership of an address.

In order to send a message for the user to sign, an application must:

1. Provide a hex or UTF-8 encoded string as a Uint8Array and then base58-encoded it.

2. Request that the encoded message is signed via the user's Broearn wallet.

Query String Parameters

// Some code
window.bw.put.signMessage({
    "message": "...", // the message, base58 encoded
    "session": "...", // token received from connect-method
    "display": "utf8" | "hex", // the encoding to use when displaying the message
})

• message (required): The message that should be signed by the user, encoded in base58. Broearn wallet will display this message to the user when they are prompted to sign.

• session (required): The session token received from the Connect method.

• display (optional): How you want us to display the string to the user. Defaults to utf8

Returns

✅ Approve

• data: An encrypted JSON object.

  // content of decrypted `data`-parameter
  {
      signature: "...", // message-signature
  }

  • signature: The message signature, encoded in base58.

❌Reject

An errorCode and errorMessage as query parameters. Please refer to Errors for a full list of possible error codes.

{
  "errorCode": "...",
  "errorMessage": "..."
}