SDK: Remove @description tags from JSDoc (#6844)

MananTank · web-flow · commit b6fdd0cc36e3 · 2025-04-24T14:52:14.000-07:00
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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<boolean>} 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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<T, TRequired extends boolean> = 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
@@ -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.
  *

Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@ import type { Hex } from "../utils/encoding/hex.js";`
`3`	`3`	`import { ERC_6492_MAGIC_VALUE } from "./constants.js";`
`4`	`4`
`5`	`5`	`/**`
`6`		`- * @description Determines if a signature is compatible with [ERC6492](https://eips.ethereum.org/EIPS/eip-6492)`
	`6`	`+ * Determines if a signature is compatible with [ERC6492](https://eips.ethereum.org/EIPS/eip-6492)`
`7`	`7`	`*`
`8`	`8`	`* @param {Hex} signature The signature to check for ERC6492 compatibility`
`9`	`9`	`*`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ export type ParseErc6492SignatureReturnType = OneOf<`
`13`	`13`	`>;`
`14`	`14`
`15`	`15`	`/**`
`16`		`- * @description Parses a serialized ({@link Hex}) [ERC-6492](https://eips.ethereum.org/EIPS/eip-6492) signature.`
	`16`	`+ * Parses a serialized ({@link Hex}) [ERC-6492](https://eips.ethereum.org/EIPS/eip-6492) signature.`
`17`	`17`	`* If the signature is not in ERC-6492 format, the original signature is returned.`
`18`	`18`	`*`
`19`	`19`	`* @param {Hex} signature The signature to parse`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@ import { ERC_6492_MAGIC_VALUE } from "./constants.js";`
`5`	`5`	`import type { Erc6492Signature } from "./types.js";`
`6`	`6`
`7`	`7`	`/**`
`8`		`- * @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.`
	`8`	`+ * 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.`
`9`	`9`	`*`
`10`	`10`	`* @param {@link Erc6492Signature} signature The signature object to serialize into Hex format`
`11`	`11`	`* @param {string} signature.address The ERC-4337 Account Factory address`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ const ZKSYNC_VALIDATOR_ADDRESS: Address =`
`32`	`32`	`"0xfB688330379976DA81eB64Fe4BF50d7401763B9C";`
`33`	`33`
`34`	`34`	`/**`
`35`		`- * @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.`
	`35`	`+ * 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.`
`36`	`36`	`* This function should rarely be used directly, instead use @see {import("./verify-signature.js")} and @see {import("./verify-typed-data.js")}}`
`37`	`37`	`*`
`38`	`38`	`* @param {Hex} options.hash The hash that was signed`
Original file line number	Diff line number	Diff line change
`@@ -74,7 +74,7 @@ export type VerifyContractWalletSignatureParams = Prettify<`
`74`	`74`	`>;`
`75`	`75`
`76`	`76`	`/**`
`77`		`- * @description Verifies a contract wallet signature using [ERC-6942](https://eips.ethereum.org/EIPS/eip-6942) Signature Validation for Predeploy Contracts.`
	`77`	`+ * Verifies a contract wallet signature using [ERC-6942](https://eips.ethereum.org/EIPS/eip-6942) Signature Validation for Predeploy Contracts.`
`78`	`78`	`* This function will validate signatures for both deployed and undeployed smart accounts of all signature types.`
`79`	`79`	`*`
`80`	`80`	`* @param {@link VerifyContractWalletSignatureParams} options - The parameters for verifying the signature.`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ import { getFid } from "../read/getFid.js";`
`11`	`11`
`12`	`12`	`/**`
`13`	`13`	* Represents the parameters for the `addSigner` function.
`14`		`- * @description`
	`14`	`+ *`
`15`	`15`	`* This function can be used wither be provided pre-generated signatures or the wallet accounts directly.`
`16`	`16`	`* 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)`
`17`	`17`	`*`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ import { getFid } from "../read/getFid.js";`
`12`	`12`
`13`	`13`	`/**`
`14`	`14`	* Represents the parameters for the `addSignerFor` function.
`15`		`- * @description`
	`15`	`+ *`
`16`	`16`	`* This function can be used wither be provided pre-generated signatures or the wallet accounts directly.`
`17`	`17`	`* 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)`
`18`	`18`	`*`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ export type DownloadOptions = Prettify<`
`11`	`11`	`>;`
`12`	`12`
`13`	`13`	`/**`
`14`		`- * @description Downloads a file from the specified IPFS, Arweave, or HTTP URI.`
	`14`	`+ * Downloads a file from the specified IPFS, Arweave, or HTTP URI.`
`15`	`15`	`*`
`16`	`16`	* `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.
`17`	`17`	`*`