From ece47c36b232e934aa7cc1904b2f2aeb9f03c493 Mon Sep 17 00:00:00 2001 From: Manan Tank Date: Fri, 25 Apr 2025 01:12:49 +0530 Subject: [PATCH] SDK: Remove @description tags from JSDoc --- packages/thirdweb/src/auth/is-erc6492-signature.ts | 2 +- packages/thirdweb/src/auth/parse-erc6492-signature.ts | 2 +- packages/thirdweb/src/auth/serialize-erc6492-signature.ts | 2 +- packages/thirdweb/src/auth/verify-hash.ts | 2 +- packages/thirdweb/src/auth/verify-signature.ts | 2 +- packages/thirdweb/src/auth/verify-typed-data.ts | 4 ++-- packages/thirdweb/src/extensions/farcaster/write/addSigner.ts | 2 +- .../thirdweb/src/extensions/farcaster/write/addSignerFor.ts | 2 +- .../src/extensions/farcaster/write/registerFidAndSigner.ts | 2 +- packages/thirdweb/src/storage/download.ts | 2 +- packages/thirdweb/src/utils/type-utils.ts | 4 ++-- .../src/wallets/in-app/core/authentication/linkAccount.ts | 3 --- 12 files changed, 13 insertions(+), 16 deletions(-) diff --git a/packages/thirdweb/src/auth/is-erc6492-signature.ts b/packages/thirdweb/src/auth/is-erc6492-signature.ts index 243512c034f..79d1dd80c7f 100644 --- a/packages/thirdweb/src/auth/is-erc6492-signature.ts +++ b/packages/thirdweb/src/auth/is-erc6492-signature.ts @@ -3,7 +3,7 @@ import type { Hex } from "../utils/encoding/hex.js"; import { ERC_6492_MAGIC_VALUE } from "./constants.js"; /** - * @description Determines if a signature is compatible with [ERC6492](https://eips.ethereum.org/EIPS/eip-6492) + * Determines if a signature is compatible with [ERC6492](https://eips.ethereum.org/EIPS/eip-6492) * * @param {Hex} signature The signature to check for ERC6492 compatibility * diff --git a/packages/thirdweb/src/auth/parse-erc6492-signature.ts b/packages/thirdweb/src/auth/parse-erc6492-signature.ts index c23f644f135..9dc7c724dd1 100644 --- a/packages/thirdweb/src/auth/parse-erc6492-signature.ts +++ b/packages/thirdweb/src/auth/parse-erc6492-signature.ts @@ -13,7 +13,7 @@ export type ParseErc6492SignatureReturnType = OneOf< >; /** - * @description Parses a serialized ({@link Hex}) [ERC-6492](https://eips.ethereum.org/EIPS/eip-6492) signature. + * Parses a serialized ({@link Hex}) [ERC-6492](https://eips.ethereum.org/EIPS/eip-6492) signature. * If the signature is not in ERC-6492 format, the original signature is returned. * * @param {Hex} signature The signature to parse diff --git a/packages/thirdweb/src/auth/serialize-erc6492-signature.ts b/packages/thirdweb/src/auth/serialize-erc6492-signature.ts index 959a432cbbb..bcdd8a85d62 100644 --- a/packages/thirdweb/src/auth/serialize-erc6492-signature.ts +++ b/packages/thirdweb/src/auth/serialize-erc6492-signature.ts @@ -5,7 +5,7 @@ import { ERC_6492_MAGIC_VALUE } from "./constants.js"; import type { Erc6492Signature } from "./types.js"; /** - * @description Serializes a signature for use with [ERC-6492](https://eips.ethereum.org/EIPS/eip-6492). The signature must be generated by a signer for an [ERC-4337](https://eips.ethereum.org/EIPS/eip-4337) Account Factory account with counterfactual deployment addresses. + * Serializes a signature for use with [ERC-6492](https://eips.ethereum.org/EIPS/eip-6492). The signature must be generated by a signer for an [ERC-4337](https://eips.ethereum.org/EIPS/eip-4337) Account Factory account with counterfactual deployment addresses. * * @param {@link Erc6492Signature} signature The signature object to serialize into Hex format * @param {string} signature.address The ERC-4337 Account Factory address diff --git a/packages/thirdweb/src/auth/verify-hash.ts b/packages/thirdweb/src/auth/verify-hash.ts index 3163d2c518a..7f6adf14787 100644 --- a/packages/thirdweb/src/auth/verify-hash.ts +++ b/packages/thirdweb/src/auth/verify-hash.ts @@ -32,7 +32,7 @@ const ZKSYNC_VALIDATOR_ADDRESS: Address = "0xfB688330379976DA81eB64Fe4BF50d7401763B9C"; /** - * @description Verify that an address created the provided signature for a given hash using [ERC-6492](https://eips.ethereum.org/EIPS/eip-6492). This function is interoperable with all wallet types, including EOAs. + * Verify that an address created the provided signature for a given hash using [ERC-6492](https://eips.ethereum.org/EIPS/eip-6492). This function is interoperable with all wallet types, including EOAs. * This function should rarely be used directly, instead use @see {import("./verify-signature.js")} and @see {import("./verify-typed-data.js")}} * * @param {Hex} options.hash The hash that was signed diff --git a/packages/thirdweb/src/auth/verify-signature.ts b/packages/thirdweb/src/auth/verify-signature.ts index e01c72d8fcd..5cdd10acce6 100644 --- a/packages/thirdweb/src/auth/verify-signature.ts +++ b/packages/thirdweb/src/auth/verify-signature.ts @@ -74,7 +74,7 @@ export type VerifyContractWalletSignatureParams = Prettify< >; /** - * @description Verifies a contract wallet signature using [ERC-6942](https://eips.ethereum.org/EIPS/eip-6942) Signature Validation for Predeploy Contracts. + * Verifies a contract wallet signature using [ERC-6942](https://eips.ethereum.org/EIPS/eip-6942) Signature Validation for Predeploy Contracts. * This function will validate signatures for both deployed and undeployed smart accounts of all signature types. * * @param {@link VerifyContractWalletSignatureParams} options - The parameters for verifying the signature. diff --git a/packages/thirdweb/src/auth/verify-typed-data.ts b/packages/thirdweb/src/auth/verify-typed-data.ts index 200ee78cb03..22340ce336a 100644 --- a/packages/thirdweb/src/auth/verify-typed-data.ts +++ b/packages/thirdweb/src/auth/verify-typed-data.ts @@ -24,7 +24,7 @@ export type VerifyTypedDataParams< }; /** - * @description Verify am [EIP-712](https://eips.ethereum.org/EIPS/eip-712) typed data signature. This function is interoperable with all wallet types (smart accounts or EOAs). + * Verify am [EIP-712](https://eips.ethereum.org/EIPS/eip-712) typed data signature. This function is interoperable with all wallet types (smart accounts or EOAs). * * @param {string} options.address The address that signed the typed data * @param {string | Uint8Array | Signature} options.signature The signature that was signed @@ -38,7 +38,7 @@ export type VerifyTypedDataParams< * @param {typeof VerifyTypedDataParams.types} options.types The EIP-712 types that were signed. * * @returns {Promise} A promise that resolves to `true` if the signature is valid, or `false` otherwise. - * + * * @example * ```ts * import { verifyTypedData } from "thirdweb/utils"; diff --git a/packages/thirdweb/src/extensions/farcaster/write/addSigner.ts b/packages/thirdweb/src/extensions/farcaster/write/addSigner.ts index b64b0586885..38908a3083d 100644 --- a/packages/thirdweb/src/extensions/farcaster/write/addSigner.ts +++ b/packages/thirdweb/src/extensions/farcaster/write/addSigner.ts @@ -11,7 +11,7 @@ import { getFid } from "../read/getFid.js"; /** * Represents the parameters for the `addSigner` function. - * @description + * * This function can be used wither be provided pre-generated signatures or the wallet accounts directly. * This is done so the helpers can be used when there's no direct access to the account, but signatures can be generated (e.g. engine) * diff --git a/packages/thirdweb/src/extensions/farcaster/write/addSignerFor.ts b/packages/thirdweb/src/extensions/farcaster/write/addSignerFor.ts index 1e9b9d8f3d7..6217cbb075f 100644 --- a/packages/thirdweb/src/extensions/farcaster/write/addSignerFor.ts +++ b/packages/thirdweb/src/extensions/farcaster/write/addSignerFor.ts @@ -12,7 +12,7 @@ import { getFid } from "../read/getFid.js"; /** * Represents the parameters for the `addSignerFor` function. - * @description + * * This function can be used wither be provided pre-generated signatures or the wallet accounts directly. * This is done so the helpers can be used when there's no direct access to the account, but signatures can be generated (e.g. engine) * diff --git a/packages/thirdweb/src/extensions/farcaster/write/registerFidAndSigner.ts b/packages/thirdweb/src/extensions/farcaster/write/registerFidAndSigner.ts index 62abca75c54..2aede9034eb 100644 --- a/packages/thirdweb/src/extensions/farcaster/write/registerFidAndSigner.ts +++ b/packages/thirdweb/src/extensions/farcaster/write/registerFidAndSigner.ts @@ -12,7 +12,7 @@ import { getFid } from "../read/getFid.js"; /** * Represents the parameters for the `registerFidAndSigner` function. - * @description + * * This function can be used wither be provided pre-generated signatures or the wallet accounts directly. * This is done so the helpers can be used when there's no direct access to the account, but signatures can be generated (e.g. engine) * diff --git a/packages/thirdweb/src/storage/download.ts b/packages/thirdweb/src/storage/download.ts index e85ecae3184..355a197b19f 100644 --- a/packages/thirdweb/src/storage/download.ts +++ b/packages/thirdweb/src/storage/download.ts @@ -11,7 +11,7 @@ export type DownloadOptions = Prettify< >; /** - * @description Downloads a file from the specified IPFS, Arweave, or HTTP URI. + * Downloads a file from the specified IPFS, Arweave, or HTTP URI. * * `download` will parse the provided URI based on its scheme (ipfs://, ar://, https://) and convert it to a URL to fetch the file from thirdweb's storage service. * diff --git a/packages/thirdweb/src/utils/type-utils.ts b/packages/thirdweb/src/utils/type-utils.ts index 2a51b196a81..172a30c7f43 100644 --- a/packages/thirdweb/src/utils/type-utils.ts +++ b/packages/thirdweb/src/utils/type-utils.ts @@ -18,7 +18,7 @@ export type Filter< : readonly [...Acc]; /** - * @description Makes attributes on the type T required if TRequired is true. + * Makes attributes on the type T required if TRequired is true. * @example * MaybeRequired<{ a: string, b?: number }, true> * => { a: string, b: number } @@ -31,7 +31,7 @@ export type MaybeRequired = TRequired extends true : T; /** - * @description Combines members of an intersection into a readable type. + * Combines members of an intersection into a readable type. * @see {@link https://twitter.com/mattpocockuk/status/1622730173446557697?s=20&t=NdpAcmEFXY01xkqU3KO0Mg} * @example * Prettify<{ a: string } & { b: string } & { c: number, d: bigint }> diff --git a/packages/thirdweb/src/wallets/in-app/core/authentication/linkAccount.ts b/packages/thirdweb/src/wallets/in-app/core/authentication/linkAccount.ts index b5dbcdbe4d6..1783c8ef3e5 100644 --- a/packages/thirdweb/src/wallets/in-app/core/authentication/linkAccount.ts +++ b/packages/thirdweb/src/wallets/in-app/core/authentication/linkAccount.ts @@ -7,7 +7,6 @@ import type { ClientScopedStorage } from "./client-scoped-storage.js"; import type { Profile } from "./types.js"; /** - * @description * Links a new account to the current one using an auth token. * For the public-facing API, use `wallet.linkProfile` instead. * @@ -58,7 +57,6 @@ export async function linkAccount({ } /** - * @description * Links a new account to the current one using an auth token. * For the public-facing API, use `wallet.linkProfile` instead. * @@ -107,7 +105,6 @@ export async function unlinkAccount({ } /** - * @description * Gets the linked accounts for the current user. * For the public-facing API, use `wallet.getProfiles` instead. *