handleSignMessage()

Package: react-wallet-kit

Defined in: react-wallet-kit/src/providers/client/Types.tsx:678

Handles the signing of a message by displaying a modal for user interaction.

This function opens a modal with the SignMessageModal component, prompting the user to review and approve the message signing request.
Supports signing with any wallet account managed by Turnkey, including externally connected wallets.
Allows for optional overrides of the encoding and hash function used for the payload, enabling advanced use cases or compatibility with specific blockchains.
Optionally displays a subtext in the modal for additional context or instructions to the user.
Returns a promise that resolves to a v1SignRawPayloadResult object containing the signed message, signature, and metadata.

params

object

required

Show params details

params.addEthereumPrefix

boolean

whether to add the Ethereum prefix to the message (default: false).

params.encoding

v1PayloadEncoding

encoding for the payload (defaults to the proper encoding for the account type).

params.hashFunction

v1HashFunction

hash function to use (defaults to the appropriate function for the account type).

params.message

string

required

The message to sign.

params.stampWith

StamperType

parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet).

params.subText

string

subtext to display in the modal.

params.successPageDuration

number

duration in seconds to display the success page after signing.

params.walletAccount

WalletAccount

required

The wallet account to use for signing.

A successful response returns the following fields:

returns

v1SignRawPayloadResult

required

A promise that resolves to a v1SignRawPayloadResult object containing the signed message.