useSignTypedData | Alchemy Docs

Similar to useSignMessage, hook for signing typed data, supporting both connected accounts and clients in EIP 712 format.

Uses eth_signTypedData to sign structured, typed data. Accepts typed, complex data structures as input. Like useSignMessage, this hook also handles deployed (1271) and undeployed accounts (6492).

Import

1 import { useSignTypedData } from "@account-kit/react";

Usage

import { function useSignTypedData({ client, ...mutationArgs }: UseSignTypedDataArgs): UseSignTypedDataResultSimilar to useSignMessage, hook for signing typed data, supporting both connected accounts and clients in EIP 712 format.
Uses eth_signTypedData to sign structured, typed data. Accepts typed, complex data structures as input. Like useSignMessage, this hook also handles deployed (1271) and undeployed accounts (6492).
useSignTypedData, function useSmartAccountClient<TChain extends Chain | undefined = Chain | undefined, TAccount extends SupportedAccountTypes | undefined = "ModularAccountV2">(args: UseSmartAccountClientProps<TChain, TAccount>): UseSmartAccountClientResult<TChain, SupportedAccount<TAccount extends undefined ? "ModularAccountV2" : TAccount>>
useSmartAccountClient } from "@account-kit/react";
const const typedData: {
    types: {
        Message: {
            name: string;
            type: string;
        }[];
    };
    primaryType: string;
    message: {
        content: string;
    };
}
typedData = {
  types: {
    Message: {
        name: string;
        type: string;
    }[];
}
types: {
    type Message: {
    name: string;
    type: string;
}[]
Message: [{ name: string
name: "content", type: string
type: "string" }],
  },
  primaryType: string
primaryType: "Message",
  message: {
    content: string;
}
message: { content: string
content: "Hello" },
};
const { const client: {
    account: ModularAccountV2<AlchemySigner>;
    batch?: {
        multicall?: boolean | Prettify<MulticallBatchOptions> | undefined;
    } | undefined;
    ... 84 more ...;
    extend: <const client extends {
        ...;
    } & ExactPartial<...>>(fn: (client: Client<...>) => client) => Client<...>;
} | undefined
client } = useSmartAccountClient<Chain | undefined, "ModularAccountV2">(args: UseSmartAccountClientProps<Chain | undefined, "ModularAccountV2">): UseSmartAccountClientResult<Chain | undefined, ModularAccountV2<...>>
useSmartAccountClient({});
const {
  const signTypedData: UseMutateFunction<`0x${string}`, Error, SignTypedDataArgs, unknown>
signTypedData,
  const signTypedDataAsync: UseMutateAsyncFunction<`0x${string}`, Error, SignTypedDataArgs, unknown>
signTypedDataAsync,
  const signedTypedData: `0x${string}` | undefined
signedTypedData,
  const isSigningTypedData: boolean
isSigningTypedData,
  const error: Error | null
error,
} = function useSignTypedData({ client, ...mutationArgs }: UseSignTypedDataArgs): UseSignTypedDataResultSimilar to useSignMessage, hook for signing typed data, supporting both connected accounts and clients in EIP 712 format.
Uses eth_signTypedData to sign structured, typed data. Accepts typed, complex data structures as input. Like useSignMessage, this hook also handles deployed (1271) and undeployed accounts (6492).
useSignTypedData({
  client: {
    account: SupportedAccounts;
    batch?: {
        multicall?: boolean | Prettify<MulticallBatchOptions> | undefined;
    } | undefined;
    ... 84 more ...;
    extend: <const client extends {
        ...;
    } & ExactPartial<...>>(fn: (client: Client<...>) => client) => Client<...>;
} | {
    ...;
} | {
    ...;
} | {
    ...;
} | undefined
client,
  // these are optional
  onSuccess?: ((data: `0x${string}`, variables: SignTypedDataArgs, context: unknown) => Promise<unknown> | unknown) | undefined
onSuccess: (result: `0x${string}`
result) => {
    // do something on success
  },
  onError?: ((error: Error, variables: SignTypedDataArgs, context: unknown) => Promise<unknown> | unknown) | undefined
onError: (error: Error
error) => var console: ConsoleThe console module provides a simple debugging console that is similar to the JavaScript console mechanism provided by web browsers.
The module exports two specific components:

A Console class with methods such as console.log(), console.error() and console.warn() that can be used to write to any Node.js stream. * A global console instance configured to write to process.stdout and process.stderr. The global console can be used without importing the node:console module.

Warning: The global console object's methods are neither consistently synchronous like the browser APIs they resemble, nor are they consistently asynchronous like all other Node.js streams. See the note on process I/O for more information.
Example using the global console:

const name = 'Will Robinson'; console.warn(`Danger $name! Danger!`); // Prints: Danger Will Robinson! Danger!, to stderr ```

Example using the `Console` class:

```js const out = getStreamSomehow(); const err = getStreamSomehow(); const myConsole = new console.Console(out, err);

myConsole.log('hello world'); // Prints: hello world, to out myConsole.log('hello %s', 'world'); // Prints: hello world, to out myConsole.error(new Error('Whoops, something bad happened')); // Prints: [Error: Whoops, something bad happened], to err

const name = 'Will Robinson'; myConsole.warn(`Danger $name! Danger!`); // Prints: Danger Will Robinson! Danger!, to err ```
console.Console.error(message?: any, ...optionalParams: any[]): void (+1 overload)Prints to stderr with newline. Multiple arguments can be passed, with the first used as the primary message and all additional used as substitution values similar to printf(3) (the arguments are all passed to util.format()).
js const code = 5; console.error('error #%d', code); // Prints: error #5, to stderr console.error('error', code); // Prints: error 5, to stderr 
If formatting elements (e.g. %d) are not found in the first string then util.inspect() is called on each argument and the resulting string values are concatenated. See util.format() for more information.
error(error: Error
error),
});

const const result: void
result = await const signTypedData: (variables: SignTypedDataArgs, options?: MutateOptions<`0x${string}`, Error, SignTypedDataArgs, unknown> | undefined) => void
signTypedData({ typedData: MessageDefinition<{
    [x: string]: readonly TypedDataParameter[];
    [x: `string[${string}]`]: undefined;
    [x: `function[${string}]`]: undefined;
    [x: `address[${string}]`]: undefined;
    [x: `bool[${string}]`]: undefined;
    [x: `bytes[${string}]`]: undefined;
    [x: `bytes2[${string}]`]: undefined;
    [x: `bytes5[${string}]`]: undefined;
    [x: `bytes1[${string}]`]: undefined;
    [x: `bytes3[${string}]`]: undefined;
    [x: `bytes4[${string}]`]: undefined;
    [x: `bytes6[${string}]`]: undefined;
    [x: `bytes7[${string}]`]: undefined;
    [x: `bytes8[${string}]`]: undefined;
    [x: `bytes9[${string}]`]: undefined;
    [x: `bytes10[${string}]`]: undefined;
    [x: `bytes11[${string}]`]: undefined;
    [x: `bytes12[${string}]`]: undefined;
    [x: `bytes13[${string}]`]: undefined;
    [x: `bytes14[${string}]`]: undefined;
    [x: `bytes15[${string}]`]: undefined;
    [x: `bytes16[${string}]`]: undefined;
    [x: `bytes17[${string}]`]: undefined;
    [x: `bytes18[${string}]`]: undefined;
    [x: `bytes19[${string}]`]: undefined;
    [x: `bytes20[${string}]`]: undefined;
    [x: `bytes21[${string}]`]: undefined;
    [x: `bytes22[${string}]`]: undefined;
    [x: `bytes23[${string}]`]: undefined;
    [x: `bytes24[${string}]`]: undefined;
    [x: `bytes25[${string}]`]: undefined;
    [x: `bytes26[${string}]`]: undefined;
    [x: `bytes27[${string}]`]: undefined;
    [x: `bytes28[${string}]`]: undefined;
    [x: `bytes29[${string}]`]: undefined;
    [x: `bytes30[${string}]`]: undefined;
    [x: `bytes31[${string}]`]: undefined;
    [x: `bytes32[${string}]`]: undefined ...
typedData });

Parameters

args

UseSignTypedDataArgs The arguments for the hook, including client and mutation-related arguments. ref

Returns

UseSignTypedDataResult An object containing methods and state related to the sign typed data mutation process. ref