signMessage()

Overview

Signs a message using the specified wallet account.

Behavior differs depending on the wallet type:

• Connected wallets
• Delegates signing to the wallet provider’s native signing method.
• Ethereum: signatures always follow EIP-191.
• The wallet automatically prefixes messages with

"\x19Ethereum Signed Message:\n" + message length before signing.

• As a result, these signatures cannot be used as raw transaction signatures or broadcast on-chain.
• If addEthereumPrefix is set to false, an error is thrown because connected Ethereum wallets always prefix.
• Other chains: follows the native connected wallet behavior.

• Embedded wallets
• Uses the Turnkey API to sign the message directly.
• Supports optional addEthereumPrefix:
• If true (default for Ethereum), the message is prefixed before signing.
• If false, the raw message is signed without any prefix.

Additional details:

• Automatically handles encoding and hashing based on the wallet account’s address format,

unless explicitly overridden.

• Optionally allows stamping with a specific stamper

(StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet).

Package: core

Defined in: clients/core.ts:2214

Parameters

params · SignMessageParams · required

Show params details

params.addEthereumPrefix

boolean

whether to prefix the message with Ethereum’s "\x19Ethereum Signed Message:\n" string (default: true for Ethereum).

params.encoding

v1PayloadEncoding

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

params.hashFunction

v1HashFunction

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

params.message

string

required

plaintext (UTF-8) message to sign.

params.organizationId

string

organization ID to target (defaults to the session’s organization ID).

params.stampWith

StamperType

optional stamper for the signing request.

params.walletAccount

WalletAccount

required

wallet account to use for signing.

Response

A successful response returns the following fields:

returns · v1SignRawPayloadResult · required

A promise that resolves to a v1SignRawPayloadResult containing the signature and metadata.