chore: tsdoc - signTypedData

bcnmy · Sep 19, 2024 · 20d27b5 · 20d27b5
1 parent b78b12c
commit 20d27b5
Show file tree

Hide file tree

Showing 3 changed files with 41 additions and 85 deletions.
diff --git a/...ecorators/erc7579/erc7579.actions.test.ts → ...rators/erc7579/erc7579.decorators.test.ts b/...ecorators/erc7579/erc7579.actions.test.ts → ...rators/erc7579/erc7579.decorators.test.ts
diff --git a/...tors/smartAccount/erc7579.actions.test.ts → ...s/smartAccount/account.decorators.test.ts b/...tors/smartAccount/erc7579.actions.test.ts → ...s/smartAccount/account.decorators.test.ts
diff --git a/src/sdk/clients/decorators/smartAccount/signTypedData.ts b/src/sdk/clients/decorators/smartAccount/signTypedData.ts
@@ -15,102 +15,58 @@ import { parseAccount } from "viem/utils"
 import { AccountNotFoundError } from "../../../account/utils/AccountNotFound"
 
 /**
- * Signs typed data and calculates an Ethereum-specific signature in [https://eips.ethereum.org/EIPS/eip-712](https://eips.ethereum.org/EIPS/eip-712): `sign(keccak256("\x19\x01" ‖ domainSeparator ‖ hashStruct(message)))`
+ * Signs typed data using the smart account.
  *
- * - Docs: https://viem.sh/docs/actions/wallet/signTypedData.html
- * - JSON-RPC Methods:
- *   - JSON-RPC Accounts: [`eth_signTypedData_v4`](https://docs.metamask.io/guide/signing-data.html#signtypeddata-v4)
- *   - Local Accounts: Signs locally. No JSON-RPC request.
+ * This function calculates an Ethereum-specific signature in [EIP-712 format](https://eips.ethereum.org/EIPS/eip-712):
+ * `sign(keccak256("\x19\x01" ‖ domainSeparator ‖ hashStruct(message)))`
  *
- * @param client - Client to use
- * @param parameters - {@link SignTypedDataParameters}
- * @returns The signed data. {@link SignTypedDataReturnType}
+ * @param client - The client instance.
+ * @param parameters - Parameters for signing the typed data.
+ * @returns The signature as a hexadecimal string.
+ * @throws {AccountNotFoundError} If the account is not found.
  *
  * @example
- * import { createWalletClient, custom } from 'viem'
- * import { mainnet } from 'viem/chains'
- * import { signTypedData } from 'viem/wallet'
+ * import { signTypedData } from '@biconomy/sdk'
+ * import { keccak256, encodeAbiParameters, parseAbiParameters } from 'viem'
  *
- * const client = createWalletClient({
- *   chain: mainnet,
- *   transport: custom(window.ethereum),
- * })
- * const signature = await signTypedData(client, {
- *   account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
- *   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!',
- *   },
- * })
+ * const domain = {
+ *   name: 'Ether Mail',
+ *   version: '1',
+ *   chainId: 1,
+ *   verifyingContract: '0xCcCCccccCCCCcCCCCCCcCcCccCcCCCcCcccccccC'
+ * }
  *
- * @example
- * // Account Hoisting
- * import { createWalletClient, http } from 'viem'
- * import { privateKeyToAccount } from 'viem/accounts'
- * import { mainnet } from 'viem/chains'
- * import { signTypedData } from 'viem/wallet'
+ * const types = {
+ *   Person: [
+ *     { name: 'name', type: 'string' },
+ *     { name: 'wallet', type: 'address' }
+ *   ],
+ *   Mail: [
+ *     { name: 'from', type: 'Person' },
+ *     { name: 'to', type: 'Person' },
+ *     { name: 'contents', type: 'string' }
+ *   ]
+ * }
  *
- * const client = createWalletClient({
- *   account: privateKeyToAccount('0x…'),
- *   chain: mainnet,
- *   transport: http(),
- * })
- * const signature = await signTypedData(client, {
- *   domain: {
- *     name: 'Ether Mail',
- *     version: '1',
- *     chainId: 1,
- *     verifyingContract: '0xCcCCccccCCCCcCCCCCCcCcCccCcCCCcCcccccccC',
+ * const message = {
+ *   from: {
+ *     name: 'Cow',
+ *     wallet: '0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826'
  *   },
- *   types: {
- *     Person: [
- *       { name: 'name', type: 'string' },
- *       { name: 'wallet', type: 'address' },
- *     ],
- *     Mail: [
- *       { name: 'from', type: 'Person' },
- *       { name: 'to', type: 'Person' },
- *       { name: 'contents', type: 'string' },
- *     ],
+ *   to: {
+ *     name: 'Bob',
+ *     wallet: '0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB'
  *   },
+ *   contents: 'Hello, Bob!'
+ * }
+ *
+ * const signature = await signTypedData(nexusClient, {
+ *   domain,
+ *   types,
  *   primaryType: 'Mail',
- *   message: {
- *     from: {
- *       name: 'Cow',
- *       wallet: '0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826',
- *     },
- *     to: {
- *       name: 'Bob',
- *       wallet: '0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB',
- *     },
- *     contents: 'Hello, Bob!',
- *   },
+ *   message
  * })
+ * console.log(signature) // '0x...'
  */
 export async function signTypedData<
   const TTypedData extends TypedData | { [key: string]: unknown },