Skip to content

Commit 48e6427

Browse files
authored
Small improvement to verifySignature docs example (#2883)
1 parent 7f4caf0 commit 48e6427

File tree

2 files changed

+11
-4
lines changed

2 files changed

+11
-4
lines changed

.changeset/spotty-trains-vanish.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"thirdweb": patch
3+
---
4+
5+
Improve docs for verifySignature

packages/thirdweb/src/auth/verifySignature.ts

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -107,17 +107,19 @@ export type VerifySignatureParams = Prettify<
107107
/**
108108
* Verifies the signature based on the provided options.
109109
* Handles smart contract wallet signatures and EOA signatures.
110-
* IMPORTANT: in order to check smart contract signatures, a chain and client must be provided.
110+
* **IMPORTANT: in order to check smart contract signatures, a chain and client must be provided.**
111111
* @param options - The options for signature verification.
112112
* @returns A boolean indicating whether the signature is valid or not.
113113
* @example
114114
* ```ts
115115
* import { verifySignature } from 'thirdweb/auth';
116116
*
117117
* const isValid = await verifySignature({
118-
* message: '0x1234567890123456789012345678901234567890',
119-
* signature: '0x1234567890123456789012345678901234567890',
120-
* address: '0x1234567890123456789012345678901234567890'
118+
* message: 'Your message to sign',
119+
* signature: '0x91db0222ec371a8c18d3b187a6d2e77789bffca1b96826ef6b8708e0d4a66c80312fc3ae95b8fbc147265abf539bb6f360152be61a0e1411d7f5771a599e769a1c',
120+
* address: '0xda9C7A86AeE76701FC1c23ae548e8E93Ba3e42A5',
121+
* client: thirdwebClient,
122+
* chain: chain
121123
* });
122124
* ```
123125
* @auth

0 commit comments

Comments
 (0)