useSignMessage

function useSignMessage<TWalletAccount>(
    ...config
): (input) => Promise<Output>;

Use this to get a function capable of signing a message with the private key of a UiWalletAccount

Type Parameters

Type Parameter
TWalletAccount extends UiWalletAccount

Parameters

ParameterType
...config[TWalletAccount]

Returns

(input) => Promise<Output>

Example

import { useSignMessage } from '@solana/react';
 
function SignMessageButton({ account, messageBytes }) {
    const signMessage = useSignMessage(account);
    return (
        <button
            onClick={async () => {
                try {
                    const { signature } = await signMessage({
                        message: messageBytes,
                    });
                    window.alert(`Signature bytes: ${signature.toString()}`);
                } catch (e) {
                    console.error('Failed to sign message', e);
                }
            }}
        >
            Sign Message
        </button>
    );
}

On this page