signTypedData
signTypedData
supports signing typed data from the MagicSigner
.
This method must be called after authenticate
. Otherwise, this method will throw an error with the message Not Authenticated
.
Usage
ts
import { createMagicSigner } from "./magic";
const magicSigner = await createMagicSigner();
const signedTypedData = await magicSigner.signTypedData({
domain: {
name: "Ether Mail",
version: "1",
chainId: 1,
verifyingContract: "0xCcCCccccCCCCcCCCCCCcCcCccCcCCCcCcccccccC",
},
types: {
Person: [
{ name: "name", type: "string" },
{ name: "wallet", type: "address" },
],
Mail: [
{ name: "from", type: "Person" },
{ name: "to", type: "Person" },
{ name: "contents", type: "string" },
],
},
primaryType: "Mail",
message: {
from: {
name: "Cow",
wallet: "0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826",
},
to: {
name: "Bob",
wallet: "0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB",
},
contents: "Hello, Bob!",
},
});
ts
import { MagicSigner } from "@alchemy/aa-signers/magic";
// this is generated from the [Magic Dashboard](https://dashboard.magic.link/)
const MAGIC_API_KEY = "pk_live_...";
export const createMagicSigner = async () => {
const magicSigner = new MagicSigner({ apiKey: MAGIC_API_KEY });
await magicSigner.authenticate({
authenticate: async () => {
await magicSigner.inner.wallet.connectWithUI();
},
});
return magicSigner;
};
Returns
Promise<Hex>
A Promise
containing the signature of the typed data.
Parameters
params: SignTypedDataParams
-- the typed data to sign
domain: TypedDataDomain
-- The typed data domaintypes: Object
-- the type definitions for the typed dataprimaryType: inferred String
-- the primary type to extract from types and use in valuemessage: inferred from types & primaryType
-- the message, inferred from