Skip to content

verifyMessage

Verify that a message was signed by the provided address.

Usage

example.ts
import { verifyMessage } from 'viem'
import { account, walletClient } from './client'
 
const signature = await walletClient.signMessage({
  account,
  message: 'hello world',
})
 
const valid = await verifyMessage({ 
  address: account.address,
  message: 'hello world',
  signature,
})
// true

Returns

boolean

Whether the provided address generated the signature.

Parameters

address

The Ethereum address that signed the original message.

const valid = await verifyMessage({
  address: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266', 
  message: 'hello world',
  signature:
    '0x66edc32e2ab001213321ab7d959a2207fcef5190cc9abb6da5b0d2a8a9af2d4d2b0700e2c317c4106f337fd934fbbb0bf62efc8811a78603b33a8265d3b8f8cb1c',
})

message

  • Type: string

The message to be verified.

By default, viem signs the UTF-8 representation of the message.

const valid = await verifyMessage({
  address: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
  message: 'hello world', 
  signature:
    '0x66edc32e2ab001213321ab7d959a2207fcef5190cc9abb6da5b0d2a8a9af2d4d2b0700e2c317c4106f337fd934fbbb0bf62efc8811a78603b33a8265d3b8f8cb1c',
})

To sign the data representation of the message, you can use the raw attribute.

const valid = await verifyMessage({
  address: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
  message: { raw: '0x68656c6c6f20776f726c64' }, 
  signature:
    '0x66edc32e2ab001213321ab7d959a2207fcef5190cc9abb6da5b0d2a8a9af2d4d2b0700e2c317c4106f337fd934fbbb0bf62efc8811a78603b33a8265d3b8f8cb1c',
})

signature

  • Type: Hex | ByteArray | Signature

The signature that was generated by signing the message with the address's private key.

const valid = await verifyMessage({
  address: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
  message: 'hello world',
  signature: 
    '0x66edc32e2ab001213321ab7d959a2207fcef5190cc9abb6da5b0d2a8a9af2d4d2b0700e2c317c4106f337fd934fbbb0bf62efc8811a78603b33a8265d3b8f8cb1c',
})