signMessage() - Turnkey

Overview

Signs a message using the specified wallet account.

Supports both embedded and connected wallets.
For connected wallets:
Delegates signing to the wallet provider’s native signing method.
Important: For Ethereum wallets (e.g., MetaMask), signatures follow EIP-191.

The message is automatically prefixed with "\x19Ethereum Signed Message:\n" + message length before signing. As a result, this signature cannot be used as a raw transaction signature or broadcast on-chain.

For embedded wallets, uses the Turnkey API to sign the message directly.
Automatically handles message encoding and hashing based on the wallet account’s address format,

unless explicitly overridden.

Package: core

Defined in: core.ts:2118

Parameters

params

object

required

Show params details

params.addEthereumPrefix

boolean

whether to prefix the message with Ethereum’s "\x19Ethereum Signed Message:\n" string.

If true (default for Ethereum), the message is prefixed before signing.
If false:
- Connected wallets will throw an error because they always prefix automatically.
- Embedded wallets will sign the raw message without any prefix.

params.encoding

v1PayloadEncoding

override for the payload encoding (defaults to the encoding appropriate for the address type).

params.hashFunction

v1HashFunction

override for the hash function (defaults to the hash function appropriate for the address type).

params.message

string

required

message to sign.

params.stampWith

StamperType

stamper to tag the signing request (e.g., Passkey, ApiKey, or Wallet).

params.walletAccount

WalletAccount

required

wallet account to use for signing.

Response

A successful response returns the following fields:

returns

v1SignRawPayloadResult

required

A promise resolving to a v1SignRawPayloadResult containing the signature and metadata.

signAndSendTransaction()signTransaction()

SDK reference

Overview

Parameters

Response