-
-
Notifications
You must be signed in to change notification settings - Fork 1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
22 changed files
with
566 additions
and
57 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
import { config, typedData } from '@wagmi/test' | ||
import { test } from 'vitest' | ||
|
||
import { signTypedData } from './signTypedData.js' | ||
|
||
test('default', async () => { | ||
signTypedData(config, { | ||
types: typedData.basic.types, | ||
primaryType: 'Mail', | ||
message: typedData.basic.message, | ||
}) | ||
}) | ||
|
||
test('domain', async () => { | ||
signTypedData(config, { | ||
primaryType: 'EIP712Domain', | ||
domain: {}, | ||
}) | ||
}) | ||
|
||
test('custom domain', async () => { | ||
signTypedData(config, { | ||
types: { | ||
EIP712Domain: [{ type: 'uint256', name: 'chainId' }], | ||
}, | ||
primaryType: 'EIP712Domain', | ||
domain: { | ||
chainId: 123n, | ||
}, | ||
}) | ||
}) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,65 @@ | ||
import { accounts, config, testConnector, typedData } from '@wagmi/test' | ||
import { recoverTypedDataAddress } from 'viem' | ||
import { expect, test } from 'vitest' | ||
|
||
import { connect } from './connect.js' | ||
import { disconnect } from './disconnect.js' | ||
import { getAccount } from './getAccount.js' | ||
import { signTypedData } from './signTypedData.js' | ||
|
||
const connector = config.connectors[0]! | ||
|
||
test('default', async () => { | ||
await connect(config, { connector }) | ||
const signature = await signTypedData(config, { | ||
types: typedData.basic.types, | ||
primaryType: 'Mail', | ||
message: typedData.basic.message, | ||
}) | ||
await expect( | ||
recoverTypedDataAddress({ | ||
types: typedData.basic.types, | ||
primaryType: 'Mail', | ||
message: typedData.basic.message, | ||
signature, | ||
}), | ||
).resolves.toBe(getAccount(config).address) | ||
await disconnect(config, { connector }) | ||
}) | ||
|
||
test('behavior: user rejected request', async () => { | ||
const connector_ = config._internal.setup( | ||
testConnector({ | ||
accounts, | ||
features: { signTypedDataError: true }, | ||
}), | ||
) | ||
await connect(config, { connector: connector_ }) | ||
await expect( | ||
signTypedData(config, { | ||
types: typedData.basic.types, | ||
primaryType: 'Mail', | ||
message: typedData.basic.message, | ||
}), | ||
).rejects.toMatchInlineSnapshot(` | ||
[UserRejectedRequestError: User rejected the request. | ||
Details: Failed to sign typed data. | ||
Version: viem@1.2.15] | ||
`) | ||
await disconnect(config, { connector: connector_ }) | ||
}) | ||
|
||
test('behavior: not connected', async () => { | ||
await expect( | ||
signTypedData(config, { | ||
types: typedData.basic.types, | ||
primaryType: 'Mail', | ||
message: typedData.basic.message, | ||
}), | ||
).rejects.toMatchInlineSnapshot(` | ||
[ConnectorNotFoundError: Connector not found. | ||
Version: @wagmi/core@x.y.z] | ||
`) | ||
}) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
import type { TypedData, UserRejectedRequestError } from 'viem' | ||
import { | ||
type SignTypedDataParameters as viem_SignTypedDataParameters, | ||
type SignTypedDataReturnType as viem_SignTypedDataReturnType, | ||
signTypedData as viem_signTypedData, | ||
} from 'viem/actions' | ||
|
||
import { type Config } from '../config.js' | ||
import { ConnectorNotFoundError } from '../errors/config.js' | ||
import { getConnectorClient } from './getConnectorClient.js' | ||
|
||
export type SignTypedDataParameters< | ||
typedData extends TypedData | Record<string, unknown> = TypedData, | ||
primaryType extends keyof typedData | 'EIP712Domain' = keyof typedData, | ||
> = viem_SignTypedDataParameters<typedData, primaryType, never> | ||
|
||
export type SignTypedDataReturnType = viem_SignTypedDataReturnType | ||
|
||
export type SignTypedDataError = | ||
| ConnectorNotFoundError | ||
| UserRejectedRequestError | ||
// base | ||
| Error | ||
|
||
/** https://wagmi.sh/core/actions/signTypedData */ | ||
export async function signTypedData< | ||
const typedData extends TypedData | Record<string, unknown>, | ||
primaryType extends keyof typedData | 'EIP712Domain', | ||
>( | ||
config: Config, | ||
parameters: SignTypedDataParameters<typedData, primaryType>, | ||
): Promise<SignTypedDataReturnType> { | ||
const client = await getConnectorClient(config) | ||
if (!client) throw new ConnectorNotFoundError() | ||
return viem_signTypedData( | ||
client, | ||
parameters as unknown as viem_SignTypedDataParameters, | ||
) | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
import { config } from '@wagmi/test' | ||
import { expect, test } from 'vitest' | ||
|
||
import { signTypedDataMutationOptions } from './signTypedData.js' | ||
|
||
test('default', () => { | ||
expect(signTypedDataMutationOptions(config)).toMatchInlineSnapshot(` | ||
{ | ||
"mutationFn": [Function], | ||
"mutationKey": [ | ||
"signTypedData", | ||
], | ||
} | ||
`) | ||
}) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
import type { MutateOptions, MutationOptions } from '@tanstack/query-core' | ||
|
||
import { | ||
type SignTypedDataError, | ||
type SignTypedDataParameters, | ||
type SignTypedDataReturnType, | ||
signTypedData, | ||
} from '../actions/signTypedData.js' | ||
import { type Config } from '../config.js' | ||
import type { Evaluate } from '../types/utils.js' | ||
import type { TypedData } from 'viem' | ||
|
||
export function signTypedDataMutationOptions<config extends Config>( | ||
config: config, | ||
) { | ||
return { | ||
mutationFn(variables) { | ||
return signTypedData(config, variables) | ||
}, | ||
mutationKey: ['signTypedData'], | ||
} as const satisfies MutationOptions< | ||
SignTypedDataData, | ||
SignTypedDataError, | ||
SignTypedDataVariables | ||
> | ||
} | ||
|
||
export type SignTypedDataData = Evaluate<SignTypedDataReturnType> | ||
|
||
export type SignTypedDataVariables< | ||
typedData extends TypedData | Record<string, unknown> = TypedData, | ||
primaryType extends keyof typedData | 'EIP712Domain' = keyof typedData, | ||
> = SignTypedDataParameters<typedData, primaryType> | ||
|
||
export type SignTypedDataMutate<context = unknown> = < | ||
const typedData extends TypedData | Record<string, unknown>, | ||
primaryType extends keyof typedData | 'EIP712Domain', | ||
>( | ||
variables: SignTypedDataVariables<typedData, primaryType>, | ||
options?: MutateOptions< | ||
SignTypedDataData, | ||
SignTypedDataError, | ||
SignTypedDataVariables<typedData, primaryType>, | ||
context | ||
>, | ||
) => void | ||
|
||
export type SignTypedDataMutateAsync<context = unknown,> = < | ||
const typedData extends TypedData | Record<string, unknown>, | ||
primaryType extends keyof typedData | 'EIP712Domain', | ||
>( | ||
variables: SignTypedDataVariables<typedData, primaryType>, | ||
options?: MutateOptions< | ||
SignTypedDataData, | ||
SignTypedDataError, | ||
SignTypedDataVariables<typedData, primaryType>, | ||
context | ||
>, | ||
) => Promise<SignTypedDataData> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.