prepareSign

1function prepareSign<TAccount>(
2 client,
3 params,
4): Promise<{
5 chainId: `0x${string}`;
6 signatureRequest:
7 | {
8 data:
9 | string
10 | {
11 raw: `0x${string}`;
12 };
13 type: "personal_sign";
14 }
15 | {
16 data: {
17 domain?: {
18 chainId?: number;
19 name?: string;
20 salt?: `0x${string}`;
21 verifyingContract?: `0x${string}`;
22 version?: string;
23 };
24 message: {
25 [key: string]: unknown;
26 };
27 primaryType: string;
28 types: {
29 [key: string]: object[];
30 };
31 };
32 type: "eth_signTypedData_v4";
33 };
34}>;

Defined in: account-kit/wallet-client/src/client/actions/prepareSign.ts:37

Prepares a signature request for signing messages or transactions.

Example

1// Prepare a message to be signed
2const result = await client.prepareSign({
3 from: "0x1234...",
4 type: "personal_sign",
5 data: "Hello, world!",
6});

Type Parameters

Type ParameterDefault type

TAccount extends undefined | `0x${string}`

undefined | `0x${string}`

Parameters

ParameterTypeDescription

client

InnerWalletApiClient

The wallet API client to use for the request

params

PrepareSignParams<TAccount>

Parameters for preparing the signature request

Returns

Promise<{ chainId: `0x${string}`; signatureRequest: | { data: | string | { raw: `0x${string}`; }; type: "personal_sign"; } | { data: { domain?: { chainId?: number; name?: string; salt?: `0x${string}`; verifyingContract?: `0x${string}`; version?: string; }; message: { [key: string]: unknown; }; primaryType: string; types: { [key: string]: object[]; }; }; type: "eth_signTypedData_v4"; }; }>

A Promise that resolves to the prepare sign result containing a signature request