Sign a message

Use the signMessage method exported from the useSignMessage hook to sign a message with an Ethereum embedded wallet.

Usage

const message = 'I hereby vote for foobar';

const uiOptions = {
  title: 'You are voting for foobar project',
  description:
    "Foobar project is so great you'll love it. Come on by and give us a vote today. Whooo hooo!",
  buttonText: 'Vote for foobar'
};

const {signature} = await signMessage(
  {message},
  {
    uiOptions,
    address: wallet.address
  }
);

Parameters

Returns

Callbacks

Configure callbacks for Privy’s signMessage method on the useSignMessage hook:

import {useSignMessage} from '@privy-io/react-auth';

const {signMessage} = useSignMessage({
  onSuccess: ({signature}) => {
    console.log(signature);
    // Any logic you'd like to execute after a user successfully signs a message
  },
  onError: (error) => {
    console.log(error);
    // Any logic you'd like to execute after a user exits the message signing flow or there is an error
  }
});

// Then call `signMessage` in your code, which will invoke these callbacks on completion

As parameters to useSignMessage, you may include an onSuccess callback and/or an onError callback.

While this component is mounted, any invocation of signMessage will trigger the onSuccess callback or onError callback on completion, depending on if the message was successfully signed or not.

onSuccess

If set, the onSuccess callback will execute after a user has successfully signed the message. Within this callback, you can access a signature parameter, which is the signature string value generated by the wallet to sign the message.

onError

If set, the onError callback will execute after a user attempts to sign a message and there is an error, or if the user exits the signature flow prematurely. Within this callback, you may access an error code with more information about the error.